Interface IRelayAllocationsApi
Represents a collection of functions to interact with the API endpoints
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 |
---|---|---|
Allocation |
allocationRequest | The allocation request. |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
CreateJoincode(JoinCodeRequest, CancellationToken)
Create a join code.
Declaration
ApiOperation<JoinCodeResponseBody> CreateJoincode(JoinCodeRequest joinCodeRequest, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
Join |
joinCodeRequest | The create join code request. |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
JoinRelay(JoinRequest, CancellationToken)
Join a Relay server.
Declaration
ApiOperation<JoinResponseBody> JoinRelay(JoinRequest joinRequest, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
Join |
joinRequest | The join request. |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
ListRegions(CancellationToken)
List available Relay regions.
Declaration
ApiOperation<RegionsResponseBody> ListRegions(CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |