JGithubPackageIssuesAssignees

class JGithubPackageIssuesAssignees extends JGithubPackage

GitHub API Assignees class for the Joomla Platform.

Methods

__construct( Registry $options = null, JGithubHttp $client = null)

Constructor.

from JGithubObject
JGithubPackage
__get( string $name)

Magic method to lazily create API objects

from JGithubPackage
object
getList( string $owner, string $repo)

List assignees.

boolean
check( string $owner, string $repo, string $assignee)

Check assignee.

Details

__construct( Registry $options = null, JGithubHttp $client = null)

Constructor.

Parameters

Registry $options GitHub options object.
JGithubHttp $client The HTTP client object.

JGithubPackage __get( string $name)

Magic method to lazily create API objects

Parameters

string $name Name of property to retrieve

Return Value

JGithubPackage GitHub API package object.

Exceptions

RuntimeException

object getList( string $owner, string $repo)

List assignees.

This call lists all the available assignees (owner + collaborators) to which issues may be assigned.

Parameters

string $owner The name of the owner of the GitHub repository.
string $repo The name of the GitHub repository.

Return Value

object

boolean check( string $owner, string $repo, string $assignee)

Check assignee.

You may check to see if a particular user is an assignee for a repository. If the given assignee login belongs to an assignee for the repository, a 204 header with no content is returned. Otherwise a 404 status code is returned.

Parameters

string $owner The name of the owner of the GitHub repository.
string $repo The name of the GitHub repository.
string $assignee The assinees login name.

Return Value

boolean

Exceptions

Exception