Bixby Developer Center

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.

This reference lists out several of the models available in this library capsule. Some sections contain tables listing information about those concepts or actions.

Transitive Imports

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

• viv.image (note: like viv.entity, viv.image is deprecated and will be removed at a future date)
• viv.geo
• viv.time
• viv.core

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.time) {
      as (time) 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.

The Dimensions structure contains two integer properties:

ImageSet

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

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:

The Color concept does not define any color values; interpreting the colors named by the symbols (for example, 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, like in the following example:

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