message_pin

message_pin is implemented by handleMessagePin in src/api/handlers/message/message_pin.osl.

Handles the message pin protocol operation through the resource-specific helper and storage layers.

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	Yes. The transport removes the internal marker and filters recipients by channel visibility.

Request

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

Field	Validation / meaning
`channel`	`schema.string().defaultValue("")`
`thread_id`	`schema.string().defaultValue("")`
`id`	`schema.string().minLen(1)`

Validator source

The handler and shared validation path use these OSL schema definitions before normalization:

*schema.Schema schemaMessagePinChange = schema.object({
  channel: schema.string().defaultValue(""),
  thread_id: schema.string().defaultValue(""),
  id: schema.string().minLen(1)
})

Shared validation and domain flow: src/api/helpers/messages.osl.

Processing path

handleCmd enforces authentication.
dispatchCmd routes message_pin to handleMessagePin.
The adapter validates and normalizes input, then calls its domain collaborators.
Durable mutations complete before the response or event is returned.
onMessage adds the request listener to direct responses and performs any marked broadcast.

Direct collaborators visible in the handler: messagePinChange, pinned, messageContext, canUserPinInChannel, storedMessageById, storedMessageRewrite, inboxMessages, threadIndexEnsure, channels, canUserViewChannel

Responses and events

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

Validation and domain failures use:

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