Hooks
扩展 AbstractPackageJoomla 框架的 GitHub API 组织钩子类。
对组织 webhook 的所有操作都需要经过身份验证的用户是所管理组织的管理员。此外，OAuth 令牌需要 "admin:org_hook" 范围。
| 链接 | |
|---|---|
| 自 |
1.4.0 |
| 包 |
Joomla 框架 |
方法
__construct
构造函数。
__construct(\Joomla\Registry\Registry options = null, \Joomla\Http\Http client = null) :
__get
延迟创建 API 对象的魔术方法
__get( name) : \Joomla\Github\AbstractPackage
create
创建一个钩子。
create( org, url, contentType = 'form', secret = null, insecureSsl = false, mixed||string|int events = ['push'], active = true) :
| 自 |
1.4.0 |
|---|---|
| 抛出 |
|
参数
- org
string组织的名称。- url
string将传递有效负载的 URL。- contentType
string用于序列化有效负载的媒体类型。支持的值包括 "json" 和 "form"。- secret
string如果提供，则有效负载将使用 X-Hub-Signature 标头传递。此标头的值计算为 [使用密钥作为 secret 的主体HMAC 十六进制摘要][hub-signature]。- insecureSsl
bool确定在传递有效负载时是否验证 url 主机的 SSL 证书。如果为 false，则执行验证。如果为 true，则不执行验证。- events
array<string|int, mixed>确定触发钩子的事件。- active
bool确定钩子是否在推送时实际触发。
响应
object
delete
删除一个钩子。
delete( org, id) :
| 自 |
1.4.0 |
|---|
参数
- org
string组织的名称- id
int要删除的钩子的 ID
响应
object
edit
编辑一个钩子。
edit( org, url, contentType = null, secret = null, insecureSsl = null, mixed||string|int events = [], active = null) :
| 自 |
1.4.0 |
|---|---|
| 抛出 |
|
参数
- org
string组织的名称。- url
string将传递有效负载的 URL。- contentType
string用于序列化有效负载的媒体类型。支持的值包括 "json" 和 "form"。- secret
string如果提供，则有效负载将使用 X-Hub-Signature 标头传递。此标头的值计算为 [使用密钥作为 secret 的主体HMAC 十六进制摘要][hub-signature]。- insecureSsl
bool确定在传递有效负载时是否验证 url 主机的 SSL 证书。如果为 false，则执行验证。如果为 true，则不执行验证。- events
array<string|int, mixed>确定触发钩子的事件。- active
bool确定钩子是否在推送时实际触发。
响应
object
fetchUrl
用于构建和返回请求完整 URL 的方法。此方法将根据需要添加适当的分页详细信息，并将 API URL 添加到请求的完整 URL。
fetchUrl( path, page, limit) : \Joomla\Uri\Uri
get
获取单个钩子。
get( org, id) :
| 自 |
1.4.0 |
|---|
参数
- org
string组织的名称。- id
int钩子 ID。
响应
object
getList
列出钩子。
getList( org) :
| 自 |
1.4.0 |
|---|
参数
- org
string组织的名称。
响应
object
ping
ping 一个钩子。
ping( org, id) :
| 自 |
1.4.0 |
|---|---|
| 抛出 |
|
参数
- org
string组织的名称- id
int要 ping 的钩子的 ID
响应
object
processResponse
处理响应并对其进行解码。
processResponse(\Joomla\Http\Response response, expectedCode = 200) :
属性
包
对象所在的包
| 自 |
1.0 |
|---|
类型
string
hookEvents
包含允许的钩子事件的数组
| 自 |
1.5.2 |
|---|---|
| 链接 | |
| 注意 |
从 1.4.0 到 1.5.1，它被称为 $events，由于与包子类命名冲突，它被重命名了 |
类型
array<string|int, mixed>