ReactControl.getOutputSchema

Ele é chamado pela estrutura antes da inicialização de um componente. Retorna um esquema de objeto com base na nomenclatura definida em manifesto, para qualquer propriedade de saída do tipo objeto.

Disponível para

Aplicativos orientados a modelos, aplicativos de tela, portais Ads.

Sintaxe

getOutputSchema(context)

Observações

A saída conterá esquema JSON para cada propriedade do tipo objeto definido no manifesto.

Por exemplo, se o manifesto tiver uma propriedade de saída do tipo objeto chamado MyOutputObject, e seu controle deve retornar um objeto como este para o valor da MyOutputObject propriedade:

{ 
  "ProductName": "sample name", 
  "Value": 123.4 
} 

Então você deve retornar:

{ 

  "MyOutputObject": { 
    "$schema": "http://json-schema.org/draft-04/schema#", 
    "type": "object", 
    "properties": { 
      "ProductName": { 
        "type": "string" 
      }, 
      "Value": { 
        "type": "number" 
      } 
    } 
  } 
} 

O esquema de retorno é um subconjunto do esquema JSON. Tipos e palavra-chave suportados para o esquema JSON:

• string
• integer
• number
• array
  • items
• object
  • properties
• boolean

Parâmetros

Example

O controle tem uma propriedade de saída de tipo de objeto chamada MyOutputObject e o valor tem esta aparência:

{ 
  id: 10, 
  productDetails: { 
    name: "Test Product", 
    price: 100.23, 
  }, 
  itemList: [ 
    { 
      itemId: 1, 
      name: "Item-1", 
      value: 123, 
      active: true, 
    }, 
    { 
      itemId: 2, 
      name: "Item-2", 
      value: 234, 
      active: false, 
    } 
  ] 
}; 

GetOutputSchema Execução:

public async getOutputSchema(context: ComponentFramework.Context<IInputs>): 
Promise<Record<string, unknown>> { 
  return Promise.resolve({ 
    MyOutputObject: { 
      "$schema": "http://json-schema.org/draft-04/schema#", 
      "type": "object", 
      "properties": { 
        "id": { 
          "type": "integer" 
        }, 
        "productDetails": { 
          "type": "object", 
          "properties": { 
            "name": { 
              "type": "string" 
            }, 
            "price": { 
              "type": "number" 
            } 
          } 
        }, 
        "itemList": { 
          "type": "array", 
          "items": 
          { 
            "type": "object", 
            "properties": { 
              "itemId": { 
                "type": "integer" 
              }, 
              "name": { 
                "type": "string" 
              }, 
              "value": { 
                "type": "integer" 
              }, 
              "active": { 
                "type": "boolean" 
              }, 
            } 
          } 
        } 
      } 
    } 
  }); 
} 

Artigos relacionados

ReactControl (Pré-visualização)
Referência da API da estrutura do componente Power Apps
Visão geral da estrutura do componente Power Apps