SIGN UP

MessengerEventTypes

Enum that represents types of messenger events.

Properties

CreateConversation

Event is triggered when a conversation is created via Messenger.createConversation or analogous methods from other Voximplant SDKs and Messaging API.

Triggered only for participants that belong to the conversation.

Handler function receives ConversationEvent object as an argument.

EditConversation

Event is triggered when the conversation properties were modified as the result of:

Triggered only for participants that belong to the conversation.

Handler function receives ConversationEvent object as an argument.

EditMessage

Event is triggered when a message was edited via Message.update or analogous methods from other Voximplant SDKs and Messaging API.

Triggered only for participants that belong to the conversation with the changed message.

Handler function receives MessageEvent object as an argument.

EditUser

Event is triggered as the result of Messenger.editUser or analogous methods from other Voximplant SDKs and Messaging API.

Triggered only for the subscribers of the changed user. Use Messenger.subscribe to subscribe for user's changes.

Handler function receives UserEvent object as an argument.

Error

Type of the event the promises of the Voximplant React Native Messaging methods are rejected with.

Subscription to this event via Messenger.on will never cause the execution of the specified handler function.

GetConversation

Type of the event the promises of the following methods are resolved with:

Subscription to this event via Messenger.on will never cause the execution of the specified handler function.

GetPublicConversations

Type of the event the promise of Messenger.getPublicConversations is resolved with.

Subscription to this event via Messenger.on will never cause the execution of the specified handler function.

GetSubscriptions

Type of the event the promise of Messenger.getSubscriptions is resolved with.

Subscription to this event via Messenger.on will never cause the execution of the specified handler function.

GetUser

Type of the event the promises of the following methods are resolved with:

Subscription to this event via Messenger.on will never cause the execution of the specified handler function.

Read

Event is triggered for all clients in the conversation as the result of Conversation.markAsRead or analogous methods from other Voximplant SDKs and Messaging API.

Handler function receives ConversationServiceEvent object as an argument.

RemoveConversation

Event is triggered when a conversation was removed.

Note that removing is possible via Voximplant Messaging API only.

Triggered only for participants that belong to the conversation.

Handler function receives ConversationEvent object as an argument.

RemoveMessage

Event is triggered when a message was removed from a conversation via Message.remove or analogous methods from other Voximplant SDKs and Messaging API.

Triggered only for participants that belong to the conversation with the deleted message.

Handler function receives MessageEvent object as an argument.

RetransmitEvents

Type of the event the promises of the following methods are resolved with:

Subscription to this event via Messenger.on will never cause the execution of the specified handler function.

SendMessage

Event is triggered when a new message was sent to a conversation via Conversation.sendMessage or analogous methods from other Voximplant SDKs and Messaging API.

Triggered only for participants that belong to the conversation.

Handler function receives MessageEvent object as an argument.

SetStatus

Event is triggered after a user status was changed via Messenger.setStatus or analogous methods from other Voximplant SDKs and Messaging API.

Triggered only for the subscribers of the changed user. Use @link Messenger#subscribe} to subscribe for a user's changes.

Handler function receives UserEvent object as an argument.

Subscribe

Event is triggered as the result of Messenger.subscribe or analogous methods from other Voximplant SDKs and Messaging API.

Triggered on all logged in clients of the current user.

Handler function receives SubscriptionEvent object as an argument.

Typing

Event is triggered when some user is typing text in a conversation. Information about typing is received via Conversation.typing or analogous methods from other Voximplant SDKs and Messaging API.

Triggered only for participants that belong to the conversation where typing is performing.

Handler function receives ConversationServiceEvent object as an argument.

Unsubscribe

Invoked as the result of Messenger.unsubscribe, Messenger.unsubscribeFromAll or analogous methods from other Voximplant SDKs and Messaging API.

Triggered on all logged in clients of the current user.

Handler function receives SubscriptionEvent object as an argument.