github-repos/mirai
1
0
Fork 0
mirror of https://github.com/mamoe/mirai.git synced 2026-09-05 22:54:55 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add permission requirement to docs on

Browse Source 
some Announcement API
This commit is contained in:
Him188
2021-07-05 16:05:40 +08:00
parent d08c6b81a8
commit c588b5ce76
2 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
mirai-core-api/src/commonMain/kotlin/contact/announcement/Announcement.kt
View File

@@ -69,7 +69,7 @@ public sealed interface Announcement {
public val parameters: AnnouncementParameters
/**
* 在该群发布群公告并获得 [OnlineAnnouncement]. 发布公告后群内将会出现 "有新公告" 系统提示.
* 在该群发布群公告并获得 [OnlineAnnouncement], 需要管理员权限. 发布公告后群内将会出现 "有新公告" 系统提示.
* @throws PermissionDeniedException 当没有权限时抛出
* @throws IllegalStateException 当协议异常时抛出
* @see Announcements.publish
@@ -78,7 +78,7 @@ public sealed interface Announcement {
public companion object {
/**
* 在该群发布群公告并获得 [OnlineAnnouncement]. 发布公告后群内将会出现 "有新公告" 系统提示.
* 在该群发布群公告并获得 [OnlineAnnouncement], 需要管理员权限. 发布公告后群内将会出现 "有新公告" 系统提示.
*
* @param content 公告内容
* @param parameters 可选的附加参数
@@ -98,7 +98,7 @@ public sealed interface Announcement {
): OnlineAnnouncement = this.announcements.publish(OfflineAnnouncement(content, parameters))
/**
* 在该群发布群公告并获得 [OnlineAnnouncement]. 发布公告后群内将会出现 "有新公告" 系统提示.
* 在该群发布群公告并获得 [OnlineAnnouncement], 需要管理员权限. 发布公告后群内将会出现 "有新公告" 系统提示.
*
* @param content 公告内容
* @param parameters 可选的附加参数

2
mirai-core-api/src/commonMain/kotlin/contact/announcement/Announcements.kt
View File

@@ -89,7 +89,7 @@ public interface Announcements {
public suspend fun get(fid: String): OnlineAnnouncement?
/**
* 在该群发布群公告并获得 [OnlineAnnouncement]. 发布公告后群内将会出现 "有新公告" 系统提示.
* 在该群发布群公告并获得 [OnlineAnnouncement], 需要管理员权限. 发布公告后群内将会出现 "有新公告" 系统提示.
* @throws PermissionDeniedException 当没有权限时抛出
* @throws IllegalStateException 当协议异常时抛出
* @see Announcement.publishTo