TranscriptStore Interface

Package:
com.microsoft.bot.builder
Maven Artifact:
com.microsoft.bot:bot-builder:4.14.3

Implements

TranscriptLogger

public interface TranscriptStore
extends TranscriptLogger

Transcript logger stores activities for conversations for recall.

Method Summary

Modifier and Type Method and Description
abstract java.util.concurrent.CompletableFuture<java.lang.Void> deleteTranscript(String channelId, String conversationId)

Deletes conversation data from the store.
default java.util.concurrent.CompletableFuture<PagedResult<Activity>> getTranscriptActivities(String channelId, String conversationId)

Gets from the store activities that match a set of criteria.
default java.util.concurrent.CompletableFuture<PagedResult<Activity>> getTranscriptActivities(String channelId, String conversationId, String continuationToken)

Gets from the store activities that match a set of criteria.
abstract java.util.concurrent.CompletableFuture<PagedResult<Activity>> getTranscriptActivities(String channelId, String conversationId, String continuationToken, OffsetDateTime startDate)

Gets from the store activities that match a set of criteria.
default java.util.concurrent.CompletableFuture<PagedResult<TranscriptInfo>> listTranscripts(String channelId)

Gets the conversations on a channel from the store.
abstract java.util.concurrent.CompletableFuture<PagedResult<TranscriptInfo>> listTranscripts(String channelId, String continuationToken)

Gets the conversations on a channel from the store.

Method Details

deleteTranscript

public abstract CompletableFuture deleteTranscript(String channelId, String conversationId)

Deletes conversation data from the store.

Parameters:

channelId - The ID of the channel the conversation is in.
conversationId - The ID of the conversation to delete.

Returns:

A task that represents the work queued to execute.

getTranscriptActivities

public default CompletableFuture> getTranscriptActivities(String channelId, String conversationId)

Gets from the store activities that match a set of criteria.

Parameters:

channelId - The ID of the channel the conversation is in.
conversationId - The ID of the conversation.

Returns:

A task that represents the work queued to execute. If the task completes successfully, the result contains the matching activities.

getTranscriptActivities

public default CompletableFuture> getTranscriptActivities(String channelId, String conversationId, String continuationToken)

Gets from the store activities that match a set of criteria.

Parameters:

channelId - The ID of the channel the conversation is in.
conversationId - The ID of the conversation.
continuationToken - The continuation token (if available).

Returns:

A task that represents the work queued to execute. If the task completes successfully, the result contains the matching activities.

getTranscriptActivities

public abstract CompletableFuture> getTranscriptActivities(String channelId, String conversationId, String continuationToken, OffsetDateTime startDate)

Gets from the store activities that match a set of criteria.

Parameters:

channelId - The ID of the channel the conversation is in.
conversationId - The ID of the conversation.
continuationToken - The continuation token (if available).
startDate - A cutoff date. Activities older than this date are not included.

Returns:

A task that represents the work queued to execute. If the task completes successfully, the result contains the matching activities.

listTranscripts

public default CompletableFuture> listTranscripts(String channelId)

Gets the conversations on a channel from the store.

Parameters:

channelId - The ID of the channel.

Returns:

A task that represents the work queued to execute.

listTranscripts

public abstract CompletableFuture> listTranscripts(String channelId, String continuationToken)

Gets the conversations on a channel from the store.

Parameters:

channelId - The ID of the channel.
continuationToken - The continuation token (if available).

Returns:

A task that represents the work queued to execute.

Applies to