social.grain.group.createGroup
Start a group on Grain's group host. The host creates the group with the viewer as its founder and hands Grain its own session on it (fyi.opensocial.provisionGroup); Grain then gives the group its pool and its Grain profile. The viewer never leaves Grain.
Details · procedure
| Kind | procedure |
|---|---|
| Authority | group.grain.social |
| Commit rev | 3n2mx2lrcyybg |
| Indexed |
Checks
Valid Lint pass{
"$type": "com.atproto.lexicon.schema",
"defs": {
"main": {
"description": "Start a group on Grain's group host. The host creates the group with the viewer as its founder and hands Grain its own session on it (fyi.opensocial.provisionGroup); Grain then gives the group its pool and its Grain profile. The viewer never leaves Grain.",
"errors": [
{
"description": "This Grain starts no groups.",
"name": "NotSupported"
},
{
"description": "The name is not 3 to 18 letters, digits and hyphens, starting and ending with no hyphen.",
"name": "InvalidName"
},
{
"description": "The group host refused the handle: taken, or not allowed.",
"name": "HandleUnavailable"
},
{
"description": "The group host did not start the group.",
"name": "CreateFailed"
},
{
"description": "The group was started, but its host did not open its pool.",
"name": "PoolFailed"
}
],
"input": {
"encoding": "application/json",
"schema": {
"properties": {
"description": {
"maxGraphemes": 300,
"maxLength": 3000,
"type": "string"
},
"displayName": {
"maxGraphemes": 64,
"maxLength": 640,
"type": "string"
},
"name": {
"description": "The first label of the group's handle, 3 to 18 characters; the host supplies its domain.",
"maxLength": 18,
"minLength": 3,
"type": "string"
}
},
"required": [
"name",
"displayName"
],
"type": "object"
}
},
"output": {
"encoding": "application/json",
"schema": {
"properties": {
"did": {
"format": "did",
"type": "string"
},
"handle": {
"format": "handle",
"type": "string"
}
},
"required": [
"did",
"handle"
],
"type": "object"
}
},
"type": "procedure"
}
},
"id": "social.grain.group.createGroup",
"lexicon": 1
}