mirror of
https://github.com/versia-pub/docs.git
synced 2025-12-06 06:18:19 +01:00
58 lines
2.2 KiB
Plaintext
58 lines
2.2 KiB
Plaintext
export const metadata = {
|
|
title: 'Groups',
|
|
description: 'Groups are a way to organize users and notes into communities.'
|
|
}
|
|
|
|
# Groups
|
|
|
|
Groups are a way to organize users and notes into communities. They can be used for any purpose, such as forums, blogs, image galleries, video sharing, audio sharing, and messaging. They are similar to Discord's channels or Matrix's rooms. {{ className: 'lead' }}
|
|
|
|
Refer to [Note](/entities/note#entity-definition)'s `group` property for how notes can be associated with groups.
|
|
|
|
## Entity Definition
|
|
|
|
<Row>
|
|
<Col>
|
|
<Properties>
|
|
<Property name="name" type="ContentFormat" required={false} typeLink="/structures/content-format">
|
|
Group name/title.
|
|
|
|
Text only (`text/plain`, `text/html`, etc).
|
|
</Property>
|
|
<Property name="description" type="ContentFormat" required={false} typeLink="/structures/content-format">
|
|
Short description of the group's contents and purpose.
|
|
|
|
Text only (`text/plain`, `text/html`, etc).
|
|
</Property>
|
|
<Property name="members" type="URI" required={true} typeLink="/types#uri">
|
|
URI of the group's members list. [Collection](/structures/collection) of [Users](/entities/user).
|
|
</Property>
|
|
<Property name="notes" type="URI" required={false} typeLink="/types#uri">
|
|
URI of the group's associated notes. [Collection](/structures/collection) of [Notes](/entities/note).
|
|
</Property>
|
|
</Properties>
|
|
</Col>
|
|
|
|
<Col sticky>
|
|
|
|
```jsonc {{ title: "Example Group" }}
|
|
{
|
|
"type": "Group",
|
|
"id": "ed480922-b095-4f09-9da5-c995be8f5960",
|
|
"uri": "https://example.com/groups/ed480922-b095-4f09-9da5-c995be8f5960",
|
|
"name": {
|
|
"text/html": {
|
|
"content": "The <strong>Woozy</strong> fan club"
|
|
}
|
|
},
|
|
"description": {
|
|
"text/plain": {
|
|
"content": "A group for fans of the Woozy emoji."
|
|
}
|
|
},
|
|
"members": "https://example.com/groups/ed480922-b095-4f09-9da5-c995be8f5960/members",
|
|
}
|
|
```
|
|
|
|
</Col>
|
|
</Row> |