APNSMessage (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class APNSMessage
extends Object
implements Serializable, Cloneable, StructuredPojo

APNS Message.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

APNSMessage()

Constructors
Constructor and Description
`APNSMessage()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`APNSMessage`	`addDataEntry(String key, String value)`
`APNSMessage`	`addSubstitutionsEntry(String key, List<String> value)`
`APNSMessage`	`clearDataEntries()` Removes all the entries added into Data.
`APNSMessage`	`clearSubstitutionsEntries()` Removes all the entries added into Substitutions.
`APNSMessage`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAction()` The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background.
`Integer`	`getBadge()` Include this key when you want the system to modify the badge of your app icon.
`String`	`getBody()` The message body of the notification.
`String`	`getCategory()` Provide this key with a string value that represents the notification's type.
`String`	`getCollapseId()` An ID that, if assigned to multiple messages, causes APNs to coalesce the messages into a single push notification instead of delivering each message individually.
`Map<String,String>`	`getData()` The data payload used for a silent push.
`String`	`getMediaUrl()` The URL that points to a video used in the push notification.
`String`	`getPreferredAuthenticationMethod()` The preferred authentication method, either "CERTIFICATE" or "TOKEN"
`String`	`getPriority()` The message priority.
`String`	`getRawContent()` The Raw JSON formatted string to be used as the payload.
`Boolean`	`getSilentPush()` Indicates if the message should display on the users device.
`String`	`getSound()` Include this key when you want the system to play a sound.
`Map<String,List<String>>`	`getSubstitutions()` Default message substitutions.
`String`	`getThreadId()` Provide this key with a string value that represents the app-specific identifier for grouping notifications.
`Integer`	`getTimeToLive()` The length of time (in seconds) that APNs stores and attempts to deliver the message.
`String`	`getTitle()` The message title that displays above the message on the user's device.
`String`	`getUrl()` The URL to open in the user's mobile browser.
`int`	`hashCode()`
`Boolean`	`isSilentPush()` Indicates if the message should display on the users device.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAction(Action action)` The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background.
`void`	`setAction(String action)` The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background.
`void`	`setBadge(Integer badge)` Include this key when you want the system to modify the badge of your app icon.
`void`	`setBody(String body)` The message body of the notification.
`void`	`setCategory(String category)` Provide this key with a string value that represents the notification's type.
`void`	`setCollapseId(String collapseId)` An ID that, if assigned to multiple messages, causes APNs to coalesce the messages into a single push notification instead of delivering each message individually.
`void`	`setData(Map<String,String> data)` The data payload used for a silent push.
`void`	`setMediaUrl(String mediaUrl)` The URL that points to a video used in the push notification.
`void`	`setPreferredAuthenticationMethod(String preferredAuthenticationMethod)` The preferred authentication method, either "CERTIFICATE" or "TOKEN"
`void`	`setPriority(String priority)` The message priority.
`void`	`setRawContent(String rawContent)` The Raw JSON formatted string to be used as the payload.
`void`	`setSilentPush(Boolean silentPush)` Indicates if the message should display on the users device.
`void`	`setSound(String sound)` Include this key when you want the system to play a sound.
`void`	`setSubstitutions(Map<String,List<String>> substitutions)` Default message substitutions.
`void`	`setThreadId(String threadId)` Provide this key with a string value that represents the app-specific identifier for grouping notifications.
`void`	`setTimeToLive(Integer timeToLive)` The length of time (in seconds) that APNs stores and attempts to deliver the message.
`void`	`setTitle(String title)` The message title that displays above the message on the user's device.
`void`	`setUrl(String url)` The URL to open in the user's mobile browser.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`APNSMessage`	`withAction(Action action)` The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background.
`APNSMessage`	`withAction(String action)` The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background.
`APNSMessage`	`withBadge(Integer badge)` Include this key when you want the system to modify the badge of your app icon.
`APNSMessage`	`withBody(String body)` The message body of the notification.
`APNSMessage`	`withCategory(String category)` Provide this key with a string value that represents the notification's type.
`APNSMessage`	`withCollapseId(String collapseId)` An ID that, if assigned to multiple messages, causes APNs to coalesce the messages into a single push notification instead of delivering each message individually.
`APNSMessage`	`withData(Map<String,String> data)` The data payload used for a silent push.
`APNSMessage`	`withMediaUrl(String mediaUrl)` The URL that points to a video used in the push notification.
`APNSMessage`	`withPreferredAuthenticationMethod(String preferredAuthenticationMethod)` The preferred authentication method, either "CERTIFICATE" or "TOKEN"
`APNSMessage`	`withPriority(String priority)` The message priority.
`APNSMessage`	`withRawContent(String rawContent)` The Raw JSON formatted string to be used as the payload.
`APNSMessage`	`withSilentPush(Boolean silentPush)` Indicates if the message should display on the users device.
`APNSMessage`	`withSound(String sound)` Include this key when you want the system to play a sound.
`APNSMessage`	`withSubstitutions(Map<String,List<String>> substitutions)` Default message substitutions.
`APNSMessage`	`withThreadId(String threadId)` Provide this key with a string value that represents the app-specific identifier for grouping notifications.
`APNSMessage`	`withTimeToLive(Integer timeToLive)` The length of time (in seconds) that APNs stores and attempts to deliver the message.
`APNSMessage`	`withTitle(String title)` The message title that displays above the message on the user's device.
`APNSMessage`	`withUrl(String url)` The URL to open in the user's mobile browser.

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

- Constructor Detail
  - APNSMessage
```
public APNSMessage()
```
- Method Detail
  - setAction
```
public void setAction(String action)
```
    The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL
    
    Parameters:
    
    action - The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL
    
    See Also:
    
    Action
  - getAction
```
public String getAction()
```
    The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL
    
    Returns:
    
    The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL
    
    See Also:
    
    Action
  - withAction
```
public APNSMessage withAction(String action)
```
    The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL
    
    Parameters:
    
    action - The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Action
  - setAction
```
public void setAction(Action action)
```
    The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL
    
    Parameters:
    
    action - The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL
    
    See Also:
    
    Action
  - withAction
```
public APNSMessage withAction(Action action)
```
    The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL
    
    Parameters:
    
    action - The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Action
  - setBadge
```
public void setBadge(Integer badge)
```
    Include this key when you want the system to modify the badge of your app icon. If this key is not included in the dictionary, the badge is not changed. To remove the badge, set the value of this key to 0.
    
    Parameters:
    
    badge - Include this key when you want the system to modify the badge of your app icon. If this key is not included in the dictionary, the badge is not changed. To remove the badge, set the value of this key to 0.
  - getBadge
```
public Integer getBadge()
```
    Include this key when you want the system to modify the badge of your app icon. If this key is not included in the dictionary, the badge is not changed. To remove the badge, set the value of this key to 0.
    
    Returns:
    
    Include this key when you want the system to modify the badge of your app icon. If this key is not included in the dictionary, the badge is not changed. To remove the badge, set the value of this key to 0.
  - withBadge
```
public APNSMessage withBadge(Integer badge)
```
    Include this key when you want the system to modify the badge of your app icon. If this key is not included in the dictionary, the badge is not changed. To remove the badge, set the value of this key to 0.
    
    Parameters:
    
    badge - Include this key when you want the system to modify the badge of your app icon. If this key is not included in the dictionary, the badge is not changed. To remove the badge, set the value of this key to 0.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBody
```
public void setBody(String body)
```
    The message body of the notification.
    
    Parameters:
    
    body - The message body of the notification.
  - getBody
```
public String getBody()
```
    The message body of the notification.
    
    Returns:
    
    The message body of the notification.
  - withBody
```
public APNSMessage withBody(String body)
```
    The message body of the notification.
    
    Parameters:
    
    body - The message body of the notification.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCategory
```
public void setCategory(String category)
```
    Provide this key with a string value that represents the notification's type. This value corresponds to the value in the identifier property of one of your app's registered categories.
    
    Parameters:
    
    category - Provide this key with a string value that represents the notification's type. This value corresponds to the value in the identifier property of one of your app's registered categories.
  - getCategory
```
public String getCategory()
```
    Provide this key with a string value that represents the notification's type. This value corresponds to the value in the identifier property of one of your app's registered categories.
    
    Returns:
    
    Provide this key with a string value that represents the notification's type. This value corresponds to the value in the identifier property of one of your app's registered categories.
  - withCategory
```
public APNSMessage withCategory(String category)
```
    Provide this key with a string value that represents the notification's type. This value corresponds to the value in the identifier property of one of your app's registered categories.
    
    Parameters:
    
    category - Provide this key with a string value that represents the notification's type. This value corresponds to the value in the identifier property of one of your app's registered categories.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCollapseId
```
public void setCollapseId(String collapseId)
```
    An ID that, if assigned to multiple messages, causes APNs to coalesce the messages into a single push notification instead of delivering each message individually. The value must not exceed 64 bytes. Amazon Pinpoint uses this value to set the apns-collapse-id request header when it sends the message to APNs.
    
    Parameters:
    
    collapseId - An ID that, if assigned to multiple messages, causes APNs to coalesce the messages into a single push notification instead of delivering each message individually. The value must not exceed 64 bytes. Amazon Pinpoint uses this value to set the apns-collapse-id request header when it sends the message to APNs.
  - getCollapseId
```
public String getCollapseId()
```
    An ID that, if assigned to multiple messages, causes APNs to coalesce the messages into a single push notification instead of delivering each message individually. The value must not exceed 64 bytes. Amazon Pinpoint uses this value to set the apns-collapse-id request header when it sends the message to APNs.
    
    Returns:
    
    An ID that, if assigned to multiple messages, causes APNs to coalesce the messages into a single push notification instead of delivering each message individually. The value must not exceed 64 bytes. Amazon Pinpoint uses this value to set the apns-collapse-id request header when it sends the message to APNs.
  - withCollapseId
```
public APNSMessage withCollapseId(String collapseId)
```
    An ID that, if assigned to multiple messages, causes APNs to coalesce the messages into a single push notification instead of delivering each message individually. The value must not exceed 64 bytes. Amazon Pinpoint uses this value to set the apns-collapse-id request header when it sends the message to APNs.
    
    Parameters:
    
    collapseId - An ID that, if assigned to multiple messages, causes APNs to coalesce the messages into a single push notification instead of delivering each message individually. The value must not exceed 64 bytes. Amazon Pinpoint uses this value to set the apns-collapse-id request header when it sends the message to APNs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getData
```
public Map<String,String> getData()
```
    The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
    
    Returns:
    
    The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
  - setData
```
public void setData(Map<String,String> data)
```
    The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
    
    Parameters:
    
    data - The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
  - withData
```
public APNSMessage withData(Map<String,String> data)
```
    The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
    
    Parameters:
    
    data - The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addDataEntry
```
public APNSMessage addDataEntry(String key,
                                String value)
```
  - clearDataEntries
```
public APNSMessage clearDataEntries()
```
    Removes all the entries added into Data.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMediaUrl
```
public void setMediaUrl(String mediaUrl)
```
    The URL that points to a video used in the push notification.
    
    Parameters:
    
    mediaUrl - The URL that points to a video used in the push notification.
  - getMediaUrl
```
public String getMediaUrl()
```
    The URL that points to a video used in the push notification.
    
    Returns:
    
    The URL that points to a video used in the push notification.
  - withMediaUrl
```
public APNSMessage withMediaUrl(String mediaUrl)
```
    The URL that points to a video used in the push notification.
    
    Parameters:
    
    mediaUrl - The URL that points to a video used in the push notification.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPreferredAuthenticationMethod
```
public void setPreferredAuthenticationMethod(String preferredAuthenticationMethod)
```
    The preferred authentication method, either "CERTIFICATE" or "TOKEN"
    
    Parameters:
    
    preferredAuthenticationMethod - The preferred authentication method, either "CERTIFICATE" or "TOKEN"
  - getPreferredAuthenticationMethod
```
public String getPreferredAuthenticationMethod()
```
    The preferred authentication method, either "CERTIFICATE" or "TOKEN"
    
    Returns:
    
    The preferred authentication method, either "CERTIFICATE" or "TOKEN"
  - withPreferredAuthenticationMethod
```
public APNSMessage withPreferredAuthenticationMethod(String preferredAuthenticationMethod)
```
    The preferred authentication method, either "CERTIFICATE" or "TOKEN"
    
    Parameters:
    
    preferredAuthenticationMethod - The preferred authentication method, either "CERTIFICATE" or "TOKEN"
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPriority
```
public void setPriority(String priority)
```
    The message priority. Amazon Pinpoint uses this value to set the apns-priority request header when it sends the message to APNs. Accepts the following values: "5" - Low priority. Messages might be delayed, delivered in groups, and throttled. "10" - High priority. Messages are sent immediately. High priority messages must cause an alert, sound, or badge on the receiving device. The default value is "10". The equivalent values for FCM or GCM messages are "normal" and "high". Amazon Pinpoint accepts these values for APNs messages and converts them. For more information about the apns-priority parameter, see Communicating with APNs in the APNs Local and Remote Notification Programming Guide.
    
    Parameters:
    
    priority - The message priority. Amazon Pinpoint uses this value to set the apns-priority request header when it sends the message to APNs. Accepts the following values: "5" - Low priority. Messages might be delayed, delivered in groups, and throttled. "10" - High priority. Messages are sent immediately. High priority messages must cause an alert, sound, or badge on the receiving device. The default value is "10". The equivalent values for FCM or GCM messages are "normal" and "high". Amazon Pinpoint accepts these values for APNs messages and converts them. For more information about the apns-priority parameter, see Communicating with APNs in the APNs Local and Remote Notification Programming Guide.
  - getPriority
```
public String getPriority()
```
    The message priority. Amazon Pinpoint uses this value to set the apns-priority request header when it sends the message to APNs. Accepts the following values: "5" - Low priority. Messages might be delayed, delivered in groups, and throttled. "10" - High priority. Messages are sent immediately. High priority messages must cause an alert, sound, or badge on the receiving device. The default value is "10". The equivalent values for FCM or GCM messages are "normal" and "high". Amazon Pinpoint accepts these values for APNs messages and converts them. For more information about the apns-priority parameter, see Communicating with APNs in the APNs Local and Remote Notification Programming Guide.
    
    Returns:
    
    The message priority. Amazon Pinpoint uses this value to set the apns-priority request header when it sends the message to APNs. Accepts the following values: "5" - Low priority. Messages might be delayed, delivered in groups, and throttled. "10" - High priority. Messages are sent immediately. High priority messages must cause an alert, sound, or badge on the receiving device. The default value is "10". The equivalent values for FCM or GCM messages are "normal" and "high". Amazon Pinpoint accepts these values for APNs messages and converts them. For more information about the apns-priority parameter, see Communicating with APNs in the APNs Local and Remote Notification Programming Guide.
  - withPriority
```
public APNSMessage withPriority(String priority)
```
    The message priority. Amazon Pinpoint uses this value to set the apns-priority request header when it sends the message to APNs. Accepts the following values: "5" - Low priority. Messages might be delayed, delivered in groups, and throttled. "10" - High priority. Messages are sent immediately. High priority messages must cause an alert, sound, or badge on the receiving device. The default value is "10". The equivalent values for FCM or GCM messages are "normal" and "high". Amazon Pinpoint accepts these values for APNs messages and converts them. For more information about the apns-priority parameter, see Communicating with APNs in the APNs Local and Remote Notification Programming Guide.
    
    Parameters:
    
    priority - The message priority. Amazon Pinpoint uses this value to set the apns-priority request header when it sends the message to APNs. Accepts the following values: "5" - Low priority. Messages might be delayed, delivered in groups, and throttled. "10" - High priority. Messages are sent immediately. High priority messages must cause an alert, sound, or badge on the receiving device. The default value is "10". The equivalent values for FCM or GCM messages are "normal" and "high". Amazon Pinpoint accepts these values for APNs messages and converts them. For more information about the apns-priority parameter, see Communicating with APNs in the APNs Local and Remote Notification Programming Guide.
    
    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 be used as the payload. This value overrides the message.
    
    Parameters:
    
    rawContent - The Raw JSON formatted string to be used as the payload. This value overrides the message.
  - getRawContent
```
public String getRawContent()
```
    The Raw JSON formatted string to be used as the payload. This value overrides the message.
    
    Returns:
    
    The Raw JSON formatted string to be used as the payload. This value overrides the message.
  - withRawContent
```
public APNSMessage withRawContent(String rawContent)
```
    The Raw JSON formatted string to be used as the payload. This value overrides the message.
    
    Parameters:
    
    rawContent - The Raw JSON formatted string to be used as the payload. This value overrides the message.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSilentPush
```
public void setSilentPush(Boolean silentPush)
```
    Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
    
    Parameters:
    
    silentPush - Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
  - getSilentPush
```
public Boolean getSilentPush()
```
    Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
    
    Returns:
    
    Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
  - withSilentPush
```
public APNSMessage withSilentPush(Boolean silentPush)
```
    Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
    
    Parameters:
    
    silentPush - Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isSilentPush
```
public Boolean isSilentPush()
```
    Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
    
    Returns:
    
    Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
  - setSound
```
public void setSound(String sound)
```
    Include this key when you want the system to play a sound. The value of this key is the name of a sound file in your app's main bundle or in the Library/Sounds folder of your app's data container. If the sound file cannot be found, or if you specify defaultfor the value, the system plays the default alert sound.
    
    Parameters:
    
    sound - Include this key when you want the system to play a sound. The value of this key is the name of a sound file in your app's main bundle or in the Library/Sounds folder of your app's data container. If the sound file cannot be found, or if you specify defaultfor the value, the system plays the default alert sound.
  - getSound
```
public String getSound()
```
    Include this key when you want the system to play a sound. The value of this key is the name of a sound file in your app's main bundle or in the Library/Sounds folder of your app's data container. If the sound file cannot be found, or if you specify defaultfor the value, the system plays the default alert sound.
    
    Returns:
    
    Include this key when you want the system to play a sound. The value of this key is the name of a sound file in your app's main bundle or in the Library/Sounds folder of your app's data container. If the sound file cannot be found, or if you specify defaultfor the value, the system plays the default alert sound.
  - withSound
```
public APNSMessage withSound(String sound)
```
    Include this key when you want the system to play a sound. The value of this key is the name of a sound file in your app's main bundle or in the Library/Sounds folder of your app's data container. If the sound file cannot be found, or if you specify defaultfor the value, the system plays the default alert sound.
    
    Parameters:
    
    sound - Include this key when you want the system to play a sound. The value of this key is the name of a sound file in your app's main bundle or in the Library/Sounds folder of your app's data container. If the sound file cannot be found, or if you specify defaultfor the value, the system plays the default alert sound.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSubstitutions
```
public Map<String,List<String>> getSubstitutions()
```
    Default message substitutions. Can be overridden by individual address substitutions.
    
    Returns:
    
    Default message substitutions. Can be overridden by individual address substitutions.
  - setSubstitutions
```
public void setSubstitutions(Map<String,List<String>> substitutions)
```
    Default message substitutions. Can be overridden by individual address substitutions.
    
    Parameters:
    
    substitutions - Default message substitutions. Can be overridden by individual address substitutions.
  - withSubstitutions
```
public APNSMessage withSubstitutions(Map<String,List<String>> substitutions)
```
    Default message substitutions. Can be overridden by individual address substitutions.
    
    Parameters:
    
    substitutions - Default message substitutions. Can be overridden by individual address substitutions.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addSubstitutionsEntry
```
public APNSMessage addSubstitutionsEntry(String key,
                                         List<String> value)
```
  - clearSubstitutionsEntries
```
public APNSMessage clearSubstitutionsEntries()
```
    Removes all the entries added into Substitutions.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setThreadId
```
public void setThreadId(String threadId)
```
    Provide this key with a string value that represents the app-specific identifier for grouping notifications. If you provide a Notification Content app extension, you can use this value to group your notifications together.
    
    Parameters:
    
    threadId - Provide this key with a string value that represents the app-specific identifier for grouping notifications. If you provide a Notification Content app extension, you can use this value to group your notifications together.
  - getThreadId
```
public String getThreadId()
```
    Provide this key with a string value that represents the app-specific identifier for grouping notifications. If you provide a Notification Content app extension, you can use this value to group your notifications together.
    
    Returns:
    
    Provide this key with a string value that represents the app-specific identifier for grouping notifications. If you provide a Notification Content app extension, you can use this value to group your notifications together.
  - withThreadId
```
public APNSMessage withThreadId(String threadId)
```
    Provide this key with a string value that represents the app-specific identifier for grouping notifications. If you provide a Notification Content app extension, you can use this value to group your notifications together.
    
    Parameters:
    
    threadId - Provide this key with a string value that represents the app-specific identifier for grouping notifications. If you provide a Notification Content app extension, you can use this value to group your notifications together.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTimeToLive
```
public void setTimeToLive(Integer timeToLive)
```
    The length of time (in seconds) that APNs stores and attempts to deliver the message. If the value is 0, APNs does not store the message or attempt to deliver it more than once. Amazon Pinpoint uses this value to set the apns-expiration request header when it sends the message to APNs.
    
    Parameters:
    
    timeToLive - The length of time (in seconds) that APNs stores and attempts to deliver the message. If the value is 0, APNs does not store the message or attempt to deliver it more than once. Amazon Pinpoint uses this value to set the apns-expiration request header when it sends the message to APNs.
  - getTimeToLive
```
public Integer getTimeToLive()
```
    The length of time (in seconds) that APNs stores and attempts to deliver the message. If the value is 0, APNs does not store the message or attempt to deliver it more than once. Amazon Pinpoint uses this value to set the apns-expiration request header when it sends the message to APNs.
    
    Returns:
    
    The length of time (in seconds) that APNs stores and attempts to deliver the message. If the value is 0, APNs does not store the message or attempt to deliver it more than once. Amazon Pinpoint uses this value to set the apns-expiration request header when it sends the message to APNs.
  - withTimeToLive
```
public APNSMessage withTimeToLive(Integer timeToLive)
```
    The length of time (in seconds) that APNs stores and attempts to deliver the message. If the value is 0, APNs does not store the message or attempt to deliver it more than once. Amazon Pinpoint uses this value to set the apns-expiration request header when it sends the message to APNs.
    
    Parameters:
    
    timeToLive - The length of time (in seconds) that APNs stores and attempts to deliver the message. If the value is 0, APNs does not store the message or attempt to deliver it more than once. Amazon Pinpoint uses this value to set the apns-expiration request header when it sends the message to APNs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTitle
```
public void setTitle(String title)
```
    The message title that displays above the message on the user's device.
    
    Parameters:
    
    title - The message title that displays above the message on the user's device.
  - getTitle
```
public String getTitle()
```
    The message title that displays above the message on the user's device.
    
    Returns:
    
    The message title that displays above the message on the user's device.
  - withTitle
```
public APNSMessage withTitle(String title)
```
    The message title that displays above the message on the user's device.
    
    Parameters:
    
    title - The message title that displays above the message on the user'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 user's mobile browser. Used if the value for Action is URL.
    
    Parameters:
    
    url - The URL to open in the user's mobile browser. Used if the value for Action is URL.
  - getUrl
```
public String getUrl()
```
    The URL to open in the user's mobile browser. Used if the value for Action is URL.
    
    Returns:
    
    The URL to open in the user's mobile browser. Used if the value for Action is URL.
  - withUrl
```
public APNSMessage withUrl(String url)
```
    The URL to open in the user's mobile browser. Used if the value for Action is URL.
    
    Parameters:
    
    url - The URL to open in the user's mobile browser. Used if the value for Action 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; useful for testing and debugging.
    
    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 APNSMessage 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 APNSMessage

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

APNSMessage

Method Detail

setAction

getAction

withAction

setAction

withAction

setBadge

getBadge

withBadge

setBody

getBody

withBody

setCategory

getCategory

withCategory

setCollapseId

getCollapseId

withCollapseId

getData

setData

withData

addDataEntry

clearDataEntries

setMediaUrl

getMediaUrl

withMediaUrl

setPreferredAuthenticationMethod

getPreferredAuthenticationMethod

withPreferredAuthenticationMethod

setPriority

getPriority

withPriority

setRawContent

getRawContent

withRawContent

setSilentPush

getSilentPush

withSilentPush

isSilentPush

setSound

getSound

withSound

getSubstitutions

setSubstitutions

withSubstitutions

addSubstitutionsEntry

clearSubstitutionsEntries

setThreadId

getThreadId

withThreadId

setTimeToLive

getTimeToLive

withTimeToLive

setTitle

getTitle

withTitle

setUrl

getUrl

withUrl

toString

equals

hashCode

clone

marshall