BlobsTranscriptStore class

Package:

botbuilder-azure-blobs

BlobsTranscriptStore is a TranscriptStore that persists transcripts in Azure Blob Storage

Constructors

BlobsTranscriptStore(string, string, BlobsTranscriptStoreOptions)

Constructs a BlobsTranscriptStore instance.

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.
logActivity(Activity, BlobsTranscriptStoreOptions)	Log an activity to the transcript.

Constructor Details

BlobsTranscriptStore(string, string, BlobsTranscriptStoreOptions)

Constructs a BlobsTranscriptStore instance.

new BlobsTranscriptStore(connectionString: string, containerName: string, options?: BlobsTranscriptStoreOptions)

Parameters

connectionString

string

Azure Blob Storage connection string

containerName

string

Azure Blob Storage container name

options

BlobsTranscriptStoreOptions

Other options for BlobsTranscriptStore

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

channelId

conversationId

string

conversationId

Returns

Promise<void>

A promise representing the async operation.

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

channelId

conversationId

string

conversationId

continuationToken

string

continuation token to page through results

startDate

Date

earliest time to include in results

Returns

Promise<PagedResult<Activity>>

Promise that resolves to a PagedResult of Activity items

listTranscripts(string, string)

List conversations in the channelId.

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

Parameters

channelId

string

channelId

continuationToken

string

continuation token to page through results

Returns

Promise<PagedResult<TranscriptInfo>>

Promise that resolves to a PagedResult of Activity items

logActivity(Activity, BlobsTranscriptStoreOptions)

Log an activity to the transcript.

function logActivity(activity: Activity, options?: BlobsTranscriptStoreOptions): Promise<void>

Parameters

activity

Activity

activity to log

options

BlobsTranscriptStoreOptions

Optional settings for BlobsTranscriptStore

Returns

Promise<void>

A promise representing the async operation.