package common.signal.v2

Get desktop application:
View/edit binary Protocol Buffers messages

GlobalSignal indicates that everything should be scheduled for a refresh. It is reserved more more extreme edge cases, such as when an account may be inactive for an extended period of time, and their log is getting significantly full. The sending of a GlobalSignal is therefore restricted to a whitelisted set of signaler's, enforced by the Signaler service.

Used in: Signal

(message has no fields)

Used in: Signal

• optional v2.PersonaId persona_id = 1

  If persona_id is set, then only the specified persona should be updated. If persona_id is not set, then all personas should be updated.

A signal notifies a client that an action should be performed. It's primary intention is to be a mechanism in which services can 'signal' a user client to perform some kind of action in a reliable way. It is _not_ a mechanism to send data, or synchronize data in and of itself. It _can_, however, be used as a mechanism to indicate that synchronization should be performed. See the related services in xiphias-api-internal and xiphias-api-mobile for usage details.

• optional Signal.Id id = 1

  Id is _only_ generated by the internal signal service. It is opaque to the rest of the world (both internal and external).

• oneof kind

  • GlobalSignal global_signal = 2

  • PersonaSignal persona_signal = 3

Id is a byte-wise lexicographically sortable Id used for synchronizing the signal stream between clients and server.

Used in: Signal

• bytes raw_value = 1