Class IpPortAssignment
IpPortAssignment model
Inherited Members
Namespace: Unity.Services.Matchmaker.Models
Assembly: Unity.Services.Multiplayer.dll
Syntax
[Preserve]
[DataContract(Name = "IpPortAssignment")]
public class IpPortAssignment
Constructors
IpPortAssignment(string, string, StatusOptions, string, int?, string, Dictionary<string, object>)
Creates an instance of IpPortAssignment.
Declaration
[Preserve]
public IpPortAssignment(string assignmentType, string message = null, IpPortAssignment.StatusOptions status = (IpPortAssignment.StatusOptions)0, string ip = null, int? port = null, string matchId = null, Dictionary<string, object> customData = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | assignmentType | assignmentType param |
| string | message | message param |
| IpPortAssignment.StatusOptions | status | The status of the assignment is one of Timeout, Failed, InProgress, Found |
| string | ip | IP address of the allocated server |
| int? | port | Port of the allocated server |
| string | matchId | Unique ID of the match. |
| Dictionary<string, object> | customData | Custom data for additional information (auth tokens, map hints, metadata, etc.) |
Properties
AssignmentType
Parameter assignmentType of IpPortAssignment
Declaration
[Preserve]
[DataMember(Name = "assignmentType", IsRequired = true, EmitDefaultValue = true)]
public string AssignmentType { get; }
Property Value
| Type | Description |
|---|---|
| string |
CustomData
Custom data for additional information (auth tokens, map hints, metadata, etc.)
Declaration
[Preserve]
[JsonConverter(typeof(JsonObjectCollectionConverter))]
[DataMember(Name = "customData", EmitDefaultValue = false)]
public Dictionary<string, IDeserializable> CustomData { get; }
Property Value
| Type | Description |
|---|---|
| Dictionary<string, IDeserializable> |
Ip
IP address of the allocated server
Declaration
[Preserve]
[DataMember(Name = "ip", EmitDefaultValue = false)]
public string Ip { get; }
Property Value
| Type | Description |
|---|---|
| string |
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 IpPortAssignment
Declaration
[Preserve]
[DataMember(Name = "message", EmitDefaultValue = false)]
public string Message { get; }
Property Value
| Type | Description |
|---|---|
| string |
Port
Port of the allocated server
Declaration
[Preserve]
[DataMember(Name = "port", EmitDefaultValue = false)]
public int? Port { get; }
Property Value
| Type | Description |
|---|---|
| int? |
Status
The status of the assignment is one of Timeout, Failed, InProgress, Found
Declaration
[Preserve]
[JsonConverter(typeof(StringEnumConverter))]
[DataMember(Name = "status", EmitDefaultValue = false)]
public IpPortAssignment.StatusOptions Status { get; }
Property Value
| Type | Description |
|---|---|
| IpPortAssignment.StatusOptions |