Activity クラス

  • java.lang.Object
    • com.microsoft.bot.schema.Activity

public class Activity

Activity クラスには、個々のより具体的なアクティビティに含めることができるすべてのプロパティが含まれます。 スーパーセット型です。

コンストラクターの概要

修飾子 コンストラクター 説明
protected Activity()

既定のコンストラクターです。

Activity(String withType)

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

メソッドの概要

修飾子と型 メソッドと説明
TypeT <TypeT>getChannelData(Class<TypeT> classType)

型指定された構造体としてチャネルデータを取得します。

ResultPair<TypeT> <TypeT>tryGetChannelData(Class<TypeT> clsType)

型指定された構造体としてチャネルデータを取得します。

final Activity applyConversationReference(ConversationReference reference)

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

final Activity applyConversationReference(ConversationReference reference, boolean isIncoming)

このアクティビティを、既存ConversationReferenceの からの配信情報と共に更新します。

static Activity clone(Activity activity)

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

static Activity createContactRelationUpdateActivity()

CONTACT_RELATION_UPDATEタイプ Activity を作成します。

static Activity createConversationUpdateActivity()

CONVERSATION_UPDATEタイプ Activity を作成します。

static Activity createEndOfConversationActivity()

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

static Activity createEventActivity()

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

static Activity createHandoffActivity()

HANDOFF 型の Activity を作成します。

static Activity createInvokeActivity()

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

static Activity createMessageActivity()

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

Activity createReply()

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

Activity createReply(String withText)

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

Activity createReply(String withText, String withLocale)

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

Activity createTrace(String withName)

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

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

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

static Activity createTraceActivity(String withName)

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

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

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

static Activity createTypingActivity()

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

java.lang.String getAction()

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

AttachmentLayoutTypes getAttachmentLayout()

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

java.util.List<Attachment> getAttachments()

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

java.lang.String getCallerId()

ボットの呼び出し元を識別する IRI を含む文字列を取得します。

java.lang.Object getChannelData()

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

java.lang.String getChannelId()

チャネルを一意に識別する ID を取得します。

EndOfConversationCodes getCode()

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

ConversationAccount getConversation()

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

ConversationReference getConversationReference()

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

java.lang.String getDeliveryMode()

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

java.util.List<Entity> getEntities()

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

java.time.LocalDateTime getExpiration()

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

ChannelAccount getFrom()

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

boolean getHistoryDisclosed()

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

java.lang.String getId()

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

java.lang.String getImportance()

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

InputHints getInputHint()

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

java.lang.String getLabel()

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

java.util.List<java.lang.String> getListenFor()

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

java.time.OffsetDateTime getLocalTimestamp()

ISO-8601 形式で表されるメッセージのローカルの日付と時刻を取得します。

java.lang.String getLocalTimezone()

IANA タイム ゾーン データベース形式で表されるメッセージのローカル タイムゾーンの名前を取得します。

java.lang.String getLocale()

テキスト フィールドの内容のロケール名。

java.util.List<ChannelAccount> getMembersAdded()

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

java.util.List<ChannelAccount> getMembersRemoved()

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

java.util.List<Mention> getMentions()

このアクティビティのエンティティからのメンションを解決します。

java.lang.String getName()

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

java.util.Map<java.lang.String,com.fasterxml.jackson.databind.JsonNode> getProperties()

オブジェクトのファースト クラス プロパティではないオーバーフロー プロパティを保持します。

java.util.List<MessageReaction> getReactionsAdded()

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

java.util.List<MessageReaction> getReactionsRemoved()

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

ChannelAccount getRecipient()

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

ConversationReference getRelatesTo()

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

ConversationReference getReplyConversationReference(ResourceResponse reply)

このアクティビティの会話情報とアクティビティの送信からのリソース応答に基づいて、会話参照を作成します。

java.lang.String getReplyToId()

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

java.lang.String getServiceUrl()

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

java.lang.String getSpeak()

読み上げるテキスト。

SuggestedActions getSuggestedActions()

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

java.lang.String getSummary()

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

java.lang.String getText()

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

TextFormatTypes getTextFormat()

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

java.util.List<TextHighlight> getTextHighlights()

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

java.time.OffsetDateTime getTimestamp()

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

java.lang.String getTopicName()

スレッドの更新されたトピック名を取得します。

java.lang.String getType()

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

java.lang.Object getValue()

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

java.lang.String getValueType()

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

boolean hasContent()

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

protected boolean isActivity(String activityType)

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

java.lang.Boolean isFromStreamingConnection()

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

boolean isTeamsActivity()

このアクティビティが Microsoft Teams からのものかどうかを確認します。

boolean isType(String compareTo)

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

java.lang.String removeMentionText(String withId)

指定された ID のメンション テキストをアクティビティから削除します。Text プロパティ。

static java.lang.String removeMentionTextImmutable(Activity activity, String id)

アクティビティからメンションを削除します。アクティビティを変更しないテキスト。

java.lang.String removeRecipientMention()

Text プロパティから受信者のメンション テキストを削除します。

static java.lang.String removeRecipientMentionImmutable(Activity activity)

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

void setAction(String withAction)

連絡先関係更新の受信者が送信者の連絡先リストに追加されたか削除されたかを示します。

void setAttachment(Attachment withAttachment)

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

void setAttachmentLayout(AttachmentLayoutTypes withAttachmentLayout)

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

void setAttachments(List<Attachment> withAttachments)

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

void setCallerId(String withCallerId)

ボットの呼び出し元を識別する IRI を設定します。

void setChannelData(Object withChannelData)

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

void setChannelId(String withChannelId)

チャネルを一意に識別する ID を設定します。

void setCode(EndOfConversationCodes withCode)

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

void setConversation(ConversationAccount withConversation)

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

void setDeliveryMode(String withDeliveryMode)

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

void setEntities(List<Entity> withEntities)

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

void setExpiration(LocalDateTime withExpiration)

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

void setFrom(ChannelAccount withFrom)

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

void setHistoryDisclosed(boolean withHistoryDisclosed)

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

void setId(String withId)

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

void setImportance(String withImportance)

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

void setInputHint(InputHints withInputHint)

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

void setLabel(String withLabel)

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

void setListenFor(List<String> withListenFor)

音声と言語のプライミング システムがリッスンする必要があるフレーズと参照の一覧を設定します。

void setLocalTimeZone(String withLocalTimezone)

IANA タイム ゾーン データベース形式で表されるメッセージのローカル タイムゾーンの名前を設定します。

void setLocalTimestamp(OffsetDateTime withLocalTimestamp)

ISO-8601 形式で表されるメッセージのローカル日付と時刻を格納します。

void setLocale(String withLocale)

テキスト フィールドの内容のロケール名。

void setMembersAdded(List<ChannelAccount> withMembersAdded)

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

void setMembersRemoved(List<ChannelAccount> withMembersRemoved)

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

void setMentions(List<Mention> withMentions)

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

void setName(String withName)

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

void setProperties(String key, JsonNode withValue)

オブジェクトの最初のクラス プロパティではないオーバーフロー プロパティを保持します。

void setReactionsAdded(List<MessageReaction> withReactionsAdded)

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

void setReactionsRemoved(List<MessageReaction> withReactionsRemoved)

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

void setRecipient(ChannelAccount withRecipient)

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

void setRelatesTo(ConversationReference withRelatesTo)

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

void setReplyToId(String withReplyToId)

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

void setServiceUrl(String withServiceUrl)

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

void setSpeak(String withSpeak)

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

void setSuggestedActions(SuggestedActions withSuggestedActions)

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

void setSummary(String withSummary)

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

void setText(String withText)

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

void setTextFormat(TextFormatTypes withTextFormat)

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

void setTextHighlights(List<TextHighlight> withTextHighlights)

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

void setTimestamp(OffsetDateTime withTimestamp)

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

void setTopicName(String withTopicName)

スレッドの更新されたトピック名を設定します。

void setType(String withType)

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

void setValue(Object withValue)

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

void setValueType(String withValueType)

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

TeamsChannelData teamsGetChannelData()

Teamsチャネルデータを取得します。

java.lang.String teamsGetChannelId()

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

TeamsMeetingInfo teamsGetMeetingInfo()

現在のアクティビティから Teams会議情報オブジェクトを取得します。

java.lang.String teamsGetTeamId()

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

TeamInfo teamsGetTeamInfo()

Teams チーム情報データを取得します。

void teamsNotifyUser()

Teamsチャネルデータの通知値を true に設定します。

void teamsNotifyUser(boolean alertInMeeting, String externalResourceUrl)

