Activity クラス

protected Activity()

既定のコンストラクター。 通常、これは ActivityType が通常必要であるため使用されません。

public Activity(String withType)

指定した型のアクティビティを構築します。

パラメーター:

public TypeT getChannelData(Class classType)

channelData を型指定された構造体として取得します。

パラメーター:

戻り値:

スロー:

public ResultPair tryGetChannelData(Class clsType)

channelData を型指定された構造体として取得します。

パラメーター:

戻り値:

public final Activity applyConversationReference(ConversationReference reference)

既存の ConversationReferenceからの送信配信情報でこのアクティビティを更新します。

パラメーター:

戻り値:

public final Activity applyConversationReference(ConversationReference reference, boolean isIncoming)

既存の ConversationReferenceからの配信情報でこのアクティビティを更新します。 受信アクティビティの #getConversationReference を呼び出して会話参照を取得します。この参照を使用して、正しい配信情報で送信アクティビティを更新できます。

パラメーター:

戻り値:

public static Activity clone(Activity activity)

アクティビティを複製します。

パラメーター:

戻り値:

public static Activity createContactRelationUpdateActivity()

CONTACT_RELATION_UPDATEの種類のアクティビティを作成します。

戻り値:

public static Activity createConversationUpdateActivity()

CONVERSATION_UPDATEの種類のアクティビティを作成します。

戻り値:

public static Activity createEndOfConversationActivity()

アクティビティのEND_OF_CONVERSATIONの種類を作成します。

戻り値:

public static Activity createEventActivity()

アクティビティの EVENT 型を作成します。

戻り値:

public static Activity createHandoffActivity()

HANDOFF 型のアクティビティを作成します。

戻り値:

public static Activity createInvokeActivity()

アクティビティの INVOKE 型を作成します。

戻り値:

public static Activity createMessageActivity()

MESSAGE 型のアクティビティを作成します。

戻り値:

public Activity createReply()

このアクティビティへの応答として新しいメッセージ アクティビティを作成します。

戻り値:

public Activity createReply(String withText)

このアクティビティへの応答として新しいメッセージ アクティビティを作成します。 このオーバーロードでは、このアクティビティのロケールが使用されます。

パラメーター:

戻り値:

public Activity createReply(String withText, String withLocale)

このアクティビティへの応答として新しいメッセージ アクティビティを作成します。

パラメーター:

戻り値:

public Activity createTrace(String withName)

Activity クラスのインスタンスを型 TRACEとして作成します。

パラメーター:

戻り値:

public Activity createTrace(String withName, Object withValue, String withValueType, String withLabel)

Activity クラスのインスタンスを型 TRACEとして作成します。

パラメーター:

戻り値:

public static Activity createTraceActivity(String withName)

TRACE 型アクティビティを作成します。

パラメーター:

戻り値:

public static Activity createTraceActivity(String withName, String withValueType, Object withValue, String withLabel)

TRACE 型アクティビティを作成します。

パラメーター:

戻り値:

public static Activity createTypingActivity()

TYPING 型アクティビティを作成します。

戻り値:

public String getAction()

contactRelationUpdate の受信者が送信者の連絡先リストに追加または削除されたかどうかを示します。

戻り値:

public AttachmentLayoutTypes getAttachmentLayout()

複数の添付ファイルのレイアウト ヒント。

戻り値:

public List getAttachments()

アクティビティへの添付ファイルを取得します。

戻り値:

public String getCallerId()

ボットの呼び出し元を識別する IRI を含む文字列を取得します。 このフィールドはネットワーク経由で送信されるのではなく、呼び出し元の ID (トークンなど) をアサートする暗号で検証可能なデータに基づいてボットとクライアントによって設定されます。

戻り値:

public Object getChannelData()

チャネル固有のコンテンツを取得します。

戻り値:

public String getChannelId()

チャネルを一意に識別する ID を取得します。 チャネルによって設定されます。

戻り値:

public EndOfConversationCodes getCode()

会話が終了した理由を示す endOfConversation アクティビティのコードを取得します。

戻り値:

public ConversationAccount getConversation()

アクティビティが属する会話を識別します。

戻り値:

public ConversationReference getConversationReference()

このアクティビティに基づいて ConversationReference を作成します。

戻り値:

public String getDeliveryMode()

アクティビティの受信者の代替配信パスに通知する配信ヒント。

既定の配信モードは \"default\" です。 DeliveryModesを参照してください。

戻り値:

public List getEntities()

アクティビティ内のエンティティのペイロード バージョンを返します。 エンティティは、フィールドの数によって異なる場合があります。 Entity クラスは、getProperties()の追加フィールドを保持します。 他のエンティティ型に変換するには、<T>getAs(Class<T> classType)を使用します。

