> For the complete documentation index, see [llms.txt](https://docs.snapfix.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.snapfix.com/how-the-apps-work/screens/rooms/room-info.md).

# Room info

{% hint style="info" %}
Draft, written by an agent and not yet checked by a person ([how to read these docs](https://docs.snapfix.com/how-to-read.md)). Platforms: iOS and Android. [Source on GitHub](https://github.com/snapfix/docs/blob/main/spec/screens/rooms/room-info.md).
{% endhint %}

A room's name, description and instructions; site admins can change them.

* **Where:** iOS: a room's task list, a tap on the header ([Room](https://docs.snapfix.com/how-the-apps-work/screens/rooms/room.md#layout)); Android: a room's task list, a tap on the header or the info icon
* **Who:** anyone who can open the room. Only site admins can edit: iOS reads the site's `parent_admin` flag and Android its `isAccountAdmin` flag; everyone else sees the same text read-only. The API's room edit accepts any site member.
* **Feature:** [Rooms and areas](https://docs.snapfix.com/product/features/rooms/rooms-and-areas.md)

The web has no room info screen; its room edit dialog is in [Areas & rooms](https://docs.snapfix.com/how-the-apps-work/screens/rooms/areas-and-rooms.md#dialogs-and-sheets).

## Layout

**iOS:** a circle with the room's name, the name and the description under it (the description line is hidden when the room has none), then three fields: the name, the description and the instructions. Site admins see each field with a border and an edit button; others see them without borders, and can't type in them.

**Android:** a toolbar with the room's name and description, then three fields: "Room Name", "Description" and "Instructions". They are editable for site admins and disabled for everyone else.

## Inputs

| Field        | Type                | Required | Default                  | Rules and messages                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| ------------ | ------------------- | -------- | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Room name    | Text                | Yes      | The current name         | Trimmed. Empty: "Room Name cannot be empty". A name another room of the site already has: "Room Name already exists in this building". iOS: at most 5 characters, and no edit that leaves more than 5 is accepted, deleting included. Android: at most 10, as on the web. The iOS duplicate check misses most names, and the duplicate is then saved. iOS checks typed characters against letters and digits but never uses the result, so any character is accepted. |
| Description  | Text, several lines | No       | The current description  | Trimmed. Android: at most 1,000 characters; iOS: no limit. Clearing it isn't saved on iOS.                                                                                                                                                                                                                                                                                                                                                                            |
| Instructions | Text, several lines | No       | The current instructions | As the description; clearing isn't saved on iOS.                                                                                                                                                                                                                                                                                                                                                                                                                      |

On iOS the two name messages are written in English in the code; Android reads them from its string file. Both show them as a red message and keep the screen open.

## Actions

| Action       | Who         | What happens                                                                                                                                                                                        | API                                                                                                                       |
| ------------ | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
| Edit a field | Site admins | The field takes the change. Only changed fields are saved.                                                                                                                                          | None                                                                                                                      |
| Back         | Anyone      | Checks the name. When it passes and an admin changed something, saves the room on the device, starts the sync and closes the screen. A failed check keeps the screen open. There is no save button. | The sync: [`?action=save_pri_room`](https://docs.snapfix.com/engineering-reference/api/rooms.md#post-actionsave_pri_room) |

The apps don't use the room REST routes here. The change is stored on the device and sent by the sync, so it works offline.

## States

* **Loading:** none; the room comes from the device.
* **Empty:** the description and instructions fields are empty when the room has none.
* **Error:** an empty or duplicate name shows its red message and keeps the screen open. A failed sync isn't shown here.
* **No permission:** users who aren't site admins see the fields read-only, with no edit buttons.
* **Offline:** the edit is kept on the device and sent when the sync runs ([shared behavior](https://docs.snapfix.com/how-the-apps-work/shared.md)).

## Platform differences

| Topic                                    | iOS                               | Android                     |
| ---------------------------------------- | --------------------------------- | --------------------------- |
| Opened from                              | The header                        | The header or the info icon |
| Name limit                               | 5 characters                      | 10 characters               |
| Clearing the description or instructions | Not saved                         | Saved                       |
| Duplicate name check                     | A query that fails for most names | Against the device's rooms  |
| Name messages                            | Written in the code               | From the string file        |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.snapfix.com/how-the-apps-work/screens/rooms/room-info.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
