Partager via

SPSite class

Paquet:
@microsoft/sp-page-context

Cette classe est principalement utilisée avec la PageContext classe . Il fournit des informations contextuelles pour la collection de sites SharePoint (« SPSite ») qui héberge la page.

Remarques

Le constructeur de cette classe est marqué comme interne. Le code tiers ne doit pas appeler directement le constructeur ou créer des sous-classes qui étendent la SPSite classe.

Propriétés

absoluteUrl

Retourne l’URL absolue de ce SPSite.
cdnPrefix

Retourne le préfixe du cdn spécifié de l’application ou une chaîne vide s’il n’y en a pas.
classification

Retourne la classification du site.
correlationId

Retourne l’ID de corrélation à la demande de serveur actuelle.
group

Informations contextuelles sur le groupe O365 associé à ce site. Si aucun O365Group n’est associé au site actuel, cette propriété n’est pas définie.
id

GUID qui identifie le SPSite sur le serveur.
isNoScriptEnabled

Retourne true si isNoScript a été activé sur le SPSite.
recycleBinItemCount

Quantité d’éléments dans la corbeille.
serverRelativeUrl

Retourne l’URL relative du serveur pour ce SPSite.
serverRequestPath

Retourne serverRelativeUrl de la requête d’origine.
sitePagesEnabled

Renvoie la valeur true si SitePages sont activés sur ce SPSite.
sitePagesFeatureVersion

Retourne le numéro de version de fonctionnalité des pages de site s’il est défini sur ce SPSite. Par exemple, pour la version 16.0.4.0, la valeur 4 est retournée.

Détails de la propriété

absoluteUrl

Retourne l’URL absolue de ce SPSite.

readonly absoluteUrl: string;

Valeur de propriété

string

Remarques

Exemple : "https://example.com/sites/PubSite" ;

cdnPrefix

Retourne le préfixe du cdn spécifié de l’application ou une chaîne vide s’il n’y en a pas.

readonly cdnPrefix: string;

Valeur de propriété

string

classification

Retourne la classification du site.

readonly classification: string;

Valeur de propriété

string

correlationId

Retourne l’ID de corrélation à la demande de serveur actuelle.

readonly correlationId: Guid;

Valeur de propriété

Guid

group

Informations contextuelles sur le groupe O365 associé à ce site. Si aucun O365Group n’est associé au site actuel, cette propriété n’est pas définie.

readonly group: O365GroupAssociation | undefined;

Valeur de propriété

O365GroupAssociation | undefined

id

GUID qui identifie le SPSite sur le serveur.

readonly id: Guid;

Valeur de propriété

Guid

isNoScriptEnabled

Retourne true si isNoScript a été activé sur le SPSite.

readonly isNoScriptEnabled: boolean;

Valeur de propriété

boolean

recycleBinItemCount

Quantité d’éléments dans la corbeille.

readonly recycleBinItemCount: number;

Valeur de propriété

number

serverRelativeUrl

Retourne l’URL relative du serveur pour ce SPSite.

readonly serverRelativeUrl: string;

Valeur de propriété

string

Remarques

Exemple : « /sites/PubSite »

serverRequestPath

Retourne serverRelativeUrl de la requête d’origine.

readonly serverRequestPath: string;

Valeur de propriété

string

Remarques

Exemple : « /teams/SPClientTest/SitePages/Home.aspx »

sitePagesEnabled

Renvoie la valeur true si SitePages sont activés sur ce SPSite.

readonly sitePagesEnabled: boolean;

Valeur de propriété

boolean

sitePagesFeatureVersion

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Retourne le numéro de version de fonctionnalité des pages de site s’il est défini sur ce SPSite. Par exemple, pour la version 16.0.4.0, la valeur 4 est retournée.

readonly sitePagesFeatureVersion: number;

Valeur de propriété

number