setUserSetting method

Future<DynamiteResponse<SettingsSetUserSettingResponseApplicationJson, void>> setUserSetting({
  1. required SettingsSetUserSettingKey key,
  2. SettingsSetUserSettingValue? value,
  3. SettingsSetUserSettingApiVersion? apiVersion,
  4. bool? oCSAPIRequest,
})

Update user setting.

Returns a Future containing a DynamiteResponse with the status code, deserialized body and headers. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

  • key Key to update.
  • value New value for the key.
  • apiVersion Defaults to v1.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: User setting updated successfully
  • 400: Updating user setting is not possible

See:

  • setUserSettingRaw for an experimental operation that returns a DynamiteRawResponse that can be serialized.

Implementation

Future<_i1.DynamiteResponse<SettingsSetUserSettingResponseApplicationJson, void>> setUserSetting({
  required SettingsSetUserSettingKey key,
  SettingsSetUserSettingValue? value,
  SettingsSetUserSettingApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = setUserSettingRaw(
    key: key,
    value: value,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}