Class Github\Api\Notification

InheritanceGithub\Api\Notification » Github\Api\AbstractApi
ImplementsGithub\Api\ApiInterface

API for accessing Notifications from your Git/Github repositories.

Important! You have to be authenticated to perform these methods

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__construct() Github\Api\AbstractApi
all() Get a listing of notifications. Github\Api\Notification
configure() Github\Api\AbstractApi
getPerPage() Github\Api\AbstractApi
markRead() Marks all notifications as read from the current date Optionally give DateTime to mark as read before that date. Github\Api\Notification
setPerPage() Github\Api\AbstractApi

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
createJsonBody() Create a JSON encoded version of an array of parameters. Github\Api\AbstractApi
delete() Send a DELETE request with JSON-encoded parameters. Github\Api\AbstractApi
get() Send a GET request with query parameters. Github\Api\AbstractApi
head() Send a HEAD request with query parameters. Github\Api\AbstractApi
patch() Send a PATCH request with JSON-encoded parameters. Github\Api\AbstractApi
post() Send a POST request with JSON-encoded parameters. Github\Api\AbstractApi
postRaw() Send a POST request with raw data. Github\Api\AbstractApi
put() Send a PUT request with JSON-encoded parameters. Github\Api\AbstractApi

Method Details

all() public method

Get a listing of notifications.

public array all ( $includingRead false, $participating false, DateTime $since null )
$includingRead bool
$participating bool
$since DateTime|null
return array

Array of notifications

markRead() public method

Marks all notifications as read from the current date Optionally give DateTime to mark as read before that date.

public void markRead ( DateTime $since null )
$since DateTime|null