Interface SPSiteLayer

layers

create

• create(
      siteTemplate: SiteTemplate,
      siteProps: Sp.CreateCommSiteProperties | Sp.CreateTeamSiteProperties,
  ): Promise<Sp.CreateSiteResponse>

  Parameters

  • siteTemplate: SiteTemplate
  • siteProps: Sp.CreateCommSiteProperties | Sp.CreateTeamSiteProperties

  Returns Promise<Sp.CreateSiteResponse>

delete

• delete(): Promise<void>

  Returns Promise<void>

get

• get(filter?: QuerySitesFilter): Promise<Sp.Site[]>

  Parameters

  • Optionalfilter: QuerySitesFilter

  Returns Promise<Sp.Site[]>

update

• update(
      siteProps: Partial<
          {
              AllowCreateDeclarativeWorkflow?: boolean;
              AllowDesigner?: boolean;
              AllowMasterPageEditing?: boolean;
              AllowRevertFromTemplate?: boolean;
              AllowSaveDeclarativeWorkflowAsTemplate?: boolean;
              AllowSavePublishDeclarativeWorkflow?: boolean;
              AllowSelfServiceUpgrade?: boolean;
              AllowSelfServiceUpgradeEvaluation?: boolean;
              AuditLogTrimmingRetention?: number;
              ChannelGroupId?: string;
              Classification?: string;
              CompatibilityLevel?: number;
              CurrentChangeToken?: { StringValue?: string };
              DisableAppViews?: boolean;
              DisableCompanyWideSharingLinks?: boolean;
              DisableFlows?: boolean;
              ExternalSharingTipsEnabled?: boolean;
              GeoLocation?: string;
              GroupId?: string;
              HubSiteId?: string;
              Id?: string;
              IsHubSite?: boolean;
              LockIssue?: string;
              MaxItemsPerThrottledOperation?: number;
              MediaTranscriptionDisabled?: boolean;
              NeedsB2BUpgrade?: boolean;
              PrimaryUri?: string;
              ReadOnly?: boolean;
              RequiredDesignerVersion?: string;
              ResourcePath?: { DecodedUrl?: string };
              SandboxedCodeActivationCapability?: number;
              SensitivityLabel?: string;
              SensitivityLabelId?: string;
              ServerRelativeUrl?: string;
              ShareByEmailEnabled?: boolean;
              ShareByLinkEnabled?: boolean;
              ShowUrlStructure?: boolean;
              TrimAuditLog?: boolean;
              UIVersionConfigurationEnabled?: boolean;
              UpgradeReminderDate?: string;
              UpgradeScheduled?: boolean;
              UpgradeScheduledDate?: string;
              Upgrading?: boolean;
              Url?: string;
              WriteLocked?: boolean;
          },
      >,
  ): Promise<void>

  Parameters

  • siteProps: Partial<
        {
            AllowCreateDeclarativeWorkflow?: boolean;
            AllowDesigner?: boolean;
            AllowMasterPageEditing?: boolean;
            AllowRevertFromTemplate?: boolean;
            AllowSaveDeclarativeWorkflowAsTemplate?: boolean;
            AllowSavePublishDeclarativeWorkflow?: boolean;
            AllowSelfServiceUpgrade?: boolean;
            AllowSelfServiceUpgradeEvaluation?: boolean;
            AuditLogTrimmingRetention?: number;
            ChannelGroupId?: string;
            Classification?: string;
            CompatibilityLevel?: number;
            CurrentChangeToken?: { StringValue?: string };
            DisableAppViews?: boolean;
            DisableCompanyWideSharingLinks?: boolean;
            DisableFlows?: boolean;
            ExternalSharingTipsEnabled?: boolean;
            GeoLocation?: string;
            GroupId?: string;
            HubSiteId?: string;
            Id?: string;
            IsHubSite?: boolean;
            LockIssue?: string;
            MaxItemsPerThrottledOperation?: number;
            MediaTranscriptionDisabled?: boolean;
            NeedsB2BUpgrade?: boolean;
            PrimaryUri?: string;
            ReadOnly?: boolean;
            RequiredDesignerVersion?: string;
            ResourcePath?: { DecodedUrl?: string };
            SandboxedCodeActivationCapability?: number;
            SensitivityLabel?: string;
            SensitivityLabelId?: string;
            ServerRelativeUrl?: string;
            ShareByEmailEnabled?: boolean;
            ShareByLinkEnabled?: boolean;
            ShowUrlStructure?: boolean;
            TrimAuditLog?: boolean;
            UIVersionConfigurationEnabled?: boolean;
            UpgradeReminderDate?: string;
            UpgradeScheduled?: boolean;
            UpgradeScheduledDate?: string;
            Upgrading?: boolean;
            Url?: string;
            WriteLocked?: boolean;
        },
    >

  Returns Promise<void>