Skip to main content

@wildix/xbees-conversations-client > GetInboxStateCommand

GetInboxStateCommand class​

Retrieves the user's inbox state to track pinned, tagged, and unread markers.

Signature:

export declare class GetInboxStateCommand extends GetInboxStateCommand_base

Extends: GetInboxStateCommand_base

Example​

Use a bare-bones client and the command you need to make an API call.

import { ConversationsClient, GetInboxStateCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
// const { ConversationsClient, GetInboxStateCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
const client = new ConversationsClient(config);
const input = { // GetInboxStateInput
  userId: "STRING_VALUE",
};
const command = new GetInboxStateCommand(input);
const response = await client.send(command);
// { // GetInboxStateOutput
//   channels: { // InboxChannelsState
//     unread: [ // InboxUnreadChannelsList // required
//       { // InboxUnreadChannel
//         channelId: "STRING_VALUE", // required
//         unreadAt: "STRING_VALUE", // required
//         messageId: "STRING_VALUE",
//       },
//     ],
//     pinned: [ // InboxPinnedChannelsList // required
//       { // InboxPinnedChannel
//         channelId: "STRING_VALUE", // required
//         pinnedAt: "STRING_VALUE", // required
//       },
//     ],
//     tagged: [ // InboxTaggedChannelsList // required
//       { // InboxTaggedChannel
//         channelId: "STRING_VALUE", // required
//         tagId: "STRING_VALUE", // required
//       },
//     ],
//   },
//   tags: [ // InboxTagsList // required
//     { // InboxTag
//       id: "STRING_VALUE", // required
//       name: "STRING_VALUE", // required
//     },
//   ],
// };