@infrasoftbe/vnv-sdk
    Preparing search index...

    Interface SPFieldLayer

    interface SPFieldLayer {
        create(
            options: Partial<Sp.CreateFieldProperties>,
        ): Promise<
            {
                data?: {
                    AutofillInfo?: string;
                    AutoIndexed?: boolean;
                    CanBeDeleted?: boolean;
                    ClientSideComponentId?: string;
                    ClientSideComponentProperties?: string;
                    ClientValidationFormula?: string;
                    ClientValidationMessage?: string;
                    CustomFormatter?: string;
                    DefaultFormula?: string;
                    DefaultValue?: string;
                    Description?: string;
                    Direction?: "none"
                    | "ltr"
                    | "rtl";
                    EnforceUniqueValues?: boolean;
                    EntityPropertyName?: string;
                    FieldTypeKind?: number;
                    Filterable?: boolean;
                    FromBaseType?: boolean;
                    Group?: string;
                    Hidden?: boolean;
                    Id?: string;
                    Indexed?: boolean;
                    IndexStatus?: number;
                    InternalName?: string;
                    IsModern?: boolean;
                    JSLink?: string;
                    PinnedToFiltersPane?: boolean;
                    ReadOnlyField?: boolean;
                    Required?: boolean;
                    SchemaXml?: string;
                    Scope?: string;
                    Sealed?: boolean;
                    ShowInFiltersPane?: number;
                    Sortable?: boolean;
                    StaticName?: string;
                    Title?: string;
                    TypeAsString?: string;
                    TypeDisplayName?: string;
                    TypeShortDescription?: string;
                    ValidationFormula?: string;
                    ValidationMessage?: string;
                };
            },
        >;
        delete(): Promise<void>;
        get<T extends [] = null>(
            filter?: QueryItemsFilter,
        ): Promise<
            T extends null
                ? {
                    AutofillInfo?: string;
                    AutoIndexed?: boolean;
                    CanBeDeleted?: boolean;
                    ClientSideComponentId?: string;
                    ClientSideComponentProperties?: string;
                    ClientValidationFormula?: string;
                    ClientValidationMessage?: string;
                    CustomFormatter?: string;
                    DefaultFormula?: string;
                    DefaultValue?: string;
                    Description?: string;
                    Direction?: "none"
                    | "ltr"
                    | "rtl";
                    EnforceUniqueValues?: boolean;
                    EntityPropertyName?: string;
                    FieldTypeKind?: number;
                    Filterable?: boolean;
                    FromBaseType?: boolean;
                    Group?: string;
                    Hidden?: boolean;
                    Id?: string;
                    Indexed?: boolean;
                    IndexStatus?: number;
                    InternalName?: string;
                    IsModern?: boolean;
                    JSLink?: string;
                    PinnedToFiltersPane?: boolean;
                    ReadOnlyField?: boolean;
                    Required?: boolean;
                    SchemaXml?: string;
                    Scope?: string;
                    Sealed?: boolean;
                    ShowInFiltersPane?: number;
                    Sortable?: boolean;
                    StaticName?: string;
                    Title?: string;
                    TypeAsString?: string;
                    TypeDisplayName?: string;
                    TypeShortDescription?: string;
                    ValidationFormula?: string;
                    ValidationMessage?: string;
                }
                : {
                    AutofillInfo?: string;
                    AutoIndexed?: boolean;
                    CanBeDeleted?: boolean;
                    ClientSideComponentId?: string;
                    ClientSideComponentProperties?: string;
                    ClientValidationFormula?: string;
                    ClientValidationMessage?: string;
                    CustomFormatter?: string;
                    DefaultFormula?: string;
                    DefaultValue?: string;
                    Description?: string;
                    Direction?: "none"
                    | "ltr"
                    | "rtl";
                    EnforceUniqueValues?: boolean;
                    EntityPropertyName?: string;
                    FieldTypeKind?: number;
                    Filterable?: boolean;
                    FromBaseType?: boolean;
                    Group?: string;
                    Hidden?: boolean;
                    Id?: string;
                    Indexed?: boolean;
                    IndexStatus?: number;
                    InternalName?: string;
                    IsModern?: boolean;
                    JSLink?: string;
                    PinnedToFiltersPane?: boolean;
                    ReadOnlyField?: boolean;
                    Required?: boolean;
                    SchemaXml?: string;
                    Scope?: string;
                    Sealed?: boolean;
                    ShowInFiltersPane?: number;
                    Sortable?: boolean;
                    StaticName?: string;
                    Title?: string;
                    TypeAsString?: string;
                    TypeDisplayName?: string;
                    TypeShortDescription?: string;
                    ValidationFormula?: string;
                    ValidationMessage?: string;
                }[],
        >;
        update(
            props: Partial<Sp.CreateFieldProperties>,
        ): Promise<
            {
                data?: {
                    AutofillInfo?: string;
                    AutoIndexed?: boolean;
                    CanBeDeleted?: boolean;
                    ClientSideComponentId?: string;
                    ClientSideComponentProperties?: string;
                    ClientValidationFormula?: string;
                    ClientValidationMessage?: string;
                    CustomFormatter?: string;
                    DefaultFormula?: string;
                    DefaultValue?: string;
                    Description?: string;
                    Direction?: "none"
                    | "ltr"
                    | "rtl";
                    EnforceUniqueValues?: boolean;
                    EntityPropertyName?: string;
                    FieldTypeKind?: number;
                    Filterable?: boolean;
                    FromBaseType?: boolean;
                    Group?: string;
                    Hidden?: boolean;
                    Id?: string;
                    Indexed?: boolean;
                    IndexStatus?: number;
                    InternalName?: string;
                    IsModern?: boolean;
                    JSLink?: string;
                    PinnedToFiltersPane?: boolean;
                    ReadOnlyField?: boolean;
                    Required?: boolean;
                    SchemaXml?: string;
                    Scope?: string;
                    Sealed?: boolean;
                    ShowInFiltersPane?: number;
                    Sortable?: boolean;
                    StaticName?: string;
                    Title?: string;
                    TypeAsString?: string;
                    TypeDisplayName?: string;
                    TypeShortDescription?: string;
                    ValidationFormula?: string;
                    ValidationMessage?: string;
                };
            },
        >;
    }
    Index

    Methods

    • Parameters

      Returns Promise<
          {
              data?: {
                  AutofillInfo?: string;
                  AutoIndexed?: boolean;
                  CanBeDeleted?: boolean;
                  ClientSideComponentId?: string;
                  ClientSideComponentProperties?: string;
                  ClientValidationFormula?: string;
                  ClientValidationMessage?: string;
                  CustomFormatter?: string;
                  DefaultFormula?: string;
                  DefaultValue?: string;
                  Description?: string;
                  Direction?: "none"
                  | "ltr"
                  | "rtl";
                  EnforceUniqueValues?: boolean;
                  EntityPropertyName?: string;
                  FieldTypeKind?: number;
                  Filterable?: boolean;
                  FromBaseType?: boolean;
                  Group?: string;
                  Hidden?: boolean;
                  Id?: string;
                  Indexed?: boolean;
                  IndexStatus?: number;
                  InternalName?: string;
                  IsModern?: boolean;
                  JSLink?: string;
                  PinnedToFiltersPane?: boolean;
                  ReadOnlyField?: boolean;
                  Required?: boolean;
                  SchemaXml?: string;
                  Scope?: string;
                  Sealed?: boolean;
                  ShowInFiltersPane?: number;
                  Sortable?: boolean;
                  StaticName?: string;
                  Title?: string;
                  TypeAsString?: string;
                  TypeDisplayName?: string;
                  TypeShortDescription?: string;
                  ValidationFormula?: string;
                  ValidationMessage?: string;
              };
          },
      >

    • Type Parameters

      • T extends [] = null

      Parameters

      Returns Promise<
          T extends null
              ? {
                  AutofillInfo?: string;
                  AutoIndexed?: boolean;
                  CanBeDeleted?: boolean;
                  ClientSideComponentId?: string;
                  ClientSideComponentProperties?: string;
                  ClientValidationFormula?: string;
                  ClientValidationMessage?: string;
                  CustomFormatter?: string;
                  DefaultFormula?: string;
                  DefaultValue?: string;
                  Description?: string;
                  Direction?: "none"
                  | "ltr"
                  | "rtl";
                  EnforceUniqueValues?: boolean;
                  EntityPropertyName?: string;
                  FieldTypeKind?: number;
                  Filterable?: boolean;
                  FromBaseType?: boolean;
                  Group?: string;
                  Hidden?: boolean;
                  Id?: string;
                  Indexed?: boolean;
                  IndexStatus?: number;
                  InternalName?: string;
                  IsModern?: boolean;
                  JSLink?: string;
                  PinnedToFiltersPane?: boolean;
                  ReadOnlyField?: boolean;
                  Required?: boolean;
                  SchemaXml?: string;
                  Scope?: string;
                  Sealed?: boolean;
                  ShowInFiltersPane?: number;
                  Sortable?: boolean;
                  StaticName?: string;
                  Title?: string;
                  TypeAsString?: string;
                  TypeDisplayName?: string;
                  TypeShortDescription?: string;
                  ValidationFormula?: string;
                  ValidationMessage?: string;
              }
              : {
                  AutofillInfo?: string;
                  AutoIndexed?: boolean;
                  CanBeDeleted?: boolean;
                  ClientSideComponentId?: string;
                  ClientSideComponentProperties?: string;
                  ClientValidationFormula?: string;
                  ClientValidationMessage?: string;
                  CustomFormatter?: string;
                  DefaultFormula?: string;
                  DefaultValue?: string;
                  Description?: string;
                  Direction?: "none"
                  | "ltr"
                  | "rtl";
                  EnforceUniqueValues?: boolean;
                  EntityPropertyName?: string;
                  FieldTypeKind?: number;
                  Filterable?: boolean;
                  FromBaseType?: boolean;
                  Group?: string;
                  Hidden?: boolean;
                  Id?: string;
                  Indexed?: boolean;
                  IndexStatus?: number;
                  InternalName?: string;
                  IsModern?: boolean;
                  JSLink?: string;
                  PinnedToFiltersPane?: boolean;
                  ReadOnlyField?: boolean;
                  Required?: boolean;
                  SchemaXml?: string;
                  Scope?: string;
                  Sealed?: boolean;
                  ShowInFiltersPane?: number;
                  Sortable?: boolean;
                  StaticName?: string;
                  Title?: string;
                  TypeAsString?: string;
                  TypeDisplayName?: string;
                  TypeShortDescription?: string;
                  ValidationFormula?: string;
                  ValidationMessage?: string;
              }[],
      >

    • Parameters

      Returns Promise<
          {
              data?: {
                  AutofillInfo?: string;
                  AutoIndexed?: boolean;
                  CanBeDeleted?: boolean;
                  ClientSideComponentId?: string;
                  ClientSideComponentProperties?: string;
                  ClientValidationFormula?: string;
                  ClientValidationMessage?: string;
                  CustomFormatter?: string;
                  DefaultFormula?: string;
                  DefaultValue?: string;
                  Description?: string;
                  Direction?: "none"
                  | "ltr"
                  | "rtl";
                  EnforceUniqueValues?: boolean;
                  EntityPropertyName?: string;
                  FieldTypeKind?: number;
                  Filterable?: boolean;
                  FromBaseType?: boolean;
                  Group?: string;
                  Hidden?: boolean;
                  Id?: string;
                  Indexed?: boolean;
                  IndexStatus?: number;
                  InternalName?: string;
                  IsModern?: boolean;
                  JSLink?: string;
                  PinnedToFiltersPane?: boolean;
                  ReadOnlyField?: boolean;
                  Required?: boolean;
                  SchemaXml?: string;
                  Scope?: string;
                  Sealed?: boolean;
                  ShowInFiltersPane?: number;
                  Sortable?: boolean;
                  StaticName?: string;
                  Title?: string;
                  TypeAsString?: string;
                  TypeDisplayName?: string;
                  TypeShortDescription?: string;
                  ValidationFormula?: string;
                  ValidationMessage?: string;
              };
          },
      >