Rate this page:

User

Interface representing user information.

Props

conversationList

Copy URL
 conversationList

Array of UUIDs identifying conversations the user is actively participating in.

Only available to the current user and is not accessible to other users.

customData

Copy URL
 customData

Arbitrary open custom data such as description that can be assigned to the user, which accessible and visible to all users.

The data can be set via the Messenger.editUser method.

displayName

Copy URL
 displayName

Display name of the user, which is specified during user creation via the Voximplant control panel or the Management API.

This name is available to all users.

imId

Copy URL
 imId

IM user's ID—the unique ID used to identify users in events and reference in user-related methods.

isDeleted

Copy URL
 isDeleted

Whether the user is deleted.

leaveConversationList

Copy URL
 leaveConversationList

Array of UUIDs for conversations the user previously participated in but is no longer a member of.

Only accessible to the current user.

privateCustomData

Copy URL
 privateCustomData

Arbitrary private custom data such as description that can be assigned to the user, accessible and visible only to the current user.

userName

Copy URL
 userName

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