package anytype

Get desktop application:
View/edit binary Protocol Buffers messages

the element of change tree used to store and internal apply smartBlock history

• repeated Change.Content content = 3

  set of actions to apply

• optional Change.Snapshot snapshot = 4

  snapshot - when not null, the Content will be ignored

• repeated Change.FileKeys fileKeys = 6

  file keys related to changes content

• int64 timestamp = 7

  creation timestamp

• uint32 version = 8

  version of business logic

• uint32 changeType = 9

  business-level type of change applied to object

• string integrationName = 10

  integrationName is the RAW app name of the paired API key that authored this change — exactly as the app link recorded it, never normalized (normalization is many-to-one and lossy; the DELETE ownership rule compares this value exactly). Stamped by heart from the authenticated session — never accepted from a request. Bounded at key issuance (domain.MaxIntegrationNameLen). Empty for changes not authored through an API key.

Used in: Content

• string targetId = 1

• model.Block.Position position = 2

• repeated model.Block blocks = 3

Used in: Content

• string targetId = 1

• model.Block.Position position = 2

• repeated string ids = 3

Used in: Content

• string targetId = 1

• model.Block.Position position = 2

• repeated string ids = 3

Used in: Content

• repeated string ids = 1

Used in: Content

• repeated Event.Message events = 2

Used in: Change, ChangeNoSnapshot

• oneof value

  • BlockCreate blockCreate = 1

  • BlockUpdate blockUpdate = 2

  • BlockRemove blockRemove = 3

  • BlockMove blockMove = 4

  • BlockDuplicate blockDuplicate = 5

  • RelationAdd relationAdd = 50

  • RelationRemove relationRemove = 51

  • DetailsSet detailsSet = 100

  • DetailsUnset detailsUnset = 101

  • ObjectTypeAdd objectTypeAdd = 105

  • ObjectTypeRemove objectTypeRemove = 106

  • StoreKeySet storeKeySet = 107

  • StoreKeyUnset storeKeyUnset = 108

  • StoreSliceUpdate storeSliceUpdate = 109

  • OriginalCreatedTimestampSet originalCreatedTimestampSet = 110

  • SetFileInfo setFileInfo = 111

  • NotificationCreate notificationCreate = 112

  • NotificationUpdate notificationUpdate = 113

  • DeviceAdd deviceAdd = 114

  • DeviceUpdate deviceUpdate = 115

Used in: Content

• string key = 1

• optional google.protobuf.Value value = 2

Used in: Content

• string key = 1

Used in: Content

• optional model.DeviceInfo device = 1

Used in: Content

• string id = 1

• string name = 2

Used in: Change, Snapshot, ChangeNoSnapshot

• string hash = 1

• map<string, string> keys = 2

Used in: Content

• optional model.Notification notification = 1

Used in: Content

• string id = 1

• model.Notification.Status status = 2

Used in: Content

• string url = 1

• string key = 2

Used in: Content

• string url = 1

• string key = 2

Used in: Content

• int64 ts = 1

Used in: Content

• repeated model.RelationLink relationLinks = 1

Used in: Content

• repeated string relationKey = 1

Used in: Content

• optional model.FileInfo fileInfo = 1

Used in: Change, SnapshotWithType

• map<string, string> logHeads = 1

  logId -> lastChangeId

• optional model.SmartBlockSnapshotBase data = 2

  snapshot data

• repeated FileKeys fileKeys = 3

  all file keys related to doc

Used in: Content

• repeated string path = 1

• optional google.protobuf.Value value = 2

Used in: Content

• repeated string path = 1

Used in: Content

• string key = 1

• oneof operation

  • StoreSliceUpdate.Add add = 2

  • StoreSliceUpdate.Remove remove = 3

  • StoreSliceUpdate.Move move = 4

Used in: StoreSliceUpdate

• string afterId = 1

• repeated string ids = 2

Used in: StoreSliceUpdate

• string afterId = 1

• repeated string ids = 2

Used in: StoreSliceUpdate

• repeated string ids = 1

• repeated Change.Content content = 3

  set of actions to apply

• repeated Change.FileKeys fileKeys = 6

  file keys related to changes content

• int64 timestamp = 7

  creation timestamp

• uint32 version = 8

  version of business logic

• uint32 changeType = 9

  business-level type of change applied to object

• string integrationName = 10

  integrationName mirrors Change.integrationName (the two messages share wire numbers by design; 1/2/5 are historical — do not reuse).

Used in: StoreChangeContent

• string collection = 1

• string documentId = 2

• string value = 3

  json

Used in: StoreChangeContent

• string collection = 1

• string documentId = 2

Used in: StoreChangeContent

• string collection = 1

• string documentId = 2

• repeated KeyModify keys = 4

Event – type of message, that could be sent from a middleware to the corresponding front-end.

• repeated Event.Message messages = 1

• string contextId = 2

• optional model.Account initiator = 3

• string traceId = 4

Used in: User.Block.Join, User.Block.Left, User.Block.SelectRange, User.Block.TextRange

(message has no fields)

(message has no fields)

Used in: Message

• optional model.Account.Config config = 1

• optional model.Account.Status status = 2

Used in: Message

• string profileId = 1

• optional google.protobuf.Struct details = 2

JsonApiStatus reports the outcome of one bind attempt for the local JSON API server (core/api). Broadcast after the initial bind at AccountSelect/AccountCreate and after every AccountChangeJsonApiAddr, whichever session triggered it. Not emitted when the server is disabled (an empty listen address). AccountChangeJsonApiAddr's response carries this exact same message as `status`, so the event and the RPC response are never two schemas to keep in sync.

Used in: Message

• bool success = 1

• string listenAddr = 2

  the effective, OS-confirmed bound address on success; the requested address on failure, since nothing bound

• string error = 3

  raw OS error text — debug/log only, never shown to the user verbatim; empty when success = true

LinkApprovalHide takes a pending prompt off screen once it is answered, denied or expired. Identified by the caller, since a request that was never approved never had a code.

Used in: Message

• optional LinkApprovalRequest.ClientInfo clientInfo = 2

LinkApprovalRequest asks the user to approve a local-link pairing. It names who is asking and nothing else: the 4-digit code does not exist yet and is never broadcast. The user's answer goes back through AccountLocalLinkApproveChallenge, which mints the code and returns it to that one caller. Replaces the former LinkChallenge event, which carried the code to every session.

