social.clippr.actor.defs

clippr.social

Documentation

preferences array

An array of refs to various preferences.

View raw schema 
{
  "type": "array",
  "items": {
    "refs": [
      "#publishingScopesPref"
    ],
    "type": "union"
  },
  "description": "An array of refs to various preferences."
}
profileView object

A view of an actor's profile.

Properties

avatar string uri Optional

A link to the profile's avatar

createdAt string datetime Optional

When the profile record was first created

description string Optional

The biography associated to the profile

maxLength: 5000 bytesmaxGraphemes: 500 graphemes
did string did Required

The DID of the profile

displayName string Required

The display name associated to the profile

maxLength: 640 bytesmaxGraphemes: 64 graphemes
handle string handle Required

The handle of the profile

View raw schema 
{
  "type": "object",
  "required": [
    "did",
    "handle",
    "displayName"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did",
      "description": "The DID of the profile"
    },
    "avatar": {
      "type": "string",
      "format": "uri",
      "description": "A link to the profile's avatar"
    },
    "handle": {
      "type": "string",
      "format": "handle",
      "description": "The handle of the profile"
    },
    "createdAt": {
      "type": "string",
      "format": "datetime",
      "description": "When the profile record was first created"
    },
    "description": {
      "type": "string",
      "maxLength": 5000,
      "description": "The biography associated to the profile",
      "maxGraphemes": 500
    },
    "displayName": {
      "type": "string",
      "maxLength": 640,
      "description": "The display name associated to the profile",
      "maxGraphemes": 64
    }
  },
  "description": "A view of an actor's profile."
}
publishingScopesPref object

Preferences for an user's publishing scopes.

Properties

defaultScope string Required

What publishing scope to mark a clip as by default

Known values: public, unlisted
View raw schema 
{
  "type": "object",
  "required": [
    "defaultScope"
  ],
  "properties": {
    "defaultScope": {
      "type": "string",
      "description": "What publishing scope to mark a clip as by default",
      "knownValues": [
        "public",
        "unlisted"
      ]
    }
  },
  "description": "Preferences for an user's publishing scopes."
}

Lexicon Garden

@