mention

The mention node represents a mention of a specific user or special group of users.

Example

Java

1
2
3
4
mention("ABCDE-ABCDE-ABCDE-ABCDE")
        .text("@jsmith")
        .userType(UserType.APP);

ADF

1
2
3
4
5
6
7
8
9
{
  "type": "mention",
  "attrs": {
    "id": "ABCDE-ABCDE-ABCDE-ABCDE",
    "text": "@jsmith",
    "userType": "APP"
  }
}

Compatibility

Products

Usage

• CaptionContent
• InlineContent

Marks

• annotation

Structure

• type - mention
• attrs
  • accessLevel? - string¹
  • id - string
  • text? - string – must begin with @²
  • userType? - DEFAULT | SPECIAL | APP
  • localId? - string (should not be empty, and likely to be a UUID, but neither is enforced)

Footnotes

1. Although the documented values for accessLevel are NONE, DEFAULT, APPLICATION, and CONTAINER, that is not enforced by the schema. Notably, the most common value seen for this field in production values is just an empty string. ↩

2. This is not enforced by the schema, but many things break if the text field does not begin with @, so this library enforces the restriction. ↩