Package com.heroiclabs.nakama.rtapi

Interface UserPresenceOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
UserPresence, UserPresence.Builder
public interface UserPresenceOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getPersistence()
    Whether this presence generates persistent data/messages, if applicable for the stream type.
    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.
    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.
    boolean
    hasStatus()
    A user-set status message for this stream, if applicable.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getUserId

      String getUserId()
       The user this presence belongs to.
      string user_id = 1;
      Returns:
      The userId.

    • getUserIdBytes

      com.google.protobuf.ByteString getUserIdBytes()
       The user this presence belongs to.
      string user_id = 1;
      Returns:
      The bytes for userId.

    • getSessionId

      String getSessionId()
       A unique session ID identifying the particular connection, because the user may have many.
      string session_id = 2;
      Returns:
      The sessionId.

    • getSessionIdBytes

      com.google.protobuf.ByteString getSessionIdBytes()
       A unique session ID identifying the particular connection, because the user may have many.
      string session_id = 2;
      Returns:
      The bytes for sessionId.

    • getUsername

      String getUsername()
       The username for display purposes.
      string username = 3;
      Returns:
      The username.

    • getUsernameBytes

      com.google.protobuf.ByteString getUsernameBytes()
       The username for display purposes.
      string username = 3;
      Returns:
      The bytes for username.

    • getPersistence

      boolean getPersistence()
       Whether this presence generates persistent data/messages, if applicable for the stream type.
      bool persistence = 4;
      Returns:
      The persistence.

    • hasStatus

      boolean hasStatus()
       A user-set status message for this stream, if applicable.
      .google.protobuf.StringValue status = 5;
      Returns:
      Whether the status field is set.

    • getStatus

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

    • getStatusOrBuilder

      StringValueOrBuilder getStatusOrBuilder()
       A user-set status message for this stream, if applicable.
      .google.protobuf.StringValue status = 5;