Class MessageDetailsExtended.Builder
- java.lang.Object
-
- com.courier.api.resources.messages.types.MessageDetailsExtended.Builder
-
- All Implemented Interfaces:
MessageDetailsExtended._FinalStage,MessageDetailsExtended.ClickedStage,MessageDetailsExtended.DeliveredStage,MessageDetailsExtended.EnqueuedStage,MessageDetailsExtended.EventStage,MessageDetailsExtended.IdStage,MessageDetailsExtended.NotificationStage,MessageDetailsExtended.OpenedStage,MessageDetailsExtended.RecipientStage,MessageDetailsExtended.SentStage,MessageDetailsExtended.StatusStage
- Enclosing class:
- MessageDetailsExtended
public static final class MessageDetailsExtended.Builder extends java.lang.Object implements MessageDetailsExtended.IdStage, MessageDetailsExtended.StatusStage, MessageDetailsExtended.EnqueuedStage, MessageDetailsExtended.SentStage, MessageDetailsExtended.DeliveredStage, MessageDetailsExtended.OpenedStage, MessageDetailsExtended.ClickedStage, MessageDetailsExtended.RecipientStage, MessageDetailsExtended.EventStage, MessageDetailsExtended.NotificationStage, MessageDetailsExtended._FinalStage
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MessageDetailsExtendedbuild()MessageDetailsExtended.RecipientStageclicked(long clicked)A UTC timestamp at which the recipient clicked on a tracked link for the first time.MessageDetailsExtended.OpenedStagedelivered(long delivered)A UTC timestamp at which the Integration provider delivered the message.MessageDetailsExtended.SentStageenqueued(long enqueued)A UTC timestamp at which Courier received the message request.MessageDetailsExtended._FinalStageerror(java.lang.String error)A message describing the error that occurred.MessageDetailsExtended._FinalStageerror(java.util.Optional<java.lang.String> error)MessageDetailsExtended.NotificationStageevent(java.lang.String event)A unique identifier associated with the event of the delivered message.MessageDetailsExtended.Builderfrom(MessageDetailsExtended other)MessageDetailsExtended.StatusStageid(java.lang.String id)A unique identifier associated with the message you wish to retrieve (results from a send).MessageDetailsExtended._FinalStagenotification(java.lang.String notification)A unique identifier associated with the notification of the delivered message.MessageDetailsExtended.ClickedStageopened(long opened)A UTC timestamp at which the recipient opened a message for the first time.MessageDetailsExtended._FinalStageproviders(java.util.List<java.util.Map<java.lang.String,java.lang.Object>> providers)MessageDetailsExtended._FinalStageproviders(java.util.Optional<java.util.List<java.util.Map<java.lang.String,java.lang.Object>>> providers)MessageDetailsExtended._FinalStagereason(Reason reason)The reason for the current status of the message.MessageDetailsExtended._FinalStagereason(java.util.Optional<Reason> reason)MessageDetailsExtended.EventStagerecipient(java.lang.String recipient)A unique identifier associated with the recipient of the delivered message.MessageDetailsExtended.DeliveredStagesent(long sent)A UTC timestamp at which Courier passed the message to the Integration provider.MessageDetailsExtended.EnqueuedStagestatus(MessageStatus status)The current status of the message.
-
-
-
Method Detail
-
from
public MessageDetailsExtended.Builder from(MessageDetailsExtended other)
- Specified by:
fromin interfaceMessageDetailsExtended.IdStage
-
id
public MessageDetailsExtended.StatusStage id(java.lang.String id)
A unique identifier associated with the message you wish to retrieve (results from a send).
- Specified by:
idin interfaceMessageDetailsExtended.IdStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
status
public MessageDetailsExtended.EnqueuedStage status(MessageStatus status)
The current status of the message.
- Specified by:
statusin interfaceMessageDetailsExtended.StatusStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
enqueued
public MessageDetailsExtended.SentStage enqueued(long enqueued)
A UTC timestamp at which Courier received the message request. Stored as a millisecond representation of the Unix epoch.
- Specified by:
enqueuedin interfaceMessageDetailsExtended.EnqueuedStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
sent
public MessageDetailsExtended.DeliveredStage sent(long sent)
A UTC timestamp at which Courier passed the message to the Integration provider. Stored as a millisecond representation of the Unix epoch.
- Specified by:
sentin interfaceMessageDetailsExtended.SentStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
delivered
public MessageDetailsExtended.OpenedStage delivered(long delivered)
A UTC timestamp at which the Integration provider delivered the message. Stored as a millisecond representation of the Unix epoch.
- Specified by:
deliveredin interfaceMessageDetailsExtended.DeliveredStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
opened
public MessageDetailsExtended.ClickedStage opened(long opened)
A UTC timestamp at which the recipient opened a message for the first time. Stored as a millisecond representation of the Unix epoch.
- Specified by:
openedin interfaceMessageDetailsExtended.OpenedStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
clicked
public MessageDetailsExtended.RecipientStage clicked(long clicked)
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.
- Specified by:
clickedin interfaceMessageDetailsExtended.ClickedStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
recipient
public MessageDetailsExtended.EventStage recipient(java.lang.String recipient)
A unique identifier associated with the recipient of the delivered message.
- Specified by:
recipientin interfaceMessageDetailsExtended.RecipientStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
event
public MessageDetailsExtended.NotificationStage event(java.lang.String event)
A unique identifier associated with the event of the delivered message.
- Specified by:
eventin interfaceMessageDetailsExtended.EventStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
notification
public MessageDetailsExtended._FinalStage notification(java.lang.String notification)
A unique identifier associated with the notification of the delivered message.
- Specified by:
notificationin interfaceMessageDetailsExtended.NotificationStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
providers
public MessageDetailsExtended._FinalStage providers(java.util.List<java.util.Map<java.lang.String,java.lang.Object>> providers)
- Specified by:
providersin interfaceMessageDetailsExtended._FinalStage
-
providers
public MessageDetailsExtended._FinalStage providers(java.util.Optional<java.util.List<java.util.Map<java.lang.String,java.lang.Object>>> providers)
- Specified by:
providersin interfaceMessageDetailsExtended._FinalStage
-
reason
public MessageDetailsExtended._FinalStage reason(Reason reason)
The reason for the current status of the message.
- Specified by:
reasonin interfaceMessageDetailsExtended._FinalStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
reason
public MessageDetailsExtended._FinalStage reason(java.util.Optional<Reason> reason)
- Specified by:
reasonin interfaceMessageDetailsExtended._FinalStage
-
error
public MessageDetailsExtended._FinalStage error(java.lang.String error)
A message describing the error that occurred.
- Specified by:
errorin interfaceMessageDetailsExtended._FinalStage- Returns:
- Reference to
thisso that method calls can be chained together.
-
error
public MessageDetailsExtended._FinalStage error(java.util.Optional<java.lang.String> error)
- Specified by:
errorin interfaceMessageDetailsExtended._FinalStage
-
build
public MessageDetailsExtended build()
- Specified by:
buildin interfaceMessageDetailsExtended._FinalStage
-
-