ai.tock.bot.engine.user

Interface UserTimelineDAO

public UserTimelineDAO

To access class UserTimelines.

See Also:

class UserTimeline

Constructor Detail

UserTimelineDAO

public UserTimelineDAO()

Method Detail

save

void save(@NotNull
          UserTimeline userTimeline,
          @NotNull
          BotDefinition botDefinition)

Saves the timeline.

Parameters:

userTimeline - the timeline to save

botDefinition - the bot definition (in order to add stats about the bot)

save

void save(@NotNull
          UserTimeline userTimeline,
          @NotNull
          java.lang.String namespace)

Saves the timeline.

Parameters:

userTimeline - the timeline to save

namespace - the namespace of the current bot

updatePlayerId

void updatePlayerId(@NotNull
                    java.lang.String namespace,
                    @NotNull
                    PlayerId oldPlayerId,
                    @NotNull
                    PlayerId newPlayerId)

Update playerId for dialog and user timelines.

loadWithLastValidDialog

@NotNull
UserTimeline loadWithLastValidDialog(@NotNull
                                              java.lang.String namespace,
                                              @NotNull
                                              PlayerId userId,
                                              @Nullable
                                              PlayerId priorUserId,
                                              @Nullable
                                              java.lang.String groupId,
                                              @NotNull
                                              kotlin.jvm.functions.Function1<? super java.lang.String,? extends ai.tock.bot.definition.StoryDefinition> storyDefinitionProvider)

Loads with last dialog. If no timeline exists, creates a new one.

Parameters:

namespace - the namespace of the bot

userId - the user id of the last message

priorUserId - not null if this user ahs an other id before

groupId - not null if this is a conversation group

storyDefinitionProvider - provides interface StoryDefinition from story ids.

loadWithoutDialogs

@NotNull
UserTimeline loadWithoutDialogs(@NotNull
                                         java.lang.String namespace,
                                         @NotNull
                                         PlayerId userId)

Loads without the dialogs. If no timeline, create a new one.

loadByTemporaryIdsWithoutDialogs

@NotNull
java.util.List<ai.tock.bot.engine.user.UserTimeline> loadByTemporaryIdsWithoutDialogs(@NotNull
                                                                                               java.lang.String namespace,
                                                                                               @NotNull
                                                                                               java.util.List<java.lang.String> temporaryIds)

Loads without the dialogs.

remove

void remove(@NotNull
            java.lang.String namespace,
            @NotNull
            PlayerId playerId)

Remove the timeline and the associated dialogs.

removeClient

void removeClient(@NotNull
                  java.lang.String namespace,
                  @NotNull
                  java.lang.String clientId)

Remove all timelines and associated dialogs of a client.

getClientDialogs

@NotNull
java.util.List<ai.tock.bot.engine.dialog.Dialog> getClientDialogs(@NotNull
                                                                           java.lang.String namespace,
                                                                           @NotNull
                                                                           java.lang.String clientId,
                                                                           @NotNull
                                                                           kotlin.jvm.functions.Function1<? super java.lang.String,? extends ai.tock.bot.definition.StoryDefinition> storyDefinitionProvider)

Returns the dialogs of specified client id.

getDialogsUpdatedFrom

@NotNull
java.util.List<ai.tock.bot.engine.dialog.Dialog> getDialogsUpdatedFrom(@NotNull
                                                                                java.lang.String namespace,
                                                                                @NotNull
                                                                                java.time.Instant from,
                                                                                @NotNull
                                                                                kotlin.jvm.functions.Function1<? super java.lang.String,? extends ai.tock.bot.definition.StoryDefinition> storyDefinitionProvider)

Returns all dialogs updated after the specified Instant.

getSnapshots

@NotNull
java.util.List<ai.tock.bot.engine.dialog.Snapshot> getSnapshots(@NotNull
                                                                         org.litote.kmongo.Id<ai.tock.bot.engine.dialog.Dialog> dialogId)

Gets the snapshots of a dialog.

getLastStoryId

@Nullable
java.lang.String getLastStoryId(@NotNull
                                          java.lang.String namespace,
                                          @NotNull
                                          PlayerId playerId)

Returns the last story id of the specified user, if any.

getArchivedEntityValues

@NotNull
java.util.List<ai.tock.bot.engine.dialog.ArchivedEntityValue> getArchivedEntityValues(@NotNull
                                                                                               org.litote.kmongo.Id<ai.tock.bot.engine.dialog.EntityStateValue> stateValueId,
                                                                                               @NotNull
                                                                                               java.util.Map<org.litote.kmongo.Id,? extends ai.tock.bot.engine.action.Action> oldActionsMap)

Returns the archived values for the state id.

Parameters:

stateValueId - the state id

oldActionsMap - the option action map in order to retrieve the action of archived entity values.