Cloud Code Services SDKs

SettingsApi

Import

Import

const { SettingsApi } = require("@unity-services/remote-config-1.1");

Constructors

Constructor

new SettingsApi(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): SettingsApi

Parameters
- Optional configuration: Configuration
- basePath: string = ...
- axios: AxiosInstance = ...
Returns SettingsApi

Methods

Assign Settings

assignSettings(settingsRequest: SettingsDeliveryRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<object>>

summary

Request settings for a user, with optional attributes for use in rules.

throws

{RequiredError}

memberof

SettingsApi

Parameters
- settingsRequest: SettingsDeliveryRequest
  
  Request to assign settings for a user.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<object>>

Assign Settings Get

assignSettingsGet(projectId: string, environmentId?: string, configType?: string, key?: string[], schemaId?: string[], type?: ("string" | "int" | "float" | "long" | "bool" | "json")[], options?: AxiosRequestConfig): Promise<AxiosResponse<object>>

summary

Request settings for a user.

throws

{RequiredError}

memberof

SettingsApi

Parameters
- projectId: string
  
  projectId for the requesting Unity project
- Optional environmentId: string
- Optional configType: string
- Optional key: string[]
- Optional schemaId: string[]
- Optional type: ("string" | "int" | "float" | "long" | "bool" | "json")[]
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<object>>