通过

FileTranscriptStore class

  • 参考
包:
botbuilder

文件脚本存储将脚本存储在文件系统中，每个活动都作为文件存储。

注解

此类提供一个接口，用于将所有传入和传出活动记录到文件系统。 它实现与 TranscriptLoggerMiddleware 插件一起使用所需的功能。 在音乐会中使用时，机器人会自动记录所有对话。

下面是在应用中使用此样板代码所需的样本代码：

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

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

构造函数

FileTranscriptStore(string)

创建 FileTranscriptStore 的实例。

方法

deleteTranscript(string, string)

删除对话及其所有活动。
getTranscriptActivities(string, string, string, Date)

获取与聊天 ID 关联的所有活动（即获取脚本）。
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

对话所在的频道 ID。

conversationId

string

要删除的会话的 ID。

返回

Promise<void>

表示异步操作的 promise。

getTranscriptActivities(string, string, string, Date)

获取与聊天 ID 关联的所有活动（即获取脚本）。

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

参数

channelId

string

通道 ID。

conversationId

string

对话 ID。

continuationToken

string

（可选）继续标记以分页浏览结果。

startDate

Date

（可选）最早包含的时间。

返回

Promise<PagedResult<Activity>>

PagedResult 的活动。

listTranscripts(string, string)

列出给定 channelId 的所有已记录对话。

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

参数

channelId

string

通道 ID。

continuationToken

string

（可选）继续标记以分页浏览结果。

返回

Promise<PagedResult<TranscriptInfo>>

脚本的 PagedResult。

logActivity(Activity)

将活动记录到脚本。

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

参数

activity

Activity

正在记录的活动。

返回

Promise<void>

表示异步操作的 promise。