AzureBlobTranscriptStore class

Package:

botbuilder-azure

Warning

This API is now deprecated.

This class is deprecated in favor of BlobsTranscriptStore

Stores transcripts in an Azure Blob container.

Remarks

Each activity is stored as JSON blob with a structure of container/{channelId]/{conversationId}/{Timestamp.ticks}-{activity.id}.json.

Constructors

AzureBlobTranscriptStore(BlobStorageSettings)

Creates a new AzureBlobTranscriptStore instance.

Methods

deleteTranscript(string, string)	Delete a specific conversation and all of it's activities.
getTranscriptActivities(string, string, string, Date)	Get activities for a conversation (Aka the transcript)
listTranscripts(string, string)	List conversations in the channelId.
logActivity(Activity)	Log an activity to the transcript.

Constructor Details

AzureBlobTranscriptStore(BlobStorageSettings)

Creates a new AzureBlobTranscriptStore instance.

new AzureBlobTranscriptStore(settings: BlobStorageSettings)

Parameters

settings

BlobStorageSettings

Settings required for configuring an instance of BlobStorage

Method Details

deleteTranscript(string, string)

Delete a specific conversation and all of it's 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>>

The PagedResult of activities.

listTranscripts(string, string)

List conversations in the channelId.

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

Parameters

channelId

string

Channel Id.

continuationToken

string

ContinuationToken token to page through results.

Returns

Promise<PagedResult<TranscriptInfo>>

A promise representation of PagedResult

logActivity(Activity)

Log an activity to the transcript.

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

Parameters

activity

Activity

Activity being logged.

Returns

Promise<void>