Referencia al modelo de objetos del cliente BCS para SharePoint

Obtenga información sobre los objetos que están disponibles para crear scripts del lado cliente mediante el modelo de objetos de cliente de SharePoint para acceder a los datos externos expuestos por Servicios de conectividad empresarial (BCS). Los siguientes objetos están disponibles para crear scripts del lado cliente mediante el modelo de objetos de cliente de SharePoint para acceder a los datos externos expuestos por Servicios de conectividad empresarial (BCS). Los componentes del modelo de objetos de BCS que se exponen al modelo de objetos de cliente se encuentran en Microsoft.SharePoint.Client.dll.

Objeto Entity

Básicamente, el objeto Entity representa una tabla de una base de datos. Los métodos y propiedades que se presentan aquí muestran los objetos que se pueden manipular usando la biblioteca de código de cliente. Cada una de estas llamadas corresponde directamente con una llamada del modelo de objetos de cliente. Sin embargo, un cliente desasociado los puede llamar, por ejemplo, en un explorador web mediante JavaScript.

Métodos

Métodos	Firma del método	Descripción
Create	Identity Create(FieldValueDictionary fieldValues, LobSystemInstance lobSystemInstanceName)
FindSpecificDefault	EntityInstance FindSpecificDefault(Identity identity, LobSystemInstance lobSystemInstanceName)
FindspecificByBdcIDDefault	EntityInstance FindSpecific(Identity identity, string specificFinderName, LobSystemInstance lobSystemInstanceName)
FindSpecificByBdcID	EntityInstance FindSpecificByBdcIDDefault(string BdcIdentity, LobSystemInstance lobSystemInstanceName)
GetCreatorView	EntityInstance FindSpecificByBdcID(string BdcIdentity, string specificFinderName,LobSystemInstance LobSystemInstanceName)
GetDefaultSpecificFinderView	View GetCreatorView(string methodInstanceName)
GetSpecificFinderView_Client	View GetDefaultSpecificFinderView()
GetUpdaterView_Client	View GetSpecificFinderView_Client( string specificFinderName)
GetIdentifiers	View GetUpdaterView_Client(string updaterName)
GetIdentifiers()

Propiedades

Propiedad	Descripción
long EstimatedInstanceCount { get; }	Obtiene el número de elementos externos que se esperan de este tipo de contenido externo.
string Name { get; }	Obtiene el nombre del objeto de metadatos.
string Namespace { get; }	Obtiene el espacio de nombres de la clase de datos dada.
int GetIdentifierCount()

Método EntityInstance

Espacios de nombres

Administrado	JavaScript
Microsoft.BusinessData.Runtime	SP. BusinessData.Runtime

Métodos

Método	Tipo de retorno	Descripción
Delete	nulo	Elimina el elemento externo.
FromXml	nulo	Establece los valores de este diccionario a partir del código XML especificado. Firma del métodoFromXml(string xml)
GetIdentity	Identity	Obtiene la identidad de este elemento externo.
Delete	nulo	Elimina el elemento externo.
ToXml	cadena	Recupera los valores con un formato XML.
Update	nulo	Envía los cambios realizados en el elemento externo.

Propiedades

Propiedad	Tipo de retorno	Description
this[string fieldDotNotation] { get; set; }	Objeto	Obtiene o establece el valor del campo al que se hace referencia mediante la notación de puntos.
RelatedSpecificFinderName { get; }	string

Método EntityView

Especifica una vista personalizada de los datos de Entity

Espacios de nombres

Administrado	JavaScript
Microsoft.BusinessData.MetadataModel	SP. BusinessData

Métodos

Método	Tipo de retorno	Descripción
GetDefaultValues_Client()	FieldValueDictionary	Obtiene un diccionario de valores de campo que contiene los valores predeterminados de esta vista.
GetXmlSchema()	string	Obtiene el esquema XML de la vista.
GetType(string fieldDotNotation)	string	Obtiene el tipo del campo especificado.
GetType(string fieldDotNotation)	TypeDescriptor	Obtiene el objeto TypeDescriptor que corresponde a la notación de puntos especificada.

