package push.v1

Get desktop application:
View/edit binary Protocol Buffers messages

PushService is used to push events to and from the client

• rpc Channel (stream ChannelRequest, stream ChannelResponse)

  api.proto:14

  Establish channel

  message ChannelRequest

  api.proto:33

  ChannelRequest is the channel request holder

  • oneof request

    • ChannelEvent channel_event = 1

      channel_event carries main payload

    • ChannelEventAck channel_event_ack = 2

      channel_event_ack is ack of channel_event

    • TopicSubscriptionRequest topic_subscription_request = 3

      topic_subscription_request to subscribe to a topic

    • TopicUnsubscriptionRequest topic_unsubscription_request = 4

      topic_unsubscription_request to unsubscribe to a topic

  message ChannelResponse

  api.proto:50

  ChannelResponse is the channel response holder

  • oneof response

    • ConnectAck connect_ack = 1

      connect_ack is the ack for channel connect request

    • ChannelEvent channel_event = 2

      channel_event carries main payload

    • ChannelEventAck channel_event_ack = 3

      channel_event_ack is ack of channel_event

    • TopicSubscriptionRequestAck topic_subscription_request_ack = 4

      topic_subscription_request_ack is ack of topic_subscription_request

    • TopicUnsubscriptionRequestAck topic_unsubscription_request_ack = 5

      topic_unsubscription_request_ack is ack of topic_unsubscription_request

• rpc SendEventToClientChannel (SendEventToClientChannelRequest, SendEventToClientChannelResponse)

  api.proto:17

  SendEventToClientChannel is called to send event to a client

  message SendEventToClientChannelRequest

  api.proto:144

  SendEventToClientChannelRequest is the request to send event to a client

  • string client_id = 1

    client_id is client id to which the event is to be sent

  • optional Event event = 2

    event sent or received

  message SendEventToClientChannelResponse

  api.proto:153

  SendEventToClientChannelResponse is the response of SendEventToClientChannel API

  • optional ResponseStatus status = 1

    generic response which indicates success/failure status of every request

• rpc SendEventToClientDeviceChannel (SendEventToClientDeviceChannelRequest, SendEventToClientDeviceChannelResponse)

  api.proto:20

  SendEventToClientDeviceChannel is called to send event to a client device

  message SendEventToClientDeviceChannelRequest

  api.proto:159

  SendEventToClientDeviceChannelRequest is the request to send event to a client with a device

  • string client_id = 1

    client_id is client id to which the event is to be sent

  • string device_id = 2

    device_id is the device id to which the event is to be sent

  • optional Event event = 3

    event sent or received

  message SendEventToClientDeviceChannelResponse

  api.proto:171

  SendEventToClientDeviceChannelResponse is the response of SendEventToClientDeviceChannel API

  • optional ResponseStatus status = 1

    generic response which indicates success/failure status of every request

• rpc SendEventToTopic (SendEventToTopicRequest, SendEventToTopicResponse)

  api.proto:23

  SendEventToTopic is called to send event to a topic

  message SendEventToTopicResponse

  api.proto:187

  SendEventToTopicResponse is the response of SendEventToTopic API

  • optional ResponseStatus status = 1

    generic response which indicates success/failure status of every request

• rpc SendEventToTopics (SendEventToTopicsRequest, SendEventToTopicsResponse)

  api.proto:26

  SendEventToTopics is called to send event to multiple topics

  message SendEventToTopicsRequest

  api.proto:193

  SendEventToTopicsRequest is the request to send event to multiple topics

  • repeated SendEventToTopicRequest requests = 1

    list of SendEventToTopicRequest

  message SendEventToTopicsResponse

  api.proto:199

  SendEventToTopicsResponse is the response of SendEventToTopics API

  • optional ResponseStatus status = 1

    generic response which indicates success/failure status of every request

• rpc GetClientActiveDevices (GetClientActiveDevicesRequest, GetClientActiveDevicesResponse)

  api.proto:29

  GetClientActiveDevices is called to get active devices of a client

  message GetClientActiveDevicesRequest

  api.proto:126

  GetClientActiveDevicesRequest is the request to get active devices of a client

  • string client_id = 1

    client_id for which devices to fetch devices

  message GetClientActiveDevicesResponse

  api.proto:132

  GetClientActiveDevicesResponse is the response of GetClientActiveDevices API

  • optional ResponseStatus status = 1

    generic response which indicates success/failure status of every request

  • bool is_client_online = 2

    is_client_online is a boolean to indicate if the client is online

  • repeated Device devices = 3

    list of active devices of a client

ChannelEvent is the main payload

Used in: ChannelRequest, ChannelResponse

• string unique_id = 1

  unique event id

• string topic = 2

  Topic of the event

• optional Event event = 3

  event sent and received

ChannelEventAck is the ack of a ChannelEvent

Used in: ChannelRequest, ChannelResponse

• string unique_id = 1

  unique event id

• optional ResponseStatus status = 2

  generic response which indicates success/failure status of every request

ConnectResponse is the response client gets on connecting to channel

Used in: ChannelResponse

• optional ResponseStatus status = 1

  Represents a generic Response which indicates success/failure status of every request

Device holds details of a device

Used in: GetClientActiveDevicesResponse

• string id = 1

  unique device id

• optional google.protobuf.Timestamp logged_in_at = 2

  logged in time

• map<string, string> attributes = 3

  device attributes

Event holds the event structure

Used in: ChannelEvent, SendEventToClientChannelRequest, SendEventToClientDeviceChannelRequest, SendEventToTopicRequest

• string name = 1

  name of the event

• Event.Type format_type = 2

  format_type is type of event format

• optional google.protobuf.Any data = 3

  data which the event carries

Types of event formats like JSON

Used in: Event

• TYPE_JSON_UNSPECIFIED = 0

  default type is JSON

• TYPE_PROTO = 1

  proto type

Represents a generic Response which indicates success/failure status of every request

Used in: ChannelEventAck, ConnectAck, GetClientActiveDevicesResponse, SendEventToClientChannelResponse, SendEventToClientDeviceChannelResponse, SendEventToTopicResponse, SendEventToTopicsResponse, TopicSubscriptionRequestAck, TopicUnsubscriptionRequestAck

• bool success = 1

  Indicates whether the request was successful or not

• string error_code = 2

  Indicates the error code associated with the request if it was unsuccessful

• map<string, string> message = 3

  Includes additional meta information associated with the unsuccessful request

• string error_type = 4

  Indicates the standard grpc error code associated with the request if it was unsuccessful

SendEventToTopicRequest is the request to send event to a topic

Used as request type in: PushService.SendEventToTopic

Used as field type in: SendEventToTopicsRequest

• string topic = 1

  topic to which the event is to be sent

• optional Event event = 2

  event sent or received

TopicSubscriptionRequest

Used in: ChannelRequest

• string topic = 1

  topic to subscribe

TopicSubscriptionRequest

Used in: ChannelResponse

• string topic = 1

  topic

• optional ResponseStatus status = 2

  generic response which indicates success/failure status of every request

TopicUnsubscriptionRequest

Used in: ChannelRequest

• string topic = 1

  topic to unsubscribe

TopicUnsubscriptionRequestAck

Used in: ChannelResponse

• string topic = 1

  topic

• optional ResponseStatus status = 2

  generic response which indicates success/failure status of every request