java.lang.Object | |
↳ | com.urbanairship.iam.banner.BannerDisplayContent |
Display content for a TYPE_BANNER
in-app message.
Nested Classes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
class | BannerDisplayContent.Builder | Banner Display Content Builder. | |||||||||
@interface | BannerDisplayContent.Placement | ||||||||||
@interface | BannerDisplayContent.Template |
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
long | DEFAULT_DURATION_MS | Default duration in milliseconds. | |||||||||
int | MAX_BUTTONS | Maximum number of buttons supported by a banner. | |||||||||
String | PLACEMENT_BOTTOM | Display the message on bottom of the screen. | |||||||||
String | PLACEMENT_TOP | Display the message on top of the screen. | |||||||||
String | TEMPLATE_LEFT_MEDIA | Template to display the optional media on the left. | |||||||||
String | TEMPLATE_RIGHT_MEDIA | Template to display the optional media on the right. |
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From interface
com.urbanairship.iam.DisplayContent
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
boolean | equals(Object o) | ||||||||||
static BannerDisplayContent |
fromJson(JsonValue value)
Parses banner display JSON.
| ||||||||||
Map<String, JsonValue> |
getActions()
Returns the action names and values to be run when the banner is clicked.
| ||||||||||
int |
getBackgroundColor()
Returns the banner background color.
| ||||||||||
TextInfo |
getBody()
Returns the optional body
TextInfo . | ||||||||||
float |
getBorderRadius()
Returns the border radius in dps.
| ||||||||||
String |
getButtonLayout()
Returns the button layout.
| ||||||||||
List<ButtonInfo> |
getButtons()
Returns the list of optional buttons.
| ||||||||||
int |
getDismissButtonColor()
Returns the banner dismiss button color.
| ||||||||||
long |
getDuration()
Returns the banner display duration.
| ||||||||||
TextInfo |
getHeading()
Returns the optional heading
TextInfo . | ||||||||||
MediaInfo |
getMedia()
Returns the optional
MediaInfo . | ||||||||||
String |
getPlacement()
Returns the banner placement.
| ||||||||||
String |
getTemplate()
Returns the banner template.
| ||||||||||
int | hashCode() | ||||||||||
static BannerDisplayContent.Builder |
newBuilder()
Builder factory method.
| ||||||||||
static BannerDisplayContent.Builder |
newBuilder(BannerDisplayContent displayContent)
Creates a builder from existing display content.
| ||||||||||
JsonValue |
toJsonValue()
Returns the objects represented as a JsonValue.
| ||||||||||
String | toString() |
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
From interface
com.urbanairship.json.JsonSerializable
|
Default duration in milliseconds.
Maximum number of buttons supported by a banner.
Display the message on bottom of the screen.
Display the message on top of the screen.
Template to display the optional media on the left.
Template to display the optional media on the right.
Parses banner display JSON.
value | The json payload. |
---|
JsonException | If the json was unable to be parsed. |
---|
Returns the action names and values to be run when the banner is clicked.
Returns the banner background color.
Returns the border radius in dps.
Returns the list of optional buttons.
Returns the banner dismiss button color.
Returns the banner display duration.
Builder factory method.
Creates a builder from existing display content.
displayContent | The display content. |
---|
Returns the objects represented as a JsonValue.