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: KnowledgeBaseArticleViewPayload | KnowledgeBaseHomeViewPayload | ConversationViewPayload | BulletinViewPayload | MainViewViewPayload | PreviousConversationsViewPayload
Each view has it's own corresponding payload type, which is used to set the view:
BulletinViewPayload: Object
| Name | Type |
|---|---|
params | { bulletinId: string } |
params.bulletinId | string |
view | "bulletin" |
ConversationViewPayload: Object
| Name | Type |
|---|---|
params? | { conversationId: string } |
params.conversationId | string |
view | "conversation" |
KnowledgeBaseArticleViewPayload: Object
| Name | Type |
|---|---|
params | { articleId: string } |
params.articleId | string |
view | "knowledgeBaseArticle" |
KnowledgeBaseHomeViewPayload: Object
| Name | Type |
|---|---|
view | "knowledgeBaseHome" |
MainViewViewPayload: Object
| Name | Type |
|---|---|
view | "mainView" |
PreviousConversationsViewPayload: Object
| Name | Type |
|---|---|
view | "previousConversations" |