ADK API Reference
    Preparing search index...

    Interface Adk

    The top-level ADK interface, exposed on the browser window object as window.adk by default.

    interface Adk {
        cmd: CommandQueue;
        config(): ConfigBuilder;
        container: ContainerApi;
        hook: HookApi;
        placement: AdkPlacementApi;
        template: TemplateApi;
        togglePanel(open?: boolean): void;
    }
    Index

    Properties

    cmd container hook placement template

    Methods

    config togglePanel

    Properties

    cmd: CommandQueue

    The asynchronous command queue, where all the commands to ADK must be dispatched.

    This queue should be initialized in the integration code to allow dispatching commands before ADK has loaded:

    window.adk = window.adk || { cmd: [] }
    container: ContainerApi

    The container API.

    hook: HookApi

    The hook API.

    placement: AdkPlacementApi

    The placement API.

    The placement API is deprecated and will be removed in a future release.

    template: TemplateApi

    The template API.

    Methods

    • Toggle the ADK panel.

      Parameters

      • Optionalopen: boolean

        Whether to open or close the panel. If not specified, the panel will toggle its current state.

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods