rtapi

package
v1.35.0 Latest Latest
Warning

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

Go to latest
Published: Nov 25, 2024 License: Apache-2.0 Imports: 7 Imported by: 12

Documentation

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",
	}
	ChannelJoin_Type_value = map[string]int32{
		"TYPE_UNSPECIFIED": 0,
		"ROOM":             1,
		"DIRECT_MESSAGE":   2,
		"GROUP":            3,
	}
)

Enum value maps for ChannelJoin_Type.

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",
	}
	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,
	}
)

Enum value maps for Error_Code.

View Source
var File_realtime_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type Channel

type Channel struct {

	// The ID of the channel.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// The users currently in the channel.
	Presences []*UserPresence `protobuf:"bytes,2,rep,name=presences,proto3" json:"presences,omitempty"`
	// A reference to the current user's presence in the channel.
	Self *UserPresence `protobuf:"bytes,3,opt,name=self,proto3" json:"self,omitempty"`
	// The name of the chat room, or an empty string if this message was not sent through a chat room.
	RoomName string `protobuf:"bytes,4,opt,name=room_name,json=roomName,proto3" json:"room_name,omitempty"`
	// The ID of the group, or an empty string if this message was not sent through a group channel.
	GroupId string `protobuf:"bytes,5,opt,name=group_id,json=groupId,proto3" json:"group_id,omitempty"`
	// The ID of the first DM user, or an empty string if this message was not sent through a DM chat.
	UserIdOne string `protobuf:"bytes,6,opt,name=user_id_one,json=userIdOne,proto3" json:"user_id_one,omitempty"`
	// The ID of the second DM user, or an empty string if this message was not sent through a DM chat.
	UserIdTwo string `protobuf:"bytes,7,opt,name=user_id_two,json=userIdTwo,proto3" json:"user_id_two,omitempty"`
	// contains filtered or unexported fields
}

A realtime chat channel.

func (*Channel) Descriptor deprecated

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

Deprecated: Use Channel.ProtoReflect.Descriptor instead.

func (*Channel) GetGroupId

func (x *Channel) GetGroupId() string

func (*Channel) GetId

func (x *Channel) GetId() string

func (*Channel) GetPresences

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

func (*Channel) GetRoomName

func (x *Channel) GetRoomName() string

func (*Channel) GetSelf

func (x *Channel) GetSelf() *UserPresence

func (*Channel) GetUserIdOne

func (x *Channel) GetUserIdOne() string

func (*Channel) GetUserIdTwo

func (x *Channel) GetUserIdTwo() string

func (*Channel) ProtoMessage

func (*Channel) ProtoMessage()

func (*Channel) ProtoReflect added in v1.8.0

func (x *Channel) ProtoReflect() protoreflect.Message

func (*Channel) Reset

func (x *Channel) Reset()

func (*Channel) String

func (x *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,proto3" json:"target,omitempty"`
	// The type of the chat channel.
	Type int32 `protobuf:"varint,2,opt,name=type,proto3" json:"type,omitempty"` // one of "ChannelId.Type".
	// Whether messages sent on this channel should be persistent.
	Persistence *wrapperspb.BoolValue `protobuf:"bytes,3,opt,name=persistence,proto3" json:"persistence,omitempty"`
	// Whether the user should appear in the channel's presence list and events.
	Hidden *wrapperspb.BoolValue `protobuf:"bytes,4,opt,name=hidden,proto3" json:"hidden,omitempty"`
	// contains filtered or unexported fields
}

Join operation for a realtime chat channel.

func (*ChannelJoin) Descriptor deprecated

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

Deprecated: Use ChannelJoin.ProtoReflect.Descriptor instead.

func (*ChannelJoin) GetHidden

func (x *ChannelJoin) GetHidden() *wrapperspb.BoolValue

func (*ChannelJoin) GetPersistence

func (x *ChannelJoin) GetPersistence() *wrapperspb.BoolValue

func (*ChannelJoin) GetTarget

func (x *ChannelJoin) GetTarget() string

func (*ChannelJoin) GetType

func (x *ChannelJoin) GetType() int32

func (*ChannelJoin) ProtoMessage

func (*ChannelJoin) ProtoMessage()

func (*ChannelJoin) ProtoReflect added in v1.8.0

func (x *ChannelJoin) ProtoReflect() protoreflect.Message

func (*ChannelJoin) Reset

func (x *ChannelJoin) Reset()

func (*ChannelJoin) String

func (x *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) Descriptor added in v1.8.0

func (ChannelJoin_Type) Enum added in v1.8.0

func (ChannelJoin_Type) EnumDescriptor deprecated

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

Deprecated: Use ChannelJoin_Type.Descriptor instead.

func (ChannelJoin_Type) Number added in v1.8.0

func (ChannelJoin_Type) String

func (x ChannelJoin_Type) String() string

func (ChannelJoin_Type) Type added in v1.8.0

type ChannelLeave

type ChannelLeave struct {

	// The ID of the channel to leave.
	ChannelId string `protobuf:"bytes,1,opt,name=channel_id,json=channelId,proto3" json:"channel_id,omitempty"`
	// contains filtered or unexported fields
}

Leave a realtime channel.

func (*ChannelLeave) Descriptor deprecated

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

Deprecated: Use ChannelLeave.ProtoReflect.Descriptor instead.

func (*ChannelLeave) GetChannelId

func (x *ChannelLeave) GetChannelId() string

func (*ChannelLeave) ProtoMessage

func (*ChannelLeave) ProtoMessage()

func (*ChannelLeave) ProtoReflect added in v1.8.0

func (x *ChannelLeave) ProtoReflect() protoreflect.Message

func (*ChannelLeave) Reset

func (x *ChannelLeave) Reset()

func (*ChannelLeave) String

func (x *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,proto3" json:"channel_id,omitempty"`
	// The unique ID assigned to the message.
	MessageId string `protobuf:"bytes,2,opt,name=message_id,json=messageId,proto3" json:"message_id,omitempty"`
	// The code representing a message type or category.
	Code *wrapperspb.Int32Value `protobuf:"bytes,3,opt,name=code,proto3" json:"code,omitempty"`
	// Username of the message sender.
	Username string `protobuf:"bytes,4,opt,name=username,proto3" json:"username,omitempty"`
	// The UNIX time (for gRPC clients) or ISO string (for REST clients) when the message was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// The UNIX time (for gRPC clients) or ISO string (for REST clients) when the message was last updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// True if the message was persisted to the channel's history, false otherwise.
	Persistent *wrapperspb.BoolValue `protobuf:"bytes,7,opt,name=persistent,proto3" json:"persistent,omitempty"`
	// The name of the chat room, or an empty string if this message was not sent through a chat room.
	RoomName string `protobuf:"bytes,8,opt,name=room_name,json=roomName,proto3" json:"room_name,omitempty"`
	// The ID of the group, or an empty string if this message was not sent through a group channel.
	GroupId string `protobuf:"bytes,9,opt,name=group_id,json=groupId,proto3" json:"group_id,omitempty"`
	// The ID of the first DM user, or an empty string if this message was not sent through a DM chat.
	UserIdOne string `protobuf:"bytes,10,opt,name=user_id_one,json=userIdOne,proto3" json:"user_id_one,omitempty"`
	// The ID of the second DM user, or an empty string if this message was not sent through a DM chat.
	UserIdTwo string `protobuf:"bytes,11,opt,name=user_id_two,json=userIdTwo,proto3" json:"user_id_two,omitempty"`
	// contains filtered or unexported fields
}

A receipt reply from a channel message send operation.

func (*ChannelMessageAck) Descriptor deprecated

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

Deprecated: Use ChannelMessageAck.ProtoReflect.Descriptor instead.

func (*ChannelMessageAck) GetChannelId

func (x *ChannelMessageAck) GetChannelId() string

func (*ChannelMessageAck) GetCode

func (x *ChannelMessageAck) GetCode() *wrapperspb.Int32Value

func (*ChannelMessageAck) GetCreateTime

func (x *ChannelMessageAck) GetCreateTime() *timestamppb.Timestamp

func (*ChannelMessageAck) GetGroupId

func (x *ChannelMessageAck) GetGroupId() string

func (*ChannelMessageAck) GetMessageId

func (x *ChannelMessageAck) GetMessageId() string

func (*ChannelMessageAck) GetPersistent

func (x *ChannelMessageAck) GetPersistent() *wrapperspb.BoolValue

func (*ChannelMessageAck) GetRoomName

func (x *ChannelMessageAck) GetRoomName() string

func (*ChannelMessageAck) GetUpdateTime

func (x *ChannelMessageAck) GetUpdateTime() *timestamppb.Timestamp

func (*ChannelMessageAck) GetUserIdOne

func (x *ChannelMessageAck) GetUserIdOne() string

func (*ChannelMessageAck) GetUserIdTwo

func (x *ChannelMessageAck) GetUserIdTwo() string

func (*ChannelMessageAck) GetUsername

func (x *ChannelMessageAck) GetUsername() string

func (*ChannelMessageAck) ProtoMessage

func (*ChannelMessageAck) ProtoMessage()

func (*ChannelMessageAck) ProtoReflect added in v1.8.0

func (x *ChannelMessageAck) ProtoReflect() protoreflect.Message

func (*ChannelMessageAck) Reset

func (x *ChannelMessageAck) Reset()

func (*ChannelMessageAck) String

func (x *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,proto3" json:"channel_id,omitempty"`
	// The ID assigned to the message to update.
	MessageId string `protobuf:"bytes,2,opt,name=message_id,json=messageId,proto3" json:"message_id,omitempty"`
	// contains filtered or unexported fields
}

Remove a message previously sent to a realtime channel.

func (*ChannelMessageRemove) Descriptor deprecated

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

Deprecated: Use ChannelMessageRemove.ProtoReflect.Descriptor instead.

func (*ChannelMessageRemove) GetChannelId

func (x *ChannelMessageRemove) GetChannelId() string

func (*ChannelMessageRemove) GetMessageId

func (x *ChannelMessageRemove) GetMessageId() string

func (*ChannelMessageRemove) ProtoMessage

func (*ChannelMessageRemove) ProtoMessage()

func (*ChannelMessageRemove) ProtoReflect added in v1.8.0

func (x *ChannelMessageRemove) ProtoReflect() protoreflect.Message

func (*ChannelMessageRemove) Reset

func (x *ChannelMessageRemove) Reset()

func (*ChannelMessageRemove) String

func (x *ChannelMessageRemove) String() string

type ChannelMessageSend

type ChannelMessageSend struct {

	// The channel to sent to.
	ChannelId string `protobuf:"bytes,1,opt,name=channel_id,json=channelId,proto3" json:"channel_id,omitempty"`
	// Message content.
	Content string `protobuf:"bytes,2,opt,name=content,proto3" json:"content,omitempty"`
	// contains filtered or unexported fields
}

Send a message to a realtime channel.

func (*ChannelMessageSend) Descriptor deprecated

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

Deprecated: Use ChannelMessageSend.ProtoReflect.Descriptor instead.

func (*ChannelMessageSend) GetChannelId

func (x *ChannelMessageSend) GetChannelId() string

func (*ChannelMessageSend) GetContent

func (x *ChannelMessageSend) GetContent() string

func (*ChannelMessageSend) ProtoMessage

func (*ChannelMessageSend) ProtoMessage()

func (*ChannelMessageSend) ProtoReflect added in v1.8.0

func (x *ChannelMessageSend) ProtoReflect() protoreflect.Message

func (*ChannelMessageSend) Reset

func (x *ChannelMessageSend) Reset()

func (*ChannelMessageSend) String

func (x *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,proto3" json:"channel_id,omitempty"`
	// The ID assigned to the message to update.
	MessageId string `protobuf:"bytes,2,opt,name=message_id,json=messageId,proto3" json:"message_id,omitempty"`
	// New message content.
	Content string `protobuf:"bytes,3,opt,name=content,proto3" json:"content,omitempty"`
	// contains filtered or unexported fields
}

Update a message previously sent to a realtime channel.

func (*ChannelMessageUpdate) Descriptor deprecated

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

Deprecated: Use ChannelMessageUpdate.ProtoReflect.Descriptor instead.

func (*ChannelMessageUpdate) GetChannelId

func (x *ChannelMessageUpdate) GetChannelId() string

func (*ChannelMessageUpdate) GetContent

func (x *ChannelMessageUpdate) GetContent() string

func (*ChannelMessageUpdate) GetMessageId

func (x *ChannelMessageUpdate) GetMessageId() string

func (*ChannelMessageUpdate) ProtoMessage

func (*ChannelMessageUpdate) ProtoMessage()

func (*ChannelMessageUpdate) ProtoReflect added in v1.8.0

func (x *ChannelMessageUpdate) ProtoReflect() protoreflect.Message

func (*ChannelMessageUpdate) Reset

func (x *ChannelMessageUpdate) Reset()

func (*ChannelMessageUpdate) String

func (x *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,proto3" json:"channel_id,omitempty"`
	// Presences joining the channel as part of this event, if any.
	Joins []*UserPresence `protobuf:"bytes,2,rep,name=joins,proto3" json:"joins,omitempty"`
	// Presences leaving the channel as part of this event, if any.
	Leaves []*UserPresence `protobuf:"bytes,3,rep,name=leaves,proto3" json:"leaves,omitempty"`
	// The name of the chat room, or an empty string if this message was not sent through a chat room.
	RoomName string `protobuf:"bytes,4,opt,name=room_name,json=roomName,proto3" json:"room_name,omitempty"`
	// The ID of the group, or an empty string if this message was not sent through a group channel.
	GroupId string `protobuf:"bytes,5,opt,name=group_id,json=groupId,proto3" json:"group_id,omitempty"`
	// The ID of the first DM user, or an empty string if this message was not sent through a DM chat.
	UserIdOne string `protobuf:"bytes,6,opt,name=user_id_one,json=userIdOne,proto3" json:"user_id_one,omitempty"`
	// The ID of the second DM user, or an empty string if this message was not sent through a DM chat.
	UserIdTwo string `protobuf:"bytes,7,opt,name=user_id_two,json=userIdTwo,proto3" json:"user_id_two,omitempty"`
	// contains filtered or unexported fields
}

A set of joins and leaves on a particular channel.

func (*ChannelPresenceEvent) Descriptor deprecated

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

Deprecated: Use ChannelPresenceEvent.ProtoReflect.Descriptor instead.

func (*ChannelPresenceEvent) GetChannelId

func (x *ChannelPresenceEvent) GetChannelId() string

func (*ChannelPresenceEvent) GetGroupId

func (x *ChannelPresenceEvent) GetGroupId() string

func (*ChannelPresenceEvent) GetJoins

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

func (*ChannelPresenceEvent) GetLeaves

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

func (*ChannelPresenceEvent) GetRoomName

func (x *ChannelPresenceEvent) GetRoomName() string

func (*ChannelPresenceEvent) GetUserIdOne

func (x *ChannelPresenceEvent) GetUserIdOne() string

func (*ChannelPresenceEvent) GetUserIdTwo

func (x *ChannelPresenceEvent) GetUserIdTwo() string

func (*ChannelPresenceEvent) ProtoMessage

func (*ChannelPresenceEvent) ProtoMessage()

func (*ChannelPresenceEvent) ProtoReflect added in v1.8.0

func (x *ChannelPresenceEvent) ProtoReflect() protoreflect.Message

func (*ChannelPresenceEvent) Reset

func (x *ChannelPresenceEvent) Reset()

func (*ChannelPresenceEvent) String

func (x *ChannelPresenceEvent) String() string

type Envelope

type Envelope struct {
	Cid string `protobuf:"bytes,1,opt,name=cid,proto3" json:"cid,omitempty"`
	// Types that are assignable 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
	//	*Envelope_Ping
	//	*Envelope_Pong
	//	*Envelope_Party
	//	*Envelope_PartyCreate
	//	*Envelope_PartyJoin
	//	*Envelope_PartyLeave
	//	*Envelope_PartyPromote
	//	*Envelope_PartyLeader
	//	*Envelope_PartyAccept
	//	*Envelope_PartyRemove
	//	*Envelope_PartyClose
	//	*Envelope_PartyJoinRequestList
	//	*Envelope_PartyJoinRequest
	//	*Envelope_PartyMatchmakerAdd
	//	*Envelope_PartyMatchmakerRemove
	//	*Envelope_PartyMatchmakerTicket
	//	*Envelope_PartyData
	//	*Envelope_PartyDataSend
	//	*Envelope_PartyPresenceEvent
	Message isEnvelope_Message `protobuf_oneof:"message"`
	// contains filtered or unexported fields
}

An envelope for a realtime message.

func (*Envelope) Descriptor deprecated

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

Deprecated: Use Envelope.ProtoReflect.Descriptor instead.

func (*Envelope) GetChannel

func (x *Envelope) GetChannel() *Channel

func (*Envelope) GetChannelJoin

func (x *Envelope) GetChannelJoin() *ChannelJoin

func (*Envelope) GetChannelLeave

func (x *Envelope) GetChannelLeave() *ChannelLeave

func (*Envelope) GetChannelMessage

func (x *Envelope) GetChannelMessage() *api.ChannelMessage

func (*Envelope) GetChannelMessageAck

func (x *Envelope) GetChannelMessageAck() *ChannelMessageAck

func (*Envelope) GetChannelMessageRemove

func (x *Envelope) GetChannelMessageRemove() *ChannelMessageRemove

func (*Envelope) GetChannelMessageSend

func (x *Envelope) GetChannelMessageSend() *ChannelMessageSend

func (*Envelope) GetChannelMessageUpdate

func (x *Envelope) GetChannelMessageUpdate() *ChannelMessageUpdate

func (*Envelope) GetChannelPresenceEvent

func (x *Envelope) GetChannelPresenceEvent() *ChannelPresenceEvent

func (*Envelope) GetCid

func (x *Envelope) GetCid() string

func (*Envelope) GetError

func (x *Envelope) GetError() *Error

func (*Envelope) GetMatch

func (x *Envelope) GetMatch() *Match

func (*Envelope) GetMatchCreate

func (x *Envelope) GetMatchCreate() *MatchCreate

func (*Envelope) GetMatchData

func (x *Envelope) GetMatchData() *MatchData

func (*Envelope) GetMatchDataSend

func (x *Envelope) GetMatchDataSend() *MatchDataSend

func (*Envelope) GetMatchJoin

func (x *Envelope) GetMatchJoin() *MatchJoin

func (*Envelope) GetMatchLeave

func (x *Envelope) GetMatchLeave() *MatchLeave

func (*Envelope) GetMatchPresenceEvent

func (x *Envelope) GetMatchPresenceEvent() *MatchPresenceEvent

func (*Envelope) GetMatchmakerAdd

func (x *Envelope) GetMatchmakerAdd() *MatchmakerAdd

func (*Envelope) GetMatchmakerMatched

func (x *Envelope) GetMatchmakerMatched() *MatchmakerMatched

func (*Envelope) GetMatchmakerRemove

func (x *Envelope) GetMatchmakerRemove() *MatchmakerRemove

func (*Envelope) GetMatchmakerTicket

func (x *Envelope) GetMatchmakerTicket() *MatchmakerTicket

func (*Envelope) GetMessage

func (m *Envelope) GetMessage() isEnvelope_Message

func (*Envelope) GetNotifications

func (x *Envelope) GetNotifications() *Notifications

func (*Envelope) GetParty added in v1.11.0

func (x *Envelope) GetParty() *Party

func (*Envelope) GetPartyAccept added in v1.11.0

func (x *Envelope) GetPartyAccept() *PartyAccept

func (*Envelope) GetPartyClose added in v1.11.0

func (x *Envelope) GetPartyClose() *PartyClose

func (*Envelope) GetPartyCreate added in v1.11.0

func (x *Envelope) GetPartyCreate() *PartyCreate

func (*Envelope) GetPartyData added in v1.11.0

func (x *Envelope) GetPartyData() *PartyData

func (*Envelope) GetPartyDataSend added in v1.11.0

func (x *Envelope) GetPartyDataSend() *PartyDataSend

func (*Envelope) GetPartyJoin added in v1.11.0

func (x *Envelope) GetPartyJoin() *PartyJoin

func (*Envelope) GetPartyJoinRequest added in v1.11.0

func (x *Envelope) GetPartyJoinRequest() *PartyJoinRequest

func (*Envelope) GetPartyJoinRequestList added in v1.11.0

func (x *Envelope) GetPartyJoinRequestList() *PartyJoinRequestList

func (*Envelope) GetPartyLeader added in v1.11.0

func (x *Envelope) GetPartyLeader() *PartyLeader

func (*Envelope) GetPartyLeave added in v1.11.0

func (x *Envelope) GetPartyLeave() *PartyLeave

func (*Envelope) GetPartyMatchmakerAdd added in v1.11.0

func (x *Envelope) GetPartyMatchmakerAdd() *PartyMatchmakerAdd

func (*Envelope) GetPartyMatchmakerRemove added in v1.11.0

func (x *Envelope) GetPartyMatchmakerRemove() *PartyMatchmakerRemove

func (*Envelope) GetPartyMatchmakerTicket added in v1.11.0

func (x *Envelope) GetPartyMatchmakerTicket() *PartyMatchmakerTicket

func (*Envelope) GetPartyPresenceEvent added in v1.11.0

func (x *Envelope) GetPartyPresenceEvent() *PartyPresenceEvent

func (*Envelope) GetPartyPromote added in v1.11.0

func (x *Envelope) GetPartyPromote() *PartyPromote

func (*Envelope) GetPartyRemove added in v1.11.0

func (x *Envelope) GetPartyRemove() *PartyRemove

func (*Envelope) GetPing

func (x *Envelope) GetPing() *Ping

func (*Envelope) GetPong

func (x *Envelope) GetPong() *Pong

func (*Envelope) GetRpc

func (x *Envelope) GetRpc() *api.Rpc

func (*Envelope) GetStatus

func (x *Envelope) GetStatus() *Status

func (*Envelope) GetStatusFollow

func (x *Envelope) GetStatusFollow() *StatusFollow

