Freigeben über


StandardControl.getOutputSchema

Sie wird vor der Initialisierung einer Komponente vom Framework aufgerufen. Gibt ein Objektschema basierend auf der im Manifest definierten Nomenklatur für jede Ausgabeeigenschaft des Typobjekts zurück.

Verfügbar für

Modellgesteuerte Apps, Canvas-Apps und Portale.

Syntax

getOutputSchema(context)

Bemerkungen

Die Ausgabe enthält JSON-Schema für jede im Manifest definierte Eigenschaft des Typobjekts.

Wenn das Manifest z. B. eine Ausgabeeigenschaft vom Typobjekt hat, die aufgerufen MyOutputObjectwird, und ihr Steuerelement sollte ein Objekt wie folgt für den Wert der MyOutputObject Eigenschaft zurückgeben:

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

Anschließend sollten Sie Folgendes zurückgeben:

{ 

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

Das Rückgabeschema ist eine Teilmenge des JSON-Schemas. Unterstützte Typen und Schlüsselwort für JSON-Schema:

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

Die Parameter

Parametername Typ Erforderlich Description
context Zusammenhang ja Die Eingabeeigenschaften , die die Parameter, Komponentenmetadaten und Schnittstellenfunktionen enthalten.

Example

Steuerelement verfügt über eine aufgerufene Objekttypausgabeeigenschaft MyOutputObject , und der Wert sieht wie folgt aus:

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

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

Steuerung
Power Apps Component Framework-API-Referenz
Power Apps component framework Übersicht