SP. Objeto de lista (Object sp.js)

Representa una lista de un sitio web de SharePoint.

Última modificación: lunes, 9 de marzo de 2015

Hace referencia a: apps for SharePoint | SharePoint Foundation 2013 | SharePoint Server 2013

En este artículo
Miembros
Observaciones
Extremo del recurso de REST

var object = new SP.List()

Miembros

El objeto List tiene los siguientes miembros.

• Constructor

• Métodos

• Propiedades

Constructor

El objeto List tiene el siguiente constructor.

Constructor	Descripción
Lista	Inicializa una nueva instancia del objeto SP.List.

Métodos

El objeto List tiene los siguientes métodos.

Método	Descripción
addItem	Crea un nuevo elemento de lista en la lista.
deleteObject	Elimina la lista.
getChanges	Devuelve la colección de los cambios del registro de cambios realizados dentro de la lista, en función de la consulta especificada.
getItemById	Devuelve el elemento de lista con el identificador de elemento de lista especificado.
getItems	Devuelve una colección de elementos de la lista en función de la consulta especificada.
getListItemChangesSinceToken
getRelatedFields	Devuelve una colección de los campos de búsqueda que usan esta lista como un origen de datos y tienen FieldLookup.IsRelationship establecido enverdadero.
getRelatedFieldsExtendedData	Este miembro está reservado para uso interno y no debe usarse directamente desde el código.
getUserEffectivePermissions
getView	Devuelve la vista de lista con el identificador de vista especificado.
reciclaje	Mueve la lista a la papelera de reciclaje y devuelve el identificador del elemento de papelera de reciclaje nuevo.
renderListData
renderListFormData
reserveListItemId
saveAsNewView
actualización	Actualiza la base de datos con los cambios realizados en la lista.

Propiedades

El objeto List tiene las siguientes propiedades.

Propiedad	Descripción
allowContentTypes	Obtiene un valor que especifica si la lista admite tipos de contenido.
baseTemplate	Obtiene el tipo de definición de lista en el que se basa la lista.
baseType	Obtiene el tipo de base de la lista.
browserFileHandling	Obtiene un valor que especifica la invalidación de la propiedadBrowserFileHandlingde la aplicación web en el nivel de la lista.
contentTypes	Obtiene los tipos de contenido asociados con la lista.
contentTypesEnabled	Obtiene o establece un valor que especifica si los tipos de contenido están habilitados para la lista.
creado	Obtiene un valor que especifica cuándo se creó la lista.
dataSource	Obtiene el origen de datos asociado con la lista, o bien obtienenullsi no se trata de una lista virtual.
defaultContentApprovalWorkflowId	Obtiene o establece un valor que especifica el identificador de flujo de trabajo predeterminado para la aprobación de contenido en la lista.
defaultDisplayFormUrl	Obtiene o establece un valor que especifica la ubicación del formulario de presentación predeterminado para la lista.
defaultEditFormUrl	Obtiene o establece un valor que especifica la dirección URL del formulario de edición que se usará para los elementos de lista de la lista.
defaultNewFormUrl	Obtiene o establece un valor que especifica la ubicación del formulario nuevo predeterminado para la lista.
defaultView
defaultViewUrl	Obtiene la dirección URL de la vista predeterminada de la lista.
Descripción	Obtiene o establece un valor que especifica la descripción de la lista.
dirección	Obtiene o establece un valor que especifica el orden de lectura de la lista.
documentTemplateUrl	Obtiene o establece un valor que especifica la dirección URL relativa al servidor de la plantilla de documento de la lista.
draftVersionVisibility	Obtiene o establece un valor que especifica los permisos mínimos necesarios para ver borradores y versiones secundarias dentro de la lista.
effectiveBasePermissions	Obtiene un valor que especifica los permisos efectivos de la lista asignados al usuario actual.
effectiveBasePermissionsForUI
enableAttachments	Obtiene o establece un valor que especifica si los datos adjuntos de elemento de lista están habilitados para la lista.
enableFolderCreation	Obtiene o establece un valor que especifica si se pueden agregar carpetas de lista nuevas a la lista.
enableMinorVersions	Obtiene o establece un valor que especifica si las versiones secundarias están habilitadas para la lista.
enableModeration	Obtiene o establece un valor que especifica si está habilitada la aprobación de contenido para la lista.
enableVersioning	Obtiene o establece un valor que especifica si se pueden crear versiones históricas de los elementos de lista y los documentos en la lista.
entityTypeName
eventReceivers
Campos	Obtiene un valor que especifica la colección de todos los campos de la lista.
forceCheckout	Obtiene o establece un valor que indica si está habilitada la desprotección forzada para la biblioteca de documentos.
formularios	Obtiene un valor que especifica la colección de todos los formularios de lista de la lista.
hasExternalDataSource	Obtiene un valor que especifica si la lista es una lista externa.
Oculto	Obtiene o establece un valor booleano que especifica si la lista está oculta.
Identificador	Obtiene el GUID que identifica la lista en la base de datos.
imageUrl	Obtiene un valor que especifica el URI del icono de la lista.
informationRightsManagementSettings
irmEnabled
irmExpire
irmReject
isApplicationList	Obtiene o establece un valor que especifica una marca que puede usar una aplicación cliente para determinar si se muestra la lista.
isCatalog	Obtiene un valor que especifica si la lista es una galería.
isPrivate
isSiteAssetsLibrary	Obtiene un valor que indica si la lista está designada como una ubicación de activos predeterminada para imágenes u otros archivos que los usuarios cargan en sus páginas wiki.
itemCount	Obtiene un valor que especifica el número de elementos de lista de la lista.
lastItemDeletedDate	Obtiene un valor que especifica la última vez que se eliminó un elemento de lista de la lista.
lastItemModifiedDate	Obtiene un valor que especifica la última vez que se modificó un elemento de lista, un campo o una propiedad de la lista.
listItemEntityTypeFullName
multipleDataList	Obtiene o establece un valor que indica si la lista de un sitio Área de trabajo contiene datos de varias instancias de reunión dentro del sitio.
noCrawl	Obtiene o establece un valor que especifica que el rastreador (crawler) no debe rastrear la lista.
onQuickLaunch	Obtiene o establece un valor que especifica si la lista aparece en el Inicio rápido del sitio.
parentWeb	Obtiene un valor que especifica el sitio que contiene la lista.
parentWebUrl	Obtiene un valor que especifica la dirección URL relativa al servidor del sitio que contiene la lista.
rootFolder	Obtiene la carpeta raíz que contiene los archivos de la lista y cualquier archivo relacionado.
schemaXml	Obtiene un valor que especifica el esquema de lista de la lista.
serverTemplateCanCreateFolders	Obtiene un valor que indica si se pueden crear carpetas dentro de la lista.
templateFeatureId	Obtiene un valor que especifica el identificador de característica de la característica que contiene el esquema de lista de la lista.
Título	Obtiene o establece el título que se muestra para la lista.
userCustomActions	Obtiene un valor que especifica la colección de todas las acciones personalizadas de usuario de la lista.
validationFormula	Obtiene o establece un valor que especifica los criterios de validación de datos de un elemento de lista.
validationMessage	Obtiene o establece un valor que especifica el mensaje de error que se devuelve cuando se produce un error en la validación de datos de un elemento de lista.
vistas	Obtiene un valor que especifica la colección de todas las vistas públicas de la lista y las vistas personales del usuario actual en la lista.
workflowAssociations	Obtiene un valor que especifica la colección de todas las asociaciones de flujo de trabajo de la lista.

