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 JGithubAccount
+ Graphe d'héritage de JGithubAccount:

Fonctions membres publiques

 createAuthorisation (array $scopes=array(), $note='', $url='')
 
 deleteAuthorisation ($id)
 
 editAuthorisation ($id, array $scopes=array(), array $addScopes=array(), array $removeScopes=array(), $note='', $url='')
 
 getAuthorisation ($id)
 
 getAuthorisations ()
 
 getRateLimit ()
 
- 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 JGithubObject
 $options
 
 $client
 

Description détaillée

GitHub API Account class for the Joomla Platform.

Depuis
3.1.4
Obsolète:
4.0 Use the joomla/github package via Composer instead

Documentation des fonctions membres

◆ createAuthorisation()

createAuthorisation ( array  $scopes = array(),
  $note = '',
  $url = '' 
)

Method to create an authorisation.

Paramètres
array$scopesA list of scopes that this authorisation is in.
string$noteA note to remind you what the OAuth token is for.
string$urlA URL to remind you what app the OAuth token is for.
Obsolète:
use authorization->create()
Renvoie
object
Depuis
3.1.4
Exceptions
DomainException

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

◆ deleteAuthorisation()

deleteAuthorisation (   $id)

Method to delete an authorisation

Paramètres
integer$idID of the authorisation to delete
Obsolète:
use authorization->delete()
Renvoie
object
Depuis
3.1.4
Exceptions
DomainException

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

◆ editAuthorisation()

editAuthorisation (   $id,
array  $scopes = array(),
array  $addScopes = array(),
array  $removeScopes = array(),
  $note = '',
  $url = '' 
)

Method to edit an authorisation.

Paramètres
integer$idID of the authorisation to edit
array$scopesReplaces the authorisation scopes with these.
array$addScopesA list of scopes to add to this authorisation.
array$removeScopesA list of scopes to remove from this authorisation.
string$noteA note to remind you what the OAuth token is for.
string$urlA URL to remind you what app the OAuth token is for.
Obsolète:
use authorization->edit()
Renvoie
object
Depuis
3.1.4
Exceptions
DomainException
RuntimeException

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

◆ getAuthorisation()

getAuthorisation (   $id)

Method to get details about an authorised application for the authenticated user.

Paramètres
integer$idID of the authorisation to retrieve
Obsolète:
use authorization->get()
Renvoie
object
Depuis
3.1.4
Note
This method will only accept Basic Authentication
Exceptions
DomainException

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

◆ getAuthorisations()

getAuthorisations ( )

Method to get the authorised applications for the authenticated user.

Obsolète:
use authorization->getList()
Renvoie
object
Depuis
3.1.4
Exceptions
DomainException
Note
This method will only accept Basic Authentication

Références $path.

◆ getRateLimit()

getRateLimit ( )

Method to get the rate limit for the authenticated user.

Obsolète:
use authorization->getRateLimit()
Renvoie
object
Depuis
3.1.4
Exceptions
DomainException

Références $path.


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