RoomGroupDto
A personal collection of rooms: the name and icon it was given, the account that owns it, and the rooms it gathers at the moment it was read.
| Name | Type | Description | Notes |
|---|---|---|---|
| id | Integer (int32) | The identifier of the group, which addresses it in every other group operation and is kept for as long as the group exists. | [optional] [example: 42] |
| name | String | The name its owner gave the group, stored trimmed of surrounding spaces. Names are not unique, so two groups of the same account can be told apart only by their identifier. | [optional] [example: Client projects] [nullable] |
| icon | MultiSizeLogoCoverDto | The built-in cover chosen for the group, carrying the cover identifier and its rendering in each available size. Null when the group has no icon, either because it was never given one or because the icon was cleared by setting it to an empty value. | [optional] |
| userId | UUID (uuid) | The account that created the group and the only one able to read, change or delete it; for any other member of the portal the group does not exist. | [optional] [example: 9a1b2c3d-4e5f-6071-8293-a4b5c6d7e8f9] |
| searchArea | SearchArea | The section the group belongs to, which categorizes it within the application's structure. This property determines which area of the interface the group is associated with and affects how its rooms are filtered and displayed. Common values include Active for standard rooms, Forms for form-based rooms, Archive for archived content, and Templates for template rooms. The search area ensures that when retrieving a group, only rooms that belong to the specified section are included in the results, maintaining proper organizational boundaries within the system. | [optional] [enum: Active, Archive, Any, RecentByLinks, Templates, Knowledge, ResultStorage, AiAgents, Forms, FormTemplates] |
| rooms | List | The rooms the group gathers, those stored in the portal first and those on connected third-party accounts after them. Null when the group was asked for without its members, and an empty array when the group holds no room the caller can still see. A room moved to the archive is left out until it is taken out of the archive. | [optional] [example: [{title=Client onboarding, fileEntryType=1}]] [nullable] |
| totalRooms | Integer (int32) | How many rooms the group shows: the same rooms rooms lists, so archived ones are not counted either. It is filled even when the rooms themselves were not asked for, which makes it the cheap way to tell an empty group from a populated one. | [optional] [example: 2] |