Options
All
  • Public
  • Public/Protected
  • All
Menu

There is only ever one instance of this api which can be retrieved via unblu.api.initialize(), see UnbluStaticApi for more details on configuring and initializing the UnbluApi.

The API connects to the integrated version of Unblu. All actions performed via the UnbluApi are executed in the name of and with the rights of current visitor and may have direct effect on the displayed Unblu UI.

For example if a conversation is started from the UnbluApi, the Unblu UI will navigate to it. If a conversation is closed via the API, it will also be closed on the Unblu UI of the visitor. For more information on UI side effects please check the documentation for each method call.

For programmatic administrator access and configuration of Unblu please use the Unblu WebAPI.

Hierarchy

  • UnbluApi

Implements

  • InitializedUnbluApi

Index

Events

ACTIVE_CONVERSATION_CHANGE: "activeConversationChange" = 'activeConversationChange'

Event emitted every time the active conversation changes.

This may happen due to a UI-navigation or an API-call.

see

on for listener registration

see

ConversationChangeListener

AGENT_AVAILABILITY_CHANGE: "availabilityChange" = 'availabilityChange'

Event emitted every time the agent availability state changes for the current named area and locale.

see

on for listener registration

see

AgentAvailabilityChangeListener

AGENT_AVAILABLE_CHANGE: "availableChange" = 'availableChange'

Event emitted every time the agent availability changes for the current named area and locale.

see

on for listener registration

see

AgentAvailableChangeListener

CONVERSATIONS_CHANGE: "conversationsChange" = 'conversationsChange'

Event emitted every time one of the conversations accessible to the current user changes or one is added or removed.

see

on for listener registration

see

ConversationsChangeListener

DEINITIALIZED: "deinitialized" = 'deinitialized'

Event emitted when this instance got de-initialized and has to be initialized again.

see

on for listener registration

see

[[DeinitializationListener]]

DEINITIALIZING: "deinitializing" = 'deinitializing'

Event emitted when this instance gets de-initialized and is not usable at the time until it fully got de-initialized.

see

on for listener registration

see

[[DeinitializationListener]]

NOTIFICATION_COUNT_CHANGE: "notificationCountChange" = 'notificationCountChange'

Event emitted every time the notification count (unread messages) changes.

see

on for listener registration

see

NotificationCountChangeListener

PERSON_ACTIVITY: "personActivity" = 'personActivity'

Event emitted every time the local person has some activity inside Unblu. This may be i.e. an interaction with the chat, a call, opening a conversation or interacting with a co-browsing layer.

The event can be used to reset the logout timer inside an authenticated area, for example.

The configuration property com.unblu.conversation.activity.activityCategoriesToTrack specifies which categories of activity trigger the event.

see

on for listener registration

see

PersonActivityListener

PERSON_CHANGE: "personChange" = 'personChange'

Event emitted every time the local person changes. This may be i.e. due to the person setting its name.

see

on for listener registration

see

PersonChangeListener

Properties

Access the UI functionality over the UI property.

