Class EconomyConfigurationApi

Represents a collection of functions to interact with the API endpoints

Inheritance

object

EconomyConfigurationApi

Implements

IEconomyConfigurationApi

IApiAccessor

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.Services.Apis.Economy

Assembly: Unity.Services.Apis.dll

Syntax

public class EconomyConfigurationApi : IEconomyConfigurationApi, IApiAccessor

Constructors

EconomyConfigurationApi(IApiClient)

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

Declaration

public EconomyConfigurationApi(IApiClient apiClient)

Parameters

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

EconomyConfigurationApi(IApiClient, IApiConfiguration)

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

Declaration

public EconomyConfigurationApi(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

GetPlayerConfiguration(string, string, string, string, string, CancellationToken)

Get player's configuration Returns the economy configuration for the player with any overrides applied.

Declaration

public ApiOperation<PlayerConfigurationResponse> GetPlayerConfiguration(string projectId, string playerId, string configAssignmentHash = null, string unityInstallationId = null, string analyticsUserId = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	ID of the project.
string	playerId	ID of the player.
string	configAssignmentHash	Configuration assignment hash that should be used when processing this request. (optional)
string	unityInstallationId	Unique identifier that identifies an installation on the client’s device. The same player can have different installationIds if they have the game installed on different devices. It is available to all Unity packages that integrate with the Services SDK Core package. (optional)
string	analyticsUserId	A unique string that identifies the player and is consistent across their subsequent play sessions for analytics purposes. It is the primary user identifier and it comes from the Core package. (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<PlayerConfigurationResponse>	The operation

Implements

IEconomyConfigurationApi

IApiAccessor