Skip to content

/AWS1/IF_BDA=>UPDATEAGENTCOLLABORATOR()

About UpdateAgentCollaborator

Updates an agent's collaborator.

Method Signature

METHODS /AWS1/IF_BDA~UPDATEAGENTCOLLABORATOR
  IMPORTING
    !IV_AGENTID TYPE /AWS1/BDAID OPTIONAL
    !IV_AGENTVERSION TYPE /AWS1/BDADRAFTVERSION OPTIONAL
    !IV_COLLABORATORID TYPE /AWS1/BDAID OPTIONAL
    !IO_AGENTDESCRIPTOR TYPE REF TO /AWS1/CL_BDAAGENTDESCRIPTOR OPTIONAL
    !IV_COLLABORATORNAME TYPE /AWS1/BDANAME OPTIONAL
    !IV_COLLABORATIONINSTRUCTION TYPE /AWS1/BDACOLLABORATIONINSTRU00 OPTIONAL
    !IV_RELAYCONVERSATIONHISTORY TYPE /AWS1/BDARELAYCONVERSATIONHI00 OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_bdaupagentcollabora01
  RAISING
    /AWS1/CX_BDAACCESSDENIEDEX
    /AWS1/CX_BDACONFLICTEXCEPTION
    /AWS1/CX_BDAINTERNALSERVEREX
    /AWS1/CX_BDARESOURCENOTFOUNDEX
    /AWS1/CX_BDASERVICEQUOTAEXCDEX
    /AWS1/CX_BDATHROTTLINGEX
    /AWS1/CX_BDAVALIDATIONEX
    /AWS1/CX_BDACLIENTEXC
    /AWS1/CX_BDASERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_agentid TYPE /AWS1/BDAID /AWS1/BDAID

The agent's ID.

iv_agentversion TYPE /AWS1/BDADRAFTVERSION /AWS1/BDADRAFTVERSION

The agent's version.

iv_collaboratorid TYPE /AWS1/BDAID /AWS1/BDAID

The collaborator's ID.

io_agentdescriptor TYPE REF TO /AWS1/CL_BDAAGENTDESCRIPTOR /AWS1/CL_BDAAGENTDESCRIPTOR

An agent descriptor for the agent collaborator.

iv_collaboratorname TYPE /AWS1/BDANAME /AWS1/BDANAME

The collaborator's name.

iv_collaborationinstruction TYPE /AWS1/BDACOLLABORATIONINSTRU00 /AWS1/BDACOLLABORATIONINSTRU00

Instruction for the collaborator.

Optional arguments:

iv_relayconversationhistory TYPE /AWS1/BDARELAYCONVERSATIONHI00 /AWS1/BDARELAYCONVERSATIONHI00

A relay conversation history for the collaborator.

RETURNING

oo_output TYPE REF TO /aws1/cl_bdaupagentcollabora01 /AWS1/CL_BDAUPAGENTCOLLABORA01

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->updateagentcollaborator(
  io_agentdescriptor = new /aws1/cl_bdaagentdescriptor( |string| )
  iv_agentid = |string|
  iv_agentversion = |string|
  iv_collaborationinstruction = |string|
  iv_collaboratorid = |string|
  iv_collaboratorname = |string|
  iv_relayconversationhistory = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_agentcollaborator = lo_result->get_agentcollaborator( ).
  IF lo_agentcollaborator IS NOT INITIAL.
    lv_id = lo_agentcollaborator->get_agentid( ).
    lv_version = lo_agentcollaborator->get_agentversion( ).
    lo_agentdescriptor = lo_agentcollaborator->get_agentdescriptor( ).
    IF lo_agentdescriptor IS NOT INITIAL.
      lv_agentaliasarn = lo_agentdescriptor->get_aliasarn( ).
    ENDIF.
    lv_id = lo_agentcollaborator->get_collaboratorid( ).
    lv_collaborationinstructio = lo_agentcollaborator->get_collaborationinstruction( ).
    lv_name = lo_agentcollaborator->get_collaboratorname( ).
    lv_datetimestamp = lo_agentcollaborator->get_createdat( ).
    lv_datetimestamp = lo_agentcollaborator->get_lastupdatedat( ).
    lv_relayconversationhistor = lo_agentcollaborator->get_relayconversationhistory( ).
    lv_clienttoken = lo_agentcollaborator->get_clienttoken( ).
  ENDIF.
ENDIF.