proto/subscription.proto at master · planarly/proto · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
syntax = "proto3";

import "query.proto";

package PlanProto;

// messages relating to channels and subscriptions


enum NodeView {
  NONE = 0;
  EDITOR = 1;
  PAGE = 2;
}


message Subscribe {
  string user = 1;

  // content of the SubscriptionSnapshot message
  // if all false, no SubscriptionSnapshot is sent
  bool snapshot_docwide = 10;
  bool snapshot_tree = 11;
  bool snapshot_node = 12;

  // subscribe to the entire base document.
  // This implies tree and docwide.
  // This options is mainly used for unit tests.
  bool full_base_doc = 2;

  // currently this includes DocOption only
  bool docwide = 8;

  // subscribe to the tree structure messages
  bool tree = 3;

  // subscribe to updates for a single node
  NodeView node_view = 4;
  // if not supplied, subscribe to the default node, i.e. first child of `Root`
  string node_id = 5;
}


message SubscriptionSnapshot
{
  ResDocwide docwide = 1;
  ResTree tree = 2;
  ResNode node = 3;
}


message KeepAlive {
  int32 dummy = 1;
}


message AddChannel {
  int32 dummy = 1;
}


message CloseChannel {
  int32 dummy = 1;
}


message UnloadDoc {
  int32 dummy = 1;
}