IDynamicDataSource interface

Paquete:

@microsoft/sp-dynamic-data

Los orígenes de datos dinámicos proporcionan datos dinámicos a los consumidores. Ofrecen metadatos para identificar los orígenes de datos y la API para obtener los datos.

Propiedades

id	Identificador del origen de datos dinámico.
metadata	Metadatos del origen de datos dinámico.

Métodos

allowedEventsAsync()	Devuelve la lista de eventos permitidos en el origen de datos dinámico. Cuando esta API devuelve un resultado no vacío, el origen debe definir la API "sendData". Si esta API no está definida o devuelve un mapa vacío, ningún consumidor podrá comunicarse con este origen.
getAnnotatedPropertyValue(propertyId)	Dado un identificador de propiedad, devuelve su valor anotado. Si el origen no proporciona el valor anotado, vuelve a lo que sea "getPropertyValue", ya que el valor de ejemplo y los metadatos serían indefinidos.
getAnnotatedPropertyValueAsync(propertyId)	Dado un identificador de propiedad, devuelve su valor anotado. Si el origen no proporciona el valor anotado, vuelve a lo que sea "getPropertyValue", ya que el valor de ejemplo y los metadatos serían indefinidos.
getPropertyDefinitions()	Devuelve todas las definiciones de propiedad de los datos dinámicos. Esto debe invalidarse mediante la implementación del componente.
getPropertyDefinitionsAsync()	Devuelve todas las definiciones de propiedad de los datos dinámicos. Esto debe invalidarse mediante la implementación del componente.
getPropertyValue(propertyId)	Dado un identificador de propiedad, devuelve el valor de la propiedad . Esto debe invalidarse mediante la implementación del componente.
getPropertyValueAsync(propertyId)	Dado un identificador de propiedad, devuelve el valor de la propiedad . Esto debe invalidarse mediante la implementación del componente.
sendEvent(eventName, data)	Si se define, permite al consumidor enviar datos al origen de datos dinámico asociado. A continuación, source puede actuar en consecuencia. La invocación de esta API produce un error cuando el objeto pasado en 'eventName' no es uno de los eventos permitidos en el origen.

Detalles de las propiedades

id

Identificador del origen de datos dinámico.

id: string;

Valor de propiedad

string

metadata

Metadatos del origen de datos dinámico.

metadata: IDynamicDataSourceMetadata;

Valor de propiedad

IDynamicDataSourceMetadata

Detalles del método

allowedEventsAsync()

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Devuelve la lista de eventos permitidos en el origen de datos dinámico. Cuando esta API devuelve un resultado no vacío, el origen debe definir la API "sendData".

Si esta API no está definida o devuelve un mapa vacío, ningún consumidor podrá comunicarse con este origen.

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

Devoluciones

Promise<ReadonlyArray<IDynamicDataEventDefinition>>

getAnnotatedPropertyValue(propertyId)

Advertencia

Esta API ya está en desuso.

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

Dado un identificador de propiedad, devuelve su valor anotado. Si el origen no proporciona el valor anotado, vuelve a lo que sea "getPropertyValue", ya que el valor de ejemplo y los metadatos serían indefinidos.

getAnnotatedPropertyValue(propertyId: string): IDynamicDataAnnotatedPropertyValue;

Parámetros

propertyId

string

Uno de los identificadores de propiedad expuestos desde el origen de datos dinámico.

Devoluciones

IDynamicDataAnnotatedPropertyValue

getAnnotatedPropertyValueAsync(propertyId)

Dado un identificador de propiedad, devuelve su valor anotado. Si el origen no proporciona el valor anotado, vuelve a lo que sea "getPropertyValue", ya que el valor de ejemplo y los metadatos serían indefinidos.

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

Parámetros

propertyId

string

Id. de propiedad para el que se solicita el valor.

Devoluciones

Promise<IDynamicDataAnnotatedPropertyValue>

getPropertyDefinitions()

Advertencia

Esta API ya está en desuso.

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

Devuelve todas las definiciones de propiedad de los datos dinámicos. Esto debe invalidarse mediante la implementación del componente.

getPropertyDefinitions(): ReadonlyArray<IDynamicDataPropertyDefinition>;

Devoluciones

ReadonlyArray<IDynamicDataPropertyDefinition>

getPropertyDefinitionsAsync()

Devuelve todas las definiciones de propiedad de los datos dinámicos. Esto debe invalidarse mediante la implementación del componente.

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

Devoluciones

Promise<ReadonlyArray<IDynamicDataPropertyDefinition>>

getPropertyValue(propertyId)

Advertencia

Esta API ya está en desuso.

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

Dado un identificador de propiedad, devuelve el valor de la propiedad . Esto debe invalidarse mediante la implementación del componente.

getPropertyValue(propertyId: string): any;

Parámetros

propertyId

string

Id. de propiedad para el que se solicita el valor.

Devoluciones

any

getPropertyValueAsync(propertyId)

Dado un identificador de propiedad, devuelve el valor de la propiedad . Esto debe invalidarse mediante la implementación del componente.

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

Parámetros

propertyId

string

Id. de propiedad para el que se solicita el valor.

Devoluciones

Promise<any>

sendEvent(eventName, data)

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Si se define, permite al consumidor enviar datos al origen de datos dinámico asociado. A continuación, source puede actuar en consecuencia.

La invocación de esta API produce un error cuando el objeto pasado en 'eventName' no es uno de los eventos permitidos en el origen.

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

Parámetros

eventName

string

Cadena que distingue mayúsculas de minúsculas que representa el nombre del evento.

data

any

Datos que se van a enviar al origen de datos dinámico.

Devoluciones

void