Frodo Library - v4.8.5
    Preparing search index...

    Type Alias ManagedObjectSchemaPropertyFields

    Field values for a flat (non-relationship) schema property. Used both for create (fully specified) and update (only the explicitly-changed subset, merged onto the property's current definition via extractManagedObjectSchemaPropertyFields).

    type ManagedObjectSchemaPropertyFields = {
        array?: boolean;
        defaultValue?: unknown;
        deriveFields?: string[];
        deriveFromRelationship?: string[];
        description?: string;
        enumTitles?: string[];
        enumValues?: string[];
        flatten?: boolean;
        notViewable?: boolean;
        onRetrieveScript?: string;
        onStoreScript?: string;
        required?: boolean;
        returnByDefault?: boolean;
        searchable?: boolean;
        title?: string;
        type?: ManagedObjectSchemaCreatablePropertyType;
        userEditable?: boolean;
    }
    Index

    Properties

    array? defaultValue? deriveFields? deriveFromRelationship? description? enumTitles? enumValues? flatten? notViewable? onRetrieveScript? onStoreScript? required? returnByDefault? searchable? title? type? userEditable?

    Properties

    array?: boolean
    defaultValue?: unknown
    deriveFields?: string[]

    Fields to pull from each referenced object — IDM's queryConfig.referencedObjectFields.

    deriveFromRelationship?: string[]

    Relationship property name(s) this RDVP derives its value through — IDM's queryConfig.referencedRelationshipFields.

    description?: string
    enumTitles?: string[]
    enumValues?: string[]
    flatten?: boolean
    notViewable?: boolean
    onRetrieveScript?: string

    JS source (already read from the file a caller's --on-retrieve-script points at), not a file path.

    onStoreScript?: string

    JS source (already read from the file a caller's --on-store-script points at), not a file path.

    required?: boolean
    returnByDefault?: boolean
    searchable?: boolean
    title?: string
    type?: ManagedObjectSchemaCreatablePropertyType
    userEditable?: boolean

    Settings

    Member Visibility

    On This Page

    Properties