Class JGithubPackageIssuesComments

GitHub API Comments class for the Joomla Platform.

The Issue Comments API supports listing, viewing, editing, and creating comments on issues and pull requests.

JGithubPackageIssuesComments

Package: Joomla\Platform\GitHub
Deprecated: 4.0 Use the joomla/github package via Composer instead
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE
Since: 12.3
Documentation: https://developer.github.com/v3/issues/comments/
Located at joomla/github/package/issues/comments.php

Methods summary

`public array`	# `getList( string $owner, string $repo, integer $issueId, integer $page = 0, integer $limit = 0 )` Method to get the list of comments on an issue. Method to get the list of comments on an issue. Parameters `$owner` `string` - $owner The name of the owner of the GitHub repository. `$repo` `string` - $repo The name of the GitHub repository. `$issueId` `integer` - $issueId The issue 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 `DomainException` Since 11.3
`public array`	# `getRepositoryList( string $owner, string $repo, string $sort = 'created', string $direction = 'asc', JDate $since = null )` Method to get the list of comments in a repository. Method to get the list of comments in a repository. Parameters `$owner` `string` - $owner The name of the owner of the GitHub repository. `$repo` `string` - $repo The name of the GitHub repository. `$sort` `string` - $sort The sort field - created or updated. `$direction` `string` - $direction The sort order- asc or desc. Ignored without sort parameter. `$since` `JDate` - $since A timestamp in ISO 8601 format. Returns `array` Throws `UnexpectedValueException` `DomainException` Since 11.3
`public mixed`	# `get( string $owner, string $repo, integer $id )` Method to get a single comment. Method to get a single comment. Parameters `$owner` `string` - $owner The name of the owner of the GitHub repository. `$repo` `string` - $repo The name of the GitHub repository. `$id` `integer` - $id The comment id. Returns `mixed`
`public object`	# `edit( string $user, string $repo, integer $commentId, string $body )` Method to update a comment on an issue. Method to update a comment on an issue. 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 `DomainException` Since 11.3
`public object`	# `create( string $user, string $repo, integer $issueId, string $body )` Method to create a comment on an issue. Method to create a comment on an issue. Parameters `$user` `string` - $user The name of the owner of the GitHub repository. `$repo` `string` - $repo The name of the GitHub repository. `$issueId` `integer` - $issueId The issue number. `$body` `string` - $body The comment body text. Returns `object` Throws `DomainException` Since 11.3
`public boolean`	# `delete( string $user, string $repo, integer $commentId )` Method to delete a comment on an issue. Method to delete a comment on an issue. 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. Returns `boolean` Throws `DomainException` Since 11.3

Methods inherited from JGithubPackage

__get()

Methods inherited from JGithubObject

__construct(), fetchUrl(), processResponse()

Magic methods summary

Properties summary

Properties inherited from JGithubPackage

$name, $packages

Properties inherited from JGithubObject

$client, $options

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JGithubPackageIssuesComments

Methods summary

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Methods inherited from JGithubPackage

Methods inherited from JGithubObject

Magic methods summary

Properties summary

Properties inherited from JGithubPackage

Properties inherited from JGithubObject