Activity Classe

Riferimento

Un'attività è il tipo di comunicazione di base per il protocollo Bot Framework 3.0.

Costruttore

Activity(*, type=None, id: str = None, timestamp=None, local_timestamp=None, local_timezone: str = None, service_url: str = None, channel_id: str = None, from_property=None, conversation=None, recipient=None, text_format=None, attachment_layout=None, members_added=None, members_removed=None, reactions_added=None, reactions_removed=None, topic_name: str = None, history_disclosed: bool = None, locale: str = None, text: str = None, speak: str = None, input_hint=None, summary: str = None, suggested_actions=None, attachments=None, entities=None, channel_data=None, action: str = None, reply_to_id: str = None, label: str = None, value_type: str = None, value=None, name: str = None, relates_to=None, code=None, expiration=None, importance=None, delivery_mode=None, listen_for=None, text_highlights=None, semantic_action=None, caller_id: str = None, **kwargs)

Parametri

Nome	Descrizione
type Necessario	str oppure <xref:botframework.connector.models.ActivityTypes> Contiene il tipo di attività. I valori possibili includono: 'message', 'contactRelationUpdate', 'conversationUpdate', 'typing', 'endOfConversation', 'event', 'invoke', 'deleteUserData', 'messageUpdate', 'messageDelete', 'installationUpdate', 'messageReaction', 'suggestion', 'trace', 'handoff'
id Necessario	str Contiene un ID che identifica in modo univoco l'attività nel canale.
timestamp Necessario	datetime Contiene la data e l'ora in cui il messaggio è stato inviato, in formato UTC, espresso in formato ISO-8601.
local_timestamp Necessario	datetime Contiene la data e l'ora locali del messaggio espresso in formato ISO-8601. Ad esempio, 2016-09-23T13:07:49.4714686-07:00.
local_timezone Necessario	str Contiene il nome del fuso orario locale del messaggio, espresso in formato di database del fuso orario IANA. Ad esempio, America/Los_Angeles.
service_url Necessario	str Contiene l'URL che specifica l'endpoint del servizio del canale. Impostato dal canale.
channel_id Necessario	str Contiene un ID che identifica in modo univoco il canale. Impostato dal canale.
from_property Necessario	<xref:botframework.connector.models.ChannelAccount> Identifica il mittente del messaggio.
conversation Necessario	<xref:botframework.connector.models.ConversationAccount> Identifica la conversazione a cui appartiene l'attività.
recipient Necessario	<xref:botframework.connector.models.ChannelAccount> Identifica il destinatario del messaggio.
text_format Necessario	str oppure <xref:botframework.connector.models.TextFormatTypes> Formato dei campi di testo Default:markdown. I valori possibili includono: 'markdown', 'plain', 'xml'
attachment_layout Necessario	str oppure <xref:botframework.connector.models.AttachmentLayoutTypes> Hint di layout per più allegati. Impostazione predefinita: elenco. I valori possibili includono: 'list', 'carousel'
members_added Necessario	list[<xref:botframework.connector.models.ChannelAccount>] Raccolta di membri aggiunti alla conversazione.
members_removed Necessario	list[<xref:botframework.connector.models.ChannelAccount>] Raccolta di membri rimossi dalla conversazione.
reactions_added Necessario	list[<xref:botframework.connector.models.MessageReaction>] Raccolta di reazioni aggiunte alla conversazione.
reactions_removed Necessario	list[<xref:botframework.connector.models.MessageReaction>] Raccolta di reazioni rimosse dalla conversazione.
topic_name Necessario	str Nome dell'argomento aggiornato della conversazione.
history_disclosed Necessario	bool Indica se la cronologia precedente del canale viene divulgata.
locale Necessario	str Nome delle impostazioni locali per il contenuto del campo di testo. Il nome delle impostazioni locali è una combinazione di codice delle impostazioni cultura ISO 639 a due o tre lettere associato a una lingua e a un codice di sottoculture a due lettere ISO 3166 associato a un paese o a un'area geografica. Il nome delle impostazioni locali può corrispondere anche a un tag di lingua BCP-47 valido.
text Necessario	str Contenuto di testo del messaggio.
speak Necessario	str Testo da pronunciare.
input_hint Necessario	str oppure <xref:botframework.connector.models.InputHints> Indica se il bot accetta, prevede o ignora l'input dell'utente dopo che il messaggio viene recapitato al client. I valori possibili includono: 'acceptingInput', 'ignoringInput', 'expectingInput'
summary Necessario	str Testo da visualizzare se il canale non è in grado di eseguire il rendering delle schede.
suggested_actions Necessario	<xref:botframework.connector.models.SuggestedActions> Azioni suggerite per l'attività.
attachments Necessario	list[<xref:botframework.connector.models.Attachment>] Allegati
entities Necessario	list[<xref:botframework.connector.models.Entity>] Rappresenta le entità menzionate nel messaggio.
channel_data Necessario	object Contiene contenuto specifico del canale.
action Necessario	str Indica se il destinatario di un contactRelationUpdate è stato aggiunto o rimosso dall'elenco contatti del mittente.
reply_to_id Necessario	str Contiene l'ID del messaggio a cui il messaggio è una risposta.
label Necessario	str Etichetta descrittiva per l'attività.
value_type Necessario	str Tipo dell'oggetto valore dell'attività.
value Necessario	object Valore associato all'attività.
name Necessario	str Nome dell'operazione associata a un'attività invoke o evento.
relates_to Necessario	<xref:botframework.connector.models.ConversationReference> Riferimento a un'altra conversazione o attività.
code Necessario	str oppure <xref:botframework.connector.models.EndOfConversationCodes> Codice per le attività endOfConversation che indica il motivo per cui la conversazione è terminata. I valori possibili includono: 'unknown', 'completedSuccessly', 'userCancelled', 'botTimedOut', 'botIssuedInvalidMessage', 'channelFailed'
expiration Necessario	datetime Il momento in cui l'attività deve essere considerata "scaduta" e non deve essere presentata al destinatario.
importance Necessario	str oppure <xref:botframework.connector.models.ActivityImportance> Importanza dell'attività. I valori possibili includono: 'low', 'normal', 'high'
delivery_mode Necessario	str oppure <xref:botframework.connector.models.DeliveryModes> Suggerimento di recapito per segnalare al destinatario percorsi di recapito alternativi per l'attività. La modalità di recapito predefinita è "default". I valori possibili includono: 'normal', 'notification', 'expectReplies', 'ephemeral'
listen_for Necessario	list[str] Elenco di frasi e riferimenti per i quali i sistemi di priming del parlato e della lingua devono essere in ascolto
text_highlights Necessario	list[<xref:botframework.connector.models.TextHighlight>] Raccolta di frammenti di testo da evidenziare quando l'attività contiene un valore ReplyToId.
semantic_action Necessario	<xref:botframework.connector.models.SemanticAction> Azione a livello di codice facoltativa associata a questa richiesta
caller_id Necessario	str Stringa contenente un IRI che identifica il chiamante di un bot. Questo campo non deve essere trasmesso in rete, ma viene popolato da bot e client basati su dati verificabili crittograficamente che asserisce l'identità dei chiamanti (ad esempio token).

Parametri di sole parole chiave

Nome	Descrizione
type Necessario
id Necessario
timestamp Necessario
local_timestamp Necessario
local_timezone Necessario
service_url Necessario
channel_id Necessario
from_property Necessario
conversation Necessario
recipient Necessario
text_format Necessario
attachment_layout Necessario
members_added Necessario
members_removed Necessario
reactions_added Necessario
reactions_removed Necessario
topic_name Necessario
history_disclosed Necessario
locale Necessario
text Necessario
speak Necessario
input_hint Necessario
summary Necessario
suggested_actions Necessario
attachments Necessario
entities Necessario
channel_data Necessario
action Necessario
reply_to_id Necessario
label Necessario
value_type Necessario
value Necessario
name Necessario
relates_to Necessario
code Necessario
expiration Necessario
importance Necessario
delivery_mode Necessario
listen_for Necessario
text_highlights Necessario
semantic_action Necessario
caller_id Necessario

Metodi

apply_conversation_reference	Aggiorna questa attività con le informazioni di recapito da un conversationReference esistente attività in ingresso, dove il bot è il destinatario; in caso contrario, False. Il valore predefinito è False e l'attività mostrerà il bot come mittente.
as_contact_relation_update_activity	Restituisce questa attività come oggetto ContactRelationUpdateActivity; o Nessuno, se questo non è questo tipo di attività.
as_conversation_update_activity	Restituisce questa attività come oggetto ConversationUpdateActivity; o Nessuno, se questo non è questo tipo di attività.
as_end_of_conversation_activity	Restituisce questa attività come oggetto EndOfConversationActivity; o Nessuno, se questo non è questo tipo di attività.
as_event_activity	Restituisce questa attività come oggetto EventActivity; o Nessuno, se questo non è questo tipo di attività.
as_handoff_activity	Restituisce questa attività come oggetto HandoffActivity; o Nessuno, se questo non è questo tipo di attività.
as_installation_update_activity	Restituisce questa attività come oggetto InstallationUpdateActivity; o Nessuno, se questo non è questo tipo di attività.
as_invoke_activity	Restituisce questa attività come oggetto InvokeActivity; o Nessuno, se questo non è questo tipo di attività.
as_message_activity	Restituisce questa attività come oggetto MessageActivity; o Nessuno, se questo non è questo tipo di attività.
as_message_delete_activity	Restituisce questa attività come oggetto MessageDeleteActivity; o Nessuno, se questo non è questo tipo di attività.
as_message_reaction_activity	Restituisce questa attività come oggetto MessageReactionActivity; o Nessuno, se questo non è questo tipo di attività.
as_message_update_activity	Restituisce questa attività come oggetto MessageUpdateActivity; o Nessuno, se questo non è questo tipo di attività.
as_suggestion_activity	Restituisce questa attività come oggetto SuggestionActivity; o Nessuno, se questo non è questo tipo di attività.
as_trace_activity	Restituisce questa attività come oggetto TraceActivity; o Nessuno, se questo non è questo tipo di attività.
as_typing_activity	Restituisce questa attività come oggetto TypingActivity; o Null, se questo non è il tipo di attività.
create_contact_relation_update_activity	Crea un'istanza della classe Activity come oggettoContactRelationUpdateActivity.
create_conversation_update_activity	Crea un'istanza della classe Activity come oggetto ConversationUpdateActivity.
create_end_of_conversation_activity	Crea un'istanza della classe Activity come oggetto EndOfConversationActivity.
create_event_activity	Crea un'istanza della classe Activity come oggetto EventActivity.
create_handoff_activity	Crea un'istanza della classe Activity come oggetto HandoffActivity.
create_invoke_activity	Crea un'istanza della classe Activity come oggetto InvokeActivity.
create_message_activity	Crea un'istanza della classe Activity come oggetto MessageActivity.
create_reply	Crea una nuova attività di messaggio come risposta a questa attività.
create_trace	Crea una nuova attività di traccia basata su questa attività. Il valore predefinito è il nome di tipo del valore. :p aram etichetta: facoltativa, un'etichetta descrittiva per questa operazione di traccia.
create_trace_activity	Crea un'istanza della classe Activity come oggetto TraceActivity. Il valore predefinito è il nome di tipo del valore. :p aram etichetta: facoltativa, un'etichetta descrittiva per questa operazione di traccia.
create_typing_activity	Crea un'istanza della classe Activity come oggetto TypingActivity.
get_conversation_reference	Crea un oggetto ConversationReference basato su questa attività.
get_mentions	Risolve le menzioni dalle entità di questa attività.
get_reply_conversation_reference	Creare un oggetto ConversationReference in base alle informazioni di conversazione di questa attività e a ResourceResponse dall'invio di un'attività.
has_content	Indica se l'attività ha contenuto.
is_from_streaming_connection	Determinare se l'attività è stata inviata tramite una connessione Http/Https o Streaming Questo può essere determinato esaminando la proprietà service_url: (1) Tutti i canali che inviano messaggi tramite http/https non sono in streaming (2) Canali che inviano messaggi tramite streaming hanno un ServiceUrl che non inizia con http/https.

