package anytype.model

Get desktop application:
View/edit binary Protocol Buffers messages

* Contains basic information about a user account

Used in: Event, Event.Account.Show, Rpc.Account.Create.Response, Rpc.Account.Select.Response

• string id = 1

  User's thread id

• optional Account.Config config = 4

• optional Account.Status status = 5

• optional Account.Info info = 6

(message has no fields)

Used in: Rpc.Account.LocalLink.ApproveChallenge.Request, Rpc.Account.LocalLink.SolveChallenge.Response, Rpc.Account.LocalLink.UpdateApp.Request, Rpc.Wallet.CreateSession.Response, AppInfo

• repeated string spaceIds = 1

  spaceIds are the spaces the key may touch; empty only when allSpaces is set — exactly one of the two must be present

• AppGrant.Perm perm = 2

• bool allSpaces = 3

  allSpaces grants every space in the account, including spaces created after the grant was made (dynamic — GitHub's "All repositories" semantics). The JSON API still excludes the tech space; reaching it requires listing it explicitly in spaceIds.

Perm is nested so its Go constants (AccountAuthAppGrant_Read) can never be misread as the key scopes (AccountAuth_JsonAPI et al.) — grant verbs and key scopes are unrelated enums about different authorization layers.

Used in: Event.Account.LinkApprovalRequest, Rpc.Account.LocalLink.NewChallenge.Request, AppGrant

• Read = 0

  the zero value is the narrowest permission, so an unset perm never widens

• ReadWrite = 1

Used in: Rpc.Account.LocalLink.CreateApp.Request, Rpc.Account.LocalLink.ListApps.Response

• string appHash = 1

• string appName = 2

  either from process or specified manually when creating

• string appKey = 4

• int64 createdAt = 5

• int64 expireAt = 6

  unix timestamp in seconds after which the key stops authenticating; 0 means the key never expires

• LocalApiScope scope = 7

• bool isActive = 8

• optional AppGrant grant = 9

  unset means an unscoped (legacy) key; only JsonAPI-scope keys may carry one

Used in: Event.Account.LinkApprovalRequest, Rpc.Account.LocalLink.NewChallenge.Request, Rpc.Wallet.CreateSession.Response, AppInfo

• Limited = 0

  Used in WebClipper; AccountSelect(to be deprecated), ObjectSearch, ObjectShow, ObjectCreate, ObjectCreateFromURL, BlockPreview, BlockPaste, BroadcastPayloadEvent

• JsonAPI = 1

  JSON API only, no direct grpc api calls allowed

• Full = 2

  Full access, not available via LocalLink

Used in: Event.Account.Config.Update, Event.Account.Update, Account

• bool enableDataview = 1

• bool enableDebug = 2

• bool enablePrereleaseChannel = 3

• bool enableSpaces = 4

• optional google.protobuf.Struct extra = 100

Used in: Rpc.Workspace.Open.Response, Account

• string homeObjectId = 2

  home dashboard block id

• string archiveObjectId = 3

  archive block id

• string profileObjectId = 4

  profile block id

• string marketplaceWorkspaceId = 11

  marketplace workspace id

• string workspaceObjectId = 15

  workspace object id. used for space-level chat

• string spaceChatId = 16

  space-level chat if exists

• string deviceId = 8

• string accountSpaceId = 9

  the first created private space. It's filled only when account is created

• string widgetsId = 10

• string spaceViewId = 13

• string techSpaceId = 14

• string gatewayUrl = 101

  gateway url for fetching static files

• string localStoragePath = 103

  path to local storage

• string timeZone = 104

  time zone from config

• string analyticsId = 105

• string networkId = 106

  network id to which anytype is connected

• string ethereumAddress = 107

  we have Any PK AND Ethereum PK derived from one seed phrase

• string metaDataKey = 108

  symmetric key for encrypting profile metadata

Used in: Event.Account.Config.Update, Event.Account.Update, Rpc.Account.Delete.Response, Rpc.Account.RevertDeletion.Response, Account

• StatusType statusType = 1

• int64 deletionDate = 2

Used in: Status

• Active = 0

• PendingDeletion = 1

• StartedDeletion = 2

• Deleted = 3

Used in: Change.BlockCreate, Event.Block.Add, Rpc.Block.Copy.Request, Rpc.Block.Copy.Response, Rpc.Block.Create.Request, Rpc.Block.CreateWidget.Request, Rpc.Block.Cut.Request, Rpc.Block.Cut.Response, Rpc.Block.Export.Request, Rpc.Block.ListConvertToObjects.Request, Rpc.Block.Paste.Request, Rpc.Block.Preview.Response, Rpc.Block.Replace.Request, Rpc.BlockLink.CreateWithObject.Request, ObjectView, SmartBlockSnapshotBase

• string id = 1

• optional google.protobuf.Struct fields = 2

• optional Block.Restrictions restrictions = 3

• repeated string childrenIds = 4

• string backgroundColor = 5

• Block.Align align = 6

• Block.VerticalAlign verticalAlign = 7

• oneof content

  • Block.Content.Smartblock smartblock = 11

  • Block.Content.Text text = 14

  • Block.Content.File file = 15

  • Block.Content.Layout layout = 16

  • Block.Content.Div div = 17

  • Block.Content.Bookmark bookmark = 18

  • Block.Content.Icon icon = 19

  • Block.Content.Link link = 20

  • Block.Content.Dataview dataview = 21

  • Block.Content.Relation relation = 22

  • Block.Content.FeaturedRelations featuredRelations = 23

  • Block.Content.Latex latex = 24

  • Block.Content.TableOfContents tableOfContents = 25

  • Block.Content.Table table = 26

  • Block.Content.TableColumn tableColumn = 27

  • Block.Content.TableRow tableRow = 28

  • Block.Content.Widget widget = 29

  • Block.Content.Chat chat = 30

Used in: Event.Block.Fill.Align, Event.Block.Set.Align, Rpc.Block.ListSetAlign.Request, Rpc.Block.ListUpdate.Request, Block, Content.Dataview.Relation

• AlignLeft = 0

• AlignCenter = 1

• AlignRight = 2

• AlignJustify = 3

(message has no fields)

Bookmark is to keep a web-link and to preview a content.

Used in: Block

• string url = 1

• string title = 2

  Deprecated. Get this data from the target object.

• string description = 3

  Deprecated. Get this data from the target object.

• string imageHash = 4

  Deprecated. Get this data from the target object.

• string faviconHash = 5

  Deprecated. Get this data from the target object.

• LinkPreview.Type type = 6

• string targetObjectId = 7

• Bookmark.State state = 8

Used in: Event.Block.Set.Bookmark.State, Bookmark

• Empty = 0

• Fetching = 1

• Done = 2

• Error = 3

Used in: Block

(message has no fields)

Used in: Block

• repeated string source = 1

  can be set for detached(without TargetObjectId) inline sets

• repeated Dataview.View views = 2

• string activeView = 3

  do not generate changes for this field

• repeated Relation relations = 4

  deprecated

• repeated Dataview.GroupOrder groupOrders = 12

• repeated Dataview.ObjectOrder objectOrders = 13

• repeated RelationLink relationLinks = 5

• string TargetObjectId = 6

  empty for original set/collection objects and for detached inline sets

• bool isCollection = 14

Used in: Group

• bool checked = 1

Used in: Group

(message has no fields)

Used in: Event.Block.Dataview.ViewUpdate.Filter.Add, Event.Block.Dataview.ViewUpdate.Filter.Update, Rpc.BlockDataview.Filter.Add.Request, Rpc.BlockDataview.Filter.Replace.Request, Rpc.Object.CrossSpaceSearch.Request, Rpc.Object.CrossSpaceSearchSubscribe.Request, Rpc.Object.Graph.Request, Rpc.Object.GroupsSubscribe.Request, Rpc.Object.Search.Request, Rpc.Object.SearchSubscribe.Request, Rpc.Object.SearchWithMeta.Request, View

• string id = 9

• Filter.Operator operator = 1

  looks not applicable?

• string RelationKey = 2

• string relationProperty = 5

• Filter.Condition condition = 3

• optional google.protobuf.Value value = 4

• Filter.QuickOption quickOption = 6

• RelationFormat format = 7

• bool includeTime = 8

• repeated Filter nestedFilters = 10

Used in: Filter

• 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

Used in: Filter

• No = 0

• Or = 1

• And = 2

Used in: Filter

• ExactDate = 0

• Yesterday = 1

• Today = 2

• Tomorrow = 3

• LastWeek = 4

• CurrentWeek = 5

• NextWeek = 6

• LastMonth = 7

• CurrentMonth = 8

• NextMonth = 9

• NumberOfDaysAgo = 10

• NumberOfDaysNow = 11

• LastYear = 12

• CurrentYear = 13

• NextYear = 14

Used in: Event.Object.Subscription.Groups, Rpc.Object.GroupsSubscribe.Response

• string id = 1

• oneof Value

  • Status status = 2

  • Tag tag = 3

  • Checkbox checkbox = 4

  • Date date = 5

Used in: Event.Block.Dataview.GroupOrderUpdate, Rpc.BlockDataview.GroupOrder.Update.Request, Dataview

• string viewId = 1

• repeated ViewGroup viewGroups = 2

Used in: Rpc.BlockDataview.ObjectOrder.Update.Request, Dataview

• string viewId = 1

• string groupId = 2

• repeated string objectIds = 3

Used in: Event.Block.Dataview.ViewUpdate.Relation.Add, Event.Block.Dataview.ViewUpdate.Relation.Update, Rpc.BlockDataview.ViewRelation.Add.Request, Rpc.BlockDataview.ViewRelation.Replace.Request, View

• string key = 1

• bool isVisible = 2

• int32 width = 3

  the displayed column % calculated based on other visible relations

• bool dateIncludeTime = 5

  bool isReadOnly = 4; // deprecated

  deprecated

• Relation.TimeFormat timeFormat = 6

  deprecated

• Relation.DateFormat dateFormat = 7

  deprecated

• Relation.FormulaType formula = 8

• Align align = 9

Used in: Relation

• 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

Used in: Relation

• None = 0

• Count = 1

• CountValue = 2

• CountDistinct = 3

• CountEmpty = 4

• CountNotEmpty = 5

• PercentEmpty = 6

• PercentNotEmpty = 7

• MathSum = 8

• MathAverage = 9

• MathMedian = 10

• MathMin = 11

• MathMax = 12

• Range = 13

Used in: Relation

• Format12 = 0

• Format24 = 1

Used in: Event.Block.Dataview.ViewUpdate.Sort.Add, Event.Block.Dataview.ViewUpdate.Sort.Update, Rpc.BlockDataview.Sort.Add.Request, Rpc.BlockDataview.Sort.Replace.Request, Rpc.Object.CrossSpaceSearch.Request, Rpc.Object.CrossSpaceSearchSubscribe.Request, Rpc.Object.Search.Request, Rpc.Object.SearchSubscribe.Request, Rpc.Object.SearchWithMeta.Request, View

• string RelationKey = 1

• Sort.Type type = 2

• repeated google.protobuf.Value customOrder = 3

• RelationFormat format = 4

• bool includeTime = 5

• string id = 6

• Sort.EmptyType emptyPlacement = 7

• bool noCollate = 8

Used in: Sort

• NotSpecified = 0

• Start = 1

• End = 2

Used in: Rpc.BlockTable.Sort.Request, Sort

• Asc = 0

• Desc = 1

• Custom = 2

Used in: Group

• string id = 1

Used in: Group

• repeated string ids = 1

Used in: Event.Block.Dataview.ViewSet, Rpc.BlockDataview.CreateFromExistingObject.Response, Rpc.BlockDataview.View.Create.Request, Rpc.BlockDataview.View.Update.Request, Dataview

• string id = 1

• View.Type type = 2

• string name = 3

• repeated Sort sorts = 4

• repeated Filter filters = 5

• repeated Relation relations = 6

  relations fields/columns options, also used to provide the order

• string coverRelationKey = 7

  Relation used for cover in gallery

• bool hideIcon = 8

  Hide icon near name

• View.Size cardSize = 9

  Gallery card size

• bool coverFit = 10

  Image fits container

• string groupRelationKey = 11

  Group view by this relationKey

• bool groupBackgroundColors = 12

  Enable backgrounds in groups

• int32 pageLimit = 13

  Limit of objects shown in widget

• string defaultTemplateId = 14

  Default template that is chosen for new object created within the view

• string defaultObjectTypeId = 15

  Default object type that is chosen for new object created within the view

• string endRelationKey = 16

  Group view by this relationKey

• bool wrapContent = 17

  Wrap content in view

• View.ListSize listSize = 18

  List view size setting

• bool alternateRows = 19

  Alternate row background colors in grid view

Used in: Event.Block.Dataview.ViewUpdate.Fields, View

• Compact = 0

  Single-line display (default)

• Regular = 1

  Two-line display with description

Used in: Event.Block.Dataview.ViewUpdate.Fields, View

• Small = 0

• Medium = 1

• Large = 2

Used in: Event.Block.Dataview.ViewUpdate.Fields, View

• Table = 0

• List = 1

• Gallery = 2

• Kanban = 3

• Calendar = 4

• Graph = 5

Used in: GroupOrder

• string groupId = 1

• int32 index = 2

• bool hidden = 3

• string backgroundColor = 4

Divider: block, that contains only one horizontal thin line

Used in: Block

• Div.Style style = 1

Used in: Event.Block.Fill.Div.Style, Event.Block.Set.Div.Style, Rpc.Block.ListUpdate.Request, Rpc.BlockDiv.ListSetStyle.Request, Div

• Line = 0

• Dots = 1

Used in: Block

(message has no fields)

Used in: Block

• string hash = 1

• string name = 2

• File.Type type = 3

• string mime = 4

• int64 size = 5

• int64 addedAt = 6

• string targetObjectId = 9

• File.State state = 7

• File.Style style = 8

Used in: Event.Block.Fill.File.State, Event.Block.Set.File.State, File

• 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

Used in: Event.Block.Fill.File.Style, Event.Block.Set.File.Style, Rpc.Block.ListUpdate.Request, Rpc.BlockFile.ListSetStyle.Request, Rpc.File.Drop.Request, Rpc.File.Upload.Request, File

• Auto = 0

  all types expect File and None has Embed style by default

• Link = 1

• Embed = 2

Used in: Event.Block.Fill.File.Type, Event.Block.Set.File.Type, Rpc.BlockFile.CreateAndUpload.Request, Rpc.File.Drop.Request, Rpc.File.Upload.Request, File

• None = 0

• File = 1

• Image = 2

• Video = 3

• Audio = 4

• PDF = 5

Used in: Block

• string name = 1

Used in: Block

• string text = 1

• Latex.Processor processor = 2

Used in: Event.Block.Set.Latex.Processor, Rpc.BlockLatex.SetProcessor.Request, Rpc.BlockLatex.SetText.Request, Latex, ChatMessage.MessageBlockEmbed

• Latex = 0

• Mermaid = 1

• Chart = 2

• Youtube = 3

• Vimeo = 4

• Soundcloud = 5

• GoogleMaps = 6

• Miro = 7

• Figma = 8

• Twitter = 9

• OpenStreetMap = 10

• Reddit = 11

• Facebook = 12

• Instagram = 13

• Telegram = 14

• GithubGist = 15

• Codepen = 16

• Bilibili = 17

• Excalidraw = 18

• Kroki = 19

• Graphviz = 20

• Sketchfab = 21

• Image = 22

• Drawio = 23

• Spotify = 24

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

Used in: Block

• Layout.Style style = 1

Used in: Layout

• Row = 0

• Column = 1

• Div = 2

• Header = 3

• TableRows = 4

• TableColumns = 5

Link: block to link some content from an external sources.

Used in: Block

• string targetBlockId = 1

  id of the target block

• Link.Style style = 2

  deprecated

• optional google.protobuf.Struct fields = 3

• Link.IconSize iconSize = 4

• Link.CardStyle cardStyle = 5

• Link.Description description = 6

• repeated string relations = 7

Used in: Event.Block.Set.Link.CardStyle, Rpc.BlockLink.ListSetAppearance.Request, Link

• Text = 0

• Card = 1

• Inline = 2

Used in: Event.Block.Set.Link.Description, Rpc.BlockLink.ListSetAppearance.Request, Link

• None = 0

• Added = 1

• Content = 2

Used in: Event.Block.Set.Link.IconSize, Rpc.BlockLink.ListSetAppearance.Request, Link

• SizeNone = 0

• SizeSmall = 1

• SizeMedium = 2

Used in: Event.Block.Fill.Link.Style, Event.Block.Set.Link.Style, Link

• Page = 0

• Dataview = 1

• Dashboard = 2

• Archive = 3

  ...

Used in: Block

• string key = 1

Used in: Block

(message has no fields)

Used in: Block

(message has no fields)

Used in: Block

(message has no fields)

Used in: Block

(message has no fields)

Used in: Block

• bool isHeader = 1

Used in: Block

• string text = 1

• Text.Style style = 2

• optional Text.Marks marks = 3

  list of marks to apply to the text

• bool checked = 4

• string color = 5

• string iconEmoji = 6

  used with style Callout

• string iconImage = 7

  in case both image and emoji are set, image should has a priority in the UI

Used in: Rpc.Block.ListUpdate.Request.Text, Rpc.BlockText.ListSetMark.Request, Marks, ChatMessage.MessageBlockText, ChatMessage.MessageContent

• optional Range range = 1

  range of symbols to apply this mark. From(symbol) To(symbol)

• Mark.Type type = 2

• string param = 3

  link, color, etc

Used in: Event.Block.MarksInfo, Mark

• Strikethrough = 0

• Keyboard = 1

• Italic = 2

• Bold = 3

• Underscored = 4

• Link = 5

• TextColor = 6

• BackgroundColor = 7

• Mention = 8

• Emoji = 9

• Object = 10

Used in: Event.Block.Fill.Text.Marks, Event.Block.Set.Text.Marks, Rpc.BlockText.SetText.Request, Text

• repeated Mark marks = 1

Used in: Event.Block.Fill.Text.Style, Event.Block.Set.Text.Style, Rpc.Block.ListTurnInto.Request, Rpc.Block.ListUpdate.Request.Text, Rpc.Block.Split.Request, Rpc.BlockText.ListSetStyle.Request, Rpc.BlockText.SetStyle.Request, Text, ChatMessage.MessageBlockText, ChatMessage.MessageContent

• 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

• ToggleHeader1 = 14

• ToggleHeader2 = 15

• ToggleHeader3 = 16

Used in: Block

• Widget.Layout layout = 1

• int32 limit = 2

• string viewId = 3

• bool autoAdded = 4

Used in: Event.Block.Set.Widget.Layout, Rpc.Block.CreateWidget.Request, Rpc.BlockWidget.SetLayout.Request, WidgetBlock, Widget

• Link = 0

• Tree = 1

• List = 2

• CompactList = 3

• View = 4

Used in: Change.BlockCreate, Change.BlockDuplicate, Change.BlockMove, Rpc.Block.Create.Request, Rpc.Block.CreateWidget.Request, Rpc.Block.ListDuplicate.Request, Rpc.Block.ListMoveToExistingObject.Request, Rpc.Block.ListMoveToNewObject.Request, Rpc.BlockBookmark.CreateAndFetch.Request, Rpc.BlockFile.CreateAndUpload.Request, Rpc.BlockLink.CreateWithObject.Request, Rpc.BlockTable.ColumnCreate.Request, Rpc.BlockTable.ColumnDuplicate.Request, Rpc.BlockTable.ColumnMove.Request, Rpc.BlockTable.Create.Request, Rpc.BlockTable.RowCreate.Request, Rpc.BlockTable.RowDuplicate.Request, Rpc.File.Drop.Request

• 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

Used in: Event.Block.Fill.Restrictions, Event.Block.Set.Restrictions, Block

• bool read = 1

• bool edit = 2

• bool remove = 3

• bool drag = 4

• bool dropOn = 5

Used in: Event.Block.Set.VerticalAlign, Rpc.Block.ListSetVerticalAlign.Request, Block

• VerticalAlignTop = 0

• VerticalAlignMiddle = 1

• VerticalAlignBottom = 2

Used to decode block meta only, without the content itself

• string id = 1

• optional google.protobuf.Struct fields = 2

Used in: Event.Chat.Add, Event.Chat.Update, Event.Chat.UpdatePinnedStatus, Rpc.Chat.AddMessage.Request, Rpc.Chat.EditMessageContent.Request, Rpc.Chat.GetMessages.Response, Rpc.Chat.GetMessagesByIds.Response, Rpc.Chat.GetPinnedMessages.Response, Rpc.Chat.SubscribeLastMessages.Response, Rpc.Chat.SubscribeToMessagePreviews.Response.ChatPreview, Search.Message.Result

• string id = 1

  Unique message identifier

• string orderId = 2

  Lexicographical id for message in order of tree traversal

• string creator = 3

  Identifier for the message creator

• int64 createdAt = 4

• int64 modifiedAt = 9

• string stateId = 11

  stateId is ever-increasing id (BSON ObjectId) for this message. Unlike orderId, this ID is ordered by the time messages are added. For example, it's useful to prevent accidental reading of messages from the past when a ChatReadMessages request is sent: a message from the past may appear, but the client is still unaware of it

• string replyToMessageId = 5

  Identifier for the message being replied to

• optional ChatMessage.MessageContent message = 6

  Message content

• repeated ChatMessage.Attachment attachments = 7

  Attachments slice

• optional ChatMessage.Reactions reactions = 8

  Reactions to the message

• bool read = 10

  Message read status

• bool mentionRead = 12

• bool hasMention = 14

• bool synced = 13

• bool pinned = 15

• bool unreadReaction = 16

• repeated ChatMessage.MessageBlock blocks = 17

  Ordered list of content blocks

• bool deleted = 18

  deleted marks a soft-deleted discussion comment (a tombstone). It keeps id, orderId, creator, createdAt and replyToMessageId, so replies keep their thread; message, attachments, blocks and reactions are empty and modifiedAt is 0. Only discussions produce it; a deleted space-chat message is removed and announced with Event.Chat.Delete. A tombstone can't be edited, reacted to, pinned or replied to.

Used in: ChatMessage

• string target = 1

  Identifier for the attachment object

• Attachment.AttachmentType type = 2

  Type of attachment

Used in: Attachment

• FILE = 0

  File attachment

• IMAGE = 1

  Image attachment

• LINK = 2

  Link attachment

Used in: ChatMessage

• oneof content

  • MessageBlockText text = 1

  • MessageBlockLink link = 2

  • MessageBlockEmbed embed = 3

  • MessageBlockEditorQuote editorQuote = 4

  • MessageBlockMessageQuote messageQuote = 5

Used in: MessageBlock

• string blockId = 1

  id of the quoted block in the source object

• optional MessageBlockText content = 2

  quoted block content (text, style, marks, ...)

Used in: MessageBlock

• string text = 1

• Block.Content.Latex.Processor processor = 2

Used in: MessageBlock

• string targetObjectId = 1

• MessageBlockLink.LinkType type = 2

Used in: MessageBlockLink

• Object = 0

• File = 1

• Image = 2

• Bookmark = 3

Used in: MessageBlock

• string messageId = 1

  id of the quoted chat message

• string participantId = 2

  id of the participant who authored the quoted message

• optional MessageBlockText content = 3

  quoted message content (text, style, marks, ...)

Used in: MessageBlock, MessageBlockEditorQuote, MessageBlockMessageQuote

• string text = 1

• Block.Content.Text.Style style = 2

• repeated Block.Content.Text.Mark marks = 3

• bool checked = 4

• string lang = 5

Used in: ChatMessage

• string text = 1

  The text content of the message part

• Block.Content.Text.Style style = 2

  The style/type of the message part

• repeated Block.Content.Text.Mark marks = 3

  List of marks applied to the text

Used in: Event.Chat.UpdateReactions, ChatMessage

• map<string, Reactions.IdentityList> reactions = 1

  Map of emoji to list of user IDs

Used in: Reactions

• repeated string ids = 1

  List of user IDs

Used in: Event.Chat.UpdateState, Rpc.Chat.GetMessages.Response, Rpc.Chat.SubscribeLastMessages.Response, Rpc.Chat.SubscribeToMessagePreviews.Response.ChatPreview

• optional ChatState.UnreadState messages = 1

  unread messages

• optional ChatState.UnreadState mentions = 2

  unread mentions

• string lastStateId = 3

  reflects the state of the chat db at the moment of sending response/event that includes this state

• int64 order = 4

  Order is serial number of this state. Client should apply chat state only if its order is greater than previously saved order

• string unreadReactionOrderId = 5

  order id of the newest message with any unread reactions

Used in: ChatState

• string oldestOrderId = 1

  oldest(in the lex sorting) unread message order id. Client should ALWAYS scroll through unread messages from the oldest to the newest

• int32 counter = 2

  total number of unread messages

Used in: Rpc.Object.ListSetDetails.Request, Rpc.Object.SetDetails.Request

• string key = 1

• optional google.protobuf.Value value = 2

  NUll - removes key

Used in: Change.DeviceAdd, Rpc.Device.List.Response

• string id = 1

• string name = 2

• int64 addDate = 3

• bool archived = 4

• bool isConnected = 5

Used in: Rpc.Device.NetworkState.Set.Request

• WIFI = 0

• CELLULAR = 1

• NOT_CONNECTED = 2

(message has no fields)

Used in: Rpc.Object.Export.Request, Rpc.Object.ListExport.Request, Notification.Export

• Markdown = 0

• Protobuf = 1

• JSON = 2

• DOT = 3

• SVG = 4

• GRAPH_JSON = 5

• AnyBlockV2 = 6

  AnyBlockV2 is the native AnyBlock v2 bundle (pkg/lib/anyblockjson format/v2/SPEC.md): a directory of `<id>.anyblock.json` documents beside an index.json and properties.json. Additive — existing values keep their numbers, so a client that does not know it is unaffected.

Diagnostics shared by all export formats. A completed export can contain issues without failing the RPC; clients should inspect status and issues.

Used in: Rpc.Object.Export.Response, Rpc.Object.ListExport.Response, Notification.Export

• ExportReport.Status status = 1

• int32 succeed = 2

  Objects accounted for, including objects represented in bundle metadata.

• int32 objectErrors = 3

• int32 fileErrors = 4

  File contents that could not be exported; their objects may still succeed.

• repeated ExportReport.Issue issues = 5

Used in: ExportReport

• string objectId = 1

  Empty for an issue affecting the export as a whole.

• Issue.Severity severity = 2

• string code = 3

  Stable diagnostic code, supplied by the exporter when available.

• string path = 4

  Field path for validation issues, or relative path of an export file.

• string message = 5

Used in: Issue

• WARNING = 0

• ERROR = 1

• INFO = 2

  Non-blocking format notes; do not make the export partial.

Used in: ExportReport

• SUCCESS = 0

• PARTIAL = 1

  Output was produced, but errors were reported. Warnings alone remain successful.

• FAILED = 2

• CANCELED = 3

Used in: FileInfo, IdentityProfile, InvitePayload

• string path = 1

• string key = 2

• NotIndexed = 0

• Indexed = 1

• NotFound = 2

Used in: Change.SetFileInfo, SmartBlockSnapshotBase

• string fileId = 1

• repeated FileEncryptionKey encryptionKeys = 2

Used in: IdentityProfileWithKey

• string identity = 1

• string name = 2

• string iconCid = 3

• repeated FileEncryptionKey iconEncryptionKeys = 4

• string description = 5

• string globalName = 6

• optional IdentityProfile identityProfile = 1

• bytes requestMetadata = 2

Used in: Rpc.BlockFile.CreateAndUpload.Request, Rpc.File.Upload.Request, Rpc.Unsplash.Download.Request

• Basic = 0

• Cover = 1

• Icon = 2

• AutomaticallyAdded = 3

(message has no fields)

Used in: Notification.GalleryImport, Notification.Import

• NULL = 0

• UNKNOWN_ERROR = 1

• BAD_INPUT = 2

• INTERNAL_ERROR = 3

• FILE_LOAD_ERROR = 8

• IMPORT_IS_CANCELED = 6

• NOTION_NO_OBJECTS_IN_INTEGRATION = 5

• NOTION_SERVER_IS_UNAVAILABLE = 12

• NOTION_RATE_LIMIT_EXCEEDED = 13

• FILE_IMPORT_NO_OBJECTS_IN_ZIP_ARCHIVE = 14

• FILE_IMPORT_NO_OBJECTS_IN_DIRECTORY = 17

• HTML_WRONG_HTML_STRUCTURE = 10

• PB_NOT_ANYBLOCK_FORMAT = 11

• CSV_LIMIT_OF_ROWS_OR_RELATIONS_EXCEEDED = 7

• INSUFFICIENT_PERMISSIONS = 9

Used in: Event.Import.Finish, Event.Import.Statistic, Rpc.Object.Import.Request, Notification.Import

• Notion = 0

• Markdown = 1

• External = 2

  external developers use it

• Pb = 3

• Html = 4

• Txt = 5

• Csv = 6

• Obsidian = 7

  Markdown with obsidian improvements

Used in: Rpc.BlockLink.CreateWithObject.Request, Rpc.Object.Create.Request, Rpc.Object.CreateObjectType.Request, Rpc.Object.CreateSet.Request, Rpc.Object.SetInternalFlags.Request

• InternalFlag.Value value = 1

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.

Used in: InternalFlag

• editorDeleteEmpty = 0

• editorSelectType = 1

• editorSelectTemplate = 2

• collectionDontIndexLinks = 3

• bytes payload = 1

• bytes signature = 2

• string creatorIdentity = 1

• string creatorName = 2

• string creatorIconCid = 12

• repeated FileEncryptionKey creatorIconEncryptionKeys = 13

• bytes aclKey = 3

• string spaceId = 4

• string spaceName = 5

• string spaceIconCid = 6

• uint32 spaceIconOption = 10

• uint32 spaceUxType = 11

  deprecated

• uint32 spaceType = 14

• repeated FileEncryptionKey spaceIconEncryptionKeys = 7

• InviteType inviteType = 8

• bytes guestKey = 9

Used in: Rpc.Space.InviteGenerate.Request, Rpc.Space.InviteGenerate.Response, Rpc.Space.InviteGetCurrent.Response, Rpc.Space.InviteView.Response, InvitePayload

• Member = 0

  aclKey contains the key to sign the ACL record

• Guest = 1

  guestKey contains the privateKey of the guest user

• WithoutApprove = 2

  aclKey contains the key to sign the ACL record, but no approval needed

• ObjectType.Layout id = 1

• string name = 2

• repeated Relation requiredRelations = 3

  relations required for this object type

Used in: Rpc.LinkPreview.Response

• string url = 1

• string title = 2

• string description = 3

• string imageUrl = 4

• string faviconUrl = 5

• LinkPreview.Type type = 6

Used in: Event.Block.Fill.Bookmark.Type, Event.Block.Set.Bookmark.Type, Block.Content.Bookmark, LinkPreview

• Unknown = 0

• Page = 1

• Image = 2

• Text = 3

Used in: Rpc.Gallery.DownloadIndex.Response, Rpc.Gallery.DownloadManifest.Response

• string schema = 1

• string id = 2

• string name = 3

• string author = 4

• string license = 5

• string title = 6

• string description = 7

• repeated string screenshots = 8

• string downloadLink = 9

• int32 fileSize = 10

• repeated string categories = 11

• string language = 12

Used in: Event.Membership.Update, Rpc.Membership.GetStatus.Response

• uint32 tier = 1

  it was Tier before, changed to int32 to allow dynamic values

• Membership.Status status = 2

• uint64 dateStarted = 3

• uint64 dateEnds = 4

• bool isAutoRenew = 5

• Membership.PaymentMethod paymentMethod = 6

• string nsName = 7

  can be empty if user did not ask for any name

• NameserviceNameType nsNameType = 8

• string userEmail = 9

  if the email was verified by the user or set during the checkout - it will be here

• bool subscribeToNewsletter = 10

Used in: Rpc.Membership.GetVerificationEmailStatus.Response

• StatusNotVerified = 0

  user NEVER comleted the verification of the email

• StatusCodeSent = 1

  user has asked for new code, but did not enter it yet (even if email was verified before, you can ask to UPDATE your e-mail) please wait, you can not ask for more codes yet

• StatusVerified = 2

  the e-mail is finally verified

Used in: Rpc.Membership.RegisterPaymentRequest.Request, Membership

• MethodNone = 0

• MethodStripe = 1

• MethodCrypto = 2

• MethodInappApple = 3

• MethodInappGoogle = 4

Used in: Membership

• StatusUnknown = 0

• StatusPending = 1

  please wait a bit more, we are still processing your request the payment is confirmed, but we need more time to do some side-effects: - increase limits - send emails - allocate names

• StatusActive = 2

  the membership is active, ready to use!

• StatusPendingRequiresFinalization = 3

  in some cases we need to finalize the process: - if user has bought membership directly without first calling the BuySubscription method in this case please call Finalize to finish the process

Used in: Event.Membership.TiersUpdate, Rpc.Membership.GetTiers.Response

• uint32 id = 1

  this is a unique Payment Node ID of the tier WARNING: tiers can be sorted differently, not according to their IDs!

• string name = 2

  localazied name of the tier

• string description = 3

  just a short technical description

• bool isTest = 4

  is this tier for testing and debugging only?

• MembershipTierData.PeriodType periodType = 5

  how long is the period of the subscription

• uint32 periodValue = 6

  i.e. "5 days" or "3 years"

• uint32 priceStripeUsdCents = 7

  this one is a price we use ONLY on Stripe platform

• uint32 anyNamesCountIncluded = 8

  number of ANY NS names that this tier includes also in the "features" list (see below)

• uint32 anyNameMinLength = 9

  somename.any - is of len 8

• repeated string features = 10

  localized strings for the features

• string colorStr = 11

  green, blue, red, purple, custom

• string stripeProductId = 12

  Stripe platform-specific data:

• string stripeManageUrl = 13

• string iosProductId = 15

  iOS platform-specific data:

• string iosManageUrl = 16

• string androidProductId = 17

  Android platform-specific data:

• string androidManageUrl = 18

• string offer = 19

  "limited offer" or somehing like that

Used in: MembershipTierData

• PeriodTypeUnknown = 0

• PeriodTypeUnlimited = 1

• PeriodTypeDays = 2

• PeriodTypeWeeks = 3

• PeriodTypeMonths = 4

• PeriodTypeYears = 5

(message has no fields)

Used in: Cart, CryptoCheckout, Invoice, Product

• string currency = 1

  ISO 4217 currency code

• int64 amountCents = 2

  $0.01 = 1 $1.00 = 100 also supports negative amounts! some invoices can have negatice amount (refund)

Used in: Rpc.MembershipV2.CartGet.Response, Rpc.MembershipV2.CartUpdate.Response

• repeated CartProduct products = 1

  if you add Nx the same product - it will be Nx in the 'products' array, i.e: each product instance has a unique index

• optional Amount total = 2

  total amount of the cart (including discounts, etc)

• optional Amount totalNextInvoice = 3

  in case you are paying in the middle of the period (for existing customers) the next invoice amount will also be generated

• uint64 nextInvoiceDate = 4

• repeated string appliedPromocodes = 5

Used in: Cart

• optional Product product = 1

• bool isYearly = 2

  otherwise - monthly or isLifetime

• bool remove = 3

  set to true if you want to remove this item from the customer it's like setting -1 to some product

• bool isLifetime = 4

  if true - then this is lifetime product (no matter what isYearly above is) unfortunately we do not use Period here to keep compatibility with old versions that still use isYearly!

• string invoiceURL = 1

• optional Amount total = 2

• bool isCanCancel = 3

Used in: Event.MembershipV2.Update, Rpc.MembershipV2.GetStatus.Response

• repeated PurchasedProduct products = 1

• optional Invoice nextInvoice = 2

• string teamOwnerID = 3

• PaymentProvider paymentProvider = 4

• repeated string appliedPromocodes = 5

Used in: Product

• uint64 storageBytes = 1

• uint32 spaceReaders = 2

• uint32 spaceWriters = 3

• uint32 sharedSpaces = 4

• uint32 teamSeats = 5

• uint32 anyNameCount = 6

• uint32 anyNameMinLen = 7

• uint32 privateSpaces = 8

Used in: Event.MembershipV2.ProductsUpdate, Event.MembershipV2.Update, Rpc.MembershipV2.GetProducts.Response, Rpc.MembershipV2.GetStatus.Response

• Freshness freshness = 1

• int64 lastSuccessfulFetchAt = 2

  unix seconds of the last successful fetch, 0 if never or unknown

• RefreshError lastRefreshError = 3

  set while the latest refresh of the resource failed

• optional Revision revision = 4

Freshness of one membership resource (status or products) as served in MembershipV2 GetStatus/GetProducts responses and update events. The zero value is FRESH, so a message that never sets it keeps the pre-freshness meaning.

Used in: FetchState

• FRESH = 0

  data comes from a recent successful fetch from the payment node

• STALE = 1

  data comes from an earlier successful fetch: the latest refresh failed, or the age of the cached data is unknown

• NONE = 2

  never fetched successfully: data is an empty placeholder and must be treated as unknown (not as "no membership")

Used in: Data

• uint64 date = 1

• optional Amount total = 2

Used in: Data

• None = 0

• Stripe = 1

• Crypto = 2

• BillingPortal = 3

• AppStore = 4

• GooglePlay = 5

Used in: PurchaseInfo

• Unlimited = 0

• Monthly = 1

• Yearly = 2

• ThreeYears = 3

• Lifetime = 4

Used in: Rpc.MembershipV2.SubscribeToUpdates.Request

• Unknown = 0

• Desktop = 1

• MobileIOS = 2

• MobileAndroid = 3

• Web = 4

Used in: Event.MembershipV2.ProductsUpdate, Rpc.MembershipV2.GetProducts.Response, CartProduct, PurchasedProduct

• string id = 1

• string name = 2

• string description = 3

• bool isTopLevel = 4

• bool isHidden = 5

• bool isIntro = 6

  isIntro flag can be used as follows: 1. if current user's top level product has isIntro flag -> then you'd rather show a FULL list of all products to enable upgrading from CURRENT product 2. but if current user's top level product has no isIntro flag -> then it means that this plan was aquired and user need to control it. then show "second screen" to control that product instead

• bool isUpgradeable = 7

  isUpgradeable can be used as follows: if current user's top level product has isUpgradeable flag -> show incentives to buy something else

• repeated Amount pricesYearly = 8

• repeated Amount pricesMonthly = 9

• string colorStr = 10

  green, blue, red, purple, custom, etc

• string offer = 11

• optional Features features = 12

• repeated Amount pricesLifetime = 13

Used in: PurchasedProduct

• ProductStatus.Status status = 1

Used in: ProductStatus

• StatusUnknown = 0

• StatusPending = 1

• StatusActive = 2

• StatusPendingRequiresAnyNameAllocation = 3

Used in: PurchasedProduct

• uint64 dateStarted = 1

• uint64 dateEnds = 2

• bool isAutoRenew = 3

• Period period = 4

Used in: Data

• optional Product product = 1

• optional PurchaseInfo purchaseInfo = 2

• optional ProductStatus productStatus = 3

Class of the last failed refresh of a resource

Used in: FetchState

• RefreshErrorNull = 0

• RefreshErrorPaymentNode = 1

  transient: timeout, payment node unreachable, connection closed

• RefreshErrorUnknown = 2

  any other failure

Orders published states of one resource. Apply a response or event only if its revision is newer than the one already applied. epoch is random and changes on every payments service start (account select or restart): reset ordering state when it changes.

Used in: FetchState

• uint64 epoch = 1

• uint64 counter = 2

• oneof payload

  • Metadata.Payload.IdentityPayload identity = 1

(message has no fields)

Used in: Metadata

• bytes profileSymKey = 1

Used in: Rpc.Membership.CodeRedeem.Request, Rpc.Membership.Finalize.Request, Rpc.Membership.IsNameValid.Request, Rpc.Membership.RegisterPaymentRequest.Request, Rpc.MembershipV2.AnyNameAllocate.Request, Rpc.MembershipV2.AnyNameIsValid.Request, Rpc.NameService.ResolveAnyId.Response, Rpc.NameService.ResolveName.Request, Rpc.NameService.ResolveSpaceId.Response, Rpc.NameService.UserAccount.Get.Response, Membership

• AnyName = 0

  .any suffix

Used in: Change.NotificationCreate, Event.Notification.Send, Event.Notification.Update, Rpc.Notification.List.Response, Rpc.Notification.Test.Response

• string id = 1

• int64 createTime = 2

• Notification.Status status = 4

• bool isLocal = 5

• oneof payload

  • Notification.Import import = 6

  • Notification.Export export = 8

  • Notification.GalleryImport galleryImport = 9

  • Notification.RequestToJoin requestToJoin = 10

  • Notification.Test test = 11

  • Notification.ParticipantRequestApproved participantRequestApproved = 13

  • Notification.RequestToLeave requestToLeave = 15

  • Notification.ParticipantRemove participantRemove = 16

  • Notification.ParticipantRequestDecline participantRequestDecline = 17

  • Notification.ParticipantPermissionsChange participantPermissionsChange = 18

• string space = 7

• string aclHeadId = 14

Used in: Rpc.Notification.Reply.Request

• CLOSE = 0

Used in: Notification

• Export.Code errorCode = 2

• Export.Format exportType = 3

• optional ExportReport report = 4

• string path = 5

  Selected destination directory for this local export.

Used in: Export

• NULL = 0

• UNKNOWN_ERROR = 1

• BAD_INPUT = 2

Used in: Notification

• string processId = 1

• Import.ErrorCode errorCode = 2

• string spaceId = 3

• string name = 4

• string spaceName = 5

Used in: Notification

• string processId = 1

• Import.ErrorCode errorCode = 2

• Import.Type importType = 3

• string spaceId = 4

• string name = 5

• string spaceName = 6

• string reportObjectId = 7

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

• int64 issuesCount = 8

  number of issues recorded during the run, for "imported with N issues" UI (importv2)

Used in: Notification

• string spaceId = 1

• ParticipantPermissions permissions = 2

• string spaceName = 3

Used in: Notification

• string identity = 1

• string identityName = 2

• string identityIcon = 3

• string spaceId = 4

• string spaceName = 5

Used in: Notification

• string spaceId = 1

• ParticipantPermissions permissions = 2

• string spaceName = 5

Used in: Notification

• string spaceId = 1

• string spaceName = 3

Used in: Notification

• string spaceId = 1

• string identity = 2

• string identityName = 3

• string identityIcon = 4

• string spaceName = 5

Used in: Notification

• string spaceId = 1

• string identity = 2

• string identityName = 3

• string identityIcon = 4

• string spaceName = 5

Used in: Change.NotificationUpdate, Notification

• Created = 0

• Shown = 1

• Read = 2

• Replied = 3

Used in: Notification

(message has no fields)

(message has no fields)

• SmartBlockType smartBlockType = 1

• string key = 2

• bytes data = 3

• optional google.protobuf.Struct details = 1

Used in: Rpc.Navigation.ListObjects.Response, ObjectInfoWithLinks, ObjectInfoWithOutboundLinks, ObjectInfoWithOutboundLinksIDs, ObjectLinksInfo

• string id = 1

• repeated string objectTypeUrls = 2

  DEPRECATED

• optional google.protobuf.Struct details = 3

• repeated Relation relations = 4

  DEPRECATED

• string snippet = 5

• bool hasInboundLinks = 6

  DEPRECATED

Used in: Rpc.Navigation.GetObjectInfoWithLinks.Response

• string id = 1

• optional ObjectInfo info = 2

• optional ObjectLinksInfo links = 3

• string id = 1

• optional ObjectInfo info = 2

• repeated ObjectInfo outboundLinks = 3

• string id = 1

• optional ObjectInfo info = 2

• repeated string outboundLinks = 3

• repeated string inboundIDs = 1

• repeated string outboundIDs = 2

Used in: ObjectInfoWithLinks

• repeated ObjectInfo inbound = 1

• repeated ObjectInfo outbound = 2

Used in: Rpc.File.Upload.Request

• none = 0

• clipboard = 1

• dragAndDrop = 2

• import = 3

• webclipper = 4

• sharingExtension = 5

• usecase = 6

• builtin = 7

• bookmark = 8

• api = 9

• string bundledObjectTypes = 1

• string bundledRelations = 2

• string bundledLayouts = 3

• int32 objectsForceReindexCounter = 4

  increased in order to trigger all objects reindex

• int32 filesForceReindexCounter = 5

  increased in order to fully reindex all objects

• int32 idxRebuildCounter = 6

  increased in order to remove indexes and reindex everything. Automatically triggers objects and files reindex(one time only)

• int32 fulltextRebuild = 7

  DEPRECATED increased in order to perform fulltext indexing for all type of objects (useful when we change fulltext config)

• int32 fulltextErase = 11

  DEPRECATED remove all the fulltext indexes and add to reindex queue after

• string bundledTemplates = 8

• int32 bundledObjects = 9

  anytypeProfile and maybe some others in the feature

• int32 filestoreKeysForceReindexCounter = 10

• bool areOldFilesRemoved = 12

• bool areDeletedObjectsReindexed = 13

  DEPRECATED

• int32 linksErase = 14

• int32 marketplaceForceReindexCounter = 15

• int32 reindexDeletedObjects = 16

• int32 reindexParticipants = 17

• int32 reindexChats = 18

• int32 reindexFulltextChatMessages = 19

• int32 invalidateObjectsIndex = 20

• int32 reindexDiscussions = 21

• string url = 1

  leave empty in case you want to create the new one

• string name = 2

  name of objectType in singular form (can be localized for bundled types)

• repeated RelationLink relationLinks = 3

  cannot contain more than one Relation with the same RelationType

• ObjectType.Layout layout = 4

• string iconEmoji = 5

  emoji symbol

• string description = 6

• bool hidden = 7

• bool readonly = 10

• repeated SmartBlockType types = 8

• bool isArchived = 9

  sets locally to hide object type from set and some other places

• bool installedByDefault = 11

• string key = 12

  name of objectType (can be localized for bundled types)

• int64 revision = 13

  revision of system objectType. Used to check if we should change type content or not

• bool restrictObjectCreation = 14

  restricts creating objects of this type for users

• int64 iconColor = 15

  color of object type icon

• string iconName = 16

  name of object type icon

• string pluralName = 17

  name of objectType in plural form (can be localized for bundled types)

Used in: Rpc.Object.ListExport.RelationsWhiteList, Rpc.Object.SetLayout.Request, Layout, ObjectType

• 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

• audio = 15

• video = 16

• date = 17

• spaceView = 18

• participant = 19

• pdf = 20

• chatDeprecated = 21

  deprecated

• chatDerived = 22

• tag = 23

• notification = 24

• missingObject = 25

• devices = 26

• discussion = 27

Works with a smart blocks: Page, Dashboard Dashboard opened, click on a page, Rpc.Block.open, Block.ShowFullscreen(PageBlock)

Used in: Rpc.History.DiffVersions.Response, Rpc.History.ShowVersion.Response, Rpc.Object.Open.Response, Rpc.Object.OpenBreadcrumbs.Response, Rpc.Object.Show.Response

• string rootId = 1

  Root block id

• repeated Block blocks = 2

  dependent simple blocks (descendants)

• repeated ObjectView.DetailsSet details = 3

  details for the current and dependent objects

• SmartBlockType type = 4

• repeated Relation relations = 7

  DEPRECATED, use relationLinks instead

• repeated RelationLink relationLinks = 10

• optional Restrictions restrictions = 8

  object restrictions

• optional ObjectView.HistorySize history = 9

• repeated ObjectView.BlockParticipant blockParticipants = 11

Used in: ObjectView

• string blockId = 1

• string participantId = 2

Used in: ObjectView

• string id = 1

  context objectId

• optional google.protobuf.Struct details = 2

  can not be a partial state. Should replace client details state

• repeated string subIds = 3

Used in: ObjectView

• int32 undo = 1

• int32 redo = 2

• string objectId = 1

• repeated RelationWithValue relations = 2

Used in: Rpc.Space.ParticipantPermissionsChange.Request

• string identity = 1

• ParticipantPermissions perms = 2

Used in: Rpc.Space.ChangeOwnership.Request, Rpc.Space.InviteChange.Request, Rpc.Space.InviteGenerate.Request, Rpc.Space.InviteGenerate.Response, Rpc.Space.InviteGetCurrent.Response, Rpc.Space.ParticipantsAddList.Request, Rpc.Space.RequestApprove.Request, Notification.ParticipantPermissionsChange, Notification.ParticipantRequestApproved, ParticipantPermissionChange

• Reader = 0

• Writer = 1

• Owner = 2

• NoPermissions = 3

• Admin = 4

• Joining = 0

• Active = 1

• Removed = 2

• Declined = 3

• Removing = 4

• Canceled = 5

Used in: Rpc.Template.GetPlaceholders.Response, Rpc.Template.SetPlaceholders.Request

• string relationKey = 1

• repeated Placeholder.Value values = 2

Used in: Value

• PlaceholderValue = 0

• PlaceholderToday = 1

• PlaceholderCurrentUser = 2

Used in: Placeholder

• Type type = 1

• optional google.protobuf.Value value = 2

General purpose structure, uses in Mark.

Used in: Event.User.Block.TextRange, Rpc.Block.Copy.Request, Rpc.Block.Cut.Request, Rpc.Block.Paste.Request, Rpc.Block.SetCarriage.Request, Rpc.Block.Split.Request, Rpc.BlockText.SetMarks.Get.Request, Rpc.BlockText.SetText.Request, Rpc.Object.Redo.Response, Rpc.Object.Undo.Response, Block.Content.Text.Mark, Search.Message.Result, Search.Meta

• int32 from = 1

• int32 to = 2

Relation describe the human-interpreted relation type. It may be something like "Date of creation, format=date" or "Assignee, format=objectId, objectType=person"

Used in: Event.Block.Dataview.OldRelationSet, Rpc.ObjectRelation.ListAvailable.Response, Block.Content.Dataview, Layout, ObjectInfo, ObjectView, RelationWithValue, Relations, SmartBlockSnapshotBase

• string id = 100

• string key = 1

  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.

• RelationFormat format = 2

  format of the underlying data

• string name = 3

  name to show (can be localized for bundled types)

• optional google.protobuf.Value defaultValue = 4

• Relation.DataSource dataSource = 5

  where the data is stored

• bool hidden = 6

  internal, not displayed to user (e.g. coverX, coverY)

• bool readOnly = 7

  value not editable by user tobe renamed to readonlyValue

• bool readOnlyRelation = 15

  relation metadata, eg name and format is not editable by user

• bool multi = 8

  allow multiple values (stored in pb list)

• repeated string objectTypes = 9

  URL of object type, empty to allow link to any object

• repeated Relation.Option selectDict = 12

  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

• int32 maxCount = 13

  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

• string description = 14

• Relation.Scope scope = 20

  on-store fields, injected only locally

  deprecated, to be removed

• string creator = 21

  creator profile id

• int64 revision = 22

  revision of system relation. Used to check if we should change relation content or not

• bool includeTime = 23

  indicates whether value of relation with date format should be processed with seconds precision

Used in: Relation

• 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

Used in: Relation, RelationOptions

• string id = 1

  id generated automatically if omitted

• string text = 2

• string color = 3

  stored

• string relationKey = 5

  4 is reserved for old relation format

  stored

• string orderId = 6

  lexicographic id of relation option for ordering

Used in: Relation

• 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 describes how the underlying data is stored in the google.protobuf.Value and how it should be validated/sanitized

Used in: Rpc.ObjectType.Property.Add.Request, Block.Content.Dataview.Filter, Block.Content.Dataview.Sort, Relation, RelationLink

• longtext = 0

  string

• shorttext = 1

  string, usually short enough. May be truncated in the future

• number = 2

  double

• status = 3

  string or list of string(len==1)

• tag = 11

  list of string (choose multiple from a list)

• date = 4

  float64(pb.Value doesn't have int64) or the string

• file = 5

  relation can has objects of specific types: file, image, audio, video

• checkbox = 6

  boolean

• url = 7

  string with sanity check

• email = 8

  string with sanity check

• phone = 9

  string with sanity check

• emoji = 10

  one emoji, can contains multiple utf-8 symbols

• object = 100

  relation can has objectType to specify objectType

• relations = 101

  base64-encoded relation pb model

• map = 102

  relation that handle map of values

Used in: Change.RelationAdd, Event.Block.Dataview.RelationSet, Event.Object.Relations.Amend, Block.Content.Dataview, ObjectType, ObjectView, SmartBlockSnapshotBase

• string key = 1

• RelationFormat format = 2

Used in: Rpc.Relation.Options.Response

• repeated Relation.Option options = 1

Used in: ObjectView.RelationWithValuePerObject

• optional Relation relation = 1

• optional google.protobuf.Value value = 2

• repeated Relation relations = 1

Used in: Event.Object.Restrictions.Set, ObjectView

• repeated Restrictions.ObjectRestriction object = 1

• repeated Restrictions.DataviewRestrictions dataview = 2

Used in: DataviewRestrictions

• DVNone = 0

• DVRelation = 1

• DVCreateObject = 2

• DVViews = 3

Used in: Restrictions

• string blockId = 1

• repeated DataviewRestriction restrictions = 2

Used in: Restrictions

• 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

• CreateObjectOfThisType = 9

  can be set only for types. Restricts creating objects of this type

• Publish = 10

  object is not allowed to publish

(message has no fields)

(message has no fields)

Used in: Rpc.Chat.Search.Response

• string chatId = 1

• string messageId = 2

• int64 score = 3

• string highlight = 4

  truncated text with highlights

• repeated Range highlightRanges = 5

  ranges of the highlight in the text (using utf-16 runes)

• optional ChatMessage message = 6

• string spaceId = 7

  space the chat belongs to; set in all search scopes

Used in: Rpc.Chat.Search.Request

• Sort.Key key = 1

• Sort.Type type = 2

Used in: Sort

• ORDER_ID = 0

• SCORE = 1

• CREATED_AT = 2

• MODIFIED_AT = 3

Used in: Sort

• Asc = 0

• Desc = 1

Used in: Result

• string highlight = 1

  truncated text with highlights

• repeated Range highlightRanges = 2

  ranges of the highlight in the text (using utf-16 runes)

• string blockId = 3

  block id where the highlight has been found

• string relationKey = 4

  relation key of the block where the highlight has been found

• optional google.protobuf.Struct relationDetails = 5

  contains details for dependent object. E.g. relation option or type. todo: rename to dependantDetails

Used in: Rpc.Object.SearchWithMeta.Response

• string objectId = 1

• optional google.protobuf.Struct details = 2

• repeated Meta meta = 3

  meta information about the search result

Used in: Change.Snapshot, Rpc.Object.Import.Request.Snapshot

• repeated Block blocks = 1

• optional google.protobuf.Struct details = 2

• optional google.protobuf.Struct fileKeys = 3

• repeated Relation extraRelations = 4

• repeated string objectTypes = 5

• optional google.protobuf.Struct collections = 6

• repeated string removedCollectionKeys = 8

• repeated RelationLink relationLinks = 7

• string key = 9

  only used for pb backup purposes, ignored in other cases

• int64 originalCreatedTimestamp = 10

  ignored in import/export in favor of createdDate relation. Used to store original user-side object creation timestamp

• optional FileInfo fileInfo = 11

Used in: SnapshotWithType, Object.ChangePayload, ObjectType, ObjectView

• 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

  DEPRECATED

• AnytypeProfile = 515

• Date = 516

• Workspace = 518

• STRelation = 521

• STType = 528

• STRelationOption = 529

• SpaceView = 530

• Identity = 532

• Participant = 534

• MissingObject = 519

• FileObject = 533

• NotificationObject = 535

• DevicesObject = 536

• ChatObjectDeprecated = 537

  DEPRECATED Container for any-store based chats

• ChatDerivedObject = 544

  Any-store based object for chat

• AccountObject = 545

  Container for account data in tech space

• DiscussionObject = 546

  Any-store based object for discussion

• TechSpaceObject = 547

  Any-store based object in tech space for cross-device sync

• TechSpaceVirtualObject = 548

  Per-space virtual object backed by a tech space CRDT document

• Private = 0

• Personal = 1

• Shared = 2

• string spaceID = 1

• StatusUnknown = 0

• StatusShareable = 1

• StatusNotShareable = 2

• Unknown = 0

  Unknown means the space is not loaded yet

• Loading = 1

  Loading - the space in progress of loading

• Ok = 2

  Ok - the space loaded and available

• Missing = 3

  Missing - the space is missing

• Error = 4

  Error - the space loading ended with an error

• RemoteWaitingDeletion = 5

  RemoteWaitingDeletion - network status is "waiting deletion"

• RemoteDeleted = 6

  RemoteDeleted - the space is deleted in the current network

• SpaceDeleted = 7

  SpaceDeleted - the space should be deleted in the network

• SpaceActive = 8

  SpaceActive - the space is active in the network

• SpaceJoining = 9

  SpaceJoining - the account is joining the space

• SpaceRemoving = 10

  SpaceRemoving - the account is removing from space or the space is removed from network

Used in: Rpc.Space.InviteView.Response

• SpaceTypeUnknown = 0

• SpaceTypeRegular = 1

• SpaceTypeTech = 2

• SpaceTypeChat = 3

• SpaceTypeOneToOne = 4

• None = 0

  old value for chat, deprecated

• Data = 1

  objects-first UX

• Stream = 2

  stream UX (chat with limited amount of owners)

• Chat = 3

  chat UX, deprecated

• OneToOne = 4

  onetoone UX (space with chat and immutable ACL between two participants)

• SyncErrorNull = 0

• SyncErrorIncompatibleVersion = 2

• SyncErrorNetworkError = 3

• SyncErrorOversized = 4

• SyncStatusSynced = 0

• SyncStatusSyncing = 1

• SyncStatusError = 2

• SyncStatusQueued = 3

• Empty = 0

• FromTemplateName = 1