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.
This reference lists out several of the models available in this library capsule. Some sections contain tables listing information about those concepts or actions.
Types are always in the viv.core.*
namespace. All properties have a cardinality of min (Optional)
, max (One)
unless otherwise specified.
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)These concepts can be used in your capsules as types for structure properties, as long as those properties are not referred to in Bixby Views or used as action inputs.
These are structures used for shape metadata. They are used in geometry structures and BaseImage
. The two shape structures are Base2dShape
and BaseXyPoint
.
Property | Type | Kind | Notes |
---|---|---|---|
width | Integer | integer | |
height | Integer | integer |
Property | Type | Kind | Notes |
---|---|---|---|
x | Integer | integer | |
y | Integer | integer |
A structure used for image metadata. This is used, among other places, by some Bixby Views components.
Property | Type | Kind | Notes |
---|---|---|---|
url | Url | text | Required |
dimensions | Base2dShape | structure | |
rotation | Decimal | decimal | |
title | Text | text | |
subtitle | Text | text | |
caption | Text | text |
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
.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
.Locale
(structure): Stores information about a locale, as accessed through the getLocale()
Expression Language function.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.
Property | Type | Kind | Notes |
---|---|---|---|
text | viv.core.Text | text | min (Required) max (One) |
speech | viv.core.Text | text | min (Required) max (One) |