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

    Interface Property<T>

    interface Property<T extends PropertyType = PropertyType> {
        $id: string | number | ExplicitKey<string>;
        $meta?: { installMethod?: "first install" | "demo" | "once" };
        $override?: Record<string, string | number | boolean>;
        choices?: string[];
        description?: string;
        ignoreCache?: boolean;
        isPrivate?: boolean;
        name: string;
        protectionPolicy?: "read" | "protected";
        roles?: { read?: (string | Role)[]; write?: (string | Role)[] };
        type?: "" | T;
        value?: string | number | boolean;
    }

    Type Parameters

    Index

    Properties

    $id $meta? $override? choices? description? ignoreCache? isPrivate? name protectionPolicy? roles? type? value?

    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.

    choices?: string[]

    Comma-separated values for a choice list

    description?: string

    A brief, descriptive phrase describing the function of the property

    ignoreCache?: boolean

    Determines whether to flush this property's value from all other server-side caches

    isPrivate?: boolean

    If true, exclude this property from being imported via update sets

    name: string

    Name of the property

    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?: { read?: (string | Role)[]; write?: (string | Role)[] }

    The roles that have access to this property

    type?: "" | T

    Data type for the property

    value?: string | number | boolean

    The desired value for the property

    Settings

    Member Visibility

    On This Page

    Properties