1. References
  2. Android SDK v3 (Beta)
  3. com.voximplant.android.sdk.messaging
  4. User
Rate this page:

User

This API is in beta and subject to change.

Interface that represents user information. Voximplant users are created via the Voximplant control panel or HTTP API.

Props

imId

Copy URL
val imId: 
Long

This API is in beta and subject to change.

The IM user id that is used to identify users in events and specify in user-related methods.

Returns

  • type:

    Long

username

Copy URL
val username: 
String

This API is in beta and subject to change.

The Voximplant username, for example username@appname.accname.

Returns

  • type:

    String

displayName

Copy URL
val displayName: 
String

This API is in beta and subject to change.

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

Copy URL
val conversationUuidList: 
List<String>?

This API is in beta and subject to change.

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

Copy URL
val leaveConversationUuidList: 
List<String>?

This API is in beta and subject to change.

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

Copy URL
val customData: 
Map<String, Any>?

This API is in beta and subject to change.

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

Copy URL
val privateCustomData: 
Map<String, Any>?

This API is in beta and subject to change.

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

Copy URL
val notifications: 
List<MessengerNotification>?

This API is in beta and subject to change.

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

isDeleted

Copy URL
val isDeleted: 
Boolean

This API is in beta and subject to change.

Whether the user is deleted.

Returns

  • type:

    Boolean