Interface HomeScreenConfig

Configuration for the optional home screen that appears before the bot chat window.

interface HomeScreenConfig {
    allow_return?: boolean;
    background?: HomeScreenBackgroundType;
    bot_avatar_url?: string;
    custom_content_only?: boolean;
    greeting?: string;
    is_on?: boolean;
    starters?: HomeScreenStarterButtons;
}

Properties

allow_return? background? bot_avatar_url? custom_content_only? greeting? is_on? starters?

Properties

Optionalallow_return

allow_return?: boolean

Defaults to true. If enabled, a user can navigate back to the home screen after they have sent a message to the assistant. If false, the home screen disappears forever after a message is sent.

Optionalbackground

background?: HomeScreenBackgroundType

The type of home screen background to render.

Optionalbot_avatar_url

bot_avatar_url?: string

An image url that will override the bot avatar displayed in home screen.

Optionalcustom_content_only

custom_content_only?: boolean

Do not show the greeting, starters, or avatar url.

Optionalgreeting

greeting?: string

The greeting to show to the user to prompt them to start a conversation.

Optionalis_on

is_on?: boolean

If the home page is turned on via config or remote config.

Optionalstarters

starters?: HomeScreenStarterButtons

Optional conversation starter utterances that are displayed as buttons.

Settings

Member Visibility

On This Page

Properties
MMNEPVFCICPMFPCPTTAAATR