Componente de saída de objeto

[Este tópico é documentação de pré-lançamento e está sujeito a alterações.]

Este componente de exemplo mostra como usar propriedades de saída de tipo de objeto. Esse componente gera um objeto estático e uma saída por meio de uma propriedade que pode ser acessada em um aplicativo de tela ou por meio de APIs de cliente em um formulário de modelo.

Disponível para

Aplicativos orientados por modelo e aplicativos Canvas

Pré-requisitos

Familiaridade na criação de componentes de código.

Código

Você pode encontrar o exemplo de código completo aqui: PowerApps-Samples/component-framework/ObjectOutputControl/.

O manifesto inclui uma propriedade de tipo de objeto chamada Data e uma propriedade oculta chamada DataSchema . A propriedade DataSchema é necessária apenas para aplicativos Canvas e usada pela plataforma para obter o esquema de objeto de saída. Também precisamos criar uma dependência de propriedade entre essas duas propriedades.

<!-- A hidden property used by Canvas to get the output object schema -->
<property name="DataSchema"
   display-name-key="DataSchema"
   description-key="DataSchema"
   of-type="SingleLine.Text"
   usage="input"
   hidden="true" />
<!-- The object type output property -->
<property name="Data"
   display-name-key="Data"
   description-key="Data"
   of-type="Object"
   usage="output"
   hidden="false"
   default-value="" />
<property-dependencies>
   <!-- Define the dependency between schema and the object type property -->
   <property-dependency input="DataSchema"
      output="Data"
      required-for="schema" />
</property-dependencies>

No arquivo index.ts, precisamos adicionar o método getOutputSchema para fornecer o esquema de objeto de saída. Quando o controle é adicionado a um aplicativo Canvas, a plataforma chama esse método antes da inicialização do controle para receber o(s) esquema(s) do(s) objeto(s) de saída.

public async getOutputSchema(context: ComponentFramework.Context<IInputs>): Promise<Record<string, unknown>> {
   return Promise.resolve({
      Data: StaticDataSchema
   });
}

Atualize o método para retornar o getOutput valor para a propriedade de saída.

public getOutputs(): IOutputs {
   return {
      Data: this._staticData
   };
}

O onLoadData método é chamado quando o botão Load Data é pressionado para carregar os dados no objeto de saída e notificar a plataforma sobre as alterações de saída. Isso dispara o comportamento onChange no aplicativo Canvas para o controle ou o evento OnOutputChange para APIs de cliente.

private onLoadData = async () => {
   this._staticData = StaticData;
   this._staticData.loadCounter = (this._staticData.loadCounter || 0) + 1;
   this.notifyOutputChanged();
}

Artigos relacionados

Evento onOutputChange
StandardControl.getOutputSchema
ReactControl.getOutputSchema
StandardControl.getOutputs
ReactControl.getOutputs