JGithubAccount

class JGithubAccount extends JGithubObject

GitHub API Account class for the Joomla Platform.

Methods

__construct( Registry $options = null, JGithubHttp $client = null)

Constructor.

from JGithubObject
object
createAuthorisation( array $scopes = array(), string $note = '', string $url = '')

Method to create an authorisation.

object
deleteAuthorisation( integer $id)

Method to delete an authorisation

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

Method to edit an authorisation.

object
getAuthorisation( integer $id)

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

object
getAuthorisations()

Method to get the authorised applications for the authenticated user.

object
getRateLimit()

Method to get the rate limit for the authenticated user.

Details

__construct( Registry $options = null, JGithubHttp $client = null)

Constructor.

Parameters

Registry $options GitHub options object.
JGithubHttp $client The HTTP client object.

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

Method to create an authorisation.

Parameters

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.

Return Value

object

Exceptions

DomainException

object deleteAuthorisation( integer $id)

Method to delete an authorisation

Parameters

integer $id ID of the authorisation to delete

Return Value

object

Exceptions

DomainException

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

Method to edit an authorisation.

Parameters

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.

Return Value

object

Exceptions

DomainException
RuntimeException

object getAuthorisation( integer $id)

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

Parameters

integer $id ID of the authorisation to retrieve

Return Value

object

Exceptions

DomainException

object getAuthorisations()

Method to get the authorised applications for the authenticated user.

Return Value

object

Exceptions

DomainException

object getRateLimit()

Method to get the rate limit for the authenticated user.

Return Value

object

Exceptions

DomainException