proto.md

Protocol Documentation

Table of Contents

• Admin.proto

  • Channel

  • ChannelConfiguration

  • CreateOrUpdateChannelInput

  • DeleteChannelInput

  • ListChannelOutput

  • AdminService

• Presence.proto

  • HeartBeatInput

  • Presence

  • PresenceSubscribeInput

  • PresenceSubscribeResponse

  • PresenceSubscribeResponse.Type

  • PresenceService

• Push.proto

  • Message

  • PushInput

  • SubscribeInput

  • PushService

• Scalar Value Types

Top

Admin.proto

Channel

Field	Type	Label	Description
name	string
configuration	ChannelConfiguration

ChannelConfiguration

Field	Type	Label	Description
admin_required_to_push	bool		Define if a message can be pushed without admin api key. Common use case: Only allow server to push message

CreateOrUpdateChannelInput

Field	Type	Label	Description
name	string
configuration	ChannelConfiguration

DeleteChannelInput

Field	Type	Label	Description
name	string

ListChannelOutput

Field	Type	Label	Description
channels	Channel	repeated

AdminService

Method Name	Request Type	Response Type	Description
CreateChannelOrUpdate	CreateOrUpdateChannelInput	.google.protobuf.Empty	Create a new channel
ListChannel	.google.protobuf.Empty	ListChannelOutput	List channels
DeleteChannel	DeleteChannelInput	.google.protobuf.Empty	Delete channel

Top

Presence.proto

HeartBeatInput

Field	Type	Label	Description
state	bytes		The state for a particular person
key	string		A unique key for presence
channel	string		A reference to the channel
topic	string		A reference to the topic

Presence

Field	Type	Label	Description
state	bytes		The state for a particular person
key	string		A unique key for presence

PresenceSubscribeInput

Field	Type	Label	Description
channel	string		A reference to the channel
topic	string		A reference to the topic

PresenceSubscribeResponse

Field	Type	Label	Description
presences	Presence	repeated	A list of presence
update_type	PresenceSubscribeResponse.Type		For now only full is supported

PresenceSubscribeResponse.Type

Name	Number	Description
FULL	0
PARTIAL	1

PresenceService

Method Name	Request Type	Response Type	Description
PresenceSubscribe	PresenceSubscribeInput	PresenceSubscribeResponse stream	Subscribe to a channel/topic to get presence update
HeartBeat	HeartBeatInput	.google.protobuf.Empty	Heartbeat to a channel

Top

Push.proto

Message

Field	Type	Label	Description
data	bytes		Your payload

PushInput

Field	Type	Label	Description
channel	string
topic	string
data	bytes		Your payload

SubscribeInput

Field	Type	Label	Description
channel	string		A reference to the channel
topic	string		A reference to the topic

PushService

Method Name	Request Type	Response Type	Description
Subscribe	SubscribeInput	Message stream	Subscribe to a channel/topic to receive Owl Message
Publish	PushInput	.google.protobuf.Empty	Subscribe to a channel/topic to receive Owl Message

Scalar Value Types

.proto Type	Notes	C++	Java	Python	Go	C#	PHP	Ruby
double		double	double	float	float64	double	float	Float
float		float	float	float	float32	float	float	Float
int32	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int64	long	int/long	int64	long	integer/string	Bignum
uint32	Uses variable-length encoding.	uint32	int	int/long	uint32	uint	integer	Bignum or Fixnum (as required)
uint64	Uses variable-length encoding.	uint64	long	int/long	uint64	ulong	integer/string	Bignum or Fixnum (as required)
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int64	long	int/long	int64	long	integer/string	Bignum
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	uint32	int	int	uint32	uint	integer	Bignum or Fixnum (as required)
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	uint64	long	int/long	uint64	ulong	integer/string	Bignum
sfixed32	Always four bytes.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sfixed64	Always eight bytes.	int64	long	int/long	int64	long	integer/string	Bignum
bool		bool	boolean	boolean	bool	bool	boolean	TrueClass/FalseClass
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String	str/unicode	string	string	string	String (UTF-8)
bytes	May contain any arbitrary sequence of bytes.	string	ByteString	str	[]byte	ByteString	string	String (ASCII-8BIT)