org.botlibre.api.sense

Interface Sense

All Known Subinterfaces:

DiscoverySense

All Known Implementing Classes:

BasicSense, Chat, Context, Email, Facebook, FacebookMessaging, Freebase, Google, GoogleCalendar, Http, IRC, Kik, RemoteService, Skype, Slack, Telegram, TextEntry, Timer, Twilio, Twitter, TwitterDirectMessaging, Vision, WeChat, Wikidata, Wiktionary, WolframAlpha

public interface Sense

Defines an external interface. i.e. - text - voice - hearing - vision

Method Summary

Modifier and Type	Method and Description
void	awake() Start sensing.
Bot	getBot() Return the associated Bot instance.
Language.LanguageState	getLanguageState() Return the current conversational state.
java.lang.String	getName() Return the name that identifies the sense.
Primitive	getPrimitive() Allows senses to be referenced by memory.
void	initialize(java.util.Map<java.lang.String,java.lang.Object> properties) Initialize any configuration properties.
void	input(java.lang.Object inputData) Receive any input from the sense.
void	input(java.lang.Object inputData, Network network) Receive any input from the sense.
boolean	isEnabled() Return if the sense is enabled.
void	migrateProperties() Migrate to new properties system.
void	notifyExceptionListeners(java.lang.Throwable exception)
void	output(Vertex output) Output the active network through the sense, could be text, sound, image, commands etc..
void	pool() Reset state when instance is pooled.
void	saveProperties()
void	setAction(java.lang.String action) Set the current action.
void	setBot(Bot Bot) Set the associated Bot instance.
void	setEmotionalState(EmotionalState emotion) Set the current conversational mood.
void	setIsEnabled(boolean isEnabled) Allow the sense to disabled/enabled.
void	setLanguageState(Language.LanguageState languageState) Set the current conversational state.
void	setName(java.lang.String name) Set the name that identifies the sense.
void	shutdown() Stop sensing.

Method Detail

initialize

void initialize(java.util.Map<java.lang.String,java.lang.Object> properties)

Initialize any configuration properties.

awake

void awake()

Start sensing.

shutdown

void shutdown()

Stop sensing.

pool

void pool()

Reset state when instance is pooled.

input

void input(java.lang.Object inputData)

Receive any input from the sense. The type of input varies by sense, could be text, sound, image, html etc.

input

void input(java.lang.Object inputData,
           Network network)
    throws java.lang.Exception

Receive any input from the sense. The type of input varies by sense, could be text, sound, image, html etc.

Throws:

java.lang.Exception

output

void output(Vertex output)

Output the active network through the sense, could be text, sound, image, commands etc..

getName

java.lang.String getName()

Return the name that identifies the sense.

setName

void setName(java.lang.String name)

Set the name that identifies the sense.

getBot

Bot getBot()

Return the associated Bot instance.

setBot

void setBot(Bot Bot)

Set the associated Bot instance.

getLanguageState

Language.LanguageState getLanguageState()

Return the current conversational state.

setLanguageState

void setLanguageState(Language.LanguageState languageState)

Set the current conversational state.

setEmotionalState

void setEmotionalState(EmotionalState emotion)

Set the current conversational mood.

setAction

void setAction(java.lang.String action)

Set the current action.

isEnabled

boolean isEnabled()

Return if the sense is enabled.

setIsEnabled

void setIsEnabled(boolean isEnabled)

Allow the sense to disabled/enabled.

getPrimitive

Primitive getPrimitive()

Allows senses to be referenced by memory.

notifyExceptionListeners

void notifyExceptionListeners(java.lang.Throwable exception)

migrateProperties

void migrateProperties()

Migrate to new properties system.

saveProperties

void saveProperties()