Class ChatSdk

Hierarchy

ChatSdk

Constructors

constructor

new ChatSdk(options): ChatSdk
Parameters
- options: ChatSDKOptions
Returns ChatSdk

Properties

`Private` _contactCustomFieldsQueue

_contactCustomFieldsQueue: CustomFieldsMap = ...

`Private` _incomingChatEventMiddleware

_incomingChatEventMiddleware: ChatEventMiddleware = ...

`Private` _messageEmitter

_messageEmitter: IChatEventTarget

`Private` _threadCache

_threadCache: Map<ThreadIdOnExternalPlatform, Thread | LivechatThread> = ...

channelId

channelId: ChannelId = ''

`Private` customer

customer: null | Customer = null

`Private` isAuthorizationEnabled

isAuthorizationEnabled: boolean = false

isLivechat

isLivechat: boolean = false

`Optional` onError

onError?: ((error) => void)

Type declaration

- (error): void
- Parameters
  - error: Error
  Returns void

`Optional` onRawEvent

onRawEvent?: ((event) => void)

Type declaration

- (event): void
- Parameters
  - event: ChatCustomEvent<ChatEventData>
  Returns void

`Private` websocketClient

websocketClient: null | WebSocketClient = null

Methods

`Private` _getContactCustomFieldsFromQueue

_getContactCustomFieldsFromQueue(): CustomFieldsObject
Returns CustomFieldsObject

`Private` _initEnvironment

_initEnvironment(options): void
Setup Environment endpoints
Parameters
- options: ChatSDKOptions
Returns void

`Private` _initWS

_initWS(brandId, channelId, customerId): void
Parameters
- brandId: BrandId
- channelId: ChannelId
- customerId: CustomerIdentityIdOnExternalPlatform
Returns void

`Private` _sendRefreshTokenEvent

_sendRefreshTokenEvent(): Promise<void>
Returns Promise<void>

authorize

authorize(authorizationCode?, visitorId?): Promise<ConsumerAuthorizationSuccessPayloadData | CustomerReconnectSuccessPayloadData>
Send Authorization Event

Throws
AuthorizationError
- This exception is thrown when the authorization or refresh token fails
Parameters
- Optional authorizationCode: string
  
  authorization code
- Optional visitorId: string
  
  visitor id
Returns Promise<ConsumerAuthorizationSuccessPayloadData | CustomerReconnectSuccessPayloadData>

generateAuthorizationToken

generateAuthorizationToken(threadIdOnExternalPlatform, url): Promise<AuthorizationToken>
Generate Authorization Token from the given url
Parameters
- threadIdOnExternalPlatform: ThreadIdOnExternalPlatform
  
  Thread Id
- url: string
  
  Authorization Service URL
Returns Promise<AuthorizationToken>

getCustomer

getCustomer(): null | Customer
Get Customer instance

Returns null | Customer

getThread

getThread(id): Thread | LivechatThread
Get Thread instance by id
Parameters
- id: ThreadIdOnExternalPlatform
  
  thread id
Returns Thread | LivechatThread
instance of thread based on channel settings

getThreadList

getThreadList(): Promise<null | ThreadView[]>
Get list of available threads

Returns Promise<null | ThreadView[]>
list of threads

getWebsocketClient

getWebsocketClient(): null | WebSocketClient
Get access to a websocket connection

Returns null | WebSocketClient
WebSocketClient instance

onChatEvent

onChatEvent(type, handler): RemoveListenerFunction
Register handler to chat event
Parameters
- type: ChatEventType
  
  type of chat event
- handler: ((event) => void)
  
  event handler
  - - (event): void
    - Parameters
      
      event: ChatCustomEvent<ChatEventData>
      
      Returns void
Returns RemoveListenerFunction
function to unregister handler

onErrorHandler

onErrorHandler(error): void
Parameters
- error: unknown
Returns void

recoverLivechatThreadData

recoverLivechatThreadData(threadIdOnExternalPlatform?): AbortablePromise<ThreadRecoveredChatEvent>
Recover livechat thread data
Parameters
- threadIdOnExternalPlatform: undefined | ThreadIdOnExternalPlatform = undefined
  
  thread id on external platform
Returns AbortablePromise<ThreadRecoveredChatEvent>
thread livechat session data

recoverThreadData

recoverThreadData(threadIdOnExternalPlatform?): AbortablePromise<ThreadRecoveredChatEvent>
Recover thread data
Parameters
- threadIdOnExternalPlatform: undefined | ThreadIdOnExternalPlatform = undefined
  
  thread id on external platform
Returns AbortablePromise<ThreadRecoveredChatEvent>
thread session data

sendOfflineMessage

sendOfflineMessage(offlineMessageData): Promise<MessageSuccessEventData>
Send the Offline Message

Throws
SendMessageFailedError
- This exception is thrown when a message fails to send. The error contains (error.data) a response from the backend with details.
Parameters
- offlineMessageData: OfflineMessageData
  
  offline message data (name, email, message)
Returns Promise<MessageSuccessEventData>
success

Generated using TypeDoc