Skip to content

/AWS1/IF_IVR=>LISTPARTICIPANTS()

About ListParticipants

Lists all participants in a specified stage session.

Method Signature

METHODS /AWS1/IF_IVR~LISTPARTICIPANTS
  IMPORTING
    !IV_STAGEARN TYPE /AWS1/IVRSTAGEARN OPTIONAL
    !IV_SESSIONID TYPE /AWS1/IVRSTAGESESSIONID OPTIONAL
    !IV_FILTERBYUSERID TYPE /AWS1/IVRUSERID OPTIONAL
    !IV_FILTERBYPUBLISHED TYPE /AWS1/IVRPUBLISHED OPTIONAL
    !IV_FILTERBYSTATE TYPE /AWS1/IVRPARTICIPANTSTATE OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/IVRPAGINATIONTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/IVRMAXPARTICIPANTRESULTS OPTIONAL
    !IV_FILTERBYRECORDINGSTATE TYPE /AWS1/IVRPARTICIPANTRCINGFIL00 OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ivrlstparticipantsrsp
  RAISING
    /AWS1/CX_IVRACCESSDENIEDEX
    /AWS1/CX_IVRVALIDATIONEX
    /AWS1/CX_IVRCLIENTEXC
    /AWS1/CX_IVRSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_stagearn TYPE /AWS1/IVRSTAGEARN /AWS1/IVRSTAGEARN

Stage ARN.

iv_sessionid TYPE /AWS1/IVRSTAGESESSIONID /AWS1/IVRSTAGESESSIONID

ID of the session within the stage.

Optional arguments:

iv_filterbyuserid TYPE /AWS1/IVRUSERID /AWS1/IVRUSERID

Filters the response list to match the specified user ID. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request. A userId is a customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems.

iv_filterbypublished TYPE /AWS1/IVRPUBLISHED /AWS1/IVRPUBLISHED

Filters the response list to only show participants who published during the stage session. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.

iv_filterbystate TYPE /AWS1/IVRPARTICIPANTSTATE /AWS1/IVRPARTICIPANTSTATE

Filters the response list to only show participants in the specified state. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.

iv_nexttoken TYPE /AWS1/IVRPAGINATIONTOKEN /AWS1/IVRPAGINATIONTOKEN

The first participant to retrieve. This is used for pagination; see the nextToken response field.

iv_maxresults TYPE /AWS1/IVRMAXPARTICIPANTRESULTS /AWS1/IVRMAXPARTICIPANTRESULTS

Maximum number of results to return. Default: 50.

iv_filterbyrecordingstate TYPE /AWS1/IVRPARTICIPANTRCINGFIL00 /AWS1/IVRPARTICIPANTRCINGFIL00

Filters the response list to only show participants with the specified recording state. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.

RETURNING

oo_output TYPE REF TO /aws1/cl_ivrlstparticipantsrsp /AWS1/CL_IVRLSTPARTICIPANTSRSP

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->listparticipants(
  iv_filterbypublished = ABAP_TRUE
  iv_filterbyrecordingstate = |string|
  iv_filterbystate = |string|
  iv_filterbyuserid = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_sessionid = |string|
  iv_stagearn = |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_participants( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_participantid = lo_row_1->get_participantid( ).
      lv_userid = lo_row_1->get_userid( ).
      lv_participantstate = lo_row_1->get_state( ).
      lv_time = lo_row_1->get_firstjointime( ).
      lv_published = lo_row_1->get_published( ).
      lv_participantrecordingsta = lo_row_1->get_recordingstate( ).
      lv_replicationtype = lo_row_1->get_replicationtype( ).
      lv_replicationstate = lo_row_1->get_replicationstate( ).
      lv_stagearn = lo_row_1->get_sourcestagearn( ).
      lv_stagesessionid = lo_row_1->get_sourcesessionid( ).
      lv_redundantingest = lo_row_1->get_redundantingest( ).
      lv_ingestconfigurationarn = lo_row_1->get_ingestconfigurationarn( ).
    ENDIF.
  ENDLOOP.
  lv_paginationtoken = lo_result->get_nexttoken( ).
ENDIF.