Référence du modèle BCS client objet SharePoint
Découvrez les objets disponibles pour la création de scripts côté client à l’aide du modèle objet client SharePoint pour accéder aux données externes exposées par Business Connectivity Services (BCS). Les objets suivants sont disponibles pour la création de scripts côté client à l’aide du modèle objet client SharePoint pour accéder aux données externes exposées par Business Connectivity Services (BCS). La BCS composants qui sont exposés au modèle objet client se trouvent dans Microsoft.SharePoint.Client.dll de modèle d'objet.
Objet Entity
L'objet Entity essentiellement représente une table dans une base de données. Les méthodes et propriétés présentées ici afficher les objets qui peuvent être manipulées à l'aide de la bibliothèque de code client. Chacun de ces appels mappe directement à un appel de modèle objet serveur. Toutefois, elles peuvent être appelées par un client détaché, comme dans un navigateur web à l'aide de JavaScript.
Méthodes
| Méthodes | Signature de la méthode | Description |
|---|---|---|
|
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() |
les propriétés.
| Propriété | Description |
|---|---|
long EstimatedInstanceCount { get; } |
Obtient le nombre d'éléments d'externes attendus de ce type de contenu externe. |
string Name { get; } |
Obtient le nom de l'objet de métadonnées. |
string Namespace { get; } |
Obtient l'espace de noms de la classe de données particulière. |
int GetIdentifierCount() |
Méthode de la propriété EntityInstance
Namespaces
| Géré | JavaScript |
|---|---|
|
Microsoft.BusinessData.Runtime |
SP. BusinessData.Runtime |
Méthodes
| méthodes | Type de retour | Description |
|---|---|---|
|
Delete |
void |
Supprime l'élément externe. |
|
FromXml |
void |
Définit les valeurs dans ce dictionnaire à partir de données XML spécifiées. Signature de méthode FromXml(string xml) |
|
GetIdentity |
Identity |
Obtient l'identité de cet élément externe. |
|
Delete |
void |
Supprime l'élément externe. |
|
ToXml |
string |
Extrait les valeurs au format XML. |
|
Update |
void |
Envoie les modifications apportées à l'élément externe. |
les propriétés.
| Propriété | Type de retour | Description |
|---|---|---|
this[string fieldDotNotation] { get; set; } |
Object |
Obtient ou définit la valeur du champ référencé par la notation par points. |
RelatedSpecificFinderName { get; } |
chaîne |
Méthode EntityView
Spécifie un affichage personnalisé des données entité
Namespaces
| Géré | JavaScript |
|---|---|
|
Microsoft.BusinessData.MetadataModel |
SP. BusinessData |
Méthodes
| méthodes | Type de retour | Description |
|---|---|---|
|
GetDefaultValues_Client() |
FieldValueDictionary |
Obtient un dictionnaire de valeur de champ qui contient les valeurs par défaut pour cet affichage. |
|
GetXmlSchema() |
string |
Obtient le schéma XML de la vue. |
|
GetType(string fieldDotNotation) |
string |
Obtient le type du champ spécifié. |
|
GetType(string fieldDotNotation) |
TypeDescriptor |
Obtient l'objet TypeDescriptor qui correspond à la notation par points donné. |
les propriétés.
| Propriété | Type de retour | Description |
|---|---|---|
Fields { get; } |
FieldCollection |
Obtient la collection de champs dans la vue. |
Name { get; } |
string |
Obtient le nom de cet objet View |
RelatedSpecificFinderName { get; } |
string |
Récupère le nom de la recherche spécifique MethodInstance qui cet affichage est lié à. |
Méthode de LobSystem
Namespaces
| Géré | JavaScript |
|---|---|
|
Microsoft.BusinessData.MetadataModel |
SP. BusinessData |
Méthodes
| méthodes | Type de retour | Description |
|---|---|---|
|
GetLobSystemInstances() |
void |
Donne la liste des instances de système LOB. |
|
Name |
void |
Obtient le nom de la LobSystem. |
les propriétés.
| Propriété | Description |
|---|---|
| Aucun. |
Méthode de LobSystemInstance
Namespaces
| Géré | JavaScript |
|---|---|
|
Microsoft.BusinessData.MetadataModel |
SP. BusinessData |
Méthodes
| méthodes | Type de retour | Description |
|---|---|---|
| None. |
void |
les propriétés.
| Propriété | Description |
|---|---|
| Aucun. |
Méthode d'identificateur
Namespaces
| Géré | JavaScript |
|---|---|
|
Microsoft.BusinessData.MetadataModel |
SP. BusinessData |
Méthodes
| méthodes | Type de retour | Description |
|---|---|---|
|
ContainsLocalizedDisplayName |
bool |
Détermine si l'objet de métadonnées contient un nom complet localisé. |
|
GetDefaultDisplayName |
string |
Renvoie le nom complet par défaut. |
|
GetLocalizedDisplayName |
string |
Renvoie le nom complet localisé. |
les propriétés.
| Propriété | Type de retour | Description |
|---|---|---|
IdentifierType {get;} |
string |
Renvoie le type d'identificateur. |
Name {get;} |
string |
Obtient le nom de l'identificateur. |
Méthode IdentifierCollection
Namespaces
| Géré | JavaScript |
|---|---|
|
Microsoft.BusinessData.MetadataModel.Collections |
SP. BusinessData.Collections |
Méthodes
| méthodes | Type de retour | Description |
|---|---|---|
| None. |
void |
les propriétés.
| Propriété | Description |
|---|---|
| Aucun. |
Méthode d'identité
Namespaces
| Géré | JavaScript |
|---|---|
|
Microsoft.BusinessData.Runtime |
SP. BusinessData.Runtime |
Constructeur
| Constructeur | Description |
|---|---|
public Identity (Object[] identifierValues) |
Crée une nouvelle instance de la classe à l'aide d'un tableau de valeurs d'identificateur. |
Méthodes
| méthodes | Type de retour | Description |
|---|---|---|
|
Serialize |
string |
Obtient une représentation sous forme de chaîne de l'identité. |
les propriétés.
| Propriété | Type de retour | Description |
|---|---|---|
IdentifierCount { get; } |
int |
Renvoie le nombre d'identificateurs. |
IsTemporary { get; } |
bool |
Vérifie si l'identité est temporaire. |
this[int identifierIndex] { get; } |
Object |
Récupère l'élément à l'index spécifié. CSOM ne prend pas en charge basée sur les int d'indexation. En fonction de la chaîne accesseur mis en œuvre pour les mêmes. |
TemporaryId { get; } |
Guid |
Renvoie la temporaire partie de l'identité. |
Méthode FieldValueDictionary
Namespaces
| Géré | JavaScript |
|---|---|
|
Microsoft.BusinessData.Runtime |
SP. BusinessData.Runtime |
Méthodes
| méthodes | Type de retour | Description |
|---|---|---|
|
FromXml |
void |
Définit les valeurs dans ce dictionnaire à partir de données XML spécifiées. |
|
GetCollectionSize |
entier |
Cette propriété renvoie la taille de la collection qui représente la notation par points. |
|
ToXml |
string |
Extrait les valeurs au format XML. |
les propriétés.
| Propriété | Description |
|---|---|
Object this[string fieldDotNotation] { get; set; } |
Obtient ou définit la valeur du champ référencé par la notation par points. |
Méthode EntityFieldCollection
Namespaces
| Géré | JavaScript |
|---|---|
|
Microsoft.BusinessData.Runtime |
SP. BusinessData.Runtime |
Méthodes
| méthodes | Type de retour | Description |
|---|---|---|
| None. |
void |
les propriétés.
| Propriété | Description |
|---|---|
| Aucun. |
Méthode EntityField
Namespaces
| Géré | JavaScript |
|---|---|
|
Microsoft.BusinessData.Runtime |
SP. BusinessData.Runtime |
Méthodes
| méthodes | Type de retour | Description |
|---|---|---|
| None. |
void |
les propriétés.
| Propriété | Type de retour | En lecture seule | Description |
|---|---|---|---|
|
ContainsLocalizedDisplayName |
Boolean |
Yes |
Détermine si le champ contient un nom complet localisé. |
|
DefaultDisplayName |
string |
Yes |
Récupère le nom d'affichage par défaut du champ. |
|
GetLocalizedDisplayName |
string |
Extrait le nom complet localisé du champ. |
|
|
Name |
string |
Yes |
Extrait le nom du champ. |
Classe TypeDescriptor
Namespaces
| Géré | JavaScript |
|---|---|
|
Microsoft.BusinessData.MetadataModel |
SP. BusinessData |
Méthodes
| méthodes | Type de retour | En lecture seule | Description |
|---|---|---|---|
|
ContainsLocalizedDisplayName() |
Boolean |
Yes |
Détermine si le descripteur de type contient un nom complet localisé. |
|
GetLocalizedDisplayName() |
string |
Yes |
Renvoie le nom complet localisé. |
|
GetDefaultDisplayName() |
string |
Renvoie le nom complet par défaut. |
les propriétés.
| Propriété | Type de retour | Description |
|---|---|---|
|
Nom |
string |
Extrait le nom du champ. |
|
TypeName |
string |
Extrait le nom du type de données représenté par ce descripteur de type. |
|
IsReadOnly |
Booléenne |
Détermine si ce descripteur de type représente une structure de données en lecture seule. |
|
ContainsReadOnly |
Booléenne |
Détermine si ce descripteur de type ou l'un de ses enfants représentent une structure de données en lecture seule. |
|
IsCollection |
Booléenne |
Détermine si le type décrite représente une structure de données de collection. |
Interfaces
L'espace de noms est Microsoft.BusinessData.MetadataModel.
| Interface | Description |
|---|---|
|
IMetadataCatalog |
Le point d'entrée dans le modèle objet BDC. Utilisez le DatabaseBasedMetadataCatalog sur le serveur. |
|
ILobSystem |
Contient des informations détaillées sur un système externe. |
|
IEntity |
Un type de contenu externe dans le magasin de métadonnées BDC. |
|
IMethod |
Une opération qui peut être effectuée sur le type de contenu externe. |
|
IEntityInstance |
Une instance d'entité (également connu sous éléments externes) est un élément unique renvoyé à partir d'un système externe dans BDC. L'interface IEntityInstance sources de données sous-jacentes et évite les clients à partir de devoir apprendre paradigmes codage propres aux applications ; elle leur permet d'accéder à toutes les données métiers de façon unique et simplifiée. À l'aide de l'interface IEntityInstance, vous pouvez travailler avec une ligne de données à partir d'une base de données dans la même manière d'utilisation avec une structure de .NET Framework complexe renvoyée par un service web. Une instance d'entité en BDC a sémantique spéciale associée au. Par exemple, il a la possibilité de savoir quel domaine ou l'identificateur de l'instance d'entité représentent les champs dans la ligne, et il vous permet d'appeler des méthodes, telles que le compte GetAssociated, GetIdentifierValueset Execute, sur cette instance d'entité. |
|
IEntityInstanceEnumerator |
Énumérateurs peuvent être utilisés pour lire les données dans la collection items externe, mais ils ne peuvent pas être utilisées pour modifier la collection sous-jacente.
IEntityInstanceEnumerator prend en charge de la diffusion en continu et est donc très utile lors de l'application de serveur principal renvoie de grandes quantités de données. |
FAQ du modèle objet client
<La balise Method> doit-elle être incluse dans une requête CAML lors de l’interrogation d’une liste externe
Non.
Tous les champs dans la liste externe doivent-ils être spécifiée dans le query? CAML
Utilisation de la balise ViewXML dans le modèle BDC, le développeur peut spécifier seulement les champs qui sont requises et les API CSOM pour les listes renvoie uniquement les champs.
Voir aussi
Référence de programmeurs Business Connectivity Services pour SharePoint
Commencer à utiliser le modèle objet client avec des données externes dans SharePoint
Comment : utiliser la bibliothèque de code client pour accéder aux données externes dans SharePoint
Nouveautés dans Business Connectivity Services dans SharePoint
Prise en main de Business Connectivity Services dans SharePoint