IOSDevicePayload.Builder

java.lang.Object
- com.urbanairship.api.push.model.notification.ios.IOSDevicePayload.Builder

Enclosing class:: IOSDevicePayload

public static class IOSDevicePayload.Builder
extends java.lang.Object

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`IOSDevicePayload.Builder`	`addAllExtraEntries(java.util.Map<java.lang.String,java.lang.String> entries)` Add key value pairs to payload.
`IOSDevicePayload.Builder`	`addExtraEntry(java.lang.String key, java.lang.String value)` Add an extra key value pair to the notification payload.
`IOSDevicePayload`	`build()` Build IOSDevicePayload
`IOSDevicePayload.Builder`	`setActions(Actions actions)` Set the Actions.
`IOSDevicePayload.Builder`	`setAlert(IOSAlertData alert)` Set the IOSAlertData object.
`IOSDevicePayload.Builder`	`setAlert(java.lang.String alert)` Create an IOSAlertData object with the given alert string.
`IOSDevicePayload.Builder`	`setBadge(IOSBadgeData badge)` Set the badge data.
`IOSDevicePayload.Builder`	`setCategory(java.lang.String value)` Set the category
`IOSDevicePayload.Builder`	`setCollapseId(java.lang.String value)` Set the collapse ID.
`IOSDevicePayload.Builder`	`setContentAvailable(boolean value)` Set the flag indicating content availability.
`IOSDevicePayload.Builder`	`setExpiry(PushExpiry value)` Set the expiry
`IOSDevicePayload.Builder`	`setInteractive(Interactive value)` Set the Interactive object
`IOSDevicePayload.Builder`	`setIosInterruptionLevel(IOSInterruptionLevel iosInterruptionLevel)` Set an interruption level.
`IOSDevicePayload.Builder`	`setIosLiveActivity(IOSLiveActivity iosLiveActivity)` Set Live Activity.
`IOSDevicePayload.Builder`	`setIosTemplate(IOSTemplate iosTemplate)` Set a template with iOS-specific message.
`IOSDevicePayload.Builder`	`setMediaAttachment(MediaAttachment value)` Set the media attachment.
`IOSDevicePayload.Builder`	`setMutableContent(java.lang.Boolean value)` Set the mutable content
`IOSDevicePayload.Builder`	`setPriority(int value)` Set the priority
`IOSDevicePayload.Builder`	`setRelevanceScore(java.lang.Double relevanceScore)` Set the relevance score.
`IOSDevicePayload.Builder`	`setSound(java.lang.String name)` Deprecated. This can now be set using setSoundData as of 4.1.0. Sets the name of the IOSSoundData object. This is a shortcut for when the only value pertaining to the 'sound' key is a sound file name.
`IOSDevicePayload.Builder`	`setSoundData(IOSSoundData value)` Set the IOSSoundData object.
`IOSDevicePayload.Builder`	`setSubtitle(java.lang.String value)`
`IOSDevicePayload.Builder`	`setTargetContentId(java.lang.String targetContentId)` Set the target content id.
`IOSDevicePayload.Builder`	`setThreadId(java.lang.String value)` Set the thread ID.
`IOSDevicePayload.Builder`	`setTitle(java.lang.String value)` Set the title

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - setAlert
```
public IOSDevicePayload.Builder setAlert(java.lang.String alert)
```
    Create an IOSAlertData object with the given alert string. This is a shortcut for setting an alert data object when no additional iOS APNS payload options are needed.
    
    Parameters:
    
    alert - String alert
    
    Returns:
    
    Builder
  - setAlert
```
public IOSDevicePayload.Builder setAlert(IOSAlertData alert)
```
    Set the IOSAlertData object.
    
    Parameters:
    
    alert - IOSAlertData
    
    Returns:
    
    Builder
  - setBadge
```
public IOSDevicePayload.Builder setBadge(IOSBadgeData badge)
```
    Set the badge data.
    
    Parameters:
    
    badge - IOSBadgeData
    
    Returns:
    
    Builder
  - setContentAvailable
```
public IOSDevicePayload.Builder setContentAvailable(boolean value)
```
    Set the flag indicating content availability.
    
    Parameters:
    
    value - Boolean for content availability.
    
    Returns:
    
    Builder
  - setExpiry
```
public IOSDevicePayload.Builder setExpiry(PushExpiry value)
```
    Set the expiry
    
    Parameters:
    
    value - Integer
    
    Returns:
    
    Builder
  - setPriority
```
public IOSDevicePayload.Builder setPriority(int value)
```
    Set the priority
    
    Parameters:
    
    value - Integer
    
    Returns:
    
    Builder
  - addExtraEntry
```
public IOSDevicePayload.Builder addExtraEntry(java.lang.String key,
                                              java.lang.String value)
```
    Add an extra key value pair to the notification payload. Maximum payload is 2000 bytes.
    
    Parameters:
    
    key - String key
    
    value - String value
    
    Returns:
    
    Builder
  - addAllExtraEntries
