Class JGithubPackageActivityNotifications

GitHub API Activity Events class for the Joomla Platform.

JGithubPackageActivityNotifications

Package: Joomla\Platform\GitHub
Deprecated: 4.0 Use the joomla/github package via Composer instead
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE
Since: 3.3 (CMS)
Documentation: https://developer.github.com/v3/activity/notifications/
Located at joomla/github/package/activity/notifications.php

Methods summary

`public object`	# `getList( boolean $all = true, boolean $participating = true, JDate $since = null )` List your notifications. List your notifications. List all notifications for the current user, grouped by repository. Parameters `$all` `boolean` - $all True to show notifications marked as read. `$participating` `boolean` - $participating True to show only notifications in which the user is directly participating or mentioned. `$since` `JDate` - $since filters out any notifications updated before the given time. The time should be passed in as UTC in the ISO 8601 format. Returns `object` Since 3.3 (CMS)
`public object`	# `getListRepository( string $owner, string $repo, boolean $all = true, boolean $participating = true, JDate $since = null )` List your notifications in a repository. List your notifications in a repository. List all notifications for the current user. Parameters `$owner` `string` - $owner Repository owner. `$repo` `string` - $repo Repository name. `$all` `boolean` - $all True to show notifications marked as read. `$participating` `boolean` - $participating True to show only notifications in which the user is directly participating or mentioned. `$since` `JDate` - $since filters out any notifications updated before the given time. The time should be passed in as UTC in the ISO 8601 format. Returns `object` Since 3.3 (CMS)
`public object`	# `markRead( boolean $unread = true, boolean $read = true, JDate $last_read_at = null )` Mark as read. Mark as read. Marking a notification as “read” removes it from the default view on GitHub.com. Parameters `$unread` `boolean` - $unread Changes the unread status of the threads. `$read` `boolean` - $read Inverse of “unread”. `$last_read_at` `JDate` - $last_read_at Describes the last point that notifications were checked. Anything updated since this time will not be updated. Default: Now. Expected in ISO 8601 format. Returns `object` Since 3.3 (CMS)
`public object`	# `markReadRepository( string $owner, string $repo, boolean $unread, boolean $read, JDate $last_read_at = null )` Mark notifications as read in a repository. Mark notifications as read in a repository. Marking all notifications in a repository as “read” removes them from the default view on GitHub.com. Parameters `$owner` `string` - $owner Repository owner. `$repo` `string` - $repo Repository name. `$unread` `boolean` - $unread Changes the unread status of the threads. `$read` `boolean` - $read Inverse of “unread”. `$last_read_at` `JDate` - $last_read_at Describes the last point that notifications were checked. Anything updated since this time will not be updated. Default: Now. Expected in ISO 8601 format. Returns `object` Since 3.3 (CMS)
`public object`	# `viewThread( integer $id )` View a single thread. View a single thread. Parameters `$id` `integer` - $id The thread id. Returns `object` Since 3.3 (CMS)
`public object`	# `markReadThread( integer $id, boolean $unread = true, boolean $read = true )` Mark a thread as read. Mark a thread as read. Parameters `$id` `integer` - $id The thread id. `$unread` `boolean` - $unread Changes the unread status of the threads. `$read` `boolean` - $read Inverse of “unread”. Returns `object` Since 3.3 (CMS)
`public object`	# `getThreadSubscription( integer $id )` Get a Thread Subscription. Get a Thread Subscription. This checks to see if the current user is subscribed to a thread. You can also get a Repository subscription. Parameters `$id` `integer` - $id The thread id. Returns `object` Since 3.3 (CMS)
`public object`	# `setThreadSubscription( integer $id, boolean $subscribed, boolean $ignored )` Set a Thread Subscription. Set a Thread Subscription. 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). Parameters `$id` `integer` - $id The thread id. `$subscribed` `boolean` - $subscribed Determines if notifications should be received from this thread. `$ignored` `boolean` - $ignored Determines if all notifications should be blocked from this thread. Returns `object` Since 3.3 (CMS)
`public object`	# `deleteThreadSubscription( integer $id )` Delete a Thread Subscription. Delete a Thread Subscription. Parameters `$id` `integer` - $id The thread id. Returns `object` Since 3.3 (CMS)

Methods inherited from JGithubPackage

__get()

Methods inherited from JGithubObject

__construct(), fetchUrl(), processResponse()

Magic methods summary

Properties summary

Properties inherited from JGithubPackage

$name, $packages

Properties inherited from JGithubObject

$client, $options

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JGithubPackageActivityNotifications

Methods summary

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Methods inherited from JGithubPackage

Methods inherited from JGithubObject

Magic methods summary

Properties summary

Properties inherited from JGithubPackage

Properties inherited from JGithubObject