Members
Extends AbstractPackageGitHub API Orgs Members class for the Joomla Framework.
| link | |
|---|---|
| since |
1.0 |
| package |
Joomla Framework |
Methods
__construct
Constructor.
__construct(\Joomla\Registry\Registry options = null, \Joomla\Http\Http client = null) :
__get
Magic method to lazily create API objects
__get( name) : \Joomla\Github\AbstractPackage
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- name
stringName of property to retrieve
Response
AbstractPackageGitHub API package object.
check
Check membership.
check( org, user) :
Check if a user is, publicly or privately, a member of the organization.
| throws |
|
|---|---|
| since |
1.0 |
Arguments
- org
stringThe name of the organization.- user
stringThe name of the user.
Response
bool
checkPublic
Check public membership.
checkPublic( org, user) :
| throws |
|
|---|---|
| since |
1.0 |
Arguments
- org
stringThe name of the organization.- user
stringThe name of the user.
Response
bool
conceal
Conceal a user’s membership.
conceal( org, user) :
| since |
1.0 |
|---|
Arguments
- org
stringThe name of the organization.- user
stringThe name of the user.
Response
object
editOrganizationMembership
Edit your organization membership
editOrganizationMembership( org, state) :
| since |
1.4.0 |
|---|
Arguments
- org
stringThe name of the organization.- state
stringThe state that the membership should be in.
Response
object
fetchUrl
Method to build and return a full request URL for the request. This method will add appropriate pagination details if necessary and also prepend the API url to have a complete URL for the request.
fetchUrl( path, page, limit) : \Joomla\Uri\Uri
| since |
1.0 |
|---|
Arguments
- path
stringURL to inflect- page
intPage to request- limit
intNumber of results to return per page
Response
getList
Members list.
getList( org) : bool|mixed
List all users who are members of an organization. A member is a user that belongs to at least 1 team in the organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned. If the requester is not a member of the organization the query will be redirected to the public members list.
| throws |
|
|---|---|
| since |
1.0 |
Arguments
- org
stringThe name of the organization.
Response
bool|mixed
getListPublic
Public members list.
getListPublic( org) :
Members of an organization can choose to have their membership publicized or not.
| since |
1.0 |
|---|
Arguments
- org
stringThe name of the organization.
Response
object
getMembership
Get organization membership
getMembership( org, user) :
In order to get a user's membership with an organization, the authenticated user must be an organization owner.
| since |
1.4.0 |
|---|
Arguments
- org
stringThe name of the organization.- user
stringThe name of the user.
Response
object
listMemberships
List your organization memberships
listMemberships() :
| since |
1.4.0 |
|---|
Response
object
listOrganizationMembership
Get your organization membership
listOrganizationMembership( org) :
| since |
1.4.0 |
|---|
Arguments
- org
stringThe name of the organization.
Response
object
processResponse
Process the response and decode it.
processResponse(\Joomla\Http\Response response, expectedCode = 200) :
| since |
1.0 |
|---|---|
| throws |
Arguments
- response
ResponseThe response.- expectedCode
intThe expected "good" code.
Response
mixed
publicize
Publicize a user’s membership.
publicize( org, user) :
| since |
1.0 |
|---|
Arguments
- org
stringThe name of the organization.- user
stringThe name of the user.
Response
object
remove
Remove a member.
remove( org, user) :
Removing a user from this list will remove them from all teams and they will no longer have any access to the organization’s repositories.
| since |
1.0 |
|---|
Arguments
- org
stringThe name of the organization.- user
stringThe name of the user.
Response
object
removeMembership
Remove organization membership
removeMembership( org, user) :
In order to remove a user's membership with an organization, the authenticated user must be an organization owner.
| since |
1.4.0 |
|---|
Arguments
- org
stringThe name of the organization.- user
stringThe name of the user.
Response
object
updateMembership
Add or update organization membership
updateMembership( org, user, role = 'member') :
In order to create or update a user's membership with an organization, the authenticated user must be an organization owner.
| since |
1.4.0 |
|---|
Arguments
- org
stringThe name of the organization.- user
stringThe name of the user.- role
stringThe role to give the user in the organization. Can be either 'member' or 'admin'.
Response
object
Properties
package
The package the object resides in
| since |
1.0 |
|---|
Type(s)
string
hookEvents
Array containing the allowed hook events
| since |
1.5.2 |
|---|---|
| link | |
| note |
From 1.4.0 to 1.5.1 this was named $events, it was renamed due to naming conflicts with package subclasses |
Type(s)
array<string|int, mixed>