TurnContext 类
创建新的 TurnContext 实例。 :p aram adapter_or_context::p aram 请求:
- 继承
-
builtins.objectTurnContext
构造函数
TurnContext(adapter_or_context, request: Activity = None)
参数
名称 | 说明 |
---|---|
adapter_or_context
必需
|
|
request
|
默认值: None
|
方法
apply_conversation_reference |
使用对话引用中的传递信息汇报活动。 在传入活动上get_conversation_reference后调用此方法将正确处理对收到的活动的答复。 :p aram 活动: :p aram reference: :p aram is_incoming: :return: |
copy_to |
当此 TurnContext 实例传递到新的 TurnContext 实例的构造函数时调用。 可以在派生类中重写。 :p aram context: :return: |
delete_activity |
删除现有活动。 :p aram id_or_reference: :return: |
get | |
get_conversation_reference |
返回活动的会话引用。 这可以保存为普通的旧 JSON 对象,然后用于主动向用户发送消息。 使用示例:reference = TurnContext.get_conversation_reference (context.request) :p aram activity: :return: |
get_mentions | |
get_reply_conversation_reference | |
has |
返回 True 设置为 () 已为键调用。 缓存的值可以是“None”类型。 :p aram 键: :return: |
on_delete_activity |
注册处理程序以接收通知,并可能截获正在删除的活动。 :p aram 处理程序: :return: |
on_send_activities |
注册处理程序以接收通知,并可能截获活动的发送。 :p aram 处理程序: :return: |
on_update_activity |
注册要通知的处理程序,并可能截获正在更新的活动。 :p aram 处理程序: :return: |
remove_mention_text | |
remove_recipient_mention | |
send_activities | |
send_activity |
向用户发送单个活动或消息。 :p aram activity_or_text: :return: |
send_trace_activity | |
set |
缓存当前轮次生存期的值。 :p aram 键: :p aram 值: :return: |
update_activity |
替换现有活动。 :p aram 活动: :return: |
apply_conversation_reference
使用对话引用中的传递信息汇报活动。 在传入活动上get_conversation_reference后调用此方法将正确处理对收到的活动的答复。 :p aram 活动: :p aram reference: :p aram is_incoming: :return:
static apply_conversation_reference(activity: Activity, reference: ConversationReference, is_incoming: bool = False) -> Activity
参数
名称 | 说明 |
---|---|
activity
必需
|
|
reference
必需
|
|
is_incoming
|
默认值: False
|
copy_to
当此 TurnContext 实例传递到新的 TurnContext 实例的构造函数时调用。 可以在派生类中重写。 :p aram context: :return:
copy_to(context: TurnContext) -> None
参数
名称 | 说明 |
---|---|
context
必需
|
|
delete_activity
删除现有活动。 :p aram id_or_reference: :return:
async delete_activity(id_or_reference: str | ConversationReference)
参数
名称 | 说明 |
---|---|
id_or_reference
必需
|
|
get
get(key: str) -> object
参数
名称 | 说明 |
---|---|
key
必需
|
|
get_conversation_reference
返回活动的会话引用。 这可以保存为普通的旧 JSON 对象,然后用于主动向用户发送消息。
使用示例:reference = TurnContext.get_conversation_reference (context.request) :p aram activity: :return:
static get_conversation_reference(activity: Activity) -> ConversationReference
参数
名称 | 说明 |
---|---|
activity
必需
|
|
get_mentions
static get_mentions(activity: Activity) -> List[Mention]
参数
名称 | 说明 |
---|---|
activity
必需
|
|
get_reply_conversation_reference
static get_reply_conversation_reference(activity: Activity, reply: ResourceResponse) -> ConversationReference
参数
名称 | 说明 |
---|---|
activity
必需
|
|
reply
必需
|
|
has
返回 True 设置为 () 已为键调用。 缓存的值可以是“None”类型。 :p aram 键: :return:
has(key: str) -> bool
参数
名称 | 说明 |
---|---|
key
必需
|
|
on_delete_activity
注册处理程序以接收通知,并可能截获正在删除的活动。 :p aram 处理程序: :return:
on_delete_activity(handler) -> TurnContext
参数
名称 | 说明 |
---|---|
handler
必需
|
|
on_send_activities
注册处理程序以接收通知,并可能截获活动的发送。 :p aram 处理程序: :return:
on_send_activities(handler) -> TurnContext
参数
名称 | 说明 |
---|---|
handler
必需
|
|
on_update_activity
注册要通知的处理程序,并可能截获正在更新的活动。 :p aram 处理程序: :return:
on_update_activity(handler) -> TurnContext
参数
名称 | 说明 |
---|---|
handler
必需
|
|
remove_mention_text
static remove_mention_text(activity: Activity, identifier: str) -> str
参数
名称 | 说明 |
---|---|
activity
必需
|
|
identifier
必需
|
|
remove_recipient_mention
static remove_recipient_mention(activity: Activity) -> str
参数
名称 | 说明 |
---|---|
activity
必需
|
|
send_activities
async send_activities(activities: List[Activity]) -> List[ResourceResponse]
参数
名称 | 说明 |
---|---|
activities
必需
|
|
send_activity
向用户发送单个活动或消息。 :p aram activity_or_text: :return:
async send_activity(activity_or_text: Activity | str, speak: str = None, input_hint: str = None) -> ResourceResponse
参数
名称 | 说明 |
---|---|
activity_or_text
必需
|
|
speak
|
默认值: None
|
input_hint
|
默认值: None
|
send_trace_activity
async send_trace_activity(name: str, value: object = None, value_type: str = None, label: str = None) -> ResourceResponse
参数
名称 | 说明 |
---|---|
name
必需
|
|
value
|
默认值: None
|
value_type
|
默认值: None
|
label
|
默认值: None
|
set
缓存当前轮次生存期的值。 :p aram 键: :p aram 值: :return:
set(key: str, value: object) -> None
参数
名称 | 说明 |
---|---|
key
必需
|
|
value
必需
|
|
update_activity
替换现有活动。 :p aram 活动: :return:
async update_activity(activity: Activity)
参数
名称 | 说明 |
---|---|
activity
必需
|
|
属性
activity
收到的活动。 :return:
responded
如果 为 true ,则至少为当前会话轮次发送了一个响应。 :return:
services
服务和其他值在轮次生存期内缓存的映射。 :return: