public class

InAppMessageScheduleInfo

extends Object
implements ScheduleInfo
java.lang.Object
   ↳ com.urbanairship.iam.InAppMessageScheduleInfo

Class Overview

Class encapsulating the implementor-set information for an in-app message schedule.

Summary

Nested Classes
class InAppMessageScheduleInfo.Builder In-app message schedule info builder. 
Constants
long TRIGGER_LIMIT The triggers limit for a single schedule.
[Expand]
Inherited Constants
From interface com.urbanairship.automation.ScheduleInfo
Public Methods
static InAppMessageScheduleInfo fromJson(JsonValue value)
Creates a schedule info from a json value.
JsonSerializable getData()
Gets the schedule data.
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.
InAppMessage getInAppMessage()
Gets the schedule's in-app message.
long getInterval()
Gets the schedule execution interval in ms.
int getLimit()
Gets the schedule fulfillment limit.
int getPriority()
Gets the schedule priority level.
long getStart()
Gets the schedule start time in ms.
List<Trigger> getTriggers()
Gets the action triggers.
static InAppMessageScheduleInfo.Builder newBuilder()
Create a new builder.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.urbanairship.automation.ScheduleInfo

Constants

public static final long TRIGGER_LIMIT

The triggers limit for a single schedule.

Constant Value: 10 (0x000000000000000a)

Public Methods

public static InAppMessageScheduleInfo fromJson (JsonValue value)

Creates a schedule info from a json value.

Parameters
value The json value.
Returns
  • A schedule info.
Throws
JsonException If the json value contains an invalid schedule info.

public JsonSerializable getData ()

Gets the schedule data.

Returns
  • Schedule data.

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

Gets the schedule's in-app message.

Returns
  • The schedule's in-app message.

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 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 static InAppMessageScheduleInfo.Builder newBuilder ()

Create a new builder.

Returns
  • A new builder instance.