Configures a reminder that fires a set time before a task's due date, computed as periodMultiples frequency units subtracted from the due date, with a subject and body for the reminder message. Represented as a "taskReminder" node in a funnel definition. As it stands, entering this node throws UnsupportedOperationException, so it is not yet wired up to fire from a live funnel.

Group: Journeys

Extends: AbstractGoalAction


Properties

PropertyReturnsDescription
bodyStringThe body text for the reminder message.
frequencyStringThe time unit used with periodMultiples to compute the reminder date, for example "days" or "hours".
periodMultiplesintThe number of frequency units subtracted from the task's due date to compute the reminder date. A value of zero or less means no reminder date is calculated.
subjectStringThe subject line for the reminder message.

Methods

getFrequency()

Returns: String

The time unit used with periodMultiples to compute the reminder date, for example "days" or "hours".

getPeriodMultiples()

Returns: int

The number of frequency units subtracted from the task's due date to compute the reminder date. A value of zero or less means no reminder date is calculated.

getSubject()

Returns: String

The subject line for the reminder message.

getBody()

Returns: String

The body text for the reminder message.

calcDueDate(Date taskDueDate)

Returns: Date

Computes the reminder's due date by subtracting periodMultiples frequency units from the given task due date.

ParameterDescription
taskDueDatethe due date of the task the reminder is for
To get full access to the Kademi Hub existing customers can login here, or new customers can register here.