social.coves.actor.defs

coves.social

Documentation

profileStats object

Aggregated statistics for a user profile

Properties

commentCount integer Optional

Total number of comments made

minimum: 0
communityCount integer Optional

Number of communities subscribed to

minimum: 0
membershipCount integer Optional

Number of communities with membership status

minimum: 0
postCount integer Optional

Total number of posts created

minimum: 0
reputation integer Optional

Global reputation score

View raw schema 
{
  "type": "object",
  "properties": {
    "postCount": {
      "type": "integer",
      "minimum": 0,
      "description": "Total number of posts created"
    },
    "reputation": {
      "type": "integer",
      "description": "Global reputation score"
    },
    "commentCount": {
      "type": "integer",
      "minimum": 0,
      "description": "Total number of comments made"
    },
    "communityCount": {
      "type": "integer",
      "minimum": 0,
      "description": "Number of communities subscribed to"
    },
    "membershipCount": {
      "type": "integer",
      "minimum": 0,
      "description": "Number of communities with membership status"
    }
  },
  "description": "Aggregated statistics for a user profile"
}
profileView object

Basic profile view with essential information

Properties

avatar string uri Optional

URL to avatar image

did string did Required

A decentralized identifier (DID).

displayName string Optional

No description available.

maxLength: 640 bytesmaxGraphemes: 64 graphemes
handle string handle Optional

Current handle resolved from DID

View raw schema 
{
  "type": "object",
  "required": [
    "did"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did"
    },
    "avatar": {
      "type": "string",
      "format": "uri",
      "description": "URL to avatar image"
    },
    "handle": {
      "type": "string",
      "format": "handle",
      "description": "Current handle resolved from DID"
    },
    "displayName": {
      "type": "string",
      "maxLength": 640,
      "maxGraphemes": 64
    }
  },
  "description": "Basic profile view with essential information"
}
profileViewDetailed object

Detailed profile view with stats and viewer state

Properties

avatar string uri Optional

URL to avatar image

banner string uri Optional

URL to banner image

createdAt string datetime Optional

An RFC 3339 formatted timestamp.

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
handle string handle Optional

Current handle resolved from DID

viewer ref #viewerState Optional

Viewer's relationship to this profile

View raw schema 
{
  "type": "object",
  "required": [
    "did"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did"
    },
    "stats": {
      "ref": "#profileStats",
      "type": "ref",
      "description": "Aggregated statistics"
    },
    "avatar": {
      "type": "string",
      "format": "uri",
      "description": "URL to avatar image"
    },
    "banner": {
      "type": "string",
      "format": "uri",
      "description": "URL to banner image"
    },
    "handle": {
      "type": "string",
      "format": "handle",
      "description": "Current handle resolved from DID"
    },
    "viewer": {
      "ref": "#viewerState",
      "type": "ref",
      "description": "Viewer's relationship to this profile"
    },
    "createdAt": {
      "type": "string",
      "format": "datetime"
    },
    "description": {
      "type": "string",
      "maxLength": 2560,
      "maxGraphemes": 256
    },
    "displayName": {
      "type": "string",
      "maxLength": 640,
      "maxGraphemes": 64
    },
    "descriptionFacets": {
      "type": "array",
      "items": {
        "ref": "social.coves.richtext.facet",
        "type": "ref"
      },
      "maxLength": 50,
      "description": "Rich text annotations for the description"
    }
  },
  "description": "Detailed profile view with stats and viewer state"
}
viewerState object

The viewing user's relationship to this profile

Properties

blocked boolean Optional

Whether the viewer has blocked this user

blockedBy boolean Optional

Whether the viewer is blocked by this user

blocking string at-uri Optional

AT-URI of the block record if the viewer has blocked this user

View raw schema 
{
  "type": "object",
  "properties": {
    "blocked": {
      "type": "boolean",
      "description": "Whether the viewer has blocked this user"
    },
    "blocking": {
      "type": "string",
      "format": "at-uri",
      "description": "AT-URI of the block record if the viewer has blocked this user"
    },
    "blockedBy": {
      "type": "boolean",
      "description": "Whether the viewer is blocked by this user"
    }
  },
  "description": "The viewing user's relationship to this profile"
}

Lexicon Garden

@