rtapi

package
v2.0.0+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 14, 2018 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

Package rtapi is a generated protocol buffer package.

It is generated from these files: 

rtapi/realtime.proto

It has these top-level messages: 

Envelope
Channel
ChannelJoin
ChannelLeave
ChannelMessageAck
ChannelMessageSend
ChannelMessageUpdate
ChannelMessageRemove
ChannelPresenceEvent
Error
Match
MatchCreate
MatchData
MatchDataSend
MatchJoin
MatchLeave
MatchPresenceEvent
MatchmakerAdd
MatchmakerMatched
MatchmakerRemove
MatchmakerTicket
Notifications
Status
StatusFollow
StatusPresenceEvent
StatusUnfollow
StatusUpdate
Stream
StreamData
StreamPresenceEvent
UserPresence

Index

Constants

This section is empty.

Variables

View Source 
var ChannelJoin_Type_name = map[int32]string{
	0: "TYPE_UNSPECIFIED",
	1: "ROOM",
	2: "DIRECT_MESSAGE",
	3: "GROUP",
}
View Source 
var ChannelJoin_Type_value = map[string]int32{
	"TYPE_UNSPECIFIED": 0,
	"ROOM":             1,
	"DIRECT_MESSAGE":   2,
	"GROUP":            3,
}
View Source 
var Error_Code_name = map[int32]string{
	0: "RUNTIME_EXCEPTION",
	1: "UNRECOGNIZED_PAYLOAD",
	2: "MISSING_PAYLOAD",
	3: "BAD_INPUT",
	4: "MATCH_NOT_FOUND",
	5: "MATCH_JOIN_REJECTED",
	6: "RUNTIME_FUNCTION_NOT_FOUND",
	7: "RUNTIME_FUNCTION_EXCEPTION",
}
View Source 
var Error_Code_value = map[string]int32{
	"RUNTIME_EXCEPTION":          0,
	"UNRECOGNIZED_PAYLOAD":       1,
	"MISSING_PAYLOAD":            2,
	"BAD_INPUT":                  3,
	"MATCH_NOT_FOUND":            4,
	"MATCH_JOIN_REJECTED":        5,
	"RUNTIME_FUNCTION_NOT_FOUND": 6,
	"RUNTIME_FUNCTION_EXCEPTION": 7,
}

Functions

This section is empty.

Types

type Channel 

type Channel struct {
	// The ID of the channel.
	Id string `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"`
	// The users currently in the channel.
	Presences []*UserPresence `protobuf:"bytes,2,rep,name=presences" json:"presences,omitempty"`
	// A reference to the current user's presence in the channel.
	Self *UserPresence `protobuf:"bytes,3,opt,name=self" json:"self,omitempty"`
}

A realtime chat channel.

func (*Channel) Descriptor 

func (*Channel) Descriptor() ([]byte, []int)

func (*Channel) GetId 

func (m *Channel) GetId() string

func (*Channel) GetPresences 

func (m *Channel) GetPresences() []*UserPresence

func (*Channel) GetSelf 

func (m *Channel) GetSelf() *UserPresence

func (*Channel) ProtoMessage 

func (*Channel) ProtoMessage()

func (*Channel) Reset 

func (m *Channel) Reset()

func (*Channel) String 

func (m *Channel) String() string

type ChannelJoin 

type ChannelJoin struct {
	// The user ID to DM with, group ID to chat with, or room channel name to join.
	Target string `protobuf:"bytes,1,opt,name=target" json:"target,omitempty"`
	// The type of the chat channel.
	Type int32 `protobuf:"varint,2,opt,name=type" json:"type,omitempty"`
	// Whether messages sent on this channel should be persistent.
	Persistence *google_protobuf1.BoolValue `protobuf:"bytes,3,opt,name=persistence" json:"persistence,omitempty"`
	// Whether the user should appear in the channel's presence list and events.
	Hidden *google_protobuf1.BoolValue `protobuf:"bytes,4,opt,name=hidden" json:"hidden,omitempty"`
}

Join operation for a realtime chat channel.

func (*ChannelJoin) Descriptor 

func (*ChannelJoin) Descriptor() ([]byte, []int)

func (*ChannelJoin) GetHidden 

func (m *ChannelJoin) GetHidden() *google_protobuf1.BoolValue

func (*ChannelJoin) GetPersistence 

func (m *ChannelJoin) GetPersistence() *google_protobuf1.BoolValue

func (*ChannelJoin) GetTarget 

func (m *ChannelJoin) GetTarget() string

func (*ChannelJoin) GetType 

func (m *ChannelJoin) GetType() int32

func (*ChannelJoin) ProtoMessage 

func (*ChannelJoin) ProtoMessage()

func (*ChannelJoin) Reset 

func (m *ChannelJoin) Reset()

func (*ChannelJoin) String 

func (m *ChannelJoin) String() string

type ChannelJoin_Type 

type ChannelJoin_Type int32

The type of chat channel. 

const (
	// Default case. Assumed as ROOM type.
	ChannelJoin_TYPE_UNSPECIFIED ChannelJoin_Type = 0
	// A room which anyone can join to chat.
	ChannelJoin_ROOM ChannelJoin_Type = 1
	// A private channel for 1-on-1 chat.
	ChannelJoin_DIRECT_MESSAGE ChannelJoin_Type = 2
	// A channel for group chat.
	ChannelJoin_GROUP ChannelJoin_Type = 3
)

func (ChannelJoin_Type) EnumDescriptor 

func (ChannelJoin_Type) EnumDescriptor() ([]byte, []int)

func (ChannelJoin_Type) String 

func (x ChannelJoin_Type) String() string

type ChannelLeave 

type ChannelLeave struct {
	// The ID of the channel to leave.
	ChannelId string `protobuf:"bytes,1,opt,name=channel_id,json=channelId" json:"channel_id,omitempty"`
}

Leave a realtime channel.

func (*ChannelLeave) Descriptor 

func (*ChannelLeave) Descriptor() ([]byte, []int)

func (*ChannelLeave) GetChannelId 

func (m *ChannelLeave) GetChannelId() string

func (*ChannelLeave) ProtoMessage 

func (*ChannelLeave) ProtoMessage()

func (*ChannelLeave) Reset 

func (m *ChannelLeave) Reset()

func (*ChannelLeave) String 

func (m *ChannelLeave) String() string

type ChannelMessageAck 

type ChannelMessageAck struct {
	// The channel the message was sent to.
	ChannelId string `protobuf:"bytes,1,opt,name=channel_id,json=channelId" json:"channel_id,omitempty"`
	// The unique ID assigned to the message.
	MessageId string `protobuf:"bytes,2,opt,name=message_id,json=messageId" json:"message_id,omitempty"`
	// The code representing a message type or category.
	Code *google_protobuf1.Int32Value `protobuf:"bytes,3,opt,name=code" json:"code,omitempty"`
	// Username of the message sender.
	Username string `protobuf:"bytes,4,opt,name=username" json:"username,omitempty"`
	// The UNIX time when the message was created.
	CreateTime *google_protobuf.Timestamp `protobuf:"bytes,5,opt,name=create_time,json=createTime" json:"create_time,omitempty"`
	// The UNIX time when the message was last updated.
	UpdateTime *google_protobuf.Timestamp `protobuf:"bytes,6,opt,name=update_time,json=updateTime" json:"update_time,omitempty"`
	// True if the message was persisted to the channel's history, false otherwise.
	Persistent *google_protobuf1.BoolValue `protobuf:"bytes,7,opt,name=persistent" json:"persistent,omitempty"`
}

A receipt reply from a channel message send operation.

func (*ChannelMessageAck) Descriptor 

func (*ChannelMessageAck) Descriptor() ([]byte, []int)

func (*ChannelMessageAck) GetChannelId 

func (m *ChannelMessageAck) GetChannelId() string

func (*ChannelMessageAck) GetCode 

func (m *ChannelMessageAck) GetCode() *google_protobuf1.Int32Value

func (*ChannelMessageAck) GetCreateTime 

func (m *ChannelMessageAck) GetCreateTime() *google_protobuf.Timestamp

func (*ChannelMessageAck) GetMessageId 

func (m *ChannelMessageAck) GetMessageId() string

func (*ChannelMessageAck) GetPersistent 

func (m *ChannelMessageAck) GetPersistent() *google_protobuf1.BoolValue

func (*ChannelMessageAck) GetUpdateTime 

func (m *ChannelMessageAck) GetUpdateTime() *google_protobuf.Timestamp

func (*ChannelMessageAck) GetUsername 

func (m *ChannelMessageAck) GetUsername() string

func (*ChannelMessageAck) ProtoMessage 

func (*ChannelMessageAck) ProtoMessage()

func (*ChannelMessageAck) Reset 

func (m *ChannelMessageAck) Reset()

func (*ChannelMessageAck) String 

func (m *ChannelMessageAck) String() string

type ChannelMessageRemove 

type ChannelMessageRemove struct {
	// The channel the message was sent to.
	ChannelId string `protobuf:"bytes,1,opt,name=channel_id,json=channelId" json:"channel_id,omitempty"`
	// The ID assigned to the message to update.
	MessageId string `protobuf:"bytes,2,opt,name=message_id,json=messageId" json:"message_id,omitempty"`
}

Remove a message previously sent to a realtime channel.

func (*ChannelMessageRemove) Descriptor 

func (*ChannelMessageRemove) Descriptor() ([]byte, []int)

func (*ChannelMessageRemove) GetChannelId 

func (m *ChannelMessageRemove) GetChannelId() string

func (*ChannelMessageRemove) GetMessageId 

func (m *ChannelMessageRemove) GetMessageId() string

func (*ChannelMessageRemove) ProtoMessage 

func (*ChannelMessageRemove) ProtoMessage()

func (*ChannelMessageRemove) Reset 

func (m *ChannelMessageRemove) Reset()

func (*ChannelMessageRemove) String 

func (m *ChannelMessageRemove) String() string

type ChannelMessageSend 

type ChannelMessageSend struct {
	// The channel to sent to.
	ChannelId string `protobuf:"bytes,1,opt,name=channel_id,json=channelId" json:"channel_id,omitempty"`
	// Message content.
	Content string `protobuf:"bytes,2,opt,name=content" json:"content,omitempty"`
}

Send a message to a realtime channel.

func (*ChannelMessageSend) Descriptor 

func (*ChannelMessageSend) Descriptor() ([]byte, []int)

func (*ChannelMessageSend) GetChannelId 

func (m *ChannelMessageSend) GetChannelId() string

func (*ChannelMessageSend) GetContent 

func (m *ChannelMessageSend) GetContent() string

func (*ChannelMessageSend) ProtoMessage 

func (*ChannelMessageSend) ProtoMessage()

func (*ChannelMessageSend) Reset 

func (m *ChannelMessageSend) Reset()

func (*ChannelMessageSend) String 

func (m *ChannelMessageSend) String() string

type ChannelMessageUpdate 

type ChannelMessageUpdate struct {
	// The channel the message was sent to.
	ChannelId string `protobuf:"bytes,1,opt,name=channel_id,json=channelId" json:"channel_id,omitempty"`
	// The ID assigned to the message to update.
	MessageId string `protobuf:"bytes,2,opt,name=message_id,json=messageId" json:"message_id,omitempty"`
	// New message content.
	Content string `protobuf:"bytes,3,opt,name=content" json:"content,omitempty"`
}

Update a message previously sent to a realtime channel.

func (*ChannelMessageUpdate) Descriptor 

func (*ChannelMessageUpdate) Descriptor() ([]byte, []int)

func (*ChannelMessageUpdate) GetChannelId 

func (m *ChannelMessageUpdate) GetChannelId() string

func (*ChannelMessageUpdate) GetContent 

func (m *ChannelMessageUpdate) GetContent() string

func (*ChannelMessageUpdate) GetMessageId 

func (m *ChannelMessageUpdate) GetMessageId() string

func (*ChannelMessageUpdate) ProtoMessage 

func (*ChannelMessageUpdate) ProtoMessage()

func (*ChannelMessageUpdate) Reset 

func (m *ChannelMessageUpdate) Reset()

func (*ChannelMessageUpdate) String 

func (m *ChannelMessageUpdate) String() string

type ChannelPresenceEvent 

type ChannelPresenceEvent struct {
	// The channel identifier this event is for.
	ChannelId string `protobuf:"bytes,1,opt,name=channel_id,json=channelId" json:"channel_id,omitempty"`
	// Presences joining the channel as part of this event, if any.
	Joins []*UserPresence `protobuf:"bytes,2,rep,name=joins" json:"joins,omitempty"`
	// Presences leaving the channel as part of this event, if any.
	Leaves []*UserPresence `protobuf:"bytes,3,rep,name=leaves" json:"leaves,omitempty"`
}

A set of joins and leaves on a particular channel.

func (*ChannelPresenceEvent) Descriptor 

func (*ChannelPresenceEvent) Descriptor() ([]byte, []int)

func (*ChannelPresenceEvent) GetChannelId 

func (m *ChannelPresenceEvent) GetChannelId() string

func (*ChannelPresenceEvent) GetJoins 

func (m *ChannelPresenceEvent) GetJoins() []*UserPresence

func (*ChannelPresenceEvent) GetLeaves 

