Interface IMatchmakerTicketsApi
Represents a collection of functions to interact with the API endpoints
Namespace: Unity.Services.Apis.Matchmaker
Assembly: Unity.Services.Apis.dll
Syntax
public interface IMatchmakerTicketsApi : IApiAccessor
Methods
CreateTicket(string, CreateTicketRequest, CancellationToken)
Create a matchmaking ticket
Declaration
ApiOperation<CreateTicketResponse> CreateTicket(string impersonatedUserId = null, CreateTicketRequest createTicketRequest = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | impersonatedUserId | When called with a service account, used to specify the player-id to create the ticket on behalf of. (optional) |
Create |
createTicketRequest | (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
DeleteTicket(string, string, CancellationToken)
Delete a matchmaking ticket
Declaration
ApiOperation DeleteTicket(string id, string impersonatedUserId = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | id | Ticket ID or Backfill Ticket ID. The ID is obtained from the response of the Create operation. |
string | impersonatedUserId | When called with a service account, used to specify the player-id to create the ticket on behalf of. (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
GetTicketStatus(string, string, CancellationToken)
Gets the status of a ticket match assignment in the matchmaker
Declaration
ApiOperation<TicketStatusResponse> GetTicketStatus(string id, string impersonatedUserId = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | id | Ticket ID or Backfill Ticket ID. The ID is obtained from the response of the Create operation. |
string | impersonatedUserId | When called with a service account, used to specify the player-id to create the ticket on behalf of. (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |