Microsoft.Bot.Builder.Dialogs.Internals.IBotDataStore< T > Interface Template Reference

Public Member Functions

Task< bool > FlushAsync (IAddress key, CancellationToken cancellationToken)
 
Task< T > LoadAsync (IAddress key, BotStoreType botStoreType, CancellationToken cancellationToken)
 Return BotData with Data pointing to a JObject or an empty BotData() record with ETag:"" More...
 
Task SaveAsync (IAddress key, BotStoreType botStoreType, T data, CancellationToken cancellationToken)
 Save a BotData using the ETag. Etag consistency checks If ETag is null or empty, this will set the value if nobody has set it yet If ETag is "*" then this will unconditionally set the value If ETag matches then this will update the value if it is unchanged. If Data is null this removes record, otherwise it stores More...
 

Detailed Description

Definition at line 59 of file Microsoft.Bot.Builder/ConnectorEx/BotData.cs.

Member Function Documentation

Task<bool> Microsoft.Bot.Builder.Dialogs.Internals.IBotDataStore< T >.FlushAsync ( IAddress  key,
CancellationToken  cancellationToken 
)
Task<T> Microsoft.Bot.Builder.Dialogs.Internals.IBotDataStore< T >.LoadAsync ( IAddress  key,
BotStoreType  botStoreType,
CancellationToken  cancellationToken 
)

Return BotData with Data pointing to a JObject or an empty BotData() record with ETag:""

Parameters
keyThe key.
botStoreTypeThe bot store type.
cancellationTokenThe cancellation token.
Returns
Bot record that is stored for this key, or "empty" bot record ready to be stored
Task Microsoft.Bot.Builder.Dialogs.Internals.IBotDataStore< T >.SaveAsync ( IAddress  key,
BotStoreType  botStoreType,
data,
CancellationToken  cancellationToken 
)

Save a BotData using the ETag. Etag consistency checks If ETag is null or empty, this will set the value if nobody has set it yet If ETag is "*" then this will unconditionally set the value If ETag matches then this will update the value if it is unchanged. If Data is null this removes record, otherwise it stores

Parameters
keyThe key.
botStoreTypeThe bot store type.
dataThe data that should be saved.
cancellationTokenThe cancellation token.
Returns
throw HttpException(HttpStatusCode.PreconditionFailed) if update fails

The documentation for this interface was generated from the following file: