All Implemented Interfaces:
```
public class MessageSettings

                    
```
The class defines the layout and behavior of an in-app message.
These settings are customizable in a Messaging extension message: width: Width of the view in which the message is displayed. Represented in percentage of the total screen width. height: Height of the view in which the message is displayed. Represented in percentage of the total screen height. verticalAlign: Defines the vertical alignment of the message. The alignments can be seen in the MessageAlignment enum. horizontalAlign: Defines the horizontal alignment of the message. The alignments can be seen in the MessageAlignment enum. verticalInset: Defines the vertical inset respective to the verticalAlign. Represented in percentage of the total screen height. horizontalInset: Defines the horizontal inset respective to the horizontalAlign. Represented in percentage of the total screen width. uiTakeover: If true, a displayed message will prevent the user from other UI interactions. displayAnimation: Defines the animation to be used when the message is displayed. The animations can be seen in the MessageAnimation enum. dismissAnimation: Defines the animation to be used when the message is dismissed. The animations can be seen in the MessageAnimation enum. backdropColor: Defines the color of the backdrop shown when a uiTakeover message is displayed. backdropOpacity: Defines the opacity of the backdrop shown when a uiTakeover message is displayed. cornerRadius: Defines the angle to use when rounding the message's webview. gestures: A mapping of gestures and their associated behaviors. The gestures can be seen in the MessageGesture enum. The behavior string is handled by the FullscreenMessageDelegate's overrideUrlLoad function.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public enum`	`MessageSettings.MessageAlignment`	Enum representing Message alignment.
`public enum`	`MessageSettings.MessageAnimation`	Enum representing Message animations.
`public enum`	`MessageSettings.MessageGesture`	Enum representing Message gestures.

Field Summary

Fields
Modifier and Type	Field	Description
`public Object`	`parent`
`public int`	`width`
`public int`	`height`
`public MessageSettings.MessageAlignment`	`verticalAlign`
`public MessageSettings.MessageAlignment`	`horizontalAlign`
`public int`	`verticalInset`
`public int`	`horizontalInset`
`public boolean`	`uiTakeover`
`public MessageSettings.MessageAnimation`	`displayAnimation`
`public MessageSettings.MessageAnimation`	`dismissAnimation`
`public String`	`backdropColor`
`public float`	`backdropOpacity`
`public float`	`cornerRadius`
`public Map<MessageSettings.MessageGesture, String>`	`gestures`

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`Object`	`getParent()`	Returns the object that owns the message created using these settings.
`void`	`setParent(Object parent)`
`int`	`getWidth()`	Returns the width of the view in which the message is displayed.
`void`	`setWidth(int width)`
`int`	`getHeight()`	Returns the height of the view in which the message is displayed.
`void`	`setHeight(int height)`	Sets the height of the view in which the message is displayed.
`MessageSettings.MessageAlignment`	`getVerticalAlign()`	Returns the vertical alignment of the message.
`void`	`setVerticalAlign(MessageSettings.MessageAlignment verticalAlign)`	Sets the vertical alignment of the message.
`MessageSettings.MessageAlignment`	`getHorizontalAlign()`	Returns the horizontal alignment of the message.
`void`	`setHorizontalAlign(MessageSettings.MessageAlignment horizontalAlign)`	Sets the horizontal alignment of the message.
`int`	`getVerticalInset()`	Returns the vertical inset respective to the vertical alignment.
`void`	`setVerticalInset(int verticalInset)`	Sets the vertical inset respective to the vertical alignment.
`int`	`getHorizontalInset()`	Returns the horizontal inset respective to the `horizontal alignment.
`void`	`setHorizontalInset(int horizontalInset)`	Sets the horizontal inset respective to the `horizontal alignment.
`boolean`	`getUITakeover()`	Returns a boolean which if true, will prevent the user from other UI interactions if a message is currently displayed.
`void`	`setUiTakeover(boolean uiTakeover)`	Sets a boolean which if true, will prevent the user from other UI interactions if a message is currently displayed.
`MessageSettings.MessageAnimation`	`getDisplayAnimation()`	Returns the animation to be used when the message is displayed.
`void`	`setDisplayAnimation(MessageSettings.MessageAnimation displayAnimation)`	Sets the animation to be used when the message is displayed.
`MessageSettings.MessageAnimation`	`getDismissAnimation()`	Returns the animation to be used when the message is dismissed.
`void`	`setDismissAnimation(MessageSettings.MessageAnimation dismissAnimation)`	Sets the animation to be used when the message is dismissed.
`String`	`getBackdropColor()`	Returns the color of the backdrop shown when a uiTakeover message is displayed.
`void`	`setBackdropColor(String backdropColor)`	Sets the color of the backdrop shown when a uiTakeover message is displayed.
`float`	`getBackdropOpacity()`	Returns the opacity of the backdrop shown when a uiTakeover message is displayed.
`void`	`setBackdropOpacity(float backdropOpacity)`	Sets the opacity of the backdrop shown when a uiTakeover message is displayed.
`float`	`getCornerRadius()`	Returns the angle to use when rounding the message's webview.
`void`	`setCornerRadius(float cornerRadius)`	Sets the angle to use when rounding the message's webview.
`Map<MessageSettings.MessageGesture, String>`	`getGestures()`	Returns a mapping of gestures and their associated behaviors.
`void`	`setGestures(Map<MessageSettings.MessageGesture, String> gestures)`	Sets a mapping of gestures and their associated behaviors.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - getParent
```
 Object getParent()
```
    Returns the object that owns the message created using these settings.
  - setParent
```
 void setParent(Object parent)
```
  - getWidth
```
 int getWidth()
