NexmoConversation (NexmoClient 4.1.3)

java.lang.Object
- com.nexmo.client.NexmoConversation

All Implemented Interfaces:: android.os.Parcelable, java.lang.Comparable<NexmoConversation>

public class NexmoConversation
extends java.lang.Object
implements android.os.Parcelable, java.lang.Comparable<NexmoConversation>

Class allows users to communicate with each other by sending events (eg. text message or an image). Each NexmoUser that joined the conversation (has NexmoMemberState) is represented as NexmoMember. Each conversation message is represented as NexmoEvent eg. NexmoTextEvent.

Before creating new conversation NexmoClient has to be initialized.

Create a new conversation using NexmoClient instance:

 client.newConversation("My NexmoConversation name", "My NexmoConversation display name", new RequestHandler<NexmoConversation>() {
     @Override
     public void onSuccess(NexmoConversation conversation) {
          Log.d("onSuccess", "Conversation loaded " + conversation.getDisplayName());
     }
     @Override
     public void onError(NexmoAPIError error) {
          Log.d("onError", "Error: Unable to load conversation %s", apiError.getMessage());
     }
 });

In above example name can be supplied, but if left empty the name will be auto-generated and assigned to the conversation.

Load existing conversation:

 client.getConversation("conversationId", new NexmoRequestListener() {
     @Override
     public void onSuccess(@Nullable NexmoConversation conversation) {
         Log.d("onSuccess", "Conversation loaded " + conversation.getDisplayName());
     }

     @Override
     public void onError(@NonNull NexmoApiError error) {
         Log.d("onError", "Error: Unable to load conversation %s", apiError.getMessage());
     }
 });

Join the NexmoConversation:

 conversation.join("username", new NexmoRequestListener<NexmoMember>() {

      @Override
      public void onSuccess(NexmoMember member) {
           // member.getUser().getName();
      }

      @Override
      public void onError(NexmoAPIError apiError) {
           // apiError.getMessage());
      }
 });

Send a text message to the conversation:

 conversation.sendText("message payload...", new NexmoRequestListener<NexmoEvent>() {

     @Override
     public void onSuccess(NexmoEvent event) {
          // Message sent
     }

     @Override
     public void onError(NexmoAPIError apiError) {
          // apiError.getMessage());
     }
 });

In above example will be relayed to every other member of the conversation.

Listen for incoming message events:

   conversation.addMessageEventListener().add(new MessageEventListener() {

    @Override
    public void onTextEvent(TextEvent text) {
        // New text message received
    }

    @Override
    public void onAttachmentEvent(AttachmentEvent attachment) {
        // New attachment received
    }

    @Override
    public void onEventDeleted(DeletedEvent deleteEvent) {
    }
  });

Load all conversation events:

 conversation.getEvents(100, NexmoPageOrder.NexmoMPageOrderAsc, null, new NexmoRequestListener() {
     @Override
     public void onSuccess(@Nullable NexmoEventsPage eventsPage) {
         // eventsPage.getData();
     }

     @Override
     public void onError(@NonNull NexmoApiError apiError) {
         // apiError.getMessage());
     }
 });

For more use cases and samples please check the client-sdk-android-samples repository.

Nested Class Summary
- Nested classes/interfaces inherited from interface android.os.Parcelable
  android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields
Modifier and Type Field and Description

static android.os.Parcelable.Creator<NexmoConversation> CREATOR
- Fields inherited from interface android.os.Parcelable
  CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Fields
Modifier and Type	Field and Description
`static android.os.Parcelable.Creator<NexmoConversation>`	`CREATOR`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addCustomEventListener(NexmoCustomEventListener listener)` Adds a callback to be invoked when custom event is received.
`void`	`addDTMFEventListener(NexmoDTMFEventListener listener)` Deprecated.
`void`	`addLegStatusEventListener(NexmoLegStatusEventListener listener)` Adds a callback to be invoked when leg event is received.
`void`	`addMediaActionEventListener(NexmoMediaActionEventListener mediaActionEventListener)` Adds a callback to be invoked when media action event is received.
`void`	`addMediaEventListener(NexmoMediaEventListener mediaEventListener)` Adds a callback to be invoked when media event is received.
`void`	`addMediaStatusListener(NexmoMediaStatusListener listener)` Adds a callback to be invoked when media status is received.
`void`	`addMemberEventListener(NexmoMemberEventListener listener)` Adds a callback to be invoked when member event is received.
`void`	`addMemberMessageStatusEventListener(NexmoMemberMessageStatusEventListener listener)` Adds a callback to be invoked when member message status event is received.
`void`	`addMessageEventListener(NexmoMessageEventListener listener)` Adds a callback to be invoked when conversation message is received.
`void`	`addNexmoConversationListener(NexmoConversationListener listener)` Adds a callback to be invoked when conversation related event occurs.
`void`	`addTypingEventListener(NexmoTypingEventListener listener)` Adds a callback to be invoked when typing event is received.
`void`	`clearCustomEventListeners()` Unsubscribes all listeners from Custom events.
`void`	`clearDTMFEventListeners()` Unsubscribes all listeners from DTMF events.
`void`	`clearLegStatusEventListeners()` Unsubscribes all listeners from Leg Status events.
`void`	`clearMemberEventListeners()` Unsubscribes all listeners from incoming Member related events.
`void`	`clearMemberMessageStatusEventListeners()` Unsubscribes all listeners from member message status events.
`void`	`clearMessageEventListeners()` Unsubscribes all listeners from incoming Message related events.
`void`	`clearNexmoConversationListeners()` Unsubscribes all listeners from incoming Message related events.
`void`	`clearNexmoEventsListeners()` Unsubscribes all listeners from incoming events.
`void`	`clearTypingEventListeners()` Unsubscribes all listeners from incoming Typing related events.
`int`	`compareTo(NexmoConversation nexmoConversation)`
`int`	`describeContents()`
`void`	`disableMedia()`
`void`	`enableMedia()`
`boolean`	`equals(java.lang.Object o)`
`java.lang.String`	`getConversationId()` Gets the id of this conversation synchronously.
`java.util.Date`	`getCreationDate()` Gets the creation date of this conversation synchronously.
`java.lang.String`	`getDisplayName()` Gets the display name of this conversation synchronously.
`void`	`getEvents(java.lang.Integer pageSize, NexmoPageOrder order, NexmoRequestListener<NexmoEventsPage> listener)` Deprecated.
`void`	`getEvents(java.lang.Integer pageSize, NexmoPageOrder order, java.lang.String eventType, NexmoRequestListener<NexmoEventsPage> listener)`
`java.lang.String`	`getLastEventId()` Gets the id of the last NexmoEvent in this conversation synchronously.
`void`	`getMember(java.lang.String memberId, NexmoRequestListener<NexmoMember> listener)` Get conversation member by id.
`void`	`getMembers(java.lang.Integer pageSize, NexmoPageOrder order, NexmoRequestListener<NexmoMembersSummaryPage> listener)`
`NexmoMember`	`getMyMember()` Gets member of the conversation that represents currently logged in `NexmoUser`.
`java.lang.String`	`getName()` Gets the name of this conversation synchronously.
`int`	`hashCode()`
`void`	`invite(java.lang.String userName, NexmoRequestListener<java.lang.String> listener)`
`void`	`join(NexmoRequestListener<java.lang.Void> listener)` Joins the current logged in `NexmoUser` to this conversation.
`void`	`join(java.lang.String username, NexmoRequestListener<java.lang.String> listener)` Joins a `NexmoUser` to this conversation.
`void`	`kick(java.lang.String memberId, NexmoRequestListener<java.lang.Void> listener)` Removes a `NexmoUser` from this conversation.
`void`	`reconnectMedia()` Manually Reconnect Media Stream
`void`	`removeCustomEventListener(NexmoCustomEventListener listener)` Unsubscribes from Custom events.
`void`	`removeDTMFEventListener(NexmoDTMFEventListener listener)` Deprecated.
`void`	`removeLegStatusEventListener(NexmoLegStatusEventListener listener)` Unsubscribes from Leg Status events.
`void`	`removeMemberEventListener(NexmoMemberEventListener listener)` Unsubscribes from incoming Member related events.
`void`	`removeMemberMessageStatusEventListener(NexmoMemberMessageStatusEventListener listener)` Unsubscribes from member message events.
`void`	`removeMessageEventListener(NexmoMessageEventListener listener)` Unsubscribes from incoming Message related events.
`void`	`removeNexmoConversationListener(NexmoConversationListener listener)` Unsubscribes from incoming Message related events.
`void`	`removeTypingEventListener(NexmoTypingEventListener listener)` Unsubscribes from incoming Typing related events.
`void`	`sendAttachment(java.io.File attachment, NexmoRequestListener listener)` Deprecated. Use NexmoClient.uploadAttachment(attachment, listener) and NexmoConversation.sendMessage(message, listener) methods instead. Once the image is uploaded, you will be able to access all 3 representations: Original at 100% size via `NexmoAttachmentEvent.getOriginal()` Medium at 50% size via `NexmoAttachmentEvent.getMedium()` Thumbnail at 10% size via `NexmoAttachmentEvent.getThumbnail()`
`void`	`sendCustomEvent(java.lang.String customType, java.util.HashMap<java.lang.String,java.lang.Object> customData, NexmoRequestListener<java.lang.Void> listener)` Sends a Custom event to a conversation.
`void`	`sendMessage(NexmoMessage message, NexmoRequestListener<java.lang.Void> listener)` Sends a Message event to a conversation.
`void`	`sendText(java.lang.String text, NexmoRequestListener<java.lang.Void> listener)` Deprecated. Use NexmoConversation.sendMessage(message, listener) method instead.
`void`	`startTyping()` Sends start typing indication.
`void`	`stopTyping()` Sends stop typing indication.
`java.lang.String`	`toString()`
`void`	`writeToParcel(android.os.Parcel dest, int flags)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - CREATOR
```
public static final android.os.Parcelable.Creator<NexmoConversation> CREATOR
```
- Method Detail
  - getMyMember