Observaciones

Las propiedades BrowserFileHandling, DataSource, EffectiveBasePermissions, HasUniqueRoleAssignments, IsAttachmentLibrary, OnQuickLaunch, SchemaXml, ValidationFormula y ValidationMessage no se incluyen en la propiedad escalar predeterminado establecido para este tipo.

Ejemplo

En el ejemplo siguiente se crea un botón de entrada en una página de aplicación que crea una nueva lista del panel de discusión en el sitio web actual.

<asp:Content ID="Main" ContentPlaceHolderID="PlaceHolderMain" runat="server">
<script type="text/ecmascript" language="ecmascript">

    var list;
    function runCode() {
        var clientContext = new SP.ClientContext.get_current();

        if (clientContext != undefined && clientContext != null) {
            var web = clientContext.get_web();

            // Specify the properties of the new list.
            var listCreationInfo = new SP.ListCreationInformation();
            listCreationInfo.set_title('New Discussion Board');
            listCreationInfo.set_templateType(SP.ListTemplateType.discussionBoard);

            this.list = web.get_lists().add(listCreationInfo);

            clientContext.load(list);
            clientContext.executeQueryAsync(Function.createDelegate(this, this.onQuerySucceeded), Function.createDelegate(this, this.onQueryFailed));
        }
    }

    function onQuerySucceeded() {
        var result = ' Added Discussion Board: ' + this.list.get_title();
        alert(result);
    }

    function onQueryFailed(sender, args) {
        alert('Request failed. ' + args.get_message() + '\n' + args.get_stackTrace());
    }

</script>

    <input id="Button1" type="button" value="Run Code" onclick="runCode()" />

</asp:Content>

Extremo del recurso de REST

Consulte Lista de recursos para más información.

Estructura de URI de extremo

http://<sitecollection>/<site>/_api/web/lists(listid)

Solicitudes HTTP

Este recurso admite los siguientes comandos HTTP:

• Delete

Sintaxis de DELETE

DELETE http://<sitecollection>/<site>/_api/web/lists(listid)

Sintaxis de MERGE

MERGE http://<sitecollection>/<site>/_api/web/lists(listid)

Sintaxis de POST

POST http://<sitecollection>/<site>/_api/web/lists(listid)

Sintaxis de PUT

PUT http://<sitecollection>/<site>/_api/web/lists(listid)