setUserSettingRaw method

  1. @experimental
DynamiteRawResponse<SettingsSetUserSettingResponseApplicationJson, void> setUserSettingRaw({
  1. required SettingsSetUserSettingKey key,
  2. SettingsSetUserSettingValue? value,
  3. SettingsSetUserSettingApiVersion? apiVersion,
  4. bool? oCSAPIRequest,
})

Update user setting.

This method and the response it returns is experimental. The API might change without a major version bump.

Returns a Future containing a DynamiteRawResponse with the raw HttpClientResponse and serialization helpers. 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:

Implementation

@experimental
DynamiteRawResponse<SettingsSetUserSettingResponseApplicationJson, void> setUserSettingRaw({
  required SettingsSetUserSettingKey key,
  SettingsSetUserSettingValue? value,
  SettingsSetUserSettingApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, dynamic>{};
  final _headers = <String, String>{
    'Accept': 'application/json',
  };

// coverage:ignore-start
  final authentication = _rootClient.authentications.firstWhereOrNull(
    (auth) => switch (auth) {
      DynamiteHttpBearerAuthentication() || DynamiteHttpBasicAuthentication() => true,
      _ => false,
    },
  );

  if (authentication != null) {
    _headers.addAll(
      authentication.headers,
    );
  } else {
    throw Exception('Missing authentication for bearer_auth or basic_auth');
  }

// coverage:ignore-end
  final $key = jsonSerializers.serialize(key, specifiedType: const FullType(SettingsSetUserSettingKey));
  _parameters['key'] = $key;

  final $value = jsonSerializers.serialize(value, specifiedType: const FullType(SettingsSetUserSettingValue));
  _parameters['value'] = $value;

  var $apiVersion =
      jsonSerializers.serialize(apiVersion, specifiedType: const FullType(SettingsSetUserSettingApiVersion));
  $apiVersion ??= 'v1';
  _parameters['apiVersion'] = $apiVersion;

  var $oCSAPIRequest = jsonSerializers.serialize(oCSAPIRequest, specifiedType: const FullType(bool));
  $oCSAPIRequest ??= true;
  _headers['OCS-APIRequest'] = const dynamite_utils.HeaderEncoder().convert($oCSAPIRequest);

  final _path =
      UriTemplate('/ocs/v2.php/apps/spreed/api/{apiVersion}/settings/user{?key*,value*}').expand(_parameters);
  return DynamiteRawResponse<SettingsSetUserSettingResponseApplicationJson, void>(
    response: _rootClient.executeRequest(
      'post',
      _path,
      _headers,
      null,
      const {200, 400},
    ),
    bodyType: const FullType(SettingsSetUserSettingResponseApplicationJson),
    headersType: null,
    serializers: jsonSerializers,
  );
}