public class

FullScreenDisplayContent

extends Object
implements DisplayContent
java.lang.Object
   ↳ com.urbanairship.iam.fullscreen.FullScreenDisplayContent

Class Overview

Display content for a TYPE_FULLSCREEN in-app message.

Summary

Nested Classes
class FullScreenDisplayContent.Builder Display Content Builder. 
@interface FullScreenDisplayContent.Template  
Constants
int MAX_BUTTONS Maximum number of buttons.
String TEMPLATE_HEADER_BODY_MEDIA Template with display order of header, body, media, buttons, footer.
String TEMPLATE_HEADER_MEDIA_BODY Template with display order of header, media, body, buttons, footer.
String TEMPLATE_MEDIA_HEADER_BODY Template with display order of media, header, body, buttons, footer.
[Expand]
Inherited Constants
From interface com.urbanairship.iam.DisplayContent
Public Methods
boolean equals(Object o)
static FullScreenDisplayContent fromJson(JsonValue value)
Parses full screen display JSON.
int getBackgroundColor()
Returns the background color.
TextInfo getBody()
Returns the optional body TextInfo.
String getButtonLayout()
Returns the button layout.
List<ButtonInfo> getButtons()
Returns the list of optional buttons.
int getDismissButtonColor()
Returns the dismiss button color.
ButtonInfo getFooter()
Returns the footer button.
TextInfo getHeading()
Returns the optional heading TextInfo.
MediaInfo getMedia()
Returns the optional MediaInfo.
String getTemplate()
Returns the template.
int hashCode()
static FullScreenDisplayContent.Builder newBuilder(FullScreenDisplayContent displayContent)
Creates a builder from existing display content.
static FullScreenDisplayContent.Builder newBuilder()
Builder factory method.
static FullScreenDisplayContent parseJson(JsonValue json)
This method is deprecated. To be removed in SDK 12. Use fromJson(JsonValue) instead.
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

Constants

public static final int MAX_BUTTONS

Maximum number of buttons.

Constant Value: 5 (0x00000005)

public static final String TEMPLATE_HEADER_BODY_MEDIA

Template with display order of header, body, media, buttons, footer.

Constant Value: "header_body_media"

public static final String TEMPLATE_HEADER_MEDIA_BODY

Template with display order of header, media, body, buttons, footer.

Constant Value: "header_media_body"

public static final String TEMPLATE_MEDIA_HEADER_BODY

Template with display order of media, header, body, buttons, footer.

Constant Value: "media_header_body"

Public Methods

public boolean equals (Object o)

public static FullScreenDisplayContent fromJson (JsonValue value)

Parses full screen display JSON.

Parameters
value The json payload.
Returns
  • The parsed display content.
Throws
JsonException If the json was unable to be parsed.

public int getBackgroundColor ()

Returns the background color.

Returns
  • The background color.

public TextInfo getBody ()

Returns the optional body TextInfo.

Returns
  • The display body.

public String getButtonLayout ()

Returns the button layout.

Returns
  • The button layout.

public List<ButtonInfo> getButtons ()

Returns the list of optional buttons.

Returns
  • A list of buttons.

public int getDismissButtonColor ()

Returns the dismiss button color.

Returns
  • The dismiss button color.

public ButtonInfo getFooter ()

Returns the footer button.

Returns
  • The footer button.

public TextInfo getHeading ()

Returns the optional heading TextInfo.

Returns
  • The display heading.

public MediaInfo getMedia ()

Returns the optional MediaInfo.

Returns
  • The display media.

public String getTemplate ()

Returns the template.

Returns
  • The template.

public int hashCode ()

public static FullScreenDisplayContent.Builder newBuilder (FullScreenDisplayContent displayContent)

Creates a builder from existing display content.

Parameters
displayContent The display content.
Returns
  • A builder instance.

public static FullScreenDisplayContent.Builder newBuilder ()

Builder factory method.

Returns
  • A builder instance.

public static FullScreenDisplayContent parseJson (JsonValue json)

This method is deprecated.
To be removed in SDK 12. Use fromJson(JsonValue) instead.

Parameters
json The json value.
Returns
  • The parsed FullScreenDisplayContent.
Throws
JsonException If the JSON is invalid.

public JsonValue toJsonValue ()

Returns the objects represented as a JsonValue.

Returns
  • The object as a JsonValue.

public String toString ()