Interface SPWebLayer

layers

create

• create(
      options: Partial<
          {
              Description?: string;
              Language?: number;
              Title?: string;
              Url?: string;
              UseSamePermissionsAsParentSite?: boolean;
              WebTemplate?: string;
          },
      >,
  ): Promise<Sp.CreateWebResponse>

  Parameters

  • options: Partial<
        {
            Description?: string;
            Language?: number;
            Title?: string;
            Url?: string;
            UseSamePermissionsAsParentSite?: boolean;
            WebTemplate?: string;
        },
    >

  Returns Promise<Sp.CreateWebResponse>

delete

• delete(): Promise<void>

  Returns Promise<void>

get

• 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;
          }[],
  >

  Type Parameters

  • T extends [] = null

  Parameters

  • Optionalfilter: QueryItemsFilter

  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;
          }[],
  >

update

• update(props: Partial<Sp.Web>): Promise<Sp.CreateWebResponse>

  Parameters

  • props: Partial<Sp.Web>

  Returns Promise<Sp.CreateWebResponse>