LISTGUESTUSERS()`¶

About ListGuestUsers¶

Retrieves a paginated list of guest users who have communicated with your Wickr network. Guest users are external users from federated networks who can communicate with network members.

Method Signature¶

METHODS /AWS1/IF_WKR~LISTGUESTUSERS
  IMPORTING
    !IV_NETWORKID TYPE /AWS1/WKRNETWORKID OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/WKRINTEGER OPTIONAL
    !IV_SORTDIRECTION TYPE /AWS1/WKRSORTDIRECTION OPTIONAL
    !IV_SORTFIELDS TYPE /AWS1/WKRGENERICSTRING OPTIONAL
    !IV_USERNAME TYPE /AWS1/WKRGENERICSTRING OPTIONAL
    !IV_BILLINGPERIOD TYPE /AWS1/WKRGENERICSTRING OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/WKRGENERICSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_wkrlistguestusersrsp
  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 guest users.

Optional arguments:¶

`iv_maxresults` `TYPE /AWS1/WKRINTEGER` `/AWS1/WKRINTEGER`¶

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

`iv_sortdirection` `TYPE /AWS1/WKRSORTDIRECTION` `/AWS1/WKRSORTDIRECTION`¶

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

`iv_sortfields` `TYPE /AWS1/WKRGENERICSTRING` `/AWS1/WKRGENERICSTRING`¶

The field to sort guest users by. Accepted values include 'username' and 'billingPeriod'.

`iv_username` `TYPE /AWS1/WKRGENERICSTRING` `/AWS1/WKRGENERICSTRING`¶

Filter results to only include guest users with usernames matching this value.

`iv_billingperiod` `TYPE /AWS1/WKRGENERICSTRING` `/AWS1/WKRGENERICSTRING`¶

Filter results to only include guest users from this billing period (e.g., '2024-01').

`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.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_wkrlistguestusersrsp` `/AWS1/CL_WKRLISTGUESTUSERSRSP`¶

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->listguestusers(
  iv_billingperiod = |string|
  iv_maxresults = 123
  iv_networkid = |string|
  iv_nexttoken = |string|
  iv_sortdirection = |string|
  iv_sortfields = |string|
  iv_username = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_genericstring = lo_result->get_nexttoken( ).
  LOOP AT lo_result->get_guestlist( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_genericstring = lo_row_1->get_billingperiod( ).
      lv_genericstring = lo_row_1->get_username( ).
      lv_genericstring = lo_row_1->get_usernamehash( ).
    ENDIF.
  ENDLOOP.
ENDIF.

Get paginated list of guest users¶

Get paginated list of guest users

DATA(lo_result) = lo_client->listguestusers(
  iv_maxresults = 20
  iv_networkid = |12345678|
  iv_sortdirection = |DESC|
  iv_sortfields = |billingPeriod|
).

Filter by billing period¶

Filter by billing period

DATA(lo_result) = lo_client->listguestusers(
  iv_billingperiod = |2024-01|
  iv_maxresults = 10
  iv_networkid = |12345678|
).

Empty guest list¶

Empty guest list

DATA(lo_result) = lo_client->listguestusers( iv_networkid = |87654321| ) .

/AWS1/IF_WKR=>LISTGUESTUSERS()¶