Skip to content

/AWS1/IF_WKR=>LISTSECURITYGROUPS()

About ListSecurityGroups

Retrieves a paginated list of security groups in a specified Wickr network. You can sort the results by various criteria.

Method Signature

METHODS /AWS1/IF_WKR~LISTSECURITYGROUPS
  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
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_wkrlistsecgroupsrsp
  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 security groups.

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 security groups to return in a single page. Valid range is 1-100. Default is 10.

iv_sortfields TYPE /AWS1/WKRGENERICSTRING /AWS1/WKRGENERICSTRING

The field to sort security groups by. Accepted values include 'id' and 'name'.

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_wkrlistsecgroupsrsp /AWS1/CL_WKRLISTSECGROUPSRSP

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->listsecuritygroups(
  iv_maxresults = 123
  iv_networkid = |string|
  iv_nexttoken = |string|
  iv_sortdirection = |string|
  iv_sortfields = |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_securitygroups( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_integer = lo_row_1->get_activemembers( ).
      lv_integer = lo_row_1->get_botmembers( ).
      lv_genericstring = lo_row_1->get_activedirectoryguid( ).
      lv_genericstring = lo_row_1->get_id( ).
      lv_boolean = lo_row_1->get_isdefault( ).
      lv_genericstring = lo_row_1->get_name( ).
      lv_integer = lo_row_1->get_modified( ).
      lo_securitygroupsettings = lo_row_1->get_securitygroupsettings( ).
      IF lo_securitygroupsettings IS NOT INITIAL.
        lv_boolean = lo_securitygroupsettings->get_alwaysreauthenticate( ).
        LOOP AT lo_securitygroupsettings->get_atakpackagevalues( ) into lo_row_2.
          lo_row_3 = lo_row_2.
          IF lo_row_3 IS NOT INITIAL.
            lv_genericstring = lo_row_3->get_value( ).
          ENDIF.
        ENDLOOP.
        lo_callingsettings = lo_securitygroupsettings->get_calling( ).
        IF lo_callingsettings IS NOT INITIAL.
          lv_boolean = lo_callingsettings->get_canstart11call( ).
          lv_boolean = lo_callingsettings->get_canvideocall( ).
          lv_boolean = lo_callingsettings->get_forcetcpcall( ).
        ENDIF.
        lv_boolean = lo_securitygroupsettings->get_checkforupdates( ).
        lv_boolean = lo_securitygroupsettings->get_enableatak( ).
        lv_boolean = lo_securitygroupsettings->get_enablecrashreports( ).
        lv_boolean = lo_securitygroupsettings->get_enablefiledownload( ).
        lv_boolean = lo_securitygroupsettings->get_enableguestfederation( ).
        lv_boolean = lo_securitygroupsettings->get_enablenotifpreview( ).
        lv_boolean = lo_securitygroupsettings->get_enableopenaccessoption( ).
        lv_boolean = lo_securitygroupsettings->get_enbrestrictedglbfedr8n( ).
        lv_boolean = lo_securitygroupsettings->get_filesenabled( ).
        lv_integer = lo_securitygroupsettings->get_forcedevicelockout( ).
        lv_boolean = lo_securitygroupsettings->get_forceopenaccess( ).
        lv_boolean = lo_securitygroupsettings->get_forcereadreceipts( ).
        lv_boolean = lo_securitygroupsettings->get_globalfederation( ).
        lv_boolean = lo_securitygroupsettings->get_isatoenabled( ).
        lv_boolean = lo_securitygroupsettings->get_islinkpreviewenabled( ).
        lv_boolean = lo_securitygroupsettings->get_locationallowmaps( ).
        lv_boolean = lo_securitygroupsettings->get_locationenabled( ).
        lv_long = lo_securitygroupsettings->get_maxautodownloadsize( ).
        lv_integer = lo_securitygroupsettings->get_maxbor( ).
        lv_long = lo_securitygroupsettings->get_maxttl( ).
        lv_boolean = lo_securitygroupsettings->get_messageforwardingenabled( ).
        lo_passwordrequirements = lo_securitygroupsettings->get_passwordrequirements( ).
        IF lo_passwordrequirements IS NOT INITIAL.
          lv_integer = lo_passwordrequirements->get_lowercase( ).
          lv_integer = lo_passwordrequirements->get_minlength( ).
          lv_integer = lo_passwordrequirements->get_numbers( ).
          lv_integer = lo_passwordrequirements->get_symbols( ).
          lv_integer = lo_passwordrequirements->get_uppercase( ).
        ENDIF.
        lv_boolean = lo_securitygroupsettings->get_presenceenabled( ).
        LOOP AT lo_securitygroupsettings->get_quickresponses( ) into lo_row_2.
          lo_row_3 = lo_row_2.
          IF lo_row_3 IS NOT INITIAL.
            lv_genericstring = lo_row_3->get_value( ).
          ENDIF.
        ENDLOOP.
        lv_boolean = lo_securitygroupsettings->get_showmasterrecoverykey( ).
        lo_shreddersettings = lo_securitygroupsettings->get_shredder( ).
        IF lo_shreddersettings IS NOT INITIAL.
          lv_boolean = lo_shreddersettings->get_canprocessmanually( ).
          lv_integer = lo_shreddersettings->get_intensity( ).
        ENDIF.
        lv_integer = lo_securitygroupsettings->get_ssomaxidleminutes( ).
        lv_integer = lo_securitygroupsettings->get_federationmode( ).
        lv_integer = lo_securitygroupsettings->get_lockoutthreshold( ).
        LOOP AT lo_securitygroupsettings->get_permittednetworks( ) into lo_row_4.
          lo_row_5 = lo_row_4.
          IF lo_row_5 IS NOT INITIAL.
            lv_networkid = lo_row_5->get_value( ).
          ENDIF.
        ENDLOOP.
        LOOP AT lo_securitygroupsettings->get_permittedwickrawsnets( ) into lo_row_6.
          lo_row_7 = lo_row_6.
          IF lo_row_7 IS NOT INITIAL.
            lv_genericstring = lo_row_7->get_region( ).
            lv_networkid = lo_row_7->get_networkid( ).
          ENDIF.
        ENDLOOP.
        LOOP AT lo_securitygroupsettings->get_permittedwickrentrpnets( ) into lo_row_8.
          lo_row_9 = lo_row_8.
          IF lo_row_9 IS NOT INITIAL.
            lv_genericstring = lo_row_9->get_domain( ).
            lv_networkid = lo_row_9->get_networkid( ).
          ENDIF.
        ENDLOOP.
      ENDIF.
    ENDIF.
  ENDLOOP.
  lv_genericstring = lo_result->get_nexttoken( ).
ENDIF.

List security groups with pagination

List security groups with pagination

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

List security groups - first page

List security groups - first page

DATA(lo_result) = lo_client->listsecuritygroups(
  iv_maxresults = 10
  iv_networkid = |12345678|
).