botbuilder-get-attachment

0.3.0 • Public • Published

botbuilder-get-attachment

Helper library for attachments retrieval. Supports attachments sent thru Skype, Chatbot Emulator and shell.

Library provides a function with next interface:

getAttament(session, attachmentId) - returns a Promise. Function arguments:

  • session - Microsoft Bot Framework Session object
  • attachmentId - index of attachment

Returned promise will be resolved with object, that will have next attributes:

  • name - (String|Buffer) Filename
  • contentUrl - optional (String|Buffer) URL to download attachment
  • content - (String|Buffer) Attachment body

Example

const builder = require('botbuilder');
const restify = require('restify');
 
let getAttachment = require('botbuilder-get-attachment.js');
let connector = new builder.ChatConnector({
  appId: '',
  appPassword: ''
});
 
let bot = new builder.UniversalBot(connector);
 
bot.dialog('/', [
  function (session) {
    builder.Prompts.attachment(session,'Import file')
  },
  function (session, args) {
    getAttachment(session, 0)
      .then( (result) => {
        session.endConversation( JSON.stringify(result.toString());
      }, (error) => {
        console.error(error);
        session.endConversation( error );
      })
  }
]);
 
 
const server = restify.createServer({name : 'Attachment Example'});
server.post('/api/messages', connector.listen());
server.listen(3978, function () {
  console.log(`server listening to 3978`);
});

Changelog

  • 0.3 - String Buffer returned
  • 0.2 - Simplified interfaces
  • 0.1 - First version of the library

Package Sidebar

Install

npm i botbuilder-get-attachment

Weekly Downloads

1

Version

0.3.0

License

MIT

Unpacked Size

4.58 kB

Total Files

5

Last publish

Collaborators

  • gudwin