Objeto SP.ClientContext (sp.js)

Artículo
01/19/2016

Representa el contexto de operaciones y objetos.

Ú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.ClientContext()

Miembros

El objeto ClientContext tiene los siguientes miembros.

Constructor

El objeto ClientContext tiene el siguiente constructor.

Constructor	Descripción
ClientContext	Inicializa una nueva instancia del objeto ClientContext para el sitio de SharePoint especificado.

Métodos

El objeto ClientContext tiene los siguientes métodos.

Método	Descripción
castTo	Convierte el objeto de cliente especificado en un tipo derivado.
dispose	Desecha el contexto.
executeQueryAsync	Ejecuta la solicitud pendiente actual de forma asincrónica en el servidor.
load	Recupera las propiedades de un objeto de cliente desde el servidor.
loadQuery	Recupera una secuencia enumerable de objetos de cliente secundarios desde la colección especificada.
onExecutingWebRequest	Genera el eventoExecutingWebRequest.
parseObjectFromJsonString	Analiza la cadenaNotación de objetos de JavaScript (JSON)especificada y obtiene un objeto de ella.

Propiedades

El objeto ClientContext tiene las siguientes propiedades.

Propiedad	Description
applicationName	Obtiene o establece el nombre del motor en tiempo de ejecución donde está ubicada la aplicación de cliente actual.
current	Obtiene el contexto de cliente actual del tiempo de ejecución del modelo de objetos de cliente (CSOM).
formDigestHandlingEnabled	Obtiene o establece un valor que indica si está habilitado el tratamiento de síntesis de formularios.
hasPendingRequest	Obtiene un valor que indica si el contexto de cliente tiene una solicitud pendiente.
pendingRequest	Obtiene la solicitud de cliente que se envía al servidor cuando se ejecuta el siguiente métodoexecuteQueryAsync.
requestTimeout	Obtiene o establece el tiempo de espera de solicitud en milisegundos
serverLibraryVersion	Obtiene la versión de compilación de Microsoft.SharePoint.Client.ServerRuntime.dll en el servidor.
serverSchemaVersion	Obtiene la versión del esquema de Microsoft.SharePoint.Client.ServerRuntime.dll en el servidor.
serverVersion	Obtiene la versión de la instancia actual deSharePoint 2013.
site	Obtiene la colección de sitios asociada con el contexto de cliente.
traceCorrelationId	Obtiene o establece el identificador de correlación de seguimientos que usa el servidor.
url	Obtiene la dirección URL asociada con el contexto del motor en tiempo de ejecución.
web	Obtiene el sitio web asociado con el contexto del cliente.

Comentarios

Use el objeto ClientContext para devolver la información de contexto sobre la aplicación web, el sitio, la colección de sitios o la versión del servidor actuales.

Ejemplo

En el siguiente ejemplo de código se crea una instancia del objeto de contexto de cliente, que se utiliza para tener acceso al modelo de objetos de SharePoint. En el ejemplo se obtiene el contexto actual mediante la propiedad 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());
}

Vea también

Otros recursos

Completar operaciones básicas con código de biblioteca de JavaScript en SharePoint 2013