fyi.opensocial.profile

lexicons.opensocial.fyi

Documentation

The group's profile. Written by the group authority into the meta space.

main record

The group's profile. Written by the group authority into the meta space.

Record Key literal:self Fixed literal value

Properties

avatar blob Optional

No description available.

maxSize: 1.0 MB
banner blob Optional

No description available.

maxSize: 1.0 MB
createdAt string datetime Required

An RFC 3339 formatted timestamp.

description string Optional

No description available.

maxLength: 3000 bytesmaxGraphemes: 300 graphemes
displayName string Required

No description available.

maxLength: 640 bytesmaxGraphemes: 64 graphemes
joinPolicy string Required

How new members get in: anyone may join, requests are reviewed, or invite only.

Known values: fyi.opensocial.profile#open, fyi.opensocial.profile#request, fyi.opensocial.profile#invite
url string uri Optional

The group's own site, if it keeps one. A third-party app that shows the group can link back to it.

View raw schema 
{
  "description": "The group's profile. Written by the group authority into the meta space.",
  "key": "literal:self",
  "record": {
    "properties": {
      "avatar": {
        "accept": [
          "image/png",
          "image/jpeg"
        ],
        "maxSize": 1000000,
        "type": "blob"
      },
      "banner": {
        "accept": [
          "image/png",
          "image/jpeg"
        ],
        "maxSize": 1000000,
        "type": "blob"
      },
      "createdAt": {
        "format": "datetime",
        "type": "string"
      },
      "description": {
        "maxGraphemes": 300,
        "maxLength": 3000,
        "type": "string"
      },
      "displayName": {
        "maxGraphemes": 64,
        "maxLength": 640,
        "type": "string"
      },
      "joinPolicy": {
        "description": "How new members get in: anyone may join, requests are reviewed, or invite only.",
        "knownValues": [
          "fyi.opensocial.profile#open",
          "fyi.opensocial.profile#request",
          "fyi.opensocial.profile#invite"
        ],
        "type": "string"
      },
      "url": {
        "description": "The group's own site, if it keeps one. A third-party app that shows the group can link back to it.",
        "format": "uri",
        "type": "string"
      }
    },
    "required": [
      "displayName",
      "joinPolicy",
      "createdAt"
    ],
    "type": "object"
  },
  "type": "record"
}
invite token

Only holders of an outstanding invite may join.

Referencefyi.opensocial.profile#invite

Tokens have no data representation. Use the reference string as a value.

View raw schema 
{
  "description": "Only holders of an outstanding invite may join.",
  "type": "token"
}
open token

Anyone may join by calling requestJoin; admitted immediately.

Referencefyi.opensocial.profile#open

Tokens have no data representation. Use the reference string as a value.

View raw schema 
{
  "description": "Anyone may join by calling requestJoin; admitted immediately.",
  "type": "token"
}
request token

requestJoin creates a pending request that a member with the admit action reviews.

Referencefyi.opensocial.profile#request

Tokens have no data representation. Use the reference string as a value.

View raw schema 
{
  "description": "requestJoin creates a pending request that a member with the admit action reviews.",
  "type": "token"
}

Lexicon Garden

@