Message.Builder (AWS Java SDK :: Services :: Amazon Pinpoint 2.10.41 API)

All Superinterfaces:

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

Enclosing class:

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

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Message.Builder`	`action(Action action)` The action to occur if a recipient taps the push notification.
`Message.Builder`	`action(String action)` The action to occur if a recipient taps the push notification.
`Message.Builder`	`body(String body)` The body of the notification message.
`Message.Builder`	`imageIconUrl(String imageIconUrl)` The URL of the image to display as the push-notification icon, such as the icon for the app.
`Message.Builder`	`imageSmallIconUrl(String imageSmallIconUrl)` The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
`Message.Builder`	`imageUrl(String imageUrl)` The URL of an image to display in the push notification.
`Message.Builder`	`jsonBody(String jsonBody)` The JSON payload to use for a silent push notification.
`Message.Builder`	`mediaUrl(String mediaUrl)` The URL of the image or video to display in the push notification.
`Message.Builder`	`rawContent(String rawContent)` The raw, JSON-formatted string to use as the payload for the notification message.
`Message.Builder`	`silentPush(Boolean silentPush)` Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device.
`Message.Builder`	`timeToLive(Integer timeToLive)` The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time.
`Message.Builder`	`title(String title)` The title to display above the notification message on a recipient's device.
`Message.Builder`	`url(String url)` The URL to open in a recipient's default mobile browser, if a recipient taps the push notification 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
```
Message.Builder action(String action)
```
    The action to occur if a recipient taps the push notification. 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 iOS and Android.
    - 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 the push notification. 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 iOS and Android.
    
    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
```
Message.Builder action(Action action)
```
    The action to occur if a recipient taps the push notification. 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 iOS and Android.
    - 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 the push notification. 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 iOS and Android.
    
    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
```
Message.Builder body(String body)
```
    The body of the notification message. The maximum number of characters is 200.
    
    Parameters:
    
    body - The body of the notification message. The maximum number of characters is 200.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - imageIconUrl
```
Message.Builder imageIconUrl(String imageIconUrl)
```
    The URL of the image to display as the push-notification icon, such as the icon for the app.
    
    Parameters:
    
    imageIconUrl - The URL of the image to display as the push-notification icon, such as the icon for the app.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - imageSmallIconUrl
```
Message.Builder imageSmallIconUrl(String imageSmallIconUrl)
```
    The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
    
    Parameters:
    
    imageSmallIconUrl - The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - imageUrl
```
Message.Builder imageUrl(String imageUrl)
```
    The URL of an image to display in the push notification.
    
    Parameters:
    
    imageUrl - The URL of an image to display in the push notification.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - jsonBody
```
Message.Builder jsonBody(String jsonBody)
```
    The JSON payload to use for a silent push notification.
    
    Parameters:
    
    jsonBody - The JSON payload to use for a silent push notification.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - mediaUrl
```
Message.Builder mediaUrl(String mediaUrl)
```
    The URL of the image or video to display in the push notification.
    
    Parameters:
    
    mediaUrl - The URL of the image or video to display in the push notification.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - rawContent
```
Message.Builder rawContent(String rawContent)
```
    The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
    
    Parameters:
    
    rawContent - The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - silentPush
```
Message.Builder silentPush(Boolean silentPush)
```
    Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
    
    Parameters:
    
    silentPush - Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - timeToLive
```
Message.Builder timeToLive(Integer timeToLive)
```
    The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
    
    This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
    
    Parameters:
    
    timeToLive - The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
    
    This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - title
```
Message.Builder title(String title)
```
    The title to display above the notification message on a recipient's device.
    
    Parameters:
    
    title - The title to display 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
```
Message.Builder url(String url)
```
    The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
    
    Parameters:
    
    url - The URL to open in a recipient's default mobile browser, if a recipient taps the push notification 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 Message.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

imageIconUrl

imageSmallIconUrl

imageUrl

jsonBody

mediaUrl

rawContent

silentPush

timeToLive

title

url