Uh oh! We couldn’t find any match.

Please try other search keywords.

Bixby Developer Center

Guides

capsule

required

The capsule node contains metadata required by Bixby that specifies version information, device targets, and imported library capsules. It must be the only root node inside the capsule.bxb, which must live at the root directory of the capsule. For more information on how to set this file up, see Setting Up Your Capsule

Note

In addition to creating your capsule.bxb file, ensure you also configure your capsule, using the Config & Secrets UI in the Bixby Developer Center and/or your capsule.properties file.

Examples

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) }
}
}

If your capsule is itself a library capsule, you will need to use the library key within the capsule block, which controls import rights.

Library Example

capsule {
id (library.shirt)
version (0.1.0)
format(3)
targets {
target (can-en-US)
target (bixby-mobile-en-US)
}
library {
scope {
public
}
}
}

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-imports
optional
Lists the capsules that this one is dependent on
library
optional
Identifies this capsule as a library capsule
marketplace-constraints
optional
Node encapsulating any marketplace constraints
permissions
optional
Defines the permissions you can request from the user for this capsule
runtime-flags
optional
Changes specific runtime behavior during the execution of the capsule
store-sections
optional
Determines the collection of sections in the Marketplace store that this capsule is visible
targets
optional
List the locale and target device supported by the capsule
version
optional
The capsule version