558 KiB
Protocol Documentation
Table of Contents
-
- Change
- Change.BlockCreate
- Change.BlockDuplicate
- Change.BlockMove
- Change.BlockRemove
- Change.BlockUpdate
- Change.Content
- Change.DetailsSet
- Change.DetailsUnset
- Change.FileKeys
- Change.FileKeys.KeysEntry
- Change.ObjectTypeAdd
- Change.ObjectTypeRemove
- Change.RelationAdd
- Change.RelationRemove
- Change.Snapshot
- Change.Snapshot.LogHeadsEntry
- Change.StoreKeySet
- Change.StoreKeyUnset
- Change.StoreSliceUpdate
- Change.StoreSliceUpdate.Add
- Change.StoreSliceUpdate.Move
- Change.StoreSliceUpdate.Remove
- Change._RelationAdd
- Change._RelationRemove
- Change._RelationUpdate
- Change._RelationUpdate.Dict
- Change._RelationUpdate.ObjectTypes
-
-
pkg/lib/pb/model/protos/models.proto
pb/protos/service/service.proto
ClientCommands
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 | |
version | uint32 | version of business logic |
Change.BlockCreate
Field | Type | Label | Description |
---|---|---|---|
targetId | string | ||
position | model.Block.Position | ||
blocks | model.Block | repeated |
Change.BlockDuplicate
Field | Type | Label | Description |
---|---|---|---|
targetId | string | ||
position | model.Block.Position | ||
ids | string | repeated |
Change.BlockMove
Field | Type | Label | Description |
---|---|---|---|
targetId | string | ||
position | model.Block.Position | ||
ids | string | repeated |
Change.BlockRemove
Field | Type | Label | Description |
---|---|---|---|
ids | string | repeated |
Change.BlockUpdate
Field | Type | Label | Description |
---|---|---|---|
events | Event.Message | repeated |
Change.Content
Field | Type | Label | Description |
---|---|---|---|
blockCreate | Change.BlockCreate | ||
blockUpdate | Change.BlockUpdate | ||
blockRemove | Change.BlockRemove | ||
blockMove | Change.BlockMove | ||
blockDuplicate | Change.BlockDuplicate | ||
relationAdd | Change.RelationAdd | ||
relationRemove | Change.RelationRemove | ||
detailsSet | Change.DetailsSet | ||
detailsUnset | Change.DetailsUnset | ||
old_relationAdd | Change._RelationAdd | deprecated | |
old_relationRemove | Change._RelationRemove | ||
old_relationUpdate | Change._RelationUpdate | ||
objectTypeAdd | Change.ObjectTypeAdd | ||
objectTypeRemove | Change.ObjectTypeRemove | ||
storeKeySet | Change.StoreKeySet | ||
storeKeyUnset | Change.StoreKeyUnset | ||
storeSliceUpdate | Change.StoreSliceUpdate |
Change.DetailsSet
Field | Type | Label | Description |
---|---|---|---|
key | string | ||
value | google.protobuf.Value |
Change.DetailsUnset
Field | Type | Label | Description |
---|---|---|---|
key | string |
Change.FileKeys
Field | Type | Label | Description |
---|---|---|---|
hash | string | ||
keys | Change.FileKeys.KeysEntry | repeated |
Change.FileKeys.KeysEntry
Field | Type | Label | Description |
---|---|---|---|
key | string | ||
value | string |
Change.ObjectTypeAdd
Field | Type | Label | Description |
---|---|---|---|
url | string |
Change.ObjectTypeRemove
Field | Type | Label | Description |
---|---|---|---|
url | string |
Change.RelationAdd
Field | Type | Label | Description |
---|---|---|---|
relationLinks | model.RelationLink | repeated |
Change.RelationRemove
Field | Type | Label | Description |
---|---|---|---|
relationKey | string | repeated |
Change.Snapshot
Field | Type | Label | Description |
---|---|---|---|
logHeads | Change.Snapshot.LogHeadsEntry | repeated | logId -> lastChangeId |
data | model.SmartBlockSnapshotBase | snapshot data | |
fileKeys | Change.FileKeys | repeated | all file keys related to doc |
Change.Snapshot.LogHeadsEntry
Field | Type | Label | Description |
---|---|---|---|
key | string | ||
value | string |
Change.StoreKeySet
Field | Type | Label | Description |
---|---|---|---|
path | string | repeated | |
value | google.protobuf.Value |
Change.StoreKeyUnset
Field | Type | Label | Description |
---|---|---|---|
path | string | repeated |
Change.StoreSliceUpdate
Field | Type | Label | Description |
---|---|---|---|
key | string | ||
add | Change.StoreSliceUpdate.Add | ||
remove | Change.StoreSliceUpdate.Remove | ||
move | Change.StoreSliceUpdate.Move |
Change.StoreSliceUpdate.Add
Field | Type | Label | Description |
---|---|---|---|
afterId | string | ||
ids | string | repeated |
Change.StoreSliceUpdate.Move
Field | Type | Label | Description |
---|---|---|---|
afterId | string | ||
ids | string | repeated |
Change.StoreSliceUpdate.Remove
Field | Type | Label | Description |
---|---|---|---|
ids | string | repeated |
Change._RelationAdd
Field | Type | Label | Description |
---|---|---|---|
relation | model.Relation |
Change._RelationRemove
Field | Type | Label | Description |
---|---|---|---|
key | string |
Change._RelationUpdate
Field | Type | Label | Description |
---|---|---|---|
key | string | ||
format | model.RelationFormat | ||
name | string | ||
defaultValue | google.protobuf.Value | ||
objectTypes | Change._RelationUpdate.ObjectTypes | ||
multi | bool | ||
selectDict | Change._RelationUpdate.Dict |
Change._RelationUpdate.Dict
Field | Type | Label | Description |
---|---|---|---|
dict | model.Relation.Option | repeated |
Change._RelationUpdate.ObjectTypes
Field | Type | Label | Description |
---|---|---|---|
objectTypes | string | repeated |
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
Rpc.Account.Config
Field | Type | Label | Description |
---|---|---|---|
enableDataview | bool | ||
enableDebug | bool | ||
enablePrereleaseChannel | bool | ||
enableSpaces | bool | ||
extra | google.protobuf.Struct |
Rpc.Account.ConfigUpdate
Rpc.Account.ConfigUpdate.Request
Field | Type | Label | Description |
---|---|---|---|
timeZone | string | ||
IPFSStorageAddr | string |
Rpc.Account.ConfigUpdate.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Account.ConfigUpdate.Response.Error |
Rpc.Account.ConfigUpdate.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Account.ConfigUpdate.Response.Error.Code | ||
description | string |
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 | |
storePath | string | Path to local storage | |
icon | int64 | Option of pre-installed icon | |
alphaInviteCode | string | DEPRECATED |
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
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Account.Create.Response.Error | Error while trying to create an account | |
account | model.Account | A newly created account; In case of a failure, i.e. error is non-NULL, the account model should contain empty/default-value fields | |
config | Rpc.Account.Config | deprecated, use account |
Rpc.Account.Create.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Account.Create.Response.Error.Code | ||
description | string |
Rpc.Account.Delete
Rpc.Account.Delete.Request
Field | Type | Label | Description |
---|---|---|---|
revert | bool |
Rpc.Account.Delete.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Account.Delete.Response.Error | Error while trying to recover an account | |
status | model.Account.Status |
Rpc.Account.Delete.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Account.Delete.Response.Error.Code | ||
description | string |
Rpc.Account.GetConfig
Rpc.Account.GetConfig.Get
Rpc.Account.GetConfig.Get.Request
Rpc.Account.Move
Rpc.Account.Move.Request
Front-end-to-middleware request to move a account to a new disk location
Field | Type | Label | Description |
---|---|---|---|
newPath | string |
Rpc.Account.Move.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Account.Move.Response.Error |
Rpc.Account.Move.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Account.Move.Response.Error.Code | ||
description | string |
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
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Account.Recover.Response.Error | Error while trying to recover an account |
Rpc.Account.Recover.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Account.Recover.Response.Error.Code | ||
description | string |
Rpc.Account.RecoverFromLegacyExport
Rpc.Account.RecoverFromLegacyExport.Request
Field | Type | Label | Description |
---|---|---|---|
path | string | ||
rootPath | string | ||
icon | int64 |
Rpc.Account.RecoverFromLegacyExport.Response
Field | Type | Label | Description |
---|---|---|---|
accountId | string | ||
error | Rpc.Account.RecoverFromLegacyExport.Response.Error |
Rpc.Account.RecoverFromLegacyExport.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Account.RecoverFromLegacyExport.Response.Error.Code | ||
description | string |
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
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Account.Select.Response.Error | Error while trying to launch/select an account | |
account | model.Account | Selected account | |
config | Rpc.Account.Config | deprecated, use account |
Rpc.Account.Select.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Account.Select.Response.Error.Code | ||
description | string |
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
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Account.Stop.Response.Error | Error while trying to launch/select an account |
Rpc.Account.Stop.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Account.Stop.Response.Error.Code | ||
description | string |
Rpc.App
Rpc.App.GetVersion
Rpc.App.GetVersion.Request
Rpc.App.GetVersion.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.App.GetVersion.Response.Error | ||
version | string | ||
details | string | build date, branch and commit |
Rpc.App.GetVersion.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.App.GetVersion.Response.Error.Code | ||
description | string |
Rpc.App.SetDeviceState
Rpc.App.SetDeviceState.Request
Field | Type | Label | Description |
---|---|---|---|
deviceState | Rpc.App.SetDeviceState.Request.DeviceState |
Rpc.App.SetDeviceState.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.App.SetDeviceState.Response.Error |
Rpc.App.SetDeviceState.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.App.SetDeviceState.Response.Error.Code | ||
description | string |
Rpc.App.Shutdown
Rpc.App.Shutdown.Request
Rpc.App.Shutdown.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.App.Shutdown.Response.Error |
Rpc.App.Shutdown.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.App.Shutdown.Response.Error.Code | ||
description | string |
Rpc.Block
Block commands
Rpc.Block.Copy
Rpc.Block.Copy.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blocks | model.Block | repeated | |
selectedTextRange | model.Range |
Rpc.Block.Copy.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Block.Copy.Response.Error | ||
textSlot | string | ||
htmlSlot | string | ||
anySlot | model.Block | repeated |
Rpc.Block.Copy.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Block.Copy.Response.Error.Code | ||
description | string |
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
Field | Type | Label | Description |
---|---|---|---|
contextId | string | id of the context object | |
targetId | string | id of the closest block | |
block | model.Block | ||
position | model.Block.Position |
Rpc.Block.Create.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Block.Create.Response.Error | ||
blockId | string | ||
event | ResponseEvent |
Rpc.Block.Create.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Block.Create.Response.Error.Code | ||
description | string |
Rpc.Block.CreateWidget
Rpc.Block.CreateWidget.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | id of the context object | |
targetId | string | id of the closest block | |
block | model.Block | ||
position | model.Block.Position | ||
widgetLayout | model.Block.Content.Widget.Layout | ||
objectLimit | int32 | ||
viewId | string |
Rpc.Block.CreateWidget.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Block.CreateWidget.Response.Error | ||
blockId | string | ||
event | ResponseEvent |
Rpc.Block.CreateWidget.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Block.CreateWidget.Response.Error.Code | ||
description | string |
Rpc.Block.Cut
Rpc.Block.Cut.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blocks | model.Block | repeated | |
selectedTextRange | model.Range |
Rpc.Block.Cut.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Block.Cut.Response.Error | ||
textSlot | string | ||
htmlSlot | string | ||
anySlot | model.Block | repeated | |
event | ResponseEvent |
Rpc.Block.Cut.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Block.Cut.Response.Error.Code | ||
description | string |
Rpc.Block.Download
Rpc.Block.Download.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockId | string |
Rpc.Block.Download.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Block.Download.Response.Error | ||
event | ResponseEvent |
Rpc.Block.Download.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Block.Download.Response.Error.Code | ||
description | string |
Rpc.Block.Export
Rpc.Block.Export.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blocks | model.Block | repeated |
Rpc.Block.Export.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Block.Export.Response.Error | ||
path | string | ||
event | ResponseEvent |
Rpc.Block.Export.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Block.Export.Response.Error.Code | ||
description | string |
Rpc.Block.ListConvertToObjects
Rpc.Block.ListConvertToObjects.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockIds | string | repeated | |
objectType | string |
Rpc.Block.ListConvertToObjects.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Block.ListConvertToObjects.Response.Error | ||
linkIds | string | repeated | |
event | ResponseEvent |
Rpc.Block.ListConvertToObjects.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Block.ListConvertToObjects.Response.Error.Code | ||
description | string |
Rpc.Block.ListDelete
Remove blocks from the childrenIds of its parents
Rpc.Block.ListDelete.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | id of the context object | |
blockIds | string | repeated | targets to remove |
Rpc.Block.ListDelete.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Block.ListDelete.Response.Error | ||
event | ResponseEvent |
Rpc.Block.ListDelete.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Block.ListDelete.Response.Error.Code | ||
description | string |
Rpc.Block.ListDuplicate
Makes blocks copy by given ids and paste it to shown place
Rpc.Block.ListDuplicate.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | id of the context object | |
targetId | string | id of the closest block | |
blockIds | string | repeated | id of block for duplicate |
position | model.Block.Position | ||
targetContextId | string |
Rpc.Block.ListDuplicate.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Block.ListDuplicate.Response.Error | ||
blockIds | string | repeated | |
event | ResponseEvent |
Rpc.Block.ListDuplicate.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Block.ListDuplicate.Response.Error.Code | ||
description | string |
Rpc.Block.ListMoveToExistingObject
Rpc.Block.ListMoveToExistingObject.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.Block.ListMoveToExistingObject.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Block.ListMoveToExistingObject.Response.Error | ||
event | ResponseEvent |
Rpc.Block.ListMoveToExistingObject.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Block.ListMoveToExistingObject.Response.Error.Code | ||
description | string |
Rpc.Block.ListMoveToNewObject
Rpc.Block.ListMoveToNewObject.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockIds | string | repeated | |
details | google.protobuf.Struct | new object details | |
dropTargetId | string | id of the simple block to insert considering position | |
position | model.Block.Position | position relatively to the dropTargetId simple block |
Rpc.Block.ListMoveToNewObject.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Block.ListMoveToNewObject.Response.Error | ||
linkId | string | ||
event | ResponseEvent |
Rpc.Block.ListMoveToNewObject.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Block.ListMoveToNewObject.Response.Error.Code | ||
description | string |
Rpc.Block.ListSetAlign
Rpc.Block.ListSetAlign.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockIds | string | repeated | when empty - align will be applied as layoutAlign |
align | model.Block.Align |
Rpc.Block.ListSetAlign.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Block.ListSetAlign.Response.Error | ||
event | ResponseEvent |
Rpc.Block.ListSetAlign.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Block.ListSetAlign.Response.Error.Code | ||
description | string |
Rpc.Block.ListSetBackgroundColor
Rpc.Block.ListSetBackgroundColor.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockIds | string | repeated | |
color | string |
Rpc.Block.ListSetBackgroundColor.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Block.ListSetBackgroundColor.Response.Error | ||
event | ResponseEvent |
Rpc.Block.ListSetBackgroundColor.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Block.ListSetBackgroundColor.Response.Error.Code | ||
description | string |
Rpc.Block.ListSetFields
Rpc.Block.ListSetFields.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockFields | Rpc.Block.ListSetFields.Request.BlockField | repeated |
Rpc.Block.ListSetFields.Request.BlockField
Field | Type | Label | Description |
---|---|---|---|
blockId | string | ||
fields | google.protobuf.Struct |
Rpc.Block.ListSetFields.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Block.ListSetFields.Response.Error | ||
event | ResponseEvent |
Rpc.Block.ListSetFields.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Block.ListSetFields.Response.Error.Code | ||
description | string |
Rpc.Block.ListSetVerticalAlign
Rpc.Block.ListSetVerticalAlign.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | id of the context object | |
blockIds | string | repeated | |
verticalAlign | model.Block.VerticalAlign |
Rpc.Block.ListSetVerticalAlign.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Block.ListSetVerticalAlign.Response.Error | ||
event | ResponseEvent |
Rpc.Block.ListSetVerticalAlign.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Block.ListSetVerticalAlign.Response.Error.Code | ||
description | string |
Rpc.Block.ListTurnInto
Rpc.Block.ListTurnInto.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockIds | string | repeated | |
style | model.Block.Content.Text.Style |
Rpc.Block.ListTurnInto.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Block.ListTurnInto.Response.Error | ||
event | ResponseEvent |
Rpc.Block.ListTurnInto.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Block.ListTurnInto.Response.Error.Code | ||
description | string |
Rpc.Block.ListUpdate
Rpc.Block.ListUpdate.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockIds | string | repeated | |
text | Rpc.Block.ListUpdate.Request.Text | ||
backgroundColor | string | ||
align | model.Block.Align | ||
fields | google.protobuf.Struct | ||
divStyle | model.Block.Content.Div.Style | ||
fileStyle | model.Block.Content.File.Style |
Rpc.Block.ListUpdate.Request.Text
Field | Type | Label | Description |
---|---|---|---|
style | model.Block.Content.Text.Style | ||
color | string | ||
mark | model.Block.Content.Text.Mark |
Rpc.Block.Merge
Rpc.Block.Merge.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
firstBlockId | string | ||
secondBlockId | string |
Rpc.Block.Merge.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Block.Merge.Response.Error | ||
event | ResponseEvent |
Rpc.Block.Merge.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Block.Merge.Response.Error.Code | ||
description | string |
Rpc.Block.Paste
Rpc.Block.Paste.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
focusedBlockId | string | ||
selectedTextRange | model.Range | ||
selectedBlockIds | string | repeated | |
isPartOfBlock | bool | ||
textSlot | string | ||
htmlSlot | string | ||
anySlot | model.Block | repeated | |
fileSlot | Rpc.Block.Paste.Request.File | repeated |
Rpc.Block.Paste.Request.File
Field | Type | Label | Description |
---|---|---|---|
name | string | ||
data | bytes | ||
localPath | string |
Rpc.Block.Paste.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Block.Paste.Response.Error | ||
blockIds | string | repeated | |
caretPosition | int32 | ||
isSameBlockCaret | bool | ||
event | ResponseEvent |
Rpc.Block.Paste.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Block.Paste.Response.Error.Code | ||
description | string |
Rpc.Block.Replace
Rpc.Block.Replace.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockId | string | ||
block | model.Block |
Rpc.Block.Replace.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Block.Replace.Response.Error | ||
blockId | string | ||
event | ResponseEvent |
Rpc.Block.Replace.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Block.Replace.Response.Error.Code | ||
description | string |
Rpc.Block.SetFields
Rpc.Block.SetFields.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockId | string | ||
fields | google.protobuf.Struct |
Rpc.Block.SetFields.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Block.SetFields.Response.Error | ||
event | ResponseEvent |
Rpc.Block.SetFields.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Block.SetFields.Response.Error.Code | ||
description | string |
Rpc.Block.Split
Rpc.Block.Split.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockId | string | ||
range | model.Range | ||
style | model.Block.Content.Text.Style | ||
mode | Rpc.Block.Split.Request.Mode |
Rpc.Block.Split.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Block.Split.Response.Error | ||
blockId | string | ||
event | ResponseEvent |
Rpc.Block.Split.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Block.Split.Response.Error.Code | ||
description | string |
Rpc.Block.Upload
Rpc.Block.Upload.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockId | string | ||
filePath | string | ||
url | string |
Rpc.Block.Upload.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Block.Upload.Response.Error | ||
event | ResponseEvent |
Rpc.Block.Upload.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Block.Upload.Response.Error.Code | ||
description | string |
Rpc.BlockBookmark
Rpc.BlockBookmark.CreateAndFetch
Rpc.BlockBookmark.CreateAndFetch.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
targetId | string | ||
position | model.Block.Position | ||
url | string |
Rpc.BlockBookmark.CreateAndFetch.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockBookmark.CreateAndFetch.Response.Error | ||
blockId | string | ||
event | ResponseEvent |
Rpc.BlockBookmark.CreateAndFetch.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockBookmark.CreateAndFetch.Response.Error.Code | ||
description | string |
Rpc.BlockBookmark.Fetch
Rpc.BlockBookmark.Fetch.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockId | string | ||
url | string |
Rpc.BlockBookmark.Fetch.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockBookmark.Fetch.Response.Error | ||
event | ResponseEvent |
Rpc.BlockBookmark.Fetch.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockBookmark.Fetch.Response.Error.Code | ||
description | string |
Rpc.BlockDataview
Rpc.BlockDataview.CreateBookmark
Rpc.BlockDataview.CreateBookmark.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockId | string | ||
url | string |
Rpc.BlockDataview.CreateBookmark.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockDataview.CreateBookmark.Response.Error | ||
id | string |
Rpc.BlockDataview.CreateBookmark.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockDataview.CreateBookmark.Response.Error.Code | ||
description | string |
Rpc.BlockDataview.CreateFromExistingObject
Rpc.BlockDataview.CreateFromExistingObject.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockId | string | ||
targetObjectId | string |
Rpc.BlockDataview.CreateFromExistingObject.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockDataview.CreateFromExistingObject.Response.Error | ||
blockId | string | ||
targetObjectId | string | ||
view | model.Block.Content.Dataview.View | repeated | |
event | ResponseEvent |
Rpc.BlockDataview.CreateFromExistingObject.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockDataview.CreateFromExistingObject.Response.Error.Code | ||
description | string |
Rpc.BlockDataview.Filter
Rpc.BlockDataview.Filter.Add
Rpc.BlockDataview.Filter.Add.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockId | string | id of dataview block to update | |
viewId | string | id of view to update | |
filter | model.Block.Content.Dataview.Filter |
Rpc.BlockDataview.Filter.Add.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockDataview.Filter.Add.Response.Error | ||
event | ResponseEvent |
Rpc.BlockDataview.Filter.Add.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockDataview.Filter.Add.Response.Error.Code | ||
description | string |
Rpc.BlockDataview.Filter.Remove
Rpc.BlockDataview.Filter.Remove.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockId | string | id of dataview block to update | |
viewId | string | id of view to update | |
ids | string | repeated |
Rpc.BlockDataview.Filter.Remove.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockDataview.Filter.Remove.Response.Error | ||
event | ResponseEvent |
Rpc.BlockDataview.Filter.Remove.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockDataview.Filter.Remove.Response.Error.Code | ||
description | string |
Rpc.BlockDataview.Filter.Replace
Rpc.BlockDataview.Filter.Replace.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockId | string | id of dataview block to update | |
viewId | string | id of view to update | |
id | string | ||
filter | model.Block.Content.Dataview.Filter |
Rpc.BlockDataview.Filter.Replace.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockDataview.Filter.Replace.Response.Error | ||
event | ResponseEvent |
Rpc.BlockDataview.Filter.Replace.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockDataview.Filter.Replace.Response.Error.Code | ||
description | string |
Rpc.BlockDataview.Filter.Sort
Rpc.BlockDataview.Filter.Sort.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockId | string | id of dataview block to update | |
viewId | string | id of view to update | |
ids | string | repeated | new order of filters |
Rpc.BlockDataview.Filter.Sort.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockDataview.Filter.Sort.Response.Error | ||
event | ResponseEvent |
Rpc.BlockDataview.Filter.Sort.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockDataview.Filter.Sort.Response.Error.Code | ||
description | string |
Rpc.BlockDataview.GroupOrder
Rpc.BlockDataview.GroupOrder.Update
Rpc.BlockDataview.GroupOrder.Update.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockId | string | ||
groupOrder | model.Block.Content.Dataview.GroupOrder |
Rpc.BlockDataview.GroupOrder.Update.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockDataview.GroupOrder.Update.Response.Error | ||
event | ResponseEvent |
Rpc.BlockDataview.GroupOrder.Update.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockDataview.GroupOrder.Update.Response.Error.Code | ||
description | string |
Rpc.BlockDataview.ObjectOrder
Rpc.BlockDataview.ObjectOrder.Move
Rpc.BlockDataview.ObjectOrder.Move.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockId | string | ||
viewId | string | ||
groupId | string | ||
afterId | string | ||
objectIds | string | repeated |
Rpc.BlockDataview.ObjectOrder.Move.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockDataview.ObjectOrder.Move.Response.Error | ||
event | ResponseEvent |
Rpc.BlockDataview.ObjectOrder.Move.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockDataview.ObjectOrder.Move.Response.Error.Code | ||
description | string |
Rpc.BlockDataview.ObjectOrder.Update
Rpc.BlockDataview.ObjectOrder.Update.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockId | string | ||
objectOrders | model.Block.Content.Dataview.ObjectOrder | repeated |
Rpc.BlockDataview.ObjectOrder.Update.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockDataview.ObjectOrder.Update.Response.Error | ||
event | ResponseEvent |
Rpc.BlockDataview.ObjectOrder.Update.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockDataview.ObjectOrder.Update.Response.Error.Code | ||
description | string |
Rpc.BlockDataview.Relation
Rpc.BlockDataview.Relation.Add
Rpc.BlockDataview.Relation.Add.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockId | string | id of dataview block to add relation | |
relationKeys | string | repeated |
Rpc.BlockDataview.Relation.Add.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockDataview.Relation.Add.Response.Error | ||
event | ResponseEvent |
Rpc.BlockDataview.Relation.Add.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockDataview.Relation.Add.Response.Error.Code | ||
description | string |
Rpc.BlockDataview.Relation.Delete
Rpc.BlockDataview.Relation.Delete.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockId | string | id of dataview block to add relation | |
relationKeys | string | repeated |
Rpc.BlockDataview.Relation.Delete.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockDataview.Relation.Delete.Response.Error | ||
event | ResponseEvent |
Rpc.BlockDataview.Relation.Delete.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockDataview.Relation.Delete.Response.Error.Code | ||
description | string |
Rpc.BlockDataview.Relation.ListAvailable
Rpc.BlockDataview.Relation.ListAvailable.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockId | string |
Rpc.BlockDataview.Relation.ListAvailable.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockDataview.Relation.ListAvailable.Response.Error | ||
relations | model.Relation | repeated |
Rpc.BlockDataview.Relation.ListAvailable.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockDataview.Relation.ListAvailable.Response.Error.Code | ||
description | string |
Rpc.BlockDataview.SetSource
Rpc.BlockDataview.SetSource.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockId | string | ||
source | string | repeated |
Rpc.BlockDataview.SetSource.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockDataview.SetSource.Response.Error | ||
event | ResponseEvent |
Rpc.BlockDataview.SetSource.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockDataview.SetSource.Response.Error.Code | ||
description | string |
Rpc.BlockDataview.Sort
Rpc.BlockDataview.Sort.Add
Rpc.BlockDataview.Sort.Add.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockId | string | id of dataview block to update | |
viewId | string | id of view to update | |
sort | model.Block.Content.Dataview.Sort |
Rpc.BlockDataview.Sort.Add.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockDataview.Sort.Add.Response.Error | ||
event | ResponseEvent |
Rpc.BlockDataview.Sort.Add.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockDataview.Sort.Add.Response.Error.Code | ||
description | string |
Rpc.BlockDataview.Sort.Remove
Rpc.BlockDataview.Sort.Remove.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockId | string | id of dataview block to update | |
viewId | string | id of view to update | |
ids | string | repeated |
Rpc.BlockDataview.Sort.Remove.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockDataview.Sort.Remove.Response.Error | ||
event | ResponseEvent |
Rpc.BlockDataview.Sort.Remove.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockDataview.Sort.Remove.Response.Error.Code | ||
description | string |
Rpc.BlockDataview.Sort.Replace
Rpc.BlockDataview.Sort.Replace.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockId | string | id of dataview block to update | |
viewId | string | id of view to update | |
id | string | ||
sort | model.Block.Content.Dataview.Sort |
Rpc.BlockDataview.Sort.Replace.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockDataview.Sort.Replace.Response.Error | ||
event | ResponseEvent |
Rpc.BlockDataview.Sort.Replace.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockDataview.Sort.Replace.Response.Error.Code | ||
description | string |
Rpc.BlockDataview.Sort.Sort
Rpc.BlockDataview.Sort.Sort.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockId | string | id of dataview block to update | |
viewId | string | id of view to update | |
ids | string | repeated | new order of sorts |
Rpc.BlockDataview.Sort.Sort.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockDataview.Sort.Sort.Response.Error | ||
event | ResponseEvent |
Rpc.BlockDataview.Sort.Sort.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockDataview.Sort.Sort.Response.Error.Code | ||
description | string |
Rpc.BlockDataview.View
Rpc.BlockDataview.View.Create
Rpc.BlockDataview.View.Create.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockId | string | id of dataview block to insert the new block | |
view | model.Block.Content.Dataview.View | ||
source | string | repeated |
Rpc.BlockDataview.View.Create.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockDataview.View.Create.Response.Error | ||
event | ResponseEvent | ||
viewId | string |
Rpc.BlockDataview.View.Create.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockDataview.View.Create.Response.Error.Code | ||
description | string |
Rpc.BlockDataview.View.Delete
Rpc.BlockDataview.View.Delete.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | id of the context object | |
blockId | string | id of the dataview | |
viewId | string | id of the view to remove |
Rpc.BlockDataview.View.Delete.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockDataview.View.Delete.Response.Error | ||
event | ResponseEvent |
Rpc.BlockDataview.View.Delete.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockDataview.View.Delete.Response.Error.Code | ||
description | string |
Rpc.BlockDataview.View.SetActive
set the current active view (persisted only within a session)
Rpc.BlockDataview.View.SetActive.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockId | string | id of dataview block | |
viewId | string | id of active view | |
offset | uint32 | ||
limit | uint32 |
Rpc.BlockDataview.View.SetActive.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockDataview.View.SetActive.Response.Error | ||
event | ResponseEvent |
Rpc.BlockDataview.View.SetActive.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockDataview.View.SetActive.Response.Error.Code | ||
description | string |
Rpc.BlockDataview.View.SetPosition
Rpc.BlockDataview.View.SetPosition.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | id of the context object | |
blockId | string | id of the dataview | |
viewId | string | id of the view to remove | |
position | uint32 | index of view position (0 - means first) |
Rpc.BlockDataview.View.SetPosition.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockDataview.View.SetPosition.Response.Error | ||
event | ResponseEvent |
Rpc.BlockDataview.View.SetPosition.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockDataview.View.SetPosition.Response.Error.Code | ||
description | string |
Rpc.BlockDataview.View.Update
Rpc.BlockDataview.View.Update.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockId | string | id of dataview block to update | |
viewId | string | id of view to update | |
view | model.Block.Content.Dataview.View |
Rpc.BlockDataview.View.Update.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockDataview.View.Update.Response.Error | ||
event | ResponseEvent |
Rpc.BlockDataview.View.Update.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockDataview.View.Update.Response.Error.Code | ||
description | string |
Rpc.BlockDataview.ViewRelation
Rpc.BlockDataview.ViewRelation.Add
Rpc.BlockDataview.ViewRelation.Add.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockId | string | id of dataview block to update | |
viewId | string | id of view to update | |
relation | model.Block.Content.Dataview.Relation |
Rpc.BlockDataview.ViewRelation.Add.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockDataview.ViewRelation.Add.Response.Error | ||
event | ResponseEvent |
Rpc.BlockDataview.ViewRelation.Add.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockDataview.ViewRelation.Add.Response.Error.Code | ||
description | string |
Rpc.BlockDataview.ViewRelation.Remove
Rpc.BlockDataview.ViewRelation.Remove.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockId | string | id of dataview block to update | |
viewId | string | id of view to update | |
relationKeys | string | repeated |
Rpc.BlockDataview.ViewRelation.Remove.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockDataview.ViewRelation.Remove.Response.Error | ||
event | ResponseEvent |
Rpc.BlockDataview.ViewRelation.Remove.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockDataview.ViewRelation.Remove.Response.Error.Code | ||
description | string |
Rpc.BlockDataview.ViewRelation.Replace
Rpc.BlockDataview.ViewRelation.Replace.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockId | string | id of dataview block to update | |
viewId | string | id of view to update | |
relationKey | string | ||
relation | model.Block.Content.Dataview.Relation |
Rpc.BlockDataview.ViewRelation.Replace.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockDataview.ViewRelation.Replace.Response.Error | ||
event | ResponseEvent |
Rpc.BlockDataview.ViewRelation.Replace.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockDataview.ViewRelation.Replace.Response.Error.Code | ||
description | string |
Rpc.BlockDataview.ViewRelation.Sort
Rpc.BlockDataview.ViewRelation.Sort.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockId | string | id of dataview block to update | |
viewId | string | id of view to update | |
relationKeys | string | repeated | new order of relations |
Rpc.BlockDataview.ViewRelation.Sort.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockDataview.ViewRelation.Sort.Response.Error | ||
event | ResponseEvent |
Rpc.BlockDataview.ViewRelation.Sort.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockDataview.ViewRelation.Sort.Response.Error.Code | ||
description | string |
Rpc.BlockDiv
Rpc.BlockDiv.ListSetStyle
Rpc.BlockDiv.ListSetStyle.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockIds | string | repeated | |
style | model.Block.Content.Div.Style |
Rpc.BlockDiv.ListSetStyle.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockDiv.ListSetStyle.Response.Error | ||
event | ResponseEvent |
Rpc.BlockDiv.ListSetStyle.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockDiv.ListSetStyle.Response.Error.Code | ||
description | string |
Rpc.BlockFile
Rpc.BlockFile.CreateAndUpload
Rpc.BlockFile.CreateAndUpload.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
targetId | string | ||
position | model.Block.Position | ||
url | string | ||
localPath | string | ||
fileType | model.Block.Content.File.Type |
Rpc.BlockFile.CreateAndUpload.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockFile.CreateAndUpload.Response.Error | ||
blockId | string | ||
event | ResponseEvent |
Rpc.BlockFile.CreateAndUpload.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockFile.CreateAndUpload.Response.Error.Code | ||
description | string |
Rpc.BlockFile.ListSetStyle
Rpc.BlockFile.ListSetStyle.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockIds | string | repeated | |
style | model.Block.Content.File.Style |
Rpc.BlockFile.ListSetStyle.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockFile.ListSetStyle.Response.Error | ||
event | ResponseEvent |
Rpc.BlockFile.ListSetStyle.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockFile.ListSetStyle.Response.Error.Code | ||
description | string |
Rpc.BlockFile.SetName
Rpc.BlockFile.SetName.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockId | string | ||
name | string |
Rpc.BlockFile.SetName.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockFile.SetName.Response.Error | ||
event | ResponseEvent |
Rpc.BlockFile.SetName.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockFile.SetName.Response.Error.Code | ||
description | string |
Rpc.BlockImage
Rpc.BlockImage.SetName
Rpc.BlockImage.SetName.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockId | string | ||
name | string |
Rpc.BlockImage.SetName.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockImage.SetName.Response.Error |
Rpc.BlockImage.SetName.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockImage.SetName.Response.Error.Code | ||
description | string |
Rpc.BlockImage.SetWidth
Rpc.BlockImage.SetWidth.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockId | string | ||
width | int32 |
Rpc.BlockImage.SetWidth.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockImage.SetWidth.Response.Error |
Rpc.BlockImage.SetWidth.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockImage.SetWidth.Response.Error.Code | ||
description | string |
Rpc.BlockLatex
Rpc.BlockLatex.SetText
Rpc.BlockLatex.SetText.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockId | string | ||
text | string |
Rpc.BlockLatex.SetText.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockLatex.SetText.Response.Error | ||
event | ResponseEvent |
Rpc.BlockLatex.SetText.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockLatex.SetText.Response.Error.Code | ||
description | string |
Rpc.BlockLink
Rpc.BlockLink.CreateWithObject
Rpc.BlockLink.CreateWithObject.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | id of the context object | |
details | google.protobuf.Struct | new object details | |
templateId | string | optional template id for creating from template | |
internalFlags | model.InternalFlag | repeated | |
targetId | string | link block params |
id of the closest simple block | | position | model.Block.Position | | | | fields | google.protobuf.Struct | | link block fields |
Rpc.BlockLink.CreateWithObject.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockLink.CreateWithObject.Response.Error | ||
blockId | string | ||
targetId | string | ||
event | ResponseEvent |
Rpc.BlockLink.CreateWithObject.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockLink.CreateWithObject.Response.Error.Code | ||
description | string |
Rpc.BlockLink.ListSetAppearance
Rpc.BlockLink.ListSetAppearance.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockIds | string | repeated | |
iconSize | model.Block.Content.Link.IconSize | ||
cardStyle | model.Block.Content.Link.CardStyle | ||
description | model.Block.Content.Link.Description | ||
relations | string | repeated |
Rpc.BlockLink.ListSetAppearance.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockLink.ListSetAppearance.Response.Error | ||
event | ResponseEvent |
Rpc.BlockLink.ListSetAppearance.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockLink.ListSetAppearance.Response.Error.Code | ||
description | string |
Rpc.BlockRelation
Rpc.BlockRelation.Add
Rpc.BlockRelation.Add.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockId | string | ||
relationKey | string |
Rpc.BlockRelation.Add.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockRelation.Add.Response.Error | ||
event | ResponseEvent |
Rpc.BlockRelation.Add.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockRelation.Add.Response.Error.Code | ||
description | string |
Rpc.BlockRelation.SetKey
Rpc.BlockRelation.SetKey.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockId | string | ||
key | string |
Rpc.BlockRelation.SetKey.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockRelation.SetKey.Response.Error | ||
event | ResponseEvent |
Rpc.BlockRelation.SetKey.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockRelation.SetKey.Response.Error.Code | ||
description | string |
Rpc.BlockTable
Rpc.BlockTable.ColumnCreate
Rpc.BlockTable.ColumnCreate.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | id of the context object | |
targetId | string | id of the closest column | |
position | model.Block.Position |
Rpc.BlockTable.ColumnCreate.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockTable.ColumnCreate.Response.Error | ||
event | ResponseEvent |
Rpc.BlockTable.ColumnCreate.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockTable.ColumnCreate.Response.Error.Code | ||
description | string |
Rpc.BlockTable.ColumnDelete
Rpc.BlockTable.ColumnDelete.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | id of the context object | |
targetId | string | id of the closest column |
Rpc.BlockTable.ColumnDelete.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockTable.ColumnDelete.Response.Error | ||
event | ResponseEvent |
Rpc.BlockTable.ColumnDelete.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockTable.ColumnDelete.Response.Error.Code | ||
description | string |
Rpc.BlockTable.ColumnDuplicate
Rpc.BlockTable.ColumnDuplicate.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | id of the context object | |
targetId | string | ||
blockId | string | block to duplicate | |
position | model.Block.Position |
Rpc.BlockTable.ColumnDuplicate.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockTable.ColumnDuplicate.Response.Error | ||
blockId | string | ||
event | ResponseEvent |
Rpc.BlockTable.ColumnDuplicate.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockTable.ColumnDuplicate.Response.Error.Code | ||
description | string |
Rpc.BlockTable.ColumnListFill
Rpc.BlockTable.ColumnListFill.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | id of the context object | |
blockIds | string | repeated |
Rpc.BlockTable.ColumnListFill.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockTable.ColumnListFill.Response.Error | ||
event | ResponseEvent |
Rpc.BlockTable.ColumnListFill.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockTable.ColumnListFill.Response.Error.Code | ||
description | string |
Rpc.BlockTable.ColumnMove
Rpc.BlockTable.ColumnMove.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
targetId | string | ||
dropTargetId | string | ||
position | model.Block.Position |
Rpc.BlockTable.ColumnMove.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockTable.ColumnMove.Response.Error | ||
event | ResponseEvent |
Rpc.BlockTable.ColumnMove.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockTable.ColumnMove.Response.Error.Code | ||
description | string |
Rpc.BlockTable.Create
Rpc.BlockTable.Create.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | id of the context object | |
targetId | string | id of the closest block | |
position | model.Block.Position | ||
rows | uint32 | ||
columns | uint32 | ||
withHeaderRow | bool |
Rpc.BlockTable.Create.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockTable.Create.Response.Error | ||
blockId | string | ||
event | ResponseEvent |
Rpc.BlockTable.Create.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockTable.Create.Response.Error.Code | ||
description | string |
Rpc.BlockTable.Expand
Rpc.BlockTable.Expand.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | id of the context object | |
targetId | string | ||
columns | uint32 | number of columns to append | |
rows | uint32 | number of rows to append |
Rpc.BlockTable.Expand.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockTable.Expand.Response.Error | ||
event | ResponseEvent |
Rpc.BlockTable.Expand.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockTable.Expand.Response.Error.Code | ||
description | string |
Rpc.BlockTable.RowCreate
Rpc.BlockTable.RowCreate.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | id of the context object | |
targetId | string | id of the closest row | |
position | model.Block.Position |
Rpc.BlockTable.RowCreate.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockTable.RowCreate.Response.Error | ||
event | ResponseEvent |
Rpc.BlockTable.RowCreate.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockTable.RowCreate.Response.Error.Code | ||
description | string |
Rpc.BlockTable.RowDelete
Rpc.BlockTable.RowDelete.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | id of the context object | |
targetId | string | id of the closest row |
Rpc.BlockTable.RowDelete.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockTable.RowDelete.Response.Error | ||
event | ResponseEvent |
Rpc.BlockTable.RowDelete.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockTable.RowDelete.Response.Error.Code | ||
description | string |
Rpc.BlockTable.RowDuplicate
Rpc.BlockTable.RowDuplicate.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | id of the context object | |
targetId | string | ||
blockId | string | block to duplicate | |
position | model.Block.Position |
Rpc.BlockTable.RowDuplicate.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockTable.RowDuplicate.Response.Error | ||
event | ResponseEvent |
Rpc.BlockTable.RowDuplicate.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockTable.RowDuplicate.Response.Error.Code | ||
description | string |
Rpc.BlockTable.RowListClean
Rpc.BlockTable.RowListClean.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | id of the context object | |
blockIds | string | repeated |
Rpc.BlockTable.RowListClean.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockTable.RowListClean.Response.Error | ||
event | ResponseEvent |
Rpc.BlockTable.RowListClean.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockTable.RowListClean.Response.Error.Code | ||
description | string |
Rpc.BlockTable.RowListFill
Rpc.BlockTable.RowListFill.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | id of the context object | |
blockIds | string | repeated |
Rpc.BlockTable.RowListFill.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockTable.RowListFill.Response.Error | ||
event | ResponseEvent |
Rpc.BlockTable.RowListFill.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockTable.RowListFill.Response.Error.Code | ||
description | string |
Rpc.BlockTable.RowSetHeader
Rpc.BlockTable.RowSetHeader.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | id of the context object | |
targetId | string | ||
isHeader | bool |
Rpc.BlockTable.RowSetHeader.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockTable.RowSetHeader.Response.Error | ||
event | ResponseEvent |
Rpc.BlockTable.RowSetHeader.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockTable.RowSetHeader.Response.Error.Code | ||
description | string |
Rpc.BlockTable.Sort
Rpc.BlockTable.Sort.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | id of the context object | |
columnId | string | ||
type | model.Block.Content.Dataview.Sort.Type |
Rpc.BlockTable.Sort.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockTable.Sort.Response.Error | ||
event | ResponseEvent |
Rpc.BlockTable.Sort.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockTable.Sort.Response.Error.Code | ||
description | string |
Rpc.BlockText
Rpc.BlockText.ListClearContent
Rpc.BlockText.ListClearContent.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockIds | string | repeated |
Rpc.BlockText.ListClearContent.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockText.ListClearContent.Response.Error | ||
event | ResponseEvent |
Rpc.BlockText.ListClearContent.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockText.ListClearContent.Response.Error.Code | ||
description | string |
Rpc.BlockText.ListClearStyle
Rpc.BlockText.ListClearStyle.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockIds | string | repeated |
Rpc.BlockText.ListClearStyle.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockText.ListClearStyle.Response.Error | ||
event | ResponseEvent |
Rpc.BlockText.ListClearStyle.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockText.ListClearStyle.Response.Error.Code | ||
description | string |
Rpc.BlockText.ListSetColor
Rpc.BlockText.ListSetColor.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockIds | string | repeated | |
color | string |
Rpc.BlockText.ListSetColor.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockText.ListSetColor.Response.Error | ||
event | ResponseEvent |
Rpc.BlockText.ListSetColor.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockText.ListSetColor.Response.Error.Code | ||
description | string |
Rpc.BlockText.ListSetMark
Rpc.BlockText.ListSetMark.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockIds | string | repeated | |
mark | model.Block.Content.Text.Mark |
Rpc.BlockText.ListSetMark.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockText.ListSetMark.Response.Error | ||
event | ResponseEvent |
Rpc.BlockText.ListSetMark.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockText.ListSetMark.Response.Error.Code | ||
description | string |
Rpc.BlockText.ListSetStyle
Rpc.BlockText.ListSetStyle.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockIds | string | repeated | |
style | model.Block.Content.Text.Style |
Rpc.BlockText.ListSetStyle.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockText.ListSetStyle.Response.Error | ||
event | ResponseEvent |
Rpc.BlockText.ListSetStyle.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockText.ListSetStyle.Response.Error.Code | ||
description | string |
Rpc.BlockText.SetChecked
Rpc.BlockText.SetChecked.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockId | string | ||
checked | bool |
Rpc.BlockText.SetChecked.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockText.SetChecked.Response.Error | ||
event | ResponseEvent |
Rpc.BlockText.SetChecked.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockText.SetChecked.Response.Error.Code | ||
description | string |
Rpc.BlockText.SetColor
Rpc.BlockText.SetColor.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockId | string | ||
color | string |
Rpc.BlockText.SetColor.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockText.SetColor.Response.Error | ||
event | ResponseEvent |
Rpc.BlockText.SetColor.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockText.SetColor.Response.Error.Code | ||
description | string |
Rpc.BlockText.SetIcon
Rpc.BlockText.SetIcon.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.BlockText.SetIcon.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockText.SetIcon.Response.Error | ||
event | ResponseEvent |
Rpc.BlockText.SetIcon.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockText.SetIcon.Response.Error.Code | ||
description | string |
Rpc.BlockText.SetMarks
Rpc.BlockText.SetMarks.Get
Get marks list in the selected range in text block.
Rpc.BlockText.SetMarks.Get.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockId | string | ||
range | model.Range |
Rpc.BlockText.SetMarks.Get.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockText.SetMarks.Get.Response.Error | ||
event | ResponseEvent |
Rpc.BlockText.SetMarks.Get.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockText.SetMarks.Get.Response.Error.Code | ||
description | string |
Rpc.BlockText.SetStyle
Rpc.BlockText.SetStyle.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockId | string | ||
style | model.Block.Content.Text.Style |
Rpc.BlockText.SetStyle.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockText.SetStyle.Response.Error | ||
event | ResponseEvent |
Rpc.BlockText.SetStyle.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockText.SetStyle.Response.Error.Code | ||
description | string |
Rpc.BlockText.SetText
Rpc.BlockText.SetText.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockId | string | ||
text | string | ||
marks | model.Block.Content.Text.Marks |
Rpc.BlockText.SetText.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockText.SetText.Response.Error | ||
event | ResponseEvent |
Rpc.BlockText.SetText.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockText.SetText.Response.Error.Code | ||
description | string |
Rpc.BlockVideo
Rpc.BlockVideo.SetName
Rpc.BlockVideo.SetName.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockId | string | ||
name | string |
Rpc.BlockVideo.SetName.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockVideo.SetName.Response.Error |
Rpc.BlockVideo.SetName.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockVideo.SetName.Response.Error.Code | ||
description | string |
Rpc.BlockVideo.SetWidth
Rpc.BlockVideo.SetWidth.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockId | string | ||
width | int32 |
Rpc.BlockVideo.SetWidth.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockVideo.SetWidth.Response.Error |
Rpc.BlockVideo.SetWidth.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockVideo.SetWidth.Response.Error.Code | ||
description | string |
Rpc.BlockWidget
Rpc.BlockWidget.SetLayout
Rpc.BlockWidget.SetLayout.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockId | string | ||
layout | model.Block.Content.Widget.Layout |
Rpc.BlockWidget.SetLayout.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockWidget.SetLayout.Response.Error | ||
event | ResponseEvent |
Rpc.BlockWidget.SetLayout.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockWidget.SetLayout.Response.Error.Code | ||
description | string |
Rpc.BlockWidget.SetLimit
Rpc.BlockWidget.SetLimit.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockId | string | ||
limit | int32 |
Rpc.BlockWidget.SetLimit.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockWidget.SetLimit.Response.Error | ||
event | ResponseEvent |
Rpc.BlockWidget.SetLimit.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockWidget.SetLimit.Response.Error.Code | ||
description | string |
Rpc.BlockWidget.SetTargetId
Rpc.BlockWidget.SetTargetId.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockId | string | ||
targetId | string |
Rpc.BlockWidget.SetTargetId.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockWidget.SetTargetId.Response.Error | ||
event | ResponseEvent |
Rpc.BlockWidget.SetTargetId.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockWidget.SetTargetId.Response.Error.Code | ||
description | string |
Rpc.BlockWidget.SetViewId
Rpc.BlockWidget.SetViewId.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
blockId | string | ||
viewId | string |
Rpc.BlockWidget.SetViewId.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.BlockWidget.SetViewId.Response.Error | ||
event | ResponseEvent |
Rpc.BlockWidget.SetViewId.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.BlockWidget.SetViewId.Response.Error.Code | ||
description | string |
Rpc.Debug
Rpc.Debug.ExportLocalstore
Rpc.Debug.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.Debug.ExportLocalstore.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Debug.ExportLocalstore.Response.Error | ||
path | string | ||
event | ResponseEvent |
Rpc.Debug.ExportLocalstore.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Debug.ExportLocalstore.Response.Error.Code | ||
description | string |
Rpc.Debug.Ping
Rpc.Debug.Ping.Request
Field | Type | Label | Description |
---|---|---|---|
index | int32 | ||
numberOfEventsToSend | int32 |
Rpc.Debug.Ping.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Debug.Ping.Response.Error | ||
index | int32 |
Rpc.Debug.Ping.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Debug.Ping.Response.Error.Code | ||
description | string |
Rpc.Debug.SpaceSummary
Rpc.Debug.SpaceSummary.Request
Rpc.Debug.SpaceSummary.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Debug.SpaceSummary.Response.Error | ||
spaceId | string | ||
infos | Rpc.Debug.TreeInfo | repeated |
Rpc.Debug.SpaceSummary.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Debug.SpaceSummary.Response.Error.Code | ||
description | string |
Rpc.Debug.Tree
Rpc.Debug.Tree.Request
Field | Type | Label | Description |
---|---|---|---|
treeId | string | ||
path | string | ||
unanonymized | bool | set to true to disable mocking of the actual data inside changes | |
generateSvg | bool | set to true to write both ZIP and SVG files |
Rpc.Debug.Tree.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Debug.Tree.Response.Error | ||
filename | string |
Rpc.Debug.Tree.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Debug.Tree.Response.Error.Code | ||
description | string |
Rpc.Debug.TreeHeads
Rpc.Debug.TreeHeads.Request
Field | Type | Label | Description |
---|---|---|---|
treeId | string |
Rpc.Debug.TreeHeads.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Debug.TreeHeads.Response.Error | ||
spaceId | string | ||
info | Rpc.Debug.TreeInfo |
Rpc.Debug.TreeHeads.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Debug.TreeHeads.Response.Error.Code | ||
description | string |
Rpc.Debug.TreeInfo
Field | Type | Label | Description |
---|---|---|---|
treeId | string | ||
headIds | string | repeated |
Rpc.File
Rpc.File.Download
Rpc.File.Download.Request
Field | Type | Label | Description |
---|---|---|---|
hash | string | ||
path | string | path to save file. Temp directory is used if empty |
Rpc.File.Download.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.File.Download.Response.Error | ||
localPath | string |
Rpc.File.Download.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.File.Download.Response.Error.Code | ||
description | string |
Rpc.File.Drop
Rpc.File.Drop.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.File.Drop.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.File.Drop.Response.Error | ||
event | ResponseEvent |
Rpc.File.Drop.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.File.Drop.Response.Error.Code | ||
description | string |
Rpc.File.ListOffload
Rpc.File.ListOffload.Request
Field | Type | Label | Description |
---|---|---|---|
onlyIds | string | repeated | empty means all |
includeNotPinned | bool | false mean not-yet-pinned files will be not |
Rpc.File.ListOffload.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.File.ListOffload.Response.Error | ||
filesOffloaded | int32 | ||
bytesOffloaded | uint64 |
Rpc.File.ListOffload.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.File.ListOffload.Response.Error.Code | ||
description | string |
Rpc.File.Offload
Rpc.File.Offload.Request
Field | Type | Label | Description |
---|---|---|---|
id | string | ||
includeNotPinned | bool |
Rpc.File.Offload.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.File.Offload.Response.Error | ||
bytesOffloaded | uint64 |
Rpc.File.Offload.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.File.Offload.Response.Error.Code | ||
description | string |
Rpc.File.SpaceUsage
Rpc.File.SpaceUsage.Request
Rpc.File.SpaceUsage.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.File.SpaceUsage.Response.Error | ||
usage | Rpc.File.SpaceUsage.Response.Usage |
Rpc.File.SpaceUsage.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.File.SpaceUsage.Response.Error.Code | ||
description | string |
Rpc.File.SpaceUsage.Response.Usage
Field | Type | Label | Description |
---|---|---|---|
filesCount | uint64 | ||
cidsCount | uint64 | ||
bytesUsage | uint64 | ||
bytesLeft | uint64 | ||
bytesLimit | uint64 | ||
localBytesUsage | uint64 |
Rpc.File.Upload
Rpc.File.Upload.Request
Field | Type | Label | Description |
---|---|---|---|
url | string | ||
localPath | string | ||
type | model.Block.Content.File.Type | ||
disableEncryption | bool | deprecated, has no affect | |
style | model.Block.Content.File.Style |
Rpc.File.Upload.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.File.Upload.Response.Error | ||
hash | string |
Rpc.File.Upload.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.File.Upload.Response.Error.Code | ||
description | string |
Rpc.GenericErrorResponse
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.GenericErrorResponse.Error |
Rpc.GenericErrorResponse.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.GenericErrorResponse.Error.Code | ||
description | string |
Rpc.History
Rpc.History.GetVersions
returns list of versions (changes)
Rpc.History.GetVersions.Request
Field | Type | Label | Description |
---|---|---|---|
objectId | string | ||
lastVersionId | string | when indicated, results will include versions before given id | |
limit | int32 | desired count of versions |
Rpc.History.GetVersions.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.History.GetVersions.Response.Error | ||
versions | Rpc.History.Version | repeated |
Rpc.History.GetVersions.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.History.GetVersions.Response.Error.Code | ||
description | string |
Rpc.History.SetVersion
Rpc.History.SetVersion.Request
Field | Type | Label | Description |
---|---|---|---|
objectId | string | ||
versionId | string |
Rpc.History.SetVersion.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.History.SetVersion.Response.Error |
Rpc.History.SetVersion.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.History.SetVersion.Response.Error.Code | ||
description | string |
Rpc.History.ShowVersion
returns blockShow event for given version
Rpc.History.ShowVersion.Request
Field | Type | Label | Description |
---|---|---|---|
objectId | string | ||
versionId | string | ||
traceId | string |
Rpc.History.ShowVersion.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.History.ShowVersion.Response.Error | ||
objectView | model.ObjectView | ||
version | Rpc.History.Version | ||
traceId | string |
Rpc.History.ShowVersion.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.History.ShowVersion.Response.Error.Code | ||
description | string |
Rpc.History.Version
Field | Type | Label | Description |
---|---|---|---|
id | string | ||
previousIds | string | repeated | |
authorId | string | ||
authorName | string | ||
time | int64 | ||
groupId | int64 |
Rpc.LinkPreview
Rpc.LinkPreview.Request
Field | Type | Label | Description |
---|---|---|---|
url | string |
Rpc.LinkPreview.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.LinkPreview.Response.Error | ||
linkPreview | model.LinkPreview |
Rpc.LinkPreview.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.LinkPreview.Response.Error.Code | ||
description | string |
Rpc.Log
Rpc.Log.Send
Rpc.Log.Send.Request
Field | Type | Label | Description |
---|---|---|---|
message | string | ||
level | Rpc.Log.Send.Request.Level |
Rpc.Log.Send.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Log.Send.Response.Error |
Rpc.Log.Send.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Log.Send.Response.Error.Code | ||
description | string |
Rpc.Metrics
Rpc.Metrics.SetParameters
Rpc.Metrics.SetParameters.Request
Field | Type | Label | Description |
---|---|---|---|
platform | string | ||
version | string |
Rpc.Metrics.SetParameters.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Metrics.SetParameters.Response.Error |
Rpc.Metrics.SetParameters.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Metrics.SetParameters.Response.Error.Code | ||
description | string |
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
Field | Type | Label | Description |
---|---|---|---|
objectId | string | ||
context | Rpc.Navigation.Context |
Rpc.Navigation.GetObjectInfoWithLinks.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Navigation.GetObjectInfoWithLinks.Response.Error | ||
object | model.ObjectInfoWithLinks |
Rpc.Navigation.GetObjectInfoWithLinks.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Navigation.GetObjectInfoWithLinks.Response.Error.Code | ||
description | string |
Rpc.Navigation.ListObjects
Rpc.Navigation.ListObjects.Request
Field | Type | Label | Description |
---|---|---|---|
context | Rpc.Navigation.Context | ||
fullText | string | ||
limit | int32 | ||
offset | int32 |
Rpc.Navigation.ListObjects.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Navigation.ListObjects.Response.Error | ||
objects | model.ObjectInfo | repeated |
Rpc.Navigation.ListObjects.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Navigation.ListObjects.Response.Error.Code | ||
description | string |
Rpc.Object
Rpc.Object.ApplyTemplate
Rpc.Object.ApplyTemplate.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
templateId | string | id of template |
Rpc.Object.ApplyTemplate.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Object.ApplyTemplate.Response.Error |
Rpc.Object.ApplyTemplate.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Object.ApplyTemplate.Response.Error.Code | ||
description | string |
Rpc.Object.BookmarkFetch
Rpc.Object.BookmarkFetch.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
url | string |
Rpc.Object.BookmarkFetch.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Object.BookmarkFetch.Response.Error |
Rpc.Object.BookmarkFetch.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Object.BookmarkFetch.Response.Error.Code | ||
description | string |
Rpc.Object.Close
Rpc.Object.Close.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | deprecated | |
objectId | string |
Rpc.Object.Close.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Object.Close.Response.Error |
Rpc.Object.Close.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Object.Close.Response.Error.Code | ||
description | string |
Rpc.Object.Create
Rpc.Object.Create.Request
Field | Type | Label | Description |
---|---|---|---|
details | google.protobuf.Struct | object details | |
internalFlags | model.InternalFlag | repeated | |
templateId | string |
Rpc.Object.Create.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Object.Create.Response.Error | ||
objectId | string | ||
event | ResponseEvent | ||
details | google.protobuf.Struct |
Rpc.Object.Create.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Object.Create.Response.Error.Code | ||
description | string |
Rpc.Object.CreateBookmark
Rpc.Object.CreateBookmark.Request
Field | Type | Label | Description |
---|---|---|---|
details | google.protobuf.Struct |
Rpc.Object.CreateBookmark.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Object.CreateBookmark.Response.Error | ||
objectId | string | ||
details | google.protobuf.Struct |
Rpc.Object.CreateBookmark.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Object.CreateBookmark.Response.Error.Code | ||
description | string |
Rpc.Object.CreateObjectType
Rpc.Object.CreateObjectType.Request
Field | Type | Label | Description |
---|---|---|---|
details | google.protobuf.Struct | ||
internalFlags | model.InternalFlag | repeated |
Rpc.Object.CreateObjectType.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Object.CreateObjectType.Response.Error | ||
details | google.protobuf.Struct | ||
objectId | string |
Rpc.Object.CreateObjectType.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Object.CreateObjectType.Response.Error.Code | ||
description | string |
Rpc.Object.CreateRelation
Rpc.Object.CreateRelation.Request
Field | Type | Label | Description |
---|---|---|---|
details | google.protobuf.Struct |
Rpc.Object.CreateRelation.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Object.CreateRelation.Response.Error | ||
objectId | string | ||
key | string | ||
details | google.protobuf.Struct |
Rpc.Object.CreateRelation.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Object.CreateRelation.Response.Error.Code | ||
description | string |
Rpc.Object.CreateRelationOption
Rpc.Object.CreateRelationOption.Request
Field | Type | Label | Description |
---|---|---|---|
details | google.protobuf.Struct |
Rpc.Object.CreateRelationOption.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Object.CreateRelationOption.Response.Error | ||
objectId | string | ||
details | google.protobuf.Struct |
Rpc.Object.CreateRelationOption.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Object.CreateRelationOption.Response.Error.Code | ||
description | string |
Rpc.Object.CreateSet
Rpc.Object.CreateSet.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 | |
internalFlags | model.InternalFlag | repeated |
Rpc.Object.CreateSet.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Object.CreateSet.Response.Error | ||
objectId | string | ||
event | ResponseEvent | ||
details | google.protobuf.Struct |
Rpc.Object.CreateSet.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Object.CreateSet.Response.Error.Code | ||
description | string |
Rpc.Object.Duplicate
Rpc.Object.Duplicate.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string |
Rpc.Object.Duplicate.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Object.Duplicate.Response.Error | ||
id | string | created template id |
Rpc.Object.Duplicate.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Object.Duplicate.Response.Error.Code | ||
description | string |
Rpc.Object.Graph
Rpc.Object.Graph.Edge
Field | Type | Label | Description |
---|---|---|---|
source | string | ||
target | string | ||
name | string | ||
type | Rpc.Object.Graph.Edge.Type | ||
description | string | ||
iconImage | string | ||
iconEmoji | string | ||
hidden | bool |
Rpc.Object.Graph.Request
Field | Type | Label | Description |
---|---|---|---|
filters | model.Block.Content.Dataview.Filter | repeated | |
limit | int32 | ||
objectTypeFilter | string | repeated | additional filter by objectTypes |
DEPRECATED | | keys | string | repeated | |
Rpc.Object.Graph.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Object.Graph.Response.Error | ||
nodes | google.protobuf.Struct | repeated | |
edges | Rpc.Object.Graph.Edge | repeated |
Rpc.Object.Graph.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Object.Graph.Response.Error.Code | ||
description | string |
Rpc.Object.GroupsSubscribe
Rpc.Object.GroupsSubscribe.Request
Field | Type | Label | Description |
---|---|---|---|
subId | string | ||
relationKey | string | ||
filters | model.Block.Content.Dataview.Filter | repeated | |
source | string | repeated | |
collectionId | string |
Rpc.Object.GroupsSubscribe.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Object.GroupsSubscribe.Response.Error | ||
groups | model.Block.Content.Dataview.Group | repeated | |
subId | string |
Rpc.Object.GroupsSubscribe.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Object.GroupsSubscribe.Response.Error.Code | ||
description | string |
Rpc.Object.Import
Rpc.Object.Import.Notion
Rpc.Object.Import.Notion.ValidateToken
Rpc.Object.Import.Notion.ValidateToken.Request
Field | Type | Label | Description |
---|---|---|---|
token | string |
Rpc.Object.Import.Notion.ValidateToken.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Object.Import.Notion.ValidateToken.Response.Error |
Rpc.Object.Import.Notion.ValidateToken.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Object.Import.Notion.ValidateToken.Response.Error.Code | ||
description | string |
Rpc.Object.Import.Request
Field | Type | Label | Description |
---|---|---|---|
notionParams | Rpc.Object.Import.Request.NotionParams | ||
bookmarksParams | Rpc.Object.Import.Request.BookmarksParams | for internal use | |
markdownParams | Rpc.Object.Import.Request.MarkdownParams | ||
htmlParams | Rpc.Object.Import.Request.HtmlParams | ||
txtParams | Rpc.Object.Import.Request.TxtParams | ||
pbParams | Rpc.Object.Import.Request.PbParams | ||
csvParams | Rpc.Object.Import.Request.CsvParams | ||
snapshots | Rpc.Object.Import.Request.Snapshot | repeated | optional, for external developers usage |
updateExistingObjects | bool | ||
type | Rpc.Object.Import.Request.Type | ||
mode | Rpc.Object.Import.Request.Mode | ||
noProgress | bool | ||
isMigration | bool |
Rpc.Object.Import.Request.BookmarksParams
Field | Type | Label | Description |
---|---|---|---|
url | string |
Rpc.Object.Import.Request.CsvParams
Field | Type | Label | Description |
---|---|---|---|
path | string | repeated | |
mode | Rpc.Object.Import.Request.CsvParams.Mode | ||
useFirstRowForRelations | bool | ||
delimiter | string | ||
transposeRowsAndColumns | bool |
Rpc.Object.Import.Request.HtmlParams
Field | Type | Label | Description |
---|---|---|---|
path | string | repeated |
Rpc.Object.Import.Request.MarkdownParams
Field | Type | Label | Description |
---|---|---|---|
path | string | repeated |
Rpc.Object.Import.Request.NotionParams
Field | Type | Label | Description |
---|---|---|---|
apiKey | string |
Rpc.Object.Import.Request.PbParams
Field | Type | Label | Description |
---|---|---|---|
path | string | repeated | |
noCollection | bool |
Rpc.Object.Import.Request.Snapshot
Field | Type | Label | Description |
---|---|---|---|
id | string | ||
snapshot | model.SmartBlockSnapshotBase |
Rpc.Object.Import.Request.TxtParams
Field | Type | Label | Description |
---|---|---|---|
path | string | repeated |
Rpc.Object.Import.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Object.Import.Response.Error |
Rpc.Object.Import.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Object.Import.Response.Error.Code | ||
description | string |
Rpc.Object.ImportList
Rpc.Object.ImportList.ImportResponse
Field | Type | Label | Description |
---|---|---|---|
type | Rpc.Object.ImportList.ImportResponse.Type |
Rpc.Object.ImportList.Request
Rpc.Object.ImportList.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Object.ImportList.Response.Error | ||
response | Rpc.Object.ImportList.ImportResponse | repeated |
Rpc.Object.ImportList.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Object.ImportList.Response.Error.Code | ||
description | string |
Rpc.Object.ImportUseCase
Rpc.Object.ImportUseCase.Request
Field | Type | Label | Description |
---|---|---|---|
useCase | Rpc.Object.ImportUseCase.Request.UseCase |
Rpc.Object.ImportUseCase.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Object.ImportUseCase.Response.Error |
Rpc.Object.ImportUseCase.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Object.ImportUseCase.Response.Error.Code | ||
description | string |
Rpc.Object.ListDelete
Rpc.Object.ListDelete.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.Object.ListDelete.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Object.ListDelete.Response.Error | ||
event | ResponseEvent |
Rpc.Object.ListDelete.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Object.ListDelete.Response.Error.Code | ||
description | string |
Rpc.Object.ListDuplicate
Rpc.Object.ListDuplicate.Request
Field | Type | Label | Description |
---|---|---|---|
objectIds | string | repeated |
Rpc.Object.ListDuplicate.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Object.ListDuplicate.Response.Error | ||
ids | string | repeated |
Rpc.Object.ListDuplicate.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Object.ListDuplicate.Response.Error.Code | ||
description | string |
Rpc.Object.ListExport
Rpc.Object.ListExport.Request
Field | Type | Label | Description |
---|---|---|---|
path | string | the path where export files will place | |
objectIds | string | repeated | ids of documents for export, when empty - will export all available docs |
format | Rpc.Object.ListExport.Format | export format | |
zip | bool | save as zip file | |
includeNested | bool | include all nested | |
includeFiles | bool | include all files | |
isJson | bool | for protobuf export | |
includeArchived | bool | for migration |
Rpc.Object.ListExport.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Object.ListExport.Response.Error | ||
path | string | ||
succeed | int32 | ||
event | ResponseEvent |
Rpc.Object.ListExport.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Object.ListExport.Response.Error.Code | ||
description | string |
Rpc.Object.ListSetIsArchived
Rpc.Object.ListSetIsArchived.Request
Field | Type | Label | Description |
---|---|---|---|
objectIds | string | repeated | |
isArchived | bool |
Rpc.Object.ListSetIsArchived.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Object.ListSetIsArchived.Response.Error |
Rpc.Object.ListSetIsArchived.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Object.ListSetIsArchived.Response.Error.Code | ||
description | string |
Rpc.Object.ListSetIsFavorite
Rpc.Object.ListSetIsFavorite.Request
Field | Type | Label | Description |
---|---|---|---|
objectIds | string | repeated | |
isFavorite | bool |
Rpc.Object.ListSetIsFavorite.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Object.ListSetIsFavorite.Response.Error |
Rpc.Object.ListSetIsFavorite.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Object.ListSetIsFavorite.Response.Error.Code | ||
description | string |
Rpc.Object.Open
Rpc.Object.Open.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | id of the context blo1k | |
objectId | string | ||
traceId | string | ||
includeRelationsAsDependentObjects | bool | some clients may set this option instead if having the single subscription to all relations |
Rpc.Object.Open.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Object.Open.Response.Error | ||
objectView | model.ObjectView |
Rpc.Object.Open.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Object.Open.Response.Error.Code | ||
description | string |
Rpc.Object.OpenBreadcrumbs
Rpc.Object.OpenBreadcrumbs.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | deprecated | |
traceId | string |
Rpc.Object.OpenBreadcrumbs.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Object.OpenBreadcrumbs.Response.Error | ||
objectId | string | ||
event | ResponseEvent | ||
objectView | model.ObjectView |
Rpc.Object.OpenBreadcrumbs.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Object.OpenBreadcrumbs.Response.Error.Code | ||
description | string |
Rpc.Object.Redo
Rpc.Object.Redo.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | id of the context object |
Rpc.Object.Redo.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Object.Redo.Response.Error | ||
event | ResponseEvent | ||
counters | Rpc.Object.UndoRedoCounter |
Rpc.Object.Redo.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Object.Redo.Response.Error.Code | ||
description | string |
Rpc.Object.Search
Rpc.Object.Search.Request
Field | Type | Label | Description |
---|---|---|---|
filters | model.Block.Content.Dataview.Filter | repeated | |
sorts | model.Block.Content.Dataview.Sort | repeated | |
fullText | string | ||
offset | int32 | ||
limit | int32 | ||
objectTypeFilter | string | repeated | additional filter by objectTypes |
DEPRECATED | | keys | string | repeated | needed keys in details for return, when empty - will return all |
Rpc.Object.Search.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Object.Search.Response.Error | ||
records | google.protobuf.Struct | repeated |
Rpc.Object.Search.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Object.Search.Response.Error.Code | ||
description | string |
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 | |
collectionId | string |
Rpc.Object.SearchSubscribe.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Object.SearchSubscribe.Response.Error | ||
records | google.protobuf.Struct | repeated | |
dependencies | google.protobuf.Struct | repeated | |
subId | string | ||
counters | Event.Object.Subscription.Counters |
Rpc.Object.SearchSubscribe.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Object.SearchSubscribe.Response.Error.Code | ||
description | string |
Rpc.Object.SearchUnsubscribe
Rpc.Object.SearchUnsubscribe.Request
Field | Type | Label | Description |
---|---|---|---|
subIds | string | repeated |
Rpc.Object.SearchUnsubscribe.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Object.SearchUnsubscribe.Response.Error |
Rpc.Object.SearchUnsubscribe.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Object.SearchUnsubscribe.Response.Error.Code | ||
description | string |
Rpc.Object.SetBreadcrumbs
Rpc.Object.SetBreadcrumbs.Request
Field | Type | Label | Description |
---|---|---|---|
breadcrumbsId | string | ||
ids | string | repeated | page ids |
Rpc.Object.SetBreadcrumbs.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Object.SetBreadcrumbs.Response.Error | ||
event | ResponseEvent |
Rpc.Object.SetBreadcrumbs.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Object.SetBreadcrumbs.Response.Error.Code | ||
description | string |
Rpc.Object.SetDetails
Rpc.Object.SetDetails.Detail
Field | Type | Label | Description |
---|---|---|---|
key | string | ||
value | google.protobuf.Value | NUll - removes key |
Rpc.Object.SetDetails.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
details | Rpc.Object.SetDetails.Detail | repeated |
Rpc.Object.SetDetails.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Object.SetDetails.Response.Error | ||
event | ResponseEvent |
Rpc.Object.SetDetails.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Object.SetDetails.Response.Error.Code | ||
description | string |
Rpc.Object.SetInternalFlags
Rpc.Object.SetInternalFlags.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
internalFlags | model.InternalFlag | repeated |
Rpc.Object.SetInternalFlags.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Object.SetInternalFlags.Response.Error | ||
event | ResponseEvent |
Rpc.Object.SetInternalFlags.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Object.SetInternalFlags.Response.Error.Code | ||
description | string |
Rpc.Object.SetIsArchived
Rpc.Object.SetIsArchived.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
isArchived | bool |
Rpc.Object.SetIsArchived.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Object.SetIsArchived.Response.Error | ||
event | ResponseEvent |
Rpc.Object.SetIsArchived.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Object.SetIsArchived.Response.Error.Code | ||
description | string |
Rpc.Object.SetIsFavorite
Rpc.Object.SetIsFavorite.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
isFavorite | bool |
Rpc.Object.SetIsFavorite.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Object.SetIsFavorite.Response.Error | ||
event | ResponseEvent |
Rpc.Object.SetIsFavorite.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Object.SetIsFavorite.Response.Error.Code | ||
description | string |
Rpc.Object.SetLayout
Rpc.Object.SetLayout.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
layout | model.ObjectType.Layout |
Rpc.Object.SetLayout.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Object.SetLayout.Response.Error | ||
event | ResponseEvent |
Rpc.Object.SetLayout.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Object.SetLayout.Response.Error.Code | ||
description | string |
Rpc.Object.SetObjectType
Rpc.Object.SetObjectType.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
objectTypeUrl | string |
Rpc.Object.SetObjectType.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Object.SetObjectType.Response.Error | ||
event | ResponseEvent |
Rpc.Object.SetObjectType.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Object.SetObjectType.Response.Error.Code | ||
description | string |
Rpc.Object.SetSource
Rpc.Object.SetSource.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
source | string | repeated |
Rpc.Object.SetSource.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Object.SetSource.Response.Error | ||
event | ResponseEvent |
Rpc.Object.SetSource.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Object.SetSource.Response.Error.Code | ||
description | string |
Rpc.Object.ShareByLink
Rpc.Object.ShareByLink.Request
Field | Type | Label | Description |
---|---|---|---|
objectId | string |
Rpc.Object.ShareByLink.Response
Field | Type | Label | Description |
---|---|---|---|
link | string | ||
error | Rpc.Object.ShareByLink.Response.Error |
Rpc.Object.ShareByLink.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Object.ShareByLink.Response.Error.Code | ||
description | string |
Rpc.Object.Show
Rpc.Object.Show.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | deprecated | |
objectId | string | ||
traceId | string | ||
includeRelationsAsDependentObjects | bool | some clients may set this option instead if having the single subscription to all relations |
Rpc.Object.Show.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Object.Show.Response.Error | ||
objectView | model.ObjectView |
Rpc.Object.Show.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Object.Show.Response.Error.Code | ||
description | string |
Rpc.Object.SubscribeIds
Rpc.Object.SubscribeIds.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 | ||
noDepSubscription | bool | disable dependent subscription |
Rpc.Object.SubscribeIds.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Object.SubscribeIds.Response.Error | ||
records | google.protobuf.Struct | repeated | |
dependencies | google.protobuf.Struct | repeated | |
subId | string |
Rpc.Object.SubscribeIds.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Object.SubscribeIds.Response.Error.Code | ||
description | string |
Rpc.Object.ToBookmark
Rpc.Object.ToBookmark.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
url | string |
Rpc.Object.ToBookmark.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Object.ToBookmark.Response.Error | ||
objectId | string |
Rpc.Object.ToBookmark.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Object.ToBookmark.Response.Error.Code | ||
description | string |
Rpc.Object.ToCollection
Rpc.Object.ToCollection.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string |
Rpc.Object.ToCollection.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Object.ToCollection.Response.Error |
Rpc.Object.ToCollection.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Object.ToCollection.Response.Error.Code | ||
description | string |
Rpc.Object.ToSet
Rpc.Object.ToSet.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
source | string | repeated |
Rpc.Object.ToSet.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Object.ToSet.Response.Error |
Rpc.Object.ToSet.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Object.ToSet.Response.Error.Code | ||
description | string |
Rpc.Object.Undo
Rpc.Object.Undo.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | id of the context object |
Rpc.Object.Undo.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Object.Undo.Response.Error | ||
event | ResponseEvent | ||
counters | Rpc.Object.UndoRedoCounter |
Rpc.Object.Undo.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Object.Undo.Response.Error.Code | ||
description | string |
Rpc.Object.UndoRedoCounter
Available undo/redo operations
Field | Type | Label | Description |
---|---|---|---|
undo | int32 | ||
redo | int32 |
Rpc.Object.WorkspaceSetDashboard
Rpc.Object.WorkspaceSetDashboard.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
objectId | string |
Rpc.Object.WorkspaceSetDashboard.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Object.WorkspaceSetDashboard.Response.Error | ||
event | ResponseEvent | ||
objectId | string |
Rpc.Object.WorkspaceSetDashboard.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Object.WorkspaceSetDashboard.Response.Error.Code | ||
description | string |
Rpc.ObjectCollection
Rpc.ObjectCollection.Add
Rpc.ObjectCollection.Add.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
afterId | string | ||
objectIds | string | repeated |
Rpc.ObjectCollection.Add.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.ObjectCollection.Add.Response.Error | ||
event | ResponseEvent |
Rpc.ObjectCollection.Add.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.ObjectCollection.Add.Response.Error.Code | ||
description | string |
Rpc.ObjectCollection.Remove
Rpc.ObjectCollection.Remove.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
objectIds | string | repeated |
Rpc.ObjectCollection.Remove.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.ObjectCollection.Remove.Response.Error | ||
event | ResponseEvent |
Rpc.ObjectCollection.Remove.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.ObjectCollection.Remove.Response.Error.Code | ||
description | string |
Rpc.ObjectCollection.Sort
Rpc.ObjectCollection.Sort.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
objectIds | string | repeated |
Rpc.ObjectCollection.Sort.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.ObjectCollection.Sort.Response.Error | ||
event | ResponseEvent |
Rpc.ObjectCollection.Sort.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.ObjectCollection.Sort.Response.Error.Code | ||
description | string |
Rpc.ObjectRelation
Rpc.ObjectRelation.Add
Rpc.ObjectRelation.Add.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
relationKeys | string | repeated |
Rpc.ObjectRelation.Add.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.ObjectRelation.Add.Response.Error | ||
event | ResponseEvent |
Rpc.ObjectRelation.Add.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.ObjectRelation.Add.Response.Error.Code | ||
description | string |
Rpc.ObjectRelation.AddFeatured
Rpc.ObjectRelation.AddFeatured.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
relations | string | repeated |
Rpc.ObjectRelation.AddFeatured.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.ObjectRelation.AddFeatured.Response.Error | ||
event | ResponseEvent |
Rpc.ObjectRelation.AddFeatured.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.ObjectRelation.AddFeatured.Response.Error.Code | ||
description | string |
Rpc.ObjectRelation.Delete
Rpc.ObjectRelation.Delete.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
relationKeys | string | repeated |
Rpc.ObjectRelation.Delete.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.ObjectRelation.Delete.Response.Error | ||
event | ResponseEvent |
Rpc.ObjectRelation.Delete.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.ObjectRelation.Delete.Response.Error.Code | ||
description | string |
Rpc.ObjectRelation.ListAvailable
Rpc.ObjectRelation.ListAvailable.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string |
Rpc.ObjectRelation.ListAvailable.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.ObjectRelation.ListAvailable.Response.Error | ||
relations | model.Relation | repeated |
Rpc.ObjectRelation.ListAvailable.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.ObjectRelation.ListAvailable.Response.Error.Code | ||
description | string |
Rpc.ObjectRelation.RemoveFeatured
Rpc.ObjectRelation.RemoveFeatured.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | ||
relations | string | repeated |
Rpc.ObjectRelation.RemoveFeatured.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.ObjectRelation.RemoveFeatured.Response.Error | ||
event | ResponseEvent |
Rpc.ObjectRelation.RemoveFeatured.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.ObjectRelation.RemoveFeatured.Response.Error.Code | ||
description | string |
Rpc.ObjectType
Rpc.ObjectType.Relation
Rpc.ObjectType.Relation.Add
Rpc.ObjectType.Relation.Add.Request
Field | Type | Label | Description |
---|---|---|---|
objectTypeUrl | string | ||
relationKeys | string | repeated |
Rpc.ObjectType.Relation.Add.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.ObjectType.Relation.Add.Response.Error | ||
relations | model.Relation | repeated |
Rpc.ObjectType.Relation.Add.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.ObjectType.Relation.Add.Response.Error.Code | ||
description | string |
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
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.ObjectType.Relation.List.Response.Error | ||
relations | model.RelationLink | repeated |
Rpc.ObjectType.Relation.List.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.ObjectType.Relation.List.Response.Error.Code | ||
description | string |
Rpc.ObjectType.Relation.Remove
Rpc.ObjectType.Relation.Remove.Request
Field | Type | Label | Description |
---|---|---|---|
objectTypeUrl | string | ||
relationKeys | string | repeated |
Rpc.ObjectType.Relation.Remove.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.ObjectType.Relation.Remove.Response.Error |
Rpc.ObjectType.Relation.Remove.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.ObjectType.Relation.Remove.Response.Error.Code | ||
description | string |
Rpc.Process
Rpc.Process.Cancel
Rpc.Process.Cancel.Request
Field | Type | Label | Description |
---|---|---|---|
id | string |
Rpc.Process.Cancel.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Process.Cancel.Response.Error |
Rpc.Process.Cancel.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Process.Cancel.Response.Error.Code | ||
description | string |
Rpc.Relation
Rpc.Relation.ListRemoveOption
Rpc.Relation.ListRemoveOption.Request
Field | Type | Label | Description |
---|---|---|---|
optionIds | string | repeated | |
checkInObjects | bool |
Rpc.Relation.ListRemoveOption.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Relation.ListRemoveOption.Response.Error |
Rpc.Relation.ListRemoveOption.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Relation.ListRemoveOption.Response.Error.Code | ||
description | string |
Rpc.Relation.Options
Rpc.Relation.Options.Request
Field | Type | Label | Description |
---|---|---|---|
relationKey | string |
Rpc.Relation.Options.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Relation.Options.Response.Error | ||
options | model.RelationOptions |
Rpc.Relation.Options.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Relation.Options.Response.Error.Code | ||
description | string |
Rpc.Template
Rpc.Template.Clone
Rpc.Template.Clone.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | id of template block for cloning |
Rpc.Template.Clone.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Template.Clone.Response.Error | ||
id | string | created template id |
Rpc.Template.Clone.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Template.Clone.Response.Error.Code | ||
description | string |
Rpc.Template.CreateFromObject
Rpc.Template.CreateFromObject.Request
Field | Type | Label | Description |
---|---|---|---|
contextId | string | id of block for making them template |
Rpc.Template.CreateFromObject.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Template.CreateFromObject.Response.Error | ||
id | string | created template id |
Rpc.Template.CreateFromObject.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Template.CreateFromObject.Response.Error.Code | ||
description | string |
Rpc.Template.CreateFromObjectType
Rpc.Template.CreateFromObjectType.Request
Field | Type | Label | Description |
---|---|---|---|
objectType | string | id of desired object type |
Rpc.Template.CreateFromObjectType.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Template.CreateFromObjectType.Response.Error | ||
id | string | created template id |
Rpc.Template.CreateFromObjectType.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Template.CreateFromObjectType.Response.Error.Code | ||
description | string |
Rpc.Template.ExportAll
Rpc.Template.ExportAll.Request
Field | Type | Label | Description |
---|---|---|---|
path | string | the path where export files will place |
Rpc.Template.ExportAll.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Template.ExportAll.Response.Error | ||
path | string | ||
event | ResponseEvent |
Rpc.Template.ExportAll.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Template.ExportAll.Response.Error.Code | ||
description | string |
Rpc.Unsplash
Rpc.Unsplash.Download
Rpc.Unsplash.Download.Request
Field | Type | Label | Description |
---|---|---|---|
pictureId | string |
Rpc.Unsplash.Download.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Unsplash.Download.Response.Error | ||
hash | string |
Rpc.Unsplash.Download.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Unsplash.Download.Response.Error.Code | ||
description | string |
Rpc.Unsplash.Search
Rpc.Unsplash.Search.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.Unsplash.Search.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Unsplash.Search.Response.Error | ||
pictures | Rpc.Unsplash.Search.Response.Picture | repeated |
Rpc.Unsplash.Search.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Unsplash.Search.Response.Error.Code | ||
description | string |
Rpc.Unsplash.Search.Response.Picture
Field | Type | Label | Description |
---|---|---|---|
id | string | ||
url | string | ||
artist | string | ||
artistUrl | string |
Rpc.UserData
Rpc.UserData.Dump
Rpc.UserData.Dump.Request
Field | Type | Label | Description |
---|---|---|---|
path | string |
Rpc.UserData.Dump.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.UserData.Dump.Response.Error |
Rpc.UserData.Dump.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.UserData.Dump.Response.Error.Code | ||
description | string |
Rpc.Wallet
Rpc.Wallet.CloseSession
Rpc.Wallet.CloseSession.Request
Field | Type | Label | Description |
---|---|---|---|
token | string |
Rpc.Wallet.CloseSession.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Wallet.CloseSession.Response.Error |
Rpc.Wallet.CloseSession.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Wallet.CloseSession.Response.Error.Code | ||
description | string |
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
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Wallet.Convert.Response.Error | Error while trying to recover a wallet | |
entropy | string | ||
mnemonic | string |
Rpc.Wallet.Convert.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Wallet.Convert.Response.Error.Code | ||
description | string |
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
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Wallet.Create.Response.Error | ||
mnemonic | string | Mnemonic of a new account (sequence of words, divided by spaces) |
Rpc.Wallet.Create.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Wallet.Create.Response.Error.Code | ||
description | string |
Rpc.Wallet.CreateSession
Rpc.Wallet.CreateSession.Request
Field | Type | Label | Description |
---|---|---|---|
mnemonic | string |
Rpc.Wallet.CreateSession.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Wallet.CreateSession.Response.Error | ||
token | string |
Rpc.Wallet.CreateSession.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Wallet.CreateSession.Response.Error.Code | ||
description | string |
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
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Wallet.Recover.Response.Error | Error while trying to recover a wallet |
Rpc.Wallet.Recover.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Wallet.Recover.Response.Error.Code | ||
description | string |
Rpc.Workspace
Rpc.Workspace.Create
Rpc.Workspace.Create.Request
Field | Type | Label | Description |
---|---|---|---|
name | string |
Rpc.Workspace.Create.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Workspace.Create.Response.Error | ||
workspaceId | string |
Rpc.Workspace.Create.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Workspace.Create.Response.Error.Code | ||
description | string |
Rpc.Workspace.Export
Rpc.Workspace.Export.Request
Field | Type | Label | Description |
---|---|---|---|
path | string | the path where export files will place | |
workspaceId | string |
Rpc.Workspace.Export.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Workspace.Export.Response.Error | ||
path | string | ||
event | ResponseEvent |
Rpc.Workspace.Export.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Workspace.Export.Response.Error.Code | ||
description | string |
Rpc.Workspace.GetAll
Rpc.Workspace.GetAll.Request
Rpc.Workspace.GetAll.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Workspace.GetAll.Response.Error | ||
workspaceIds | string | repeated |
Rpc.Workspace.GetAll.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Workspace.GetAll.Response.Error.Code | ||
description | string |
Rpc.Workspace.GetCurrent
Rpc.Workspace.GetCurrent.Request
Rpc.Workspace.GetCurrent.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Workspace.GetCurrent.Response.Error | ||
workspaceId | string |
Rpc.Workspace.GetCurrent.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Workspace.GetCurrent.Response.Error.Code | ||
description | string |
Rpc.Workspace.Object
Rpc.Workspace.Object.Add
Rpc.Workspace.Object.Add.Request
Field | Type | Label | Description |
---|---|---|---|
objectId | string |
Rpc.Workspace.Object.Add.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Workspace.Object.Add.Response.Error | ||
objectId | string | ||
details | google.protobuf.Struct |
Rpc.Workspace.Object.Add.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Workspace.Object.Add.Response.Error.Code | ||
description | string |
Rpc.Workspace.Object.ListAdd
Rpc.Workspace.Object.ListAdd.Request
Field | Type | Label | Description |
---|---|---|---|
objectIds | string | repeated |
Rpc.Workspace.Object.ListAdd.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Workspace.Object.ListAdd.Response.Error | ||
objectIds | string | repeated |
Rpc.Workspace.Object.ListAdd.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Workspace.Object.ListAdd.Response.Error.Code | ||
description | string |
Rpc.Workspace.Object.ListRemove
Rpc.Workspace.Object.ListRemove.Request
Field | Type | Label | Description |
---|---|---|---|
objectIds | string | repeated |
Rpc.Workspace.Object.ListRemove.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Workspace.Object.ListRemove.Response.Error | ||
ids | string | repeated |
Rpc.Workspace.Object.ListRemove.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Workspace.Object.ListRemove.Response.Error.Code | ||
description | string |
Rpc.Workspace.Select
Rpc.Workspace.Select.Request
Field | Type | Label | Description |
---|---|---|---|
workspaceId | string |
Rpc.Workspace.Select.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Workspace.Select.Response.Error |
Rpc.Workspace.Select.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Workspace.Select.Response.Error.Code | ||
description | string |
Rpc.Workspace.SetIsHighlighted
Rpc.Workspace.SetIsHighlighted.Request
Field | Type | Label | Description |
---|---|---|---|
objectId | string | ||
isHighlighted | bool |
Rpc.Workspace.SetIsHighlighted.Response
Field | Type | Label | Description |
---|---|---|---|
error | Rpc.Workspace.SetIsHighlighted.Response.Error |
Rpc.Workspace.SetIsHighlighted.Response.Error
Field | Type | Label | Description |
---|---|---|---|
code | Rpc.Workspace.SetIsHighlighted.Response.Error.Code | ||
description | string |
StreamRequest
Field | Type | Label | Description |
---|---|---|---|
token | string |
Rpc.Account.ConfigUpdate.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | |
ACCOUNT_IS_NOT_RUNNING | 101 | |
FAILED_TO_WRITE_CONFIG | 102 | |
FAILED_TO_GET_CONFIG | 103 |
Rpc.Account.ConfigUpdate.Timezones
Name | Number | Description |
---|---|---|
GMT | 0 | |
ECT | 1 | |
EET | 2 | |
EAT | 3 | |
MET | 4 | |
NET | 5 | |
PLT | 6 | |
IST | 7 | |
BST | 8 | |
VST | 9 | |
CTT | 10 | |
JST | 11 | |
ACT | 12 | |
AET | 13 | |
SST | 14 | |
NST | 15 | |
MIT | 16 | |
HST | 17 | |
AST | 18 | |
PST | 19 | |
MST | 20 | |
CST | 21 | |
IET | 22 | |
PRT | 23 | |
CNT | 24 | |
BET | 25 | |
BRT | 26 | |
CAT | 27 |
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 | |
FAILED_TO_WRITE_CONFIG | 105 | |
FAILED_TO_CREATE_LOCAL_REPO | 106 | |
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.Delete.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | No error; |
UNKNOWN_ERROR | 1 | Any other errors |
BAD_INPUT | 2 | |
ACCOUNT_IS_ALREADY_DELETED | 101 | |
ACCOUNT_IS_ACTIVE | 102 |
Rpc.Account.Move.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | |
FAILED_TO_STOP_NODE | 101 | |
FAILED_TO_IDENTIFY_ACCOUNT_DIR | 102 | |
FAILED_TO_REMOVE_ACCOUNT_DATA | 103 | |
FAILED_TO_CREATE_LOCAL_REPO | 104 | |
FAILED_TO_WRITE_CONFIG | 105 | |
FAILED_TO_GET_CONFIG | 106 |
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.RecoverFromLegacyExport.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | |
DIFFERENT_ACCOUNT | 3 |
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 | |
ACCOUNT_IS_DELETED | 109 | |
FAILED_TO_FETCH_REMOTE_NODE_HAS_INCOMPATIBLE_PROTO_VERSION | 110 |
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.App.GetVersion.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | |
VERSION_IS_EMPTY | 3 | |
NOT_FOUND | 101 | |
TIMEOUT | 102 |
Rpc.App.SetDeviceState.Request.DeviceState
Name | Number | Description |
---|---|---|
BACKGROUND | 0 | |
FOREGROUND | 1 |
Rpc.App.SetDeviceState.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | |
NODE_NOT_STARTED | 101 |
Rpc.App.Shutdown.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | |
NODE_NOT_STARTED | 101 |
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.CreateWidget.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.Block.Cut.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.ListConvertToObjects.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.Block.ListDelete.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.Block.ListDuplicate.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.Block.ListMoveToExistingObject.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.Block.ListMoveToNewObject.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.Block.ListSetAlign.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.Block.ListSetBackgroundColor.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.Block.ListSetFields.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.Block.ListSetVerticalAlign.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.Block.ListTurnInto.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.Paste.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.SetFields.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
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.Upload.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.BlockBookmark.CreateAndFetch.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 |
Rpc.BlockBookmark.Fetch.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 |
Rpc.BlockDataview.CreateBookmark.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.BlockDataview.CreateFromExistingObject.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.BlockDataview.Filter.Add.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 |
Rpc.BlockDataview.Filter.Remove.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 |
Rpc.BlockDataview.Filter.Replace.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 |
Rpc.BlockDataview.Filter.Sort.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 |
Rpc.BlockDataview.GroupOrder.Update.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 |
Rpc.BlockDataview.ObjectOrder.Move.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 |
Rpc.BlockDataview.ObjectOrder.Update.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 |
Rpc.BlockDataview.Relation.Add.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 |
Rpc.BlockDataview.Relation.Delete.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 |
Rpc.BlockDataview.Relation.ListAvailable.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | |
NOT_A_DATAVIEW_BLOCK | 3 | ... |
Rpc.BlockDataview.SetSource.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 |
Rpc.BlockDataview.Sort.Add.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 |
Rpc.BlockDataview.Sort.Remove.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 |
Rpc.BlockDataview.Sort.Replace.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 |
Rpc.BlockDataview.Sort.Sort.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 |
Rpc.BlockDataview.View.Create.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.BlockDataview.View.Delete.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.BlockDataview.View.SetActive.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.BlockDataview.View.SetPosition.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.BlockDataview.View.Update.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.BlockDataview.ViewRelation.Add.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 |
Rpc.BlockDataview.ViewRelation.Remove.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 |
Rpc.BlockDataview.ViewRelation.Replace.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 |
Rpc.BlockDataview.ViewRelation.Sort.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 |
Rpc.BlockDiv.ListSetStyle.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.BlockFile.CreateAndUpload.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 |
Rpc.BlockFile.ListSetStyle.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.BlockFile.SetName.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.BlockImage.SetName.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.BlockImage.SetWidth.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.BlockLatex.SetText.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.BlockLink.CreateWithObject.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.BlockLink.ListSetAppearance.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.BlockRelation.Add.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 |
Rpc.BlockRelation.SetKey.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 |
Rpc.BlockTable.ColumnCreate.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.BlockTable.ColumnDelete.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.BlockTable.ColumnDuplicate.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.BlockTable.ColumnListFill.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.BlockTable.ColumnMove.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.BlockTable.Create.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.BlockTable.Expand.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.BlockTable.RowCreate.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.BlockTable.RowDelete.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.BlockTable.RowDuplicate.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.BlockTable.RowListClean.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.BlockTable.RowListFill.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.BlockTable.RowSetHeader.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.BlockTable.Sort.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.BlockText.ListClearContent.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.BlockText.ListClearStyle.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.BlockText.ListSetColor.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.BlockText.ListSetMark.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.BlockText.ListSetStyle.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.BlockText.SetChecked.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.BlockText.SetColor.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.BlockText.SetIcon.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.BlockText.SetMarks.Get.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.BlockText.SetStyle.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.BlockText.SetText.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.BlockVideo.SetName.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.BlockVideo.SetWidth.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.BlockWidget.SetLayout.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 |
Rpc.BlockWidget.SetLimit.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 |
Rpc.BlockWidget.SetTargetId.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 |
Rpc.BlockWidget.SetViewId.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 |
Rpc.Debug.ExportLocalstore.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.Debug.Ping.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 |
Rpc.Debug.SpaceSummary.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.Debug.TreeHeads.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.File.Download.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | |
NOT_FOUND | 3 |
Rpc.File.Drop.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.File.ListOffload.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | |
NODE_NOT_STARTED | 103 | ... |
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.File.SpaceUsage.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.File.Upload.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 |
Rpc.GenericErrorResponse.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.History.GetVersions.Response.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.ShowVersion.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.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.ApplyTemplate.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.Object.BookmarkFetch.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.Object.Close.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.Object.Create.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.Object.CreateBookmark.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.Object.CreateObjectType.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | |
UNKNOWN_OBJECT_TYPE_URL | 3 | ... |
Rpc.Object.CreateRelation.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 |
Rpc.Object.CreateRelationOption.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 |
Rpc.Object.CreateSet.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | |
UNKNOWN_OBJECT_TYPE_URL | 3 |
Rpc.Object.Duplicate.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.GroupsSubscribe.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 |
Rpc.Object.Import.Notion.ValidateToken.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
INTERNAL_ERROR | 1 | |
UNAUTHORIZED | 2 | |
UNKNOWN_ERROR | 3 | |
BAD_INPUT | 4 | |
FORBIDDEN | 5 | |
SERVICE_UNAVAILABLE | 6 | |
ACCOUNT_IS_NOT_RUNNING | 7 |
Rpc.Object.Import.Request.CsvParams.Mode
Name | Number | Description |
---|---|---|
COLLECTION | 0 | |
TABLE | 1 |
Rpc.Object.Import.Request.Mode
Name | Number | Description |
---|---|---|
ALL_OR_NOTHING | 0 | |
IGNORE_ERRORS | 1 |
Rpc.Object.Import.Request.Type
Name | Number | Description |
---|---|---|
Notion | 0 | |
Markdown | 1 | |
External | 2 | external developers use it |
Pb | 3 | |
Html | 4 | |
Txt | 5 | |
Csv | 6 |
Rpc.Object.Import.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
INTERNAL_ERROR | 1 | |
UNKNOWN_ERROR | 2 | |
BAD_INPUT | 3 | |
ACCOUNT_IS_NOT_RUNNING | 4 | |
NO_OBJECTS_TO_IMPORT | 5 | |
IMPORT_IS_CANCELED | 6 |
Rpc.Object.ImportList.ImportResponse.Type
Name | Number | Description |
---|---|---|
Notion | 0 | |
Markdown | 1 | |
Html | 2 | |
Txt | 3 |
Rpc.Object.ImportList.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
INTERNAL_ERROR | 1 | |
UNKNOWN_ERROR | 2 | |
BAD_INPUT | 3 |
Rpc.Object.ImportUseCase.Request.UseCase
Name | Number | Description |
---|---|---|
SKIP | 0 | |
PERSONAL_PROJECTS | 1 | |
KNOWLEDGE_BASE | 2 | |
NOTES_DIARY | 3 |
Rpc.Object.ImportUseCase.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 |
Rpc.Object.ListDelete.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.Object.ListDuplicate.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.Object.ListExport.Format
Name | Number | Description |
---|---|---|
Markdown | 0 | |
Protobuf | 1 | |
JSON | 2 | |
DOT | 3 | |
SVG | 4 | |
GRAPH_JSON | 5 |
Rpc.Object.ListExport.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.Object.ListSetIsArchived.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.Object.ListSetIsFavorite.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.Object.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.Object.OpenBreadcrumbs.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.Object.Redo.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | |
CAN_NOT_MOVE | 3 | ... |
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.SetBreadcrumbs.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.Object.SetDetails.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.Object.SetInternalFlags.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | |
UNKNOWN_OBJECT_TYPE_URL | 3 |
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.SetObjectType.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | |
UNKNOWN_OBJECT_TYPE_URL | 3 |
Rpc.Object.SetSource.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.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.Object.SubscribeIds.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.Object.ToBookmark.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.Object.ToCollection.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.Object.Undo.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | |
CAN_NOT_MOVE | 3 | ... |
Rpc.Object.WorkspaceSetDashboard.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 |
Rpc.ObjectCollection.Add.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 |
Rpc.ObjectCollection.Remove.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 |
Rpc.ObjectCollection.Sort.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 |
Rpc.ObjectRelation.Add.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 |
Rpc.ObjectRelation.AddFeatured.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.ObjectRelation.Delete.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 |
Rpc.ObjectRelation.ListAvailable.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.ObjectRelation.RemoveFeatured.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.Process.Cancel.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 |
Rpc.Relation.ListRemoveOption.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | |
OPTION_USED_BY_OBJECTS | 3 |
Rpc.Relation.Options.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 |
Rpc.Template.Clone.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.Template.CreateFromObject.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.Template.CreateFromObjectType.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.Template.ExportAll.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.Unsplash.Download.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | |
RATE_LIMIT_EXCEEDED | 100 | ... |
Rpc.Unsplash.Search.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | |
RATE_LIMIT_EXCEEDED | 100 | ... |
Rpc.UserData.Dump.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 |
Rpc.Wallet.CloseSession.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 |
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.CreateSession.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 |
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.Export.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.Object.Add.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.Workspace.Object.ListAdd.Response.Error.Code
Name | Number | Description |
---|---|---|
NULL | 0 | |
UNKNOWN_ERROR | 1 | |
BAD_INPUT | 2 | ... |
Rpc.Workspace.Object.ListRemove.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 | ... |
File-level Extensions
Extension | Type | Base | Number | Description |
---|---|---|---|---|
no_auth | bool | .google.protobuf.MessageOptions | 7777 |
pb/protos/events.proto
Event
Event – type of message, that could be sent from a middleware to the corresponding front-end.
Field | Type | Label | Description |
---|---|---|---|
messages | Event.Message | repeated | |
contextId | string | ||
initiator | model.Account | ||
traceId | string |
Event.Account
Event.Account.Config
Event.Account.Config.Update
Field | Type | Label | Description |
---|---|---|---|
config | model.Account.Config | ||
status | model.Account.Status |
Event.Account.Details
Field | Type | Label | Description |
---|---|---|---|
profileId | string | ||
details | google.protobuf.Struct |
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.Account.Update
Field | Type | Label | Description |
---|---|---|---|
config | model.Account.Config | ||
status | model.Account.Status |
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.GroupOrderUpdate
Field | Type | Label | Description |
---|---|---|---|
id | string | dataview block's id | |
groupOrder | model.Block.Content.Dataview.GroupOrder |
Event.Block.Dataview.IsCollectionSet
Field | Type | Label | Description |
---|---|---|---|
id | string | dataview block's id | |
value | bool |
Event.Block.Dataview.ObjectOrderUpdate
Field | Type | Label | Description |
---|---|---|---|
id | string | dataview block's id | |
viewId | string | ||
groupId | string | ||
sliceChanges | Event.Block.Dataview.SliceChange | repeated |
Event.Block.Dataview.OldRelationDelete
Field | Type | Label | Description |
---|---|---|---|
id | string | dataview block's id | |
relationKey | string | relation key to remove |
Event.Block.Dataview.OldRelationSet
sent when the dataview relation has been changed or added
Field | Type | Label | Description |
---|---|---|---|
id | string | dataview block's id | |
relationKey | string | relation key to update | |
relation | model.Relation |
Event.Block.Dataview.RelationDelete
Field | Type | Label | Description |
---|---|---|---|
id | string | dataview block's id | |
relationKeys | string | repeated | relation key to remove |
Event.Block.Dataview.RelationSet
sent when the dataview relation has been changed or added
Field | Type | Label | Description |
---|---|---|---|
id | string | dataview block's id | |
relationLinks | model.RelationLink | repeated | relation id to update |
Event.Block.Dataview.SliceChange
Field | Type | Label | Description |
---|---|---|---|
op | Event.Block.Dataview.SliceOperation | ||
ids | string | repeated | |
afterId | string |
Event.Block.Dataview.SourceSet
Field | Type | Label | Description |
---|---|---|---|
id | string | dataview block's id | |
source | string | repeated |
Event.Block.Dataview.TargetObjectIdSet
Field | Type | Label | Description |
---|---|---|---|
id | string | dataview block's id | |
targetObjectId | string |
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 |
Event.Block.Dataview.ViewUpdate
Field | Type | Label | Description |
---|---|---|---|
id | string | ||
viewId | string | ||
filter | Event.Block.Dataview.ViewUpdate.Filter | repeated | |
relation | Event.Block.Dataview.ViewUpdate.Relation | repeated | |
sort | Event.Block.Dataview.ViewUpdate.Sort | repeated | |
fields | Event.Block.Dataview.ViewUpdate.Fields |
Event.Block.Dataview.ViewUpdate.Fields
Field | Type | Label | Description |
---|---|---|---|
type | model.Block.Content.Dataview.View.Type | ||
name | string | ||
coverRelationKey | string | Relation used for cover in gallery | |
hideIcon | bool | Hide icon near name | |
cardSize | model.Block.Content.Dataview.View.Size | Gallery card size | |
coverFit | bool | Image fits container | |
groupRelationKey | string | Group view by this relationKey | |
groupBackgroundColors | bool | Enable backgrounds in groups | |
pageLimit | int32 |
Event.Block.Dataview.ViewUpdate.Filter
Field | Type | Label | Description |
---|---|---|---|
add | Event.Block.Dataview.ViewUpdate.Filter.Add | ||
remove | Event.Block.Dataview.ViewUpdate.Filter.Remove | ||
update | Event.Block.Dataview.ViewUpdate.Filter.Update | ||
move | Event.Block.Dataview.ViewUpdate.Filter.Move |
Event.Block.Dataview.ViewUpdate.Filter.Add
Field | Type | Label | Description |
---|---|---|---|
afterId | string | ||
items | model.Block.Content.Dataview.Filter | repeated |
Event.Block.Dataview.ViewUpdate.Filter.Move
Field | Type | Label | Description |
---|---|---|---|
afterId | string | ||
ids | string | repeated |
Event.Block.Dataview.ViewUpdate.Filter.Remove
Field | Type | Label | Description |
---|---|---|---|
ids | string | repeated |
Event.Block.Dataview.ViewUpdate.Filter.Update
Field | Type | Label | Description |
---|---|---|---|
id | string | ||
item | model.Block.Content.Dataview.Filter |
Event.Block.Dataview.ViewUpdate.Relation
Field | Type | Label | Description |
---|---|---|---|
add | Event.Block.Dataview.ViewUpdate.Relation.Add | ||
remove | Event.Block.Dataview.ViewUpdate.Relation.Remove | ||
update | Event.Block.Dataview.ViewUpdate.Relation.Update | ||
move | Event.Block.Dataview.ViewUpdate.Relation.Move |
Event.Block.Dataview.ViewUpdate.Relation.Add
Field | Type | Label | Description |
---|---|---|---|
afterId | string | ||
items | model.Block.Content.Dataview.Relation | repeated |
Event.Block.Dataview.ViewUpdate.Relation.Move
Field | Type | Label | Description |
---|---|---|---|
afterId | string | ||
ids | string | repeated |
Event.Block.Dataview.ViewUpdate.Relation.Remove
Field | Type | Label | Description |
---|---|---|---|
ids | string | repeated |
Event.Block.Dataview.ViewUpdate.Relation.Update
Field | Type | Label | Description |
---|---|---|---|
id | string | ||
item | model.Block.Content.Dataview.Relation |
Event.Block.Dataview.ViewUpdate.Sort
Field | Type | Label | Description |
---|---|---|---|
add | Event.Block.Dataview.ViewUpdate.Sort.Add | ||
remove | Event.Block.Dataview.ViewUpdate.Sort.Remove | ||
update | Event.Block.Dataview.ViewUpdate.Sort.Update | ||
move | Event.Block.Dataview.ViewUpdate.Sort.Move |
Event.Block.Dataview.ViewUpdate.Sort.Add
Field | Type | Label | Description |
---|---|---|---|
afterId | string | ||
items | model.Block.Content.Dataview.Sort | repeated |
Event.Block.Dataview.ViewUpdate.Sort.Move
Field | Type | Label | Description |
---|---|---|---|
afterId | string | ||
ids | string | repeated |
Event.Block.Dataview.ViewUpdate.Sort.Remove
Field | Type | Label | Description |
---|---|---|---|
ids | string | repeated |
Event.Block.Dataview.ViewUpdate.Sort.Update
Field | Type | Label | Description |
---|---|---|---|
id | string | ||
item | model.Block.Content.Dataview.Sort |
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
Field | Type | Label | Description |
---|---|---|---|
id | string | ||
align | model.Block.Align |
Event.Block.Fill.BackgroundColor
Field | Type | Label | Description |
---|---|---|---|
id | string | ||
backgroundColor | string |
Event.Block.Fill.Bookmark
Field | Type | Label | Description |
---|---|---|---|
id | string | ||
url | Event.Block.Fill.Bookmark.Url | ||
title | Event.Block.Fill.Bookmark.Title | ||
description | Event.Block.Fill.Bookmark.Description | ||
imageHash | Event.Block.Fill.Bookmark.ImageHash | ||
faviconHash | Event.Block.Fill.Bookmark.FaviconHash | ||
type | Event.Block.Fill.Bookmark.Type | ||
targetObjectId | Event.Block.Fill.Bookmark.TargetObjectId |
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.TargetObjectId
Field | Type | Label | Description |
---|---|---|---|
value | string |
Event.Block.Fill.Bookmark.Title
Field | Type | Label | Description |
---|---|---|---|
value | string |
Event.Block.Fill.Bookmark.Type
Field | Type | Label | Description |
---|---|---|---|
value | model.LinkPreview.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
Field | Type | Label | Description |
---|---|---|---|
id | string | ||
records | google.protobuf.Struct | repeated |
Event.Block.Fill.Details
Field | Type | Label | Description |
---|---|---|---|
id | string | ||
details | google.protobuf.Struct |
Event.Block.Fill.Div
Field | Type | Label | Description |
---|---|---|---|
id | string | ||
style | Event.Block.Fill.Div.Style |
Event.Block.Fill.Div.Style
Field | Type | Label | Description |
---|---|---|---|
value | model.Block.Content.Div.Style |
Event.Block.Fill.Fields
Field | Type | Label | Description |
---|---|---|---|
id | string | ||
fields | google.protobuf.Struct |
Event.Block.Fill.File
Field | Type | Label | Description |
---|---|---|---|
id | string | ||
type | Event.Block.Fill.File.Type | ||
state | Event.Block.Fill.File.State | ||
mime | Event.Block.Fill.File.Mime | ||
hash | Event.Block.Fill.File.Hash | ||
name | Event.Block.Fill.File.Name | ||
size | Event.Block.Fill.File.Size | ||
style | Event.Block.Fill.File.Style |
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
Field | Type | Label | Description |
---|---|---|---|
value | model.Block.Content.File.State |
Event.Block.Fill.File.Style
Field | Type | Label | Description |
---|---|---|---|
value | model.Block.Content.File.Style |
Event.Block.Fill.File.Type
Field | Type | Label | Description |
---|---|---|---|
value | model.Block.Content.File.Type |
Event.Block.Fill.File.Width
Field | Type | Label | Description |
---|---|---|---|
value | int32 |
Event.Block.Fill.Link
Field | Type | Label | Description |
---|---|---|---|
id | string | ||
targetBlockId | Event.Block.Fill.Link.TargetBlockId | ||
style | Event.Block.Fill.Link.Style | ||
fields | Event.Block.Fill.Link.Fields |
Event.Block.Fill.Link.Fields
Field | Type | Label | Description |
---|---|---|---|
value | google.protobuf.Struct |
Event.Block.Fill.Link.Style
Field | Type | Label | Description |
---|---|---|---|
value | model.Block.Content.Link.Style |
Event.Block.Fill.Link.TargetBlockId
Field | Type | Label | Description |
---|---|---|---|
value | string |
Event.Block.Fill.Restrictions
Field | Type | Label | Description |
---|---|---|---|
id | string | ||
restrictions | model.Block.Restrictions |
Event.Block.Fill.Text
Field | Type | Label | Description |
---|---|---|---|
id | string | ||
text | Event.Block.Fill.Text.Text | ||
style | Event.Block.Fill.Text.Style | ||
marks | Event.Block.Fill.Text.Marks | ||
checked | Event.Block.Fill.Text.Checked | ||
color | Event.Block.Fill.Text.Color |
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
Field | Type | Label | Description |
---|---|---|---|
value | model.Block.Content.Text.Marks |
Event.Block.Fill.Text.Style
Field | Type | Label | Description |
---|---|---|---|
value | model.Block.Content.Text.Style |
Event.Block.Fill.Text.Text
Field | Type | Label | Description |
---|---|---|---|
value | string |
Event.Block.MarksInfo
Field | Type | Label | Description |
---|---|---|---|
marksInRange | model.Block.Content.Text.Mark.Type | repeated |
Event.Block.Set
Event.Block.Set.Align
Field | Type | Label | Description |
---|---|---|---|
id | string | ||
align | model.Block.Align |
Event.Block.Set.BackgroundColor
Field | Type | Label | Description |
---|---|---|---|
id | string | ||
backgroundColor | string |
Event.Block.Set.Bookmark
Field | Type | Label | Description |
---|---|---|---|
id | string | ||
url | Event.Block.Set.Bookmark.Url | ||
title | Event.Block.Set.Bookmark.Title | ||
description | Event.Block.Set.Bookmark.Description | ||
imageHash | Event.Block.Set.Bookmark.ImageHash | ||
faviconHash | Event.Block.Set.Bookmark.FaviconHash | ||
type | Event.Block.Set.Bookmark.Type | ||
targetObjectId | Event.Block.Set.Bookmark.TargetObjectId | ||
state | Event.Block.Set.Bookmark.State |
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.State
Field | Type | Label | Description |
---|---|---|---|
value | model.Block.Content.Bookmark.State |
Event.Block.Set.Bookmark.TargetObjectId
Field | Type | Label | Description |
---|---|---|---|
value | string |
Event.Block.Set.Bookmark.Title
Field | Type | Label | Description |
---|---|---|---|
value | string |
Event.Block.Set.Bookmark.Type
Field | Type | Label | Description |
---|---|---|---|
value | model.LinkPreview.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
Field | Type | Label | Description |
---|---|---|---|
id | string | ||
style | Event.Block.Set.Div.Style |
Event.Block.Set.Div.Style
Field | Type | Label | Description |
---|---|---|---|
value | model.Block.Content.Div.Style |
Event.Block.Set.Fields
Field | Type | Label | Description |
---|---|---|---|
id | string | ||
fields | google.protobuf.Struct |
Event.Block.Set.File
Field | Type | Label | Description |
---|---|---|---|
id | string | ||
type | Event.Block.Set.File.Type | ||
state | Event.Block.Set.File.State | ||
mime | Event.Block.Set.File.Mime | ||
hash | Event.Block.Set.File.Hash | ||
name | Event.Block.Set.File.Name | ||
size | Event.Block.Set.File.Size | ||
style | Event.Block.Set.File.Style |
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
Field | Type | Label | Description |
---|---|---|---|
value | model.Block.Content.File.State |
Event.Block.Set.File.Style
Field | Type | Label | Description |
---|---|---|---|
value | model.Block.Content.File.Style |
Event.Block.Set.File.Type
Field | Type | Label | Description |
---|---|---|---|
value | model.Block.Content.File.Type |
Event.Block.Set.File.Width
Field | Type | Label | Description |
---|---|---|---|
value | int32 |
Event.Block.Set.Latex
Field | Type | Label | Description |
---|---|---|---|
id | string | ||
text | Event.Block.Set.Latex.Text |
Event.Block.Set.Latex.Text
Field | Type | Label | Description |
---|---|---|---|
value | string |
Event.Block.Set.Link
Field | Type | Label | Description |
---|---|---|---|
id | string | ||
targetBlockId | Event.Block.Set.Link.TargetBlockId | ||
style | Event.Block.Set.Link.Style | ||
fields | Event.Block.Set.Link.Fields | ||
iconSize | Event.Block.Set.Link.IconSize | ||
cardStyle | Event.Block.Set.Link.CardStyle | ||
description | Event.Block.Set.Link.Description | ||
relations | Event.Block.Set.Link.Relations |
Event.Block.Set.Link.CardStyle
Field | Type | Label | Description |
---|---|---|---|
value | model.Block.Content.Link.CardStyle |
Event.Block.Set.Link.Description
Field | Type | Label | Description |
---|---|---|---|
value | model.Block.Content.Link.Description |
Event.Block.Set.Link.Fields
Field | Type | Label | Description |
---|---|---|---|
value | google.protobuf.Struct |
Event.Block.Set.Link.IconSize
Field | Type | Label | Description |
---|---|---|---|
value | model.Block.Content.Link.IconSize |
Event.Block.Set.Link.Relations
Field | Type | Label | Description |
---|---|---|---|
value | string | repeated |
Event.Block.Set.Link.Style
Field | Type | Label | Description |
---|---|---|---|
value | model.Block.Content.Link.Style |
Event.Block.Set.Link.TargetBlockId
Field | Type | Label | Description |
---|---|---|---|
value | string |
Event.Block.Set.Relation
Field | Type | Label | Description |
---|---|---|---|
id | string | ||
key | Event.Block.Set.Relation.Key |
Event.Block.Set.Relation.Key
Field | Type | Label | Description |
---|---|---|---|
value | string |
Event.Block.Set.Restrictions
Field | Type | Label | Description |
---|---|---|---|
id | string | ||
restrictions | model.Block.Restrictions |
Event.Block.Set.TableRow
Field | Type | Label | Description |
---|---|---|---|
id | string | ||
isHeader | Event.Block.Set.TableRow.IsHeader |
Event.Block.Set.TableRow.IsHeader
Field | Type | Label | Description |
---|---|---|---|
value | bool |
Event.Block.Set.Text
Field | Type | Label | Description |
---|---|---|---|
id | string | ||
text | Event.Block.Set.Text.Text | ||
style | Event.Block.Set.Text.Style | ||
marks | Event.Block.Set.Text.Marks | ||
checked | Event.Block.Set.Text.Checked | ||
color | Event.Block.Set.Text.Color | ||
iconEmoji | Event.Block.Set.Text.IconEmoji | ||
iconImage | Event.Block.Set.Text.IconImage |
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
Field | Type | Label | Description |
---|---|---|---|
value | model.Block.Content.Text.Marks |
Event.Block.Set.Text.Style
Field | Type | Label | Description |
---|---|---|---|
value | model.Block.Content.Text.Style |
Event.Block.Set.Text.Text
Field | Type | Label | Description |
---|---|---|---|
value | string |
Event.Block.Set.VerticalAlign
Field | Type | Label | Description |
---|---|---|---|
id | string | ||
verticalAlign | model.Block.VerticalAlign |
Event.Block.Set.Widget
Field | Type | Label | Description |
---|---|---|---|
id | string | ||
layout | Event.Block.Set.Widget.Layout | ||
limit | Event.Block.Set.Widget.Limit | ||
viewId | Event.Block.Set.Widget.ViewId |
Event.Block.Set.Widget.Layout
Field | Type | Label | Description |
---|---|---|---|
value | model.Block.Content.Widget.Layout |
Event.Block.Set.Widget.Limit
Field | Type | Label | Description |
---|---|---|---|
value | int32 |
Event.Block.Set.Widget.ViewId
Field | Type | Label | Description |
---|---|---|---|
value | string |
Event.File
Event.File.LimitReached
Field | Type | Label | Description |
---|---|---|---|
spaceId | string | ||
fileId | string |
Event.File.LocalUsage
Field | Type | Label | Description |
---|---|---|---|
localBytesUsage | uint64 |
Event.File.SpaceUsage
Field | Type | Label | Description |
---|---|---|---|
bytesUsage | uint64 |
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
Field | Type | Label | Description |
---|---|---|---|
id | string | context objectId | |
details | Event.Object.Details.Amend.KeyValue | repeated | slice of changed key-values |
subIds | string | repeated |
Event.Object.Details.Amend.KeyValue
Field | Type | Label | Description |
---|---|---|---|
key | string | ||
value | google.protobuf.Value | should not be null |
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.Relations
Event.Object.Relations.Amend
Field | Type | Label | Description |
---|---|---|---|
id | string | context objectId | |
relationLinks | model.RelationLink | repeated |
Event.Object.Relations.Remove
Field | Type | Label | Description |
---|---|---|---|
id | string | context objectId | |
relationKeys | string | repeated |
Event.Object.Remove
Field | Type | Label | Description |
---|---|---|---|
ids | string | repeated | notifies that objects were removed |
Event.Object.Restrictions
Event.Object.Restrictions.Set
Field | Type | Label | Description |
---|---|---|---|
id | string | ||
restrictions | model.Restrictions |
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.Groups
Field | Type | Label | Description |
---|---|---|---|
subId | string | ||
group | model.Block.Content.Dataview.Group | ||
remove | bool |
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
Field | Type | Label | Description |
---|---|---|---|
process | Model.Process |
Event.Process.New
Field | Type | Label | Description |
---|---|---|---|
process | Model.Process |
Event.Process.Update
Field | Type | Label | Description |
---|---|---|---|
process | Model.Process |
Event.Status
Event.Status.Thread
Field | Type | Label | Description |
---|---|---|---|
summary | Event.Status.Thread.Summary | ||
cafe | Event.Status.Thread.Cafe | ||
accounts | Event.Status.Thread.Account | repeated |
Event.Status.Thread.Account
Field | Type | Label | Description |
---|---|---|---|
id | string | ||
name | string | ||
imageHash | string | ||
online | bool | ||
lastPulled | int64 | ||
lastEdited | int64 | ||
devices | Event.Status.Thread.Device | repeated |
Event.Status.Thread.Cafe
Field | Type | Label | Description |
---|---|---|---|
status | Event.Status.Thread.SyncStatus | ||
lastPulled | int64 | ||
lastPushSucceed | bool | ||
files | Event.Status.Thread.Cafe.PinStatus |
Event.Status.Thread.Cafe.PinStatus
Field | Type | Label | Description |
---|---|---|---|
pinning | int32 | ||
pinned | int32 | ||
failed | int32 | ||
updated | int64 |
Event.Status.Thread.Device
Field | Type | Label | Description |
---|---|---|---|
name | string | ||
online | bool | ||
lastPulled | int64 | ||
lastEdited | int64 |
Event.Status.Thread.Summary
Field | Type | Label | Description |
---|---|---|---|
status | Event.Status.Thread.SyncStatus |
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. |
Event.User.Block.TextRange
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
Field | Type | Label | Description |
---|---|---|---|
id | string | ||
type | Model.Process.Type | ||
state | Model.Process.State | ||
progress | Model.Process.Progress |
Model.Process.Progress
Field | Type | Label | Description |
---|---|---|---|
total | int64 | ||
done | int64 | ||
message | string |
ResponseEvent
Field | Type | Label | Description |
---|---|---|---|
messages | Event.Message | repeated | |
contextId | string | ||
traceId | string |
Event.Block.Dataview.SliceOperation
Name | Number | Description |
---|---|---|
SliceOperationNone | 0 | not used |
SliceOperationAdd | 1 | |
SliceOperationMove | 2 | |
SliceOperationRemove | 3 | |
SliceOperationReplace | 4 |
Event.Status.Thread.SyncStatus
Name | Number | Description |
---|---|---|
Unknown | 0 | |
Offline | 1 | |
Syncing | 2 | |
Synced | 3 | |
Failed | 4 | |
IncompatibleVersion | 5 |
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 | |
Migration | 5 |
pb/protos/snapshot.proto
Profile
Field | Type | Label | Description |
---|---|---|---|
name | string | ||
avatar | string | ||
address | string | ||
spaceDashboardId | string | ||
profileId | string | ||
analyticsId | string |
SnapshotWithType
Field | Type | Label | Description |
---|---|---|---|
sbType | model.SmartBlockType | ||
snapshot | Change.Snapshot |
pkg/lib/pb/model/protos/localstore.proto
ObjectDetails
Field | Type | Label | Description |
---|---|---|---|
details | google.protobuf.Struct |
ObjectInfo
Field | Type | Label | Description |
---|---|---|---|
id | string | ||
objectTypeUrls | string | repeated | DEPRECATED |
details | google.protobuf.Struct | ||
relations | Relation | repeated | DEPRECATED |
snippet | string | ||
hasInboundLinks | bool | DEPRECATED | |
objectType | SmartBlockType |
ObjectInfoWithLinks
Field | Type | Label | Description |
---|---|---|---|
id | string | ||
info | ObjectInfo | ||
links | ObjectLinksInfo |
ObjectInfoWithOutboundLinks
Field | Type | Label | Description |
---|---|---|---|
id | string | ||
info | ObjectInfo | ||
outboundLinks | ObjectInfo | repeated |
ObjectInfoWithOutboundLinksIDs
Field | Type | Label | Description |
---|---|---|---|
id | string | ||
info | ObjectInfo | ||
outboundLinks | string | repeated |
ObjectLinks
Field | Type | Label | Description |
---|---|---|---|
inboundIDs | string | repeated | |
outboundIDs | string | repeated |
ObjectLinksInfo
Field | Type | Label | Description |
---|---|---|---|
inbound | ObjectInfo | repeated | |
outbound | ObjectInfo | repeated |
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 | |
filestoreKeysForceReindexCounter | int32 |
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 | |
config | Account.Config | ||
status | Account.Status | ||
info | Account.Info |
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
Field | Type | Label | Description |
---|---|---|---|
enableDataview | bool | ||
enableDebug | bool | ||
enablePrereleaseChannel | bool | ||
enableSpaces | bool | ||
extra | google.protobuf.Struct |
Account.Info
Field | Type | Label | Description |
---|---|---|---|
homeObjectId | string | home dashboard block id | |
archiveObjectId | string | archive block id | |
profileObjectId | string | profile block id | |
marketplaceWorkspaceId | string | marketplace workspace id | |
deviceId | string | ||
accountSpaceId | string | marketplace template id | |
widgetsId | string | ||
gatewayUrl | string | gateway url for fetching static files | |
localStoragePath | string | path to local storage | |
timeZone | string | time zone from config | |
analyticsId | string |
Account.Status
Field | Type | Label | Description |
---|---|---|---|
statusType | Account.StatusType | ||
deletionDate | int64 |
Block
Field | Type | Label | Description |
---|---|---|---|
id | string | ||
fields | google.protobuf.Struct | ||
restrictions | Block.Restrictions | ||
childrenIds | string | repeated | |
backgroundColor | string | ||
align | Block.Align | ||
verticalAlign | Block.VerticalAlign | ||
smartblock | Block.Content.Smartblock | ||
text | Block.Content.Text | ||
file | Block.Content.File | ||
layout | Block.Content.Layout | ||
div | Block.Content.Div | ||
bookmark | Block.Content.Bookmark | ||
icon | Block.Content.Icon | ||
link | Block.Content.Link | ||
dataview | Block.Content.Dataview | ||
relation | Block.Content.Relation | ||
featuredRelations | Block.Content.FeaturedRelations | ||
latex | Block.Content.Latex | ||
tableOfContents | Block.Content.TableOfContents | ||
table | Block.Content.Table | ||
tableColumn | Block.Content.TableColumn | ||
tableRow | Block.Content.TableRow | ||
widget | Block.Content.Widget |
Block.Content
Block.Content.Bookmark
Bookmark is to keep a web-link and to preview a content.
Field | Type | Label | Description |
---|---|---|---|
url | string | ||
title | string | Deprecated. Get this data from the target object. | |
description | string | Deprecated. Get this data from the target object. | |
imageHash | string | Deprecated. Get this data from the target object. | |
faviconHash | string | Deprecated. Get this data from the target object. | |
type | LinkPreview.Type | ||
targetObjectId | string | ||
state | Block.Content.Bookmark.State |
Block.Content.Dataview
Field | Type | Label | Description |
---|---|---|---|
source | string | repeated | |
views | Block.Content.Dataview.View | repeated | |
relations | Relation | repeated | deprecated |
activeView | string | saved within a session | |
groupOrders | Block.Content.Dataview.GroupOrder | repeated | |
objectOrders | Block.Content.Dataview.ObjectOrder | repeated | |
relationLinks | RelationLink | repeated | |
TargetObjectId | string | ||
isCollection | bool |
Block.Content.Dataview.Checkbox
Field | Type | Label | Description |
---|---|---|---|
checked | bool |
Block.Content.Dataview.Date
Block.Content.Dataview.Filter
Field | Type | Label | Description |
---|---|---|---|
id | string | ||
operator | Block.Content.Dataview.Filter.Operator | looks not applicable? | |
RelationKey | string | ||
relationProperty | string | ||
condition | Block.Content.Dataview.Filter.Condition | ||
value | google.protobuf.Value | ||
quickOption | Block.Content.Dataview.Filter.QuickOption | ||
format | RelationFormat | ||
includeTime | bool |
Block.Content.Dataview.Group
Field | Type | Label | Description |
---|---|---|---|
id | string | ||
status | Block.Content.Dataview.Status | ||
tag | Block.Content.Dataview.Tag | ||
checkbox | Block.Content.Dataview.Checkbox | ||
date | Block.Content.Dataview.Date |
Block.Content.Dataview.GroupOrder
Field | Type | Label | Description |
---|---|---|---|
viewId | string | ||
viewGroups | Block.Content.Dataview.ViewGroup | repeated |
Block.Content.Dataview.ObjectOrder
Field | Type | Label | Description |
---|---|---|---|
viewId | string | ||
groupId | string | ||
objectIds | string | repeated |
Block.Content.Dataview.Relation
Field | Type | Label | Description |
---|---|---|---|
key | string | ||
isVisible | bool | ||
width | int32 | the displayed column % calculated based on other visible relations | |
dateIncludeTime | bool | ||
timeFormat | Block.Content.Dataview.Relation.TimeFormat | ||
dateFormat | Block.Content.Dataview.Relation.DateFormat |
Block.Content.Dataview.Sort
Field | Type | Label | Description |
---|---|---|---|
id | string | ||
RelationKey | string | ||
type | Block.Content.Dataview.Sort.Type | ||
customOrder | google.protobuf.Value | repeated | |
format | RelationFormat | ||
includeTime | bool |
Block.Content.Dataview.Status
Field | Type | Label | Description |
---|---|---|---|
id | string |
Block.Content.Dataview.Tag
Field | Type | Label | Description |
---|---|---|---|
ids | string | repeated |
Block.Content.Dataview.View
Field | Type | Label | Description |
---|---|---|---|
id | string | ||
type | Block.Content.Dataview.View.Type | ||
name | string | ||
sorts | Block.Content.Dataview.Sort | repeated | |
filters | Block.Content.Dataview.Filter | repeated | |
relations | Block.Content.Dataview.Relation | repeated | relations fields/columns options, also used to provide the order |
coverRelationKey | string | Relation used for cover in gallery | |
hideIcon | bool | Hide icon near name | |
cardSize | Block.Content.Dataview.View.Size | Gallery card size | |
coverFit | bool | Image fits container | |
groupRelationKey | string | Group view by this relationKey | |
groupBackgroundColors | bool | Enable backgrounds in groups | |
pageLimit | int32 | ||
defaultTemplateId | string |
Block.Content.Dataview.ViewGroup
Field | Type | Label | Description |
---|---|---|---|
groupId | string | ||
index | int32 | ||
hidden | bool | ||
backgroundColor | string |
Block.Content.Div
Divider: block, that contains only one horizontal thin line
Field | Type | Label | Description |
---|---|---|---|
style | Block.Content.Div.Style |
Block.Content.FeaturedRelations
Block.Content.File
Field | Type | Label | Description |
---|---|---|---|
hash | string | ||
name | string | ||
type | Block.Content.File.Type | ||
mime | string | ||
size | int64 | ||
addedAt | int64 | ||
state | Block.Content.File.State | ||
style | Block.Content.File.Style |
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
Field | Type | Label | Description |
---|---|---|---|
style | Block.Content.Layout.Style |
Block.Content.Link
Link: block to link some content from an external sources.
Field | Type | Label | Description |
---|---|---|---|
targetBlockId | string | id of the target block | |
style | Block.Content.Link.Style | deprecated | |
fields | google.protobuf.Struct | ||
iconSize | Block.Content.Link.IconSize | ||
cardStyle | Block.Content.Link.CardStyle | ||
description | Block.Content.Link.Description | ||
relations | string | repeated |
Block.Content.Relation
Field | Type | Label | Description |
---|---|---|---|
key | string |
Block.Content.Smartblock
Block.Content.Table
Block.Content.TableColumn
Block.Content.TableOfContents
Block.Content.TableRow
Field | Type | Label | Description |
---|---|---|---|
isHeader | bool |
Block.Content.Text
Field | Type | Label | Description |
---|---|---|---|
text | string | ||
style | Block.Content.Text.Style | ||
marks | Block.Content.Text.Marks | list of marks to apply to the text | |
checked | bool | ||
color | string | ||
iconEmoji | string | used with style Callout | |
iconImage | string | in case both image and emoji are set, image should has a priority in the UI |
Block.Content.Text.Mark
Field | Type | Label | Description |
---|---|---|---|
range | Range | range of symbols to apply this mark. From(symbol) To(symbol) | |
type | Block.Content.Text.Mark.Type | ||
param | string | link, color, etc |
Block.Content.Text.Marks
Field | Type | Label | Description |
---|---|---|---|
marks | Block.Content.Text.Mark | repeated |
Block.Content.Widget
Field | Type | Label | Description |
---|---|---|---|
layout | Block.Content.Widget.Layout | ||
limit | int32 | ||
viewId | string |
Block.Restrictions
Field | Type | Label | Description |
---|---|---|---|
read | bool | ||
edit | bool | ||
remove | bool | ||
drag | bool | ||
dropOn | bool |
BlockMetaOnly
Used to decode block meta only, without the content itself
Field | Type | Label | Description |
---|---|---|---|
id | string | ||
fields | google.protobuf.Struct |
InternalFlag
Field | Type | Label | Description |
---|---|---|---|
value | InternalFlag.Value |
Layout
Field | Type | Label | Description |
---|---|---|---|
id | ObjectType.Layout | ||
name | string | ||
requiredRelations | Relation | repeated | relations required for this object type |
LinkPreview
Field | Type | Label | Description |
---|---|---|---|
url | string | ||
title | string | ||
description | string | ||
imageUrl | string | ||
faviconUrl | string | ||
type | LinkPreview.Type |
Object
Object.ChangePayload
Field | Type | Label | Description |
---|---|---|---|
smartBlockType | SmartBlockType |
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) | |
relationLinks | RelationLink | 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 | |
installedByDefault | bool |
ObjectView
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 | Block | repeated | dependent simple blocks (descendants) |
details | ObjectView.DetailsSet | repeated | details for the current and dependent objects |
type | SmartBlockType | ||
relations | Relation | repeated | DEPRECATED, use relationLinks instead |
relationLinks | RelationLink | repeated | |
restrictions | Restrictions | object restrictions | |
history | ObjectView.HistorySize |
ObjectView.DetailsSet
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 |
ObjectView.HistorySize
Field | Type | Label | Description |
---|---|---|---|
undo | int32 | ||
redo | int32 |
ObjectView.RelationWithValuePerObject
Field | Type | Label | Description |
---|---|---|---|
objectId | string | ||
relations | RelationWithValue | repeated |
Range
General purpose structure, uses in Mark.
Field | Type | Label | Description |
---|---|---|---|
from | int32 | ||
to | int32 |
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 |
---|---|---|---|
id | string | ||
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 | |
relationKey | string | 4 is reserved for old relation format |
stored |
RelationLink
Field | Type | Label | Description |
---|---|---|---|
key | string | ||
format | RelationFormat |
RelationOptions
Field | Type | Label | Description |
---|---|---|---|
options | Relation.Option | repeated |
RelationWithValue
Field | Type | Label | Description |
---|---|---|---|
relation | Relation | ||
value | google.protobuf.Value |
Relations
Field | Type | Label | Description |
---|---|---|---|
relations | Relation | repeated |
Restrictions
Field | Type | Label | Description |
---|---|---|---|
object | Restrictions.ObjectRestriction | repeated | |
dataview | Restrictions.DataviewRestrictions | repeated |
Restrictions.DataviewRestrictions
Field | Type | Label | Description |
---|---|---|---|
blockId | string | ||
restrictions | Restrictions.DataviewRestriction | repeated |
SmartBlockSnapshotBase
Field | Type | Label | Description |
---|---|---|---|
blocks | Block | repeated | |
details | google.protobuf.Struct | ||
fileKeys | google.protobuf.Struct | ||
extraRelations | Relation | repeated | deprecated |
objectTypes | string | repeated | |
collections | google.protobuf.Struct | ||
removedCollectionKeys | string | repeated | |
relationLinks | RelationLink | repeated |
Account.StatusType
Name | Number | Description |
---|---|---|
Active | 0 | |
PendingDeletion | 1 | |
StartedDeletion | 2 | |
Deleted | 3 |
Block.Align
Name | Number | Description |
---|---|---|
AlignLeft | 0 | |
AlignCenter | 1 | |
AlignRight | 2 |
Block.Content.Bookmark.State
Name | Number | Description |
---|---|---|
Empty | 0 | |
Fetching | 1 | |
Done | 2 | |
Error | 3 |
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 | "at least one value(from the provided list) is IN" |
NotIn | 10 | "none of provided values are IN" |
Empty | 11 | |
NotEmpty | 12 | |
AllIn | 13 | |
NotAllIn | 14 | |
ExactIn | 15 | |
NotExactIn | 16 | |
Exists | 17 |
Block.Content.Dataview.Filter.Operator
Name | Number | Description |
---|---|---|
And | 0 | |
Or | 1 |
Block.Content.Dataview.Filter.QuickOption
Name | Number | Description |
---|---|---|
ExactDate | 0 | |
Yesterday | 1 | |
Today | 2 | |
Tomorrow | 3 | |
LastWeek | 4 | |
CurrentWeek | 5 | |
NextWeek | 6 | |
LastMonth | 7 | |
CurrentMonth | 8 | |
NextMonth | 9 | |
NumberOfDaysAgo | 10 | |
NumberOfDaysNow | 11 |
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 | |
Custom | 2 |
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 | |
5 |
Block.Content.Layout.Style
Name | Number | Description |
---|---|---|
Row | 0 | |
Column | 1 | |
Div | 2 | |
Header | 3 | |
TableRows | 4 | |
TableColumns | 5 |
Block.Content.Link.CardStyle
Name | Number | Description |
---|---|---|
Text | 0 | |
Card | 1 | |
Inline | 2 |
Block.Content.Link.Description
Name | Number | Description |
---|---|---|
None | 0 | |
Added | 1 | |
Content | 2 |
Block.Content.Link.IconSize
Name | Number | Description |
---|---|---|
SizeNone | 0 | |
SizeSmall | 1 | |
SizeMedium | 2 |
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 one block of this style can exists on a page |
Checkbox | 8 | |
Marked | 9 | |
Numbered | 10 | |
Toggle | 11 | |
Description | 12 | currently only one block of this style can exists on a page |
Callout | 13 |
Block.Content.Widget.Layout
Name | Number | Description |
---|---|---|
Link | 0 | |
Tree | 1 | |
List | 2 | |
CompactList | 3 |
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 |
Block.VerticalAlign
Name | Number | Description |
---|---|---|
VerticalAlignTop | 0 | |
VerticalAlignMiddle | 1 | |
VerticalAlignBottom | 2 |
InternalFlag.Value
Use such a weird construction due to the issue with imported repeated enum type Look https://github.com/golang/protobuf/issues/1135 for more information.
Name | Number | Description |
---|---|---|
editorDeleteEmpty | 0 | |
editorSelectType | 1 | |
editorSelectTemplate | 2 | |
collectionDontIndexLinks | 3 |
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 | |
bookmark | 11 | |
relationOptionsList | 12 | |
relationOption | 13 | |
collection | 14 | |
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.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 |
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 | restricts type changing |
LayoutChange | 6 | restricts layout changing |
Template | 7 | restricts template creation from this object |
Duplicate | 8 | restricts duplicate object |
SmartBlockType
Name | Number | Description |
---|---|---|
AccountOld | 0 | deprecated |
Page | 16 | |
ProfilePage | 17 | |
Home | 32 | |
Archive | 48 | |
Widget | 112 | |
File | 256 | |
Template | 288 | |
BundledTemplate | 289 | |
BundledRelation | 512 | DEPRECATED |
SubObject | 513 | |
BundledObjectType | 514 | |
AnytypeProfile | 515 | |
Date | 516 | |
Workspace | 518 | |
MissingObject | 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) |