JourneyResponse

Provides information about the status, configuration, and other settings for a journey.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity.

Link copied to clipboard

The unique identifier for the application that the journey applies to.

Link copied to clipboard

The time when a journey will not send messages. QuietTime should be configured first and SendingSchedule should be set to true.

Link copied to clipboard

The date, in ISO 8601 format, when the journey was created.

Link copied to clipboard
val id: String?

The unique identifier for the journey.

Link copied to clipboard

The channel-specific configurations for the journey.

Link copied to clipboard

The date, in ISO 8601 format, when the journey was last modified.

Link copied to clipboard

The messaging and entry limits for the journey.

Link copied to clipboard

Specifies whether the journey's scheduled start and end times use each participant's local time. If this value is true, the schedule uses each participant's local time.

Link copied to clipboard
val name: String?

The name of the journey.

Link copied to clipboard

The time when a journey can send messages. QuietTime should be configured first and SendingSchedule should be set to true.

Link copied to clipboard

The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met:

Link copied to clipboard

The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.

Link copied to clipboard

Indicates whether the journey participants should be refreshed when a segment is updated.

Link copied to clipboard

The schedule settings for the journey.

Link copied to clipboard

Indicates if journey has Advance Quiet Time enabled. This flag should be set to true in order to allow using OpenHours and ClosedDays.

Link copied to clipboard

The unique identifier for the first activity in the journey.

Link copied to clipboard

The segment that defines which users are participants in the journey.

Link copied to clipboard
val state: State?

The current status of the journey. Possible values are:

Link copied to clipboard

This object is not used or supported.

Link copied to clipboard

An array of time zone estimation methods, if any, to use for determining an Endpoints time zone if the Endpoint does not have a value for the Demographic.Timezone attribute.

Link copied to clipboard

Indicates whether endpoints in quiet hours should enter a wait activity until quiet hours have elapsed.

Functions

Link copied to clipboard
inline fun copy(block: JourneyResponse.Builder.() -> Unit = {}): JourneyResponse
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String