Bixby Developer Center

Guides
References

Core (viv.core)

The viv.core capsule provides a set of foundational models for Bixby capsules. These include definitions for primitive concepts such as Integer, Boolean, and Text, as well as base concepts extended by other library capsules.

Note

When higher-level capsules such as viv.time and viv.geo are available, your capsules should use those in preference to viv.core models. Higher-level capsules provide task-specific features and functionality that viv.core lacks.

Models

Types are always in the viv.core.* namespace. All properties have a cardinality of min (Optional), max (One) unless otherwise specified.

Primitives

  • Boolean (boolean): The supertype of all primitive boolean concepts.
  • Confirmation: (boolean): Concept used for matching confirmation prompts.
  • Decimal (decimal): The supertype of all primitive decimal concepts.
  • FormElement (name): Concept for wrapping references to be resolved by the client.
  • Integer (integer): The supertype of all primitive integer concepts.
  • Intent (text)
  • MeasurementSystem (enum): One of Imperial, Metric, or USC.
  • Text (text): The supertype of all primitive text, name, enum, and qualified concepts.
  • Url (text)

Shapes

These are structures used for shape metadata. They are used in geometry structures and BaseImage.

Base2dShape
PropertyTypeKindNotes
widthIntegerinteger
heightIntegerinteger 
BaseXyPoint
PropertyTypeKindNotes
xIntegerinteger
yIntegerinteger 

BaseImage

A structure used for image metadata. This is used, among other places, by some Bixby Views components.

PropertyTypeKindNotes
urlUrltextRequired
dimensionsBase2dShapestructure
rotationDecimaldecimal
titleTexttext
subtitleTexttext
captionTexttext 

Date and Time

Use models from viv.time in your capsule to work with date and time values.

  • BaseDate: Base for viv.time.Date. Properties of this viv.core.BaseDate structure have a default-value of 0.
  • BaseDateInterval: Base for viv.time.DateInterval.
  • BaseDateTime: Base for viv.time.DateTime.
  • BaseDateTimeInterval: Base for viv.time.DateTimeInterval.
  • BasePeriod: Base for viv.time.DurationPeriod. Properties of this viv.core.BasePeriod structure have a default-value of 0.
  • BaseTime: Base for viv.time.Time.

Geometry

Use models from viv.geo in your capsule to work with geometry values.

  • BaseDistance: Base for viv.geo.Distance.
  • BaseDistanceUnit: Base for viv.geo.DistanceUnit.
  • BaseGeoIcon: Base for viv.geo.GeoIcon.
  • BaseGeoMarker: Base for viv.geo.GeoMarker.
  • BaseGeometryWKT: Base for viv.geo.GeometryWKT.
  • BaseGeoPoint: Base for viv.geo.GeoPoint.

Metadata

Meta-Commands

These models are placeholders, designed for capsules to extend to support list navigation commands. Structure concepts have no properties defined in viv.core.

  • CancelCommand (structure)
  • CardinalSelector (integer)
  • CurrentPageCommand (structure)
  • FollowupPromptAffirmative (structure)
  • FollowupPromptNegative (structure)
  • ItemSelectionAffirmative (structure)
  • ItemSelectionNegative (structure)
  • NextItemAffirmative (structure)
  • NextItemNegative (structure)
  • NextPageAffirmative (structure)
  • NextPageCommand (structure)
  • NextPageNegative (structure)
  • OrdinalSelector (name)
  • PageSelectionAffirmative (structure)
  • PageSelectionNegative (structure)
  • PreviousPageCommand (structure)
  • SelectNone (structure)

MultiModalString

The MultiModalString structure is the type returned by the macroEach EL function. It is a simple structure with two properties, text and speech, both of viv.core.Text type.

PropertyTypeKindNotes
textviv.core.Texttextmin (Required) max (One)
speechviv.core.Texttextmin (Required) max (One)