Bixby Developer Center

Guides
References

6748

We've made a number of updates to the capsule-info.bxb file, which allows you to provide information about your capsule, such as the name, website, and branding images:

  • Renamed top-level description key to capsule-info.
  • Replaced companyName with developer-name.
  • Deprecated all related camel-case keys, which have been replaced with hyphenated variants.
  • Deprecated name, which has been replaced with display-name.
  • iconUrl has been deprecated, which has been replaced with icon-asset.
  • Added new option to include up to 10 screenshots.

Learn more about setting up your capsule's capsule-info.bxb file.

Examples

Deprecated:

description {
name (Tip Calculator)
displayName(Tip Calculator)
iconUrl (/images/icons/gratuity.png)
imageUrl (/images/icons/gratuity.png)
description (Calculate the appropriate gratuity for a given service.)
dispatch-name (tip calculator)
dispatch-aliases {
alias (tip calculator app)
alias (gratuity calculator)
alias (gratuity calculator app)
alias (tips)
alias (gratuity)
}
websiteUrl (http://bixby.samsung.com/)
}

New:

capsule-info {
display-name (Tip Calculator)
icon-asset (/images/icons/gratuity.png) // must be local asset
image-asset (/images/icons/gratuity.png) // must be local asset
description (Calculate the appropriate gratuity for a given service.)
dispatch-name (tip calculator)
dispatch-aliases {
alias (tip calculator app)
alias (gratuity calculator)
alias (gratuity calculator app)
alias (tips)
alias (gratuity)
}
website-url (http://bixby.samsung.com/)

screenshots {
asset (/foo/fi/foh/fum.jpg)
asset (https://example.com/image.jpg) // ERROR, only local assets
}
}

Deprecation Stages (learn more)

  • Stage 1: R19O
  • Stage 2: R19O
  • End of Life: R19U