TranscriptStore interface

Package:

botbuilder-core

Transcript logger stores activities for conversations for recall.

Extends

TranscriptLogger

Methods

deleteTranscript(string, string)	Delete a specific conversation and all of its activities.
getTranscriptActivities(string, string, string, Date)	Get activities for a conversation (Aka the transcript)
listTranscripts(string, string)	List conversations in the channelId.

Inherited Methods

logActivity(Activity)

Log an activity to the transcript.

Method Details

deleteTranscript(string, string)

Delete a specific conversation and all of its activities.

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

Parameters

channelId

string

Channel Id where conversation took place.

conversationId

string

Id of the conversation to delete.

Returns

Promise<void>

getTranscriptActivities(string, string, string, Date)

Get activities for a conversation (Aka the transcript)

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

Parameters

channelId

string

Channel Id.

conversationId

string

Conversation Id.

continuationToken

string

Continuation token to page through results.

startDate

Date

Earliest time to include.

Returns

Promise<PagedResult<Activity>>

listTranscripts(string, string)

List conversations in the channelId.

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

Parameters

channelId

string

Channel Id.

continuationToken

string

Continuation token to page through results.

Returns

Promise<PagedResult<TranscriptInfo>>

Inherited Method Details

logActivity(Activity)

Log an activity to the transcript.

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

Parameters

activity

Activity

Activity being logged.

Returns

void | Promise<void>

Inherited From TranscriptLogger.logActivity