Teams
扩展 AbstractPackageJoomla 框架的 GitHub API Orgs Teams 类。
对团队的所有操作至少需要一个经过身份验证的用户,该用户是正在管理的 :org 中所有者团队的成员。此外,OAuth 用户需要“user”范围。
链接 | |
---|---|
自 |
1.0 |
包 |
Joomla 框架 |
方法
__construct
构造函数。
__construct(\Joomla\Registry\Registry options = null, \Joomla\Http\Http client = null) :
__get
懒惰地创建 API 对象的魔法方法
__get( name) : \Joomla\Github\AbstractPackage
addMember
添加团队成员。
addMember( id, user) :
为了将用户添加到团队,经过身份验证的用户必须对该团队拥有“admin”权限,或者是对该团队所属的组织的所有者。
自 |
1.0 |
---|---|
已弃用 |
请使用 addTeamMembership() 代替 |
参数
- id
int
团队 ID。- user
string
用户的名称。
响应
object
addRepo
添加或更新团队存储库。
addRepo( id, org, repo) :
为了将存储库添加到团队,经过身份验证的用户必须是对该团队所属的组织的所有者。此外,该存储库必须归组织所有,或者是以组织直接拥有的存储库的形式。
如果尝试将存储库添加到不属于组织的团队,则会收到以下信息:状态:422 不可处理的实体
自 |
1.0 |
---|
参数
- id
int
团队 ID。- org
string
GitHub 存储库的组织名称。- repo
string
GitHub 存储库的名称。
响应
object
addTeamMembership
添加团队成员资格
addTeamMembership( id, user, role = 'member') :
如果该用户已经是该团队组织的成员,则此端点会将该用户添加到该团队。为了在组织成员和团队之间添加成员资格,经过身份验证的用户必须是组织所有者或该团队的维护者。
自 |
1.4.0 |
---|---|
抛出 |
|
参数
- id
int
团队 ID。- user
string
用户的名称。- role
string
用户在团队中应具有的角色。可以是“member”或“maintainer”。
响应
object
checkRepo
检查团队是否管理存储库。
checkRepo( id, owner, repo) :
自 |
1.0 |
---|---|
抛出 |
|
参数
- id
int
团队 ID。- owner
string
GitHub 存储库的所有者。- repo
string
GitHub 存储库的名称。
响应
bool
create
创建团队。
create( org, name, mixed||string|int repoNames = [], permission = '') :
为了创建团队,经过身份验证的用户必须是组织的所有者。
自 |
1.0 |
---|---|
抛出 |
|
参数
- org
string
组织的名称。- name
string
团队的名称。- repoNames
array<string|int, mixed>
存储库名称。- permission
string
权限。(已弃用)pull - 团队成员可以拉取,但不能推送或管理这些存储库。默认 push - 团队成员可以拉取和推送,但不能管理这些存储库。admin - 团队成员可以拉取、推送和管理这些存储库。
响应
object
delete
删除团队。
delete( id) :
为了删除团队,经过身份验证的用户必须是对该团队所属的组织的所有者。
自 |
1.0 |
---|
参数
- id
int
团队 ID。
响应
object
edit
编辑团队。
edit( id, name, permission = '') :
为了编辑团队,经过身份验证的用户必须是对该团队所属的组织的所有者。
自 |
1.0 |
---|---|
抛出 |
|
参数
- id
int
团队 ID。- name
string
团队的名称。- permission
string
权限。(已弃用)pull - 团队成员可以拉取,但不能推送或管理这些存储库。默认 push - 团队成员可以拉取和推送,但不能管理这些存储库。admin - 团队成员可以拉取、推送和管理这些存储库。
响应
object
fetchUrl
构建并返回请求的完整请求 URL 的方法。如果需要,此方法会添加适当的分页详细信息,并将 API URL 放在前面,以获取请求的完整 URL。
fetchUrl( path, page, limit) : \Joomla\Uri\Uri
get
获取团队。
get( id) :
自 |
1.0 |
---|
参数
- id
int
团队 ID。
响应
object
getList
列出团队。
getList( org) :
自 |
1.0 |
---|
参数
- org
string
组织的名称。
响应
object
getListMembers
列出团队成员。
getListMembers( id) :
为了列出团队中的成员,经过身份验证的用户必须是该团队的成员。
自 |
1.0 |
---|
参数
- id
int
团队 ID。
响应
object
getListRepos
列出团队存储库。
getListRepos( id) :
自 |
1.0 |
---|
参数
- id
int
团队 ID。
响应
object
getTeamMembership
获取团队成员资格
getTeamMembership( id, user) : string|bool
为了获取用户在团队中的成员资格,该团队必须对经过身份验证的用户可见。
自 |
1.4.0 |
---|---|
抛出 |
|
参数
- id
int
团队 ID。- user
string
用户的名称。
响应
string|bool
用户的成员资格所处的状态,如果用户不是成员,则为布尔值 false。
getUserTeams
列出用户团队。
getUserTeams( page, limit) :
列出经过身份验证的用户所属的所有组织中的所有团队。此方法在通过 OAuth 进行身份验证时需要 user、repo 或 read:org 范围。
自 |
1.4.0 |
---|
参数
- page
int
要从中获取项目的页码。- limit
int
每页的项目数。
响应
object
isMember
获取团队成员。
isMember( id, user) :
为了获取用户是否为团队成员,经过身份验证的用户必须是该团队的成员。
自 |
1.0 |
---|---|
抛出 |
|
已弃用 |
请使用 getTeamMembership() 代替 |
参数
- id
int
团队 ID。- user
string
用户的名称。
响应
bool
processResponse
处理响应并对其进行解码。
processResponse(\Joomla\Http\Response response, expectedCode = 200) :
removeMember
删除团队成员。
removeMember( id, user) :
为了从团队中删除用户,经过身份验证的用户必须对该团队拥有“admin”权限,或者是对该团队所属的组织的所有者。注意:这不会删除用户,只会将他们从团队中移除。
自 |
1.0 |
---|---|
已弃用 |
请使用 removeTeamMembership() 代替 |
参数
- id
int
团队 ID。- user
string
用户的名称。
响应
object
removeRepo
删除团队存储库。
removeRepo( id, owner, repo) :
为了从团队中删除存储库,经过身份验证的用户必须是对该团队所属的组织的所有者。注意:这不会删除存储库,只会将其从团队中移除。
自 |
1.0 |
---|
参数
- id
int
团队 ID。- owner
string
GitHub 存储库所有者的名称。- repo
string
GitHub 存储库的名称。
响应
object
removeTeamMembership
删除团队成员资格
removeTeamMembership( id, user) :
为了删除用户和团队之间的成员资格,经过身份验证的用户必须对该团队拥有“admin”权限,或者是对该团队所属的组织的所有者。注意:这不会删除用户,只会将其成员资格从团队中移除。
自 |
1.4.0 |
---|---|
抛出 |
|
参数
- id
int
团队 ID。- user
string
用户的名称。
响应
object
属性
包
对象所在的包
自 |
1.0 |
---|
类型
string
hookEvents
包含允许的挂钩事件的数组
自 |
1.5.2 |
---|---|
链接 | |
note |
从 1.4.0 到 1.5.1,这被命名为 $events,由于与包子类的命名冲突,它被重命名 |
类型
array<string|int, mixed>