Teamsチャネルデータ内の会議の通知を設定します。

メソッドの継承元: java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

コンストラクターの詳細

Activity

protected Activity()

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

Activity

public Activity(String withType)

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

Parameters:

withType - アクティビティの種類。

メソッドの詳細

<TypeT>getChannelData

public TypeT getChannelData(Class classType)

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

Parameters:

classType - 使用する TypeT のクラス

Returns:

型指定されたオブジェクトまたは default(TypeT)

Throws:

com.fasterxml.jackson.core.JsonProcessingException - チャネル データを TypeT に変換できない場合。

<TypeT>tryGetChannelData

public ResultPair tryGetChannelData(Class clsType)

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

Parameters:

clsType - 使用する TypeT のクラス

Returns:

TypeT としての ChannelData

applyConversationReference

public final Activity applyConversationReference(ConversationReference reference)

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

Parameters:

reference - 既存の会話参照。

Returns:

このアクティビティは、配信情報で更新されました。

applyConversationReference

public final Activity applyConversationReference(ConversationReference reference, boolean isIncoming)

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

Parameters:

reference - 既存の会話参照。
isIncoming - ボットが受信者である受信アクティビティとしてアクティビティを扱う場合は true。それ以外の場合は false。

Returns:

このアクティビティは、配信情報で更新されました。

clone

public static Activity clone(Activity activity)

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

Parameters:

activity - 複製するアクティビティ。

Returns:

新しい複製されたアクティビティ

createContactRelationUpdateActivity

public static Activity createContactRelationUpdateActivity()

CONTACT_RELATION_UPDATEタイプ Activity を作成します。

Returns:

連絡先関係の更新の種類 Activity。

createConversationUpdateActivity

public static Activity createConversationUpdateActivity()

CONVERSATION_UPDATEタイプ Activity を作成します。

Returns:

会話の更新の種類のアクティビティ。

createEndOfConversationActivity

public static Activity createEndOfConversationActivity()

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

Returns:

会話アクティビティの新しい終了。

createEventActivity

public static Activity createEventActivity()

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

Returns:

新しいイベント アクティビティ。

createHandoffActivity

public static Activity createHandoffActivity()

HANDOFF 型の Activity を作成します。

Returns:

新しいハンドオフ アクティビティ。

createInvokeActivity

public static Activity createInvokeActivity()

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

Returns:

新しい呼び出しアクティビティ。

createMessageActivity

public static Activity createMessageActivity()

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

Returns:

メッセージアクティビティの種類。

createReply

public Activity createReply()

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

Returns:

新しいメッセージ アクティビティ。

createReply

public Activity createReply(String withText)

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

Parameters:

withText - 返信のテキスト。

Returns:

新しいメッセージ アクティビティ。

createReply

public Activity createReply(String withText, String withLocale)

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

Parameters:

withText - 返信のテキスト。
withLocale - テキストの言語コード。

Returns:

新しいメッセージ アクティビティ。

createTrace

public Activity createTrace(String withName)

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

Parameters:

withName - 作成するトレース操作の名前。

Returns:

新しいトレース アクティビティ。

createTrace

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

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

Parameters:

withName - 作成するトレース操作の名前。
withValue - 省略可能。このトレース操作の内容。
withValueType - 省略可能、withValue の形式の識別子。 既定値は、withValue の型の名前です。
withLabel - 省略可能。このトレース操作の説明ラベル。

Returns:

新しいトレース アクティビティ。

createTraceActivity

public static Activity createTraceActivity(String withName)

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

Parameters:

withName - 操作の名前

Returns:

トレースの種類のアクティビティ。

createTraceActivity

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

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

Parameters:

withName - 操作の名前
withValueType - valueType 値スキーマを識別するのに役立つ場合 (既定値は value です。Gettype()。名前)
withValue - このトレース操作の内容。
withLabel - このトレース操作のわかりやすいラベル。

Returns:

トレースの種類のアクティビティ。

createTypingActivity

public static Activity createTypingActivity()

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

Returns:

新しい入力アクティビティ。

getAction

public String getAction()

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

Returns:

受信者のアクション。

getAttachmentLayout

public AttachmentLayoutTypes getAttachmentLayout()

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

Returns:

添付ファイルの種類。

getAttachments

public List getAttachments()

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

Returns:

Attachment一覧。

getCallerId

public String getCallerId()

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

Returns:

呼び出し元 IRI。

getChannelData

public Object getChannelData()

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

Returns:

チャネル固有のデータ。

getChannelId

public String getChannelId()

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

Returns:

チャネル ID。

getCode

public EndOfConversationCodes getCode()

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

Returns:

endOfConversation コード。

getConversation

public ConversationAccount getConversation()

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

Returns:

getConversationReference

public ConversationReference getConversationReference()

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

Returns:

このアクティビティを含む会話の会話参照。

getDeliveryMode

public String getDeliveryMode()

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

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

Returns:

配信モードのヒント。

getEntities

public List getEntities()

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

Returns:

Entity一覧。

getExpiration

public LocalDateTime getExpiration()

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

Returns:

アクティビティの有効期限。

getFrom

public ChannelAccount getFrom()

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

Returns:

ChannelAccount送信者の 。

getHistoryDisclosed

public boolean getHistoryDisclosed()

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

Returns:

True の場合、履歴が開示されます。

getId

public String getId()

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

Returns:

アクティビティ ID。

getImportance

public String getImportance()

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

Returns:

アクティビティの重要度。

getInputHint

public InputHints getInputHint()

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

Returns:

アクティビティの入力ヒント。

getLabel

public String getLabel()

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

Returns:

アクティビティ ラベル。

getListenFor

public List getListenFor()

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

Returns:

リッスンする語句の一覧。

getLocalTimestamp

public OffsetDateTime getLocalTimestamp()

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

Returns:

アクティビティのローカル タイムスタンプ。

getLocalTimezone

public String getLocalTimezone()

IANA タイム ゾーン データベース形式で表されるメッセージのローカル タイムゾーンの名前を取得します。 例: America/Los_Angeles。

Returns:

ローカル タイムゾーン。

getLocale

public String getLocale()

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

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

Returns:

コンテンツ ロケール。

getMembersAdded

public List getMembersAdded()

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

Returns:

追加されたメンバーの ChannelAccount 一覧。

getMembersRemoved

public List getMembersRemoved()

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

Returns:

削除されたメンバーの ChannelAccount 一覧。

getMentions

public List getMentions()

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

Returns:

メンションの配列。または空の配列 (何も見つからない場合)。

getName

public String getName()

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

Returns:

アクティビティ名。

getProperties

public Map getProperties()

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

Returns:

追加のプロパティのマップ。

getReactionsAdded

public List getReactionsAdded()

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

Returns:

MessageReaction一覧。

getReactionsRemoved

public List getReactionsRemoved()

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

Returns:

MessageReaction一覧。

getRecipient

public ChannelAccount getRecipient()

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

Returns:

ChannelAccount受信者の 。

getRelatesTo

public ConversationReference getRelatesTo()

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

Returns:

会話の参照。

getReplyConversationReference

public ConversationReference getReplyConversationReference(ResourceResponse reply)

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

Parameters:

reply - sendActivity から返される ResourceResponse。

Returns:

後でアクティビティを削除または更新するために格納および使用できる ConversationReference。

getReplyToId

public String getReplyToId()

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

Returns:

ID への応答。

getServiceUrl

public String getServiceUrl()

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

Returns:

サービス URL。

getSpeak

public String getSpeak()

読み上げるテキスト。

Returns:

読み上げる SSML テキスト。

getSuggestedActions

public SuggestedActions getSuggestedActions()

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

Returns:

アクティビティの SuggestedActions。

getSummary

public String getSummary()

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

Returns:

概要テキスト。

getText

public String getText()

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

Returns:

テキスト コンテンツ。

getTextFormat

public TextFormatTypes getTextFormat()

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

Returns:

TextFormatTypes 型。

getTextHighlights

public List getTextHighlights()

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

Returns:

TextHighlight の一覧。

getTimestamp

public OffsetDateTime getTimestamp()

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

Returns:

アクティビティの UTC タイムスタンプ。

getTopicName

public String getTopicName()

スレッドの更新されたトピック名を取得します。

Returns:

トピック名。

getType

public String getType()

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

Returns:

アクティビティの種類。

getValue

public Object getValue()

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

Returns:

Activity 値。

getValueType

public String getValueType()

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

Returns:

値の型です。

hasContent

public boolean hasContent()

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

