SP. Метод Web.getSubwebsForCurrentUser (sp.js)

Статья
02/03/2016

Возвращает коллекцию дочерних сайтов текущего сайта на основе указанного запроса.

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

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

SP.Web.getSubwebsForCurrentUser()

Параметры

query
Тип: SP. SubwebQuery

Указывает, какие дочерние узлы для возврата.

Возвращаемое значение

Тип: SP. WebCollection

Дочерние сайты.

Замечания

Если запрос не является допустимым, сервер должен вернуть пустую коллекцию.

Пример

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

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

    var webCollection = null;
    function runCode() {

        var clientContext = new SP.ClientContext.get_current();
        if (clientContext != undefined && clientContext != null) {
            var web = clientContext.get_web();

            this.webCollection = web.getSubwebsForCurrentUser(null);

            clientContext.load(this.webCollection);
            clientContext.executeQueryAsync(Function.createDelegate(this, this.onQuerySucceeded), Function.createDelegate(this, this.onQueryFailed));
        }
    }

    function onQuerySucceeded() {
        var webInfo = 'Child sites of the current site: \n\n';
        var webEnumerator = this.webCollection.getEnumerator();
        while (webEnumerator.moveNext()) {
            var web = webEnumerator.get_current();
            webInfo += web.get_title() + '\n';
        }
        alert(webInfo);
    }

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

</script>

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

</asp:Content>

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

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

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

http://<sitecollection>/<site>/_api/web/getSubwebsForCurrentUser(query)

Запросы HTTP

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

POST

Синтаксис POST

POST http://<sitecollection>/<site>/_api/web/getSubwebsForCurrentUser(query)

Параметры ресурса

query

Поделиться через