Compartilhar via

FileTranscriptStore class

  • Referência
Pacote:
botbuilder

O repositório de transcrição de arquivos armazena transcrições no sistema de arquivos com cada atividade como um arquivo.

Comentários

Essa classe fornece uma interface para registrar todas as atividades de entrada e saída no sistema de arquivos. Ele implementa os recursos necessários para trabalhar junto com o plug-in TranscriptLoggerMiddleware. Quando usado em conjunto, o bot registrará automaticamente todas as conversas.

Veja abaixo o código clichê necessário para usá-lo em seu aplicativo:

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

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

Construtores

FileTranscriptStore(string)

Cria uma instância do FileTranscriptStore.

Métodos

deleteTranscript(string, string)

Exclua uma conversa e todas as atividades.
getTranscriptActivities(string, string, string, Date)

Obtenha todas as atividades associadas a uma ID de conversa (também conhecida como obter a transcrição).
listTranscripts(string, string)

Liste todas as conversas registradas em log para uma determinada channelId.
logActivity(Activity)

Registre uma atividade na transcrição.

Detalhes do construtor

FileTranscriptStore(string)

Cria uma instância do FileTranscriptStore.

new FileTranscriptStore(folder: string)

Parâmetros

folder

string

Pasta raiz em que a transcrição será armazenada.

Detalhes do método

deleteTranscript(string, string)

Exclua uma conversa e todas as atividades.

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

Parâmetros

channelId

string

ID do canal onde a conversa ocorreu.

conversationId

string

ID da conversa a ser excluída.

Retornos

Promise<void>

Uma promessa que representa a operação assíncrona.

getTranscriptActivities(string, string, string, Date)

Obtenha todas as atividades associadas a uma ID de conversa (também conhecida como obter a transcrição).

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

Parâmetros

channelId

string

ID do canal.

conversationId

string

ID da conversa.

continuationToken

string

(Opcional) Token de continuação para a página pelos resultados.

startDate

Date

(Opcional) Hora mais antiga para incluir.

Retornos

Promise<PagedResult<Activity>>

PagedResult de atividades.

listTranscripts(string, string)

Liste todas as conversas registradas em log para uma determinada channelId.

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

Parâmetros

channelId

string

ID do canal.

continuationToken

string

(Opcional) Token de continuação para a página pelos resultados.

Retornos

Promise<PagedResult<TranscriptInfo>>

PagedResult de transcrições.

logActivity(Activity)

Registre uma atividade na transcrição.

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

Parâmetros

activity

Activity

Atividade sendo registrada em log.

Retornos

Promise<void>

uma promessa que representa a operação assíncrona.