deleteUserToken method

Future<void> deleteUserToken({
  1. required String userToken,
  2. RequestOptions? requestOptions,
})

Deletes all events related to the specified user token from events metrics and analytics. The deletion is asynchronous, and processed within 48 hours. To delete a personalization user profile, see Delete a user profile in the Personalization API.

Parameters:

  • userToken User token for which to delete all associated events.
  • requestOptions additional request configuration.

Implementation

Future<void> deleteUserToken({
  required String userToken,
  RequestOptions? requestOptions,
}) async {
  assert(
    userToken.isNotEmpty,
    'Parameter `userToken` is required when calling `deleteUserToken`.',
  );
  final request = ApiRequest(
    method: RequestMethod.delete,
    path: r'/1/usertokens/{userToken}'.replaceAll(
        '{' r'userToken' '}', Uri.encodeComponent(userToken.toString())),
  );
  await _retryStrategy.execute(
    request: request,
    options: requestOptions,
  );
}