JGithubPackageActivityNotifications
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\Registry
GitHub options object.- $client
\JGithubHttp
The HTTP client object.
__get
Magic method to lazily create API objects
__get(string $name) : \JGithubPackage
since |
3.3 |
---|---|
throws |
|
Arguments
- $name
string
Name of property to retrieve
Response
\JGithubPackage
GitHub API package object.
deleteThreadSubscription
Delete a Thread Subscription.
deleteThreadSubscription(integer $id) : object
since |
3.3 |
---|
Arguments
- $id
integer
The thread id.
Response
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
string
URL to inflect- $page
integer
Page to request- $limit
integer
Number of results to return per page
Response
string
The request URL.
getList
List your notifications.
getList(boolean $all = true, boolean $participating = true, \JDate $since = null) : object
List all notifications for the current user, grouped by repository.
since |
3.3 |
---|
Arguments
- $all
boolean
True to show notifications marked as read.- $participating
boolean
True to show only notifications in which the user is directly participating or mentioned.- $since
\JDate
filters out any notifications updated before the given time. The time should be passed in as UTC in the ISO 8601 format.
Response
object
getListRepository
List your notifications in a repository.
getListRepository(string $owner, string $repo, boolean $all = true, boolean $participating = true, \JDate $since = null) : object
List all notifications for the current user.
since |
3.3 |
---|
Arguments
- $owner
string
Repository owner.- $repo
string
Repository name.- $all
boolean
True to show notifications marked as read.- $participating
boolean
True to show only notifications in which the user is directly participating or mentioned.- $since
\JDate
filters out any notifications updated before the given time. The time should be passed in as UTC in the ISO 8601 format.
Response
object
getThreadSubscription
Get a Thread Subscription.
getThreadSubscription(integer $id) : object
This checks to see if the current user is subscribed to a thread. You can also get a Repository subscription.
since |
3.3 |
---|
Arguments
- $id
integer
The thread id.
Response
object
markRead
Mark as read.
markRead(boolean $unread = true, boolean $read = true, \JDate $lastReadAt = null) : object
Marking a notification as “read” removes it from the default view on GitHub.com.
since |
3.3 |
---|
Arguments
- $unread
boolean
Changes the unread status of the threads.- $read
boolean
Inverse of “unread”.- $lastReadAt
\JDate
Describes the last point that notifications were checked. Anything updated since this time will not be updated. Default: Now. Expected in ISO 8601 format.
Response
object
markReadRepository
Mark notifications as read in a repository.
markReadRepository(string $owner, string $repo, boolean $unread, boolean $read, \JDate $lastReadAt = null) : object
Marking all notifications in a repository as “read” removes them from the default view on GitHub.com.
since |
3.3 |
---|
Arguments
- $owner
string
Repository owner.- $repo
string
Repository name.- $unread
boolean
Changes the unread status of the threads.- $read
boolean
Inverse of “unread”.- $lastReadAt
\JDate
Describes the last point that notifications were checked. Anything updated since this time will not be updated. Default: Now. Expected in ISO 8601 format.
Response
object
markReadThread
Mark a thread as read.
markReadThread(integer $id, boolean $unread = true, boolean $read = true) : object
since |
3.3 |
---|
Arguments
- $id
integer
The thread id.- $unread
boolean
Changes the unread status of the threads.- $read
boolean
Inverse of “unread”.
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
\JHttpResponse
The response.- $expectedCode
integer
The expected "good" code.- $decode
boolean
If the should be response be JSON decoded.
Response
mixed
setThreadSubscription
Set a Thread Subscription.
setThreadSubscription(integer $id, boolean $subscribed, boolean $ignored) : object
This lets you subscribe to a thread, or ignore it. Subscribing to a thread is unnecessary if the user is already subscribed to the repository. Ignoring a thread will mute all future notifications (until you comment or get @mentioned).
since |
3.3 |
---|
Arguments
- $id
integer
The thread id.- $subscribed
boolean
Determines if notifications should be received from this thread.- $ignored
boolean
Determines if all notifications should be blocked from this thread.
Response
object
viewThread
View a single thread.
viewThread(integer $id) : object
since |
3.3 |
---|
Arguments
- $id
integer
The thread id.
Response
object
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.