Interface IPlayerPolicyAdminApi

Represents a collection of functions to interact with the API endpoints

Inherited Members

IApiAccessor.Configuration

IApiAccessor.GetBasePath()

Namespace: Unity.Services.Apis.Admin.AccessPolicy

Assembly: Unity.Services.Apis.dll

Syntax

public interface IPlayerPolicyAdminApi : IApiAccessor

Methods

DeletePlayerPolicyStatements(string, string, string, DeleteOptions, CancellationToken)

Delete policy statement(s)

Declaration

ApiOperation DeletePlayerPolicyStatements(string projectId, string environmentId, string playerId, DeleteOptions deleteOptions, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project
string	environmentId	ID of the environment
string	playerId	ID of the player
DeleteOptions	deleteOptions
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation	The operation

GetAllPlayerPolicies(string, string, int?, string, CancellationToken)

Get all player based policies in project

Declaration

ApiOperation<PlayerPolicies> GetAllPlayerPolicies(string projectId, string environmentId, int? limit = null, string next = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project
string	environmentId	ID of the environment
int?	limit	max results per page - is ignored if next query parameter is provided (optional)
string	next	pagination token for requesting next page of results (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<PlayerPolicies>	The operation

GetPlayerPolicy(string, string, string, CancellationToken)

Get a player based policy

Declaration

ApiOperation<PlayerPolicy> GetPlayerPolicy(string projectId, string environmentId, string playerId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project
string	environmentId	ID of the environment
string	playerId	ID of the player
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<PlayerPolicy>	The operation

UpsertPlayerPolicy(string, string, string, PlayerPolicyUpsert, CancellationToken)

Create or update a player based policy

Declaration

ApiOperation UpsertPlayerPolicy(string projectId, string environmentId, string playerId, PlayerPolicyUpsert playerPolicyUpsert, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project
string	environmentId	ID of the environment
string	playerId	ID of the player
PlayerPolicyUpsert	playerPolicyUpsert
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation	The operation