Class CreateBackfillTicketOptions

Paramter class for making matchmaker backfill ticket requests.

Inheritance
object
CreateBackfillTicketOptions
Inherited Members
Namespace: Unity.Services.Matchmaker
Assembly: Unity.Services.Matchmaker.dll
Syntax
public class CreateBackfillTicketOptions

Constructors

CreateBackfillTicketOptions()

Default constructor

Declaration
public CreateBackfillTicketOptions()

CreateBackfillTicketOptions(string, string, Dictionary<string, object>, BackfillTicketProperties, string, string)

Parameterized constructor

Declaration
public CreateBackfillTicketOptions(string queueName, string connection, Dictionary<string, object> attributes = null, BackfillTicketProperties properties = null, string poolId = null, string matchId = null)
Parameters
Type Name Description
string queueName
string connection
Dictionary<string, object> attributes
BackfillTicketProperties properties
string poolId
string matchId

Properties

Attributes

A dictionary of attributes (number or string), indexed by the attribute name. The attributes are compared against the corresponding filters defined in the matchmaking config and used to segment the ticket population into pools. Example attributes include map, mode, platform, and build number. (Optional)

Declaration
public Dictionary<string, object> Attributes { get; set; }
Property Value
Type Description
Dictionary<string, object>

Connection

The IP address and port of the server creating the backfill (using the format ip:port). This property is used to assign the server the matching tickets

Declaration
public string Connection { get; set; }
Property Value
Type Description
string

MatchId

The Id of the match that this backfill ticket is targeting. The match Id is contained in the allocation payload.

Declaration
public string MatchId { get; set; }
Property Value
Type Description
string

PoolId

The ID of the pool to create the backfill ticket in. Cannot be used if the attributes field is present. The allocation payload contains the pool ID of the match it was created in.

Declaration
public string PoolId { get; set; }
Property Value
Type Description
string

Properties

Properties object containing match information.

Declaration
public BackfillTicketProperties Properties { get; set; }
Property Value
Type Description
BackfillTicketProperties

QueueName

Name of the queue to target the backfill request.

Declaration
public string QueueName { get; set; }
Property Value
Type Description
string