botbuilder-azure (original) (raw)

Bot Builder Azure

Azure extensions for Microsoft BotBuilder.

• Installing
• Basic Use
• Documentation
• Class Reference
• GitHub Repo
• Report Issues

Installing

To add the latest version of this package to your bot:

npm install --save botbuilder-azure

Use the Daily Build

To get access to the daily builds of this library, configure npm to use the MyGet feed before installing.

npm config set registry https://botbuilder.myget.org/F/botbuilder-v4-js-daily/npm/

To reset the registry in order to get the latest published version, run:

npm config set registry https://registry.npmjs.org/

What's Included

This module contains interfaces to use common Azure services to back Bot Builder's state storage. When used with UserState, ConversationState and BotState, these storage interfaces will automatically read and write values to the associated Azure service.

It currently supports Cosmos DB (CosmosDbPartitionedStorage()) and Azure Blob Storage (BlobStorage()).

Also included is an interface to store and retrieve chat transcripts in blog storage called AzureBlobTranscriptStore()

Use

Import the module into your app.

const { BlobStorage } = require('botbuilder-azure');

Configure the storage driver to work with your Azure resources.

const blobStorage = new BlobStorage(options);

Pass the storage driver into your state managers:

const userState = new UserState(blobStorage); const conversationState = new ConverationState(blobStorage);