APNSPushNotificationTemplate.Builder (AWS Java SDK :: Services

All Superinterfaces:

Buildable, CopyableBuilder<APNSPushNotificationTemplate.Builder,APNSPushNotificationTemplate>, SdkBuilder<APNSPushNotificationTemplate.Builder,APNSPushNotificationTemplate>, SdkPojo

Enclosing class:

APNSPushNotificationTemplate
```
public static interface APNSPushNotificationTemplate.Builder
extends SdkPojo, CopyableBuilder<APNSPushNotificationTemplate.Builder,APNSPushNotificationTemplate>
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`APNSPushNotificationTemplate.Builder`	`action(Action action)` The action to occur if a recipient taps a push notification that's based on the message template.
`APNSPushNotificationTemplate.Builder`	`action(String action)` The action to occur if a recipient taps a push notification that's based on the message template.
`APNSPushNotificationTemplate.Builder`	`body(String body)` The message body to use in push notifications that are based on the message template.
`APNSPushNotificationTemplate.Builder`	`mediaUrl(String mediaUrl)` The URL of an image or video to display in push notifications that are based on the message template.
`APNSPushNotificationTemplate.Builder`	`sound(String sound)` The key for the sound to play when the recipient receives a push notification that's based on the message template.
`APNSPushNotificationTemplate.Builder`	`title(String title)` The title to use in push notifications that are based on the message template.
`APNSPushNotificationTemplate.Builder`	`url(String url)` The URL to open in the recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

- Method Detail
  - action
```
APNSPushNotificationTemplate.Builder action(String action)
```
    The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:
    - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
    - DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform.
    - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
    Parameters:
    action - The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:
    
    OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
    
    DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform.
    
    URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Action, Action
  - action
```
APNSPushNotificationTemplate.Builder action(Action action)
```
    The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:
    - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
    - DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform.
    - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
    Parameters:
    action - The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:
    
    OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
    
    DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform.
    
    URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Action, Action
  - body
```
APNSPushNotificationTemplate.Builder body(String body)
```
    The message body to use in push notifications that are based on the message template.
    
    Parameters:
    
    body - The message body to use in push notifications that are based on the message template.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - mediaUrl
```
APNSPushNotificationTemplate.Builder mediaUrl(String mediaUrl)
```
    The URL of an image or video to display in push notifications that are based on the message template.
    
    Parameters:
    
    mediaUrl - The URL of an image or video to display in push notifications that are based on the message template.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - sound
```
APNSPushNotificationTemplate.Builder sound(String sound)
```
    The key for the sound to play when the recipient receives a push notification that's based on the message template. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.
    
    Parameters:
    
    sound - The key for the sound to play when the recipient receives a push notification that's based on the message template. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - title
```
APNSPushNotificationTemplate.Builder title(String title)
```
    The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device.
    
    Parameters:
    
    title - The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - url
```
APNSPushNotificationTemplate.Builder url(String url)
```
    The URL to open in the recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.
    
    Parameters:
    
    url - The URL to open in the recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.

Interface APNSPushNotificationTemplate.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

Method Detail

action

action

body

mediaUrl

sound

title

url