The documentation is currently a work in progress whilst the product is in alpha.


API used to handle events when the application is in a foreground state.

onForegroundEvent(observer: (event: Event) => void): () => void;

Applications in a foreground state will use an event handler registered by this API method to send events. Multiple foreground observers can be registered throughout the applications lifecycle. The method returns a function, used to unsubscribe from further events,

View the Foreground events documentation for more information and example usage.

To listen to background events, see the onBackgroundEvent documentation.


A Function which returns a Promise, called on a new event when the application is in a foreground state.

Copyright 2020 © Invertase Limited

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 3.0 License and code samples are licensed under the Apache 2.0 License.

All product names, logos, and brands are property of their respective owners. All company, product and service names used in this website are for identification purposes only. Use of these names, logos, and brands does not imply endorsement.