VIMessenger class
Interface that may be used to control messaging functions.
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- me → String?
-
Get the Voximplant user identifier for the current user, e.g., 'username@appname.accname'
no setter
- onCreateConversation ↔ VICreateConversation?
-
Callback for getting notified when a new conversation is created
with the current user.
getter/setter pair
- onEditConversation ↔ VIEditConversation?
-
Callback for getting notified when the properties of a conversation
the current user belongs to were modified
getter/setter pair
- onEditMessage ↔ VIEditMessage?
-
Callback for getting notified when a message was edited
getter/setter pair
- onEditUser ↔ VIEditUser?
-
Callback for getting notified when an user changes
getter/setter pair
- onRead ↔ VIIsRead?
-
Callback for getting notified when a participant in a conversation mark the event as read
getter/setter pair
- onRemoveConversation ↔ VIRemoveConversation?
-
Callback for getting notified when a conversation
the current user belongs to is removed
getter/setter pair
- onRemoveMessage ↔ VIRemoveMessage?
-
Callback for getting notified when a message was removed from a conversation
the current user belongs to
getter/setter pair
- onSendMessage ↔ VISendMessage?
-
Callback for getting notified when a new message was sent to a conversation
the current user belongs to
getter/setter pair
- onSetStatus ↔ VISetStatus?
-
Callback for getting notified when an user status was changed
getter/setter pair
- onSubscribe ↔ VISubscribe?
-
Callback for getting notified about new subscriptions.
getter/setter pair
- onTyping ↔ VITyping?
-
Callback for getting notified when some user is typing text in a conversation.
getter/setter pair
- onUnsubscribe ↔ VIUnsubscribe?
-
Callback for getting notified about changes in current subscriptions.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
createConversation(
VIConversationConfig config) → Future< VIConversationEvent> - Create a new conversation with the extended configuration.
-
editUser(
Map< String, Object> ? customData, Map<String, Object> ? privateCustomData) → Future<VIUserEvent> - Edit current user information.
-
getConversation(
String uuid) → Future< VIConversationEvent> - Get a conversation by its UUID.
-
getConversations(
List< String> uuids) → Future<List< VIConversationEvent> > - Get the multiple conversations by the list of UUIDs. Maximum 30 conversations.
-
getPublicConversations(
) → Future< VIConversationListEvent> - Get all public conversations (VIConversation.publicJoin is true).
-
getSubscriptions(
) → Future< VISubscriptionEvent> - Get all current subscriptions, i.e., the list of users the current user is subscribed to.
-
getUserByIMId(
int userId) → Future< VIUserEvent> - Get information for the user specified by the IM user id.
-
getUserByName(
String username) → Future< VIUserEvent> - Get information for the user specified by the Voximplant user name, e.g., 'username@appname.accname'.
-
getUsersByIMId(
List< int> users) → Future<List< VIUserEvent> > - Get information for the users specified by the list of the IM user ids. Maximum 50 users.
-
getUsersByName(
List< String> users) → Future<List< VIUserEvent> > - Get information for the users specified by the list of the Voximplant user names. Maximum 50 users.
-
joinConversation(
String uuid) → Future< VIConversationEvent> - Join the current user to any conversation specified by the UUID.
-
leaveConversation(
String uuid) → Future< VIConversationEvent> - Make the current user to leave a conversation specified by the UUID.
-
managePushNotifications(
List< VIMessengerNotification> ? notifications) → Future<VIUserEvent> - Manage messenger push notification subscriptions for the current user.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
recreateConversation(
String uuid, {required VIConversationConfig conversationConfig, required int lastSequence, required int lastUpdateTime, required int createdTime}) → VIConversation - Recreate a conversation.
-
recreateMessage(
String uuid, String conversationUuid, {required String text, required List< Map< payload, int sequence = 0}) → VIMessageString, Object> > - Recreate a message.
-
setStatus(
bool online) → Future< VIStatusEvent> - Set the current user status.
-
subscribe(
List< int> users) → Future<VISubscriptionEvent> - Subscribe for other user(s) information and status changes.
-
toString(
) → String -
A string representation of this object.
inherited
-
unsubscribe(
List< int> users) → Future<VISubscriptionEvent> - Unsubscribe from other user(s) information and status changes.
-
unsubscribeFromAll(
) → Future< VISubscriptionEvent> - Unsubscribe from all subscriptions.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited