social.colibri.richtext.facet

colibri.social

Documentation

A rich text facet annotation on a message.

main object

A rich text facet annotation on a message.

Properties

View raw schema 
{
  "type": "object",
  "required": [
    "index",
    "features"
  ],
  "properties": {
    "index": {
      "ref": "lex:social.colibri.richtext.facet#byteSlice",
      "type": "ref"
    },
    "features": {
      "type": "array",
      "items": {
        "refs": [
          "lex:social.colibri.richtext.facet#channel",
          "lex:social.colibri.richtext.facet#bold",
          "lex:social.colibri.richtext.facet#italic",
          "lex:social.colibri.richtext.facet#underline",
          "lex:social.colibri.richtext.facet#strikethrough",
          "lex:social.colibri.richtext.facet#code",
          "lex:social.colibri.richtext.facet#mention",
          "lex:social.colibri.richtext.facet#link"
        ],
        "type": "union"
      },
      "description": "The features of this facet."
    }
  },
  "description": "A rich text facet annotation on a message."
}
bold object

A facet feature for bold text.

This object has no properties defined.

View raw schema 
{
  "type": "object",
  "properties": {},
  "description": "A facet feature for bold text."
}
byteSlice object

Specifies the sub-string range a facet feature applies to. Start index is inclusive, end index is exclusive. Indices are zero-based, counting bytes of the UTF-8 encoded text.

Properties

byteEnd integer Required

The end index of the byte slice (exclusive).

minimum: 0
byteStart integer Required

The start index of the byte slice (inclusive).

minimum: 0
View raw schema 
{
  "type": "object",
  "required": [
    "byteStart",
    "byteEnd"
  ],
  "properties": {
    "byteEnd": {
      "type": "integer",
      "minimum": 0,
      "description": "The end index of the byte slice (exclusive)."
    },
    "byteStart": {
      "type": "integer",
      "minimum": 0,
      "description": "The start index of the byte slice (inclusive)."
    }
  },
  "description": "Specifies the sub-string range a facet feature applies to. Start index is inclusive, end index is exclusive. Indices are zero-based, counting bytes of the UTF-8 encoded text."
}
channel object

A facet feature for a channel reference.

Properties

channel string record-key Required

The record key of the referenced channel.

View raw schema 
{
  "type": "object",
  "required": [
    "channel"
  ],
  "properties": {
    "channel": {
      "type": "string",
      "format": "record-key",
      "description": "The record key of the referenced channel."
    }
  },
  "description": "A facet feature for a channel reference."
}
code object

A facet feature for inline code text.

This object has no properties defined.

View raw schema 
{
  "type": "object",
  "properties": {},
  "description": "A facet feature for inline code text."
}
italic object

A facet feature for italic text.

This object has no properties defined.

View raw schema 
{
  "type": "object",
  "properties": {},
  "description": "A facet feature for italic text."
}
link object

A facet feature for a hyperlink.

Properties

uri string uri Required

The URI of the link.

View raw schema 
{
  "type": "object",
  "required": [
    "uri"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "format": "uri",
      "description": "The URI of the link."
    }
  },
  "description": "A facet feature for a hyperlink."
}
mention object

A facet feature for a user mention.

Properties

did string did Required

The DID of the mentioned user.

View raw schema 
{
  "type": "object",
  "required": [
    "did"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did",
      "description": "The DID of the mentioned user."
    }
  },
  "description": "A facet feature for a user mention."
}
strikethrough object

A facet feature for strikethrough text.

This object has no properties defined.

View raw schema 
{
  "type": "object",
  "properties": {},
  "description": "A facet feature for strikethrough text."
}
underline object

A facet feature for underlined text.

This object has no properties defined.

View raw schema 
{
  "type": "object",
  "properties": {},
  "description": "A facet feature for underlined text."
}

Lexicon Garden

@