指派者
扩展自 AbstractPackageJoomla 框架的 GitHub API 指派者类。
| 链接 | |
|---|---|
| 自 |
1.0 |
| 包 |
Joomla 框架 |
方法
__construct
构造函数。
__construct(\Joomla\Registry\Registry options = null, \Joomla\Http\Http client = null) :
__get
延迟创建 API 对象的魔术方法
__get( name) : \Joomla\Github\AbstractPackage
add
向问题添加指派者
add( owner, repo, number, string||string|int assignees) :
此调用将传递在指派者键（作为其登录名）中的用户添加到问题中。
| 自 |
1.4.0 |
|---|---|
| 抛出 |
|
参数
- 所有者
stringGitHub 存储库的所有者名称。- 存储库
stringGitHub 存储库的名称。- 编号
int要向其添加指派者的问题编号。- 指派者
array<string|int, string>要分配给此问题的 GitHub 用户的登录名。
响应
对象
check
检查指派者。
check( owner, repo, assignee) :
您可以检查特定用户是否为存储库的指派者。如果给定的指派者登录名属于存储库的指派者，则返回不包含内容的 204 标头。否则，返回 404 状态代码。
| 自 |
1.0 |
|---|---|
| 抛出 |
|
参数
- 所有者
stringGitHub 存储库的所有者名称。- 存储库
stringGitHub 存储库的名称。- 指派者
string指派者的登录名。
响应
布尔值
fetchUrl
构建并返回请求的完整请求 URL 的方法。此方法将在必要时添加适当的分页详细信息，并将 API URL 放在前面以获取请求的完整 URL。
fetchUrl( path, page, limit) : \Joomla\Uri\Uri
getList
列出指派者。
getList( owner, repo) :
此调用列出所有可用的指派者（所有者 + 协作者），问题可以分配给他们。
| 自 |
1.0 |
|---|
参数
- 所有者
stringGitHub 存储库的所有者名称。- 存储库
stringGitHub 存储库的名称。
响应
对象
processResponse
处理响应并对其进行解码。
processResponse(\Joomla\Http\Response response, expectedCode = 200) :
remove
从问题中删除指派者
remove( owner, repo, number, string||string|int assignees) :
此调用从问题中删除传递在指派者键（作为其登录名）中的用户。
| 自 |
1.4.0 |
|---|---|
| 抛出 |
|
参数
- 所有者
stringGitHub 存储库的所有者名称。- 存储库
stringGitHub 存储库的名称。- 编号
int要向其添加指派者的问题编号。- 指派者
array<string|int, string>要分配给此问题的 GitHub 用户的登录名。
响应
对象
属性
包
对象所在的包
| 自 |
1.0 |
|---|
类型(s)
字符串
hookEvents
包含允许的挂钩事件的数组
| 自 |
1.5.2 |
|---|---|
| 链接 | |
| 注意 |
从 1.4.0 到 1.5.1，此名称为 $events，由于与包子类的命名冲突，因此已重命名 |
类型(s)
array<string|int, mixed>