onEvent handler

Responsible for handling events received from Alan.

While Alan interacts with the user and interpretes the user’s input, it emits a series of events. For each event, Alan generates JSON output with the event description. You can intercept the event information and use it in your app logic if needed.

You can use the following Alan events:

• recognized

• parsed

• text

recognized event

The event is emitted during and upon the user’s input recognition. The event description contains the interpreted phrase and the recognition state in the final field:

• If the user’s input is being recognized, the final field value is false.

• If the user’s input has been recognized, the final field value is true.

// The user’s input is being recognized
{text: hello, final: false}

// The user’s input has been recognized
{text: hello, final: true}

parsed event

The event is emitted after the user’s input has been parsed and interpreted.The event description contains the interpreted user’s phrase.

{text: hello}

text event

This event is emitted when Alan plays the reply to the user. The event description contains Alan’s phrase.

{text: I am here}

Examples

Web (React, Angular, etc.)

var alanBtnInstance = alanBtn({
  key: "a552799e77cd7970091cb1f9fc484b652e956eca572e1d8b807a3e2338fdd0dc/stage",
  onEvent: function (e) {
    console.info('onEvent', e);
  },
  rootEl: document.getElementById("alan-btn"),
});

Objective-C

self.button.onEvent = ^(NSString *payload) {
  NSData* eventData = [payload dataUsingEncoding:NSUTF8StringEncoding];
  NSError* error = nil;
  NSDictionary* eventDict = [NSJSONSerialization JSONObjectWithData:eventData options:0 error:&error];
  if (error != nil) {
    return;
  }
  NSLog(@"%@", eventDict);
};

Swift

self.button.onEvent = { event in
  guard let eventData = event?.data(using: .utf8, allowLossyConversion: false),
    let eventDict = try? JSONSerialization.jsonObject(with: eventData, options: .mutableContainers)
  else {
    return
  }
  print(eventDict)
}

Kotlin

val alanCallback: AlanCallback = object : AlanCallback() {
  /// Handle events
  override fun onEvent(payload: String) {
    try {
      val eventDict = JSONObject(payload)
      Log.d("AlanButton", "onEvent: event: $eventDict")
    } catch (e: JSONException) {
      Log.e("AlanButton", e.message)
    }
  }
}

Java

AlanCallback alanCallback = new AlanCallback() {
  /// Handle events
  @Override
  public void onEvent(String payload) {
    try {
      JSONObject eventDict = new JSONObject(payload);
      Log.d("AlanButton", "onEvent: event: " + eventDict);
    } catch (JSONException e) {
      Log.e("AlanButton", e.getMessage());
    }
  }
};

Flutter

_MyHomePageState() {
  /// Handle events
  AlanVoice.onEvent.add((event) {
    debugPrint("got new event ${event.data.toString()}");
  });
}

Ionic

this.alanBtnComponent.nativeElement.addEventListener('event', (data) => {
  const event = (<CustomEvent>data).detail;
  this.eventSectionEl.nativeElement.innerText = this.eventSectionEl.nativeElement.innerText + JSON.stringify(event) + '\n\n';
});

React Native

import { NativeEventEmitter, NativeModules } from 'react-native';
const { AlanManager, AlanEventEmitter } = NativeModules;
const alanEventEmitter = new NativeEventEmitter(AlanEventEmitter);

componentDidMount() {
  /// Handle events
  alanEventEmitter.addListener('onEvent', (payload) => {
    console.log(`onEvent: ${JSON.stringify(payload)}`);
  });
}
componentWillUnmount() {
  alanEventEmitter.removeAllListeners('onEvent');
}