Interface IMatchmakerTicketsApi

Represents a collection of functions to interact with the API endpoints

Inherited Members

IApiAccessor.Configuration

IApiAccessor.GetBasePath()

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)
CreateTicketRequest	createTicketRequest	(optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Returns

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

Returns

Type	Description
ApiOperation<TicketStatusResponse>	The operation