APIEnums

Enums

46 enums, in the order the schema defines them.

AttachmentStatusEnumenum

ValueDescription
PENDING_UPLOAD
UPLOADED
READY
FAILED

Used by Attachment

AuditOutcomeGqlenum

How an audited command or macro execution ended.

ValueDescription
SUCCESS
ERROR
CONFIRMATION_REQUIRED
PERMISSION_DENIED
RATE_LIMITED
STEP_ERROR
MACRO_PARTIAL_FAILURE

Used by AuditLogEntry

CommandArgumentTypeenum

The type of a command argument. Clients map each value to a form control and to a JSON schema fragment when they describe the command to an AI agent.

ValueDescription
STRING
INTEGER
FLOAT
BOOLEAN
ENUM
USER_ID
CONVERSATION_ID
MESSAGE_ID
THREAD_ID
WORKSPACE_ID
SELECTION_TEXT

Used by CommandArgument

CommandExecutionTargetenum

ValueDescription
BACKEND
DESKTOP_LOCAL

Used by Command

CommandInitiatorenum

Where a command execution came from. The server uses it for the audit log and the confirmation policy: AGENT and PLUGIN executions of mutating commands need a confirmation proof.

ValueDescription
PALETTE

User typed/clicked in the command palette.

AGENT

AI agent issued the command via the dispatcher.

MACRO

Inside a macro / user command expansion.

KEYBIND

Keyboard shortcut bound to a command.

CONTEXT_MENU

Context menu (right-click) on a chat element.

PLUGIN

Plugin's own runtime invoked the command.

CLI

Out-of-process CLI client (rim-cli).

Used by ExecuteCommandInput, ExecuteMacroInput

CommandResultStatusenum

ValueDescription
SUCCESS
ERROR
CONFIRMATION_REQUIRED

The command needs a confirmation and the call carried no matching proof. That is the case for a dangerous or RESTRICTED command, and for a MUTATING one an AGENT or PLUGIN initiator runs. confirmationRequired on the result carries the challenge: show it to the user, then re-submit with confirmation: { inBandToken: { token, argsHash } }.

Used by CommandResult, PipeStageResult

CommandSensitivityenum

How much a command can affect. It decides whether a call needs a confirmation proof and is recorded in the audit log; clients use it to cap an agent's mutating calls.

ValueDescription
SAFE

Read-only, no user-visible side effects.

SENSITIVE

Tracked in audit but low blast radius.

MUTATING

Mutates durable state; counts against agent mutating-call cap.

RESTRICTED

High-blast-radius admin/destructive; always requires confirmation.

Used by Command, CreateMacroInput, MacroDef, UpdateMacroInput

CommandSourceKindenum

ValueDescription
BUILT_IN
PLUGIN
INTEGRATION
USER

Used by Command

CommandSurfaceenum

ValueDescription
PALETTE
CONTEXT_MENU
KEYBIND_PICKER
AI

Used by Query.commands

ConversationChangesStatusenum

How one conversation of a messageChanges request was answered.

ValueDescription
OK

The changes after the requested cursor.

NO_ACCESS

The caller cannot read this conversation (removed from it, not a member of a private one, or it does not exist). No changes; the cursor is echoed. Stop syncing it.

RESET

The stored cursor is ahead of the server (its counters were reset). The changes start from the beginning: drop the cached copy of this conversation, then apply them.

Used by ConversationMessageChanges

ConversationTypeEnumenum

ValueDescription
DIRECT
GROUP
CHANNEL

Used by Conversation, SearchResultMessage

DeviceLinkStateenum

EXPIRED is a link that was still open, offered or answered when it expired.

ValueDescription
OPEN
OFFERED
ANSWERED
CONSUMED
CANCELLED
EXPIRED

Used by DeviceLink

DigestFrequencyenum

How often unread notifications are emailed.

ValueDescription
OFF
HOURLY
DAILY

Used by NotificationSettings, UpdateNotificationSettingsInput

DmFloorSourceKindenum

Who set a floor.

ValueDescription
OPERATOR

The server's operator (RIM_DM_INBOUND).

WORKSPACE

A workspace's owner.

Used by DmFloorSource

DmInboundenum

DMs from people on other servers, and from people here outside the recipient's workspaces (RIM_DM_INBOUND).

ValueDescription
OPEN

No floor; each person's choice applies.

REQUESTS

The first message is a request.

PARTNERS

Only people on the partner servers and this one, with a request.

NONE

Nobody outside a shared workspace.

Used by ServerInfo

DmMembersenum

How a DM from a fellow member of a workspace arrives.

ValueDescription
DIRECT

Straight into the conversation list.

REQUESTS

As a request.

Used by Mutation.setWorkspaceDmPolicy, Mutation.setMyWorkspaceDmSetting, Server, WorkspaceDmPolicy, WorkspaceDmSetting

DmOutboundenum

DMs people here start with people on other servers (RIM_DM_OUTBOUND).

ValueDescription
ALLOWED
PARTNERS

Only with people on the partner servers.

NONE

Used by ServerInfo

DmOutsideenum

A person's choice for DMs from people outside their workspaces.

ValueDescription
REQUESTS

The first message is a request.

NONE

Refused.

Used by Mutation.setMyDmSettings, MyDmSettings

DmOutsideFloorenum

A workspace's floor for DMs to its members from people outside their workspaces.

ValueDescription
NONE

No floor.

REQUESTS

At least a request.

CLOSED

Refused.

Used by Mutation.setWorkspaceDmPolicy, Server, WorkspaceDmPolicy

DmRequestStatusenum

ValueDescription
PENDING
ACCEPTED
IGNORED

Used by DmRequest, Query.dmRequests

FilterFieldenum

