Options
All
  • Public
  • Public/Protected
  • All
Menu

Unblu Visitor JS API

Index

Type aliases

AgentAvailabilityChangeListener: (availability: AgentAvailabilityState) => void

Type declaration

AgentAvailableChangeListener: (isAvailable: boolean) => void

Type declaration

    • (isAvailable: boolean): void
    • Listener called whenever the agent availability changes.

      Parameters

      • isAvailable: boolean

        A boolean that indicates if an agent is available.

      Returns void

CallStateListener: (callState: CallState) => void

Type declaration

ConnectionStateListener: (connectionState: ConnectionState) => void

Type declaration

ConversationChangeListener: (conversation?: Conversation) => void

Type declaration

    • Listener called whenever the active conversation changes.

      Note: If no conversation is currently active the passed conversation object will be null

      Parameters

      • Optional conversation: Conversation

        API object for the active conversation or null if no conversation is active.

      Returns void

ConversationStateListener: (conversationState: ConversationState) => void

Type declaration

ConversationsChangeListener: (conversations: ConversationInfo[]) => void

Type declaration

    • Listener called whenever a conversation changed, added or removed from all conversations.

      Parameters

      Returns void

ErrorListener: (e: Error) => void

Type declaration

    • (e: Error): void
    • Parameters

      • e: Error

      Returns void

InvitationsListener: (invitations: Invitation[]) => void

Type declaration

NewConversationInterceptor: (conversationType: ConversationType, visitorData?: String, recipient?: ConversationRecipient) => Promise<String | NewConversationInterceptorResult>

Type declaration

NotificationCountChangeListener: (count: number) => void

Type declaration

    • (count: number): void
    • Listener called whenever the notification count of a person (i.e. unread messages) changes.

      Parameters

      • count: number

        The number of unseen notifications.

      Returns void

PersonActivityListener: (lastActivity: Number) => void

Type declaration

    • (lastActivity: Number): void
    • Listener called whenever there is activity by the person.

      Parameters

      • lastActivity: Number

        A UTC timestamp when the last activity happened.

      Returns void

PersonChangeListener: (person: PersonInfo) => void

Type declaration

    • Listener called whenever the local person changes.

      Parameters

      Returns void

ReadyListener: (api: UnbluApi) => void

Type declaration

UiStateChangeListener: (uistate: IndividualUiState) => void

Type declaration

Variables

unblu: Unblu = ...