com.urbanairship.iam.InAppMessageAdapter |
Known Indirect Subclasses |
In-app message adapter. An adapter is responsible for displaying a particular type of in-app message.
Nested Classes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
interface | InAppMessageAdapter.Factory | Factory interface for InAppMessageAdapters. | |||||||||
@interface | InAppMessageAdapter.PrepareResult |
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
int | CANCEL | Indicates that the prepare step failed and the schedule should be canceled. | |||||||||
int | OK | Indicates a successful result. | |||||||||
int | RETRY | Indicates that the the prepare step should be retried. |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
abstract boolean |
isReady(Context context)
Called before displaying but after the message is prepared.
| ||||||||||
abstract void |
onDisplay(Context context, DisplayHandler displayHandler)
Called to display an in-app message.
| ||||||||||
abstract void |
onFinish(Context context)
Called after the in-app message is finished displaying.
| ||||||||||
abstract int |
onPrepare(Context context, Assets assets)
Called to prepare the message to be displayed.
|
Indicates that the prepare step failed and the schedule should be canceled.
Indicates a successful result.
Indicates that the the prepare step should be retried.
Called before displaying but after the message is prepared.
context | The application context. |
---|
true
if the message is ready to be displayed, otherwise false
.
Called to display an in-app message.
context | The application context. |
---|---|
displayHandler | The display handler. |
Called after the in-app message is finished displaying. Perform any cache clean up here.
context | The application context. |
---|
Called to prepare the message to be displayed.
context | The application context. |
---|---|
assets | Any assets that were prepared for the message. |