SEARCHCHANNELS()`¶

About SearchChannels¶

Allows the ChimeBearer to search channels by channel members. Users or bots can search across the channels that they belong to. Users in the AppInstanceAdmin role can search across all channels.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

This operation isn't supported for AppInstanceUsers with a large number of memberships.

Method Signature¶

METHODS /AWS1/IF_CHS~SEARCHCHANNELS
  IMPORTING
    !IV_CHIMEBEARER TYPE /AWS1/CHSCHIMEARN OPTIONAL
    !IT_FIELDS TYPE /AWS1/CL_CHSSEARCHFIELD=>TT_SEARCHFIELDS OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/CHSMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/CHSNEXTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_chssearchchannelsrsp
  RAISING
    /AWS1/CX_CHSBADREQUESTEX
    /AWS1/CX_CHSFORBIDDENEXCEPTION
    /AWS1/CX_CHSSERVICEFAILUREEX
    /AWS1/CX_CHSSERVICEUNAVAILEX
    /AWS1/CX_CHSTHROTTLEDCLIENTEX
    /AWS1/CX_CHSUNAUTHDCLIENTEX
    /AWS1/CX_CHSCLIENTEXC
    /AWS1/CX_CHSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`it_fields` `TYPE /AWS1/CL_CHSSEARCHFIELD=>TT_SEARCHFIELDS` `TT_SEARCHFIELDS`¶

A list of the Field objects in the channel being searched.

Optional arguments:¶

`iv_chimebearer` `TYPE /AWS1/CHSCHIMEARN` `/AWS1/CHSCHIMEARN`¶

The AppInstanceUserArn of the user making the API call.

`iv_maxresults` `TYPE /AWS1/CHSMAXRESULTS` `/AWS1/CHSMAXRESULTS`¶

The maximum number of channels that you want returned.

`iv_nexttoken` `TYPE /AWS1/CHSNEXTTOKEN` `/AWS1/CHSNEXTTOKEN`¶

The token returned from previous API requests until the number of channels is reached.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_chssearchchannelsrsp` `/AWS1/CL_CHSSEARCHCHANNELSRSP`¶

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->searchchannels(
  it_fields = VALUE /aws1/cl_chssearchfield=>tt_searchfields(
    (
      new /aws1/cl_chssearchfield(
        it_values = VALUE /aws1/cl_chssrchfieldvalues_w=>tt_searchfieldvalues(
          ( new /aws1/cl_chssrchfieldvalues_w( |string| ) )
        )
        iv_key = |string|
        iv_operator = |string|
      )
    )
  )
  iv_chimebearer = |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_channels( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_nonemptyresourcename = lo_row_1->get_name( ).
      lv_chimearn = lo_row_1->get_channelarn( ).
      lv_channelmode = lo_row_1->get_mode( ).
      lv_channelprivacy = lo_row_1->get_privacy( ).
      lv_metadata = lo_row_1->get_metadata( ).
      lv_timestamp = lo_row_1->get_lastmessagetimestamp( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_CHS=>SEARCHCHANNELS()¶