Screen Note

Screen notes are comments added to a screen and can be either point notes, which have a single point in the position field, or area notes, which have a position field containing both a start and end point to define a rectangular region.

Type: object

AttributeTypeDescription
idstringThe unique id of the note
creatorUser-
orderintegerOrder of the note in the screen (e.g., 1, 2, 3, so on)
statusScreen Note Status-
positionScreen Note Position-
colorScreen Note Color-
commentsScreen Note Comment[]-
createdintegerThe unix timestamp when the note was created

Example

{
  "id": "5dbad85a76ea51c1f35b6f69",
  "created": 1572347818,
  "order": 1,
  "status": "open",
  "position": {
    "x": 0.93,
    "y": 0.1,
    "x_start": 0.9,
    "y_start": 0.05
  },
  "color": {
    "name": "yellow",
    "r": 254,
    "g": 207,
    "b": 51,
    "a": 1
  },
  "creator": {
    "id": "5d9caaecb4a3fa9bc9718686",
    "email": "[email protected]",
    "username": "zozo",
    "emotar": "🍎",
    "avatar": "http://placekitten.com/200/300",
    "last_seen": 1616739240
  },
  "comments": [
    {
      "id": "5dbad85a89ea51c1f35bcffe",
      "author": {
        "id": "5d9caaecb4a3fa9bc9718686",
        "email": "[email protected]",
        "username": "zozo",
        "emotar": "🍎",
        "avatar": "http://placekitten.com/200/300",
        "last_seen": 1616739240
      },
      "content": "Hey ho! Let's go!",
      "updated": 1572347818,
      "reactions": [
        {
          "id": "5dbad85a89ea51c1f35bcffe",
          "short_code": "thumbsup",
          "unicode": "👍",
          "users": [
            {
              "id": "5d9caaecb4a3fa9bc9718686",
              "email": "[email protected]",
              "username": "zozo",
              "emotar": "🍎",
              "avatar": "http://placekitten.com/200/300",
              "last_seen": 1616739240
            }
          ]
        }
      ],
      "screen_version_id": "5dbad85a89ea51c1f35bcfff"
    }
  ]
}