@servicenow/sdk - v4.7.0
    Preparing search index...

    Interface ApplicationMenu

    interface ApplicationMenu {
        $id: string | number | ExplicitKey<string>;
        $meta?: { installMethod?: "first install" | "demo" | "once" };
        $override?: Record<string, string | number | boolean>;
        active?: boolean;
        category?: string | Record<"sys_app_category">;
        description?: string;
        hint?: string;
        name?: string;
        order?: number;
        protectionPolicy?: "read" | "protected";
        roles?: (string | Role)[];
        title: string;
    }
    Index

    Properties

    $id $meta? $override? active? category? description? hint? name? order? protectionPolicy? roles? title

    Properties

    $id: string | number | ExplicitKey<string>
    $meta?: { installMethod?: "first install" | "demo" | "once" }

    Type Declaration

    • OptionalinstallMethod?: "first install" | "demo" | "once"

      Map a record to an output folder that loads only in specific circumstances. 'first install' -> 'unload' (only loaded when plugin is first registered), 'demo' -> 'unload.demo' (only loaded when demo data is loaded), 'once' -> 'apply_once' (scripts that are only applied once)

    $override?: Record<string, string | number | boolean>

    Set properties not directly supported by this API.

    active?: boolean

    Whether the menu is enabled.

    category?: string | Record<"sys_app_category">

    The menu category that defines the navigation menu style.

    description?: string

    Additional information about what the application does.

    hint?: string

    The tooltip text that appears when a user hovers over the menu.

    name?: string

    An internal name to differentiate between applications with the same title.

    order?: number

    The relative position of the application menu in the application navigator.

    protectionPolicy?: "read" | "protected"

    Controls edit/view access for other developers after the application is installed.

    • read: Others can see the script logic but not change it.
    • protected: Others cannot change this record.
    • Omit to allow other developers to customize this record.
    roles?: (string | Role)[]

    A list of Role objects or names of roles that can access the menu.

    title: string

    The label for the menu in the application navigator.

    Settings

    Member Visibility

    On This Page

    Properties