com.heroiclabs.nakama.rtapi

Class Channel

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.heroiclabs.nakama.rtapi.Channel

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ChannelOrBuilder, java.io.Serializable

public final class Channel
extends com.google.protobuf.GeneratedMessage
implements ChannelOrBuilder

 A realtime chat channel.
 

Protobuf type nakama.realtime.Channel

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Channel.Builder A realtime chat channel.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

com.google.protobuf.AbstractMessage.BuilderParent

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	GROUP_ID_FIELD_NUMBER
static int	ID_FIELD_NUMBER
static int	PRESENCES_FIELD_NUMBER
static int	ROOM_NAME_FIELD_NUMBER
static int	SELF_FIELD_NUMBER
static int	USER_ID_ONE_FIELD_NUMBER
static int	USER_ID_TWO_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
static Channel	getDefaultInstance()
Channel	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
java.lang.String	getGroupId() The ID of the group, or an empty string if this message was not sent through a group channel.
com.google.protobuf.ByteString	getGroupIdBytes() The ID of the group, or an empty string if this message was not sent through a group channel.
java.lang.String	getId() The ID of the channel.
com.google.protobuf.ByteString	getIdBytes() The ID of the channel.
com.google.protobuf.Parser<Channel>	getParserForType()
UserPresence	getPresences(int index) The users currently in the channel.
int	getPresencesCount() The users currently in the channel.
java.util.List<UserPresence>	getPresencesList() The users currently in the channel.
UserPresenceOrBuilder	getPresencesOrBuilder(int index) The users currently in the channel.
java.util.List<? extends UserPresenceOrBuilder>	getPresencesOrBuilderList() The users currently in the channel.
java.lang.String	getRoomName() The name of the chat room, or an empty string if this message was not sent through a chat room.
com.google.protobuf.ByteString	getRoomNameBytes() The name of the chat room, or an empty string if this message was not sent through a chat room.
UserPresence	getSelf() A reference to the current user's presence in the channel.
UserPresenceOrBuilder	getSelfOrBuilder() A reference to the current user's presence in the channel.
int	getSerializedSize()
java.lang.String	getUserIdOne() The ID of the first DM user, or an empty string if this message was not sent through a DM chat.
com.google.protobuf.ByteString	getUserIdOneBytes() The ID of the first DM user, or an empty string if this message was not sent through a DM chat.
java.lang.String	getUserIdTwo() The ID of the second DM user, or an empty string if this message was not sent through a DM chat.
com.google.protobuf.ByteString	getUserIdTwoBytes() The ID of the second DM user, or an empty string if this message was not sent through a DM chat.
int	hashCode()
boolean	hasSelf() A reference to the current user's presence in the channel.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Channel.Builder	newBuilder()
static Channel.Builder	newBuilder(Channel prototype)
Channel.Builder	newBuilderForType()
protected Channel.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static Channel	parseDelimitedFrom(java.io.InputStream input)
static Channel	parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Channel	parseFrom(byte[] data)
static Channel	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Channel	parseFrom(java.nio.ByteBuffer data)
static Channel	parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Channel	parseFrom(com.google.protobuf.ByteString data)
static Channel	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Channel	parseFrom(com.google.protobuf.CodedInputStream input)
static Channel	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Channel	parseFrom(java.io.InputStream input)
static Channel	parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Channel>	parser()
Channel.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER

See Also:

Constant Field Values

PRESENCES_FIELD_NUMBER

public static final int PRESENCES_FIELD_NUMBER

See Also:

Constant Field Values

SELF_FIELD_NUMBER

public static final int SELF_FIELD_NUMBER

See Also:

Constant Field Values

ROOM_NAME_FIELD_NUMBER

public static final int ROOM_NAME_FIELD_NUMBER

See Also:

Constant Field Values

GROUP_ID_FIELD_NUMBER

public static final int GROUP_ID_FIELD_NUMBER

See Also:

Constant Field Values

USER_ID_ONE_FIELD_NUMBER

public static final int USER_ID_ONE_FIELD_NUMBER

See Also:

Constant Field Values

USER_ID_TWO_FIELD_NUMBER

public static final int USER_ID_TWO_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

getId

public java.lang.String getId()

 The ID of the channel.
 

string id = 1 [json_name = "id"];

Specified by:

getId in interface ChannelOrBuilder

Returns:

The id.

getIdBytes

public com.google.protobuf.ByteString getIdBytes()

 The ID of the channel.
 

string id = 1 [json_name = "id"];

Specified by:

getIdBytes in interface ChannelOrBuilder

Returns:

The bytes for id.

getPresencesList

public java.util.List<UserPresence> getPresencesList()

 The users currently in the channel.
 

repeated .nakama.realtime.UserPresence presences = 2 [json_name = "presences"];

Specified by:

getPresencesList in interface ChannelOrBuilder

getPresencesOrBuilderList

public java.util.List<? extends UserPresenceOrBuilder> getPresencesOrBuilderList()

 The users currently in the channel.
 

repeated .nakama.realtime.UserPresence presences = 2 [json_name = "presences"];

Specified by:

getPresencesOrBuilderList in interface ChannelOrBuilder

getPresencesCount

