TurnContext Classe
Cria uma nova instância TurnContext. :p aram adapter_or_context: solicitação :p aram:
- Herança
-
builtins.objectTurnContext
Construtor
TurnContext(adapter_or_context, request: Activity = None)
Parâmetros
Nome | Description |
---|---|
adapter_or_context
Obrigatório
|
|
request
|
Valor padrão: None
|
Métodos
apply_conversation_reference |
Atualizações uma atividade com as informações de entrega de uma referência de conversa. Chamar isso após get_conversation_reference em uma atividade de entrada abordará corretamente a resposta a uma atividade recebida. atividade :p aram: referência :p aram: :p aram is_incoming: :return: |
copy_to |
Chamado quando essa instância TurnContext é passada para o construtor de uma nova instância TurnContext. Pode ser substituído em classes derivadas. :p am contexto: :return: |
delete_activity |
Exclui uma atividade existente. :p aram id_or_reference: :return: |
get | |
get_conversation_reference |
Retorna a referência de conversa para uma atividade. Isso pode ser salvo como um objeto JSON antigo simples e depois usado para enviar mensagens proativamente ao usuário. Exemplo de uso: reference = TurnContext.get_conversation_reference(context.request) :p aram activity: :return: |
get_mentions | |
get_reply_conversation_reference | |
has |
Returns True is set() foi chamado para uma chave. O valor armazenado em cache pode ser do tipo 'None'. :p aram key: :return: |
on_delete_activity |
Registra um manipulador a ser notificado e potencialmente intercepta uma atividade que está sendo excluída. manipulador :p aram: :return: |
on_send_activities |
Registra um manipulador a ser notificado e potencialmente intercepta o envio de atividades. manipulador :p aram: :return: |
on_update_activity |
Registra um manipulador a ser notificado e potencialmente intercepta uma atividade que está sendo atualizada. manipulador :p aram: :return: |
remove_mention_text | |
remove_recipient_mention | |
send_activities | |
send_activity |
Envia uma única atividade ou mensagem ao usuário. :p aram activity_or_text: :return: |
send_trace_activity | |
set |
Armazena em cache um valor para o tempo de vida do turno atual. :p aram key: :p aram value: :return: |
update_activity |
Substitui uma atividade existente. atividade :p aram: :return: |
apply_conversation_reference
Atualizações uma atividade com as informações de entrega de uma referência de conversa. Chamar isso após get_conversation_reference em uma atividade de entrada abordará corretamente a resposta a uma atividade recebida. atividade :p aram: referência :p aram: :p aram is_incoming: :return:
static apply_conversation_reference(activity: Activity, reference: ConversationReference, is_incoming: bool = False) -> Activity
Parâmetros
Nome | Description |
---|---|
activity
Obrigatório
|
|
reference
Obrigatório
|
|
is_incoming
|
Valor padrão: False
|
copy_to
Chamado quando essa instância TurnContext é passada para o construtor de uma nova instância TurnContext. Pode ser substituído em classes derivadas. :p am contexto: :return:
copy_to(context: TurnContext) -> None
Parâmetros
Nome | Description |
---|---|
context
Obrigatório
|
|
delete_activity
Exclui uma atividade existente. :p aram id_or_reference: :return:
async delete_activity(id_or_reference: str | ConversationReference)
Parâmetros
Nome | Description |
---|---|
id_or_reference
Obrigatório
|
|
get
get(key: str) -> object
Parâmetros
Nome | Description |
---|---|
key
Obrigatório
|
|
get_conversation_reference
Retorna a referência de conversa para uma atividade. Isso pode ser salvo como um objeto JSON antigo simples e depois usado para enviar mensagens proativamente ao usuário.
Exemplo de uso: reference = TurnContext.get_conversation_reference(context.request) :p aram activity: :return:
static get_conversation_reference(activity: Activity) -> ConversationReference
Parâmetros
Nome | Description |
---|---|
activity
Obrigatório
|
|
get_mentions
static get_mentions(activity: Activity) -> List[Mention]
Parâmetros
Nome | Description |
---|---|
activity
Obrigatório
|
|
get_reply_conversation_reference
static get_reply_conversation_reference(activity: Activity, reply: ResourceResponse) -> ConversationReference
Parâmetros
Nome | Description |
---|---|
activity
Obrigatório
|
|
reply
Obrigatório
|
|
has
Returns True is set() foi chamado para uma chave. O valor armazenado em cache pode ser do tipo 'None'. :p aram key: :return:
has(key: str) -> bool
Parâmetros
Nome | Description |
---|---|
key
Obrigatório
|
|
on_delete_activity
Registra um manipulador a ser notificado e potencialmente intercepta uma atividade que está sendo excluída. manipulador :p aram: :return:
on_delete_activity(handler) -> TurnContext
Parâmetros
Nome | Description |
---|---|
handler
Obrigatório
|
|
on_send_activities
Registra um manipulador a ser notificado e potencialmente intercepta o envio de atividades. manipulador :p aram: :return:
on_send_activities(handler) -> TurnContext
Parâmetros
Nome | Description |
---|---|
handler
Obrigatório
|
|
on_update_activity
Registra um manipulador a ser notificado e potencialmente intercepta uma atividade que está sendo atualizada. manipulador :p aram: :return:
on_update_activity(handler) -> TurnContext
Parâmetros
Nome | Description |
---|---|
handler
Obrigatório
|
|
remove_mention_text
static remove_mention_text(activity: Activity, identifier: str) -> str
Parâmetros
Nome | Description |
---|---|
activity
Obrigatório
|
|
identifier
Obrigatório
|
|
remove_recipient_mention
static remove_recipient_mention(activity: Activity) -> str
Parâmetros
Nome | Description |
---|---|
activity
Obrigatório
|
|
send_activities
async send_activities(activities: List[Activity]) -> List[ResourceResponse]
Parâmetros
Nome | Description |
---|---|
activities
Obrigatório
|
|
send_activity
Envia uma única atividade ou mensagem ao usuário. :p aram activity_or_text: :return:
async send_activity(activity_or_text: Activity | str, speak: str = None, input_hint: str = None) -> ResourceResponse
Parâmetros
Nome | Description |
---|---|
activity_or_text
Obrigatório
|
|
speak
|
Valor padrão: None
|
input_hint
|
Valor padrão: None
|
send_trace_activity
async send_trace_activity(name: str, value: object = None, value_type: str = None, label: str = None) -> ResourceResponse
Parâmetros
Nome | Description |
---|---|
name
Obrigatório
|
|
value
|
Valor padrão: None
|
value_type
|
Valor padrão: None
|
label
|
Valor padrão: None
|
set
Armazena em cache um valor para o tempo de vida do turno atual. :p aram key: :p aram value: :return:
set(key: str, value: object) -> None
Parâmetros
Nome | Description |
---|---|
key
Obrigatório
|
|
value
Obrigatório
|
|
update_activity
Substitui uma atividade existente. atividade :p aram: :return:
async update_activity(activity: Activity)
Parâmetros
Nome | Description |
---|---|
activity
Obrigatório
|
|
Atributos
activity
A atividade recebida. :retorna:
responded
Se true , pelo menos uma resposta foi enviada para a virada atual da conversa. :retorna:
services
Mapa de serviços e outros valores armazenados em cache durante o tempo de vida da vez. :retorna: