APNSMessage (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.pinpoint.model.APNSMessage

All Implemented Interfaces:: StructuredPojo, ToCopyableBuilder<APNSMessage.Builder,APNSMessage>

@Generated("software.amazon.awssdk:codegen")
public class APNSMessage
extends Object
implements StructuredPojo, ToCopyableBuilder<APNSMessage.Builder,APNSMessage>

APNS Message.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface APNSMessage.Builder

Nested Classes
Modifier and Type	Class	Description
`static interface`	`APNSMessage.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`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.
`Integer`	`badge()`	Include this key when you want the system to modify the badge of your app icon.
`String`	`body()`	The message body of the notification, the email body or the text message.
`static APNSMessage.Builder`	`builder()`
`String`	`category()`	Provide this key with a string value that represents the notification's type.
`Map<String,String>`	`data()`	The data payload used for a silent push.
`boolean`	`equals(Object obj)`
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`	Marshalls this structured data using the given `ProtocolMarshaller`.
`String`	`mediaUrl()`	The URL that points to a video used in the push notification.
`String`	`rawContent()`	The Raw JSON formatted string to be used as the payload.
`static Class<? extends APNSMessage.Builder>`	`serializableBuilderClass()`
`Boolean`	`silentPush()`	Indicates if the message should display on the users device.
`String`	`sound()`	Include this key when you want the system to play a sound.
`Map<String,List<String>>`	`substitutions()`	Default message substitutions.
`String`	`threadId()`	Provide this key with a string value that represents the app-specific identifier for grouping notifications.
`String`	`title()`	The message title that displays above the message on the user's device.
`APNSMessage.Builder`	`toBuilder()`	Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`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

- Method Detail
  - action
```
public 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:
    
    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
  - badge
```
public 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:
    
    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.
  - body
```
public String body()
```
    The message body of the notification, the email body or the text message.
    
    Returns:
    
    The message body of the notification, the email body or the text message.
  - category
```
public 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:
    
    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.
  - data
```
public Map<String,String> data()
```
    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
  - mediaUrl
```
public String mediaUrl()
```
    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.
  - rawContent
```
public String rawContent()
```
    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.
  - silentPush
```
public 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:
    
    Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
  - sound
```
public 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:
    
    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.
  - substitutions
```
public Map<String,List<String>> substitutions()
```
    Default message substitutions. Can be overridden by individual address substitutions.
    
    Returns:
    
    Default message substitutions. Can be overridden by individual address substitutions.
  - threadId
```
public 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:
    
    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.
  - title
```
public String title()
```
    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.
  - url
```
public String url()
```
    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.
  - toBuilder
```
public APNSMessage.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<APNSMessage.Builder,APNSMessage>
    
    Returns:
    
    a builder for type T
  - builder
```
public static APNSMessage.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends APNSMessage.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString 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.

Class APNSMessage

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

action

badge

body

category

data

mediaUrl

rawContent

silentPush

sound

substitutions

threadId

title

url

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

marshall