This site is obsolete and should be used for reference only. The information in this documentation is not guaranteed to work for Bot Framework SDK versions past 4.9.1.

Event Companion (Android)

The Event Companion app enables you to create widgets that will responds to custom events sent from your Virtual Assistant

Architecture

Virtual Assistant Client (Android) overview diagram

Prerequisites

  1. Set up your own Virtual Assistant Client.

  2. Download the Event Companion app source code.

Build and run

Run

Build and run your app to deploy to the Android Emulator or a connected device.

Create new widgets

Create sample numeric and toggle widgets.

Numeric widgets and toggle widgets are available in Event Companion app for now. Event Companion app widgets

Numeric widget

  1. Long press on a blank area of the home screen, then select Widgets.

  2. Select a numeric widget and drag onto the the home screen.

  3. Configure:
    • Label: Widget label
    • Event: The name value of an event activity
    • Icon: Widget icon Predefined templates are available to populate a numeric widget for common scenarios. Numeric widget
  4. Click Add Widget to finish placing on the home screen.

Toggle widget

  1. Long press on a blank area of the home screen, then select Widgets.

  2. Select a toggle widget and drag onto the the home screen.

  3. Configure:
    • Label: Widget label
    • Event: The name value of an event activity
    • Icon: Widget icon Predefined templates are available to populate a toggle widget for common scenarios. Toggle widget
  4. Click Add Widget to finish setting up the widget.

Manage widgets

All created widgets can be reconfigured from the main screen of the Event Companion app. Event companion manage widgets

  1. Select the widget which needs to be reconfigured.

  2. Modify properties.

  3. Select Save Widget to apply the changes.