1. class
  2. PCIT
  3. \
  4. GitHub
  5. \
  6. Service
  7. \
  8. Activity
  9. \
  10. NotificationsClient

NotificationsClient

class NotificationsClient

Traits

CICommon

Properties

protected $curl from CICommon
protected $api_url from CICommon

Methods

__construct(Curl $curl, string $api_url)

CICommon constructor.

from CICommon
mixed
list(bool $all, bool $participating, string $since, string $before)

List your notifications.

mixed
repository(string $repo_full_name, bool $all, bool $participating, string $since, string $before)

List your notifications in a repository.

mixed
markAsRead(string $last_read_at)

Mark as read.

mixed
markAsReadInRepository(string $repo_full_name, string $last_read_at)

Mark notifications as read in a repository.

mixed
viewSingleThread(int $thread_id)

View a single thread.

mixed
markThreadAsRead(int $thread_id)

Mark a thread as read.

mixed
getThreadSubscription(int $thread_id)

Get a thread subscription.

mixed
setThreadSubscription(int $thread_id, bool $ignored = false)

Set a thread subscription.

mixed
deleteThreadSubscription(int $thread_id)

Delete a thread subscription.

Details

in CICommon at line 18
__construct(Curl $curl, string $api_url)

CICommon constructor.

Parameters

Curl $curl
string $api_url

at line 20
mixed list(bool $all, bool $participating, string $since, string $before)

List your notifications.

Parameters

bool $all
bool $participating
string $since
string $before

Return Value

mixed

Exceptions

Exception

at line 39
mixed repository(string $repo_full_name, bool $all, bool $participating, string $since, string $before)

List your notifications in a repository.

Parameters

string $repo_full_name
bool $all
bool $participating
string $since
string $before

Return Value

mixed

Exceptions

Exception

at line 62
mixed markAsRead(string $last_read_at)

Mark as read.

205

Parameters

string $last_read_at ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ

Return Value

mixed

Exceptions

Exception

at line 76
mixed markAsReadInRepository(string $repo_full_name, string $last_read_at)

Mark notifications as read in a repository.

Parameters

string $repo_full_name
string $last_read_at

Return Value

mixed

Exceptions

Exception

at line 88
mixed viewSingleThread(int $thread_id)

View a single thread.

Parameters

int $thread_id

Return Value

mixed

Exceptions

Exception

at line 102
mixed markThreadAsRead(int $thread_id)

Mark a thread as read.

205

Parameters

int $thread_id

Return Value

mixed

Exceptions

Exception

at line 114
mixed getThreadSubscription(int $thread_id)

Get a thread subscription.

Parameters

int $thread_id

Return Value

mixed

Exceptions

Exception

at line 126
mixed setThreadSubscription(int $thread_id, bool $ignored = false)

Set a thread subscription.

Parameters

int $thread_id
bool $ignored

Return Value

mixed

Exceptions

Exception

at line 140
mixed deleteThreadSubscription(int $thread_id)

Delete a thread subscription.

204

Parameters

int $thread_id

Return Value

mixed

Exceptions

Exception