IDynamicDataSource interface

Pacote:

@microsoft/sp-dynamic-data

As Origens de Dados Dinâmicas fornecem Dados Dinâmicos aos consumidores. Oferecem metadados para identificar as origens de dados e a API para obter os dados.

Propriedades

id	ID da Origem de Dados Dinâmica.
metadata	Metadados da Origem de Dados Dinâmica.

Métodos

allowedEventsAsync()	Devolve a lista de eventos permitidos na origem de dados dinâmica. Quando esta api devolve um resultado não vazio, a origem tem de definir a api "sendData". Se esta api não estiver definida ou devolver um mapa vazio, nenhum consumidor poderá falar com esta origem.
getAnnotatedPropertyValue(propertyId)	Dado um ID de propriedade, devolve o respetivo valor anotado. Se a origem não fornecer o valor anotado, reverterá para o valor "getPropertyValue" que o valor de exemplo e os metadados não seriam definidos.
getAnnotatedPropertyValueAsync(propertyId)	Dado um ID de propriedade, devolve o respetivo valor anotado. Se a origem não fornecer o valor anotado, reverterá para o valor "getPropertyValue" que o valor de exemplo e os metadados não seriam definidos.
getPropertyDefinitions()	Devolve todas as definições de propriedade para dados dinâmicos. Isto tem de ser substituído pela implementação do componente.
getPropertyDefinitionsAsync()	Devolve todas as definições de propriedade para dados dinâmicos. Isto tem de ser substituído pela implementação do componente.
getPropertyValue(propertyId)	Dado um ID de propriedade, devolve o valor da propriedade . Isto tem de ser substituído pela implementação do componente.
getPropertyValueAsync(propertyId)	Dado um ID de propriedade, devolve o valor da propriedade . Isto tem de ser substituído pela implementação do componente.
sendEvent(eventName, data)	Se definido, permite ao consumidor enviar dados para a origem de dados dinâmica associada. Em seguida, a fonte pode agir em conformidade. Invocar esta api gera um erro quando o "eventName" transmitido não é um dos eventos permitidos na origem.

Detalhes da propriedade

id

ID da Origem de Dados Dinâmica.

id: string;

Valor da propriedade

string

metadata

Metadados da Origem de Dados Dinâmica.

metadata: IDynamicDataSourceMetadata;

Valor da propriedade

IDynamicDataSourceMetadata

Detalhes do método

allowedEventsAsync()

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Devolve a lista de eventos permitidos na origem de dados dinâmica. Quando esta api devolve um resultado não vazio, a origem tem de definir a api "sendData".

Se esta api não estiver definida ou devolver um mapa vazio, nenhum consumidor poderá falar com esta origem.

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

Retornos

Promise<ReadonlyArray<IDynamicDataEventDefinition>>

getAnnotatedPropertyValue(propertyId)

Aviso

Essa API foi preterida.

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

Dado um ID de propriedade, devolve o respetivo valor anotado. Se a origem não fornecer o valor anotado, reverterá para o valor "getPropertyValue" que o valor de exemplo e os metadados não seriam definidos.

getAnnotatedPropertyValue(propertyId: string): IDynamicDataAnnotatedPropertyValue;

Parâmetros

propertyId

string

Um dos IDs de propriedade expostos a partir da origem de dados dinâmica.

Retornos

IDynamicDataAnnotatedPropertyValue

getAnnotatedPropertyValueAsync(propertyId)

Dado um ID de propriedade, devolve o respetivo valor anotado. Se a origem não fornecer o valor anotado, reverterá para o valor "getPropertyValue" que o valor de exemplo e os metadados não seriam definidos.

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

Parâmetros

propertyId

string

ID da propriedade para o qual o valor é pedido.

Retornos

Promise<IDynamicDataAnnotatedPropertyValue>

getPropertyDefinitions()

Aviso

Essa API foi preterida.

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

Devolve todas as definições de propriedade para dados dinâmicos. Isto tem de ser substituído pela implementação do componente.

getPropertyDefinitions(): ReadonlyArray<IDynamicDataPropertyDefinition>;

Retornos

ReadonlyArray<IDynamicDataPropertyDefinition>

getPropertyDefinitionsAsync()

Devolve todas as definições de propriedade para dados dinâmicos. Isto tem de ser substituído pela implementação do componente.

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

Retornos

Promise<ReadonlyArray<IDynamicDataPropertyDefinition>>

getPropertyValue(propertyId)

Aviso

Essa API foi preterida.

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

Dado um ID de propriedade, devolve o valor da propriedade . Isto tem de ser substituído pela implementação do componente.

getPropertyValue(propertyId: string): any;

Parâmetros

propertyId

string

ID da propriedade para o qual o valor é pedido.

Retornos

any

getPropertyValueAsync(propertyId)

Dado um ID de propriedade, devolve o valor da propriedade . Isto tem de ser substituído pela implementação do componente.

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

Parâmetros

propertyId

string

ID da propriedade para o qual o valor é pedido.

Retornos

Promise<any>

sendEvent(eventName, data)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Se definido, permite ao consumidor enviar dados para a origem de dados dinâmica associada. Em seguida, a fonte pode agir em conformidade.

Invocar esta api gera um erro quando o "eventName" transmitido não é um dos eventos permitidos na origem.

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

Parâmetros

eventName

string

Uma cadeia sensível a maiúsculas e minúsculas que representa o nome do evento.

data

any

Dados a serem enviados para a origem de dados dinâmica.

Retornos

void