com.getorbyt.community.setAnnouncement
Sets or clears the Community's announcement, shown on its page and, when set or changed, in its members' activity as `communityAnnouncement`. Requires manage-settings. The announcement is service state rather than part of the declaration record, so a moderator granted manage-settings can set it without writing the owner's repository. Setting and clearing are both recorded in the moderation log.
Details · procedure
| Kind | procedure |
|---|---|
| Authority | community.getorbyt.com |
| Indexed |
Checks
Valid Lint pass{
"$type": "com.atproto.lexicon.schema",
"defs": {
"main": {
"description": "Sets or clears the Community's announcement, shown on its page and, when set or changed, in its members' activity as `communityAnnouncement`. Requires manage-settings. The announcement is service state rather than part of the declaration record, so a moderator granted manage-settings can set it without writing the owner's repository. Setting and clearing are both recorded in the moderation log.",
"errors": [
{
"name": "AuthenticationRequired"
},
{
"name": "CommunityNotFound"
},
{
"name": "InsufficientRole"
},
{
"name": "InvalidRequest"
}
],
"input": {
"encoding": "application/json",
"schema": {
"properties": {
"community": {
"format": "at-uri",
"type": "string"
},
"text": {
"description": "The announcement text. Absent or blank clears the announcement. The service holds it to a shorter limit than this ceiling, which getServiceInfo serves as `community.announcementMaxCharacters`.",
"maxGraphemes": 300,
"maxLength": 3000,
"type": "string"
}
},
"required": [
"community"
],
"type": "object"
}
},
"output": {
"encoding": "application/json",
"schema": {
"properties": {
"announcement": {
"description": "The announcement now. Absent once cleared.",
"ref": "com.getorbyt.community.defs#announcementView",
"type": "ref"
},
"changed": {
"type": "boolean"
}
},
"required": [
"changed"
],
"type": "object"
}
},
"type": "procedure"
}
},
"id": "com.getorbyt.community.setAnnouncement",
"lexicon": 1
}