Partager via

IDynamicDataCallables interface

  • Référence
Paquet:
@microsoft/sp-dynamic-data

Interface pour les composants à implémenter afin d’être des sources de données dynamiques. Cela peut être implémenté sous la forme d’un objet avec un état ou d’un ensemble de fonctions libres qui retournent les données.

Méthodes

allowedEvents()

Retourne la liste des événements autorisés sur la source de données dynamique.

Lorsque cette fonction retourne un résultat non vide, la source doit définir l’API « sendEvent ».

Si cette API n’est pas définie ou retourne un tableau vide, aucun consommateur ne peut communiquer avec cette source.
getAnnotatedPropertyValue(propertyId)

En fonction d’un ID de propriété, retourne sa valeur annotée. Si la source ne fournit pas la valeur annotée, elle revient à ce que « getPropertyValue » retourne, car la valeur de l’exemple et les métadonnées ne sont pas définies.
getPropertyDefinitions()

Retourne toutes les définitions de propriété que la source de données fournira.
getPropertyValue(propertyId)

En fonction d’un ID de propriété, retourne la valeur de la propriété .
sendEvent(eventName, data)

S’il est défini, permet au consommateur d’envoyer des données à la source de données dynamique associée. La source peut alors agir en conséquence.

L’appel de cette API génère une erreur lorsque le passé dans 'eventName' n’est pas l’un des événements autorisés sur la source.

Détails de la méthode

allowedEvents()

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Retourne la liste des événements autorisés sur la source de données dynamique.

Lorsque cette fonction retourne un résultat non vide, la source doit définir l’API « sendEvent ».

Si cette API n’est pas définie ou retourne un tableau vide, aucun consommateur ne peut communiquer avec cette source.

allowedEvents?(): ReadonlyArray<IDynamicDataEventDefinition>;

Retours

ReadonlyArray<IDynamicDataEventDefinition>

getAnnotatedPropertyValue(propertyId)

En fonction d’un ID de propriété, retourne sa valeur annotée. Si la source ne fournit pas la valeur annotée, elle revient à ce que « getPropertyValue » retourne, car la valeur de l’exemple et les métadonnées ne sont pas définies.

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

Paramètres

propertyId

string

Un des ID de propriété exposés à partir de la source de données dynamique.

Retours

IDynamicDataAnnotatedPropertyValue | undefined

getPropertyDefinitions()

Retourne toutes les définitions de propriété que la source de données fournira.

getPropertyDefinitions(): ReadonlyArray<IDynamicDataPropertyDefinition>;

Retours

ReadonlyArray<IDynamicDataPropertyDefinition>

getPropertyValue(propertyId)

En fonction d’un ID de propriété, retourne la valeur de la propriété .

getPropertyValue(propertyId: string): any;

Paramètres

propertyId

string

Retours

any

Remarques

On suppose que lorsque cette fonction retourne un tableau, il est homogène.

sendEvent(eventName, data)

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

S’il est défini, permet au consommateur d’envoyer des données à la source de données dynamique associée. La source peut alors agir en conséquence.

L’appel de cette API génère une erreur lorsque le passé dans 'eventName' n’est pas l’un des événements autorisés sur la source.

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

Paramètres

eventName

string

Chaîne sensible à la casse représentant le nom de l’événement.

data

any

Données à envoyer à la source de données dynamique.

Retours

void