func (*Envelope) GetStatusPresenceEvent

func (x *Envelope) GetStatusPresenceEvent() *StatusPresenceEvent

func (*Envelope) GetStatusUnfollow

func (x *Envelope) GetStatusUnfollow() *StatusUnfollow

func (*Envelope) GetStatusUpdate

func (x *Envelope) GetStatusUpdate() *StatusUpdate

func (*Envelope) GetStreamData

func (x *Envelope) GetStreamData() *StreamData

func (*Envelope) GetStreamPresenceEvent

func (x *Envelope) GetStreamPresenceEvent() *StreamPresenceEvent

func (*Envelope) ProtoMessage

func (*Envelope) ProtoMessage()

func (*Envelope) ProtoReflect added in v1.8.0

func (x *Envelope) ProtoReflect() protoreflect.Message

func (*Envelope) Reset

func (x *Envelope) Reset()

func (*Envelope) String

func (x *Envelope) String() string

type Envelope_Channel

type Envelope_Channel struct {
	// A response from a channel join operation.
	Channel *Channel `protobuf:"bytes,2,opt,name=channel,proto3,oneof"`
}

type Envelope_ChannelJoin

type Envelope_ChannelJoin struct {
	// Join a realtime chat channel.
	ChannelJoin *ChannelJoin `protobuf:"bytes,3,opt,name=channel_join,json=channelJoin,proto3,oneof"`
}

type Envelope_ChannelLeave

type Envelope_ChannelLeave struct {
	// Leave a realtime chat channel.
	ChannelLeave *ChannelLeave `protobuf:"bytes,4,opt,name=channel_leave,json=channelLeave,proto3,oneof"`
}

type Envelope_ChannelMessage

type Envelope_ChannelMessage struct {
	// An incoming message on a realtime chat channel.
	ChannelMessage *api.ChannelMessage `protobuf:"bytes,5,opt,name=channel_message,json=channelMessage,proto3,oneof"`
}

type Envelope_ChannelMessageAck

type Envelope_ChannelMessageAck struct {
	// An acknowledgement received in response to sending a message on a chat channel.
	ChannelMessageAck *ChannelMessageAck `protobuf:"bytes,6,opt,name=channel_message_ack,json=channelMessageAck,proto3,oneof"`
}

type Envelope_ChannelMessageRemove

type Envelope_ChannelMessageRemove struct {
	// Remove a message previously sent to a realtime chat channel.
	ChannelMessageRemove *ChannelMessageRemove `protobuf:"bytes,9,opt,name=channel_message_remove,json=channelMessageRemove,proto3,oneof"`
}

type Envelope_ChannelMessageSend

type Envelope_ChannelMessageSend struct {
	// Send a message to a realtime chat channel.
	ChannelMessageSend *ChannelMessageSend `protobuf:"bytes,7,opt,name=channel_message_send,json=channelMessageSend,proto3,oneof"`
}

type Envelope_ChannelMessageUpdate

type Envelope_ChannelMessageUpdate struct {
	// Update a message previously sent to a realtime chat channel.
	ChannelMessageUpdate *ChannelMessageUpdate `protobuf:"bytes,8,opt,name=channel_message_update,json=channelMessageUpdate,proto3,oneof"`
}

type Envelope_ChannelPresenceEvent

type Envelope_ChannelPresenceEvent struct {
	// Presence update for a particular realtime chat channel.
	ChannelPresenceEvent *ChannelPresenceEvent `protobuf:"bytes,10,opt,name=channel_presence_event,json=channelPresenceEvent,proto3,oneof"`
}

type Envelope_Error

type Envelope_Error struct {
	// Describes an error which occurred on the server.
	Error *Error `protobuf:"bytes,11,opt,name=error,proto3,oneof"`
}

type Envelope_Match

type Envelope_Match struct {
	// Incoming information about a realtime match.
	Match *Match `protobuf:"bytes,12,opt,name=match,proto3,oneof"`
}

type Envelope_MatchCreate

type Envelope_MatchCreate struct {
	// A client to server request to create a realtime match.
	MatchCreate *MatchCreate `protobuf:"bytes,13,opt,name=match_create,json=matchCreate,proto3,oneof"`
}

type Envelope_MatchData

type Envelope_MatchData struct {
	// Incoming realtime match data delivered from the server.
	MatchData *MatchData `protobuf:"bytes,14,opt,name=match_data,json=matchData,proto3,oneof"`
}

type Envelope_MatchDataSend

type Envelope_MatchDataSend struct {
	// A client to server request to send data to a realtime match.
	MatchDataSend *MatchDataSend `protobuf:"bytes,15,opt,name=match_data_send,json=matchDataSend,proto3,oneof"`
}

type Envelope_MatchJoin

type Envelope_MatchJoin struct {
	// A client to server request to join a realtime match.
	MatchJoin *MatchJoin `protobuf:"bytes,16,opt,name=match_join,json=matchJoin,proto3,oneof"`
}

type Envelope_MatchLeave

type Envelope_MatchLeave struct {
	// A client to server request to leave a realtime match.
	MatchLeave *MatchLeave `protobuf:"bytes,17,opt,name=match_leave,json=matchLeave,proto3,oneof"`
}

type Envelope_MatchPresenceEvent

type Envelope_MatchPresenceEvent struct {
	// Presence update for a particular realtime match.
	MatchPresenceEvent *MatchPresenceEvent `protobuf:"bytes,18,opt,name=match_presence_event,json=matchPresenceEvent,proto3,oneof"`
}

type Envelope_MatchmakerAdd

type Envelope_MatchmakerAdd struct {
	// Submit a new matchmaking process request.
	MatchmakerAdd *MatchmakerAdd `protobuf:"bytes,19,opt,name=matchmaker_add,json=matchmakerAdd,proto3,oneof"`
}

type Envelope_MatchmakerMatched

type Envelope_MatchmakerMatched struct {
	// A successful matchmaking result.
	MatchmakerMatched *MatchmakerMatched `protobuf:"bytes,20,opt,name=matchmaker_matched,json=matchmakerMatched,proto3,oneof"`
}

type Envelope_MatchmakerRemove

type Envelope_MatchmakerRemove struct {
	// Cancel a matchmaking process using a ticket.
	MatchmakerRemove *MatchmakerRemove `protobuf:"bytes,21,opt,name=matchmaker_remove,json=matchmakerRemove,proto3,oneof"`
}

type Envelope_MatchmakerTicket

type Envelope_MatchmakerTicket struct {
	// A response from starting a new matchmaking process.
	MatchmakerTicket *MatchmakerTicket `protobuf:"bytes,22,opt,name=matchmaker_ticket,json=matchmakerTicket,proto3,oneof"`
}

type Envelope_Notifications

type Envelope_Notifications struct {
	// Notifications send by the server.
	Notifications *Notifications `protobuf:"bytes,23,opt,name=notifications,proto3,oneof"`
}

type Envelope_Party added in v1.11.0

type Envelope_Party struct {
	// Incoming information about a party.
	Party *Party `protobuf:"bytes,34,opt,name=party,proto3,oneof"`
}

type Envelope_PartyAccept added in v1.11.0

type Envelope_PartyAccept struct {
	// Accept a request to join.
	PartyAccept *PartyAccept `protobuf:"bytes,40,opt,name=party_accept,json=partyAccept,proto3,oneof"`
}

type Envelope_PartyClose added in v1.11.0

type Envelope_PartyClose struct {
	// End a party, kicking all party members and closing it.
	PartyClose *PartyClose `protobuf:"bytes,42,opt,name=party_close,json=partyClose,proto3,oneof"`
}

type Envelope_PartyCreate added in v1.11.0

type Envelope_PartyCreate struct {
	// Create a party.
	PartyCreate *PartyCreate `protobuf:"bytes,35,opt,name=party_create,json=partyCreate,proto3,oneof"`
}

type Envelope_PartyData added in v1.11.0

type Envelope_PartyData struct {
	// Incoming party data delivered from the server.
	PartyData *PartyData `protobuf:"bytes,48,opt,name=party_data,json=partyData,proto3,oneof"`
}

type Envelope_PartyDataSend added in v1.11.0

type Envelope_PartyDataSend struct {
	// A client to server request to send data to a party.
	PartyDataSend *PartyDataSend `protobuf:"bytes,49,opt,name=party_data_send,json=partyDataSend,proto3,oneof"`
}

type Envelope_PartyJoin added in v1.11.0

type Envelope_PartyJoin struct {
	// Join a party, or request to join if the party is not open.
	PartyJoin *PartyJoin `protobuf:"bytes,36,opt,name=party_join,json=partyJoin,proto3,oneof"`
}

type Envelope_PartyJoinRequest added in v1.11.0

type Envelope_PartyJoinRequest struct {
	// Incoming notification for one or more new presences attempting to join the party.
	PartyJoinRequest *PartyJoinRequest `protobuf:"bytes,44,opt,name=party_join_request,json=partyJoinRequest,proto3,oneof"`
}

type Envelope_PartyJoinRequestList added in v1.11.0

type Envelope_PartyJoinRequestList struct {
	// Request a list of pending join requests for a party.
	PartyJoinRequestList *PartyJoinRequestList `protobuf:"bytes,43,opt,name=party_join_request_list,json=partyJoinRequestList,proto3,oneof"`
}

type Envelope_PartyLeader added in v1.11.0

type Envelope_PartyLeader struct {
	// Announcement of a new party leader.
	PartyLeader *PartyLeader `protobuf:"bytes,39,opt,name=party_leader,json=partyLeader,proto3,oneof"`
}

type Envelope_PartyLeave added in v1.11.0

type Envelope_PartyLeave struct {
	// Leave a party.
	PartyLeave *PartyLeave `protobuf:"bytes,37,opt,name=party_leave,json=partyLeave,proto3,oneof"`
}

type Envelope_PartyMatchmakerAdd added in v1.11.0

type Envelope_PartyMatchmakerAdd struct {
	// Begin matchmaking as a party.
	PartyMatchmakerAdd *PartyMatchmakerAdd `protobuf:"bytes,45,opt,name=party_matchmaker_add,json=partyMatchmakerAdd,proto3,oneof"`
}

type Envelope_PartyMatchmakerRemove added in v1.11.0

type Envelope_PartyMatchmakerRemove struct {
	// Cancel a party matchmaking process using a ticket.
	PartyMatchmakerRemove *PartyMatchmakerRemove `protobuf:"bytes,46,opt,name=party_matchmaker_remove,json=partyMatchmakerRemove,proto3,oneof"`
}

type Envelope_PartyMatchmakerTicket added in v1.11.0

type Envelope_PartyMatchmakerTicket struct {
	// A response from starting a new party matchmaking process.
	PartyMatchmakerTicket *PartyMatchmakerTicket `protobuf:"bytes,47,opt,name=party_matchmaker_ticket,json=partyMatchmakerTicket,proto3,oneof"`
}

type Envelope_PartyPresenceEvent added in v1.11.0

type Envelope_PartyPresenceEvent struct {
	// Presence update for a particular party.
	PartyPresenceEvent *PartyPresenceEvent `protobuf:"bytes,50,opt,name=party_presence_event,json=partyPresenceEvent,proto3,oneof"`
}

