setBadge

The key that indicates whether and how to modify the badge of your app's icon when the recipient receives the
push notification. If this key isn't included in the dictionary, the badge doesn't change. To remove the badge,
set this value to 0.

Parameters:

badge - The key that indicates whether and how to modify the badge of your app's icon when the recipient receives
the push notification. If this key isn't included in the dictionary, the badge doesn't change. To remove
the badge, set this value to 0.

getBadge

The key that indicates whether and how to modify the badge of your app's icon when the recipient receives the
push notification. If this key isn't included in the dictionary, the badge doesn't change. To remove the badge,
set this value to 0.

Returns:

The key that indicates whether and how to modify the badge of your app's icon when the recipient receives
the push notification. If this key isn't included in the dictionary, the badge doesn't change. To remove
the badge, set this value to 0.

withBadge

The key that indicates whether and how to modify the badge of your app's icon when the recipient receives the
push notification. If this key isn't included in the dictionary, the badge doesn't change. To remove the badge,
set this value to 0.

Parameters:

badge - The key that indicates whether and how to modify the badge of your app's icon when the recipient receives
the push notification. If this key isn't included in the dictionary, the badge doesn't change. To remove
the badge, set this value to 0.

Returns:

Returns a reference to this object so that method calls can be chained together.

setCollapseId

An arbitrary identifier that, if assigned to multiple messages, APNs uses to coalesce the messages into a single
push notification instead of delivering each message individually. This value can't exceed 64 bytes.

Amazon Pinpoint specifies this value in the apns-collapse-id request header when it sends the notification
message to APNs.

Parameters:

collapseId - An arbitrary identifier that, if assigned to multiple messages, APNs uses to coalesce the messages into a
single push notification instead of delivering each message individually. This value can't exceed 64
bytes.

Amazon Pinpoint specifies this value in the apns-collapse-id request header when it sends the notification
message to APNs.

getCollapseId

An arbitrary identifier that, if assigned to multiple messages, APNs uses to coalesce the messages into a single
push notification instead of delivering each message individually. This value can't exceed 64 bytes.

Amazon Pinpoint specifies this value in the apns-collapse-id request header when it sends the notification
message to APNs.

Returns:

An arbitrary identifier that, if assigned to multiple messages, APNs uses to coalesce the messages into a
single push notification instead of delivering each message individually. This value can't exceed 64
bytes.

Amazon Pinpoint specifies this value in the apns-collapse-id request header when it sends the
notification message to APNs.

withCollapseId

An arbitrary identifier that, if assigned to multiple messages, APNs uses to coalesce the messages into a single
push notification instead of delivering each message individually. This value can't exceed 64 bytes.

Amazon Pinpoint specifies this value in the apns-collapse-id request header when it sends the notification
message to APNs.

Parameters:

collapseId - An arbitrary identifier that, if assigned to multiple messages, APNs uses to coalesce the messages into a
single push notification instead of delivering each message individually. This value can't exceed 64
bytes.

Amazon Pinpoint specifies this value in the apns-collapse-id request header when it sends the notification
message to APNs.

Returns:

Returns a reference to this object so that method calls can be chained together.

setPriority

para>5 - Low priority, the notification might be delayed, delivered as part of a group, or throttled.

/listitem>

10 - High priority, the notification is sent immediately. This is the default value. A high priority notification
should trigger an alert, play a sound, or badge your app's icon on the recipient's device.

/para>

Amazon Pinpoint specifies this value in the apns-priority request header when it sends the notification message
to APNs.

The equivalent values for Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), are normal, for
5, and high, for 10. If you specify an FCM value for this property, Amazon Pinpoint accepts and converts the
value to the corresponding APNs value.

Parameters:

priority - para>5 - Low priority, the notification might be delayed, delivered as part of a group, or
throttled./listitem>

10 - High priority, the notification is sent immediately. This is the default value. A high priority
notification should trigger an alert, play a sound, or badge your app's icon on the recipient's device.

/para>

Amazon Pinpoint specifies this value in the apns-priority request header when it sends the notification
message to APNs.

The equivalent values for Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), are
normal, for 5, and high, for 10. If you specify an FCM value for this property, Amazon Pinpoint accepts
and converts the value to the corresponding APNs value.

getPriority

para>5 - Low priority, the notification might be delayed, delivered as part of a group, or throttled.

/listitem>

10 - High priority, the notification is sent immediately. This is the default value. A high priority notification
should trigger an alert, play a sound, or badge your app's icon on the recipient's device.

/para>

Amazon Pinpoint specifies this value in the apns-priority request header when it sends the notification message
to APNs.

