Rate this page:

IUser

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

Methods

getConversationList

Copy URL

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

  • type:

    List<String>

getCustomData

Copy URL

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

  • type:

    Map<String, Object>

getDisplayName

Copy URL

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

  • type:

    String

getIMId

Copy URL

long

getIMId()

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

Returns

  • type:

    long

getLeaveConversationList

Copy URL

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

  • type:

    List<String>

getName

Copy URL

String

getName()

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

Returns

  • type:

    String

getNotifications

Copy URL

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

Copy URL

Map<String, Object>

getPrivateCustomData()

Get private custom data available only to the current user.

Returns

  • type:

    Map<String, Object>

isDeleted

Copy URL

boolean

isDeleted()

Check if the user is deleted or not.

Returns

  • type:

    boolean