Interface VariableDefinition

A format to describe a variable available to be read from the server. Application fields are optional, and only populated when a variable is provided by application mode.

APIs which take a VariableDefinition must at least be provided an object with a type and id field.

Hierarchy

  • VariableDefinition

Accessors

applicationId applicationName description id name title type

Accessors

applicationId

  • get applicationId(): string

  • Optional description for the variable's contents, typically used to provide more detail that wouldn't be reasonable to put in the title

    Returns string

    String

applicationName

  • get applicationName(): string

  • The name of the application which provided this variable

    Returns string

    String

description

  • get description(): string

  • Optional description for the variable's contents, typically used to provide more detail that wouldn't be reasonable to put in the title

    Returns string

    String

id

  • get id(): string

  • An opaque identifier for this variable

    Returns string

    String

name

  • get name(): string

  • Returns string

title

  • get title(): string

  • The name of the variable, to be used when rendering it to a user

    Returns string

    String

type

  • get type(): VariableTypeType

  • The type of the variable, one of dh.VariableType

    Returns VariableTypeType

    dh.VariableType.

Settings

Member Visibility

Theme

On This Page