APNSPushNotificationTemplate (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class APNSPushNotificationTemplate
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 APNs (Apple Push Notification service) channel.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

APNSPushNotificationTemplate()

Constructors
Constructor and Description
`APNSPushNotificationTemplate()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`APNSPushNotificationTemplate`	`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 push notifications that are based on the message template.
`String`	`getMediaUrl()` The URL of an image or video to display in push notifications that are based on the message template.
`String`	`getRawContent()` The raw, JSON-formatted string to use as the payload for push notifications that are based on the message template.
`String`	`getSound()` The key for the sound to play when the recipient receives a push notification that's based on the message template.
`String`	`getTitle()` The title to use in push notifications that are based on the message template.
`String`	`getUrl()` The URL to open in the recipient's default mobile browser, if a recipient taps 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)` Marshalls this structured data using the given `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 push notifications that are based on the message template.
`void`	`setMediaUrl(String mediaUrl)` The URL of an image or video to display in push notifications that are based on the message template.
`void`	`setRawContent(String rawContent)` The raw, JSON-formatted string to use as the payload for push notifications that are based on the message template.
`void`	`setSound(String sound)` The key for the sound to play when the recipient receives a push notification that's based on the message template.
`void`	`setTitle(String title)` The title to use in push notifications that are based on the message template.
`void`	`setUrl(String url)` The URL to open in the recipient's default mobile browser, if a recipient taps 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.
`APNSPushNotificationTemplate`	`withAction(Action action)` The action to occur if a recipient taps a push notification that's based on the message template.
`APNSPushNotificationTemplate`	`withAction(String action)` The action to occur if a recipient taps a push notification that's based on the message template.
`APNSPushNotificationTemplate`	`withBody(String body)` The message body to use in push notifications that are based on the message template.
`APNSPushNotificationTemplate`	`withMediaUrl(String mediaUrl)` The URL of an image or video to display in push notifications that are based on the message template.
`APNSPushNotificationTemplate`	`withRawContent(String rawContent)` The raw, JSON-formatted string to use as the payload for push notifications that are based on the message template.
`APNSPushNotificationTemplate`	`withSound(String sound)` The key for the sound to play when the recipient receives a push notification that's based on the message template.
`APNSPushNotificationTemplate`	`withTitle(String title)` The title to use in push notifications that are based on the message template.
`APNSPushNotificationTemplate`	`withUrl(String url)` The URL to open in the recipient's default mobile browser, if a recipient taps 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
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - APNSPushNotificationTemplate
```
public APNSPushNotificationTemplate()
```
- 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 setting uses the deep-linking features of the iOS 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 setting uses the deep-linking features of the iOS 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 setting uses the deep-linking features of the iOS 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 setting uses the deep-linking features of the iOS 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 APNSPushNotificationTemplate 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 setting uses the deep-linking features of the iOS 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 setting uses the deep-linking features of the iOS 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 APNSPushNotificationTemplate 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 setting uses the deep-linking features of the iOS 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 setting uses the deep-linking features of the iOS 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 push notifications that are based on the message template.
    
    Parameters:
    
    body - The message body to use in push notifications that are based on the message template.
  - getBody
```
public String getBody()
```
    The message body to use in push notifications that are based on the message template.
    
    Returns:
    
    The message body to use in push notifications that are based on the message template.
  - withBody
```
public APNSPushNotificationTemplate withBody(String body)
```
    The message body to use in push notifications that are based on the message template.
    
    Parameters:
    
    body - The message body to use in push notifications that are based on the message template.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMediaUrl
```
public void setMediaUrl(String mediaUrl)
```
    The URL of an image or video to display in push notifications that are based on the message template.
    
    Parameters:
    
    mediaUrl - The URL of an image or video to display in push notifications that are based on the message template.
  - getMediaUrl
```
public String getMediaUrl()
```
    The URL of an image or video to display in push notifications that are based on the message template.
    
    Returns:
    
    The URL of an image or video to display in push notifications that are based on the message template.
  - withMediaUrl
```
public APNSPushNotificationTemplate withMediaUrl(String mediaUrl)
```
    The URL of an image or video to display in push notifications that are based on the message template.
    
    Parameters:
    
    mediaUrl - The URL of an image or video to display in push notifications that are 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 push notifications that are 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 push notifications that are 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 push notifications that are 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 push notifications that are based on the message template. If specified, this value overrides all other content for the message template.
  - withRawContent
```
public APNSPushNotificationTemplate withRawContent(String rawContent)
```
    The raw, JSON-formatted string to use as the payload for push notifications that are 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 push notifications that are 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.
  - setSound
```
public void setSound(String sound)
```
    The key for the sound to play when the recipient receives a push notification that's based on the message template. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.
    
    Parameters:
    
    sound - The key for the sound to play when the recipient receives a push notification that's based on the message template. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.
  - getSound
```
public String getSound()
```
    The key for the sound to play when the recipient receives a push notification that's based on the message template. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.
    
    Returns:
    
    The key for the sound to play when the recipient receives a push notification that's based on the message template. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.
  - withSound
```
public APNSPushNotificationTemplate withSound(String sound)
```
    The key for the sound to play when the recipient receives a push notification that's based on the message template. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.
    
    Parameters:
    
    sound - The key for the sound to play when the recipient receives a push notification that's based on the message template. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.
    
    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 push notifications that are based on the message template. This title appears above the notification message on a recipient's device.
    
    Parameters:
    
    title - The title to use in push notifications that are 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 push notifications that are based on the message template. This title appears above the notification message on a recipient's device.
    
    Returns:
    
    The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device.
  - withTitle
```
public APNSPushNotificationTemplate withTitle(String title)
```
    The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device.
    
    Parameters:
    
    title - The title to use in push notifications that are 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 the recipient's default mobile browser, if a recipient taps 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 the recipient's default mobile browser, if a recipient taps 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 the recipient's default mobile browser, if a recipient taps 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 the recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.
  - withUrl
```
public APNSPushNotificationTemplate withUrl(String url)
```
    The URL to open in the recipient's default mobile browser, if a recipient taps 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 the recipient's default mobile browser, if a recipient taps 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 APNSPushNotificationTemplate clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class APNSPushNotificationTemplate

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

APNSPushNotificationTemplate

Method Detail

setAction

getAction

withAction

withAction

setBody

getBody

withBody

setMediaUrl

getMediaUrl

withMediaUrl

setRawContent

getRawContent

withRawContent

setSound

getSound

withSound

setTitle

getTitle

withTitle

setUrl

getUrl

withUrl

toString

equals

hashCode

clone

marshall