```
public IOSDevicePayload.Builder addAllExtraEntries(java.util.Map<java.lang.String,java.lang.String> entries)
```
    Add key value pairs to payload. Maximum payload is 2000 bytes.
    
    Parameters:
    
    entries - Map of key value pairs
    
    Returns:
    
    Builder.
  - setCategory
```
public IOSDevicePayload.Builder setCategory(java.lang.String value)
```
    Set the category
    
    Parameters:
    
    value - String
    
    Returns:
    
    Builder
  - setInteractive
```
public IOSDevicePayload.Builder setInteractive(Interactive value)
```
    Set the Interactive object
    
    Parameters:
    
    value - Interactive
    
    Returns:
    
    Builder
  - setTitle
```
public IOSDevicePayload.Builder setTitle(java.lang.String value)
```
    Set the title
    
    Parameters:
    
    value - String
    
    Returns:
    
    Builder
  - setSubtitle
```
public IOSDevicePayload.Builder setSubtitle(java.lang.String value)
```
  - setMediaAttachment
```
public IOSDevicePayload.Builder setMediaAttachment(MediaAttachment value)
```
    Set the media attachment.
    
    Parameters:
    
    value - MediaAttachment
    
    Returns:
    
    Builder
  - setSoundData
```
public IOSDevicePayload.Builder setSoundData(IOSSoundData value)
```
    Set the IOSSoundData object.
    
    Parameters:
    
    value - IOSSoundData
    
    Returns:
    
    Builder
  - setSound
```
@Deprecated
public IOSDevicePayload.Builder setSound(java.lang.String name)
```
    Deprecated. This can now be set using setSoundData as of 4.1.0. Sets the name of the IOSSoundData object. This is a shortcut for when the only value pertaining to the 'sound' key is a sound file name.
    
    Parameters:
    
    name - String
    
    Returns:
    
    Builder
  - setMutableContent
```
public IOSDevicePayload.Builder setMutableContent(java.lang.Boolean value)
```
    Set the mutable content
    
    Parameters:
    
    value - Boolean
    
    Returns:
    
    Builder
  - setCollapseId
```
public IOSDevicePayload.Builder setCollapseId(java.lang.String value)
```
    Set the collapse ID. When there is a newer message that renders an older, related message irrelevant to the client app, the new message replaces the older message with the same collapse ID.
    
    Parameters:
    
    value - String
    
    Returns:
    
    Builder
  - setThreadId
```
public IOSDevicePayload.Builder setThreadId(java.lang.String value)
```
    Set the thread ID.
    
    Parameters:
    
    value - String
    
    Returns:
    
    Builder
  - setActions
```
public IOSDevicePayload.Builder setActions(Actions actions)
```
    Set the Actions. These describe actions to be performed by the SDK when a user interacts with the notification.
    
    Parameters:
    
    actions - Actions
    
    Returns:
    
    Builder
  - setTargetContentId
```
public IOSDevicePayload.Builder setTargetContentId(java.lang.String targetContentId)
```
    Set the target content id. The identifier of the window to bring forward when the notification is opened. Used for multi-window content, such as App Clips.
    
    Parameters:
    
    targetContentId - String
    
    Returns:
    
    Builder
  - setIosTemplate
```
public IOSDevicePayload.Builder setIosTemplate(IOSTemplate iosTemplate)
```
    Set a template with iOS-specific message.
    
    Parameters:
    
    iosTemplate - IOSTemplate
    
    Returns:
    
    Builder
  - setIosInterruptionLevel
```
public IOSDevicePayload.Builder setIosInterruptionLevel(IOSInterruptionLevel iosInterruptionLevel)
```
    Set an interruption level.
    
    Parameters:
    
    iosInterruptionLevel - IOSInterruptionLevel
    
    Returns:
    
    Builder
  - setRelevanceScore
```
public IOSDevicePayload.Builder setRelevanceScore(java.lang.Double relevanceScore)
```
    Set the relevance score.
    
    Parameters:
    
    relevanceScore - Double
    
    Returns:
    
    Builder
  - setIosLiveActivity
```
public IOSDevicePayload.Builder setIosLiveActivity(IOSLiveActivity iosLiveActivity)
```
    Set Live Activity.
    
    Parameters:
    
    iosLiveActivity - IOSLiveActivity
    
    Returns:
    
    Builder
  - build
```
public IOSDevicePayload build()
```
    Build IOSDevicePayload
    
    Returns:
    
    IOSDevicePayload

Class IOSDevicePayload.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setAlert

setAlert

setBadge

setContentAvailable

setExpiry

setPriority

addExtraEntry

addAllExtraEntries

setCategory

setInteractive

setTitle

setSubtitle

setMediaAttachment

setSoundData

setSound

setMutableContent

setCollapseId

setThreadId

setActions

setTargetContentId

setIosTemplate

setIosInterruptionLevel

setRelevanceScore

setIosLiveActivity

build