clearChat method

Future<ChatEventsVersionedMixin?> clearChat(
  1. ChatId id,
  2. ChatItemId untilId
)

Clears an existing Chat (hides all its ChatItems) for the authenticated MyUser until the specified ChatItem inclusively.

Authentication

Mandatory.

Result

Only the following ChatEvent may be produced on success:

Idempotent

Succeeds as no-op (and returns no ChatEvent) if the specified Chat is already cleared until the specified ChatItem.

Implementation

Future<ChatEventsVersionedMixin?> clearChat(
  ChatId id,
  ChatItemId untilId,
) async {
  Log.debug('clearChat($id, $untilId)', '$runtimeType');

  final ClearChatArguments variables = ClearChatArguments(
    id: id,
    untilId: untilId,
  );
  final QueryResult result = await client.mutate(
    MutationOptions(
      operationName: 'ClearChat',
      document: ClearChatMutation(variables: variables).document,
      variables: variables.toJson(),
    ),
    onException:
        (data) => ClearChatException(
          (ClearChat$Mutation.fromJson(data).clearChat
                  as ClearChat$Mutation$ClearChat$ClearChatError)
              .code,
        ),
  );
  return ClearChat$Mutation.fromJson(result.data!).clearChat
      as ChatEventsVersionedMixin?;
}