@salurusrinivasarao/emarsys-sdk-wrapper-plugin v1.0.5

capacitor-emarsys-sdk-plugin

Custom Capacitor Plugin To have communication with Emarsys SDK

Install

npm install capacitor-emarsys-sdk-plugin
npx cap sync

API

• echo(...)
• addListener('pushMessageEvent', ...)
• getUUID(...)
• requestPermissions()
• checkPermissions()
• setContact(...)
• getPushToken()
• register()
• checkPermissions()
• clearContact(...)
• setPushTokenFirebase(...)
• setPushMessage(...)
• getUserInfo(...)
• setUser(...)
• clearUser()
• getDeviceInformation(...)
• trackEvent(...)
• loadInlineInapp(...)
• addListener('EmarsysInAppDeepLink', ...)
• addListener('EmarsysInAppApplicationEvent', ...)
• addListener('EmarsysPushDeepLink', ...)
• addListener('EmarsysPushApplicationEvent', ...)
• addListener('EmarsysPushNotificationReceived', ...)
• Interfaces
• Type Aliases

echo(...)

echo(options: { value: string; }) => Promise<{ value: string; }>

Returns: Promise<{ value: string; }>

addListener('pushMessageEvent', ...)

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

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

getUUID(...)

getUUID(value: string) => Promise<{ value: string; }>

Returns: Promise<{ value: string; }>

requestPermissions()

requestPermissions() => Promise<PermissionStatus>

Returns: Promise<any>

checkPermissions()

checkPermissions() => Promise<PermissionStatus>

Returns: Promise<any>

setContact(...)

setContact(options: SetContactOptions) => Promise<void>

getPushToken()

getPushToken() => Promise<TokenResult>

Returns: Promise<TokenResult>

register()

register() => Promise<TokenResult>

Returns: Promise<TokenResult>

checkPermissions()

checkPermissions() => Promise<PermissionStatus>

Returns: Promise<any>

clearContact(...)

clearContact(options: SetContactOptions) => Promise<void>

setPushTokenFirebase(...)

setPushTokenFirebase(data: { value: string; }) => Promise<ITokenInitializationStatus>

Returns: Promise<ITokenInitializationStatus>

setPushMessage(...)

setPushMessage(data: PushMessageDTO) => Promise<{ value: PushMessageDTO; }>

Returns: Promise<{ value: PushMessageDTO; }>

getUserInfo(...)

getUserInfo(data: UserInformationDTO) => Promise<{ value: unknown; }>

Returns: Promise<{ value: unknown; }>

setUser(...)

setUser(data: { value: string; }) => Promise<void>

clearUser()

clearUser() => Promise<void>

getDeviceInformation(...)

getDeviceInformation(options?: { value?: string | undefined; } | undefined) => Promise<{ value: string; }>

Returns: Promise<{ value: string; }>

trackEvent(...)

trackEvent(options?: { eventName: string; eventAttributes: any; } | undefined) => Promise<{ value: string; }>

Returns: Promise<{ value: string; }>

loadInlineInapp(...)

loadInlineInapp(data: { inAppName: string; }) => Promise<void>

addListener('EmarsysInAppDeepLink', ...)

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

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

addListener('EmarsysInAppApplicationEvent', ...)

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

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

addListener('EmarsysPushDeepLink', ...)

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

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

addListener('EmarsysPushApplicationEvent', ...)

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

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

addListener('EmarsysPushNotificationReceived', ...)

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

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

Interfaces

PluginListenerHandle

PushMessageEvent

PermissionStatus

SetContactOptions

TokenResult

ITokenInitializationStatus

PushMessageDTO

UserInformationDTO

Type Aliases

PermissionState

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