Skip to main content

Payload Type

info

Please note that this content is under development and is not ready for implementation. This status message will be updated as content development progresses.

Description​

The type property of the props object in a component configuration defines the kind of data that component is responsible for handling.

Usage​

The type property of the props object is required for component receiving data such as import-button, qr-code-scanner-dialog-button, etc. The component will use the type to determine how to handle the data it receives.

Types​

JSON​

When a component has the JSON type, it will suppose receive any JSON object as its payload and will not transform it in any way.

VerifiableCredential​

When a component has the VerifiableCredential type, it will suppose receive a Verifiable Credential as its payload and will verify the credential before using it.

Examples​

{
  "name": "ImportButton",
  "type": "EntryData",
  "props": {
    "label": "Import JSON",
    "type": "JSON",
    "style": {}
  }
}

In this example, the ImportButton component is of type EntryData and expects any JSON object as its payload.

{
  "name": "ImportButton",
  "type": "EntryData",
  "props": {
    "label": "Import JSON",
    "type": "VerifiableCredential",
    "style": {}
  }
}

In this example, the ImportButton component is of type EntryData and expects a Verifiable Credential as its payload.