Bixby Developer Center

References

qualified

optionalvalue required

Defines a qualified primitive concept model. A qualified model is a primitive Name that matches a regular expression, defined by a regex-pattern. This is a good choice when you want to validate a string and want it to be visible to Bixby, but can’t enumerate every possible value in advance. The regex also makes it easier for Bixby to recognize valid values.

This top-level key and its child keys must be defined in a *.model.bxb file. The file must be in the models/concepts folder.

Example

// models/concepts/primitives/PhoneNumber.model.bxb
qualified (PhoneNumber) {
description (A string representing a phone number that is validated by a qualification pattern)
regex-pattern ("\\+?1? ?-? ?((\\(\\d\\d\\d\\))|\\d\\d\\d)? ?-? ?\\d\\d\\d ?-? ?\\d\\d\\d\\d")

named-consumer (call) {
description (Call this number)
action (Call)
input (phoneNumber)
}
}

Child Keys

description
optional
Adds text describing the primitive concept, which is useful in describing how a primitive can be used
equivalence
optional
A primitive equivalence policy specifies how the system should compare two instances of the same concept
extends
optional
Extends a parent concept with a new child concept, which inherits all of the parent properties
features
optional
Marks a concept with special concept features for user preferences, privacy, or security
named-consumer
optional
Named consumers allow explicitly linking a concept to an action
regex-pattern
optional
The regex pattern used in qualified primitives
role-of
optional
There are cases where you want to assign a specific role to a feature, but not extend the feature