Class Customer

Hierarchy

Customer

Index

Constructors

Methods

getCustomFields getCustomFieldsArray getId getName sendCustomFields setCustomField setCustomFields setCustomFieldsFromArray setExists setImage setName getId getIdOrCreateNewOne getImage getName setId setImage setName

Constructors

constructor

new Customer(id, name, image, websocketClient): Customer
Parameters
- id: CustomerIdentityIdOnExternalPlatform
- name: undefined | string
- image: undefined | string
- websocketClient: null | WebSocketClient
Returns Customer

Methods

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(): CustomerIdentityIdOnExternalPlatform
Returns CustomerIdentityIdOnExternalPlatform

getName

getName(): undefined | string
Returns undefined | 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

Example
```
setCustomFields({ identName: 'value', identName2: 'value2' })
```
Parameters
- customFields: CustomFieldsObject
  
  custom fields object
Returns undefined | Promise<ChatEventData>

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

setImage

setImage(image?): void
Parameters
- Optional image: string
Returns void

setName

setName(name?): void
Parameters
- Optional name: string
Returns void

`Static` getId

getId(): null | CustomerIdentityIdOnExternalPlatform
Returns null | CustomerIdentityIdOnExternalPlatform

`Static` getIdOrCreateNewOne

getIdOrCreateNewOne(): CustomerIdentityIdOnExternalPlatform
Returns CustomerIdentityIdOnExternalPlatform

`Static` getImage

getImage(): undefined | string
Returns undefined | string

`Static` getName

getName(): undefined | string
Returns undefined | string

`Static` setId

setId(id): void
Parameters
- id: CustomerIdentityIdOnExternalPlatform
Returns void

`Static` setImage

setImage(image?): void
Parameters
- Optional image: string
Returns void

`Static` setName

setName(name?): void
Parameters
- Optional name: string
Returns void

Generated using TypeDoc