Class Github\Api\Issue\Comments

InheritanceGithub\Api\Issue\Comments » Github\Api\AbstractApi
ImplementsGithub\Api\ApiInterface

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__construct() Github\Api\AbstractApi
all() Get all comments for an issue. Github\Api\Issue\Comments
configure() Configure the body type. Github\Api\Issue\Comments
create() Create a comment for an issue. Github\Api\Issue\Comments
getPerPage() Github\Api\AbstractApi
remove() Delete a comment for an issue. Github\Api\Issue\Comments
setPerPage() Github\Api\AbstractApi
show() Get a comment for an issue. Github\Api\Issue\Comments
update() Update a comment for an issue. Github\Api\Issue\Comments

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
createJsonBody() Create a JSON encoded version of an array of parameters. Github\Api\AbstractApi
delete() Send a DELETE request with JSON-encoded parameters. Github\Api\AbstractApi
get() Send a GET request with query parameters. Github\Api\AbstractApi
head() Send a HEAD request with query parameters. Github\Api\AbstractApi
patch() Send a PATCH request with JSON-encoded parameters. Github\Api\AbstractApi
post() Send a POST request with JSON-encoded parameters. Github\Api\AbstractApi
postRaw() Send a POST request with raw data. Github\Api\AbstractApi
put() Send a PUT request with JSON-encoded parameters. Github\Api\AbstractApi

Method Details

all() public method

Get all comments for an issue.

public array all ( $username, $repository, $issue, $page 1 )
$username string
$repository string
$issue int
$page int
configure() public method

Configure the body type.

public void configure ( $bodyType null )
$bodyType string|null
create() public method

Create a comment for an issue.

public array create ( $username, $repository, $issue, array $params )
$username string
$repository string
$issue int
$params array
throws Github\Exception\MissingArgumentException
remove() public method

Delete a comment for an issue.

public array remove ( $username, $repository, $comment )
$username string
$repository string
$comment int
show() public method

Get a comment for an issue.

public array show ( $username, $repository, $comment )
$username string
$repository string
$comment int
update() public method

Update a comment for an issue.

public array update ( $username, $repository, $comment, array $params )
$username string
$repository string
$comment int
$params array
throws Github\Exception\MissingArgumentException