Rate this page:

VIUser

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

Props

conversationList

Copy URL

List<String>

conversationList

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>

customData

Copy URL

Map<String, dynamic>

customData

The specified user's public custom data available to all users.

A custom data can be set via the VIMessenger.editUser method.

Returns

  • type:

    Map<String, dynamic>

displayName

Copy URL

String

displayName

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

imId

Copy URL

int

imId

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

Returns

  • type:

    int

isDeleted

Copy URL

bool

isDeleted

Determines whether the user is deleted or not.

Returns

  • type:

    bool

leaveConversationList

Copy URL

List<String>

leaveConversationList

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>

name

Copy URL

String

name

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

Returns

  • type:

    String

notifications

Copy URL

List<VIMessengerNotification>

notifications

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

privateCustomData

Copy URL

Map<String, dynamic>

privateCustomData

Private custom data available only to the current user.

Returns

  • type:

    Map<String, dynamic>