Documentation

Powered by Algolia

Alan Client SDKs

With the Alan Client SDK, you can integrate Alan with any app built with:

Upon integration, your app gets the in-app voice assistant that can be activated with the Alan button displayed on top of the app's UI. The users can interact with the voice assistant by giving the voice commands defined in the script of your Alan Studio project.

To enable communication between Alan and the app and let you implement voice UX functionality on the client side, Alan exposes its methods and handlers:

  • Client API methods: enable communication between the client app and Alan and allow triggering voice activities on the client side.
  • onCommand handler: handles commands sent from the voice scripts to the app. Use this handler to perform tasks or actions on voice commands in the client app: navigate between the app screens, highlight a UI element on the screen and so on.
  • onButtonState handler: handles the Alan button state change events.
  • onEvent handler: handles events received from Alan when the user’s input is being recognized.