Authorization
扩展自 AbstractPackageJoomla 框架的 GitHub API 授权类。
| 文档 |
http://developer.github.com/v3/oauth/ http://developer.github.com/v3/oauth_authorizations/ |
|---|---|
| 注意 |
此类中的方法只能通过基本身份验证访问 |
| 自 |
1.0 |
| 包 |
Joomla 框架 |
方法
__construct
构造函数。
__construct(\Joomla\Registry\Registry options = null, \Joomla\Http\Http client = null) :
__get
延迟创建 API 对象的魔术方法
__get( name) : \Joomla\Github\AbstractPackage
create
创建授权的方法。
create(mixed||string|int scopes = [], note = '', url = '') :
| 自 |
1.0 |
|---|---|
| 抛出 |
|
参数
- scopes
array<string|int, mixed>此授权所属的范围列表。- 注意
string提醒您 OAuth 令牌用途的注释。- url
string提醒您 OAuth 令牌所属应用的 URL。
响应
对象
delete
删除授权的方法
delete( id) :
| 自 |
1.0 |
|---|---|
| 抛出 |
|
参数
- id
int要删除的授权的 ID
响应
对象
deleteGrant
删除授权
deleteGrant( id) :
删除 OAuth 应用程序的授权也将删除与该应用程序关联的用户的所有 OAuth 令牌。
| 自 |
1.5.0 |
|---|---|
| 抛出 |
|
参数
- id
int要删除的授权的 ID
响应
对象
edit
编辑授权的方法。
edit( id, mixed||string|int scopes = [], mixed||string|int addScopes = [], mixed||string|int removeScopes = [], note = '', url = '') :
| 自 |
1.0 |
|---|---|
| 抛出 |
|
参数
- id
int要编辑的授权的 ID- scopes
array<string|int, mixed>用这些替换授权范围。- addScopes
array<string|int, mixed>要添加到此授权的范围列表。- removeScopes
array<string|int, mixed>要从此授权中删除的范围列表。- 注意
string提醒您 OAuth 令牌用途的注释。- url
string提醒您 OAuth 令牌所属应用的 URL。
响应
对象
fetchUrl
构建并返回请求的完整请求 URL 的方法。如果需要，此方法将添加适当的分页详细信息，并将 API URL 添加到请求的前面，以便请求的完整 URL。
fetchUrl( path, page, limit) : \Joomla\Uri\Uri
get
获取已认证用户授权应用程序的详细信息的方法。
get( id) :
| 自 |
1.0 |
|---|---|
| 抛出 |
|
参数
- id
int要检索的授权的 ID
响应
对象
getAuthorizationLink
- 在 GitHub 上请求授权。
getAuthorizationLink( clientId, redirectUri = '', scope = '', state = '') :
| 自 |
1.0 |
|---|
参数
- clientId
string您在注册时从 GitHub 收到的客户端 ID。- redirectUri
string授权后用户将被发送到应用中的 URL。- scope
string范围的逗号分隔列表。- state
string一个不可猜测的随机字符串。它用于防止跨站点请求伪造攻击。
响应
字符串
getGrant
获取单个授权
getGrant( id) :
| 自 |
1.5.0 |
|---|---|
| 抛出 |
|
参数
- id
int要检索的授权的 ID
响应
对象
getList
获取已认证用户的授权应用程序的方法。
getList() :
| 自 |
1.0 |
|---|---|
| 抛出 |
|
响应
对象
getListGrants
列出您的授权。
getListGrants() :
您可以使用此 API 列出已授予访问您帐户权限的 OAuth 应用程序集。
| 自 |
1.5.0 |
|---|---|
| 抛出 |
|
响应
对象
getRateLimit
获取已认证用户的速率限制的方法。
getRateLimit() :
| 自 |
1.0 |
|---|---|
| 抛出 |
响应
object返回一个包含 limit 和 remaining 属性的对象。如果没有限制，则 limit 属性将为 false。
processResponse
处理响应并对其进行解码。
processResponse(\Joomla\Http\Response response, expectedCode = 200) :
requestToken
- 请求访问令牌。
requestToken( clientId, clientSecret, code, redirectUri = '', format = '') :
| 自 |
1.0 |
|---|---|
| 抛出 |
|
参数
- clientId
string您在注册时从 GitHub 收到的客户端 ID。- clientSecret
string您在注册时从 GitHub 收到的客户端密钥。- code
string您作为步骤 1 的响应收到的代码。- redirectUri
string授权后用户将被发送到应用中的 URL。- format
string响应格式（json、xml 等）。
响应
字符串
revokeGrantForApplication
撤销应用程序的授权
revokeGrantForApplication( clientId, accessToken) :
OAuth 应用程序所有者可以撤销其 OAuth 应用程序和特定用户的授权。
| 自 |
1.5.0 |
|---|---|
| 抛出 |
|
参数
- clientId
int应用程序客户端 ID- accessToken
int要撤销的访问令牌
响应
对象
属性
包
对象所在的包
| 自 |
1.0 |
|---|
类型
字符串
hookEvents
包含允许的钩子事件的数组
| 自 |
1.5.2 |
|---|---|
| link | |
| 注意 |
从 1.4.0 到 1.5.1，这命名为 $events，由于与包子类的命名冲突而被重命名 |
类型
array<string|int, mixed>