Objet SP.ClientContext (sp.js)

Article
04/08/2016

Représente le contexte des objets et des opérations.

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

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

var object = new SP.ClientContext()

Membres

L’objet ClientContext possède les membres suivants.

Constructeur

L’objet ClientContext présente le constructeur suivant.

Constructeur	Description
ClientContext	Initialise une nouvelle instance de l'objet ClientContext pour le site SharePoint spécifié.

Méthodes

L’objet ClientContext dispose des méthodes suivantes.

Méthode	Description
castTo	Effectuer un cast de l'objet de client spécifié à un type dérivé.
dispose	Supprime le contexte.
executeQueryAsync	Exécute de façon asynchrone en attente de la demande en cours sur le serveur.
load	Récupère les propriétés d'un objet de client à partir du serveur.
loadQuery	Récupère une séquence énumérable d'objets de clients enfants de la collection spécifiée.
onExecutingWebRequest	Déclenche l’événementExecutingWebRequestÉvénement
parseObjectFromJsonString	Analyse le texte spécifiéJSONchaîne et obtient un objet à partir de celui-ci.

Propriétés

L’objet ClientContext possède les propriétés suivantes.

Propriété	Description
applicationName	Obtient ou définit le nom du runtime où se trouve l'application cliente en cours.
current	Obtient le contexte client actuel de l’exécution du modèle CSOM.
formDigestHandlingEnabled	Obtient ou définit une valeur qui indique si le chiffrement de formulaire gestion est activée.
hasPendingRequest	Obtient une valeur qui indique si le contexte client a une demande en attente.
pendingRequest	Obtient la demande du client qui est envoyée au serveur lors de la prochaineexecuteQueryAsyncméthode est exécutée.
requestTimeout	Obtient ou définit le délai d'attente de la demande en millisecondes
serverLibraryVersion	Obtient la version de build de Microsoft.SharePoint.Client.ServerRuntime.dll sur le serveur.
serverSchemaVersion	Obtient la version de schéma de Microsoft.SharePoint.Client.ServerRuntime.dll sur le serveur.
serverVersion	Obtient la version de l’instance actuelle deSharePoint 2013.
site	Obtient la collection de sites associée au contexte client.
traceCorrelationId	Obtient ou définit l'ID de corrélation de suivi utilisé par le serveur.
url	Obtient l'URL associée au contexte d'exécution.
web	Obtient le site web associé au contexte client.

Remarques

Utilisez l’objet ClientContext pour renvoyer des informations contextuelles sur l’application web, le site, la collection de sites ou la version du serveur en cours d’utilisation.

Exemple

L’exemple de code suivant crée une instance de l’objet de contexte client utilisée pour accéder au modèle objet SharePoint. L’exemple obtient le contexte actuel à l’aide de la propriété current.

var clientContext;
var website;

// Make sure the SharePoint script file 'sp.js' is loaded before your
// code runs.
SP.SOD.executeFunc('sp.js', 'SP.ClientContext', sharePointReady);

// Create an instance of the current context.
function sharePointReady() {
    clientContext = SP.ClientContext.get_current();
    website = clientContext.get_web();

    clientContext.load(website);
    clientContext.executeQueryAsync(onRequestSucceeded, onRequestFailed);
}
function onRequestSucceeded() {
    alert(website.get_url());
}
function onRequestFailed(sender, args) {
    alert('Error: ' + args.get_message());
}

Voir aussi

Autres ressources

Procédure : effectuer des opérations de base avec du code de bibliothèque JavaScript dans SharePoint 2013