JGithubPackageGistsComments

class JGithubPackageGistsComments extends JGithubPackage

GitHub API Gists Comments class for the Joomla Platform.

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
create( integer $gistId, string $body)

Method to create a comment on a gist.

void
delete( integer $commentId)

Method to delete a comment on a gist.

object
edit( integer $commentId, string $body)

Method to update a comment on a gist.

object
get( integer $commentId)

Method to get a specific comment on a gist.

array
getList( integer $gistId, integer $page, integer $limit)

Method to get the list of comments on a gist.

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 create( integer $gistId, string $body)

Method to create a comment on a gist.

Parameters

integer $gistId The gist number.
string $body The comment body text.

Return Value

object

Exceptions

DomainException

void delete( integer $commentId)

Method to delete a comment on a gist.

Parameters

integer $commentId The id of the comment to delete.

Return Value

void

Exceptions

DomainException

object edit( integer $commentId, string $body)

Method to update a comment on a gist.

Parameters

integer $commentId The id of the comment to update.
string $body The new body text for the comment.

Return Value

object

Exceptions

DomainException

object get( integer $commentId)

Method to get a specific comment on a gist.

Parameters

integer $commentId The comment id to get.

Return Value

object

Exceptions

DomainException

array getList( integer $gistId, integer $page, integer $limit)

Method to get the list of comments on a gist.

Parameters

integer $gistId The gist number.
integer $page The page number from which to get items.
integer $limit The number of items on a page.

Return Value

array

Exceptions

DomainException