Class Conversation

This class gives API access to the currently active conversation.

As long as a conversation is active one can register and receive the events provided by this class and call the methods. Once the conversation is closed this API object will be destroyed and no more event callbacks will be called. Any subsequent calls will fail.

Use the CLOSE event to de-init any code connected to this conversation.

Hierarchy

  • Conversation

Methods

closeConversation destroy endConversation getCallConnectionState getCallState getConnectionState getConversationId getConversationState getQueueStatus getVisitorData isDestroyed leaveConversation off on setVisitorData startAudioCall startVideoCall

Events

CALL_CONNECTION_STATE_CHANGE CALL_STATE_CHANGE CLOSE CONNECTION_STATE_CHANGE CONVERSATION_STATE_CHANGE CUSTOM_ACTION_INVOCATION END QUEUE_STATUS_CHANGE

Methods

closeConversation

  • Closes this conversation locally.

    When called, the connection to this conversation is closed and the overview is displayed.

    Note that:

    • Closing does NOT end the conversation.
    • The person does NOT leave the conversation.
    • All Conversation api instances for this conversation will be destroyed.

    The conversation can be joined again either via the UI or using UnbluApi.openConversation.

    Returns Promise<void>

    A Promise that resolves to null or is rejected with a UnbluApiError if the call fails.

    See

destroy

  • Destroys this conversation API instance.

    Calling destroy will unregister all event listeners and prohibit any further calls to this object. Once the conversation is destroyed, any subsequent calls will reject the returned promise with UnbluErrorType.ILLEGAL_STATE as the reason.

    Note that:

    • Destroying does NOT close the conversation .
    • Destroying does NOT end the conversation.
    • Destroying does NOT leave the conversation.
    • Other instances of the same Conversation will NOT be destroyed.

    This call simply destroys this local API instance to the conversation.

    A destroyed but still open conversation can be accessed again using UnbluApi.getActiveConversation.

    Returns void

    See

endConversation

  • Ends and closes this conversation.

    If the local person doesn't have the right to end the conversation, the returned promise will be rejected with the unblu error type UnbluErrorType.ACTION_NOT_GRANTED.

    Returns Promise<void>

    A Promise that resolves to null or is rejected with a UnbluApiError if the call fails.

    See

getCallConnectionState

  • Gets the call connection state for the current active call of the local participant. Check CallConnectionState for possible states.

    Returns Promise<CallConnectionState>

    A promise that resolves to the current call connection state of the conversation or is rejected with a UnbluApiError if the call fails. The promise resolves to CallConnectionState.DISCONNECTED if there's no active call.

    See

    CALL_CONNECTION_STATE_CHANGE if you need to listen to changes.

getCallState

  • Gets the conversation's call state the local participant has, check CallState for possible states.

    Returns Promise<CallState>

    A promise that resolves to the current call state of the local participant

    See

    CALL_STATE_CHANGE if you need to listen to changes

getConnectionState

  • Returns the current connection state the conversation is in.

    If the connection is lost, the conversation will automatically try to reconnect using an exponential back-off strategy. If a fatal error is detected, the state will change to ConnectionState.ERROR.

    If this happens, the conversation is in it's terminal state. A dialog or other UI will be displayed to the user with details on the failure. The conversation is not automatically closed in this case. It may either be closed through a manual action by the visitor (confirming the error) or via the API.

    Returns Promise<ConnectionState>

    A promise that resolves to the current connection state of the conversation or is rejected with a UnbluApiError if the call fails.

    See

    CONNECTION_STATE_CHANGE if you need to listen to changes.

getConversationId

  • Returns the ID of this conversation.

    Returns string

getConversationState

  • Returns the current state the conversation is in.

    Returns Promise<ConversationState>

    A promise that resolves to the current state of the conversation or is rejected with a UnbluApiError if the call fails.

getQueueStatus

  • Gets the conversation's queue status. The position and/or averageWaitingTime of the return value can be null, if the feature is disabled for them in the configuration.

    Returns Promise<ConversationQueueStatus>

    A promise that either resolves to the current queue status of the conversation or resolves empty if the conversation isn't queued. The promise is rejected with a UnbluApiError if the call fails.

    See

    QUEUE_STATUS_CHANGE if you need to listen to changes.

getVisitorData

  • Get the custom visitor data from the conversation.

    Returns Promise<String>

    The custom visitor data in the conversation

isDestroyed

  • Returns weather this conversation is destroyed or not.

    Conversations are destroyed if destroy is called or the conversation is closed. This usually happens when the user navigates back to an overview or into an other conversation.

    Returns boolean

    Weather this conversation is destroyed or not.

    See

leaveConversation

  • Leaves and closes this conversation.

    By leaving, the visitor is removed from the active participant list of the conversation. Once a conversation is left, the visitor can not re-open it. It will not be visible in the conversation history either.

    If the local person doesn't have the right to leave the conversation, the returned promise will be rejected with the unblu error type UnbluErrorType.ACTION_NOT_GRANTED.

    Returns Promise<void>

    A Promise that resolves to null or is rejected with a UnbluApiError if the call fails.

    See

