Referência do modelo de objeto de cliente BCS para o SharePoint
Saiba mais sobre os objetos que estão disponíveis para criar scripts do lado do cliente com o modelo de objeto de cliente do SharePoint para aceder a dados externos expostos pelos Serviços de Conectividade Empresarial (BCS). Os seguintes objetos estão disponíveis para criar scripts do lado do cliente com o modelo de objeto de cliente do SharePoint para aceder a dados externos que são expostos pelos Serviços de Conectividade Empresarial (BCS). O BCS componentes que são expostos ao modelo de objeto do cliente estão localizados em Microsoft.SharePoint.Client.dll de modelo de objeto.
Objeto Entity
O objeto Entity essencialmente representa uma tabela em um banco de dados. Os métodos e propriedades apresentadas aqui mostram os objetos que podem ser manipulados com o uso de biblioteca de código do cliente. Cada uma dessas chamadas mapeia diretamente para uma chamada de modelo de objeto do servidor. No entanto, eles estarão que pode ser chamados por um cliente desanexado, como em um navegador da web usando JavaScript.
Métodos
| Métodos | Assinatura do método | Descrição |
|---|---|---|
|
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() |
Propriedades
| Property | Descrição |
|---|---|
long EstimatedInstanceCount { get; } |
Obtém o número de itens externos esperados desse tipo de conteúdo externo. |
string Name { get; } |
Obtém o nome do objeto de metadados. |
string Namespace { get; } |
Obtém o namespace da classe dados fornecidos. |
int GetIdentifierCount() |
Método EntityInstance
Namespaces
| Gerenciados | JavaScript |
|---|---|
|
Microsoft.BusinessData.Runtime |
SP. BusinessData.Runtime |
Métodos
| Método | Tipo de Retorno | Descrição |
|---|---|---|
|
Delete |
void |
Exclui o Item externo. |
|
FromXml |
void |
Define os valores neste dicionário do XML especificado. Assinatura do método FromXml(string xml) |
|
GetIdentity |
Identity |
Obtém a identidade deste item externo. |
|
Delete |
void |
Exclui o Item externo. |
|
ToXml |
string |
Recupera os valores em formato XML. |
|
Update |
void |
Submete as alterações feitas no Item externo. |
Propriedades
| Propriedade | Tipo de Retorno | Descrição |
|---|---|---|
this[string fieldDotNotation] { get; set; } |
Objeto |
Obtém ou define o valor do campo referido pela notação de ponto. |
RelatedSpecificFinderName { get; } |
cadeia de caracteres |
Método EntityView
Especifica uma exibição personalizada dos dados entidade
Namespaces
| Gerenciados | JavaScript |
|---|---|
|
Microsoft.BusinessData.MetadataModel |
SP. BusinessData |
Métodos
| Método | Tipo de Retorno | Descrição |
|---|---|---|
|
GetDefaultValues_Client() |
FieldValueDictionary |
Obtém um dicionário de valor do campo que contém os valores padrão para este modo de exibição. |
|
GetXmlSchema() |
string |
Obtém o esquema XML do modo de exibição. |
|
GetType(campo de cadeiaDotNotation) |
string |
Obtém o tipo do campo especificado. |
|
GetType(campo de cadeiaDotNotation) |
TypeDescriptor |
Obtém o objeto TypeDescriptor que corresponde à notação de ponto especificada. |
Propriedades
| Propriedade | Tipo de Retorno | Descrição |
|---|---|---|
Fields { get; } |
FieldCollection |
Obtém a coleção de campos no modo de exibição. |
Name { get; } |
string |
Obtém o nome deste objeto View |
RelatedSpecificFinderName { get; } |
string |
Recupera o nome do localizador específico MethodInstance associada a este modo de exibição. |
Método LobSystem
Namespaces
| Gerenciados | JavaScript |
|---|---|
|
Microsoft.BusinessData.MetadataModel |
SP. BusinessData |
Métodos
| Método | Tipo de Retorno | Descrição |
|---|---|---|
|
GetLobSystemInstances() |
void |
Fornece a lista de instâncias de sistema LOB. |
|
Name |
void |
Obtém o nome da LobSystem. |
Propriedades
| Property | Descrição |
|---|---|
| Nenhuma. |
Método de LobSystemInstance
Namespaces
| Gerenciados | JavaScript |
|---|---|
|
Microsoft.BusinessData.MetadataModel |
SP. BusinessData |
Métodos
| Método | Tipo de Retorno | Descrição |
|---|---|---|
| Nenhuma. |
void |
Propriedades
| Property | Descrição |
|---|---|
| Nenhuma. |
Método identificador
Namespaces
| Gerenciados | JavaScript |
|---|---|
|
Microsoft.BusinessData.MetadataModel |
SP. BusinessData |
Métodos
| Método | Tipo de Retorno | Descrição |
|---|---|---|
|
ContainsLocalizedDisplayName |
bool |
Determina se o objeto de metadados contém o nome de exibição localizado. |
|
GetDefaultDisplayName |
string |
Retorna o nome de exibição padrão. |
|
GetLocalizedDisplayName |
string |
Retorna o nome de exibição localizado. |
Propriedades
| Propriedade | Tipo de Retorno | Descrição |
|---|---|---|
IdentifierType {get;} |
string |
Retorna o tipo de identificador. |
Name {get;} |
string |
Obtém o nome do identificador. |
Método IdentifierCollection
Namespaces
| Gerenciados | JavaScript |
|---|---|
|
Microsoft.BusinessData.MetadataModel.Collections |
SP. BusinessData.Collections |
Métodos
| Método | Tipo de Retorno | Descrição |
|---|---|---|
| Nenhuma. |
void |
Propriedades
| Property | Descrição |
|---|---|
| Nenhuma. |
Método de identidade
Namespaces
| Gerenciados | JavaScript |
|---|---|
|
Microsoft.BusinessData.Runtime |
SP. BusinessData.Runtime |
Construtor
| Construtor | Descrição |
|---|---|
public Identity (Object[] identifierValues) |
Constrói uma nova instância da classe usando uma matriz de valores de identificador. |
Métodos
| Método | Tipo de Retorno | Descrição |
|---|---|---|
|
Serialize |
string |
Obtém uma representação de cadeia de caracteres da identidade. |
Propriedades
| Propriedade | Tipo de Retorno | Descrição |
|---|---|---|
IdentifierCount { get; } |
int |
Retorna o número de identificadores. |
IsTemporary { get; } |
bool |
Verifica se a identidade é temporária. |
this[int identifierIndex] { get; } |
Object |
Recupera o elemento no índice fornecido. CSOM não oferece suporte a indexação baseada em int. Baseada em cadeia de caracteres acessador implementado para o mesmo. |
TemporaryId { get; } |
Guid |
Retorna o temporário parte da identidade. |
Método FieldValueDictionary
Namespaces
| Gerenciados | JavaScript |
|---|---|
|
Microsoft.BusinessData.Runtime |
SP. BusinessData.Runtime |
Métodos
| Método | Tipo de Retorno | Descrição |
|---|---|---|
|
FromXml |
void |
Define os valores neste dicionário do XML especificado. |
|
GetCollectionSize |
int |
Retorna o tamanho da coleção a notação de ponto referente à. |
|
ToXml |
string |
Recupera os valores em formato XML. |
Propriedades
| Property | Descrição |
|---|---|
Object this[string fieldDotNotation] { get; set; } |
Obtém ou define o valor do campo referido pela notação de ponto. |
Método EntityFieldCollection
Namespaces
| Gerenciados | JavaScript |
|---|---|
|
Microsoft.BusinessData.Runtime |
SP. BusinessData.Runtime |
Métodos
| Método | Tipo de Retorno | Descrição |
|---|---|---|
| Nenhuma. |
void |
Propriedades
| Property | Descrição |
|---|---|
| Nenhuma. |
Método EntityField
Namespaces
| Gerenciados | JavaScript |
|---|---|
|
Microsoft.BusinessData.Runtime |
SP. BusinessData.Runtime |
Métodos
| Método | Tipo de Retorno | Descrição |
|---|---|---|
| Nenhuma. |
void |
Propriedades
| Propriedade | Tipo de Retorno | Somente leitura. | Descrição |
|---|---|---|---|
|
ContainsLocalizedDisplayName |
Boolean |
Sim |
Determina se o campo contém um nome de exibição localizado. |
|
DefaultDisplayName |
string |
Sim |
Recupera o nome de exibição padrão do campo. |
|
GetLocalizedDisplayName |
string |
Recupera o nome de exibição localizado do campo. |
|
|
Name |
string |
Sim |
Recupera o nome do campo. |
Classe TypeDescriptor
Namespaces
| Gerenciados | JavaScript |
|---|---|
|
Microsoft.BusinessData.MetadataModel |
SP. BusinessData |
Métodos
| Método | Tipo de Retorno | Somente leitura. | Descrição |
|---|---|---|---|
|
ContainsLocalizedDisplayName() |
Boolean |
Sim |
Determina se o descritor de tipo contém um nome de exibição localizado. |
|
GetLocalizedDisplayName() |
string |
Sim |
Retorna o nome de exibição localizado. |
|
GetDefaultDisplayName() |
string |
Retorna o nome de exibição padrão. |
Propriedades
| Propriedade | Tipo de Retorno | Descrição |
|---|---|---|
|
Nome |
string |
Recupera o nome do campo. |
|
TypeName |
string |
Recupera o nome do tipo de dados representado por este descritor de tipo. |
|
IsReadOnly |
Boolean |
Determina se o descritor do tipo representa uma estrutura de dados somente leitura. |
|
ContémReadOnly |
Boolean |
Determina se esse descritor de tipo ou um dos seus filhos representam uma estrutura de dados somente leitura. |
|
IsCollection |
Boolean |
Determina se o tipo descrito representa uma estrutura de dados do conjunto. |
Interfaces
O namespace é Microsoft.BusinessData.MetadataModel.
| Interface | Descrição |
|---|---|
|
IMetadataCatalog |
Ponto de entrada para o modelo de objeto do BDC. Use o DatabaseBasedMetadataCatalog no servidor. |
|
ILobSystem |
Contém os detalhes sobre um sistema externo. |
|
IEntity |
Um tipo de conteúdo externo no repositório de Metadados BDC. |
|
IMethod |
Uma operação que pode ser executada no tipo de conteúdo externo. |
|
IEntityInstance |
Uma instância da entidade (também conhecido como item externo) é um único item retornado de um sistema externo no catálogo de dados corporativos. A interface de IEntityInstance abstrai as fontes de dados subjacentes e protege os clientes tenham de aprender paradigmas de codificação de aplicativo específico; permite que eles acessem todos os dados de negócios de uma maneira única e simplificada. Usando a interface de IEntityInstance, você pode trabalhar com uma linha de dados de um banco de dados da mesma maneira que trabalha com uma estrutura complexa do .NET Framework retornada por um serviço web. Uma instância da entidade BDC tem semântica especial anexada a ele. Por exemplo, ela tem a capacidade de saber qual campo ou campos na linha representam o identificador para a instância da entidade e permite que você chamar métodos, como GetAssociated, GetIdentifierValuese Execute, nessa instância da entidade. |
|
IEntityInstanceEnumerator |
Enumeradores podem ser usados para ler os dados na coleção items externo, mas eles não podem ser usados para modificar a coleção subjacente.
IEntityInstanceEnumerator dá suporte ao streaming e, portanto, é muito útil quando o aplicativo back-end retorna grandes quantidades de dados. |
Perguntas frequentes sobre o modelo de objeto do cliente
<A etiqueta Método> tem de ser incluída numa consulta CAML ao consultar uma lista externa
Não.
Todos os campos na lista externa precisa ser especificado na consulta CAML?
Usando a marca ViewXML no modelo BDC, o desenvolvedor pode especificar apenas os campos necessários e as APIs de CSOM para listas retornará apenas os campos.