Class Inbox

operatorPresence

user

all

• all(options): Promise<InboxChannel>

• Joins the inbox.all channel.

  On error, the promise reject reason may be either 'timeout', or a string indicating why it failed.

  This channel is only available for supervisors.

  Parameters

  • options: InboxChannelOptions

  Returns Promise<InboxChannel>

assigned

• assigned(options): Promise<InboxChannel>

• Joins the inbox.assigned channel.

  On error, the promise reject reason may be either 'timeout', or a string indicating why it failed.

  Parameters

  • options: InboxChannelOptions

  Returns Promise<InboxChannel>

automated

• automated(options): Promise<InboxChannel>

• Joins the inbox.automated channel.

  On error, the promise reject reason may be either 'timeout', or a string indicating why it failed.

  This channel is only available for supervisors.

  Parameters

  • options: InboxChannelOptions

  Returns Promise<InboxChannel>

closed

• closed(options): Promise<InboxChannel>

• Joins the inbox.closed channel.

  On error, the promise reject reason may be either 'timeout', or a string indicating why it failed.

  Parameters

  • options: InboxChannelOptions

  Returns Promise<InboxChannel>

destroy

• destroy(): void

• Destructor.

  Removes the iframe. Closes the websocket.

  The inbox object cannot be reused after this.

  Returns void

listInitiateableChannels

• listInitiateableChannels(): Promise<InitiatableChannel[]>

• Lists the channels on which a conversation can be started.

  Returns Promise<InitiatableChannel[]>

mine

• mine(options): Promise<InboxChannel>

• Joins the inbox.mine channel.

  This channel contains the conversations that were assigned to me.

  On error, the promise reject reason may be either 'timeout', or a string indicating why it failed.

  Parameters

  • options: InboxChannelOptions

  Returns Promise<InboxChannel>

navigateToConversation

• navigateToConversation(conversation, options?): Promise<void>

• Instructs the iframe to navigate to the given conversation.

  If there is no iframe on the page yet, it will be added.

  Parameters

  • conversation: Pick<Conversation, "id" | "botId">
  • Optional options: ConversationOptions

  Returns Promise<void>

new

• new(options): Promise<InboxChannel>

• Joins the inbox.new channel.

  On error, the promise reject reason may be either 'timeout', or a string indicating why it failed.

  Parameters

  • options: InboxChannelOptions

  Returns Promise<InboxChannel>

openFullInboxView

• openFullInboxView(options): Promise<void>

• Renders the full inbox (not just a conversation) in the iframe.

  If there is no iframe on the page yet, it will be added.

  Parameters

  • options: InboxViewOptions

  Returns Promise<void>

openNotesView

• openNotesView(options): Promise<void>

• Renders just the notes view in the iframe.

  If there is no iframe on the page yet, it will be added.

  Parameters

  • options: NotesViewOptions

  Returns Promise<void>

openTodayView

• openTodayView(options): Promise<void>

• Renders just the today view in the iframe.

  If there is no iframe on the page yet, it will be added.

  Parameters

  • options: TodayViewOptions

  Returns Promise<void>

removeIframe

• removeIframe(): void

• Remove the current iframe from page (if present).

  Calling navigateToConversation will add the iframe again.

  Returns void

startConversation

• startConversation(channel, userKey): Promise<Conversation>

• Starts a new conversation.

  Parameters:

  • channel: the channel as returned by listInitiateableChannels.
  • userKey: the identifier for the end user (e.g. phone number, email address) appropriate for the selected channel.

  Parameters

  • channel: InitiatableChannel
  • userKey: string

  Returns Promise<Conversation>

updateLanguageCode

• updateLanguageCode(languageCode): Promise<void>

• Updates the language code in the iframe.

  Parameters

  • languageCode: string

  Returns Promise<void>

watched

• watched(options): Promise<InboxChannel>

• Joins the inbox.watched channel.

  On error, the promise reject reason may be either 'timeout', or a string indicating why it failed.

  Parameters

  • options: InboxChannelOptions

  Returns Promise<InboxChannel>