Skip to content

Commit 3d2834e

Browse files
committed
feat: Document offline_support field to manifest.webapp section
1 parent 68c0a3b commit 3d2834e

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -243,6 +243,7 @@ Field | Description
243243
`name_prefix` | the prefix to display with the name
244244
`notifications` | an object defining how the application can notify the user. See [Notifications](https://docs.cozy.io/en/cozy-stack/apps/#notifications) documentation.
245245
`oauth` | _(konnector specific)_ JSON object containing oAuth information, like `scope`. If a manifest provides an `oauth` property, it is considered as an OAuth konnector. Note: scope can be a string or an array. If it is an array, its values will be joined with a space. A `false` or `null` value in scope will remove any scope parameter in the request sent to the oauth provider.
246+
`offline_support` | (Boolean) indicating if the app supports Offline mode when opened from our Flagship applicaiton. See [Flagship Offline mode](https://github.com/cozy/cozy-flagship-app/blob/master/docs/how-to-make-cozy-app-offline-compatible.md) documentation
246247
`parameters` | _(konnector specific)_ Additional parameters which should be passed to the konnector. Used for example for bank konnectors to pass a `bankId` parameter.
247248
`partnership` | an object to provide informations (to display in the Store for example) about a partnership related to the application (`icon` `description`, `name` and `domain`). It can also be used to trigger alternative konnector connection policies for some vendors (see the [budget-insight konnector policy in cozy-harvest](https://github.com/cozy/cozy-libs/blob/065f7e2f3e89efa3b6b49e4ba7f9e20f92825560/packages/cozy-harvest-lib/src/services/budget-insight.js#L123)).
248249
`permissions` | a map of permissions needed by the app (see [see cozy-stack permissions doc ](https://docs.cozy.io/en/cozy-stack/permissions/) for more details)

0 commit comments

Comments
 (0)