com.getorbyt.actor.defs

getorbyt.com

Documentation

profileView object

An actor as Orbyt presents them. Orbyt profile fields win; anything absent is filled from the connected network's profile, which is also all an account that has never used Orbyt has.

Properties

avatar string uri Optional

A valid URI.

avatarVideo string uri Optional

A valid URI.

banner string uri Optional

A valid URI.

description string Optional

No description available.

maxLength: 2560 bytesmaxGraphemes: 256 graphemes
did string did Required

A decentralized identifier (DID).

displayName string Optional

No description available.

maxLength: 640 bytesmaxGraphemes: 64 graphemes
followersCount integer Optional

No description available.

minimum: 0
followsCount integer Optional

No description available.

minimum: 0
handle string handle Optional

An AT Protocol handle (e.g., alice.bsky.social).

isBeta boolean Optional

Joined during Orbyt's beta. Both apps badge it.

isOrbytUser boolean Required

False for an account known only from the connected network, which clients badge as such.

joinedAt string datetime Optional

An RFC 3339 formatted timestamp.

viewer ref #viewerState Optional

No description available.

View raw schema 
{
  "description": "An actor as Orbyt presents them. Orbyt profile fields win; anything absent is filled from the connected network's profile, which is also all an account that has never used Orbyt has.",
  "properties": {
    "avatar": {
      "format": "uri",
      "type": "string"
    },
    "avatarVideo": {
      "format": "uri",
      "type": "string"
    },
    "banner": {
      "format": "uri",
      "type": "string"
    },
    "colors": {
      "ref": "com.getorbyt.profile#colors",
      "type": "ref"
    },
    "description": {
      "maxGraphemes": 256,
      "maxLength": 2560,
      "type": "string"
    },
    "did": {
      "format": "did",
      "type": "string"
    },
    "displayName": {
      "maxGraphemes": 64,
      "maxLength": 640,
      "type": "string"
    },
    "followersCount": {
      "minimum": 0,
      "type": "integer"
    },
    "followsCount": {
      "minimum": 0,
      "type": "integer"
    },
    "handle": {
      "format": "handle",
      "type": "string"
    },
    "isBeta": {
      "description": "Joined during Orbyt's beta. Both apps badge it.",
      "type": "boolean"
    },
    "isOrbytUser": {
      "description": "False for an account known only from the connected network, which clients badge as such.",
      "type": "boolean"
    },
    "joinedAt": {
      "format": "datetime",
      "type": "string"
    },
    "showNetworkLink": {
      "type": "boolean"
    },
    "viewer": {
      "ref": "#viewerState",
      "type": "ref"
    }
  },
  "required": [
    "did",
    "isOrbytUser"
  ],
  "type": "object"
}
viewerState object

The signed-in viewer's Orbyt relationship to this actor. Absent for anonymous reads.

Properties

blocking string at-uri Optional

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

followedBy string at-uri Optional

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

following string at-uri Optional

The viewer's com.getorbyt.graph.follow record for this actor.

followingOnNetwork boolean Optional

Whether the viewer follows this actor on the connected network, as of the viewer's last follow sync. Absent when unknown.

View raw schema 
{
  "description": "The signed-in viewer's Orbyt relationship to this actor. Absent for anonymous reads.",
  "properties": {
    "blocking": {
      "format": "at-uri",
      "type": "string"
    },
    "followedBy": {
      "format": "at-uri",
      "type": "string"
    },
    "following": {
      "description": "The viewer's com.getorbyt.graph.follow record for this actor.",
      "format": "at-uri",
      "type": "string"
    },
    "followingOnNetwork": {
      "description": "Whether the viewer follows this actor on the connected network, as of the viewer's last follow sync. Absent when unknown.",
      "type": "boolean"
    }
  },
  "type": "object"
}

Lexicon Garden

@