Bot_Controller

Bot_Controller

new Bot_Controller(instances)

Parameters:
Name Type Description
instances Array.<Bot> An array with bot instances config
Source:

Methods

clearUservars(user, lang) → {Array}

Clears the rivescript user variables object
Parameters:
Name Type Description
user String The id of the user
lang String The language of the bot
Source:
Returns:
The rivescript user variables object
Type
Array

freezeUservars(user, lang) → {Array}

Freezes the rivescript user variables object
Parameters:
Name Type Description
user String The id of the user
lang String The language of the bot
Source:
Returns:
The rivescript user variables object
Type
Array

getArray(lang) → {Array}

Gets a rivescript array object
Parameters:
Name Type Description
lang String The language of the bot
Source:
Returns:
The array object
Type
Array

getSubstitution(lang) → {Array}

Gets a rivescript subtitution object
Parameters:
Name Type Description
lang String The language of the bot
Source:
Returns:
The subtitution object
Type
Array

getUserTopicTriggers(user, lang) → {Array}

Gets a rivescript user topic triggers
Parameters:
Name Type Description
user String The id of the user
lang String The language of the bot
Source:
Returns:
The rivescript user initial match
Type
Array

getUservar(user, name, lang) → {Array}

Gets a rivescript user variable by a given name
Parameters:
Name Type Description
user String The id of the user
name String The name of the substitution
lang String The language of the bot
Source:
Returns:
The rivescript user variable
Type
Array

getUservars(user, lang) → {Array}

Gets a rivescript user variables object
Parameters:
Name Type Description
user String The id of the user
lang String The language of the bot
Source:
Returns:
The rivescript user variables object
Type
Array

getVariable(user, name, lang) → {Array}

Gets a rivescript variable by a given name
Parameters:
Name Type Description
user String The id of the user
name String The name of the substitution
lang String The language of the bot
Source:
Returns:
The rivescript variable
Type
Array

initialMatch(user, lang) → {Array}

Gets a rivescript user initial match
Parameters:
Name Type Description
user String The id of the user
lang String The language of the bot
Source:
Returns:
The rivescript user initial match
Type
Array

lastMatch(user, lang) → {Array}

Gets a rivescript user last match
Parameters:
Name Type Description
user String The id of the user
lang String The language of the bot
Source:
Returns:
The rivescript user last match
Type
Array

processEvent(event) → {Object}

Process bot event and sends to rivescript
Parameters:
Name Type Description
event Event A NGINB event object
Source:
Returns:
A bluebird promise bot response object
Type
Object

setArray(name, value, lang) → {Array}

Sets a rivescript array to be used by the brain
Parameters:
Name Type Description
name String The name of the key of array
value Array The array of values
lang String The language of the bot
Source:
Returns:
The array
Type
Array

setEntities(entities, lang) → {Boolean}

Process entities and configure to use in rivescript
Parameters:
Name Type Description
entities Array.<EntityConfig> An array of entities objects
lang String The language of the bot to set entities to
Source:
Returns:
A bluebird promise with true or false
Type
Boolean

setGlobal(name, value, lang) → {Object}

Sets a rivescript global to be used by the brain
Parameters:
Name Type Description
name String The name of the key of global
value Array The array of values
lang String The language of the bot
Source:
Returns:
The global
Type
Object

setHandler(language_name, obj, lang) → {Object}

Sets a rivescript handler to be used by the brain
Parameters:
Name Type Description
language_name String The name of language used
obj Object A object to be used
lang String The language of the bot
Source:
Returns:
The handler
Type
Object

setPerson(name, value, lang) → {Object}

Sets a rivescript person to be used by the brain
Parameters:
Name Type Description
name String The name of the person
value Object The value of the person
lang String The language of the bot
Source:
Returns:
The person
Type
Object

setSubroutine(user, code, lang) → {Object}

Sets a rivescript subroutine to be used by the brain
Parameters:
Name Type Description
user String The id of the user
code Object The subroutine code
lang String The language of the bot
Source:
Returns:
The subroutine
Type
Object

setSubstitution(name, value, lang) → {Object}

Sets a rivescript substitution to be used by the brain
Parameters:
Name Type Description
name String The name of the substitution
value Object The value of the substitution
lang String The language of the bot
Source:
Returns:
The substitution
Type
Object

setUservar(user, name, value, lang) → {Object}

Sets a rivescript user variable to be used by the brain
Parameters:
Name Type Description
user String The id of the user
name String The name of the key of variable
value Array The array of values
lang String The language of the bot
Source:
Returns:
The user variable
Type
Object

setUservars(user, data, lang) → {Object}

Sets a object with rivescript user variables to be used by the brain
Parameters:
Name Type Description
user String The id of the user
data Object A data object with pairs of key/values
lang String The language of the bot
Source:
Returns:
The user variables object
Type
Object

setVariable(name, value, lang) → {Object}

Sets a rivescript variable to be used by the brain
Parameters:
Name Type Description
name String The name of the key of variable
value Array The array of values
lang String The language of the bot
Source:
Returns:
The variable
Type
Object

thawUservars(user, lang) → {Array}

Thaws the rivescript user variables object
Parameters:
Name Type Description
user String The id of the user
lang String The language of the bot
Source:
Returns:
The rivescript user variables object
Type
Array