Interface IRemoteConfigSettingsApi
Represents a collection of functions to interact with the API endpoints
Namespace: Unity.Services.Apis.RemoteConfig
Assembly: Unity.Services.Apis.dll
Syntax
public interface IRemoteConfigSettingsApi : IApiAccessor
Methods
AssignSettings(SettingsDeliveryRequest, CancellationToken)
Request Player Settings with optional attributes for use in campaign (game overrides).
Declaration
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
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 |