Class Github\Api\CurrentUser\Notifications

InheritanceGithub\Api\CurrentUser\Notifications » Github\Api\AbstractApi
ImplementsGithub\Api\ApiInterface

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

List all notifications for the authenticated user.

public array all ( array $params = [] )
$params array
allInRepository() public method

List all notifications for the authenticated user in selected repository.

public array allInRepository ( $username, $repository, array $params = [] )
$username string

The user who owns the repo

$repository string

The name of the repo

$params array
createSubscription() public method

Create a subscription.

public array createSubscription ( $id, array $params )
$id string

The notification number

$params array
markAsRead() public method

Mark a notification as read.

public array markAsRead ( $id, array $params )
$id string

The notification number

$params array
markAsReadAll() public method

Mark all notifications as read.

public array markAsReadAll ( array $params = [] )
$params array
markAsReadInRepository() public method

Mark all notifications for a repository as read.

public array markAsReadInRepository ( $username, $repository, array $params = [] )
$username string

The user who owns the repo

$repository string

The name of the repo

$params array
removeSubscription() public method

Delete a subscription.

public array removeSubscription ( $id )
$id string

The notification number

show() public method

Show a notification.

public array show ( $id )
$id string

The notification number

showSubscription() public method

Show a subscription.

public array showSubscription ( $id )
$id string

The notification number