func (m *ChannelPresenceEvent) GetLeaves() []*UserPresence

func (*ChannelPresenceEvent) ProtoMessage 

func (*ChannelPresenceEvent) ProtoMessage()

func (*ChannelPresenceEvent) Reset 

func (m *ChannelPresenceEvent) Reset()

func (*ChannelPresenceEvent) String 

func (m *ChannelPresenceEvent) String() string

type Envelope 

type Envelope struct {
	Cid string `protobuf:"bytes,1,opt,name=cid" json:"cid,omitempty"`
	// Types that are valid to be assigned to Message:
	//	*Envelope_Channel
	//	*Envelope_ChannelJoin
	//	*Envelope_ChannelLeave
	//	*Envelope_ChannelMessage
	//	*Envelope_ChannelMessageAck
	//	*Envelope_ChannelMessageSend
	//	*Envelope_ChannelMessageUpdate
	//	*Envelope_ChannelMessageRemove
	//	*Envelope_ChannelPresenceEvent
	//	*Envelope_Error
	//	*Envelope_Match
	//	*Envelope_MatchCreate
	//	*Envelope_MatchData
	//	*Envelope_MatchDataSend
	//	*Envelope_MatchJoin
	//	*Envelope_MatchLeave
	//	*Envelope_MatchPresenceEvent
	//	*Envelope_MatchmakerAdd
	//	*Envelope_MatchmakerMatched
	//	*Envelope_MatchmakerRemove
	//	*Envelope_MatchmakerTicket
	//	*Envelope_Notifications
	//	*Envelope_Rpc
	//	*Envelope_Status
	//	*Envelope_StatusFollow
	//	*Envelope_StatusPresenceEvent
	//	*Envelope_StatusUnfollow
	//	*Envelope_StatusUpdate
	//	*Envelope_StreamData
	//	*Envelope_StreamPresenceEvent
	Message isEnvelope_Message `protobuf_oneof:"message"`
}

An envelope for a realtime message.

func (*Envelope) Descriptor 

func (*Envelope) Descriptor() ([]byte, []int)

func (*Envelope) GetChannel 

func (m *Envelope) GetChannel() *Channel

func (*Envelope) GetChannelJoin 

func (m *Envelope) GetChannelJoin() *ChannelJoin

func (*Envelope) GetChannelLeave 

func (m *Envelope) GetChannelLeave() *ChannelLeave

func (*Envelope) GetChannelMessage 

func (m *Envelope) GetChannelMessage() *nakama_api.ChannelMessage

func (*Envelope) GetChannelMessageAck 

func (m *Envelope) GetChannelMessageAck() *ChannelMessageAck

func (*Envelope) GetChannelMessageRemove 

func (m *Envelope) GetChannelMessageRemove() *ChannelMessageRemove

func (*Envelope) GetChannelMessageSend 

func (m *Envelope) GetChannelMessageSend() *ChannelMessageSend

func (*Envelope) GetChannelMessageUpdate 

func (m *Envelope) GetChannelMessageUpdate() *ChannelMessageUpdate

func (*Envelope) GetChannelPresenceEvent 

func (m *Envelope) GetChannelPresenceEvent() *ChannelPresenceEvent

func (*Envelope) GetCid 

func (m *Envelope) GetCid() string

func (*Envelope) GetError 

func (m *Envelope) GetError() *Error

func (*Envelope) GetMatch 

func (m *Envelope) GetMatch() *Match

func (*Envelope) GetMatchCreate 

func (m *Envelope) GetMatchCreate() *MatchCreate

func (*Envelope) GetMatchData 

func (m *Envelope) GetMatchData() *MatchData

func (*Envelope) GetMatchDataSend 

func (m *Envelope) GetMatchDataSend() *MatchDataSend

func (*Envelope) GetMatchJoin 

func (m *Envelope) GetMatchJoin() *MatchJoin

func (*Envelope) GetMatchLeave 

func (m *Envelope) GetMatchLeave() *MatchLeave

func (*Envelope) GetMatchPresenceEvent 

func (m *Envelope) GetMatchPresenceEvent() *MatchPresenceEvent

func (*Envelope) GetMatchmakerAdd 

func (m *Envelope) GetMatchmakerAdd() *MatchmakerAdd

func (*Envelope) GetMatchmakerMatched 

func (m *Envelope) GetMatchmakerMatched() *MatchmakerMatched

func (*Envelope) GetMatchmakerRemove 

func (m *Envelope) GetMatchmakerRemove() *MatchmakerRemove

func (*Envelope) GetMatchmakerTicket 

func (m *Envelope) GetMatchmakerTicket() *MatchmakerTicket

func (*Envelope) GetMessage 

func (m *Envelope) GetMessage() isEnvelope_Message

func (*Envelope) GetNotifications 

func (m *Envelope) GetNotifications() *Notifications

func (*Envelope) GetRpc 

func (m *Envelope) GetRpc() *nakama_api.Rpc

func (*Envelope) GetStatus 

func (m *Envelope) GetStatus() *Status

func (*Envelope) GetStatusFollow 

func (m *Envelope) GetStatusFollow() *StatusFollow

func (*Envelope) GetStatusPresenceEvent 

func (m *Envelope) GetStatusPresenceEvent() *StatusPresenceEvent

func (*Envelope) GetStatusUnfollow 

func (m *Envelope) GetStatusUnfollow() *StatusUnfollow

func (*Envelope) GetStatusUpdate 

func (m *Envelope) GetStatusUpdate() *StatusUpdate

func (*Envelope) GetStreamData 

func (m *Envelope) GetStreamData() *StreamData

func (*Envelope) GetStreamPresenceEvent 

func (m *Envelope) GetStreamPresenceEvent() *StreamPresenceEvent

func (*Envelope) ProtoMessage 

func (*Envelope) ProtoMessage()

func (*Envelope) Reset 

func (m *Envelope) Reset()

func (*Envelope) String 

func (m *Envelope) String() string

func (*Envelope) XXX_OneofFuncs 

func (*Envelope) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})

XXX_OneofFuncs is for the internal use of the proto package.

type Envelope_Channel 

type Envelope_Channel struct {
	Channel *Channel `protobuf:"bytes,2,opt,name=channel,oneof"`
}

type Envelope_ChannelJoin 

type Envelope_ChannelJoin struct {
	ChannelJoin *ChannelJoin `protobuf:"bytes,3,opt,name=channel_join,json=channelJoin,oneof"`
}

type Envelope_ChannelLeave 

type Envelope_ChannelLeave struct {
	ChannelLeave *ChannelLeave `protobuf:"bytes,4,opt,name=channel_leave,json=channelLeave,oneof"`
}

type Envelope_ChannelMessage 

type Envelope_ChannelMessage struct {
	ChannelMessage *nakama_api.ChannelMessage `protobuf:"bytes,5,opt,name=channel_message,json=channelMessage,oneof"`
}

type Envelope_ChannelMessageAck 

type Envelope_ChannelMessageAck struct {
	ChannelMessageAck *ChannelMessageAck `protobuf:"bytes,6,opt,name=channel_message_ack,json=channelMessageAck,oneof"`
}

type Envelope_ChannelMessageRemove 

type Envelope_ChannelMessageRemove struct {
	ChannelMessageRemove *ChannelMessageRemove `protobuf:"bytes,9,opt,name=channel_message_remove,json=channelMessageRemove,oneof"`
}

type Envelope_ChannelMessageSend 

type Envelope_ChannelMessageSend struct {
	ChannelMessageSend *ChannelMessageSend `protobuf:"bytes,7,opt,name=channel_message_send,json=channelMessageSend,oneof"`
}

type Envelope_ChannelMessageUpdate 

type Envelope_ChannelMessageUpdate struct {
	ChannelMessageUpdate *ChannelMessageUpdate `protobuf:"bytes,8,opt,name=channel_message_update,json=channelMessageUpdate,oneof"`
}

type Envelope_ChannelPresenceEvent 

type Envelope_ChannelPresenceEvent struct {
	ChannelPresenceEvent *ChannelPresenceEvent `protobuf:"bytes,10,opt,name=channel_presence_event,json=channelPresenceEvent,oneof"`
}

type Envelope_Error 

type Envelope_Error struct {
	Error *Error `protobuf:"bytes,11,opt,name=error,oneof"`
}

type Envelope_Match 

type Envelope_Match struct {
	Match *Match `protobuf:"bytes,12,opt,name=match,oneof"`
}

type Envelope_MatchCreate 

type Envelope_MatchCreate struct {
	MatchCreate *MatchCreate `protobuf:"bytes,13,opt,name=match_create,json=matchCreate,oneof"`
}

type Envelope_MatchData 

type Envelope_MatchData struct {
	MatchData *MatchData `protobuf:"bytes,14,opt,name=match_data,json=matchData,oneof"`
}

type Envelope_MatchDataSend 

type Envelope_MatchDataSend struct {
	MatchDataSend *MatchDataSend `protobuf:"bytes,15,opt,name=match_data_send,json=matchDataSend,oneof"`
}

type Envelope_MatchJoin 

type Envelope_MatchJoin struct {
	MatchJoin *MatchJoin `protobuf:"bytes,16,opt,name=match_join,json=matchJoin,oneof"`
}

type Envelope_MatchLeave 

type Envelope_MatchLeave struct {
	MatchLeave *MatchLeave `protobuf:"bytes,17,opt,name=match_leave,json=matchLeave,oneof"`
}

type Envelope_MatchPresenceEvent 

type Envelope_MatchPresenceEvent struct {
	MatchPresenceEvent *MatchPresenceEvent `protobuf:"bytes,18,opt,name=match_presence_event,json=matchPresenceEvent,oneof"`
}

type Envelope_MatchmakerAdd 

type Envelope_MatchmakerAdd struct {
	MatchmakerAdd *MatchmakerAdd `protobuf:"bytes,19,opt,name=matchmaker_add,json=matchmakerAdd,oneof"`
}

type Envelope_MatchmakerMatched 

type Envelope_MatchmakerMatched struct {
	MatchmakerMatched *MatchmakerMatched `protobuf:"bytes,20,opt,name=matchmaker_matched,json=matchmakerMatched,oneof"`
}

type Envelope_MatchmakerRemove 

type Envelope_MatchmakerRemove struct {
	MatchmakerRemove *MatchmakerRemove `protobuf:"bytes,21,opt,name=matchmaker_remove,json=matchmakerRemove,oneof"`
}

type Envelope_MatchmakerTicket 

type Envelope_MatchmakerTicket struct {
	MatchmakerTicket *MatchmakerTicket `protobuf:"bytes,22,opt,name=matchmaker_ticket,json=matchmakerTicket,oneof"`
}

type Envelope_Notifications 

type Envelope_Notifications struct {
	Notifications *Notifications `protobuf:"bytes,23,opt,name=notifications,oneof"`
}

type Envelope_Rpc 

type Envelope_Rpc struct {
	Rpc *nakama_api.Rpc `protobuf:"bytes,24,opt,name=rpc,oneof"`
}

type Envelope_Status 

type Envelope_Status struct {
	Status *Status `protobuf:"bytes,25,opt,name=status,oneof"`
}

type Envelope_StatusFollow 

type Envelope_StatusFollow struct {
	StatusFollow *StatusFollow `protobuf:"bytes,26,opt,name=status_follow,json=statusFollow,oneof"`
}

type Envelope_StatusPresenceEvent 

type Envelope_StatusPresenceEvent struct {
	StatusPresenceEvent *StatusPresenceEvent `protobuf:"bytes,27,opt,name=status_presence_event,json=statusPresenceEvent,oneof"`
}

type Envelope_StatusUnfollow 

type Envelope_StatusUnfollow struct {
	StatusUnfollow *StatusUnfollow `protobuf:"bytes,28,opt,name=status_unfollow,json=statusUnfollow,oneof"`
}

type Envelope_StatusUpdate 

type Envelope_StatusUpdate struct {
	StatusUpdate *StatusUpdate `protobuf:"bytes,29,opt,name=status_update,json=statusUpdate,oneof"`
}

type Envelope_StreamData 

type Envelope_StreamData struct {
	StreamData *StreamData `protobuf:"bytes,30,opt,name=stream_data,json=streamData,oneof"`
}

type Envelope_StreamPresenceEvent 

type Envelope_StreamPresenceEvent struct {
	StreamPresenceEvent *StreamPresenceEvent `protobuf:"bytes,31,opt,name=stream_presence_event,json=streamPresenceEvent,oneof"`
}

type Error 

type Error struct {
	// The error code which should be one of "Error.Code" enums.
	Code int32 `protobuf:"varint,1,opt,name=code" json:"code,omitempty"`
	// A message in English to help developers debug the response.
	Message string `protobuf:"bytes,2,opt,name=message" json:"message,omitempty"`
	// Additional error details which may be different for each response.
	Context map[string]string `` /* 134-byte string literal not displayed */
}

A logical error which may occur on the server.

func (*Error) Descriptor 

func (*Error) Descriptor() ([]byte, []int)

func (*Error) GetCode 

func (m *Error) GetCode() int32

func (*Error) GetContext 

func (m *Error) GetContext() map[string]string

func (*Error) GetMessage 

func (m *Error) GetMessage() string

func (*Error) ProtoMessage 

