Manifest

The manifest is a JSON file that describes some properties of your plugin.

metadata/manifest.json

{
  "name": "Sample plugin",
  "version": "1.0.0",
  "allowedDomains": [
    {
      "domain": "example.com",
      "reason": "A reason to fetch from example.com"
    }
  ],
  "permissions": {
    "geolocation": {
      "required": true,
      "reason": "I need it because X reasoning"
    }
  }
}

name

The name of your plugin. This is the name that will be displayed in Qatium UI. Accepts a string or an object with translations.

Name Translations

For translations it currently accepts the following locale language codes:

• en (English)
• es (Spanish)
• pt (Portuguese)

It defaults to en if other translations are not specified, but it’s recommended to provide translations for all languages that are supported in the app (English, Spanish and Portuguese).

Example

metadata/manifest.json

{
  "name": {
    "en": "Tank autonomy",
    "es": "Autonomía de los tanques",
    "pt": "Autonomia dos tanques"
  },
  "version": "1.0.0"
}

runtime

It can be either:

• js: For plugins developed in JavaScript (or Typescript)
• python: For plugins developed in Python

It defaults to js if none is specified.

version

The version of your plugin. This will be used for tracking and versioning your plugin in the Marketplace.

allowedDomains

A list of domains that your plugin will be fetching to and a reason to do so. This is an optional property. If no domains are listed, you won’t be able to fetch any external data.

permissions

A list of permissions that you’re plugin may need. Currently only geolocation is supported.

geolocation

{
  "geolocation": {
    "required": true,
    "reason": "I need it because X reasoning"
  }
}

downloads

If your plugin needs to perform downloads use this permission attribute.

{
  "downloads": {
    "required": true,
    "reason": "I need it because X reasoning"
  }
}