Docs For Class JGithubAccount

Description

GitHub API Account class for the Joomla Platform.

since: 12.3

Located in /libraries/joomla/github/account.php (line 19)

JGithubObject
   |
   --JGithubAccount

Method Summary

object createAuthorisation ([array $scopes = array()], [string $note = ''], [string $url = ''])

object deleteAuthorisation (integer $id)

object editAuthorisation (integer $id, [array $scopes = array()], [array $addScopes = array()], [array $removeScopes = array()], [string $note = ''], [string $url = ''])

object getAuthorisation (integer $id)

object getAuthorisations ()

object getRateLimit ()

Variables

Inherited Variables

Inherited from JGithubObject

JGithubObject::$client
JGithubObject::$options

Methods

createAuthorisation (line 33)

Method to create an authorisation.

since: 12.3
throws: DomainException
access: public

object createAuthorisation ([array $scopes = array()], [string $note = ''], [string $url = ''])

array $scopes: A list of scopes that this authorisation is in.
string $note: A note to remind you what the OAuth token is for.
string $url: A URL to remind you what app the OAuth token is for.

deleteAuthorisation (line 66)

Method to delete an authorisation

since: 12.3
throws: DomainException
access: public

object deleteAuthorisation (integer $id)

integer $id: ID of the authorisation to delete

editAuthorisation (line 101)

Method to edit an authorisation.

throws: DomainException
throws: RuntimeException
since: 12.3
access: public

object editAuthorisation (integer $id, [array $scopes = array()], [array $addScopes = array()], [array $removeScopes = array()], [string $note = ''], [string $url = ''])

integer $id: ID of the authorisation to edit
array $scopes: Replaces the authorisation scopes with these.
array $addScopes: A list of scopes to add to this authorisation.
array $removeScopes: A list of scopes to remove from this authorisation.
string $note: A note to remind you what the OAuth token is for.
string $url: A URL to remind you what app the OAuth token is for.

getAuthorisation (line 167)

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

since: 12.3
throws: DomainException
access: public

object getAuthorisation (integer $id)

integer $id: ID of the authorisation to retrieve

getAuthorisations (line 195)

Method to get the authorised applications for the authenticated user.

since: 12.3
throws: DomainException
access: public

object getAuthorisations ()

getRateLimit (line 222)

Method to get the rate limit for the authenticated user.

since: 12.3
throws: DomainException
access: public

object getRateLimit ()

Inherited Methods

Inherited From JGithubObject

JGithubObject::__construct()
JGithubObject::fetchUrl()
JGithubObject::processResponse()