UPDATEBOT()`¶

About UpdateBot¶

Updates the properties of an existing bot in a Wickr network. This operation allows you to modify the bot's display name, security group, password, or suspension status.

Method Signature¶

METHODS /AWS1/IF_WKR~UPDATEBOT
  IMPORTING
    !IV_NETWORKID TYPE /AWS1/WKRNETWORKID OPTIONAL
    !IV_BOTID TYPE /AWS1/WKRBOTID OPTIONAL
    !IV_DISPLAYNAME TYPE /AWS1/WKRGENERICSTRING OPTIONAL
    !IV_GROUPID TYPE /AWS1/WKRGENERICSTRING OPTIONAL
    !IV_CHALLENGE TYPE /AWS1/WKRSENSITIVESTRING OPTIONAL
    !IV_SUSPEND TYPE /AWS1/WKRBOOLEAN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_wkrupdatebotresponse
  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 bot to update.

`iv_botid` `TYPE /AWS1/WKRBOTID` `/AWS1/WKRBOTID`¶

The unique identifier of the bot to update.

Optional arguments:¶

`iv_displayname` `TYPE /AWS1/WKRGENERICSTRING` `/AWS1/WKRGENERICSTRING`¶

The new display name for the bot.

`iv_groupid` `TYPE /AWS1/WKRGENERICSTRING` `/AWS1/WKRGENERICSTRING`¶

The ID of the new security group to assign the bot to.

`iv_challenge` `TYPE /AWS1/WKRSENSITIVESTRING` `/AWS1/WKRSENSITIVESTRING`¶

The new password for the bot account.

`iv_suspend` `TYPE /AWS1/WKRBOOLEAN` `/AWS1/WKRBOOLEAN`¶

Set to true to suspend the bot or false to unsuspend it. Omit this field for standard updates that don't affect suspension status.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_wkrupdatebotresponse` `/AWS1/CL_WKRUPDATEBOTRESPONSE`¶

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->updatebot(
  iv_botid = |string|
  iv_challenge = |string|
  iv_displayname = |string|
  iv_groupid = |string|
  iv_networkid = |string|
  iv_suspend = ABAP_TRUE
).

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_message( ).
ENDIF.

Update bot successfully¶

Update bot successfully

DATA(lo_result) = lo_client->updatebot(
  iv_botid = |98765|
  iv_displayname = |Updated Support Bot|
  iv_groupid = |support_group|
  iv_networkid = |12345678|
).

Update bot - bot not found¶

Update bot - bot not found

DATA(lo_result) = lo_client->updatebot(
  iv_botid = |99999|
  iv_displayname = |Updated Bot|
  iv_networkid = |12345678|
).

/AWS1/IF_WKR=>UPDATEBOT()¶