github-repos/mirai
1
0
Fork 0
mirror of https://github.com/mamoe/mirai.git synced 2025-01-30 02:30:12 +08:00
Code Issues Packages Projects Releases Wiki Activity

Improve docs

Browse Source
This commit is contained in:
Him188 2020-12-27 23:37:30 +08:00
parent 42f824d516
commit f12ee89d08
2 changed files with 7 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -158,8 +158,6 @@ public interface Group : Contact, CoroutineScope {
* - 请手动关闭输入流
* - 请使用 amr 或 silk 格式
*
* @suppress 这是一个实验性 API 且随时会被删除
*
* @throws EventCancelledException 当发送消息事件被取消
* @throws OverFileSizeMaxException 当语音文件过大而被服务器拒绝上传时. (最大大小约为 1 MB)
*/

26
mirai-core-api/src/commonMain/kotlin/utils/ExternalResource.kt
View File

@ -17,7 +17,6 @@ import net.mamoe.mirai.contact.Contact
import net.mamoe.mirai.contact.Contact.Companion.sendImage
import net.mamoe.mirai.contact.Contact.Companion.uploadImage
import net.mamoe.mirai.contact.Group
import net.mamoe.mirai.contact.User
import net.mamoe.mirai.message.MessageReceipt
import net.mamoe.mirai.message.data.Image
import net.mamoe.mirai.message.data.Voice
@ -144,16 +143,14 @@ public interface ExternalResource : Closeable {
*
* @see Contact.uploadImage 上传图片
* @see Contact.sendMessage 最终调用, 发送消息.
*
* @throws OverFileSizeMaxException
*/
@JvmBlockingBridge
@JvmStatic
@JvmName("sendAsImage")
public suspend fun <C : Contact> ExternalResource.sendAsImageTo(contact: C): MessageReceipt<C> =
when (contact) {
is Group -> contact.uploadImage(this).sendTo(contact)
is User -> contact.uploadImage(this).sendTo(contact)
else -> error("unreachable")
}
contact.uploadImage(this).sendTo(contact)
/**
* 读取 [InputStream] 到临时文件并将其作为图片发送到指定联系人
@ -162,7 +159,6 @@ public interface ExternalResource : Closeable {
*
* @throws OverFileSizeMaxException
*/
@Throws(OverFileSizeMaxException::class)
@JvmStatic
@JvmBlockingBridge
@JvmName("sendAsImage")
@ -176,7 +172,6 @@ public interface ExternalResource : Closeable {
* 将文件作为图片发送到指定联系人
* @throws OverFileSizeMaxException
*/
@Throws(OverFileSizeMaxException::class)
@JvmStatic
@JvmBlockingBridge
@JvmName("sendAsImage")
@ -195,13 +190,9 @@ public interface ExternalResource : Closeable {
*
* @see Contact.uploadImage 最终调用, 上传图片.
*/
@JvmBlockingBridge
@JvmStatic
public suspend fun ExternalResource.uploadAsImage(contact: Contact): Image = when (contact) {
is Group -> contact.uploadImage(this)
is User -> contact.uploadImage(this)
else -> error("unreachable")
}
@JvmBlockingBridge
public suspend fun ExternalResource.uploadAsImage(contact: Contact): Image = contact.uploadImage(this)
/**
* 读取 [InputStream] 到临时文件并将其作为图片上传后构造 [Image]
@ -210,7 +201,6 @@ public interface ExternalResource : Closeable {
*
* @throws OverFileSizeMaxException
*/
@Throws(OverFileSizeMaxException::class)
@JvmStatic
@JvmBlockingBridge
public suspend fun InputStream.uploadAsImage(contact: Contact): Image =
@ -221,7 +211,6 @@ public interface ExternalResource : Closeable {
* 将文件作为图片上传后构造 [Image]
* @throws OverFileSizeMaxException
*/
@Throws(OverFileSizeMaxException::class)
@JvmStatic
@JvmBlockingBridge
public suspend fun File.uploadAsImage(contact: Contact): Image {
@ -236,14 +225,13 @@ public interface ExternalResource : Closeable {
* - 请手动关闭输入流
* - 请使用 amr 或 silk 格式
*
* @suppress 注意，这只是个实验性功能且随时可能会删除
* @suppress 将来支持好友语音之后将会把参数修改为 [Contact], 这会是一个不兼容变更. 因此请优先使用 [Group.uploadVoice]
* @throws OverFileSizeMaxException
*/
@JvmBlockingBridge
@JvmStatic
@Throws(OverFileSizeMaxException::class)
@MiraiExperimentalApi
public suspend fun ExternalResource.uploadAsVoice(group: Group): Voice {
public suspend inline fun ExternalResource.uploadAsVoice(group: Group): Voice {
return group.uploadVoice(this)
}
}