The equivalent values for Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), are normal, for
5, and high, for 10. If you specify an FCM value for this property, Amazon Pinpoint accepts and converts the
value to the corresponding APNs value.

Returns:

para>5 - Low priority, the notification might be delayed, delivered as part of a group, or
throttled./listitem>

10 - High priority, the notification is sent immediately. This is the default value. A high priority
notification should trigger an alert, play a sound, or badge your app's icon on the recipient's device.

/para>

Amazon Pinpoint specifies this value in the apns-priority request header when it sends the notification
message to APNs.

The equivalent values for Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), are
normal, for 5, and high, for 10. If you specify an FCM value for this property, Amazon Pinpoint accepts
and converts the value to the corresponding APNs value.

withPriority

para>5 - Low priority, the notification might be delayed, delivered as part of a group, or throttled.

/listitem>

10 - High priority, the notification is sent immediately. This is the default value. A high priority notification
should trigger an alert, play a sound, or badge your app's icon on the recipient's device.

/para>

Amazon Pinpoint specifies this value in the apns-priority request header when it sends the notification message
to APNs.

The equivalent values for Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), are normal, for
5, and high, for 10. If you specify an FCM value for this property, Amazon Pinpoint accepts and converts the
value to the corresponding APNs value.

Parameters:

priority - para>5 - Low priority, the notification might be delayed, delivered as part of a group, or
throttled./listitem>

10 - High priority, the notification is sent immediately. This is the default value. A high priority
notification should trigger an alert, play a sound, or badge your app's icon on the recipient's device.

/para>

Amazon Pinpoint specifies this value in the apns-priority request header when it sends the notification
message to APNs.

The equivalent values for Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), are
normal, for 5, and high, for 10. If you specify an FCM value for this property, Amazon Pinpoint accepts
and converts the value to the corresponding APNs value.

Returns:

Returns a reference to this object so that method calls can be chained together.

setSilentPush

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.

getSilentPush

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:

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.

withSilentPush

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.

isSilentPush

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:

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.

setSound

The key for the sound to play when the recipient receives the push notification. The value of 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 the push notification. The value of 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.

getSound

The key for the sound to play when the recipient receives the push notification. The value of 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:

The key for the sound to play when the recipient receives the push notification. The value of 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.

withSound

The key for the sound to play when the recipient receives the push notification. The value of 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 the push notification. The value of 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.

setThreadId

The key that represents your 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 - The key that represents your 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

The key that represents your 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 - The key that represents your 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

The amount of time, in seconds, that APNs should store and attempt to deliver the push notification, if the
service is unable to deliver the notification the first time. If this value is 0, APNs treats the notification as
if it expires immediately and the service doesn't store or try to deliver the notification again.

Amazon Pinpoint specifies this value in the apns-expiration request header when it sends the notification message
to APNs.

Parameters:

timeToLive - The amount of time, in seconds, that APNs should store and attempt to deliver the push notification, if
the service is unable to deliver the notification the first time. If this value is 0, APNs treats the
notification as if it expires immediately and the service doesn't store or try to deliver the notification
again.

Amazon Pinpoint specifies this value in the apns-expiration request header when it sends the notification
message to APNs.

getTimeToLive

The amount of time, in seconds, that APNs should store and attempt to deliver the push notification, if the
service is unable to deliver the notification the first time. If this value is 0, APNs treats the notification as
if it expires immediately and the service doesn't store or try to deliver the notification again.

Amazon Pinpoint specifies this value in the apns-expiration request header when it sends the notification message
to APNs.

Returns:

The amount of time, in seconds, that APNs should store and attempt to deliver the push notification, if
the service is unable to deliver the notification the first time. If this value is 0, APNs treats the
notification as if it expires immediately and the service doesn't store or try to deliver the
notification again.

Amazon Pinpoint specifies this value in the apns-expiration request header when it sends the notification
message to APNs.

withTimeToLive

The amount of time, in seconds, that APNs should store and attempt to deliver the push notification, if the
service is unable to deliver the notification the first time. If this value is 0, APNs treats the notification as
if it expires immediately and the service doesn't store or try to deliver the notification again.

Amazon Pinpoint specifies this value in the apns-expiration request header when it sends the notification message
to APNs.

Parameters:

timeToLive - The amount of time, in seconds, that APNs should store and attempt to deliver the push notification, if
the service is unable to deliver the notification the first time. If this value is 0, APNs treats the
notification as if it expires immediately and the service doesn't store or try to deliver the notification
again.

Amazon Pinpoint specifies this value in the apns-expiration request header when it sends the notification
message to APNs.

Returns:

Returns a reference to this object so that method calls can be chained together.