package yorkie.v1

Get desktop application:
View/edit binary Protocol Buffers messages

Yorkie is a service that provides an API for SDKs.

• rpc ActivateClient (ActivateClientRequest, ActivateClientResponse)

  yorkie.proto:29

  message ActivateClientRequest

  yorkie.proto:42

  • string client_key = 1

  • map<string, string> metadata = 2

  message ActivateClientResponse

  yorkie.proto:47

  • string client_id = 1

• rpc DeactivateClient (DeactivateClientRequest, DeactivateClientResponse)

  yorkie.proto:30

  message DeactivateClientRequest

  yorkie.proto:51

  • string client_id = 1

  message DeactivateClientResponse

  yorkie.proto:55

  (message has no fields)

• rpc AttachDocument (AttachDocumentRequest, AttachDocumentResponse)

  yorkie.proto:32

  message AttachDocumentRequest

  yorkie.proto:58

  • string client_id = 1

  • optional ChangePack change_pack = 2

  message AttachDocumentResponse

  yorkie.proto:63

  • string document_id = 1

  • optional ChangePack change_pack = 2

• rpc DetachDocument (DetachDocumentRequest, DetachDocumentResponse)

  yorkie.proto:33

  message DetachDocumentRequest

  yorkie.proto:68

  • string client_id = 1

  • string document_id = 2

  • optional ChangePack change_pack = 3

  • bool remove_if_not_attached = 4

  message DetachDocumentResponse

  yorkie.proto:75

  • optional ChangePack change_pack = 2

• rpc RemoveDocument (RemoveDocumentRequest, RemoveDocumentResponse)

  yorkie.proto:34

  message RemoveDocumentRequest

  yorkie.proto:95

  • string client_id = 1

  • string document_id = 2

  • optional ChangePack change_pack = 3

  message RemoveDocumentResponse

  yorkie.proto:101

  • optional ChangePack change_pack = 1

• rpc PushPullChanges (PushPullChangesRequest, PushPullChangesResponse)

  yorkie.proto:35

  message PushPullChangesRequest

  yorkie.proto:105

  • string client_id = 1

  • string document_id = 2

  • optional ChangePack change_pack = 3

  • bool push_only = 4

  message PushPullChangesResponse

  yorkie.proto:112

  • optional ChangePack change_pack = 1

• rpc WatchDocument (WatchDocumentRequest, stream WatchDocumentResponse)

  yorkie.proto:37

  message WatchDocumentRequest

  yorkie.proto:79

  • string client_id = 1

  • string document_id = 2

  message WatchDocumentResponse

  yorkie.proto:84

  • oneof body

    • WatchDocumentResponse.Initialization initialization = 1

    • DocEvent event = 2

• rpc Broadcast (BroadcastRequest, BroadcastResponse)

  yorkie.proto:39

  message BroadcastRequest

  yorkie.proto:116

  • string client_id = 1

  • string document_id = 2

  • string topic = 3

  • bytes payload = 4

  message BroadcastResponse

  yorkie.proto:123

  (message has no fields)

Used in: ChangePack

• optional ChangeID id = 1

• string message = 2

• repeated Operation operations = 3

• optional PresenceChange presence_change = 4

Used in: Change

• uint32 client_seq = 1

• int64 server_seq = 2

• int64 lamport = 3

• bytes actor_id = 4

• optional VersionVector version_vector = 5

ChangePack is a message that contains all changes that occurred in a document. It is used to synchronize changes between clients and servers.

Used in: AttachDocumentRequest, AttachDocumentResponse, DetachDocumentRequest, DetachDocumentResponse, PushPullChangesRequest, PushPullChangesResponse, RemoveDocumentRequest, RemoveDocumentResponse

• string document_key = 1

• optional Checkpoint checkpoint = 2

• bytes snapshot = 3

• repeated Change changes = 4

• optional TimeTicket min_synced_ticket = 5

  deprecated

• bool is_removed = 6

• optional VersionVector version_vector = 7

Used in: ChangePack

• int64 server_seq = 1

• uint32 client_seq = 2

Used in: WatchDocumentResponse

• DocEventType type = 1

• string publisher = 2

• optional DocEventBody body = 3

Used in: DocEvent

• string topic = 1

• bytes payload = 2

Used in: DocEvent

• DOC_EVENT_TYPE_DOCUMENT_CHANGED = 0

• DOC_EVENT_TYPE_DOCUMENT_WATCHED = 1

• DOC_EVENT_TYPE_DOCUMENT_UNWATCHED = 2

• DOC_EVENT_TYPE_DOCUMENT_BROADCAST = 3

• string id = 1

• string key = 2

• string snapshot = 3

• optional google.protobuf.Timestamp created_at = 4

