@azure/notification-hubs 1.0.0-beta.5 → 1.0.0-beta.6

package/README.md

@@ -20,7 +20,7 @@ Key links:
 
 ### Currently supported environments
 
-- [LTS versions of Node.js](https://nodejs.org/about/releases/)
+- [LTS versions of Node.js](https://github.com/nodejs/release#release-schedule)
 - Latest versions of Safari, Chrome, Edge, and Firefox.
 
 See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details.
@@ -359,7 +359,7 @@ for await (const pages of registrations.byPage()) {
 
 Notification Hubs supports sending notifications to devices either directly using the unique PNS provided identifier, using tags for audience send, or a general broadcast to all devices.  Using the Standard SKU and above, [scheduled send](https://docs.microsoft.com/azure/notification-hubs/notification-hubs-send-push-notifications-scheduled) allows the user to schedule notifications up to seven days in advance.  All send operations return a Tracking ID and Correlation ID which can be used for Notification Hubs support cases.  With the Standard SKU and above, a Notification ID is also returned which can be used to get notification telemetry via the `getNotificationOutcomeDetails` method.
 
-For debugging purposes, the `enableTestSend` options can be set to `true` which gets immediate feedback from the PNS on the `sendNotification` or `sendBroadcastNotification` methods, however, is not supported in production scenarios.  This is not supported on the scheduled send methods.
+For debugging purposes, the `enableTestSend` options can be set to `true` which gets immediate feedback from the PNS on the `sendNotification` method, however, is not supported in production scenarios.  This is not supported on the scheduled send methods.
 
 Raw JSON or XML strings can be sent to the send or scheduled send methods, or the notification builders can be used which helps construct messages per PNS such as APNs, Firebase, Baidu, ADM and WNS.  These builders will build the native message format and fill in associated HTTP headers so there is no guessing about which fields are available for each PNS.
 
@@ -370,7 +370,6 @@ import { buildAppleNativeMessage } from "@azure/notification-hubs";
 // Using the modular approach
 import { buildAppleNativeMessage } from "@azure/notification-hubs/models/notificationBuilder";
 
-
 const apnsMessage = buildAppleNativeMessage({
   alert: {
     title: "Notification Title",
@@ -383,17 +382,16 @@ const apnsMessage = buildAppleNativeMessage({
 
 // Send the message using the modular approach
 
-const result = await sendBroadcastNotification(context, apnsMessage);
+const result = await sendNotification(context, apnsMessage);
 ```
 
 #### Broadcast Send
 
-Notification Hubs can be used to send notifications to all registered devices per platform using broadcast send through the `sendBroadcastNotification` method.
+Notification Hubs can be used to send notifications to all registered devices per platform using broadcast send through the `sendNotification` method.
 
 ```typescript
 import { 
   NotificationHubServiceClient,
-  SendOperationOptions,
   createAppleNotification,
 } from "@azure/notification-hubs/client";
 
@@ -409,9 +407,7 @@ const message = createAppleNotification({
   },
 });
 
-// Not required but can set test send to true for debugging purposes.
-const sendOptions: SendOperationOptions = { enableTestSend: false };
-const result = await client.sendBroadcastNotification(message, sendOptions);
+const result = await client.sendNotification(message);
 
 console.log(`Tracking ID: ${result.trackingId}`);
 console.log(`Correlation ID: ${result.correlationId}`);
@@ -425,10 +421,9 @@ if (result.notificationId) {
 Using the modular approach, the code would be as follows:
 
 ```typescript
-import { SendOperationOptions } from "@azure/notification-hubs/models/options";
 import { createClientContext } from "@azure/notification-hubs/client";
 import { createAppleNotification } from "@azure/notification-hubs/models/notification";
-import { sendBroadcastNotification } from "@azure/notification-hubs/client/sendBroadcastNotification";
+import { sendNotification } from "@azure/notification-hubs/client/sendNotification";
 
 const context = createClientContext(connectionString, hubName);
 
@@ -442,9 +437,7 @@ const message = createAppleNotification({
   },
 });
 
-// Not required but can set test send to true for debugging purposes.
-const sendOptions: SendOperationOptions = { enableTestSend: false };
-const result = await sendBroadcastNotification(context, message, sendOptions);
+const result = await sendNotification(context, message);
 
 console.log(`Tracking ID: ${result.trackingId}`);
 console.log(`Correlation ID: ${result.correlationId}`);
@@ -457,18 +450,17 @@ if (result.notificationId) {
 
 #### Direct Send
 
-To send directly a device, the user can send using the platform provided unique identifier such as APNs device token by calling the `sendDirectNotification` method.  
+To send directly a device, the user can send using the platform provided unique identifier such as APNs device token by calling the `sendNotification` method with a `deviceHandle` parameter.  
 
 ```typescript
 import {
   NotificationHubServiceClient,
-  SendOperationOptions,
   createAppleNotification,
 } from "@azure/notification-hubs";
 
 const client = new NotificationHubServiceClient(connectionString, hubName);
 
-const deviceToken = "00fc13adff785122b4ad28809a3420982341241421348097878e577c991de8f0";
+const deviceHandle = "00fc13adff785122b4ad28809a3420982341241421348097878e577c991de8f0";
 const messageBody = `{ "aps" : { "alert" : "Hello" } }`;
 
 const message = createAppleNotification({
@@ -479,7 +471,7 @@ const message = createAppleNotification({
   },
 });
 
-const result = await client.sendDirectNotification(devicetoken, message);
+const result = await client.sendNotification(message, { deviceHandle });
 
 console.log(`Tracking ID: ${result.trackingId}`);
 console.log(`Correlation ID: ${result.correlationId}`);
@@ -493,14 +485,13 @@ if (result.notificationId) {
 Using the modular approach, the code would be as follows:
 
 ```typescript
-import { SendOperationOptions } from "@azure/notification-hubs/models/options";
 import { createClientContext } from "@azure/notification-hubs/client";
 import { createAppleNotification } from "@azure/notification-hubs/models/notification";
-import { sendDirectNotification } from "@azure/notification-hubs/client/sendDirectNotification";
+import { sendNotification } from "@azure/notification-hubs/client/sendDirectNotification";
 
 const context = createClientContext(connectionString, hubName);
 
-const deviceToken = "00fc13adff785122b4ad28809a3420982341241421348097878e577c991de8f0";
+const deviceHandle = "00fc13adff785122b4ad28809a3420982341241421348097878e577c991de8f0";
 const messageBody = `{ "aps" : { "alert" : "Hello" } }`;
 
 const message = createAppleNotification({
@@ -511,7 +502,7 @@ const message = createAppleNotification({
   },
 });
 
-const result = await sendDirectNotification(context, devicetoken, message, sendOptions);
+const result = await sendNotification(context, message, { deviceHandle });
 
 console.log(`Tracking ID: ${result.trackingId}`);
 console.log(`Correlation ID: ${result.correlationId}`);
@@ -529,8 +520,7 @@ In addition to targeting a single device, a user can target multiple devices usi
 ```typescript
 import {
   NotificationHubServiceClient,
-  SendOperationOptions,
-  createAppleMessage,
+  createAppleNotification,
 } from "@azure/notification-hubs";
 
 const client = new NotificationHubServiceClient("<connection string>", "<hub name>");
@@ -538,7 +528,7 @@ const client = new NotificationHubServiceClient("<connection string>", "<hub nam
 const tagExpression = "likes_hockey && likes_football";
 const messageBody = `{ "aps" : { "alert" : "Hello" } }`;
 
-const message = createAppleMessage({
+const notification = createAppleNotification({
   body: messageBody,
   headers: {
     "apns-priority": "10",
@@ -546,10 +536,7 @@ const message = createAppleMessage({
   },
 });
 
-
-// Not required but can set test send to true for debugging purposes.
-const sendOptions: SendOperationOptions = { enableTestSend: false };
-const result = await client.sendNotification(tagExpression, message, sendOptions);
+const result = await client.sendNotification(notification, { tags: tagExpression });
 
 console.log(`Tracking ID: ${result.trackingId}`);
 console.log(`Correlation ID: ${result.correlationId}`);
@@ -563,7 +550,6 @@ if (result.notificationId) {
 Using the modular approach, the code would be as follows:
 
 ```typescript
-import { SendOperationOptions } from "@azure/notification-hubs/models/options";
 import { createClientContext } from "@azure/notification-hubs/client";
 import { createAppleNotification } from "@azure/notification-hubs/models/notification";
 import { sendNotification } from "@azure/notification-hubs/client/sendNotification";
@@ -573,7 +559,7 @@ const context = createClientContext("<connection string>", "<hub name>");
 const tagExpression = "likes_hockey && likes_football";
 const messageBody = `{ "aps" : { "alert" : "Hello" } }`;
 
-const message = createAppleMessage({
+const notification = createAppleNotification({
   body: messageBody,
   headers: {
     "apns-priority": "10",
@@ -581,10 +567,7 @@ const message = createAppleMessage({
   },
 });
 
-
-// Not required but can set test send to true for debugging purposes.
-const sendOptions: SendOperationOptions = { enableTestSend: false };
-const result = await sendNotification(context, tagExpression, message, sendOptions);
+const result = await sendNotification(context, notification, { tags: tagExpression });
 
 console.log(`Tracking ID: ${result.trackingId}`);
 console.log(`Correlation ID: ${result.correlationId}`);
@@ -597,12 +580,11 @@ if (result.notificationId) {
 
 #### Scheduled Send
 
-Push notifications can be scheduled up to seven days in advance with Standard SKU namespaces and above using the `scheduleBroadcastNotification` method to send to devices with tags or a general broadcast with the `scheduleBroadcastNotification`.  This returns a notification ID which can be then used to cancel if necessary via the `cancelScheduledNotification` method.
+Push notifications can be scheduled up to seven days in advance with Standard SKU namespaces and above using the `scheduleBroadcastNotification` method to send to devices with tags or a general broadcast.  This returns a notification ID which can be then used to cancel if necessary via the `cancelScheduledNotification` method.
 
 ```typescript
 import {
   NotificationHubServiceClient,
-  SendOperationOptions,
   createAppleNotification,
 } from "@azure/notification-hubs";
 
@@ -611,7 +593,7 @@ const client = new NotificationHubServiceClient("<connection string>", "<hub nam
 const tagExpression = "likes_hockey && likes_football";
 const messageBody = `{ "aps" : { "alert" : "Hello" } }`;
 
-// Schedule 8 hours from nows
+// Schedule 8 hours from now
 const scheduledTime = new Date(Date.now() + (8 * 60 * 60 * 1000));
 
 const message = createAppleNotification({
@@ -622,7 +604,7 @@ const message = createAppleNotification({
   },
 });
 
-const result = await client.scheduleNotification(scheduledTime, tagExpression, message);
+const result = await client.scheduleNotification(scheduledTime, message, { tags: tagExpression });
 
 console.log(`Tracking ID: ${result.trackingId}`);
 console.log(`Correlation ID: ${result.correlationId}`);
@@ -634,7 +616,6 @@ console.log(`Notification ID: ${result.notificationId}`);
 Using the modular approach, the code would be as follows:
 
 ```typescript
-import { SendOperationOptions } from "@azure/notification-hubs/models/options";
 import { createClientContext } from "@azure/notification-hubs/client";
 import { createAppleNotification } from "@azure/notification-hubs/models/notification";
 import { scheduleNotification } from "@azure/notification-hubs/client/scheduleNotification";
@@ -644,7 +625,7 @@ const context = createClientContext("<connection string>", "<hub name>");
 const tagExpression = "likes_hockey && likes_football";
 const messageBody = `{ "aps" : { "alert" : "Hello" } }`;
 
-// Schedule 8 hours from nows
+// Schedule 8 hours from now
 const scheduledTime = new Date(Date.now() + (8 * 60 * 60 * 1000));
 
 const message = createAppleNotification({
@@ -655,7 +636,7 @@ const message = createAppleNotification({
   },
 });
 
-const result = await scheduleNotification(context, scheduledTime, tagExpression, message);
+const result = await scheduleNotification(context, scheduledTime, message, { tags: tagExpression });
 
 console.log(`Tracking ID: ${result.trackingId}`);
 console.log(`Correlation ID: ${result.correlationId}`);
@@ -673,8 +654,11 @@ Azure Notification Hubs has a complete guide to troubleshooting problems with dr
 [Test send](https://docs.microsoft.com/azure/notification-hubs/notification-hubs-push-notification-fixer#enabletestsend-property) is supported supported in the `sendNotification` method with the `enableTestSend` option:
 
 ```typescript
-const sendOptions: SendOperationOptions = { enableTestSend: true };
-const result = await client.sendNotification(tags, message, sendOptions);
+// Using the client
+const result = await client.sendNotification(message, { tags, enableTestSend: true });
+
+// Using the modular approach
+const result = await sendNotification(context, notification, { tags, enableTestSend: true });
 ```
 
 ### Logging