removeChatMember method

Future<ChatEventsVersionedMixin?> removeChatMember(
  1. ChatId chatId,
  2. UserId userId
)

Removes an User from a Chat-group by the authority of the authenticated MyUser.

Authentication

Mandatory.

Result

Only the following ChatEvent may be produced on success:

Idempotent

Succeeds as no-op (and returns no ChatEvent) if the specified User is not a member of the specified Chat already.

Implementation

Future<ChatEventsVersionedMixin?> removeChatMember(
  ChatId chatId,
  UserId userId,
) async {
  Log.debug('removeChatMember($chatId, $userId)', '$runtimeType');

  RemoveChatMemberArguments variables = RemoveChatMemberArguments(
    chatId: chatId,
    userId: userId,
  );
  var result = await client.mutate(
    MutationOptions(
      operationName: 'RemoveChatMember',
      document: RemoveChatMemberMutation(variables: variables).document,
      variables: variables.toJson(),
    ),
    onException:
        (data) => RemoveChatMemberException(
          (RemoveChatMember$Mutation.fromJson(data).removeChatMember
                  as RemoveChatMember$Mutation$RemoveChatMember$RemoveChatMemberError)
              .code,
        ),
  );
  return (RemoveChatMember$Mutation.fromJson(result.data!).removeChatMember
      as ChatEventsVersionedMixin?);
}