com.nexmo.client

Class NexmoAttachmentEvent

java.lang.Object

com.nexmo.client.NexmoEvent

com.nexmo.client.NexmoAttachmentEvent

All Implemented Interfaces:

android.os.Parcelable, java.io.Serializable

public class NexmoAttachmentEvent
extends NexmoEvent

Represents the attachment events dispatched into NexmoMessageEventListener.onAttachmentEvent(com.nexmo.client.NexmoAttachmentEvent) (currently only images).

The NexmoConversation allows to send the attachment:

     conversation.sendAttachment(imageFile, new NexmoRequestListener<NexmoAttachmentEvent>() {
       @Override
       public void onSuccess(NexmoAttachmentEvent image) {
       }

       @Override
       public void onError(NexmoAPIError error) {
       }
     });
 

To receive attachment add NexmoMessageEventListener to NexmoConversation and use NexmoMessageEventListener.onAttachmentEvent(com.nexmo.client.NexmoAttachmentEvent) callback:

 conversation.addMessageEventListener(new NexmoMessageEventListener() {
     @Override
     public void onTextEvent(@NonNull NexmoTextEvent textEvent) {}

     @Override
     public void onAttachmentEvent(@NonNull NexmoAttachmentEvent attachmentEvent) {
         Log.d("onAttachmentEvent", "NexmoAttachmentEvent received");

         // image retrieval
         attachmentEvent.getMedium() ;
     }

     @Override
     public void onEventDeleted(@NonNull NexmoDeletedEvent deletedEvent) {}

     @Override
     public void onSeenReceipt(@NonNull NexmoSeenEvent seenEvent) {}

     @Override
     public void onDeliveredReceipt(@NonNull NexmoDeliveredEvent deliveredEvent) {}

     @Override
     public void onTypingEvent(@NonNull NexmoTypingEvent typingEvent) {}
 });
 

Mark attachment event as seen:

 attachmentEvent.markAsSeen(new NexmoRequestListener() {
   @Override
   public void onSuccess() {
   }

   @Override
   public void onError(NexmoAPIError error) {
   }
 });
 

Mark attachment event event as delivered:

 attachmentEvent.markAsDelivered(new NexmoRequestListener() {
   @Override
   public void onSuccess() {
   }

   @Override
   public void onError(NexmoAPIError error) {
   }
 });
 

Delete attachment event:

 attachmentEvent.delete(new NexmoRequestListener() {
   @Override
   public void onSuccess() {
   }

   @Override
   public void onError(NexmoAPIError error) {
   }
 });
 

See Also:

Serialized Form

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<NexmoAttachmentEvent>	CREATOR

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Method Summary

Modifier and Type	Method and Description
void	delete(NexmoRequestListener listener) Deletes an attachment event.
int	describeContents()
boolean	equals(java.lang.Object o)
java.util.Map<EMessageState,java.util.List<MemberForMessageStateBundle>>	getEventState() Gets the event state of this event.
NexmoImageRepresentation	getMedium() Gets medium image size represented by NexmoImageRepresentation.
NexmoImageRepresentation	getOriginal() Gets original image size represented by NexmoImageRepresentation.
NexmoImageRepresentation	getThumbnail() Gets thumbnail image size represented by NexmoImageRepresentation.
int	hashCode()
void	markAsDelivered(NexmoRequestListener listener) Mark this event as delivered.
void	markAsSeen(NexmoRequestListener listener) Marks an Image event as seen.
java.lang.String	toString()
void	updateAsDelivered(java.lang.String memberId, java.lang.String timestamp) Updates this event as delivered.
void	updateAsSeen(java.lang.String memberId, java.lang.String timestamp) Updates an this event as seen.
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class com.nexmo.client.NexmoEvent

getConversation, getConversationId, getCreationDate, getEmbeddedInfo, getEventType, getFromMemberId, getId, markEventState, updateEventState

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<NexmoAttachmentEvent> CREATOR

Method Detail

delete

public void delete(NexmoRequestListener listener)

Deletes an attachment event.

Parameters:

listener - The request completion listener.

markAsSeen

public void markAsSeen(NexmoRequestListener listener)

Marks an Image event as seen. NexmoEvent seen receipt cannot be revoked.

Parameters:

listener - The request completion listener.

markAsDelivered

public void markAsDelivered(NexmoRequestListener listener)

Mark this event as delivered. This action can't be revoked. After this call succeeds updateAsDelivered(String, String) should be called.

Parameters:

listener - The request completion listener.

updateAsDelivered

public void updateAsDelivered(java.lang.String memberId,
                              java.lang.String timestamp)

Updates this event as delivered. This action can't be revoked.

Parameters:

memberId - The id of the member who has marked the event

timestamp - The timestamp of when the member marked the event

updateAsSeen

public void updateAsSeen(java.lang.String memberId,
                         java.lang.String timestamp)

Updates an this event as seen. This action can't be revoked.

Parameters:

memberId - The id of the member who has marked the event

timestamp - The timestamp of when the member marked the event

getEventState

public java.util.Map<EMessageState,java.util.List<MemberForMessageStateBundle>> getEventState()

Gets the event state of this event.

Returns:

The event state.

getOriginal

public NexmoImageRepresentation getOriginal()

Gets original image size represented by NexmoImageRepresentation.

getMedium

public NexmoImageRepresentation getMedium()

Gets medium image size represented by NexmoImageRepresentation.

getThumbnail

public NexmoImageRepresentation getThumbnail()

Gets thumbnail image size represented by NexmoImageRepresentation.

toString

public java.lang.String toString()

Overrides:

toString in class NexmoEvent

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class NexmoEvent

hashCode

public int hashCode()

Overrides:

hashCode in class NexmoEvent

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

Overrides:

describeContents in class NexmoEvent

writeToParcel

public void writeToParcel(android.os.Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable

Overrides:

writeToParcel in class NexmoEvent