$setPreference_Request method

@experimental Request $setPreference_Request({ required String appId, required String configKey, required PreferencesSetPreferenceRequestApplicationJson $body, 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:

• 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 appId,
  required String configKey,
  required PreferencesSetPreferenceRequestApplicationJson $body,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, Object?>{};
  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 = _i6.UriTemplate('/ocs/v2.php/apps/provisioning_api/api/v1/config/users/{appId}/{configKey}')
      .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 = _i4.IterableExtension(_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 _i5.HeaderEncoder().convert(__oCSAPIRequest);

  _request.headers['Content-Type'] = 'application/json';
  _request.body = json.encode(
    _$jsonSerializers.serialize(
      $body,
      specifiedType: const FullType(PreferencesSetPreferenceRequestApplicationJson),
    ),
  );
  return _request;
}