Interface IRelayAllocationsApi

Represents a collection of functions to interact with the API endpoints

Inherited Members

IApiAccessor.Configuration

IApiAccessor.GetBasePath()

Namespace: Unity.Services.Apis.Relay

Assembly: Unity.Services.Apis.dll

Syntax

public interface IRelayAllocationsApi : IApiAccessor

Methods

CreateAllocation(AllocationRequest, CancellationToken)

Create an allocation.

Declaration

ApiOperation<AllocateResponseBody> CreateAllocation(AllocationRequest allocationRequest, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
AllocationRequest	allocationRequest	The allocation request.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<AllocateResponseBody>	The operation

CreateJoincode(JoinCodeRequest, CancellationToken)

Create a join code.

Declaration

ApiOperation<JoinCodeResponseBody> CreateJoincode(JoinCodeRequest joinCodeRequest, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
JoinCodeRequest	joinCodeRequest	The create join code request.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<JoinCodeResponseBody>	The operation

JoinRelay(JoinRequest, CancellationToken)

Join a Relay server.

Declaration

ApiOperation<JoinResponseBody> JoinRelay(JoinRequest joinRequest, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
JoinRequest	joinRequest	The join request.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<JoinResponseBody>	The operation

ListRegions(CancellationToken)

List available Relay regions.

Declaration

ApiOperation<RegionsResponseBody> ListRegions(CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<RegionsResponseBody>	The operation