JGithubPackageIssuesEvents

class JGithubPackageIssuesEvents extends JGithubPackage

GitHub API Issues Events class for the Joomla Platform.

Records various events that occur around an Issue or Pull Request. This is useful both for display on issue/pull request information pages and also to determine who should be notified of comments.

Methods

__construct( Registry $options = null, JGithubHttp $client = null)

Constructor.

from JGithubObject
JGithubPackage
__get( string $name)

Magic method to lazily create API objects

from JGithubPackage
object
getList( string $owner, string $repo, integer $issue_number, integer $page, integer $limit)

List events for an issue.

object
getListRepository( string $owner, string $repo, integer $issueId, integer $page, integer $limit)

List events for a repository.

object
get( string $owner, string $repo, integer $id)

Get a single event.

Details

__construct( Registry $options = null, JGithubHttp $client = null)

Constructor.

Parameters

Registry $options GitHub options object.
JGithubHttp $client The HTTP client object.

JGithubPackage __get( string $name)

Magic method to lazily create API objects

Parameters

string $name Name of property to retrieve

Return Value

JGithubPackage GitHub API package object.

Exceptions

RuntimeException

object getList( string $owner, string $repo, integer $issue_number, integer $page, integer $limit)

List events for an issue.

Parameters

string $owner The name of the owner of the GitHub repository.
string $repo The name of the GitHub repository.
integer $issue_number The issue number.
integer $page The page number from which to get items.
integer $limit The number of items on a page.

Return Value

object

object getListRepository( string $owner, string $repo, integer $issueId, integer $page, integer $limit)

List events for a repository.

Parameters

string $owner The name of the owner of the GitHub repository.
string $repo The name of the GitHub repository.
integer $issueId The issue number.
integer $page The page number from which to get items.
integer $limit The number of items on a page.

Return Value

object

object get( string $owner, string $repo, integer $id)

Get a single event.

Parameters

string $owner The name of the owner of the GitHub repository.
string $repo The name of the GitHub repository.
integer $id The event number.

Return Value

object