apply_conversation_reference

Aggiorna questa attività con le informazioni di recapito da un conversationReference esistente

attività in ingresso, dove il bot è il destinatario; in caso contrario, False. Il valore predefinito è False e l'attività mostrerà il bot come mittente.

apply_conversation_reference(reference: ConversationReference, is_incoming: bool = False)

Parametri

Nome	Descrizione
reference Necessario
is_incoming	Valore predefinito: False

Restituisce

Tipo	Descrizione
	la sua attività, aggiornata con le informazioni di consegna.

Commenti

Chiamare GetConversationReference su un'attività in ingresso per ottenere un riferimento di conversazione che è quindi possibile usare per aggiornare un'attività in uscita con le informazioni di recapito corrette.

as_contact_relation_update_activity

Restituisce questa attività come oggetto ContactRelationUpdateActivity; o Nessuno, se questo non è questo tipo di attività.

as_contact_relation_update_activity()

Restituisce

Tipo	Descrizione
	Questa attività come attività di messaggio; o Nessuno.

as_conversation_update_activity

Restituisce questa attività come oggetto ConversationUpdateActivity; o Nessuno, se questo non è questo tipo di attività.

as_conversation_update_activity()

Restituisce

Tipo	Descrizione
	Questa attività come attività di aggiornamento della conversazione; o Nessuno.

