/AWS1/IF_CNT=>CREATEPUSHNOTIFICATIONREG()

About CreatePushNotificationRegistration

Creates registration for a device token and a chat contact to receive real-time push notifications. For more information about push notifications, see Set up push notifications in Amazon Connect for mobile chat in the Amazon Connect Administrator Guide.

Method Signature

METHODS /AWS1/IF_CNT~CREATEPUSHNOTIFICATIONREG
  IMPORTING
    !IV_INSTANCEID TYPE /AWS1/CNTINSTANCEID OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/CNTCLIENTTOKEN OPTIONAL
    !IV_PINPOINTAPPARN TYPE /AWS1/CNTARN OPTIONAL
    !IV_DEVICETOKEN TYPE /AWS1/CNTDEVICETOKEN OPTIONAL
    !IV_DEVICETYPE TYPE /AWS1/CNTDEVICETYPE OPTIONAL
    !IO_CONTACTCONFIGURATION TYPE REF TO /AWS1/CL_CNTCONTACTCONF OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cntcrepushnotifregrsp
  RAISING
    /AWS1/CX_CNTACCESSDENIEDEX
    /AWS1/CX_CNTINTERNALSERVICEEX
    /AWS1/CX_CNTINVALIDPARAMETEREX
    /AWS1/CX_CNTRESOURCENOTFOUNDEX
    /AWS1/CX_CNTSERVICEQUOTAEXCDEX
    /AWS1/CX_CNTTHROTTLINGEX
    /AWS1/CX_CNTCLIENTEXC
    /AWS1/CX_CNTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_instanceid TYPE /AWS1/CNTINSTANCEID /AWS1/CNTINSTANCEID

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

iv_pinpointapparn TYPE /AWS1/CNTARN /AWS1/CNTARN

The Amazon Resource Name (ARN) of the Pinpoint application.

iv_devicetoken TYPE /AWS1/CNTDEVICETOKEN /AWS1/CNTDEVICETOKEN

The push notification token issued by the Apple or Google gateways.

iv_devicetype TYPE /AWS1/CNTDEVICETYPE /AWS1/CNTDEVICETYPE

The device type to use when sending the message.

io_contactconfiguration TYPE REF TO /AWS1/CL_CNTCONTACTCONF /AWS1/CL_CNTCONTACTCONF

The contact configuration for push notification registration.

Optional arguments:

iv_clienttoken TYPE /AWS1/CNTCLIENTTOKEN /AWS1/CNTCLIENTTOKEN

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

RETURNING

oo_output TYPE REF TO /aws1/cl_cntcrepushnotifregrsp /AWS1/CL_CNTCREPUSHNOTIFREGRSP

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->createpushnotificationreg(
  io_contactconfiguration = new /aws1/cl_cntcontactconf(
    iv_contactid = |string|
    iv_includerawmessage = ABAP_TRUE
    iv_participantrole = |string|
  )
  iv_clienttoken = |string|
  iv_devicetoken = |string|
  iv_devicetype = |string|
  iv_instanceid = |string|
  iv_pinpointapparn = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_registrationid = lo_result->get_registrationid( ).
ENDIF.