setPreferenceRaw method

  1. @experimental
DynamiteRawResponse<PreferencesSetPreferenceResponseApplicationJson, void> setPreferenceRaw({
  1. required String configValue,
  2. required String appId,
  3. required String configKey,
  4. bool? oCSAPIRequest,
})

Update a preference value of an app.

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:

  • 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:

Implementation

@experimental
DynamiteRawResponse<PreferencesSetPreferenceResponseApplicationJson, void> setPreferenceRaw({
  required String configValue,
  required String appId,
  required String configKey,
  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 $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;

  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/provisioning_api/api/v1/config/users/{appId}/{configKey}{?configValue*}')
          .expand(_parameters);
  return DynamiteRawResponse<PreferencesSetPreferenceResponseApplicationJson, void>(
    response: _rootClient.executeRequest(
      'post',
      _path,
      _headers,
      null,
      const {200, 400},
    ),
    bodyType: const FullType(PreferencesSetPreferenceResponseApplicationJson),
    headersType: null,
    serializers: jsonSerializers,
  );
}