Class SettingsApi

SettingsApi - object-oriented interface

Export

SettingsApi

Hierarchy

BaseAPI
- SettingsApi

Index

Constructors

Properties

axios basePath configuration

Methods

settingsControllerDelete settingsControllerGet settingsControllerGetOne settingsControllerSet

Constructors

constructor

new SettingsApi(configuration?, basePath?, axios?): SettingsApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns SettingsApi
Inherited from BaseAPI.constructor
- Defined in packages/lib-apiclient/src/generated/base.ts:52

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

settingsControllerDelete

settingsControllerDelete(key, gameServerId?, options?): Promise<AxiosResponse<APIOutput, any>>
Required permissions: MANAGE_SETTINGS
Parameters
- key: string
- OptionalgameServerId: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<APIOutput, any>>
Summary
Delete

Throws
Memberof
SettingsApi
- Defined in packages/lib-apiclient/src/generated/api.ts:19800

settingsControllerGet

settingsControllerGet(keys?, gameServerId?, options?): Promise<AxiosResponse<SettingsOutputArrayDTOAPI, any>>
Parameters
- Optionalkeys: SettingsControllerGetKeysEnum[]
- OptionalgameServerId: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<SettingsOutputArrayDTOAPI, any>>
Summary
Get

Throws
Memberof
SettingsApi
- Defined in packages/lib-apiclient/src/generated/api.ts:19815

settingsControllerGetOne

settingsControllerGetOne(key, gameServerId?, options?): Promise<AxiosResponse<SettingsOutputDTOAPI, any>>
Parameters
- key: string
- OptionalgameServerId: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<SettingsOutputDTOAPI, any>>
Summary
Get one

Throws
Memberof
SettingsApi
- Defined in packages/lib-apiclient/src/generated/api.ts:19834

settingsControllerSet

settingsControllerSet(key, settingsSetDTO?, options?): Promise<AxiosResponse<SettingsOutputDTOAPI, any>>
Required permissions: MANAGE_SETTINGS
Parameters
- key: string
- OptionalsettingsSetDTO: SettingsSetDTO
  SettingsSetDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<SettingsOutputDTOAPI, any>>
Summary
Set

Throws
Memberof
SettingsApi
- Defined in packages/lib-apiclient/src/generated/api.ts:19849