SP. Método Web.getSubwebsForCurrentUser (sp.js)

Devuelve la colección de sitios secundarios del sitio actual en función de la consulta especificada.

Última modificación: domingo, 27 de abril de 2014

Hace referencia a: apps for SharePoint | SharePoint Foundation 2013 | SharePoint Server 2013

SP.Web.getSubwebsForCurrentUser()

Parámetros

• query
  Tipo: SP SubwebQuery

  Especifica los secundarios de sitios para devolver.

Valor devuelto

Tipo: SP WebCollection

Los subsitios.

Observaciones

Si la consulta no es válida, el servidor debe devolver una colección vacía.

Ejemplo

En el ejemplo siguiente se crea un botón de entrada en una página de aplicación que muestra los títulos de los sitios secundarios del sitio actual.

<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>

Extremo del recurso de REST

Consulte Recurso web para más información.

Estructura de URI de extremo

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

Solicitudes HTTP

Este recurso admite los siguientes comandos HTTP:

• Post

Sintaxis de POST

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

Parámetros del recurso

• query