SIGN UP

IUser

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

Methods

getConversationList

List<String> getConversationList()

Get 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 will be null.

Returns

  • Return:

    List<String>

    List of conversation UUIDs (can be empty list) or null

getCustomData

Map<String,Object> getCustomData()

Get 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

  • Return:

    Map<String,Object>

    Public custom data

getDisplayName

String getDisplayName()

Get 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

  • Return:

    String

    User display name

getIMId

long getIMId()

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

Returns

  • Return:

    long

    IM user id

getLeaveConversationList

List<String> getLeaveConversationList()

Get 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 will be null.

Returns

  • Return:

    List<String>

    List of conversations UUIDs (can be empty list) or null

getName

String getName()

Get the Voximplant user identifier, for example 'username@appname.accname'.

Returns

  • Return:

    String

    Voximplant user identifier

getNotifications

List<MessengerNotification> getNotifications()

Get 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 will be null.

Returns

getPrivateCustomData

Map<String,Object> getPrivateCustomData()

Get private custom data available only to the current user.

Returns

  • Return:

    Map<String,Object>

    Private custom data, or null if a user is not the current user

isDeleted

boolean isDeleted()

Check if the user is deleted or not.

Returns

  • Return:

    boolean

    True if the user was deleted, false otherwise