LISTDEVICESFORUSER()`¶

About ListDevicesForUser¶

Retrieves a paginated list of devices associated with a specific user in a Wickr network. This operation returns information about all devices where the user has logged into Wickr.

Method Signature¶

METHODS /AWS1/IF_WKR~LISTDEVICESFORUSER
  IMPORTING
    !IV_NETWORKID TYPE /AWS1/WKRNETWORKID OPTIONAL
    !IV_USERID TYPE /AWS1/WKRUSERID 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
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_wkrlistdevforuserrsp
  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 containing the user.

`iv_userid` `TYPE /AWS1/WKRUSERID` `/AWS1/WKRUSERID`¶

The unique identifier of the user whose devices will be listed.

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 devices 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 devices by. Multiple fields can be specified by separating them with '+'. Accepted values include 'lastlogin', 'type', 'suspend', and 'created'.

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

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

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_wkrlistdevforuserrsp` `/AWS1/CL_WKRLISTDEVFORUSERRSP`¶

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->listdevicesforuser(
  iv_maxresults = 123
  iv_networkid = |string|
  iv_nexttoken = |string|
  iv_sortdirection = |string|
  iv_sortfields = |string|
  iv_userid = |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_devices( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_genericstring = lo_row_1->get_appid( ).
      lv_genericstring = lo_row_1->get_created( ).
      lv_genericstring = lo_row_1->get_lastlogin( ).
      lv_genericstring = lo_row_1->get_statustext( ).
      lv_boolean = lo_row_1->get_suspend( ).
      lv_genericstring = lo_row_1->get_type( ).
    ENDIF.
  ENDLOOP.
ENDIF.

Successful device list retrieval¶

Successful device list retrieval

DATA(lo_result) = lo_client->listdevicesforuser(
  iv_maxresults = 10
  iv_networkid = |12345678|
  iv_sortdirection = |DESC|
  iv_sortfields = |appId|
  iv_userid = |12345|
).

Retrieving subsequent page of devices¶

Retrieving subsequent page of devices

DATA(lo_result) = lo_client->listdevicesforuser(
  iv_maxresults = 10
  iv_networkid = |12345678|
  iv_nexttoken = |v1:pagination:6ba7b810-9dad-11d1-80b4-00c04fd430c8|
  iv_userid = |12345|
).

Invalid userId error¶

Invalid userId error

DATA(lo_result) = lo_client->listdevicesforuser(
  iv_maxresults = 10
  iv_networkid = |12345678|
  iv_userid = |99999|
).

/AWS1/IF_WKR=>LISTDEVICESFORUSER()¶