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

Class MessageDetails

java.lang.Object

com.courier.api.resources.messages.types.MessageDetails

public final class MessageDetails
extends java.lang.Object

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static MessageDetails.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<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()

Returns:

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

getStatus

public MessageStatus getStatus()

Returns:

The current status of the message.

getEnqueued

public long getEnqueued()

Returns:

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

getSent

public long getSent()

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()

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()

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()

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()

Returns:

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

getEvent

public java.lang.String getEvent()

Returns:

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

getNotification

public java.lang.String getNotification()

Returns:

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

getError

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

Returns:

A message describing the error that occurred.

getReason

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

Returns:

The reason for the current status of the message.

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 MessageDetails.IdStage builder()