APNSMessage (AWS SDK for Android

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

All Implemented Interfaces:

java.io.Serializable
```
public class APNSMessage
extends java.lang.Object
implements java.io.Serializable
```
APNS Message.

See Also:

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(java.lang.String key, java.lang.String value)` The data payload used for a silent push.
`APNSMessage`	`addSubstitutionsEntry(java.lang.String key, java.util.List<java.lang.String> value)` Default message substitutions.
`APNSMessage`	`clearDataEntries()` Removes all the entries added into Data.
`APNSMessage`	`clearSubstitutionsEntries()` Removes all the entries added into Substitutions.
`boolean`	`equals(java.lang.Object obj)`
`java.lang.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.
`java.lang.Integer`	`getBadge()` Include this key when you want the system to modify the badge of your app icon.
`java.lang.String`	`getBody()` The message body of the notification.
`java.lang.String`	`getCategory()` Provide this key with a string value that represents the notification's type.
`java.lang.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.
`java.util.Map<java.lang.String,java.lang.String>`	`getData()` The data payload used for a silent push.
`java.lang.String`	`getMediaUrl()` A URL that refers to the location of an image or video that you want to display in the push notification.
`java.lang.String`	`getPreferredAuthenticationMethod()` The preferred authentication method, either "CERTIFICATE" or "TOKEN"
`java.lang.String`	`getPriority()` The message priority.
`java.lang.String`	`getRawContent()` The Raw JSON formatted string to be used as the payload.
`java.lang.Boolean`	`getSilentPush()` Indicates if the message should display on the users device.
`java.lang.String`	`getSound()` Include this key when you want the system to play a sound.
`java.util.Map<java.lang.String,java.util.List<java.lang.String>>`	`getSubstitutions()` Default message substitutions.
`java.lang.String`	`getThreadId()` Provide this key with a string value that represents the app-specific identifier for grouping notifications.
`java.lang.Integer`	`getTimeToLive()` The length of time (in seconds) that APNs stores and attempts to deliver the message.
`java.lang.String`	`getTitle()` The message title that displays above the message on the user's device.
`java.lang.String`	`getUrl()` The URL to open in the user's mobile browser.
`int`	`hashCode()`
`java.lang.Boolean`	`isSilentPush()` Indicates if the message should display on the users device.
`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(java.lang.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(java.lang.Integer badge)` Include this key when you want the system to modify the badge of your app icon.
`void`	`setBody(java.lang.String body)` The message body of the notification.
`void`	`setCategory(java.lang.String category)` Provide this key with a string value that represents the notification's type.
`void`	`setCollapseId(java.lang.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(java.util.Map<java.lang.String,java.lang.String> data)` The data payload used for a silent push.
`void`	`setMediaUrl(java.lang.String mediaUrl)` A URL that refers to the location of an image or video that you want to display in the push notification.
`void`	`setPreferredAuthenticationMethod(java.lang.String preferredAuthenticationMethod)` The preferred authentication method, either "CERTIFICATE" or "TOKEN"
`void`	`setPriority(java.lang.String priority)` The message priority.
`void`	`setRawContent(java.lang.String rawContent)` The Raw JSON formatted string to be used as the payload.
`void`	`setSilentPush(java.lang.Boolean silentPush)` Indicates if the message should display on the users device.
`void`	`setSound(java.lang.String sound)` Include this key when you want the system to play a sound.
`void`	`setSubstitutions(java.util.Map<java.lang.String,java.util.List<java.lang.String>> substitutions)` Default message substitutions.
`void`	`setThreadId(java.lang.String threadId)` Provide this key with a string value that represents the app-specific identifier for grouping notifications.
`void`	`setTimeToLive(java.lang.Integer timeToLive)` The length of time (in seconds) that APNs stores and attempts to deliver the message.
`void`	`setTitle(java.lang.String title)` The message title that displays above the message on the user's device.
`void`	`setUrl(java.lang.String url)` The URL to open in the user's mobile browser.
`java.lang.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(java.lang.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(java.lang.Integer badge)` Include this key when you want the system to modify the badge of your app icon.
`APNSMessage`	`withBody(java.lang.String body)` The message body of the notification.
`APNSMessage`	`withCategory(java.lang.String category)` Provide this key with a string value that represents the notification's type.
`APNSMessage`	`withCollapseId(java.lang.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(java.util.Map<java.lang.String,java.lang.String> data)` The data payload used for a silent push.
`APNSMessage`	`withMediaUrl(java.lang.String mediaUrl)` A URL that refers to the location of an image or video that you want to display in the push notification.
`APNSMessage`	`withPreferredAuthenticationMethod(java.lang.String preferredAuthenticationMethod)` The preferred authentication method, either "CERTIFICATE" or "TOKEN"
`APNSMessage`	`withPriority(java.lang.String priority)` The message priority.
`APNSMessage`	`withRawContent(java.lang.String rawContent)` The Raw JSON formatted string to be used as the payload.
`APNSMessage`	`withSilentPush(java.lang.Boolean silentPush)` Indicates if the message should display on the users device.
`APNSMessage`	`withSound(java.lang.String sound)` Include this key when you want the system to play a sound.
`APNSMessage`	`withSubstitutions(java.util.Map<java.lang.String,java.util.List<java.lang.String>> substitutions)` Default message substitutions.
`APNSMessage`	`withThreadId(java.lang.String threadId)` Provide this key with a string value that represents the app-specific identifier for grouping notifications.
`APNSMessage`	`withTimeToLive(java.lang.Integer timeToLive)` The length of time (in seconds) that APNs stores and attempts to deliver the message.
`APNSMessage`	`withTitle(java.lang.String title)` The message title that displays above the message on the user's device.
`APNSMessage`	`withUrl(java.lang.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
  - getAction
```
public java.lang.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
    Constraints:
    Allowed Values: 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
  - setAction
```
public void setAction(java.lang.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
    Constraints:
    Allowed Values: 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(java.lang.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
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: 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:
    
    A reference to this updated 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
    Constraints:
    Allowed Values: 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
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: 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:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    Action
  - getBadge
```
public java.lang.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.
  - setBadge
```
public void setBadge(java.lang.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.
  - withBadge
```
public APNSMessage withBadge(java.lang.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.
    Returns a reference to this object so that method calls can be chained together.
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getBody
```
public java.lang.String getBody()
```
    The message body of the notification.
    
    Returns:
    
    The message body of the notification.
  - setBody
```
public void setBody(java.lang.String body)
```
    The message body of the notification.
    
    Parameters:
    
    body - The message body of the notification.
  - withBody
```
public APNSMessage withBody(java.lang.String body)
```
    The message body of the notification.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    body - The message body of the notification.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getCategory
```
public java.lang.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.
  - setCategory
```
public void setCategory(java.lang.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.
  - withCategory
```
public APNSMessage withCategory(java.lang.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.
    Returns a reference to this object so that method calls can be chained together.
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getCollapseId
```
public java.lang.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.
  - setCollapseId
```
public void setCollapseId(java.lang.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.
  - withCollapseId
```
public APNSMessage withCollapseId(java.lang.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.
    Returns a reference to this object so that method calls can be chained together.
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getData
```
public java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.lang.String,java.lang.String> data)
```
    The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    data - The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addDataEntry
```
public APNSMessage addDataEntry(java.lang.String key,
                                java.lang.String value)
```
    The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
    The method adds a new key-value pair into Data parameter, and returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    key - The key of the entry to be added into Data.
    
    value - The corresponding value of the entry to be added into Data.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - clearDataEntries
```
public APNSMessage clearDataEntries()
```
    Removes all the entries added into Data.
    Returns a reference to this object so that method calls can be chained together.
  - getMediaUrl
```
public java.lang.String getMediaUrl()
```
    A URL that refers to the location of an image or video that you want to display in the push notification.
    
    Returns:
    
    A URL that refers to the location of an image or video that you want to display in the push notification.
  - setMediaUrl
```
public void setMediaUrl(java.lang.String mediaUrl)
```
    A URL that refers to the location of an image or video that you want to display in the push notification.
    
    Parameters:
    
    mediaUrl - A URL that refers to the location of an image or video that you want to display in the push notification.
  - withMediaUrl
```
public APNSMessage withMediaUrl(java.lang.String mediaUrl)
```
    A URL that refers to the location of an image or video that you want to display in the push notification.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    mediaUrl - A URL that refers to the location of an image or video that you want to display in the push notification.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getPreferredAuthenticationMethod
```
public java.lang.String getPreferredAuthenticationMethod()
```
    The preferred authentication method, either "CERTIFICATE" or "TOKEN"
    
    Returns:
    
    The preferred authentication method, either "CERTIFICATE" or "TOKEN"
  - setPreferredAuthenticationMethod
```
public void setPreferredAuthenticationMethod(java.lang.String preferredAuthenticationMethod)
```
    The preferred authentication method, either "CERTIFICATE" or "TOKEN"
    
    Parameters:
    
    preferredAuthenticationMethod - The preferred authentication method, either "CERTIFICATE" or "TOKEN"
  - withPreferredAuthenticationMethod
```
public APNSMessage withPreferredAuthenticationMethod(java.lang.String preferredAuthenticationMethod)
```
    The preferred authentication method, either "CERTIFICATE" or "TOKEN"
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    preferredAuthenticationMethod - The preferred authentication method, either "CERTIFICATE" or "TOKEN"
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getPriority
```
public java.lang.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.
  - setPriority
```
public void setPriority(java.lang.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.
  - withPriority
```
public APNSMessage withPriority(java.lang.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.
    Returns a reference to this object so that method calls can be chained together.
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getRawContent
```
public java.lang.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.
  - setRawContent
```
public void setRawContent(java.lang.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.
  - withRawContent
```
public APNSMessage withRawContent(java.lang.String rawContent)
```
    The Raw JSON formatted string to be used as the payload. This value overrides the message.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    rawContent - The Raw JSON formatted string to be used as the payload. This value overrides the message.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - isSilentPush
```
public java.lang.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.
  - getSilentPush
```
public java.lang.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.
  - setSilentPush
```
public void setSilentPush(java.lang.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.
  - withSilentPush
```
public APNSMessage withSilentPush(java.lang.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.
    Returns a reference to this object so that method calls can be chained together.
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getSound
```
public java.lang.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.
  - setSound
```
public void setSound(java.lang.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.
  - withSound
```
public APNSMessage withSound(java.lang.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.
    Returns a reference to this object so that method calls can be chained together.
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getSubstitutions
```
public java.util.Map<java.lang.String,java.util.List<java.lang.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(java.util.Map<java.lang.String,java.util.List<java.lang.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(java.util.Map<java.lang.String,java.util.List<java.lang.String>> substitutions)
```
    Default message substitutions. Can be overridden by individual address substitutions.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    substitutions - Default message substitutions. Can be overridden by individual address substitutions.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addSubstitutionsEntry
```
public APNSMessage addSubstitutionsEntry(java.lang.String key,
                                         java.util.List<java.lang.String> value)
```
    Default message substitutions. Can be overridden by individual address substitutions.
    The method adds a new key-value pair into Substitutions parameter, and returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    key - The key of the entry to be added into Substitutions.
    
    value - The corresponding value of the entry to be added into Substitutions.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - clearSubstitutionsEntries
```
public APNSMessage clearSubstitutionsEntries()
```
    Removes all the entries added into Substitutions.
    Returns a reference to this object so that method calls can be chained together.
  - getThreadId
```
public java.lang.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.
  - setThreadId
```
public void setThreadId(java.lang.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.
  - withThreadId
```
public APNSMessage withThreadId(java.lang.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.
    Returns a reference to this object so that method calls can be chained 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:
    
    A reference to this updated object so that method calls can be chained together.
  - getTimeToLive
```
public java.lang.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.
  - setTimeToLive
```
public void setTimeToLive(java.lang.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.
  - withTimeToLive
```
public APNSMessage withTimeToLive(java.lang.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.
    Returns a reference to this object so that method calls can be chained together.
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getTitle
```
public java.lang.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.
  - setTitle
```
public void setTitle(java.lang.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.
  - withTitle
```
public APNSMessage withTitle(java.lang.String title)
```
    The message title that displays above the message on the user's device.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    title - The message title that displays above the message on the user's device.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getUrl
```
public java.lang.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.
  - setUrl
```
public void setUrl(java.lang.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.
  - withUrl
```
public APNSMessage withUrl(java.lang.String url)
```
    The URL to open in the user's mobile browser. Used if the value for Action is URL.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    url - The URL to open in the user's mobile browser. Used if the value for Action is URL.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class APNSMessage

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

APNSMessage

Method Detail

getAction

setAction

withAction

setAction

withAction

getBadge

setBadge

withBadge

getBody

setBody

withBody

getCategory

setCategory

withCategory

getCollapseId

setCollapseId

withCollapseId

getData

setData

withData

addDataEntry

clearDataEntries

getMediaUrl

setMediaUrl

withMediaUrl

getPreferredAuthenticationMethod

setPreferredAuthenticationMethod

withPreferredAuthenticationMethod

getPriority

setPriority

withPriority

getRawContent

setRawContent

withRawContent

isSilentPush

getSilentPush

setSilentPush

withSilentPush

getSound

setSound

withSound

getSubstitutions

setSubstitutions

withSubstitutions

addSubstitutionsEntry

clearSubstitutionsEntries

getThreadId

setThreadId

withThreadId

getTimeToLive

setTimeToLive

withTimeToLive

getTitle

setTitle

withTitle

getUrl

setUrl

withUrl

toString

hashCode

equals