Package com.courier.api.resources.messages.types

Class MessageDetailsExtended

java.lang.Object

com.courier.api.resources.messages.types.MessageDetailsExtended

All Implemented Interfaces:

IMessageDetails

public final class MessageDetailsExtended
extends java.lang.Object
implements IMessageDetails

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MessageDetailsExtended._FinalStage
static class	MessageDetailsExtended.Builder
static interface	MessageDetailsExtended.ClickedStage
static interface	MessageDetailsExtended.DeliveredStage
static interface	MessageDetailsExtended.EnqueuedStage
static interface	MessageDetailsExtended.EventStage
static interface	MessageDetailsExtended.IdStage
static interface	MessageDetailsExtended.NotificationStage
static interface	MessageDetailsExtended.OpenedStage
static interface	MessageDetailsExtended.RecipientStage
static interface	MessageDetailsExtended.SentStage
static interface	MessageDetailsExtended.StatusStage

Method Summary

Modifier and Type	Method	Description
static MessageDetailsExtended.IdStage	builder()
boolean	equals(java.lang.Object other)
java.util.Map<java.lang.String,java.lang.Object>	getAdditionalProperties()
long	getClicked()
long	getDelivered()
long	getEnqueued()
java.util.Optional<java.lang.String>	getError()
java.lang.String	getEvent()
java.lang.String	getId()
java.lang.String	getNotification()
long	getOpened()
java.util.Optional<java.util.List<java.util.Map<java.lang.String,java.lang.Object>>>	getProviders()
java.util.Optional<Reason>	getReason()
java.lang.String	getRecipient()
long	getSent()
MessageStatus	getStatus()
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getId

public java.lang.String getId()

Specified by:

getId in interface IMessageDetails

Returns:

A unique identifier associated with the message you wish to retrieve (results from a send).

getStatus

public MessageStatus getStatus()

Specified by:

getStatus in interface IMessageDetails

Returns:

The current status of the message.

getEnqueued

public long getEnqueued()

Specified by:

getEnqueued in interface IMessageDetails

Returns:

A UTC timestamp at which Courier received the message request. Stored as a millisecond representation of the Unix epoch.

getSent

public long getSent()

Specified by:

getSent in interface IMessageDetails

Returns:

A UTC timestamp at which Courier passed the message to the Integration provider. Stored as a millisecond representation of the Unix epoch.

getDelivered

public long getDelivered()

Specified by:

getDelivered in interface IMessageDetails

Returns:

A UTC timestamp at which the Integration provider delivered the message. Stored as a millisecond representation of the Unix epoch.

getOpened

public long getOpened()

Specified by:

getOpened in interface IMessageDetails

Returns:

A UTC timestamp at which the recipient opened a message for the first time. Stored as a millisecond representation of the Unix epoch.

getClicked

public long getClicked()

Specified by:

getClicked in interface IMessageDetails

Returns:

A UTC timestamp at which the recipient clicked on a tracked link for the first time. Stored as a millisecond representation of the Unix epoch.

getRecipient

public java.lang.String getRecipient()

Specified by:

getRecipient in interface IMessageDetails

Returns:

A unique identifier associated with the recipient of the delivered message.

getEvent

public java.lang.String getEvent()

Specified by:

getEvent in interface IMessageDetails

Returns:

A unique identifier associated with the event of the delivered message.

getNotification

public java.lang.String getNotification()

Specified by:

getNotification in interface IMessageDetails

Returns:

A unique identifier associated with the notification of the delivered message.

getError

public java.util.Optional<java.lang.String> getError()

Specified by:

getError in interface IMessageDetails

Returns:

A message describing the error that occurred.

getReason

public java.util.Optional<Reason> getReason()

Specified by:

getReason in interface IMessageDetails

Returns:

The reason for the current status of the message.

getProviders

public java.util.Optional<java.util.List<java.util.Map<java.lang.String,java.lang.Object>>> getProviders()

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

getAdditionalProperties

public java.util.Map<java.lang.String,java.lang.Object> getAdditionalProperties()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

builder

public static MessageDetailsExtended.IdStage builder()