成员
扩展自 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
check
检查成员资格。
check( org, user) :
检查用户是否公开或私下是组织的成员。
| 抛出 |
|
|---|---|
| 自 |
1.0 |
参数
- 组织
string组织的名称。- 用户
string用户的名称。
响应
布尔值
checkPublic
检查公共成员资格。
checkPublic( org, user) :
| 抛出 |
|
|---|---|
| 自 |
1.0 |
参数
- 组织
string组织的名称。- 用户
string用户的名称。
响应
布尔值
conceal
隐藏用户的成员资格。
conceal( org, user) :
| 自 |
1.0 |
|---|
参数
- 组织
string组织的名称。- 用户
string用户的名称。
响应
对象
editOrganizationMembership
编辑您的组织成员资格
editOrganizationMembership( org, state) :
| 自 |
1.4.0 |
|---|
参数
- 组织
string组织的名称。- 状态
string成员资格应处于的状态。
响应
对象
fetchUrl
构建并返回请求的完整请求 URL 的方法。如果需要，此方法将添加适当的分页详细信息，并将 API URL 添加到请求的开头，以获得请求的完整 URL。
fetchUrl( path, page, limit) : \Joomla\Uri\Uri
getList
成员列表。
getList( org) : bool|mixed
列出所有属于组织的成员。成员是至少属于组织中 1 个团队的用户。如果经过身份验证的用户也是此组织的成员，则将返回隐藏的和公开的成员。如果请求者不是组织的成员，则查询将重定向到公开成员列表。
| 抛出 |
|
|---|---|
| 自 |
1.0 |
参数
- 组织
string组织的名称。
响应
布尔值|混合
getListPublic
公开成员列表。
getListPublic( org) :
组织成员可以选择公开或不公开其成员资格。
| 自 |
1.0 |
|---|
参数
- 组织
string组织的名称。
响应
对象
getMembership
获取组织成员资格
getMembership( org, user) :
为了获取用户与组织的成员资格，经过身份验证的用户必须是组织所有者。
| 自 |
1.4.0 |
|---|
参数
- 组织
string组织的名称。- 用户
string用户的名称。
响应
对象
listMemberships
列出您的组织成员资格
listMemberships() :
| 自 |
1.4.0 |
|---|
响应
对象
listOrganizationMembership
获取您的组织成员资格
listOrganizationMembership( org) :
| 自 |
1.4.0 |
|---|
参数
- 组织
string组织的名称。
响应
对象
processResponse
处理响应并对其进行解码。
processResponse(\Joomla\Http\Response response, expectedCode = 200) :
publicize
公开用户的成员资格。
publicize( org, user) :
| 自 |
1.0 |
|---|
参数
- 组织
string组织的名称。- 用户
string用户的名称。
响应
对象
remove
删除成员。
remove( org, user) :
从此列表中删除用户将将其从所有团队中删除，并且他们将不再对组织的存储库有任何访问权限。
| 自 |
1.0 |
|---|
参数
- 组织
string组织的名称。- 用户
string用户的名称。
响应
对象
removeMembership
删除组织成员资格
removeMembership( org, user) :
为了删除用户与组织的成员资格，经过身份验证的用户必须是组织所有者。
| 自 |
1.4.0 |
|---|
参数
- 组织
string组织的名称。- 用户
string用户的名称。
响应
对象
updateMembership
添加或更新组织成员资格
updateMembership( org, user, role = 'member') :
为了创建或更新用户与组织的成员资格，经过身份验证的用户必须是组织所有者。
| 自 |
1.4.0 |
|---|
参数
- 组织
string组织的名称。- 用户
string用户的名称。- 角色
string赋予用户在组织中的角色。可以是“成员”或“管理员”。
响应
对象
属性
包
对象所在的包
| 自 |
1.0 |
|---|
类型(s)
字符串
hookEvents
包含允许的挂钩事件的数组
| 自 |
1.5.2 |
|---|---|
| 链接 | |
| 注意 |
从 1.4.0 到 1.5.1，此名称为 $events，由于与包子类的命名冲突，因此将其重命名 |
类型(s)
array<string|int, mixed>