IDynamicDataCallables interface

Paquete:

@microsoft/sp-dynamic-data

Interfaz para que los componentes se implementen para que sean orígenes de datos dinámicos. Esto se puede implementar como un objeto con estado o un conjunto de funciones sueltas que devuelve los datos.

Métodos

allowedEvents()	Devuelve la lista de eventos permitidos en el origen de datos dinámico. Cuando esta función devuelve un resultado no vacío, el origen debe definir la API "sendEvent". Si esta API no está definida o devuelve una matriz vacía, 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 devuelve "getPropertyValue", ya que el valor de ejemplo y los metadatos serían indefinidos.
getPropertyDefinitions()	Devuelve todas las definiciones de propiedad que proporcionará DataSource.
getPropertyValue(propertyId)	Dado un identificador de propiedad, devuelve el valor de la propiedad .
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 del método

allowedEvents()

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 función devuelve un resultado no vacío, el origen debe definir la API "sendEvent".

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

allowedEvents?(): ReadonlyArray<IDynamicDataEventDefinition>;

Devoluciones

ReadonlyArray<IDynamicDataEventDefinition>

getAnnotatedPropertyValue(propertyId)

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

getAnnotatedPropertyValue?(propertyId: string): IDynamicDataAnnotatedPropertyValue | undefined;

Parámetros

propertyId

string

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

Devoluciones

IDynamicDataAnnotatedPropertyValue | undefined

getPropertyDefinitions()

Devuelve todas las definiciones de propiedad que proporcionará DataSource.

getPropertyDefinitions(): ReadonlyArray<IDynamicDataPropertyDefinition>;

Devoluciones

ReadonlyArray<IDynamicDataPropertyDefinition>

getPropertyValue(propertyId)

Dado un identificador de propiedad, devuelve el valor de la propiedad .

getPropertyValue(propertyId: string): any;

Parámetros

propertyId

string

Devoluciones

any

Comentarios

Se supone que cuando esta función devuelve una matriz, es homogénea.

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