ValueDescription
HAS_LINKS
AUTHOR_ID
HAS_ATTACHMENTS
TEXT_CONTAINS
IS_PINNED

Used by FilterConditionGql, FilterConditionInput

FilterLogicenum

ValueDescription
AND
OR

Used by FilterSpecGql, FilterSpecInput

FilterOpenum

ValueDescription
EQ
IN
CONTAINS

Used by FilterConditionGql, FilterConditionInput

InviteTokenTypeGqlenum

The type of an invite token, used by InviteTokenPreview.

ValueDescription
INSTANCE

Instance invite: routes to instanceInviteToken input on signupWithInvite.

WORKSPACE

Workspace invite: join-a-workspace flow.

Used by InviteTokenPreviewGql

KeyLogEntryKindenum

ValueDescription
INCEPTION
ROTATE

Used by KeyLogEntry

KeybindContextenum

ValueDescription
GLOBAL
COMPOSER
MESSAGE_LIST
THREAD_VIEW
CONVERSATION_VIEW
PANEL
COMMAND_PALETTE

Used by CreateKeybindInput, Keybind, UpdateKeybindInput

KeybindScopeenum

ValueDescription
USER
WORKSPACE

Used by CreateKeybindInput, Keybind

KeybindSourceenum

ValueDescription
DEFAULT
USER
WORKSPACE

Used by Keybind

MessageChangeKindenum

What happened to a message, judged from its state at its newest change. DELETED wins over EDITED; a message whose text never changed is CREATED.

ValueDescription
CREATED
EDITED
DELETED

Used by MessageChange

MessageReportStatusenum

ValueDescription
OPEN
RESOLVED
DISMISSED

Used by MessageReport, Query.messageReports

NotificationLevelenum

Which messages of a conversation notify the viewer.

ValueDescription
ALL

Every message.

MENTIONS

Direct messages, mentions (<@user>, @channel, @here), keyword hits, replies in the viewer's threads and reactions to the viewer's messages.

NONE

Nothing, mentions included.

Used by Conversation, ConversationNotificationLevel, Mutation.setConversationNotificationLevel, NotificationSettings, UpdateNotificationSettingsInput

NotificationReasonenum

Why the viewer was notified (the strongest reason that applied).

ValueDescription
DIRECT
MENTION
KEYWORD
THREAD_REPLY
ALL
REACTION

Someone reacted to the viewer's message; one entry per message, re-surfaced by each new reaction.

Used by Notification

PageDirenum

ValueDescription
BEFORE
AFTER

Used by Query.inboxConversations, Query.channels, Query.messages, Query.threadMessages, Query.messageReports, Query.myNotifications, SearchMessagesInput

PipelineTriggerKindGqlenum

ValueDescription
NEW_MESSAGE
MESSAGE_UPDATED
MESSAGE_DELETED
REACTIONS_UPDATED
MEMBER_JOINED
WORKSPACE_STATE_CHANGED

Used by PipelineTriggerGql, PipelineTriggerInput

PluginRuntimeKindenum

ValueDescription
DESKTOP_LOCAL_PROCESS
WEB_SANDBOXED

Used by WorkspacePlugin

PluginSignatureStatusenum

ValueDescription
VALID
PUBLISHER_RECOVERED

The publisher recovered their key after the statement's keySeq: clients refuse new installs and updates of the entry.

Used by WorkspacePlugin

PluginSourceKindenum

ValueDescription
BUNDLE
GIT

Used by PluginSource

PresenceStatusenum

ValueDescription
ONLINE
AWAY
OFFLINE

Used by HeartbeatInput, UserPresenceGql

RegistrationModeGqlenum

How new accounts may sign up on this instance.

ValueDescription
INVITE_ONLY

Default: signup requires a valid token (instance or workspace invite).

OPEN

RIM_OPEN_REGISTRATION=true: signup accepts no token; rate-limited.

POW

RIM_REGISTRATION_POW_BITS: signupWithKey takes a token or a proof-of-work whose difficulty the discovery document's registration.powBits gives; a password signup takes a token.

Used by Query.registrationMode

ReportOutcomeenum

How a moderator closes a report.

ValueDescription
RESOLVED
DISMISSED

Used by Mutation.resolveReport

RevocationFanoutStatusenum

Where a revocation's delivery to one host stands.

ValueDescription
PENDING
ACKED
GAVE_UP

Used by RevocationFanout

ServerFeatureStateenum

Whether an optional feature works on this instance.

ValueDescription
ENABLED

The feature works.

DISABLED

The operator switched it off.

UNAVAILABLE

The configuration lacks something the feature needs; reason says what.

Used by ServerFeatureInfo

ServerMemberRoleGqlenum

A member's role in a workspace, from most to least privileged. Used by Server.viewerRole, ServerMember.memberRole, CreateInviteInput.role and setMemberRole.

ValueDescription
OWNER
MODERATOR
MEMBER
GUEST

Used by CreateInviteInput, Mutation.setMemberRole, Server, ServerMember

TypedVerbGqlenum

ValueDescription
READ
WRITE
DELETE
SEND
OPEN
CLOSE
TOGGLE
NAVIGATE
EXECUTE
CONFIGURE
OTHER

Used by AuditLogEntry, AuditLogFilterInput

WorkspacePluginStatusenum

ValueDescription
RECOMMENDED
REQUIRED

Offered to every member when the workspace opens; never installed without consent.

Used by AddWorkspacePluginInput, UpdateWorkspacePluginInput, WorkspacePlugin

WorkspaceStateScopeGqlenum

ValueDescription
SERVER
USER

Used by DeleteWorkspaceStateInput, Query.workspaceState, Query.workspaceStateList, SetWorkspaceStateInput, WorkspaceStateEntryGql