Class UGCAuthApi

Represents a collection of functions to interact with the API endpoints

Inheritance

object

UGCAuthApi

Implements

IUGCAuthApi

IApiAccessor

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: Unity.Services.Apis.UGC

Assembly: solution.dll

Syntax

public class UGCAuthApi : IUGCAuthApi, IApiAccessor

Constructors

UGCAuthApi(IApiClient)

Initializes a new instance of the UGCAuthApi class using a Configuration object and client instance.

Declaration

public UGCAuthApi(IApiClient apiClient)

Parameters

Type	Name	Description
IApiClient	apiClient	The client interface for synchronous API access.

UGCAuthApi(IApiClient, IApiConfiguration)

Initializes a new instance of the UGCAuthApi class using a Configuration object and client instance.

Declaration

public UGCAuthApi(IApiClient apiClient, IApiConfiguration apiConfiguration)

Parameters

Type	Name	Description
IApiClient	apiClient	The client interface for synchronous API access.
IApiConfiguration	apiConfiguration	The configuration object.

Properties

Client

The client for accessing this underlying API asynchronously.

Declaration

public IApiClient Client { get; }

Property Value

Type	Description
IApiClient

Configuration

Gets the configuration object

Declaration

public IApiConfiguration Configuration { get; }

Property Value

Type	Description
IApiConfiguration	An instance of the Configuration

Methods

GetBasePath()

Gets the base path of the API client.

Declaration

public string GetBasePath()

Returns

Type	Description
string	The base path

Redirect(string, string, string, CancellationToken)

Redirect user after authentication and forward state, code and id_token

Declaration

public ApiOperation Redirect(string state, string code, string idToken, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	state	State provided by the application, should contain a JSON string with an object having a redirectUrl property
string	code	Authentication code provided by the authentication provider
string	idToken	Id token provided by the authentication provider
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation	The operation

Implements

IUGCAuthApi

IApiAccessor