Azure Notification Hubs
@jonz94/capacitor-azure-notification-hubs
Capacitor plugin to register push notifications via Azure Notification Hub.
Install
npm install @jonz94/capacitor-azure-notification-hubs @capacitor/push-notifications
npx cap sync
iOS
On iOS you must enable the Push Notifications capability. See Setting Capabilities for instructions on how to enable the capability.
After enabling the Push Notifications capability, add the following to your app's AppDelegate.swift:
func application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) {
NotificationCenter.default.post(name: .capacitorDidRegisterForRemoteNotifications, object: deviceToken)
}
func application(_ application: UIApplication, didFailToRegisterForRemoteNotificationsWithError error: Error) {
NotificationCenter.default.post(name: .capacitorDidFailToRegisterForRemoteNotifications, object: error)
}
Android
The Push Notification API uses Firebase Cloud Messaging SDK for handling notifications. See Set up a Firebase Cloud Messaging client app on Android and follow the instructions for creating a Firebase project and registering your application. There is no need to add the Firebase SDK to your app or edit your app manifest - the Push Notifications provides that for you. All that is required is your Firebase project's google-services.json file added to the module (app-level) directory of your app.
Variables
This plugin will use the following project variables (defined in your app's variables.gradle file):
$firebaseMessagingVersionversion ofcom.google.firebase:firebase-messagin(default:23.0.5)$azureNotificationHubsVersionversion ofcom.microsoft.azure:notification-hubs-android-sdk-fcm(default:1.1.4)$androidVolleyVersionversion ofcom.android.volley:volley(default:1.2.1)$kotlinVersionversion oforg.jetbrains.kotlin:kotlin-stdlib-jdk7(default:1.7.10)$coreKtxversion ofandroidx.core:core-ktx(default:1.8.0)
Configuration
No configuration required for this plugin.
Usage
import { Device } from '@capacitor/device';
import { PushNotifications } from '@capacitor/push-notifications';
import { AzureNotificationHubs } from '@jonz94/capacitor-azure-notification-hubs';
const addListeners = async () => {
await AzureNotificationHubs.addListener('registration', token => {
console.info('Registration token: ', token.value);
});
await AzureNotificationHubs.addListener('registrationError', err => {
console.error('Registration error: ', err.error);
});
}
const registerNotifications = async () => {
let permissionStatus = await PushNotifications.checkPermissions();
if (permissionStatus.receive === 'prompt') {
permissionStatus = await PushNotifications.requestPermissions();
}
if (permissionStatus.receive !== 'granted') {
throw new Error('User denied permissions!');
}
const { uuid } = await Device.getId();
const myDeviceTag = `${uuid}-${Date.now()}`
await AzureNotificationHubs.register({
notificationHubName: 'azure-notification-hub-name',
connectionString: 'my-connection-string',
deviceTag: myDeviceTag,
});
}
API
register(...)addListener('registration', ...)addListener('registrationError', ...)removeAllListeners()- Interfaces
register(...)
register(info: RegisterInfo) => Promise<void>
Register the app to receive push notifications.
This method will trigger the 'registration' event with the push token or 'registrationError' if there was a problem. It does not prompt the user for notification permissions, use PushNotifications.requestPermissions() from @capacitor/push-notifications first.
| Param | Type |
|---|---|
info |
RegisterInfo |
Since: 1.0.0
addListener('registration', ...)
addListener(eventName: 'registration', listenerFunc: (token: Token) => void) => Promise<PluginListenerHandle> & PluginListenerHandle
Called when the push notification registration finishes without problems.
Provides the push notification token.
| Param | Type |
|---|---|
eventName |
'registration' |
listenerFunc |
(token: Token) => void |
Returns: Promise<PluginListenerHandle> & PluginListenerHandle
Since: 1.0.0
addListener('registrationError', ...)
addListener(eventName: 'registrationError', listenerFunc: (error: RegistrationError) => void) => Promise<PluginListenerHandle> & PluginListenerHandle
Called when the push notification registration finished with problems.
Provides an error with the registration problem.
| Param | Type |
|---|---|
eventName |
'registrationError' |
listenerFunc |
(error: RegistrationError) => void |
Returns: Promise<PluginListenerHandle> & PluginListenerHandle
Since: 1.0.0
removeAllListeners()
removeAllListeners() => Promise<void>
Remove all native listeners for this plugin.
Since: 1.0.0
Interfaces
RegisterInfo
| Prop | Type | Description | Since |
|---|---|---|---|
notificationHubName |
string |
The notification hub name. | 1.0.0 |
connectionString |
string |
The connection string. | 1.0.0 |
deviceTag |
string |
The device tag. | 1.0.0 |
PluginListenerHandle
| Prop | Type |
|---|---|
remove |
() => Promise<void> |
Token
| Prop | Type | Description | Since |
|---|---|---|---|
value |
string |
On iOS it contains the APNS token. On Android it contains the FCM token. | 1.0.0 |
RegistrationError
| Prop | Type | Description | Since |
|---|---|---|---|
error |
string |
Error message describing the registration failure. | 1.0.0 |
Changelog
See CHANGELOG.md.
License
See LICENSE.
10 Dec 29, 2022
113 Oct 28, 2022
29 Oct 17, 2022
16 Mar 3, 2022
257 Nov 3, 2022
0 Dec 29, 2021
65 Dec 28, 2022
91 Jun 2, 2022
420 Dec 22, 2022
0 Jan 7, 2022
0 Dec 19, 2021
70 Dec 30, 2022
11 Dec 28, 2022
37 Mar 23, 2022
0 Jun 24, 2022
672 Nov 17, 2022
5.2k Dec 26, 2022
6.2k Dec 22, 2022
4 Dec 10, 2022
10 May 9, 2022
4 May 22, 2022
307 Oct 17, 2022
3 Nov 17, 2022
4 Mar 18, 2022
8 Nov 21, 2022
32 Dec 21, 2022
15k Jan 8, 2023
1 Feb 8, 2022