User (Sendbird Chat SDK for Android reference)

java.lang.Object
- com.sendbird.android.User

Direct Known Subclasses:

Member, Sender
```
public class User
extends java.lang.Object
```
Represents a user.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`User.ConnectionStatus` The user connection status type.
`static interface`	`User.DeleteMetaDataHandler` DeleteMetaData handler.
`static interface`	`User.MetaDataHandler` MetaData handler.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static User`	`buildFromSerializedData(byte[] data)` Builds `User` instance from serialized data generated by `serialize()`.
`void`	`createMetaData(java.util.Map<java.lang.String,java.lang.String> metaDataMap, User.MetaDataHandler handler)` Creates meta data.
`void`	`deleteAllMetaData(User.DeleteMetaDataHandler handler)` Deletes all meta data.
`void`	`deleteMetaData(java.lang.String key, User.DeleteMetaDataHandler handler)` Deletes a meta data.
`boolean`	`equals(java.lang.Object o)`
`User.ConnectionStatus`	`getConnectionStatus()` Returns `User` connection status.
`java.lang.String`	`getFriendDiscoveryKey()` Returns friend discovery key.
`java.lang.String`	`getFriendName()` Returns friend name.
`long`	`getLastSeenAt()` Returns the time this `User` has been last seen at.
`java.util.Map<java.lang.String,java.lang.String>`	`getMetaData()` Gets all meta data.
`java.lang.String`	`getMetaData(java.lang.String key)` Gets meta data.
`java.lang.String`	`getNickname()` Returns `User` nickname.
`java.lang.String`	`getOriginalProfileUrl()` Returns `User` original profile URL.
`java.lang.String`	`getPlainProfileImageUrl()` Returns plain profile image URL, which does not contain `SendBird.getEkey()` as a parameter.
`java.util.List<java.lang.String>`	`getPreferredLanguages()` Gets preferred languages.
`java.lang.String`	`getProfileUrl()` Returns the `User` profile URL.
`java.lang.String`	`getUserId()` Returns `User` ID.
`int`	`hashCode()`
`boolean`	`isActive()` Checks if this user is active.
`byte[]`	`serialize()` Serializes the `User` instance.
`java.lang.String`	`toString()`
`void`	`updateMetaData(java.util.Map<java.lang.String,java.lang.String> metaDataMap, User.MetaDataHandler handler)` Updates meta data.

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

- Method Detail
  - buildFromSerializedData
```
public static User buildFromSerializedData(byte[] data)
```
    Builds User instance from serialized data generated by serialize().
    
    Parameters:
    
    data - Serialized User data.
    
    Returns:
    
    User instance.
    
    Since:
    
    3.0.19
  - serialize
```
public byte[] serialize()
```
    Serializes the User instance. This byte array can be stored in the database in your application. The instance can be restored by buildFromSerializedData(byte[]).
    
    Returns:
    
    Serialized User data.
    
    Since:
    
    3.0.19
  - getUserId
```
public java.lang.String getUserId()
```
    Returns User ID.
    
    Returns:
    
    The User ID.
  - getNickname
```
public java.lang.String getNickname()
```
    Returns User nickname.
    
    Returns:
    
    The User nickname.
  - getProfileUrl
```
public java.lang.String getProfileUrl()
```
    Returns the User profile URL. If the file encryption feature is enabled, the returned url will contain encryption key as a parameter.
    If you enabled the file encryption feature and want to cache the file with URL string as a key, it is recommended to use getPlainProfileImageUrl() ()} instead. This is because the URL returned by this method embeds SendBird.getEkey(), which changes at every login, leading to a frequent cache miss.
    
    Returns:
    
    The URL.
  - getPlainProfileImageUrl
```
public java.lang.String getPlainProfileImageUrl()
```
    Returns plain profile image URL, which does not contain SendBird.getEkey() as a parameter. If the file encryption feature is enabled, you must put SendBird.getEkey() to the request header with as the key. Otherwise, the server will refuse the connection.
    Generally, it is recommended to use getProfileUrl() to fetch resources, but if you want to cache the profile image with URL string as a key while enabled the file encryption feature, it is recommended to use this method instead. This is because the URL returned by this method does not embed SendBird.getEkey(), making it a less changing cache key.
    
    Returns:
    
    Plain profile image URL without a parameter.
    
    Since:
    
    3.0.140
    
    See Also:
    
    SendBird.getEkey(), getProfileUrl()
  - getOriginalProfileUrl
```
public java.lang.String getOriginalProfileUrl()
```
    Returns User original profile URL.
    
    Returns:
    
    The URL.
    
    Since:
    
    3.0.47
  - getFriendDiscoveryKey
```
public java.lang.String getFriendDiscoveryKey()
```
    Returns friend discovery key.
    
    Returns:
    
    The friend discovery key.
    
    Since:
    
    3.0.47
  - getFriendName
```
public java.lang.String getFriendName()
```
    Returns friend name.
    
    Returns:
    
    The friend name.
    
    Since:
    
    3.0.47
  - getConnectionStatus
```
public User.ConnectionStatus getConnectionStatus()
```
    Returns User connection status.
    
    Returns:
    
    The User connection status.
  - getLastSeenAt
```
public long getLastSeenAt()
```
    Returns the time this User has been last seen at. Zero if this User is online.
    
    Returns:
    
    Timestamp in milliseconds.
  - isActive
```
public boolean isActive()
```
    Checks if this user is active.
    
    Returns:
    
    true if this user is active.
    
    Since:
    
    3.0.45
  - createMetaData
```
public void createMetaData(java.util.Map<java.lang.String,java.lang.String> metaDataMap,
                           User.MetaDataHandler handler)