戻り値:

public LocalDateTime getExpiration()

アクティビティの有効期限が切れていると見なされ、受信者に表示されない時刻を取得します。

戻り値:

public ChannelAccount getFrom()

メッセージの送信者を識別します。

戻り値:

public boolean getHistoryDisclosed()

チャネルの以前の履歴が公開されているかどうかを取得します。

戻り値:

public String getId()

チャネルのアクティビティを一意に識別する ID を返します。

戻り値:

public String getImportance()

アクティビティの重要度を取得します。

戻り値:

public InputHints getInputHint()

メッセージがクライアントに配信された後、ボットがユーザー入力を受け入れるか、想定しているか、無視しているかを示します。

戻り値:

public String getLabel()

アクティビティの説明ラベルを取得します。

戻り値:

public List getListenFor()

音声および言語プライミング システムがリッスンする必要がある語句と参照の一覧を取得します。

戻り値:

public OffsetDateTime getLocalTimestamp()

ISO-8601 形式で表されるメッセージのローカル日時を取得します。 たとえば、2016-09-23T13:07:49.4714686-07:00 などです。

戻り値:

public String getLocalTimezone()

IANA タイム ゾーン データベース形式で表される、メッセージのローカル タイムゾーンの名前を取得します。 たとえば、アメリカ/Los_Angelesです。

戻り値:

public String getLocale()

テキスト フィールドの内容のロケール名。 ロケール名は、言語に関連付けられた ISO 639 の 2 文字または 3 文字のカルチャ コードと、国または地域に関連付けられた ISO 3166 2 文字のサブカルチャ コードの組み合わせです。

ロケール名は、有効な BCP-47 言語タグにも対応できます。

戻り値:

public List getMembersAdded()

会話に追加されたメンバーのコレクションを取得します。

戻り値:

public List getMembersRemoved()

会話から削除されたメンバーのコレクションを取得します。

戻り値:

public List getMentions()

このアクティビティのエンティティからのメンションを解決します。 このメソッドは、Activity クラスで定義されていますが、アクティビティの Activity#type が MESSAGEに設定されているメッセージ アクティビティでのみ使用することを目的としています。

戻り値:

public String getName()

呼び出しアクティビティまたはイベント アクティビティに関連付けられている操作の名前を取得します。

戻り値:

public Map getProperties()

オブジェクトの最初のクラス のプロパティではないオーバーフロー プロパティを保持します。 これにより、オブジェクトを維持しながら拡張性を実現できます。

戻り値:

public List getReactionsAdded()

会話に追加されたリアクションのコレクションを取得します。

戻り値:

public List getReactionsRemoved()

会話から削除されたリアクションのコレクションを取得します。

戻り値:

public ChannelAccount getRecipient()

メッセージの受信者を識別します。

戻り値:

public ConversationReference getRelatesTo()

別の会話またはアクティビティへの参照。

戻り値:

public ConversationReference getReplyConversationReference(ResourceResponse reply)

このアクティビティの会話情報と、アクティビティの送信からの ResourceResponse に基づいて ConversationReference を作成します。

パラメーター:

戻り値:

public String getReplyToId()

このメッセージが応答であるメッセージの ID を取得します。

戻り値:

public String getServiceUrl()

チャネルのサービス エンドポイントを指定する URL を設定します。 チャネルによって設定されます。

戻り値:

public String getSpeak()

読み上げるテキスト。

戻り値:

public SuggestedActions getSuggestedActions()

アクティビティの推奨されるアクションを取得します。

戻り値:

public String getSummary()

チャネルがカードをレンダリングできない場合に表示するテキストを取得します。

戻り値:

public String getText()

メッセージのテキスト コンテンツを取得します。

戻り値:

public TextFormatTypes getTextFormat()

テキスト フィールドの形式 Default:markdown。 指定できる値は、'markdown'、'plain'、'xml' です。

戻り値:

public List getTextHighlights()

アクティビティに ReplyToId 値が含まれている場合に強調表示するテキスト フラグメントのコレクションを取得します。

戻り値:

public OffsetDateTime getTimestamp()

ISO-8601 形式で表された、メッセージが送信された日付と時刻を UTC で取得します。

戻り値:

public String getTopicName()

会話の更新されたトピック名を取得します。

戻り値:

public String getType()

アクティビティの ActivityTypes を取得します。

戻り値:

public Object getValue()

アクティビティに関連付けられている値を取得します。

戻り値:

public String getValueType()

アクティビティの値オブジェクトの型を取得します。

戻り値:

public boolean hasContent()

この (メッセージ) アクティビティにコンテンツがあるかどうかを確認します。

戻り値:

