Class JoinCodeRequest

A request to create a join code.

Inheritance

object

JoinCodeRequest

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: Unity.Services.Apis.Relay

Assembly: solution.dll

Syntax

[Preserve]
public class JoinCodeRequest

Constructors

JoinCodeRequest(string)

Initializes a new instance of the JoinCodeRequest class.

Declaration

[Preserve]
public JoinCodeRequest(string allocationId = null)

Parameters

Type	Name	Description
string	allocationId	The UUID of the allocation. The Allocations service maps this allocation ID to the generated join code. The Allocations service shares the allocation connection data with players who use the join code with the /join endpoint. This sharing mechanism establishes communication between players via the Relay server data protocol. (required).

Properties

AllocationId

The UUID of the allocation. The Allocations service maps this allocation ID to the generated join code. The Allocations service shares the allocation connection data with players who use the join code with the /join endpoint. This sharing mechanism establishes communication between players via the Relay server data protocol.

Declaration

[Preserve]
public string AllocationId { get; set; }

Property Value

Type	Description
string	The UUID of the allocation. The Allocations service maps this allocation ID to the generated join code. The Allocations service shares the allocation connection data with players who use the join code with the /join endpoint. This sharing mechanism establishes communication between players via the Relay server data protocol.