Uh oh! We couldn’t find any match.

Please try other search keywords.

Bixby Developer Center

Guides

description

required

Metadata provided in the capsule-info.bxb file.

Example

description {
  displayName(Tip Calculator)
  iconUrl (/images/icons/gratuity.png)
  description (Calculate the appropriate gratuity for a given service.)
  privacy-policy-url(http://my-capsule.com/privacy-policy)
  search-keywords{
    keyword (tips)
    keyword (calculator)
    keyword (gratuity)
  }
}

Child Keys

actionBgColor
optional
Background color of a button during a confirmation prompt
actionFgColor
optional
Foreground color of a button during a confirmation prompt
actionIconUrl
optional
This key is not currently used by Bixby
androidAppId
optional
Android application ID
companyName
optional
The capsule name that is visible to end-users
description
optional
Description of the capsule
dispatch-aliases
optional
Parent key for alternate names (alias) for when users interact with your capsule using named dispatch
dispatch-name
optional
The primary name for when users interact with your capsule using named dispatch
displayName
optional
The capsule name that is visible to end-users
iconUrl
optional
Icon that represents the provider or capsule
name[deprecated]
optional
Capsule name
privacy-policy-url
optional
Defines the URL to the privacy policy for your capsule
search-keywords
optional
Defines the set of keywords to use when searching in the capsule Marketplace
termsUrl
optional
Website associated with the capsule's terms and conditions
websiteUrl
optional
Website associated with the capsule