simbot-component-tencent-guild-api/love.forte.simbot.tencentguild.api.message.direct/DmsSendApi

DmsSendApi

class DmsSendApi : TencentApi<TencentMessage>

发送私信

接口

POST /dms/{guild_id}/messages

功能描述

用于发送私信消息，前提是已经创建了私信会话。

  • 私信的 guild_id 在创建私信会话时以及私信消息事件中获取。

  • 私信场景下，每个机器人每天可以对一个用户发 2 条主动消息。

  • 私信场景下，每个机器人每天累计可以发 200 条主动消息。

  • 私信场景下，被动消息没有条数限制。

参数

和 发送消息 参数一致。

返回

和 发送消息 返回一致。

Author

ForteScarlet

See also

Constructors

Link copied to clipboard
@JvmOverloads
fun DmsSendApi(guildId: ID, content: String, msgId: ID? = null)
Link copied to clipboard
@JvmOverloads
fun DmsSendApi(guildId: ID, embed: TencentMessage.Embed, msgId: ID? = null)
Link copied to clipboard
@JvmOverloads
fun DmsSendApi(guildId: ID, ark: TencentMessage.Ark, msgId: ID? = null)
Link copied to clipboard
@JvmOverloads
fun DmsSendApi(guildId: ID, sendingBody: TencentMessageForSending, fileImage: Resource? = null)
Link copied to clipboard
fun DmsSendApi(guildId: ID, fileImage: Resource)

Functions

Link copied to clipboard
open suspend fun doRequest(client: HttpClient, server: Url, token: String, decoder: StringFormat = Json): TencentMessage

使用此api发起一次请求，并得到预期中的结果。如果返回了代表错误的响应值

Link copied to clipboard
open fun post(resp: TencentMessage)

Do something after resp.

Link copied to clipboard
open override fun route(builder: RouteInfoBuilder)

此请求对应的api路由路径以及路径参数。 例如：/guild/list

Properties

Link copied to clipboard
open override val body: Any

此次请求所发送的数据。为null则代表没有参数。

Link copied to clipboard
open override val method: HttpMethod

此api请求方式

Link copied to clipboard
open override val resultDeserializer: DeserializationStrategy<out TencentMessage>

得到响应值的反序列化器.

Extensions

Link copied to clipboard
suspend fun <R> TencentApi<R>.request(client: HttpClient, server: Url, token: String, decoder: StringFormat = defaultJson): R

通过提供的参数，对此api进行请求并得到最终结果。