Class TriggersAdminApi

Represents a collection of functions to interact with the API endpoints

Inheritance

object

TriggersAdminApi

Implements

ITriggersAdminApi

IApiAccessor

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

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 TriggersAdminApi class using a Configuration object and client instance.

Declaration

public TriggersAdminApi(IApiClient apiClient)

Parameters

Type	Name	Description
IApiClient	apiClient	The client interface for synchronous API access.

TriggersAdminApi(IApiClient, IApiConfiguration)

Initializes a new instance of the TriggersAdminApi class using a Configuration object and client instance.

Declaration

public TriggersAdminApi(IApiClient apiClient, IApiConfiguration apiConfiguration)

Parameters

Type	Name	Description
IApiClient	apiClient	The client interface for synchronous API access.
IApiConfiguration	apiConfiguration	The configuration object.

Properties

Client

The client for accessing this underlying API asynchronously.

Declaration

public IApiClient Client { get; }

Property Value

Type	Description
IApiClient

Configuration

Gets the configuration object

Declaration

public IApiConfiguration Configuration { get; }

Property Value

Type	Description
IApiConfiguration	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
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 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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation	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)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<TriggerConfigPage>	The operation

Implements

ITriggersAdminApi

IApiAccessor