Function SettingsApiFactory

Returns {
    settingsControllerDelete(key: string, gameServerId?: string, options?: RawAxiosRequestConfig): AxiosPromise<APIOutput>;
    settingsControllerGet(keys?: SettingsControllerGetKeysEnum[], gameServerId?: string, options?: RawAxiosRequestConfig): AxiosPromise<SettingsOutputArrayDTOAPI>;
    settingsControllerGetOne(key: string, gameServerId?: string, options?: RawAxiosRequestConfig): AxiosPromise<SettingsOutputDTOAPI>;
    settingsControllerSet(key: string, settingsSetDTO?: SettingsSetDTO, options?: RawAxiosRequestConfig): AxiosPromise<SettingsOutputDTOAPI>;
}

• settingsControllerDelete:function

  • settingsControllerDelete(key, gameServerId?, options?): AxiosPromise<APIOutput>

  • Required permissions: MANAGE_SETTINGS

    Parameters

    • key: string
    • OptionalgameServerId: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<APIOutput>

    Summary

    Delete

    Throws

• settingsControllerGet:function

  • settingsControllerGet(keys?, gameServerId?, options?): AxiosPromise<SettingsOutputArrayDTOAPI>

  • Parameters

    • Optionalkeys: SettingsControllerGetKeysEnum[]
    • OptionalgameServerId: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<SettingsOutputArrayDTOAPI>

    Summary

    Get

    Throws

• settingsControllerGetOne:function

  • settingsControllerGetOne(key, gameServerId?, options?): AxiosPromise<SettingsOutputDTOAPI>

  • Parameters

    • key: string
    • OptionalgameServerId: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<SettingsOutputDTOAPI>

    Summary

    Get one

    Throws

• settingsControllerSet:function

  • settingsControllerSet(key, settingsSetDTO?, options?): AxiosPromise<SettingsOutputDTOAPI>

  • Required permissions: MANAGE_SETTINGS

    Parameters

    • key: string
    • OptionalsettingsSetDTO: SettingsSetDTO

      SettingsSetDTO
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<SettingsOutputDTOAPI>

    Summary

    Set

    Throws