type Envelope_PartyPromote added in v1.11.0

type Envelope_PartyPromote struct {
	// Promote a new party leader.
	PartyPromote *PartyPromote `protobuf:"bytes,38,opt,name=party_promote,json=partyPromote,proto3,oneof"`
}

type Envelope_PartyRemove added in v1.11.0

type Envelope_PartyRemove struct {
	// Kick a party member, or decline a request to join.
	PartyRemove *PartyRemove `protobuf:"bytes,41,opt,name=party_remove,json=partyRemove,proto3,oneof"`
}

type Envelope_Ping

type Envelope_Ping struct {
	// Application-level heartbeat and connection check.
	Ping *Ping `protobuf:"bytes,32,opt,name=ping,proto3,oneof"`
}

type Envelope_Pong

type Envelope_Pong struct {
	// Application-level heartbeat and connection check response.
	Pong *Pong `protobuf:"bytes,33,opt,name=pong,proto3,oneof"`
}

type Envelope_Rpc

type Envelope_Rpc struct {
	// RPC call or response.
	Rpc *api.Rpc `protobuf:"bytes,24,opt,name=rpc,proto3,oneof"`
}

type Envelope_Status

type Envelope_Status struct {
	// An incoming status snapshot for some set of users.
	Status *Status `protobuf:"bytes,25,opt,name=status,proto3,oneof"`
}

type Envelope_StatusFollow

type Envelope_StatusFollow struct {
	// Start following some set of users to receive their status updates.
	StatusFollow *StatusFollow `protobuf:"bytes,26,opt,name=status_follow,json=statusFollow,proto3,oneof"`
}

type Envelope_StatusPresenceEvent

type Envelope_StatusPresenceEvent struct {
	// An incoming status update.
	StatusPresenceEvent *StatusPresenceEvent `protobuf:"bytes,27,opt,name=status_presence_event,json=statusPresenceEvent,proto3,oneof"`
}

type Envelope_StatusUnfollow

type Envelope_StatusUnfollow struct {
	// Stop following some set of users to no longer receive their status updates.
	StatusUnfollow *StatusUnfollow `protobuf:"bytes,28,opt,name=status_unfollow,json=statusUnfollow,proto3,oneof"`
}

type Envelope_StatusUpdate

type Envelope_StatusUpdate struct {
	// Set the user's own status.
	StatusUpdate *StatusUpdate `protobuf:"bytes,29,opt,name=status_update,json=statusUpdate,proto3,oneof"`
}

type Envelope_StreamData

type Envelope_StreamData struct {
	// A data message delivered over a stream.
	StreamData *StreamData `protobuf:"bytes,30,opt,name=stream_data,json=streamData,proto3,oneof"`
}

type Envelope_StreamPresenceEvent

type Envelope_StreamPresenceEvent struct {
	// Presence update for a particular stream.
	StreamPresenceEvent *StreamPresenceEvent `protobuf:"bytes,31,opt,name=stream_presence_event,json=streamPresenceEvent,proto3,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,proto3" json:"code,omitempty"`
	// A message in English to help developers debug the response.
	Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
	// Additional error details which may be different for each response.
	Context map[string]string `` /* 155-byte string literal not displayed */
	// contains filtered or unexported fields
}

A logical error which may occur on the server.

func (*Error) Descriptor deprecated

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

Deprecated: Use Error.ProtoReflect.Descriptor instead.

func (*Error) GetCode

func (x *Error) GetCode() int32

func (*Error) GetContext

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

func (*Error) GetMessage

func (x *Error) GetMessage() string

func (*Error) ProtoMessage

func (*Error) ProtoMessage()

func (*Error) ProtoReflect added in v1.8.0

func (x *Error) ProtoReflect() protoreflect.Message

func (*Error) Reset

func (x *Error) Reset()

func (*Error) String

func (x *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) Descriptor added in v1.8.0

func (Error_Code) Descriptor() protoreflect.EnumDescriptor

func (Error_Code) Enum added in v1.8.0

func (x Error_Code) Enum() *Error_Code

func (Error_Code) EnumDescriptor deprecated

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

Deprecated: Use Error_Code.Descriptor instead.

func (Error_Code) Number added in v1.8.0

func (x Error_Code) Number() protoreflect.EnumNumber

func (Error_Code) String

func (x Error_Code) String() string

func (Error_Code) Type added in v1.8.0

type Match

