Class JGithubPackageGistsComments

GitHub API Gists Comments class for the Joomla Platform.

JGithubPackageGistsComments

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: 3.3 (CMS)
Documentation: https://developer.github.com/v3/gists/comments/
Located at joomla/github/package/gists/comments.php

Methods summary

`public object`	# `create( integer $gistId, string $body )` Method to create a comment on a gist. Method to create a comment on a gist. Parameters `$gistId` `integer` - $gistId The gist number. `$body` `string` - $body The comment body text. Returns `object` Throws `DomainException` Since 11.3
`public`	# `delete( integer $commentId )` Method to delete a comment on a gist. Method to delete a comment on a gist. Parameters `$commentId` `integer` - $commentId The id of the comment to delete. Throws `DomainException` Since 11.3
`public object`	# `edit( integer $commentId, string $body )` Method to update a comment on a gist. Method to update a comment on a gist. Parameters `$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`	# `get( integer $commentId )` Method to get a specific comment on a gist. Method to get a specific comment on a gist. Parameters `$commentId` `integer` - $commentId The comment id to get. Returns `object` Throws `DomainException` Since 11.3
`public array`	# `getList( integer $gistId, integer $page = 0, integer $limit = 0 )` Method to get the list of comments on a gist. Method to get the list of comments on a gist. Parameters `$gistId` `integer` - $gistId The gist 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

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 JGithubPackageGistsComments

Methods summary

Parameters

Returns

Throws

Since

Parameters

Throws

Since

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