off

  • Removes a previously registered listener.

    Parameters

    • event: ConversationEventType

      The event to unregister from.

    • listener: Listener

      The listener to remove.

    Returns boolean

on

  • Registers an event listener for the given event.

    Parameters

    • event: "connectionStateChange"

      The call state change event.

    • listener: ConnectionStateListener

      The listener to be called.

    Returns void

    See

    CONNECTION_STATE_CHANGE

  • Registers an event listener for the given event.

    Parameters

    • event: "conversationStateChange"

      The conversation state change event.

    • listener: ConversationStateListener

      The listener to be called.

    Returns void

    See

    CONVERSATION_STATE_CHANGE

  • Registers an event listener for the given event.

    Parameters

    • event: "callStateChange"

      The call state change event.

    • listener: CallStateListener

      The listener to be called.

    Returns void

    See

    CALL_STATE_CHANGE

  • Registers an event listener for the given event

    Parameters

    • event: "queueStatusChange"

      The call state change event

    • listener: QueueStatusChangeListener

      The listener to be called

    Returns void

    See

    QUEUE_STATUS_CHANGE

  • Registers an event listener for the given event

    Parameters

    • event: "callConnectionStateChange"

      The call connection state change event

    • listener: CallConnectionStateChangeListener

      The listener to be called

    Returns void

    See

    CALL_CONNECTION_STATE_CHANGE

  • Registers an event listener for the given event.

    Parameters

    • event: "end"

      The end event.

    • listener: (() => void)

      The listener to be called.

        • (): void

        • Returns void

    Returns void

    Deprecated

    The end event is not always available, depending on the configuration. Use instead CONVERSATION_STATE_CHANGE event.

    See

    END

  • Registers an event listener for the given event.

    Parameters

    • event: "close"

      The close event.

    • listener: (() => void)

      The listener to be called.

        • (): void

        • Returns void

    Returns void

    See

    CLOSE

  • Registers an event listener for the given event.

    Parameters

    Returns void

    See

    CUSTOM_ACTION_INVOCATION

setVisitorData

  • Set custom visitor data on the conversation. Don't use for confidential information. Security-related data should be stored in the conversation metadata.

    Parameters

    • visitorData: String

      Custom data for the visitor in any format.

    Returns Promise<void>

startAudioCall

  • Starts a voice call in this conversation.

    • If a call is already active, this call will be ignored.
    • If the local person doesn't have the right to start a voice call, the returned promise will be rejected with the unblu error type UnbluErrorType.ACTION_NOT_GRANTED.

    Returns Promise<void>

    A Promise that resolves to null or is rejected with a UnbluApiError if the call fails.

    See

    CALL_STATE_CHANGE If you need to listen to changes.

startVideoCall

  • Starts a video call in this conversation.

    • If a call is already active, this call will be ignored.
    • If the local person doesn't have the right to start a video call, the returned promise will be rejected with the unblu error type UnbluErrorType.ACTION_NOT_GRANTED.

    Returns Promise<void>

    A Promise that resolves to null or is rejected with a UnbluApiError if the call fails.

    See

    CALL_STATE_CHANGE If you need to listen to changes.

Events

Static Readonly CALL_CONNECTION_STATE_CHANGE

CALL_CONNECTION_STATE_CHANGE: "callConnectionStateChange" = 'callConnectionStateChange'

Event emitted when the CallConnectionState of the conversation changes callConnectionStateChange

See

on for listener registration

Static Readonly CALL_STATE_CHANGE

CALL_STATE_CHANGE: "callStateChange" = 'callStateChange'

Event emitted when the CallState of this conversation changes. callStateChange

See

on for listener registration

Static Readonly CLOSE

CLOSE: "close" = 'close'

Event emitted when the conversation is closed.

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

close

See

on for listener registration

Static Readonly CONNECTION_STATE_CHANGE

CONNECTION_STATE_CHANGE: "connectionStateChange" = 'connectionStateChange'

Event emitted when the ConnectionState of this conversation changes. connectionStateChange

See

on for listener registration

Static Readonly CONVERSATION_STATE_CHANGE

CONVERSATION_STATE_CHANGE: "conversationStateChange" = 'conversationStateChange'

Event emitted when the ConversationState of this conversation changes. conversationStateChange

See

on for listener registration

Static Readonly CUSTOM_ACTION_INVOCATION

CUSTOM_ACTION_INVOCATION: "customActionInvocation" = 'customActionInvocation'

Event emitted every time a custom action is configured to trigger a JS API event for the current client when a custom action is invoked

customActionInvocation

See

Static Readonly END

END: "end" = 'end'

Event emitted when the conversation ends.

Deprecated

The end event is not always available, depending on the configuration. Use the CONVERSATION_STATE_CHANGE event instead. end

See

on for listener registration

Static Readonly QUEUE_STATUS_CHANGE

QUEUE_STATUS_CHANGE: "queueStatusChange" = 'queueStatusChange'

Event emitted when the queue status of this conversation changes. queueStatusChange

See

on for listener registration

Settings

Member Visibility

Theme

On This Page