Methods

  • deinitialize(): Promise<void>
  • De-initializes the API. It will destroy the UI, all connections and will release all resources (as far as it is technically possible).

    Afterwards the API can be initialized again via window.unblu.api.initialize()

    Returns Promise<void>

  • Returns the currently active conversation or null if no conversation is active.

    NOTE: calling this method twice while the same conversation is active, will result in two individual conversation API instances being returned. destroying one of them will not cause the other one to also be destroyed. If however the active conversation is closed, all returned Conversation instances will be destroyed.

    see

    ACTIVE_CONVERSATION_CHANGE

    Returns Promise<Conversation>

    A promise that either resolves to the currently active conversation or null if no conversation is open.

  • Returns the current availability state for the current named area and language.

    see

    isAgentAvailable for a simpler check.

    Returns Promise<AgentAvailabilityState>

    Promise that resolves to the current availability state.

  • Returns all conversations of the current visitor. If no conversation is present, an empty array is returned.

    Returns Promise<ConversationInfo[]>

    A promise that resolves to an array of ConversationInfo.

  • getNotificationCount(): Promise<number>
  • Returns the number of unread messages.

    Returns Promise<number>

    A promise that resolves to the current number of unread messages.

  • Returns information about the visitor.

    Returns Promise<PersonInfo>

    A promise that resolves to the current visitors person info.

  • isAgentAvailable(): Promise<boolean>
  • Checks if an agent is available for the current named area and language.

    see

    getAgentAvailabilityState for a more detailed check.

    Returns Promise<boolean>

    Promise that resolves to true if the availability state is AVAILABLE or BUSY, false otherwise.

  • isDeinitialized(): Boolean
  • Returns Boolean

  • joinConversation(pin: string, visitorName?: string): Promise<Conversation>
  • Joins an existing conversation with a given PIN.

    NOTE: calling this method will NOT automatically open the Unblu UI if it is collapsed. Use ui.openIndividualUi() if this is needed.

    Parameters

    • pin: string

      The PIN retrieved from the Unblu Agent Desk.

    • Optional visitorName: string

      The name the local visitor should have. This is only taken into account if the visitor is not already authenticated.

    Returns Promise<Conversation>

    A promise that resolves to the conversation object giving API access to the joined conversation.

  • off(event: GeneralEventType | AgentAvailabilityEventType | MetaEventType, listener: Listener): boolean
  • Removes a previously registered listener

    Parameters

    • event: GeneralEventType | AgentAvailabilityEventType | MetaEventType

      The event to unregister from.

    • listener: Listener

      The listener to remove.

    Returns boolean

  • Registers an event listener for the given event.

    see

    ACTIVE_CONVERSATION_CHANGE

    Parameters

    • event: "activeConversationChange"

      The activeConversationChange event.

    • listener: ConversationChangeListener

      The listener to be called.

    Returns void

  • Registers an event listener for the given event.

    see

    CONVERSATIONS_CHANGE

    Parameters

    Returns void

  • Registers an event listener for the given event.

    see

    NOTIFICATION_COUNT_CHANGE

    Parameters

    Returns void

  • Registers an event listener for the given event.

    see

    PERSON_CHANGE

    Parameters

    • event: "personChange"

      The personChange event.

    • listener: PersonChangeListener

      The listener to be called.

    Returns void

  • Registers an event listener for the given event.

    see

    PERSON_ACTIVITY

    Parameters

    • event: "personActivity"

      The personActivity event.

    • listener: PersonActivityListener

      The listener to be called.

    Returns void

  • Registers an event listener for the given event.

    see

    AGENT_AVAILABLE_CHANGE

    Parameters

    Returns void

  • Registers an event listener for the given event.

    see

    AGENT_AVAILABILITY_CHANGE

    Parameters

    Returns void

  • Registers an event listener for the given event.

    see

    DEINITIALIZED

    Parameters

    • event: "deinitializing"

      The deinitializing event.

    • listener: DeinitializationListener

      The listener to be called.

    Returns void

  • Registers an event listener for the given event.

    see

    DEINITIALIZED

    Parameters

    • event: "deinitialized"

      The deinitialized event.

    • listener: DeinitializationListener

      The listener to be called.

    Returns void

  • openConversation(conversationId: string): Promise<Conversation>
  • Opens the existing conversation with the given conversation ID.

    NOTE: calling this method will NOT automatically open the Unblu UI if it is collapsed. Use ui.openIndividualUi() if this is needed.

    Parameters

    • conversationId: string

      The id of the conversation to be opened.

    Returns Promise<Conversation>

    A promise that resolves to the conversation object giving API access to the opened conversation.

  • Set a custom interceptor which will be triggered when a new conversation is started (initiated from UI or JavaScript).

    Parameters

    Returns Promise<void>

    A promise that resolves when the interceptor is successfully applied and active.

  • setPersonNickname(nickname: string): Promise<void>
  • Set the nickname of the current visitor. This could be set before or during a conversation.

    Parameters

    • nickname: string

    Returns Promise<void>

    A empty promise when operation is done.

  • startConversation(type: ConversationType, visitorName?: string, visitorData?: string, recipient?: ConversationRecipient): Promise<Conversation>
  • Starts a new Conversation and places it into the inbound conversation queue.

    Starting a new conversation involves an agent availability check. For ConversationType.OFFLINE_CHAT_REQUEST conversations, the check proceeds as follows:

    • If an agent is available, the conversation type will be changed to ConversationType.CHAT_REQUEST.
    • If no agents are available, it will start an offline conversation provided offline chat requests are enabled in the Unblu server's configuration.
    • if offline chat requests aren't enabled, the request will be rejected.

    For all online conversation types, the check works as follows:

    • If an agent is available, the conversation will be started.
    • If no agents are available, the request will be rejected.

    You should therefore always check agent availability before starting a new conversation. If no agents are available, only start conversations of the type ConversationType.OFFLINE_CHAT_REQUEST.

    NOTE: calling this method will NOT automatically open the Unblu UI if it is collapsed. Use ui.openIndividualUi() if this is needed.

    Parameters

    • type: ConversationType

      The conversation type that shall be started.

    • Optional visitorName: string

      The name the local visitor should have. This is only taken into account if the visitor is not already authenticated.

    • Optional visitorData: string

      Custom data for the visitor in any format. NOTE: The data which is passed here could be used in NewConversationCallback

    • Optional recipient: ConversationRecipient

      The team or agent recipient of the conversation. This will overwrite any named area that might be set for this web page. NOTE: The data which is passed here could be used in NewConversationCallback

    Returns Promise<Conversation>

    A promise that resolves to the conversation object giving API access to the started conversation.