```
    Returns the width of the view in which the message is displayed. Represented in percentage of the total screen width.
  - setWidth
```
 void setWidth(int width)
```
  - getHeight
```
 int getHeight()
```
    Returns the height of the view in which the message is displayed. Represented in percentage of the total screen height.
  - setHeight
```
 void setHeight(int height)
```
    Sets the height of the view in which the message is displayed.
    
    Parameters:
    
    height - An int containing the height of the view in which the message is displayed
  - getVerticalAlign
```
 MessageSettings.MessageAlignment getVerticalAlign()
```
    Returns the vertical alignment of the message. See MessageAlignment.
  - setVerticalAlign
```
 void setVerticalAlign(MessageSettings.MessageAlignment verticalAlign)
```
    Sets the vertical alignment of the message.
    
    Parameters:
    
    verticalAlign - A MessageAlignment value for the vertical alignment
  - getHorizontalAlign
```
 MessageSettings.MessageAlignment getHorizontalAlign()
```
    Returns the horizontal alignment of the message. See MessageAlignment.
  - setHorizontalAlign
```
 void setHorizontalAlign(MessageSettings.MessageAlignment horizontalAlign)
```
    Sets the horizontal alignment of the message. See MessageAlignment.
    
    Parameters:
    
    horizontalAlign - A MessageAlignment value for the horizontal alignment
  - getVerticalInset
```
 int getVerticalInset()
```
    Returns the vertical inset respective to the vertical alignment. Represented in percentage of the total screen height.
  - setVerticalInset
```
 void setVerticalInset(int verticalInset)
```
    Sets the vertical inset respective to the vertical alignment. Represented in percentage of the total screen height.
    
    Parameters:
    
    verticalInset - An int containing the vertical inset percentage
  - getHorizontalInset
```
 int getHorizontalInset()
```
    Returns the horizontal inset respective to the `horizontal alignment. Represented in percentage of the total screen width.
  - setHorizontalInset
```
 void setHorizontalInset(int horizontalInset)
```
    Sets the horizontal inset respective to the `horizontal alignment. Represented in percentage of the total screen width.
    
    Parameters:
    
    horizontalInset - An int containing the horizontal inset percentage
  - getUITakeover
```
 boolean getUITakeover()
```
    Returns a boolean which if true, will prevent the user from other UI interactions if a message is currently displayed.
  - setUiTakeover
```
 void setUiTakeover(boolean uiTakeover)
```
    Sets a boolean which if true, will prevent the user from other UI interactions if a message is currently displayed.
    
    Parameters:
    
    uiTakeover - A boolean value which if true, will prevent the user from other UI interactions if a message is currently displayed.
  - getDisplayAnimation
```
 MessageSettings.MessageAnimation getDisplayAnimation()
```
    Returns the animation to be used when the message is displayed. See MessageAnimation.
  - setDisplayAnimation
```
 void setDisplayAnimation(MessageSettings.MessageAnimation displayAnimation)
```
    Sets the animation to be used when the message is displayed. See MessageAnimation.
    
    Parameters:
    
    displayAnimation - A MessageAnimation value for the display animation
  - getDismissAnimation
```
 MessageSettings.MessageAnimation getDismissAnimation()
```
    Returns the animation to be used when the message is dismissed. See MessageAnimation.
  - setDismissAnimation
```
 void setDismissAnimation(MessageSettings.MessageAnimation dismissAnimation)
```
    Sets the animation to be used when the message is dismissed. See MessageAnimation.
    
    Parameters:
    
    dismissAnimation - A MessageAnimation value for the dismiss animation
  - getBackdropColor
```
 String getBackdropColor()
```
    Returns the color of the backdrop shown when a uiTakeover message is displayed.
  - setBackdropColor
```
 void setBackdropColor(String backdropColor)
```
    Sets the color of the backdrop shown when a uiTakeover message is displayed.
    
    Parameters:
    
    backdropColor - A String containing the HTML hex string color code to use for the backdrop
  - getBackdropOpacity
```
 float getBackdropOpacity()
```
    Returns the opacity of the backdrop shown when a uiTakeover message is displayed.
  - setBackdropOpacity
```
 void setBackdropOpacity(float backdropOpacity)
```
    Sets the opacity of the backdrop shown when a uiTakeover message is displayed.
    
    Parameters:
    
    backdropOpacity - A float containing the backdrop opacity percentage with 0.0 being fully transparent and 1.
  - getCornerRadius
```
 float getCornerRadius()
```
    Returns the angle to use when rounding the message's webview.
  - setCornerRadius
```
 void setCornerRadius(float cornerRadius)
```
    Sets the angle to use when rounding the message's webview.
    
    Parameters:
    
    cornerRadius - A float containing the corner radius angle to use when rounding the message corners
  - getGestures
```
 Map<MessageSettings.MessageGesture, String> getGestures()
```
    Returns a mapping of gestures and their associated behaviors.
  - setGestures
```
 void setGestures(Map<MessageSettings.MessageGesture, String> gestures)
```
    Sets a mapping of gestures and their associated behaviors.
    
    Parameters:
    
    gestures - A Map<MessageGesture, String containing gestures and their associated behaviors

Class MessageSettings

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

getParent

setParent

getWidth

setWidth

getHeight

setHeight

getVerticalAlign

setVerticalAlign

getHorizontalAlign

setHorizontalAlign

getVerticalInset

setVerticalInset

getHorizontalInset

setHorizontalInset

getUITakeover

setUiTakeover

getDisplayAnimation

setDisplayAnimation

getDismissAnimation

setDismissAnimation

getBackdropColor

setBackdropColor

getBackdropOpacity

setBackdropOpacity

getCornerRadius

setCornerRadius

getGestures

setGestures