Skip to content

/AWS1/IF_GST=>CANCELCONTACT()

About CancelContact

Cancels or stops a contact with a specified contact ID based on its position in the contact lifecycle.

For contacts that:

  • Have yet to start, the contact will be cancelled.

  • Have started but have yet to finish, the contact will be stopped.

Method Signature

METHODS /AWS1/IF_GST~CANCELCONTACT
  IMPORTING
    !IV_CONTACTID TYPE /AWS1/GSTUUID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_gstcontactidresponse
  RAISING
    /AWS1/CX_GSTDEPENDENCYEX
    /AWS1/CX_GSTINVALIDPARAMETEREX
    /AWS1/CX_GSTRESOURCENOTFOUNDEX
    /AWS1/CX_GSTCLIENTEXC
    /AWS1/CX_GSTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_contactid TYPE /AWS1/GSTUUID /AWS1/GSTUUID

UUID of a contact.

RETURNING

oo_output TYPE REF TO /aws1/cl_gstcontactidresponse /AWS1/CL_GSTCONTACTIDRESPONSE

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->cancelcontact( |string| ).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_uuid = lo_result->get_contactid( ).
ENDIF.