Joomla! API

Download
Launch

Notifications

Extends AbstractPackage

GitHub API Activity Events class for the Joomla Framework.

link
since

1.0
package

Joomla Framework

Methods

__construct

Constructor.

__construct(\Joomla\Registry\Registry options = null, \Joomla\Http\Http client = null) : mixed
inherited
since

1.0

Arguments

options

\Joomla\Registry\RegistryGitHub options object.

client

\Joomla\Http\HttpThe HTTP client object.

Response

mixed

__get

Magic method to lazily create API objects

__get(string name) : \Joomla\Github\AbstractPackage
inherited
since

1.0
throws

\InvalidArgumentException

Arguments

name

stringName of property to retrieve

Response

\Joomla\Github\AbstractPackageGitHub API package object.

deleteThreadSubscription

Delete a Thread Subscription.

deleteThreadSubscription(int id) : object
since

1.0

Arguments

id

intThe 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, int page, int limit) : string
inherited
since

1.0
note

As of 2.0 this method will return a Joomla\Uri\Uri object

Arguments

path

stringURL to inflect

page

intPage to request

limit

intNumber of results to return per page

Response

stringThe request URL.

getList

List your notifications.

getList(bool all = true, bool participating = true, \DateTime since = null, \DateTime before = null) : object

List all notifications for the current user, grouped by repository.

since

1.0

Arguments

all

boolTrue to show notifications marked as read.

participating

boolTrue to show only notifications in which the user is directly participating or mentioned.

since

\DateTimeOnly show notifications updated after the given time.

before

\DateTimeOnly show notifications updated before the given time.

Response

object

getListRepository

List your notifications in a repository.

getListRepository(string owner, string repo, bool all = true, bool participating = true, \DateTime since = null, \DateTime before = null) : object

List all notifications for the current user.

since

1.0

Arguments

owner

stringRepository owner.

repo

stringRepository name.

all

boolTrue to show notifications marked as read.

participating

boolTrue to show only notifications in which the user is directly participating or mentioned.

since

\DateTimeOnly show notifications updated after the given time.

before

\DateTimeOnly show notifications updated before the given time.

Response

object

getThreadSubscription

Get a Thread Subscription.

getThreadSubscription(int id) : object

This checks to see if the current user is subscribed to a thread. You can also get a Repository subscription.

since

1.0

Arguments

id

intThe thread id.

Response

object

markRead

Mark as read.

markRead(bool unread = true, bool read = true, \DateTime lastReadAt = null) : object

Marking a notification as “read” removes it from the default view on GitHub.com.

since

1.0

Arguments

unread

boolChanges the unread status of the threads.

read

boolInverse of “unread”.

lastReadAt

\DateTimeDescribes 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, bool unread, bool read, \DateTime lastReadAt = null) : object

Marking all notifications in a repository as “read” removes them from the default view on GitHub.com.

since

1.0

Arguments

owner

stringRepository owner.

repo

stringRepository name.

unread

boolChanges the unread status of the threads.

read

boolInverse of “unread”.

lastReadAt

\DateTimeDescribes 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(int id, bool unread = true, bool read = true) : object
since

1.0

Arguments

id

intThe thread id.

unread

boolChanges the unread status of the threads.

read

boolInverse of “unread”.

Response

object

processResponse

Process the response and decode it.

processResponse(\Joomla\Http\Response response, int expectedCode = 200) : mixed
inherited
since

1.0
throws

\Joomla\Http\Exception\UnexpectedResponseException

Arguments

response

\Joomla\Http\ResponseThe response.

expectedCode

intThe expected "good" code.

Response

mixed

setThreadSubscription

Set a Thread Subscription.

setThreadSubscription(int id, bool subscribed, bool 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

1.0

Arguments

id

intThe thread id.

subscribed

boolDetermines if notifications should be received from this thread.

ignored

boolDetermines if all notifications should be blocked from this thread.

Response

object

viewThread

View a single thread.

viewThread(int id) : object
since

1.0

Arguments

id

intThe thread id.

Response

object

Properties

options

Options for the GitHub object.

inherited
since

1.0

Type(s)

\Joomla\Registry\Registry

client

The HTTP client object to use in sending HTTP requests.

inherited
since

1.0

Type(s)

\Joomla\Http\Http

package

The package the object resides in

inherited
since

1.0

Type(s)

string

hookEvents

Array containing the allowed hook events

inherited
since

1.5.2
link
note

From 1.4.0 to 1.5.1 this was named $events, it was renamed due to naming conflicts with package subclasses

Type(s)

array
  • \ Joomla
  • \ Github
  • \ Package
  • \ Activity
  • \ Notifications