protected boolean isActivity(String activityType)

True の 場合、アクティビティが指定したアクティビティの種類です。

パラメーター:

戻り値:

public Boolean isFromStreamingConnection()

アクティビティが Http/Https 接続またはストリーミング経由で送信されたかどうかを判断します。これは、ServiceUrl プロパティを調べることで判断できます。(1) http/https 経由でメッセージを送信するすべてのチャネルがストリーミングされていない (2) ストリーミング経由でメッセージを送信するチャネルには、http/https で始まらない ServiceUrl があります。

戻り値:

public boolean isTeamsActivity()

このアクションが Microsoft チームから提供されているかどうかを確認します。

戻り値:

public boolean isType(String compareTo)

Activity が指定した型の場合に返す便利なメソッドです。

パラメーター:

戻り値:

public String removeMentionText(String withId)

指定した ID のメンション テキストを Activity.Text プロパティから削除します。 たとえば、"@echoBot Hi Bot" というメッセージが表示された場合、"@echoBot" は削除され、"Hi Bot" は残ります。 通常、これはターゲット受信者 (通常はボット) のメンション テキストを削除するために使用されますが、メンバーごとに呼び出される可能性があります。 例: turnContext.Activity.RemoveMentionText(turnContext.Activity.Recipient.Id);メンション Activity.Entity の形式は、チャネルによって異なります。 ただし、いずれの場合も、Mention.Text には Activity.Text に表示されるユーザーの正確なテキストが含まれていることが想定されています。 たとえば、Teams ではユーザー名が使用されますが、slack では @usernameが使用されます。 テキストが Activity.Text 内にあり、このメソッドによって Activity.Text からその値が削除されることが想定されています。

パラメーター:

戻り値:

public static String removeMentionTextImmutable(Activity activity, String id)

Activity を変更せずに Activity.Text からメンションを削除します。

パラメーター:

戻り値:

public String removeRecipientMention()

Text プロパティから受信者のメンション テキストを削除します。 この関数はアクティビティのテキストを変更するため、注意して使用してください。

戻り値:

public static String removeRecipientMentionImmutable(Activity activity)

アクティビティを変更せずに受信者のメンションを削除します。

パラメーター:

戻り値:

public void setAction(String withAction)

contactRelationUpdate の受信者が送信者の連絡先リストに追加または削除されたかどうかを示します。

パラメーター:

public void setAttachment(Attachment withAttachment)

アクティビティに 1 つの添付ファイルを設定します。

パラメーター:

public void setAttachmentLayout(AttachmentLayoutTypes withAttachmentLayout)

複数の添付ファイルのレイアウト ヒントを設定します。

パラメーター:

public void setAttachments(List withAttachments)

添付ファイルをアクティビティに設定します。

パラメーター:

public void setCallerId(String withCallerId)

ボットの呼び出し元を識別する IRI を設定します。 このフィールドはネットワーク経由で送信されるのではなく、呼び出し元の ID (トークンなど) をアサートする暗号で検証可能なデータに基づいてボットとクライアントによって設定されます。

パラメーター:

public void setChannelData(Object withChannelData)

チャネル固有のコンテンツを設定します。

パラメーター:

public void setChannelId(String withChannelId)

チャネルを一意に識別する ID を設定します。 チャネルによって設定されます。

パラメーター:

public void setCode(EndOfConversationCodes withCode)

会話が終了した理由を示す endOfConversation アクティビティのコードを設定します。

パラメーター:

public void setConversation(ConversationAccount withConversation)

アクティビティが属する会話を識別します。

パラメーター:

public void setDeliveryMode(String withDeliveryMode)

アクティビティの受信者の代替配信パスに通知する配信ヒント。

既定の配信モードは \"default\" です。

パラメーター:

public void setEntities(List withEntities)

アクティビティ内のエンティティのペイロード バージョンを設定します。

パラメーター:

public void setExpiration(LocalDateTime withExpiration)

アクティビティの有効期限が切れていると見なされ、受信者に表示されない時間を設定します。

パラメーター:

public void setFrom(ChannelAccount withFrom)

メッセージの送信者を識別します。

パラメーター:

public void setHistoryDisclosed(boolean withHistoryDisclosed)

チャネルの以前の履歴が開示されるかどうかを設定します。

パラメーター:

public void setId(String withId)

チャネルのアクティビティを一意に識別する ID を設定します。

パラメーター:

public void setImportance(String withImportance)

アクティビティの重要度を設定します。

パラメーター:

public void setInputHint(InputHints withInputHint)

メッセージがクライアントに配信された後、ボットがユーザー入力を受け入れるか、想定しているか、無視しているかを示します。

パラメーター:

public void setLabel(String withLabel)

