Skip to content

colbylwilliams/NomadCode.BotFramework

Repository files navigation

NomadCode.BotFramework

NomadCode.BotFramework is a simple library to make working with Microsoft's Bot Framework on iOS and Android much easier.

Instead of polling GET requests, the library implements WebSockets using SocketRocket on iOS, and OkHttp3 on Android.

Installation

To make it easy to use anywhere, NomadCode.BotFramework is a shared project with only a few files.

To use in your project, you can either, clone, download, etc. and reference your local copy in your project.

Or, if you're using Git, you can add it as a submodule with the following command:

cd /path/to/your/projects/root

git submodule add https://github.com/colbylwilliams/NomadCode.BotFramework NomadCode.BotFramework

Use

NomadCode.BotFramework only contains a few classes, you'll primarily work with: BotClient and BotMessage.

BotClient is the class you'll use to interact with your bot. It handles sending messages to, and receiving messages from the Direct Line channel, including managing the state of the web socket, authentication, etc.

BotMessage is a wrapper around the incoming and outgoing Activities that make up a conversation, and contains additional metadata useful for displaying rich message formats in your app UI.

About

Created by Colby Williams.

License

Licensed under the MIT License (MIT). See LICENSE for details.