As a developer, strive to ensure that users have a predictable experience in Bixby, no matter which capsule they are using. Refer to the design principles behind Bixby while developing your capsule. Also, the Designing Conversations guide describes how each conversation between Bixby and users should flow, including how to write dialog and the components to use in various views. The Designing With Bixby Views guide discusses the components that you should use within views. This guide specifically defines the key policies that govern a consistent user experience with respect to punching out.
In general, users should stay in the Bixby interface while interacting with your capsule. Staying within Bixby allows users to experience efficient and personalized experiences you can offer within your capsule. Additionally, it gives you, as the developer, several benefits:
As previously mentioned, you should strive to keep your user in the Bixby experience until their task is complete. However, there are a few situations in which leaving the Bixby experience makes sense. These typically break down into two cases: (1) the user asks Bixby to open an app directly and (2) the user taps on something in a Bixby result view that causes a punch-out action for a scenario that is within the defined policy.
If the utterance requires more information (for example, Which John do you want to call? or On which service should I play this video?), you should handle this in Bixby before launching the appropriate application.
You can direct them to a separate application in the following situations:
You can have users tap on a component in Bixby to navigate them out to a website or application in the following situations:
If your user is purchasing something in Bixby, you should have them punch out to the appropriate application to finish the transaction. Your capsule should still help users complete as much of the transaction as possible (such as filling out details of an order or setting the date and time for a reservation), but once Bixby collects that information, you should direct the user to complete payments or bookings in the app or website with the Action Button. For more information on how to punch out, see How to Navigate Users Out of Bixby.
For example, if users say "Buy chocolate chip cookies", your capsule can return a list of results. Once they tap on a result they like, it can direct them to the details view of that item. In the details view, your
select-button-text could say something like "Buy on My Cookies Company". When they tap on that Action Button, you can use
app-launch to direct users to the "My Cookies Company" app or website, where they can purchase the item.
For situations not specifically listed in when you should punch out, you should model and train Bixby to stay within its interface. Additionally, if you need to disambiguate any situation in the previous section, you should gracefully handle this in Bixby before punching out to the app. For example, if users ask "Call John" and there are multiple Johns in their contacts list, you should create an
input-view to list the contacts, asking Which John? for users to select.
Do not punch out of Bixby in the following situations:
If you need to direct a user to another location and your situation does not follow the app launch policies listed above, consider using an
attribution-link instead. For more examples and additional guidelines, see Punching Out of Bixby Views.
If you have a scenario that falls into the acceptable situations of when it's okay to leave Bixby, you can punch out using the following methods:
app-launchkey in a
result-view. This will automatically take a user out of Bixby to the designated application.
on-clickkey defined in a component to direct them to a URL or an intent that takes them to a separate application. The user must tap on the component in a Bixby View in order to punch out.
attribution-linkat the bottom of a
result-view. The user has to tap on the link at the bottom of the page to leave Bixby.
If you are sending the user out of Bixby through an
on-click, you must define the
external-link-badge child key to indicate to users that tapping on that component will make them exit Bixby.