```
    Creates meta data. This can be used to customize the user.
    
    Parameters:
    
    metaDataMap - Meta data key-value map.
    
    handler - Callback handler.
    
    Since:
    
    3.0.35
  - updateMetaData
```
public void updateMetaData(java.util.Map<java.lang.String,java.lang.String> metaDataMap,
                           User.MetaDataHandler handler)
```
    Updates meta data.
    
    Parameters:
    
    metaDataMap - Meta data key-value map to update.
    
    handler - Callback handler.
    
    Since:
    
    3.0.35
  - getMetaData
```
public java.lang.String getMetaData(java.lang.String key)
```
    Gets meta data.
    
    Parameters:
    
    key - Meta data to get.
    
    Returns:
    
    Meta data value.
    
    Since:
    
    3.0.35
  - getMetaData
```
public java.util.Map<java.lang.String,java.lang.String> getMetaData()
```
    Gets all meta data.
    
    Returns:
    
    Meta data map.
    
    Since:
    
    3.0.35
  - getPreferredLanguages
```
public java.util.List<java.lang.String> getPreferredLanguages()
```
    Gets preferred languages.
    
    Returns:
    
    Preferred languages. If not set, empty List for currentUser, and null for other users.
    
    Since:
    
    3.0.109
  - deleteMetaData
```
public void deleteMetaData(java.lang.String key,
                           User.DeleteMetaDataHandler handler)
```
    Deletes a meta data.
    
    Parameters:
    
    key - Meta data key to delete.
    
    handler - Callback handler.
    
    Since:
    
    3.0.35
  - deleteAllMetaData
```
public void deleteAllMetaData(User.DeleteMetaDataHandler handler)
```
    Deletes all meta data.
    
    Parameters:
    
    handler - Callback handler.
    
    Since:
    
    3.0.35
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class User

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

buildFromSerializedData

serialize

getUserId

getNickname

getProfileUrl

getPlainProfileImageUrl

getOriginalProfileUrl

getFriendDiscoveryKey

getFriendName

getConnectionStatus

getLastSeenAt

isActive

createMetaData

updateMetaData

getMetaData

getMetaData

getPreferredLanguages

deleteMetaData

deleteAllMetaData

equals

hashCode

toString