Class JGithubPackagePullsComments
GitHub API Pulls Comments class for the Joomla Platform.
-
JGithubObject
-
JGithubPackage
-
JGithubPackagePullsComments
Methods summary
public
object
|
#
create( string $user, string $repo, integer $pullId, string $body, string $commitId, string $filePath, string $position )
Method to create a comment on a pull request.
Method to create a comment on a pull request.
Parameters
- $user
string - $user The name of the owner of the GitHub repository.- $repo
string - $repo The name of the GitHub repository.- $pullId
integer - $pullId The pull request number.- $body
string - $body The comment body text.- $commitId
string - $commitId The SHA1 hash of the commit to comment on.- $filePath
string - $filePath The Relative path of the file to comment on.- $position
string - $position The line index in the diff to comment on. Returns
object
Throws
Since
11.3
|
public
object
|
#
createReply( string $user, string $repo, integer $pullId, string $body, integer $inReplyTo )
Method to create a comment in reply to another comment.
Method to create a comment in reply to another comment.
Parameters
- $user
string - $user The name of the owner of the GitHub repository.- $repo
string - $repo The name of the GitHub repository.- $pullId
integer - $pullId The pull request number.- $body
string - $body The comment body text.- $inReplyTo
integer - $inReplyTo The id of the comment to reply to. Returns
object
Throws
Since
11.3
|
public
|
#
delete( string $user, string $repo, integer $commentId )
Method to delete a comment on a pull request.
Method to delete a comment on a pull request.
Parameters
- $user
string - $user The name of the owner of the GitHub repository.- $repo
string - $repo The name of the GitHub repository.- $commentId
integer - $commentId The id of the comment to delete. Throws
Since
11.3
|
public
object
|
#
edit( string $user, string $repo, integer $commentId, string $body )
Method to update a comment on a pull request.
Method to update a comment on a pull request.
Parameters
- $user
string - $user The name of the owner of the GitHub repository.- $repo
string - $repo The name of the GitHub repository.- $commentId
integer - $commentId The id of the comment to update.- $body
string - $body The new body text for the comment. Returns
object
Throws
Since
11.3
|
public
object
|
#
get( string $user, string $repo, integer $commentId )
Method to get a specific comment on a pull request.
Method to get a specific comment on a pull request.
Parameters
- $user
string - $user The name of the owner of the GitHub repository.- $repo
string - $repo The name of the GitHub repository.- $commentId
integer - $commentId The comment id to get. Returns
object
Throws
Since
11.3
|
public
array
|
#
getList( string $user, string $repo, integer $pullId, integer $page = 0, integer $limit = 0 )
Method to get the list of comments on a pull request.
Method to get the list of comments on a pull request.
Parameters
- $user
string - $user The name of the owner of the GitHub repository.- $repo
string - $repo The name of the GitHub repository.- $pullId
integer - $pullId The pull request number.- $page
integer - $page The page number from which to get items.- $limit
integer - $limit The number of items on a page. Returns
array
Throws
Since
11.3
|
__get()
__construct(),
fetchUrl(),
processResponse()
Magic methods summary
Properties summary
$name,
$packages
$client,
$options
