social.colibri.beta.emoji.defs

colibri.social

Documentation

catalogView object

Every custom emoji and pack in one repo.

Properties

emojis array of ref#emojiView Required

Every emoji in the repo.

owner string did Required

The repo the catalog belongs to.

packs array of ref#packView Required

Every pack in the repo.

View raw schema
{
  "description": "Every custom emoji and pack in one repo.",
  "properties": {
    "emojis": {
      "description": "Every emoji in the repo.",
      "items": {
        "ref": "#emojiView",
        "type": "ref"
      },
      "type": "array"
    },
    "owner": {
      "description": "The repo the catalog belongs to.",
      "format": "did",
      "type": "string"
    },
    "packs": {
      "description": "Every pack in the repo.",
      "items": {
        "ref": "#packView",
        "type": "ref"
      },
      "type": "array"
    }
  },
  "required": [
    "owner",
    "emojis",
    "packs"
  ],
  "type": "object"
}
emojiImage object

One stored rendition of an emoji.

Properties

animated boolean Required

Whether the format is animated.

cid string cid Required

The blob's CID in the owner's repo.

format string Required

The image format.

Known values: png, webp, gif, apng, lottie, other
mimeType string Optional

The blob's MIME type.

pixels integer Optional

The rendition's longest edge in pixels, when the provider fixes one.

minimum: 1
size integer Optional

The blob's size in bytes.

minimum: 0
View raw schema
{
  "description": "One stored rendition of an emoji.",
  "properties": {
    "animated": {
      "description": "Whether the format is animated.",
      "type": "boolean"
    },
    "cid": {
      "description": "The blob's CID in the owner's repo.",
      "format": "cid",
      "type": "string"
    },
    "format": {
      "description": "The image format.",
      "knownValues": [
        "png",
        "webp",
        "gif",
        "apng",
        "lottie",
        "other"
      ],
      "type": "string"
    },
    "mimeType": {
      "description": "The blob's MIME type.",
      "type": "string"
    },
    "pixels": {
      "description": "The rendition's longest edge in pixels, when the provider fixes one.",
      "minimum": 1,
      "type": "integer"
    },
    "size": {
      "description": "The blob's size in bytes.",
      "minimum": 0,
      "type": "integer"
    }
  },
  "required": [
    "cid",
    "format",
    "animated"
  ],
  "type": "object"
}
emojiOwner object

The user or community that holds an emoji or pack.

Properties

avatar string uri Optional

The user's avatar or the community's icon.

did string did Required

The owner.

displayName string Optional

The user's display name or the community's name.

handle string handle Optional

The owner's handle.

kind string Required

Whether the owner is a user or a community.

Known values: user, community
View raw schema
{
  "description": "The user or community that holds an emoji or pack.",
  "properties": {
    "avatar": {
      "description": "The user's avatar or the community's icon.",
      "format": "uri",
      "type": "string"
    },
    "did": {
      "description": "The owner.",
      "format": "did",
      "type": "string"
    },
    "displayName": {
      "description": "The user's display name or the community's name.",
      "type": "string"
    },
    "handle": {
      "description": "The owner's handle.",
      "format": "handle",
      "type": "string"
    },
    "kind": {
      "description": "Whether the owner is a user or a community.",
      "knownValues": [
        "user",
        "community"
      ],
      "type": "string"
    }
  },
  "required": [
    "did",
    "kind"
  ],
  "type": "object"
}
emojiView object

A custom emoji, normalised from its provider's record.

Properties

adultOnly boolean Optional

Whether the owner marked the emoji as adult content.

alt string Optional

Alt text for the image.

cid string cid Optional

The record's CID.

createdAt string datetime Required

When the record was created.

fallback string Optional

The text shown where the image cannot render.

images array of ref#emojiImage Required

Every rendition the record carries.

name string Required

The name without colons.

owner string did Required

The repo that holds the record and its blobs.

provider string Required

The emoji provider whose lexicon the record uses.

Known values: blue.moji
uri string at-uri Required

The emoji's record URI.

View raw schema
{
  "description": "A custom emoji, normalised from its provider's record.",
  "properties": {
    "adultOnly": {
      "description": "Whether the owner marked the emoji as adult content.",
      "type": "boolean"
    },
    "alt": {
      "description": "Alt text for the image.",
      "type": "string"
    },
    "cid": {
      "description": "The record's CID.",
      "format": "cid",
      "type": "string"
    },
    "createdAt": {
      "description": "When the record was created.",
      "format": "datetime",
      "type": "string"
    },
    "fallback": {
      "description": "The text shown where the image cannot render.",
      "type": "string"
    },
    "images": {
      "description": "Every rendition the record carries.",
      "items": {
        "ref": "#emojiImage",
        "type": "ref"
      },
      "type": "array"
    },
    "name": {
      "description": "The name without colons.",
      "type": "string"
    },
    "owner": {
      "description": "The repo that holds the record and its blobs.",
      "format": "did",
      "type": "string"
    },
    "provider": {
      "description": "The emoji provider whose lexicon the record uses.",
      "knownValues": [
        "blue.moji"
      ],
      "type": "string"
    },
    "uri": {
      "description": "The emoji's record URI.",
      "format": "at-uri",
      "type": "string"
    }
  },
  "required": [
    "uri",
    "provider",
    "owner",
    "name",
    "images",
    "createdAt"
  ],
  "type": "object"
}
followView object