public int getPresencesCount()

 The users currently in the channel.
 

repeated .nakama.realtime.UserPresence presences = 2 [json_name = "presences"];

Specified by:

getPresencesCount in interface ChannelOrBuilder

getPresences

public UserPresence getPresences(int index)

 The users currently in the channel.
 

repeated .nakama.realtime.UserPresence presences = 2 [json_name = "presences"];

Specified by:

getPresences in interface ChannelOrBuilder

getPresencesOrBuilder

public UserPresenceOrBuilder getPresencesOrBuilder(int index)

 The users currently in the channel.
 

repeated .nakama.realtime.UserPresence presences = 2 [json_name = "presences"];

Specified by:

getPresencesOrBuilder in interface ChannelOrBuilder

hasSelf

public boolean hasSelf()

 A reference to the current user's presence in the channel.
 

.nakama.realtime.UserPresence self = 3 [json_name = "self"];

Specified by:

hasSelf in interface ChannelOrBuilder

Returns:

Whether the self field is set.

getSelf

public UserPresence getSelf()

 A reference to the current user's presence in the channel.
 

.nakama.realtime.UserPresence self = 3 [json_name = "self"];

Specified by:

getSelf in interface ChannelOrBuilder

Returns:

The self.

getSelfOrBuilder

public UserPresenceOrBuilder getSelfOrBuilder()

 A reference to the current user's presence in the channel.
 

.nakama.realtime.UserPresence self = 3 [json_name = "self"];

Specified by:

getSelfOrBuilder in interface ChannelOrBuilder

getRoomName

public java.lang.String getRoomName()

 The name of the chat room, or an empty string if this message was not sent through a chat room.
 

string room_name = 4 [json_name = "roomName"];

Specified by:

getRoomName in interface ChannelOrBuilder

Returns:

The roomName.

getRoomNameBytes

public com.google.protobuf.ByteString getRoomNameBytes()

 The name of the chat room, or an empty string if this message was not sent through a chat room.
 

string room_name = 4 [json_name = "roomName"];

Specified by:

getRoomNameBytes in interface ChannelOrBuilder

Returns:

The bytes for roomName.

getGroupId

public java.lang.String getGroupId()

 The ID of the group, or an empty string if this message was not sent through a group channel.
 

string group_id = 5 [json_name = "groupId"];

Specified by:

getGroupId in interface ChannelOrBuilder

Returns:

The groupId.

getGroupIdBytes

public com.google.protobuf.ByteString getGroupIdBytes()

 The ID of the group, or an empty string if this message was not sent through a group channel.
 

string group_id = 5 [json_name = "groupId"];

Specified by:

getGroupIdBytes in interface ChannelOrBuilder

Returns:

The bytes for groupId.

getUserIdOne

public java.lang.String getUserIdOne()

 The ID of the first DM user, or an empty string if this message was not sent through a DM chat.
 

string user_id_one = 6 [json_name = "userIdOne"];

Specified by:

getUserIdOne in interface ChannelOrBuilder

Returns:

The userIdOne.

getUserIdOneBytes

public com.google.protobuf.ByteString getUserIdOneBytes()

 The ID of the first DM user, or an empty string if this message was not sent through a DM chat.
 

string user_id_one = 6 [json_name = "userIdOne"];

Specified by:

getUserIdOneBytes in interface ChannelOrBuilder

Returns:

The bytes for userIdOne.

getUserIdTwo

public java.lang.String getUserIdTwo()

 The ID of the second DM user, or an empty string if this message was not sent through a DM chat.
 

string user_id_two = 7 [json_name = "userIdTwo"];

Specified by:

getUserIdTwo in interface ChannelOrBuilder

Returns:

The userIdTwo.

getUserIdTwoBytes

public com.google.protobuf.ByteString getUserIdTwoBytes()

 The ID of the second DM user, or an empty string if this message was not sent through a DM chat.
 

string user_id_two = 7 [json_name = "userIdTwo"];

Specified by:

getUserIdTwoBytes in interface ChannelOrBuilder

Returns:

The bytes for userIdTwo.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessage

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessage

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Channel parseFrom(java.nio.ByteBuffer data)
                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Channel parseFrom(java.nio.ByteBuffer data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Channel parseFrom(com.google.protobuf.ByteString data)
                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Channel parseFrom(com.google.protobuf.ByteString data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Channel parseFrom(byte[] data)
                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Channel parseFrom(byte[] data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Channel parseFrom(java.io.InputStream input)
                         throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static Channel parseFrom(java.io.InputStream input,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static Channel parseDelimitedFrom(java.io.InputStream input)
                                  throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static Channel parseDelimitedFrom(java.io.InputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static Channel parseFrom(com.google.protobuf.CodedInputStream input)
                         throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static Channel parseFrom(com.google.protobuf.CodedInputStream input,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public Channel.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Channel.Builder newBuilder()

newBuilder

public static Channel.Builder newBuilder(Channel prototype)

toBuilder

public Channel.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Channel.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static Channel getDefaultInstance()

parser

public static com.google.protobuf.Parser<Channel> parser()

getParserForType

public com.google.protobuf.Parser<Channel> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessage

getDefaultInstanceForType

public Channel getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder