Class Customer

constructor

• new Customer(id?, name?, image?, websocketClient?): Customer

• Parameters

  • Optional id: CustomerIdentityIdOnExternalPlatform

  • Optional name: string

  • Optional image: string

  • Optional websocketClient: null | WebSocketClient

  Returns Customer

id

image

name

destroy

• destroy(): void

• Returns void

getCustomFields

• getCustomFields(): CustomFieldsObject

• Get Customer Custom fields (as object)

  Returns CustomFieldsObject

getCustomFieldsArray

• getCustomFieldsArray(): Id<Partial<Pick<{
      ident: string;
      value: null | string;
  }, never>> & RequiredProps<{
      ident: string;
      value: null | string;
  }>>[]

• Get Customer Custom fields (as array of CustomField)

  Returns Id<Partial<Pick<{
      ident: string;
      value: null | string;
  }, never>> & RequiredProps<{
      ident: string;
      value: null | string;
  }>>[]

getId

• getId(): null | CustomerIdentityIdOnExternalPlatform

• Returns null | CustomerIdentityIdOnExternalPlatform

getIdOrCreateNewOne

• getIdOrCreateNewOne(): CustomerIdentityIdOnExternalPlatform

• Returns CustomerIdentityIdOnExternalPlatform

getImage

• getImage(): null | string

• Returns null | string

getName

• getName(): null | string

• Returns null | string

sendCustomFields

• sendCustomFields(): Promise<ChatEventData>

• Send Customer Custom fields

  • call this only after the first message or recover event

  Returns Promise<ChatEventData>

  Promise

setCustomField

• setCustomField(name, value): undefined | Promise<ChatEventData>

• Set Customer Custom field

  Parameters

  • name: string

    Custom field name

  • value: null | string

    Custom field value

  Returns undefined | Promise<ChatEventData>

setCustomFields

• setCustomFields(customFields): undefined | Promise<ChatEventData>

• Set Customer Custom fields

  Parameters

  • customFields: CustomFieldsObject

    custom fields object

  Returns undefined | Promise<ChatEventData>

  Example

  setCustomFields({ identName: 'value', identName2: 'value2' })
  Copy

setCustomFieldsFromArray

• setCustomFieldsFromArray(customFields): void

• Set Customer Custom fields from an array of custom fields

  Parameters

  • customFields: Id<Partial<Pick<{
        ident: string;
        value: null | string;
    }, never>> & RequiredProps<{
        ident: string;
        value: null | string;
    }>>[]

    custom fields array

  Returns void

setExists

• setExists(exists): void

• Parameters

  • exists: boolean

  Returns void

setId

• setId(customerIdentityIdOnExternalPlatform): void

• Parameters

  • customerIdentityIdOnExternalPlatform: CustomerIdentityIdOnExternalPlatform

  Returns void

setImage

• setImage(image): void

• Parameters

  • image: string

  Returns void

setName

• setName(name): void

• Parameters

  • name: string

  Returns void

setWebsocketClient

• setWebsocketClient(websocketClient): void

• Parameters

  • websocketClient: WebSocketClient

  Returns void