Class JGithubAccount

GitHub API Account class for the Joomla Platform.

JGithubAccount

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: 12.3
Located at joomla/github/account.php

Methods summary

`public object`	# `createAuthorisation( array $scopes = array(), string $note = '', string $url = '' )` Method to create an authorisation. Method to create an authorisation. Parameters `$scopes` `array` - $scopes A list of scopes that this authorisation is in. `$note` `string` - $note A note to remind you what the OAuth token is for. `$url` `string` - $url A URL to remind you what app the OAuth token is for. Returns `object` Throws `DomainException` Since 12.3
`public object`	# `deleteAuthorisation( integer $id )` Method to delete an authorisation Method to delete an authorisation Parameters `$id` `integer` - $id ID of the authorisation to delete Returns `object` Throws `DomainException` Since 12.3
`public object`	# `editAuthorisation( integer $id, array $scopes = array(), array $addScopes = array(), array $removeScopes = array(), string $note = '', string $url = '' )` Method to edit an authorisation. Method to edit an authorisation. Parameters `$id` `integer` - $id ID of the authorisation to edit `$scopes` `array` - $scopes Replaces the authorisation scopes with these. `$addScopes` `array` - $addScopes A list of scopes to add to this authorisation. `$removeScopes` `array` - $removeScopes A list of scopes to remove from this authorisation. `$note` `string` - $note A note to remind you what the OAuth token is for. `$url` `string` - $url A URL to remind you what app the OAuth token is for. Returns `object` Throws `DomainException` `RuntimeException` Since 12.3
`public object`	# `getAuthorisation( integer $id )` Method to get details about an authorised application for the authenticated user. Method to get details about an authorised application for the authenticated user. Parameters `$id` `integer` - $id ID of the authorisation to retrieve Returns `object` Throws `DomainException` Since 12.3 Note This method will only accept Basic Authentication
`public object`	# `getAuthorisations( )` Method to get the authorised applications for the authenticated user. Method to get the authorised applications for the authenticated user. Returns `object` Throws `DomainException` Since 12.3 Note This method will only accept Basic Authentication
`public object`	# `getRateLimit( )` Method to get the rate limit for the authenticated user. Method to get the rate limit for the authenticated user. Returns `object` Throws `DomainException` Since 12.3

Methods inherited from JGithubObject

__construct(), fetchUrl(), processResponse()

Magic methods summary

Properties summary

Properties inherited from JGithubObject

$client, $options

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JGithubAccount

Methods summary

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Note

Returns

Throws

Since

Note

Returns

Throws

Since

Methods inherited from JGithubObject

Magic methods summary

Properties summary

Properties inherited from JGithubObject