React SDK Reference / VitalSignEnginePlugin
Interface: VitalSignEnginePlugin
The main interface of the Vital Sign Plugin.
Methods
configure()
configure(
config):void
Call this method to configure the plugin.
Parameters
config
The object with configuration settings
Returns
void
getHealth()
getHealth(
options):GetHealthResult
When the scanning session started, client must call this method with a frequency of atleast 20Hz.
Parameters
options
Contains the required informations for processing.
Returns
isReady()
isReady():
Promise<boolean>
Call this method to check if the plugin is ready to start.
Returns
Promise<boolean>
sendHealthReport()
sendHealthReport(
healthReport,emailTemplate,source):Promise<void>
Parameters
email
string[]
A list of receipients' email
healthReport
string
An attachement of file(s) (e.g. pdf, images, ...) in base64 string
emailTemplate
The template used in the email to the user which contains the health report
source
string
The sender email used for sending the email to the user
Returns
Promise<void>
Deprecated
For backward compatibility only. A feature to distribute health report in PDF via AWS SES
start()
start():
Promise<void>
Call this method to start a scanning session.
Returns
Promise<void>
stop()
stop():
Promise<void>
Call this method to stop the scanning session.
Returns
Promise<void>
waitUntilReady()
waitUntilReady():
Promise<void>
Call this method to wait until the plugin is ready.
Returns
Promise<void>