Class JGithubPackageOrgsMembers

GitHub API Orgs Members class for the Joomla Platform.

JGithubPackageOrgsMembers

Package: Joomla\Platform\GitHub
Deprecated: 4.0 Use the joomla/github package via Composer instead
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE
Since: 12.3
Documentation: https://developer.github.com/v3/orgs/members/
Located at joomla/github/package/orgs/members.php

Methods summary

`public boolean\|mixed`	# `getList( string $org )` Members list. 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. Parameters `$org` `string` - $org The name of the organization. Returns `boolean\|mixed` Throws `UnexpectedValueException` Since 3.3 (CMS)
`public boolean`	# `check( string $org, string $user )` Check membership. Check membership. Check if a user is, publicly or privately, a member of the organization. Parameters `$org` `string` - $org The name of the organization. `$user` `string` - $user The name of the user. Returns `boolean` Throws `UnexpectedValueException` Since 3.3 (CMS)
`public object`	# `remove( string $org, string $user )` Remove a member. 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. Parameters `$org` `string` - $org The name of the organization. `$user` `string` - $user The name of the user. Returns `object` Since 3.3 (CMS)
`public object`	# `getListPublic( string $org )` Public members list. Public members list. Members of an organization can choose to have their membership publicized or not. Parameters `$org` `string` - $org The name of the organization. Returns `object` Since 3.3 (CMS)
`public object`	# `checkPublic( string $org, string $user )` Check public membership. Check public membership. Parameters `$org` `string` - $org The name of the organization. `$user` `string` - $user The name of the user. Returns `object` Throws `UnexpectedValueException` Since 3.3 (CMS)
`public object`	# `publicize( string $org, string $user )` Publicize a user’s membership. Publicize a user’s membership. Parameters `$org` `string` - $org The name of the organization. `$user` `string` - $user The name of the user. Returns `object` Since 3.3 (CMS)
`public object`	# `conceal( string $org, string $user )` Conceal a user’s membership. Conceal a user’s membership. Parameters `$org` `string` - $org The name of the organization. `$user` `string` - $user The name of the user. Returns `object` Since 3.3 (CMS)

Methods inherited from JGithubPackage

__get()

Methods inherited from JGithubObject

__construct(), fetchUrl(), processResponse()

Magic methods summary

Properties summary

Properties inherited from JGithubPackage

$name, $packages

Properties inherited from JGithubObject

$client, $options

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JGithubPackageOrgsMembers

Methods summary

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Since

Parameters

Returns

Since

Methods inherited from JGithubPackage

Methods inherited from JGithubObject

Magic methods summary

Properties summary

Properties inherited from JGithubPackage

Properties inherited from JGithubObject