ChannelServiceHandlerBase class
ChannelServiceHandlerBase 會實作 API,以將活動轉送至技能,並實作透過 Bot/配接器從技能向上路由 ChannelAPI 呼叫。
方法
方法詳細資料
handleCreateConversation(string, ConversationParameters)
建立新的交談。
function handleCreateConversation(authHeader: string, parameters: ConversationParameters): Promise<ConversationResourceResponse>
參數
- authHeader
-
string
驗證標頭。
- parameters
-
ConversationParameters
(xref:botbuilder-core.ConversationParameters) 以建立對話的來源。
傳回
Promise<ConversationResourceResponse>
作業的 Promise
表示法。
handleDeleteActivity(string, string, string)
刪除現有的 活動。
function handleDeleteActivity(authHeader: string, conversationId: string, activityId: string): Promise<void>
參數
- authHeader
-
string
驗證標頭。
- conversationId
-
string
交談標識碼。
- activityId
-
string
要刪除的活動識別碼。
傳回
Promise<void>
handleDeleteConversationMember(string, string, string)
從交談中刪除成員。
function handleDeleteConversationMember(authHeader: string, conversationId: string, memberId: string): Promise<void>
參數
- authHeader
-
string
驗證標頭。
- conversationId
-
string
交談標識碼。
- memberId
-
string
要從這個交談中刪除的成員標識碼。
傳回
Promise<void>
handleGetActivityMembers(string, string, string)
列舉 Activity的成員。
function handleGetActivityMembers(authHeader: string, conversationId: string, activityId: string): Promise<ChannelAccount[]>
參數
- authHeader
-
string
驗證標頭。
- conversationId
-
string
交談標識碼。
- activityId
-
string
活動標識碼。
傳回
Promise<ChannelAccount[]>
列舉 ChannelAccount 清單。
handleGetConversationMember(string, string, string)
取得單一交談成員的帳戶。
function handleGetConversationMember(authHeader: string, userId: string, conversationId: string): Promise<ChannelAccount>
參數
- authHeader
-
string
驗證標頭。
- userId
-
string
用戶標識碼。
- conversationId
-
string
交談標識碼。
傳回
Promise<ChannelAccount>
所提供使用者標識碼的 ChannelAccount。
handleGetConversationMembers(string, string)
列舉交談的成員。
function handleGetConversationMembers(authHeader: string, conversationId: string): Promise<ChannelAccount[]>
參數
- authHeader
-
string
驗證標頭。
- conversationId
-
string
交談標識碼。
傳回
Promise<ChannelAccount[]>
列舉 ChannelAccount 清單。
handleGetConversationPagedMembers(string, string, number, string)
一次列舉一頁交談的成員。
function handleGetConversationPagedMembers(authHeader: string, conversationId: string, pageSize?: number, continuationToken?: string): Promise<PagedMembersResult>
參數
- authHeader
-
string
驗證標頭。
- conversationId
-
string
交談標識碼。
- pageSize
-
number
建議的頁面大小。
- continuationToken
-
string
接續令牌。
傳回
Promise<PagedMembersResult>
Promise
,代表作業 PagedMembersResult。
handleGetConversations(string, string, string)
列出 Bot 參與的交談。
function handleGetConversations(authHeader: string, conversationId: string, continuationToken?: string): Promise<ConversationsResult>
參數
- authHeader
-
string
驗證標頭。
- conversationId
-
string
交談標識碼。
- continuationToken
-
string
略過或接續令牌。
傳回
Promise<ConversationsResult>
作業的 Promise
表示法。
handleReplyToActivity(string, string, string, Activity)
回復傳送至 活動。
function handleReplyToActivity(authHeader: string, conversationId: string, activityId: string, activity: Activity): Promise<ResourceResponse>
參數
- authHeader
-
string
驗證標頭。
- conversationId
-
string
交談標識碼。
- activityId
-
string
回復的活動標識碼。
- activity
-
Activity
要傳送 活動。
傳回
Promise<ResourceResponse>
Promise
,代表作業的 ResourceResponse。
handleSendConversationHistory(string, string, Transcript)
上傳交談的歷史活動。
function handleSendConversationHistory(authHeader: string, conversationId: string, transcript: Transcript): Promise<ResourceResponse>
參數
- authHeader
-
string
驗證標頭。
- conversationId
-
string
交談標識碼。
- transcript
-
Transcript
(xref:botframework-schema.活動的文字記錄。
傳回
Promise<ResourceResponse>
Promise
,代表作業的 ResourceResponse。
handleSendToConversation(string, string, Activity)
將 活動 傳送至交談結尾。
function handleSendToConversation(authHeader: string, conversationId: string, activity: Activity): Promise<ResourceResponse>
參數
- authHeader
-
string
驗證標頭。
- conversationId
-
string
交談標識碼。
- activity
-
Activity
要傳送 活動。
傳回
Promise<ResourceResponse>
Promise
,代表作業的 ResourceResponse。
handleUpdateActivity(string, string, string, Activity)
編輯先前傳送的現有 活動。
function handleUpdateActivity(authHeader: string, conversationId: string, activityId: string, activity: Activity): Promise<ResourceResponse>
參數
- authHeader
-
string
驗證標頭。
- conversationId
-
string
交談標識碼。
- activityId
-
string
要更新的活動標識碼。
- activity
-
Activity
取代 活動。
傳回
Promise<ResourceResponse>
Promise
,代表作業的 ResourceResponse。
handleUploadAttachment(string, string, AttachmentData)
在處理企業時,將數據儲存在符合規範的存放區中。
function handleUploadAttachment(authHeader: string, conversationId: string, attachmentUpload: AttachmentData): Promise<ResourceResponse>
參數
- authHeader
-
string
驗證標頭。
- conversationId
-
string
交談標識碼。
- attachmentUpload
-
AttachmentData
(xref:botframework-schema.AttachmentData)。
傳回
Promise<ResourceResponse>
Promise
,代表作業的 ResourceResponse。