saihubot 0.38.0 | Documentation

SaihuBot

SaihuBot main instance.

new SaihuBot(config: Object, renderMessage: function, renderComponent: function)

Parameters

config (Object)

Name	Description
config.adapter `object`	Saihubot platform specific adapter.
config.brainConfig `object`	brain related config.
config.notFoundMessages `Array<string>`	default not found messages
config.saveChatLog `boolean`	save chatlog or not (default: true), need coperate with `brain` in addon.
config.user `string`	user prompt (default: me) , same as connfig.userAlias
config.userAlias `string`	user prompt (default: me)
config.welcomeMessage `string`	default welcome message (optional) messages (optional)
config.addons `Array<object>`	addons array
config.skills `Array<Object>`	skills array
config.debug `boolean`	show debug messages

renderMessage (function) define how to render the message

renderComponent (function) define how to render the html component

Instance Members

▸ responses

Host all support skills

responses

▸ catchAll(msg)

render not found messages.

catchAll(msg: string)

Parameters

msg (string) origin message

▸ processListeners(msg)

Check if input message matched with any skill.

processListeners(msg: string)

Parameters

msg (string) message to process

▸ send(msg, role)

Send text based message to bot.

send(msg: string, role: string)

Parameters

msg (string) input message

role (string) who send the message ('bot' or 'user')

▸ sendComponent(element, role)

Send object based message to bot. the object depends on adapter's implementation.

sendComponent(element: string, role: string)

Parameters

element (string) input object

role (string) who send the message ('bot' or 'user')

▸ ask(msg)

Send text based message to reuse other skill. Will not show in chat history.

ask(msg: string)

Parameters

msg (string) input message

▸ render()

Render result to screen.

render()

▸ hasRightDependency(requirements)

To validate requirements.

hasRightDependency(requirements: Object): boolean

Parameters

requirements (Object)

Name	Description
requirements.adapters `Array<string>`	requirements definition from adapters
requirements.addons `Array<string>`	requirements definition from addons
requirements.skills `Array<string>`	requirements definition from skills

Returns

boolean: result - the requirements is valid or not