com.heroiclabs.nakama.rtapi

Class UserPresence

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.heroiclabs.nakama.rtapi.UserPresence

All Implemented Interfaces:

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

public final class UserPresence
extends com.google.protobuf.GeneratedMessage
implements UserPresenceOrBuilder

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

Protobuf type nakama.realtime.UserPresence

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UserPresence.Builder A user session associated to a stream, usually through a list operation or a join/leave event.

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	PERSISTENCE_FIELD_NUMBER
static int	SESSION_ID_FIELD_NUMBER
static int	STATUS_FIELD_NUMBER
static int	USER_ID_FIELD_NUMBER
static int	USERNAME_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 UserPresence	getDefaultInstance()
UserPresence	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Parser<UserPresence>	getParserForType()
boolean	getPersistence() Whether this presence generates persistent data/messages, if applicable for the stream type.
int	getSerializedSize()
java.lang.String	getSessionId() A unique session ID identifying the particular connection, because the user may have many.
com.google.protobuf.ByteString	getSessionIdBytes() A unique session ID identifying the particular connection, because the user may have many.
com.google.protobuf.StringValue	getStatus() A user-set status message for this stream, if applicable.
com.google.protobuf.StringValueOrBuilder	getStatusOrBuilder() A user-set status message for this stream, if applicable.
java.lang.String	getUserId() The user this presence belongs to.
com.google.protobuf.ByteString	getUserIdBytes() The user this presence belongs to.
java.lang.String	getUsername() The username for display purposes.
com.google.protobuf.ByteString	getUsernameBytes() The username for display purposes.
int	hashCode()
boolean	hasStatus() A user-set status message for this stream, if applicable.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static UserPresence.Builder	newBuilder()
static UserPresence.Builder	newBuilder(UserPresence prototype)
UserPresence.Builder	newBuilderForType()
protected UserPresence.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static UserPresence	parseDelimitedFrom(java.io.InputStream input)
static UserPresence	parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static UserPresence	parseFrom(byte[] data)
static UserPresence	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static UserPresence	parseFrom(java.nio.ByteBuffer data)
static UserPresence	parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static UserPresence	parseFrom(com.google.protobuf.ByteString data)
static UserPresence	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static UserPresence	parseFrom(com.google.protobuf.CodedInputStream input)
static UserPresence	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static UserPresence	parseFrom(java.io.InputStream input)
static UserPresence	parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<UserPresence>	parser()
UserPresence.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

USER_ID_FIELD_NUMBER

public static final int USER_ID_FIELD_NUMBER

See Also:

Constant Field Values

SESSION_ID_FIELD_NUMBER

public static final int SESSION_ID_FIELD_NUMBER

See Also:

Constant Field Values

USERNAME_FIELD_NUMBER

public static final int USERNAME_FIELD_NUMBER

See Also:

Constant Field Values

PERSISTENCE_FIELD_NUMBER

public static final int PERSISTENCE_FIELD_NUMBER

See Also:

Constant Field Values

STATUS_FIELD_NUMBER

public static final int STATUS_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

getUserId

public java.lang.String getUserId()

 The user this presence belongs to.
 

string user_id = 1 [json_name = "userId"];

Specified by:

getUserId in interface UserPresenceOrBuilder

Returns:

The userId.

getUserIdBytes

public com.google.protobuf.ByteString getUserIdBytes()

 The user this presence belongs to.
 

string user_id = 1 [json_name = "userId"];

Specified by:

getUserIdBytes in interface UserPresenceOrBuilder

Returns:

The bytes for userId.

getSessionId

public java.lang.String getSessionId()

 A unique session ID identifying the particular connection, because the user may have many.
 

string session_id = 2 [json_name = "sessionId"];

Specified by:

getSessionId in interface UserPresenceOrBuilder

Returns:

The sessionId.

getSessionIdBytes

public com.google.protobuf.ByteString getSessionIdBytes()

 A unique session ID identifying the particular connection, because the user may have many.
 

string session_id = 2 [json_name = "sessionId"];

Specified by:

getSessionIdBytes in interface UserPresenceOrBuilder

Returns:

The bytes for sessionId.

getUsername

public java.lang.String getUsername()

 The username for display purposes.
 

string username = 3 [json_name = "username"];

Specified by:

getUsername in interface UserPresenceOrBuilder

Returns:

The username.

getUsernameBytes

public com.google.protobuf.ByteString getUsernameBytes()

 The username for display purposes.
 

string username = 3 [json_name = "username"];

Specified by:

getUsernameBytes in interface UserPresenceOrBuilder

Returns:

The bytes for username.

getPersistence

public boolean getPersistence()

 Whether this presence generates persistent data/messages, if applicable for the stream type.
 

bool persistence = 4 [json_name = "persistence"];

Specified by:

getPersistence in interface UserPresenceOrBuilder

Returns:

The persistence.

hasStatus

public boolean hasStatus()

 A user-set status message for this stream, if applicable.
 

.google.protobuf.StringValue status = 5 [json_name = "status"];

Specified by:

hasStatus in interface UserPresenceOrBuilder

Returns:

Whether the status field is set.

getStatus

public com.google.protobuf.StringValue getStatus()

 A user-set status message for this stream, if applicable.
 

.google.protobuf.StringValue status = 5 [json_name = "status"];

Specified by:

getStatus in interface UserPresenceOrBuilder

Returns:

The status.

getStatusOrBuilder

public com.google.protobuf.StringValueOrBuilder getStatusOrBuilder()

 A user-set status message for this stream, if applicable.
 

.google.protobuf.StringValue status = 5 [json_name = "status"];

Specified by:

getStatusOrBuilder in interface UserPresenceOrBuilder

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 UserPresence parseFrom(java.nio.ByteBuffer data)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.IOException

parseDelimitedFrom

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

Throws:

java.io.IOException

parseDelimitedFrom

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

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.IOException

newBuilderForType

public UserPresence.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static UserPresence.Builder newBuilder()

newBuilder

public static UserPresence.Builder newBuilder(UserPresence prototype)

toBuilder

public UserPresence.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static UserPresence getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<UserPresence> 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 UserPresence getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder