Skip to content
Chatto v0.5.0

AdminRoomLayoutService

Chatto exposes this service below /api/connect.

Shared message and enum definitions are documented in Shared Types And Enums.

Reads and mutates the server-admin room layout.

Gets management-authorized channel room metadata. Requires role.manage or effective room.manage for the room.

POST /api/connect/chatto.admin.v1.AdminRoomLayoutService/GetRoom

Request for management-authorized channel room metadata.

FieldTypeDescription
room_idstringRequired channel room ID.

Channel room metadata and the caller’s management capabilities.

FieldTypeDescription
roomchatto.api.v1.RoomRequested channel room. This read does not require ordinary directory visibility when the caller can configure the room’s role permissions.
viewer_can_manage_roomboolWhether the caller can update the room’s general settings.
viewer_can_manage_permissionsboolWhether the caller can configure role permissions for the room.

Gets management-authorized room group metadata. Requires role.manage or effective room.manage for the group.

POST /api/connect/chatto.admin.v1.AdminRoomLayoutService/GetRoomGroup

Request for management-authorized room group metadata.

FieldTypeDescription
group_idstringRequired room group ID.

Room group metadata and the caller’s management capabilities.

FieldTypeDescription
groupAdminRoomLayoutGroupRequested room group metadata. Ordered room and link entries are omitted so role permission managers do not gain visibility into private room names.
viewer_can_manage_groupboolWhether the caller can update the room group’s general settings.
viewer_can_manage_permissionsboolWhether the caller can configure role permissions for the room group.

Lists the editable room group layout. Requires server-scope room.manage and includes archived rooms for administrative actions such as unarchiving.

POST /api/connect/chatto.admin.v1.AdminRoomLayoutService/ListRoomGroups

Request for the server-admin room group layout.

Server-admin room group layout response.

FieldTypeDescription
groupsrepeated AdminRoomLayoutGroupOrdered room groups, including archived rooms the caller can manage.

Creates a room group. Requires server-scope room.manage.

POST /api/connect/chatto.admin.v1.AdminRoomLayoutService/CreateRoomGroup

Request to create a room group.

FieldTypeDescription
namestringRequired group display name.
descriptionstringOptional public group description.

Result of creating a room group.

FieldTypeDescription
groupAdminRoomLayoutGroupCreated room group.

Updates a room group’s metadata. Requires effective room.manage for the group.

POST /api/connect/chatto.admin.v1.AdminRoomLayoutService/UpdateRoomGroup

Request to update a room group.

FieldTypeDescription
group_idstringRequired room group ID.
nameoptional stringNew group display name, when changing it.
descriptionoptional stringNew public group description, when changing it. Empty clears the description.
update_maskgoogle.protobuf.FieldMaskEditable fields to apply or reset: name, description. Omit to infer populated fields; * selects all editable fields. An explicit empty mask is invalid. Unselected values are ignored. Selected absent values reset the field to its default, subject to field validation.

Result of updating a room group.

FieldTypeDescription
groupAdminRoomLayoutGroupUpdated room group.

Deletes an empty room group. Requires effective room.manage for the group.

POST /api/connect/chatto.admin.v1.AdminRoomLayoutService/DeleteRoomGroup

Request to delete an empty room group.

FieldTypeDescription
group_idstringRequired room group ID.

Result of deleting a room group.

Replaces the global room group order. Requires server-scope room.manage.

POST /api/connect/chatto.admin.v1.AdminRoomLayoutService/ReorderRoomGroups

Request to replace the global room group order.

FieldTypeDescription
ordered_group_idsrepeated stringOrdered room group IDs. The list must include every existing group exactly once.

Result of replacing the global room group order.

FieldTypeDescription
groupsrepeated AdminRoomLayoutGroupRoom groups in their new order.

Moves one room group before another group, or to the end. Requires server-scope room.manage.

POST /api/connect/chatto.admin.v1.AdminRoomLayoutService/MoveRoomGroup

Request to place one room group immediately before another group. When before_group_id is absent, the group moves to the end of the sidebar.

