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

    Interface SPWidgetDependency

    interface SPWidgetDependency {
        $id: string | number | ExplicitKey<string>;
        $meta?: { installMethod?: "first install" | "demo" | "once" };
        $override?: Record<string, string | number | boolean>;
        angularModuleName?: string;
        cssIncludes?: CssIncludeWithOrder[];
        includeOnPageLoad?: boolean;
        jsIncludes?: JsIncludeWithOrder[];
        name: string;
        portalsForPageLoad?: (string | Record<"sp_portal">)[];
        protectionPolicy?: "read" | "protected";
    }
    Index

    Properties

    $id $meta? $override? angularModuleName? cssIncludes? includeOnPageLoad? jsIncludes? name portalsForPageLoad? protectionPolicy?

    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.

    angularModuleName?: string

    The Angular module name for the widget dependency

    cssIncludes?: CssIncludeWithOrder[]

    An array of CSS includes for the widget dependency

    includeOnPageLoad?: boolean

    Whether the widget should be included on page load (default is false)

    jsIncludes?: JsIncludeWithOrder[]

    An array of JavaScript includes for the widget dependency

    name: string

    The name of the widget dependency (required)

    portalsForPageLoad?: (string | Record<"sp_portal">)[]

    An array of portals for the widget dependency

    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.

    Settings

    Member Visibility

    On This Page

    Properties