public interface

InAppAutomationScheduler

com.urbanairship.iam.InAppAutomationScheduler
Known Indirect Subclasses

Class Overview

Interface for scheduling in-app automations.

Summary

Public Methods
abstract PendingResult<Boolean> cancelSchedule(String scheduleId)
Cancels an in-app schedule.
abstract PendingResult<Boolean> cancelScheduleGroup(String group)
Cancels in-app schedules by the group.
abstract PendingResult<Boolean> editSchedule(String scheduleId, ScheduleEdits<? extends ScheduleData> edits)
Edits an in-app schedule.
abstract PendingResult<Schedule<Actions>> getActionSchedule(String scheduleId)
Gets an action schedule by ID.
abstract PendingResult<Collection<Schedule<Actions>>> getActionScheduleGroup(String group)
Gets action schedules by group.
abstract PendingResult<Collection<Schedule<Actions>>> getActionSchedules()
Gets all action schedules.
abstract PendingResult<Schedule<InAppMessage>> getMessageSchedule(String scheduleId)
Gets a message schedule by ID.
abstract PendingResult<Collection<Schedule<InAppMessage>>> getMessageScheduleGroup(String group)
Gets message schedules by group.
abstract PendingResult<Collection<Schedule<InAppMessage>>> getMessageSchedules()
Gets all message schedules.
abstract PendingResult<Boolean> schedule(Schedule<? extends ScheduleData> schedule)
Schedules an in-app automation.
abstract PendingResult<Boolean> schedule(List<Schedule<? extends ScheduleData>> schedules)
Schedules a list of in-app automations.

Public Methods

public abstract PendingResult<Boolean> cancelSchedule (String scheduleId)

Cancels an in-app schedule.

Parameters
scheduleId The in-app schedule ID.
Returns
  • A pending result. The result will be true if success, otherwise false.

public abstract PendingResult<Boolean> cancelScheduleGroup (String group)

Cancels in-app schedules by the group.

Parameters
group The schedule group.
Returns
  • A pending result.

public abstract PendingResult<Boolean> editSchedule (String scheduleId, ScheduleEdits<? extends ScheduleData> edits)

Edits an in-app schedule.

Parameters
scheduleId The schedule ID.
edits The edits.
Returns
  • A pending result with the result.

public abstract PendingResult<Schedule<Actions>> getActionSchedule (String scheduleId)

Gets an action schedule by ID.

Parameters
scheduleId The schedule ID.
Returns
  • A pending result.

public abstract PendingResult<Collection<Schedule<Actions>>> getActionScheduleGroup (String group)

Gets action schedules by group.

Parameters
group The group.
Returns
  • A pending result.

public abstract PendingResult<Collection<Schedule<Actions>>> getActionSchedules ()

Gets all action schedules.

Returns
  • A pending result.

public abstract PendingResult<Schedule<InAppMessage>> getMessageSchedule (String scheduleId)

Gets a message schedule by ID.

Parameters
scheduleId The schedule ID.
Returns
  • A pending result.

public abstract PendingResult<Collection<Schedule<InAppMessage>>> getMessageScheduleGroup (String group)

Gets message schedules by group.

Parameters
group The group.
Returns
  • A pending result.

public abstract PendingResult<Collection<Schedule<InAppMessage>>> getMessageSchedules ()

Gets all message schedules.

Returns
  • A pending result.

public abstract PendingResult<Boolean> schedule (Schedule<? extends ScheduleData> schedule)

Schedules an in-app automation.

Parameters
schedule The in-app schedule.
Returns
  • A pending result. The result will be true if success, otherwise false.

public abstract PendingResult<Boolean> schedule (List<Schedule<? extends ScheduleData>> schedules)

Schedules a list of in-app automations.

Parameters
schedules The list of schedules.
Returns
  • A pending result. The result will be true if success, otherwise false.