JGithubPackageActivityEvents
Extends \JGithubPackageGitHub API Activity Events class for the Joomla Platform.
| documentation | |
|---|---|
| since |
3.3 |
| deprecated |
4.0 Use the |
| package |
Joomla.Platform |
Methods
__construct
Constructor.
__construct(\Joomla\Registry\Registry $options = null, \JGithubHttp $client = null)
| since |
1.7.3 |
|---|
Arguments
- $options
\Joomla\Registry\RegistryGitHub options object.- $client
\JGithubHttpThe HTTP client object.
__get
Magic method to lazily create API objects
__get(string $name) : \JGithubPackage
| since |
3.3 |
|---|---|
| throws |
|
Arguments
- $name
stringName of property to retrieve
Response
\JGithubPackageGitHub API package object.
fetchUrl
Method to build and return a full request URL for the request. This method will add appropriate pagination details if necessary and also prepend the API url to have a complete URL for the request.
fetchUrl(string $path, integer $page, integer $limit) : string
| since |
1.7.3 |
|---|
Arguments
- $path
stringURL to inflect- $page
integerPage to request- $limit
integerNumber of results to return per page
Response
stringThe request URL.
getByUser
List events performed by a user.
getByUser(string $user) : object
If you are authenticated as the given user, you will see your private events. Otherwise, you’ll only see public events.
| since |
3.1.4 |
|---|
Arguments
- $user
stringUser name.
Response
object
getByUserPublic
List public events performed by a user.
getByUserPublic(string $user) : object
| since |
3.1.4 |
|---|
Arguments
- $user
stringUser name.
Response
object
getIssue
List issue events for a repository.
getIssue(string $owner, string $repo) : object
| since |
3.1.4 |
|---|
Arguments
- $owner
stringRepository owner.- $repo
stringRepository name.
Response
object
getNetwork
List public events for a network of repositories.
getNetwork(string $owner, string $repo) : object
| since |
3.1.4 |
|---|
Arguments
- $owner
stringRepository owner.- $repo
stringRepository name.
Response
object
getOrg
List public events for an organization.
getOrg(string $org) : object
| since |
3.1.4 |
|---|
Arguments
- $org
stringOrganisation.
Response
object
getPublic
List public events.
getPublic() : object
| since |
3.1.4 |
|---|
Response
object
getRepository
List repository events.
getRepository(string $owner, string $repo) : object
| since |
3.1.4 |
|---|
Arguments
- $owner
stringRepository owner.- $repo
stringRepository name.
Response
object
getUser
List events that a user has received.
getUser(string $user) : object
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.
| since |
3.1.4 |
|---|
Arguments
- $user
stringUser name.
Response
object
getUserOrg
List events for an organization.
getUserOrg(string $user, string $org) : object
This is the user’s organization dashboard. You must be authenticated as the user to view this.
| since |
3.1.4 |
|---|
Arguments
- $user
stringUser name.- $org
stringOrganisation.
Response
object
getUserPublic
List public events that a user has received.
getUserPublic(string $user) : object
| since |
3.1.4 |
|---|
Arguments
- $user
stringUser name.
Response
object
processResponse
Process the response and decode it.
processResponse(\JHttpResponse $response, integer $expectedCode = 200, boolean $decode = true) : mixed
| throws |
|
|---|---|
| since |
3.3.0 |
Arguments
- $response
\JHttpResponseThe response.- $expectedCode
integerThe expected "good" code.- $decode
booleanIf the should be response be JSON decoded.
Response
mixed
Properties
name
| since |
3.3 |
|---|
Type(s)
string
packages
| since |
3.3 |
|---|
Type(s)
array
client
The HTTP client object to use in sending HTTP requests.