StandardControl.getOutputSchema

Ia dipanggil oleh rangka kerja sebelum permulaan komponen. Mengembalikan skema objek berdasarkan tatanama yang ditakrifkan dalam manifes, untuk mana-mana sifat output objek jenis.

Tersedia untuk

Apl dipacu model, apl kanvas & portal.

Sintaks

getOutputSchema(context)

Ucapan

Output akan mengandungi skema JSON untuk setiap sifat jenis objek yang ditakrifkan dalam manifes.

Contohnya, jika manifes mempunyai sifat output jenis objek yang dipanggil MyOutputObject, dan kawalan anda harus mengembalikan objek seperti ini untuk nilai MyOutputObject sifat:

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

Kemudian anda harus mengembalikan:

{ 

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

Skema pemulangan ialah subset skema JSON. Jenis dan kata kunci yang disokong untuk skema JSON:

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

Parameter

Nama Parameter Jenis Wajib Keterangan
konteks Konteks ya Sifat Input yang mengandungi parameter, metadata komponen dan fungsi antara muka.

Contoh

Kawalan mempunyai sifat output jenis objek yang dipanggil MyOutputObject dan nilainya kelihatan seperti ini:

{ 
  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 Pelaksanaan:

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" 
              }, 
            } 
          } 
        } 
      } 
    } 
  }); 
} 

Kawalan
Rujukan API rangka kerja komponen Power Apps
Gambaran keseluruhan rangka kerja komponen Power Apps