2.0 MarkupText object

Represents text with optional markup.

Text formatting is stored separately from the text to allow clients that do not support formatting to function normally, ignoring the markup.

Example

{
  "text": "Nothing beats a glass of H2O",
  "markup": [{
    "type": "subscript",
    "offset": 26,
    "length": 1
  }]
}

Fields

Field Type Description
text
required
String The actual text.
markup
required
Collection of 2.0 Markup objects An array of markup objects that are to be applied to the text. In case of no markup, the array may be empty.