Watching
扩展 AbstractPackageJoomla 框架的 GitHub API 活动观察事件类。
| link | |
|---|---|
| since |
1.0 |
| package |
Joomla 框架 |
方法
__construct
构造函数。
__construct(\Joomla\Registry\Registry options = null, \Joomla\Http\Http client = null) :
继承
__get
懒惰创建 API 对象的魔术方法
__get( name) : \Joomla\Github\AbstractPackage
继承
check
检查您是否正在观察存储库（旧版）。
check( owner, repo) :
要求用户进行身份验证。
| since |
1.0 |
|---|---|
| 抛出 |
|
参数
- owner
string存储库所有者。- repo
string存储库名称。
响应
bool
deleteSubscription
删除存储库订阅。
deleteSubscription( owner, repo) :
| since |
1.0 |
|---|
参数
- owner
string存储库所有者。- repo
string存储库名称。
响应
object
fetchUrl
用于构建并返回完整请求 URL 的方法。此方法会在必要时添加适当的分页详细信息，并同时将 API url 添加到开头，以获得完整的请求 URL。
fetchUrl( path, page, limit) : \Joomla\Uri\Uri
继承
getList
列出观察者
getList( owner, repo) :
| since |
1.0 |
|---|
参数
- owner
string存储库所有者。- repo
string存储库名称。
响应
混合
getRepositories
列出正在观察的存储库。
getRepositories( user = '') :
列出用户正在观察的存储库。
| since |
1.0 |
|---|
参数
- user
string用户名。
响应
混合
getSubscription
获取存储库订阅。
getSubscription( owner, repo) :
| since |
1.0 |
|---|
参数
- owner
string存储库所有者。- repo
string存储库名称。
响应
object
processResponse
处理响应并对其进行解码。
processResponse(\Joomla\Http\Response response, expectedCode = 200) :
继承
setSubscription
设置存储库订阅。
setSubscription( owner, repo, subscribed, ignored) :
| since |
1.0 |
|---|
参数
- owner
string存储库所有者。- repo
string存储库名称。- subscribed
bool确定是否应从此线程接收通知。- ignored
bool确定是否应阻止来自此线程的所有通知。
响应
object
unwatch
停止观察存储库（旧版）。
unwatch( owner, repo) :
要求用户进行身份验证。
| since |
1.0 |
|---|
参数
- owner
string存储库所有者。- repo
string存储库名称。
响应
object
watch
观察存储库（旧版）。
watch( owner, repo) :
要求用户进行身份验证。
| since |
1.0 |
|---|
参数
- owner
string存储库所有者。- repo
string存储库名称。
响应
object
属性
package
对象所在的包
继承
| since |
1.0 |
|---|
类型
string
hookEvents
包含允许的钩子事件的数组
继承
| since |
1.5.2 |
|---|---|
| link | |
| note |
从 1.4.0 到 1.5.1，此属性名为 $events，由于与包子类的命名冲突，它被重命名了 |
类型
array<string|int, mixed>