Classes

Class: MoiSession

28min

 / Exports﻿ / MoiSession
Table of contents
Constructors
﻿constructor﻿﻿
Properties
﻿config﻿﻿
﻿context﻿﻿
﻿feedbacks﻿﻿
﻿genericOptions﻿﻿
﻿menu﻿﻿
﻿messages﻿﻿
﻿options﻿﻿
Methods
﻿addFeedback﻿﻿
﻿clear﻿﻿
﻿query﻿﻿
﻿save﻿﻿
Constructors
constructor
• new MoiSession(state, options, context, config)
Parameters
Name
Type
state
Object
state.feedbacks
﻿MoiSavedFeedback﻿[]
state.genericOptions
undefined | { options: { chat: string ; name: string ; type: "message" | "clearChat"  }[]  }
state.menu
undefined | { options: { chat: string ; name: string ; options: { key: string ; validations: string ; value: string  }[] ; type: "message" | "customerSupport"  }[]  }
state.messages
﻿MoiMessages﻿﻿
options
﻿MoiStartOptions﻿﻿
context
﻿MoiContext﻿﻿
config
﻿KlevuConfig﻿﻿
Defined in
﻿connection/moi/moi.ts:322﻿
Properties
config
• config: KlevuConfig﻿﻿
Defined in
﻿connection/moi/moi.ts:354﻿
﻿
context
• context: MoiContext﻿﻿
Defined in
﻿connection/moi/moi.ts:353﻿
﻿
feedbacks
• feedbacks: MoiSavedFeedback﻿[]
Defined in
﻿connection/moi/moi.ts:351﻿
﻿
genericOptions
• Optional genericOptions: Object
Type declaration
Name
Type
options
{ chat: string ; name: string ; type: "message" | "clearChat"  }[]
Defined in
﻿connection/moi/moi.ts:350﻿
﻿
menu
• menu: undefined | { options: { chat: string ; name: string ; options: { key: string ; validations: string ; value: string  }[] ; type: "message" | "customerSupport"  }[]  }
Defined in
﻿connection/moi/moi.ts:349﻿
﻿
messages
• messages: MoiMessages﻿﻿
Defined in
﻿connection/moi/moi.ts:348﻿
﻿
options
• options: MoiStartOptions﻿﻿
Defined in
﻿connection/moi/moi.ts:352﻿
Methods
addFeedback
▸ addFeedback(messageId, thumbs, reason?): Promise<MoiResponse﻿>
Parameters
Name
Type
messageId
string
thumbs
"up" | "down"
reason?
string
Returns
Promise<MoiResponse﻿>
Defined in
﻿connection/moi/moi.ts:456﻿
﻿
clear
▸ clear(): void
Returns
void
Defined in
﻿connection/moi/moi.ts:417﻿
﻿
query
▸ query(request, target?): Promise<MoiResponse﻿>
Parameters
Name
Type
request
Omit<MoiRequest﻿, "context">
target?
MoiAPITarget
Returns
Promise<MoiResponse﻿>
Defined in
﻿connection/moi/moi.ts:356﻿
﻿
save
▸ save(): void
Returns
void
Defined in
﻿connection/moi/moi.ts:423﻿

Name	Type
state	Object
state.feedbacks	MoiSavedFeedback[]
state.genericOptions	undefined \| { options: { chat: string ; name: string ; type: "message" \| "clearChat" }[] }
state.menu	undefined \| { options: { chat: string ; name: string ; options: { key: string ; validations: string ; value: string }[] ; type: "message" \| "customerSupport" }[] }
state.messages	MoiMessages
options	MoiStartOptions
context	MoiContext
config	KlevuConfig

Name	Type
options	{ chat: string ; name: string ; type: "message" \| "clearChat" }[]

Name	Type
messageId	string
thumbs	"up" \| "down"
reason?	string

Name	Type
request	Omit<MoiRequest, "context">
target?	MoiAPITarget

Updated 25 Mar 2024

Did this page help you?

Class: KlevuResponseQueryObject

Enumeration: AdvancedSortingDiretion