social.colibri.beta.notification.defs

colibri.social

Documentation

notificationView object

A notification for the requesting user.

Properties

channel string space-ref Required

The channel it happened in.

community string did Required

The community it happened in.

id string Required

Opaque identifier, used to mark this notification seen.

indexedAt string datetime Required

When the AppView raised it.

kind string Required

Why it was raised.

Known values: mention, reply, message
mentionRole string Optional

Name of the role whose mention raised this, for role mentions.

seenAt string datetime Optional

When the user marked it seen.

View raw schema 
{
  "type": "object",
  "required": [
    "id",
    "kind",
    "author",
    "channel",
    "community",
    "indexedAt"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Opaque identifier, used to mark this notification seen."
    },
    "kind": {
      "type": "string",
      "description": "Why it was raised.",
      "knownValues": [
        "mention",
        "reply",
        "message"
      ]
    },
    "author": {
      "ref": "social.colibri.beta.actor.defs#profileView",
      "type": "ref",
      "description": "Who caused it."
    },
    "seenAt": {
      "type": "string",
      "format": "datetime",
      "description": "When the user marked it seen."
    },
    "channel": {
      "type": "string",
      "format": "space-ref",
      "description": "The channel it happened in."
    },
    "message": {
      "ref": "social.colibri.beta.channel.defs#messageView",
      "type": "ref",
      "description": "The message, when still readable."
    },
    "community": {
      "type": "string",
      "format": "did",
      "description": "The community it happened in."
    },
    "indexedAt": {
      "type": "string",
      "format": "datetime",
      "description": "When the AppView raised it."
    },
    "mentionRole": {
      "type": "string",
      "description": "Name of the role whose mention raised this, for role mentions."
    }
  },
  "description": "A notification for the requesting user."
}

Lexicon Garden

@