Interface ITriggersAdminApi

Represents a collection of functions to interact with the API endpoints

Inherited Members

IApiAccessor.Configuration

IApiAccessor.GetBasePath()

Namespace: Unity.Services.Apis.Admin.Triggers

Assembly: Unity.Services.Apis.dll

Syntax

public interface ITriggersAdminApi : IApiAccessor

Methods

CreateTriggerConfig(string, string, TriggerConfigBody, CancellationToken)

Create Trigger Config

Declaration

ApiOperation<TriggerConfig> CreateTriggerConfig(string projectId, string environmentId, TriggerConfigBody triggerConfigBody = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	The project's Project ID
string	environmentId	The Environment ID of a project
TriggerConfigBody	triggerConfigBody	(optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<TriggerConfig>	The operation

DeleteTriggerConfig(string, string, string, CancellationToken)

Delete Trigger Config

Declaration

ApiOperation DeleteTriggerConfig(string projectId, string environmentId, string triggerId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	The project's Project ID
string	environmentId	The Environment ID of a project
string	triggerId	ID of the trigger config. IDs can be retrieved by listing the triggers configurations.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation	The operation

ListTriggerConfigs(string, string, int?, string, CancellationToken)

List existing Triggers Config

Declaration

ApiOperation<TriggerConfigPage> ListTriggerConfigs(string projectId, string environmentId, int? limit = null, string after = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	The project's Project ID
string	environmentId	The Environment ID of a project
int?	limit	The number of triggers to display per page (optional, default to 100)
string	after	A token to get the next page (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<TriggerConfigPage>	The operation