StandardControl.getOutputSchema

Det kaldes af strukturen før en komponentinitialisering. Returnerer et objektskema, der er baseret på den nomenklatur, der er defineret i manifestet, for alle outputegenskaber for typeobjektet.

Tilgængelig for

Modeldrevne apps, lærredsapps og portaler.

Syntaks

getOutputSchema(context)

Bemærkninger

Outputtet indeholder JSON-skema for hver egenskab af typen objekt, der er defineret i manifestet.

Hvis manifestet f.eks. har en outputegenskab af typen objekt kaldet MyOutputObject, og kontrolelementet skal returnere et objekt som dette for egenskabens MyOutputObject værdi:

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

Derefter skal du returnere:

{ 

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

Returskemaet er et undersæt af JSON-skemaet. Understøttede typer og nøgleord for JSON-skema:

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

Parametre

Parameternavn	Type	Obligatorisk	Beskrivelse
kontekst	Sammenhæng	yes	Inputegenskaberne, der indeholder parametrene, komponentmetadata og grænsefladefunktioner.

Eksempel

Kontrolelementet har en outputegenskab af objekttypen, der kaldes MyOutputObject , og værdien ser sådan ud:

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

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

Relaterede artikler

Kontrolelement
API-reference til Power Apps Component Framework
Oversigt over Komponentstruktur i Power Apps