Activity クラス
アクティビティは、Bot Framework 3.0 プロトコルの基本的な通信の種類です。
コンストラクター
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)パラメーター
| 名前 | 説明 |
|---|---|
|
type
必須
|
str または
<xref:botframework.connector.models.ActivityTypes>
アクティビティの種類を格納します。 使用できる値は、'message'、'contactRelationUpdate'、'conversationUpdate'、'typing'、'endOfConversation'、'event'、'invoke'、'deleteUserData'、'messageUpdate'、'messageDelete'、'installationUpdate'、'messageReaction'、'suggestion'、'trace'、'handoff' です。 |
|
id
必須
|
チャネルのアクティビティを一意に識別する ID を含みます。 |
|
timestamp
必須
|
ISO-8601 形式で表された、メッセージが送信された日時 (UTC) を格納します。 |
|
local_timestamp
必須
|
ISO-8601 形式で表されるメッセージのローカル日時を格納します。 たとえば、2016-09-23T13:07:49.4714686-07:00 などです。 |
|
local_timezone
必須
|
メッセージのローカル タイムゾーンの名前を IANA タイム ゾーン データベース形式で表します。 たとえば、アメリカ/Los_Angelesです。 |
|
service_url
必須
|
チャネルのサービス エンドポイントを指定する URL が含まれています。 チャネルによって設定されます。 |
|
channel_id
必須
|
チャネルを一意に識別する ID を含みます。 チャネルによって設定されます。 |
|
from_property
必須
|
<xref:botframework.connector.models.ChannelAccount>
メッセージの送信者を識別します。 |
|
conversation
必須
|
<xref:botframework.connector.models.ConversationAccount>
アクティビティが属する会話を識別します。 |
|
recipient
必須
|
<xref:botframework.connector.models.ChannelAccount>
メッセージの受信者を識別します。 |
|
text_format
必須
|
str または
<xref:botframework.connector.models.TextFormatTypes>
テキスト フィールドの形式 Default:markdown。 指定できる値は、'markdown'、'plain'、'xml' です。 |
|
attachment_layout
必須
|
str または
<xref:botframework.connector.models.AttachmentLayoutTypes>
複数の添付ファイルのレイアウト ヒント。 既定値: リスト。 使用可能な値は、'list'、'carousel' です。 |
|
members_added
必須
|
list[<xref:botframework.connector.models.ChannelAccount>]
会話に追加されたメンバーのコレクション。 |
|
members_removed
必須
|
list[<xref:botframework.connector.models.ChannelAccount>]
会話から削除されたメンバーのコレクション。 |
|
reactions_added
必須
|
list[<xref:botframework.connector.models.MessageReaction>]
会話に追加されたリアクションのコレクション。 |
|
reactions_removed
必須
|
list[<xref:botframework.connector.models.MessageReaction>]
会話から削除されたリアクションのコレクション。 |
|
topic_name
必須
|
会話の更新されたトピック名。 |
|
history_disclosed
必須
|
チャネルの過去の履歴が開示されているかどうかを示します。 |
|
locale
必須
|
テキスト フィールドの内容のロケール名。 ロケール名は、言語に関連付けられた ISO 639 の 2 文字または 3 文字のカルチャ コードと、国または地域に関連付けられた ISO 3166 2 文字のサブカルチャ コードの組み合わせです。 ロケール名は、有効な BCP-47 言語タグにも対応できます。 |
|
text
必須
|
メッセージのテキスト コンテンツ。 |
|
speak
必須
|
読み上げるテキスト。 |
|
input_hint
必須
|
str または
<xref:botframework.connector.models.InputHints>
メッセージがクライアントに配信された後、ボットがユーザー入力を受け入れるか、想定しているか、無視しているかを示します。 使用可能な値は、'acceptingInput'、'ignoringInput'、'expectingInput' です。 |
|
summary
必須
|
チャネルでカードをレンダリングできない場合に表示するテキスト。 |
|
suggested_actions
必須
|
<xref:botframework.connector.models.SuggestedActions>
アクティビティに対して推奨されるアクション。 |
|
attachments
必須
|
list[<xref:botframework.connector.models.Attachment>]
添付 ファイル |
|
entities
必須
|
list[<xref:botframework.connector.models.Entity>]
メッセージに記載されたエンティティを表します。 |
|
channel_data
必須
|
チャネル固有のコンテンツが含まれます。 |
|
action
必須
|
contactRelationUpdate の受信者が送信者の連絡先リストに追加または削除されたかどうかを示します。 |
|
reply_to_id
必須
|
このメッセージが応答であるメッセージの ID を格納します。 |
|
label
必須
|
アクティビティの説明ラベル。 |
|
value_type
必須
|
アクティビティの値オブジェクトの型。 |
|
value
必須
|
アクティビティに関連付けられている値。 |
|
name
必須
|
呼び出しアクティビティまたはイベント アクティビティに関連付けられている操作の名前。 |
|
relates_to
必須
|
<xref:botframework.connector.models.ConversationReference>
別の会話またはアクティビティへの参照。 |
|
code
必須
|
str または
<xref:botframework.connector.models.EndOfConversationCodes>
会話が終了した理由を示す endOfConversation アクティビティのコード。 指定できる値は、'unknown'、'completedSuccessfully'、'userCancelled'、'botTimedOut'、'botIssuedInvalidMessage'、'channelFailed' です。 |
|
expiration
必須
|
アクティビティが "期限切れ" と見なされ、受信者に表示されない時刻。 |
|
importance
必須
|
str または
<xref:botframework.connector.models.ActivityImportance>
アクティビティの重要性。 指定できる値は、'low'、'normal'、'high' です。 |
|
delivery_mode
必須
|
str または
<xref:botframework.connector.models.DeliveryModes>
アクティビティの受信者の代替配信パスに通知する配信ヒント。 既定の配信モードは "default" です。 指定できる値は、'normal'、'notification'、'expectReplies'、'ephemeral' です。 |
|
listen_for
必須
|
音声および言語プライミング システムがリッスンする必要がある語句と参照の一覧 |
|
text_highlights
必須
|
list[<xref:botframework.connector.models.TextHighlight>]
アクティビティに ReplyToId 値が含まれているときに強調表示するテキスト フラグメントのコレクション。 |
|
semantic_action
必須
|
<xref:botframework.connector.models.SemanticAction>
この要求に付随するオプションのプログラムによるアクション |
|
caller_id
必須
|
ボットの呼び出し元を識別する IRI を含む文字列。 このフィールドはネットワーク経由で送信されるのではなく、呼び出し元の ID (トークンなど) をアサートする暗号で検証可能なデータに基づいてボットとクライアントによって設定されます。 |
キーワードのみのパラメーター
| 名前 | 説明 |
|---|---|
|
type
必須
|
|
|
id
必須
|
|
|
timestamp
必須
|
|
|
local_timestamp
必須
|
|
|
local_timezone
必須
|
|
|
service_url
必須
|
|
|
channel_id
必須
|
|
|
from_property
必須
|
|
|
conversation
必須
|
|
|
recipient
必須
|
|
|
text_format
必須
|
|
|
attachment_layout
必須
|
|
|
members_added
必須
|
|
|
members_removed
必須
|
|
|
reactions_added
必須
|
|
|
reactions_removed
必須
|
|
|
topic_name
必須
|
|
|
history_disclosed
必須
|
|
|
locale
必須
|
|
|
text
必須
|
|
|
speak
必須
|
|
|
input_hint
必須
|
|
|
summary
必須
|
|
|
suggested_actions
必須
|
|
|
attachments
必須
|
|
|
entities
必須
|
|
|
channel_data
必須
|
|
|
action
必須
|
|
|
reply_to_id
必須
|
|
|
label
必須
|
|
|
value_type
必須
|
|
|
value
必須
|
|
|
name
必須
|
|
|
relates_to
必須
|
|
|
code
必須
|
|
|
expiration
必須
|
|
|
importance
必須
|
|
|
delivery_mode
必須
|
|
|
listen_for
必須
|
|
|
text_highlights
必須
|
|
|
semantic_action
必須
|
|
|
caller_id
必須
|
|
メソッド
| apply_conversation_reference |
既存の ConversationReference からの配信情報でこのアクティビティを更新します ボットが受信者である受信アクティビティ。それ以外の場合は False。 既定値は False で、アクティビティにはボットが送信者として表示されます。 |
| as_contact_relation_update_activity |
このアクティビティを ContactRelationUpdateActivity オブジェクトとして返します。または None (この種類のアクティビティではない場合)。 |
| as_conversation_update_activity |
このアクティビティを ConversationUpdateActivity オブジェクトとして返します。または None (この種類のアクティビティではない場合)。 |
| as_end_of_conversation_activity |
このアクティビティを EndOfConversationActivity オブジェクトとして返します。または None (この種類のアクティビティではない場合)。 |
| as_event_activity |
このアクティビティを EventActivity オブジェクトとして返します。または None (この種類のアクティビティではない場合)。 |
| as_handoff_activity |
このアクティビティを HandoffActivity オブジェクトとして返します。または None (この種類のアクティビティではない場合)。 |
| as_installation_update_activity |
このアクティビティを InstallationUpdateActivity オブジェクトとして返します。または None (この種類のアクティビティではない場合)。 |
| as_invoke_activity |
このアクティビティを InvokeActivity オブジェクトとして返します。または None (この種類のアクティビティではない場合)。 |
| as_message_activity |
このアクティビティを MessageActivity オブジェクトとして返します。または None (この種類のアクティビティではない場合)。 |
| as_message_delete_activity |
このアクティビティを MessageDeleteActivity オブジェクトとして返します。または None (この種類のアクティビティではない場合)。 |
| as_message_reaction_activity |
このアクティビティを MessageReactionActivity オブジェクトとして返します。または None (この種類のアクティビティではない場合)。 |
| as_message_update_activity |
このアクティビティを MessageUpdateActivity オブジェクトとして返します。または None (この種類のアクティビティではない場合)。 |
| as_suggestion_activity |
このアクティビティを SuggestionActivity オブジェクトとして返します。または None (この種類のアクティビティではない場合)。 |
| as_trace_activity |
このアクティビティを TraceActivity オブジェクトとして返します。または None (この種類のアクティビティではない場合)。 |
| as_typing_activity |
このアクティビティを TypingActivity オブジェクトとして返します。または null (これがアクティビティの種類ではない場合)。 |
| create_contact_relation_update_activity |
Activity クラスのインスタンスを aContactRelationUpdateActivity オブジェクトとして作成します。 |
| create_conversation_update_activity |
Activity クラスのインスタンスを ConversationUpdateActivity オブジェクトとして作成します。 |
| create_end_of_conversation_activity |
EndOfConversationActivity オブジェクトとして Activity クラスのインスタンスを作成します。 |
| create_event_activity |
Activity クラスのインスタンスを EventActivity オブジェクトとして作成します。 |
| create_handoff_activity |
Activity クラスのインスタンスを HandoffActivity オブジェクトとして作成します。 |
| create_invoke_activity |
Activity クラスのインスタンスを InvokeActivity オブジェクトとして作成します。 |
| create_message_activity |
Activity クラスのインスタンスを MessageActivity オブジェクトとして作成します。 |
| create_reply |
このアクティビティへの応答として新しいメッセージ アクティビティを作成します。 |
| create_trace |
このアクティビティに基づいて新しいトレース アクティビティを作成します。 既定値は、値の型の名前です。 :p aram ラベル: 省略可能。このトレース操作の説明ラベルです。 |
| create_trace_activity |
TraceActivity オブジェクトとして Activity クラスのインスタンスを作成します。 既定値は、値の型の名前です。 :p aram ラベル: 省略可能。このトレース操作の説明ラベルです。 |
| create_typing_activity |
Activity クラスのインスタンスを TypingActivity オブジェクトとして作成します。 |
| get_conversation_reference |
このアクティビティに基づいて ConversationReference を作成します。 |
| get_mentions |
このアクティビティのエンティティからのメンションを解決します。 |
| get_reply_conversation_reference |
このアクティビティの会話情報と、アクティビティの送信からの ResourceResponse に基づいて ConversationReference を作成します。 |
| has_content |
このアクティビティにコンテンツがあるかどうかを示します。 |
| is_from_streaming_connection |
アクティビティが Http/Https 接続またはストリーミング経由で送信されたかどうかを確認します。これは、service_url プロパティを参照して判断できます。(1) http/https 経由でメッセージを送信するすべてのチャネルがストリーミングされていない (2) ストリーミング経由でメッセージを送信するチャネルには、http/https で始まらない ServiceUrl があります。 |
apply_conversation_reference
既存の ConversationReference からの配信情報でこのアクティビティを更新します
ボットが受信者である受信アクティビティ。それ以外の場合は False。 既定値は False で、アクティビティにはボットが送信者として表示されます。
apply_conversation_reference(reference: ConversationReference, is_incoming: bool = False)パラメーター
| 名前 | 説明 |
|---|---|
|
reference
必須
|
|
|
is_incoming
|
規定値: False
|
戻り値
| 型 | 説明 |
|---|---|
|
彼の活動は、配信情報で更新されました。 |
注釈
受信アクティビティで GetConversationReference を呼び出して会話参照を取得します。この参照を使用して、正しい配信情報で送信アクティビティを更新できます。
as_contact_relation_update_activity
このアクティビティを ContactRelationUpdateActivity オブジェクトとして返します。または None (この種類のアクティビティではない場合)。
as_contact_relation_update_activity()戻り値
| 型 | 説明 |
|---|---|
|
メッセージ アクティビティとしてのこのアクティビティ。または [なし] を選択します。 |
as_conversation_update_activity
このアクティビティを ConversationUpdateActivity オブジェクトとして返します。または None (この種類のアクティビティではない場合)。
as_conversation_update_activity()戻り値
| 型 | 説明 |
|---|---|
|
会話更新アクティビティとしてのこのアクティビティ。または [なし] を選択します。 |
as_end_of_conversation_activity
このアクティビティを EndOfConversationActivity オブジェクトとして返します。または None (この種類のアクティビティではない場合)。
as_end_of_conversation_activity()戻り値
| 型 | 説明 |
|---|---|
|
会話アクティビティの終了としてのこのアクティビティ。または [なし] を選択します。 |
as_event_activity
このアクティビティを EventActivity オブジェクトとして返します。または None (この種類のアクティビティではない場合)。
as_event_activity()戻り値
| 型 | 説明 |
|---|---|
|
イベント アクティビティとしてのこのアクティビティ。または [なし] を選択します。 |
as_handoff_activity
このアクティビティを HandoffActivity オブジェクトとして返します。または None (この種類のアクティビティではない場合)。
as_handoff_activity()戻り値
| 型 | 説明 |
|---|---|
|
このアクティビティはハンドオフ アクティビティです。または [なし] を選択します。 |
as_installation_update_activity
このアクティビティを InstallationUpdateActivity オブジェクトとして返します。または None (この種類のアクティビティではない場合)。
as_installation_update_activity()戻り値
| 型 | 説明 |
|---|---|
|
インストール更新アクティビティとしてのこのアクティビティ。または [なし] を選択します。 |
as_invoke_activity
このアクティビティを InvokeActivity オブジェクトとして返します。または None (この種類のアクティビティではない場合)。
as_invoke_activity()戻り値
| 型 | 説明 |
|---|---|
|
呼び出しアクティビティとしてのこのアクティビティ。または [なし] を選択します。 |
as_message_activity
このアクティビティを MessageActivity オブジェクトとして返します。または None (この種類のアクティビティではない場合)。
as_message_activity()戻り値
| 型 | 説明 |
|---|---|
|
メッセージ アクティビティとしてのこのアクティビティ。または [なし] を選択します。 |
as_message_delete_activity
このアクティビティを MessageDeleteActivity オブジェクトとして返します。または None (この種類のアクティビティではない場合)。
as_message_delete_activity()戻り値
| 型 | 説明 |
|---|---|
|
メッセージ削除要求としてのこのアクティビティ。または [なし] を選択します。 |
as_message_reaction_activity
このアクティビティを MessageReactionActivity オブジェクトとして返します。または None (この種類のアクティビティではない場合)。
as_message_reaction_activity()戻り値
| 型 | 説明 |
|---|---|
|
この活動は、メッセージ反応活動として;または [なし] を選択します。 |
as_message_update_activity
このアクティビティを MessageUpdateActivity オブジェクトとして返します。または None (この種類のアクティビティではない場合)。
as_message_update_activity()戻り値
| 型 | 説明 |
|---|---|
|
メッセージ更新要求としてのこのアクティビティ。または [なし] を選択します。 |
as_suggestion_activity
このアクティビティを SuggestionActivity オブジェクトとして返します。または None (この種類のアクティビティではない場合)。
as_suggestion_activity()戻り値
| 型 | 説明 |
|---|---|
|
提案アクティビティとしてのこのアクティビティ。または [なし] を選択します。 |
as_trace_activity
このアクティビティを TraceActivity オブジェクトとして返します。または None (この種類のアクティビティではない場合)。
as_trace_activity()戻り値
| 型 | 説明 |
|---|---|
|
トレース アクティビティとしてのこのアクティビティ。または [なし] を選択します。 |
as_typing_activity
このアクティビティを TypingActivity オブジェクトとして返します。または null (これがアクティビティの種類ではない場合)。
as_typing_activity()戻り値
| 型 | 説明 |
|---|---|
|
入力アクティビティとしてのこのアクティビティ。または null。 |
create_contact_relation_update_activity
Activity クラスのインスタンスを aContactRelationUpdateActivity オブジェクトとして作成します。
static create_contact_relation_update_activity()戻り値
| 型 | 説明 |
|---|---|
|
新しい連絡先関係の更新アクティビティ。 |
create_conversation_update_activity
Activity クラスのインスタンスを ConversationUpdateActivity オブジェクトとして作成します。
static create_conversation_update_activity()戻り値
| 型 | 説明 |
|---|---|
|
新しい会話の更新アクティビティ。 |
create_end_of_conversation_activity
EndOfConversationActivity オブジェクトとして Activity クラスのインスタンスを作成します。
static create_end_of_conversation_activity()戻り値
| 型 | 説明 |
|---|---|
|
会話アクティビティの新しい終了。 |
create_event_activity
Activity クラスのインスタンスを EventActivity オブジェクトとして作成します。
static create_event_activity()戻り値
| 型 | 説明 |
|---|---|
|
新しいイベント アクティビティ。 |
create_handoff_activity
Activity クラスのインスタンスを HandoffActivity オブジェクトとして作成します。
static create_handoff_activity()戻り値
| 型 | 説明 |
|---|---|
|
新しいハンドオフ アクティビティ。 |
create_invoke_activity
Activity クラスのインスタンスを InvokeActivity オブジェクトとして作成します。
static create_invoke_activity()戻り値
| 型 | 説明 |
|---|---|
|
新しい呼び出しアクティビティ。 |
create_message_activity
Activity クラスのインスタンスを MessageActivity オブジェクトとして作成します。
static create_message_activity()戻り値
| 型 | 説明 |
|---|---|
|
新しいメッセージ アクティビティ。 |
create_reply
このアクティビティへの応答として新しいメッセージ アクティビティを作成します。
create_reply(text: str = None, locale: str = None)パラメーター
| 名前 | 説明 |
|---|---|
|
text
|
返信のテキスト。 規定値: None
|
|
locale
|
テキストの言語コード。 規定値: None
|
戻り値
| 型 | 説明 |
|---|---|
|
新しいメッセージ アクティビティ。 |
注釈
新しいアクティビティは、このアクティビティに基づいてルーティング情報を設定します。
create_trace
このアクティビティに基づいて新しいトレース アクティビティを作成します。
既定値は、値の型の名前です。 :p aram ラベル: 省略可能。このトレース操作の説明ラベルです。
create_trace(name: str, value: object = None, value_type: str = None, label: str = None)パラメーター
| 名前 | 説明 |
|---|---|
|
name
必須
|
|
|
value
|
規定値: None
|
|
value_type
|
規定値: None
|
|
label
|
規定値: None
|
戻り値
| 型 | 説明 |
|---|---|
|
新しいトレース アクティビティ。 |
create_trace_activity
TraceActivity オブジェクトとして Activity クラスのインスタンスを作成します。
既定値は、値の型の名前です。 :p aram ラベル: 省略可能。このトレース操作の説明ラベルです。
static create_trace_activity(name: str, value: object = None, value_type: str = None, label: str = None)パラメーター
| 名前 | 説明 |
|---|---|
|
name
必須
|
|
|
value
|
規定値: None
|
|
value_type
|
規定値: None
|
|
label
|
規定値: None
|
戻り値
| 型 | 説明 |
|---|---|
|
新しいトレース アクティビティ。 |
create_typing_activity
Activity クラスのインスタンスを TypingActivity オブジェクトとして作成します。
static create_typing_activity()戻り値
| 型 | 説明 |
|---|---|
|
新しい入力アクティビティ。 |
get_conversation_reference
このアクティビティに基づいて ConversationReference を作成します。
get_conversation_reference()戻り値
| 型 | 説明 |
|---|---|
|
このアクティビティを含む会話の会話参照。 |
get_mentions
このアクティビティのエンティティからのメンションを解決します。
get_mentions() -> List[Mention]戻り値
| 型 | 説明 |
|---|---|
|
メンションの配列。または空の配列 (見つからない場合)。 |
注釈
このメソッドは、Activity クラスで定義されていますが、activity Activity.Type が ActivityTypes.Message に設定されているメッセージ アクティビティでのみ使用することを目的としています。
get_reply_conversation_reference
このアクティビティの会話情報と、アクティビティの送信からの ResourceResponse に基づいて ConversationReference を作成します。
get_reply_conversation_reference(reply: ResourceResponse) -> ConversationReferenceパラメーター
| 名前 | 説明 |
|---|---|
|
reply
必須
|
send_activityから返される ResourceResponse。 |
戻り値
| 型 | 説明 |
|---|---|
|
後でアクティビティを削除または更新するために格納および使用できる ConversationReference。 |
has_content
このアクティビティにコンテンツがあるかどうかを示します。
has_content() -> bool戻り値
| 型 | 説明 |
|---|---|
|
True の 場合、このアクティビティに送信するコンテンツが含まれます。それ以外の場合は false。 |
注釈
このメソッドは、Activity クラスで定義されていますが、activity Activity.Type が ActivityTypes.Message に設定されているメッセージ アクティビティでのみ使用することを目的としています。
is_from_streaming_connection
アクティビティが Http/Https 接続またはストリーミング経由で送信されたかどうかを確認します。これは、service_url プロパティを参照して判断できます。(1) http/https 経由でメッセージを送信するすべてのチャネルがストリーミングされていない (2) ストリーミング経由でメッセージを送信するチャネルには、http/https で始まらない ServiceUrl があります。
is_from_streaming_connection() -> bool戻り値
| 型 | 説明 |
|---|---|
|
True の 場合、アクティビティは、ストリーミング接続から発生しました。 |