Partager via

IDynamicDataSource interface

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

Les sources de données dynamiques fournissent des données dynamiques aux consommateurs. Ils offrent des métadonnées pour identifier les sources de données et l’API pour obtenir les données.

Propriétés

id

ID de la source de données dynamique.
metadata

Métadonnées de la source de données dynamique.

Méthodes

allowedEventsAsync()

Retourne la liste des événements autorisés sur la source de données dynamique. Lorsque cette API retourne un résultat non vide, la source doit définir l’api « sendData ».

Si cette API n’est pas définie ou retourne une carte 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 à la valeur « getPropertyValue », car la valeur de l’exemple et les métadonnées ne sont pas définies.
getAnnotatedPropertyValueAsync(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 à la valeur « getPropertyValue », 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é pour les données dynamiques. Cela doit être remplacé par l’implémentation du composant.
getPropertyDefinitionsAsync()

Retourne toutes les définitions de propriété pour les données dynamiques. Cela doit être remplacé par l’implémentation du composant.
getPropertyValue(propertyId)

En fonction d’un ID de propriété, retourne la valeur de la propriété . Cela doit être remplacé par l’implémentation du composant.
getPropertyValueAsync(propertyId)

En fonction d’un ID de propriété, retourne la valeur de la propriété . Cela doit être remplacé par l’implémentation du composant.
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 propriété

id

ID de la source de données dynamique.

id: string;

Valeur de propriété

string

metadata

Métadonnées de la source de données dynamique.

metadata: IDynamicDataSourceMetadata;

Valeur de propriété

IDynamicDataSourceMetadata

Détails de la méthode

allowedEventsAsync()

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 API retourne un résultat non vide, la source doit définir l’api « sendData ».

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

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

Retours

Promise<ReadonlyArray<IDynamicDataEventDefinition>>

getAnnotatedPropertyValue(propertyId)

Avertissement

Cette API est à présent déconseillée.

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

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 à la valeur « getPropertyValue », car la valeur de l’exemple et les métadonnées ne sont pas définies.

getAnnotatedPropertyValue(propertyId: string): IDynamicDataAnnotatedPropertyValue;

Paramètres

propertyId

string

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

Retours

IDynamicDataAnnotatedPropertyValue

getAnnotatedPropertyValueAsync(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 à la valeur « getPropertyValue », car la valeur de l’exemple et les métadonnées ne sont pas définies.

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

Paramètres

propertyId

string

ID de propriété pour laquelle la valeur est demandée.

Retours

Promise<IDynamicDataAnnotatedPropertyValue>

getPropertyDefinitions()

Avertissement

Cette API est à présent déconseillée.

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

Retourne toutes les définitions de propriété pour les données dynamiques. Cela doit être remplacé par l’implémentation du composant.

getPropertyDefinitions(): ReadonlyArray<IDynamicDataPropertyDefinition>;

Retours

ReadonlyArray<IDynamicDataPropertyDefinition>

getPropertyDefinitionsAsync()

Retourne toutes les définitions de propriété pour les données dynamiques. Cela doit être remplacé par l’implémentation du composant.

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

Retours

Promise<ReadonlyArray<IDynamicDataPropertyDefinition>>

getPropertyValue(propertyId)

Avertissement

Cette API est à présent déconseillée.

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

En fonction d’un ID de propriété, retourne la valeur de la propriété . Cela doit être remplacé par l’implémentation du composant.

getPropertyValue(propertyId: string): any;

Paramètres

propertyId

string

ID de propriété pour laquelle la valeur est demandée.

Retours

any

getPropertyValueAsync(propertyId)

En fonction d’un ID de propriété, retourne la valeur de la propriété . Cela doit être remplacé par l’implémentation du composant.

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

Paramètres

propertyId

string

ID de propriété pour laquelle la valeur est demandée.

Retours

Promise<any>

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