Skip to content
OriginChats

unreads_get

unreads_get is implemented by handleUnreadsGet in src/api/handlers/unreads/unreads_get.osl.

Handles the unreads get protocol operation through the resource-specific helper and storage layers.

Access

Section titled “Access”
Gate Requirement
Authentication Required by the central API gate.
Central permission None. Resource, channel, ownership, or hierarchy checks may still apply in the handler/helpers.
Broadcast Not marked global directly by this adapter. A helper may emit focused or server-wide updates.

Request

Section titled “Request”

Every request includes cmd: "unreads_get" and may include an opaque listener correlation value.

Field Validation / meaning
— No command-specific request fields.

Validator source

Section titled “Validator source”

This adapter delegates validation to a shared helper. The field table lists values read directly by the handler; follow the collaborators below for the shared domain schema.

Processing path

Section titled “Processing path”
  1. handleCmd enforces authentication.
  2. dispatchCmd routes unreads_get to handleUnreadsGet.
  3. The adapter validates and normalizes input, then calls its domain collaborators.
  4. Durable mutations complete before the response or event is returned.
  5. onMessage adds the request listener to direct responses and performs any marked broadcast.

Direct collaborators visible in the handler: lock, unreadStateRead, unlock, channels, canUserViewChannel, unreadEntry, unreadSummary, channelFiles, threadIndexEnsure, threadFromId

Responses and events

Section titled “Responses and events”

Response/event command names visible in this adapter: unreads_get.

Validation and domain failures use:

{
  "cmd": "error",
  "val": "<message>",
  "src": "unreads_get",
  "listener": "<copied from request>"
}