v1.0.0
Latest
2022.3+

Class JoinCodeRequest

A request to create a join code.

Inheritance
System.Object
JoinCodeRequest
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Unity.Services.Relay.Models
Syntax
public class JoinCodeRequest

Constructors

JoinCodeRequest(Guid)

A request to create a join code.

Declaration
public JoinCodeRequest(Guid allocationId)
Parameters
TypeNameDescription
System.GuidallocationId

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.

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
public Guid AllocationId { get; }
Property Value
TypeDescription
System.Guid