Returns:

このメッセージに送信するコンテンツがある場合は true を返します。 それ以外の場合は false です。

isActivity

protected boolean isActivity(String activityType)

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

Parameters:

activityType - 比較対象の型。

Returns:

アクティビティが特定の種類の場合は true。

isFromStreamingConnection

public Boolean isFromStreamingConnection()

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

Returns:

True を指定すると、アクティビティはストリーミング接続から生成されます。

isTeamsActivity

public boolean isTeamsActivity()

このアクティビティが Microsoft Teams からのものかどうかを確認します。

Returns:

アクティビティが Microsoft Teams からの場合は true。

isType

public boolean isType(String compareTo)

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

Parameters:

compareTo - 比較対象の型。

Returns:

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

removeMentionText

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 からその値を削除します。

Parameters:

withId - 一致するメンション ID。

Returns:

new Activity.Text プロパティの値。

removeMentionTextImmutable

public static String removeMentionTextImmutable(Activity activity, String id)

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

Parameters:

activity - メンション テキストを削除するアクティビティ。
id - 受信者の ID。

Returns:

メンションが削除された Activity.Text。

removeRecipientMention

public String removeRecipientMention()

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

Returns:

新機能。Text プロパティの値。

removeRecipientMentionImmutable

public static String removeRecipientMentionImmutable(Activity activity)

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

Parameters:

activity - メンションを削除するアクティビティ。

Returns:

メンションが削除された Activity.Text。

setAction

public void setAction(String withAction)

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

Parameters:

withAction - 受信者のアクション。

setAttachment

public void setAttachment(Attachment withAttachment)

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

Parameters:

withAttachment - Attachment オブジェクト。

setAttachmentLayout

public void setAttachmentLayout(AttachmentLayoutTypes withAttachmentLayout)

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

Parameters:

withAttachmentLayout - 添付ファイルの種類。

setAttachments

public void setAttachments(List withAttachments)

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

Parameters:

withAttachments - の Attachment一覧。

setCallerId

public void setCallerId(String withCallerId)

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

Parameters:

withCallerId - 呼び出し元 ID。

setChannelData

public void setChannelData(Object withChannelData)

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

Parameters:

withChannelData - 特定のデータを JsonNode としてチャネルします。

setChannelId

public void setChannelId(String withChannelId)

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

Parameters:

withChannelId - チャネル ID。

setCode

public void setCode(EndOfConversationCodes withCode)

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

Parameters:

withCode - endOfConversation コード。

setConversation

public void setConversation(ConversationAccount withConversation)

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

Parameters:

withConversation - ConversationAccount

setDeliveryMode

public void setDeliveryMode(String withDeliveryMode)

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

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

Parameters:

withDeliveryMode - 配信モードヒント。

setEntities

public void setEntities(List withEntities)

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

Parameters:

withEntities - ペイロード エンティティ。

setExpiration

public void setExpiration(LocalDateTime withExpiration)

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

Parameters:

withExpiration - アクティビティの有効期限。

setFrom

public void setFrom(ChannelAccount withFrom)

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

Parameters:

withFrom - ChannelAccount送信者の 。

setHistoryDisclosed

public void setHistoryDisclosed(boolean withHistoryDisclosed)

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

Parameters:

withHistoryDisclosed - True を指定すると、履歴が開示されます。

setId

public void setId(String withId)

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

Parameters:

withId - アクティビティ ID。

setImportance

public void setImportance(String withImportance)

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

Parameters:

withImportance - アクティビティの重要度。

setInputHint

public void setInputHint(InputHints withInputHint)

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

Parameters:

withInputHint - アクティビティの入力ヒント。

setLabel

public void setLabel(String withLabel)

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

Parameters:

withLabel - アクティビティ ラベル。

setListenFor

public void setListenFor(List withListenFor)

音声と言語のプライミング システムがリッスンする必要があるフレーズと参照の一覧を設定します。

Parameters:

withListenFor - リッスンするフレーズの一覧。

setLocalTimeZone

public void setLocalTimeZone(String withLocalTimezone)

IANA タイム ゾーン データベース形式で表されるメッセージのローカル タイムゾーンの名前を設定します。 例: America/Los_Angeles。

Parameters:

withLocalTimezone - ローカルタイムゾーン。

setLocalTimestamp

