JGithubPackageActivityEvents

class JGithubPackageActivityEvents extends JGithubPackage

GitHub API Activity Events 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
getPublic()

List public events.

object
getRepository( string $owner, string $repo)

List repository events.

object
getIssue( string $owner, string $repo)

List issue events for a repository.

object
getNetwork( string $owner, string $repo)

List public events for a network of repositories.

object
getOrg( string $org)

List public events for an organization.

object
getUser( string $user)

List events that a user has received.

object
getUserPublic( string $user)

List public events that a user has received.

object
getByUser( string $user)

List events performed by a user.

object
getByUserPublic( string $user)

List public events performed by a user.

object
getUserOrg( string $user, string $org)

List events for an organization.

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 getPublic()

List public events.

Return Value

object

object getRepository( string $owner, string $repo)

List repository events.

Parameters

string $owner Repository owner.
string $repo Repository name.

Return Value

object

object getIssue( string $owner, string $repo)

List issue events for a repository.

Parameters

string $owner Repository owner.
string $repo Repository name.

Return Value

object

object getNetwork( string $owner, string $repo)

List public events for a network of repositories.

Parameters

string $owner Repository owner.
string $repo Repository name.

Return Value

object

object getOrg( string $org)

List public events for an organization.

Parameters

string $org Organisation.

Return Value

object

object getUser( string $user)

List events that a user has received.

These are events that you’ve received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you’ll only see public events.

Parameters

string $user User name.

Return Value

object

object getUserPublic( string $user)

List public events that a user has received.

Parameters

string $user User name.

Return Value

object

object getByUser( string $user)

List events performed by a user.

If you are authenticated as the given user, you will see your private events. Otherwise, you’ll only see public events.

Parameters

string $user User name.

Return Value

object

object getByUserPublic( string $user)

List public events performed by a user.

Parameters

string $user User name.

Return Value

object

object getUserOrg( string $user, string $org)

List events for an organization.

This is the user’s organization dashboard. You must be authenticated as the user to view this.

Parameters

string $user User name.
string $org Organisation.

Return Value

object