```
public NexmoMember getMyMember()
```
    Gets member of the conversation that represents currently logged in NexmoUser.
  - getEvents
```
@Deprecated
public void getEvents(java.lang.Integer pageSize,
                                  NexmoPageOrder order,
                                  NexmoRequestListener<NexmoEventsPage> listener)
```
    Deprecated.
  - getEvents
```
public void getEvents(java.lang.Integer pageSize,
                      NexmoPageOrder order,
                      java.lang.String eventType,
                      NexmoRequestListener<NexmoEventsPage> listener)
```
  - getMembers
```
public void getMembers(java.lang.Integer pageSize,
                       NexmoPageOrder order,
                       NexmoRequestListener<NexmoMembersSummaryPage> listener)
```
  - getMember
```
public void getMember(java.lang.String memberId,
                      NexmoRequestListener<NexmoMember> listener)
```
    Get conversation member by id.
    
    Parameters:
    
    memberId - member identifier.
  - sendText
```
public void sendText(java.lang.String text,
                     NexmoRequestListener<java.lang.Void> listener)
```
    Deprecated. Use NexmoConversation.sendMessage(message, listener) method instead.
    
    Sends a Text event to a conversation.
    
    Parameters:
    
    text - The text payload.
    
    listener - The request completion listener.
  - sendMessage
```
public void sendMessage(NexmoMessage message,
                        NexmoRequestListener<java.lang.Void> listener)
```
    Sends a Message event to a conversation.
    
    Parameters:
    
    message - The params of the message event.
    
    listener - The request completion listener.
  - sendCustomEvent
```
public void sendCustomEvent(java.lang.String customType,
                            java.util.HashMap<java.lang.String,java.lang.Object> customData,
                            NexmoRequestListener<java.lang.Void> listener)
```
    Sends a Custom event to a conversation.
    
    Parameters:
    
    customType - the type of custom event.
    
    customData - the data of custom event.
    
    listener - The request completion listener.
  - sendAttachment
```
public void sendAttachment(java.io.File attachment,
                           NexmoRequestListener listener)
```
    Deprecated.
    Use NexmoClient.uploadAttachment(attachment, listener) and NexmoConversation.sendMessage(message, listener) methods instead.
    Once the image is uploaded, you will be able to access all 3 representations:
    
    Original at 100% size via NexmoAttachmentEvent.getOriginal()
    
    Medium at 50% size via NexmoAttachmentEvent.getMedium()
    
    Thumbnail at 10% size via NexmoAttachmentEvent.getThumbnail()
    Sends/Uploads an attachment to a conversation.
    
    Parameters:
    
    attachment - The attachment file.
    
    listener - The request completion listener.
  - join
```
public void join(NexmoRequestListener<java.lang.Void> listener)
```
    Joins the current logged in NexmoUser to this conversation.
    Note: any NexmoUser that joins a NexmoConversation becomes a NexmoMember.
    
    Parameters:
    
    listener - The request completion listener.
  - join
```
public void join(java.lang.String username,
                 NexmoRequestListener<java.lang.String> listener)
```
    Joins a NexmoUser to this conversation.
    Note: any NexmoUser that joins a NexmoConversation becomes a NexmoMember.
    
    Parameters:
    
    username - The username of the user that will join this NexmoConversation.
    
    listener - The request completion listener.
  - kick
```
public void kick(java.lang.String memberId,
                 NexmoRequestListener<java.lang.Void> listener)
```
    Removes a NexmoUser from this conversation.
    
    Parameters:
    
    memberId - The memberId to be removed.
    
    listener - The request completion listener.
  - invite
```
public void invite(java.lang.String userName,
                   NexmoRequestListener<java.lang.String> listener)
```
  - startTyping
```
public void startTyping()
```
    Sends start typing indication.
  - stopTyping
```
public void stopTyping()
```
    Sends stop typing indication.
  - addNexmoConversationListener
```
public void addNexmoConversationListener(NexmoConversationListener listener)
```
    Adds a callback to be invoked when conversation related event occurs.
    
    Parameters:
    
    listener - NexmoConversationListener.
  - removeNexmoConversationListener
```
public void removeNexmoConversationListener(NexmoConversationListener listener)
```
    Unsubscribes from incoming Message related events.
    
    Parameters:
    
    listener - NexmoConversationListener.
  - clearNexmoConversationListeners
```
public void clearNexmoConversationListeners()
```
    Unsubscribes all listeners from incoming Message related events.
  - addMessageEventListener
```
public void addMessageEventListener(NexmoMessageEventListener listener)
```
    Adds a callback to be invoked when conversation message is received.
    Event types:
    - Nexmo Text event
    - Nexmo Attachment event.
    - Nexmo Message event.
    Parameters:
    
    listener - Event listener.
  - removeMessageEventListener
```
public void removeMessageEventListener(NexmoMessageEventListener listener)
```
    Unsubscribes from incoming Message related events.
    
    Parameters:
    
    listener - Event listener.
  - clearMessageEventListeners
```
public void clearMessageEventListeners()
```
    Unsubscribes all listeners from incoming Message related events.
  - addDTMFEventListener
```
@Deprecated
public void addDTMFEventListener(NexmoDTMFEventListener listener)
```
    Deprecated.
    
    Adds a callback to be invoked when DTMF event is received.
    
    Parameters:
    
    listener - Event listener.
  - removeDTMFEventListener
```
@Deprecated
public void removeDTMFEventListener(NexmoDTMFEventListener listener)
```
    Deprecated.
    
    Unsubscribes from DTMF events.
    
    Parameters:
    
    listener - Event listener.
  - clearDTMFEventListeners
```
public void clearDTMFEventListeners()
```
    Unsubscribes all listeners from DTMF events.
  - addLegStatusEventListener
```
public void addLegStatusEventListener(NexmoLegStatusEventListener listener)
```
    Adds a callback to be invoked when leg event is received.
    
    Parameters:
    
    listener - Event listener.
  - removeLegStatusEventListener
```
public void removeLegStatusEventListener(NexmoLegStatusEventListener listener)
```
    Unsubscribes from Leg Status events.
    
    Parameters:
    
    listener - Event listener.
  - clearLegStatusEventListeners
```
public void clearLegStatusEventListeners()
```
    Unsubscribes all listeners from Leg Status events.
  - addMemberMessageStatusEventListener
```
public void addMemberMessageStatusEventListener(NexmoMemberMessageStatusEventListener listener)
```
    Adds a callback to be invoked when member message status event is received.
    
    Parameters:
    
    listener - Event listener.
  - removeMemberMessageStatusEventListener
```
public void removeMemberMessageStatusEventListener(NexmoMemberMessageStatusEventListener listener)
```
    Unsubscribes from member message events.
    
    Parameters:
    
    listener - Event listener.
  - clearMemberMessageStatusEventListeners
```
public void clearMemberMessageStatusEventListeners()
```
    Unsubscribes all listeners from member message status events.
  - addCustomEventListener
```
public void addCustomEventListener(NexmoCustomEventListener listener)
```
    Adds a callback to be invoked when custom event is received.
    
    Parameters:
    
    listener - Event listener.
  - removeCustomEventListener
```
public void removeCustomEventListener(NexmoCustomEventListener listener)
```
    Unsubscribes from Custom events.
    
    Parameters:
    
    listener - Event listener.
  - clearCustomEventListeners
```
public void clearCustomEventListeners()
```
    Unsubscribes all listeners from Custom events.
  - addMemberEventListener
```
public void addMemberEventListener(NexmoMemberEventListener listener)
```
    Adds a callback to be invoked when member event is received.
    
    Parameters:
    
    listener - Event listener.
  - removeMemberEventListener
```
public void removeMemberEventListener(NexmoMemberEventListener listener)
```
    Unsubscribes from incoming Member related events.
    
    Parameters:
    
    listener - Event listener.
  - clearMemberEventListeners
```
public void clearMemberEventListeners()
```
    Unsubscribes all listeners from incoming Member related events.
  - addTypingEventListener
```
public void addTypingEventListener(NexmoTypingEventListener listener)
```
    Adds a callback to be invoked when typing event is received.
    
    Parameters:
    
    listener - Event listener.
  - removeTypingEventListener
```
public void removeTypingEventListener(NexmoTypingEventListener listener)
```
    Unsubscribes from incoming Typing related events.
    
    Parameters:
    
    listener - Event listener.
  - clearTypingEventListeners
```
public void clearTypingEventListeners()
```
    Unsubscribes all listeners from incoming Typing related events.
  - clearNexmoEventsListeners
```
public void clearNexmoEventsListeners()
```
    Unsubscribes all listeners from incoming events.
  - getConversationId
```
public java.lang.String getConversationId()
```
    Gets the id of this conversation synchronously.
    
    Returns:
    
    The auto-generated application unique ID of this conversation.
  - getName
```
public java.lang.String getName()
```
    Gets the name of this conversation synchronously.
    
    Returns:
    
    The name used to create this conversation.
  - getDisplayName
```
public java.lang.String getDisplayName()
```
    Gets the display name of this conversation synchronously.
    
    Returns:
    
    The display name used to create this conversation, or null if it wasn't provided at creation.
  - getCreationDate
```
public java.util.Date getCreationDate()
```
    Gets the creation date of this conversation synchronously.
    
    Returns:
    
    Creation date.
  - getLastEventId
```
public java.lang.String getLastEventId()
```
    Gets the id of the last NexmoEvent in this conversation synchronously.
    
    Returns:
    
    Last event id.
  - describeContents
```
public int describeContents()
```
    Specified by:
    
    describeContents in interface android.os.Parcelable
  - writeToParcel
```
public void writeToParcel(android.os.Parcel dest,
                          int flags)
```
    Specified by:
    
    writeToParcel in interface android.os.Parcelable
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - disableMedia
```
public void disableMedia()
```
  - enableMedia
```
public void enableMedia()
```
  - reconnectMedia
```
public void reconnectMedia()
```
    Manually Reconnect Media Stream
  - addMediaEventListener
```
public void addMediaEventListener(NexmoMediaEventListener mediaEventListener)
```
    Adds a callback to be invoked when media event is received.
    
    Parameters:
    
    mediaEventListener - Event listener.
  - addMediaActionEventListener
```
public void addMediaActionEventListener(NexmoMediaActionEventListener mediaActionEventListener)
```
    Adds a callback to be invoked when media action event is received.
    
    Parameters:
    
    mediaActionEventListener - Event listener.
  - addMediaStatusListener
```
public void addMediaStatusListener(NexmoMediaStatusListener listener)
```
    Adds a callback to be invoked when media status is received.
    
    Parameters:
    
    listener - Event listener.
  - compareTo
```
public int compareTo(NexmoConversation nexmoConversation)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<NexmoConversation>

Class NexmoConversation

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

Field Summary

Fields inherited from interface android.os.Parcelable

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CREATOR

Method Detail

getMyMember

getEvents

getEvents

getMembers

getMember

sendText

sendMessage

sendCustomEvent

sendAttachment

join

join

kick

invite

startTyping

stopTyping

addNexmoConversationListener

removeNexmoConversationListener

clearNexmoConversationListeners

addMessageEventListener

removeMessageEventListener

clearMessageEventListeners

addDTMFEventListener

removeDTMFEventListener

clearDTMFEventListeners

addLegStatusEventListener

removeLegStatusEventListener

clearLegStatusEventListeners

addMemberMessageStatusEventListener

removeMemberMessageStatusEventListener

clearMemberMessageStatusEventListeners

addCustomEventListener

removeCustomEventListener

clearCustomEventListeners

addMemberEventListener

removeMemberEventListener

clearMemberEventListeners

addTypingEventListener

removeTypingEventListener

clearTypingEventListeners

clearNexmoEventsListeners

getConversationId

getName

getDisplayName

getCreationDate

getLastEventId

describeContents

writeToParcel

toString

equals

hashCode

disableMedia

enableMedia

reconnectMedia

addMediaEventListener

addMediaActionEventListener

addMediaStatusListener

compareTo