Notifications
扩展 AbstractPackageJoomla 框架的 GitHub API 活动事件类。
| link | |
|---|---|
| since |
1.0 |
| package |
Joomla 框架 |
方法
__construct
构造函数。
__construct(\Joomla\Registry\Registry options = null, \Joomla\Http\Http client = null) :
__get
延迟创建 API 对象的魔术方法
__get( name) : \Joomla\Github\AbstractPackage
deleteThreadSubscription
删除主题订阅。
deleteThreadSubscription( id) :
| since |
1.0 |
|---|
参数
- id
int主题 ID。
响应
对象
fetchUrl
构建并返回完整请求 URL 的方法。此方法将在必要时添加适当的分页详细信息，并将 API URL 添加到请求以获得完整的 URL。
fetchUrl( path, page, limit) : \Joomla\Uri\Uri
getList
列出您的通知。
getList( all = true, participating = true, \DateTimeInterface since = null, \DateTimeInterface before = null) :
列出当前用户的所有通知，按仓库分组。
| since |
1.0 |
|---|
参数
- all
booltrue 表示显示标记为已读的通知。- participating
booltrue 表示仅显示用户直接参与或被提及的通知。- since
DateTimeInterface|null仅显示在给定时间后更新的通知。- before
DateTimeInterface|null仅显示在给定时间之前更新的通知。
响应
对象
getListRepository
列出您在仓库中的通知。
getListRepository( owner, repo, all = true, participating = true, \DateTimeInterface since = null, \DateTimeInterface before = null) :
列出当前用户的所有通知。
| since |
1.0 |
|---|
参数
- owner
string仓库所有者。- repo
string仓库名称。- all
booltrue 表示显示标记为已读的通知。- participating
booltrue 表示仅显示用户直接参与或被提及的通知。- since
DateTimeInterface|null仅显示在给定时间后更新的通知。- before
DateTimeInterface|null仅显示在给定时间之前更新的通知。
响应
对象
getThreadSubscription
获取主题订阅。
getThreadSubscription( id) :
这将检查当前用户是否订阅了主题。您也可以获取仓库订阅。
| since |
1.0 |
|---|
参数
- id
int主题 ID。
响应
对象
markRead
标记为已读。
markRead( unread = true, read = true, \DateTimeInterface lastReadAt = null) :
将通知标记为“已读”会将其从 GitHub.com 上的默认视图中删除。
| since |
1.0 |
|---|
参数
- unread
bool更改主题的未读状态。- read
bool“unread”的反义词。- lastReadAt
DateTimeInterface|null描述上次检查通知的时间。自该时间以来更新的任何内容都不会更新。默认：现在。以 ISO 8601 格式表示。
响应
对象
markReadRepository
将仓库中的通知标记为已读。
markReadRepository( owner, repo, unread, read, \DateTimeInterface lastReadAt = null) :
将仓库中的所有通知标记为“已读”会将其从 GitHub.com 上的默认视图中删除。
| since |
1.0 |
|---|
参数
- owner
string仓库所有者。- repo
string仓库名称。- unread
bool更改主题的未读状态。- read
bool“unread”的反义词。- lastReadAt
DateTimeInterface|null描述上次检查通知的时间。自该时间以来更新的任何内容都不会更新。默认：现在。以 ISO 8601 格式表示。
响应
对象
markReadThread
将主题标记为已读。
markReadThread( id, unread = true, read = true) :
| since |
1.0 |
|---|
参数
- id
int主题 ID。- unread
bool更改主题的未读状态。- read
bool“unread”的反义词。
响应
对象
processResponse
处理响应并对其进行解码。
processResponse(\Joomla\Http\Response response, expectedCode = 200) :
setThreadSubscription
设置主题订阅。
setThreadSubscription( id, subscribed, ignored) :
这允许您订阅主题或忽略主题。如果您已经订阅了仓库，则不需要订阅主题。忽略主题将静音所有未来的通知（直到您发表评论或被 @提及）。
| since |
1.0 |
|---|
参数
- id
int主题 ID。- subscribed
bool确定是否应从该主题接收通知。- ignored
bool确定是否应阻止该主题的所有通知。
响应
对象
viewThread
查看单个主题。
viewThread( id) :
| since |
1.0 |
|---|
参数
- id
int主题 ID。
响应
对象
属性
package
对象所在的包
| since |
1.0 |
|---|
类型
string
hookEvents
包含允许的挂钩事件的数组
| since |
1.5.2 |
|---|---|
| link | |
| note |
从 1.4.0 到 1.5.1，它被称为 $events，由于与包子类命名冲突，它被重命名了 |
类型
array<string|int, mixed>