Skip to main content

Manifest

The manifest file describes your app.

app

Identifying information about the app.

PropertyDescriptionRequiredTypeDefault
nameThe app's nametruestring-
keyThe app's keytruestring-
versionThe app's versiontruestring-
globalWhether to apply globallyfalsebooleantrue
categoryThe app's categoryfalseSystem-

modules

Defines the functions that contain your app's logic, and the different modules your apps use. refer to modules

resources

Define resources,Array<{key: string, value: string}>, refer to resources

PropertyDescriptionRequiredTypeDefault
keyresource keytruestring-
pathresource pathtruestring-

storage

Define the format for storing application data, please refer to Storage API for details.

display conditions

Control the visibility of the application, please refer to Display conditions for details.

dependVersion

dependVersion:
team:
- '2.2.0'
- '^2.10.0'
- '3.2.0 - 3.4.0'
- '>=3.8.0'
one:
- '2.0.4'
- '>=3.1.0'

dependVersion can declare dependencies on different products, such as: team, doc, code, one, and at least one of them is required.

If the dependVersion of the application does not match the current product version, the application subscription will fail.

The declared version is an array, representing the supported versions.

From the declaration above, it means that this app can support the following versions of team (as long as one of them is satisfied):

  • Version 2.2.0 (exact match)
  • Versions greater than or equal to 2.10.0 but less than 3.0.0
  • Versions between 3.2.0 and 3.4.0
  • Versions greater than or equal to 3.8.0, including 4.0.0 and 5.0.0