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

    Type Alias InferredActivityDef<FlowOrAction, Type, InputDisplay, ExperienceDisplay, TEnableAiAgent, TAiFieldDisplay, PublicAccess>

    Inferred type for an activity definition.

    • inputs: derived from flow/action inputs, filtered by inputDisplayPreferences
    • outputs: derived from flow/action outputs
    • experienceProperties: derived from ActivityType, filtered by experienceDisplayPreferences
    type InferredActivityDef<
        FlowOrAction extends BackingDef
        | undefined,
        Type extends ActivityTypeDef | undefined,
        InputDisplay extends Record<string, DisplayLevel> | undefined,
        ExperienceDisplay extends Record<string, DisplayLevel> | undefined,
        TEnableAiAgent extends "on" | "off" = "off",
        TAiFieldDisplay extends
            Record<string, DisplayLevel> | undefined = undefined,
        PublicAccess extends boolean
        | undefined = undefined,
    > = {
        __activityDef: true;
        __aiFieldDisplayPreferences: TAiFieldDisplay;
        __enableAiAgent: TEnableAiAgent;
        __publicAccess: PublicAccess extends true ? true : false;
        __rawExperienceProperties: Type extends ActivityTypeDef
            ? ExperienceDisplay extends Record<string, DisplayLevel>
                ? {
                    [K in keyof ExperienceDisplay & keyof NonNullable<
                        Type["experienceProperties"],
                    >]: NonNullable<Type["experienceProperties"]>[K]
                }
                : Type["experienceProperties"] extends Record<string, AnyTypedEntry>
                    ? Type["experienceProperties"]
                    : never
            : never;
        __rawInputs: FlowOrAction extends { rawInputs: infer R }
            ? R extends Record<string, AnyTypedEntry> ? R : never
            : never;
        __rawOutputs: FlowOrAction extends { rawOutputs: infer R }
            ? R extends Record<string, AnyTypedEntry> ? R : never
            : never;
        experienceProperties?: Type extends ActivityTypeDef
            ? ExperienceDisplay extends Record<string, DisplayLevel>
                ? {
                    [K in keyof ExperienceDisplay & keyof NonNullable<
                        Type["experienceProperties"],
                    >]?: TypeOf<NonNullable<Type["experienceProperties"]>[K]>
                }
                : ActivityEntryTypes<Type["experienceProperties"]>
            : undefined;
        inputs?: FlowOrAction extends BackingDef
            ? InputDisplay extends Record<string, DisplayLevel>
                ? {
                    [K in keyof InputDisplay & keyof NonNullable<FlowOrAction["inputs"]>]?: NonNullable<
                        FlowOrAction["inputs"],
                    >[K]
                }
                : FlowOrAction["inputs"]
            : undefined;
        outputs: FlowOrAction extends BackingDef ? FlowOrAction["outputs"] : {};
    }

    Type Parameters

    Index

    Properties

    __activityDef __aiFieldDisplayPreferences __enableAiAgent __publicAccess __rawExperienceProperties __rawInputs __rawOutputs experienceProperties? inputs? outputs

    Properties

    Readonly__activityDef

    __activityDef: true

    Readonly__aiFieldDisplayPreferences

    __aiFieldDisplayPreferences: TAiFieldDisplay

    Readonly__enableAiAgent

    __enableAiAgent: TEnableAiAgent

    Readonly__publicAccess

    __publicAccess: PublicAccess extends true ? true : false

    Whether this definition is allowed inside a public playbook (sys_pd_activity_definition.public_access). Carried on the type so Activity() can propagate it to the lane and the playbook body, where a playbook with publicAccess: true rejects non-public activities at compile time.

    Readonly__rawExperienceProperties

    __rawExperienceProperties: Type extends ActivityTypeDef
        ? ExperienceDisplay extends Record<string, DisplayLevel>
            ? {
                [K in keyof ExperienceDisplay & keyof NonNullable<
                    Type["experienceProperties"],
                >]: NonNullable<Type["experienceProperties"]>[K]
            }
            : Type["experienceProperties"] extends Record<string, AnyTypedEntry>
                ? Type["experienceProperties"]
                : never
        : never

    Raw experienceProperties Column types preserved for dependent record resolution at Activity() call sites

    Readonly__rawInputs

    __rawInputs: FlowOrAction extends { rawInputs: infer R }
        ? R extends Record<string, AnyTypedEntry> ? R : never
        : never

    Raw input Column types preserved for dependent input resolution at Activity() call sites

    Readonly__rawOutputs

    __rawOutputs: FlowOrAction extends { rawOutputs: infer R }
        ? R extends Record<string, AnyTypedEntry> ? R : never
        : never

    Raw output Column types preserved for dependent output resolution at Activity() call sites

    experienceProperties?: Type extends ActivityTypeDef
        ? ExperienceDisplay extends Record<string, DisplayLevel>
            ? {
                [K in keyof ExperienceDisplay & keyof NonNullable<
                    Type["experienceProperties"],
                >]?: TypeOf<NonNullable<Type["experienceProperties"]>[K]>
            }
            : ActivityEntryTypes<Type["experienceProperties"]>
        : undefined
    inputs?: FlowOrAction extends BackingDef
        ? InputDisplay extends Record<string, DisplayLevel>
            ? {
                [K in keyof InputDisplay & keyof NonNullable<FlowOrAction["inputs"]>]?: NonNullable<
                    FlowOrAction["inputs"],
                >[K]
            }
            : FlowOrAction["inputs"]
        : undefined
    outputs: FlowOrAction extends BackingDef ? FlowOrAction["outputs"] : {}

    Settings

    Member Visibility

    On This Page

    Properties