(window.webpackJsonp=window.webpackJsonp||[]).push([[48],{451:function(t,s,e){"use strict";e.r(s);var a=e(55),n=Object(a.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"nonebot-session"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#nonebot-session","aria-hidden":"true"}},[t._v("#")]),t._v(" nonebot.session")]),t._v(" "),e("h2",{attrs:{id:"class-basesession-bot-event"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#class-basesession-bot-event","aria-hidden":"true"}},[t._v("#")]),t._v(" "),e("em",[t._v("class")]),t._v(" "),e("code",[t._v("BaseSession(bot, event)")])]),t._v(" "),e("ul",[e("li",[e("p",[e("strong",[t._v("说明")])]),t._v(" "),e("p",[t._v("基础 session 类，"),e("code",[t._v("CommandSession")]),t._v(" 等均继承自此类。")])]),t._v(" "),e("li",[e("p",[e("strong",[t._v("参数")])]),t._v(" "),e("ul",[e("li",[e("p",[e("code",[t._v("bot")]),t._v(" ("),e("RouterLink",{attrs:{to:"/api/#class-nonebot-config-object-none"}},[t._v("NoneBot")]),t._v(")")],1)]),t._v(" "),e("li",[e("p",[e("code",[t._v("event")]),t._v(" (aiocqhttp.event.Event)")])])])])]),t._v(" "),e("h3",{attrs:{id:"instance-var-bot"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#instance-var-bot","aria-hidden":"true"}},[t._v("#")]),t._v(" "),e("em",[t._v("instance-var")]),t._v(" "),e("code",[t._v("bot")])]),t._v(" "),e("ul",[e("li",[e("p",[e("strong",[t._v("类型:")])])]),t._v(" "),e("li",[e("p",[e("strong",[t._v("说明:")]),t._v(" Session 对应的 NoneBot 对象。")])]),t._v(" "),e("li",[e("p",[e("strong",[t._v("用法")])]),t._v(" "),e("div",{staticClass:"language-python line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-python"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" session"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("bot"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("send"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'hello'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br")])]),e("p",[t._v("在当前 Session 对应的上下文中发送 "),e("code",[t._v("hello")]),t._v("。")])])]),t._v(" "),e("h3",{attrs:{id:"property-ctx"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#property-ctx","aria-hidden":"true"}},[t._v("#")]),t._v(" "),e("em",[t._v("property")]),t._v(" "),e("code",[t._v("ctx")]),t._v(" "),e("Badge",{attrs:{text:"1.5.0-",type:"error"}})],1),t._v(" "),e("ul",[e("li",[e("p",[e("strong",[t._v("类型:")]),t._v(" aiocqhttp.event.Event")])]),t._v(" "),e("li",[e("p",[e("strong",[t._v("说明:")]),t._v(" CQHTTP 上报的事件数据对象，或称事件上下文，具体请参考 "),e("a",{attrs:{href:"https://cqhttp.cc/docs/#/Post",target:"_blank",rel:"noopener noreferrer"}},[t._v("事件上报"),e("OutboundLink")],1),t._v("。")])]),t._v(" "),e("li",[e("p",[e("strong",[t._v("用法")])]),t._v(" "),e("div",{staticClass:"language-python line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-python"}},[e("code",[t._v("user_id "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" session"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("ctx"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'user_id'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br")])]),e("p",[t._v("获取当前事件的 "),e("code",[t._v("user_id")]),t._v(" 字段。")])])]),t._v(" "),e("h3",{attrs:{id:"instance-var-event"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#instance-var-event","aria-hidden":"true"}},[t._v("#")]),t._v(" "),e("em",[t._v("instance-var")]),t._v(" "),e("code",[t._v("event")]),t._v(" "),e("Badge",{attrs:{text:"1.5.0+"}})],1),t._v(" "),e("ul",[e("li",[e("p",[e("strong",[t._v("类型:")])])]),t._v(" "),e("li",[e("p",[e("strong",[t._v("说明:")]),t._v(" CQHTTP 上报的事件数据对象，具体请参考 "),e("a",{attrs:{href:"https://aiocqhttp.nonebot.dev/module/aiocqhttp/index.html#aiocqhttp.Event",target:"_blank",rel:"noopener noreferrer"}},[e("code",[t._v("aiocqhttp.Event")]),e("OutboundLink")],1),t._v(" 和 "),e("a",{attrs:{href:"https://cqhttp.cc/docs/#/Post",target:"_blank",rel:"noopener noreferrer"}},[t._v("事件上报"),e("OutboundLink")],1),t._v("。")])]),t._v(" "),e("li",[e("p",[e("strong",[t._v("用法")])]),t._v(" "),e("div",{staticClass:"language-python line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-python"}},[e("code",[t._v("user_id "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" session"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("event"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'user_id'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\ngroup_id "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" session"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("event"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("group_id\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br")])]),e("p",[t._v("获取当前事件的 "),e("code",[t._v("user_id")]),t._v(" 和 "),e("code",[t._v("group_id")]),t._v(" 字段。")])])]),t._v(" "),e("h3",{attrs:{id:"property-self-id"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#property-self-id","aria-hidden":"true"}},[t._v("#")]),t._v(" "),e("em",[t._v("property")]),t._v(" "),e("code",[t._v("self_id")]),t._v(" "),e("Badge",{attrs:{text:"1.1.0+"}})],1),t._v(" "),e("ul",[e("li",[e("p",[e("strong",[t._v("类型:")]),t._v(" int")])]),t._v(" "),e("li",[e("p",[e("strong",[t._v("说明")])]),t._v(" "),e("p",[t._v("当前 session 对应的 QQ 机器人账号，在多个机器人账号使用同一个 NoneBot 后端时可用于区分当前收到消息或事件的是哪一个机器人。")]),t._v(" "),e("p",[t._v("等价于 "),e("code",[t._v("session.event.self_id")]),t._v("。")])]),t._v(" "),e("li",[e("p",[e("strong",[t._v("用法")])]),t._v(" "),e("div",{staticClass:"language-python line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-python"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" bot"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("send_private_msg"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("self_id"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v("session"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("self_id"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" user_id"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("12345678")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" message"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Hello'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br")])])])]),t._v(" "),e("h3",{attrs:{id:"async-method-send-self-message-at-sender-false-ensure-private-false-ignore-failure-true-kwargs"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#async-method-send-self-message-at-sender-false-ensure-private-false-ignore-failure-true-kwargs","aria-hidden":"true"}},[t._v("#")]),t._v(" "),e("em",[t._v("async method")]),t._v(" "),e("code",[t._v("send(self, message, *, at_sender=False, ensure_private=False, ignore_failure=True, **kwargs)")])]),t._v(" "),e("ul",[e("li",[e("p",[e("strong",[t._v("说明")])]),t._v(" "),e("p",[t._v("发送消息到 Session 对应的上下文中。")])]),t._v(" "),e("li",[e("p",[e("strong",[t._v("参数")])]),t._v(" "),e("ul",[e("li",[e("p",[e("code",[t._v("message")]),t._v(" ("),e("RouterLink",{attrs:{to:"/api/typing.html#var-message-t"}},[t._v("Message_T")]),t._v("): 要发送的消息内容")],1)]),t._v(" "),e("li",[e("p",[e("code",[t._v("at_sender")]),t._v(" (bool): 是否 @ 发送者，对私聊不起作用")])]),t._v(" "),e("li",[e("p",[e("code",[t._v("ensure_private")]),t._v(" (bool): 确保消息发送到私聊，对于群组和讨论组消息上下文，会私聊发送者")])]),t._v(" "),e("li",[e("p",[e("code",[t._v("ignore_failure")]),t._v(" (bool): 发送失败时忽略 "),e("code",[t._v("CQHttpError")]),t._v(" 异常")])]),t._v(" "),e("li",[e("p",[e("code",[t._v("**kwargs")]),t._v(": 其它传入 "),e("code",[t._v("CQHttp.send()")]),t._v(" 的命名参数")])])])]),t._v(" "),e("li",[e("p",[e("strong",[t._v("返回")])]),t._v(" "),e("ul",[e("li",[t._v("Any "),e("Badge",{attrs:{text:"1.1.0+"}}),t._v(": 返回 CQHTTP 插件发送消息接口的调用返回值，具体见 aiocqhttp 的 "),e("a",{attrs:{href:"https://aiocqhttp.nonebot.dev/#/what-happened#api-%E8%B0%83%E7%94%A8",target:"_blank",rel:"noopener noreferrer"}},[t._v("API 调用"),e("OutboundLink")],1)],1)])]),t._v(" "),e("li",[e("p",[e("strong",[t._v("异常")])]),t._v(" "),e("ul",[e("li",[e("code",[t._v("CQHttpError")]),t._v(": 发送失败时抛出，实际由 [aiocqhttp] 抛出，等价于 "),e("code",[t._v("aiocqhttp.Error")])])])]),t._v(" "),e("li",[e("p",[e("strong",[t._v("用法")])]),t._v(" "),e("div",{staticClass:"language-python line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-python"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" session"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("send"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'hello'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br")])]),e("p",[t._v("在当前 Session 对应的上下文中发送 "),e("code",[t._v("hello")]),t._v("。")])])])])},[],!1,null,null,null);s.default=n.exports}}]);