Skip to content

/AWS1/IF_CNT=>LISTUSERNOTIFICATIONS()

About ListUserNotifications

Retrieves a paginated list of notifications for a specific user, including the notification status for that user.

Method Signature

METHODS /AWS1/IF_CNT~LISTUSERNOTIFICATIONS
  IMPORTING
    !IV_INSTANCEID TYPE /AWS1/CNTINSTANCEID OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/CNTNEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/CNTMAXRESULT1000 OPTIONAL
    !IV_USERID TYPE /AWS1/CNTUSERID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cntlistusernotifsrsp
  RAISING
    /AWS1/CX_CNTACCESSDENIEDEX
    /AWS1/CX_CNTINTERNALSERVICEEX
    /AWS1/CX_CNTINVALIDPARAMETEREX
    /AWS1/CX_CNTINVALIDREQUESTEX
    /AWS1/CX_CNTRESOURCENOTFOUNDEX
    /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_userid TYPE /AWS1/CNTUSERID /AWS1/CNTUSERID

The identifier of the user.

Optional arguments:

iv_nexttoken TYPE /AWS1/CNTNEXTTOKEN /AWS1/CNTNEXTTOKEN

The token for the next set of results. Use the value returned in the previous response to retrieve the next page of results.

iv_maxresults TYPE /AWS1/CNTMAXRESULT1000 /AWS1/CNTMAXRESULT1000

The maximum number of results to return per page. Valid range is 1-1000.

RETURNING

oo_output TYPE REF TO /aws1/cl_cntlistusernotifsrsp /AWS1/CL_CNTLISTUSERNOTIFSRSP

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->listusernotifications(
  iv_instanceid = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_userid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_usernotifications( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_notificationid = lo_row_1->get_notificationid( ).
      lv_notificationstatus = lo_row_1->get_notificationstatus( ).
      lv_instanceid = lo_row_1->get_instanceid( ).
      lv_agentid = lo_row_1->get_recipientid( ).
      LOOP AT lo_row_1->get_content( ) into ls_row_2.
        lv_key = ls_row_2-key.
        lo_value = ls_row_2-value.
        IF lo_value IS NOT INITIAL.
          lv_localizedstring = lo_value->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_notificationpriority = lo_row_1->get_priority( ).
      lv_notificationsource = lo_row_1->get_source( ).
      lv_timestamp = lo_row_1->get_createdat( ).
      lv_timestamp = lo_row_1->get_expiresat( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.