CREATECHAT()`¶

About CreateChat¶

Creates a new chat execution in the specified agent space

Method Signature¶

METHODS /AWS1/IF_DOA~CREATECHAT
  IMPORTING
    !IV_AGENTSPACEID TYPE /AWS1/DOAAGENTSPACEID OPTIONAL
    !IV_USERID TYPE /AWS1/DOARESOURCEID OPTIONAL
    !IV_USERTYPE TYPE /AWS1/DOAUSERTYPE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_doacreatechatresponse
  RAISING
    /AWS1/CX_DOAACCESSDENIEDEX
    /AWS1/CX_DOACONFLICTEXCEPTION
    /AWS1/CX_DOACONTENTSIZEEXCDEX
    /AWS1/CX_DOAINTERNALSERVEREX
    /AWS1/CX_DOAINVALIDPARAMETEREX
    /AWS1/CX_DOARESOURCENOTFOUNDEX
    /AWS1/CX_DOASERVICEQUOTAEXCDEX
    /AWS1/CX_DOATHROTTLINGEX
    /AWS1/CX_DOAVLDTNEXCEPTION
    /AWS1/CX_DOACLIENTEXC
    /AWS1/CX_DOASERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_agentspaceid` `TYPE /AWS1/DOAAGENTSPACEID` `/AWS1/DOAAGENTSPACEID`¶

Unique identifier for an agent space (allows alphanumeric characters and hyphens; 1-64 characters)

Optional arguments:¶

`iv_userid` `TYPE /AWS1/DOARESOURCEID` `/AWS1/DOARESOURCEID`¶

The user identifier for the chat. This field is deprecated and will be ignored — the service resolves user identity from the authenticated session.

`iv_usertype` `TYPE /AWS1/DOAUSERTYPE` `/AWS1/DOAUSERTYPE`¶

The authentication type of the user

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_doacreatechatresponse` `/AWS1/CL_DOACREATECHATRESPONSE`¶

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->createchat(
  iv_agentspaceid = |string|
  iv_userid = |string|
  iv_usertype = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_resourceid = lo_result->get_executionid( ).
  lv_timestamp = lo_result->get_createdat( ).
ENDIF.

/AWS1/IF_DOA=>CREATECHAT()¶