syclin / keywordbotinterface

a node module of an easy-to-use keyword chatbot interface.

KeywordBotInterface

a node module of an easy-to-use keyword chatbot interface.

Getting started

Require this module

var KeywordBotInterface = require('path/to/this/repo'); // please wait for me to publish this repo, haha.
var keywordBot = new KeywordBotInterface();

Simple Text Response Example

In this part of the tutorial you will find it really simple to define the bot's simple text response to specific messages received.

The following four code snippets demonstrate the CRUD of simple text response behavior.

1. Create keyword response

keywordBot.addKeyword('mySampleMessage', 'mySampleResponse', function(err) {
  if(err && err.code == keywordBot.error.KEYWORD_DUPLICATE) {
    console.log('Error: the key already existed');
  } else {
    console.log('Keyword added successfully');
  }
});

2. Read keyword response

keywordBot.getResponse('mySampleMessage', function(err, res) {
  if(err && err.code == keywordBot.error.KEYWORD_NOT_FOUND) {
    console.log('Error: keyword not found');
  } else {
    console.log('the response is:', res);
  }
});

3. Update keyword response

(TODO)

4. Delete keyword response

keywordBot.removeKeyword('mySampleMessage', null, function(err, res) {
  if(err && err.code == keywordBot.error.KEYWORD_NOT_FOUND) {
    console.log('Error: keyword not found');
  } else {
    console.log('Keyword deleted successfully');
  }
});