Object

Addition

Properties shared by all addition types.

Properties

type
string
(Required)

The type of addition. For example, Link.

rangeLength
integer

The number of text characters that will be highlighted as the link.

rangeStart
integer

The starting character index for which the addition is meant. A range starts at 0 for the first character.

If rangeStart is specified, rangeLength is required.

Discussion

This is an abstract definition. Do not use this object type directly; use only the objects that extend it like Link.

See Also

Links

object Link

The addition object for defining links in text components that don’t use HTML or Markdown formatting.

object ComponentLink

The component addition object for making a component interactable and making it open a link to elsewhere in News.

object ComponentAddition

Properties shared by all types of component additions.