favoriteChat method

Future<ChatEventsVersionedMixin?> favoriteChat(
  1. ChatId id,
  2. ChatFavoritePosition position
)

Marks the specified Chat as favorited for the authenticated MyUser and sets its position in the favorites list.

To move the Chat to a concrete position in a favorites list, provide the average value of two other Chats positions surrounding it.

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 favorited at the same position.

Implementation

Future<ChatEventsVersionedMixin?> favoriteChat(
  ChatId id,
  ChatFavoritePosition position,
) async {
  Log.debug('favoriteChat($id, $position)', '$runtimeType');

  final variables = FavoriteChatArguments(id: id, pos: position);
  final QueryResult result = await client.mutate(
    MutationOptions(
      operationName: 'FavoriteChat',
      document: FavoriteChatMutation(variables: variables).document,
      variables: variables.toJson(),
    ),
    onException:
        (data) => FavoriteChatException(
          (FavoriteChat$Mutation.fromJson(data).favoriteChat
                  as FavoriteChat$Mutation$FavoriteChat$FavoriteChatError)
              .code,
        ),
  );
  return FavoriteChat$Mutation.fromJson(result.data!).favoriteChat
      as ChatEventsVersionedMixin?;
}