SP. Objeto Web (Object sp.js)

Representa un sitio web de spfnvlongMicrosoft SharePoint Foundation.

Última modificación: lunes, 9 de marzo de 2015

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

var object = new SP.Web()

Miembros

El objeto Web tiene los siguientes miembros.

• Constructor

• Métodos

• Propiedades

Constructor

El objeto Web tiene el siguiente constructor.

Constructor	Descripción
Web	Este miembro está reservado para uso interno y no debe usarse directamente desde el código.

Métodos

El objeto Web tiene los siguientes métodos.

Método	Descripción
applyTheme	Aplica el tema especificado por los contenidos de cada uno de los archivos especificados en los argumentos del sitio.
applyWebTemplate	Aplica la definición de sitio o plantilla de sitio especificada al sitio web al que no se ha aplicado ninguna plantilla.
deleteObject	Elimina el sitio web.
doesPushNotificationSubscriberExist	Comprueba si existe el suscriptor de notificaciones de inserción para el usuario actual con el identificador especificado de la instancia de aplicación del dispositivo.
doesUserHavePermissions	Devuelve si el usuario actual tiene el conjunto de permisos determinado.
ensureUser	Comprueba si el nombre de inicio de sesión especificado pertenece a un usuario válido en el sitio. Si el usuario no existe, agrega el usuario al sitio.
getAppBdcCatalog
getAppBdcCatalogForAppInstance
getAppInstanceById	Recupera una instancia de aplicación instalada en este sitio.
getAppInstancesByProductId	Recupera todas las instancias de aplicación instaladas en este sitio que son instancias de la aplicación especificada.
getAvailableWebTemplates	Devuelve una colección de plantillas de sitio disponibles para el sitio.
getCatalog	Obtiene la galería de plantillas de lista, la galería de plantillas de sitio o la galería de elementos web del sitio web.
getChanges	Devuelve la colección de todos los cambios del registro de cambios realizados dentro del ámbito del sitio, en función de la consulta especificada.
getEntity	Obtiene el tipo de contenido externo especificado en una aplicación del sistema de línea de negocio.
getFileByServerRelativeUrl	Devuelve el objeto de archivo ubicado en la dirección URL relativa al servidor especificada.
getFolderByServerRelativeUrl	Devuelve el objeto de carpeta ubicado en la dirección URL relativa al servidor especificada.
getPushNotificationSubscriber	Obtiene el suscriptor de notificaciones de inserción a través del sitio para el identificador especificado de la instancia de aplicación del dispositivo.
getPushNotificationSubscribersByArgs	Consulta los suscriptores de notificaciones de inserción a través del sitio para el valor especificado de los argumentos personalizados. Los argumentos personalizados nulos o vacíos devolverán suscriptores sin ningún filtro.
getPushNotificationSubscribersByUser	Consulta los suscriptores de notificaciones de inserción a través del sitio para el usuario especificado.
getSubwebsForCurrentUser	Devuelve la colección de sitios secundarios del sitio actual en función de la consulta especificada.
getUserById	Devuelve el usuario correspondiente al identificador de miembro especificado para el sitio actual.
getUserEffectivePermissions	Obtiene el permiso efectivo que el usuario especificado tiene dentro del ámbito de la aplicación actual.
initPropertiesFromJson
loadAndInstallApp	Carga e instala un paquete de aplicaciones en este sitio.
loadAndInstallAppInSpecifiedLocale	Carga e instala un paquete de aplicación en el sitio en una configuración regional especificada.
loadApp	Carga un paquete de aplicación y crea una instancia a partir de él.
mapToIcon	Devuelve el nombre del archivo de imagen del icono que se usa para representar el archivo especificado.
registerPushNotificationSubscriber	Registra al suscriptor para notificaciones de inserción a través del sitio. Si el registro ya existe, el token de servicio se actualiza con el nuevo valor.
unregisterPushNotificationSubscriber	Anula el registro del suscriptor para notificaciones de inserción del sitio.
actualización	Actualiza la base de datos con los cambios realizados en el sitio web.

Propiedades

El objeto Web tiene las siguientes propiedades.

