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

closeConversation(): Promise<void>
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
- CLOSE fired after this call.
- endConversation for details on ending a conversation.
- leaveConversation for details on leaving a conversation.
- destroy for details on destroying a conversation.
- Defined in shared/conversation.ts:362

destroy

destroy(): void
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
- isDestroyed
- closeConversation for details on how to close a conversation
- endConversation for details on how to end a conversation
- Defined in shared/conversation.ts:404

endConversation

endConversation(): Promise<void>
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
- END fired after this call.
- closeConversation for details on closing a conversation.
- Defined in shared/conversation.ts:323

getCallState

getCallState(): Promise<CallState>
Returns Promise<CallState>
A promise that resolves to the current call state of the local user or is rejected with a UnbluApiError if the call fails.

See
CALL_STATE_CHANGE if you need to listen to changes.
- Defined in shared/conversation.ts:260

getConnectionState

getConnectionState(): Promise<ConnectionState>
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.
- Defined in shared/conversation.ts:240

getConversationId

getConversationId(): string
Returns the ID of this conversation.

Returns string
- Defined in shared/conversation.ts:222

getConversationState

getConversationState(): Promise<ConversationState>
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.
- Defined in shared/conversation.ts:250

getVisitorData

getVisitorData(): Promise<String>
Get the custom visitor data from the conversation.

Returns Promise<String>
The custom visitor data in the conversation
- Defined in shared/conversation.ts:281

isDestroyed

isDestroyed(): boolean
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
- destroy
- CLOSE
- Defined in shared/conversation.ts:380

leaveConversation

leaveConversation(): Promise<void>
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
- CLOSE fired after this call.
- closeConversation for details on closing a conversation without leaving.
- Defined in shared/conversation.ts:340

off

off(event, listener): boolean
Removes a previously registered listener.
Parameters
- event: ConversationEventType
  
  The event to unregister from.
- listener: Listener
  
  The listener to remove.
Returns boolean
- Defined in shared/conversation.ts:164

on

on(event, listener): void
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
- Defined in shared/conversation.ts:102
on(event, listener): void
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
- Defined in shared/conversation.ts:110
on(event, listener): void
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
- Defined in shared/conversation.ts:119
on(event, listener): void
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
- Defined in shared/conversation.ts:128
on(event, listener): void
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
- Defined in shared/conversation.ts:136
on(event, listener): void
Registers an event listener for the given event.
Parameters
- event: "customActionInvocation"
  
  The customActionInvocation event.
- listener: CustomActionInvocationListener
  
  The listener to be called.
Returns void

See
CUSTOM_ACTION_INVOCATION
- Defined in shared/conversation.ts:144

setVisitorData

setVisitorData(visitorData): Promise<void>
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>
- Defined in shared/conversation.ts:271

startAudioCall

startAudioCall(): Promise<void>
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.
- Defined in shared/conversation.ts:295

startVideoCall

startVideoCall(): Promise<void>
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.
- Defined in shared/conversation.ts:309

Events

`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.

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

CustomActionInvocationListener
on for listener registration

`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

Class Conversation

This class gives API access to the currently active conversation.

Hierarchy

Index

Methods

Events

Methods

closeConversation

Returns Promise<void>

See

destroy

Returns void

See

endConversation

Returns Promise<void>

See

getCallState

Returns Promise<CallState>

See

getConnectionState

Returns Promise<ConnectionState>

See

getConversationId

Returns string

getConversationState

Returns Promise<ConversationState>

getVisitorData

Returns Promise<String>

isDestroyed

Returns boolean

See

leaveConversation

Returns Promise<void>

See

off

Parameters

event: ConversationEventType

listener: Listener

Returns boolean

on

Parameters

event: "connectionStateChange"

listener: ConnectionStateListener

Returns void

See

Parameters

event: "conversationStateChange"

listener: ConversationStateListener

Returns void

See

Parameters

event: "callStateChange"

listener: CallStateListener

Returns void

See

Parameters

event: "end"

listener: (() => void)

Returns void

Returns void

Deprecated

See

Parameters

event: "close"

listener: (() => void)

Returns void

Returns void

See

Parameters

event: "customActionInvocation"

listener: CustomActionInvocationListener

Returns void

See

setVisitorData

Parameters

visitorData: String

Returns Promise<void>

startAudioCall

Returns Promise<void>

See

`Static` `Readonly` CALL_STATE_CHANGE

`Static` `Readonly` CLOSE

`Static` `Readonly` CONNECTION_STATE_CHANGE

`Static` `Readonly` CONVERSATION_STATE_CHANGE

`Static` `Readonly` CUSTOM_ACTION_INVOCATION

`Static` `Readonly` END