Used in: Message

• optional LinkApprovalRequest.ClientInfo clientInfo = 2

• model.Account.Auth.LocalApiScope scope = 3

• model.Account.Auth.AppGrant.Perm requestedPerm = 5

  the permission the app claims to need; pre-fills the prompt's permission control. Untrusted like `name`, and never a ceiling — the human approving decides. Read is the zero value, so a read claim is indistinguishable from no claim (both render the safe default).

Used in: LinkApprovalHide, LinkApprovalRequest

• string processName = 1

• string processPath = 2

• string name = 4

• bool signatureVerified = 3

• string origin = 5

  origin of the browser caller that asked for the challenge, e.g. "chrome-extension://<id>" or "http://localhost:3000". Empty for native clients, which send no Origin header. Taken from the header the browser sets, never from the request body, so it names the caller even when `name` is arbitrary. Show it to the user: it is the only attributable part of a pairing request.

Recovery is the account start-up status stream (GO-7471): a recovery-scoped, monotonic event log covering every app open, from the first millisecond of AccountSelect until every space has published its load result. Rpc.Account.RecoveryState serves the folded Snapshot from the same state, so push and pull cannot drift. Clients apply Updates with the same runId and id == last+1; on a gap or a new runId they re-pull the snapshot. Every payload is a level, never a delta.

(message has no fields)

Used in: Update

• string peerId = 1

• optional ErrorInfo error = 2

• int32 attempt = 3

Used in: Update

• string spaceId = 1

• string peerId = 2

  empty = waiting for a peer

• int32 attempt = 3

  pull rounds started; a new round means "still trying"

Used in: Update

• int64 durationMs = 1

Used in: Update

• string peerId = 1

• PeerKind kind = 2

• repeated string nodeTypes = 3

• optional ErrorInfo error = 4

• int32 attempt = 5

  dials observed since the last Connected

• int64 durationMs = 6

Used in: Update

• string peerId = 1

• PeerKind kind = 2

• repeated string nodeTypes = 3

  nodeconf node types, e.g. coordinator, tree, file

• int32 addrsCount = 4

Used in: PeerConnected

• Outbound = 0

• Inbound = 1

Used in: LocalDiscoveryState, Snapshot

• Possible = 0

• NoInterfaces = 1

• Restricted = 2

Used in: ErrorInfo

• None = 0

• NoNetwork = 1

• PeerUnreachable = 2

• IncompatibleVersion = 3

• NotAuthorized = 4

• SpaceDeleted = 5

• AccountDeleted = 6

• AccountNotFound = 7

• RateLimited = 8

• StorageLimit = 9

  reserved, no producer yet

• Unexpected = 10

ErrorInfo (not "Error": enum values and nested messages share the enclosing scope, and SpaceState.Error already takes that name)

Used in: AccountFetchError, DialFailed, PhaseChanged, Snapshot, Snapshot.Peer, Snapshot.Space, SpaceStateChanged

• ErrorClass class = 1

• bool retryable = 2

• string debugMessage = 3

  raw error text for logs/diagnostics; clients may log it, must never headline it

Used in: Update

• int32 spacesTotal = 1

• int32 spacesLoaded = 2

• int32 spacesFailed = 3

• int64 totalDurationMs = 4

• bool viewsConfirmed = 5

  true: the SpaceView set was confirmed against the network ("no more spaces to download"); false: the completeness gate opened on its stall bound and no completeness claim may be made — keep relying on the SpaceView subscription for spaces that appear later

Used in: Update

• DiscoveryState state = 1

LocalPeersState is the fold's headline for the LAN layer, derived from every LocalPeer's dial state and space-exchange answer. The negative verdict surfaces only once every connected LAN peer has answered and none holds the account; one positive answer flips it at once.

Used in: LocalPeersStateChanged, Snapshot

• NoLocalPeers = 0

• LocalPeersConnecting = 1

  discovered, dialing, or connected and awaiting the exchange

• LocalPeersUnreachable = 2

  every discovered peer failed to connect

• AccountNotOnLocalPeers = 3

  every connected peer answered: it does not hold the account

• AccountOnLocalPeer = 4

  at least one peer holds the account's tech space

Used in: Update

• LocalPeersState state = 1

• LocalPeersState fromState = 2

ModeUnknown is the zero value and is never emitted: an unset field must not read as a cold recovery, the worse failure direction.

Used in: Snapshot, Started

• ModeUnknown = 0

• ColdRecovery = 1

  fresh device: the account repo did not exist

• WarmStart = 2

  the repo existed

• NewAccount = 3

  account creation paths

Used in: Update

• string peerId = 1

• PeerKind kind = 2

• repeated string nodeTypes = 3

• Direction direction = 4

• string addr = 5

  display only; never compare across directions

• string transport = 6

  scheme as any-sync reports it: quic, yamux, ...

• uint32 protoVersion = 7

• int64 durationMs = 8

  0 = unknown (inbound)

• int32 openConnections = 9

Used in: Update

• string peerId = 1

• PeerKind kind = 2

• int32 openConnections = 3

• repeated string nodeTypes = 4

Used in: Update

• string peerId = 1

• repeated string addrs = 2

  display only

• PeerKind kind = 3

• repeated string nodeTypes = 4

Used in: DialFailed, DialStarted, PeerConnected, PeerDisconnected, PeerDiscovered, Snapshot.Peer

• LocalPeer = 0

• NetworkNode = 1

PeerSpaceExchange reports what the space exchange with a LAN peer said — a fact, not a verdict: whether the peer holds this account's tech space and how many spaces it shares. exchanged=false means no answer is known (the peer was dropped from the peer store).

Used in: Update

• string peerId = 1

• bool exchanged = 2

• bool hasAccountSpace = 3

• int32 sharedSpaceCount = 4

NOT monotone: the phase is derived from the run's current condition and moves back when that condition regresses (losing the last node connection mid-fetch goes FetchingAccount -> Connecting; the WaitingForNetwork overlay returns to the phase it interrupted). Clients must render the phase last received rather than dropping backward transitions. Only Done and Failed are terminal. Phases may be skipped (a warm start never enters FetchingAccount); clients must accept any forward jump.

Used in: PhaseChanged, Snapshot

• LookingForPeers = 0

• Connecting = 1

• FetchingAccount = 2

• LoadingSpaces = 3

• Done = 4

• WaitingForNetwork = 5

  calm, auto-retrying resting state; not an error screen

• Failed = 6

  account-level fatal; AccountSelect itself failed

• NotStarted = 7

  NotStarted is the idle snapshot's phase: no recovery run has begun in this process (Snapshot.runId is empty). A new number on purpose: the zero value would read as LookingForPeers before anything happens.

Used in: Update

• Phase phase = 1

• Phase fromPhase = 2

• int64 previousPhaseDurationMs = 3

• optional ErrorInfo error = 4

  set for WaitingForNetwork and Failed

Folded state. Served by Rpc.Account.RecoveryState and pushed once to each new session. The RPC is total: before any run it returns the idle snapshot (runId empty, phase NotStarted) rather than an error.

Used in: Update

• string runId = 1

  empty: no run has begun, ignore the rest

• int64 lastEventId = 2

• Mode mode = 3

• string networkId = 4

• int64 startedAtMs = 5

• Phase phase = 6

• int64 phaseStartedAtMs = 7

• bool done = 8

• optional ErrorInfo error = 9

  account-level only

• DiscoveryState discovery = 10

• bool accountFetchStarted = 11

• bool accountReady = 12

• repeated Snapshot.Peer peers = 13

• repeated Snapshot.Space spaces = 14

• int32 spacesTotal = 15

• int32 spacesLoaded = 16

• int32 spacesFailed = 17

• bool viewsConfirmed = 18

  meaningful once done; see Finished

• int32 accountFetchAttempt = 19

• optional ErrorInfo accountFetchError = 20

  last failed pull; cleared at AccountReady

• LocalPeersState localPeers = 21

Used in: Snapshot

• string peerId = 1

• PeerKind kind = 2

• repeated string nodeTypes = 3

• int32 openConnections = 4

• string transport = 5

• uint32 protoVersion = 6

• int32 dialAttempts = 7

• optional ErrorInfo lastError = 8

• bool discoveredLocally = 9

• bool exchanged = 10

  a space exchange answered; the two fields below apply

• bool hasAccountSpace = 11

• int32 sharedSpaceCount = 12

Used in: Snapshot

• string spaceId = 1

• string spaceViewId = 2

• SpaceKind kind = 3

• SpaceState state = 4

• optional ErrorInfo error = 5

• int32 attempt = 6

Used in: Update

• string spaceId = 1

• string spaceViewId = 2

• SpaceKind kind = 3

Used in: Snapshot.Space, SpaceDiscovered

• Regular = 0

• Tech = 1

Loaded = the space controller published LocalStatusOk: mandatory objects fetched, tree sync started. Object-level progress after that is on Event.Space.SyncStatus.Update.

Used in: Snapshot.Space, SpaceStateChanged

• Queued = 0

• Pulling = 1

• Loading = 2

• Loaded = 3

• Error = 4

• Removed = 5

  Removed: the space left this run (deleted or removed while recovering); drop it from the list, it is excluded from counters

• Stalled = 6

  Stalled: the run settled around this space but it never published a load result. Not terminal — the load may still complete, and the state will change again if it does — so Finished does not fire while a space is stalled. Render it as a determinate stall with a retry ("79 of 80 loaded, 1 stalled"), never as ongoing progress.

Used in: Update

• string spaceId = 1

• SpaceState state = 2

• SpaceState fromState = 3

• optional ErrorInfo error = 4

• int32 attempt = 5

  pull attempts, a level

Used in: Update

• Mode mode = 1

• string networkId = 2

Used in: Message

• string runId = 1

  random per run; a change means "new run, reset"

• int64 id = 2

  monotonic within runId, starts at 1; gap => re-pull

• int64 timestampMs = 3

  unix ms

• oneof payload

  • Started started = 10

  • PhaseChanged phaseChanged = 11

  • LocalDiscoveryState localDiscoveryState = 12

  • PeerDiscovered peerDiscovered = 13

  • DialStarted dialStarted = 14

  • PeerConnected peerConnected = 15

  • DialFailed dialFailed = 16

  • PeerDisconnected peerDisconnected = 17

  • AccountFetchStarted accountFetchStarted = 18

  • AccountFetchError accountFetchError = 19

  • AccountReady accountReady = 20

  • SpaceDiscovered spaceDiscovered = 21

  • SpaceStateChanged spaceStateChanged = 22

  • Finished finished = 23

  • Snapshot snapshot = 24

    sent only to a newly attached session: snapshot-on-subscribe

  • PeerSpaceExchange peerSpaceExchange = 25

  • LocalPeersStateChanged localPeersStateChanged = 26

* Message, that will be sent to the front on each account found after an AccountRecoverRequest

Used in: Message

• int32 index = 1

  Number of an account in an all found accounts list

• optional model.Account account = 2

  An Account, that has been found for the mnemonic

Used in: Message

• optional model.Account.Config config = 1

• optional model.Account.Status status = 2

(message has no fields)

Event to show internal blocks on a client. Example Scenarios A. Block Creation 1. Block A have been created on a client C1 2. Client C2 receives Event.Block.Add(Block A), Event.Block.Update(Page.children) B. Partial block load 1. Client C1 opens Page1, that contains, for example, 133 blocks. 2. M -> F: ShowFullScreen(Root, blocks1-50) 3. M -> F: Block.Add(blocks51-100) 3. M -> F: Block.Add(blocks101-133)

Used in: Message

• repeated model.Block blocks = 1

  id -> block

(message has no fields)

Used in: Message

• string id = 1

  dataview block's id

• optional model.Block.Content.Dataview.GroupOrder groupOrder = 2

Used in: Message

• string id = 1

  dataview block's id

• bool value = 2

Used in: Message

• string id = 1

  dataview block's id

• string viewId = 2

• string groupId = 3

• repeated SliceChange sliceChanges = 4

Used in: Message

• string id = 1

  dataview block's id

• string relationKey = 2

  relation key to remove

sent when the dataview relation has been changed or added

Used in: Message

• string id = 1

  dataview block's id

• string relationKey = 2

  relation key to update

• optional model.Relation relation = 3

Used in: Message

• string id = 1

  dataview block's id

• repeated string relationKeys = 2

  relation key to remove

sent when the dataview relation has been changed or added

Used in: Message

• string id = 1

  dataview block's id

• repeated model.RelationLink relationLinks = 2

  relation id to update

Used in: ObjectOrderUpdate

• SliceOperation op = 1

• repeated string ids = 2

• string afterId = 3

Used in: SliceChange

• SliceOperationNone = 0

  not used

• SliceOperationAdd = 1

• SliceOperationMove = 2

• SliceOperationRemove = 3

• SliceOperationReplace = 4

Used in: Message

• string id = 1

  dataview block's id

• repeated string source = 2

Used in: Message

• string id = 1

  dataview block's id

• string targetObjectId = 2

Used in: Message

• string id = 1

  dataview block's id

• string viewId = 2

  view id to remove

Used in: Message

• string id = 1

  dataview block's id

• repeated string viewIds = 2

  view ids in new order

sent when the view have been changed or added

Used in: Message

• string id = 1

  dataview block's id

• string viewId = 2

  view id, client should double check this to make sure client

• optional model.Block.Content.Dataview.View view = 3

  doesn't switch the active view in the middle

Used in: Message

• string id = 1

• string viewId = 2

• repeated ViewUpdate.Filter filter = 3

• repeated ViewUpdate.Relation relation = 4

• repeated ViewUpdate.Sort sort = 5

• optional ViewUpdate.Fields fields = 6

Used in: ViewUpdate

• model.Block.Content.Dataview.View.Type type = 1

• string name = 2

• string coverRelationKey = 3

  Relation used for cover in gallery

• bool hideIcon = 4

  Hide icon near name

• model.Block.Content.Dataview.View.Size cardSize = 5

  Gallery card size

• bool coverFit = 6

  Image fits container

• string groupRelationKey = 7

  Group view by this relationKey

• string endRelationKey = 16

• bool groupBackgroundColors = 8

  Enable backgrounds in groups

• int32 pageLimit = 9

  Limit of objects shown in widget

• string defaultTemplateId = 10

  Id of template object set default for the view

• string defaultObjectTypeId = 15

  Default object type that is chosen for new object created

• bool wrapContent = 17

  within the view

  Wrap content in view

• model.Block.Content.Dataview.View.ListSize listSize = 18

  List view size setting

• bool alternateRows = 19

  Alternate row background colors in grid view

Used in: ViewUpdate

• oneof operation

  • Filter.Add add = 1

  • Filter.Remove remove = 2

  • Filter.Update update = 3

  • Filter.Move move = 4

Used in: Filter

• string afterId = 1

• repeated model.Block.Content.Dataview.Filter items = 2

Used in: Filter

• string afterId = 1

• repeated string ids = 2

Used in: Filter

• repeated string ids = 1

Used in: Filter

• string id = 1

• optional model.Block.Content.Dataview.Filter item = 2

Used in: ViewUpdate

• oneof operation

  • Relation.Add add = 1

  • Relation.Remove remove = 2

  • Relation.Update update = 3

  • Relation.Move move = 4

Used in: Relation

• string afterId = 1

• repeated model.Block.Content.Dataview.Relation items = 2

Used in: Relation

• string afterId = 1

• repeated string ids = 2

Used in: Relation

• repeated string ids = 1

Used in: Relation

• string id = 1

• optional model.Block.Content.Dataview.Relation item = 2

Used in: ViewUpdate

• oneof operation

  • Sort.Add add = 1

  • Sort.Remove remove = 2

  • Sort.Update update = 3

  • Sort.Move move = 4

Used in: Sort

• string afterId = 1

• repeated model.Block.Content.Dataview.Sort items = 2

Used in: Sort

• string afterId = 1

• repeated string ids = 2

Used in: Sort

• repeated string ids = 1

Used in: Sort

• string id = 1

• optional model.Block.Content.Dataview.Sort item = 2

Used in: Message

• repeated string blockIds = 1

* Middleware to front end event message, that will be sent on one of this scenarios: Precondition: user A opened a block 1. User A drops a set of files/pictures/videos 2. User A creates a MediaBlock and drops a single media, that corresponds to its type.

Used in: Message

• string blockId = 1

  if empty => create new blocks

• repeated string filePath = 2

  filepaths to the files

(message has no fields)

• string id = 1

• model.Block.Align align = 2

• string id = 1

• string backgroundColor = 2

• string id = 1

• optional Bookmark.Url url = 2

• optional Bookmark.Title title = 3

• optional Bookmark.Description description = 4

• optional Bookmark.ImageHash imageHash = 5

• optional Bookmark.FaviconHash faviconHash = 6

• optional Bookmark.Type type = 7

• optional Bookmark.TargetObjectId targetObjectId = 8

Used in: Bookmark

• string value = 1

Used in: Bookmark

• string value = 1

Used in: Bookmark

• string value = 1

Used in: Bookmark

• string value = 1

Used in: Bookmark

• string value = 1

Used in: Bookmark

• model.LinkPreview.Type value = 1

Used in: Bookmark

• string value = 1

• string id = 1

• repeated string childrenIds = 2

• string id = 1

• repeated google.protobuf.Struct records = 2

• string id = 1

• optional google.protobuf.Struct details = 2

• string id = 1

• optional Div.Style style = 2

Used in: Div

• model.Block.Content.Div.Style value = 1

• string id = 1

• optional google.protobuf.Struct fields = 2

• string id = 1

• optional File.Type type = 2

• optional File.State state = 3

• optional File.Mime mime = 4

• optional File.Hash hash = 5

• optional File.Name name = 6

• optional File.Size size = 7

• optional File.Style style = 8

Used in: File

• string value = 1

Used in: File

• string value = 1

Used in: File

• string value = 1

Used in: File

• int64 value = 1

Used in: File

• model.Block.Content.File.State value = 1

Used in: File

• model.Block.Content.File.Style value = 1

Used in: File

• model.Block.Content.File.Type value = 1

• int32 value = 1

• string id = 1

• optional Link.TargetBlockId targetBlockId = 2

• optional Link.Style style = 3

• optional Link.Fields fields = 4

Used in: Link

• optional google.protobuf.Struct value = 1

Used in: Link

• model.Block.Content.Link.Style value = 1

Used in: Link

• string value = 1

• string id = 1

• optional model.Block.Restrictions restrictions = 2

• string id = 1

• optional Text.Text text = 2

• optional Text.Style style = 3

• optional Text.Marks marks = 4

• optional Text.Checked checked = 5

• optional Text.Color color = 6

Used in: Text

• bool value = 1

Used in: Text

• string value = 1

Used in: Text

• optional model.Block.Content.Text.Marks value = 1

Used in: Text

• model.Block.Content.Text.Style value = 1

Used in: Text

• string value = 1

Used in: Message

• repeated model.Block.Content.Text.Mark.Type marksInRange = 1

(message has no fields)

Used in: Message

• string id = 1

• model.Block.Align align = 2

Used in: Message

• string id = 1

• string backgroundColor = 2

Used in: Message

• string id = 1

• optional Bookmark.Url url = 2

• optional Bookmark.Title title = 3

• optional Bookmark.Description description = 4

• optional Bookmark.ImageHash imageHash = 5

• optional Bookmark.FaviconHash faviconHash = 6

• optional Bookmark.Type type = 7

• optional Bookmark.TargetObjectId targetObjectId = 8

• optional Bookmark.State state = 9

Used in: Bookmark

• string value = 1

Used in: Bookmark

• string value = 1

Used in: Bookmark

• string value = 1

Used in: Bookmark

• model.Block.Content.Bookmark.State value = 1

Used in: Bookmark

• string value = 1

Used in: Bookmark

• string value = 1

Used in: Bookmark

• model.LinkPreview.Type value = 1

Used in: Bookmark

• string value = 1

Used in: Message

• string id = 1

• repeated string childrenIds = 2

Used in: Message

• string id = 1

• optional Div.Style style = 2

Used in: Div

• model.Block.Content.Div.Style value = 1

Used in: Message

• string id = 1

• optional google.protobuf.Struct fields = 2

Used in: Message

• string id = 1

• optional File.Type type = 2

• optional File.State state = 3

• optional File.Mime mime = 4

• optional File.Hash hash = 5

• optional File.Name name = 6

• optional File.Size size = 7

• optional File.Style style = 8

• optional File.TargetObjectId targetObjectId = 9

Used in: File

• string value = 1

Used in: File

• string value = 1

Used in: File

• string value = 1

Used in: File

• int64 value = 1

Used in: File

• model.Block.Content.File.State value = 1

Used in: File

• model.Block.Content.File.Style value = 1

Used in: File

• string value = 1

Used in: File

• model.Block.Content.File.Type value = 1

• int32 value = 1

Used in: Message

• string id = 1

• optional Latex.Text text = 2

• optional Latex.Processor processor = 3

Used in: Latex

• model.Block.Content.Latex.Processor value = 1

Used in: Latex

• string value = 1

Used in: Message

• string id = 1

• optional Link.TargetBlockId targetBlockId = 2

• optional Link.Style style = 3

• optional Link.Fields fields = 4

• optional Link.IconSize iconSize = 5

• optional Link.CardStyle cardStyle = 6

• optional Link.Description description = 7

• optional Link.Relations relations = 8

Used in: Link

• model.Block.Content.Link.CardStyle value = 1

Used in: Link

• model.Block.Content.Link.Description value = 1

Used in: Link

• optional google.protobuf.Struct value = 1

Used in: Link

• model.Block.Content.Link.IconSize value = 1

Used in: Link

• repeated string value = 1

Used in: Link

• model.Block.Content.Link.Style value = 1

Used in: Link

• string value = 1

Used in: Message

• string id = 1

• optional Relation.Key key = 2

Used in: Relation

• string value = 1

Used in: Message

• string id = 1

• optional model.Block.Restrictions restrictions = 2

Used in: Message

• string id = 1

• optional TableRow.IsHeader isHeader = 2

Used in: TableRow

• bool value = 1

Used in: Message

• string id = 1

• optional Text.Text text = 2

• optional Text.Style style = 3

• optional Text.Marks marks = 4

• optional Text.Checked checked = 5

• optional Text.Color color = 6

• optional Text.IconEmoji iconEmoji = 7

• optional Text.IconImage iconImage = 8

Used in: Text

• bool value = 1

Used in: Text

• string value = 1

Used in: Text

• string value = 1

Used in: Text

• string value = 1

Used in: Text

• optional model.Block.Content.Text.Marks value = 1

Used in: Text

• model.Block.Content.Text.Style value = 1

Used in: Text

• string value = 1

Used in: Message

• string id = 1

• model.Block.VerticalAlign verticalAlign = 2

Used in: Message

• string id = 1

• optional Widget.Layout layout = 2

• optional Widget.Limit limit = 3

• optional Widget.ViewId viewId = 4

Used in: Widget

• model.Block.Content.Widget.Layout value = 1

Used in: Widget

• int32 value = 1

Used in: Widget

• string value = 1

(message has no fields)

Used in: Message

• string id = 1

• string orderId = 2

• string afterOrderId = 6

• optional model.ChatMessage message = 3

• repeated string subIds = 4

• repeated google.protobuf.Struct dependencies = 5

Used in: Message

• string id = 1

• repeated string subIds = 2

Used in: Message

• string id = 1

• optional model.ChatMessage message = 2

• repeated string subIds = 3

Used in: Message

• repeated string ids = 1

• bool isRead = 2

• repeated string subIds = 3

Used in: Message

• int32 messageCount = 1

  total number of non-deleted messages (includes replies)

• repeated string subIds = 2

Used in: Message

• repeated string ids = 1

• bool isRead = 2

• repeated string subIds = 3

Used in: Message

• repeated string ids = 1

• bool isSynced = 2

• repeated string subIds = 3

Used in: Message

• optional model.ChatMessage message = 1

• bool isPinned = 2

• repeated string subIds = 3

Used in: Message

• repeated string ids = 1

• bool isUnread = 2

• repeated string subIds = 3

Used in: Message

• string id = 1

• optional model.ChatMessage.Reactions reactions = 2

• repeated string subIds = 3

Used in: Message

• optional model.ChatState state = 1

• repeated string subIds = 2

(message has no fields)

ProfileCreated is emitted whenever the middleware writes a snapshot archive on its own (e.g. the memory-growth detector), so clients can surface it or queue the archive for upload without polling the profiles directory. Archives produced as a result of a client RPC (DebugRunProfiler) are NOT re-announced via this event — the RPC response already carries the path.

Used in: Message

• string reason = 1

  reason is a short, stable, UPPER_SNAKE_CASE label describing why the middleware produced this report. It is NOT the DebugRunProfiler Reason enum — values come from the internal call sites: - "MEMORY_GROWTH" : the desktop memory-growth detector tripped - "LONG_RPC" : an RPC exceeded the long-execution threshold - "DB_CORRUPTION" : an anystore/spacestore database failed to open More reasons may be added over time; clients should forward unknown values to Sentry as-is.

• string jsonInfo = 2

  jsonInfo is JSON-encoded context produced by the middleware (reason- specific keys like "sysMemory", "method", "durationMs", "db", "code"). Clients forward it verbatim to Sentry as the event context.

• string path = 3

  path is the absolute path to the snapshot archive on disk; empty when the reason is event-only (e.g. DB_CORRUPTION) and no artifact was produced.

• bool full = 4

  full is true when the archive carries a timed CPU profile + trace in addition to heap and goroutines. False for fast snapshots and for event-only reports.

(message has no fields)

Used in: Message

• string spaceId = 1

• string fileId = 2

Used in: Message

• uint64 bytesLimit = 1

Used in: Message

• uint64 localBytesUsage = 1

Used in: Message

• uint64 bytesUsage = 1

• string spaceId = 2

(message has no fields)

Used in: Message

• string rootCollectionID = 1

• int64 objectsCount = 2

• model.Import.Type importType = 3

• string reportObjectId = 4

  id of the import report page listing per-object issues; empty when the run was clean (importv2)

• int64 issuesCount = 5

  number of issues recorded during the run (importv2)

Statistic is the structured progress surface of one importv2 run: per-phase counters — deliberately NO blended overall percentage (fetching is rate-limit-bound at ~1.5 items/s, creating runs at persist speed: any blended bar crawls for an hour and then leaps) — plus the three-state running/throttled/retrying model: rate limiting is normal operation, not an error. The same message is served by ObjectImportRunStatus/ObjectImportRunList for runs with no live engine.

Used in: Message

• string importId = 1

  the durable run id; stable across restarts

• string processId = 2

  correlates with the legacy progress process

• model.Import.Type importType = 3

• Statistic.Phase phase = 4

• int64 phaseStartedAt = 5

  unix ms; clients show elapsed without their own clock

• bool totalsKnown = 6

  false while the total is indeterminate (a cursor-chained scan has no total until it ends): render a count-up, never a fake bar

• int64 pagesTotal = 7

  pages and files are SEPARATE counters: 500 small files and one huge one behave nothing alike

• int64 pagesDone = 8

• int64 filesTotal = 9

• int64 filesDone = 10

• int64 bytesTotal = 11

  files only; 0 = unknown

• int64 bytesDone = 12

• Statistic.State state = 13

• int64 resumesInMs = 14

  Throttled: when the rate-limit window reopens

• int32 attempt = 15

  Retrying: attempt N...

• int32 attemptsMax = 16

  ...of M

• string errorMessage = 17

  Error only

• double itemsPerSecond = 18

  recent-window rate, per phase

• int64 estimatedRemainingMs = 19

  0 = unknown; honest computation only

• Statistic.CancelEffect cancelEffect = 20

• int64 objectsCreated = 21

  for phrasing "stop and remove the N objects created"

• bool safeToClose = 22

  closing now loses nothing (resume exists for the current phase)

• int64 warningCount = 23

  live issue counts — abort a bad import at minute 20, not minute 110

• int64 errorCount = 24

• string currentItem = 25

  "Fetching: Q3 Planning" — the strongest not-stuck signal. USER CONTENT: displayable, never loggable.

Used in: Statistic

• NothingToUndo = 0

  passes 1-2: nothing has entered the space yet

• RemovesCreated = 1

  pass 3 onward: cancel deletes what was created

Used in: Statistic

• Scanning = 0

• Analyzing = 1

• Fetching = 2

• Creating = 3

• Finalizing = 4

Used in: Statistic

• Running = 0

• Throttled = 1

  expected and calm; carries resumesInMs

• Retrying = 2

  transient failure under backoff

• Error = 3

  something is actually wrong

(message has no fields)

Used in: Message

• repeated model.MembershipTierData tiers = 1

Used in: Message

• optional model.Membership data = 1

(message has no fields)

Used in: Message

• repeated model.MembershipV2.Product products = 1

• optional model.MembershipV2.FetchState fetchState = 2

  freshness, last successful fetch, last error and revision of the products

Used in: Message

• optional model.MembershipV2.Data data = 1

• optional model.MembershipV2.FetchState fetchState = 2

  freshness, last successful fetch, last error and revision of the status

Used in: Change.BlockUpdate, Event, ResponseEvent

• string spaceId = 132

• oneof value

  • Account.Show accountShow = 1

  • Account.Details accountDetails = 201

  • Account.Config.Update accountConfigUpdate = 202

  • Account.Update accountUpdate = 203

  • Account.LinkApprovalRequest accountLinkApprovalRequest = 204

  • Account.LinkApprovalHide accountLinkApprovalHide = 205

  • Account.Recovery.Update accountRecoveryUpdate = 206

  • Account.JsonApiStatus accountJsonApiStatus = 207

  • Object.Details.Set objectDetailsSet = 16

  • Object.Details.Amend objectDetailsAmend = 50

  • Object.Details.Unset objectDetailsUnset = 51

  • Object.Relations.Amend objectRelationsAmend = 52

  • Object.Relations.Remove objectRelationsRemove = 53

  • Object.Remove objectRemove = 54

  • Object.Close objectClose = 65

  • Object.Restrictions.Set objectRestrictionsSet = 55

  • Object.Subscription.Add subscriptionAdd = 60

  • Object.Subscription.Remove subscriptionRemove = 61

  • Object.Subscription.Position subscriptionPosition = 62

  • Object.Subscription.Counters subscriptionCounters = 63

  • Object.Subscription.Groups subscriptionGroups = 64

  • Block.Add blockAdd = 2

  • Block.Delete blockDelete = 3

  • Block.FilesUpload filesUpload = 4

  • Block.MarksInfo marksInfo = 5

  • Block.Set.Fields blockSetFields = 6

  • Block.Set.ChildrenIds blockSetChildrenIds = 7

  • Block.Set.Restrictions blockSetRestrictions = 8

  • Block.Set.BackgroundColor blockSetBackgroundColor = 9

  • Block.Set.Text blockSetText = 10

  • Block.Set.File blockSetFile = 11

  • Block.Set.Link blockSetLink = 13

  • Block.Set.Bookmark blockSetBookmark = 14

  • Block.Set.Align blockSetAlign = 15

  • Block.Set.Div blockSetDiv = 17

  • Block.Set.Relation blockSetRelation = 21

  • Block.Set.Latex blockSetLatex = 25

  • Block.Set.VerticalAlign blockSetVerticalAlign = 36

  • Block.Set.TableRow blockSetTableRow = 37

  • Block.Set.Widget blockSetWidget = 40

  • Block.Dataview.ViewSet blockDataviewViewSet = 19

  • Block.Dataview.ViewDelete blockDataviewViewDelete = 20

  • Block.Dataview.ViewOrder blockDataviewViewOrder = 29

  • Block.Dataview.SourceSet blockDataviewSourceSet = 35

    deprecated, source is no longer used

  • Block.Dataview.GroupOrderUpdate blockDataViewGroupOrderUpdate = 38

  • Block.Dataview.ObjectOrderUpdate blockDataViewObjectOrderUpdate = 39

  • Block.Dataview.RelationDelete blockDataviewRelationDelete = 124

  • Block.Dataview.RelationSet blockDataviewRelationSet = 123

  • Block.Dataview.ViewUpdate blockDataviewViewUpdate = 125

  • Block.Dataview.TargetObjectIdSet blockDataviewTargetObjectIdSet = 126

  • Block.Dataview.IsCollectionSet blockDataviewIsCollectionSet = 127

  • Block.Dataview.OldRelationDelete blockDataviewOldRelationDelete = 24

    deprecated

  • Block.Dataview.OldRelationSet blockDataviewOldRelationSet = 23

    deprecated

  • User.Block.Join userBlockJoin = 31

  • User.Block.Left userBlockLeft = 32

  • User.Block.SelectRange userBlockSelectRange = 33

  • User.Block.TextRange userBlockTextRange = 34

  • Ping ping = 100

  • Process.New processNew = 101

  • Process.Update processUpdate = 102

  • Process.Done processDone = 103

  • Status.Thread threadStatus = 110

  • File.LimitReached fileLimitReached = 111

  • File.SpaceUsage fileSpaceUsage = 112

  • File.LocalUsage fileLocalUsage = 113

  • File.LimitUpdated fileLimitUpdated = 118

  • Notification.Send notificationSend = 114

  • Notification.Update notificationUpdate = 115

  • Payload.Broadcast payloadBroadcast = 116

  • Membership.Update membershipUpdate = 117

  • Membership.TiersUpdate membershipTiersUpdate = 137

  • Space.SyncStatus.Update spaceSyncStatusUpdate = 119

  • P2PStatus.Update p2pStatusUpdate = 120

  • Import.Finish importFinish = 121

  • Chat.Add chatAdd = 128

  • Chat.Update chatUpdate = 129

  • Chat.UpdateReactions chatUpdateReactions = 130

  • Chat.UpdateMessageReadStatus chatUpdateMessageReadStatus = 134

    received to update per-message read status (if needed to

  • Chat.UpdateMentionReadStatus chatUpdateMentionReadStatus = 135

    highlight the unread messages in the UI)

    received to update per-message mention read status (if needed

  • Chat.UpdateMessageSyncStatus chatUpdateMessageSyncStatus = 136

    to highlight the unread mentions in the UI)

  • Chat.UpdatePinnedStatus chatUpdatePinnedStatus = 140

  • Chat.UpdateReactionReadStatus chatUpdateReactionReadStatus = 141

  • Object.AutoArchive objectAutoArchive = 142

  • Object.AutoRestore objectAutoRestore = 143

  • Object.CleanupSuggestion objectCleanupSuggestion = 146

  • Debug.ProfileCreated debugProfileCreated = 145

  • Chat.UpdateMessageCount chatUpdateMessageCount = 144

    received whenever the total number of non-deleted messages in

  • Chat.Delete chatDelete = 131

  • Chat.UpdateState chatStateUpdate = 133

    in case new unread messages received or chat state changed

  • MembershipV2.Update membershipV2Update = 138

  • MembershipV2.ProductsUpdate membershipV2ProductsUpdate = 139

  • Import.Statistic importStatistic = 147

  • Pubsub.Message pubsubMessage = 148

(message has no fields)

Used in: Message

• optional model.Notification notification = 1

Used in: Message

• optional model.Notification notification = 1

(message has no fields)

Used in: Message

• repeated string objectIds = 1

Used in: Message

• repeated string objectIds = 1

Used in: Message

• repeated string objectIds = 1

  orphan ids (objects at any level + files at level >= 2) created within contextId

• string contextId = 2

  the object that was archived / deleted / had a link removed

• CleanupSuggestion.Trigger trigger = 3

Used in: CleanupSuggestion

• archive = 0

• delete = 1

• linkRemoval = 2

Used in: Message

• string id = 1

(message has no fields)

Amend (i.e. add a new key-value pair or update an existing key-value pair) existing state

Used in: Message

• string id = 1

  context objectId

• repeated Amend.KeyValue details = 2

  slice of changed key-values

• repeated string subIds = 3

Used in: Amend

• string key = 1

• optional google.protobuf.Value value = 2

  should not be null

Overwrite current state

Used in: Message

• string id = 1

  context objectId

• optional google.protobuf.Struct details = 2

  can not be a partial state. Should replace client details

• repeated string subIds = 3

  state

Unset existing detail keys

Used in: Message

• string id = 1

  context objectId

• repeated string keys = 2

• repeated string subIds = 3

(message has no fields)

Used in: Message

• string id = 1

  context objectId

• repeated model.RelationLink relationLinks = 2

Used in: Message

• string id = 1

  context objectId

• repeated string relationKeys = 2

Used in: Message

• repeated string ids = 1

  notifies that objects were removed

(message has no fields)

Used in: Message

• string id = 1

• optional model.Restrictions restrictions = 2

(message has no fields)

Adds new document to subscriptions

Used in: Message

• string id = 1

  object id

• string afterId = 2

  id of previous doc in order, empty means first

• string subId = 3

  subscription id

Used in: Message

• int64 total = 1

  total available records

• int64 nextCount = 2

  how many records available after

• int64 prevCount = 3

  how many records available before

• string subId = 4

  subscription id

Used in: Message

• string subId = 1

• optional model.Block.Content.Dataview.Group group = 2

