foo-webview-sdk
    Preparing search index...

    Interface DiscoveryMainMenuCommand

    One main-menu command, static or expanded from a dynamic submenu.

    interface DiscoveryMainMenuCommand {
        checked: boolean;
        description: string;
        enabled: boolean;
        executable: boolean;
        flags: number;
        guid: string;
        hidden: boolean;
        index: number;
        isDynamic: boolean;
        isDynamicParent: boolean;
        name: string;
        parentGuid: string;
        path: string;
        radioChecked: boolean;
        source:
            | "mainmenu_static"
            | "mainmenu_dynamic"
            | "contextmenu_static"
            | "contextmenu_dynamic"
            | "hmenu_fallback";
        stateKnown: boolean;
        subGuid?: string;
        unaddressableReason: | ""
        | "separator"
        | "dynamicParent"
        | "noStableIdentifier"
        | "emptyNode";
    }

    Hierarchy

    • MenuNodeState
      • DiscoveryMainMenuCommand
    Index
    checked: boolean

    Whether the entry shows a check mark (a radio mark counts too).

    description: string

    Description the component provides; empty when it has none.

    enabled: boolean

    Whether the entry can be clicked. Meaningless while stateKnown is false.

    executable: boolean

    Whether the entry can be executed.

    flags: number

    The raw display flags the component reported. Main menu: 1 disabled, 2 checked, 4 radio, 8 default-hidden. Context menu: 1 checked, 2 disabled, 4 grayed, 8 radio.

    guid: string

    Command GUID. For an entry expanded from a dynamic submenu this is the owning command's GUID.

    hidden: boolean

    Whether the host would not draw the entry.

    index: number

    Index of the command within its service.

    isDynamic: boolean

    Whether the entry belongs to a dynamic submenu, as its parent slot or as an expanded child.

    isDynamicParent: boolean

    Whether the entry is the parent slot of a dynamic submenu: a container that cannot be executed on its own.

    name: string

    Label as the host reports it (localized on a translated build).

    parentGuid: string

    GUID of the group the command is filed under.

    path: string

    Slash-separated label path; for a static slot just its label.

    radioChecked: boolean

    Whether the check mark is a radio mark.

    source:
        | "mainmenu_static"
        | "mainmenu_dynamic"
        | "contextmenu_static"
        | "contextmenu_dynamic"
        | "hmenu_fallback"

    Where the entry came from.

    stateKnown: boolean

    Whether enabled and checked were observed. False when the state could not be evaluated, such as a context-menu entry with nothing selected or playing.

    subGuid?: string

    GUID of the child node inside a dynamic submenu; pass it with guid to discovery.executeMainMenuCommand. Absent on static entries.

    unaddressableReason:
        | ""
        | "separator"
        | "dynamicParent"
        | "noStableIdentifier"
        | "emptyNode"

    Why it cannot be executed; empty when it can.