• optional google.protobuf.Timestamp accessed_at = 5

• optional google.protobuf.Timestamp updated_at = 6

Used in: RGANode, RHTNode, Snapshot

• oneof body

  • JSONElement.JSONObject json_object = 1

  • JSONElement.JSONArray json_array = 2

  • JSONElement.Primitive primitive = 3

  • JSONElement.Text text = 5

  • JSONElement.Counter counter = 6

  • JSONElement.Tree tree = 7

Used in: JSONElement

• ValueType type = 1

• bytes value = 2

• optional TimeTicket created_at = 3

• optional TimeTicket moved_at = 4

• optional TimeTicket removed_at = 5

Used in: JSONElement

• repeated RGANode nodes = 1

• optional TimeTicket created_at = 2

• optional TimeTicket moved_at = 3

• optional TimeTicket removed_at = 4

Used in: JSONElement

• repeated RHTNode nodes = 1

• optional TimeTicket created_at = 2

• optional TimeTicket moved_at = 3

• optional TimeTicket removed_at = 4

Used in: JSONElement

• ValueType type = 1

• bytes value = 2

• optional TimeTicket created_at = 3

• optional TimeTicket moved_at = 4

• optional TimeTicket removed_at = 5

Used in: JSONElement

• repeated TextNode nodes = 1

• optional TimeTicket created_at = 2

• optional TimeTicket moved_at = 3

• optional TimeTicket removed_at = 4

Used in: JSONElement

• repeated TreeNode nodes = 1

• optional TimeTicket created_at = 2

• optional TimeTicket moved_at = 3

• optional TimeTicket removed_at = 4

Used in: Operation.Add, Operation.ArraySet, Operation.Increase, Operation.Set

• optional TimeTicket created_at = 1

• optional TimeTicket moved_at = 2

• optional TimeTicket removed_at = 3

• ValueType type = 4

• bytes value = 5

Used in: TextNode, TreeNode

• string value = 1

• optional TimeTicket updated_at = 2

• bool is_removed = 3

Used in: Change

• oneof body

  • Operation.Set set = 1

  • Operation.Add add = 2

  • Operation.Move move = 3

  • Operation.Remove remove = 4

  • Operation.Edit edit = 5

  • Operation.Select select = 6

  • Operation.Style style = 7

  • Operation.Increase increase = 8

  • Operation.TreeEdit tree_edit = 9

  • Operation.TreeStyle tree_style = 10

  • Operation.ArraySet array_set = 11

Used in: Operation

• optional TimeTicket parent_created_at = 1

• optional TimeTicket prev_created_at = 2

• optional JSONElementSimple value = 3

• optional TimeTicket executed_at = 4

Used in: Operation

• optional TimeTicket parent_created_at = 1

• optional TimeTicket created_at = 2

• optional JSONElementSimple value = 3

• optional TimeTicket executed_at = 4

Used in: Operation

• optional TimeTicket parent_created_at = 1

• optional TextNodePos from = 2

• optional TextNodePos to = 3

• map<string, TimeTicket> created_at_map_by_actor = 4

  deprecated

• string content = 5

• optional TimeTicket executed_at = 6

• map<string, string> attributes = 7

Used in: Operation

• optional TimeTicket parent_created_at = 1

• optional JSONElementSimple value = 2

• optional TimeTicket executed_at = 3

Used in: Operation

• optional TimeTicket parent_created_at = 1

• optional TimeTicket prev_created_at = 2

• optional TimeTicket created_at = 3

• optional TimeTicket executed_at = 4

Used in: Operation

• optional TimeTicket parent_created_at = 1

• optional TimeTicket created_at = 2

• optional TimeTicket executed_at = 3

NOTE(hackerwins): Select Operation is not used in the current version. In the previous version, it was used to represent selection of Text. However, it has been replaced by Presence now. It is retained for backward compatibility purposes.

Used in: Operation

• optional TimeTicket parent_created_at = 1

• optional TextNodePos from = 2

• optional TextNodePos to = 3

• optional TimeTicket executed_at = 4

Used in: Operation

• optional TimeTicket parent_created_at = 1

• string key = 2

• optional JSONElementSimple value = 3

• optional TimeTicket executed_at = 4

Used in: Operation

• optional TimeTicket parent_created_at = 1

• optional TextNodePos from = 2

• optional TextNodePos to = 3

• map<string, string> attributes = 4

• optional TimeTicket executed_at = 5

• map<string, TimeTicket> created_at_map_by_actor = 6

  deprecated

Used in: Operation

• optional TimeTicket parent_created_at = 1

• optional TreePos from = 2

• optional TreePos to = 3

• map<string, TimeTicket> created_at_map_by_actor = 4

  deprecated

• repeated TreeNodes contents = 5

• int32 split_level = 7

• optional TimeTicket executed_at = 6

Used in: Operation

• optional TimeTicket parent_created_at = 1

• optional TreePos from = 2

• optional TreePos to = 3

• map<string, string> attributes = 4

• optional TimeTicket executed_at = 5

• repeated string attributes_to_remove = 6

• map<string, TimeTicket> created_at_map_by_actor = 7

  deprecated

Used in: PresenceChange, Snapshot

• map<string, string> data = 1

Used in: Change

• PresenceChange.ChangeType type = 1

• optional Presence presence = 2

Used in: PresenceChange

• CHANGE_TYPE_UNSPECIFIED = 0

• CHANGE_TYPE_PUT = 1

• CHANGE_TYPE_DELETE = 2

• CHANGE_TYPE_CLEAR = 3

• string id = 1

• string name = 2

• string public_key = 3

• string secret_key = 4

• string auth_webhook_url = 5

• repeated string auth_webhook_methods = 6

• string client_deactivate_threshold = 7

• optional google.protobuf.Timestamp created_at = 8

• optional google.protobuf.Timestamp updated_at = 9

Used in: JSONElement.JSONArray

• optional RGANode next = 1

• optional JSONElement element = 2

Used in: JSONElement.JSONObject

• string key = 1

• optional JSONElement element = 2

/////////////////////////////////////// Messages for Snapshot // ///////////////////////////////////////

• optional JSONElement root = 1

• map<string, Presence> presences = 2

Used in: JSONElement.Text

• optional TextNodeID id = 1

• string value = 2

• optional TimeTicket removed_at = 3

• optional TextNodeID ins_prev_id = 4

• map<string, NodeAttr> attributes = 5

Used in: TextNode

• optional TimeTicket created_at = 1

• int32 offset = 2

Used in: Operation.Edit, Operation.Select, Operation.Style

• optional TimeTicket created_at = 1

• int32 offset = 2

• int32 relative_offset = 3

Used in: ChangePack, JSONElement.Counter, JSONElement.JSONArray, JSONElement.JSONObject, JSONElement.Primitive, JSONElement.Text, JSONElement.Tree, JSONElementSimple, NodeAttr, Operation.Add, Operation.ArraySet, Operation.Edit, Operation.Increase, Operation.Move, Operation.Remove, Operation.Select, Operation.Set, Operation.Style, Operation.TreeEdit, Operation.TreeStyle, TextNode, TextNodeID, TextNodePos, TreeNode, TreeNodeID

• int64 lamport = 1

• uint32 delimiter = 2

• bytes actor_id = 3

Used in: JSONElement.Tree, TreeNodes

• optional TreeNodeID id = 1

• string type = 2

• string value = 3

• optional TimeTicket removed_at = 4

• optional TreeNodeID ins_prev_id = 5

• optional TreeNodeID ins_next_id = 6

• int32 depth = 7

• map<string, NodeAttr> attributes = 8

Used in: TreeNode, TreePos

• optional TimeTicket created_at = 1

• int32 offset = 2

Used in: Operation.TreeEdit

• repeated TreeNode content = 1

Used in: Operation.TreeEdit, Operation.TreeStyle

• optional TreeNodeID parent_id = 1

• optional TreeNodeID left_sibling_id = 2

• optional google.protobuf.StringValue name = 1

• optional google.protobuf.StringValue auth_webhook_url = 2

• optional UpdatableProjectFields.AuthWebhookMethods auth_webhook_methods = 3

• optional google.protobuf.StringValue client_deactivate_threshold = 4

Used in: UpdatableProjectFields

• repeated string methods = 1

• string id = 1

• string username = 2

• optional google.protobuf.Timestamp created_at = 3

Used in: JSONElement.Counter, JSONElement.Primitive, JSONElementSimple

• VALUE_TYPE_NULL = 0

• VALUE_TYPE_BOOLEAN = 1

• VALUE_TYPE_INTEGER = 2

• VALUE_TYPE_LONG = 3

• VALUE_TYPE_DOUBLE = 4

• VALUE_TYPE_STRING = 5

• VALUE_TYPE_BYTES = 6

• VALUE_TYPE_DATE = 7

• VALUE_TYPE_JSON_OBJECT = 8

• VALUE_TYPE_JSON_ARRAY = 9

• VALUE_TYPE_TEXT = 10

• VALUE_TYPE_INTEGER_CNT = 11

• VALUE_TYPE_LONG_CNT = 12

• VALUE_TYPE_TREE = 13

Used in: ChangeID, ChangePack

• map<string, int64> vector = 1

Used in: WatchDocumentResponse

• repeated string client_ids = 1