Class TriggersAdminApi
Represents a collection of functions to interact with the API endpoints
Inherited Members
Namespace: Unity.Services.Apis.Admin.Triggers
Assembly: Unity.Services.Apis.dll
Syntax
public class TriggersAdminApi : ITriggersAdminApi, IApiAccessor
Constructors
TriggersAdminApi(IApiClient)
Initializes a new instance of the Triggers
Declaration
public TriggersAdminApi(IApiClient apiClient)
Parameters
Type | Name | Description |
---|---|---|
IApi |
apiClient | The client interface for synchronous API access. |
TriggersAdminApi(IApiClient, IApiConfiguration)
Initializes a new instance of the Triggers
Declaration
public TriggersAdminApi(IApiClient apiClient, IApiConfiguration apiConfiguration)
Parameters
Type | Name | Description |
---|---|---|
IApi |
apiClient | The client interface for synchronous API access. |
IApi |
apiConfiguration | The configuration object. |
Properties
Client
The client for accessing this underlying API asynchronously.
Declaration
public IApiClient Client { get; }
Property Value
Type | Description |
---|---|
IApi |
Configuration
Gets the configuration object
Declaration
public IApiConfiguration Configuration { get; }
Property Value
Type | Description |
---|---|
IApi |
An instance of the Configuration |
Methods
CreateTriggerConfig(string, string, TriggerConfigBody, CancellationToken)
Create Trigger Config Add Trigger to the project's environment
Declaration
public 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 |
Trigger |
triggerConfigBody | (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
DeleteTriggerConfig(string, string, string, CancellationToken)
Delete Trigger Config Delete the project's environment's Trigger
Declaration
public 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. |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
GetBasePath()
Gets the base path of the API client.
Declaration
public string GetBasePath()
Returns
Type | Description |
---|---|
string | The base path |
ListTriggerConfigs(string, string, int?, string, CancellationToken)
List existing Triggers Config List project's environment existing Triggers
Declaration
public 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) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |