Protocol Documentation
Table of Contents
Top
pb/protos/service/service.proto
ClientCommands
Top
pb/protos/changes.proto
Change
the element of change tree used to store and internal apply smartBlock history
| Field |
Type |
Label |
Description |
| previous_ids |
string |
repeated |
ids of previous changes |
| last_snapshot_id |
string |
|
id of the last snapshot |
| previous_meta_ids |
string |
repeated |
ids of the last changes with details/relations content |
| content |
Change.Content |
repeated |
set of actions to apply |
| snapshot |
Change.Snapshot |
|
snapshot - when not null, the Content will be ignored |
| fileKeys |
Change.FileKeys |
repeated |
file keys related to changes content |
| timestamp |
int64 |
|
creation timestamp |
Change.BlockCreate
Change.BlockDuplicate
Change.BlockMove
Change.BlockRemove
| Field |
Type |
Label |
Description |
| ids |
string |
repeated |
|
Change.BlockUpdate
Change.Content
Change.DetailsSet
Change.DetailsUnset
| Field |
Type |
Label |
Description |
| key |
string |
|
|
Change.FileKeys
Change.FileKeys.KeysEntry
Change.ObjectTypeAdd
| Field |
Type |
Label |
Description |
| url |
string |
|
|
Change.ObjectTypeRemove
| Field |
Type |
Label |
Description |
| url |
string |
|
|
Change.RelationAdd
Change.RelationRemove
| Field |
Type |
Label |
Description |
| key |
string |
|
|
Change.RelationUpdate
Change.RelationUpdate.Dict
Change.RelationUpdate.ObjectTypes
| Field |
Type |
Label |
Description |
| objectTypes |
string |
repeated |
|
Change.Snapshot
Change.Snapshot.LogHeadsEntry
Change.StoreKeySet
Change.StoreKeyUnset
| Field |
Type |
Label |
Description |
| path |
string |
repeated |
|
Top
pb/protos/commands.proto
Empty
Rpc
Rpc is a namespace, that agregates all of the service commands between client and middleware.
Structure: Topic > Subtopic > Subsub... > Action > (Request, Response).
Request – message from a client.
Response – message from a middleware.
Rpc.Account
Namespace, that agregates subtopics and actions, that relates to account.
Rpc.Account.Config
Rpc.Account.Create
Rpc.Account.Create.Request
Front end to middleware request-to-create-an account
| Field |
Type |
Label |
Description |
| name |
string |
|
Account name |
| avatarLocalPath |
string |
|
Path to an image, that will be used as an avatar of this account |
| alphaInviteCode |
string |
|
|
Rpc.Account.Create.Response
Middleware-to-front-end response for an account creation request, that can contain a NULL error and created account or a non-NULL error and an empty account
Rpc.Account.Create.Response.Error
Rpc.Account.Recover
Rpc.Account.Recover.Request
Front end to middleware request-to-start-search of an accounts for a recovered mnemonic.
Each of an account that would be found will come with an AccountAdd event
Rpc.Account.Recover.Response
Middleware-to-front-end response to an account recover request, that can contain a NULL error and created account or a non-NULL error and an empty account
Rpc.Account.Recover.Response.Error
Rpc.Account.Select
Rpc.Account.Select.Request
Front end to middleware request-to-launch-a specific account using account id and a root path
User can select an account from those, that came with an AccountAdd events
| Field |
Type |
Label |
Description |
| id |
string |
|
Id of a selected account |
| rootPath |
string |
|
Root path is optional, set if this is a first request |
Rpc.Account.Select.Response
Middleware-to-front-end response for an account select request, that can contain a NULL error and selected account or a non-NULL error and an empty account
Rpc.Account.Select.Response.Error
Rpc.Account.Stop
Rpc.Account.Stop.Request
Front end to middleware request to stop currently running account node and optionally remove the locally stored data
| Field |
Type |
Label |
Description |
| removeData |
bool |
|
|
Rpc.Account.Stop.Response
Middleware-to-front-end response for an account stop request
Rpc.Account.Stop.Response.Error
Rpc.ApplyTemplate
Rpc.ApplyTemplate.Request
| Field |
Type |
Label |
Description |
| contextId |
string |
|
|
| templateId |
string |
|
id of template |
Rpc.ApplyTemplate.Response
Rpc.ApplyTemplate.Response.Error
Rpc.Block
Namespace, that agregates subtopics and actions, that relates to blocks.
Rpc.Block.Bookmark
Rpc.Block.Bookmark.CreateAndFetch
Rpc.Block.Bookmark.CreateAndFetch.Request
Rpc.Block.Bookmark.CreateAndFetch.Response
Rpc.Block.Bookmark.CreateAndFetch.Response.Error
Rpc.Block.Bookmark.Fetch
Rpc.Block.Bookmark.Fetch.Request
Rpc.Block.Bookmark.Fetch.Response
Rpc.Block.Bookmark.Fetch.Response.Error
Rpc.Block.Close
Block.Close – it means unsubscribe from a block.
Precondition: block should be opened.
Rpc.Block.Close.Request
| Field |
Type |
Label |
Description |
| contextId |
string |
|
id of the context blo1k |
| blockId |
string |
|
|
Rpc.Block.Close.Response
Rpc.Block.Close.Response.Error
Rpc.Block.Copy
Rpc.Block.Copy.Request
Rpc.Block.Copy.Response
Rpc.Block.Copy.Response.Error
Rpc.Block.Create
Create a Smart/Internal block. Request can contain a block with a content, or it can be an empty block with a specific block.content.
Example scenario
1A. Create Page on a dashboard
1. Front -> MW: Rpc.Block.Create.Request(blockId:dashboard.id, position:bottom, block: emtpy block with page content and id = "")
2. Front -> MW: Rpc.Block.Close.Request(block: dashboard.id)
3. Front <- MW: Rpc.Block.Close.Response(err)
4. Front <- MW: Rpc.Block.Create.Response(page.id)
5. Front <- MW: Rpc.Block.Open.Response(err)
6. Front <- MW: Event.Block.Show(page)
1B. Create Page on a Page
1. Front -> MW: Rpc.Block.Create.Request(blockId:dashboard.id, position:bottom, block: emtpy block with page content and id = "")
2. Front <- MW: Rpc.Block.Create.Response(newPage.id)
3. Front <- MW: Event.Block.Show(newPage)
Rpc.Block.Create.Request
common simple block command
Rpc.Block.Create.Response
Rpc.Block.Create.Response.Error
Rpc.Block.CreatePage
Rpc.Block.CreatePage.Request
| Field |
Type |
Label |
Description |
| contextId |
string |
|
id of the context block |
| details |
google.protobuf.Struct |
|
new page details |
| templateId |
string |
|
optional template id for creating from template |
| targetId |
string |
|
link block params |
id of the closest simple block |
| position | model.Block.Position | | |
| fields | google.protobuf.Struct | | link block fields |
Rpc.Block.CreatePage.Response
Rpc.Block.CreatePage.Response.Error
Rpc.Block.CreateSet
Rpc.Block.CreateSet.Request
Rpc.Block.CreateSet.Response
Rpc.Block.CreateSet.Response.Error
Rpc.Block.Cut
Rpc.Block.Cut.Request
Rpc.Block.Cut.Response
Rpc.Block.Cut.Response.Error
Rpc.Block.Dataview
Rpc.Block.Dataview.RecordCreate
Rpc.Block.Dataview.RecordCreate.Request
Rpc.Block.Dataview.RecordCreate.Response
Rpc.Block.Dataview.RecordCreate.Response.Error
Rpc.Block.Dataview.RecordDelete
Rpc.Block.Dataview.RecordDelete.Request
Rpc.Block.Dataview.RecordDelete.Response
Rpc.Block.Dataview.RecordDelete.Response.Error
Rpc.Block.Dataview.RecordRelationOptionAdd
RecordRelationOptionAdd may return existing option in case object specified with recordId already have the option with the same name or ID
Rpc.Block.Dataview.RecordRelationOptionAdd.Request
| Field |
Type |
Label |
Description |
| contextId |
string |
|
|
| blockId |
string |
|
id of dataview block to add relation |
| relationKey |
string |
|
relation key to add the option |
| option |
model.Relation.Option |
|
id of select options will be autogenerated |
| recordId |
string |
|
id of record which is used to add an option |
Rpc.Block.Dataview.RecordRelationOptionAdd.Response
Rpc.Block.Dataview.RecordRelationOptionAdd.Response.Error
Rpc.Block.Dataview.RecordRelationOptionDelete
Rpc.Block.Dataview.RecordRelationOptionDelete.Request
| Field |
Type |
Label |
Description |
| contextId |
string |
|
|
| blockId |
string |
|
id of dataview block to add relation |
| relationKey |
string |
|
relation key to add the option |
| optionId |
string |
|
id of select options to remove |
| recordId |
string |
|
id of record which is used to delete an option |
Rpc.Block.Dataview.RecordRelationOptionDelete.Response
Rpc.Block.Dataview.RecordRelationOptionDelete.Response.Error
Rpc.Block.Dataview.RecordRelationOptionUpdate
Rpc.Block.Dataview.RecordRelationOptionUpdate.Request
| Field |
Type |
Label |
Description |
| contextId |
string |
|
|
| blockId |
string |
|
id of dataview block to add relation |
| relationKey |
string |
|
relation key to add the option |
| option |
model.Relation.Option |
|
id of select options will be autogenerated |
| recordId |
string |
|
id of record which is used to update an option |
Rpc.Block.Dataview.RecordRelationOptionUpdate.Response
Rpc.Block.Dataview.RecordRelationOptionUpdate.Response.Error
Rpc.Block.Dataview.RecordUpdate
Rpc.Block.Dataview.RecordUpdate.Request
Rpc.Block.Dataview.RecordUpdate.Response
Rpc.Block.Dataview.RecordUpdate.Response.Error
Rpc.Block.Dataview.RelationAdd
Rpc.Block.Dataview.RelationAdd.Request
Rpc.Block.Dataview.RelationAdd.Response
Rpc.Block.Dataview.RelationAdd.Response.Error
Rpc.Block.Dataview.RelationDelete
Rpc.Block.Dataview.RelationDelete.Request
| Field |
Type |
Label |
Description |
| contextId |
string |
|
|
| blockId |
string |
|
id of dataview block to add relation |
| relationKey |
string |
|
|
Rpc.Block.Dataview.RelationDelete.Response
Rpc.Block.Dataview.RelationDelete.Response.Error
Rpc.Block.Dataview.RelationListAvailable
Rpc.Block.Dataview.RelationListAvailable.Request
| Field |
Type |
Label |
Description |
| contextId |
string |
|
|
| blockId |
string |
|
|
Rpc.Block.Dataview.RelationListAvailable.Response
Rpc.Block.Dataview.RelationListAvailable.Response.Error
Rpc.Block.Dataview.RelationUpdate
Rpc.Block.Dataview.RelationUpdate.Request
| Field |
Type |
Label |
Description |
| contextId |
string |
|
|
| blockId |
string |
|
id of dataview block to add relation |
| relationKey |
string |
|
key of relation to update |
| relation |
model.Relation |
|
|
Rpc.Block.Dataview.RelationUpdate.Response
Rpc.Block.Dataview.RelationUpdate.Response.Error
Rpc.Block.Dataview.SetSource
Rpc.Block.Dataview.SetSource.Request
Rpc.Block.Dataview.SetSource.Response
Rpc.Block.Dataview.SetSource.Response.Error
Rpc.Block.Dataview.ViewCreate
Rpc.Block.Dataview.ViewCreate.Request
Rpc.Block.Dataview.ViewCreate.Response
Rpc.Block.Dataview.ViewCreate.Response.Error
Rpc.Block.Dataview.ViewDelete
Rpc.Block.Dataview.ViewDelete.Request
| Field |
Type |
Label |
Description |
| contextId |
string |
|
id of the context block |
| blockId |
string |
|
id of the dataview |
| viewId |
string |
|
id of the view to remove |
Rpc.Block.Dataview.ViewDelete.Response
Rpc.Block.Dataview.ViewDelete.Response.Error
Rpc.Block.Dataview.ViewSetActive
set the current active view (persisted only within a session)
Rpc.Block.Dataview.ViewSetActive.Request
Rpc.Block.Dataview.ViewSetActive.Response
Rpc.Block.Dataview.ViewSetActive.Response.Error
Rpc.Block.Dataview.ViewSetPosition
Rpc.Block.Dataview.ViewSetPosition.Request
| Field |
Type |
Label |
Description |
| contextId |
string |
|
id of the context block |
| blockId |
string |
|
id of the dataview |
| viewId |
string |
|
id of the view to remove |
| position |
uint32 |
|
index of view position (0 - means first) |
Rpc.Block.Dataview.ViewSetPosition.Response
Rpc.Block.Dataview.ViewSetPosition.Response.Error
Rpc.Block.Dataview.ViewUpdate
Rpc.Block.Dataview.ViewUpdate.Request
Rpc.Block.Dataview.ViewUpdate.Response
Rpc.Block.Dataview.ViewUpdate.Response.Error
Rpc.Block.Download
Rpc.Block.Download.Request
| Field |
Type |
Label |
Description |
| contextId |
string |
|
|
| blockId |
string |
|
|
Rpc.Block.Download.Response
Rpc.Block.Download.Response.Error
Rpc.Block.Export
Rpc.Block.Export.Request
Rpc.Block.Export.Response
Rpc.Block.Export.Response.Error
Rpc.Block.File
Rpc.Block.File.CreateAndUpload
Rpc.Block.File.CreateAndUpload.Request
Rpc.Block.File.CreateAndUpload.Response
Rpc.Block.File.CreateAndUpload.Response.Error
Rpc.Block.Get
Rpc.Block.Get.Marks
Get marks list in the selected range in text block.
Rpc.Block.Get.Marks.Request
Rpc.Block.Get.Marks.Response
Rpc.Block.Get.Marks.Response.Error
Rpc.Block.GetPublicWebURL
Rpc.Block.GetPublicWebURL.Request
| Field |
Type |
Label |
Description |
| blockId |
string |
|
|
Rpc.Block.GetPublicWebURL.Response
Rpc.Block.GetPublicWebURL.Response.Error
Rpc.Block.ImportMarkdown
Rpc.Block.ImportMarkdown.Request
| Field |
Type |
Label |
Description |
| contextId |
string |
|
|
| importPath |
string |
|
|
Rpc.Block.ImportMarkdown.Response
Rpc.Block.ImportMarkdown.Response.Error
Rpc.Block.Merge
Rpc.Block.Merge.Request
Rpc.Block.Merge.Response
Rpc.Block.Merge.Response.Error
Rpc.Block.ObjectType
Rpc.Block.ObjectType.Set
Rpc.Block.ObjectType.Set.Request
| Field |
Type |
Label |
Description |
| contextId |
string |
|
|
| objectTypeUrl |
string |
|
|
Rpc.Block.ObjectType.Set.Response
Rpc.Block.ObjectType.Set.Response.Error
Rpc.Block.Open
Works with a smart blocks (block-organizers, like page, dashboard etc)
Example scenario
1A. On front-end start.
1. Front -> MW: Rpc.Block.Open.Request(dashboard.id)
2. MW -> Front: BlockShow(dashboard)
3. MW -> Front: Rpc.Block.Open.Response(err)
1B. User clicks on a page icon on the dashboard.
1. Front -> MW: Rpc.Block.Close.Request(dashboard.id)
Get close response first, then open request:
2. MW -> Front: Rpc.Block.Close.Response(err)
3. Front -> MW: Rpc.Block.Open.Request(page.id)
4. MW -> Front: BlockShow(<page, blocks>)
5. MW -> Front: Rpc.Block.Open.Response(err)
Image/Video/File blocks then:
6. MW -> Front: BlockShow(<blocks>)
Rpc.Block.Open.Request
| Field |
Type |
Label |
Description |
| contextId |
string |
|
id of the context blo1k |
| blockId |
string |
|
|
| traceId |
string |
|
|
Rpc.Block.Open.Response
Rpc.Block.Open.Response.Error
Rpc.Block.OpenBreadcrumbs
Rpc.Block.OpenBreadcrumbs.Request
| Field |
Type |
Label |
Description |
| contextId |
string |
|
id of the context blo1k |
| traceId |
string |
|
|
Rpc.Block.OpenBreadcrumbs.Response
Rpc.Block.OpenBreadcrumbs.Response.Error
Rpc.Block.Paste
Rpc.Block.Paste.Request
Rpc.Block.Paste.Request.File
Rpc.Block.Paste.Response
Rpc.Block.Paste.Response.Error
Rpc.Block.Redo
Rpc.Block.Redo.Request
| Field |
Type |
Label |
Description |
| contextId |
string |
|
id of the context block |
Rpc.Block.Redo.Response
Rpc.Block.Redo.Response.Error
Rpc.Block.Relation
Rpc.Block.Relation.Add
Rpc.Block.Relation.Add.Request
Rpc.Block.Relation.Add.Response
Rpc.Block.Relation.Add.Response.Error
Rpc.Block.Relation.SetKey
Rpc.Block.Relation.SetKey.Request
Rpc.Block.Relation.SetKey.Response
Rpc.Block.Relation.SetKey.Response.Error
Rpc.Block.Replace
Rpc.Block.Replace.Request
Rpc.Block.Replace.Response
Rpc.Block.Replace.Response.Error
Rpc.Block.Set
Rpc.Block.Set.Details
Rpc.Block.Set.Details.Detail
Rpc.Block.Set.Details.Request
Rpc.Block.Set.Details.Response
Rpc.Block.Set.Details.Response.Error
Rpc.Block.Set.Fields
Rpc.Block.Set.Fields.Request
Rpc.Block.Set.Fields.Response
Rpc.Block.Set.Fields.Response.Error
Rpc.Block.Set.File
Rpc.Block.Set.File.Name
Rpc.Block.Set.File.Name.Request
Rpc.Block.Set.File.Name.Response
Rpc.Block.Set.File.Name.Response.Error
Rpc.Block.Set.Image
Rpc.Block.Set.Image.Name
Rpc.Block.Set.Image.Name.Request
Rpc.Block.Set.Image.Name.Response
Rpc.Block.Set.Image.Name.Response.Error
Rpc.Block.Set.Image.Width
Rpc.Block.Set.Image.Width.Request
Rpc.Block.Set.Image.Width.Response
Rpc.Block.Set.Image.Width.Response.Error
Rpc.Block.Set.Latex
Rpc.Block.Set.Latex.Text
Rpc.Block.Set.Latex.Text.Request
Rpc.Block.Set.Latex.Text.Response
Rpc.Block.Set.Latex.Text.Response.Error
Rpc.Block.Set.Link
Rpc.Block.Set.Link.TargetBlockId
Rpc.Block.Set.Link.TargetBlockId.Request
Rpc.Block.Set.Link.TargetBlockId.Response
Rpc.Block.Set.Link.TargetBlockId.Response.Error
Rpc.Block.Set.Page
Rpc.Block.Set.Page.IsArchived
Rpc.Block.Set.Page.IsArchived.Request
Rpc.Block.Set.Page.IsArchived.Response
Rpc.Block.Set.Page.IsArchived.Response.Error
Rpc.Block.Set.Restrictions
Rpc.Block.Set.Restrictions.Request
Rpc.Block.Set.Restrictions.Response
Rpc.Block.Set.Restrictions.Response.Error
Rpc.Block.Set.Text
Rpc.Block.Set.Text.Checked
Rpc.Block.Set.Text.Checked.Request
Rpc.Block.Set.Text.Checked.Response
Rpc.Block.Set.Text.Checked.Response.Error
Rpc.Block.Set.Text.Color
Rpc.Block.Set.Text.Color.Request
Rpc.Block.Set.Text.Color.Response
Rpc.Block.Set.Text.Color.Response.Error
Rpc.Block.Set.Text.Icon
Rpc.Block.Set.Text.Icon.Request
| Field |
Type |
Label |
Description |
| contextId |
string |
|
|
| blockId |
string |
|
|
| iconImage |
string |
|
in case both image and emoji are set, image has a priority to show |
| iconEmoji |
string |
|
|
Rpc.Block.Set.Text.Icon.Response
Rpc.Block.Set.Text.Icon.Response.Error
Rpc.Block.Set.Text.Style
Rpc.Block.Set.Text.Style.Request
Rpc.Block.Set.Text.Style.Response
Rpc.Block.Set.Text.Style.Response.Error
Rpc.Block.Set.Text.Text
Rpc.Block.Set.Text.Text.Request
Rpc.Block.Set.Text.Text.Response
Rpc.Block.Set.Text.Text.Response.Error
Rpc.Block.Set.Video
Rpc.Block.Set.Video.Name
Rpc.Block.Set.Video.Name.Request
Rpc.Block.Set.Video.Name.Response
Rpc.Block.Set.Video.Name.Response.Error
Rpc.Block.Set.Video.Width
Rpc.Block.Set.Video.Width.Request
Rpc.Block.Set.Video.Width.Response
Rpc.Block.Set.Video.Width.Response.Error
Rpc.Block.SetBreadcrumbs
Rpc.Block.SetBreadcrumbs.Request
| Field |
Type |
Label |
Description |
| breadcrumbsId |
string |
|
|
| ids |
string |
repeated |
page ids |
Rpc.Block.SetBreadcrumbs.Response
Rpc.Block.SetBreadcrumbs.Response.Error
Rpc.Block.Show
Rpc.Block.Show.Request
| Field |
Type |
Label |
Description |
| contextId |
string |
|
id of the context blo1k |
| blockId |
string |
|
|
| traceId |
string |
|
|
Rpc.Block.Show.Response
Rpc.Block.Show.Response.Error
Rpc.Block.Split
Rpc.Block.Split.Request
Rpc.Block.Split.Response
Rpc.Block.Split.Response.Error
Rpc.Block.Undo
Rpc.Block.Undo.Request
| Field |
Type |
Label |
Description |
| contextId |
string |
|
id of the context block |
Rpc.Block.Undo.Response
Rpc.Block.Undo.Response.Error
Rpc.Block.UndoRedoCounter
Available undo/redo operations
| Field |
Type |
Label |
Description |
| undo |
int32 |
|
|
| redo |
int32 |
|
|
Rpc.Block.Unlink
Remove blocks from the childrenIds of its parents
Rpc.Block.Unlink.Request
| Field |
Type |
Label |
Description |
| contextId |
string |
|
id of the context block |
| blockIds |
string |
repeated |
targets to remove |
Rpc.Block.Unlink.Response
Rpc.Block.Unlink.Response.Error
Rpc.Block.UpdateContent
Rpc.Block.UpdateContent.Request
Rpc.Block.UpdateContent.Response
Rpc.Block.UpdateContent.Response.Error
Rpc.Block.Upload
Rpc.Block.Upload.Request
Rpc.Block.Upload.Response
Rpc.Block.Upload.Response.Error
Rpc.BlockList
Rpc.BlockList.ConvertChildrenToPages
Rpc.BlockList.ConvertChildrenToPages.Request
Rpc.BlockList.ConvertChildrenToPages.Response
Rpc.BlockList.ConvertChildrenToPages.Response.Error
Rpc.BlockList.Duplicate
Makes blocks copy by given ids and paste it to shown place
Rpc.BlockList.Duplicate.Request
| Field |
Type |
Label |
Description |
| contextId |
string |
|
id of the context block |
| targetId |
string |
|
id of the closest block |
| blockIds |
string |
repeated |
id of block for duplicate |
| position |
model.Block.Position |
|
|
Rpc.BlockList.Duplicate.Response
Rpc.BlockList.Duplicate.Response.Error
Rpc.BlockList.Move
Rpc.BlockList.Move.Request
| Field |
Type |
Label |
Description |
| contextId |
string |
|
|
| blockIds |
string |
repeated |
|
| targetContextId |
string |
|
|
| dropTargetId |
string |
|
id of the simple block to insert considering position |
| position |
model.Block.Position |
|
position relatively to the dropTargetId simple block |
Rpc.BlockList.Move.Response
Rpc.BlockList.Move.Response.Error
Rpc.BlockList.MoveToNewPage
Rpc.BlockList.MoveToNewPage.Request
Rpc.BlockList.MoveToNewPage.Response
Rpc.BlockList.MoveToNewPage.Response.Error
Rpc.BlockList.Set
Rpc.BlockList.Set.Align
Rpc.BlockList.Set.Align.Request
Rpc.BlockList.Set.Align.Response
Rpc.BlockList.Set.Align.Response.Error
Rpc.BlockList.Set.BackgroundColor
Rpc.BlockList.Set.BackgroundColor.Request
Rpc.BlockList.Set.BackgroundColor.Response
Rpc.BlockList.Set.BackgroundColor.Response.Error
Rpc.BlockList.Set.Div
Rpc.BlockList.Set.Div.Style
Rpc.BlockList.Set.Div.Style.Request
Rpc.BlockList.Set.Div.Style.Response
Rpc.BlockList.Set.Div.Style.Response.Error
Rpc.BlockList.Set.Fields
Rpc.BlockList.Set.Fields.Request
Rpc.BlockList.Set.Fields.Request.BlockField
Rpc.BlockList.Set.Fields.Response
Rpc.BlockList.Set.Fields.Response.Error
Rpc.BlockList.Set.File
Rpc.BlockList.Set.File.Style
Rpc.BlockList.Set.File.Style.Request
Rpc.BlockList.Set.File.Style.Response
Rpc.BlockList.Set.File.Style.Response.Error
Rpc.BlockList.Set.Text
commands acceptable only for text blocks, others will be ignored
Rpc.BlockList.Set.Text.Color
Rpc.BlockList.Set.Text.Color.Request
Rpc.BlockList.Set.Text.Color.Response
Rpc.BlockList.Set.Text.Color.Response.Error
Rpc.BlockList.Set.Text.Mark
Rpc.BlockList.Set.Text.Mark.Request
Rpc.BlockList.Set.Text.Mark.Response
Rpc.BlockList.Set.Text.Mark.Response.Error
Rpc.BlockList.Set.Text.Style
Rpc.BlockList.Set.Text.Style.Request
Rpc.BlockList.Set.Text.Style.Response
Rpc.BlockList.Set.Text.Style.Response.Error
Rpc.BlockList.TurnInto
Rpc.BlockList.TurnInto.Request
Rpc.BlockList.TurnInto.Response
Rpc.BlockList.TurnInto.Response.Error
Rpc.CloneTemplate
Rpc.CloneTemplate.Request
| Field |
Type |
Label |
Description |
| contextId |
string |
|
id of template block for cloning |
Rpc.CloneTemplate.Response
Rpc.CloneTemplate.Response.Error
Rpc.Config
Rpc.Config.Get
Rpc.Config.Get.Request
Rpc.Config.Get.Response
| Field |
Type |
Label |
Description |
| error |
Rpc.Config.Get.Response.Error |
|
|
| homeBlockId |
string |
|
home dashboard block id |
| archiveBlockId |
string |
|
archive block id |
| profileBlockId |
string |
|
profile block id |
| marketplaceTypeId |
string |
|
marketplace type id |
| marketplaceRelationId |
string |
|
marketplace relation id |
| marketplaceTemplateId |
string |
|
marketplace template id |
| deviceId |
string |
|
|
| gatewayUrl |
string |
|
gateway url for fetching static files |
Rpc.Config.Get.Response.Error
Rpc.Debug
Rpc.Debug.Sync
Rpc.Debug.Sync.Request
| Field |
Type |
Label |
Description |
| recordsTraverseLimit |
int32 |
|
0 means no limit |
| skipEmptyLogs |
bool |
|
do not set if you want the whole picture |
| tryToDownloadRemoteRecords |
bool |
|
if try we will try to download remote records in case missing |
Rpc.Debug.Sync.Response
Rpc.Debug.Sync.Response.Error
Rpc.Debug.Thread
Rpc.Debug.Thread.Request
| Field |
Type |
Label |
Description |
| threadId |
string |
|
|
| skipEmptyLogs |
bool |
|
do not set if you want the whole picture |
| tryToDownloadRemoteRecords |
bool |
|
if try we will try to download remote records in case missing |
Rpc.Debug.Thread.Response
Rpc.Debug.Thread.Response.Error
Rpc.Debug.Tree
Rpc.Debug.Tree.Request
| Field |
Type |
Label |
Description |
| blockId |
string |
|
|
| path |
string |
|
|
| unanonymized |
bool |
|
set to true to disable mocking of the actual data inside changes |
Rpc.Debug.Tree.Response
Rpc.Debug.Tree.Response.Error
Rpc.Debug.logInfo
Rpc.Debug.threadInfo
Rpc.DownloadFile
Rpc.DownloadFile.Request
| Field |
Type |
Label |
Description |
| hash |
string |
|
|
| path |
string |
|
path to save file. Temp directory is used if empty |
Rpc.DownloadFile.Response
Rpc.DownloadFile.Response.Error
Rpc.Export
Rpc.Export.Request
| Field |
Type |
Label |
Description |
| path |
string |
|
the path where export files will place |
| docIds |
string |
repeated |
ids of documents for export, when empty - will export all available docs |
| format |
Rpc.Export.Format |
|
export format |
| zip |
bool |
|
save as zip file |
| includeNested |
bool |
|
include all nested |
| includeFiles |
bool |
|
include all files |
Rpc.Export.Response
Rpc.Export.Response.Error
Rpc.ExportLocalstore
Rpc.ExportLocalstore.Request
| Field |
Type |
Label |
Description |
| path |
string |
|
the path where export files will place |
| docIds |
string |
repeated |
ids of documents for export, when empty - will export all available docs |
Rpc.ExportLocalstore.Response
Rpc.ExportLocalstore.Response.Error
Rpc.ExportTemplates
Rpc.ExportTemplates.Request
| Field |
Type |
Label |
Description |
| path |
string |
|
the path where export files will place |
Rpc.ExportTemplates.Response
Rpc.ExportTemplates.Response.Error
Rpc.ExportWorkspace
Rpc.ExportWorkspace.Request
| Field |
Type |
Label |
Description |
| path |
string |
|
the path where export files will place |
| workspaceId |
string |
|
|
Rpc.ExportWorkspace.Response
Rpc.ExportWorkspace.Response.Error
Rpc.ExternalDrop
Rpc.ExternalDrop.Content
Rpc.ExternalDrop.Content.Request
| Field |
Type |
Label |
Description |
| contextId |
string |
|
|
| focusedBlockId |
string |
|
can be null |
| content |
bytes |
|
TODO |
Rpc.ExternalDrop.Content.Response
Rpc.ExternalDrop.Content.Response.Error
Rpc.ExternalDrop.Files
Rpc.ExternalDrop.Files.Request
| Field |
Type |
Label |
Description |
| contextId |
string |
|
|
| dropTargetId |
string |
|
id of the simple block to insert considering position |
| position |
model.Block.Position |
|
position relatively to the dropTargetId simple block |
| localFilePaths |
string |
repeated |
|
Rpc.ExternalDrop.Files.Response
Rpc.ExternalDrop.Files.Response.Error
Rpc.File
Rpc.File.Offload
Rpc.File.Offload.Request
| Field |
Type |
Label |
Description |
| id |
string |
|
|
| includeNotPinned |
bool |
|
|
Rpc.File.Offload.Response
Rpc.File.Offload.Response.Error
Rpc.FileList
Rpc.FileList.Offload
Rpc.FileList.Offload.Request
| Field |
Type |
Label |
Description |
| onlyIds |
string |
repeated |
empty means all |
| includeNotPinned |
bool |
|
false mean not-yet-pinned files will be not |
Rpc.FileList.Offload.Response
Rpc.FileList.Offload.Response.Error
Rpc.GenericErrorResponse
Rpc.GenericErrorResponse.Error
Rpc.History
Rpc.History.SetVersion
Rpc.History.SetVersion.Request
Rpc.History.SetVersion.Response
Rpc.History.SetVersion.Response.Error
Rpc.History.Show
returns blockShow event for given version
Rpc.History.Show.Request
Rpc.History.Show.Response
Rpc.History.Show.Response.Error
Rpc.History.Versions
returns list of versions (changes)
Rpc.History.Versions.Request
| Field |
Type |
Label |
Description |
| pageId |
string |
|
|
| lastVersionId |
string |
|
when indicated, results will include versions before given id |
| limit |
int32 |
|
desired count of versions |
Rpc.History.Versions.Response
Rpc.History.Versions.Response.Error
Rpc.History.Versions.Version
Rpc.LinkPreview
Rpc.LinkPreview.Request
| Field |
Type |
Label |
Description |
| url |
string |
|
|
Rpc.LinkPreview.Response
Rpc.LinkPreview.Response.Error
Rpc.Log
Namespace, that agregates log subtopics and actions.
Usage: send request with topic (Level) and description (message) from client to middleware to log.
Rpc.Log.Send
Rpc.Log.Send.Request
Rpc.Log.Send.Response
Rpc.Log.Send.Response.Error
Rpc.MakeTemplate
Rpc.MakeTemplate.Request
| Field |
Type |
Label |
Description |
| contextId |
string |
|
id of block for making them template |
Rpc.MakeTemplate.Response
Rpc.MakeTemplate.Response.Error
Rpc.MakeTemplateByObjectType
Rpc.MakeTemplateByObjectType.Request
| Field |
Type |
Label |
Description |
| objectType |
string |
|
id of desired object type |
Rpc.MakeTemplateByObjectType.Response
Rpc.MakeTemplateByObjectType.Response.Error
Rpc.Metrics
Rpc.Metrics.SetParameters
Rpc.Metrics.SetParameters.Request
| Field |
Type |
Label |
Description |
| platform |
string |
|
|
Rpc.Metrics.SetParameters.Response
Rpc.Metrics.SetParameters.Response.Error
Rpc.Navigation
Rpc.Navigation.GetObjectInfoWithLinks
Get the info for page alongside with info for all inbound and outbound links from/to this page
Rpc.Navigation.GetObjectInfoWithLinks.Request
Rpc.Navigation.GetObjectInfoWithLinks.Response
Rpc.Navigation.GetObjectInfoWithLinks.Response.Error
Rpc.Navigation.ListObjects
Rpc.Navigation.ListObjects.Request
Rpc.Navigation.ListObjects.Response
Rpc.Navigation.ListObjects.Response.Error
Rpc.Object
Rpc.Object.AddWithObjectId
Rpc.Object.AddWithObjectId.Request
Rpc.Object.AddWithObjectId.Response
Rpc.Object.AddWithObjectId.Response.Error
Rpc.Object.FeaturedRelation
Rpc.Object.FeaturedRelation.Add
Rpc.Object.FeaturedRelation.Add.Request
| Field |
Type |
Label |
Description |
| contextId |
string |
|
|
| relations |
string |
repeated |
|
Rpc.Object.FeaturedRelation.Add.Response
Rpc.Object.FeaturedRelation.Add.Response.Error
Rpc.Object.FeaturedRelation.Remove
Rpc.Object.FeaturedRelation.Remove.Request
| Field |
Type |
Label |
Description |
| contextId |
string |
|
|
| relations |
string |
repeated |
|
Rpc.Object.FeaturedRelation.Remove.Response
Rpc.Object.FeaturedRelation.Remove.Response.Error
Rpc.Object.Graph
Rpc.Object.Graph.Edge
Rpc.Object.Graph.Node
Rpc.Object.Graph.Request
Rpc.Object.Graph.Response
Rpc.Object.Graph.Response.Error
Rpc.Object.IdsSubscribe
Rpc.Object.IdsSubscribe.Request
| Field |
Type |
Label |
Description |
| subId |
string |
|
(optional) subscription identifier client can provide some string or middleware will generate it automatically if subId is already registered on middleware, the new query will replace previous subscription |
| ids |
string |
repeated |
ids for subscribe |
| keys |
string |
repeated |
sorts (required) needed keys in details for return, for object fields mw will return (and subscribe) objects as dependent |
| ignoreWorkspace |
string |
|
|
Rpc.Object.IdsSubscribe.Response
Rpc.Object.IdsSubscribe.Response.Error
Rpc.Object.RelationAdd
Rpc.Object.RelationAdd.Request
Rpc.Object.RelationAdd.Response
Rpc.Object.RelationAdd.Response.Error
Rpc.Object.RelationDelete
Rpc.Object.RelationDelete.Request
| Field |
Type |
Label |
Description |
| contextId |
string |
|
|
| relationKey |
string |
|
|
Rpc.Object.RelationDelete.Response
Rpc.Object.RelationDelete.Response.Error
Rpc.Object.RelationListAvailable
Rpc.Object.RelationListAvailable.Request
| Field |
Type |
Label |
Description |
| contextId |
string |
|
|
Rpc.Object.RelationListAvailable.Response
Rpc.Object.RelationListAvailable.Response.Error
Rpc.Object.RelationOptionAdd
RelationOptionAdd may return existing option in case dataview already has one with the same text
Rpc.Object.RelationOptionAdd.Request
| Field |
Type |
Label |
Description |
| contextId |
string |
|
|
| relationKey |
string |
|
relation key to add the option |
| option |
model.Relation.Option |
|
id of select options will be autogenerated |
Rpc.Object.RelationOptionAdd.Response
Rpc.Object.RelationOptionAdd.Response.Error
Rpc.Object.RelationOptionDelete
Rpc.Object.RelationOptionDelete.Request
| Field |
Type |
Label |
Description |
| contextId |
string |
|
|
| relationKey |
string |
|
relation key to add the option |
| optionId |
string |
|
id of select options to remove |
| confirmRemoveAllValuesInRecords |
bool |
|
confirm remove all values in records |
Rpc.Object.RelationOptionDelete.Response
Rpc.Object.RelationOptionDelete.Response.Error
Rpc.Object.RelationOptionUpdate
Rpc.Object.RelationOptionUpdate.Request
| Field |
Type |
Label |
Description |
| contextId |
string |
|
|
| relationKey |
string |
|
relation key to add the option |
| option |
model.Relation.Option |
|
id of select options will be autogenerated |
Rpc.Object.RelationOptionUpdate.Response
Rpc.Object.RelationOptionUpdate.Response.Error
Rpc.Object.RelationUpdate
Rpc.Object.RelationUpdate.Request
Rpc.Object.RelationUpdate.Response
Rpc.Object.RelationUpdate.Response.Error
Rpc.Object.Search
Rpc.Object.Search.Request
deprecated, to be removed |
| keys | string | repeated | needed keys in details for return, when empty - will return all |
Rpc.Object.Search.Response
Rpc.Object.Search.Response.Error
Rpc.Object.SearchSubscribe
Rpc.Object.SearchSubscribe.Request
| Field |
Type |
Label |
Description |
| subId |
string |
|
(optional) subscription identifier client can provide some string or middleware will generate it automatically if subId is already registered on middleware, the new query will replace previous subscription |
| filters |
model.Block.Content.Dataview.Filter |
repeated |
filters |
| sorts |
model.Block.Content.Dataview.Sort |
repeated |
sorts |
| limit |
int64 |
|
results limit |
| offset |
int64 |
|
initial offset; middleware will find afterId |
| keys |
string |
repeated |
(required) needed keys in details for return, for object fields mw will return (and subscribe) objects as dependent |
| afterId |
string |
|
(optional) pagination: middleware will return results after given id |
| beforeId |
string |
|
(optional) pagination: middleware will return results before given id |
| source |
string |
repeated |
|
| ignoreWorkspace |
string |
|
|
| noDepSubscription |
bool |
|
disable dependent subscription |
Rpc.Object.SearchSubscribe.Response
Rpc.Object.SearchSubscribe.Response.Error
Rpc.Object.SearchUnsubscribe
Rpc.Object.SearchUnsubscribe.Request
| Field |
Type |
Label |
Description |
| subIds |
string |
repeated |
|
Rpc.Object.SearchUnsubscribe.Response
Rpc.Object.SearchUnsubscribe.Response.Error
Rpc.Object.SetIsArchived
Rpc.Object.SetIsArchived.Request
| Field |
Type |
Label |
Description |
| contextId |
string |
|
|
| isArchived |
bool |
|
|
Rpc.Object.SetIsArchived.Response
Rpc.Object.SetIsArchived.Response.Error
Rpc.Object.SetIsFavorite
Rpc.Object.SetIsFavorite.Request
| Field |
Type |
Label |
Description |
| contextId |
string |
|
|
| isFavorite |
bool |
|
|
Rpc.Object.SetIsFavorite.Response
Rpc.Object.SetIsFavorite.Response.Error
Rpc.Object.SetLayout
Rpc.Object.SetLayout.Request
Rpc.Object.SetLayout.Response
Rpc.Object.SetLayout.Response.Error
Rpc.Object.ShareByLink
Rpc.Object.ShareByLink.Request
| Field |
Type |
Label |
Description |
| objectId |
string |
|
|
Rpc.Object.ShareByLink.Response
Rpc.Object.ShareByLink.Response.Error
Rpc.Object.ToSet
Rpc.Object.ToSet.Request
| Field |
Type |
Label |
Description |
| contextId |
string |
|
|
| source |
string |
repeated |
|
Rpc.Object.ToSet.Response
Rpc.Object.ToSet.Response.Error
Rpc.ObjectDuplicate
Rpc.ObjectDuplicate.Request
| Field |
Type |
Label |
Description |
| contextId |
string |
|
id of template block for cloning |
Rpc.ObjectDuplicate.Response
Rpc.ObjectDuplicate.Response.Error
Rpc.ObjectList
Rpc.ObjectList.Delete
Rpc.ObjectList.Delete.Request
Deletes the object, keys from the local store and unsubscribe from remote changes. Also offloads all orphan files
| Field |
Type |
Label |
Description |
| objectIds |
string |
repeated |
objects to remove |
Rpc.ObjectList.Delete.Response
Rpc.ObjectList.Delete.Response.Error
Rpc.ObjectList.Set
Rpc.ObjectList.Set.IsArchived
Rpc.ObjectList.Set.IsArchived.Request
| Field |
Type |
Label |
Description |
| objectIds |
string |
repeated |
|
| isArchived |
bool |
|
|
Rpc.ObjectList.Set.IsArchived.Response
Rpc.ObjectList.Set.IsArchived.Response.Error
Rpc.ObjectList.Set.IsFavorite
Rpc.ObjectList.Set.IsFavorite.Request
| Field |
Type |
Label |
Description |
| objectIds |
string |
repeated |
|
| isFavorite |
bool |
|
|
Rpc.ObjectList.Set.IsFavorite.Response
Rpc.ObjectList.Set.IsFavorite.Response.Error
Rpc.ObjectType
Rpc.ObjectType.Create
Rpc.ObjectType.Create.Request
Rpc.ObjectType.Create.Response
Rpc.ObjectType.Create.Response.Error
Rpc.ObjectType.List
Rpc.ObjectType.List.Request
Rpc.ObjectType.List.Response
Rpc.ObjectType.List.Response.Error
Rpc.ObjectType.Relation
Rpc.ObjectType.Relation.Add
Rpc.ObjectType.Relation.Add.Request
Rpc.ObjectType.Relation.Add.Response
Rpc.ObjectType.Relation.Add.Response.Error
Rpc.ObjectType.Relation.List
Rpc.ObjectType.Relation.List.Request
| Field |
Type |
Label |
Description |
| objectTypeUrl |
string |
|
|
| appendRelationsFromOtherTypes |
bool |
|
add relations from other object types in the end |
Rpc.ObjectType.Relation.List.Response
Rpc.ObjectType.Relation.List.Response.Error
Rpc.ObjectType.Relation.Remove
Rpc.ObjectType.Relation.Remove.Request
| Field |
Type |
Label |
Description |
| objectTypeUrl |
string |
|
|
| relationKey |
string |
|
|
Rpc.ObjectType.Relation.Remove.Response
Rpc.ObjectType.Relation.Remove.Response.Error
Rpc.ObjectType.Relation.Update
Rpc.ObjectType.Relation.Update.Request
Rpc.ObjectType.Relation.Update.Response
Rpc.ObjectType.Relation.Update.Response.Error
Rpc.Page
Rpc.Page.Create
Rpc.Page.Create.Request
Rpc.Page.Create.Response
Rpc.Page.Create.Response.Error
Rpc.Ping
Rpc.Ping.Request
| Field |
Type |
Label |
Description |
| index |
int32 |
|
|
| numberOfEventsToSend |
int32 |
|
|
Rpc.Ping.Response
Rpc.Ping.Response.Error
Rpc.Process
Rpc.Process.Cancel
Rpc.Process.Cancel.Request
| Field |
Type |
Label |
Description |
| id |
string |
|
|
Rpc.Process.Cancel.Response
Rpc.Process.Cancel.Response.Error
Rpc.Set
Rpc.Set.Create
Rpc.Set.Create.Request
| Field |
Type |
Label |
Description |
| source |
string |
repeated |
|
| details |
google.protobuf.Struct |
|
if omitted the name of page will be the same with object type |
| templateId |
string |
|
optional template id for creating from template |
Rpc.Set.Create.Response
Rpc.Set.Create.Response.Error
Rpc.Shutdown
Rpc.Shutdown.Request
Rpc.Shutdown.Response
Rpc.Shutdown.Response.Error
Rpc.UnsplashDownload
Rpc.UnsplashDownload.Request
| Field |
Type |
Label |
Description |
| pictureId |
string |
|
|
Rpc.UnsplashDownload.Response
Rpc.UnsplashDownload.Response.Error
Rpc.UnsplashSearch
Rpc.UnsplashSearch.Request
| Field |
Type |
Label |
Description |
| query |
string |
|
empty means random images |
| limit |
int32 |
|
may be omitted if the request was cached previously with another limit |
Rpc.UnsplashSearch.Response
Rpc.UnsplashSearch.Response.Error
Rpc.UnsplashSearch.Response.Picture
Rpc.UploadFile
Rpc.UploadFile.Request
Rpc.UploadFile.Response
Rpc.UploadFile.Response.Error
Rpc.Version
Get info about a version of a middleware.
Info is a string, that contains: BuildDate, GitCommit, GitBranch, GitState
Rpc.Version.Get
Rpc.Version.Get.Request
Rpc.Version.Get.Response
Rpc.Version.Get.Response.Error
Rpc.Wallet
Namespace, that aggregates subtopics and actions, that relates to wallet.
Rpc.Wallet.Convert
Rpc.Wallet.Convert.Request
| Field |
Type |
Label |
Description |
| mnemonic |
string |
|
Mnemonic of a wallet to convert |
| entropy |
string |
|
entropy of a wallet to convert |
Rpc.Wallet.Convert.Response
Rpc.Wallet.Convert.Response.Error
Rpc.Wallet.Create
Rpc.Wallet.Create.Request
Front-end-to-middleware request to create a new wallet
| Field |
Type |
Label |
Description |
| rootPath |
string |
|
Path to a wallet directory |
Rpc.Wallet.Create.Response
Middleware-to-front-end response, that can contain mnemonic of a created account and a NULL error or an empty mnemonic and a non-NULL error
Rpc.Wallet.Create.Response.Error
Rpc.Wallet.Recover
Rpc.Wallet.Recover.Request
Front end to middleware request-to-recover-a wallet with this mnemonic and a rootPath
| Field |
Type |
Label |
Description |
| rootPath |
string |
|
Path to a wallet directory |
| mnemonic |
string |
|
Mnemonic of a wallet to recover |
Rpc.Wallet.Recover.Response
Middleware-to-front-end response, that can contain a NULL error or a non-NULL error
Rpc.Wallet.Recover.Response.Error
Rpc.Workspace
Rpc.Workspace.Create
Rpc.Workspace.Create.Request
| Field |
Type |
Label |
Description |
| name |
string |
|
|
Rpc.Workspace.Create.Response
Rpc.Workspace.Create.Response.Error
Rpc.Workspace.GetAll
Rpc.Workspace.GetAll.Request
Rpc.Workspace.GetAll.Response
Rpc.Workspace.GetAll.Response.Error
Rpc.Workspace.GetCurrent
Rpc.Workspace.GetCurrent.Request
Rpc.Workspace.GetCurrent.Response
Rpc.Workspace.GetCurrent.Response.Error
Rpc.Workspace.Select
Rpc.Workspace.Select.Request
| Field |
Type |
Label |
Description |
| workspaceId |
string |
|
|
Rpc.Workspace.Select.Response
Rpc.Workspace.Select.Response.Error
Rpc.Workspace.SetIsHighlighted
Rpc.Workspace.SetIsHighlighted.Request
| Field |
Type |
Label |
Description |
| objectId |
string |
|
|
| isHighlighted |
bool |
|
|
Rpc.Workspace.SetIsHighlighted.Response
Rpc.Workspace.SetIsHighlighted.Response.Error
Rpc.Account.Create.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
No error; Account should be non-empty |
| UNKNOWN_ERROR |
1 |
Any other errors |
| BAD_INPUT |
2 |
Avatar or name is not correct |
| ACCOUNT_CREATED_BUT_FAILED_TO_START_NODE |
101 |
|
| ACCOUNT_CREATED_BUT_FAILED_TO_SET_NAME |
102 |
|
| ACCOUNT_CREATED_BUT_FAILED_TO_SET_AVATAR |
103 |
|
| FAILED_TO_STOP_RUNNING_NODE |
104 |
|
| BAD_INVITE_CODE |
900 |
|
| NET_ERROR |
901 |
means general network error |
| NET_CONNECTION_REFUSED |
902 |
means we wasn't able to connect to the cafe server |
| NET_OFFLINE |
903 |
client can additionally support this error code to notify user that device is offline |
Rpc.Account.Recover.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
No error; |
| UNKNOWN_ERROR |
1 |
Any other errors |
| BAD_INPUT |
2 |
|
| NO_ACCOUNTS_FOUND |
101 |
|
| NEED_TO_RECOVER_WALLET_FIRST |
102 |
|
| FAILED_TO_CREATE_LOCAL_REPO |
103 |
|
| LOCAL_REPO_EXISTS_BUT_CORRUPTED |
104 |
|
| FAILED_TO_RUN_NODE |
105 |
|
| WALLET_RECOVER_NOT_PERFORMED |
106 |
|
| FAILED_TO_STOP_RUNNING_NODE |
107 |
|
| ANOTHER_ANYTYPE_PROCESS_IS_RUNNING |
108 |
|
Rpc.Account.Select.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
No error |
| UNKNOWN_ERROR |
1 |
Any other errors |
| BAD_INPUT |
2 |
Id or root path is wrong |
| FAILED_TO_CREATE_LOCAL_REPO |
101 |
|
| LOCAL_REPO_EXISTS_BUT_CORRUPTED |
102 |
|
| FAILED_TO_RUN_NODE |
103 |
|
| FAILED_TO_FIND_ACCOUNT_INFO |
104 |
|
| LOCAL_REPO_NOT_EXISTS_AND_MNEMONIC_NOT_SET |
105 |
|
| FAILED_TO_STOP_SEARCHER_NODE |
106 |
|
| FAILED_TO_RECOVER_PREDEFINED_BLOCKS |
107 |
|
| ANOTHER_ANYTYPE_PROCESS_IS_RUNNING |
108 |
|
Rpc.Account.Stop.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
No error |
| UNKNOWN_ERROR |
1 |
Any other errors |
| BAD_INPUT |
2 |
Id or root path is wrong |
| ACCOUNT_IS_NOT_RUNNING |
101 |
|
| FAILED_TO_STOP_NODE |
102 |
|
| FAILED_TO_REMOVE_ACCOUNT_DATA |
103 |
|
Rpc.ApplyTemplate.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Block.Bookmark.CreateAndFetch.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
|
Rpc.Block.Bookmark.Fetch.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
|
Rpc.Block.Close.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Block.Copy.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Block.Create.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Block.CreatePage.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Block.CreateSet.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
|
| UNKNOWN_OBJECT_TYPE_URL |
3 |
... |
Rpc.Block.Cut.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Block.Dataview.RecordCreate.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Block.Dataview.RecordDelete.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Block.Dataview.RecordRelationOptionAdd.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
|
Rpc.Block.Dataview.RecordRelationOptionDelete.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
|
Rpc.Block.Dataview.RecordRelationOptionUpdate.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
|
Rpc.Block.Dataview.RecordUpdate.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Block.Dataview.RelationAdd.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
|
Rpc.Block.Dataview.RelationDelete.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
|
Rpc.Block.Dataview.RelationListAvailable.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
|
| NOT_A_DATAVIEW_BLOCK |
3 |
... |
Rpc.Block.Dataview.RelationUpdate.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
|
Rpc.Block.Dataview.SetSource.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
|
Rpc.Block.Dataview.ViewCreate.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Block.Dataview.ViewDelete.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Block.Dataview.ViewSetActive.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Block.Dataview.ViewSetPosition.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Block.Dataview.ViewUpdate.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Block.Download.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Block.Export.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Block.File.CreateAndUpload.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
|
Rpc.Block.Get.Marks.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Block.GetPublicWebURL.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Block.ImportMarkdown.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Block.Merge.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Block.ObjectType.Set.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
|
| UNKNOWN_OBJECT_TYPE_URL |
3 |
|
Rpc.Block.Open.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
|
| NOT_FOUND |
3 |
|
| ANYTYPE_NEEDS_UPGRADE |
10 |
failed to read unknown data format – need to upgrade anytype |
Rpc.Block.OpenBreadcrumbs.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Block.Paste.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Block.Redo.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
|
| CAN_NOT_MOVE |
3 |
... |
Rpc.Block.Relation.Add.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
|
Rpc.Block.Relation.SetKey.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
|
Rpc.Block.Replace.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Block.Set.Details.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Block.Set.Fields.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Block.Set.File.Name.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Block.Set.Image.Name.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Block.Set.Image.Width.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Block.Set.Latex.Text.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Block.Set.Link.TargetBlockId.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Block.Set.Page.IsArchived.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Block.Set.Restrictions.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Block.Set.Text.Checked.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Block.Set.Text.Color.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Block.Set.Text.Icon.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Block.Set.Text.Style.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Block.Set.Text.Text.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Block.Set.Video.Name.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Block.Set.Video.Width.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Block.SetBreadcrumbs.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Block.Show.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
|
| NOT_FOUND |
3 |
|
| ANYTYPE_NEEDS_UPGRADE |
10 |
failed to read unknown data format – need to upgrade anytype |
Rpc.Block.Split.Request.Mode
| Name |
Number |
Description |
| BOTTOM |
0 |
new block will be created under existing |
| TOP |
1 |
new block will be created above existing |
| INNER |
2 |
new block will be created as the first children of existing |
| TITLE |
3 |
new block will be created after header (not required for set at client side, will auto set for title block) |
Rpc.Block.Split.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Block.Undo.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
|
| CAN_NOT_MOVE |
3 |
... |
Rpc.Block.Unlink.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Block.UpdateContent.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Block.Upload.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.BlockList.ConvertChildrenToPages.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.BlockList.Duplicate.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.BlockList.Move.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.BlockList.MoveToNewPage.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.BlockList.Set.Align.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.BlockList.Set.BackgroundColor.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.BlockList.Set.Div.Style.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.BlockList.Set.Fields.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.BlockList.Set.File.Style.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.BlockList.Set.Text.Color.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.BlockList.Set.Text.Mark.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.BlockList.Set.Text.Style.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.BlockList.TurnInto.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.CloneTemplate.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Config.Get.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
|
| NODE_NOT_STARTED |
101 |
|
Rpc.Debug.Sync.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Debug.Thread.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Debug.Tree.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.DownloadFile.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
|
| NOT_FOUND |
3 |
|
Rpc.Export.Format
| Name |
Number |
Description |
| Markdown |
0 |
|
| Protobuf |
1 |
|
| JSON |
2 |
|
| DOT |
3 |
|
| SVG |
4 |
|
| GRAPH_JSON |
5 |
|
Rpc.Export.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.ExportLocalstore.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.ExportTemplates.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.ExportWorkspace.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.ExternalDrop.Content.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.ExternalDrop.Files.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.File.Offload.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
|
| NODE_NOT_STARTED |
103 |
... |
| FILE_NOT_YET_PINNED |
104 |
|
Rpc.FileList.Offload.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
|
| NODE_NOT_STARTED |
103 |
... |
Rpc.GenericErrorResponse.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.History.SetVersion.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.History.Show.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.History.Versions.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.LinkPreview.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
|
Rpc.Log.Send.Request.Level
| Name |
Number |
Description |
| DEBUG |
0 |
|
| ERROR |
1 |
|
| FATAL |
2 |
|
| INFO |
3 |
|
| PANIC |
4 |
|
| WARNING |
5 |
|
Rpc.Log.Send.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
|
| NOT_FOUND |
101 |
|
| TIMEOUT |
102 |
|
Rpc.MakeTemplate.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.MakeTemplateByObjectType.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Metrics.SetParameters.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Navigation.Context
| Name |
Number |
Description |
| Navigation |
0 |
|
| MoveTo |
1 |
do not show sets/archive |
| LinkTo |
2 |
same for mention, do not show sets/archive |
Rpc.Navigation.GetObjectInfoWithLinks.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Navigation.ListObjects.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Object.AddWithObjectId.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Object.FeaturedRelation.Add.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Object.FeaturedRelation.Remove.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Object.Graph.Edge.Type
| Name |
Number |
Description |
| Link |
0 |
|
| Relation |
1 |
|
Rpc.Object.Graph.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Object.IdsSubscribe.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Object.RelationAdd.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
|
| ALREADY_EXISTS |
10 |
|
Rpc.Object.RelationDelete.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
|
Rpc.Object.RelationListAvailable.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Object.RelationOptionAdd.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
|
Rpc.Object.RelationOptionDelete.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
|
| SOME_RECORDS_HAS_RELATION_VALUE_WITH_THIS_OPTION |
3 |
need to confirm with confirmRemoveAllValuesInRecords=true |
Rpc.Object.RelationOptionUpdate.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
|
Rpc.Object.RelationUpdate.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
|
Rpc.Object.Search.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Object.SearchSubscribe.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Object.SearchUnsubscribe.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
|
Rpc.Object.SetIsArchived.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Object.SetIsFavorite.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Object.SetLayout.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Object.ShareByLink.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Object.ToSet.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.ObjectDuplicate.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.ObjectList.Delete.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.ObjectList.Set.IsArchived.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.ObjectList.Set.IsFavorite.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.ObjectType.Create.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
|
| UNKNOWN_OBJECT_TYPE_URL |
3 |
... |
Rpc.ObjectType.List.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.ObjectType.Relation.Add.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
|
| UNKNOWN_OBJECT_TYPE_URL |
3 |
|
| READONLY_OBJECT_TYPE |
4 |
... |
Rpc.ObjectType.Relation.List.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
|
| UNKNOWN_OBJECT_TYPE_URL |
3 |
... |
Rpc.ObjectType.Relation.Remove.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
|
| UNKNOWN_OBJECT_TYPE_URL |
3 |
|
| READONLY_OBJECT_TYPE |
4 |
... |
Rpc.ObjectType.Relation.Update.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
|
| UNKNOWN_OBJECT_TYPE_URL |
3 |
|
| READONLY_OBJECT_TYPE |
4 |
... |
Rpc.Page.Create.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Ping.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
|
Rpc.Process.Cancel.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
|
Rpc.Set.Create.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
|
| UNKNOWN_OBJECT_TYPE_URL |
3 |
|
Rpc.Shutdown.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
|
| NODE_NOT_STARTED |
101 |
|
Rpc.UnsplashDownload.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
|
| RATE_LIMIT_EXCEEDED |
100 |
... |
Rpc.UnsplashSearch.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
|
| RATE_LIMIT_EXCEEDED |
100 |
... |
Rpc.UploadFile.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
|
Rpc.Version.Get.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
|
| VERSION_IS_EMPTY |
3 |
|
| NOT_FOUND |
101 |
|
| TIMEOUT |
102 |
|
Rpc.Wallet.Convert.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
No error; wallet successfully recovered |
| UNKNOWN_ERROR |
1 |
Any other errors |
| BAD_INPUT |
2 |
mnemonic is wrong |
Rpc.Wallet.Create.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
No error; mnemonic should be non-empty |
| UNKNOWN_ERROR |
1 |
Any other errors |
| BAD_INPUT |
2 |
Root path is wrong |
| FAILED_TO_CREATE_LOCAL_REPO |
101 |
... |
Rpc.Wallet.Recover.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
No error; wallet successfully recovered |
| UNKNOWN_ERROR |
1 |
Any other errors |
| BAD_INPUT |
2 |
Root path or mnemonic is wrong |
| FAILED_TO_CREATE_LOCAL_REPO |
101 |
|
Rpc.Workspace.Create.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Workspace.GetAll.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Workspace.GetCurrent.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Workspace.Select.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Rpc.Workspace.SetIsHighlighted.Response.Error.Code
| Name |
Number |
Description |
| NULL |
0 |
|
| UNKNOWN_ERROR |
1 |
|
| BAD_INPUT |
2 |
... |
Top
pb/protos/events.proto
Event
Event – type of message, that could be sent from a middleware to the corresponding front-end.
Event.Account
Event.Account.Config
Event.Account.Config.Update
Event.Account.Details
Event.Account.Show
Message, that will be sent to the front on each account found after an AccountRecoverRequest
| Field |
Type |
Label |
Description |
| index |
int32 |
|
Number of an account in an all found accounts list |
| account |
model.Account |
|
An Account, that has been found for the mnemonic |
Event.Block
Event.Block.Add
Event to show internal blocks on a client.
Example Scenarios
A. Block Creation
- Block A have been created on a client C1
- Client C2 receives Event.Block.Add(Block A), Event.Block.Update(Page.children)
B. Partial block load
- Client C1 opens Page1, that contains, for example, 133 blocks.
- M -> F: ShowFullScreen(Root, blocks1-50)
- M -> F: Block.Add(blocks51-100)
- M -> F: Block.Add(blocks101-133)
| Field |
Type |
Label |
Description |
| blocks |
model.Block |
repeated |
id -> block |
Event.Block.Dataview
Event.Block.Dataview.RelationDelete
| Field |
Type |
Label |
Description |
| id |
string |
|
dataview block's id |
| relationKey |
string |
|
relation key to remove |
Event.Block.Dataview.RelationSet
sent when the dataview relation has been changed or added
Event.Block.Dataview.SourceSet
| Field |
Type |
Label |
Description |
| id |
string |
|
dataview block's id |
| source |
string |
repeated |
|
Event.Block.Dataview.ViewDelete
| Field |
Type |
Label |
Description |
| id |
string |
|
dataview block's id |
| viewId |
string |
|
view id to remove |
Event.Block.Dataview.ViewOrder
| Field |
Type |
Label |
Description |
| id |
string |
|
dataview block's id |
| viewIds |
string |
repeated |
view ids in new order |
Event.Block.Dataview.ViewSet
sent when the view have been changed or added
| Field |
Type |
Label |
Description |
| id |
string |
|
dataview block's id |
| viewId |
string |
|
view id, client should double check this to make sure client doesn't switch the active view in the middle |
| view |
model.Block.Content.Dataview.View |
|
|
| offset |
uint32 |
|
middleware will try to preserve the current aciveview's offset&limit but may reset it in case it becomes invalid or not actual anymore |
| limit |
uint32 |
|
|
Event.Block.Delete
| Field |
Type |
Label |
Description |
| blockIds |
string |
repeated |
|
Event.Block.FilesUpload
Middleware to front end event message, that will be sent on one of this scenarios:
Precondition: user A opened a block
- User A drops a set of files/pictures/videos
- User A creates a MediaBlock and drops a single media, that corresponds to its type.
| Field |
Type |
Label |
Description |
| blockId |
string |
|
if empty => create new blocks |
| filePath |
string |
repeated |
filepaths to the files |
Event.Block.Fill
Event.Block.Fill.Align
Event.Block.Fill.BackgroundColor
| Field |
Type |
Label |
Description |
| id |
string |
|
|
| backgroundColor |
string |
|
|
Event.Block.Fill.Bookmark
Event.Block.Fill.Bookmark.Description
| Field |
Type |
Label |
Description |
| value |
string |
|
|
Event.Block.Fill.Bookmark.FaviconHash
| Field |
Type |
Label |
Description |
| value |
string |
|
|
Event.Block.Fill.Bookmark.ImageHash
| Field |
Type |
Label |
Description |
| value |
string |
|
|
Event.Block.Fill.Bookmark.Title
| Field |
Type |
Label |
Description |
| value |
string |
|
|
Event.Block.Fill.Bookmark.Type
Event.Block.Fill.Bookmark.Url
| Field |
Type |
Label |
Description |
| value |
string |
|
|
Event.Block.Fill.ChildrenIds
| Field |
Type |
Label |
Description |
| id |
string |
|
|
| childrenIds |
string |
repeated |
|
Event.Block.Fill.DatabaseRecords
Event.Block.Fill.Details
Event.Block.Fill.Div
Event.Block.Fill.Div.Style
Event.Block.Fill.Fields
Event.Block.Fill.File
Event.Block.Fill.File.Hash
| Field |
Type |
Label |
Description |
| value |
string |
|
|
Event.Block.Fill.File.Mime
| Field |
Type |
Label |
Description |
| value |
string |
|
|
Event.Block.Fill.File.Name
| Field |
Type |
Label |
Description |
| value |
string |
|
|
Event.Block.Fill.File.Size
| Field |
Type |
Label |
Description |
| value |
int64 |
|
|
Event.Block.Fill.File.State
Event.Block.Fill.File.Style
Event.Block.Fill.File.Type
Event.Block.Fill.File.Width
| Field |
Type |
Label |
Description |
| value |
int32 |
|
|
Event.Block.Fill.Link
Event.Block.Fill.Link.Fields
Event.Block.Fill.Link.Style
Event.Block.Fill.Link.TargetBlockId
| Field |
Type |
Label |
Description |
| value |
string |
|
|
Event.Block.Fill.Restrictions
Event.Block.Fill.Text
Event.Block.Fill.Text.Checked
| Field |
Type |
Label |
Description |
| value |
bool |
|
|
Event.Block.Fill.Text.Color
| Field |
Type |
Label |
Description |
| value |
string |
|
|
Event.Block.Fill.Text.Marks
Event.Block.Fill.Text.Style
Event.Block.Fill.Text.Text
| Field |
Type |
Label |
Description |
| value |
string |
|
|
Event.Block.MarksInfo
Event.Block.Set
Event.Block.Set.Align
Event.Block.Set.BackgroundColor
| Field |
Type |
Label |
Description |
| id |
string |
|
|
| backgroundColor |
string |
|
|
Event.Block.Set.Bookmark
Event.Block.Set.Bookmark.Description
| Field |
Type |
Label |
Description |
| value |
string |
|
|
Event.Block.Set.Bookmark.FaviconHash
| Field |
Type |
Label |
Description |
| value |
string |
|
|
Event.Block.Set.Bookmark.ImageHash
| Field |
Type |
Label |
Description |
| value |
string |
|
|
Event.Block.Set.Bookmark.Title
| Field |
Type |
Label |
Description |
| value |
string |
|
|
Event.Block.Set.Bookmark.Type
Event.Block.Set.Bookmark.Url
| Field |
Type |
Label |
Description |
| value |
string |
|
|
Event.Block.Set.ChildrenIds
| Field |
Type |
Label |
Description |
| id |
string |
|
|
| childrenIds |
string |
repeated |
|
Event.Block.Set.Div
Event.Block.Set.Div.Style
Event.Block.Set.Fields
Event.Block.Set.File
Event.Block.Set.File.Hash
| Field |
Type |
Label |
Description |
| value |
string |
|
|
Event.Block.Set.File.Mime
| Field |
Type |
Label |
Description |
| value |
string |
|
|
Event.Block.Set.File.Name
| Field |
Type |
Label |
Description |
| value |
string |
|
|
Event.Block.Set.File.Size
| Field |
Type |
Label |
Description |
| value |
int64 |
|
|
Event.Block.Set.File.State
Event.Block.Set.File.Style
Event.Block.Set.File.Type
Event.Block.Set.File.Width
| Field |
Type |
Label |
Description |
| value |
int32 |
|
|
Event.Block.Set.Latex
Event.Block.Set.Latex.Text
| Field |
Type |
Label |
Description |
| value |
string |
|
|
Event.Block.Set.Link
Event.Block.Set.Link.Fields
Event.Block.Set.Link.Style
Event.Block.Set.Link.TargetBlockId
| Field |
Type |
Label |
Description |
| value |
string |
|
|
Event.Block.Set.Relation
Event.Block.Set.Relation.Key
| Field |
Type |
Label |
Description |
| value |
string |
|
|
Event.Block.Set.Restrictions
Event.Block.Set.Text
Event.Block.Set.Text.Checked
| Field |
Type |
Label |
Description |
| value |
bool |
|
|
Event.Block.Set.Text.Color
| Field |
Type |
Label |
Description |
| value |
string |
|
|
Event.Block.Set.Text.IconEmoji
| Field |
Type |
Label |
Description |
| value |
string |
|
|
Event.Block.Set.Text.IconImage
| Field |
Type |
Label |
Description |
| value |
string |
|
|
Event.Block.Set.Text.Marks
Event.Block.Set.Text.Style
Event.Block.Set.Text.Text
| Field |
Type |
Label |
Description |
| value |
string |
|
|
Event.Message
Event.Object
Event.Object.Details
Event.Object.Details.Amend
Amend (i.e. add a new key-value pair or update an existing key-value pair) existing state
Event.Object.Details.Amend.KeyValue
Event.Object.Details.Set
Overwrite current state
| Field |
Type |
Label |
Description |
| id |
string |
|
context objectId |
| details |
google.protobuf.Struct |
|
can not be a partial state. Should replace client details state |
| subIds |
string |
repeated |
|
Event.Object.Details.Unset
Unset existing detail keys
| Field |
Type |
Label |
Description |
| id |
string |
|
context objectId |
| keys |
string |
repeated |
|
| subIds |
string |
repeated |
|
Event.Object.Relation
Event.Object.Relation.Remove
| Field |
Type |
Label |
Description |
| id |
string |
|
context objectId |
| relationKey |
string |
|
|
Event.Object.Relation.Set
| Field |
Type |
Label |
Description |
| id |
string |
|
context objectId |
| relationKey |
string |
|
|
| relation |
model.Relation |
|
missing value means relation should be removed |
Event.Object.Relations
Event.Object.Relations.Amend
Event.Object.Relations.Remove
| Field |
Type |
Label |
Description |
| id |
string |
|
context objectId |
| keys |
string |
repeated |
|
Event.Object.Relations.Set
Event.Object.Remove
| Field |
Type |
Label |
Description |
| ids |
string |
repeated |
notifies that objects were removed |
Event.Object.Restriction
Event.Object.Show
Works with a smart blocks: Page, Dashboard
Dashboard opened, click on a page, Rpc.Block.open, Block.ShowFullscreen(PageBlock)
| Field |
Type |
Label |
Description |
| rootId |
string |
|
Root block id |
| blocks |
model.Block |
repeated |
dependent simple blocks (descendants) |
| details |
Event.Object.Details.Set |
repeated |
details for the current and dependent objects |
| type |
model.SmartBlockType |
|
|
| objectTypes |
model.ObjectType |
repeated |
objectTypes contains ONLY to get layouts for the actual and all dependent objects. Relations are currently omitted // todo: switch to other pb model |
| relations |
model.Relation |
repeated |
combined relations of object's type + extra relations. If object doesn't has some relation key in the details this means client should hide it and only suggest when adding existing one |
| restrictions |
model.Restrictions |
|
object restrictions |
Event.Object.Show.RelationWithValuePerObject
Event.Object.Subscription
Event.Object.Subscription.Add
Adds new document to subscriptions
| Field |
Type |
Label |
Description |
| id |
string |
|
object id |
| afterId |
string |
|
id of previous doc in order, empty means first |
| subId |
string |
|
subscription id |
Event.Object.Subscription.Counters
| Field |
Type |
Label |
Description |
| total |
int64 |
|
total available records |
| nextCount |
int64 |
|
how many records available after |
| prevCount |
int64 |
|
how many records available before |
| subId |
string |
|
subscription id |
Event.Object.Subscription.Position
Indicates new position of document
| Field |
Type |
Label |
Description |
| id |
string |
|
object id |
| afterId |
string |
|
id of previous doc in order, empty means first |
| subId |
string |
|
subscription id |
Event.Object.Subscription.Remove
Removes document from subscription
| Field |
Type |
Label |
Description |
| id |
string |
|
object id |
| subId |
string |
|
subscription id |
Event.Ping
| Field |
Type |
Label |
Description |
| index |
int32 |
|
|
Event.Process
Event.Process.Done
Event.Process.New
Event.Process.Update
Event.Status
Event.Status.Thread
Event.Status.Thread.Account
Event.Status.Thread.Cafe
Event.Status.Thread.Cafe.PinStatus
Event.Status.Thread.Device
Event.Status.Thread.Summary
Event.User
Event.User.Block
Event.User.Block.Join
Middleware to front end event message, that will be sent in this scenario:
Precondition: user A opened a block
- User B opens the same block
- User A receives a message about p.1
| Field |
Type |
Label |
Description |
| account |
Event.Account |
|
Account of the user, that opened a block |
Event.User.Block.Left
Middleware to front end event message, that will be sent in this scenario:
Precondition: user A and user B opened the same block
- User B closes the block
- User A receives a message about p.1
| Field |
Type |
Label |
Description |
| account |
Event.Account |
|
Account of the user, that left the block |
Event.User.Block.SelectRange
Middleware to front end event message, that will be sent in this scenario:
Precondition: user A and user B opened the same block
- User B selects some inner blocks
- User A receives a message about p.1
| Field |
Type |
Label |
Description |
| account |
Event.Account |
|
Account of the user, that selected blocks |
| blockIdsArray |
string |
repeated |
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
- User B sets cursor or selects a text region into a text block
- User A receives a message about p.1
| Field |
Type |
Label |
Description |
| account |
Event.Account |
|
Account of the user, that selected a text |
| blockId |
string |
|
Id of the text block, that have a selection |
| range |
model.Range |
|
Range of the selection |
Model
Model.Process
Model.Process.Progress
ResponseEvent
Event.Status.Thread.SyncStatus
| Name |
Number |
Description |
| Unknown |
0 |
|
| Offline |
1 |
|
| Syncing |
2 |
|
| Synced |
3 |
|
| Failed |
4 |
|
Model.Process.State
| Name |
Number |
Description |
| None |
0 |
|
| Running |
1 |
|
| Done |
2 |
|
| Canceled |
3 |
|
| Error |
4 |
|
Model.Process.Type
| Name |
Number |
Description |
| DropFiles |
0 |
|
| Import |
1 |
|
| Export |
2 |
|
| SaveFile |
3 |
|
| RecoverAccount |
4 |
|
Top
pkg/lib/pb/model/protos/localstore.proto
ObjectDetails
ObjectInfo
ObjectInfoWithLinks
ObjectInfoWithOutboundLinks
ObjectInfoWithOutboundLinksIDs
ObjectLinks
| Field |
Type |
Label |
Description |
| inboundIDs |
string |
repeated |
|
| outboundIDs |
string |
repeated |
|
ObjectLinksInfo
ObjectStoreChecksums
| Field |
Type |
Label |
Description |
| bundledObjectTypes |
string |
|
|
| bundledRelations |
string |
|
|
| bundledLayouts |
string |
|
|
| objectsForceReindexCounter |
int32 |
|
increased in order to trigger all objects reindex |
| filesForceReindexCounter |
int32 |
|
increased in order to fully reindex all objects |
| idxRebuildCounter |
int32 |
|
increased in order to remove indexes and reindex everything. Automatically triggers objects and files reindex(one time only) |
| fulltextRebuild |
int32 |
|
increased in order to perform fulltext indexing for all type of objects (useful when we change fulltext config) |
| bundledTemplates |
string |
|
|
| bundledObjects |
int32 |
|
anytypeProfile and maybe some others in the feature |
Top
pkg/lib/pb/model/protos/models.proto
Account
Contains basic information about a user account
| Field |
Type |
Label |
Description |
| id |
string |
|
User's thread id |
| name |
string |
|
User name, that associated with this account |
| avatar |
Account.Avatar |
|
Avatar of a user's account |
Account.Avatar
Avatar of a user's account. It could be an image or color
| Field |
Type |
Label |
Description |
| image |
Block.Content.File |
|
Image of the avatar. Contains the hash to retrieve the image. |
| color |
string |
|
Color of the avatar, used if image not set. |
Account.Config
Block
Block.Content
Block.Content.Bookmark
Bookmark is to keep a web-link and to preview a content.
Block.Content.Dataview
Block.Content.Dataview.Filter
Block.Content.Dataview.Relation
Block.Content.Dataview.Sort
Block.Content.Dataview.View
Block.Content.Div
Divider: block, that contains only one horizontal thin line
Block.Content.FeaturedRelations
Block.Content.File
Block.Content.Icon
| Field |
Type |
Label |
Description |
| name |
string |
|
|
Block.Content.Latex
| Field |
Type |
Label |
Description |
| text |
string |
|
|
Block.Content.Layout
Layout have no visual representation, but affects on blocks, that it contains.
Row/Column layout blocks creates only automatically, after some of a D&D operations, for example
Block.Content.Link
Link: block to link some content from an external sources.
Block.Content.Relation
| Field |
Type |
Label |
Description |
| key |
string |
|
|
Block.Content.Smartblock
Block.Content.TableOfContents
Block.Content.Text
Block.Content.Text.Mark
Block.Content.Text.Marks
Block.Restrictions
BlockMetaOnly
Used to decode block meta only, without the content itself
Layout
LinkPreview
ObjectType
| Field |
Type |
Label |
Description |
| url |
string |
|
leave empty in case you want to create the new one |
| name |
string |
|
name of objectType (can be localized for bundled types) |
| relations |
Relation |
repeated |
cannot contain more than one Relation with the same RelationType |
| layout |
ObjectType.Layout |
|
|
| iconEmoji |
string |
|
emoji symbol |
| description |
string |
|
|
| hidden |
bool |
|
|
| readonly |
bool |
|
|
| types |
SmartBlockType |
repeated |
|
| isArchived |
bool |
|
sets locally to hide object type from set and some other places |
Range
General purpose structure, uses in Mark.
Relation
Relation describe the human-interpreted relation type. It may be something like "Date of creation, format=date" or "Assignee, format=objectId, objectType=person"
| Field |
Type |
Label |
Description |
| key |
string |
|
Key under which the value is stored in the map. Must be unique for the object type. It usually auto-generated bsonid, but also may be something human-readable in case of prebuilt types. |
| format |
RelationFormat |
|
format of the underlying data |
| name |
string |
|
name to show (can be localized for bundled types) |
| defaultValue |
google.protobuf.Value |
|
|
| dataSource |
Relation.DataSource |
|
where the data is stored |
| hidden |
bool |
|
internal, not displayed to user (e.g. coverX, coverY) |
| readOnly |
bool |
|
value not editable by user tobe renamed to readonlyValue |
| readOnlyRelation |
bool |
|
relation metadata, eg name and format is not editable by user |
| multi |
bool |
|
allow multiple values (stored in pb list) |
| objectTypes |
string |
repeated |
URL of object type, empty to allow link to any object |
| selectDict |
Relation.Option |
repeated |
index 10, 11 was used in internal-only builds. Can be reused, but may break some test accounts |
default dictionary with unique values to choose for select/multiSelect format |
| maxCount | int32 | | max number of values can be set for this relation. 0 means no limit. 1 means the value can be stored in non-repeated field |
| description | string | | |
| scope | Relation.Scope | | on-store fields, injected only locally
scope from which this relation have been aggregated |
| creator | string | | creator profile id |
Relation.Option
| Field |
Type |
Label |
Description |
| id |
string |
|
id generated automatically if omitted |
| text |
string |
|
|
| color |
string |
|
stored |
| scope |
Relation.Option.Scope |
|
on-store contains only local-scope relations. All others injected on-the-fly |
RelationOptions
RelationWithValue
Relations
| Field |
Type |
Label |
Description |
| relations |
Relation |
repeated |
|
Restrictions
Restrictions.DataviewRestrictions
SmartBlockSnapshotBase
ThreadCreateQueueEntry
| Field |
Type |
Label |
Description |
| collectionThread |
string |
|
|
| threadId |
string |
|
|
ThreadDeeplinkPayload
| Field |
Type |
Label |
Description |
| key |
string |
|
|
| addrs |
string |
repeated |
|
Block.Align
| Name |
Number |
Description |
| AlignLeft |
0 |
|
| AlignCenter |
1 |
|
| AlignRight |
2 |
|
Block.Content.Dataview.Filter.Condition
| Name |
Number |
Description |
| None |
0 |
|
| Equal |
1 |
|
| NotEqual |
2 |
|
| Greater |
3 |
|
| Less |
4 |
|
| GreaterOrEqual |
5 |
|
| LessOrEqual |
6 |
|
| Like |
7 |
|
| NotLike |
8 |
|
| In |
9 |
|
| NotIn |
10 |
|
| Empty |
11 |
|
| NotEmpty |
12 |
|
| AllIn |
13 |
|
| NotAllIn |
14 |
|
Block.Content.Dataview.Filter.Operator
| Name |
Number |
Description |
| And |
0 |
|
| Or |
1 |
|
Block.Content.Dataview.Relation.DateFormat
| Name |
Number |
Description |
| MonthAbbrBeforeDay |
0 |
Jul 30, 2020 |
| MonthAbbrAfterDay |
1 |
30 Jul 2020 |
| Short |
2 |
30/07/2020 |
| ShortUS |
3 |
07/30/2020 |
| ISO |
4 |
2020-07-30 |
Block.Content.Dataview.Relation.TimeFormat
| Name |
Number |
Description |
| Format12 |
0 |
|
| Format24 |
1 |
|
Block.Content.Dataview.Sort.Type
| Name |
Number |
Description |
| Asc |
0 |
|
| Desc |
1 |
|
Block.Content.Dataview.View.Size
| Name |
Number |
Description |
| Small |
0 |
|
| Medium |
1 |
|
| Large |
2 |
|
Block.Content.Dataview.View.Type
| Name |
Number |
Description |
| Table |
0 |
|
| List |
1 |
|
| Gallery |
2 |
|
| Kanban |
3 |
|
Block.Content.Div.Style
| Name |
Number |
Description |
| Line |
0 |
|
| Dots |
1 |
|
Block.Content.File.State
| Name |
Number |
Description |
| Empty |
0 |
There is no file and preview, it's an empty block, that waits files. |
| Uploading |
1 |
There is still no file/preview, but file already uploading |
| Done |
2 |
File and preview downloaded |
| Error |
3 |
Error while uploading |
Block.Content.File.Style
| Name |
Number |
Description |
| Auto |
0 |
all types expect File and None has Embed style by default |
| Link |
1 |
|
| Embed |
2 |
|
Block.Content.File.Type
| Name |
Number |
Description |
| None |
0 |
|
| File |
1 |
|
| Image |
2 |
|
| Video |
3 |
|
| Audio |
4 |
|
| PDF |
5 |
|
Block.Content.Layout.Style
| Name |
Number |
Description |
| Row |
0 |
|
| Column |
1 |
|
| Div |
2 |
|
| Header |
3 |
|
Block.Content.Link.Style
| Name |
Number |
Description |
| Page |
0 |
|
| Dataview |
1 |
|
| Dashboard |
2 |
|
| Archive |
3 |
... |
Block.Content.Text.Mark.Type
| Name |
Number |
Description |
| Strikethrough |
0 |
|
| Keyboard |
1 |
|
| Italic |
2 |
|
| Bold |
3 |
|
| Underscored |
4 |
|
| Link |
5 |
|
| TextColor |
6 |
|
| BackgroundColor |
7 |
|
| Mention |
8 |
|
| Emoji |
9 |
|
| Object |
10 |
|
Block.Content.Text.Style
| Name |
Number |
Description |
| Paragraph |
0 |
|
| Header1 |
1 |
|
| Header2 |
2 |
|
| Header3 |
3 |
|
| Header4 |
4 |
deprecated |
| Quote |
5 |
|
| Code |
6 |
|
| Title |
7 |
currently only only one block of this style can exists on a page |
| Checkbox |
8 |
|
| Marked |
9 |
|
| Numbered |
10 |
|
| Toggle |
11 |
|
| Description |
12 |
currently only only one block of this style can exists on a page |
| Callout |
13 |
currently only only one block of this style can exists on a page |
Block.Position
| Name |
Number |
Description |
| None |
0 |
|
| Top |
1 |
above target block |
| Bottom |
2 |
under target block |
| Left |
3 |
to left of target block |
| Right |
4 |
to right of target block |
| Inner |
5 |
inside target block, as last block |
| Replace |
6 |
replace target block |
| InnerFirst |
7 |
inside target block, as first block |
LinkPreview.Type
| Name |
Number |
Description |
| Unknown |
0 |
|
| Page |
1 |
|
| Image |
2 |
|
| Text |
3 |
|
ObjectType.Layout
| Name |
Number |
Description |
| basic |
0 |
|
| profile |
1 |
|
| todo |
2 |
|
| set |
3 |
|
| objectType |
4 |
|
| relation |
5 |
|
| file |
6 |
|
| dashboard |
7 |
|
| image |
8 |
|
| note |
9 |
|
| space |
10 |
|
| database |
20 |
to be released later |
Relation.DataSource
| Name |
Number |
Description |
| details |
0 |
default, stored inside the object's details |
| derived |
1 |
stored locally, e.g. in badger or generated on the fly |
| account |
2 |
stored in the account DB. means existing only for specific anytype account |
| local |
3 |
stored locally |
Relation.Option.Scope
| Name |
Number |
Description |
| local |
0 |
stored within the object/aggregated from set |
| relation |
1 |
aggregated from all relation of this relation's key |
| format |
2 |
aggregated from all relations of this relation's format |
Relation.Scope
| Name |
Number |
Description |
| object |
0 |
stored within the object |
| type |
1 |
stored within the object type |
| setOfTheSameType |
2 |
aggregated from the dataview of sets of the same object type |
| objectsOfTheSameType |
3 |
aggregated from the dataview of sets of the same object type |
| library |
4 |
aggregated from relations library |
RelationFormat
RelationFormat describes how the underlying data is stored in the google.protobuf.Value and how it should be validated/sanitized
| Name |
Number |
Description |
| longtext |
0 |
string |
| shorttext |
1 |
string, usually short enough. May be truncated in the future |
| number |
2 |
double |
| status |
3 |
string or list of string(len==1) |
| tag |
11 |
list of string (choose multiple from a list) |
| date |
4 |
float64(pb.Value doesn't have int64) or the string |
| file |
5 |
relation can has objects of specific types: file, image, audio, video |
| checkbox |
6 |
boolean |
| url |
7 |
string with sanity check |
| email |
8 |
string with sanity check |
| phone |
9 |
string with sanity check |
| emoji |
10 |
one emoji, can contains multiple utf-8 symbols |
| object |
100 |
relation can has objectType to specify objectType |
| relations |
101 |
base64-encoded relation pb model |
Restrictions.DataviewRestriction
| Name |
Number |
Description |
| DVNone |
0 |
|
| DVRelation |
1 |
|
| DVCreateObject |
2 |
|
| DVViews |
3 |
|
Restrictions.ObjectRestriction
| Name |
Number |
Description |
| None |
0 |
|
| Delete |
1 |
restricts delete |
| Relations |
2 |
restricts work with relations |
| Blocks |
3 |
restricts work with blocks |
| Details |
4 |
restricts work with details |
| TypeChange |
5 |
|
| LayoutChange |
6 |
|
| Template |
7 |
|
SmartBlockType
| Name |
Number |
Description |
| AccountOld |
0 |
|
| Breadcrumbs |
1 |
|
| Page |
16 |
|
| ProfilePage |
17 |
|
| Home |
32 |
|
| Archive |
48 |
|
| Database |
64 |
|
| Set |
65 |
only have dataview simpleblock |
| STObjectType |
96 |
have relations list |
| File |
256 |
|
| Template |
288 |
|
| BundledTemplate |
289 |
|
| MarketplaceType |
272 |
|
| MarketplaceRelation |
273 |
|
| MarketplaceTemplate |
274 |
|
| BundledRelation |
512 |
|
| IndexedRelation |
513 |
|
| BundledObjectType |
514 |
|
| AnytypeProfile |
515 |
|
| Date |
516 |
|
| WorkspaceOld |
517 |
deprecated thread-based workspace |
| Workspace |
518 |
|
| RelationOptionList |
519 |
|
Scalar Value Types
| .proto Type |
Notes |
C++ |
Java |
Python |
Go |
C# |
PHP |
Ruby |
| double |
|
double |
double |
float |
float64 |
double |
float |
Float |
| float |
|
float |
float |
float |
float32 |
float |
float |
Float |
| int32 |
Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. |
int32 |
int |
int |
int32 |
int |
integer |
Bignum or Fixnum (as required) |
| int64 |
Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. |
int64 |
long |
int/long |
int64 |
long |
integer/string |
Bignum |
| uint32 |
Uses variable-length encoding. |
uint32 |
int |
int/long |
uint32 |
uint |
integer |
Bignum or Fixnum (as required) |
| uint64 |
Uses variable-length encoding. |
uint64 |
long |
int/long |
uint64 |
ulong |
integer/string |
Bignum or Fixnum (as required) |
| sint32 |
Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. |
int32 |
int |
int |
int32 |
int |
integer |
Bignum or Fixnum (as required) |
| sint64 |
Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. |
int64 |
long |
int/long |
int64 |
long |
integer/string |
Bignum |
| fixed32 |
Always four bytes. More efficient than uint32 if values are often greater than 2^28. |
uint32 |
int |
int |
uint32 |
uint |
integer |
Bignum or Fixnum (as required) |
| fixed64 |
Always eight bytes. More efficient than uint64 if values are often greater than 2^56. |
uint64 |
long |
int/long |
uint64 |
ulong |
integer/string |
Bignum |
| sfixed32 |
Always four bytes. |
int32 |
int |
int |
int32 |
int |
integer |
Bignum or Fixnum (as required) |
| sfixed64 |
Always eight bytes. |
int64 |
long |
int/long |
int64 |
long |
integer/string |
Bignum |
| bool |
|
bool |
boolean |
boolean |
bool |
bool |
boolean |
TrueClass/FalseClass |
| string |
A string must always contain UTF-8 encoded or 7-bit ASCII text. |
string |
String |
str/unicode |
string |
string |
string |
String (UTF-8) |
| bytes |
May contain any arbitrary sequence of bytes. |
string |
ByteString |
str |
[]byte |
ByteString |
string |
String (ASCII-8BIT) |
