Class JGithubPackageRepositoriesCollaborators

GitHub API Repositories Collaborators class for the Joomla Platform.

JGithubPackageRepositoriesCollaborators

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: 11.3
Documentation: https://developer.github.com/v3/repos/collaborators
Located at joomla/github/package/repositories/collaborators.php

Methods summary

`public object`	# `getList( string $owner, string $repo )` List. List. When authenticating as an organization owner of an organization-owned repository, all organization owners are included in the list of collaborators. Otherwise, only users with access to the repository are returned in the collaborators list. Parameters `$owner` `string` - $owner The name of the owner of the GitHub repository. `$repo` `string` - $repo The name of the GitHub repository. Returns `object` Since 3.3 (CMS)
`public boolean`	# `get( string $owner, string $repo, string $user )` Test if a user is a collaborator. Test if a user is a collaborator. Parameters `$owner` `string` - $owner The name of the owner of the GitHub repository. `$repo` `string` - $repo The name of the GitHub repository. `$user` `string` - $user The name of the GitHub user. Returns `boolean` Throws `UnexpectedValueException` Since 3.3 (CMS)
`public object`	# `add( string $owner, string $repo, string $user )` Add collaborator. Add collaborator. Parameters `$owner` `string` - $owner The name of the owner of the GitHub repository. `$repo` `string` - $repo The name of the GitHub repository. `$user` `string` - $user The name of the GitHub user. Returns `object` Since 3.3 (CMS)
`public object`	# `remove( string $owner, string $repo, string $user )` Remove collaborator. Remove collaborator. Parameters `$owner` `string` - $owner The name of the owner of the GitHub repository. `$repo` `string` - $repo The name of the GitHub repository. `$user` `string` - $user The name of the GitHub 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 JGithubPackageRepositoriesCollaborators

Methods summary

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