通过

SPSite class

包:
@microsoft/sp-page-context

此类主要用于 PageContext 类。 它为托管页面的 SharePoint 网站集 (“SPSite”) 提供上下文信息。

注解

此类的构造函数标记为内部。 第三方代码不应直接调用构造函数或创建扩展类的 SPSite 子类。

属性

absoluteUrl

返回此 SPSite 的绝对 URL。
cdnPrefix

返回应用程序的指定 cdn 的前缀;如果没有，则返回一个空字符串。
classification

返回该网站的分类。
correlationId

返回当前服务器请求的相关 id。
group

有关与此网站关联的 O365 组的上下文信息。 如果没有与当前站点关联的 O365Group，则此属性是未定义的。
id

用于标识服务器上 SPSite 的 GUID。
isNoScriptEnabled

如果已启用 SPSite 上的 isNoScript，则返回 true。
recycleBinItemCount

回收站中的项数。
serverRelativeUrl

返回此 SPSite 相对于服务器的 URL。
serverRequestPath

返回原始请求的 serverRelativeUrl。
sitePagesEnabled

如果已启用此 SPSite 上的 SitePages，则返回 true。
sitePagesFeatureVersion

如果在此 SPSite 上定义，则返回站点页功能版本号。 例如，对于版本 16.0.4.0，这将返回 4。

属性详细信息

absoluteUrl

返回此 SPSite 的绝对 URL。

readonly absoluteUrl: string;

属性值

string

注解

示例：“https://example.com/sites/PubSite"

cdnPrefix

返回应用程序的指定 cdn 的前缀;如果没有，则返回一个空字符串。

readonly cdnPrefix: string;

属性值

string

classification

返回该网站的分类。

readonly classification: string;

属性值

string

correlationId

返回当前服务器请求的相关 id。

readonly correlationId: Guid;

属性值

Guid

group

有关与此网站关联的 O365 组的上下文信息。 如果没有与当前站点关联的 O365Group，则此属性是未定义的。

readonly group: O365GroupAssociation | undefined;

属性值

O365GroupAssociation | undefined

id

用于标识服务器上 SPSite 的 GUID。

readonly id: Guid;

属性值

Guid

isNoScriptEnabled

如果已启用 SPSite 上的 isNoScript，则返回 true。

readonly isNoScriptEnabled: boolean;

属性值

boolean

recycleBinItemCount

回收站中的项数。

readonly recycleBinItemCount: number;

属性值

number

serverRelativeUrl

返回此 SPSite 相对于服务器的 URL。

readonly serverRelativeUrl: string;

属性值

string

注解

示例：“/sites/PubSite”

serverRequestPath

返回原始请求的 serverRelativeUrl。

readonly serverRequestPath: string;

属性值

string

注解

示例：“/ teams/SPClientTest/SitePages/Home.aspx”

sitePagesEnabled

如果已启用此 SPSite 上的 SitePages，则返回 true。

readonly sitePagesEnabled: boolean;

属性值

boolean

sitePagesFeatureVersion

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

如果在此 SPSite 上定义，则返回站点页功能版本号。 例如，对于版本 16.0.4.0，这将返回 4。

readonly sitePagesFeatureVersion: number;

属性值

number