Class UnbluInboxApi

constructor

• new UnbluInboxApi(
      inboxModule: InboxModule,
      apiStateProvider: ApiStateProvider,
  ): UnbluInboxApi

  Parameters

  • inboxModule: InboxModule
  • apiStateProvider: ApiStateProvider

  Returns UnbluInboxApi

getConversations

• getConversations(): Promise<ConversationInfo[]>

  Returns the conversations in the inbox.

  It includes all conversations independent of the tabs inside the inbox.

  Returns Promise<ConversationInfo[]>

  The conversations in the inbox

  Throws

  UnbluApiError with type UnbluErrorType.ILLEGAL_STATE when the API instance is deinitialized.

getMetadata

• getMetadata(conversationId: string): Promise<Metadata>

  Get the metadata of the conversation. Metadata access to the conversation has to be allowed via configuration of the conversation.

  Parameters

  • conversationId: string

    The ID of the conversation for which the metadata should be retrieved

  Returns Promise<Metadata>

  The conversation metadata

  Throws

  UnbluApiError with type UnbluErrorType.ILLEGAL_STATE when the API instance is deinitialized.

  Throws

  UnbluApiError with type UnbluErrorType.ACTION_NOT_GRANTED when there is no permission to access the metadata.

off

• off(event: InboxEventType, listener: (data?: any) => void): Promise<boolean>

  Removes a previously registered listener

  Parameters

  • event: InboxEventType

    The event to unregister from.

  • listener: (data?: any) => void

    The listener to remove.

  Returns Promise<boolean>

  Throws

  UnbluApiError with type UnbluErrorType.ILLEGAL_STATE when the API instance is deinitialized.

on

• on(
      event: "conversationsChanged",
      listener: InboxConversationsChangedListener,
  ): void

  Registers an event listener for the given event.

  Parameters

  • event: "conversationsChanged"

    The conversationsChanged event.

  • listener: InboxConversationsChangedListener

    The listener to be called.

  Returns void

  See

  UnbluInboxApi.CONVERSATIONS_CHANGED

  Throws

  UnbluApiError with type UnbluErrorType.ILLEGAL_STATE when the API instance is deinitialized.

• on(event: "conversationAdded", listener: InboxConversationAddedListener): void

  Registers an event listener for the given event.

  Parameters

  • event: "conversationAdded"

    The conversationAdded event.

  • listener: InboxConversationAddedListener

    The listener to be called.

  Returns void

  See

  UnbluInboxApi.CONVERSATION_ADDED

  Throws

  UnbluApiError with type UnbluErrorType.ILLEGAL_STATE when the API instance is deinitialized.

• on(
      event: "conversationRemoved",
      listener: InboxConversationRemovedListener,
  ): void

  Registers an event listener for the given event.

  Parameters

  • event: "conversationRemoved"

    The conversationRemoved event.

  • listener: InboxConversationRemovedListener

    The listener to be called.

  Returns void

  See

  UnbluInboxApi.CONVERSATION_REMOVED

  Throws

  UnbluApiError with type UnbluErrorType.ILLEGAL_STATE when the API instance is deinitialized.

Static ReadonlyCONVERSATION_ADDED

Static ReadonlyCONVERSATION_REMOVED

Static ReadonlyCONVERSATIONS_CHANGED