SP. Web object (sp.js)

Статья
02/03/2016

Представляет Microsoft SharePoint Foundation веб-сайта.

Дата последнего изменения: 9 марта 2015 г.

Область применения: apps for SharePoint | SharePoint Foundation 2013 | SharePoint Server 2013

var object = new SP.Web()

Элементы

Объект Web содержит следующие элементы.

Конструктор

Объект Web имеет следующий конструктор.

Конструктор	Описание
Интернет	Инициализирует новый экземпляр объекта SP.RegionalSettings.

Методы

Объект Web содержит следующие методы.

Метод	Описание
applyTheme	Изменение представления.
applyWebTemplate	Задает определение или шаблон сайта, используемые для создания экземпляра сайта.
deleteObject	Удаляет веб-сайт.
doesPushNotificationSubscriberExist	Получает уникальный идентификатор объекта SP. Установлено object (sp.js).
doesUserHavePermissions	Предоставляет операции доступа и изменения для существующих веб-частей на странице веб-частей, а также операции для добавления новых веб-частей на страницу.
ensureUser	Получает или задает логическое значение, указывающее, скрыт ли список.
getAppBdcCatalog
getAppBdcCatalogForAppInstance
getAppInstanceById	Возвращает из коллекции группу по идентификатору участника.
getAppInstancesByProductId	, используемого для представления.
getAvailableWebTemplates	Получает веб-сайт, связанный с клиентским контекстом.
getCatalog	Получает коллекцию шаблонов списков, сайтов или веб-частей для веб-сайта.
getChanges	, указывающее, является ли поле производным от базового типа.
getEntity	Получает указанный внешний тип контента в бизнес-приложении.
getFileByServerRelativeUrl	Получает или задает значение, указывающее, включены ли в запрос изменения представлений.
getFolderByServerRelativeUrl	Представляет элемент управления поля выбора.
getPushNotificationSubscriber	Фиксирует изменение свойств представления списка.
getPushNotificationSubscribersByArgs	Запрашивает у подписчиков push-уведомлений на сайте указанное значение настраиваемых аргументов. Настраиваемые аргументы со значением Null или пустые настраиваемые аргументы будут возвращать подписчиков без фильтрации.
getPushNotificationSubscribersByUser	Получает значение, которое указывает размещение символов A.M. и P.M.: до или после строки времени.
getSubwebsForCurrentUser	Возвращает коллекцию дочерних сайтов текущего сайта по указанному запросу.
getUserById	Возвращает пользователя, соответствующего указанному идентификатору участника для текущего сайта.
getUserEffectivePermissions	Задает тип субъекта.
initPropertiesFromJson
loadAndInstallApp	Задает указанное разрешение для текущего экземпляра.
loadAndInstallAppInSpecifiedLocale	Передает и устанавливает пакет приложений на сайте с указанным языковым стандартом.
loadApp	Получает абсолютный URL-адрес сайта, созданного при установке экземпляра приложения, которое используется для размещения компонентов SharePoint.
mapToIcon	Задает свойства нового сайта.
registerPushNotificationSubscriber	Получает значение, задающее имя для входа субъекта.
unregisterPushNotificationSubscriber	Отменяет регистрацию подписчика на получение push-уведомлений с сайта.
обновление	Инициализирует новый экземпляр объекта SP.ChangeQuery.

Properties

Объект Web имеет следующие свойства.

Свойство	Описание
allowDesignerForCurrentUser	Получает значение, указывающее, может ли текущий пользователь использовать приложение-конструктор для настройки этого сайта.
allowMasterPageEditingForCurrentUser	Уникальный идентификатор назначения ролей.
allowRevertFromTemplateForCurrentUser	Получает значение, указывающее, может ли текущий пользователь вернуть сайт к шаблону по умолчанию.
allowRssFeeds	Получает значение, указывающее, допускает ли сайт использование RSS-каналов.
allProperties	Добавляет в коллекцию новое назначение ролей с указанным субъектом и определениями ролей.
appInstanceId	reservemember
associatedMemberGroup	Задает поле, которое может содержать несколько строк текста.
associatedOwnerGroup	Получает подписчика push-уведомлений на сайте для указанного идентификатора экземпляра приложения устройства.
associatedVisitorGroup	Получает или задает связанную группу посетителей веб-сайта.
availableContentTypes	reservemember
availableFields	Получает значение, указывающее коллекцию всех полей, доступных в текущей области, включая типы текущего и всех родительских сайтов.
Конфигурация	Задает по указанному запросу коллекцию изменений семейства веб-сайтов из журнала, которые происходили в семействе веб-сайтов.
contentTypes	Представляет тип контента для веб-сайта или списка.
создан	Получает или задает значение, указывающее, включены ли в запрос обновления.
currentUser	reservemember
customMasterUrl	Получает или задает URL-адрес файла настраиваемой главной страницы, применяемый к веб-сайту.
Описание	Свойство, указывающее на возможность обновления данного объекта.
documentLibraryCalloutOfficeWebAppPreviewersDisabled	Удаляет межсайтовую группу с указанным именем из коллекции.
effectiveBasePermissions	Получает или задает значение, указывающее предполагаемые поля, которые будут использоваться в представлении списка.
enableMinimalDownload	Представляет уникальное последовательное расположение изменения в журнале изменений.
eventReceivers	Получает или задает значение, указывающее конечное число шкалы оценки.
функции	.
поля	Получает коллекцию объектов полей, представляющую все поля веб-сайта.
папки	Сведения о темах для данного сайта, включая информацию о цветах, шрифтах, радиусах границ и т. д.
Идентификатор	Задает свойства, используемые как параметры при инициализации нового типа контента.
язык	Добавляет в коллекцию новый веб-сайт.
lastItemModifiedDate	Продолжает сеанс отправки блока с дополнительным фрагментом. Текущее содержимое файла не изменяется.
списки	Получает значение, задающее идентификатор элемента корзины.
listTemplates	Получает значение, задающее коллекцию пользовательских дополнительных действий в семействе веб-сайтов.
masterUrl	Получает или задает URL-адрес изображения, связанного с дополнительным действием.
Навигация	Получает значение, задающее структуру навигации сайта, включая панель быстрого запуска и верхнюю панель навигации.
parentWeb	.
pushNotificationSubscribers	Приводит указанный клиентский объект к производному типу.
quickLaunchEnabled	Получает или задает значение, указывающее, является ли новый элемент списка файлом или папкой.
recycleBin	reservemember
recycleBinEnabled	Получает или задает значение, указывающее, включена ли корзина для веб-сайта.
regionalSettings	Получает региональные параметры, в настоящее время реализованные на веб-сайте.
roleDefinitions	Получает символ, используемый для представления отрицательного знака на сервере.
rootFolder	Получает заголовок приложения SharePoint.
saveSiteAsTemplateEnabled	Представляет сопоставление шаблона рабочих процессов с определенным списком или типом контента, содержащее члены, которые возвращают дополнительные сведения о сопоставлении рабочего процесса с этим списком или типом.
serverRelativeUrl	Получает или задает зависящий от сервера URL-адрес веб-сайта.
showUrlStructureForCurrentUser	Получает эффективные разрешения указанного пользователя в пределах области текущего приложения.
siteGroups	reservemember
siteUserInfoList	Получает значение, задающее идентификатор сопоставления рабочих процессов.
siteUsers	Получает или задает значение, которое указывает отображаемый текст, соответствующий средней оценке на шкале.
supportedUILanguageIds	Добавляет в коллекцию пользователя, указанного параметром сведений для создания пользователя.
syndicationEnabled	Получает или задает значение, указывающее, включены ли RSS-каналы на сайте.
themeInfo	.
Заголовок	Получает или задает заголовок веб-сайта.
treeViewEnabled	Получает значение, указывающее сайт, который содержит измененное представление.
uiVersion	Получает или задает версию пользовательского интерфейса веб-сайта.
uiVersionConfigurationEnabled	Получает или задает значение, указывающее, отображаются ли параметры пользовательского интерфейса визуального обновления.
URL-адрес	Получает назначение ролей по указанному индексу в коллекции.
userCustomActions	Получает значение, задающее отображаемое имя элемента списка.
веб-сайтов	Получает объект семейства веб-сайтов, представляющий все его непосредственные дочерние веб-сайты, но не их дочерние веб-сайты.
webTemplate	Инициализирует новый экземпляр объекта SP.ChangeView.
workflowAssociations	Этот класс определяет результат общего доступа для отдельного пользователя, который возвращается с помощью метода UpdateDocumentSharingInfo.
workflowTemplates	Получает шаблон рабочих процессов по указанному индексу в коллекции.

Пример

В следующем примере создается кнопку ввода на страницу приложения, которое отображает сведения об дочернего сайта.

<asp:Content ID="Main" ContentPlaceHolderID="PlaceHolderMain" runat="server">
<script type="text/ecmascript" language="ecmascript">

    var targetWeb;

    function runCode() {
        // Specify a client context using the server-relative URL of the sub web, load the sub web, and call the ExecuteQueryAsync method.
        var clientContext = new SP.ClientContext('/MySubWeb');
        targetWeb = clientContext.get_web();
        clientContext.load(targetWeb);
        clientContext.executeQueryAsync(Function.createDelegate(this, this.onQuerySucceeded), Function.createDelegate(this, this.onQueryFailed));
    }

    function onQuerySucceeded() {
        // On success, use get_ property assessor methods to return the value of the Title, ID, Language, uiVersion, Description, and Created properties of the SP.Web object.
        var message = "Web retrieved:";
        message += "\n Title: " + targetWeb.get_title();
        message += "\n ID: " + targetWeb.get_id();
        message += "\n Language: " + targetWeb.get_language();
        message += "\n UI Version: " + targetWeb.get_uiVersion();
        message += "\n Description: " + targetWeb.get_description();
        message += "\n Created: " + targetWeb.get_created();
        alert(message);
    }

    function onQueryFailed(sender, args) {
        alert('Request failed. \nError: ' + args.get_message() + '\nStackTrace: ' + args.get_stackTrace());
    }

</script>

    <input id="Button1" type="button" value="Run Code" onclick="runCode()" />

</asp:Content>

Конечная точка ресурса REST

Дополнительные сведения см. в разделе Веб-ресурс.

Структура URI конечной точки

http://<sitecollection>/<site>/_api/web

Запросы HTTP

Этот ресурс поддерживает следующие команды HTTP:

Delete.

Синтаксис DELETE

DELETE http://<sitecollection>/<site>/_api/web

Синтаксис MERGE

MERGE http://<sitecollection>/<site>/_api/web

Синтаксис POST

POST http://<sitecollection>/<site>/_api/web

Синтаксис PUT

PUT http://<sitecollection>/<site>/_api/web

Share via