foo-webview-sdk
    Preparing search index...

    Interface MenuGetContextMenuParams

    Parameters for menu.getContextMenu. Get the context menu for the tracks mode selects, as a tree.

    interface MenuGetContextMenuParams {
        handles?: JsonValue[];
        i18n?: boolean;
        locale?: string;
        mode?: string;
        withAvailability?: boolean;
    }
    Index
    handles?: JsonValue[]

    Tracks for mode: "handles" and auto: each a path, optionally ending in |subsong:N, or an object { path, subsong }. Paths the security policy refuses and entries of other types are skipped. Each path is checked on disk, so prefer selection, playlist or nowPlaying for tracks the host already lists.

    i18n?: boolean

    false turns the label translation off.

    true
    
    locale?: string

    Locale for displayLabel: auto keeps the host's labels; a zh or en tag translates common labels.

    "auto"
    
    mode?: string

    Tracks to build the menu for: handles uses handles, playlist the active playlist, nowPlaying the playing track and selection the active playlist selection. Any other value, auto included, takes the first of handles, the playing track, the selection and the active playlist that is available. Given handles of which none is usable fail with INVALID_PARAMS in every mode, auto included, rather than falling back to other tracks; nowPlaying with nothing playing and selection with nothing selected fail with NO_ACTIVE_ITEM.

    "auto"
    
    withAvailability?: boolean

    Add command counts to submenus.

    true