Propiedad	Descripción
allowDesignerForCurrentUser	Obtiene un valor que especifica si se permite al usuario actual usar una aplicación de diseñador para personalizar este sitio.
allowMasterPageEditingForCurrentUser	Obtiene un valor que especifica si se permite al usuario actual editar la página maestra.
allowRevertFromTemplateForCurrentUser	Obtiene un valor que especifica si se permite al usuario actual revertir el sitio a una plantilla de sitio predeterminada.
allowRssFeeds	Obtiene un valor que especifica si el sitio permite fuentes RSS.
allProperties	Obtiene una colección de metadatos para el sitio web.
appInstanceId	El identificador de instancia de la instancia de la aplicación que representa esta web.
associatedMemberGroup	Obtiene o establece el grupo de usuarios a los que se han asignado permisos de colaboración en el sitio web.
associatedOwnerGroup	Obtiene o establece el grupo de propietarios asociados del sitio web.
associatedVisitorGroup	Obtiene o establece el grupo de visitantes asociados del sitio web.
availableContentTypes	Obtiene la colección de todos los tipos de contenido que se aplican al ámbito actual, incluidos los del sitio web actual al igual que los de cualquier sitio web primario.
availableFields	Obtiene un valor que especifica la colección de todos los campos disponibles para el ámbito actual, incluidos los del sitio actual al igual que los de cualquier sitio primario.
configuración	Obtiene el identificador (Id.) de la configuración de la definición de sitios que se usó para crear el sitio o el identificador de la configuración de la definición de sitios desde la que se derivó la plantilla de sitios usada para crear el sitio.
contentTypes	Obtiene la colección de los tipos de contenido del sitio web.
creado	Obtiene un valor que especifica cuándo se creó el sitio.
currentUser	Obtiene el usuario actual del sitio.
customMasterUrl	Obtiene o establece la dirección URL para un archivo de página maestra personalizada para aplicar al sitio web.
Descripción	Obtiene o establece la descripción del sitio.
documentLibraryCalloutOfficeWebAppPreviewersDisabled	Determina si los controladores de vista previa WAC de las llamadas a la biblioteca de documentos están habilitados o no.
effectiveBasePermissions	Obtiene un valor que especifica los permisos efectivos asignados al usuario actual.
enableMinimalDownload	Obtiene o establece un valor booleano que especifica si el sitio web debería usar la estrategia de descarga mínima.
eventReceivers	Obtiene la colección de definiciones de receptores de eventos que hay actualmente disponibles en el sitio web.
características	Obtiene un valor que especifica la colección de características activas actualmente en el sitio.
Campos	Obtiene la colección de objetos de campo que representa todos los campos del sitio web.
Carpetas	Obtiene la colección de todas las carpetas de primer nivel del sitio web.
Id.	Obtiene un valor que especifica el identificador de sitio del sitio.
idioma	Obtiene un valor que especifica el LCID del idioma usado en el sitio.
lastItemModifiedDate	Obtiene un valor que especifica cuándo se modificó por última vez un elemento en el sitio.
Listas	Obtiene la colección de todas las listas incluidas en el sitio web disponibles para el usuario actual en función de sus permisos.
listTemplates	Obtiene un valor que especifica la colección de definiciones de lista y plantillas de lista disponibles para crear listas en el sitio.
masterUrl	Obtiene o establece la dirección URL de la página maestra que se usa para el sitio web.
navegación	Obtiene un valor que especifica la estructura de navegación del sitio, incluidas el área Inicio rápido y la barra de navegación superior.
parentWeb	Obtiene el sitio web primario del sitio web especificado.
pushNotificationSubscribers	Obtiene la colección de suscriptores de notificación de inserción a través del sitio.
quickLaunchEnabled	Obtiene o establece un valor que especifica si el área Inicio rápido está habilitada en el sitio.
recycleBin	Especifica la colección de elementos de papelera de reciclaje de la papelera de reciclaje del sitio.
recycleBinEnabled	Obtiene o establece un valor que determina si la papelera de reciclaje está habilitada para el sitio web.
regionalSettings	Obtiene la configuración regional que está actualmente implementada en el sitio web.
roleDefinitions	Obtiene la colección de las definiciones de roles del sitio web.
rootFolder	Obtiene la carpeta raíz del sitio web.
saveSiteAsTemplateEnabled	Obtiene o establece un valor booleano que especifica si el sitio web se puede guardar como plantilla de sitio.
serverRelativeUrl	Obtiene o establece la dirección URL relativa al servidor del sitio web.
showUrlStructureForCurrentUser	Obtiene un valor que especifica si el usuario actual puede ver la estructura del sistema de archivos de este sitio.
siteGroups	Obtiene la colección de grupos de la colección de sitios.
siteUserInfoList	Obtiene la lista UserInfo de la colección de sitios que contiene el sitio web.
siteUsers	Obtiene la colección de todos los usuarios que pertenecen a la colección de sitios.
supportedUILanguageIds	Especifica los identificadores de configuración regional (LCID) de los idiomas que están habilitados para el sitio.
syndicationEnabled	Obtiene o establece un valor que especifica si las fuentes RSS están habilitadas en el sitio.
themeInfo	La información del tema de este sitio. Esto incluye información como colores, fuentes, tamaños de radios del borde, etc.
título	Obtiene o establece el título del sitio web.
treeViewEnabled	Obtiene o establece un valor que especifica si la vista de árbol está habilitada en el sitio.
uiVersion	Obtiene o establece la versión de la interfaz de usuario (UI) del sitio web.
uiVersionConfigurationEnabled	Obtiene o establece un valor que especifica si se muestra u oculta la interfaz de usuario de configuración para la actualización visual.
dirección URL	Obtiene la dirección URL absoluta del sitio web.
userCustomActions	Obtiene un valor que especifica la colección de acciones personalizadas de usuario del sitio.
Webs	Obtiene el objeto de colección de sitios web que representa todos los sitios web que se encuentran inmediatamente por debajo del sitio web, a excepción de sus sitios web secundarios.
webTemplate	Obtiene el nombre de la definición de sitios o la plantilla de sitios que se usó para crear el sitio.
workflowAssociations	Obtiene un valor que especifica la colección de todas las asociaciones de flujo de trabajo del sitio.
workflowTemplates	Obtiene un valor que especifica la colección de plantillas de flujo de trabajo asociadas con el sitio.

Ejemplo

En el ejemplo siguiente se crea un botón de entrada en una página de aplicación que muestra información acerca de un subsitio.

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

Extremo del recurso de REST

Consulte Recurso web para más información.

Estructura de URI de extremo

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

Solicitudes HTTP

Este recurso admite los siguientes comandos HTTP:

• Delete

Sintaxis de DELETE

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

Sintaxis de MERGE

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

Sintaxis de POST

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

Sintaxis de PUT

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