setPreference method

Future<DynamiteResponse<PreferencesSetPreferenceResponseApplicationJson, void>> setPreference({
  1. required String appId,
  2. required String configKey,
  3. required PreferencesSetPreferenceRequestApplicationJson $body,
  4. bool? oCSAPIRequest,
})

Update a preference value of an app.

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:

  • 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

Future<_i1.DynamiteResponse<PreferencesSetPreferenceResponseApplicationJson, void>> setPreference({
  required String appId,
  required String configKey,
  required PreferencesSetPreferenceRequestApplicationJson $body,
  bool? oCSAPIRequest,
}) async {
  final _request = $setPreference_Request(
    appId: appId,
    configKey: configKey,
    oCSAPIRequest: oCSAPIRequest,
    $body: $body,
  );
  final _streamedResponse = await _rootClient.httpClient.send(_request);
  final _response = await _i3.Response.fromStream(_streamedResponse);

  final _serializer = $setPreference_Serializer();
  return _i1.ResponseConverter<PreferencesSetPreferenceResponseApplicationJson, void>(_serializer).convert(_response);
}