アクティビティの説明ラベルを設定します。

パラメーター:

public void setListenFor(List withListenFor)

音声および言語プライミング システムがリッスンする語句と参照の一覧を設定します。

パラメーター:

public void setLocalTimeZone(String withLocalTimezone)

IANA タイム ゾーン データベース形式で表される、メッセージのローカル タイムゾーンの名前を設定します。 たとえば、アメリカ/Los_Angelesです。

パラメーター:

public void setLocalTimestamp(OffsetDateTime withLocalTimestamp)

ISO-8601 形式で表される、メッセージのローカルの日付と時刻を格納します。 たとえば、2016-09-23T13:07:49.4714686-07:00 などです。

パラメーター:

public void setLocale(String withLocale)

テキスト フィールドの内容のロケール名。 ロケール名は、言語に関連付けられた ISO 639 の 2 文字または 3 文字のカルチャ コードと、国または地域に関連付けられた ISO 3166 2 文字のサブカルチャ コードの組み合わせです。

ロケール名は、有効な BCP-47 言語タグにも対応できます。

パラメーター:

public void setMembersAdded(List withMembersAdded)

会話に追加されたメンバーのコレクションを設定します。

パラメーター:

public void setMembersRemoved(List withMembersRemoved)

会話から削除されたメンバーのコレクションを設定します。

パラメーター:

public void setMentions(List withMentions)

アクティビティのメンションのペイロード バージョンを設定します。

パラメーター:

public void setName(String withName)

呼び出しアクティビティまたはイベント アクティビティに関連付けられている操作の名前を設定します。

パラメーター:

public void setProperties(String key, JsonNode withValue)

オブジェクトの最初のクラス のプロパティではないオーバーフロー プロパティを保持します。 これにより、オブジェクトを維持しながら拡張性を実現できます。

パラメーター:

public void setReactionsAdded(List withReactionsAdded)

会話に追加されたリアクションのコレクションを設定します。

パラメーター:

public void setReactionsRemoved(List withReactionsRemoved)

会話から削除されたリアクションのコレクションを設定します。

パラメーター:

public void setRecipient(ChannelAccount withRecipient)

メッセージの受信者を識別します。

パラメーター:

public void setRelatesTo(ConversationReference withRelatesTo)

別の会話またはアクティビティへの参照。

パラメーター:

public void setReplyToId(String withReplyToId)

このメッセージが応答であるメッセージの ID を設定します。

パラメーター:

public void setServiceUrl(String withServiceUrl)

チャネルのサービス エンドポイントを指定する URL を設定します。 チャネルによって設定されます。

パラメーター:

public void setSpeak(String withSpeak)

読み上げるテキストを設定します。

パラメーター:

public void setSuggestedActions(SuggestedActions withSuggestedActions)

アクティビティに対して推奨されるアクション。

パラメーター:

public void setSummary(String withSummary)

チャネルでカードをレンダリングできない場合に表示するテキストを設定します。

パラメーター:

public void setText(String withText)

メッセージのテキスト コンテンツを設定します。

パラメーター:

public void setTextFormat(TextFormatTypes withTextFormat)

テキスト フィールドの形式。

パラメーター:

public void setTextHighlights(List withTextHighlights)

アクティビティに ReplyToId 値が含まれている場合に強調表示するテキスト フラグメントのコレクションを設定します。

パラメーター:

public void setTimestamp(OffsetDateTime withTimestamp)

ISO-8601 形式で表された、メッセージが送信された日時を UTC で設定します。

パラメーター:

public void setTopicName(String withTopicName)

会話の更新されたトピック名を設定します。

パラメーター:

public void setType(String withType)

アクティビティの ActivityTypes を設定します。

パラメーター:

public void setValue(Object withValue)

アクティビティに関連付けられている値を設定します。

パラメーター:

public void setValueType(String withValueType)

アクティビティの値オブジェクトの型を設定します。

パラメーター:

public TeamsChannelData teamsGetChannelData()

TeamsChannelData を取得します。

戻り値:

public String teamsGetChannelId()

チャネルを表す一意識別子を取得します。

戻り値:

public TeamsMeetingInfo teamsGetMeetingInfo()

現在のアクティビティから TeamsMeetingInfo オブジェクトを取得します。

戻り値:

public String teamsGetTeamId()

チームを表す一意識別子を取得します。

戻り値:

public TeamInfo teamsGetTeamInfo()

Teams TeamInfo データを取得します。

戻り値:

public void teamsNotifyUser()

TeamsChannelData の通知値を true に設定します。

public void teamsNotifyUser(boolean alertInMeeting, String externalResourceUrl)

TeamsChannelData の会議の通知を設定します。

パラメーター: