deletePreference method

Future<DynamiteResponse<PreferencesDeletePreferenceResponseApplicationJson, void>> deletePreference({ required String appId, required String configKey, bool? oCSAPIRequest, })

Delete a preference for 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 to delete.
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: Preference deleted successfully
• 400: Preference invalid

See:

• $deletePreference_Request for the request send by this method.
• $deletePreference_Serializer for a converter to parse the Response from an executed request.

Implementation

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

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