Class JoinCodeRequest

A request to create a join code.

Inheritance

object

JoinCodeRequest

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.Services.Relay.Models

Assembly: Unity.Services.Multiplayer.dll

Syntax

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

Constructors

JoinCodeRequest(Guid)

A request to create a join code.

Declaration

[Preserve]
public JoinCodeRequest(Guid allocationId)

Parameters

Type	Name	Description
Guid	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.

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]
[DataMember(Name = "allocationId", IsRequired = true, EmitDefaultValue = true)]
public Guid AllocationId { get; }

Property Value

Type	Description
Guid