Class JoinAllocation
An allocation created via a join code.
Inherited Members
Namespace: Unity.Services.Relay.Models
Syntax
[Preserve]
public class JoinAllocationConstructors
JoinAllocation(Guid, List<RelayServerEndpoint>, RelayServer, Byte[], Byte[], Byte[], String, Byte[])
An allocation created via a join code.
Declaration
[Preserve]
public JoinAllocation(Guid allocationId, List<RelayServerEndpoint> serverEndpoints, RelayServer relayServer, byte[] key, byte[] connectionData, byte[] allocationIdBytes, string region, byte[] hostConnectionData)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | allocationId | The unique ID of the allocation. |
| List<RelayServerEndpoint> | serverEndpoints | Connection endpoints for the assigned Relay server. > Note: The order of server endpoints is not guaranteed and users should iterate over the items and look for the desired values. |
| RelayServer | relayServer | relayServer param |
| Byte[] | key | A base64-encoded key required for the HMAC signature of the |
| Byte[] | connectionData | A base64-encoded representation of an encrypted connection data blob describing this allocation. This data is equired for establishing communication with other players. |
| Byte[] | allocationIdBytes | A base64-encoded form of the allocation ID. When decoded, this is the exact expected byte alignment to use when crafting Relay protocol messages that require the allocation ID. For example, |
| String | region | The allocation region. |
| Byte[] | hostConnectionData | A base64-encoded representation of an encrypted connection data blob describing the allocation and Relay server of the player who created the join code. Connecting players can use this data to establish communication with the host player. |
Properties
AllocationId
The unique ID of the allocation.
Declaration
[Preserve]
public Guid AllocationId { get; }Property Value
| Type | Description |
|---|---|
| Guid |
AllocationIdBytes
A base64-encoded form of the allocation ID. When decoded, this is the exact expected byte alignment to use when crafting Relay protocol messages that require the allocation ID. For example, PING, CONNECT, RELAY, and CLOSE message types.
Declaration
[Preserve]
public byte[] AllocationIdBytes { get; }Property Value
| Type | Description |
|---|---|
| Byte[] |
ConnectionData
A base64-encoded representation of an encrypted connection data blob describing this allocation. This data is equired for establishing communication with other players.
Declaration
[Preserve]
public byte[] ConnectionData { get; }Property Value
| Type | Description |
|---|---|
| Byte[] |
HostConnectionData
A base64-encoded representation of an encrypted connection data blob describing the allocation and Relay server of the player who created the join code. Connecting players can use this data to establish communication with the host player.
Declaration
[Preserve]
public byte[] HostConnectionData { get; }Property Value
| Type | Description |
|---|---|
| Byte[] |
Key
A base64-encoded key required for the HMAC signature of the BIND message.
Declaration
[Preserve]
public byte[] Key { get; }Property Value
| Type | Description |
|---|---|
| Byte[] |
Region
The allocation region.
Declaration
[Preserve]
public string Region { get; }Property Value
| Type | Description |
|---|---|
| String |
RelayServer
Parameter relayServer of JoinAllocation
Declaration
[Preserve]
public RelayServer RelayServer { get; }Property Value
| Type | Description |
|---|---|
| RelayServer |
ServerEndpoints
Connection endpoints for the assigned Relay server. > Note: The order of server endpoints is not guaranteed and users should iterate over the items and look for the desired values.
Declaration
[Preserve]
public List<RelayServerEndpoint> ServerEndpoints { get; }Property Value
| Type | Description |
|---|---|
| List<RelayServerEndpoint> |