Class Thread

constructor

• new Thread(idOnExternalPlatform, websocketClient, messageEmitter, customer, customFields?, isAuthorizationEnabled?): Thread

• Parameters

  • idOnExternalPlatform: ThreadIdOnExternalPlatform

  • websocketClient: WebSocketClient

  • messageEmitter: IChatEventTarget

  • customer: null | Customer

  • customFields: CustomFieldsObject = {}

  • isAuthorizationEnabled: boolean = false

  Returns Thread

idOnExternalPlatform

archive

• archive(): Promise<true>

• Set thread as archived

  Returns Promise<true>

  Promise true

  Throws

  ArchiveThreadFailedError

  • This exception is thrown when the archive thread failed.

getMetadata

• getMetadata(): Promise<LoadThreadMetadataChatEvent>

• Get Thread Metadata

  Returns Promise<LoadThreadMetadataChatEvent>

  response otherwise throw an error response

  Throws

  GetMetadataFailedError

  • This exception is thrown when getting thread metadata failed.

keystroke

• keystroke(timeout?, onSendCallback?): void

• Send start and stop typing events. It sends stop typing event after the timeout. Repeated calls resets this timeout.

  Parameters

  • timeout: number = 1000

    The timeout in milliseconds.

  • Optional onSendCallback: (() => void)

    Callback to be called after the stop typing event is sent.

    • • (): void

      • Returns void

  Returns void

keystrokeForPreview

• keystrokeForPreview(currentText, timeout?): void

• Send typing event for message preview after the timeout.

  Parameters

  • currentText: string

    current text

  • timeout: number = 1250

    timeout in milliseconds

  Returns void

  void

lastMessageSeen

• lastMessageSeen(): Promise<ChatEventData>

• Mark all messages in the thread as seen

  Returns Promise<ChatEventData>

loadMoreMessages

• loadMoreMessages(): Promise<null | MoreMessagesLoadedEvent>

• Load previous messages

  Returns Promise<null | MoreMessagesLoadedEvent>

  Promise MoreMessagesLoadedEvent | null

  Throws

  LoadMoreMessagesFailedError

  • This exception is thrown when the attempt to load more messages fails.

onThreadEvent

• onThreadEvent(type, handler): RemoveListenerFunction

• Parameters

  • type: ChatEventType

  • handler: EventListenerFunction

  Returns RemoveListenerFunction

recover

• recover(): AbortablePromise<ThreadRecoveredData>

• Recover existing chat

  Returns AbortablePromise<ThreadRecoveredData>

  AbortablePromise

  Throws

  ThreadRecoverFailedError

  • This exception is thrown when the recover fails or the thread does not exist.

sendAttachments

• sendAttachments(files, options?): Promise<MessageSuccessEventData>

• Send attachment

  Raw function to send attachments

  Parameters

  • files: FileList

    An object of this type is returned by the files' property of the HTML element; this lets you access the list of files selected with the element.

  • options: SendMessageOptions = {}

    options

  Returns Promise<MessageSuccessEventData>

  Throws

  UploadAttachmentError

  • This exception is thrown when the file upload fails. The error.data contains information about allowed file size and types.

sendCustomFields

• sendCustomFields(): Promise<ChatEventData>

• Send current Custom Fields

  Returns Promise<ChatEventData>

sendMessage

• sendMessage(messageData): Promise<MessageSuccessEventData>

• Send message

  Parameters

  • messageData: SendMessageEventData

    message data

  Returns Promise<MessageSuccessEventData>

  Throws

  SendMessageFailedError

  • This exception is thrown when a message fails to send. The error contains (error.data) a response from the backend with details.

sendMessagePreview

• sendMessagePreview(text): Promise<void>

• Send message preview

  Parameters

  • text: string

    text

  Returns Promise<void>

sendOutboundMessage

• sendOutboundMessage(messageData): Promise<MessageSuccessEventData>

• Send Outbound Message

  Parameters

  • messageData: SendOutboundEventData

    message data

  Returns Promise<MessageSuccessEventData>

  Throws

  SendMessageFailedError

  • This exception is thrown when a message fails to send. The error contains (error.data) a response from the backend with details.

sendPostbackMessage

• sendPostbackMessage(postback, messageText, options?): Promise<MessageSuccessEventData>

• Send postback message

  Parameters

  • postback: string

    postback

  • messageText: string

    text of message

  • options: SendMessageOptions = {}

    options

  Returns Promise<MessageSuccessEventData>

sendTextMessage

• sendTextMessage(messageText, options?): Promise<MessageSuccessEventData>

• Send text message

  Parameters

  • messageText: string

    text of message

  • options: SendMessageOptions = {}

    options

  Returns Promise<MessageSuccessEventData>

sendTranscript

• sendTranscript(contactNumber, email): Promise<ChatEventData>

• Send conversation transcript to email

  Parameters

  • contactNumber: ContactNumber

  • email: string

  Returns Promise<ChatEventData>

setCustomField

• setCustomField(name, value): Promise<void>

• Set thread custom field

  Parameters

  • name: string

    custom field name

  • value: null | string

    custom field value

  Returns Promise<void>

setCustomFields

• setCustomFields(customFields): Promise<void>

• Set thread custom fields and send them

  Parameters

  • customFields: CustomFieldsObject

    custom fields object

  Returns Promise<void>

  Example

  { indentName: 'value' }
  Copy

setName

• setName(name): Promise<true>

• Set thread name

  Parameters

  • name: string

    New name of the Thread

  Returns Promise<true>

  Promise true

  Throws

  SetThreadNameFailedError

  • This exception is thrown when the set thread name failed.

stopTyping

• stopTyping(): void

• Manually send the stop typing event and clear the keystroke timeout.

  Returns void

stopTypingForPreview

• stopTypingForPreview(shouldSendPreview?): void

• Manually send the stop typing event for message preview and clear the keystroke timeout.

  Parameters

  • shouldSendPreview: boolean = true

    should send preview

  Returns void

  void