SP. Objet de site (sp.js)

Article
04/08/2016

Représente une collection de sites dans une application web, incluant un site web de niveau supérieur et tous ses sous-sites.

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

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

Dans cet article
Membres
Remarques
Point de terminaison de ressource REST

var object = new SP.Site()

Membres

L'objet Site a les membres suivants.

Constructeur

L'objet Site a le constructeur suivant.

Constructeur	Description
Site	Initialise une nouvelle instance de l’objet SP.Site.

Méthodes

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

Méthode	Description
createPreviewSPSite	Crée une évaluation temporaire SPSite pour cette SPSite, afin de déterminer si une mise à niveau est susceptible d'être réussie.
extendUpgradeReminderDate	Étendre la date de mise à niveau de rappel pour cette SPSite selon les jours spécifiés lors de le WebApplication.UpgradeReminderDelay.
getCatalog	Spécifie la galerie de modèles de liste, la galerie de modèles de site, la galerie de composants WebPart, la galerie de pages maîtres ou d’autres galeries dans la collection de sites, notamment les galeries personnalisées définies par les utilisateurs.
getChanges	Retourne la collection des modifications de la collection de sites enregistrées dans le journal des modifications et qui se sont produites dans l’étendue de la collection de sites, en fonction de la requête spécifiée.
getCustomListTemplates	Spécifie la collection de modèles de liste personnalisés pour un site donné.
getWebTemplates	Retourne la collection de définitions de site disponibles pour la création de sites Web au sein de la collection de sites.
initPropertiesFromJson
invalider	Invalide les informations de mise à niveau mis en cache sur la collection de sites afin que cette information est recalculée la prochaine fois que cela est nécessaire.
needsUpgradeByType	TrueSi l'objet doit être mis à niveau ; dans le cas contraire,False.
openWeb	Renvoie le site à l'URL spécifiée.
openWebById	Retourne le site portant le GUID spécifié.
runHealthCheck	Exécute une vérification d'intégrité comme suit. (Les règles d'intégrité référencés ci-dessous permet d'effectuer une vérification dépend de l'implémentation de l'intégrité d'une collection de sites)
runUpgradeSiteSession	Exécute une mise à niveau de collection de sites, ou planifie pour être exécuté à l'avenir, en fonction des ressources système disponibles et la valeur du paramètre queueOnly.L'utilisateur qui exécute cette méthode doit être un administrateur de batterie de serveurs ou un administrateur de collection de sites.
updateClientObjectModelUseRemoteAPIsPermissionSetting	Indique si les demandes de (CSOM) de modèle objet côté client qui sont effectuées dans le contexte d'un site à l'intérieur de la collection de sites nécessitent UseRemoteAPIs autorisation.

Propriétés

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

Propriété	Description
allowDesigner	Obtient ou définit une valeur qui indique si un concepteur peut être utilisé sur cette collection de sites.
allowMasterPageEditing	Obtient ou définit une valeur qui indique si la modification de la page maître est autorisée sur cette collection de sites.
allowRevertFromTemplate	Obtient ou définit une valeur qui indique si cette collection de sites peut être rétablie à son modèle de base.
allowSelfServiceUpgrade	Si la mise à niveau de version à l'autre est autorisé sur ce site.
allowSelfServiceUpgradeEvaluation	Indique si la collection de sites d'évaluation de mise à niveau est autorisée.
canUpgrade	Propriété qui indique si cet objet peut être mis à niveau.
compatibilityLevel	Obtient la version principale de cette collection de sites à des fins de vérifications de compatibilité d'au niveau de la version majeure.
eventReceivers	Fournit des récepteurs d'événements pour les événements qui se produisent au niveau de l'étendue de la collection de sites.
Fonctionnalités	Obtient une valeur qui spécifie la collection des fonctionnalités de la collection de sites contenant le site.
ID	Obtient le GUID qui identifie la collection de sites.
lockIssue	Obtient ou définit le commentaire qui est utilisé dans le verrouillage d'une collection de sites.
maxItemsPerThrottledOperation	Obtient une valeur qui spécifie le nombre maximal d’éléments de liste autorisé par opération au-delà duquel se produit une limitation.
Propriétaire	Obtient ou définit le propriétaire de la collection de sites. (En lecture seule danssolutions bac à sable.)
primaryUri	Spécifie l'URI de cette collection de sites, y compris le nom d'hôte, le numéro de port et le chemin principal.
readOnly	Obtient ou définit uneBooléennevaleur qui indique si la collection de sites est en lecture seule, verrouillée et indisponible pour un accès en écriture.
recycleBin	Obtient une valeur qui spécifie la collection d’éléments de la Corbeille pour la collection de sites.
rootWeb	Obtient une valeur qui retourne le site de niveau supérieur de la collection de sites.
serverRelativeUrl	Obtient l’URL relative de serveur du site web racine dans la collection de sites.
shareByLinkEnabled	Propriété qui indique si les utilisateurs seront en mesure de partager des liens vers des documents qui est accessible sans se connecter.
showUrlStructure	Obtient ou définit une valeur qui indique si la structure d’URL de cette collection de sites est visualisable.
uiVersionConfigurationEnabled	Obtient ou définit une valeur qui indique si l’interface utilisateur de la mise à niveau visuelle de cette collection de sites apparaît.
upgradeInfo	Spécifie les informations de mise à niveau de cette collection de sites.
upgradeReminderDate	Spécifie une date, après lequel les administrateurs de collection de sites un rappel de mise à niveau de la collection de sites.
Mise à niveau	Spécifie si le site est actuellement mise à niveau.
« url »	Obtient l’URL complète du site web racine de la collection de sites, incluant le nom d’hôte, le numéro de port et le chemin d’accès.
Utilisation	Obtient une valeur qui spécifie les informations d’utilisation du site, notamment la bande passante, le stockage et le nombre de visites de la collection de sites.
userCustomActions	Obtient une valeur qui spécifie la collection d’actions personnalisées utilisateur pour la collection de sites.

Remarques

Chaque objet de Site ou une collection de sites, est représentée dans un objet SiteCollection qui se compose de la collection de toutes les collections de sites dans l'application Web.

La propriété Usage n'est pas incluse dans la propriété scalaire par défaut définie pour ce type.

Point de terminaison de ressource REST

Structure des URI de point de terminaison

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

Requêtes HTTP

Cette ressource prend en charge les commandes HTTP suivantes :

Post

Syntaxe POST

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

Partager via