Справочник по клиентской объектной модели BCS для SharePoint
Сведения об объектах, доступных для создания клиентских скриптов с помощью клиентской объектной модели SharePoint для доступа к внешним данным, предоставляемым службами Business Connectivity Services (BCS). Следующие объекты доступны для создания клиентских скриптов с помощью клиентской объектной модели SharePoint для доступа к внешним данным, предоставляемым службами Business Connectivity Services (BCS). BCS объектной модели, компоненты, предоставляемые клиентскую объектную модель, находятся в библиотеке Microsoft.SharePoint.Client.dll.
Объект Entity
Объект Entity по сути представляет таблицу в базе данных. Методы и свойства, представленные здесь Показать объекты, которые можно управлять с помощью клиентской библиотеки кода. Каждый из этих вызовов сопоставляет непосредственно звонка server объектной модели. Тем не менее они могут вызываться отключением клиента, такие как и в веб-браузере с помощью JavaScript.
Методы
| Методы | Подпись метода | Описание |
|---|---|---|
|
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() |
Свойства
| Свойство | Описание |
|---|---|
long EstimatedInstanceCount { get; } |
Получает число ожидаемых внешние элементы этого внешнего типа контента. |
string Name { get; } |
Возвращает имя объекта метаданных. |
string Namespace { get; } |
Возвращает пространство имен класса данных. |
int GetIdentifierCount() |
Метод экземпляра сущности
Пространства имен
| Managed (Управляемая) | JavaScript |
|---|---|
|
Microsoft.BusinessData.Runtime |
SP. BusinessData.Runtime |
Методы
| Метод | Возвращаемый тип | Описание |
|---|---|---|
|
Delete |
void |
Удаление внешнего элемента. |
|
FromXml |
void |
Задает значения в словаре из указанного XML. Сигнатура метода FromXml(string xml) |
|
GetIdentity |
Identity |
Получает идентификатор этого внешнего элемента. |
|
Delete |
void |
Удаление внешнего элемента. |
|
ToXml |
string |
Извлекает значения в формате XML. |
|
Update |
void |
Отправляет данные изменения, внесенные внешнего элемента. |
Properties
| Свойство | Возвращаемый тип | Описание |
|---|---|---|
this[string fieldDotNotation] { get; set; } |
Объект |
Получает или задает значение поля, на который ссылается точечную нотацию. |
RelatedSpecificFinderName { get; } |
string |
Метод EntityView
Определяет настраиваемое представление данных сущности
Пространства имен
| Managed (Управляемая) | JavaScript |
|---|---|
|
Microsoft.BusinessData.MetadataModel |
SP. BusinessData |
Методы
| Метод | Возвращаемый тип | Описание |
|---|---|---|
|
GetDefaultValues_Client() |
FieldValueDictionary |
Получает словарь значение поля, который содержит значения по умолчанию для этого представления. |
|
GetXmlSchema() |
string |
Возвращает схему XML для представления. |
|
GetType(string fieldDotNotation) |
string |
Получает тип указанного поля. |
|
GetType(string fieldDotNotation) |
TypeDescriptor |
Получает объект TypeDescriptor, соответствующий заданным точечную нотацию. |
Properties
| Свойство | Возвращаемый тип | Описание |
|---|---|---|
Fields { get; } |
FieldCollection |
Получает коллекцию всех полей в представлении. |
Name { get; } |
string |
Получает имя объекта View |
RelatedSpecificFinderName { get; } |
string |
Получает имя специальный метод поиска MethodInstance, которая связана с этого представления. |
Метод бизнес-системы
Пространства имен
| Managed (Управляемая) | JavaScript |
|---|---|
|
Microsoft.BusinessData.MetadataModel |
SP. BusinessData |
Методы
| Метод | Возвращаемый тип | Описание |
|---|---|---|
|
GetLobSystemInstances() |
void |
Предоставляет список экземпляров системы LOB. |
|
Name |
void |
Получает имя LobSystem. |
Properties
| Свойство | Описание |
|---|---|
| Нет. |
Метод бизнес-системы
Пространства имен
| Managed (Управляемая) | JavaScript |
|---|---|
|
Microsoft.BusinessData.MetadataModel |
SP. BusinessData |
Методы
| Метод | Возвращаемый тип | Описание |
|---|---|---|
| Нет. |
void |
Properties
| Свойство | Описание |
|---|---|
| Нет. |
Метод идентификатор
Пространства имен
| Managed (Управляемая) | JavaScript |
|---|---|
|
Microsoft.BusinessData.MetadataModel |
SP. BusinessData |
Методы
| Метод | Возвращаемый тип | Описание |
|---|---|---|
|
ContainsLocalizedDisplayName |
bool |
Определяет, содержит ли объект метаданных локализованное отображаемое имя. |
|
GetDefaultDisplayName |
string |
Возвращает отображаемое имя по умолчанию. |
|
GetLocalizedDisplayName |
string |
Возвращает локализованное отображаемое имя. |
Properties
| Свойство | Возвращаемый тип | Описание |
|---|---|---|
IdentifierType {get;} |
string |
Возвращает тип идентификатора. |
Name {get;} |
string |
Получает имя идентификатора. |
Метод IdentifierCollection
Пространства имен
| Managed (Управляемая) | JavaScript |
|---|---|
|
Microsoft.BusinessData.MetadataModel.Collections |
SP. BusinessData.Collections |
Методы
| Метод | Возвращаемый тип | Описание |
|---|---|---|
| Нет. |
void |
Properties
| Свойство | Описание |
|---|---|
| Нет. |
Метод удостоверений
Пространства имен
| Managed (Управляемая) | JavaScript |
|---|---|
|
Microsoft.BusinessData.Runtime |
SP. BusinessData.Runtime |
Конструктор
| Конструктор | Описание |
|---|---|
public Identity (Object[] identifierValues) |
Создает новый экземпляр класса с помощью массив значений идентификаторов. |
Методы
| Метод | Возвращаемый тип | Описание |
|---|---|---|
|
Serialize |
string |
Возвращает строковое представление удостоверения. |
Properties
| Свойство | Возвращаемый тип | Описание |
|---|---|---|
IdentifierCount { get; } |
int |
Возвращает число идентификаторов. |
IsTemporary { get; } |
bool |
Проверяет, является ли идентификатор временного. |
this[int identifierIndex] { get; } |
Object |
Получает элемент по указанному индексу. CSOM не поддерживает на основе int индексирования. На основе строки доступа к данным реализован для того же. |
TemporaryId { get; } |
Guid |
Возвращает временной части удостоверения. |
Метод словаря
Пространства имен
| Managed (Управляемая) | JavaScript |
|---|---|
|
Microsoft.BusinessData.Runtime |
SP. BusinessData.Runtime |
Методы
| Метод | Возвращаемый тип | Описание |
|---|---|---|
|
FromXml |
void |
Задает значения в словаре из указанного XML. |
|
GetCollectionSize |
целое |
Возвращает размер семейства сайтов, на который ссылается точечную нотацию. |
|
ToXml |
string |
Извлекает значения в формате XML. |
Properties
| Свойство | Описание |
|---|---|
Object this[string fieldDotNotation] { get; set; } |
Получает или задает значение поля, на который ссылается точечную нотацию. |
Метод EntityFieldCollection
Пространства имен
| Managed (Управляемая) | JavaScript |
|---|---|
|
Microsoft.BusinessData.Runtime |
SP. BusinessData.Runtime |
Методы
| Метод | Возвращаемый тип | Описание |
|---|---|---|
| Нет. |
void |
Properties
| Свойство | Описание |
|---|---|
| Нет. |
Метод EntityField
Пространства имен
| Managed (Управляемая) | JavaScript |
|---|---|
|
Microsoft.BusinessData.Runtime |
SP. BusinessData.Runtime |
Методы
| Метод | Возвращаемый тип | Описание |
|---|---|---|
| Нет |
void |
Properties
| Свойство | Возвращаемый тип | Только чтение | Описание |
|---|---|---|---|
|
ContainsLocalizedDisplayName |
Boolean |
Да |
Определяет, содержит ли поле локализованное отображаемое имя. |
|
DefaultDisplayName |
string |
Да |
Получает отображаемое имя по умолчанию поля. |
|
GetLocalizedDisplayName |
string |
Получает локализованное отображаемое имя поля. |
|
|
Name |
string |
Да |
Получает имя поля. |
Класс TypeDescriptor
Пространства имен
| Managed (Управляемая) | JavaScript |
|---|---|
|
Microsoft.BusinessData.MetadataModel |
SP. BusinessData |
Методы
| Метод | Возвращаемый тип | Только чтение | Описание |
|---|---|---|---|
|
ContainsLocalizedDisplayName() |
Boolean |
Да |
Определяет, содержит ли дескриптор типа локализованное отображаемое имя. |
|
GetLocalizedDisplayName() |
string |
Да |
Возвращает локализованное отображаемое имя. |
|
GetDefaultDisplayName() |
string |
Возвращает отображаемое имя по умолчанию. |
Properties
| Свойство | Возвращаемый тип | Описание |
|---|---|---|
|
Name |
string |
Получает имя поля. |
|
TypeName |
string |
Получает имя типа данных, представленного в этом дескриптором типа. |
|
IsReadOnly |
Логический |
Определяет, является ли этот тип дескриптора структуру данных только для чтения. |
|
СодержитReadOnly |
Логический |
Определяет, представляют ли этот дескриптор типа или одного из его дочерние элементы структуры данных только для чтения. |
|
IsCollection |
Логический |
Определяет, представляет ли описанного типа структуры данных семейства сайтов. |
Интерфейсы
Пространство имен является Microsoft.BusinessData.MetadataModel.
| Интерфейс | Описание |
|---|---|
|
IMetadataCatalog |
Точка входа для объектной модели BDC. Используйте DatabaseBasedMetadataCatalog на сервере. |
|
ILobSystem |
Содержит сведения о внешней системе. |
|
IEntity |
Внешний тип контента в хранилище метаданных службы подключения к бизнес-данным. |
|
IMethod |
Операция, которую можно выполнить с внешним типом контента. |
|
IEntityInstance |
Экземпляр сущности (также известной как внешнего элемента) представляет собой отдельный элемент, возвращенный из внешней системы в BDC. Интерфейс IEntityInstance выделяет используемых источников данных и изолирует клиентов от необходимости сведения схемы написания кода конкретного приложения; позволяет им получить доступ к всем бизнес-данным в одном упрощенный способ. С помощью интерфейса IEntityInstance, можно работать со строкой данных из базы данных в точно так же, так как работа с сложную структуру .NET Framework, возвращаемый веб-службой. Экземпляр сущности в BDC имеет специальной семантики, подключенного к нему. Например имеет возможность знать, какие поля или поля строки, представляющие идентификатор для экземпляра сущности и позволяет звонить методы, такие как GetAssociated, GetIdentifierValuesи Executeна этот экземпляр сущности. |
|
IEntityInstanceEnumerator |
Перечислителя может использоваться для чтения данных в коллекции внешние элементы, но не может использоваться для изменения коллекции.
IEntityInstanceEnumerator поддерживает потоковая передача и поэтому очень полезен при возврате серверного приложения больших объемов данных. |
Вопросы и ответы по объектной модели клиента
<Нужно ли включать тег Method> в запрос CAML при запросе к внешнему списку
Нет.
Есть ли необходимость всех полей во внешний список с помощью запроса CAML?
Использование тега текст ViewXML в модели BDC, разработчик можно указать только те поля, которые необходимы и CSOM API-интерфейсы для списков будет возвращать только те поля.
См. также
Справочник по программистов Business Connectivity Services для SharePoint
Начало работы с помощью клиентской объектной модели с внешними данными в SharePoint
Как: используйте клиентская библиотека кода для доступа к внешним данным в SharePoint
Новые возможности служб Business Connectivity Services в SharePoint
Начало работы со службами Business Connectivity Services в SharePoint