listInbox method

  1. @override
Future<InboxPage> listInbox({
  1. required int limit,
  2. String? cursor,
  3. required bool archived,
})
override

Loads one cursor page of the connected user's inbox: conversations with their latest-message preview, unread count and the caller's read state, ordered by activity time then conversation id, both descending.

limit is 1..100. Pass the previous page's nextCursor as cursor for the next page and null for the head. Reject a malformed cursor with a ConvoKitException whose statusCode is 400 (code INVALID_CURSOR). A ConvoKitException with statusCode 404 means the endpoint does not exist on the backend; the list controller then falls back to getConversations without previews for the rest of its session.

Implementation

@override
Future<InboxPage> listInbox({
  required int limit,
  String? cursor,
  required bool archived,
}) => ConvoKit.listInbox(limit: limit, cursor: cursor, archived: archived);