Joomla CMS  3.10.11 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.10.11 et du framework Joomla Platform intégré
Tout Structures de données Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe JGithubPackageActivityNotifications
+ Graphe d'héritage de JGithubPackageActivityNotifications:

Fonctions membres publiques

 getList ($all=true, $participating=true, JDate $since=null)
 
 getListRepository ($owner, $repo, $all=true, $participating=true, JDate $since=null)
 
 markRead ($unread=true, $read=true, JDate $lastReadAt=null)
 
 markReadRepository ($owner, $repo, $unread, $read, JDate $lastReadAt=null)
 
 viewThread ($id)
 
 markReadThread ($id, $unread=true, $read=true)
 
 getThreadSubscription ($id)
 
 setThreadSubscription ($id, $subscribed, $ignored)
 
 deleteThreadSubscription ($id)
 
- Fonctions membres publiques hérités de JGithubPackage
 __get ($name)
 
- Fonctions membres publiques hérités de JGithubObject
 __construct (Registry $options=null, JGithubHttp $client=null)
 

Membres hérités additionnels

- Fonctions membres protégées hérités de JGithubObject
 fetchUrl ($path, $page=0, $limit=0)
 
 processResponse (JHttpResponse $response, $expectedCode=200, $decode=true)
 
- Attributs protégés hérités de JGithubPackage
 $name = ''
 
 $packages = array()
 
- Attributs protégés hérités de JGithubObject
 $options
 
 $client
 

Description détaillée

GitHub API Activity Events class for the Joomla Platform.

https://developer.github.com/v3/activity/notifications/

Depuis
3.3 (CMS)
Obsolète:
4.0 Use the joomla/github package via Composer instead

Documentation des fonctions membres

◆ deleteThreadSubscription()

deleteThreadSubscription (   $id)

Delete a Thread Subscription.

Paramètres
integer$idThe thread id.
Depuis
3.3 (CMS)
Renvoie
object

Références $id, et $path.

◆ getList()

getList (   $all = true,
  $participating = true,
JDate  $since = null 
)

List your notifications.

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

Paramètres
boolean$allTrue to show notifications marked as read.
boolean$participatingTrue to show only notifications in which the user is directly participating or mentioned.
JDate$sincefilters out any notifications updated before the given time. The time should be passed in as UTC in the ISO 8601 format.
Depuis
3.3 (CMS)
Renvoie
object

Références $path.

◆ getListRepository()

getListRepository (   $owner,
  $repo,
  $all = true,
  $participating = true,
JDate  $since = null 
)

List your notifications in a repository.

List all notifications for the current user.

Paramètres
string$ownerRepository owner.
string$repoRepository name.
boolean$allTrue to show notifications marked as read.
boolean$participatingTrue to show only notifications in which the user is directly participating or mentioned.
JDate$sincefilters out any notifications updated before the given time. The time should be passed in as UTC in the ISO 8601 format.
Depuis
3.3 (CMS)
Renvoie
object

Références $path.

◆ getThreadSubscription()

getThreadSubscription (   $id)

Get a Thread Subscription.

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

Paramètres
integer$idThe thread id.
Depuis
3.3 (CMS)
Renvoie
object

Références $id, et $path.

◆ markRead()

markRead (   $unread = true,
  $read = true,
JDate  $lastReadAt = null 
)

Mark as read.

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

Paramètres
boolean$unreadChanges the unread status of the threads.
boolean$readInverse of “unread”.
JDate$lastReadAtDescribes the last point that notifications were checked. Anything updated since this time will not be updated. Default: Now. Expected in ISO 8601 format.
Depuis
3.3 (CMS)
Renvoie
object

Références $data, $path, $unread, et json_encode.

◆ markReadRepository()

markReadRepository (   $owner,
  $repo,
  $unread,
  $read,
JDate  $lastReadAt = null 
)

Mark notifications as read in a repository.

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

Paramètres
string$ownerRepository owner.
string$repoRepository name.
boolean$unreadChanges the unread status of the threads.
boolean$readInverse of “unread”.
JDate$lastReadAtDescribes the last point that notifications were checked. Anything updated since this time will not be updated. Default: Now. Expected in ISO 8601 format.
Depuis
3.3 (CMS)
Renvoie
object

Références $data, $path, $unread, et json_encode.

◆ markReadThread()

markReadThread (   $id,
  $unread = true,
  $read = true 
)

Mark a thread as read.

Paramètres
integer$idThe thread id.
boolean$unreadChanges the unread status of the threads.
boolean$readInverse of “unread”.
Depuis
3.3 (CMS)
Renvoie
object

Références $data, $id, $path, $unread, et json_encode.

◆ setThreadSubscription()

setThreadSubscription (   $id,
  $subscribed,
  $ignored 
)

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 ).

Paramètres
integer$idThe thread id.
boolean$subscribedDetermines if notifications should be received from this thread.
boolean$ignoredDetermines if all notifications should be blocked from this thread.
Depuis
3.3 (CMS)
Renvoie
object

Références $data, $id, $path, et json_encode.

◆ viewThread()

viewThread (   $id)

View a single thread.

Paramètres
integer$idThe thread id.
Depuis
3.3 (CMS)
Renvoie
object

Références $id, et $path.


La documentation de cette classe a été générée à partir du fichier suivant :