Misskey · Schema

Antenna

Open-SourceSocial NetworksFediverseActivityPubDecentralized

Properties

Name Type Description
id string
createdAt string
name string
keywords array
excludeKeywords array
src string
userListId stringnull
users array
caseSensitive boolean
localOnly boolean
excludeBots boolean
withReplies boolean
withFile boolean
isActive boolean
hasUnreadNote boolean
notify boolean
excludeNotesInSensitiveChannel boolean
View JSON Schema on GitHub

JSON Schema

misskey-antenna-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://misskey.io/schemas/Antenna",
  "title": "Antenna",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "id"
    },
    "createdAt": {
      "type": "string",
      "format": "date-time"
    },
    "name": {
      "type": "string"
    },
    "keywords": {
      "type": "array",
      "items": {
        "type": "array",
        "items": {
          "type": "string"
        }
      }
    },
    "excludeKeywords": {
      "type": "array",
      "items": {
        "type": "array",
        "items": {
          "type": "string"
        }
      }
    },
    "src": {
      "type": "string",
      "enum": [
        "home",
        "all",
        "users",
        "list",
        "users_blacklist"
      ]
    },
    "userListId": {
      "type": [
        "string",
        "null"
      ],
      "format": "id"
    },
    "users": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "caseSensitive": {
      "type": "boolean",
      "default": false
    },
    "localOnly": {
      "type": "boolean",
      "default": false
    },
    "excludeBots": {
      "type": "boolean",
      "default": false
    },
    "withReplies": {
      "type": "boolean",
      "default": false
    },
    "withFile": {
      "type": "boolean"
    },
    "isActive": {
      "type": "boolean"
    },
    "hasUnreadNote": {
      "type": "boolean",
      "default": false
    },
    "notify": {
      "type": "boolean",
      "default": false
    },
    "excludeNotesInSensitiveChannel": {
      "type": "boolean",
      "default": false
    }
  },
  "required": [
    "id",
    "createdAt",
    "name",
    "keywords",
    "excludeKeywords",
    "src",
    "userListId",
    "users",
    "caseSensitive",
    "localOnly",
    "excludeBots",
    "withReplies",
    "withFile",
    "isActive",
    "hasUnreadNote",
    "notify",
    "excludeNotesInSensitiveChannel"
  ]
}