public void setLocalTimestamp(OffsetDateTime withLocalTimestamp)

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

Parameters:

withLocalTimestamp - アクティビティのローカル タイムスタンプ。

setLocale

public void setLocale(String withLocale)

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

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

Parameters:

withLocale - コンテンツ ロケール。

setMembersAdded

public void setMembersAdded(List withMembersAdded)

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

Parameters:

withMembersAdded - 追加されたメンバーの ChannelAccount 一覧。

setMembersRemoved

public void setMembersRemoved(List withMembersRemoved)

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

Parameters:

withMembersRemoved - 削除されたメンバーの ChannelAccount 一覧。

setMentions

public void setMentions(List withMentions)

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

Parameters:

withMentions - ペイロード エンティティ。

setName

public void setName(String withName)

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

Parameters:

withName - アクティビティ名。

setProperties

public void setProperties(String key, JsonNode withValue)

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

Parameters:

key - 設定するプロパティのキー。
withValue - プロパティの値。

setReactionsAdded

public void setReactionsAdded(List withReactionsAdded)

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

Parameters:

withReactionsAdded - の MessageReaction一覧。

setReactionsRemoved

public void setReactionsRemoved(List withReactionsRemoved)

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

Parameters:

withReactionsRemoved - の MessageReaction一覧。

setRecipient

public void setRecipient(ChannelAccount withRecipient)

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

Parameters:

withRecipient - ChannelAccount受信者の 。

setRelatesTo

public void setRelatesTo(ConversationReference withRelatesTo)

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

Parameters:

withRelatesTo - 会話参照。

setReplyToId

public void setReplyToId(String withReplyToId)

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

Parameters:

withReplyToId - ID への応答。

setServiceUrl

public void setServiceUrl(String withServiceUrl)

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

Parameters:

withServiceUrl - アクティビティのサービス URL。

setSpeak

public void setSpeak(String withSpeak)

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

Parameters:

withSpeak - 読み上げる SSML テキスト。

setSuggestedActions

public void setSuggestedActions(SuggestedActions withSuggestedActions)

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

Parameters:

withSuggestedActions - アクティビティの SuggestedActions。

setSummary

public void setSummary(String withSummary)

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

Parameters:

withSummary - 概要テキスト。

setText

public void setText(String withText)

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

Parameters:

withText - テキスト コンテンツ。

setTextFormat

public void setTextFormat(TextFormatTypes withTextFormat)

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

Parameters:

withTextFormat - TextFormatTypes 型。

setTextHighlights

public void setTextHighlights(List withTextHighlights)

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

Parameters:

withTextHighlights - TextHighlight の一覧。

setTimestamp

public void setTimestamp(OffsetDateTime withTimestamp)

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

Parameters:

withTimestamp - アクティビティの UTC タイムスタンプ。

setTopicName

public void setTopicName(String withTopicName)

スレッドの更新されたトピック名を設定します。

Parameters:

withTopicName - トピック名。

setType

public void setType(String withType)

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

Parameters:

withType - アクティビティの種類。

setValue

public void setValue(Object withValue)

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

Parameters:

withValue - Activity 値。

setValueType

public void setValueType(String withValueType)

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

Parameters:

withValueType - Activity 値の型。

teamsGetChannelData

public TeamsChannelData teamsGetChannelData()

TeamsChannelData を取得します。

Returns:

TeamsChannelData

teamsGetChannelId

public String teamsGetChannelId()

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

Returns:

有効なデータを含む Teams アクティビティの場合は、チャネルを表す一意識別子。

teamsGetMeetingInfo

public TeamsMeetingInfo teamsGetMeetingInfo()

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

Returns:

現在のアクティビティのチームの会議、または null。

teamsGetTeamId

public String teamsGetTeamId()

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

Returns:

有効なデータを含む Teams アクティビティの場合は、チームを表す一意の識別子。

teamsGetTeamInfo

public TeamInfo teamsGetTeamInfo()

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

Returns:

有効なデータを含む Teams アクティビティの場合は、TeamInfo オブジェクト。

teamsNotifyUser

public void teamsNotifyUser()

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

teamsNotifyUser

public void teamsNotifyUser(boolean alertInMeeting, String externalResourceUrl)

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

Parameters:

alertInMeeting - True の 場合は、会議のアラートです。
externalResourceUrl - 外部リソースの URL。

適用対象