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

    Interface UiPage

    interface UiPage {
        $id: string | number | ExplicitKey<string>;
        $meta?: { installMethod?: "first install" | "demo" | "once" };
        $override?: Record<string, string | number | boolean>;
        category?:
            | "catalog"
            | "kb"
            | "general"
            | "cms"
            | "homepages"
            | "htmleditor";
        clientScript?: string;
        description?: string;
        direct?: boolean;
        endpoint: `${string}.do`;
        html?: string;
        processingScript?: string
        | ((...args: unknown[]) => void);
        protectionPolicy?: "read" | "protected";
    }
    Index

    Properties

    $id $meta? $override? category? clientScript? description? direct? endpoint html? processingScript? 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.

    category?: "catalog" | "kb" | "general" | "cms" | "homepages" | "htmleditor"

    select a category from one of these values : general, homepages, htmleditor, kb, cms, catalog'

    clientScript?: string

    client-side JavaScript that runs in the browser, such as functions called by buttons. It’s intended to handle any client-side processing needed, like setting focus to a field or other interactive DHTML features after a page is loaded.

    description?: string

    description about ui page

    direct?: boolean

    Select this check box for a direct UI page

    endpoint: `${string}.do`

    endpoint for the page, typically in the format <scope_name>_<ui_page_name>.do

    html?: string

    define what is rendered when the page is shown. It can contain either static XHTML, dynamically generated content defined as Jelly, or call script includes and UI Macros.

    processingScript?: string | ((...args: unknown[]) => void)

    Script that runs on the server when the page is submitted

    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