Freigeben über

IDynamicDataSource interface

  • Referenz
Paket:
@microsoft/sp-dynamic-data

Dynamische Datenquellen stellen dynamische Daten für Consumer bereit. Sie bieten Metadaten, um die Datenquellen und die API zum Abrufen der Daten zu identifizieren.

Eigenschaften

id

ID der dynamischen Datenquelle.
metadata

Metadaten der dynamischen Datenquelle.

Methoden

allowedEventsAsync()

Gibt eine Liste der zulässigen Ereignisse für die dynamische Datenquelle zurück. Wenn diese API ein nicht leeres Ergebnis zurückgibt, muss die Quelle die API "sendData" definieren.

Wenn diese API nicht definiert ist oder eine leere Zuordnung 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 den "getPropertyValue"-Wert zurück, da der Beispielwert und die Metadaten nicht definiert wären.
getAnnotatedPropertyValueAsync(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 den "getPropertyValue"-Wert zurück, da der Beispielwert und die Metadaten nicht definiert wären.
getPropertyDefinitions()

Gibt alle Eigenschaftendefinitionen für dynamische Daten zurück. Dies muss von der Implementierung der Komponente überschrieben werden.
getPropertyDefinitionsAsync()

Gibt alle Eigenschaftendefinitionen für dynamische Daten zurück. Dies muss von der Implementierung der Komponente überschrieben werden.
getPropertyValue(propertyId)

Gibt bei einer Eigenschafts-ID den Wert der Eigenschaft zurück. Dies muss von der Implementierung der Komponente überschrieben werden.
getPropertyValueAsync(propertyId)

Gibt bei einer Eigenschafts-ID den Wert der Eigenschaft zurück. Dies muss von der Implementierung der Komponente überschrieben werden.
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 Eigenschaft

id

ID der dynamischen Datenquelle.

id: string;

Eigenschaftswert

string

metadata

Metadaten der dynamischen Datenquelle.

metadata: IDynamicDataSourceMetadata;

Eigenschaftswert

IDynamicDataSourceMetadata

Details zur Methode

allowedEventsAsync()

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 API ein nicht leeres Ergebnis zurückgibt, muss die Quelle die API "sendData" definieren.

Wenn diese API nicht definiert ist oder eine leere Zuordnung zurückgibt, kann kein Consumer mit dieser Quelle kommunizieren.

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

Gibt zurück

Promise<ReadonlyArray<IDynamicDataEventDefinition>>

getAnnotatedPropertyValue(propertyId)

Warnung

Diese API ist nun veraltet.

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

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 den "getPropertyValue"-Wert zurück, da der Beispielwert und die Metadaten nicht definiert wären.

getAnnotatedPropertyValue(propertyId: string): IDynamicDataAnnotatedPropertyValue;

Parameter

propertyId

string

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

Gibt zurück

IDynamicDataAnnotatedPropertyValue

getAnnotatedPropertyValueAsync(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 den "getPropertyValue"-Wert zurück, da der Beispielwert und die Metadaten nicht definiert wären.

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

Parameter

propertyId

string

Eigenschafts-ID, für die der Wert angefordert wird.

Gibt zurück

Promise<IDynamicDataAnnotatedPropertyValue>

getPropertyDefinitions()

Warnung

Diese API ist nun veraltet.

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

Gibt alle Eigenschaftendefinitionen für dynamische Daten zurück. Dies muss von der Implementierung der Komponente überschrieben werden.

getPropertyDefinitions(): ReadonlyArray<IDynamicDataPropertyDefinition>;

Gibt zurück

ReadonlyArray<IDynamicDataPropertyDefinition>

getPropertyDefinitionsAsync()

Gibt alle Eigenschaftendefinitionen für dynamische Daten zurück. Dies muss von der Implementierung der Komponente überschrieben werden.

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

Gibt zurück

Promise<ReadonlyArray<IDynamicDataPropertyDefinition>>

getPropertyValue(propertyId)

Warnung

Diese API ist nun veraltet.

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

Gibt bei einer Eigenschafts-ID den Wert der Eigenschaft zurück. Dies muss von der Implementierung der Komponente überschrieben werden.

getPropertyValue(propertyId: string): any;

Parameter

propertyId

string

Eigenschafts-ID, für die der Wert angefordert wird.

Gibt zurück

any

getPropertyValueAsync(propertyId)

Gibt bei einer Eigenschafts-ID den Wert der Eigenschaft zurück. Dies muss von der Implementierung der Komponente überschrieben werden.

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

Parameter

propertyId

string

Eigenschafts-ID, für die der Wert angefordert wird.

Gibt zurück

Promise<any>

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