Skip to content

/AWS1/CL_QQCPUSHAPNSMSGTMPLC00

The content of the push message template that applies to APNS (Apple Push Notification service) notification service.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_title TYPE /AWS1/QQCNONEMPTYUNLIMITEDSTR /AWS1/QQCNONEMPTYUNLIMITEDSTR

The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.

io_body TYPE REF TO /AWS1/CL_QQCMSGTMPLBODYCONTP00 /AWS1/CL_QQCMSGTMPLBODYCONTP00

The message body to use in a push notification that is based on the message template.

iv_action TYPE /AWS1/QQCPUSHMESSAGEACTION /AWS1/QQCPUSHMESSAGEACTION

The action to occur if a recipient taps a push notification that is 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 action 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.

iv_sound TYPE /AWS1/QQCNONEMPTYUNLIMITEDSTR /AWS1/QQCNONEMPTYUNLIMITEDSTR

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.

iv_url TYPE /AWS1/QQCNONEMPTYUNLIMITEDSTR /AWS1/QQCNONEMPTYUNLIMITEDSTR

The URL to open in a 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.

iv_mediaurl TYPE /AWS1/QQCNONEMPTYUNLIMITEDSTR /AWS1/QQCNONEMPTYUNLIMITEDSTR

The URL of an image or video to display in push notifications that are based on the message template.

io_rawcontent TYPE REF TO /AWS1/CL_QQCMSGTMPLBODYCONTP00 /AWS1/CL_QQCMSGTMPLBODYCONTP00

The raw, JSON-formatted string to use as the payload for a push notification that's based on the message template. If specified, this value overrides all other content for the message template.


Queryable Attributes

title

The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.

Accessible with the following methods

Method Description
GET_TITLE() Getter for TITLE, with configurable default
ASK_TITLE() Getter for TITLE w/ exceptions if field has no value
HAS_TITLE() Determine if TITLE has a value

body

The message body to use in a push notification that is based on the message template.

Accessible with the following methods

Method Description
GET_BODY() Getter for BODY

action

The action to occur if a recipient taps a push notification that is 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 action 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.

Accessible with the following methods

Method Description
GET_ACTION() Getter for ACTION, with configurable default
ASK_ACTION() Getter for ACTION w/ exceptions if field has no value
HAS_ACTION() Determine if ACTION has a value

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.

Accessible with the following methods

Method Description
GET_SOUND() Getter for SOUND, with configurable default
ASK_SOUND() Getter for SOUND w/ exceptions if field has no value
HAS_SOUND() Determine if SOUND has a value

url

The URL to open in a 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.

Accessible with the following methods

Method Description
GET_URL() Getter for URL, with configurable default
ASK_URL() Getter for URL w/ exceptions if field has no value
HAS_URL() Determine if URL has a value

mediaUrl

The URL of an image or video to display in push notifications that are based on the message template.

Accessible with the following methods

Method Description
GET_MEDIAURL() Getter for MEDIAURL, with configurable default
ASK_MEDIAURL() Getter for MEDIAURL w/ exceptions if field has no value
HAS_MEDIAURL() Determine if MEDIAURL has a value

rawContent

The raw, JSON-formatted string to use as the payload for a push notification that's based on the message template. If specified, this value overrides all other content for the message template.

Accessible with the following methods

Method Description
GET_RAWCONTENT() Getter for RAWCONTENT