zendesk-messaging-client
    Preparing search index...

    Type Alias Webview

    When a webview actions is clicked/tapped, the provided URI will be loaded in a webview. Channels that do not support webviews will open the fallback URI instead.

    type Webview = {
        default?: boolean;
        extraChannelOptions?: ExtraChannelOptions;
        fallback: string;
        metadata?: Metadata;
        openOnReceive?: boolean;
        size?: "compact" | "tall" | "full";
        text: string;
        type: string;
        uri: string;
    }
    Index

    Properties

    default? extraChannelOptions? fallback metadata? openOnReceive? size? text type uri

    Properties

    default?: boolean

    Boolean value indicating whether the action is the default action for a message item in Facebook Messenger.

    extraChannelOptions?: ExtraChannelOptions
    fallback: string

    The fallback uri for channels that don’t support webviews. Used for actions of type webview.

    metadata?: Metadata
    openOnReceive?: boolean

    Boolean value indicating if the webview should open automatically. Only one action per message can be set to true. Currently only supported on the Web Messenger.

    size?: "compact" | "tall" | "full"

    The size to display a webview. Used for actions of type webview.

    text

    text: string

    The button text.

    type: string

    The type of action.

    uri: string

    The webview URI. This is the URI that will open in the webview when clicking the button.

    Settings

    Member Visibility

    On This Page

    Properties