Skip to content

/AWS1/IF_WDX=>CREATECOMMENT()

About CreateComment

Adds a new comment to the specified document version.

Method Signature

METHODS /AWS1/IF_WDX~CREATECOMMENT
  IMPORTING
    !IV_AUTHENTICATIONTOKEN TYPE /AWS1/WDXAUTHNTCTNHEADERTYPE OPTIONAL
    !IV_DOCUMENTID TYPE /AWS1/WDXRESOURCEIDTYPE OPTIONAL
    !IV_VERSIONID TYPE /AWS1/WDXDOCUMENTVERSIONIDTYPE OPTIONAL
    !IV_PARENTID TYPE /AWS1/WDXCOMMENTIDTYPE OPTIONAL
    !IV_THREADID TYPE /AWS1/WDXCOMMENTIDTYPE OPTIONAL
    !IV_TEXT TYPE /AWS1/WDXCOMMENTTEXTTYPE OPTIONAL
    !IV_VISIBILITY TYPE /AWS1/WDXCOMMENTVISIBILITYTYPE OPTIONAL
    !IV_NOTIFYCOLLABORATORS TYPE /AWS1/WDXBOOLEANTYPE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_wdxcreatecommentrsp
  RAISING
    /AWS1/CX_WDXDOCLKEDFORCOMMEN00
    /AWS1/CX_WDXENTITYNOTEXISTSEX
    /AWS1/CX_WDXFAILEDDEPENDENCYEX
    /AWS1/CX_WDXINVALIDCOMMENTOPEX
    /AWS1/CX_WDXPROHIBITEDSTATEEX
    /AWS1/CX_WDXSERVICEUNAVAILEX
    /AWS1/CX_WDXUNAUTHDOPERATIONEX
    /AWS1/CX_WDXUNAUTHDRESRCACCEX
    /AWS1/CX_WDXCLIENTEXC
    /AWS1/CX_WDXSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_documentid TYPE /AWS1/WDXRESOURCEIDTYPE /AWS1/WDXRESOURCEIDTYPE

The ID of the document.

iv_versionid TYPE /AWS1/WDXDOCUMENTVERSIONIDTYPE /AWS1/WDXDOCUMENTVERSIONIDTYPE

The ID of the document version.

iv_text TYPE /AWS1/WDXCOMMENTTEXTTYPE /AWS1/WDXCOMMENTTEXTTYPE

The text of the comment.

Optional arguments:

iv_authenticationtoken TYPE /AWS1/WDXAUTHNTCTNHEADERTYPE /AWS1/WDXAUTHNTCTNHEADERTYPE

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

iv_parentid TYPE /AWS1/WDXCOMMENTIDTYPE /AWS1/WDXCOMMENTIDTYPE

The ID of the parent comment.

iv_threadid TYPE /AWS1/WDXCOMMENTIDTYPE /AWS1/WDXCOMMENTIDTYPE

The ID of the root comment in the thread.

iv_visibility TYPE /AWS1/WDXCOMMENTVISIBILITYTYPE /AWS1/WDXCOMMENTVISIBILITYTYPE

The visibility of the comment. Options are either PRIVATE, where the comment is visible only to the comment author and document owner and co-owners, or PUBLIC, where the comment is visible to document owners, co-owners, and contributors.

iv_notifycollaborators TYPE /AWS1/WDXBOOLEANTYPE /AWS1/WDXBOOLEANTYPE

Set this parameter to TRUE to send an email out to the document collaborators after the comment is created.

RETURNING

oo_output TYPE REF TO /aws1/cl_wdxcreatecommentrsp /AWS1/CL_WDXCREATECOMMENTRSP

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->createcomment(
  iv_authenticationtoken = |string|
  iv_documentid = |string|
  iv_notifycollaborators = ABAP_TRUE
  iv_parentid = |string|
  iv_text = |string|
  iv_threadid = |string|
  iv_versionid = |string|
  iv_visibility = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_comment = lo_result->get_comment( ).
  IF lo_comment IS NOT INITIAL.
    lv_commentidtype = lo_comment->get_commentid( ).
    lv_commentidtype = lo_comment->get_parentid( ).
    lv_commentidtype = lo_comment->get_threadid( ).
    lv_commenttexttype = lo_comment->get_text( ).
    lo_user = lo_comment->get_contributor( ).
    IF lo_user IS NOT INITIAL.
      lv_idtype = lo_user->get_id( ).
      lv_usernametype = lo_user->get_username( ).
      lv_emailaddresstype = lo_user->get_emailaddress( ).
      lv_userattributevaluetype = lo_user->get_givenname( ).
      lv_userattributevaluetype = lo_user->get_surname( ).
      lv_idtype = lo_user->get_organizationid( ).
      lv_resourceidtype = lo_user->get_rootfolderid( ).
      lv_resourceidtype = lo_user->get_recyclebinfolderid( ).
      lv_userstatustype = lo_user->get_status( ).
      lv_usertype = lo_user->get_type( ).
      lv_timestamptype = lo_user->get_createdtimestamp( ).
      lv_timestamptype = lo_user->get_modifiedtimestamp( ).
      lv_timezoneidtype = lo_user->get_timezoneid( ).
      lv_localetype = lo_user->get_locale( ).
      lo_userstoragemetadata = lo_user->get_storage( ).
      IF lo_userstoragemetadata IS NOT INITIAL.
        lv_sizetype = lo_userstoragemetadata->get_storageutilizedinbytes( ).
        lo_storageruletype = lo_userstoragemetadata->get_storagerule( ).
        IF lo_storageruletype IS NOT INITIAL.
          lv_positivesizetype = lo_storageruletype->get_storageallocatedinbytes( ).
          lv_storagetype = lo_storageruletype->get_storagetype( ).
        ENDIF.
      ENDIF.
    ENDIF.
    lv_timestamptype = lo_comment->get_createdtimestamp( ).
    lv_commentstatustype = lo_comment->get_status( ).
    lv_commentvisibilitytype = lo_comment->get_visibility( ).
    lv_idtype = lo_comment->get_recipientid( ).
  ENDIF.
ENDIF.