IDynamicDataSource interface

Пакет:

@microsoft/sp-dynamic-data

Динамические источники данных предоставляют потребителям динамические данные. Они предлагают метаданные для идентификации источников данных и API для получения данных.

Свойства

id	Идентификатор динамического источника данных.
metadata	Метаданные динамического источника данных.

Методы

allowedEventsAsync()	Возвращает список разрешенных событий в динамическом источнике данных. Когда этот API возвращает непустый результат, источник должен определить api sendData. Если этот API не определен или возвращает пустую карту, ни один потребитель не сможет взаимодействовать с этим источником.
getAnnotatedPropertyValue(propertyId)	При указании идентификатора свойства возвращает его значение с заметками. Если источник не предоставляет значение с заметками, он возвращается к методу getPropertyValue, так как выборочное значение и метаданные будут неопределенными.
getAnnotatedPropertyValueAsync(propertyId)	При указании идентификатора свойства возвращает его значение с заметками. Если источник не предоставляет значение с заметками, он возвращается к методу getPropertyValue, так как выборочное значение и метаданные будут неопределенными.
getPropertyDefinitions()	Возвращает все определения свойств для динамических данных. Его необходимо переопределить реализацией компонента.
getPropertyDefinitionsAsync()	Возвращает все определения свойств для динамических данных. Его необходимо переопределить реализацией компонента.
getPropertyValue(propertyId)	При указании идентификатора свойства возвращает значение свойства . Его необходимо переопределить реализацией компонента.
getPropertyValueAsync(propertyId)	При указании идентификатора свойства возвращает значение свойства . Его необходимо переопределить реализацией компонента.
sendEvent(eventName, data)	Если этот параметр определен, потребитель может отправлять данные в связанный динамический источник данных. Затем источник может действовать соответствующим образом. Вызов этого API выдает ошибку, если переданное в "eventName" не является одним из разрешенных событий в источнике.

Сведения о свойстве

id

Идентификатор динамического источника данных.

id: string;

Значение свойства

string

metadata

Метаданные динамического источника данных.

metadata: IDynamicDataSourceMetadata;

Значение свойства

IDynamicDataSourceMetadata

Сведения о методе

allowedEventsAsync()

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Возвращает список разрешенных событий в динамическом источнике данных. Когда этот API возвращает непустый результат, источник должен определить api sendData.

Если этот API не определен или возвращает пустую карту, ни один потребитель не сможет взаимодействовать с этим источником.

allowedEventsAsync?(): Promise<ReadonlyArray<IDynamicDataEventDefinition>>;

Возвращаемое значение

Promise<ReadonlyArray<IDynamicDataEventDefinition>>

getAnnotatedPropertyValue(propertyId)

Предупреждение

Теперь этот API является нерекомендуемым.

• This API is deprecated. Please use the asynchronous version getAsyncAnnotatedPropertyValue

При указании идентификатора свойства возвращает его значение с заметками. Если источник не предоставляет значение с заметками, он возвращается к методу getPropertyValue, так как выборочное значение и метаданные будут неопределенными.

getAnnotatedPropertyValue(propertyId: string): IDynamicDataAnnotatedPropertyValue;

Параметры

propertyId

string

Один из идентификаторов свойств, предоставляемых из динамического источника данных.

Возвращаемое значение

IDynamicDataAnnotatedPropertyValue

getAnnotatedPropertyValueAsync(propertyId)

При указании идентификатора свойства возвращает его значение с заметками. Если источник не предоставляет значение с заметками, он возвращается к методу getPropertyValue, так как выборочное значение и метаданные будут неопределенными.

getAnnotatedPropertyValueAsync(propertyId: string): Promise<IDynamicDataAnnotatedPropertyValue>;

Параметры

propertyId

string

Идентификатор свойства, для которого запрашивается значение.

Возвращаемое значение

Promise<IDynamicDataAnnotatedPropertyValue>

getPropertyDefinitions()

Предупреждение

Теперь этот API является нерекомендуемым.

• This API is deprecated. Please use the asynchronous version getPropertyDefinitionsAsync

Возвращает все определения свойств для динамических данных. Его необходимо переопределить реализацией компонента.

getPropertyDefinitions(): ReadonlyArray<IDynamicDataPropertyDefinition>;

Возвращаемое значение

ReadonlyArray<IDynamicDataPropertyDefinition>

getPropertyDefinitionsAsync()

Возвращает все определения свойств для динамических данных. Его необходимо переопределить реализацией компонента.

getPropertyDefinitionsAsync(): Promise<ReadonlyArray<IDynamicDataPropertyDefinition>>;

Возвращаемое значение

Promise<ReadonlyArray<IDynamicDataPropertyDefinition>>

getPropertyValue(propertyId)

Предупреждение

Теперь этот API является нерекомендуемым.

• This API is deprecated. Please use the asynchronous version getAsyncPropertyValue

При указании идентификатора свойства возвращает значение свойства . Его необходимо переопределить реализацией компонента.

getPropertyValue(propertyId: string): any;

Параметры

propertyId

string

Идентификатор свойства, для которого запрашивается значение.

Возвращаемое значение

any

getPropertyValueAsync(propertyId)

При указании идентификатора свойства возвращает значение свойства . Его необходимо переопределить реализацией компонента.

getPropertyValueAsync(propertyId: string): Promise<any>;

Параметры

propertyId

string

Идентификатор свойства, для которого запрашивается значение.

Возвращаемое значение

Promise<any>

sendEvent(eventName, data)

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Если этот параметр определен, потребитель может отправлять данные в связанный динамический источник данных. Затем источник может действовать соответствующим образом.

Вызов этого API выдает ошибку, если переданное в "eventName" не является одним из разрешенных событий в источнике.

sendEvent?(eventName: string, data: any): void;

Параметры

eventName

string

Строка с учетом регистра, представляющая имя события.

data

any

Данные, отправляемые в динамический источник данных.

Возвращаемое значение

void