public static class

ModalDisplayContent.Builder

extends Object
java.lang.Object
   ↳ com.urbanairship.iam.modal.ModalDisplayContent.Builder

Class Overview

Display Content Builder.

Summary

Public Methods
ModalDisplayContent.Builder addButton(ButtonInfo buttonInfo)
Adds a button info.
ModalDisplayContent build()
Builds the modal display content.
ModalDisplayContent.Builder setAllowFullscreenDisplay(boolean isFullscreenDisplayAllowed)
Enables the modal dialog to display as fullscreen.
ModalDisplayContent.Builder setBackgroundColor(int color)
Sets the background color.
ModalDisplayContent.Builder setBody(TextInfo body)
Sets the message's body.
ModalDisplayContent.Builder setBorderRadius(float borderRadius)
Sets the border radius in dps.
ModalDisplayContent.Builder setButtonLayout(String buttonLayout)
Sets the button layout.
ModalDisplayContent.Builder setButtons(List<ButtonInfo> buttons)
Sets the message's buttons.
ModalDisplayContent.Builder setDismissButtonColor(int color)
Sets the dismiss button color.
ModalDisplayContent.Builder setFooter(ButtonInfo footer)
Sets the footer button.
ModalDisplayContent.Builder setHeading(TextInfo heading)
Sets the message's heading.
ModalDisplayContent.Builder setMedia(MediaInfo media)
Sets the media.
ModalDisplayContent.Builder setTemplate(String template)
Sets the template.
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public ModalDisplayContent.Builder addButton (ButtonInfo buttonInfo)

Adds a button info.

Parameters
buttonInfo Adds a button to the message.
Returns
  • The builder instance.

public ModalDisplayContent build ()

Builds the modal display content.

Returns
  • The modal display content.
Throws
IllegalArgumentException If more than 2 buttons are defined, or if both the heading and body are missing.

public ModalDisplayContent.Builder setAllowFullscreenDisplay (boolean isFullscreenDisplayAllowed)

Enables the modal dialog to display as fullscreen. The modal will display as fullscreen if enabled and and the bool resource `ua_iam_modal_allow_fullscreen_display` is true. `ua_iam_modal_allow_fullscreen_display` defaults to true when the screen width is less than 480dps.

Parameters
isFullscreenDisplayAllowed true to allow displaying the iam as fullscreen, otherwise false.
Returns
  • The builder instance.

public ModalDisplayContent.Builder setBackgroundColor (int color)

Sets the background color. Defaults to white.

Parameters
color The background color.
Returns
  • The builder instance.

public ModalDisplayContent.Builder setBody (TextInfo body)

Sets the message's body.

Parameters
body The message's body.
Returns
  • The builder instance.

public ModalDisplayContent.Builder setBorderRadius (float borderRadius)

Sets the border radius in dps. Defaults to 0.

Parameters
borderRadius The border radius.
Returns
  • The builder instance.

public ModalDisplayContent.Builder setButtonLayout (String buttonLayout)

Sets the button layout.

Parameters
buttonLayout The button layout.
Returns
  • The builder instance.

public ModalDisplayContent.Builder setButtons (List<ButtonInfo> buttons)

Sets the message's buttons.

Parameters
buttons A list of button infos.
Returns
  • The builder instance.

public ModalDisplayContent.Builder setDismissButtonColor (int color)

Sets the dismiss button color. Defaults to black.

Parameters
color The dismiss button color.
Returns
  • The builder instance.

public ModalDisplayContent.Builder setFooter (ButtonInfo footer)

Sets the footer button.

Parameters
footer The footer button info.
Returns
  • The builder instance.

public ModalDisplayContent.Builder setHeading (TextInfo heading)

Sets the message's heading.

Parameters
heading The message's heading.
Returns
  • The builder instance.

public ModalDisplayContent.Builder setMedia (MediaInfo media)

Sets the media.

Parameters
media The media info.
Returns
  • The builder instance.

public ModalDisplayContent.Builder setTemplate (String template)

Sets the template. Defaults to TEMPLATE_HEADER_MEDIA_BODY.

Parameters
template The message's template.
Returns
  • The builder instance.