leap-capacitor

Plugin for Leap

Install

npm install leap-capacitor
npx cap sync

API

• start(...)
• startWithSelfHostingEnabled(...)
• flushProperties(...)
• setUniqueUserId(...)
• startProject(...)
• embedProject(...)
• offlineSync(...)
• disable()
• logout()
• setAppLocale(...)
• registerExceptionCallback(...)
• addListener('leapCallbacks', ...)
• addListener('leapElementActionCallbacks', ...)
• addListener('leapExceptionCallbacks', ...)
• Interfaces

start(...)

start(options: { apiKey: string; }) => Promise<void>

| Param | Type | | ------------- | -------------------------------- | | options | { apiKey: string; } |

startWithSelfHostingEnabled(...)

startWithSelfHostingEnabled(options: { apiKey: string; baseUrl: string; }) => Promise<void>

| Param | Type | | ------------- | ------------------------------------------------- | | options | { apiKey: string; baseUrl: string; } |

flushProperties(...)

flushProperties(options: { properties: UserProperty; }) => Promise<void>

| Param | Type | | ------------- | ---------------------------------------------------------------------- | | options | { properties: UserProperty; } |

setUniqueUserId(...)

setUniqueUserId(options: { uniqueUserId: string; }) => Promise<void>

| Param | Type | | ------------- | -------------------------------------- | | options | { uniqueUserId: string; } |

startProject(...)

startProject(options: { projectId: string; resetProject?: boolean; }) => Promise<void>

| Param | Type | | ------------- | ----------------------------------------------------------- | | options | { projectId: string; resetProject?: boolean; } |

embedProject(...)

embedProject(options: { projectId: string; }) => Promise<void>

| Param | Type | | ------------- | ----------------------------------- | | options | { projectId: string; } |

offlineSync(...)

offlineSync(options: { projectIds: string[]; }) => Promise<void>

| Param | Type | | ------------- | -------------------------------------- | | options | { projectIds: string[]; } |

disable()

disable() => Promise<void>

logout()

logout() => Promise<void>

setAppLocale(...)

setAppLocale(options: { localeCode: string; }) => Promise<void>

| Param | Type | | ------------- | ------------------------------------ | | options | { localeCode: string; } |

registerExceptionCallback(...)

registerExceptionCallback(options: { callbackLevels: string[]; }) => Promise<void>

| Param | Type | | ------------- | ------------------------------------------ | | options | { callbackLevels: string[]; } |

addListener('leapCallbacks', ...)

addListener(eventName: 'leapCallbacks', listenerFunc: (event: LeapCallbacks) => void) => Promise<PluginListenerHandle> & PluginListenerHandle

| Param | Type | | ------------------ | --------------------------------------------------------------------------- | | eventName | 'leapCallbacks' | | listenerFunc | (event: LeapCallbacks) => void |

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

addListener('leapElementActionCallbacks', ...)

addListener(eventName: 'leapElementActionCallbacks', listenerFunc: (event: LeapElementActionCallbacks) => void) => Promise<PluginListenerHandle> & PluginListenerHandle

| Param | Type | | ------------------ | ----------------------------------------------------------------------------------------------------- | | eventName | 'leapElementActionCallbacks' | | listenerFunc | (event: LeapElementActionCallbacks) => void |

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

addListener('leapExceptionCallbacks', ...)

addListener(eventName: 'leapExceptionCallbacks', listenerFunc: (event: LeapExceptionCallbacks) => void) => Promise<PluginListenerHandle> & PluginListenerHandle

| Param | Type | | ------------------ | --------------------------------------------------------------------------------------------- | | eventName | 'leapExceptionCallbacks' | | listenerFunc | (event: LeapExceptionCallbacks) => void |

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

Interfaces

UserProperty

PluginListenerHandle

| Prop | Type | | ------------ | ----------------------------------------- | | remove | () => Promise<void> |

LeapCallbacks

LeapElementActionCallbacks

LeapExceptionCallbacks