/AWS1/IF_LM2=>LISTINTENTS()

About ListIntents

Get a list of intents that meet the specified criteria.

Method Signature

METHODS /AWS1/IF_LM2~LISTINTENTS
  IMPORTING
    !IV_BOTID TYPE /AWS1/LM2ID OPTIONAL
    !IV_BOTVERSION TYPE /AWS1/LM2BOTVERSION OPTIONAL
    !IV_LOCALEID TYPE /AWS1/LM2LOCALEID OPTIONAL
    !IO_SORTBY TYPE REF TO /AWS1/CL_LM2INTENTSORTBY OPTIONAL
    !IT_FILTERS TYPE /AWS1/CL_LM2INTENTFILTER=>TT_INTENTFILTERS OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/LM2MAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/LM2NEXTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_lm2listintentsrsp
  RAISING
    /AWS1/CX_LM2INTERNALSERVEREX
    /AWS1/CX_LM2SERVICEQUOTAEXCDEX
    /AWS1/CX_LM2THROTTLINGEX
    /AWS1/CX_LM2VALIDATIONEX
    /AWS1/CX_LM2CLIENTEXC
    /AWS1/CX_LM2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_botid TYPE /AWS1/LM2ID /AWS1/LM2ID

The unique identifier of the bot that contains the intent.

iv_botversion TYPE /AWS1/LM2BOTVERSION /AWS1/LM2BOTVERSION

The version of the bot that contains the intent.

iv_localeid TYPE /AWS1/LM2LOCALEID /AWS1/LM2LOCALEID

The identifier of the language and locale of the intents to list. The string must match one of the supported locales. For more information, see Supported languages.

Optional arguments:

io_sortby TYPE REF TO /AWS1/CL_LM2INTENTSORTBY /AWS1/CL_LM2INTENTSORTBY

Determines the sort order for the response from the ListIntents operation. You can choose to sort by the intent name or last updated date in either ascending or descending order.

it_filters TYPE /AWS1/CL_LM2INTENTFILTER=>TT_INTENTFILTERS TT_INTENTFILTERS

Provides the specification of a filter used to limit the intents in the response to only those that match the filter specification. You can only specify one filter and only one string to filter on.

iv_maxresults TYPE /AWS1/LM2MAXRESULTS /AWS1/LM2MAXRESULTS

The maximum number of intents to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.

iv_nexttoken TYPE /AWS1/LM2NEXTTOKEN /AWS1/LM2NEXTTOKEN

If the response from the ListIntents operation contains more results than specified in the maxResults parameter, a token is returned in the response.

Use the returned token in the nextToken parameter of a ListIntents request to return the next page of results. For a complete set of results, call the ListIntents operation until the nextToken returned in the response is null.

RETURNING

oo_output TYPE REF TO /aws1/cl_lm2listintentsrsp /AWS1/CL_LM2LISTINTENTSRSP

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->listintents(
  io_sortby = new /aws1/cl_lm2intentsortby(
    iv_attribute = |string|
    iv_order = |string|
  )
  it_filters = VALUE /aws1/cl_lm2intentfilter=>tt_intentfilters(
    (
      new /aws1/cl_lm2intentfilter(
        it_values = VALUE /aws1/cl_lm2filtervalues_w=>tt_filtervalues(
          ( new /aws1/cl_lm2filtervalues_w( |string| ) )
        )
        iv_name = |string|
        iv_operator = |string|
      )
    )
  )
  iv_botid = |string|
  iv_botversion = |string|
  iv_localeid = |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.
  lv_id = lo_result->get_botid( ).
  lv_botversion = lo_result->get_botversion( ).
  lv_localeid = lo_result->get_localeid( ).
  LOOP AT lo_result->get_intentsummaries( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_id = lo_row_1->get_intentid( ).
      lv_name = lo_row_1->get_intentname( ).
      lv_description = lo_row_1->get_description( ).
      lv_intentsignature = lo_row_1->get_parentintentsignature( ).
      LOOP AT lo_row_1->get_inputcontexts( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_name = lo_row_3->get_name( ).
        ENDIF.
      ENDLOOP.
      LOOP AT lo_row_1->get_outputcontexts( ) into lo_row_4.
        lo_row_5 = lo_row_4.
        IF lo_row_5 IS NOT INITIAL.
          lv_name = lo_row_5->get_name( ).
          lv_contexttimetoliveinseco = lo_row_5->get_timetoliveinseconds( ).
          lv_contextturnstolive = lo_row_5->get_turnstolive( ).
        ENDIF.
      ENDLOOP.
      lv_timestamp = lo_row_1->get_lastupdateddatetime( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.