as_end_of_conversation_activity

Restituisce questa attività come oggetto EndOfConversationActivity; o Nessuno, se questo non è questo tipo di attività.

as_end_of_conversation_activity()

Restituisce

Tipo	Descrizione
	Questa attività come fine dell'attività di conversazione; o Nessuno.

as_event_activity

Restituisce questa attività come oggetto EventActivity; o Nessuno, se questo non è questo tipo di attività.

as_event_activity()

Restituisce

Tipo	Descrizione
	Questa attività come attività evento; o Nessuno.

as_handoff_activity

Restituisce questa attività come oggetto HandoffActivity; o Nessuno, se questo non è questo tipo di attività.

as_handoff_activity()

Restituisce

Tipo	Descrizione
	Questa attività come attività di consegna; o Nessuno.

as_installation_update_activity

Restituisce questa attività come oggetto InstallationUpdateActivity; o Nessuno, se questo non è questo tipo di attività.

as_installation_update_activity()

Restituisce

Tipo	Descrizione
	Questa attività come attività di aggiornamento dell'installazione; o Nessuno.

as_invoke_activity

Restituisce questa attività come oggetto InvokeActivity; o Nessuno, se questo non è questo tipo di attività.

as_invoke_activity()

Restituisce

Tipo	Descrizione
	Questa attività come attività invoke; o Nessuno.

as_message_activity

Restituisce questa attività come oggetto MessageActivity; o Nessuno, se questo non è questo tipo di attività.

as_message_activity()

Restituisce

Tipo	Descrizione
	Questa attività come attività di messaggio; o Nessuno.

as_message_delete_activity

Restituisce questa attività come oggetto MessageDeleteActivity; o Nessuno, se questo non è questo tipo di attività.

as_message_delete_activity()

Restituisce

Tipo	Descrizione
	Questa attività come richiesta di eliminazione di messaggi; o Nessuno.

as_message_reaction_activity

Restituisce questa attività come oggetto MessageReactionActivity; o Nessuno, se questo non è questo tipo di attività.

as_message_reaction_activity()

Restituisce

Tipo	Descrizione
	Questa attività come attività di reazione al messaggio; o Nessuno.

as_message_update_activity

Restituisce questa attività come oggetto MessageUpdateActivity; o Nessuno, se questo non è questo tipo di attività.

as_message_update_activity()

Restituisce

Tipo	Descrizione
	Questa attività come richiesta di aggiornamento dei messaggi; o Nessuno.

as_suggestion_activity

Restituisce questa attività come oggetto SuggestionActivity; o Nessuno, se questo non è questo tipo di attività.

as_suggestion_activity()

Restituisce

Tipo	Descrizione
	Questa attività come attività di suggerimento; o Nessuno.

as_trace_activity

Restituisce questa attività come oggetto TraceActivity; o Nessuno, se questo non è questo tipo di attività.

as_trace_activity()

Restituisce

Tipo	Descrizione
	Questa attività come attività di traccia; o Nessuno.

as_typing_activity

Restituisce questa attività come oggetto TypingActivity; o Null, se questo non è il tipo di attività.

as_typing_activity()

Restituisce

Tipo	Descrizione
	Questa attività come attività di digitazione; o Null.

create_contact_relation_update_activity

Crea un'istanza della classe Activity come oggettoContactRelationUpdateActivity.

static create_contact_relation_update_activity()

Restituisce

Tipo	Descrizione
	Nuova attività di aggiornamento della relazione di contatto.

create_conversation_update_activity

Crea un'istanza della classe Activity come oggetto ConversationUpdateActivity.

static create_conversation_update_activity()

Restituisce

Tipo	Descrizione
	Nuova attività di aggiornamento della conversazione.

create_end_of_conversation_activity

Crea un'istanza della classe Activity come oggetto EndOfConversationActivity.

static create_end_of_conversation_activity()

Restituisce

Tipo	Descrizione
	Nuova fine dell'attività di conversazione.

create_event_activity

Crea un'istanza della classe Activity come oggetto EventActivity.

