NativeHost Class

Backend for desktop/mobile native applications

Methods

Name Description
checkInternetConnectivity(): InternetConnectivityStatus Static get current value of internet connectivity  
notifyNativeFrontend<T extends undefined>(methodName: T extends undefined, ...args: Parameters<>): void Static Send a notification to the NativeApp connected to this NativeHost.  
shutdown(): Promise<void> Static Shutdown native app backend.  
startup(opt?: NativeHostOpts): Promise<void> Static Start the backend of a native app.  

Properties

Name Type Description
applicationName Accessor StaticReadOnly string    
appSettingsCacheDir Accessor StaticReadOnly string Get the local cache folder for application settings  
isValid Accessor StaticReadOnly boolean    
onInternetConnectivityChanged Static BeEvent<(status: InternetConnectivityStatus) => void> Event called when the internet connectivity changes, if known.  
onUserStateChanged Static BeEvent<(token?: AccessToken) => void> Event called when the user's sign-in state changes - this may be due to calls to signIn(), signOut() or because the token was refreshed  
settingsStore Accessor StaticReadOnly NativeAppStorage Get the settings store for this NativeHost.  

Defined in

Last Updated: 01 December, 2021