User
Class that represents user information. Voximplant users are created via the Voximplant control panel or HTTP API.
Methods
toString
fun toString(): String
Returns
type:
String
Props
imId
val imId: Long
The IM user id that is used to identify users in events and specify in user-related methods.
Returns
type:
Long
username
val username: String
The Voximplant username, for example username@appname.accname.
Returns
type:
String
displayName
val displayName: String
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
conversationUuidList
val conversationUuidList: List<String>?
The list of UUIDs of the conversations that the user currently belongs to. Can be null or empty.
Note that if this getter is called not for the current user, the result is null.
Returns
type:
List<String>?
leaveConversationUuidList
val leaveConversationUuidList: List<String>?
The list of UUIDs for the conversations that:
- the user belonged to, but currently is not participating in
- are not removed
Can be null or empty.
Note that if this getter is called not for the current user, the result is null.
Returns
type:
List<String>?
customData
val customData: Map<String, Any>?
The specified user's public custom data available to all users.
A custom data can be set via the Messenger.editUser method.
Returns
type:
Map<String, Any>?
privateCustomData
val privateCustomData: Map<String, Any>?
The private custom data available only to the current user.
Note that if this getter is called not for the current user, the result is null.
Returns
type:
Map<String, Any>?
notifications
val notifications: List<MessengerNotification>?
The list of messenger notifications that the current user is subscribed to. Can be null or empty.
Note that if this getter is called not for the current user, the result is null.
Returns
type:
List<MessengerNotification>?
isDeleted
val isDeleted: Boolean
Whether the user is deleted.
Returns
type:
Boolean