Uh oh! We couldn’t find any match.

Please try other search keywords.

Bixby Developer Center

Guides

Entity (viv.entity)

The viv.entity capsule includes a set of generalized layout macros, models, and dialogs for use in other capsules. It also imports a set of other capsules transitively, allowing your capsules to import those capsules through entity for consistent versioning.

Transitive Imports

The following capsules are imported by viv.entity at their most recent stable versions:

To import these capsules through entity, use the following syntax in your capsule.bxb file:

capsule {
// ... your capsule version, targets, etc.
capsule-imports {
// import entity (check you're specifying the most recent
// stable version!)
import (viv.entity) {
as (entity) version (3.7.33)
}
// import capsules from entity
import (viv.image) {
as (image) version-from (entity)
}
import (viv.geo) {
as (geo) version-from (entity)
}
}
}

Models

PhotoInfo

The PhotoInfo model extends viv.image.Image to add title and subtitle fields. The properties from Image are included below.

PropertyTypeKindNotes
urlUrltextRequired
sizeSizeinteger
dimensionsDimensionsstructure
rotationmeasurement.AngleValuedecimal
captionCaptiontext
titlecore.Texttext
subtitlecore.Texttext 

The Dimensions structure contains two integer properties:

PropertyTypeKindNotes
heightHeightinteger
widthWidthinteger 

ImageSet

An ImageSet is used in image carousels, image grid galleries, and lightboxes.

PropertyTypeKindNotes
imagesPhotoInfostructureRequired, Many
titlecore.Texttext
subtitlecore.Texttext 

The title and subtitle properties of ImageSet are for the image set itself, and are independent from the properties of the same name in PhotoInfo.

Color

This primitive is an enum with a set of symbols for color names. This is intended for training purposes, to handle utterances such as:

[g:Shoes] I'd like to order the (red)[v:entity.Color:Red] shoes.

The following symbols are defined:

ColorColorColorColor
AmarantoDarkRedLightCyanPink
AmberDarkSalmonLightGoldenRodYellowPistachio
AmethystDarkSeaGreenLightGreyPlum
ApricotDarkSlateBlueLightGreenPowderBlue
AquaDarkSlateGreyLightPinkPurple
AquamarineDarkTurquoiseLightSalmonRed
AvioDarkVioletLightSeaGreenRoyalBlue
AzaleaDeepPinkLightSkyBlueRuby
AzureDeepSkyBlueLightSlateGreySaddleBrown
BeigeDimGreyLightSteelBlueSalmon
BlackEarthTonesLightYellowSandyBrown
BlueElectricBlueLimeSeaGreen
BlueVioletForestGreenLimeGreenSienna
BottleGreenFuchsiaLobsterSilver
BronzeGoldMagentaSkyBlue
BrownGoldenRodMaroonSlateBlue
CharcoalGreyMidnightBlueSlateGrey
ChartreuseGreenMixedColorsSpringGreen
ChocolateGreenYellowNavyBlueSteelBlue
CrimsonHoneyOcherStrawColoured
CyanHotPinkOldWhiteTan
DarkBlueIndianRedOliveTeal
DarkCyanIndigoOliveDrabTurquoise
DarkGoldenRodIvoryOrangeViolet
DarkGreyKhakiOrangeRedWatermelon
DarkGreenLavenderPaleGreenWheat
DarkKhakiLavenderBlushPaleTurquoiseWhite
DarkMagentaLawnGreenPaleVioletRedWhiteSmoke
DarkOliveGreenLemonChiffonPastelsYellow
DarkOrangeLightBluePeachYellowGreen

The Color concept does not define any color values; interpreting the colors named by the symbols (e.g., translating MidnightBlue to RGB(25,25,112)) is up to your application.

Ordinal

This primitive is an enum which simply consists of the symbols 1 through 10. It is intended to allow hands-free selection of an item from a list, e.g.:

Choose the (third)[v:entity.Ordinal:3] one.