Propiedades

Propiedad	Tipo de retorno	Descripción
Fields { get; }	FieldCollection	Obtiene la colección de campos de la vista.
Name { get; }	string	Obtiene el nombre de este objeto View
RelatedSpecificFinderName { get; }	string	Recupera el nombre del buscador específico MethodInstance al que esta vista está enlazada.

Método LobSystem

Espacios de nombres

Administrado	JavaScript
Microsoft.BusinessData.MetadataModel	SP. BusinessData

Métodos

Método	Tipo de retorno	Descripción
GetLobSystemInstances()	void	Proporciona la lista de instancias del sistema LOB.
Name	void	Obtiene el nombre de LobSystem.

Propiedades

Propiedad	Descripción
Ninguno.

Método LobSystemInstance

Espacios de nombres

Administrado	JavaScript
Microsoft.BusinessData.MetadataModel	SP. BusinessData

Métodos

Método	Tipo de retorno	Descripción
Ninguno.	void

Propiedades

Propiedad	Descripción
Ninguno.

Método Identifier

Espacios de nombres

Administrado	JavaScript
Microsoft.BusinessData.MetadataModel	SP. BusinessData

Métodos

Método	Tipo de retorno	Descripción
ContainsLocalizedDisplayName	bool	Determina si el objeto de metadatos contiene un nombre para mostrar localizado.
GetDefaultDisplayName	string	Devuelve el nombre para mostrar predeterminado.
GetLocalizedDisplayName	string	Devuelve el nombre para mostrar localizado.

Propiedades

Propiedad	Tipo de retorno	Descripción
IdentifierType {get;}	string	Devuelve el tipo de identificador.
Name {get;}	string	Obtiene el nombre del identificador.

Método IdentifierCollection

Espacios de nombres

Administrado	JavaScript
Microsoft.BusinessData.MetadataModel.Collections	SP. BusinessData.Collections

Métodos

Método	Tipo de retorno	Descripción
Ninguno.	void

Propiedades

Propiedad	Descripción
Ninguno.

Método Identity

Espacios de nombres

Administrado	JavaScript
Microsoft.BusinessData.Runtime	SP. BusinessData.Runtime

Constructor

Constructor	Descripción
public Identity (Object[] identifierValues)	Construye una nueva instancia de la clase usando una matriz de valores de identificador.

Métodos

Método	Tipo de retorno	Description
Serialize	string	Obtiene una representación de cadena de la identidad.

Propiedades

Propiedad	Tipo de retorno	Descripción
IdentifierCount { get; }	int	Devuelve el número de identificadores.
IsTemporary { get; }	bool	Comprueba si la identidad es temporal.
this[int identifierIndex] { get; }	Object	Recupera el elemento en el índice especificado. CSOM no admite la indización basada en enteros. Para ello se implementó el descriptor de acceso basado en cadena.
TemporaryId { get; }	Guid	Devuelve la parte temporal de la identidad.

Método FieldValueDictionary

Espacios de nombres

Administrado	JavaScript
Microsoft.BusinessData.Runtime	SP. BusinessData.Runtime

Métodos

Método	Tipo de retorno	Descripción
FromXml	void	Establece los valores de este diccionario a partir del código XML especificado.
GetCollectionSize	entero	Devuelve el tamaño de la colección a la que hace referencia la notación de puntos.
ToXml	cadena	Recupera los valores con un formato XML.

Propiedades

Propiedad	Descripción
Object this[string fieldDotNotation] { get; set; }	Obtiene o establece el valor del campo al que se hace referencia mediante la notación de puntos.

Método EntityFieldCollection

Espacios de nombres

Administrado	JavaScript
Microsoft.BusinessData.Runtime	SP. BusinessData.Runtime

Métodos

Método	Tipo de retorno	Descripción
Ninguno.	void

Propiedades

Propiedad	Descripción
Ninguno.

Método EntityField

Espacios de nombres

Administrado	JavaScript
Microsoft.BusinessData.Runtime	SP. BusinessData.Runtime

Métodos

Método	Tipo de retorno	Descripción
Ninguno.	nulo

Propiedades

