public final class

Schedule

extends Object
java.lang.Object
   ↳ com.urbanairship.automation.Schedule<T extends com.urbanairship.automation.ScheduleData>

Class Overview

Schedule.

Summary

Nested Classes
class Schedule.Builder<T extends ScheduleData> In-app message schedule info builder. 
Constants
long TRIGGER_LIMIT The triggers limit for a single schedule.
Public Methods
boolean equals(Object o)
Audience getAudience()
Gets the audience.
T getData()
Gets the schedule data, coerced to the specified type.
ScheduleDelay getDelay()
Gets the schedule's delay.
long getEditGracePeriod()
Gets the edit grace period in ms.
long getEnd()
Gets the schedule end time in ms.
String getGroup()
Gets the schedule group.
String getId()
Gets the schedule ID.
long getInterval()
Gets the schedule execution interval in ms.
int getLimit()
Gets the schedule fulfillment limit.
JsonMap getMetadata()
Gets the metadata.
int getPriority()
Gets the schedule priority level.
long getStart()
Gets the schedule start time in ms.
List<Trigger> getTriggers()
Gets the action triggers.
String getType()
Gets the schedule type.
int hashCode()
static Builder<Actions> newBuilder(Actions actions)
Create a new builder for an action schedule.
static <T extends ScheduleData> Builder<T> newBuilder(Schedule<T> schedule)
Create a new builder.
static Builder<InAppMessage> newBuilder(InAppMessage message)
Create a new builder for an in-app message schedule.
String toString()
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final long TRIGGER_LIMIT

The triggers limit for a single schedule.

Constant Value: 10 (0x000000000000000a)

Public Methods

public boolean equals (Object o)

public Audience getAudience ()

Gets the audience.

Returns
  • The audience.

public T getData ()

Gets the schedule data, coerced to the specified type.

Returns
  • Schedule data, coerced to the specified type.

public ScheduleDelay getDelay ()

Gets the schedule's delay.

Returns
  • A ScheduleDelay instance.

public long getEditGracePeriod ()

Gets the edit grace period in ms.

Returns
  • The edit grace period in ms.

public long getEnd ()

Gets the schedule end time in ms.

Returns
  • The schedule end time in ms.

public String getGroup ()

Gets the schedule group.

Returns
  • The schedule group.

public String getId ()

Gets the schedule ID.

Returns
  • The schedule ID.

public long getInterval ()

Gets the schedule execution interval in ms.

Returns
  • The interval in ms.

public int getLimit ()

Gets the schedule fulfillment limit.

Returns
  • The fulfillment limit.

public JsonMap getMetadata ()

Gets the metadata.

Returns
  • The metadata.

public int getPriority ()

Gets the schedule priority level.

Returns
  • The priority level.

public long getStart ()

Gets the schedule start time in ms.

Returns
  • The schedule start time in ms.

public List<Trigger> getTriggers ()

Gets the action triggers.

Returns
  • A list of triggers.

public String getType ()

Gets the schedule type.

Returns
  • The schedule type.

public int hashCode ()

public static Builder<Actions> newBuilder (Actions actions)

Create a new builder for an action schedule.

Parameters
actions The actions.
Returns
  • A new builder instance.

public static Builder<T> newBuilder (Schedule<T> schedule)

Create a new builder.

Parameters
schedule The schedule to extend.
Returns
  • A new builder instance.

public static Builder<InAppMessage> newBuilder (InAppMessage message)

Create a new builder for an in-app message schedule.

Parameters
message The message.
Returns
  • A new builder instance.

public String toString ()