FieldTypeDescription
group_idstringRequired room group to move.
before_group_idoptional stringGroup that follows the moved group. Omit to place the group last.

Result of moving one room group.

FieldTypeDescription
groupsrepeated AdminRoomLayoutGroupRoom groups in their authoritative order after the move.

Moves a channel room to another room group. Requires room.manage in both source and destination groups.

POST /api/connect/chatto.admin.v1.AdminRoomLayoutService/MoveRoomToGroup

Request to move a channel room to another room group.

FieldTypeDescription
room_idstringRequired channel room ID.
group_idstringRequired destination room group ID.

Result of moving a channel room.

FieldTypeDescription
roomchatto.api.v1.RoomMoved room after the operation.

Replaces the mixed room/link sidebar order in one group. Requires room.manage in that group.

POST /api/connect/chatto.admin.v1.AdminRoomLayoutService/ReorderSidebarItemsInGroup

Request to replace the mixed sidebar item order in one group.

FieldTypeDescription
group_idstringRequired room group ID.
itemsrepeated AdminRoomLayoutItemInputOrdered room/sidebar-link item references.

Result: ReorderSidebarItemsInGroupResponse

Section titled “Result: ReorderSidebarItemsInGroupResponse”

Result of replacing the mixed sidebar item order.

FieldTypeDescription
groupAdminRoomLayoutGroupUpdated room group.

Moves one room or sidebar link to a position in a room group. Requires room.manage in the source and destination groups.

POST /api/connect/chatto.admin.v1.AdminRoomLayoutService/MoveSidebarItem

Request to move one room or sidebar link to an exact sidebar position. The server resolves the complete current layout, including entries that the caller’s ordinary room directory does not show.

FieldTypeDescription
itemAdminRoomLayoutItemInputRequired room or sidebar link to move.
group_idstringRequired destination room group.
beforeAdminRoomLayoutItemInputItem that follows the moved item. Omit to place the item last.

Result of moving one sidebar item.

FieldTypeDescription
groupAdminRoomLayoutGroupDestination room group after the move.

Creates a sidebar link. Requires room.manage in the destination group.

POST /api/connect/chatto.admin.v1.AdminRoomLayoutService/CreateSidebarLink

Request to create a sidebar link in one room group.

FieldTypeDescription
group_idstringRequired destination room group ID.
labelstringRequired display label.
urlstringRequired absolute http(s) URL or server-local path.

Result of creating a sidebar link.

FieldTypeDescription
sidebar_linkchatto.api.v1.SidebarLinkCreated sidebar link.

Updates a sidebar link. Requires room.manage in the link’s current group.

POST /api/connect/chatto.admin.v1.AdminRoomLayoutService/UpdateSidebarLink

Request to update a sidebar link.

FieldTypeDescription
link_idstringRequired sidebar link ID.
labeloptional stringNew display label, when changing it.
urloptional stringNew absolute http(s) URL or server-local path, when changing it.
update_maskgoogle.protobuf.FieldMaskEditable fields to apply or reset: label, url. Omit to infer populated fields; * selects all editable fields. An explicit empty mask is invalid. Unselected values are ignored. Selected absent values reset the field to its default, subject to field validation.

Result of updating a sidebar link.

FieldTypeDescription
sidebar_linkchatto.api.v1.SidebarLinkUpdated sidebar link.

Deletes a sidebar link. Requires room.manage in the link’s current group.

POST /api/connect/chatto.admin.v1.AdminRoomLayoutService/DeleteSidebarLink

Request to delete a sidebar link.

FieldTypeDescription
link_idstringRequired sidebar link ID.

Result of deleting a sidebar link.

Moves a sidebar link to another group. Requires room.manage in both source and destination groups.

POST /api/connect/chatto.admin.v1.AdminRoomLayoutService/MoveSidebarLinkToGroup

Request to move a sidebar link to another room group.

FieldTypeDescription
link_idstringRequired sidebar link ID.
group_idstringRequired destination room group ID.

Result of moving a sidebar link.

FieldTypeDescription
sidebar_linkchatto.api.v1.SidebarLinkMoved sidebar link.