FileTranscriptStore class

套件:

botbuilder

檔案文字記錄存放區會將文字記錄儲存在文件系統中，並將每個活動儲存為檔案。

備註

這個類別提供介面，將所有傳入和傳出活動記錄到文件系統。 它會實作與 TranscriptLoggerMiddleware 外掛程式搭配運作所需的功能。 在協奏中使用時，您的 Bot 會自動記錄所有交談。

以下是在您的應用程式中使用此程式碼所需的重複使用程式碼：

const { FileTranscriptStore, TranscriptLoggerMiddleware } = require('botbuilder');

adapter.use(new TranscriptLoggerMiddleware(new FileTranscriptStore(__dirname + '/transcripts/')));

建構函式

FileTranscriptStore(string)

建立 FileTranscriptStore 的實例。

方法

deleteTranscript(string, string)	刪除交談及其所有活動。
getTranscriptActivities(string, string, string, Date)	取得與交談標識符相關聯的所有活動（也稱為取得文字記錄）。
listTranscripts(string, string)	列出指定 channelId 的所有已記錄交談。
logActivity(Activity)	將活動記錄至文字記錄。

建構函式詳細資料

FileTranscriptStore(string)

建立 FileTranscriptStore 的實例。

new FileTranscriptStore(folder: string)

參數

folder

string

將儲存文字記錄的根資料夾。

方法詳細資料

deleteTranscript(string, string)

刪除交談及其所有活動。

function deleteTranscript(channelId: string, conversationId: string): Promise<void>

參數

channelId

string

發生交談的通道標識碼。

conversationId

string

要刪除之交談的標識碼。

傳回

Promise<void>

代表異步操作的承諾。

getTranscriptActivities(string, string, string, Date)

取得與交談標識符相關聯的所有活動（也稱為取得文字記錄）。

function getTranscriptActivities(channelId: string, conversationId: string, continuationToken?: string, startDate?: Date): Promise<PagedResult<Activity>>

參數

channelId

string

通道標識碼。

conversationId

string

交談標識碼。

continuationToken

string

（選擇性）逐頁查看結果的接續令牌。

startDate

Date

（選擇性）最早包含的時間。

傳回

Promise<PagedResult<Activity>>

PagedResult 活動。

listTranscripts(string, string)

列出指定 channelId 的所有已記錄交談。

function listTranscripts(channelId: string, continuationToken?: string): Promise<PagedResult<TranscriptInfo>>

參數

channelId

string

通道標識碼。

continuationToken

string

（選擇性）逐頁查看結果的接續令牌。

傳回

Promise<PagedResult<TranscriptInfo>>

PagedResult 的文字記錄。

logActivity(Activity)

將活動記錄至文字記錄。

function logActivity(activity: Activity): Promise<void>

參數

activity

Activity

正在記錄的活動。

傳回

Promise<void>

代表異步操作的承諾。