func (*Error) ProtoMessage()

func (*Error) Reset 

func (m *Error) Reset()

func (*Error) String 

func (m *Error) String() string

type Error_Code 

type Error_Code int32

The selection of possible error codes. 

const (
	// An unexpected result from the server.
	Error_RUNTIME_EXCEPTION Error_Code = 0
	// The server received a message which is not recognised.
	Error_UNRECOGNIZED_PAYLOAD Error_Code = 1
	// A message was expected but contains no content.
	Error_MISSING_PAYLOAD Error_Code = 2
	// Fields in the message have an invalid format.
	Error_BAD_INPUT Error_Code = 3
	// The match id was not found.
	Error_MATCH_NOT_FOUND Error_Code = 4
	// The match join was rejected.
	Error_MATCH_JOIN_REJECTED Error_Code = 5
	// The runtime function does not exist on the server.
	Error_RUNTIME_FUNCTION_NOT_FOUND Error_Code = 6
	// The runtime function executed with an error.
	Error_RUNTIME_FUNCTION_EXCEPTION Error_Code = 7
)

func (Error_Code) EnumDescriptor 

func (Error_Code) EnumDescriptor() ([]byte, []int)

func (Error_Code) String 

func (x Error_Code) String() string

type Match 

type Match struct {
	// The match unique ID.
	MatchId string `protobuf:"bytes,1,opt,name=match_id,json=matchId" json:"match_id,omitempty"`
	// True if it's an server-managed authoritative match, false otherwise.
	Authoritative bool `protobuf:"varint,2,opt,name=authoritative" json:"authoritative,omitempty"`
	// Match label, if any.
	Label *google_protobuf1.StringValue `protobuf:"bytes,3,opt,name=label" json:"label,omitempty"`
	// The number of users currently in the match.
	Size int32 `protobuf:"varint,4,opt,name=size" json:"size,omitempty"`
	// The users currently in the match.
	Presences []*UserPresence `protobuf:"bytes,5,rep,name=presences" json:"presences,omitempty"`
	// A reference to the current user's presence in the match.
	Self *UserPresence `protobuf:"bytes,6,opt,name=self" json:"self,omitempty"`
}

A realtime match.

func (*Match) Descriptor 

func (*Match) Descriptor() ([]byte, []int)

func (*Match) GetAuthoritative 

func (m *Match) GetAuthoritative() bool

func (*Match) GetLabel 

func (m *Match) GetLabel() *google_protobuf1.StringValue

func (*Match) GetMatchId 

func (m *Match) GetMatchId() string

func (*Match) GetPresences 

func (m *Match) GetPresences() []*UserPresence

func (*Match) GetSelf 

func (m *Match) GetSelf() *UserPresence

func (*Match) GetSize 

func (m *Match) GetSize() int32

func (*Match) ProtoMessage 

func (*Match) ProtoMessage()

func (*Match) Reset 

func (m *Match) Reset()

func (*Match) String 

func (m *Match) String() string

type MatchCreate 

type MatchCreate struct {
}

Create a new realtime match.

func (*MatchCreate) Descriptor 

func (*MatchCreate) Descriptor() ([]byte, []int)

func (*MatchCreate) ProtoMessage 

func (*MatchCreate) ProtoMessage()

func (*MatchCreate) Reset 

func (m *MatchCreate) Reset()

func (*MatchCreate) String 

func (m *MatchCreate) String() string

type MatchData 

type MatchData struct {
	// The match unique ID.
	MatchId string `protobuf:"bytes,1,opt,name=match_id,json=matchId" json:"match_id,omitempty"`
	// A reference to the user presence that sent this data, if any.
	Presence *UserPresence `protobuf:"bytes,2,opt,name=presence" json:"presence,omitempty"`
	// Op code value.
	OpCode int64 `protobuf:"varint,3,opt,name=op_code,json=opCode" json:"op_code,omitempty"`
	// Data payload, if any.
	Data []byte `protobuf:"bytes,4,opt,name=data,proto3" json:"data,omitempty"`
}

Realtime match data received from the server.

func (*MatchData) Descriptor 

func (*MatchData) Descriptor() ([]byte, []int)

func (*MatchData) GetData 

func (m *MatchData) GetData() []byte

func (*MatchData) GetMatchId 

func (m *MatchData) GetMatchId() string

func (*MatchData) GetOpCode 

func (m *MatchData) GetOpCode() int64

func (*MatchData) GetPresence 

func (m *MatchData) GetPresence() *UserPresence

func (*MatchData) ProtoMessage 

func (*MatchData) ProtoMessage()

func (*MatchData) Reset 

func (m *MatchData) Reset()

func (*MatchData) String 

func (m *MatchData) String() string

type MatchDataSend 

type MatchDataSend struct {
	// The match unique ID.
	MatchId string `protobuf:"bytes,1,opt,name=match_id,json=matchId" json:"match_id,omitempty"`
	// Op code value.
	OpCode int64 `protobuf:"varint,2,opt,name=op_code,json=opCode" json:"op_code,omitempty"`
	// Data payload, if any.
	Data []byte `protobuf:"bytes,3,opt,name=data,proto3" json:"data,omitempty"`
	// List of presences in the match to deliver to, if filtering is required. Otherwise deliver to everyone in the match.
	Presences []*UserPresence `protobuf:"bytes,4,rep,name=presences" json:"presences,omitempty"`
}

Send realtime match data to the server.

func (*MatchDataSend) Descriptor 

func (*MatchDataSend) Descriptor() ([]byte, []int)

func (*MatchDataSend) GetData 

func (m *MatchDataSend) GetData() []byte

func (*MatchDataSend) GetMatchId 

func (m *MatchDataSend) GetMatchId() string

func (*MatchDataSend) GetOpCode 

func (m *MatchDataSend) GetOpCode() int64

func (*MatchDataSend) GetPresences 

func (m *MatchDataSend) GetPresences() []*UserPresence

func (*MatchDataSend) ProtoMessage 

func (*MatchDataSend) ProtoMessage()

func (*MatchDataSend) Reset 

func (m *MatchDataSend) Reset()

func (*MatchDataSend) String 

func (m *MatchDataSend) String() string

type MatchJoin 

type MatchJoin struct {
	// Types that are valid to be assigned to Id:
	//	*MatchJoin_MatchId
	//	*MatchJoin_Token
	Id isMatchJoin_Id `protobuf_oneof:"id"`
}

Join an existing realtime match.

func (*MatchJoin) Descriptor 

func (*MatchJoin) Descriptor() ([]byte, []int)

func (*MatchJoin) GetId 

func (m *MatchJoin) GetId() isMatchJoin_Id

func (*MatchJoin) GetMatchId 

func (m *MatchJoin) GetMatchId() string

func (*MatchJoin) GetToken 

func (m *MatchJoin) GetToken() string

func (*MatchJoin) ProtoMessage 

func (*MatchJoin) ProtoMessage()

func (*MatchJoin) Reset 

func (m *MatchJoin) Reset()

func (*MatchJoin) String 

func (m *MatchJoin) String() string

func (*MatchJoin) XXX_OneofFuncs 

func (*MatchJoin) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})

XXX_OneofFuncs is for the internal use of the proto package.

type MatchJoin_MatchId 

type MatchJoin_MatchId struct {
	MatchId string `protobuf:"bytes,1,opt,name=match_id,json=matchId,oneof"`
}

type MatchJoin_Token 

type MatchJoin_Token struct {
	Token string `protobuf:"bytes,2,opt,name=token,oneof"`
}

type MatchLeave 

type MatchLeave struct {
	// The match unique ID.
	MatchId string `protobuf:"bytes,1,opt,name=match_id,json=matchId" json:"match_id,omitempty"`
}

Leave a realtime match.

func (*MatchLeave) Descriptor 

func (*MatchLeave) Descriptor() ([]byte, []int)

func (*MatchLeave) GetMatchId 

func (m *MatchLeave) GetMatchId() string

func (*MatchLeave) ProtoMessage 

func (*MatchLeave) ProtoMessage()

func (*MatchLeave) Reset 

func (m *MatchLeave) Reset()

func (*MatchLeave) String 

func (m *MatchLeave) String() string

type MatchPresenceEvent 

type MatchPresenceEvent struct {
	// The match unique ID.
	MatchId string `protobuf:"bytes,1,opt,name=match_id,json=matchId" json:"match_id,omitempty"`
	// User presences that have just joined the match.
	Joins []*UserPresence `protobuf:"bytes,2,rep,name=joins" json:"joins,omitempty"`
	// User presences that have just left the match.
	Leaves []*UserPresence `protobuf:"bytes,3,rep,name=leaves" json:"leaves,omitempty"`
}

A set of joins and leaves on a particular realtime match.

func (*MatchPresenceEvent) Descriptor 

func (*MatchPresenceEvent) Descriptor() ([]byte, []int)

func (*MatchPresenceEvent) GetJoins 

func (m *MatchPresenceEvent) GetJoins() []*UserPresence

func (*MatchPresenceEvent) GetLeaves 

func (m *MatchPresenceEvent) GetLeaves() []*UserPresence

func (*MatchPresenceEvent) GetMatchId 

func (m *MatchPresenceEvent) GetMatchId() string

func (*MatchPresenceEvent) ProtoMessage 

func (*MatchPresenceEvent) ProtoMessage()

func (*MatchPresenceEvent) Reset 

func (m *MatchPresenceEvent) Reset()

func (*MatchPresenceEvent) String 

func (m *MatchPresenceEvent) String() string

type MatchmakerAdd 

type MatchmakerAdd struct {
	// Minimum total user count to match together.
	MinCount int32 `protobuf:"varint,1,opt,name=min_count,json=minCount" json:"min_count,omitempty"`
	// Maximum total user count to match together.
	MaxCount int32 `protobuf:"varint,2,opt,name=max_count,json=maxCount" json:"max_count,omitempty"`
	// Filter query used to identify suitable users.
	Query string `protobuf:"bytes,3,opt,name=query" json:"query,omitempty"`
	// String properties.
	StringProperties map[string]string `` /* 176-byte string literal not displayed */
	// Numeric properties.
	NumericProperties map[string]float64 `` /* 181-byte string literal not displayed */
}

Start a new matchmaking process.

func (*MatchmakerAdd) Descriptor 

func (*MatchmakerAdd) Descriptor() ([]byte, []int)

func (*MatchmakerAdd) GetMaxCount 

func (m *MatchmakerAdd) GetMaxCount() int32

func (*MatchmakerAdd) GetMinCount 

func (m *MatchmakerAdd) GetMinCount() int32

func (*MatchmakerAdd) GetNumericProperties 

func (m *MatchmakerAdd) GetNumericProperties() map[string]float64

func (*MatchmakerAdd) GetQuery 

func (m *MatchmakerAdd) GetQuery() string

func (*MatchmakerAdd) GetStringProperties 

func (m *MatchmakerAdd) GetStringProperties() map[string]string

func (*MatchmakerAdd) ProtoMessage 

func (*MatchmakerAdd) ProtoMessage()

func (*MatchmakerAdd) Reset 

func (m *MatchmakerAdd) Reset()

func (*MatchmakerAdd) String 

func (m *MatchmakerAdd) String() string

type MatchmakerMatched 

type MatchmakerMatched struct {
	// The matchmaking ticket that has completed.
	Ticket string `protobuf:"bytes,1,opt,name=ticket" json:"ticket,omitempty"`
	// The match token or match ID to join.
	//
	// Types that are valid to be assigned to Id:
	//	*MatchmakerMatched_MatchId
	//	*MatchmakerMatched_Token
	Id isMatchmakerMatched_Id `protobuf_oneof:"id"`
	// The users that have been matched together, and information about their matchmaking data.
	Users []*MatchmakerMatched_MatchmakerUser `protobuf:"bytes,4,rep,name=users" json:"users,omitempty"`
	// A reference to the current user and their properties.
	Self *MatchmakerMatched_MatchmakerUser `protobuf:"bytes,5,opt,name=self" json:"self,omitempty"`
}

A successful matchmaking result.

func (*MatchmakerMatched) Descriptor 

func (*MatchmakerMatched) Descriptor() ([]byte, []int)

func (*MatchmakerMatched) GetId 

func (m *MatchmakerMatched) GetId() isMatchmakerMatched_Id

func (*MatchmakerMatched) GetMatchId 

func (m *MatchmakerMatched) GetMatchId() string

func (*MatchmakerMatched) GetSelf 

func (m *MatchmakerMatched) GetSelf() *MatchmakerMatched_MatchmakerUser

func (*MatchmakerMatched) GetTicket 

func (m *MatchmakerMatched) GetTicket() string

func (*MatchmakerMatched) GetToken 

func (m *MatchmakerMatched) GetToken() string

func (*MatchmakerMatched) GetUsers 

func (m *MatchmakerMatched) GetUsers() []*MatchmakerMatched_MatchmakerUser

func (*MatchmakerMatched) ProtoMessage 

func (*MatchmakerMatched) ProtoMessage()

func (*MatchmakerMatched) Reset 

func (m *MatchmakerMatched) Reset()

func (*MatchmakerMatched) String 

func (m *MatchmakerMatched) String() string

func (*MatchmakerMatched) XXX_OneofFuncs 

