PrivateConversationState Class

Package:: com.microsoft.bot.builder

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

java.lang.Object
- com.microsoft.bot.builder.BotState
- - com.microsoft.bot.builder.PrivateConversationState

public class PrivateConversationState
extends BotState

Handles persistence of a conversation state object using the conversation.Id and from.Id part of an activity.

Constructor Summary

Constructor	Description
PrivateConversationState(Storage storage)	Initializes a new instance of the PrivateConversationState class.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getStorageKey(TurnContext turnContext) Gets the key to use when reading and writing state to and from storage.

Methods inherited from BotState

<T>createProperty <T>getPropertyValue clearState delete deletePropertyValue get getCachedState getStorageKey load load saveChanges saveChanges setPropertyValue

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Constructor Details

PrivateConversationState

public PrivateConversationState(Storage storage)

Initializes a new instance of the PrivateConversationState class.

Parameters:

storage - The storage provider to use.

Method Details

getStorageKey

public String getStorageKey(TurnContext turnContext)

Gets the key to use when reading and writing state to and from storage.

Overrides:

PrivateConversationState.getStorageKey(TurnContext turnContext)

Parameters:

turnContext - The context object for this turn.

Returns:

The storage key.

Throws:

java.lang.IllegalArgumentException