Class CustomAssignment

CustomAssignment model

Inheritance

object

CustomAssignment

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.Services.Matchmaker.Models

Assembly: Unity.Services.Multiplayer.dll

Syntax

[Preserve]
[DataContract(Name = "CustomAssignment")]
public class CustomAssignment

Constructors

CustomAssignment(string, string, StatusOptions, string, Dictionary<string, object>)

Creates an instance of CustomAssignment.

Declaration

[Preserve]
public CustomAssignment(string assignmentType, string message = null, CustomAssignment.StatusOptions status = (CustomAssignment.StatusOptions)0, string matchId = null, Dictionary<string, object> customData = null)

Parameters

Type	Name	Description
string	assignmentType	assignmentType param
string	message	message param
CustomAssignment.StatusOptions	status	The status of the assignment is one of Timeout, Failed, InProgress, Found
string	matchId	Unique ID of the match.
Dictionary<string, object>	customData	Custom data containing all connection information. This is the primary connection mechanism for custom assignments.

Properties

AssignmentType

Parameter assignmentType of CustomAssignment

Declaration

[Preserve]
[DataMember(Name = "assignmentType", IsRequired = true, EmitDefaultValue = true)]
public string AssignmentType { get; }

Property Value

Type	Description
string

CustomData

Custom data containing all connection information. This is the primary connection mechanism for custom assignments.

Declaration

[Preserve]
[JsonConverter(typeof(JsonObjectCollectionConverter))]
[DataMember(Name = "customData", EmitDefaultValue = false)]
public Dictionary<string, IDeserializable> CustomData { get; }

Property Value

Type	Description
Dictionary<string, IDeserializable>

MatchId

Unique ID of the match.

Declaration

[Preserve]
[DataMember(Name = "matchId", EmitDefaultValue = false)]
public string MatchId { get; }

Property Value

Type	Description
string

Message

Parameter message of CustomAssignment

Declaration

[Preserve]
[DataMember(Name = "message", EmitDefaultValue = false)]
public string Message { get; }

Property Value

Type	Description
string

Status

The status of the assignment is one of Timeout, Failed, InProgress, Found

Declaration

[Preserve]
[JsonConverter(typeof(StringEnumConverter))]
[DataMember(Name = "status", EmitDefaultValue = false)]
public CustomAssignment.StatusOptions Status { get; }

Property Value

Type	Description
CustomAssignment.StatusOptions