SP. Objeto de archivo (Object sp.js)

Artículo
01/19/2016

Representa un archivo de un sitio web de SharePoint que puede ser una página de elementos web, un elemento de una biblioteca de documentos o un archivo de una carpeta.

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

Miembros

El objeto File tiene los siguientes miembros.

Constructor

El objeto File tiene el siguiente constructor.

Constructor	Descripción
Archivo	Inicializa una nueva instancia del objeto SP.File.

Métodos

El objeto File tiene los siguientes métodos.

Método	Descripción
aprobar	Aprueba el archivo enviado para la aprobación de su contenido con el comentario especificado.
checkIn	Protege el archivo en una biblioteca de documentos en función del tipo de protección.
checkOut	Desprotege el archivo de una biblioteca de documentos en función del tipo de desprotección.
copyTo	Copia el archivo en la dirección URL de destino.
deleteObject	Elimina el objetoFile.
denegar	Deniega la aprobación para un archivo que se envió para aprobación de contenido.
getContentVerFromTag	Reservado solo para uso interno. Este método expone el valor ContentVersion interno dentro de una ContentTag.
getLimitedWebPartManager	Especifica el conjunto de controles usado para obtener acceso a los elementos web asociados con esta vista y página de elementos web, modificarlos o agregar elementos nuevos.
moveTo	Mueve el archivo a la dirección URL de destino especificada.
Publicación	Envía el archivo para la aprobación de su contenido con el comentario especificado.
reciclaje	Mueve el archivo a la papelera de reciclaje y devuelve el identificador del elemento de papelera de reciclaje nuevo.
saveBinary
undoCheckOut	Revierte una desprotección existente del archivo.
unPublish	Quita el archivo de la aprobación de contenido o cancela la publicación de una versión principal.

Propiedades

El objeto File tiene las siguientes propiedades.

Propiedad	Descripción
autor	Obtiene un valor que especifica el usuario que agregó el archivo.
checkedOutByUser	Obtiene un valor que devuelve el usuario que desprotegió el archivo.
checkInComment	Obtiene un valor que devuelve el comentario usado cuando se protege un documento en una biblioteca de documentos.
checkOutType	Obtiene un valor que indica el modo en que se desprotege el archivo de una biblioteca de documentos.
contentTag	Devuelve la versión interna del contenido, que se usa para validar la igualdad de documentos con propósitos de lectura.
customizedPageStatus	Obtiene un valor que especifica el estado de personalización del archivo.
eTag	Obtiene un valor que especifica el valor de ETag.
existe	Obtiene un valor que especifica si existe el archivo.
longitud	Obtiene el tamaño del archivo en bytes, excluyendo el tamaño de los elementos web que se usan en el archivo.
nivel de	Obtiene un valor que especifica el nivel de publicación del archivo.
listItemAllFields	Obtiene un valor que especifica los valores de campo de elemento de lista para el elemento de lista correspondiente al archivo.
lockedByUser	Obtiene un valor que devuelve el usuario propietario del bloqueo actual en el archivo.
majorVersion	Obtiene un valor que especifica la versión principal del archivo.
minorVersion	Obtiene un valor que especifica la versión secundaria del archivo.
modifiedBy	Obtiene un valor que devuelve el usuario que modificó el archivo por última vez.
nombre	Obtiene el nombre del archivo que incluye la extensión.
serverRelativeUrl	Obtiene la dirección URL relativa del archivo en función de la dirección URL del servidor.
timeCreated	Obtiene un valor que especifica cuándo se creó el archivo.
timeLastModified	Obtiene un valor que especifica cuándo se modificó por última vez el archivo.
título	Obtiene un valor que especifica el nombre para mostrar del archivo.
uiVersion	Obtiene un valor que especifica el identificador de versión específico de la implementación del archivo.
uiVersionLabel	Obtiene un valor que especifica el identificador de versión específico de la implementación del archivo.
versiones	Obtiene un valor que devuelve una colección de objetos de versión de archivo que representan las versiones del archivo.

Extremo del recurso de REST

Consulte Recurso de archivo para más información.

Estructura de URI de extremo

http://<sitecollection>/<site>/_api/web/folders/getbyurl(folderrelativeurl)/files/getbyurl(filerelativeurl)

Solicitudes HTTP

Este recurso admite los siguientes comandos HTTP:

Delete

Sintaxis de DELETE

DELETE http://<sitecollection>/<site>/_api/web/folders/getbyurl(folderrelativeurl)/files/getbyurl(filerelativeurl)

Sintaxis de POST

POST http://<sitecollection>/<site>/_api/web/folders/getbyurl(folderrelativeurl)/files/getbyurl(filerelativeurl)