directline-api-v3

Connect to microsoft bot framework, directline through Version 3 APIs

This library is intended as a demonstration of my skills. Please follow this link for official microsoft library.

https://github.com/microsoft/botframework-directlinejs

Install

npm install directline-api-v3

usage

var BotConnect = require('directline-api-v3');

exchanging secret for a token

  BotConnect.getTokenObject('add your app secret here').subscribe(
      (tokenObject)=>{
       console.log(tokenObject);
     },
     (err)=>console.log(err),
     ()=>console.log('complete')
  )

getTokenObject(secret) takes a string(your app secret) as input and returns an observable which inturn returns a tokenObject. A TokenObject returned by this observable will look like this and you will have to store this object for further operations.

{ 
conversationId: 'LtWoKPdC5pX37GL3zLrJnL',
token: '3TL1kEsa6oY.dAA.TAB0AFcAbwBLAFAAZABDADUAcABYADMANwBHAEwAMwB6AEwAcgBKAG4ATAA.c93vfLV60gE.B8BJw8P6s60.O-8VJVii9WRlu0XrviYzwFES1ZG9ZhGld2QVa7OHSVo',
expires_in: 1800 
}

starting a conversation and start receiving messages from bot through web socket.

        let callback = function() {
	        if(err) console.log(err);
	        else console.log("Successfully opened Stream");
        }
        BotConnect.initConversationStream(TokenObject, callback).subscribe(
            (message)=>{
                  console.log(message);
            },
            (err)=>console.log(err),
            ()=>console.log("complete")
        )
    }

initConversationStream(TokenObject) will take the TokenObject & callback function as input and return an oberservable that will inturn emit messages from the bot. Under the hood a web socket is setup for receiving messages from bot, when the bot opens websocket stream, callback will be called with error being null, and when bot closes the websocket you will receive a complete event from observable. Callback is useful to determine when to start sending messages to bot.

sending a message to bot

         let options = { from: 'test@mail.com'};
         BotConnect.sendMessage(TokenObject,"hello", options).subscribe(
                      next:(data)=>console.log(data),
                      error:(err)=>console.log(err),
                      complete:()=>console.log("complete")
)}

sendMessage(TokenObject,message) will take the TokenObject and a string containing the message as input as well as options object containing from property and return an observable using which you can test weather it was successfull. If your next call back gets called then the operation can be considered successful.

This is a work in progress I will keep adding more features in near future. Thanks