• bool remove = 3

Indicates new position of document

Used in: Message

• string id = 1

  object id

• string afterId = 2

  id of previous doc in order, empty means first

• string subId = 3

  subscription id

Removes document from subscription

Used in: Message

• string id = 1

  object id

• string subId = 2

  subscription id

(message has no fields)

Used in: Update

• NotConnected = 0

• NotPossible = 1

• Connected = 2

• Restricted = 3

  only for ios for now, fallback to NotPossible if not

Used in: Message

• string spaceId = 1

• Status status = 2

• int64 devicesCounter = 3

(message has no fields)

Used in: Message

• string payload = 1

Used in: Message

• int32 index = 1

(message has no fields)

Used in: Message

• optional Model.Process process = 1

Used in: Message

• optional Model.Process process = 1

Used in: Message

• optional Model.Process process = 1

(message has no fields)

Message is one decrypted, signature-verified pub/sub message received on a topic matching at least one active Rpc.Pubsub.Subscribe subscription. The space is carried by Event.Message.spaceId. Delivery is ephemeral, at-most-once: messages published while not subscribed are never seen.

Used in: Message

• string topic = 1

  topic is the concrete '/'-separated topic the message was published to

• bytes payload = 2

  payload is the application payload, decrypted with the space read key

• string identity = 3

  identity is the signature-verified account id of the sender; a client also receives its own published messages back (local echo)

• repeated string subIds = 4

  subIds are the local subscription ids whose pattern matched the topic

(message has no fields)

Used in: SyncStatus.Update

• Anytype = 0

• SelfHost = 1

• LocalOnly = 2

Used in: SyncStatus.Update

• Synced = 0

• Syncing = 1

• Error = 2

• Offline = 3

• NetworkNeedsUpdate = 4

Used in: SyncStatus.Update

• Null = 0

• StorageLimitExceed = 1

• IncompatibleVersion = 2

• NetworkError = 3

(message has no fields)

Used in: Message

• string id = 1

• Status status = 2

• Network network = 3

• SyncError error = 4

• int64 syncingObjectsCounter = 5

• int64 notSyncedFilesCounter = 6

• int64 uploadingFilesCounter = 7

(message has no fields)

Used in: Message

• optional Thread.Summary summary = 1

• optional Thread.Cafe cafe = 2

• repeated Thread.Account accounts = 3

Used in: Thread

• string id = 1

• string name = 2

• string imageHash = 3

• bool online = 4

• int64 lastPulled = 5

• int64 lastEdited = 6

• repeated Device devices = 7

Used in: Thread

• SyncStatus status = 1

• int64 lastPulled = 2

• bool lastPushSucceed = 3

• optional Cafe.PinStatus files = 4

Used in: Cafe

• int32 pinning = 1

• int32 pinned = 2

• int32 failed = 3

• int64 updated = 4

Used in: Account

• string name = 1

• bool online = 2

• int64 lastPulled = 3

• int64 lastEdited = 4

Used in: Thread

• SyncStatus status = 1

Used in: Cafe, Summary

• Unknown = 0

• Offline = 1

• Syncing = 2

• Synced = 3

• Failed = 4

• IncompatibleVersion = 5

• NetworkNeedsUpdate = 6

(message has no fields)

(message has no fields)

* Middleware to front end event message, that will be sent in this scenario: Precondition: user A opened a block 1. User B opens the same block 2. User A receives a message about p.1

Used in: Message

• optional Account account = 1

  Account of the user, that opened a block

* Middleware to front end event message, that will be sent in this scenario: Precondition: user A and user B opened the same block 1. User B closes the block 2. User A receives a message about p.1

Used in: Message

• optional Account account = 1

  Account of the user, that left the block

* Middleware to front end event message, that will be sent in this scenario: Precondition: user A and user B opened the same block 1. User B selects some inner blocks 2. User A receives a message about p.1

Used in: Message

• optional Account account = 1

  Account of the user, that selected blocks

• repeated string blockIdsArray = 2

  Ids of selected blocks.

* Middleware to front end event message, that will be sent in this scenario: Precondition: user A and user B opened the same block 1. User B sets cursor or selects a text region into a text block 2. User A receives a message about p.1

Used in: Message

• optional Account account = 1

  Account of the user, that selected a text

• string blockId = 2

  Id of the text block, that have a selection

• optional model.Range range = 3

  Range of the selection

Used in: DocumentModify

• repeated string keyPath = 1

  key path; example: [user, email]

• ModifyOp modifyOp = 3

  modify op: set, unset, inc, etc.

• string modifyValue = 4

  json value; example: '"new@email.com"'

(message has no fields)

Used in: Event.Process.Done, Event.Process.New, Event.Process.Update

• string id = 1

• Process.State state = 3

• optional Process.Progress progress = 4

• string spaceId = 5

• oneof message

  • Process.DropFiles dropFiles = 6

  • Process.Import import = 7

  • Process.Export export = 8

  • Process.SaveFile saveFile = 9

  • Process.Migration migration = 10

  • Process.PreloadFile preloadFile = 12

• string error = 11

Used in: Process

(message has no fields)

Used in: Process

(message has no fields)

Used in: Process

(message has no fields)

Used in: Process

(message has no fields)

Used in: Process

(message has no fields)

Used in: Process

• int64 total = 1

• int64 done = 2

• string message = 3

Used in: Process

(message has no fields)

Used in: Process

• None = 0

• Running = 1

• Done = 2

• Canceled = 3

• Error = 4

Used in: KeyModify

• Set = 0

• Unset = 1

• Inc = 2

• AddToSet = 3

• Pull = 4

• string name = 1

• string avatar = 2

• string address = 4

• string spaceDashboardId = 5

  aka homepage

• string profileId = 6

• string analyticsId = 7

• string startingPage = 8

  deprecated

• repeated WidgetBlock widgets = 9

• repeated Event.Message messages = 1

• string contextId = 2

• string traceId = 4

• model.SmartBlockType sbType = 1

• optional Change.Snapshot snapshot = 2

• repeated StoreChangeContent changeSet = 1

Used in: StoreChange

• oneof change

  • DocumentCreate create = 1

  • DocumentModify modify = 2

  • DocumentDelete delete = 3

Used in: Profile

• model.Block.Content.Widget.Layout layout = 1

• string targetObjectId = 2

• int32 objectLimit = 3