/AWS1/IF_SNS=>CREATEPLATFORMAPPLICATION()

About CreatePlatformApplication

Creates a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging), to which devices and mobile apps may register. You must specify PlatformPrincipal and PlatformCredential attributes when using the CreatePlatformApplication action.

PlatformPrincipal and PlatformCredential are received from the notification service.

• For ADM, PlatformPrincipal is client id and PlatformCredential is client secret.

• For APNS and APNS_SANDBOX using certificate credentials, PlatformPrincipal is SSL certificate and PlatformCredential is private key.

• For APNS and APNS_SANDBOX using token credentials, PlatformPrincipal is signing key ID and PlatformCredential is signing key.

• For Baidu, PlatformPrincipal is API key and PlatformCredential is secret key.

• For GCM (Firebase Cloud Messaging) using key credentials, there is no PlatformPrincipal. The PlatformCredential is API key.

• For GCM (Firebase Cloud Messaging) using token credentials, there is no PlatformPrincipal. The PlatformCredential is a JSON formatted private key file. When using the Amazon Web Services CLI or Amazon Web Services SDKs, the file must be in string format and special characters must be ignored. To format the file correctly, Amazon SNS recommends using the following command: SERVICE_JSON=$(jq @json < service.json).

• For MPNS, PlatformPrincipal is TLS certificate and PlatformCredential is private key.

• For WNS, PlatformPrincipal is Package Security Identifier and PlatformCredential is secret key.

You can use the returned PlatformApplicationArn as an attribute for the CreatePlatformEndpoint action.

Method Signature

METHODS /AWS1/IF_SNS~CREATEPLATFORMAPPLICATION
  IMPORTING
    !IV_NAME TYPE /AWS1/SNSSTRING OPTIONAL
    !IV_PLATFORM TYPE /AWS1/SNSSTRING OPTIONAL
    !IT_ATTRIBUTES TYPE /AWS1/CL_SNSMAPSTRTOSTR_W=>TT_MAPSTRINGTOSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_snscreplatformappli01
  RAISING
    /AWS1/CX_SNSAUTHERROREXCEPTION
    /AWS1/CX_SNSINTERNALERROREX
    /AWS1/CX_SNSINVALIDPARAMETEREX
    /AWS1/CX_SNSCLIENTEXC
    /AWS1/CX_SNSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_name TYPE /AWS1/SNSSTRING /AWS1/SNSSTRING

Application names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters long.

iv_platform TYPE /AWS1/SNSSTRING /AWS1/SNSSTRING

The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Firebase Cloud Messaging).

it_attributes TYPE /AWS1/CL_SNSMAPSTRTOSTR_W=>TT_MAPSTRINGTOSTRING TT_MAPSTRINGTOSTRING

For a list of attributes, see SetPlatformApplicationAttributes .

RETURNING

oo_output TYPE REF TO /aws1/cl_snscreplatformappli01 /AWS1/CL_SNSCREPLATFORMAPPLI01

Domain	/AWS1/RT_ACCOUNT_ID
Primitive Type	NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->createplatformapplication(
  it_attributes = VALUE /aws1/cl_snsmapstrtostr_w=>tt_mapstringtostring(
    (
      VALUE /aws1/cl_snsmapstrtostr_w=>ts_mapstringtostring_maprow(
        value = new /aws1/cl_snsmapstrtostr_w( |string| )
        key = |string|
      )
    )
  )
  iv_name = |string|
  iv_platform = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_string = lo_result->get_platformapplicationarn( ).
ENDIF.