LISTCONTACTS()`¶

About ListContacts¶

Lists the contacts present in a specific contact list.

Method Signature¶

METHODS /AWS1/IF_SE2~LISTCONTACTS
  IMPORTING
    !IV_CONTACTLISTNAME TYPE /AWS1/SE2CONTACTLISTNAME OPTIONAL
    !IO_FILTER TYPE REF TO /AWS1/CL_SE2LISTCONTACTSFILTER OPTIONAL
    !IV_PAGESIZE TYPE /AWS1/SE2MAXITEMS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/SE2NEXTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_se2listcontactsrsp
  RAISING
    /AWS1/CX_SE2BADREQUESTEX
    /AWS1/CX_SE2NOTFOUNDEXCEPTION
    /AWS1/CX_SE2TOOMANYREQUESTSEX
    /AWS1/CX_SE2CLIENTEXC
    /AWS1/CX_SE2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_contactlistname` `TYPE /AWS1/SE2CONTACTLISTNAME` `/AWS1/SE2CONTACTLISTNAME`¶

The name of the contact list.

Optional arguments:¶

`io_filter` `TYPE REF TO /AWS1/CL_SE2LISTCONTACTSFILTER` `/AWS1/CL_SE2LISTCONTACTSFILTER`¶

A filter that can be applied to a list of contacts.

`iv_pagesize` `TYPE /AWS1/SE2MAXITEMS` `/AWS1/SE2MAXITEMS`¶

The number of contacts that may be returned at once, which is dependent on if there are more or less contacts than the value of the PageSize. Use this parameter to paginate results. If additional contacts exist beyond the specified limit, the NextToken element is sent in the response. Use the NextToken value in subsequent requests to retrieve additional contacts.

`iv_nexttoken` `TYPE /AWS1/SE2NEXTTOKEN` `/AWS1/SE2NEXTTOKEN`¶

A string token indicating that there might be additional contacts available to be listed. Use the token provided in the Response to use in the subsequent call to ListContacts with the same parameters to retrieve the next page of contacts.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_se2listcontactsrsp` `/AWS1/CL_SE2LISTCONTACTSRSP`¶

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->listcontacts(
  io_filter = new /aws1/cl_se2listcontactsfilter(
    io_topicfilter = new /aws1/cl_se2topicfilter(
      iv_topicname = |string|
      iv_usedefifpreferenceunavail = ABAP_TRUE
    )
    iv_filteredstatus = |string|
  )
  iv_contactlistname = |string|
  iv_nexttoken = |string|
  iv_pagesize = 123
).

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_contacts( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_emailaddress = lo_row_1->get_emailaddress( ).
      LOOP AT lo_row_1->get_topicpreferences( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_topicname = lo_row_3->get_topicname( ).
          lv_subscriptionstatus = lo_row_3->get_subscriptionstatus( ).
        ENDIF.
      ENDLOOP.
      LOOP AT lo_row_1->get_topicdefaultpreferences( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_topicname = lo_row_3->get_topicname( ).
          lv_subscriptionstatus = lo_row_3->get_subscriptionstatus( ).
        ENDIF.
      ENDLOOP.
      lv_unsubscribeall = lo_row_1->get_unsubscribeall( ).
      lv_timestamp = lo_row_1->get_lastupdatedtimestamp( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_SE2=>LISTCONTACTS()¶