Skip to content

/AWS1/IF_WKR=>LISTBOTS()

About ListBots

Retrieves a paginated list of bots in a specified Wickr network. You can filter and sort the results based on various criteria.

Method Signature

METHODS /AWS1/IF_WKR~LISTBOTS
  IMPORTING
    !IV_NETWORKID TYPE /AWS1/WKRNETWORKID OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/WKRGENERICSTRING OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/WKRINTEGER OPTIONAL
    !IV_SORTFIELDS TYPE /AWS1/WKRGENERICSTRING OPTIONAL
    !IV_SORTDIRECTION TYPE /AWS1/WKRSORTDIRECTION OPTIONAL
    !IV_DISPLAYNAME TYPE /AWS1/WKRGENERICSTRING OPTIONAL
    !IV_USERNAME TYPE /AWS1/WKRGENERICSTRING OPTIONAL
    !IV_STATUS TYPE /AWS1/WKRBOTSTATUS OPTIONAL
    !IV_GROUPID TYPE /AWS1/WKRGENERICSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_wkrlistbotsresponse
  RAISING
    /AWS1/CX_WKRBADREQUESTERROR
    /AWS1/CX_WKRFORBIDDENERROR
    /AWS1/CX_WKRINTSERVERERROR
    /AWS1/CX_WKRRATELIMITERROR
    /AWS1/CX_WKRRESNOTFOUNDERROR
    /AWS1/CX_WKRUNAUTHORIZEDERROR
    /AWS1/CX_WKRVALIDATIONERROR
    /AWS1/CX_WKRCLIENTEXC
    /AWS1/CX_WKRSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_networkid TYPE /AWS1/WKRNETWORKID /AWS1/WKRNETWORKID

The ID of the Wickr network from which to list bots.

Optional arguments:

iv_nexttoken TYPE /AWS1/WKRGENERICSTRING /AWS1/WKRGENERICSTRING

The token for retrieving the next page of results. This is returned from a previous request when there are more results available.

iv_maxresults TYPE /AWS1/WKRINTEGER /AWS1/WKRINTEGER

The maximum number of bots to return in a single page. Valid range is 1-100. Default is 10.

iv_sortfields TYPE /AWS1/WKRGENERICSTRING /AWS1/WKRGENERICSTRING

The fields to sort bots by. Multiple fields can be specified by separating them with '+'. Accepted values include 'username', 'firstName', 'displayName', 'status', and 'groupId'.

iv_sortdirection TYPE /AWS1/WKRSORTDIRECTION /AWS1/WKRSORTDIRECTION

The direction to sort results. Valid values are 'ASC' (ascending) or 'DESC' (descending). Default is 'DESC'.

iv_displayname TYPE /AWS1/WKRGENERICSTRING /AWS1/WKRGENERICSTRING

Filter results to only include bots with display names matching this value.

iv_username TYPE /AWS1/WKRGENERICSTRING /AWS1/WKRGENERICSTRING

Filter results to only include bots with usernames matching this value.

iv_status TYPE /AWS1/WKRBOTSTATUS /AWS1/WKRBOTSTATUS

Filter results to only include bots with this status (1 for pending, 2 for active).

iv_groupid TYPE /AWS1/WKRGENERICSTRING /AWS1/WKRGENERICSTRING

Filter results to only include bots belonging to this security group.

RETURNING

oo_output TYPE REF TO /aws1/cl_wkrlistbotsresponse /AWS1/CL_WKRLISTBOTSRESPONSE

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->listbots(
  iv_displayname = |string|
  iv_groupid = |string|
  iv_maxresults = 123
  iv_networkid = |string|
  iv_nexttoken = |string|
  iv_sortdirection = |string|
  iv_sortfields = |string|
  iv_status = 123
  iv_username = |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_bots( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_genericstring = lo_row_1->get_botid( ).
      lv_genericstring = lo_row_1->get_displayname( ).
      lv_genericstring = lo_row_1->get_username( ).
      lv_genericstring = lo_row_1->get_uname( ).
      lv_genericstring = lo_row_1->get_pubkey( ).
      lv_botstatus = lo_row_1->get_status( ).
      lv_genericstring = lo_row_1->get_groupid( ).
      lv_boolean = lo_row_1->get_haschallenge( ).
      lv_boolean = lo_row_1->get_suspended( ).
      lv_genericstring = lo_row_1->get_lastlogin( ).
    ENDIF.
  ENDLOOP.
  lv_genericstring = lo_result->get_nexttoken( ).
ENDIF.

List bots with pagination

List bots with pagination

DATA(lo_result) = lo_client->listbots(
  iv_maxresults = 10
  iv_networkid = |12345678|
  iv_sortdirection = |ASC|
  iv_sortfields = |username|
).

List bots with filters

List bots with filters

DATA(lo_result) = lo_client->listbots(
  iv_displayname = |Support|
  iv_maxresults = 10
  iv_networkid = |12345678|
  iv_status = 2
).