DESCRIBECOMMENTS()`¶

About DescribeComments¶

List all the comments for the specified document version.

Method Signature¶

METHODS /AWS1/IF_WDX~DESCRIBECOMMENTS
  IMPORTING
    !IV_AUTHENTICATIONTOKEN TYPE /AWS1/WDXAUTHNTCTNHEADERTYPE OPTIONAL
    !IV_DOCUMENTID TYPE /AWS1/WDXRESOURCEIDTYPE OPTIONAL
    !IV_VERSIONID TYPE /AWS1/WDXDOCUMENTVERSIONIDTYPE OPTIONAL
    !IV_LIMIT TYPE /AWS1/WDXLIMITTYPE OPTIONAL
    !IV_MARKER TYPE /AWS1/WDXMARKERTYPE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_wdxdescrcommentsrsp
  RAISING
    /AWS1/CX_WDXENTITYNOTEXISTSEX
    /AWS1/CX_WDXFAILEDDEPENDENCYEX
    /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.

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_limit` `TYPE /AWS1/WDXLIMITTYPE` `/AWS1/WDXLIMITTYPE`¶

The maximum number of items to return.

`iv_marker` `TYPE /AWS1/WDXMARKERTYPE` `/AWS1/WDXMARKERTYPE`¶

The marker for the next set of results. This marker was received from a previous call.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_wdxdescrcommentsrsp` `/AWS1/CL_WDXDESCRCOMMENTSRSP`¶

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->describecomments(
  iv_authenticationtoken = |string|
  iv_documentid = |string|
  iv_limit = 123
  iv_marker = |string|
  iv_versionid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_comments( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_commentidtype = lo_row_1->get_commentid( ).
      lv_commentidtype = lo_row_1->get_parentid( ).
      lv_commentidtype = lo_row_1->get_threadid( ).
      lv_commenttexttype = lo_row_1->get_text( ).
      lo_user = lo_row_1->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_row_1->get_createdtimestamp( ).
      lv_commentstatustype = lo_row_1->get_status( ).
      lv_commentvisibilitytype = lo_row_1->get_visibility( ).
      lv_idtype = lo_row_1->get_recipientid( ).
    ENDIF.
  ENDLOOP.
  lv_markertype = lo_result->get_marker( ).
ENDIF.

/AWS1/IF_WDX=>DESCRIBECOMMENTS()¶