SPSite class

Пакет:

@microsoft/sp-page-context

Этот класс в основном используется с классом PageContext . Он предоставляет контекстную информацию для семейства веб-сайтов SharePoint ("SPSite"), в котором размещается страница.

Комментарии

Конструктор для этого класса помечен как внутренний. Сторонний код не должен напрямую вызывать конструктор или создавать подклассы, расширяющие класс SPSite.

Свойства

absoluteUrl	Возвращает абсолютный URL-адрес SPSite.
cdnPrefix	Возвращает префикс указанного cdn приложения или пустую строку, если ее нет.
classification	Возвращает классификацию сайта.
correlationId	Возвращает идентификатор корреляции для текущего запроса сервера.
group	Контекстные сведения о группе O365, связанной с этим сайтом. Если с текущим сайтом не связанА группа O365Group, это свойство будет не определено.
id	GUID, определяющий SPSite на сервере.
isNoScriptEnabled	Возвращает значение true, если isNoScript включен для SPSite.
recycleBinItemCount	Количество элементов в корзине.
serverRelativeUrl	Возвращает связанный с сервером URL-адрес для SPSite.
serverRequestPath	Возвращает serverRelativeUrl исходного запроса.
sitePagesEnabled	Возвращает значение true, если SitePages включен для SPSite.
sitePagesFeatureVersion	Возвращает номер версии компонента страниц сайта, если он определен на этом сайте SPSite. Например, для версии 16.0.4.0 возвращается значение 4.

Сведения о свойстве

absoluteUrl

Возвращает абсолютный URL-адрес SPSite.

readonly absoluteUrl: string;

Значение свойства

string

Комментарии

Пример: "https://example.com/sites/PubSite"

cdnPrefix

Возвращает префикс указанного cdn приложения или пустую строку, если ее нет.

readonly cdnPrefix: string;

Значение свойства

string

classification

Возвращает классификацию сайта.

readonly classification: string;

Значение свойства

string

correlationId

Возвращает идентификатор корреляции для текущего запроса сервера.

readonly correlationId: Guid;

Значение свойства

Guid

group

Контекстные сведения о группе O365, связанной с этим сайтом. Если с текущим сайтом не связанА группа O365Group, это свойство будет не определено.

readonly group: O365GroupAssociation | undefined;

Значение свойства

O365GroupAssociation | undefined

id

GUID, определяющий SPSite на сервере.

readonly id: Guid;

Значение свойства

Guid

isNoScriptEnabled

Возвращает значение true, если isNoScript включен для SPSite.

readonly isNoScriptEnabled: boolean;

Значение свойства

boolean

recycleBinItemCount

Количество элементов в корзине.

readonly recycleBinItemCount: number;

Значение свойства

number

serverRelativeUrl

Возвращает связанный с сервером URL-адрес для SPSite.

readonly serverRelativeUrl: string;

Значение свойства

string

Комментарии

Пример: "/sites/PubSite".

serverRequestPath

Возвращает serverRelativeUrl исходного запроса.

readonly serverRequestPath: string;

Значение свойства

string

Комментарии

Пример: "/teams/SPClientTest/SitePages/Home.aspx".

sitePagesEnabled

Возвращает значение true, если SitePages включен для SPSite.

readonly sitePagesEnabled: boolean;

Значение свойства

boolean

sitePagesFeatureVersion

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Возвращает номер версии компонента страниц сайта, если он определен на этом сайте SPSite. Например, для версии 16.0.4.0 возвращается значение 4.

readonly sitePagesFeatureVersion: number;

Значение свойства

number