Interface ILivechatCreator

Hierarchy

ILivechatCreator

Index

Methods

createAndReturnVisitor createRoom createToken createVisitor

Methods

createAndReturnVisitor

createAndReturnVisitor(visitor): Promise<IVisitor>
Creates a Livechat visitor
Parameters
- visitor: IVisitor
  
  Data of the visitor to be created
Returns Promise<IVisitor>
- Defined in src/definition/accessors/ILivechatCreator.ts:36

createRoom

createRoom(visitor, agent, extraParams?): Promise<ILivechatRoom>
Creates a room to connect the visitor to an agent.

This method uses the Livechat routing method configured in the server
Parameters
- visitor: IVisitor
  
  The Livechat Visitor that started the conversation
- agent: IUser
  
  The agent responsible for the room
- Optional extraParams: IExtraRoomParams
Returns Promise<ILivechatRoom>
- Defined in src/definition/accessors/ILivechatCreator.ts:21

createToken

createToken(): string
Creates a token to be used when creating a new livechat visitor

Returns string
- Defined in src/definition/accessors/ILivechatCreator.ts:42

createVisitor

createVisitor(visitor): Promise<string>
Parameters
- visitor: IVisitor
  
  Data of the visitor to be created
Returns Promise<string>

Deprecated
Use createAndReturnVisitor instead. Creates a Livechat visitor
- Defined in src/definition/accessors/ILivechatCreator.ts:29

Generated using TypeDoc