LISTSIGNALINGCHANNELS()`¶

About ListSignalingChannels¶

Returns an array of ChannelInfo objects. Each object describes a signaling channel. To retrieve only those channels that satisfy a specific condition, you can specify a ChannelNameCondition.

Method Signature¶

METHODS /AWS1/IF_KNV~LISTSIGNALINGCHANNELS
  IMPORTING
    !IV_MAXRESULTS TYPE /AWS1/KNVLISTSTREAMSINPUTLIMIT OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/KNVNEXTTOKEN OPTIONAL
    !IO_CHANNELNAMECONDITION TYPE REF TO /AWS1/CL_KNVCHANNELNAMECOND OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_knvlstsignalingchan01
  RAISING
    /AWS1/CX_KNVACCESSDENIEDEX
    /AWS1/CX_KNVCLIENTLIMITEXCDEX
    /AWS1/CX_KNVINVALIDARGUMENTEX
    /AWS1/CX_KNVCLIENTEXC
    /AWS1/CX_KNVSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_maxresults` `TYPE /AWS1/KNVLISTSTREAMSINPUTLIMIT` `/AWS1/KNVLISTSTREAMSINPUTLIMIT`¶

The maximum number of channels to return in the response. The default is 500.

`iv_nexttoken` `TYPE /AWS1/KNVNEXTTOKEN` `/AWS1/KNVNEXTTOKEN`¶

If you specify this parameter, when the result of a ListSignalingChannels operation is truncated, the call returns the NextToken in the response. To get another batch of channels, provide this token in your next request.

`io_channelnamecondition` `TYPE REF TO /AWS1/CL_KNVCHANNELNAMECOND` `/AWS1/CL_KNVCHANNELNAMECOND`¶

Optional: Returns only the channels that satisfy a specific condition.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_knvlstsignalingchan01` `/AWS1/CL_KNVLSTSIGNALINGCHAN01`¶

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->listsignalingchannels(
  io_channelnamecondition = new /aws1/cl_knvchannelnamecond(
    iv_comparisonoperator = |string|
    iv_comparisonvalue = |string|
  )
  iv_maxresults = 123
  iv_nexttoken = |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_channelinfolist( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_channelname = lo_row_1->get_channelname( ).
      lv_resourcearn = lo_row_1->get_channelarn( ).
      lv_channeltype = lo_row_1->get_channeltype( ).
      lv_status = lo_row_1->get_channelstatus( ).
      lv_timestamp = lo_row_1->get_creationtime( ).
      lo_singlemasterconfigurati = lo_row_1->get_singlemasterconf( ).
      IF lo_singlemasterconfigurati IS NOT INITIAL.
        lv_messagettlseconds = lo_singlemasterconfigurati->get_messagettlseconds( ).
      ENDIF.
      lv_version = lo_row_1->get_version( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_KNV=>LISTSIGNALINGCHANNELS()¶