Skip to content

/AWS1/IF_CMT=>GETCOMMENTSFORPULLREQUEST()

About GetCommentsForPullRequest

Returns comments made on a pull request.

Reaction counts might include numbers from user identities who were deleted after the reaction was made. For a count of reactions from active identities, use GetCommentReactions.

Method Signature

METHODS /AWS1/IF_CMT~GETCOMMENTSFORPULLREQUEST
  IMPORTING
    !IV_PULLREQUESTID TYPE /AWS1/CMTPULLREQUESTID OPTIONAL
    !IV_REPOSITORYNAME TYPE /AWS1/CMTREPOSITORYNAME OPTIONAL
    !IV_BEFORECOMMITID TYPE /AWS1/CMTCOMMITID OPTIONAL
    !IV_AFTERCOMMITID TYPE /AWS1/CMTCOMMITID OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/CMTNEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/CMTMAXRESULTS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cmtgetcommentsforpu01
  RAISING
    /AWS1/CX_CMTCOMMITDOESNOTEXEX
    /AWS1/CX_CMTCOMMITIDREQUIREDEX
    /AWS1/CX_CMTENCINTEGRITYCHXF00
    /AWS1/CX_CMTENCKEYACCDENIEDEX
    /AWS1/CX_CMTENCKEYDISABLEDEX
    /AWS1/CX_CMTENCKEYNOTFOUNDEX
    /AWS1/CX_CMTENCKEYUNAVAILEX
    /AWS1/CX_CMTINVALIDCOMMITIDEX
    /AWS1/CX_CMTINVCONTINUATIONT00
    /AWS1/CX_CMTINVMAXRESULTSEX
    /AWS1/CX_CMTINVPULLREQUESTIDEX
    /AWS1/CX_CMTINVREPOSITORYNAM00
    /AWS1/CX_CMTPULLREQDOESNOTEXEX
    /AWS1/CX_CMTPULLREQIDREQUIRE00
    /AWS1/CX_CMTREPOSITORYDOESNO00
    /AWS1/CX_CMTREPOSITORYNAMERE00
    /AWS1/CX_CMTREPOSITORYNOTASC00
    /AWS1/CX_CMTCLIENTEXC
    /AWS1/CX_CMTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_pullrequestid TYPE /AWS1/CMTPULLREQUESTID /AWS1/CMTPULLREQUESTID

The system-generated ID of the pull request. To get this ID, use ListPullRequests.

Optional arguments:

iv_repositoryname TYPE /AWS1/CMTREPOSITORYNAME /AWS1/CMTREPOSITORYNAME

The name of the repository that contains the pull request. Requirement is conditional: repositoryName must be specified when beforeCommitId and afterCommitId are included.

iv_beforecommitid TYPE /AWS1/CMTCOMMITID /AWS1/CMTCOMMITID

The full commit ID of the commit in the destination branch that was the tip of the branch at the time the pull request was created. Requirement is conditional: beforeCommitId must be specified when repositoryName is included.

iv_aftercommitid TYPE /AWS1/CMTCOMMITID /AWS1/CMTCOMMITID

The full commit ID of the commit in the source branch that was the tip of the branch at the time the comment was made. Requirement is conditional: afterCommitId must be specified when repositoryName is included.

iv_nexttoken TYPE /AWS1/CMTNEXTTOKEN /AWS1/CMTNEXTTOKEN

An enumeration token that, when provided in a request, returns the next batch of the results.

iv_maxresults TYPE /AWS1/CMTMAXRESULTS /AWS1/CMTMAXRESULTS

A non-zero, non-negative integer used to limit the number of returned results. The default is 100 comments. You can return up to 500 comments with a single request.

RETURNING

oo_output TYPE REF TO /aws1/cl_cmtgetcommentsforpu01 /AWS1/CL_CMTGETCOMMENTSFORPU01

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->getcommentsforpullrequest(
  iv_aftercommitid = |string|
  iv_beforecommitid = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_pullrequestid = |string|
  iv_repositoryname = |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_commentsforpullreqdata( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_pullrequestid = lo_row_1->get_pullrequestid( ).
      lv_repositoryname = lo_row_1->get_repositoryname( ).
      lv_commitid = lo_row_1->get_beforecommitid( ).
      lv_commitid = lo_row_1->get_aftercommitid( ).
      lv_objectid = lo_row_1->get_beforeblobid( ).
      lv_objectid = lo_row_1->get_afterblobid( ).
      lo_location = lo_row_1->get_location( ).
      IF lo_location IS NOT INITIAL.
        lv_path = lo_location->get_filepath( ).
        lv_position = lo_location->get_fileposition( ).
        lv_relativefileversionenum = lo_location->get_relativefileversion( ).
      ENDIF.
      LOOP AT lo_row_1->get_comments( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_commentid = lo_row_3->get_commentid( ).
          lv_content = lo_row_3->get_content( ).
          lv_commentid = lo_row_3->get_inreplyto( ).
          lv_creationdate = lo_row_3->get_creationdate( ).
          lv_lastmodifieddate = lo_row_3->get_lastmodifieddate( ).
          lv_arn = lo_row_3->get_authorarn( ).
          lv_iscommentdeleted = lo_row_3->get_deleted( ).
          lv_clientrequesttoken = lo_row_3->get_clientrequesttoken( ).
          LOOP AT lo_row_3->get_callerreactions( ) into lo_row_4.
            lo_row_5 = lo_row_4.
            IF lo_row_5 IS NOT INITIAL.
              lv_reactionvalue = lo_row_5->get_value( ).
            ENDIF.
          ENDLOOP.
          LOOP AT lo_row_3->get_reactioncounts( ) into ls_row_6.
            lv_key = ls_row_6-key.
            lo_value = ls_row_6-value.
            IF lo_value IS NOT INITIAL.
              lv_count = lo_value->get_value( ).
            ENDIF.
          ENDLOOP.
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.