Method Detail

• buildFromSerializedData

   static User buildFromSerializedData(Array<byte> data)

  Builds User instance from serialized data generated by serialize.

  Parameters:

  data - Serialized User data.

• serialize

   Array<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.

• getUserId

   String getUserId()

  Returns User ID.

• getNickname

   String getNickname()

  Returns User nickname.

• getProfileUrl

   String getProfileUrl()

  Returns the User profile URL. If the file encryption feature is enabled, thereturned url will contain encryption key as a parameter.

  If you enabled the file encryption feature and want to cache the file with URL string asa key, it is recommended to use getPlainProfileImageUrl ()} instead. This isbecause the URL returned by this method embeds getEkey, which changes atevery login, leading to a frequent cache miss.

• getPlainProfileImageUrl

   String getPlainProfileImageUrl()

  Returns plain profile image URL, which does not contain getEkey as aparameter. If the file encryption feature is enabled, you must put getEkey to the request header with {@value StringSet#user_auth_key} as the key. Otherwise, the server will refuse the connection.

  Generally, it is recommended to use getProfileUrl to fetch resources, but if youwant to cache the profile image with URL string as a key while enabled the file encryptionfeature, it is recommended to use this method instead. This is because the URL returnedby this method does not embed getEkey, making it a less changingcache key.

• getOriginalProfileUrl

   String getOriginalProfileUrl()

  Returns User original profile URL.

• getFriendDiscoveryKey

   String getFriendDiscoveryKey()

  Returns friend discovery key.

• getFriendName

   String getFriendName()

  Returns friend name.

• getConnectionStatus

   User.ConnectionStatus getConnectionStatus()

  Returns User connection status.

• getLastSeenAt

   long getLastSeenAt()

  Returns the time this User has been last seen at. Zero if this User is online.

• isActive

   boolean isActive()

  Checks if this user is active.

• createMetaData

   void createMetaData(Map<String, 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.

• updateMetaData

   void updateMetaData(Map<String, String> metaDataMap, User.MetaDataHandler handler)

  Updates meta data.

  Parameters:

  metaDataMap - Meta data key-value map to update.

  handler - Callback handler.

• getMetaData

   String getMetaData(String key)

  Gets meta data.

  Parameters:

  key - Meta data to get.

• getMetaData

   Map<String, String> getMetaData()

  Gets all meta data.

• getPreferredLanguages

   List<String> getPreferredLanguages()

  Gets preferred languages.

• deleteMetaData

   void deleteMetaData(String key, User.DeleteMetaDataHandler handler)

  Deletes a meta data.

  Parameters:

  key - Meta data key to delete.

  handler - Callback handler.

• deleteAllMetaData

   void deleteAllMetaData(User.DeleteMetaDataHandler handler)

  Deletes all meta data.

  Parameters:

  handler - Callback handler.

• equals

   boolean equals(Object o)

• hashCode

   int hashCode()

• toString

   String toString()