SP. Objet Web (sp.js)

Article
04/08/2016

Cet objet représente un site Web de Microsoft SharePoint Foundation.

**Dernière modification :**lundi 9 mars 2015

**S’applique à :**apps for SharePoint | SharePoint Foundation 2013 | SharePoint Server 2013

var object = new SP.Web()

Membres

L'objet Web a les membres suivants.

Constructeur

L'objet Web a le constructeur suivant.

Constructeur	Description
Web	Ce membre est réservé à une utilisation interne et n’est pas destiné à être utilisé directement à partir de votre code.

Méthodes

L'objet Web possède les méthodes suivantes.

Méthode	Description
applyTheme	Applique le thème spécifié par le contenu de chacun des fichiers spécifiés dans les arguments pour le site.
applyWebTemplate	Applique la définition de site ou le modèle de site spécifié au site web auquel n’est appliqué aucun modèle.
deleteObject	Supprime le site web.
doesPushNotificationSubscriberExist	Vérifie si l'abonné de notification push existent pour l'utilisateur actuel à l'application de périphériques donnée d'instance ID.
doesUserHavePermissions	Indique si l’utilisateur actuel possède le jeu d’autorisations donné.
ensureUser	Vérifie si le nom de connexion spécifié appartient à un utilisateur valide dans le site. Si l'utilisateur n'existe pas, ajoute l'utilisateur au site.
getAppBdcCatalog
getAppBdcCatalogForAppInstance
getAppInstanceById	Récupère un AppInstance installé sur ce Site.
getAppInstancesByProductId	Récupère tous les AppInstances installés sur ce site qui sont des instances de l'application spécifiée.
getAvailableWebTemplates	Retourne une collection de modèles de site disponibles pour le site.
getCatalog	Obtient la galerie de modèles de listes, la galerie de modèles de sites ou la galerie de composants WebPart du site web.
getChanges	Retourne la collection de toutes les modifications enregistrées dans le journal des modifications et qui se sont produites dans l’étendue du site, en fonction de la requête spécifiée.
getEntity	Obtient le type de contenu externe spécifié dans une application de système de métier (LOB).
getFileByServerRelativeUrl	Retourne l’objet de fichier situé à l’URL relative de serveur spécifiée.
getFolderByServerRelativeUrl	Retourne l’objet de dossier situé à l’URL relative de serveur spécifiée.
getPushNotificationSubscriber	Obtient l'abonné aux notifications de type push sur le site pour l'ID d'instance d'application de périphérique spécifié.
getPushNotificationSubscribersByArgs	Requêtes pour les abonnés de notification push sur le site pour la valeur d'arguments personnalisées spécifiée. NULL ou vides arguments personnalisés renverra les abonnés sans aucun filtrage.
getPushNotificationSubscribersByUser	Requêtes pour les abonnés de notification push sur le site pour l'utilisateur spécifié.
getSubwebsForCurrentUser	Retourne la collection de sites enfants du site actuel en fonction de la requête spécifiée.
getUserById	Renvoie l'utilisateur correspondant à l'identificateur de membre spécifié pour le site actuel.
getUserEffectivePermissions	Obtient les autorisations effectives dont dispose l'utilisateur spécifié dans l'étendue d'application en cours.
initPropertiesFromJson
loadAndInstallApp	Télécharge et installe un package d'application pour ce site.
loadAndInstallAppInSpecifiedLocale	Télécharge et installe un package d'application sur le site dans les paramètres régionaux spécifié.
loadApp	Télécharge un package d'application et crée une instance de celle-ci.
mapToIcon	Retourne le nom du fichier image de l’icône utilisée pour la représentation du fichier spécifié.
registerPushNotificationSubscriber	Enregistre l'abonné les notifications push sur le site. Si l'enregistrement n'existe déjà, le jeton de service est mis à jour avec la nouvelle valeur.
unregisterPushNotificationSubscriber	Annule l'inscription de l'abonné pour les notifications push à partir du site.
Mettre à jour	Met à jour la base de données avec les modifications apportées au site web.

Propriétés

L'objet Web possède les propriétés suivantes.

Propriété	Description
allowDesignerForCurrentUser	Obtient une valeur qui indique si l’utilisateur actuel est autorisé à personnaliser ce site à l’aide d’un concepteur.
allowMasterPageEditingForCurrentUser	Obtient une valeur qui indique si l’utilisateur actuel est autorisé à modifier la page maître.
allowRevertFromTemplateForCurrentUser	Obtient une valeur qui indique si l’utilisateur actuel est autorisé à rétablir le site à un modèle de site par défaut.
allowRssFeeds	Obtient une valeur qui indique si le site autorise les flux RSS.
allProperties	Obtient une collection de métadonnées pour le site web.
appInstanceId	L'Id de l'instance de l'Instance d'application qui représente ce site web.
associatedMemberGroup	Obtient ou définit le groupe d’utilisateurs auquel ont été accordées des autorisations de contribution au site web.
associatedOwnerGroup	Obtient ou définit le groupe de propriétaires associé du site web.
associatedVisitorGroup	Obtient ou définit le groupe de visiteurs associé du site web.
availableContentTypes	Obtient la collection de tous les types de contenu qui s’appliquent à l’étendue actuelle, notamment ceux du site web actuel, ainsi que tous les sites web parents.
availableFields	Obtient une valeur qui spécifie la collection de tous les champs disponibles pour l’étendue actuelle, notamment ceux du site actuel, ainsi que tous les sites parents.
Configuration :	Obtient l'identificateur (ID) de la configuration de définition de site qui a servi à créer le site, ou l'ID de la configuration de définition de site à partir de laquelle le modèle de site utilisé pour créer le site a été dérivé.
contentTypes	Obtient la collection de types de contenu du site web.
créé	Obtient une valeur qui spécifie la date de création du site.
currentUser	Obtient l’utilisateur actuel du site.
customMasterUrl	Obtient ou définit l'URL d'un fichier de page maître personnalisée à appliquer au site Web.
Description	Obtient ou définit la description du site.
documentLibraryCalloutOfficeWebAppPreviewersDisabled	Détermine si les générateurs de WAC de la légende de bibliothèque de documents sont activés ou non.
effectiveBasePermissions	Obtient une valeur qui spécifie les autorisations effectives attribuées à l’utilisateur actuel.
enableMinimalDownload	Obtient ou définit une valeur de type Boolean qui indique si le site Web doit utiliser la stratégie de téléchargement Minimal.
eventReceivers	Obtient la collection de définitions de récepteur d'événements qui sont actuellement disponibles sur le site Web.
fonctionnalités	Obtient une valeur qui spécifie la collection de fonctionnalités actuellement activées dans le site.
champs	Obtient la collection d’objets de champ qui représente tous les champs dans le site web.
dossiers	Obtient la collection de tous les dossiers de premier niveau dans le site web.
ID	Obtient une valeur qui spécifie l’identificateur du site.
langue	Obtient une valeur qui spécifie le LCID de la langue utilisée sur le site.
lastItemModifiedDate	Obtient une valeur qui indique la date de dernière modification d’un élément dans le site.
listes	Obtient la collection de toutes les listes qui sont contenues dans le site Web disponible pour l'utilisateur actuel en fonction des autorisations de l'utilisateur actuel.
listTemplates	Obtient une valeur qui spécifie la collection de définitions de liste et de modèles de liste disponibles pour la création de listes sur le site.
masterUrl	Obtient ou définit l'URL de la page maître qui est utilisée pour le site Web.
navigation	Obtient une valeur qui spécifie la structure de navigation sur le site, notamment la zone de la barre de lancement rapide et la barre de navigation supérieure.
parentWeb	Obtient le site Web parent du site Web spécifié.
pushNotificationSubscribers	Obtient la collection de type push abonnés de notification sur le site.
quickLaunchEnabled	Obtient ou définit une valeur qui indique si la zone de la barre de lancement rapide est activée sur le site.
recycleBin	Spécifie la collection d'éléments de la Corbeille de la Corbeille du site.
recycleBinEnabled	Obtient ou définit une valeur qui détermine si la Corbeille est activée pour le site Web.
regionalSettings	Obtient les paramètres régionaux qui sont actuellement mis en œuvre sur le site Web.
roleDefinitions	Obtient la collection des définitions de rôle pour le site web.
rootFolder	Obtient le dossier racine du site web.
saveSiteAsTemplateEnabled	Obtient ou définit une valeur de type Boolean qui indique si le site Web peut être enregistré en tant que modèle de site.
serverRelativeUrl	Obtient ou définit l’URL relative de serveur pour le site web.
showUrlStructureForCurrentUser	Obtient une valeur qui indique si l’utilisateur actuel peut afficher la structure du système de fichiers de ce site.
siteGroups	Obtient la collection de groupes pour la collection de sites.
siteUserInfoList	Obtient la liste UserInfo de la collection de sites qui contient le site web.
siteUsers	Obtient la collection de tous les utilisateurs qui appartiennent à la collection de sites.
supportedUILanguageIds	Spécifie les identificateurs de code de langue (LCID) des langues activées pour le site.
syndicationEnabled	Obtient ou définit une valeur qui indique si les flux RSS sont activés sur le site.
themeInfo	Les informations d'un thème pour ce site. Cela inclut des informations telles que les couleurs, les polices, les tailles de rayons etc. de bordure.
titre	Obtient ou définit le titre du site web.
treeViewEnabled	Obtient ou définit une valeur qui indique si l’arborescence est activée sur le site.
uiVersion	Obtient ou définit la version d’interface utilisateur du site web.
uiVersionConfigurationEnabled	Obtient ou définit une valeur qui indique si l’interface utilisateur des paramètres de la mise à niveau visuelle est affichée ou masquée.
URL	Obtient l'URL absolue du site Web.
userCustomActions	Obtient une valeur qui spécifie la collection d’actions personnalisées utilisateur pour le site.
Webs	Obtient un objet de collection de sites web qui représente tous les sites web situés juste au-dessous du site web, à l’exclusion des enfants de ces sites web.
webTemplate	Obtient le nom de la définition de site ou d'un modèle de site qui a servi à créer le site.
workflowAssociations	Obtient une valeur qui spécifie la collection de toutes les associations de flux de travail pour la site.
workflowTemplates	Obtient une valeur qui spécifie la collection de modèles de flux de travail associés au site.

Exemple

L'exemple suivant crée un bouton input sur une page d'application qui affiche des informations sur un sous-site.

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

Point de terminaison de ressource REST

Pour plus d’informations, voir Ressource web.

Structure des URI de point de terminaison

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

Requêtes HTTP

Cette ressource prend en charge les commandes HTTP suivantes :

Supprimer

Syntaxe DELETE

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

Syntaxe MERGE

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

Syntaxe POST

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

Syntaxe PUT

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

Partager via