func (*MatchmakerMatched) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})

XXX_OneofFuncs is for the internal use of the proto package.

type MatchmakerMatched_MatchId 

type MatchmakerMatched_MatchId struct {
	MatchId string `protobuf:"bytes,2,opt,name=match_id,json=matchId,oneof"`
}

type MatchmakerMatched_MatchmakerUser 

type MatchmakerMatched_MatchmakerUser struct {
	// User info.
	Presence *UserPresence `protobuf:"bytes,1,opt,name=presence" json:"presence,omitempty"`
	// String properties.
	StringProperties map[string]string `` /* 176-byte string literal not displayed */
	// Numeric properties.
	NumericProperties map[string]float64 `` /* 181-byte string literal not displayed */
}

func (*MatchmakerMatched_MatchmakerUser) Descriptor 

func (*MatchmakerMatched_MatchmakerUser) Descriptor() ([]byte, []int)

func (*MatchmakerMatched_MatchmakerUser) GetNumericProperties 

func (m *MatchmakerMatched_MatchmakerUser) GetNumericProperties() map[string]float64

func (*MatchmakerMatched_MatchmakerUser) GetPresence 

func (m *MatchmakerMatched_MatchmakerUser) GetPresence() *UserPresence

func (*MatchmakerMatched_MatchmakerUser) GetStringProperties 

func (m *MatchmakerMatched_MatchmakerUser) GetStringProperties() map[string]string

func (*MatchmakerMatched_MatchmakerUser) ProtoMessage 

func (*MatchmakerMatched_MatchmakerUser) ProtoMessage()

func (*MatchmakerMatched_MatchmakerUser) Reset 

func (m *MatchmakerMatched_MatchmakerUser) Reset()

func (*MatchmakerMatched_MatchmakerUser) String 

func (m *MatchmakerMatched_MatchmakerUser) String() string

type MatchmakerMatched_Token 

type MatchmakerMatched_Token struct {
	Token string `protobuf:"bytes,3,opt,name=token,oneof"`
}

type MatchmakerRemove 

type MatchmakerRemove struct {
	// The ticket to cancel.
	Ticket string `protobuf:"bytes,1,opt,name=ticket" json:"ticket,omitempty"`
}

Cancel an existing ongoing matchmaking process.

func (*MatchmakerRemove) Descriptor 

func (*MatchmakerRemove) Descriptor() ([]byte, []int)

func (*MatchmakerRemove) GetTicket 

func (m *MatchmakerRemove) GetTicket() string

func (*MatchmakerRemove) ProtoMessage 

func (*MatchmakerRemove) ProtoMessage()

func (*MatchmakerRemove) Reset 

func (m *MatchmakerRemove) Reset()

func (*MatchmakerRemove) String 

func (m *MatchmakerRemove) String() string

type MatchmakerTicket 

type MatchmakerTicket struct {
	// The ticket that can be used to cancel matchmaking.
	Ticket string `protobuf:"bytes,1,opt,name=ticket" json:"ticket,omitempty"`
}

A ticket representing a new matchmaking process.

func (*MatchmakerTicket) Descriptor 

func (*MatchmakerTicket) Descriptor() ([]byte, []int)

func (*MatchmakerTicket) GetTicket 

func (m *MatchmakerTicket) GetTicket() string

func (*MatchmakerTicket) ProtoMessage 

func (*MatchmakerTicket) ProtoMessage()

func (*MatchmakerTicket) Reset 

func (m *MatchmakerTicket) Reset()

func (*MatchmakerTicket) String 

func (m *MatchmakerTicket) String() string

type Notifications 

type Notifications struct {
	// Collection of notifications.
	Notifications []*nakama_api.Notification `protobuf:"bytes,1,rep,name=notifications" json:"notifications,omitempty"`
}

A collection of zero or more notifications.

func (*Notifications) Descriptor 

func (*Notifications) Descriptor() ([]byte, []int)

func (*Notifications) GetNotifications 

func (m *Notifications) GetNotifications() []*nakama_api.Notification

func (*Notifications) ProtoMessage 

func (*Notifications) ProtoMessage()

func (*Notifications) Reset 

func (m *Notifications) Reset()

func (*Notifications) String 

func (m *Notifications) String() string

type Status 

type Status struct {
	// User statuses.
	Presences []*UserPresence `protobuf:"bytes,1,rep,name=presences" json:"presences,omitempty"`
}

A snapshot of statuses for some set of users.

func (*Status) Descriptor 

func (*Status) Descriptor() ([]byte, []int)

func (*Status) GetPresences 

func (m *Status) GetPresences() []*UserPresence

func (*Status) ProtoMessage 

func (*Status) ProtoMessage()

func (*Status) Reset 

func (m *Status) Reset()

func (*Status) String 

func (m *Status) String() string

type StatusFollow 

type StatusFollow struct {
	// Users to follow.
	UserIds []string `protobuf:"bytes,1,rep,name=user_ids,json=userIds" json:"user_ids,omitempty"`
}

Start receiving status updates for some set of users.

func (*StatusFollow) Descriptor 

func (*StatusFollow) Descriptor() ([]byte, []int)

func (*StatusFollow) GetUserIds 

func (m *StatusFollow) GetUserIds() []string

func (*StatusFollow) ProtoMessage 

func (*StatusFollow) ProtoMessage()

func (*StatusFollow) Reset 

func (m *StatusFollow) Reset()

func (*StatusFollow) String 

func (m *StatusFollow) String() string

type StatusPresenceEvent 

type StatusPresenceEvent struct {
	// New statuses for the user.
	Joins []*UserPresence `protobuf:"bytes,2,rep,name=joins" json:"joins,omitempty"`
	// Previous statuses for the user.
	Leaves []*UserPresence `protobuf:"bytes,3,rep,name=leaves" json:"leaves,omitempty"`
}

A batch of status updates for a given user.

func (*StatusPresenceEvent) Descriptor 

func (*StatusPresenceEvent) Descriptor() ([]byte, []int)

func (*StatusPresenceEvent) GetJoins 

func (m *StatusPresenceEvent) GetJoins() []*UserPresence

func (*StatusPresenceEvent) GetLeaves 

func (m *StatusPresenceEvent) GetLeaves() []*UserPresence

func (*StatusPresenceEvent) ProtoMessage 

func (*StatusPresenceEvent) ProtoMessage()

func (*StatusPresenceEvent) Reset 

func (m *StatusPresenceEvent) Reset()

func (*StatusPresenceEvent) String 

func (m *StatusPresenceEvent) String() string

type StatusUnfollow 

type StatusUnfollow struct {
	// Users to unfollow.
	UserIds []string `protobuf:"bytes,1,rep,name=user_ids,json=userIds" json:"user_ids,omitempty"`
}

Stop receiving status updates for some set of users.

func (*StatusUnfollow) Descriptor 

func (*StatusUnfollow) Descriptor() ([]byte, []int)

func (*StatusUnfollow) GetUserIds 

func (m *StatusUnfollow) GetUserIds() []string

func (*StatusUnfollow) ProtoMessage 

func (*StatusUnfollow) ProtoMessage()

func (*StatusUnfollow) Reset 

func (m *StatusUnfollow) Reset()

func (*StatusUnfollow) String 

func (m *StatusUnfollow) String() string

type StatusUpdate 

type StatusUpdate struct {
	// Status string to set, if not present the user will appear offline.
	Status *google_protobuf1.StringValue `protobuf:"bytes,1,opt,name=status" json:"status,omitempty"`
}

Set the user's own status.

func (*StatusUpdate) Descriptor 

func (*StatusUpdate) Descriptor() ([]byte, []int)

func (*StatusUpdate) GetStatus 

func (m *StatusUpdate) GetStatus() *google_protobuf1.StringValue

func (*StatusUpdate) ProtoMessage 

func (*StatusUpdate) ProtoMessage()

func (*StatusUpdate) Reset 

func (m *StatusUpdate) Reset()

func (*StatusUpdate) String 

func (m *StatusUpdate) String() string

type Stream 

type Stream struct {
	// Mode identifies the type of stream.
	Mode int32 `protobuf:"varint,1,opt,name=mode" json:"mode,omitempty"`
	// Subject is the primary identifier, if any.
	Subject string `protobuf:"bytes,2,opt,name=subject" json:"subject,omitempty"`
	// Descriptor is a secondary identifier, if any.
	Descriptor_ string `protobuf:"bytes,3,opt,name=descriptor" json:"descriptor,omitempty"`
	// The label is an arbitrary identifying string, if the stream has one.
	Label string `protobuf:"bytes,4,opt,name=label" json:"label,omitempty"`
}

Represents identifying information for a stream.

func (*Stream) Descriptor 

func (*Stream) Descriptor() ([]byte, []int)

func (*Stream) GetDescriptor_ 

func (m *Stream) GetDescriptor_() string

func (*Stream) GetLabel 

func (m *Stream) GetLabel() string

func (*Stream) GetMode 

func (m *Stream) GetMode() int32

func (*Stream) GetSubject 

func (m *Stream) GetSubject() string

func (*Stream) ProtoMessage 

func (*Stream) ProtoMessage()

func (*Stream) Reset 

func (m *Stream) Reset()

func (*Stream) String 

func (m *Stream) String() string

type StreamData 

type StreamData struct {
	// The stream this data message relates to.
	Stream *Stream `protobuf:"bytes,1,opt,name=stream" json:"stream,omitempty"`
	// The sender, if any.
	Sender *UserPresence `protobuf:"bytes,2,opt,name=sender" json:"sender,omitempty"`
	// Arbitrary contents of the data message.
	Data string `protobuf:"bytes,3,opt,name=data" json:"data,omitempty"`
}

A data message delivered over a stream.

func (*StreamData) Descriptor 

func (*StreamData) Descriptor() ([]byte, []int)

func (*StreamData) GetData 

func (m *StreamData) GetData() string

func (*StreamData) GetSender 

func (m *StreamData) GetSender() *UserPresence

func (*StreamData) GetStream 

func (m *StreamData) GetStream() *Stream

func (*StreamData) ProtoMessage 

func (*StreamData) ProtoMessage()

func (*StreamData) Reset 

func (m *StreamData) Reset()

func (*StreamData) String 

func (m *StreamData) String() string

type StreamPresenceEvent 

type StreamPresenceEvent struct {
	// The stream this event relates to.
	Stream *Stream `protobuf:"bytes,1,opt,name=stream" json:"stream,omitempty"`
	// Presences joining the stream as part of this event, if any.
	Joins []*UserPresence `protobuf:"bytes,2,rep,name=joins" json:"joins,omitempty"`
	// Presences leaving the stream as part of this event, if any.
	Leaves []*UserPresence `protobuf:"bytes,3,rep,name=leaves" json:"leaves,omitempty"`
}

A set of joins and leaves on a particular stream.

func (*StreamPresenceEvent) Descriptor 

func (*StreamPresenceEvent) Descriptor() ([]byte, []int)

func (*StreamPresenceEvent) GetJoins 

func (m *StreamPresenceEvent) GetJoins() []*UserPresence

func (*StreamPresenceEvent) GetLeaves 

func (m *StreamPresenceEvent) GetLeaves() []*UserPresence

func (*StreamPresenceEvent) GetStream 

func (m *StreamPresenceEvent) GetStream() *Stream

func (*StreamPresenceEvent) ProtoMessage 

func (*StreamPresenceEvent) ProtoMessage()

func (*StreamPresenceEvent) Reset 

func (m *StreamPresenceEvent) Reset()

func (*StreamPresenceEvent) String 

func (m *StreamPresenceEvent) String() string

type UserPresence 

type UserPresence struct {
	// The user this presence belongs to.
	UserId string `protobuf:"bytes,1,opt,name=user_id,json=userId" json:"user_id,omitempty"`
	// A unique session ID identifying the particular connection, because the user may have many.
	SessionId string `protobuf:"bytes,2,opt,name=session_id,json=sessionId" json:"session_id,omitempty"`
	// The username for display purposes.
	Username string `protobuf:"bytes,3,opt,name=username" json:"username,omitempty"`
	// Whether this presence generates persistent data/messages, if applicable for the stream type.
	Persistence bool `protobuf:"varint,4,opt,name=persistence" json:"persistence,omitempty"`
	// A user-set status message for this stream, if applicable.
	Status *google_protobuf1.StringValue `protobuf:"bytes,5,opt,name=status" json:"status,omitempty"`
}

A user session associated to a stream, usually through a list operation or a join/leave event.

func (*UserPresence) Descriptor 

func (*UserPresence) Descriptor() ([]byte, []int)

func (*UserPresence) GetPersistence 

func (m *UserPresence) GetPersistence() bool

func (*UserPresence) GetSessionId 

func (m *UserPresence) GetSessionId() string

func (*UserPresence) GetStatus 

func (m *UserPresence) GetStatus() *google_protobuf1.StringValue

func (*UserPresence) GetUserId 

func (m *UserPresence) GetUserId() string

func (*UserPresence) GetUsername 

func (m *UserPresence) GetUsername() string

func (*UserPresence) ProtoMessage 

func (*UserPresence) ProtoMessage()

func (*UserPresence) Reset 

func (m *UserPresence) Reset()

func (*UserPresence) String 

func (m *UserPresence) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.