Class RemoteConfigSettingsApi
Represents a collection of functions to interact with the API endpoints
Inherited Members
Namespace: Unity.Services.Apis.RemoteConfig
Assembly: Unity.Services.Apis.dll
Syntax
public class RemoteConfigSettingsApi : IRemoteConfigSettingsApi, IApiAccessor
Constructors
RemoteConfigSettingsApi(IApiClient)
Initializes a new instance of the Remote
Declaration
public RemoteConfigSettingsApi(IApiClient apiClient)
Parameters
Type | Name | Description |
---|---|---|
IApi |
apiClient | The client interface for synchronous API access. |
RemoteConfigSettingsApi(IApiClient, IApiConfiguration)
Initializes a new instance of the Remote
Declaration
public RemoteConfigSettingsApi(IApiClient apiClient, IApiConfiguration apiConfiguration)
Parameters
Type | Name | Description |
---|---|---|
IApi |
apiClient | The client interface for synchronous API access. |
IApi |
apiConfiguration | The configuration object. |
Properties
Client
The client for accessing this underlying API asynchronously.
Declaration
public IApiClient Client { get; }
Property Value
Type | Description |
---|---|
IApi |
Configuration
Gets the configuration object
Declaration
public IApiConfiguration Configuration { get; }
Property Value
Type | Description |
---|---|
IApi |
An instance of the Configuration |
Methods
AssignSettings(SettingsDeliveryRequest, CancellationToken)
Request Player Settings with optional attributes for use in campaign (game overrides).
Declaration
public ApiOperation<SettingsDeliveryResponse> AssignSettings(SettingsDeliveryRequest settingsRequest, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
Settings |
settingsRequest | Request to assign settings for a user. |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
AssignSettingsGet(string, string, string, List<string>, List<string>, CancellationToken)
Get Player Settings
Declaration
public ApiOperation<SettingsDeliveryResponse> AssignSettingsGet(string projectId, string environmentId = null, string configType = null, List<string> key = null, List<string> type = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | projectId for the requesting Unity project |
string | environmentId | optional environmentId to choose a non-default environment (optional) |
string | configType | optional configType (optional) |
List<string> | key | optional filter to include settings with keys containing any of the specified values (optional) |
List<string> | type | optional filter to include settings with specific types in the response (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
GetBasePath()
Gets the base path of the API client.
Declaration
public string GetBasePath()
Returns
Type | Description |
---|---|
string | The base path |