capacitor-clevertap v0.0.11

capacitor-clevertap

This plugin partially implements CleverTapAnalytics SDK. It's still under development and has many missing functions.

Follow iOS and Android initial setup instructions.

Install

npm install capacitor-clevertap
npx cap sync

API

• profileGetID()
• recordEvent(...)
• recordChargedEvent(...)
• profileIncrementValue(...)
• profilePush(...)
• setLocation(...)
• setPushTokenAs(...)
• onUserLogin(...)
• stopGeofence()
• initGeofence()
• addListener('geofenceInitializedListener', ...)
• addListener('locationUpdateListener', ...)
• addListener('geofenceEnteredListener', ...)
• addListener('geofenceExitedListener', ...)
• checkPermissions()
• requestPermissions()
• Interfaces
• Type Aliases

profileGetID()

profileGetID() => Promise<{ id: string; }>

Returns: Promise<{ id: string; }>

recordEvent(...)

recordEvent(props: { event: string; properties: any; }) => Promise<void>

recordChargedEvent(...)

recordChargedEvent(props: { details: any; items: any[]; }) => Promise<void>

profileIncrementValue(...)

profileIncrementValue(props: { key: string; value: number; }) => Promise<void>

profilePush(...)

profilePush(props: { profileProperties: any; }) => Promise<void>

setLocation(...)

setLocation(props: { lat: number; lng: number; }) => Promise<void>

setPushTokenAs(...)

setPushTokenAs(props: { token: string; }) => Promise<void>

onUserLogin(...)

onUserLogin(props: { profileProperties: any; }) => Promise<void>

stopGeofence()

stopGeofence() => Promise<void>

initGeofence()

initGeofence() => Promise<void>

addListener('geofenceInitializedListener', ...)

addListener(eventName: 'geofenceInitializedListener', listenerFunc: (event: { status: string; }) => void) => Promise<PluginListenerHandle>

Returns: Promise<PluginListenerHandle>

addListener('locationUpdateListener', ...)

addListener(eventName: 'locationUpdateListener', listenerFunc: (event: { lat: number; lng: number; }) => void) => Promise<PluginListenerHandle>

Returns: Promise<PluginListenerHandle>

addListener('geofenceEnteredListener', ...)

addListener(eventName: 'geofenceEnteredListener', listenerFunc: (event: GeofenceStatusChange) => void) => Promise<PluginListenerHandle>

Returns: Promise<PluginListenerHandle>

addListener('geofenceExitedListener', ...)

addListener(eventName: 'geofenceExitedListener', listenerFunc: (event: GeofenceStatusChange) => void) => Promise<PluginListenerHandle>

Returns: Promise<PluginListenerHandle>

checkPermissions()

checkPermissions() => Promise<{ location: PermissionState; backgroundUpdate: PermissionState; }>

Returns: Promise<{ location: PermissionState; backgroundUpdate: PermissionState; }>

requestPermissions()

requestPermissions() => Promise<void>

Interfaces

PluginListenerHandle

GeofenceStatusChange

Type Aliases

PermissionState

'prompt' | 'prompt-with-rationale' | 'granted' | 'denied'