FileTranscriptStore class
文件脚本存储区将脚本存储在文件系统中,其中每个活动都作为一个文件。
注解
此类提供一个接口,用于将所有传入和传出活动记录到文件系统。 它实现与 TranscriptLoggerMiddleware 插件一起工作所需的功能。 在音乐会中使用时,机器人将自动记录所有对话。
下面是在应用中使用它所需的样板代码:
const { FileTranscriptStore, TranscriptLoggerMiddleware } = require('botbuilder');
adapter.use(new TranscriptLoggerMiddleware(new FileTranscriptStore(__dirname + '/transcripts/')));
构造函数
File |
创建 FileTranscriptStore 的实例。 |
方法
delete |
删除对话及其所有活动。 |
get |
获取与对话 ID 关联的所有活动, (又名获取脚本) 。 |
list |
列出给定 channelId 的所有记录对话。 |
log |
将活动记录到脚本中。 |
构造函数详细信息
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>
表示异步操作的承诺。
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>
表示异步操作的承诺。