deletePreference method

Future<DynamiteResponse<PreferencesDeletePreferenceResponseApplicationJson, void>> deletePreference({
  1. required String appId,
  2. required String configKey,
  3. 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:

Implementation

Future<DynamiteResponse<PreferencesDeletePreferenceResponseApplicationJson, void>> deletePreference({
  required String appId,
  required String configKey,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = deletePreferenceRaw(
    appId: appId,
    configKey: configKey,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}