Package com.heroiclabs.nakama.rtapi

Class UserPresence

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
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, Serializable
public final class UserPresence extends com.google.protobuf.GeneratedMessageV3 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:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final 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.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    PERSISTENCE_FIELD_NUMBER
     
    static final int
    SESSION_ID_FIELD_NUMBER
     
    static final int
    STATUS_FIELD_NUMBER
     
    static final int
    USER_ID_FIELD_NUMBER
     
    static final int
    USERNAME_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    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
    Description
    boolean
    equals(Object obj)
     
    static UserPresence
    getDefaultInstance()
     
    UserPresence
    getDefaultInstanceForType()
     
    static final 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()
     
    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.
    StringValue
    getStatus()
    A user-set status message for this stream, if applicable.
    StringValueOrBuilder
    getStatusOrBuilder()
    A user-set status message for this stream, if applicable.
    final com.google.protobuf.UnknownFieldSet
    getUnknownFields()
     
    String
    getUserId()
    The user this presence belongs to.
    com.google.protobuf.ByteString
    getUserIdBytes()
    The user this presence belongs to.
    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.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static UserPresence.Builder
    newBuilder()
     
    static UserPresence.Builder
    newBuilder(UserPresence prototype)
     
    UserPresence.Builder
    newBuilderForType()
     
    protected UserPresence.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static UserPresence
    parseDelimitedFrom(InputStream input)
     
    static UserPresence
    parseDelimitedFrom(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(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(InputStream input)
     
    static UserPresence
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static UserPresence
    parseFrom(ByteBuffer data)
     
    static UserPresence
    parseFrom(ByteBuffer data, 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.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, 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.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getUnknownFields

      public final com.google.protobuf.UnknownFieldSet getUnknownFields()
      Specified by:
      getUnknownFields in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getUnknownFields in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getUserId

      public String getUserId()
       The user this presence belongs to.
      string user_id = 1;
      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;
      Specified by:
      getUserIdBytes in interface UserPresenceOrBuilder
      Returns:
      The bytes for userId.

    • getSessionId

      public String getSessionId()
       A unique session ID identifying the particular connection, because the user may have many.
      string session_id = 2;
      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;
      Specified by:
      getSessionIdBytes in interface UserPresenceOrBuilder
      Returns:
      The bytes for sessionId.

    • getUsername

      public String getUsername()
       The username for display purposes.
      string username = 3;
      Specified by:
      getUsername in interface UserPresenceOrBuilder
      Returns:
      The username.

    • getUsernameBytes

      public com.google.protobuf.ByteString getUsernameBytes()
       The username for display purposes.
      string username = 3;
      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;
      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;
      Specified by:
      hasStatus in interface UserPresenceOrBuilder
      Returns:
      Whether the status field is set.

    • getStatus

      public StringValue getStatus()
       A user-set status message for this stream, if applicable.
      .google.protobuf.StringValue status = 5;
      Specified by:
      getStatus in interface UserPresenceOrBuilder
      Returns:
      The status.

    • getStatusOrBuilder

      public StringValueOrBuilder getStatusOrBuilder()
       A user-set status message for this stream, if applicable.
      .google.protobuf.StringValue status = 5;
      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.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(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(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static UserPresence parseFrom(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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static UserPresence parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

      public static UserPresence parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static UserPresence parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      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.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • 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.GeneratedMessageV3

    • getDefaultInstanceForType

      public UserPresence getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder