NexmoConversation

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

public class NexmoConversation
extends java.lang.Object

Create conversations NexmoClient.newConversation(String, String, NexmoRequestListener). NexmoConversation name can be supplied, but if left empty there will be an auto-generated name assigned to the conversation.

Example usage:

     stitchClient.newConversation("My NexmoConversation name", "My NexmoConversation display name", new RequestHandler() {
         @Override
         public void onSuccess(NexmoConversation conversation) {
              // Update the application UI here if needed.
         }
         @Override
         public void onError(NexmoAPIError error) {
              // Update the application UI here if needed.
         }
    });

Add another users to the NexmoConversation with join(String, NexmoRequestListener) *

Example usage:

     myConversation.join("username", new RequestHandler() {
         @Override
         public void onSuccess(NexmoMember member) {
              // Update the application UI here if needed.
         }
         @Override
         public void onError(NexmoAPIError error) {
              // Update the application UI here if needed.
         }
    });

Send text messages to a specific conversation with sendText(String, NexmoRequestListener).

Example usage:

     myConversation.sendText("message payload...", new RequestHandler() {
         @Override
         public void onSuccess(NexmoEvent event) {
              // Update the application UI here if needed.
         }
         @Override
         public void onError(NexmoAPIError error) {
              // Update the application UI here if needed.
         }
    });

Listen for incoming message events addMessageEventListener(NexmoMessageEventListener)

Example usage:

   conversation.addMessageEventListener().add(new MessageEventListener() {
    @Override
    public void onTextEvent(TextEvent text) {
        // Update the application UI here if needed with new text.
    }
    @Override
    public void onAttachmentEvent(AttachmentEvent attachment) {
        // Update the application UI here if needed with new attachment.
    }
    @Override
    public void onEventDeleted(DeletedEvent deleteEvent) {
        // Update the application UI here if needed.
    }
  });

Field Summary

Fields
Modifier and Type Field and Description

static <any> CREATOR

Fields
Modifier and Type	Field and Description
`static <any>`	`CREATOR`

Constructor Summary

Constructors
Modifier Constructor and Description

protected NexmoConversation(Parcel in)

Constructors
Modifier	Constructor and Description
`protected`	`NexmoConversation(Parcel in)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addDTMFEventListener(NexmoDTMFEventListener listener)` Subscribe for DTMF events for this conversation
`void`	`addMemberEventListener(NexmoMemberEventListener listener)` Listen for incoming Member related events.
`void`	`addMessageEventListener(NexmoMessageEventListener listener)` Listen for incoming messages from this conversation.
`void`	`addNexmoConversationListener(NexmoConversationListener listener)` subscribe to NexmoConversationListener alerts
`void`	`addTypingEventListener(NexmoTypingEventListener listener)` Listen for incoming Typing related events.
`int`	`describeContents()`
`boolean`	`equals(java.lang.Object o)`
`java.util.List<NexmoMember>`	`getAllMembers()` Get all members that are JOINED/INVITED/LEFT in this conversation, synchronously.
`java.lang.String`	`getConversationId()` Get the id of this conversation, synchronously.
`java.lang.String`	`getCreationDate()` Get the creation date of this conversation, synchronously.
`java.lang.String`	`getDisplayName()` Get the display name of this conversation, synchronously.
`void`	`getEvents(com.nexmo.client.request_listener.NexmoRequestListener<java.util.Collection<NexmoEvent>> listener)` Retrieve the entire event history of this NexmoConversation.
`java.lang.String`	`getLastEventId()` Get the Id of the last NexmoEvent in this conversation, synchronously.
`NexmoMember`	`getMember(java.lang.String memberId)`
`NexmoMember`	`getMyMember()` Get the member of the current user in this conversation, synchronously.
`java.lang.String`	`getName()` Get the name of this conversation, synchronously.
`NexmoUser`	`getUser()`
`int`	`hashCode()`
`void`	`join(com.nexmo.client.request_listener.NexmoRequestListener<NexmoMember> listener)` Join the current logged in `NexmoUser` to this conversation.
`void`	`join(java.lang.String username, com.nexmo.client.request_listener.NexmoRequestListener<java.lang.String> listener)` Join a `NexmoUser` to this conversation.
`void`	`kick(NexmoMember member, com.nexmo.client.request_listener.NexmoRequestListener listener)` Remove a `NexmoUser` from this conversation.
`void`	`removeDTMFEventListener(NexmoDTMFEventListener listener)` Unsubscribe from DTMF events
`void`	`removeMemberEventListener(NexmoMemberEventListener listener)` Unsubscribe from incoming Member related events.
`void`	`removeMessageEventListener(NexmoMessageEventListener listener)` Unsubscribe from incoming Message related events.
`void`	`removeNexmoConversationListener(NexmoConversationListener listener)` Unsubscribe from incoming Message related events.
`void`	`removeTypingEventListener(NexmoTypingEventListener listener)` Unsubscribe from incoming Typing related events.
`void`	`sendAttachment(java.io.File attachment, com.nexmo.client.request_listener.NexmoRequestListener listener)` Send/Upload an attachment to a conversation.
`void`	`sendText(java.lang.String text, com.nexmo.client.request_listener.NexmoRequestListener listener)` Send a Text event to a conversation.
`void`	`startTyping()` Send a typing indicator ON event to the conversation.
`void`	`stopTyping()` Send a typing indicator OFF event to the conversation.
`java.lang.String`	`toString()`
`void`	`writeToParcel(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 <any> CREATOR
```
- Constructor Detail
  - NexmoConversation
```
protected NexmoConversation(Parcel in)
```
- Method Detail
  - getEvents
```
public void getEvents(com.nexmo.client.request_listener.NexmoRequestListener<java.util.Collection<NexmoEvent>> listener)
```
    Retrieve the entire event history of this NexmoConversation.
    
    Parameters:
    
    listener - The request completion listener.
  - sendText
```
public void sendText(java.lang.String text,
                     com.nexmo.client.request_listener.NexmoRequestListener listener)
```
    Send a Text event to a conversation.
    
    Parameters:
    
    text - The text payload.
    
    listener - The request completion listener.
  - sendAttachment
```
public void sendAttachment(java.io.File attachment,
                           com.nexmo.client.request_listener.NexmoRequestListener listener)
```
    Send/Upload an attachment to a conversation.
    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()
    TODO implement cancellable upload CSA-814
    Parameters:
    
    attachment - The attachment file.
    
    listener - The request completion listener.
  - join
```
public void join(com.nexmo.client.request_listener.NexmoRequestListener<NexmoMember> listener)
```
    Join 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,
                 com.nexmo.client.request_listener.NexmoRequestListener<java.lang.String> listener)
```
    Join 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(NexmoMember member,
                 com.nexmo.client.request_listener.NexmoRequestListener listener)
```
    Remove a NexmoUser from this conversation.
    
    Parameters:
    
    member - The member to be removed.
    
    listener - The request completion listener.
  - startTyping
```
public void startTyping()
```
    Send a typing indicator ON event to the conversation.
  - stopTyping
```
public void stopTyping()
```
    Send a typing indicator OFF event to the conversation.
  - getUser
```
public NexmoUser getUser()
```
  - getMember
```
public NexmoMember getMember(java.lang.String memberId)
```
  - addNexmoConversationListener
```
public void addNexmoConversationListener(NexmoConversationListener listener)
```
    subscribe to NexmoConversationListener alerts
    
    Parameters:
    
    listener - NexmoConversationListener.
  - removeNexmoConversationListener
```
public void removeNexmoConversationListener(NexmoConversationListener listener)
```
    Unsubscribe from incoming Message related events.
    
    Parameters:
    
    listener - NexmoConversationListener.
  - addMessageEventListener
```
public void addMessageEventListener(NexmoMessageEventListener listener)
```
    Listen for incoming messages from this conversation.
    Event types:
    - Nexmo Text event
    - Nexmo Attachment event.
    Parameters:
    
    listener - Event listener.
  - removeMessageEventListener
```
public void removeMessageEventListener(NexmoMessageEventListener listener)
```
    Unsubscribe from incoming Message related events.
    
    Parameters:
    
    listener - Event listener.
  - addDTMFEventListener
```
public void addDTMFEventListener(NexmoDTMFEventListener listener)
```
    Subscribe for DTMF events for this conversation
    
    Parameters:
    
    listener -
  - removeDTMFEventListener
```
public void removeDTMFEventListener(NexmoDTMFEventListener listener)
```
    Unsubscribe from DTMF events
    
    Parameters:
    
    listener -
  - addMemberEventListener
```
public void addMemberEventListener(NexmoMemberEventListener listener)
```
    Listen for incoming Member related events.
    
    Parameters:
    
    listener - Event listener.
  - removeMemberEventListener
```
public void removeMemberEventListener(NexmoMemberEventListener listener)
```
    Unsubscribe from incoming Member related events.
    
    Parameters:
    
    listener - Event listener.
  - addTypingEventListener
```
public void addTypingEventListener(NexmoTypingEventListener listener)
```
    Listen for incoming Typing related events.
    
    Parameters:
    
    listener - Event listener.
  - removeTypingEventListener
```
public void removeTypingEventListener(NexmoTypingEventListener listener)
```
    Unsubscribe from incoming Typing related events.
    
    Parameters:
    
    listener - Event listener.
  - getConversationId
```
public java.lang.String getConversationId()
```
    Get the id of this conversation, synchronously.
    
    Returns:
    
    The auto-generated application unique ID of this conversation.
  - getName
```
public java.lang.String getName()
```
    Get the name of this conversation, synchronously.
    
    Returns:
    
    The name used to create this conversation.
  - getDisplayName
```
public java.lang.String getDisplayName()
```
    Get 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.lang.String getCreationDate()
```
    Get the creation date of this conversation, synchronously.
    
    Returns:
    
    Creation date.
  - getLastEventId
```
public java.lang.String getLastEventId()
```
    Get the Id of the last NexmoEvent in this conversation, synchronously.
    
    Returns:
    
    Last event id.
  - getMyMember
```
public NexmoMember getMyMember()
```
    Get the member of the current user in this conversation, synchronously.
    
    Returns:
    
    The member with auto-generated memberId for current user, or null if user is not part of the conversation.
  - getAllMembers
```
public final java.util.List<NexmoMember> getAllMembers()
```
    Get all members that are JOINED/INVITED/LEFT in this conversation, synchronously.
    
    Returns:
    
    The list of all members.
  - describeContents
```
public int describeContents()
```
  - writeToParcel
```
public void writeToParcel(Parcel dest,
                          int flags)
```
  - 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

Class NexmoConversation

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CREATOR

Constructor Detail

NexmoConversation

Method Detail

getEvents

sendText

sendAttachment

join

join

kick

startTyping

stopTyping

getUser

getMember

addNexmoConversationListener

removeNexmoConversationListener

addMessageEventListener

removeMessageEventListener

addDTMFEventListener

removeDTMFEventListener

addMemberEventListener

removeMemberEventListener

addTypingEventListener

removeTypingEventListener

getConversationId

getName

getDisplayName

getCreationDate

getLastEventId

getMyMember

getAllMembers

describeContents

writeToParcel

toString

equals

hashCode