ActivityEx module
as |
傳回來源活動做為 ICommandActivity 物件;如果這不是該類型的活動,則為 null。 |
as |
以 ICommandResultActivity 物件的形式傳回來源活動;如果這不是該類型的活動,則為 null。 |
as |
以 IContactRelationUpdateActivity 物件的形式傳回來源活動;如果這不是該類型的活動,則為 null。 |
as |
以 IConversationUpdateActivity 物件的形式傳回來源活動;如果這不是該類型的活動,則為 null。 |
as |
以 IEndOfConversationActivity 物件的形式傳回來源活動;如果這不是該類型的活動,則為 null。 |
as |
傳回來源活動做為 IEventActivity 物件;如果這不是該類型的活動,則為 null。 |
as |
傳回來源活動做為 IHandoffActivity 物件;如果這不是該類型的活動,則為 null。 |
as |
以 IInstallationUpdateActivity 物件的形式傳回來源活動;如果這不是該類型的活動,則為 null。 |
as |
傳回來源活動做為 IInvokeActivity 物件;如果這不是該類型的活動,則為 null。 |
as |
傳回來源活動做為 IMessageActivity 物件;如果這不是該類型的活動,則為 null。 |
as |
傳回來源活動做為 IMessageDeleteActivity 物件;如果這不是該類型的活動,則為 null。 |
as |
以 IMessageReactionActivity 物件的形式傳回來源活動;如果這不是該類型的活動,則為 null。 |
as |
以 IMessageUpdateActivity 物件的形式傳回來源活動;如果這不是該類型的活動,則為 null。 |
as |
傳回來源活動做為 ISuggestionActivity 物件;如果這不是該類型的活動,則為 null。 |
as |
傳回來源活動做為 ITraceActivity 物件;如果這不是該類型的活動,則為 null。 |
as |
傳回來源活動做為 ITypingActivity 物件;如果這不是該類型的活動,則為 null。 |
create |
建立 Activity 做為 IContactRelationUpdateActivity 物件。 |
create |
建立 Activity 做為 IConversationUpdateActivity 物件。 |
create |
建立 Activity 做為 IEndOfConversationActivity 物件。 |
create |
建立 Activity 做為 IEventActivity 物件。 |
create |
建立 Activity 做為 IHandoffActivity 物件。 |
create |
建立 Activity 做為 IInvokeActivity 物件。 |
create |
建立 Activity 做為 IMessageActivity 物件。 |
create |
建立新的訊息活動作為此活動的回應。 |
create |
根據來源活動建立新的追蹤活動。 |
create |
建立 Activity 做為 ITraceActivity 物件。 |
create |
建立 Activity 做為 ITypingActivity 物件。 |
get |
從交談參考建立活動,因為它會張貼至 Bot。 |
get |
根據來源活動建立 ConversationReference。 |
get |
從來源活動的實體解析提及。 請參閱 cref=「entities」 。 請參閱 cref=「mention」 。 |
has |
指出來源活動是否有內容。 |
is |
指出此活動是否為指定的活動類型。 |
is |
判斷活動是否透過 Http/Https 連線或串流傳送。 您可以藉由查看 ServiceUrl 屬性來判斷: (1) 透過 HTTP/HTTPs 傳送訊息的所有通道都不會串流 (2 個) 通道,這些通道透過串流傳送訊息的 ServiceUrl 開頭不是 HTTP/HTTPs。 |
傳回來源活動做為 ICommandActivity 物件;如果這不是該類型的活動,則為 null。
function asCommandActivity<T>(source: Partial<Activity>): Partial<ICommandActivity<T>>
參數
- source
-
Partial<Activity>
來源活動。
傳回
Partial<ICommandActivity<T>>
此活動作為命令活動;或 null。
以 ICommandResultActivity 物件的形式傳回來源活動;如果這不是該類型的活動,則為 null。
function asCommandResultActivity<T>(source: Partial<Activity>): Partial<ICommandResultActivity<T>>
參數
- source
-
Partial<Activity>
來源活動。
傳回
Partial<ICommandResultActivity<T>>
此活動作為命令結果活動;或 null。
以 IContactRelationUpdateActivity 物件的形式傳回來源活動;如果這不是該類型的活動,則為 null。
function asContactRelationUpdateActivity(source: Partial<Activity>): Partial<IContactRelationUpdateActivity>
參數
- source
-
Partial<Activity>
來源活動。
傳回
Partial<IContactRelationUpdateActivity>
此活動做為連絡人關係更新活動;或 null。
以 IConversationUpdateActivity 物件的形式傳回來源活動;如果這不是該類型的活動,則為 null。
function asConversationUpdateActivity(source: Partial<Activity>): Partial<IConversationUpdateActivity>
參數
- source
-
Partial<Activity>
來源活動。
傳回
Partial<IConversationUpdateActivity>
此活動做為交談更新活動;或 null。
以 IEndOfConversationActivity 物件的形式傳回來源活動;如果這不是該類型的活動,則為 null。
function asEndOfConversationActivity(source: Partial<Activity>): Partial<IEndOfConversationActivity>
參數
- source
-
Partial<Activity>
來源活動。
傳回
Partial<IEndOfConversationActivity>
此活動作為對話活動的結尾;或 null。
傳回來源活動做為 IEventActivity 物件;如果這不是該類型的活動,則為 null。
function asEventActivity(source: Partial<Activity>): Partial<IEventActivity>
參數
- source
-
Partial<Activity>
來源活動。
傳回
Partial<IEventActivity>
此活動做為事件活動;或 null。
傳回來源活動做為 IHandoffActivity 物件;如果這不是該類型的活動,則為 null。
function asHandoffActivity(source: Partial<Activity>): Partial<IHandoffActivity>
參數
- source
-
Partial<Activity>
來源活動。
傳回
Partial<IHandoffActivity>
此活動做為交接活動;或 null。
以 IInstallationUpdateActivity 物件的形式傳回來源活動;如果這不是該類型的活動,則為 null。
function asInstallationUpdateActivity(source: Partial<Activity>): Partial<IInstallationUpdateActivity>
參數
- source
-
Partial<Activity>
來源活動。
傳回
Partial<IInstallationUpdateActivity>
此活動作為安裝更新活動;或 null。
傳回來源活動做為 IInvokeActivity 物件;如果這不是該類型的活動,則為 null。
function asInvokeActivity(source: Partial<Activity>): Partial<IInvokeActivity>
參數
- source
-
Partial<Activity>
來源活動。
傳回
Partial<IInvokeActivity>
此活動作為叫用活動;或 null。
傳回來源活動做為 IMessageActivity 物件;如果這不是該類型的活動,則為 null。
function asMessageActivity(source: Partial<Activity>): Partial<IMessageActivity>
參數
- source
-
Partial<Activity>
來源活動。
傳回
Partial<IMessageActivity>
此活動作為訊息活動;或 null。
傳回來源活動做為 IMessageDeleteActivity 物件;如果這不是該類型的活動,則為 null。
function asMessageDeleteActivity(source: Partial<Activity>): Partial<IMessageDeleteActivity>
參數
- source
-
Partial<Activity>
來源活動。
傳回
Partial<IMessageDeleteActivity>
此活動作為訊息刪除要求;或 null。
以 IMessageReactionActivity 物件的形式傳回來源活動;如果這不是該類型的活動,則為 null。
function asMessageReactionActivity(source: Partial<Activity>): Partial<IMessageReactionActivity>
參數
- source
-
Partial<Activity>
來源活動。
傳回
Partial<IMessageReactionActivity>
此活動作為訊息反應活動;或 null。
以 IMessageUpdateActivity 物件的形式傳回來源活動;如果這不是該類型的活動,則為 null。
function asMessageUpdateActivity(source: Partial<Activity>): Partial<IMessageUpdateActivity>
參數
- source
-
Partial<Activity>
來源活動。
傳回
Partial<IMessageUpdateActivity>
此活動作為訊息更新要求;或 null。
傳回來源活動做為 ISuggestionActivity 物件;如果這不是該類型的活動,則為 null。
function asSuggestionActivity(source: Partial<Activity>): Partial<ISuggestionActivity>
參數
- source
-
Partial<Activity>
來源活動。
傳回
Partial<ISuggestionActivity>
此活動為建議活動;或 null。
傳回來源活動做為 ITraceActivity 物件;如果這不是該類型的活動,則為 null。
function asTraceActivity(source: Partial<Activity>): Partial<ITraceActivity>
參數
- source
-
Partial<Activity>
來源活動。
傳回
Partial<ITraceActivity>
此活動作為追蹤活動;或 null。
傳回來源活動做為 ITypingActivity 物件;如果這不是該類型的活動,則為 null。
function asTypingActivity(source: Partial<Activity>): Partial<ITypingActivity>
參數
- source
-
Partial<Activity>
來源活動。
傳回
Partial<ITypingActivity>
此活動做為輸入活動;或 null。
建立 Activity 做為 IContactRelationUpdateActivity 物件。
function createContactRelationUpdateActivity(): Partial<IContactRelationUpdateActivity>
傳回
Partial<IContactRelationUpdateActivity>
新的連絡人關聯更新活動。
建立 Activity 做為 IConversationUpdateActivity 物件。
function createConversationUpdateActivity(): Partial<IConversationUpdateActivity>
傳回
Partial<IConversationUpdateActivity>
新的交談更新活動。
建立 Activity 做為 IEndOfConversationActivity 物件。
function createEndOfConversationActivity(): Partial<IEndOfConversationActivity>
傳回
Partial<IEndOfConversationActivity>
對話活動的新結束。
建立 Activity 做為 IEventActivity 物件。
function createEventActivity(): Partial<IEventActivity>
傳回
Partial<IEventActivity>
新的事件活動。
建立 Activity 做為 IHandoffActivity 物件。
function createHandoffActivity(): Partial<IHandoffActivity>
傳回
Partial<IHandoffActivity>
新的遞交活動。
建立 Activity 做為 IInvokeActivity 物件。
function createInvokeActivity(): Partial<IInvokeActivity>
傳回
Partial<IInvokeActivity>
新的叫用活動。
建立 Activity 做為 IMessageActivity 物件。
function createMessageActivity(): Partial<IMessageActivity>
傳回
Partial<IMessageActivity>
新的訊息活動。
建立新的訊息活動作為此活動的回應。
function createReply(source: Activity, text?: string, locale?: string): Activity
參數
- source
- Activity
要回應的活動。
- text
-
string
回復的文字。
- locale
-
string
文字 的語言代碼 @param 。
傳回
新的訊息活動。
備註
新的活動會根據此活動設定路由資訊。
根據來源活動建立新的追蹤活動。
function createTrace(source: Activity, name: string, value?: unknown, valueType?: string, label?: string): ITraceActivity
參數
- source
- Activity
要根據追蹤的活動。
- name
-
string
要建立的追蹤作業名稱。
- value
-
unknown
選擇性,此追蹤作業的內容。
- valueType
-
string
選擇性,值 格式的 @param 識別碼。 預設值是值 類型的 @param 名稱。
- label
-
string
選擇性,這個追蹤作業的描述性標籤。
傳回
新的追蹤活動。
建立 Activity 做為 ITraceActivity 物件。
function createTraceActivity(name: string, valueType?: string, value?: unknown, label?: string): Partial<ITraceActivity>
參數
- name
-
string
要建立的追蹤作業名稱。
- valueType
-
string
選擇性,值 格式的 @param 識別碼。 預設值是值 類型的 @param 名稱。
- value
-
unknown
選擇性,此追蹤作業的內容。
- label
-
string
選擇性,這個追蹤作業的描述性標籤。
傳回
Partial<ITraceActivity>
新的追蹤活動。
建立 Activity 做為 ITypingActivity 物件。
function createTypingActivity(): Partial<ITypingActivity>
傳回
Partial<ITypingActivity>
新的輸入活動。
從交談參考建立活動,因為它會張貼至 Bot。
function getContinuationActivity(reference: Partial<ConversationReference>): Partial<Activity>
參數
- reference
-
Partial<ConversationReference>
交談參考
傳回
Partial<Activity>
活動
根據來源活動建立 ConversationReference。
function getConversationReference(source: Partial<Activity>): ConversationReference
參數
- source
-
Partial<Activity>
來源活動。
傳回
包含活動之交談的交談參考。
從來源活動的實體解析提及。
請參閱 cref=「entities」 。
請參閱 cref=「mention」 。
function getMentions(source: Partial<Activity>): Mention[]
參數
- source
-
Partial<Activity>
來源活動。
傳回
Mention[]
提及的陣列;如果找不到空陣列,則為 。
備註
這個方法只適用于訊息活動,其中活動類型設定為 Message。
指出來源活動是否有內容。
function hasContent(source: Partial<Activity>): boolean
參數
- source
-
Partial<Activity>
來源活動。
傳回
boolean
True 是表示 如果此活動有任何要傳送的內容;否則為 false。
備註
這個方法只適用于訊息活動,其中活動類型設定為 Message。
指出此活動是否為指定的活動類型。
function isActivity(source: Partial<Activity>, activityType: string): boolean
參數
- source
-
Partial<Activity>
來源活動。
- activityType
-
string
要檢查的活動類型。
傳回
boolean
如果活動是指定的活動類型,則為 True;否則為 false。
判斷活動是否透過 Http/Https 連線或串流傳送。 您可以藉由查看 ServiceUrl 屬性來判斷: (1) 透過 HTTP/HTTPs 傳送訊息的所有通道都不會串流 (2 個) 通道,這些通道透過串流傳送訊息的 ServiceUrl 開頭不是 HTTP/HTTPs。
function isFromStreamingConnection(source: Partial<Activity>): boolean
參數
- source
-
Partial<Activity>
來源活動。
傳回
boolean
如果活動源自串流連線,則為 True。