static create_event_activity()

Restituisce

Tipo	Descrizione
	Nuova attività evento.

create_handoff_activity

Crea un'istanza della classe Activity come oggetto HandoffActivity.

static create_handoff_activity()

Restituisce

Tipo	Descrizione
	Nuova attività di handoff.

create_invoke_activity

Crea un'istanza della classe Activity come oggetto InvokeActivity.

static create_invoke_activity()

Restituisce

Tipo	Descrizione
	Nuova attività invoke.

create_message_activity

Crea un'istanza della classe Activity come oggetto MessageActivity.

static create_message_activity()

Restituisce

Tipo	Descrizione
	Nuova attività del messaggio.

create_reply

Crea una nuova attività di messaggio come risposta a questa attività.

create_reply(text: str = None, locale: str = None)

Parametri

Nome	Descrizione
text	Testo della risposta. Valore predefinito: None
locale	Codice della lingua per il testo. Valore predefinito: None

Restituisce

Tipo	Descrizione
	Nuova attività del messaggio.

Commenti

La nuova attività configura le informazioni di routing in base a questa attività.

create_trace

Crea una nuova attività di traccia basata su questa attività.

Il valore predefinito è il nome di tipo del valore. :p aram etichetta: facoltativa, un'etichetta descrittiva per questa operazione di traccia.

create_trace(name: str, value: object = None, value_type: str = None, label: str = None)

Parametri

Nome	Descrizione
name Necessario
value	Valore predefinito: None
value_type	Valore predefinito: None
label	Valore predefinito: None

Restituisce

Tipo	Descrizione
	Nuova attività di traccia.

create_trace_activity

Crea un'istanza della classe Activity come oggetto TraceActivity.

Il valore predefinito è il nome di tipo del valore. :p aram etichetta: facoltativa, un'etichetta descrittiva per questa operazione di traccia.

static create_trace_activity(name: str, value: object = None, value_type: str = None, label: str = None)

Parametri

Nome	Descrizione
name Necessario
value	Valore predefinito: None
value_type	Valore predefinito: None
label	Valore predefinito: None

Restituisce

Tipo	Descrizione
	Nuova attività di traccia.

create_typing_activity

Crea un'istanza della classe Activity come oggetto TypingActivity.

static create_typing_activity()

Restituisce

Tipo	Descrizione
	Nuova attività di digitazione.

get_conversation_reference

Crea un oggetto ConversationReference basato su questa attività.

get_conversation_reference()

Restituisce

Tipo	Descrizione
	Riferimento di conversazione per la conversazione che contiene questa attività.

get_mentions

Risolve le menzioni dalle entità di questa attività.

get_mentions() -> List[Mention]

Restituisce

Tipo	Descrizione
	Matrice di menzioni; o una matrice vuota, se non viene trovata alcuna matrice.

Commenti

Questo metodo viene definito nella classe Activity, ma è destinato solo all'uso con un'attività di messaggio, in cui l'attività Activity.Type è impostata su ActivityTypes.Message.

get_reply_conversation_reference

Creare un oggetto ConversationReference in base alle informazioni di conversazione di questa attività e a ResourceResponse dall'invio di un'attività.

get_reply_conversation_reference(reply: ResourceResponse) -> ConversationReference

Parametri

Nome	Descrizione
reply Necessario	ResourceResponse restituito da send_activity.

Restituisce

Tipo	Descrizione
	ConversationReference che può essere archiviato e usato in un secondo momento per eliminare o aggiornare l'attività.

has_content

Indica se l'attività ha contenuto.

has_content() -> bool

Restituisce

Tipo	Descrizione
	True, se questa attività contiene contenuto da inviare; in caso contrario, false.

Commenti

Questo metodo viene definito nella classe Activity, ma è destinato solo all'uso con un'attività di messaggio, in cui l'attività Activity.Type è impostata su ActivityTypes.Message.

is_from_streaming_connection

Determinare se l'attività è stata inviata tramite una connessione Http/Https o Streaming Questo può essere determinato esaminando la proprietà service_url: (1) Tutti i canali che inviano messaggi tramite http/https non sono in streaming (2) Canali che inviano messaggi tramite streaming hanno un ServiceUrl che non inizia con http/https.

is_from_streaming_connection() -> bool

Restituisce

Tipo	Descrizione
	True se l'attività ha avuto origine da una connessione di streaming.

Commenti e suggerimenti

Questa pagina è stata utile?