Interface: MelioEmbed
Defined in: index.ts:81
The main object for embedding Melio into your application.
Properties
navigate()
navigate: (
target) =>void
Defined in: index.ts:91
Navigate to target location after the application has already rendered.
Parameters
target
string
The target to navigate to.
Returns
void
onExitRequested()
onExitRequested: (
callback) =>UnlistenFn
Defined in: index.ts:98
Callback to be called when the user requests to exit Melio's application.
Parameters
callback
(originator) => void
The callback to be called when the user requests to exit the application.
Returns
onSessionExpired()
onSessionExpired: (
callback) =>UnlistenFn
Defined in: index.ts:104
Callback to be called when the user's session has expired.
Parameters
callback
() => void
The callback to be called when the user's session has expired.
Returns
onSyncUrl()
onSyncUrl: (
callback) =>UnlistenFn
Defined in: index.ts:119
Callback to be called when the user navigates to a new target internally, so that the host application can keep the url in sync.
Parameters
callback
(target) => void
The callback to be called when the user navigates to a new target internally.
Returns
onUserActivePing()
onUserActivePing: (
callback) =>UnlistenFn
Defined in: index.ts:111
Callback to be called whenever an active ping is received from Melio's application. Use this to keep the user's session alive when the user interacts with Melio.
Parameters
callback
() => void
The callback to be called when the user is active.
Returns
render()
render: (
options) =>void
Defined in: index.ts:86
Render the Melio application into the specified HTML element.
Parameters
options
The options for rendering the application.
Returns
void