IUser
Interface that represents user information. Voximplant users are created via the Voximplant control panel or HTTP API.
Methods
getConversationList
List<String>
getConversationList()Gets the list of UUIDs of the conversations that the user currently belongs to.
Note that if the method is called not for the current user, the result is null.
Returns
type:
List<String>
getCustomData
Map<String, Object>
getCustomData()Gets the specified user's public custom data available to all users.
A custom data can be set via the IMessenger.editUser(Map, Map, IMessengerCompletionHandler) method.
Returns
type:
Map<String, Object>
getDisplayName
String
getDisplayName()Gets the user's display name which is specified during user creation via the Voximplant control panel or HTTP API.
The display name is available to all users.
Returns
type:
String
getIMId
long
getIMId()Gets the IM unique ID that is used to identify users in events and specify in user-related methods.
Returns
type:
long
getLeaveConversationList
List<String>
getLeaveConversationList()Gets the list of UUIDs for the conversations that:
- the user belonged to, but currently is not participating in
- are not removed
Note that if the method is called not for the current user, the result is null.
Returns
type:
List<String>
getName
String
getName()Gets the Voximplant user identifier, for example 'username@appname.accname'.
Returns
type:
String
getNotifications
List<MessengerNotification>
getNotifications()Gets the list of messenger notifications that the current user is subscribed to.
Note that if the method is called not for the current user, the result is null.
Returns
type:
List<MessengerNotification>
getPrivateCustomData
Map<String, Object>
getPrivateCustomData()Gets the private custom data available only to the current user.
Returns
type:
Map<String, Object>
isDeleted
boolean
isDeleted()Whether the user is deleted or not.
Returns
type:
boolean