Joomla CMS  3.10.11 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.10.11 et du framework Joomla Platform intégré
Tout Structures de données Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe JGithubPackageOrgsMembers
+ Graphe d'héritage de JGithubPackageOrgsMembers:

Fonctions membres publiques

 getList ($org)
 
 check ($org, $user)
 
 remove ($org, $user)
 
 getListPublic ($org)
 
 checkPublic ($org, $user)
 
 publicize ($org, $user)
 
 conceal ($org, $user)
 
- Fonctions membres publiques hérités de JGithubPackage
 __get ($name)
 
- Fonctions membres publiques hérités de JGithubObject
 __construct (Registry $options=null, JGithubHttp $client=null)
 

Membres hérités additionnels

- Fonctions membres protégées hérités de JGithubObject
 fetchUrl ($path, $page=0, $limit=0)
 
 processResponse (JHttpResponse $response, $expectedCode=200, $decode=true)
 
- Attributs protégés hérités de JGithubPackage
 $name = ''
 
 $packages = array()
 
- Attributs protégés hérités de JGithubObject
 $options
 
 $client
 

Description détaillée

GitHub API Orgs Members class for the Joomla Platform.

https://developer.github.com/v3/orgs/members/

Depuis
3.1.4
Obsolète:
4.0 Use the joomla/github package via Composer instead

Documentation des fonctions membres

◆ check()

check (   $org,
  $user 
)

Check membership.

Check if a user is, publicly or privately, a member of the organization.

Paramètres
string$orgThe name of the organization.
string$userThe name of the user.
Exceptions
UnexpectedValueException
Depuis
3.3 (CMS)
Renvoie
boolean

Références $path, et $user.

◆ checkPublic()

checkPublic (   $org,
  $user 
)

Check public membership.

Paramètres
string$orgThe name of the organization.
string$userThe name of the user.
Exceptions
UnexpectedValueException
Depuis
3.3 (CMS)
Renvoie
object

Références $path, et $user.

◆ conceal()

conceal (   $org,
  $user 
)

Conceal a user’s membership.

Paramètres
string$orgThe name of the organization.
string$userThe name of the user.
Depuis
3.3 (CMS)
Renvoie
object

Références $path, et $user.

◆ getList()

getList (   $org)

Members list.

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.

Paramètres
string$orgThe name of the organization.
Exceptions
UnexpectedValueException
Depuis
3.3 (CMS)
Renvoie
boolean|mixed

Références $path.

◆ getListPublic()

getListPublic (   $org)

Public members list.

Members of an organization can choose to have their membership publicized or not.

Paramètres
string$orgThe name of the organization.
Depuis
3.3 (CMS)
Renvoie
object

Références $path.

◆ publicize()

publicize (   $org,
  $user 
)

Publicize a user’s membership.

Paramètres
string$orgThe name of the organization.
string$userThe name of the user.
Depuis
3.3 (CMS)
Renvoie
object

Références $path, et $user.

◆ remove()

remove (   $org,
  $user 
)

Add a member.

To add someone as a member to an org, you must add them to a team. Remove a member.

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.

Paramètres
string$orgThe name of the organization.
string$userThe name of the user.
Depuis
3.3 (CMS)
Renvoie
object

Références $path, et $user.


La documentation de cette classe a été générée à partir du fichier suivant :