IConversation

Adds new participants to the conversation.

It is possible only on the following conditions:

• the participants are users of the main Voximplant developer account or its child accounts
• the current user can manage other participants (ConversationParticipant.canManageParticipants() is true)
• the conversation is not a direct one (IConversation.isDirect() is false)

Duplicated users are ignored. Causes IErrorEvent if at least one user does not exist or already belongs to the conversation.

To get the method call result use one of the following options:

1. Specify the handler parameter to consume the results with IConversationEvent or IErrorEvent in case of success/error accordingly.
2. Implement the IMessengerListener.onEditConversation(IConversationEvent) and IMessengerListener.onError(IErrorEvent) events.

Other parties of the conversation (online participants and logged in clients) can be informed about adding participants via the IMessengerListener.onEditConversation(IConversationEvent) event.

Edits participants' permissions. It is possible only if the current user can manage other participants (ConversationParticipant.canManageParticipants() is true).

Duplicated users are ignored. Causes IErrorEvent if at least one user does not exist or belong to the conversation.

To get the method call result use one of the following options:

1. Specify the handler parameter to consume the results with IConversationEvent or IErrorEvent in case of success/error accordingly.
2. Implement the IMessengerListener.onEditConversation(IConversationEvent) and IMessengerListener.onError(IErrorEvent) events.

Other parties of the conversation (online participants and logged in clients) can be informed about editing participants via the IMessengerListener.onEditConversation(IConversationEvent) event.

Gets the UNIX timestamp (seconds) that specifies the time of the conversation creation.

Gets a custom data, up to 5kb.

Returns the sequence of the last event in the conversation.

Gets the UNIX timestamp (seconds) that specifies the time when one of IConversationEvent or IMessageEvent has been the last triggered event in this conversation.

Gets the list of participants alongside with their permissions.

Gets the current conversation title.

Gets the universally unique identifier (UUID) of this conversation.

Whether the conversation is direct.

A direct conversation cannot be uber and/or public.

There can be only 2 participants in a direct conversation which is unique and the only one for these participants. There cannot be more than 1 direct conversation for the same 2 users.

If one of these users tries to create a new direct conversation with the same participant via IMessenger.createConversation(ConversationConfig, IMessengerCompletionHandler), the method returns the UUID of the already existing direct conversation.

Whether a conversation is public. In a public one, anyone can join the conversation by UUID.

A public conversation cannot be direct.

Whether the conversation is uber or not.

A uber conversation cannot be direct.

Users in a uber conversation cannot retrieve messages that have been posted to the conversation after they quit.

Marks the event with the specified sequence as read.

A method call with the specified sequence makes the ConversationParticipant.getLastReadEventSequence() method return this sequence, i.e., such sequences can be get for each participant separately.

If the sequence parameter specified less than 1, the method marks all the events as unread (for this participant) except the event with the sequence equals to '1'.

To get the method call result use one of the following options:

1. Specify the handler parameter to consume the results with IConversationServiceEvent or IErrorEvent in case of success/error accordingly.
2. Implement the IMessengerListener.isRead(IConversationServiceEvent) and IMessengerListener.onError(IErrorEvent) events.

Other parties of the conversation (online participants and logged in clients) can be informed about marking events as read via the IMessengerListener.isRead(IConversationServiceEvent) event.

Removes participants from the conversation.

It is possible only on two conditions:

• the current user can manage other participants (ConversationParticipant.canManageParticipants() is true).
• the conversation is not a direct one (IConversation.isDirect() is false)

Duplicated users are ignored. Causes IErrorEvent if at least one user:

• does not exist
• is already removed

Note that you can remove participants that are marked as deleted (IUser.isDeleted() is true).

The removed users can later get this conversation's UUID via the IUser.getLeaveConversationList() method.

To get the method call result use one of the following options:

1. Specify the handler parameter to consume the results with IConversationEvent or IErrorEvent in case of success/error accordingly.
2. Implement the IMessengerListener.onEditConversation(IConversationEvent) and IMessengerListener.onError(IErrorEvent) events.

Other parties of the conversation (online participants and logged in clients) can be informed about removing participants via the IMessengerListener.onEditConversation(IConversationEvent) event.

Requests events in the specified sequence range to be sent from the cloud to this client.

Only IConversationEvent and IMessageEvent events can be retransmitted; any other events cannot be retransmitted.

The method is used to get history or missed events in case of network disconnect. Client should use this method to request all events based on the last event sequence received from the cloud and last event sequence saved locally (if any).

The maximum number of retransmitted events per method call is 100. Requesting more than 100 events causes IErrorEvent.

If the current user quits a IConversation.isUber() conversation, messages that are posted during the user's absence are not retransmitted later.

To get the method call result use one of the following options:

1. Specify the handler parameter to consume the results with IRetransmitEvent or IErrorEvent in case of success/error accordingly.
2. Implement the IMessengerListener.onRetransmitEvents(IRetransmitEvent) and IMessengerListener.onError(IErrorEvent) events.

Requests a number of events starting with the specified sequence to be sent from the cloud to this client.

Only IConversationEvent and IMessageEvent events can be retransmitted; any other events cannot be retransmitted.

The method is used to get history or get missed events in case of network disconnect. Client should use this method to request all events based on the last event sequence received from the cloud and last event sequence saved locally (if any).

The maximum number of retransmitted events per method call is 100. Requesting more than 100 events causes an IErrorEvent.

If the current user quits a IConversation.isUber() conversation, messages that are posted during the user's absence are not retransmitted later.

The result contains maximum available events for the current user even if it is less than the specified count value. To get the method call result use one of the following options:

1. Specify the handler parameter to consume the results with IRetransmitEvent or IErrorEvent in case of success/error accordingly.
2. Implement the IMessengerListener.onRetransmitEvents(IRetransmitEvent) and IMessengerListener.onError(IErrorEvent) events.

Requests a number of events up to the specified sequence to be sent from the cloud to this client.

Only IConversationEvent and IMessageEvent events can be retransmitted; any other events cannot be retransmitted.

The method is used to get history or get missed events in case of network disconnect. Client should use this method to request all events based on the last event sequence received from the cloud and last event sequence saved locally (if any).

The maximum number of retransmitted events per method call is 100. Requesting more than 100 events causes IErrorEvent.

If the current user quits a IConversation.isUber() conversation, messages that are posted during the user's absence are not retransmitted later.

The result contains maximum available events for the current user even if it is less than the specified count value. To get the method call result use one of the following options:

1. Specify the handler parameter to consume the results with IRetransmitEvent or IErrorEvent in case of success/error accordingly.
2. Implement the IMessengerListener.onRetransmitEvents(IRetransmitEvent) and IMessengerListener.onError(IErrorEvent) events.

Sends a message to the conversation.

Sending messages is available only for participants that have write permissions (ConversationParticipant.canWrite() is true).

To get the method call result use one of the following options:

1. Specify the handler parameter to consume the results with IMessageEvent or IErrorEvent in case of success/error accordingly.
2. Implement the IMessengerListener.onSendMessage(IMessageEvent) and IMessengerListener.onError(IErrorEvent) events.

Other parties of the conversation (online participants and logged in clients) can be informed about sending messages to the conversation via the IMessengerListener.onSendMessage(IMessageEvent) event.

To be informed about sending messages while being offline, participants can subscribe to the MessengerNotification.ON_SEND_MESSAGE messenger push notification.

Sets a new custom data for the conversation.

Note that calling this method does not send changes to the cloud. Use IConversation.update(IMessengerCompletionHandler)} to send all changes at once.

Whether to enable public join in the conversation.

A public conversation cannot be direct.

Note that calling this method does not send changes to the cloud. Use IConversation.update(IMessengerCompletionHandler) to send all changes at once

Sets a new title for the current conversation.

Note that calling this method does not send changes to the cloud. Use IConversation.update(IMessengerCompletionHandler) to send all changes at once.

Informs the cloud that the user is typing some text.

The method calls within 10s interval from the last call cause IErrorEvent.

To get the method call result use one of the following options:

1. Specify the handler parameter to consume the results with IConversationServiceEvent or IErrorEvent in case of success/error accordingly.
2. Implement the IMessengerListener.onTyping(IConversationServiceEvent) and IMessengerListener.onError(IErrorEvent) events.

Other parties of the conversation (online participants and logged in clients) can be informed about typing via the IMessengerListener.onTyping(IConversationServiceEvent) event.

Sends the conversation changes to the cloud. The sent changes are: title, public join flag and custom data.

Successful update happens if a participant is the owner (ConversationParticipant.isOwner() is true).

To get the method call result use one of the following options:

1. Specify the handler parameter to consume the results with IConversationEvent or IErrorEvent in case of success/error accordingly.
2. Implement the IMessengerListener.onEditConversation(IConversationEvent) and IMessengerListener.onError(IErrorEvent) events.

Other parties of the conversation (online participants and logged in clients) can be informed about changing the title or custom data and enabling/disabling public join via the IMessengerListener.onEditConversation(IConversationEvent) event.