class JGithubPackageActivityWatching extends JGithubPackage

GitHub API Activity Watching Events class for the Joomla Platform.

Methods

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

Constructor.

__get( string $name)

Magic method to lazily create API objects

mixed
getList( string $owner, string $repo)

List watchers

mixed
getRepositories( string $user = '')

List repositories being watched.

mixed
getSubscription( string $owner, string $repo)

Get a Repository Subscription.

object
setSubscription( string $owner, string $repo, boolean $subscribed, boolean $ignored)

Set a Repository Subscription.

object
deleteSubscription( string $owner, string $repo)

Delete a Repository Subscription.

object
check( string $owner, string $repo)

Check if you are watching a repository (LEGACY).

object
watch( string $owner, string $repo)

Watch a repository (LEGACY).

object
unwatch( string $owner, string $repo)

Stop watching a repository (LEGACY).

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

mixed getList( string $owner, string $repo)

List watchers

Parameters

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

Return Value

mixed

mixed getRepositories( string $user = '')

List repositories being watched.

List repositories being watched by a user.

Parameters

string $user User name.

Return Value

mixed

mixed getSubscription( string $owner, string $repo)

Get a Repository Subscription.

Parameters

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

Return Value

mixed

object setSubscription( string $owner, string $repo, boolean $subscribed, boolean $ignored)

Set a Repository Subscription.

Parameters

string $owner Repository owner.
string $repo Repository name.
boolean $subscribed Determines if notifications should be received from this thread.
boolean $ignored Determines if all notifications should be blocked from this thread.

Return Value

object

object deleteSubscription( string $owner, string $repo)

Delete a Repository Subscription.

Parameters

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

Return Value

object

object check( string $owner, string $repo)

Check if you are watching a repository (LEGACY).

Requires for the user to be authenticated.

Parameters

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

Return Value

object

Exceptions

UnexpectedValueException

object watch( string $owner, string $repo)

Watch a repository (LEGACY).

Requires for the user to be authenticated.

Parameters

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

Return Value

object

object unwatch( string $owner, string $repo)

Stop watching a repository (LEGACY).

Requires for the user to be authenticated.

Parameters

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

Return Value

object