clearHistory method

Future<DynamiteResponse<ChatClearHistoryResponseApplicationJson, ChatChatClearHistoryHeaders>> clearHistory({
  1. required String token,
  2. ChatClearHistoryApiVersion? apiVersion,
  3. bool? oCSAPIRequest,
})

Clear the chat history.

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:

  • apiVersion Defaults to v1.
  • token
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: History cleared successfully
  • 202: History cleared successfully, but Matterbridge is configured, so the information can be replicated elsewhere
  • 403: Missing permissions to clear history

See:

Implementation

Future<DynamiteResponse<ChatClearHistoryResponseApplicationJson, ChatChatClearHistoryHeaders>> clearHistory({
  required String token,
  ChatClearHistoryApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = clearHistoryRaw(
    token: token,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}