Joomla CMS  3.10.11 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.10.11 et du framework Joomla Platform intégré
Tout Structures de données Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe JGithubPackageGistsComments
+ Graphe d'héritage de JGithubPackageGistsComments:

Fonctions membres publiques

 create ($gistId, $body)
 
 delete ($commentId)
 
 edit ($commentId, $body)
 
 get ($commentId)
 
 getList ($gistId, $page=0, $limit=0)
 
- Fonctions membres publiques hérités de JGithubPackage
 __get ($name)
 
- Fonctions membres publiques hérités de JGithubObject
 __construct (Registry $options=null, JGithubHttp $client=null)
 

Membres hérités additionnels

- Fonctions membres protégées hérités de JGithubObject
 fetchUrl ($path, $page=0, $limit=0)
 
 processResponse (JHttpResponse $response, $expectedCode=200, $decode=true)
 
- Attributs protégés hérités de JGithubPackage
 $name = ''
 
 $packages = array()
 
- Attributs protégés hérités de JGithubObject
 $options
 
 $client
 

Description détaillée

GitHub API Gists Comments class for the Joomla Platform.

https://developer.github.com/v3/gists/comments/

Depuis
3.3 (CMS)
Obsolète:
4.0 Use the joomla/github package via Composer instead

Documentation des fonctions membres

◆ create()

create (   $gistId,
  $body 
)

Method to create a comment on a gist.

Paramètres
integer$gistIdThe gist number.
string$bodyThe comment body text.
Exceptions
DomainException
Depuis
1.7.3
Renvoie
object

Références $data, $path, et json_encode.

◆ delete()

delete (   $commentId)

Method to delete a comment on a gist.

Paramètres
integer$commentIdThe id of the comment to delete.
Exceptions
DomainException
Depuis
1.7.3
Renvoie
void

Références $path.

◆ edit()

edit (   $commentId,
  $body 
)

Method to update a comment on a gist.

Paramètres
integer$commentIdThe id of the comment to update.
string$bodyThe new body text for the comment.
Exceptions
DomainException
Depuis
1.7.3
Renvoie
object

Références $data, $path, et json_encode.

◆ get()

get (   $commentId)

Method to get a specific comment on a gist.

Paramètres
integer$commentIdThe comment id to get.
Exceptions
DomainException
Depuis
1.7.3
Renvoie
object

Références $path.

◆ getList()

getList (   $gistId,
  $page = 0,
  $limit = 0 
)

Method to get the list of comments on a gist.

Paramètres
integer$gistIdThe gist number.
integer$pageThe page number from which to get items.
integer$limitThe number of items on a page.
Exceptions
DomainException
Depuis
1.7.3
Renvoie
array

Références $limit, et $path.


La documentation de cette classe a été générée à partir du fichier suivant :