IDynamicDataCallables interface

Paket:

@microsoft/sp-dynamic-data

Schnittstelle für Komponenten, die implementiert werden sollen, um dynamische Datenquellen zu sein. Dies kann als Objekt mit Zustand oder als Eine Reihe von losen Funktionen implementiert werden, die die Daten zurückgeben.

Methoden

allowedEvents()	Gibt eine Liste der zulässigen Ereignisse für die dynamische Datenquelle zurück. Wenn diese Funktion ein nicht leeres Ergebnis zurückgibt, muss die Quelle die API "sendEvent" definieren. Wenn diese API nicht definiert ist oder ein leeres Array zurückgibt, kann kein Consumer mit dieser Quelle kommunizieren.
getAnnotatedPropertyValue(propertyId)	Gibt bei einer Eigenschafts-ID den mit Anmerkungen versehenen Wert zurück. Wenn die Quelle den mit Anmerkungen versehenen Wert nicht angibt, greift sie auf das zurück, was "getPropertyValue" zurückgibt, da der Beispielwert und die Metadaten nicht definiert sind.
getPropertyDefinitions()	Gibt alle Eigenschaftendefinitionen zurück, die von DataSource bereitgestellt werden.
getPropertyValue(propertyId)	Gibt bei einer Eigenschafts-ID den Wert der Eigenschaft zurück.
sendEvent(eventName, data)	Sofern definiert, kann der Consumer Daten an die zugeordnete dynamische Datenquelle senden. Dann kann die Quelle entsprechend handeln. Beim Aufrufen dieser API wird ein Fehler ausgelöst, wenn das in "eventName" übergebene nicht zu den zulässigen Ereignissen in der Quelle gehört.

Details zur Methode

allowedEvents()

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Gibt eine Liste der zulässigen Ereignisse für die dynamische Datenquelle zurück.

Wenn diese Funktion ein nicht leeres Ergebnis zurückgibt, muss die Quelle die API "sendEvent" definieren.

Wenn diese API nicht definiert ist oder ein leeres Array zurückgibt, kann kein Consumer mit dieser Quelle kommunizieren.

allowedEvents?(): ReadonlyArray<IDynamicDataEventDefinition>;

Gibt zurück

ReadonlyArray<IDynamicDataEventDefinition>

getAnnotatedPropertyValue(propertyId)

Gibt bei einer Eigenschafts-ID den mit Anmerkungen versehenen Wert zurück. Wenn die Quelle den mit Anmerkungen versehenen Wert nicht angibt, greift sie auf das zurück, was "getPropertyValue" zurückgibt, da der Beispielwert und die Metadaten nicht definiert sind.

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

Parameter

propertyId

string

Eine der Eigenschaften-IDs, die aus der dynamischen Datenquelle verfügbar gemacht werden.

Gibt zurück

IDynamicDataAnnotatedPropertyValue | undefined

getPropertyDefinitions()

Gibt alle Eigenschaftendefinitionen zurück, die von DataSource bereitgestellt werden.

getPropertyDefinitions(): ReadonlyArray<IDynamicDataPropertyDefinition>;

Gibt zurück

ReadonlyArray<IDynamicDataPropertyDefinition>

getPropertyValue(propertyId)

Gibt bei einer Eigenschafts-ID den Wert der Eigenschaft zurück.

getPropertyValue(propertyId: string): any;

Parameter

propertyId

string

Gibt zurück

any

Hinweise

Es wird davon ausgegangen, dass diese Funktion, wenn sie ein Array zurückgibt, homogen ist.

sendEvent(eventName, data)

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Sofern definiert, kann der Consumer Daten an die zugeordnete dynamische Datenquelle senden. Dann kann die Quelle entsprechend handeln.

Beim Aufrufen dieser API wird ein Fehler ausgelöst, wenn das in "eventName" übergebene nicht zu den zulässigen Ereignissen in der Quelle gehört.

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

Parameter

eventName

string

Eine Zeichenfolge, bei der die Groß-/Kleinschreibung beachtet wird, die den Namen des Ereignisses darstellt.

data

any

Daten, die an die dynamische Datenquelle gesendet werden sollen.

Gibt zurück

void