AndroidPushNotificationTemplate (AWS Java SDK for Amazon Pinpoint 1.11.679 API)

java.lang.Object
- com.amazonaws.services.pinpoint.model.AndroidPushNotificationTemplate

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AndroidPushNotificationTemplate
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Specifies channel-specific content and settings for a message template that can be used in push notifications that are sent through the ADM (Amazon Device Messaging), Baidu (Baidu Cloud Push), or GCM (Firebase Cloud Messaging, formerly Google Cloud Messaging) channel.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AndroidPushNotificationTemplate()

Constructors
Constructor and Description
`AndroidPushNotificationTemplate()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AndroidPushNotificationTemplate`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAction()` The action to occur if a recipient taps a push notification that's based on the message template.
`String`	`getBody()` The message body to use in a push notification that's based on the message template.
`String`	`getImageIconUrl()` The URL of the large icon image to display in the content view of a push notification that's based on the message template.
`String`	`getImageUrl()` The URL of an image to display in a push notification that's based on the message template.
`String`	`getRawContent()` The raw, JSON-formatted string to use as the payload for a push notification that's based on the message template.
`String`	`getSmallImageIconUrl()` The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.
`String`	`getSound()` The sound to play when a recipient receives a push notification that's based on the message template.
`String`	`getTitle()` The title to use in a push notification that's based on the message template.
`String`	`getUrl()` The URL to open in a recipient's default mobile browser, if a recipient taps a a push notification that's based on the message template and the value of the Action property is URL.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setAction(String action)` The action to occur if a recipient taps a push notification that's based on the message template.
`void`	`setBody(String body)` The message body to use in a push notification that's based on the message template.
`void`	`setImageIconUrl(String imageIconUrl)` The URL of the large icon image to display in the content view of a push notification that's based on the message template.
`void`	`setImageUrl(String imageUrl)` The URL of an image to display in a push notification that's based on the message template.
`void`	`setRawContent(String rawContent)` The raw, JSON-formatted string to use as the payload for a push notification that's based on the message template.
`void`	`setSmallImageIconUrl(String smallImageIconUrl)` The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.
`void`	`setSound(String sound)` The sound to play when a recipient receives a push notification that's based on the message template.
`void`	`setTitle(String title)` The title to use in a push notification that's based on the message template.
`void`	`setUrl(String url)` The URL to open in a recipient's default mobile browser, if a recipient taps a a push notification that's based on the message template and the value of the Action property is URL.
`String`	`toString()` Returns a string representation of this object.
`AndroidPushNotificationTemplate`	`withAction(Action action)` The action to occur if a recipient taps a push notification that's based on the message template.
`AndroidPushNotificationTemplate`	`withAction(String action)` The action to occur if a recipient taps a push notification that's based on the message template.
`AndroidPushNotificationTemplate`	`withBody(String body)` The message body to use in a push notification that's based on the message template.
`AndroidPushNotificationTemplate`	`withImageIconUrl(String imageIconUrl)` The URL of the large icon image to display in the content view of a push notification that's based on the message template.
`AndroidPushNotificationTemplate`	`withImageUrl(String imageUrl)` The URL of an image to display in a push notification that's based on the message template.
`AndroidPushNotificationTemplate`	`withRawContent(String rawContent)` The raw, JSON-formatted string to use as the payload for a push notification that's based on the message template.
`AndroidPushNotificationTemplate`	`withSmallImageIconUrl(String smallImageIconUrl)` The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.
`AndroidPushNotificationTemplate`	`withSound(String sound)` The sound to play when a recipient receives a push notification that's based on the message template.
`AndroidPushNotificationTemplate`	`withTitle(String title)` The title to use in a push notification that's based on the message template.
`AndroidPushNotificationTemplate`	`withUrl(String url)` The URL to open in a recipient's default mobile browser, if a recipient taps a a push notification that's based on the message template and the value of the Action property is URL.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AndroidPushNotificationTemplate
```
public AndroidPushNotificationTemplate()
```
- Method Detail
  - setAction
```
public void setAction(String action)
```
    The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:
    - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
    - DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
    - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
    Parameters:
    action - The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:
    
    OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
    
    DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
    
    URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
    See Also:
    
    Action
  - getAction
```
public String getAction()
```
    The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:
    - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
    - DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
    - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
    Returns:
    The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:
    
    OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
    
    DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
    
    URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
    See Also:
    
    Action
  - withAction
```
public AndroidPushNotificationTemplate withAction(String action)
```
    The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:
    - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
    - DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
    - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
    Parameters:
    action - The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:
    
    OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
    
    DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
    
    URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Action
  - withAction
```
public AndroidPushNotificationTemplate withAction(Action action)
```
    The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:
    - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
    - DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
    - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
    Parameters:
    action - The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:
    
    OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
    
    DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
    
    URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Action
  - setBody
```
public void setBody(String body)
```
    The message body to use in a push notification that's based on the message template.
    
    Parameters:
    
    body - The message body to use in a push notification that's based on the message template.
  - getBody
```
public String getBody()
```
    The message body to use in a push notification that's based on the message template.
    
    Returns:
    
    The message body to use in a push notification that's based on the message template.
  - withBody
```
public AndroidPushNotificationTemplate withBody(String body)
```
    The message body to use in a push notification that's based on the message template.
    
    Parameters:
    
    body - The message body to use in a push notification that's based on the message template.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setImageIconUrl