A pack or single emoji the user follows, resolved against the owner's current catalog.

Properties

createdAt string datetime Required

When the user started following.

emojis array of ref#emojiView Required

The pack's current emoji in pack order, or the single followed emoji. Empty unless state is available.

kind string Required

Whether the subject is a pack or a single emoji.

Known values: pack, emoji
owner ref #emojiOwner Required

Who holds the subject.

pack ref #packView Optional

The pack, when kind is pack and state is available.

state string Required

available when the subject resolves. missing when the owner deleted it. unreachable when the owner's repo cannot be read, for example a deactivated or taken down account.

Known values: available, missing, unreachable
subject string at-uri Required

The followed pack or emoji.

uri string at-uri Required

The follow record.

View raw schema
{
  "description": "A pack or single emoji the user follows, resolved against the owner's current catalog.",
  "properties": {
    "createdAt": {
      "description": "When the user started following.",
      "format": "datetime",
      "type": "string"
    },
    "emojis": {
      "description": "The pack's current emoji in pack order, or the single followed emoji. Empty unless state is available.",
      "items": {
        "ref": "#emojiView",
        "type": "ref"
      },
      "type": "array"
    },
    "kind": {
      "description": "Whether the subject is a pack or a single emoji.",
      "knownValues": [
        "pack",
        "emoji"
      ],
      "type": "string"
    },
    "owner": {
      "description": "Who holds the subject.",
      "ref": "#emojiOwner",
      "type": "ref"
    },
    "pack": {
      "description": "The pack, when kind is pack and state is available.",
      "ref": "#packView",
      "type": "ref"
    },
    "state": {
      "description": "available when the subject resolves. missing when the owner deleted it. unreachable when the owner's repo cannot be read, for example a deactivated or taken down account.",
      "knownValues": [
        "available",
        "missing",
        "unreachable"
      ],
      "type": "string"
    },
    "subject": {
      "description": "The followed pack or emoji.",
      "format": "at-uri",
      "type": "string"
    },
    "uri": {
      "description": "The follow record.",
      "format": "at-uri",
      "type": "string"
    }
  },
  "required": [
    "uri",
    "subject",
    "kind",
    "state",
    "owner",
    "emojis",
    "createdAt"
  ],
  "type": "object"
}
libraryView object

A user's emoji library.

Properties

follows array of ref#followView Required

Everything the user follows, oldest follow first.

own ref #catalogView Required

The emoji and packs in the user's own repo.

View raw schema
{
  "description": "A user's emoji library.",
  "properties": {
    "follows": {
      "description": "Everything the user follows, oldest follow first.",
      "items": {
        "ref": "#followView",
        "type": "ref"
      },
      "type": "array"
    },
    "own": {
      "description": "The emoji and packs in the user's own repo.",
      "ref": "#catalogView",
      "type": "ref"
    }
  },
  "required": [
    "own",
    "follows"
  ],
  "type": "object"
}
packView object

A named group of custom emoji, normalised from its provider's records.

Properties

createdAt string datetime Required

When the record was created.

description string Optional

The pack's description.

emojis array of stringat-uri Required

The URIs of the emoji in the pack, in the order they were added. Only emoji present in the catalog are listed.

name string Required

The pack's name.

owner string did Required

The repo that holds the pack.

provider string Required

The emoji provider whose lexicon the record uses.

Known values: blue.moji
uri string at-uri Required

The pack's record URI.

View raw schema
{
  "description": "A named group of custom emoji, normalised from its provider's records.",
  "properties": {
    "createdAt": {
      "description": "When the record was created.",
      "format": "datetime",
      "type": "string"
    },
    "description": {
      "description": "The pack's description.",
      "type": "string"
    },
    "emojis": {
      "description": "The URIs of the emoji in the pack, in the order they were added. Only emoji present in the catalog are listed.",
      "items": {
        "format": "at-uri",
        "type": "string"
      },
      "type": "array"
    },
    "name": {
      "description": "The pack's name.",
      "type": "string"
    },
    "owner": {
      "description": "The repo that holds the pack.",
      "format": "did",
      "type": "string"
    },
    "provider": {
      "description": "The emoji provider whose lexicon the record uses.",
      "knownValues": [
        "blue.moji"
      ],
      "type": "string"
    },
    "uri": {
      "description": "The pack's record URI.",
      "format": "at-uri",
      "type": "string"
    }
  },
  "required": [
    "uri",
    "provider",
    "owner",
    "name",
    "emojis",
    "createdAt"
  ],
  "type": "object"
}

Lexicon Garden

@