IDynamicDataSource interface
动态数据源向使用者提供动态数据。 它们提供元数据来标识数据源和 API 来获取数据。
方法
| allowed |
返回动态数据源上允许的事件的列表。 当此 API 返回非空结果时,源必须定义“sendData”api。 如果未定义此 API 或返回空映射,则任何使用者都无法与此源通信。 |
| get |
给定属性 ID 后,返回其批注值。 如果源未提供批注值,则它会回退到任何“getPropertyValue”,因为示例值和元数据是未定义的。 |
| get |
给定属性 ID 后,返回其批注值。 如果源未提供批注值,则它会回退到任何“getPropertyValue”,因为示例值和元数据是未定义的。 |
| get |
返回动态数据的所有属性定义。 这需要通过组件的实现来替代。 |
| get |
返回动态数据的所有属性定义。 这需要通过组件的实现来替代。 |
| get |
给定属性 ID,返回属性的值。 这需要通过组件的实现来替代。 |
| get |
给定属性 ID,返回属性的值。 这需要通过组件的实现来替代。 |
| send |
如果已定义,则使用者能够将数据发送到关联的动态数据源。 然后,源可以采取相应的措施。 当在“eventName”中传递的 不是源上允许的事件之一时,调用此 API 会引发错误。 |
属性详细信息
id
动态数据源的 ID。
id: string;
属性值
string
metadata
方法详细信息
allowedEventsAsync()
注意
此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
返回动态数据源上允许的事件的列表。 当此 API 返回非空结果时,源必须定义“sendData”api。
如果未定义此 API 或返回空映射,则任何使用者都无法与此源通信。
allowedEventsAsync?(): Promise<ReadonlyArray<IDynamicDataEventDefinition>>;
返回
Promise<ReadonlyArray<IDynamicDataEventDefinition>>
getAnnotatedPropertyValue(propertyId)
警告
现已弃用此 API。
- This API is deprecated. Please use the asynchronous version
getAsyncAnnotatedPropertyValue
给定属性 ID 后,返回其批注值。 如果源未提供批注值,则它会回退到任何“getPropertyValue”,因为示例值和元数据是未定义的。
getAnnotatedPropertyValue(propertyId: string): IDynamicDataAnnotatedPropertyValue;
参数
- propertyId
-
string
从动态数据源公开的属性 ID 之一。
返回
getAnnotatedPropertyValueAsync(propertyId)
给定属性 ID 后,返回其批注值。 如果源未提供批注值,则它会回退到任何“getPropertyValue”,因为示例值和元数据是未定义的。
getAnnotatedPropertyValueAsync(propertyId: string): Promise<IDynamicDataAnnotatedPropertyValue>;
参数
- propertyId
-
string
为其请求值的属性 ID。
返回
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
给定属性 ID,返回属性的值。 这需要通过组件的实现来替代。
getPropertyValue(propertyId: string): any;
参数
- propertyId
-
string
为其请求值的属性 ID。
返回
any
getPropertyValueAsync(propertyId)
给定属性 ID,返回属性的值。 这需要通过组件的实现来替代。
getPropertyValueAsync(propertyId: string): Promise<any>;
参数
- propertyId
-
string
为其请求值的属性 ID。
返回
Promise<any>
sendEvent(eventName, data)
注意
此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
如果已定义,则使用者能够将数据发送到关联的动态数据源。 然后,源可以采取相应的措施。
当在“eventName”中传递的 不是源上允许的事件之一时,调用此 API 会引发错误。
sendEvent?(eventName: string, data: any): void;
参数
- eventName
-
string
表示事件名称的区分大小写的字符串。
- data
-
any
要发送到动态数据源的数据。
返回
void