$setPreference_Request method

@experimental Request $setPreference_Request({ required String configValue, required String appId, required String configKey, bool? oCSAPIRequest, })

Update a preference value of an app.

Returns a DynamiteRequest backing the setPreference operation. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

• configValue New value.
• appId ID of the app.
• configKey Key of the preference.
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: Preference updated successfully
• 400: Preference invalid

See:

• setPreference for a method executing this request and parsing the response.
• $setPreference_Serializer for a converter to parse the Response from an executed this request.

Implementation

@_i2.experimental
_i3.Request $setPreference_Request({
  required String configValue,
  required String appId,
  required String configKey,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, Object?>{};
  final $configValue = _$jsonSerializers.serialize(configValue, specifiedType: const FullType(String));
  _parameters['configValue'] = $configValue;

  final $appId = _$jsonSerializers.serialize(appId, specifiedType: const FullType(String));
  _parameters['appId'] = $appId;

  final $configKey = _$jsonSerializers.serialize(configKey, specifiedType: const FullType(String));
  _parameters['configKey'] = $configKey;

  final _path =
      _i5.UriTemplate('/ocs/v2.php/apps/provisioning_api/api/v1/config/users/{appId}/{configKey}{?configValue*}')
          .expand(_parameters);
  final _uri = Uri.parse('${_rootClient.baseURL}$_path');
  final _request = _i3.Request('post', _uri);
  _request.headers['Accept'] = 'application/json';
// coverage:ignore-start
  final authentication = _rootClient.authentications?.firstWhereOrNull(
    (auth) => switch (auth) {
      _i1.DynamiteHttpBearerAuthentication() || _i1.DynamiteHttpBasicAuthentication() => true,
      _ => false,
    },
  );

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

// coverage:ignore-end
  var $oCSAPIRequest = _$jsonSerializers.serialize(oCSAPIRequest, specifiedType: const FullType(bool));
  $oCSAPIRequest ??= true;
  _request.headers['OCS-APIRequest'] = const _i4.HeaderEncoder().convert($oCSAPIRequest);

  return _request;
}