Manager | @botsquad/sdk

Hierarchy

Manager

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Manager(socket: Socket, config: Config, conversationInfo: ConversationsJoinResponse, onNudge: OnNudge, onEvent: OnEvent): Manager

- Defined in src/visitors.ts:14
Parameters
- socket: Socket
- config: Config
- conversationInfo: ConversationsJoinResponse
- onNudge: OnNudge
- onEvent: OnEvent
Returns Manager

Properties

Private channel

channel: Channel

onEvent

onEvent: OnEvent

onNudge

onNudge: OnNudge

Methods

join

join(): Promise<VisitorsJoinResponse>

- Defined in src/visitors.ts:24
Returns Promise<VisitorsJoinResponse>

Private joinChannel

joinChannel(): Promise<VisitorsJoinResponse>

- Defined in src/visitors.ts:64
Returns Promise<VisitorsJoinResponse>

Private joinParams

joinParams(config: Config, conversationInfo: ConversationsJoinResponse): VisitorsJoinParams

- Defined in src/visitors.ts:55
Parameters
- config: Config
- conversationInfo: ConversationsJoinResponse
Returns VisitorsJoinParams

nudgeResponse

nudgeResponse(nudge: Nudge, action: NudgeResponse, response?: ExtendedNudgeResponse): Promise<void>

- Defined in src/visitors.ts:46
Parameters
- nudge: Nudge
- action: NudgeResponse
- Optional response: ExtendedNudgeResponse
Returns Promise<void>

Private onReceiveEvent

onReceiveEvent(__namedParameters: object): void

- Defined in src/visitors.ts:77
Parameters
- __namedParameters: object
  - json: string
  - name: string
  - sender: string
Returns void

Private onReceiveNudge

onReceiveNudge(__namedParameters: object): void

- Defined in src/visitors.ts:70
Parameters
- __namedParameters: object
  - id: string
  - json: string
Returns void

sendChatOpenState

sendChatOpenState(open: boolean): Promise<__type>

- Defined in src/visitors.ts:40
Parameters
- open: boolean
Returns Promise<__type>

sendPageScroll

sendPageScroll(percentage: number): Promise<__type>

- Defined in src/visitors.ts:34
Parameters
- percentage: number
Returns Promise<__type>

sendPageView

sendPageView(url: string, title: string): Promise<__type>

- Defined in src/visitors.ts:28
Parameters
- url: string
- title: string
Returns Promise<__type>

Generated using TypeDoc