type Match struct {

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

A realtime match.

func (*Match) Descriptor deprecated

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

Deprecated: Use Match.ProtoReflect.Descriptor instead.

func (*Match) GetAuthoritative

func (x *Match) GetAuthoritative() bool

func (*Match) GetLabel

func (x *Match) GetLabel() *wrapperspb.StringValue

func (*Match) GetMatchId

func (x *Match) GetMatchId() string

func (*Match) GetPresences

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

func (*Match) GetSelf

func (x *Match) GetSelf() *UserPresence

func (*Match) GetSize

func (x *Match) GetSize() int32

func (*Match) ProtoMessage

func (*Match) ProtoMessage()

func (*Match) ProtoReflect added in v1.8.0

func (x *Match) ProtoReflect() protoreflect.Message

func (*Match) Reset

func (x *Match) Reset()

func (*Match) String

func (x *Match) String() string

type MatchCreate

type MatchCreate struct {

	// Optional name to use when creating the match.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Create a new realtime match.

func (*MatchCreate) Descriptor deprecated

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

Deprecated: Use MatchCreate.ProtoReflect.Descriptor instead.

func (*MatchCreate) GetName added in v1.20.0

func (x *MatchCreate) GetName() string

func (*MatchCreate) ProtoMessage

func (*MatchCreate) ProtoMessage()

func (*MatchCreate) ProtoReflect added in v1.8.0

func (x *MatchCreate) ProtoReflect() protoreflect.Message

func (*MatchCreate) Reset

func (x *MatchCreate) Reset()

func (*MatchCreate) String

func (x *MatchCreate) String() string

type MatchData

type MatchData struct {

	// The match unique ID.
	MatchId string `protobuf:"bytes,1,opt,name=match_id,json=matchId,proto3" json:"match_id,omitempty"`
	// A reference to the user presence that sent this data, if any.
	Presence *UserPresence `protobuf:"bytes,2,opt,name=presence,proto3" json:"presence,omitempty"`
	// Op code value.
	OpCode int64 `protobuf:"varint,3,opt,name=op_code,json=opCode,proto3" json:"op_code,omitempty"`
	// Data payload, if any.
	Data []byte `protobuf:"bytes,4,opt,name=data,proto3" json:"data,omitempty"`
	// True if this data was delivered reliably, false otherwise.
	Reliable bool `protobuf:"varint,5,opt,name=reliable,proto3" json:"reliable,omitempty"`
	// contains filtered or unexported fields
}

Realtime match data received from the server.

func (*MatchData) Descriptor deprecated

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

Deprecated: Use MatchData.ProtoReflect.Descriptor instead.

func (*MatchData) GetData

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

func (*MatchData) GetMatchId

func (x *MatchData) GetMatchId() string

func (*MatchData) GetOpCode

func (x *MatchData) GetOpCode() int64

func (*MatchData) GetPresence

func (x *MatchData) GetPresence() *UserPresence

func (*MatchData) GetReliable

func (x *MatchData) GetReliable() bool

func (*MatchData) ProtoMessage

func (*MatchData) ProtoMessage()

func (*MatchData) ProtoReflect added in v1.8.0

func (x *MatchData) ProtoReflect() protoreflect.Message

func (*MatchData) Reset

func (x *MatchData) Reset()

func (*MatchData) String

func (x *MatchData) String() string

type MatchDataSend

type MatchDataSend struct {

	// The match unique ID.
	MatchId string `protobuf:"bytes,1,opt,name=match_id,json=matchId,proto3" json:"match_id,omitempty"`
	// Op code value.
	OpCode int64 `protobuf:"varint,2,opt,name=op_code,json=opCode,proto3" 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,proto3" json:"presences,omitempty"`
	// True if the data should be sent reliably, false otherwise.
	Reliable bool `protobuf:"varint,5,opt,name=reliable,proto3" json:"reliable,omitempty"`
	// contains filtered or unexported fields
}

Send realtime match data to the server.

func (*MatchDataSend) Descriptor deprecated

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

Deprecated: Use MatchDataSend.ProtoReflect.Descriptor instead.

func (*MatchDataSend) GetData

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

func (*MatchDataSend) GetMatchId

func (x *MatchDataSend) GetMatchId() string

func (*MatchDataSend) GetOpCode

func (x *MatchDataSend) GetOpCode() int64

func (*MatchDataSend) GetPresences

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

func (*MatchDataSend) GetReliable

func (x *MatchDataSend) GetReliable() bool

func (*MatchDataSend) ProtoMessage

func (*MatchDataSend) ProtoMessage()

func (*MatchDataSend) ProtoReflect added in v1.8.0

func (x *MatchDataSend) ProtoReflect() protoreflect.Message

func (*MatchDataSend) Reset

func (x *MatchDataSend) Reset()

func (*MatchDataSend) String

func (x *MatchDataSend) String() string

type MatchJoin

type MatchJoin struct {

	// Types that are assignable to Id:
	//
	//	*MatchJoin_MatchId
	//	*MatchJoin_Token
	Id isMatchJoin_Id `protobuf_oneof:"id"`
	// An optional set of key-value metadata pairs to be passed to the match handler, if any.
	Metadata map[string]string `` /* 157-byte string literal not displayed */
	// contains filtered or unexported fields
}

Join an existing realtime match.

func (*MatchJoin) Descriptor deprecated

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

Deprecated: Use MatchJoin.ProtoReflect.Descriptor instead.

func (*MatchJoin) GetId

func (m *MatchJoin) GetId() isMatchJoin_Id

func (*MatchJoin) GetMatchId

func (x *MatchJoin) GetMatchId() string

func (*MatchJoin) GetMetadata

func (x *MatchJoin) GetMetadata() map[string]string

func (*MatchJoin) GetToken

func (x *MatchJoin) GetToken() string

func (*MatchJoin) ProtoMessage

func (*MatchJoin) ProtoMessage()

func (*MatchJoin) ProtoReflect added in v1.8.0

func (x *MatchJoin) ProtoReflect() protoreflect.Message

func (*MatchJoin) Reset

func (x *MatchJoin) Reset()

func (*MatchJoin) String

func (x *MatchJoin) String() string

type MatchJoin_MatchId

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

type MatchJoin_Token

type MatchJoin_Token struct {
	// A matchmaking result token.
	Token string `protobuf:"bytes,2,opt,name=token,proto3,oneof"`
}

type MatchLeave

type MatchLeave struct {

	// The match unique ID.
	MatchId string `protobuf:"bytes,1,opt,name=match_id,json=matchId,proto3" json:"match_id,omitempty"`
	// contains filtered or unexported fields
}

Leave a realtime match.

func (*MatchLeave) Descriptor deprecated

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

Deprecated: Use MatchLeave.ProtoReflect.Descriptor instead.

func (*MatchLeave) GetMatchId

func (x *MatchLeave) GetMatchId() string

func (*MatchLeave) ProtoMessage

func (*MatchLeave) ProtoMessage()

func (*MatchLeave) ProtoReflect added in v1.8.0

func (x *MatchLeave) ProtoReflect() protoreflect.Message

func (*MatchLeave) Reset

func (x *MatchLeave) Reset()

func (*MatchLeave) String

func (x *MatchLeave) String() string

type MatchPresenceEvent

type MatchPresenceEvent struct {

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

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

func (*MatchPresenceEvent) Descriptor deprecated

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

Deprecated: Use MatchPresenceEvent.ProtoReflect.Descriptor instead.

func (*MatchPresenceEvent) GetJoins

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

func (*MatchPresenceEvent) GetLeaves

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

func (*MatchPresenceEvent) GetMatchId

func (x *MatchPresenceEvent) GetMatchId() string

func (*MatchPresenceEvent) ProtoMessage

func (*MatchPresenceEvent) ProtoMessage()

func (*MatchPresenceEvent) ProtoReflect added in v1.8.0

func (x *MatchPresenceEvent) ProtoReflect() protoreflect.Message

func (*MatchPresenceEvent) Reset

func (x *MatchPresenceEvent) Reset()

func (*MatchPresenceEvent) String

func (x *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,proto3" json:"min_count,omitempty"`
	// Maximum total user count to match together.
	MaxCount int32 `protobuf:"varint,2,opt,name=max_count,json=maxCount,proto3" json:"max_count,omitempty"`
	// Filter query used to identify suitable users.
	Query string `protobuf:"bytes,3,opt,name=query,proto3" json:"query,omitempty"`
	// String properties.
	StringProperties map[string]string `` /* 197-byte string literal not displayed */
	// Numeric properties.
	NumericProperties map[string]float64 `` /* 202-byte string literal not displayed */
	// Optional multiple of the count that must be satisfied.
	CountMultiple *wrapperspb.Int32Value `protobuf:"bytes,6,opt,name=count_multiple,json=countMultiple,proto3" json:"count_multiple,omitempty"`
	// contains filtered or unexported fields
}

Start a new matchmaking process.

func (*MatchmakerAdd) Descriptor deprecated

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

Deprecated: Use MatchmakerAdd.ProtoReflect.Descriptor instead.

func (*MatchmakerAdd) GetCountMultiple added in v1.22.0

func (x *MatchmakerAdd) GetCountMultiple() *wrapperspb.Int32Value

func (*MatchmakerAdd) GetMaxCount

func (x *MatchmakerAdd) GetMaxCount() int32

func (*MatchmakerAdd) GetMinCount

func (x *MatchmakerAdd) GetMinCount() int32

func (*MatchmakerAdd) GetNumericProperties

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

func (*MatchmakerAdd) GetQuery

func (x *MatchmakerAdd) GetQuery() string

func (*MatchmakerAdd) GetStringProperties

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

func (*MatchmakerAdd) ProtoMessage

func (*MatchmakerAdd) ProtoMessage()

func (*MatchmakerAdd) ProtoReflect added in v1.8.0

func (x *MatchmakerAdd) ProtoReflect() protoreflect.Message

func (*MatchmakerAdd) Reset

func (x *MatchmakerAdd) Reset()

func (*MatchmakerAdd) String

func (x *MatchmakerAdd) String() string

type MatchmakerMatched

type MatchmakerMatched struct {

	// The matchmaking ticket that has completed.
	Ticket string `protobuf:"bytes,1,opt,name=ticket,proto3" json:"ticket,omitempty"`
	// The match token or match ID to join.
	//
	// Types that are assignable 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,proto3" json:"users,omitempty"`
	// A reference to the current user and their properties.
	Self *MatchmakerMatched_MatchmakerUser `protobuf:"bytes,5,opt,name=self,proto3" json:"self,omitempty"`
	// contains filtered or unexported fields
}

A successful matchmaking result.

func (*MatchmakerMatched) Descriptor deprecated

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

Deprecated: Use MatchmakerMatched.ProtoReflect.Descriptor instead.

func (*MatchmakerMatched) GetId

func (m *MatchmakerMatched) GetId() isMatchmakerMatched_Id

func (*MatchmakerMatched) GetMatchId

func (x *MatchmakerMatched) GetMatchId() string

func (*MatchmakerMatched) GetSelf

func (*MatchmakerMatched) GetTicket

func (x *MatchmakerMatched) GetTicket() string

func (*MatchmakerMatched) GetToken

func (x *MatchmakerMatched) GetToken() string

func (*MatchmakerMatched) GetUsers

func (*MatchmakerMatched) ProtoMessage

func (*MatchmakerMatched) ProtoMessage()

func (*MatchmakerMatched) ProtoReflect added in v1.8.0

func (x *MatchmakerMatched) ProtoReflect() protoreflect.Message

func (*MatchmakerMatched) Reset

func (x *MatchmakerMatched) Reset()

func (*MatchmakerMatched) String

func (x *MatchmakerMatched) String() string

type MatchmakerMatched_MatchId

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

type MatchmakerMatched_MatchmakerUser

type MatchmakerMatched_MatchmakerUser struct {

	// User info.
	Presence *UserPresence `protobuf:"bytes,1,opt,name=presence,proto3" json:"presence,omitempty"`
	// Party identifier, if this user was matched as a party member.
	PartyId string `protobuf:"bytes,2,opt,name=party_id,json=partyId,proto3" json:"party_id,omitempty"`
	// String properties.
	StringProperties map[string]string `` /* 197-byte string literal not displayed */
	// Numeric properties.
	NumericProperties map[string]float64 `` /* 202-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*MatchmakerMatched_MatchmakerUser) Descriptor deprecated

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

Deprecated: Use MatchmakerMatched_MatchmakerUser.ProtoReflect.Descriptor instead.

func (*MatchmakerMatched_MatchmakerUser) GetNumericProperties

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

func (*MatchmakerMatched_MatchmakerUser) GetPartyId added in v1.11.0

func (x *MatchmakerMatched_MatchmakerUser) GetPartyId() string

func (*MatchmakerMatched_MatchmakerUser) GetPresence

func (*MatchmakerMatched_MatchmakerUser) GetStringProperties

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

func (*MatchmakerMatched_MatchmakerUser) ProtoMessage

func (*MatchmakerMatched_MatchmakerUser) ProtoMessage()

func (*MatchmakerMatched_MatchmakerUser) ProtoReflect added in v1.8.0

func (*MatchmakerMatched_MatchmakerUser) Reset

func (*MatchmakerMatched_MatchmakerUser) String

type MatchmakerMatched_Token

type MatchmakerMatched_Token struct {
	// Match join token.
	Token string `protobuf:"bytes,3,opt,name=token,proto3,oneof"`
}

type MatchmakerRemove

type MatchmakerRemove struct {

	// The ticket to cancel.
	Ticket string `protobuf:"bytes,1,opt,name=ticket,proto3" json:"ticket,omitempty"`
	// contains filtered or unexported fields
}

Cancel an existing ongoing matchmaking process.

func (*MatchmakerRemove) Descriptor deprecated

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

Deprecated: Use MatchmakerRemove.ProtoReflect.Descriptor instead.

func (*MatchmakerRemove) GetTicket

func (x *MatchmakerRemove) GetTicket() string

func (*MatchmakerRemove) ProtoMessage

func (*MatchmakerRemove) ProtoMessage()

func (*MatchmakerRemove) ProtoReflect added in v1.8.0

func (x *MatchmakerRemove) ProtoReflect() protoreflect.Message

func (*MatchmakerRemove) Reset

func (x *MatchmakerRemove) Reset()

func (*MatchmakerRemove) String

func (x *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,proto3" json:"ticket,omitempty"`
	// contains filtered or unexported fields
}

A ticket representing a new matchmaking process.

func (*MatchmakerTicket) Descriptor deprecated

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

Deprecated: Use MatchmakerTicket.ProtoReflect.Descriptor instead.

func (*MatchmakerTicket) GetTicket

func (x *MatchmakerTicket) GetTicket() string

func (*MatchmakerTicket) ProtoMessage

func (*MatchmakerTicket) ProtoMessage()

func (*MatchmakerTicket) ProtoReflect added in v1.8.0

func (x *MatchmakerTicket) ProtoReflect() protoreflect.Message

func (*MatchmakerTicket) Reset

func (x *MatchmakerTicket) Reset()

func (*MatchmakerTicket) String

func (x *MatchmakerTicket) String() string

type Notifications

type Notifications struct {

	// Collection of notifications.
	Notifications []*api.Notification `protobuf:"bytes,1,rep,name=notifications,proto3" json:"notifications,omitempty"`
	// contains filtered or unexported fields
}

A collection of zero or more notifications.

func (*Notifications) Descriptor deprecated

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

Deprecated: Use Notifications.ProtoReflect.Descriptor instead.

func (*Notifications) GetNotifications

func (x *Notifications) GetNotifications() []*api.Notification

func (*Notifications) ProtoMessage

func (*Notifications) ProtoMessage()

func (*Notifications) ProtoReflect added in v1.8.0

func (x *Notifications) ProtoReflect() protoreflect.Message

func (*Notifications) Reset

func (x *Notifications) Reset()

func (*Notifications) String

func (x *Notifications) String() string

type Party added in v1.11.0

type Party struct {

	// Unique party identifier.
	PartyId string `protobuf:"bytes,1,opt,name=party_id,json=partyId,proto3" json:"party_id,omitempty"`
	// Open flag.
	Open bool `protobuf:"varint,2,opt,name=open,proto3" json:"open,omitempty"`
	// Maximum number of party members.
	MaxSize int32 `protobuf:"varint,3,opt,name=max_size,json=maxSize,proto3" json:"max_size,omitempty"`
	// Self.
	Self *UserPresence `protobuf:"bytes,4,opt,name=self,proto3" json:"self,omitempty"`
	// Leader.
	Leader *UserPresence `protobuf:"bytes,5,opt,name=leader,proto3" json:"leader,omitempty"`
	// All current party members.
	Presences []*UserPresence `protobuf:"bytes,6,rep,name=presences,proto3" json:"presences,omitempty"`
	// contains filtered or unexported fields
}

Incoming information about a party.

func (*Party) Descriptor deprecated added in v1.11.0

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

Deprecated: Use Party.ProtoReflect.Descriptor instead.

func (*Party) GetLeader added in v1.11.0

func (x *Party) GetLeader() *UserPresence

func (*Party) GetMaxSize added in v1.11.0

func (x *Party) GetMaxSize() int32

func (*Party) GetOpen added in v1.11.0

func (x *Party) GetOpen() bool

func (*Party) GetPartyId added in v1.11.0

func (x *Party) GetPartyId() string

func (*Party) GetPresences added in v1.11.0

func (x *Party) GetPresences() []*UserPresence

func (*Party) GetSelf added in v1.11.0

func (x *Party) GetSelf() *UserPresence

func (*Party) ProtoMessage added in v1.11.0

func (*Party) ProtoMessage()

func (*Party) ProtoReflect added in v1.11.0

func (x *Party) ProtoReflect() protoreflect.Message

func (*Party) Reset added in v1.11.0

func (x *Party) Reset()

func (*Party) String added in v1.11.0

func (x *Party) String() string

type PartyAccept added in v1.11.0

type PartyAccept struct {

	// Party ID to accept a join request for.
	PartyId string `protobuf:"bytes,1,opt,name=party_id,json=partyId,proto3" json:"party_id,omitempty"`
	// The presence to accept as a party member.
	Presence *UserPresence `protobuf:"bytes,2,opt,name=presence,proto3" json:"presence,omitempty"`
	// contains filtered or unexported fields
}

Accept a request to join.

func (*PartyAccept) Descriptor deprecated added in v1.11.0

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

Deprecated: Use PartyAccept.ProtoReflect.Descriptor instead.

func (*PartyAccept) GetPartyId added in v1.11.0

func (x *PartyAccept) GetPartyId() string

func (*PartyAccept) GetPresence added in v1.11.0

func (x *PartyAccept) GetPresence() *UserPresence

func (*PartyAccept) ProtoMessage added in v1.11.0

func (*PartyAccept) ProtoMessage()

func (*PartyAccept) ProtoReflect added in v1.11.0

func (x *PartyAccept) ProtoReflect() protoreflect.Message

func (*PartyAccept) Reset added in v1.11.0

func (x *PartyAccept) Reset()

func (*PartyAccept) String added in v1.11.0

func (x *PartyAccept) String() string

type PartyClose added in v1.11.0

type PartyClose struct {

	// Party ID to close.
	PartyId string `protobuf:"bytes,1,opt,name=party_id,json=partyId,proto3" json:"party_id,omitempty"`
	// contains filtered or unexported fields
}

End a party, kicking all party members and closing it.

func (*PartyClose) Descriptor deprecated added in v1.11.0

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

Deprecated: Use PartyClose.ProtoReflect.Descriptor instead.

func (*PartyClose) GetPartyId added in v1.11.0

func (x *PartyClose) GetPartyId() string

func (*PartyClose) ProtoMessage added in v1.11.0

func (*PartyClose) ProtoMessage()

func (*PartyClose) ProtoReflect added in v1.11.0

func (x *PartyClose) ProtoReflect() protoreflect.Message

func (*PartyClose) Reset added in v1.11.0

func (x *PartyClose) Reset()

func (*PartyClose) String added in v1.11.0

func (x *PartyClose) String() string

type PartyCreate added in v1.11.0

type PartyCreate struct {

	// Whether or not the party will require join requests to be approved by the party leader.
	Open bool `protobuf:"varint,1,opt,name=open,proto3" json:"open,omitempty"`
	// Maximum number of party members.
	MaxSize int32 `protobuf:"varint,2,opt,name=max_size,json=maxSize,proto3" json:"max_size,omitempty"`
	// contains filtered or unexported fields
}

Create a party.

func (*PartyCreate) Descriptor deprecated added in v1.11.0

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

Deprecated: Use PartyCreate.ProtoReflect.Descriptor instead.

func (*PartyCreate) GetMaxSize added in v1.11.0

func (x *PartyCreate) GetMaxSize() int32

func (*PartyCreate) GetOpen added in v1.11.0

func (x *PartyCreate) GetOpen() bool

func (*PartyCreate) ProtoMessage added in v1.11.0

func (*PartyCreate) ProtoMessage()

func (*PartyCreate) ProtoReflect added in v1.11.0

func (x *PartyCreate) ProtoReflect() protoreflect.Message

func (*PartyCreate) Reset added in v1.11.0

func (x *PartyCreate) Reset()

func (*PartyCreate) String added in v1.11.0

func (x *PartyCreate) String() string

type PartyData added in v1.11.0

type PartyData struct {

	// The party ID.
	PartyId string `protobuf:"bytes,1,opt,name=party_id,json=partyId,proto3" json:"party_id,omitempty"`
	// A reference to the user presence that sent this data, if any.
	Presence *UserPresence `protobuf:"bytes,2,opt,name=presence,proto3" json:"presence,omitempty"`
	// Op code value.
	OpCode int64 `protobuf:"varint,3,opt,name=op_code,json=opCode,proto3" json:"op_code,omitempty"`
	// Data payload, if any.
	Data []byte `protobuf:"bytes,4,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

Incoming party data delivered from the server.

func (*PartyData) Descriptor deprecated added in v1.11.0

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

Deprecated: Use PartyData.ProtoReflect.Descriptor instead.

func (*PartyData) GetData added in v1.11.0

func (x *PartyData) GetData() []byte

func (*PartyData) GetOpCode added in v1.11.0

func (x *PartyData) GetOpCode() int64

func (*PartyData) GetPartyId added in v1.11.0

func (x *PartyData) GetPartyId() string

func (*PartyData) GetPresence added in v1.11.0

func (x *PartyData) GetPresence() *UserPresence

func (*PartyData) ProtoMessage added in v1.11.0

func (*PartyData) ProtoMessage()

func (*PartyData) ProtoReflect added in v1.11.0

func (x *PartyData) ProtoReflect() protoreflect.Message

func (*PartyData) Reset added in v1.11.0

func (x *PartyData) Reset()

func (*PartyData) String added in v1.11.0

func (x *PartyData) String() string

type PartyDataSend added in v1.11.0

type PartyDataSend struct {

	// Party ID to send to.
	PartyId string `protobuf:"bytes,1,opt,name=party_id,json=partyId,proto3" json:"party_id,omitempty"`
	// Op code value.
	OpCode int64 `protobuf:"varint,2,opt,name=op_code,json=opCode,proto3" json:"op_code,omitempty"`
	// Data payload, if any.
	Data []byte `protobuf:"bytes,3,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

Send data to a party.

func (*PartyDataSend) Descriptor deprecated added in v1.11.0

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

Deprecated: Use PartyDataSend.ProtoReflect.Descriptor instead.

func (*PartyDataSend) GetData added in v1.11.0

func (x *PartyDataSend) GetData() []byte

func (*PartyDataSend) GetOpCode added in v1.11.0

func (x *PartyDataSend) GetOpCode() int64

func (*PartyDataSend) GetPartyId added in v1.11.0

func (x *PartyDataSend) GetPartyId() string

func (*PartyDataSend) ProtoMessage added in v1.11.0

func (*PartyDataSend) ProtoMessage()

func (*PartyDataSend) ProtoReflect added in v1.11.0

func (x *PartyDataSend) ProtoReflect() protoreflect.Message

func (*PartyDataSend) Reset added in v1.11.0

func (x *PartyDataSend) Reset()

func (*PartyDataSend) String added in v1.11.0

func (x *PartyDataSend) String() string

type PartyJoin added in v1.11.0

type PartyJoin struct {

	// Party ID to join.
	PartyId string `protobuf:"bytes,1,opt,name=party_id,json=partyId,proto3" json:"party_id,omitempty"`
	// contains filtered or unexported fields
}

Join a party, or request to join if the party is not open.

func (*PartyJoin) Descriptor deprecated added in v1.11.0

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

Deprecated: Use PartyJoin.ProtoReflect.Descriptor instead.

func (*PartyJoin) GetPartyId added in v1.11.0

func (x *PartyJoin) GetPartyId() string

func (*PartyJoin) ProtoMessage added in v1.11.0

func (*PartyJoin) ProtoMessage()

func (*PartyJoin) ProtoReflect added in v1.11.0

func (x *PartyJoin) ProtoReflect() protoreflect.Message

func (*PartyJoin) Reset added in v1.11.0

func (x *PartyJoin) Reset()

func (*PartyJoin) String added in v1.11.0

func (x *PartyJoin) String() string

type PartyJoinRequest added in v1.11.0

type PartyJoinRequest struct {

	// Party ID these presences are attempting to join.
	PartyId string `protobuf:"bytes,1,opt,name=party_id,json=partyId,proto3" json:"party_id,omitempty"`
	// Presences attempting to join.
	Presences []*UserPresence `protobuf:"bytes,2,rep,name=presences,proto3" json:"presences,omitempty"`
	// contains filtered or unexported fields
}

Incoming notification for one or more new presences attempting to join the party.

func (*PartyJoinRequest) Descriptor deprecated added in v1.11.0

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

Deprecated: Use PartyJoinRequest.ProtoReflect.Descriptor instead.

func (*PartyJoinRequest) GetPartyId added in v1.11.0

func (x *PartyJoinRequest) GetPartyId() string

func (*PartyJoinRequest) GetPresences added in v1.11.0

func (x *PartyJoinRequest) GetPresences() []*UserPresence

func (*PartyJoinRequest) ProtoMessage added in v1.11.0

func (*PartyJoinRequest) ProtoMessage()

func (*PartyJoinRequest) ProtoReflect added in v1.11.0

func (x *PartyJoinRequest) ProtoReflect() protoreflect.Message

func (*PartyJoinRequest) Reset added in v1.11.0

func (x *PartyJoinRequest) Reset()

func (*PartyJoinRequest) String added in v1.11.0

func (x *PartyJoinRequest) String() string

type PartyJoinRequestList added in v1.11.0

type PartyJoinRequestList struct {

	// Party ID to get a list of join requests for.
	PartyId string `protobuf:"bytes,1,opt,name=party_id,json=partyId,proto3" json:"party_id,omitempty"`
	// contains filtered or unexported fields
}

Request a list of pending join requests for a party.

func (*PartyJoinRequestList) Descriptor deprecated added in v1.11.0

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

Deprecated: Use PartyJoinRequestList.ProtoReflect.Descriptor instead.

func (*PartyJoinRequestList) GetPartyId added in v1.11.0

func (x *PartyJoinRequestList) GetPartyId() string

func (*PartyJoinRequestList) ProtoMessage added in v1.11.0

func (*PartyJoinRequestList) ProtoMessage()

func (*PartyJoinRequestList) ProtoReflect added in v1.11.0

func (x *PartyJoinRequestList) ProtoReflect() protoreflect.Message

func (*PartyJoinRequestList) Reset added in v1.11.0

func (x *PartyJoinRequestList) Reset()

func (*PartyJoinRequestList) String added in v1.11.0

func (x *PartyJoinRequestList) String() string

type PartyLeader added in v1.11.0

type PartyLeader struct {

	// Party ID to announce the new leader for.
	PartyId string `protobuf:"bytes,1,opt,name=party_id,json=partyId,proto3" json:"party_id,omitempty"`
	// The presence of the new party leader.
	Presence *UserPresence `protobuf:"bytes,2,opt,name=presence,proto3" json:"presence,omitempty"`
	// contains filtered or unexported fields
}

Announcement of a new party leader.

func (*PartyLeader) Descriptor deprecated added in v1.11.0

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

Deprecated: Use PartyLeader.ProtoReflect.Descriptor instead.

func (*PartyLeader) GetPartyId added in v1.11.0

func (x *PartyLeader) GetPartyId() string

func (*PartyLeader) GetPresence added in v1.11.0

func (x *PartyLeader) GetPresence() *UserPresence

func (*PartyLeader) ProtoMessage added in v1.11.0

func (*PartyLeader) ProtoMessage()

func (*PartyLeader) ProtoReflect added in v1.11.0

func (x *PartyLeader) ProtoReflect() protoreflect.Message

func (*PartyLeader) Reset added in v1.11.0

func (x *PartyLeader) Reset()

func (*PartyLeader) String added in v1.11.0

func (x *PartyLeader) String() string

type PartyLeave added in v1.11.0

type PartyLeave struct {

	// Party ID to leave.
	PartyId string `protobuf:"bytes,1,opt,name=party_id,json=partyId,proto3" json:"party_id,omitempty"`
	// contains filtered or unexported fields
}

Leave a party.

func (*PartyLeave) Descriptor deprecated added in v1.11.0

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

Deprecated: Use PartyLeave.ProtoReflect.Descriptor instead.

func (*PartyLeave) GetPartyId added in v1.11.0

func (x *PartyLeave) GetPartyId() string

func (*PartyLeave) ProtoMessage added in v1.11.0

func (*PartyLeave) ProtoMessage()

func (*PartyLeave) ProtoReflect added in v1.11.0

func (x *PartyLeave) ProtoReflect() protoreflect.Message

func (*PartyLeave) Reset added in v1.11.0

func (x *PartyLeave) Reset()

func (*PartyLeave) String added in v1.11.0

func (x *PartyLeave) String() string

type PartyMatchmakerAdd added in v1.11.0

type PartyMatchmakerAdd struct {

	// Party ID.
	PartyId string `protobuf:"bytes,1,opt,name=party_id,json=partyId,proto3" json:"party_id,omitempty"`
	// Minimum total user count to match together.
	MinCount int32 `protobuf:"varint,2,opt,name=min_count,json=minCount,proto3" json:"min_count,omitempty"`
	// Maximum total user count to match together.
	MaxCount int32 `protobuf:"varint,3,opt,name=max_count,json=maxCount,proto3" json:"max_count,omitempty"`
	// Filter query used to identify suitable users.
	Query string `protobuf:"bytes,4,opt,name=query,proto3" json:"query,omitempty"`
	// String properties.
	StringProperties map[string]string `` /* 197-byte string literal not displayed */
	// Numeric properties.
	NumericProperties map[string]float64 `` /* 202-byte string literal not displayed */
	// Optional multiple of the count that must be satisfied.
	CountMultiple *wrapperspb.Int32Value `protobuf:"bytes,7,opt,name=count_multiple,json=countMultiple,proto3" json:"count_multiple,omitempty"`
	// contains filtered or unexported fields
}

Begin matchmaking as a party.

func (*PartyMatchmakerAdd) Descriptor deprecated added in v1.11.0

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

Deprecated: Use PartyMatchmakerAdd.ProtoReflect.Descriptor instead.

func (*PartyMatchmakerAdd) GetCountMultiple added in v1.22.0

func (x *PartyMatchmakerAdd) GetCountMultiple() *wrapperspb.Int32Value

func (*PartyMatchmakerAdd) GetMaxCount added in v1.11.0

func (x *PartyMatchmakerAdd) GetMaxCount() int32

func (*PartyMatchmakerAdd) GetMinCount added in v1.11.0

func (x *PartyMatchmakerAdd) GetMinCount() int32

func (*PartyMatchmakerAdd) GetNumericProperties added in v1.11.0

func (x *PartyMatchmakerAdd) GetNumericProperties() map[string]float64

func (*PartyMatchmakerAdd) GetPartyId added in v1.11.0

func (x *PartyMatchmakerAdd) GetPartyId() string

func (*PartyMatchmakerAdd) GetQuery added in v1.11.0

func (x *PartyMatchmakerAdd) GetQuery() string

func (*PartyMatchmakerAdd) GetStringProperties added in v1.11.0

func (x *PartyMatchmakerAdd) GetStringProperties() map[string]string

func (*PartyMatchmakerAdd) ProtoMessage added in v1.11.0

func (*PartyMatchmakerAdd) ProtoMessage()

func (*PartyMatchmakerAdd) ProtoReflect added in v1.11.0

func (x *PartyMatchmakerAdd) ProtoReflect() protoreflect.Message

func (*PartyMatchmakerAdd) Reset added in v1.11.0

func (x *PartyMatchmakerAdd) Reset()

func (*PartyMatchmakerAdd) String added in v1.11.0

func (x *PartyMatchmakerAdd) String() string

type PartyMatchmakerRemove added in v1.11.0

type PartyMatchmakerRemove struct {

	// Party ID.
	PartyId string `protobuf:"bytes,1,opt,name=party_id,json=partyId,proto3" json:"party_id,omitempty"`
	// The ticket to cancel.
	Ticket string `protobuf:"bytes,2,opt,name=ticket,proto3" json:"ticket,omitempty"`
	// contains filtered or unexported fields
}

Cancel a party matchmaking process using a ticket.

func (*PartyMatchmakerRemove) Descriptor deprecated added in v1.11.0

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

Deprecated: Use PartyMatchmakerRemove.ProtoReflect.Descriptor instead.

func (*PartyMatchmakerRemove) GetPartyId added in v1.11.0

func (x *PartyMatchmakerRemove) GetPartyId() string

func (*PartyMatchmakerRemove) GetTicket added in v1.11.0

func (x *PartyMatchmakerRemove) GetTicket() string

func (*PartyMatchmakerRemove) ProtoMessage added in v1.11.0

func (*PartyMatchmakerRemove) ProtoMessage()

func (*PartyMatchmakerRemove) ProtoReflect added in v1.11.0

func (x *PartyMatchmakerRemove) ProtoReflect() protoreflect.Message

func (*PartyMatchmakerRemove) Reset added in v1.11.0

func (x *PartyMatchmakerRemove) Reset()

func (*PartyMatchmakerRemove) String added in v1.11.0

func (x *PartyMatchmakerRemove) String() string

type PartyMatchmakerTicket added in v1.11.0

type PartyMatchmakerTicket struct {

	// Party ID.
	PartyId string `protobuf:"bytes,1,opt,name=party_id,json=partyId,proto3" json:"party_id,omitempty"`
	// The ticket that can be used to cancel matchmaking.
	Ticket string `protobuf:"bytes,2,opt,name=ticket,proto3" json:"ticket,omitempty"`
	// contains filtered or unexported fields
}

A response from starting a new party matchmaking process.

func (*PartyMatchmakerTicket) Descriptor deprecated added in v1.11.0

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

Deprecated: Use PartyMatchmakerTicket.ProtoReflect.Descriptor instead.

func (*PartyMatchmakerTicket) GetPartyId added in v1.11.0

func (x *PartyMatchmakerTicket) GetPartyId() string

func (*PartyMatchmakerTicket) GetTicket added in v1.11.0

func (x *PartyMatchmakerTicket) GetTicket() string

func (*PartyMatchmakerTicket) ProtoMessage added in v1.11.0

func (*PartyMatchmakerTicket) ProtoMessage()

func (*PartyMatchmakerTicket) ProtoReflect added in v1.11.0

func (x *PartyMatchmakerTicket) ProtoReflect() protoreflect.Message

func (*PartyMatchmakerTicket) Reset added in v1.11.0

func (x *PartyMatchmakerTicket) Reset()

func (*PartyMatchmakerTicket) String added in v1.11.0

func (x *PartyMatchmakerTicket) String() string

type PartyPresenceEvent added in v1.11.0

type PartyPresenceEvent struct {

	// The party ID.
	PartyId string `protobuf:"bytes,1,opt,name=party_id,json=partyId,proto3" json:"party_id,omitempty"`
	// User presences that have just joined the party.
	Joins []*UserPresence `protobuf:"bytes,2,rep,name=joins,proto3" json:"joins,omitempty"`
	// User presences that have just left the party.
	Leaves []*UserPresence `protobuf:"bytes,3,rep,name=leaves,proto3" json:"leaves,omitempty"`
	// contains filtered or unexported fields
}

Presence update for a particular party.

func (*PartyPresenceEvent) Descriptor deprecated added in v1.11.0

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

Deprecated: Use PartyPresenceEvent.ProtoReflect.Descriptor instead.

func (*PartyPresenceEvent) GetJoins added in v1.11.0

func (x *PartyPresenceEvent) GetJoins() []*UserPresence

func (*PartyPresenceEvent) GetLeaves added in v1.11.0

func (x *PartyPresenceEvent) GetLeaves() []*UserPresence

func (*PartyPresenceEvent) GetPartyId added in v1.11.0

func (x *PartyPresenceEvent) GetPartyId() string

func (*PartyPresenceEvent) ProtoMessage added in v1.11.0

func (*PartyPresenceEvent) ProtoMessage()

func (*PartyPresenceEvent) ProtoReflect added in v1.11.0

func (x *PartyPresenceEvent) ProtoReflect() protoreflect.Message

func (*PartyPresenceEvent) Reset added in v1.11.0

func (x *PartyPresenceEvent) Reset()

func (*PartyPresenceEvent) String added in v1.11.0

func (x *PartyPresenceEvent) String() string

type PartyPromote added in v1.11.0

type PartyPromote struct {

	// Party ID to promote a new leader for.
	PartyId string `protobuf:"bytes,1,opt,name=party_id,json=partyId,proto3" json:"party_id,omitempty"`
	// The presence of an existing party member to promote as the new leader.
	Presence *UserPresence `protobuf:"bytes,2,opt,name=presence,proto3" json:"presence,omitempty"`
	// contains filtered or unexported fields
}

Promote a new party leader.

func (*PartyPromote) Descriptor deprecated added in v1.11.0

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

Deprecated: Use PartyPromote.ProtoReflect.Descriptor instead.

func (*PartyPromote) GetPartyId added in v1.11.0

func (x *PartyPromote) GetPartyId() string

func (*PartyPromote) GetPresence added in v1.11.0

func (x *PartyPromote) GetPresence() *UserPresence

func (*PartyPromote) ProtoMessage added in v1.11.0

func (*PartyPromote) ProtoMessage()

func (*PartyPromote) ProtoReflect added in v1.11.0

func (x *PartyPromote) ProtoReflect() protoreflect.Message

func (*PartyPromote) Reset added in v1.11.0

func (x *PartyPromote) Reset()

func (*PartyPromote) String added in v1.11.0

func (x *PartyPromote) String() string

type PartyRemove added in v1.11.0

type PartyRemove struct {

	// Party ID to remove/reject from.
	PartyId string `protobuf:"bytes,1,opt,name=party_id,json=partyId,proto3" json:"party_id,omitempty"`
	// The presence to remove or reject.
	Presence *UserPresence `protobuf:"bytes,2,opt,name=presence,proto3" json:"presence,omitempty"`
	// contains filtered or unexported fields
}

Kick a party member, or decline a request to join.

func (*PartyRemove) Descriptor deprecated added in v1.11.0

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

Deprecated: Use PartyRemove.ProtoReflect.Descriptor instead.

func (*PartyRemove) GetPartyId added in v1.11.0

func (x *PartyRemove) GetPartyId() string

func (*PartyRemove) GetPresence added in v1.11.0

func (x *PartyRemove) GetPresence() *UserPresence

func (*PartyRemove) ProtoMessage added in v1.11.0

func (*PartyRemove) ProtoMessage()

func (*PartyRemove) ProtoReflect added in v1.11.0

func (x *PartyRemove) ProtoReflect() protoreflect.Message

func (*PartyRemove) Reset added in v1.11.0

func (x *PartyRemove) Reset()

func (*PartyRemove) String added in v1.11.0

func (x *PartyRemove) String() string

type Ping

type Ping struct {
	// contains filtered or unexported fields
}

Application-level heartbeat and connection check.

func (*Ping) Descriptor deprecated

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

Deprecated: Use Ping.ProtoReflect.Descriptor instead.

func (*Ping) ProtoMessage

func (*Ping) ProtoMessage()

func (*Ping) ProtoReflect added in v1.8.0

func (x *Ping) ProtoReflect() protoreflect.Message

func (*Ping) Reset

func (x *Ping) Reset()

func (*Ping) String

func (x *Ping) String() string

type Pong

type Pong struct {
	// contains filtered or unexported fields
}

Application-level heartbeat and connection check response.

func (*Pong) Descriptor deprecated

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

Deprecated: Use Pong.ProtoReflect.Descriptor instead.

func (*Pong) ProtoMessage

func (*Pong) ProtoMessage()

func (*Pong) ProtoReflect added in v1.8.0

func (x *Pong) ProtoReflect() protoreflect.Message

func (*Pong) Reset

func (x *Pong) Reset()

func (*Pong) String

func (x *Pong) String() string

type Status

type Status struct {

	// User statuses.
	Presences []*UserPresence `protobuf:"bytes,1,rep,name=presences,proto3" json:"presences,omitempty"`
	// contains filtered or unexported fields
}

A snapshot of statuses for some set of users.

func (*Status) Descriptor deprecated

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

Deprecated: Use Status.ProtoReflect.Descriptor instead.

func (*Status) GetPresences

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

func (*Status) ProtoMessage

func (*Status) ProtoMessage()

func (*Status) ProtoReflect added in v1.8.0

func (x *Status) ProtoReflect() protoreflect.Message

func (*Status) Reset

func (x *Status) Reset()

func (*Status) String

func (x *Status) String() string

type StatusFollow

type StatusFollow struct {

	// User IDs to follow.
	UserIds []string `protobuf:"bytes,1,rep,name=user_ids,json=userIds,proto3" json:"user_ids,omitempty"`
	// Usernames to follow.
	Usernames []string `protobuf:"bytes,2,rep,name=usernames,proto3" json:"usernames,omitempty"`
	// contains filtered or unexported fields
}

Start receiving status updates for some set of users.

func (*StatusFollow) Descriptor deprecated

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

Deprecated: Use StatusFollow.ProtoReflect.Descriptor instead.

func (*StatusFollow) GetUserIds

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

func (*StatusFollow) GetUsernames

func (x *StatusFollow) GetUsernames() []string

func (*StatusFollow) ProtoMessage

func (*StatusFollow) ProtoMessage()

func (*StatusFollow) ProtoReflect added in v1.8.0

func (x *StatusFollow) ProtoReflect() protoreflect.Message

func (*StatusFollow) Reset

func (x *StatusFollow) Reset()

func (*StatusFollow) String

func (x *StatusFollow) String() string

type StatusPresenceEvent

type StatusPresenceEvent struct {

	// New statuses for the user.
	Joins []*UserPresence `protobuf:"bytes,2,rep,name=joins,proto3" json:"joins,omitempty"`
	// Previous statuses for the user.
	Leaves []*UserPresence `protobuf:"bytes,3,rep,name=leaves,proto3" json:"leaves,omitempty"`
	// contains filtered or unexported fields
}

A batch of status updates for a given user.

func (*StatusPresenceEvent) Descriptor deprecated

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

Deprecated: Use StatusPresenceEvent.ProtoReflect.Descriptor instead.

func (*StatusPresenceEvent) GetJoins

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

func (*StatusPresenceEvent) GetLeaves

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

func (*StatusPresenceEvent) ProtoMessage

func (*StatusPresenceEvent) ProtoMessage()

func (*StatusPresenceEvent) ProtoReflect added in v1.8.0

func (x *StatusPresenceEvent) ProtoReflect() protoreflect.Message

func (*StatusPresenceEvent) Reset

func (x *StatusPresenceEvent) Reset()

func (*StatusPresenceEvent) String

func (x *StatusPresenceEvent) String() string

type StatusUnfollow

type StatusUnfollow struct {

	// Users to unfollow.
	UserIds []string `protobuf:"bytes,1,rep,name=user_ids,json=userIds,proto3" json:"user_ids,omitempty"`
	// contains filtered or unexported fields
}

Stop receiving status updates for some set of users.

func (*StatusUnfollow) Descriptor deprecated

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

Deprecated: Use StatusUnfollow.ProtoReflect.Descriptor instead.

func (*StatusUnfollow) GetUserIds

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

func (*StatusUnfollow) ProtoMessage

func (*StatusUnfollow) ProtoMessage()

func (*StatusUnfollow) ProtoReflect added in v1.8.0

func (x *StatusUnfollow) ProtoReflect() protoreflect.Message

func (*StatusUnfollow) Reset

func (x *StatusUnfollow) Reset()

func (*StatusUnfollow) String

func (x *StatusUnfollow) String() string

type StatusUpdate

type StatusUpdate struct {

	// Status string to set, if not present the user will appear offline.
	Status *wrapperspb.StringValue `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

Set the user's own status.

func (*StatusUpdate) Descriptor deprecated

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

Deprecated: Use StatusUpdate.ProtoReflect.Descriptor instead.

func (*StatusUpdate) GetStatus

func (x *StatusUpdate) GetStatus() *wrapperspb.StringValue

func (*StatusUpdate) ProtoMessage

func (*StatusUpdate) ProtoMessage()

func (*StatusUpdate) ProtoReflect added in v1.8.0

func (x *StatusUpdate) ProtoReflect() protoreflect.Message

func (*StatusUpdate) Reset

func (x *StatusUpdate) Reset()

func (*StatusUpdate) String

func (x *StatusUpdate) String() string

type Stream

type Stream struct {

	// Mode identifies the type of stream.
	Mode int32 `protobuf:"varint,1,opt,name=mode,proto3" json:"mode,omitempty"`
	// Subject is the primary identifier, if any.
	Subject string `protobuf:"bytes,2,opt,name=subject,proto3" json:"subject,omitempty"`
	// Subcontext is a secondary identifier, if any.
	Subcontext string `protobuf:"bytes,3,opt,name=subcontext,proto3" json:"subcontext,omitempty"`
	// The label is an arbitrary identifying string, if the stream has one.
	Label string `protobuf:"bytes,4,opt,name=label,proto3" json:"label,omitempty"`
	// contains filtered or unexported fields
}

Represents identifying information for a stream.

func (*Stream) Descriptor deprecated

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

Deprecated: Use Stream.ProtoReflect.Descriptor instead.

func (*Stream) GetLabel

func (x *Stream) GetLabel() string

func (*Stream) GetMode

func (x *Stream) GetMode() int32

func (*Stream) GetSubcontext

func (x *Stream) GetSubcontext() string

func (*Stream) GetSubject

func (x *Stream) GetSubject() string

func (*Stream) ProtoMessage

func (*Stream) ProtoMessage()

func (*Stream) ProtoReflect added in v1.8.0

func (x *Stream) ProtoReflect() protoreflect.Message

func (*Stream) Reset

func (x *Stream) Reset()

func (*Stream) String

func (x *Stream) String() string

type StreamData

type StreamData struct {

	// The stream this data message relates to.
	Stream *Stream `protobuf:"bytes,1,opt,name=stream,proto3" json:"stream,omitempty"`
	// The sender, if any.
	Sender *UserPresence `protobuf:"bytes,2,opt,name=sender,proto3" json:"sender,omitempty"`
	// Arbitrary contents of the data message.
	Data string `protobuf:"bytes,3,opt,name=data,proto3" json:"data,omitempty"`
	// True if this data was delivered reliably, false otherwise.
	Reliable bool `protobuf:"varint,4,opt,name=reliable,proto3" json:"reliable,omitempty"`
	// contains filtered or unexported fields
}

A data message delivered over a stream.

func (*StreamData) Descriptor deprecated

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

Deprecated: Use StreamData.ProtoReflect.Descriptor instead.

func (*StreamData) GetData

func (x *StreamData) GetData() string

func (*StreamData) GetReliable

func (x *StreamData) GetReliable() bool

func (*StreamData) GetSender

func (x *StreamData) GetSender() *UserPresence

func (*StreamData) GetStream

func (x *StreamData) GetStream() *Stream

func (*StreamData) ProtoMessage

func (*StreamData) ProtoMessage()

func (*StreamData) ProtoReflect added in v1.8.0

func (x *StreamData) ProtoReflect() protoreflect.Message

func (*StreamData) Reset

func (x *StreamData) Reset()

func (*StreamData) String

func (x *StreamData) String() string

type StreamPresenceEvent

type StreamPresenceEvent struct {

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

A set of joins and leaves on a particular stream.

func (*StreamPresenceEvent) Descriptor deprecated

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

Deprecated: Use StreamPresenceEvent.ProtoReflect.Descriptor instead.

func (*StreamPresenceEvent) GetJoins

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

func (*StreamPresenceEvent) GetLeaves

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

func (*StreamPresenceEvent) GetStream

func (x *StreamPresenceEvent) GetStream() *Stream

func (*StreamPresenceEvent) ProtoMessage

func (*StreamPresenceEvent) ProtoMessage()

func (*StreamPresenceEvent) ProtoReflect added in v1.8.0

func (x *StreamPresenceEvent) ProtoReflect() protoreflect.Message

func (*StreamPresenceEvent) Reset

func (x *StreamPresenceEvent) Reset()

func (*StreamPresenceEvent) String

func (x *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,proto3" 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,proto3" json:"session_id,omitempty"`
	// The username for display purposes.
	Username string `protobuf:"bytes,3,opt,name=username,proto3" json:"username,omitempty"`
	// Whether this presence generates persistent data/messages, if applicable for the stream type.
	Persistence bool `protobuf:"varint,4,opt,name=persistence,proto3" json:"persistence,omitempty"`
	// A user-set status message for this stream, if applicable.
	Status *wrapperspb.StringValue `protobuf:"bytes,5,opt,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

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

func (*UserPresence) Descriptor deprecated

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

Deprecated: Use UserPresence.ProtoReflect.Descriptor instead.

func (*UserPresence) GetPersistence

func (x *UserPresence) GetPersistence() bool

func (*UserPresence) GetSessionId

func (x *UserPresence) GetSessionId() string

func (*UserPresence) GetStatus

func (x *UserPresence) GetStatus() *wrapperspb.StringValue

func (*UserPresence) GetUserId

func (x *UserPresence) GetUserId() string

func (*UserPresence) GetUsername

func (x *UserPresence) GetUsername() string

func (*UserPresence) ProtoMessage

func (*UserPresence) ProtoMessage()

func (*UserPresence) ProtoReflect added in v1.8.0

func (x *UserPresence) ProtoReflect() protoreflect.Message

func (*UserPresence) Reset

func (x *UserPresence) Reset()

func (*UserPresence) String

func (x *UserPresence) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL