package ricochet

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc AcceptInboundRequest (ContactRequest, Contact)

  core.proto:43

• rpc AddContactRequest (ContactRequest, Contact)

  core.proto:40

• rpc DeleteContact (DeleteContactRequest, DeleteContactReply)

  core.proto:42

  message DeleteContactRequest

  contact.proto:60

  • string address = 1

  message DeleteContactReply

  contact.proto:64

  (message has no fields)

• rpc GetIdentity (IdentityRequest, Identity)

  core.proto:32

  message IdentityRequest

  identity.proto:8

  (message has no fields)

• rpc GetServerStatus (ServerStatusRequest, ServerStatusReply)

  core.proto:11

  Query RPC server version and status

  message ServerStatusRequest

  core.proto:55

  • int32 rpcVersion = 1

  message ServerStatusReply

  core.proto:59

  • int32 rpcVersion = 1

  • string serverVersion = 2

• rpc MarkConversationRead (MarkConversationReadRequest, Reply)

  core.proto:49

  message MarkConversationReadRequest

  conversation.proto:51

  • optional Entity entity = 1

  • uint64 lastRecvIdentifier = 2

  message Reply

  core.proto:52

  (message has no fields)

• rpc MonitorContacts (MonitorContactsRequest, stream ContactEvent)

  core.proto:39

  Query contacts and monitor for contact changes. The full contact list is sent in POPULATE events, terminated by a POPULATE event with no subject. Any new, removed, or modified contacts, including changes in the state of contacts, are sent as ADD, UPDATE, or DELETE events until the stream is closed.

  message MonitorContactsRequest

  contact.proto:38

  (message has no fields)

  message ContactEvent

  contact.proto:41

  • ContactEvent.Type type = 1

  • oneof subject

    • Contact contact = 2

    • ContactRequest request = 3

• rpc MonitorConversations (MonitorConversationsRequest, stream ConversationEvent)

  core.proto:47

  Open a stream to monitor messages in conversations with contacts.

  message MonitorConversationsRequest

  conversation.proto:17

  (message has no fields)

  message ConversationEvent

  conversation.proto:4

  • ConversationEvent.Type type = 1

  • optional Message msg = 2

• rpc MonitorNetwork (MonitorNetworkRequest, stream NetworkStatus)

  core.proto:16

  Open a stream to monitor changes to network status. The current NetworkStatus will be sent immediately, and the stream will receive a new NetworkStatus after any changes until the stream is closed.

  message MonitorNetworkRequest

  network.proto:4

  (message has no fields)

• rpc RejectInboundRequest (ContactRequest, RejectInboundRequestReply)

  core.proto:44

  message RejectInboundRequestReply

  contact.proto:67

  (message has no fields)

• rpc SendMessage (Message, Message)

  core.proto:48

• rpc StartNetwork (StartNetworkRequest, NetworkStatus)

  core.proto:23

  Start connecting to the network. Before StartNetwork is called (by any client), the backend will not make any connections or appear online. This call blocks until the first connection attempt succeeds or fails, and returns the current network status, but connection attempts will continue unless this call returns an RPC error, or until StopNetwork is called.

  message StartNetworkRequest

  network.proto:50

  (message has no fields)

• rpc StopNetwork (StopNetworkRequest, NetworkStatus)

  core.proto:26

  Stop all network connections and go offline. Blocks until the network has been taken offline, and returns the new network status.

  message StopNetworkRequest

  network.proto:53

  (message has no fields)

• rpc UpdateContact (Contact, Contact)

  core.proto:41

(message has no fields)

• optional Identity identity = 1

• map<string, Contact> contacts = 2

• optional Secrets secrets = 3

Used as request type in: RicochetCore.UpdateContact

Used as response type in: RicochetCore.AcceptInboundRequest, RicochetCore.AddContactRequest, RicochetCore.UpdateContact

Used as field type in: Config, ContactEvent

• string address = 2

• string nickname = 3

• string whenCreated = 4

• string lastConnected = 5

• optional ContactRequest request = 6

• Contact.Status status = 10

Used in: Contact

• UNKNOWN = 0

• OFFLINE = 1

• ONLINE = 2

• REQUEST = 3

• REJECTED = 4

Used in: ContactEvent

• NULL = 0

• POPULATE = 1

• ADD = 2

• UPDATE = 3

• DELETE = 4

Used as request type in: RicochetCore.AcceptInboundRequest, RicochetCore.AddContactRequest, RicochetCore.RejectInboundRequest

Used as field type in: Contact, ContactEvent

• ContactRequest.Direction direction = 1

• string address = 2

• string nickname = 3

• string text = 4

• string fromNickname = 5

• string whenCreated = 6

• bool rejected = 7

• string whenDelivered = 8

• string whenRejected = 9

• string remoteError = 10

Used in: ContactRequest

• INBOUND = 0

• OUTBOUND = 1

Used in: ConversationEvent

• NULL = 0

• POPULATE = 1

• RECEIVE = 2

• SEND = 3

• UPDATE = 4

Used in: MarkConversationReadRequest, Message

• string address = 2

  address MAY be unspecified for self

• bool isSelf = 3

Used as response type in: RicochetCore.GetIdentity

Used as field type in: Config

• string address = 1

Used as request type in: RicochetCore.SendMessage

Used as response type in: RicochetCore.SendMessage

Used as field type in: ConversationEvent

• optional Entity sender = 1

• optional Entity recipient = 2

• int64 timestamp = 3

• uint64 identifier = 4

  Identifiers are unique for the tuple of (sender, recipient, direction) within a single session, and should be randomized between sessions to reduce the chance of collision.

• Message.Status status = 5

• string text = 6

Used in: Message

• NULL = 0

• ERROR = 1

• QUEUED = 2

  Outbound

• SENDING = 3

• DELIVERED = 4

• UNREAD = 5

  Inbound

• READ = 6

Used as response type in: RicochetCore.MonitorNetwork, RicochetCore.StartNetwork, RicochetCore.StopNetwork

• optional TorProcessStatus process = 1

• optional TorControlStatus control = 2

• optional TorConnectionStatus connection = 3

Secrets are not transmitted to frontend RPC clients

Used in: Config

• bytes servicePrivateKey = 1

Used in: NetworkStatus

• TorConnectionStatus.Status status = 1

• string bootstrapProgress = 10

• repeated string socksAddress = 11

Used in: TorConnectionStatus

• UNKNOWN = 0

• OFFLINE = 1

• BOOTSTRAPPING = 2

• READY = 3

Used in: NetworkStatus

• TorControlStatus.Status status = 1

• string errorMessage = 2

• string torVersion = 10

Used in: TorControlStatus

• STOPPED = 0

• ERROR = 1

• CONNECTING = 2

• CONNECTED = 3

Used in: NetworkStatus

• TorProcessStatus.Status status = 1

• string errorMessage = 2

Used in: TorProcessStatus

• DISABLED = 0

• STOPPED = 1

• STARTING = 2

• RUNNING = 3