/
StoryHandlerListener.kt
39 lines (34 loc) · 1.31 KB
/
StoryHandlerListener.kt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
/*
* Copyright (C) 2017/2021 e-voyageurs technologies
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package ai.tock.bot.definition
import ai.tock.bot.engine.BotBus
/**
* To listen before and after action handling.
* Need to be registered using [ai.tock.bot.engine.BotRepository.registerStoryHandlerListener].
*/
interface StoryHandlerListener {
/**
* Called before [StoryHandler.handle].
* If it returns false, the [StoryHandlerListener]s registered after this listener
* and the [StoryHandler] are not called.
* (however [endAction] of each [StoryHandlerListener] is called].
*/
fun startAction(botBus: BotBus, handler: StoryHandler): Boolean = true
/**
* Called when [StoryHandler] handling is over.
*/
fun endAction(botBus: BotBus, handler: StoryHandler) = Unit
}