UserPresence.Builder (nakama-java 2.5.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessage.Builder<UserPresence.Builder>
    - - com.heroiclabs.nakama.rtapi.UserPresence.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, UserPresenceOrBuilder, java.lang.Cloneable

Enclosing class:

UserPresence
```
public static final class UserPresence.Builder
extends com.google.protobuf.GeneratedMessage.Builder<UserPresence.Builder>
implements UserPresenceOrBuilder
```
```
 A user session associated to a stream, usually through a list operation or a join/leave event.
 
```
Protobuf type nakama.realtime.UserPresence

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UserPresence`	`build()`
`UserPresence`	`buildPartial()`
`UserPresence.Builder`	`clear()`
`UserPresence.Builder`	`clearPersistence()` Whether this presence generates persistent data/messages, if applicable for the stream type.
`UserPresence.Builder`	`clearSessionId()` A unique session ID identifying the particular connection, because the user may have many.
`UserPresence.Builder`	`clearStatus()` A user-set status message for this stream, if applicable.
`UserPresence.Builder`	`clearUserId()` The user this presence belongs to.
`UserPresence.Builder`	`clearUsername()` The username for display purposes.
`UserPresence`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`boolean`	`getPersistence()` Whether this presence generates persistent data/messages, if applicable for the stream type.
`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.StringValue.Builder`	`getStatusBuilder()` 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.
`boolean`	`hasStatus()` A user-set status message for this stream, if applicable.
`protected com.google.protobuf.GeneratedMessage.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`UserPresence.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`UserPresence.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`UserPresence.Builder`	`mergeFrom(UserPresence other)`
`UserPresence.Builder`	`mergeStatus(com.google.protobuf.StringValue value)` A user-set status message for this stream, if applicable.
`UserPresence.Builder`	`setPersistence(boolean value)` Whether this presence generates persistent data/messages, if applicable for the stream type.
`UserPresence.Builder`	`setSessionId(java.lang.String value)` A unique session ID identifying the particular connection, because the user may have many.
`UserPresence.Builder`	`setSessionIdBytes(com.google.protobuf.ByteString value)` A unique session ID identifying the particular connection, because the user may have many.
`UserPresence.Builder`	`setStatus(com.google.protobuf.StringValue.Builder builderForValue)` A user-set status message for this stream, if applicable.
`UserPresence.Builder`	`setStatus(com.google.protobuf.StringValue value)` A user-set status message for this stream, if applicable.
`UserPresence.Builder`	`setUserId(java.lang.String value)` The user this presence belongs to.
`UserPresence.Builder`	`setUserIdBytes(com.google.protobuf.ByteString value)` The user this presence belongs to.
`UserPresence.Builder`	`setUsername(java.lang.String value)` The username for display purposes.
`UserPresence.Builder`	`setUsernameBytes(com.google.protobuf.ByteString value)` The username for display purposes.

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

- 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.Builder<UserPresence.Builder>
  - clear
```
public UserPresence.Builder clear()
```
    Specified by:
    
    clear in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clear in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clear in class com.google.protobuf.GeneratedMessage.Builder<UserPresence.Builder>
  - getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
    
    Overrides:
    
    getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<UserPresence.Builder>
  - getDefaultInstanceForType
```
public UserPresence getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public UserPresence build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public UserPresence buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - mergeFrom
```
public UserPresence.Builder mergeFrom(com.google.protobuf.Message other)
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<UserPresence.Builder>
  - mergeFrom
```
public UserPresence.Builder mergeFrom(UserPresence other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessage.Builder<UserPresence.Builder>
  - mergeFrom
```
public UserPresence.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws java.io.IOException
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    mergeFrom in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<UserPresence.Builder>
    
    Throws:
    
    java.io.IOException
  - 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.
  - setUserId
```
public UserPresence.Builder setUserId(java.lang.String value)
```
```
 The user this presence belongs to.
 
```
    string user_id = 1 [json_name = "userId"];
    Parameters:
    
    value - The userId to set.
    
    Returns:
    
    This builder for chaining.
  - clearUserId
```
public UserPresence.Builder clearUserId()
```
```
 The user this presence belongs to.
 
```
    string user_id = 1 [json_name = "userId"];
    Returns:
    
    This builder for chaining.
  - setUserIdBytes
```
public UserPresence.Builder setUserIdBytes(com.google.protobuf.ByteString value)
```
```
 The user this presence belongs to.
 
```
    string user_id = 1 [json_name = "userId"];
    Parameters:
    
    value - The bytes for userId to set.
    
    Returns:
    
    This builder for chaining.
  - 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.
  - setSessionId
```
public UserPresence.Builder setSessionId(java.lang.String value)
```
```
 A unique session ID identifying the particular connection, because the user may have many.
 
```
    string session_id = 2 [json_name = "sessionId"];
    Parameters:
    
    value - The sessionId to set.
    
    Returns:
    
    This builder for chaining.
  - clearSessionId
```
public UserPresence.Builder clearSessionId()
```
```
 A unique session ID identifying the particular connection, because the user may have many.
 
```
    string session_id = 2 [json_name = "sessionId"];
    Returns:
    
    This builder for chaining.
  - setSessionIdBytes
```
public UserPresence.Builder setSessionIdBytes(com.google.protobuf.ByteString value)
```
```
 A unique session ID identifying the particular connection, because the user may have many.
 
```
    string session_id = 2 [json_name = "sessionId"];
    Parameters:
    
    value - The bytes for sessionId to set.
    
    Returns:
    
    This builder for chaining.
  - 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.
  - setUsername
```
public UserPresence.Builder setUsername(java.lang.String value)
```
```
 The username for display purposes.
 
```
    string username = 3 [json_name = "username"];
    Parameters:
    
    value - The username to set.
    
    Returns:
    
    This builder for chaining.
  - clearUsername
```
public UserPresence.Builder clearUsername()
```
```
 The username for display purposes.
 
```
    string username = 3 [json_name = "username"];
    Returns:
    
    This builder for chaining.
  - setUsernameBytes
```
public UserPresence.Builder setUsernameBytes(com.google.protobuf.ByteString value)
```
```
 The username for display purposes.
 
```
    string username = 3 [json_name = "username"];
    Parameters:
    
    value - The bytes for username to set.
    
    Returns:
    
    This builder for chaining.
  - 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.
  - setPersistence
```
public UserPresence.Builder setPersistence(boolean value)
```
```
 Whether this presence generates persistent data/messages, if applicable for the stream type.
 
```
    bool persistence = 4 [json_name = "persistence"];
    Parameters:
    
    value - The persistence to set.
    
    Returns:
    
    This builder for chaining.
  - clearPersistence
```
public UserPresence.Builder clearPersistence()
```
```
 Whether this presence generates persistent data/messages, if applicable for the stream type.
 
```
    bool persistence = 4 [json_name = "persistence"];
    Returns:
    
    This builder for chaining.
  - 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.
  - setStatus
```
public UserPresence.Builder setStatus(com.google.protobuf.StringValue value)
```
```
 A user-set status message for this stream, if applicable.
 
```
    .google.protobuf.StringValue status = 5 [json_name = "status"];
  - setStatus
```
public UserPresence.Builder setStatus(com.google.protobuf.StringValue.Builder builderForValue)
```
```
 A user-set status message for this stream, if applicable.
 
```
    .google.protobuf.StringValue status = 5 [json_name = "status"];
  - mergeStatus
```
public UserPresence.Builder mergeStatus(com.google.protobuf.StringValue value)
```
```
 A user-set status message for this stream, if applicable.
 
```
    .google.protobuf.StringValue status = 5 [json_name = "status"];
  - clearStatus
```
public UserPresence.Builder clearStatus()
```
```
 A user-set status message for this stream, if applicable.
 
```
    .google.protobuf.StringValue status = 5 [json_name = "status"];
  - getStatusBuilder
```
public com.google.protobuf.StringValue.Builder getStatusBuilder()
```
```
 A user-set status message for this stream, if applicable.
 
```
    .google.protobuf.StringValue status = 5 [json_name = "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

Class UserPresence.Builder

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.Message.Builder

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

mergeFrom

mergeFrom

isInitialized

mergeFrom

getUserId

getUserIdBytes

setUserId

clearUserId

setUserIdBytes

getSessionId

getSessionIdBytes

setSessionId

clearSessionId

setSessionIdBytes

getUsername

getUsernameBytes

setUsername

clearUsername

setUsernameBytes

getPersistence

setPersistence

clearPersistence

hasStatus

getStatus

setStatus

setStatus

mergeStatus

clearStatus

getStatusBuilder

getStatusOrBuilder