public interface

InAppMessageScheduler

com.urbanairship.iam.InAppMessageScheduler
Known Indirect Subclasses

Class Overview

Interface for scheduling in-app messages.

Summary

Public Methods
abstract PendingResult<Boolean> cancelMessage(String messageId)
Cancels an in-app message schedule for the given message ID.
abstract PendingResult<Void> cancelMessages(Collection<String> messageIds)
Message Ids that need to be cancelled.
abstract PendingResult<Void> cancelSchedule(String scheduleId)
Cancels an in-app message schedule.
abstract PendingResult<InAppMessageSchedule> editSchedule(String scheduleId, InAppMessageScheduleEdits edits)
Edits an in-app message schedule.
abstract PendingResult<InAppMessageSchedule> getSchedule(String scheduleId)
Gets the schedule.
abstract PendingResult<Collection<InAppMessageSchedule>> getSchedules(String messageId)
Gets the schedules associated with the message ID.
abstract PendingResult<Collection<InAppMessageSchedule>> getSchedules()
Gets all the schedules.
abstract PendingResult<List<InAppMessageSchedule>> schedule(List<InAppMessageScheduleInfo> scheduleInfos)
New schedules that need to be scheduled.
abstract PendingResult<InAppMessageSchedule> scheduleMessage(InAppMessageScheduleInfo messageScheduleInfo)
Schedules an in-app message.

Public Methods

public abstract PendingResult<Boolean> cancelMessage (String messageId)

Cancels an in-app message schedule for the given message ID. If more than one in-app message shares the same ID, they will all be cancelled.

Parameters
messageId The in-app message's ID.
Returns
  • A pending result.

public abstract PendingResult<Void> cancelMessages (Collection<String> messageIds)

Message Ids that need to be cancelled.

Parameters
messageIds The list of message IDs.
Returns
  • A pending result.

public abstract PendingResult<Void> cancelSchedule (String scheduleId)

Cancels an in-app message schedule.

Parameters
scheduleId The in-app message's schedule ID.
Returns
  • A pending result.

public abstract PendingResult<InAppMessageSchedule> editSchedule (String scheduleId, InAppMessageScheduleEdits edits)

Edits an in-app message schedule.

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

public abstract PendingResult<InAppMessageSchedule> getSchedule (String scheduleId)

Gets the schedule.

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

public abstract PendingResult<Collection<InAppMessageSchedule>> getSchedules (String messageId)

Gets the schedules associated with the message ID.

Parameters
messageId The message ID.
Returns
  • A pending result.

public abstract PendingResult<Collection<InAppMessageSchedule>> getSchedules ()

Gets all the schedules.

Returns
  • A pending result.

public abstract PendingResult<List<InAppMessageSchedule>> schedule (List<InAppMessageScheduleInfo> scheduleInfos)

New schedules that need to be scheduled.

Parameters
scheduleInfos The list of schedule infos.
Returns
  • A pending result.

public abstract PendingResult<InAppMessageSchedule> scheduleMessage (InAppMessageScheduleInfo messageScheduleInfo)

Schedules an in-app message.

Parameters
messageScheduleInfo The in-app message schedule info.
Returns