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.
|
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.
|
public static User buildFromSerializedData(byte[] data)
User
instance from serialized data generated by serialize()
.data
- Serialized User
data.User
instance.public byte[] serialize()
User
instance. This byte array can be stored in the database in your application.
The instance can be restored by buildFromSerializedData(byte[])
.User
data.public java.lang.String getUserId()
User
ID.User
ID.public java.lang.String getNickname()
User
nickname.User
nickname.public java.lang.String getProfileUrl()
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.
public java.lang.String getPlainProfileImageUrl()
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.
SendBird.getEkey()
,
getProfileUrl()
public java.lang.String getOriginalProfileUrl()
User
original profile URL.public java.lang.String getFriendDiscoveryKey()
public java.lang.String getFriendName()
public User.ConnectionStatus getConnectionStatus()
User
connection status.User
connection status.public long getLastSeenAt()
User
has been last seen at. Zero if this User
is online.public boolean isActive()
true
if this user is active.public void createMetaData(java.util.Map<java.lang.String,java.lang.String> metaDataMap, User.MetaDataHandler handler)
metaDataMap
- Meta data key-value map.handler
- Callback handler.public void updateMetaData(java.util.Map<java.lang.String,java.lang.String> metaDataMap, User.MetaDataHandler handler)
metaDataMap
- Meta data key-value map to update.handler
- Callback handler.public java.lang.String getMetaData(java.lang.String key)
key
- Meta data to get.public java.util.Map<java.lang.String,java.lang.String> getMetaData()
public java.util.List<java.lang.String> getPreferredLanguages()
List
for currentUser, and null
for other users.public void deleteMetaData(java.lang.String key, User.DeleteMetaDataHandler handler)
key
- Meta data key to delete.handler
- Callback handler.public void deleteAllMetaData(User.DeleteMetaDataHandler handler)
handler
- Callback handler.public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
Copyright © 2021, Sendbird or its affiliates. All rights reserved.
Report a bug or request a feature
For further developer documentation, see Chat SDK Documentation. That documentation contains more detailed descriptions, conceptual overviews, definitions of terms, and code examples.