resulcapacitor

Resul capacitor plugin

Install

npm install resulcapacitor
npx cap sync

API

• register()
• registerWithPermission()
• updatePushToken(...)
• onDeviceUserRegister(...)
• customEvent(...)
• locationUpdate(...)
• appConversionTracking(...)
• getNotifications()
• getNotificationsReadCount()
• getNotificationsUnReadCount()
• deleteNotificationById(...)
• notificationCTAClicked(...)
• deleteNotificationByCampaignId(...)
• readNotification(...)
• unReadNotification(...)
• screenTracking(...)
• echo(...)
• addListener('registration', ...)
• addListener('registrationError', ...)
• addListener('pushNotificationReceived', ...)
• addListener('pushNotificationActionPerformed', ...)
• removeAllListeners()
• Interfaces
• Type Aliases

register()

register() => Promise<void>

registerWithPermission()

registerWithPermission() => Promise<void>

updatePushToken(...)

updatePushToken(options: { token: string; }) => Promise<void>

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

onDeviceUserRegister(...)

onDeviceUserRegister(options: JsonObject) => Promise<void>

| Param | Type | | ------------- | ------------------------------------------------- | | options | JsonObject |

customEvent(...)

customEvent(options: JsonObject) => Promise<void>

| Param | Type | | ------------- | ------------------------------------------------- | | options | JsonObject |

locationUpdate(...)

locationUpdate(options: JsonObject) => Promise<void>

| Param | Type | | ------------- | ------------------------------------------------- | | options | JsonObject |

appConversionTracking(...)

appConversionTracking(options: JsonObject) => Promise<void>

| Param | Type | | ------------- | ------------------------------------------------- | | options | JsonObject |

getNotifications()

getNotifications() => Promise<{ notifications: any[]; }>

Returns: Promise<{ notifications: any[]; }>

getNotificationsReadCount()

getNotificationsReadCount() => Promise<{ count: number; }>

Returns: Promise<{ count: number; }>

getNotificationsUnReadCount()

getNotificationsUnReadCount() => Promise<{ count: number; }>

Returns: Promise<{ count: number; }>

deleteNotificationById(...)

deleteNotificationById(options: string) => Promise<string>

| Param | Type | | ------------- | ------------------- | | options | string |

Returns: Promise<string>

notificationCTAClicked(...)

notificationCTAClicked(options: JsonObject) => Promise<void>

| Param | Type | | ------------- | ------------------------------------------------- | | options | JsonObject |

deleteNotificationByCampaignId(...)

deleteNotificationByCampaignId(options: { campaignId: string; }) => Promise<string>

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

Returns: Promise<string>

readNotification(...)

readNotification(options: { campaignId: string; }) => Promise<void>

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

unReadNotification(...)

unReadNotification(options: { campaignId: string; }) => Promise<void>

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

screenTracking(...)

screenTracking(options: { screenName: string; }) => Promise<void>

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

echo(...)

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

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

Returns: Promise<{ value: string; }>

addListener('registration', ...)

addListener(eventName: 'registration', listenerFunc: (token: Token) => void) => Promise<PluginListenerHandle> & PluginListenerHandle

| Param | Type | | ------------------ | ----------------------------------------------------------- | | eventName | 'registration' | | listenerFunc | (token: Token) => void |

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

addListener('registrationError', ...)

addListener(eventName: 'registrationError', listenerFunc: (error: any) => void) => Promise<PluginListenerHandle> & PluginListenerHandle

| Param | Type | | ------------------ | ------------------------------------ | | eventName | 'registrationError' | | listenerFunc | (error: any) => void |

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

addListener('pushNotificationReceived', ...)

addListener(eventName: 'pushNotificationReceived', listenerFunc: (notification: PushNotificationSchema) => void) => Promise<PluginListenerHandle> & PluginListenerHandle

| Param | Type | | ------------------ | ---------------------------------------------------------------------------------------------------- | | eventName | 'pushNotificationReceived' | | listenerFunc | (notification: PushNotificationSchema) => void |

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

addListener('pushNotificationActionPerformed', ...)

addListener(eventName: 'pushNotificationActionPerformed', listenerFunc: (notification: ActionPerformed) => void) => Promise<PluginListenerHandle> & PluginListenerHandle

| Param | Type | | ------------------ | -------------------------------------------------------------------------------------- | | eventName | 'pushNotificationActionPerformed' | | listenerFunc | (notification: ActionPerformed) => void |

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

removeAllListeners()

removeAllListeners() => Promise<void>

Interfaces

PluginListenerHandle

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

Token

| Prop | Type | | ----------- | ------------------- | | value | string |

PushNotificationSchema

| Prop | Type | | ------------------ | -------------------- | | title | string | | subtitle | string | | body | string | | id | string | | badge | number | | notification | any | | data | any | | click_action | string | | link | string | | group | string | | groupSummary | boolean |

ActionPerformed

| Prop | Type | | ------------------ | ------------------------------------------------------------------------- | | actionId | string | | inputValue | string | | notification | PushNotificationSchema |

Type Aliases

JsonObject

{ [key: string]: any; }