```
public void setImageIconUrl(String imageIconUrl)
```
    The URL of the large icon image to display in the content view of a push notification that's based on the message template.
    
    Parameters:
    
    imageIconUrl - The URL of the large icon image to display in the content view of a push notification that's based on the message template.
  - getImageIconUrl
```
public String getImageIconUrl()
```
    The URL of the large icon image to display in the content view of a push notification that's based on the message template.
    
    Returns:
    
    The URL of the large icon image to display in the content view of a push notification that's based on the message template.
  - withImageIconUrl
```
public AndroidPushNotificationTemplate withImageIconUrl(String imageIconUrl)
```
    The URL of the large icon image to display in the content view of a push notification that's based on the message template.
    
    Parameters:
    
    imageIconUrl - The URL of the large icon image to display in the content view of a push notification that's based on the message template.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setImageUrl
```
public void setImageUrl(String imageUrl)
```
    The URL of an image to display in a push notification that's based on the message template.
    
    Parameters:
    
    imageUrl - The URL of an image to display in a push notification that's based on the message template.
  - getImageUrl
```
public String getImageUrl()
```
    The URL of an image to display in a push notification that's based on the message template.
    
    Returns:
    
    The URL of an image to display in a push notification that's based on the message template.
  - withImageUrl
```
public AndroidPushNotificationTemplate withImageUrl(String imageUrl)
```
    The URL of an image to display in a push notification that's based on the message template.
    
    Parameters:
    
    imageUrl - The URL of an image to display in a push notification that's based on the message template.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRawContent
```
public void setRawContent(String rawContent)
```
    The raw, JSON-formatted string to use as the payload for a push notification that's based on the message template. If specified, this value overrides all other content for the message template.
    
    Parameters:
    
    rawContent - The raw, JSON-formatted string to use as the payload for a push notification that's based on the message template. If specified, this value overrides all other content for the message template.
  - getRawContent
```
public String getRawContent()
```
    The raw, JSON-formatted string to use as the payload for a push notification that's based on the message template. If specified, this value overrides all other content for the message template.
    
    Returns:
    
    The raw, JSON-formatted string to use as the payload for a push notification that's based on the message template. If specified, this value overrides all other content for the message template.
  - withRawContent
```
public AndroidPushNotificationTemplate withRawContent(String rawContent)
```
    The raw, JSON-formatted string to use as the payload for a push notification that's based on the message template. If specified, this value overrides all other content for the message template.
    
    Parameters:
    
    rawContent - The raw, JSON-formatted string to use as the payload for a push notification that's based on the message template. If specified, this value overrides all other content for the message template.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSmallImageIconUrl
```
public void setSmallImageIconUrl(String smallImageIconUrl)
```
    The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.
    
    Parameters:
    
    smallImageIconUrl - The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.
  - getSmallImageIconUrl
```
public String getSmallImageIconUrl()
```
    The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.
    
    Returns:
    
    The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.
  - withSmallImageIconUrl
```
public AndroidPushNotificationTemplate withSmallImageIconUrl(String smallImageIconUrl)
```
    The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.
    
    Parameters:
    
    smallImageIconUrl - The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSound
```
public void setSound(String sound)
```
    The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
    
    Parameters:
    
    sound - The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
  - getSound
```
public String getSound()
```
    The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
    
    Returns:
    
    The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
  - withSound
```
public AndroidPushNotificationTemplate withSound(String sound)
```
    The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
    
    Parameters:
    
    sound - The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTitle
```
public void setTitle(String title)
```
    The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.
    
    Parameters:
    
    title - The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.
  - getTitle
```
public String getTitle()
```
    The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.
    
    Returns:
    
    The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.
  - withTitle
```
public AndroidPushNotificationTemplate withTitle(String title)
```
    The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.
    
    Parameters:
    
    title - The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUrl
```
public void setUrl(String url)
```
    The URL to open in a recipient's default mobile browser, if a recipient taps a a push notification that's based on the message template and the value of the Action property is URL.
    
    Parameters:
    
    url - The URL to open in a recipient's default mobile browser, if a recipient taps a a push notification that's based on the message template and the value of the Action property is URL.
  - getUrl
```
public String getUrl()
```
    The URL to open in a recipient's default mobile browser, if a recipient taps a a push notification that's based on the message template and the value of the Action property is URL.
    
    Returns:
    
    The URL to open in a recipient's default mobile browser, if a recipient taps a a push notification that's based on the message template and the value of the Action property is URL.
  - withUrl
```
public AndroidPushNotificationTemplate withUrl(String url)
```
    The URL to open in a recipient's default mobile browser, if a recipient taps a a push notification that's based on the message template and the value of the Action property is URL.
    
    Parameters:
    
    url - The URL to open in a recipient's default mobile browser, if a recipient taps a a push notification that's based on the message template and the value of the Action property is URL.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public AndroidPushNotificationTemplate clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class AndroidPushNotificationTemplate

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AndroidPushNotificationTemplate

Method Detail

setAction

getAction

withAction

withAction

setBody

getBody

withBody

setImageIconUrl

getImageIconUrl

withImageIconUrl

setImageUrl

getImageUrl

withImageUrl

setRawContent

getRawContent

withRawContent

setSmallImageIconUrl

getSmallImageIconUrl

withSmallImageIconUrl

setSound

getSound

withSound

setTitle

getTitle

withTitle

setUrl

getUrl

withUrl

toString

equals

hashCode

clone

marshall