Propiedad	Tipo de retorno	Solo lectura	Descripción
ContainsLocalizedDisplayName	Boolean	Sí	Determina si el campo contiene un nombre para mostrar localizado.
DefaultDisplayName	string	Sí	Recupera el espacio de nombres predeterminado del campo.
GetLocalizedDisplayName	string		Recupera el espacio de nombres localizado del campo.
Name	string	Sí	Recupera el nombre del campo.

Clase TypeDescriptor

Espacios de nombres

Administrado	JavaScript
Microsoft.BusinessData.MetadataModel	SP. BusinessData

Métodos

Método	Tipo de retorno	Solo lectura	Descripción
ContainsLocalizedDisplayName()	Boolean	Sí	Determina si el tipo de descriptor contiene un nombre para mostrar localizado.
GetLocalizedDisplayName()	string	Sí	Devuelve el nombre para mostrar localizado.
GetDefaultDisplayName()	string		Devuelve el nombre para mostrar predeterminado.

Propiedades

Propiedad	Tipo de retorno	Descripción
Name	cadena	Recupera el nombre del campo.
TypeName	cadena	Recupera el nombre del tipo de datos representado por este descriptor de tipo.
IsReadOnly	Booleano	Determina si este descriptor de tipo representa una estructura de datos de solo lectura.
ContainsReadOnly	Booleano	Determina si este descriptor de tipo o uno de sus elementos secundarios representan una estructura de datos de solo lectura.
IsCollection	Booleano	Determina si el tipo descrito representa una estructura de datos de colección.

Interfaces

El espacio de nombres es Microsoft.BusinessData.MetadataModel.

Interfaz	Descripción
IMetadataCatalog	Punto de entrada al modelo de objetos de BDC. Use DatabaseBasedMetadataCatalog en el servidor.
ILobSystem	Contiene información detallada sobre un sistema externo.
IEntity	Tipo de contenido externo en el almacén de metadatos de BDC.
IMethod	Operación que se puede realizar en el tipo de conexión externo.
IEntityInstance	Una instancia de entidad (también conocida como elemento externo) es un único elemento devuelto por un sistema externo en BDC. La interfaz IEntityInstance abstrae los orígenes de datos subyacentes y aísla a los clientes de tener que aprender paradigmas de codificación específicos de la aplicación; les permite acceder a todos los datos empresariales de una manera única y simplificada. Mediante la interfaz IEntityInstance , puede trabajar con una fila de datos de una base de datos de la misma manera que trabajar con una estructura compleja de .NET Framework devuelta por un servicio web. Una instancia de entidad de BDC tiene asociada una semántica especial. Por ejemplo, tiene la capacidad de saber qué campo o campos de la fila representan el identificador de la instancia de la entidad y le permite llamar a métodos, como GetAssociated, GetIdentifierValues y Execute, en esta instancia de entidad.
IEntityInstanceEnumerator	Los enumeradores se pueden usar para leer los datos de la colección de elementos externos, pero no se pueden usar para modificar la colección subyacente. IEntityInstanceEnumerator admite la transmisión en secuencias y, por lo tanto, resulta muy útil cuando la aplicación back-end devuelve grandes cantidades de datos.

Preguntas más frecuentes de modelo de objetos de cliente

• ¿Es necesario incluir la <etiqueta Method> en una consulta CAML al consultar una lista externa?

  No.

• ¿Es necesario especificar en la consulta CAML todos los campos en la lista externa?

  Con la etiqueta de ViewXML en el modelo de conectividad a datos profesionales, el programador puede especificar sólo aquellos campos que son necesarios y las API de CSOM para las listas devolverá sólo esos campos.

Vea también

• Referencia a los programadores de Servicios de conectividad empresarial para SharePoint

• Referencia de la API de cliente .NET para SharePoint Online

• Introducción al uso del modelo de objetos de cliente con datos externos en SharePoint

• Cómo usar la biblioteca de códigos de cliente para obtener acceso a datos externos en SharePoint

• Novedades en Servicios de conectividad empresarial en SharePoint

• Introducción a los Servicios de conectividad empresarial en SharePoint