Views
Below is the union of the possible values for setting the active view of the widget.
type WidgetViews =
| 'KnowledgeBaseArticleView'
| 'KnowledgeBaseHomeView'
| 'ConversationView'
| 'BulletinView'
| 'MainView'
| 'PreviousConversationsView';SetWidgetViewPayload
SetWidgetViewPayload: KnowledgeBaseArticleViewPayload | KnowledgeBaseHomeViewPayload | ConversationViewPayload | BulletinViewPayload | MainViewViewPayload | PreviousConversationsViewPayload
Each view has it's own corresponding payload type, which is used to set the view:
BulletinView
BulletinViewPayload: Object
Type declaration
| Name | Type |
|---|---|
params |
{ bulletinId: string } |
params.bulletinId |
string |
view |
"bulletin" |
ConversationView
ConversationViewPayload: Object
Type declaration
| Name | Type |
|---|---|
params? |
{ conversationId: string } |
params.conversationId |
string |
view |
"conversation" |
KnowledgeBaseArticleView
KnowledgeBaseArticleViewPayload: Object
Type declaration
| Name | Type |
|---|---|
params |
{ articleId: string } |
params.articleId |
string |
view |
"knowledgeBaseArticle" |
KnowledgeBaseHomeView
KnowledgeBaseHomeViewPayload: Object
Type declaration
| Name | Type |
|---|---|
view |
"knowledgeBaseHome" |
MainViewView
MainViewViewPayload: Object
Type declaration
| Name | Type |
|---|---|
view |
"mainView" |
PreviousConversationsView
PreviousConversationsViewPayload: Object
Type declaration
| Name | Type |
|---|---|
view |
"previousConversations" |