@azure/notification-hubs 1.0.0-beta.5 → 1.0.0-beta.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +104 -113
- package/dist/index.cjs +625 -602
- package/dist/index.cjs.map +1 -1
- package/dist-esm/src/api/beginSubmitNotificationHubJob.js +131 -0
- package/dist-esm/src/api/beginSubmitNotificationHubJob.js.map +1 -0
- package/dist-esm/src/{client → api}/cancelScheduledNotification.js +1 -1
- package/dist-esm/src/api/cancelScheduledNotification.js.map +1 -0
- package/dist-esm/src/{client → api}/createOrUpdateInstallation.js +1 -1
- package/dist-esm/src/api/createOrUpdateInstallation.js.map +1 -0
- package/dist-esm/src/{client → api}/createOrUpdateRegistration.js +1 -1
- package/dist-esm/src/api/createOrUpdateRegistration.js.map +1 -0
- package/dist-esm/src/{client → api}/createRegistration.js +1 -1
- package/dist-esm/src/api/createRegistration.js.map +1 -0
- package/dist-esm/src/{client → api}/createRegistrationId.js +1 -1
- package/dist-esm/src/api/createRegistrationId.js.map +1 -0
- package/dist-esm/src/{client → api}/deleteInstallation.js +1 -1
- package/dist-esm/src/api/deleteInstallation.js.map +1 -0
- package/dist-esm/src/{client → api}/deleteRegistration.js +1 -1
- package/dist-esm/src/api/deleteRegistration.js.map +1 -0
- package/dist-esm/src/{client → api}/getFeedbackContainerUrl.js +1 -1
- package/dist-esm/src/api/getFeedbackContainerUrl.js.map +1 -0
- package/dist-esm/src/{client → api}/getInstallation.js +1 -1
- package/dist-esm/src/api/getInstallation.js.map +1 -0
- package/dist-esm/src/{client → api}/getNotificationHubJob.js +1 -1
- package/dist-esm/src/api/getNotificationHubJob.js.map +1 -0
- package/dist-esm/src/{client → api}/getNotificationOutcomeDetails.js +1 -1
- package/dist-esm/src/api/getNotificationOutcomeDetails.js.map +1 -0
- package/dist-esm/src/{client → api}/getRegistration.js +1 -1
- package/dist-esm/src/api/getRegistration.js.map +1 -0
- package/dist-esm/src/{client → api}/index.js +24 -2
- package/dist-esm/src/api/index.js.map +1 -0
- package/dist-esm/src/{client → api}/internal/_client.js +1 -1
- package/dist-esm/src/api/internal/_client.js.map +1 -0
- package/dist-esm/src/{client → api}/internal/_createOrUpdateRegistrationDescription.js +0 -0
- package/dist-esm/src/api/internal/_createOrUpdateRegistrationDescription.js.map +1 -0
- package/dist-esm/src/{client/listRegistrations.js → api/internal/_listRegistrations.js} +6 -38
- package/dist-esm/src/api/internal/_listRegistrations.js.map +1 -0
- package/dist-esm/src/{client → api}/listNotificationHubJobs.js +1 -1
- package/dist-esm/src/api/listNotificationHubJobs.js.map +1 -0
- package/dist-esm/src/api/listRegistrations.js +35 -0
- package/dist-esm/src/api/listRegistrations.js.map +1 -0
- package/dist-esm/src/api/listRegistrationsByChannel.js +58 -0
- package/dist-esm/src/api/listRegistrationsByChannel.js.map +1 -0
- package/dist-esm/src/{client → api}/listRegistrationsByTag.js +1 -1
- package/dist-esm/src/api/listRegistrationsByTag.js.map +1 -0
- package/dist-esm/src/api/scheduleNotification.js +31 -0
- package/dist-esm/src/api/scheduleNotification.js.map +1 -0
- package/dist-esm/src/api/sendNotification.js +63 -0
- package/dist-esm/src/api/sendNotification.js.map +1 -0
- package/dist-esm/src/{client → api}/submitNotificationHubJob.js +1 -1
- package/dist-esm/src/api/submitNotificationHubJob.js.map +1 -0
- package/dist-esm/src/{client → api}/updateInstallation.js +1 -1
- package/dist-esm/src/api/updateInstallation.js.map +1 -0
- package/dist-esm/src/{client → api}/updateRegistration.js +1 -1
- package/dist-esm/src/api/updateRegistration.js.map +1 -0
- package/dist-esm/src/index.js +3 -2
- package/dist-esm/src/index.js.map +1 -1
- package/dist-esm/src/models/index.js +12 -0
- package/dist-esm/src/models/index.js.map +1 -0
- package/dist-esm/src/models/installation.js.map +1 -1
- package/dist-esm/src/models/notification.js.map +1 -1
- package/dist-esm/src/models/notificationBodyBuilder.js +48 -0
- package/dist-esm/src/models/notificationBodyBuilder.js.map +1 -0
- package/dist-esm/src/models/notificationDetails.js.map +1 -1
- package/dist-esm/src/models/notificationHubJob.js.map +1 -1
- package/dist-esm/src/models/options.js.map +1 -1
- package/dist-esm/src/models/registration.js +12 -12
- package/dist-esm/src/models/registration.js.map +1 -1
- package/dist-esm/src/models/tagExpressionBuilder.js +11 -0
- package/dist-esm/src/models/tagExpressionBuilder.js.map +1 -0
- package/dist-esm/src/notificationHubsClient.js +49 -68
- package/dist-esm/src/notificationHubsClient.js.map +1 -1
- package/dist-esm/src/serializers/notificationDetailsSerializer.js +2 -1
- package/dist-esm/src/serializers/notificationDetailsSerializer.js.map +1 -1
- package/dist-esm/src/serializers/notificationHubJobSerializer.js +3 -1
- package/dist-esm/src/serializers/notificationHubJobSerializer.js.map +1 -1
- package/dist-esm/src/serializers/notificationOutcomeSerializer.js +2 -2
- package/dist-esm/src/serializers/notificationOutcomeSerializer.js.map +1 -1
- package/dist-esm/src/serializers/registrationSerializer.js +16 -16
- package/dist-esm/src/serializers/registrationSerializer.js.map +1 -1
- package/dist-esm/src/utils/constants.js +1 -1
- package/dist-esm/src/utils/constants.js.map +1 -1
- package/dist-esm/src/utils/notificationUtils.js +19 -0
- package/dist-esm/src/utils/notificationUtils.js.map +1 -0
- package/dist-esm/src/utils/optionUtils.js +20 -0
- package/dist-esm/src/utils/optionUtils.js.map +1 -0
- package/package.json +14 -17
- package/types/3.1/notification-hubs.d.ts +468 -281
- package/types/latest/notification-hubs.d.ts +500 -286
- package/types/latest/tsdoc-metadata.json +1 -1
- package/types/src/api/beginSubmitNotificationHubJob.d.ts +12 -0
- package/types/src/api/beginSubmitNotificationHubJob.d.ts.map +1 -0
- package/types/src/{client → api}/cancelScheduledNotification.d.ts +0 -0
- package/types/src/api/cancelScheduledNotification.d.ts.map +1 -0
- package/types/src/{client → api}/createOrUpdateInstallation.d.ts +0 -0
- package/types/src/api/createOrUpdateInstallation.d.ts.map +1 -0
- package/types/src/{client → api}/createOrUpdateRegistration.d.ts +0 -0
- package/types/src/api/createOrUpdateRegistration.d.ts.map +1 -0
- package/types/src/{client → api}/createRegistration.d.ts +0 -0
- package/types/src/api/createRegistration.d.ts.map +1 -0
- package/types/src/{client → api}/createRegistrationId.d.ts +0 -0
- package/types/src/api/createRegistrationId.d.ts.map +1 -0
- package/types/src/{client → api}/deleteInstallation.d.ts +0 -0
- package/types/src/api/deleteInstallation.d.ts.map +1 -0
- package/types/src/{client → api}/deleteRegistration.d.ts +0 -0
- package/types/src/api/deleteRegistration.d.ts.map +1 -0
- package/types/src/{client → api}/getFeedbackContainerUrl.d.ts +0 -0
- package/types/src/api/getFeedbackContainerUrl.d.ts.map +1 -0
- package/types/src/{client → api}/getInstallation.d.ts +0 -0
- package/types/src/api/getInstallation.d.ts.map +1 -0
- package/types/src/{client → api}/getNotificationHubJob.d.ts +0 -0
- package/types/src/api/getNotificationHubJob.d.ts.map +1 -0
- package/types/src/{client → api}/getNotificationOutcomeDetails.d.ts +0 -0
- package/types/src/api/getNotificationOutcomeDetails.d.ts.map +1 -0
- package/types/src/{client → api}/getRegistration.d.ts +0 -0
- package/types/src/api/getRegistration.d.ts.map +1 -0
- package/types/src/{client → api}/index.d.ts +23 -1
- package/types/src/api/index.d.ts.map +1 -0
- package/types/src/{client → api}/internal/_client.d.ts +0 -0
- package/types/src/api/internal/_client.d.ts.map +1 -0
- package/types/src/{client → api}/internal/_createOrUpdateRegistrationDescription.d.ts +0 -0
- package/types/src/api/internal/_createOrUpdateRegistrationDescription.d.ts.map +1 -0
- package/types/src/api/internal/_listRegistrations.d.ts +6 -0
- package/types/src/api/internal/_listRegistrations.d.ts.map +1 -0
- package/types/src/{client → api}/listNotificationHubJobs.d.ts +0 -0
- package/types/src/api/listNotificationHubJobs.d.ts.map +1 -0
- package/types/src/{client → api}/listRegistrations.d.ts +3 -3
- package/types/src/api/listRegistrations.d.ts.map +1 -0
- package/types/src/api/listRegistrationsByChannel.d.ts +13 -0
- package/types/src/api/listRegistrationsByChannel.d.ts.map +1 -0
- package/types/src/{client → api}/listRegistrationsByTag.d.ts +0 -0
- package/types/src/api/listRegistrationsByTag.d.ts.map +1 -0
- package/types/src/{client → api}/scheduleNotification.d.ts +3 -5
- package/types/src/api/scheduleNotification.d.ts.map +1 -0
- package/types/src/{client → api}/sendNotification.d.ts +3 -5
- package/types/src/api/sendNotification.d.ts.map +1 -0
- package/types/src/{client → api}/submitNotificationHubJob.d.ts +0 -0
- package/types/src/api/submitNotificationHubJob.d.ts.map +1 -0
- package/types/src/{client → api}/updateInstallation.d.ts +0 -0
- package/types/src/api/updateInstallation.d.ts.map +1 -0
- package/types/src/{client → api}/updateRegistration.d.ts +0 -0
- package/types/src/api/updateRegistration.d.ts.map +1 -0
- package/types/src/index.d.ts +3 -2
- package/types/src/index.d.ts.map +1 -1
- package/types/src/models/index.d.ts +10 -0
- package/types/src/models/index.d.ts.map +1 -0
- package/types/src/models/installation.d.ts +12 -11
- package/types/src/models/installation.d.ts.map +1 -1
- package/types/src/models/notification.d.ts +10 -18
- package/types/src/models/notification.d.ts.map +1 -1
- package/types/src/models/{notificationBuilder.d.ts → notificationBodyBuilder.d.ts} +62 -64
- package/types/src/models/notificationBodyBuilder.d.ts.map +1 -0
- package/types/src/models/notificationDetails.d.ts +9 -9
- package/types/src/models/notificationDetails.d.ts.map +1 -1
- package/types/src/models/notificationHubJob.d.ts +5 -0
- package/types/src/models/notificationHubJob.d.ts.map +1 -1
- package/types/src/models/options.d.ts +36 -2
- package/types/src/models/options.d.ts.map +1 -1
- package/types/src/models/registration.d.ts +235 -69
- package/types/src/models/registration.d.ts.map +1 -1
- package/types/src/models/tagExpressionBuilder.d.ts +7 -0
- package/types/src/models/tagExpressionBuilder.d.ts.map +1 -0
- package/types/src/notificationHubsClient.d.ts +25 -41
- package/types/src/notificationHubsClient.d.ts.map +1 -1
- package/types/src/serializers/registrationSerializer.d.ts +14 -14
- package/types/src/serializers/registrationSerializer.d.ts.map +1 -1
- package/types/src/utils/notificationUtils.d.ts +6 -0
- package/types/src/utils/notificationUtils.d.ts.map +1 -0
- package/types/src/utils/optionUtils.d.ts +14 -0
- package/types/src/utils/optionUtils.d.ts.map +1 -0
- package/dist-esm/src/client/cancelScheduledNotification.js.map +0 -1
- package/dist-esm/src/client/createOrUpdateInstallation.js.map +0 -1
- package/dist-esm/src/client/createOrUpdateRegistration.js.map +0 -1
- package/dist-esm/src/client/createRegistration.js.map +0 -1
- package/dist-esm/src/client/createRegistrationId.js.map +0 -1
- package/dist-esm/src/client/deleteInstallation.js.map +0 -1
- package/dist-esm/src/client/deleteRegistration.js.map +0 -1
- package/dist-esm/src/client/getFeedbackContainerUrl.js.map +0 -1
- package/dist-esm/src/client/getInstallation.js.map +0 -1
- package/dist-esm/src/client/getNotificationHubJob.js.map +0 -1
- package/dist-esm/src/client/getNotificationOutcomeDetails.js.map +0 -1
- package/dist-esm/src/client/getRegistration.js.map +0 -1
- package/dist-esm/src/client/index.js.map +0 -1
- package/dist-esm/src/client/internal/_client.js.map +0 -1
- package/dist-esm/src/client/internal/_createOrUpdateRegistrationDescription.js.map +0 -1
- package/dist-esm/src/client/internal/_scheduleNotificationPayload.js +0 -38
- package/dist-esm/src/client/internal/_scheduleNotificationPayload.js.map +0 -1
- package/dist-esm/src/client/internal/_sendNotificationPayload.js +0 -51
- package/dist-esm/src/client/internal/_sendNotificationPayload.js.map +0 -1
- package/dist-esm/src/client/listNotificationHubJobs.js.map +0 -1
- package/dist-esm/src/client/listRegistrations.js.map +0 -1
- package/dist-esm/src/client/listRegistrationsByTag.js.map +0 -1
- package/dist-esm/src/client/scheduleBroadcastNotification.js +0 -17
- package/dist-esm/src/client/scheduleBroadcastNotification.js.map +0 -1
- package/dist-esm/src/client/scheduleNotification.js +0 -18
- package/dist-esm/src/client/scheduleNotification.js.map +0 -1
- package/dist-esm/src/client/sendBroadcastNotification.js +0 -15
- package/dist-esm/src/client/sendBroadcastNotification.js.map +0 -1
- package/dist-esm/src/client/sendDirectNotification.js +0 -15
- package/dist-esm/src/client/sendDirectNotification.js.map +0 -1
- package/dist-esm/src/client/sendNotification.js +0 -16
- package/dist-esm/src/client/sendNotification.js.map +0 -1
- package/dist-esm/src/client/submitNotificationHubJob.js.map +0 -1
- package/dist-esm/src/client/updateInstallation.js.map +0 -1
- package/dist-esm/src/client/updateRegistration.js.map +0 -1
- package/dist-esm/src/models/notificationBuilder.js +0 -169
- package/dist-esm/src/models/notificationBuilder.js.map +0 -1
- package/dist-esm/src/utils/retryPolicy.js +0 -144
- package/dist-esm/src/utils/retryPolicy.js.map +0 -1
- package/types/src/client/cancelScheduledNotification.d.ts.map +0 -1
- package/types/src/client/createOrUpdateInstallation.d.ts.map +0 -1
- package/types/src/client/createOrUpdateRegistration.d.ts.map +0 -1
- package/types/src/client/createRegistration.d.ts.map +0 -1
- package/types/src/client/createRegistrationId.d.ts.map +0 -1
- package/types/src/client/deleteInstallation.d.ts.map +0 -1
- package/types/src/client/deleteRegistration.d.ts.map +0 -1
- package/types/src/client/getFeedbackContainerUrl.d.ts.map +0 -1
- package/types/src/client/getInstallation.d.ts.map +0 -1
- package/types/src/client/getNotificationHubJob.d.ts.map +0 -1
- package/types/src/client/getNotificationOutcomeDetails.d.ts.map +0 -1
- package/types/src/client/getRegistration.d.ts.map +0 -1
- package/types/src/client/index.d.ts.map +0 -1
- package/types/src/client/internal/_client.d.ts.map +0 -1
- package/types/src/client/internal/_createOrUpdateRegistrationDescription.d.ts.map +0 -1
- package/types/src/client/internal/_scheduleNotificationPayload.d.ts +0 -9
- package/types/src/client/internal/_scheduleNotificationPayload.d.ts.map +0 -1
- package/types/src/client/internal/_sendNotificationPayload.d.ts +0 -10
- package/types/src/client/internal/_sendNotificationPayload.d.ts.map +0 -1
- package/types/src/client/listNotificationHubJobs.d.ts.map +0 -1
- package/types/src/client/listRegistrations.d.ts.map +0 -1
- package/types/src/client/listRegistrationsByTag.d.ts.map +0 -1
- package/types/src/client/scheduleBroadcastNotification.d.ts +0 -16
- package/types/src/client/scheduleBroadcastNotification.d.ts.map +0 -1
- package/types/src/client/scheduleNotification.d.ts.map +0 -1
- package/types/src/client/sendBroadcastNotification.d.ts +0 -14
- package/types/src/client/sendBroadcastNotification.d.ts.map +0 -1
- package/types/src/client/sendDirectNotification.d.ts +0 -15
- package/types/src/client/sendDirectNotification.d.ts.map +0 -1
- package/types/src/client/sendNotification.d.ts.map +0 -1
- package/types/src/client/submitNotificationHubJob.d.ts.map +0 -1
- package/types/src/client/updateInstallation.d.ts.map +0 -1
- package/types/src/client/updateRegistration.d.ts.map +0 -1
- package/types/src/models/notificationBuilder.d.ts.map +0 -1
- package/types/src/utils/retryPolicy.d.ts +0 -72
- package/types/src/utils/retryPolicy.d.ts.map +0 -1
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
import { AdmNotification, AppleNotification, BaiduNotification, FcmLegacyNotification, WindowsNotification } from "./notification.js";
|
|
2
1
|
/**
|
|
3
2
|
* Represents what is in the APNs alert body.
|
|
4
3
|
*/
|
|
@@ -20,45 +19,45 @@ export interface AppleAlert {
|
|
|
20
19
|
* The name of the launch image file to display. If the user chooses to launch your app,
|
|
21
20
|
* the contents of the specified image or storyboard file are displayed instead of your app’s normal launch image.
|
|
22
21
|
*/
|
|
23
|
-
|
|
22
|
+
"launch-image"?: string;
|
|
24
23
|
/**
|
|
25
24
|
* The key for a localized title string. Specify this key instead of the title key to retrieve
|
|
26
25
|
* the title from your app’s Localizable.strings files. The value must contain the name of a key in your strings file.
|
|
27
26
|
*/
|
|
28
|
-
|
|
27
|
+
"title-loc-key"?: string;
|
|
29
28
|
/**
|
|
30
29
|
* An array of strings containing replacement values for variables in your title string.
|
|
31
30
|
* Each %\@ character in the string specified by the title-loc-key is replaced by a value
|
|
32
31
|
* from this array. The first item in the array replaces the first instance
|
|
33
32
|
* of the %\@ character in the string, the second item replaces the second instance, and so on.
|
|
34
33
|
*/
|
|
35
|
-
|
|
34
|
+
"title-loc-args"?: string[];
|
|
36
35
|
/**
|
|
37
36
|
* The key for a localized subtitle string. Use this key, instead of the subtitle key, to
|
|
38
37
|
* retrieve the subtitle from your app’s Localizable.strings file.
|
|
39
38
|
* The value must contain the name of a key in your strings file.
|
|
40
39
|
*/
|
|
41
|
-
|
|
40
|
+
"subtitle-loc-key"?: string;
|
|
42
41
|
/**
|
|
43
42
|
* An array of strings containing replacement values for variables in your title string.
|
|
44
43
|
* Each %\@ character in the string specified by subtitle-loc-key is replaced by a value
|
|
45
44
|
* from this array. The first item in the array replaces the first instance of the
|
|
46
45
|
* %\@ character in the string, the second item replaces the second instance, and so on.
|
|
47
46
|
*/
|
|
48
|
-
|
|
47
|
+
"subtitle-loc-args"?: string[];
|
|
49
48
|
/**
|
|
50
49
|
* The key for a localized message string. Use this key, instead of the body key, to
|
|
51
50
|
* retrieve the message text from your app’s Localizable.strings file. The value must contain
|
|
52
51
|
* the name of a key in your strings file.
|
|
53
52
|
*/
|
|
54
|
-
|
|
53
|
+
"loc-key"?: string;
|
|
55
54
|
/**
|
|
56
55
|
* An array of strings containing replacement values for variables in your message text.
|
|
57
56
|
* Each %\@ character in the string specified by loc-key is replaced by a value from
|
|
58
57
|
* this array. The first item in the array replaces the first instance of the %\@ character
|
|
59
58
|
* in the string, the second item replaces the second instance, and so on.
|
|
60
59
|
*/
|
|
61
|
-
|
|
60
|
+
"loc-args"?: string[];
|
|
62
61
|
}
|
|
63
62
|
/**
|
|
64
63
|
* Represents an APNs critical sound
|
|
@@ -100,7 +99,7 @@ export interface AppleNativeMessage extends Record<string, any> {
|
|
|
100
99
|
/**
|
|
101
100
|
* An app-specific identifier for grouping related notifications.
|
|
102
101
|
*/
|
|
103
|
-
|
|
102
|
+
"thread-id"?: string;
|
|
104
103
|
/**
|
|
105
104
|
* The notification’s type.
|
|
106
105
|
*/
|
|
@@ -109,29 +108,29 @@ export interface AppleNativeMessage extends Record<string, any> {
|
|
|
109
108
|
* The background notification flag. To perform a silent background update,
|
|
110
109
|
* specify the value 1 and don’t include the alert, badge, or sound keys in your payload.
|
|
111
110
|
*/
|
|
112
|
-
|
|
111
|
+
"content-available"?: number;
|
|
113
112
|
/**
|
|
114
113
|
* The notification service app extension flag. If the value is 1, the system passes
|
|
115
114
|
* the notification to your notification service app extension before delivery.
|
|
116
115
|
*/
|
|
117
|
-
|
|
116
|
+
"mutable-content"?: number;
|
|
118
117
|
/**
|
|
119
118
|
* The identifier of the window brought forward.
|
|
120
119
|
*/
|
|
121
|
-
|
|
120
|
+
"target-content-id"?: string;
|
|
122
121
|
/**
|
|
123
122
|
* The importance and delivery timing of a notification.
|
|
124
123
|
*/
|
|
125
|
-
|
|
124
|
+
"interruption-level"?: "passive" | "active" | "time-sensitive" | "critical";
|
|
126
125
|
/**
|
|
127
126
|
* The relevance score, a number between 0 and 1, that the system uses to sort the
|
|
128
127
|
* notifications from your app. The highest score gets featured in the notification summary.
|
|
129
128
|
*/
|
|
130
|
-
|
|
129
|
+
"relevance-score"?: number;
|
|
131
130
|
/**
|
|
132
131
|
* The criteria the system evaluates to determine if it displays the notification in the current Focus.
|
|
133
132
|
*/
|
|
134
|
-
|
|
133
|
+
"filter-criteria"?: string;
|
|
135
134
|
}
|
|
136
135
|
/**
|
|
137
136
|
* Creates an APNs native message to send to Notification Hubs.
|
|
@@ -139,7 +138,7 @@ export interface AppleNativeMessage extends Record<string, any> {
|
|
|
139
138
|
* @param additionalProperties - Additional properties for Apple messages.
|
|
140
139
|
* @returns An AppleNotification to send to Notification Hubs.
|
|
141
140
|
*/
|
|
142
|
-
export declare function
|
|
141
|
+
export declare function createAppleNotificationBody(nativeMessage: AppleNativeMessage): string;
|
|
143
142
|
/**
|
|
144
143
|
* Represents the targets, options, and payload for HTTP JSON messages for the Firebase Legacy HTTP interface.
|
|
145
144
|
*/
|
|
@@ -151,7 +150,7 @@ export interface FirebaseLegacyNativeMessage {
|
|
|
151
150
|
/**
|
|
152
151
|
* The recipient of a multicast message, a message sent to more than one registration token.
|
|
153
152
|
*/
|
|
154
|
-
|
|
153
|
+
registration_ids?: string[];
|
|
155
154
|
/**
|
|
156
155
|
* A logical expression of conditions that determine the message target.
|
|
157
156
|
*/
|
|
@@ -159,7 +158,7 @@ export interface FirebaseLegacyNativeMessage {
|
|
|
159
158
|
/**
|
|
160
159
|
* Used to identify a group of messages.
|
|
161
160
|
*/
|
|
162
|
-
|
|
161
|
+
collapse_key?: string;
|
|
163
162
|
/**
|
|
164
163
|
* The priority of the message.
|
|
165
164
|
*/
|
|
@@ -168,24 +167,24 @@ export interface FirebaseLegacyNativeMessage {
|
|
|
168
167
|
* The background notification flag. To perform a silent background update,
|
|
169
168
|
* specify the value 1 and don’t include the alert, badge, or sound keys in your payload.
|
|
170
169
|
*/
|
|
171
|
-
|
|
170
|
+
content_available?: boolean;
|
|
172
171
|
/**
|
|
173
172
|
* The notification service app extension flag. If the value is 1, the system passes
|
|
174
173
|
* the notification to your notification service app extension before delivery.
|
|
175
174
|
*/
|
|
176
|
-
|
|
175
|
+
mutable_content?: number;
|
|
177
176
|
/**
|
|
178
177
|
* Specifies how long (in seconds) the message should be kept in FCM storage if the device is offline
|
|
179
178
|
*/
|
|
180
|
-
|
|
179
|
+
time_to_live?: number;
|
|
181
180
|
/**
|
|
182
181
|
* The package name of the application where the registration tokens must match in order to receive the message.
|
|
183
182
|
*/
|
|
184
|
-
|
|
183
|
+
restricted_package_name?: string;
|
|
185
184
|
/**
|
|
186
185
|
* When set to true, allows developers to test a request without actually sending a message.
|
|
187
186
|
*/
|
|
188
|
-
|
|
187
|
+
dry_run?: boolean;
|
|
189
188
|
/**
|
|
190
189
|
* Custom key-value pairs of the message's payload.
|
|
191
190
|
*/
|
|
@@ -218,7 +217,7 @@ export interface FirebaseLegacyAppleNativePayload {
|
|
|
218
217
|
/**
|
|
219
218
|
* The action associated with a user click on the notification which corresponds to the APNs category.
|
|
220
219
|
*/
|
|
221
|
-
|
|
220
|
+
click_action?: string;
|
|
222
221
|
/**
|
|
223
222
|
* The notification's subtitle.
|
|
224
223
|
*/
|
|
@@ -226,19 +225,19 @@ export interface FirebaseLegacyAppleNativePayload {
|
|
|
226
225
|
/**
|
|
227
226
|
* The key to the body string in the app's string resources to use to localize the body text to the user's current localization.
|
|
228
227
|
*/
|
|
229
|
-
|
|
228
|
+
body_loc_key?: string;
|
|
230
229
|
/**
|
|
231
230
|
* Variable string values to be used in place of the format specifiers in body_loc_key to use to localize the body text to the user's current localization.
|
|
232
231
|
*/
|
|
233
|
-
|
|
232
|
+
body_loc_args?: string[];
|
|
234
233
|
/**
|
|
235
234
|
* The key to the title string in the app's string resources to use to localize the title text to the user's current localization.
|
|
236
235
|
*/
|
|
237
|
-
|
|
236
|
+
title_loc_key?: string;
|
|
238
237
|
/**
|
|
239
238
|
* Variable string values to be used in place of the format specifiers in title_loc_key to use to localize the title text to the user's current localization.
|
|
240
239
|
*/
|
|
241
|
-
|
|
240
|
+
title_loc_args?: string[];
|
|
242
241
|
}
|
|
243
242
|
/**
|
|
244
243
|
* Represents an Android native payload for the Firebase Legacy HTTP interface.
|
|
@@ -255,7 +254,7 @@ export interface FirebaseLegacyAndroidNativePayload {
|
|
|
255
254
|
/**
|
|
256
255
|
* The notification's channel ID.
|
|
257
256
|
*/
|
|
258
|
-
|
|
257
|
+
android_channel_id?: string;
|
|
259
258
|
/**
|
|
260
259
|
* The notification's icon.
|
|
261
260
|
*/
|
|
@@ -275,23 +274,23 @@ export interface FirebaseLegacyAndroidNativePayload {
|
|
|
275
274
|
/**
|
|
276
275
|
* The action associated with a user click on the notification.
|
|
277
276
|
*/
|
|
278
|
-
|
|
277
|
+
click_action?: string;
|
|
279
278
|
/**
|
|
280
279
|
* The key to the body string in the app's string resources to use to localize the body text to the user's current localization.
|
|
281
280
|
*/
|
|
282
|
-
|
|
281
|
+
body_loc_key?: string;
|
|
283
282
|
/**
|
|
284
283
|
* Variable string values to be used in place of the format specifiers in body_loc_key to use to localize the body text to the user's current localization.
|
|
285
284
|
*/
|
|
286
|
-
|
|
285
|
+
body_loc_args?: string[];
|
|
287
286
|
/**
|
|
288
287
|
* The key to the title string in the app's string resources to use to localize the title text to the user's current localization.
|
|
289
288
|
*/
|
|
290
|
-
|
|
289
|
+
title_loc_key?: string;
|
|
291
290
|
/**
|
|
292
291
|
* Variable string values to be used in place of the format specifiers in title_loc_key to use to localize the title text to the user's current localization.
|
|
293
292
|
*/
|
|
294
|
-
|
|
293
|
+
title_loc_args?: string[];
|
|
295
294
|
}
|
|
296
295
|
/**
|
|
297
296
|
* Represents an Web Push native payload for the Firebase Legacy HTTP interface.
|
|
@@ -312,14 +311,14 @@ export interface FirebaseLegacyWebNativePayload {
|
|
|
312
311
|
/**
|
|
313
312
|
* The action associated with a user click on the notification.
|
|
314
313
|
*/
|
|
315
|
-
|
|
314
|
+
click_action?: string;
|
|
316
315
|
}
|
|
317
316
|
/**
|
|
318
317
|
* Creates a FcmLegacyNotification from a native Firebase payload.
|
|
319
318
|
* @param nativeMessage - The native message payload to send to Notification Hubs.
|
|
320
|
-
* @returns The
|
|
319
|
+
* @returns The JSON body to send to Notification Hubs.
|
|
321
320
|
*/
|
|
322
|
-
export declare function
|
|
321
|
+
export declare function createFirebaseLegacyNotificationBody(nativeMessage: FirebaseLegacyNativeMessage): string;
|
|
323
322
|
/**
|
|
324
323
|
* Describes ADM notification messages.
|
|
325
324
|
*/
|
|
@@ -351,27 +350,27 @@ export interface AdmNativeNotification {
|
|
|
351
350
|
/**
|
|
352
351
|
* The action associated with a user click on the notification.
|
|
353
352
|
*/
|
|
354
|
-
|
|
353
|
+
click_action?: string;
|
|
355
354
|
/**
|
|
356
355
|
* The key to the body string in the app's string resources to use to localize the body text to the user's current localization.
|
|
357
356
|
*/
|
|
358
|
-
|
|
357
|
+
body_loc_key?: string;
|
|
359
358
|
/**
|
|
360
359
|
* Variable string values to be used in place of the format specifiers in body_loc_key to use to localize the body text to the user's current localization.
|
|
361
360
|
*/
|
|
362
|
-
|
|
361
|
+
body_loc_args?: string[];
|
|
363
362
|
/**
|
|
364
363
|
* The key to the title string in the app's string resources to use to localize the title text to the user's current localization.
|
|
365
364
|
*/
|
|
366
|
-
|
|
365
|
+
title_loc_key?: string;
|
|
367
366
|
/**
|
|
368
367
|
* Variable string values to be used in place of the format specifiers in title_loc_key to use to localize the title text to the user's current localization.
|
|
369
368
|
*/
|
|
370
|
-
|
|
369
|
+
title_loc_args?: string[];
|
|
371
370
|
/**
|
|
372
371
|
* The notification's channel id.
|
|
373
372
|
*/
|
|
374
|
-
|
|
373
|
+
channel_id?: string;
|
|
375
374
|
/**
|
|
376
375
|
* Sets the "ticker" text, which is sent to accessibility services.
|
|
377
376
|
*/
|
|
@@ -383,27 +382,27 @@ export interface AdmNativeNotification {
|
|
|
383
382
|
/**
|
|
384
383
|
* Set the time that the event in the notification occurred. Must be a timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
|
|
385
384
|
*/
|
|
386
|
-
|
|
385
|
+
event_time?: string;
|
|
387
386
|
/**
|
|
388
387
|
* Set whether or not this notification is relevant only to the current device.
|
|
389
388
|
*/
|
|
390
|
-
|
|
389
|
+
local_only?: boolean;
|
|
391
390
|
/**
|
|
392
391
|
* Set the relative priority for this notification.
|
|
393
392
|
*/
|
|
394
|
-
|
|
393
|
+
notification_priority?: "PRIORITY_UNSPECIFIED" | "PRIORITY_MIN" | "PRIORITY_LOW" | "PRIORITY_DEFAULT" | "PRIORITY_HIGH" | "PRIORITY_MAX";
|
|
395
394
|
/**
|
|
396
395
|
* If set to true, use the Android framework's default sound for the notification.
|
|
397
396
|
*/
|
|
398
|
-
|
|
397
|
+
default_sound?: boolean;
|
|
399
398
|
/**
|
|
400
399
|
* Set the Notification.visibility of the notification.
|
|
401
400
|
*/
|
|
402
|
-
visibility?:
|
|
401
|
+
visibility?: "VISIBILITY_UNSPECIFIED" | "PRIVATE" | "PUBLIC" | "SECRET";
|
|
403
402
|
/**
|
|
404
403
|
* Sets the number of items this notification represents.
|
|
405
404
|
*/
|
|
406
|
-
|
|
405
|
+
notification_count?: number;
|
|
407
406
|
/**
|
|
408
407
|
* Contains the URL of an image that is going to be displayed in a notification.
|
|
409
408
|
*/
|
|
@@ -444,7 +443,7 @@ export interface AdmNativeMessage {
|
|
|
444
443
|
* @param nativeMessage - The native message payload to send to Notification Hubs.
|
|
445
444
|
* @returns The AdmNotification to send to Notification Hubs.
|
|
446
445
|
*/
|
|
447
|
-
export declare function
|
|
446
|
+
export declare function createAdmNotificationBody(nativeMessage: AdmNativeMessage): string;
|
|
448
447
|
/**
|
|
449
448
|
* Represents the Baidu Apple native payload.
|
|
450
449
|
*/
|
|
@@ -479,23 +478,23 @@ export interface BaiduNativeMessage extends Record<string, any> {
|
|
|
479
478
|
/**
|
|
480
479
|
* Baidu Notification builder ID.
|
|
481
480
|
*/
|
|
482
|
-
|
|
481
|
+
notification_builder_id?: number;
|
|
483
482
|
/**
|
|
484
483
|
* Baidu Notification Android basic style.
|
|
485
484
|
*/
|
|
486
|
-
|
|
485
|
+
notification_basic_style?: number;
|
|
487
486
|
/**
|
|
488
487
|
* Baidu Android open type.
|
|
489
488
|
*/
|
|
490
|
-
|
|
489
|
+
open_type?: number;
|
|
491
490
|
/**
|
|
492
491
|
* Baidu Android net support option.
|
|
493
492
|
*/
|
|
494
|
-
|
|
493
|
+
net_support?: number;
|
|
495
494
|
/**
|
|
496
495
|
* Baidu Android user confirm.
|
|
497
496
|
*/
|
|
498
|
-
|
|
497
|
+
user_confirm?: number;
|
|
499
498
|
/**
|
|
500
499
|
* Baidu Android URL.
|
|
501
500
|
*/
|
|
@@ -503,15 +502,15 @@ export interface BaiduNativeMessage extends Record<string, any> {
|
|
|
503
502
|
/**
|
|
504
503
|
* Baidu Android package content.
|
|
505
504
|
*/
|
|
506
|
-
|
|
505
|
+
pkg_content?: string;
|
|
507
506
|
/**
|
|
508
507
|
* Baidu Android package version.
|
|
509
508
|
*/
|
|
510
|
-
|
|
509
|
+
pkg_version?: string;
|
|
511
510
|
/**
|
|
512
511
|
* Baidu Android custom content dictionary.
|
|
513
512
|
*/
|
|
514
|
-
|
|
513
|
+
custom_content?: Record<string, any>;
|
|
515
514
|
/**
|
|
516
515
|
* Baidu APNs support.
|
|
517
516
|
*/
|
|
@@ -520,10 +519,9 @@ export interface BaiduNativeMessage extends Record<string, any> {
|
|
|
520
519
|
/**
|
|
521
520
|
* Creates a BaiduNotification from a native Baidu payload.
|
|
522
521
|
* @param nativeMessage - The native message payload to send to Notification Hubs.
|
|
523
|
-
* @
|
|
524
|
-
* @returns The BaiduNotification to send to Notification Hubs.
|
|
522
|
+
* @returns The JSON body to send to Notification Hubs.
|
|
525
523
|
*/
|
|
526
|
-
export declare function
|
|
524
|
+
export declare function createBaiduNotificationBody(nativeMessage: BaiduNativeMessage): string;
|
|
527
525
|
/**
|
|
528
526
|
* Represents the types of Windows Badge Glyphs
|
|
529
527
|
*/
|
|
@@ -540,7 +538,7 @@ export interface WindowsBadgeNativeMessage {
|
|
|
540
538
|
/**
|
|
541
539
|
* Builds a WindowsNotification from a Windows Badge.
|
|
542
540
|
* @param nativeMessage - The Windows Badge Message to build.
|
|
543
|
-
* @returns
|
|
541
|
+
* @returns The WNS XML created with the badge information.
|
|
544
542
|
*/
|
|
545
|
-
export declare function
|
|
546
|
-
//# sourceMappingURL=
|
|
543
|
+
export declare function createWindowsBadgeNotificationBody(nativeMessage: WindowsBadgeNativeMessage): string;
|
|
544
|
+
//# sourceMappingURL=notificationBodyBuilder.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"notificationBodyBuilder.d.ts","sourceRoot":"","sources":["../../../src/models/notificationBodyBuilder.ts"],"names":[],"mappings":"AAKA;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE5B;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE/B;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAC7D;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,UAAU,CAAC;IAE5B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,kBAAkB,CAAC;IAEpC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,oBAAoB,CAAC,EAAE,SAAS,GAAG,QAAQ,GAAG,gBAAgB,GAAG,UAAU,CAAC;IAE5E;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED;;;;;GAKG;AACH,wBAAgB,2BAA2B,CAAC,aAAa,EAAE,kBAAkB,GAAG,MAAM,CAErF;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE5B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;IAE7B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAE3B;;OAEG;IACH,YAAY,CAAC,EACT,gCAAgC,GAChC,kCAAkC,GAClC,8BAA8B,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IAEzB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IAEzB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;;GAIG;AACH,wBAAgB,oCAAoC,CAClD,aAAa,EAAE,2BAA2B,GACzC,MAAM,CAER;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IAEzB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAE1B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,qBAAqB,CAAC,EAClB,sBAAsB,GACtB,cAAc,GACd,cAAc,GACd,kBAAkB,GAClB,eAAe,GACf,cAAc,CAAC;IAEnB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,UAAU,CAAC,EAAE,wBAAwB,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,CAAC;IAExE;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,YAAY,CAAC,EAAE,qBAAqB,CAAC;IAErC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;IAE7B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED;;;;GAIG;AACH,wBAAgB,yBAAyB,CAAC,aAAa,EAAE,gBAAgB,GAAG,MAAM,CAEjF;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAmB,SAAQ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAC7D;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAErC;;OAEG;IACH,GAAG,CAAC,EAAE,uBAAuB,CAAC;CAC/B;AAED;;;;GAIG;AACH,wBAAgB,2BAA2B,CAAC,aAAa,EAAE,kBAAkB,GAAG,MAAM,CAErF;AAED;;GAEG;AACH,oBAAY,qBAAqB,GAC7B,MAAM,GACN,UAAU,GACV,OAAO,GACP,OAAO,GACP,WAAW,GACX,WAAW,GACX,MAAM,GACN,MAAM,GACN,OAAO,GACP,YAAY,GACZ,QAAQ,GACR,SAAS,GACT,aAAa,CAAC;AAElB;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,KAAK,EAAE,qBAAqB,GAAG,MAAM,CAAC;CACvC;AAED;;;;GAIG;AACH,wBAAgB,kCAAkC,CAChD,aAAa,EAAE,yBAAyB,GACvC,MAAM,CAMR"}
|
|
@@ -5,7 +5,7 @@ export declare type NotificationOutcomeState = "Enqueued" | "DetailedStateAvaila
|
|
|
5
5
|
/**
|
|
6
6
|
* The per platform count per state.
|
|
7
7
|
*/
|
|
8
|
-
export interface
|
|
8
|
+
export interface NotificationOutcome {
|
|
9
9
|
/**
|
|
10
10
|
* The state of the notification.
|
|
11
11
|
*/
|
|
@@ -62,27 +62,27 @@ export interface NotificationDetails {
|
|
|
62
62
|
/**
|
|
63
63
|
* APNs outcomes counts per state.
|
|
64
64
|
*/
|
|
65
|
-
apnsOutcomeCounts?:
|
|
65
|
+
apnsOutcomeCounts?: NotificationOutcome[];
|
|
66
66
|
/**
|
|
67
67
|
* WNS outcomes counts per state.
|
|
68
68
|
*/
|
|
69
|
-
wnsOutcomeCounts?:
|
|
69
|
+
wnsOutcomeCounts?: NotificationOutcome[];
|
|
70
70
|
/**
|
|
71
71
|
* FCM outcome counts per state.
|
|
72
72
|
*/
|
|
73
|
-
fcmOutcomeCounts?:
|
|
73
|
+
fcmOutcomeCounts?: NotificationOutcome[];
|
|
74
74
|
/**
|
|
75
75
|
* ADM outcome counts per state.
|
|
76
76
|
*/
|
|
77
|
-
admOutcomeCounts?:
|
|
77
|
+
admOutcomeCounts?: NotificationOutcome[];
|
|
78
78
|
/**
|
|
79
79
|
* Baidu outcome counts per state.
|
|
80
80
|
*/
|
|
81
|
-
baiduOutcomeCounts?:
|
|
81
|
+
baiduOutcomeCounts?: NotificationOutcome[];
|
|
82
82
|
/**
|
|
83
83
|
* Web Push outcome counts per state.
|
|
84
84
|
*/
|
|
85
|
-
browserOutcomeCounts?:
|
|
85
|
+
browserOutcomeCounts?: NotificationOutcome[];
|
|
86
86
|
}
|
|
87
87
|
/**
|
|
88
88
|
* Describes a response from the Notification Hubs which includes a tracking ID, correlation ID and location.
|
|
@@ -133,11 +133,11 @@ export interface NotificationHubsMessageResponse extends NotificationHubsRespons
|
|
|
133
133
|
/**
|
|
134
134
|
* The number of devices that successfully received the notification.
|
|
135
135
|
*/
|
|
136
|
-
|
|
136
|
+
successCount: number;
|
|
137
137
|
/**
|
|
138
138
|
* The number of devices that failed to receive a notification.
|
|
139
139
|
*/
|
|
140
|
-
|
|
140
|
+
failureCount: number;
|
|
141
141
|
/**
|
|
142
142
|
* The list of notification outcome results for each device registered with the hub, to which this notification was sent.
|
|
143
143
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"notificationDetails.d.ts","sourceRoot":"","sources":["../../../src/models/notificationDetails.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,oBAAY,wBAAwB,GAChC,UAAU,GACV,wBAAwB,GACxB,YAAY,GACZ,WAAW,GACX,WAAW,GACX,SAAS,GACT,eAAe,GACf,WAAW,CAAC;AAEhB;;GAEG;AACH,MAAM,WAAW,
|
|
1
|
+
{"version":3,"file":"notificationDetails.d.ts","sourceRoot":"","sources":["../../../src/models/notificationDetails.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,oBAAY,wBAAwB,GAChC,UAAU,GACV,wBAAwB,GACxB,YAAY,GACZ,WAAW,GACX,WAAW,GACX,SAAS,GACT,eAAe,GACf,WAAW,CAAC;AAEhB;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,wBAAwB,CAAC;IAEjC;;OAEG;IACH,WAAW,CAAC,EAAE,IAAI,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,CAAC;IAEjB;;OAEG;IACH,OAAO,CAAC,EAAE,IAAI,CAAC;IAEf;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,iBAAiB,CAAC,EAAE,mBAAmB,EAAE,CAAC;IAE1C;;OAEG;IACH,gBAAgB,CAAC,EAAE,mBAAmB,EAAE,CAAC;IAEzC;;OAEG;IACH,gBAAgB,CAAC,EAAE,mBAAmB,EAAE,CAAC;IAEzC;;OAEG;IACH,gBAAgB,CAAC,EAAE,mBAAmB,EAAE,CAAC;IAEzC;;OAEG;IACH,kBAAkB,CAAC,EAAE,mBAAmB,EAAE,CAAC;IAE3C;;OAEG;IACH,oBAAoB,CAAC,EAAE,mBAAmB,EAAE,CAAC;CAC9C;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,+BAAgC,SAAQ,wBAAwB;IAC/E;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,EAAE,kBAAkB,EAAE,CAAC;IAE9B;;OAEG;IACH,KAAK,EAAE,wBAAwB,CAAC;CACjC"}
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { OperationState, SimplePollerLike } from "@azure/core-lro";
|
|
1
2
|
/**
|
|
2
3
|
* Describes the types of notification hub jobs.
|
|
3
4
|
*/
|
|
@@ -101,4 +102,8 @@ export interface NotificationHubJob {
|
|
|
101
102
|
*/
|
|
102
103
|
updatedAt?: Date;
|
|
103
104
|
}
|
|
105
|
+
/**
|
|
106
|
+
* Describes a poller for NotificationHubJob types.
|
|
107
|
+
*/
|
|
108
|
+
export declare type NotificationHubJobPoller = SimplePollerLike<OperationState<NotificationHubJob>, NotificationHubJob>;
|
|
104
109
|
//# sourceMappingURL=notificationHubJob.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"notificationHubJob.d.ts","sourceRoot":"","sources":["../../../src/models/notificationHubJob.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,oBAAY,sBAAsB;AAChC;;GAEG;AACD,qBAAqB;AAEvB;;GAEG;GACD,2BAA2B;AAE7B;;GAEG;GACD,2BAA2B;AAE7B;;GAEG;GACD,2BAA2B;AAE7B;;GAEG;GACD,2BAA2B,CAAC;AAEhC;;GAEG;AACH,oBAAY,wBAAwB;AAClC;;GAEG;AACD,SAAS;AAEX;;;GAGG;GACD,SAAS;AAEX;;;GAGG;GACD,WAAW;AAEb;;GAEG;GACD,QAAQ,CAAC;AAEb;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,sBAAsB,CAAC;IAE7B;;OAEG;IACH,MAAM,CAAC,EAAE,wBAAwB,CAAC;IAElC;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEzC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAE1C;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,CAAC;IAEjB;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,CAAC;CAClB"}
|
|
1
|
+
{"version":3,"file":"notificationHubJob.d.ts","sourceRoot":"","sources":["../../../src/models/notificationHubJob.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAEnE;;GAEG;AACH,oBAAY,sBAAsB;AAChC;;GAEG;AACD,qBAAqB;AAEvB;;GAEG;GACD,2BAA2B;AAE7B;;GAEG;GACD,2BAA2B;AAE7B;;GAEG;GACD,2BAA2B;AAE7B;;GAEG;GACD,2BAA2B,CAAC;AAEhC;;GAEG;AACH,oBAAY,wBAAwB;AAClC;;GAEG;AACD,SAAS;AAEX;;;GAGG;GACD,SAAS;AAEX;;;GAGG;GACD,WAAW;AAEb;;GAEG;GACD,QAAQ,CAAC;AAEb;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,sBAAsB,CAAC;IAE7B;;OAEG;IACH,MAAM,CAAC,EAAE,wBAAwB,CAAC;IAElC;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEzC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAE1C;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,CAAC;IAEjB;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,CAAC;CAClB;AAED;;GAEG;AACH,oBAAY,wBAAwB,GAAG,gBAAgB,CACrD,cAAc,CAAC,kBAAkB,CAAC,EAClC,kBAAkB,CACnB,CAAC"}
|
|
@@ -1,18 +1,52 @@
|
|
|
1
1
|
import { CommonClientOptions, OperationOptions } from "@azure/core-client";
|
|
2
|
+
import { BrowserPushChannel } from "./installation.js";
|
|
2
3
|
/**
|
|
3
4
|
* Describes the options that can be provided while creating the NotificationHubsClientContext.
|
|
4
5
|
*/
|
|
5
6
|
export interface NotificationHubsClientOptions extends CommonClientOptions {
|
|
6
7
|
}
|
|
7
8
|
/**
|
|
8
|
-
*
|
|
9
|
+
* Options for polled operations including the polling interval cycle.
|
|
9
10
|
*/
|
|
10
|
-
export interface
|
|
11
|
+
export interface PolledOperationOptions extends OperationOptions {
|
|
12
|
+
/**
|
|
13
|
+
* Time delay between poll requests, in milliseconds.
|
|
14
|
+
*/
|
|
15
|
+
updateIntervalInMs?: number;
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* Options for sending notifications for both tag based send and broadcast scheduled send.
|
|
19
|
+
*/
|
|
20
|
+
export interface ScheduleNotificationOptions extends OperationOptions {
|
|
21
|
+
/**
|
|
22
|
+
* A tag expression used to target devices. Use the `createTagExpression` function to create a tag expression from an array of tags.
|
|
23
|
+
* If not set, this results in a broadcast notification to be scheduled.
|
|
24
|
+
*/
|
|
25
|
+
tagExpression?: string;
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* Options for sending notifications for both tag based send and broadcast send.
|
|
29
|
+
*/
|
|
30
|
+
export interface SendNotificationOptions extends OperationOptions {
|
|
31
|
+
/**
|
|
32
|
+
* A tag expression used to target devices. Use the `createTagExpression` function to create a tag expression from an array of tags.
|
|
33
|
+
* If not set, this results in a broadcast notification to be sent.
|
|
34
|
+
*/
|
|
35
|
+
tagExpression?: string;
|
|
11
36
|
/**
|
|
12
37
|
* Set to true to enable test send.
|
|
13
38
|
*/
|
|
14
39
|
enableTestSend?: boolean;
|
|
15
40
|
}
|
|
41
|
+
/**
|
|
42
|
+
* Options for sending notifications to individual devices.
|
|
43
|
+
*/
|
|
44
|
+
export interface DirectSendNotificationOptions extends OperationOptions {
|
|
45
|
+
/**
|
|
46
|
+
* The device handle to send the notification. If an array is provided, this uses batch direct send which is only available in Standard SKU and above.
|
|
47
|
+
*/
|
|
48
|
+
deviceHandle: string | BrowserPushChannel | string[];
|
|
49
|
+
}
|
|
16
50
|
/**
|
|
17
51
|
* Represents entity update operation options that can be set.
|
|
18
52
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../../../src/models/options.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;
|
|
1
|
+
{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../../../src/models/options.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3E,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAEvD;;GAEG;AACH,MAAM,WAAW,6BAA8B,SAAQ,mBAAmB;CAAG;AAE7E;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB;IAC9D;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,gBAAgB;IACnE;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,gBAAgB;IAC/D;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,6BAA8B,SAAQ,gBAAgB;IACrE;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,kBAAkB,GAAG,MAAM,EAAE,CAAC;CACtD;AAED;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB;IAC9D;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,6BAA8B,SAAQ,gBAAgB;IACrE;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,6BAA6B;IAC7E;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB"}
|