Uh oh! We couldn’t find any match.

Please try other search keywords.

Bixby Developer Center

Guides

capsule

required

The capsule node contains the metadata required by Bixby to know how to interpret the contents of a capsule source code. It must be the only root node inside the capsule.bxb, which must live at the root directory of the capsule.

Note

In addition to creating your capsule.bxb file, ensure you also configure your capsule.properties file, which allows you to store configuration properties related to your capsule.

Example

capsule {
id (example.shirt)
version (0.1.0)
format(3)
targets {
target (can-en-US)
target (bixby-mobile-en-US)
}
capsule-imports {
import (viv.core) { as (core) }
import (viv.money) { as (money) }
import (viv.time) { as (time) }
}
}

Child Keys

format
required
The value associated with the key format indicates the capsule format version with which this capsule is compatible
id
required
The globally unique identifier for the capsule
capsule-categories
optional
This is a beta feature and doesn't yet have documentation
capsule-imports
optional
Lists the capsules that this one is dependent on
marketplace-constraints
optional
Node encapsulating any marketplace constraints
permissions
optional
Defines the permissions you can request from the user for this capsule
targets
optional
List the locale and target device supported by the capsule
version
optional
The capsule version