fractel-push-notifications

Custom Capacitor Plugin for Incoming call and regular push notifications with Firebase

Install

npm install fractel-push-notifications
npx cap sync

API

• checkPermissions()
• requestPermissions()
• register()
• unregister()
• getBadgeNumber()
• setBadgeNumber(...)
• getDeliveredNotifications()
• removeDeliveredNotifications(...)
• removeAllDeliveredNotifications()
• addListener('token', ...)
• addListener('message', ...)
• removeAllListeners()
• hasStorage()
• deleteStorage()
• Interfaces
• Type Aliases

checkPermissions()

checkPermissions() => Promise<PermissionStatus>

Check permission to receive push notifications.

Will always return "granted" on Android

Returns: Promise<PermissionStatus>

Since: 1.0.0

requestPermissions()

requestPermissions() => Promise<PermissionStatus>

Request permission to receive push notifications.

Will always return "granted" on Android

Returns: Promise<PermissionStatus>

Since: 1.0.0

register()

register() => Promise<void>

Register the app to receive push notifications.

Since: 1.0.0

unregister()

unregister() => Promise<void>

Should be called to unregister the Firebase Instance. For example if a User logs out.

Since: 1.1.0

getBadgeNumber()

getBadgeNumber() => Promise<BadgeCount>

Get icon badge Value

Only available on iOS

Returns: Promise<BadgeCount>

Since: 1.2.0

setBadgeNumber(...)

setBadgeNumber(options: BadgeCount) => Promise<void>

Set icon badge Value

Only available on iOS

| Param | Type | | ------------- | ------------------------------------------------- | | options | BadgeCount |

Since: 1.2.0

getDeliveredNotifications()

getDeliveredNotifications() => Promise<NotificationsResult>

Get notifications in Notification Center

Returns: Promise<NotificationsResult>

Since: 1.2.0

removeDeliveredNotifications(...)

removeDeliveredNotifications(options: NotificationsIds) => Promise<void>

Remove notifications from the notifications screen based on the id

| Param | Type | | ------------- | ------------------------------------------------------------- | | options | NotificationsIds |

Since: 1.2.0

removeAllDeliveredNotifications()

removeAllDeliveredNotifications() => Promise<void>

Remove all notifications from the notifications screen

Since: 1.2.0

addListener('token', ...)

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

Called when a new fcm token is created

| Param | Type | | ------------------ | ------------------------------------------------------------------------ | | eventName | 'token' | | listenerFunc | (result: TokenResult) => void |

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

Since: 1.0.0

addListener('message', ...)

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

Called when a new message is received

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

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

Since: 1.0.0

removeAllListeners()

removeAllListeners() => Promise<void>

Remove all native listeners for this plugin.

Since: 1.0.0

hasStorage()

hasStorage() => Promise<HasStorage>

Check if app storage has data

Returns: Promise<HasStorage>

Since: 1.2.0

deleteStorage()

deleteStorage() => Promise<void>

Remove all native storage for this plugin.

Since: 1.2.0

Interfaces

PermissionStatus

| Prop | Type | Since | | ------------- | ----------------------------------------------------------- | ----- | | receive | PermissionState | 1.0.0 |

BadgeCount

| Prop | Type | Since | | ----------- | ------------------- | ----- | | count | number | 1.2.0 |

NotificationsResult

| Prop | Type | Since | | ------------------- | ------------------ | ----- | | notifications | any[] | 1.2.0 |

NotificationsIds

| Prop | Type | Since | | --------- | --------------------- | ----- | | ids | string[] | 1.2.0 |

PluginListenerHandle

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

TokenResult

| Prop | Type | | ----------- | ------------------- | | token | string |

HasStorage

| Prop | Type | Description | Since | | ----------- | -------------------- | -------------------------------------------------- | ----- | | value | boolean | Whether or not the device has data in app storage. | 1.2.0 |

Type Aliases

PermissionState

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