@azure/notification-hubs 1.0.0-beta.6 → 1.0.0-beta.8
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 +86 -78
- package/dist/index.cjs +321 -369
- package/dist/index.cjs.map +1 -1
- package/dist-esm/src/{client → api}/beginSubmitNotificationHubJob.js +0 -0
- package/dist-esm/src/api/beginSubmitNotificationHubJob.js.map +1 -0
- package/dist-esm/src/{client → api}/cancelScheduledNotification.js +0 -0
- package/dist-esm/src/api/cancelScheduledNotification.js.map +1 -0
- package/dist-esm/src/{client → api}/createOrUpdateInstallation.js +0 -0
- package/dist-esm/src/api/createOrUpdateInstallation.js.map +1 -0
- package/dist-esm/src/{client → api}/createOrUpdateRegistration.js +0 -0
- package/dist-esm/src/api/createOrUpdateRegistration.js.map +1 -0
- package/dist-esm/src/{client → api}/createRegistration.js +0 -0
- package/dist-esm/src/api/createRegistration.js.map +1 -0
- package/dist-esm/src/{client → api}/createRegistrationId.js +8 -0
- package/dist-esm/src/api/createRegistrationId.js.map +1 -0
- package/dist-esm/src/{client → api}/deleteInstallation.js +0 -0
- package/dist-esm/src/api/deleteInstallation.js.map +1 -0
- package/dist-esm/src/{client → api}/deleteRegistration.js +0 -0
- package/dist-esm/src/api/deleteRegistration.js.map +1 -0
- package/dist-esm/src/{client → api}/getFeedbackContainerUrl.js +0 -0
- package/dist-esm/src/api/getFeedbackContainerUrl.js.map +1 -0
- package/dist-esm/src/{client → api}/getInstallation.js +0 -0
- package/dist-esm/src/api/getInstallation.js.map +1 -0
- package/dist-esm/src/{client → api}/getNotificationHubJob.js +0 -0
- package/dist-esm/src/api/getNotificationHubJob.js.map +1 -0
- package/dist-esm/src/{client → api}/getNotificationOutcomeDetails.js +0 -0
- package/dist-esm/src/api/getNotificationOutcomeDetails.js.map +1 -0
- package/dist-esm/src/{client → api}/getRegistration.js +0 -0
- package/dist-esm/src/api/getRegistration.js.map +1 -0
- package/dist-esm/src/{client → api}/index.js +22 -0
- 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 +0 -0
- 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 +0 -0
- package/dist-esm/src/api/listRegistrationsByTag.js.map +1 -0
- package/dist-esm/src/{client → api}/scheduleNotification.js +2 -3
- package/dist-esm/src/api/scheduleNotification.js.map +1 -0
- package/dist-esm/src/{client → api}/sendNotification.js +3 -3
- package/dist-esm/src/api/sendNotification.js.map +1 -0
- package/dist-esm/src/{client → api}/submitNotificationHubJob.js +0 -0
- package/dist-esm/src/api/submitNotificationHubJob.js.map +1 -0
- package/dist-esm/src/{client → api}/updateInstallation.js +0 -0
- package/dist-esm/src/api/updateInstallation.js.map +1 -0
- package/dist-esm/src/{client → api}/updateRegistration.js +0 -0
- 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/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 +34 -24
- package/dist-esm/src/notificationHubsClient.js.map +1 -1
- package/dist-esm/src/serializers/notificationDetailsSerializer.js +1 -0
- package/dist-esm/src/serializers/notificationDetailsSerializer.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 +17 -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 +0 -6
- package/dist-esm/src/utils/notificationUtils.js.map +1 -1
- package/package.json +23 -19
- package/types/3.1/notification-hubs.d.ts +420 -249
- package/types/latest/notification-hubs.d.ts +448 -254
- package/types/latest/tsdoc-metadata.json +1 -1
- package/types/src/{client → api}/beginSubmitNotificationHubJob.d.ts +0 -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 +22 -0
- 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 +0 -0
- package/types/src/api/scheduleNotification.d.ts.map +1 -0
- package/types/src/{client → api}/sendNotification.d.ts +0 -0
- 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/options.d.ts +4 -4
- 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 +12 -5
- package/types/src/notificationHubsClient.d.ts.map +1 -1
- package/types/src/serializers/notificationDetailsSerializer.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 +0 -4
- package/types/src/utils/notificationUtils.d.ts.map +1 -1
- package/dist-esm/src/client/beginSubmitNotificationHubJob.js.map +0 -1
- 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/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/scheduleNotification.js.map +0 -1
- 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/beginSubmitNotificationHubJob.d.ts.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/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/scheduleNotification.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
|
@@ -73,27 +73,27 @@ export declare interface AdmNativeNotification {
|
|
|
73
73
|
/**
|
|
74
74
|
* The action associated with a user click on the notification.
|
|
75
75
|
*/
|
|
76
|
-
|
|
76
|
+
click_action?: string;
|
|
77
77
|
/**
|
|
78
78
|
* 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.
|
|
79
79
|
*/
|
|
80
|
-
|
|
80
|
+
body_loc_key?: string;
|
|
81
81
|
/**
|
|
82
82
|
* 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.
|
|
83
83
|
*/
|
|
84
|
-
|
|
84
|
+
body_loc_args?: string[];
|
|
85
85
|
/**
|
|
86
86
|
* 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.
|
|
87
87
|
*/
|
|
88
|
-
|
|
88
|
+
title_loc_key?: string;
|
|
89
89
|
/**
|
|
90
90
|
* 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.
|
|
91
91
|
*/
|
|
92
|
-
|
|
92
|
+
title_loc_args?: string[];
|
|
93
93
|
/**
|
|
94
94
|
* The notification's channel id.
|
|
95
95
|
*/
|
|
96
|
-
|
|
96
|
+
channel_id?: string;
|
|
97
97
|
/**
|
|
98
98
|
* Sets the "ticker" text, which is sent to accessibility services.
|
|
99
99
|
*/
|
|
@@ -105,27 +105,27 @@ export declare interface AdmNativeNotification {
|
|
|
105
105
|
/**
|
|
106
106
|
* 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".
|
|
107
107
|
*/
|
|
108
|
-
|
|
108
|
+
event_time?: string;
|
|
109
109
|
/**
|
|
110
110
|
* Set whether or not this notification is relevant only to the current device.
|
|
111
111
|
*/
|
|
112
|
-
|
|
112
|
+
local_only?: boolean;
|
|
113
113
|
/**
|
|
114
114
|
* Set the relative priority for this notification.
|
|
115
115
|
*/
|
|
116
|
-
|
|
116
|
+
notification_priority?: "PRIORITY_UNSPECIFIED" | "PRIORITY_MIN" | "PRIORITY_LOW" | "PRIORITY_DEFAULT" | "PRIORITY_HIGH" | "PRIORITY_MAX";
|
|
117
117
|
/**
|
|
118
118
|
* If set to true, use the Android framework's default sound for the notification.
|
|
119
119
|
*/
|
|
120
|
-
|
|
120
|
+
default_sound?: boolean;
|
|
121
121
|
/**
|
|
122
122
|
* Set the Notification.visibility of the notification.
|
|
123
123
|
*/
|
|
124
|
-
visibility?:
|
|
124
|
+
visibility?: "VISIBILITY_UNSPECIFIED" | "PRIVATE" | "PUBLIC" | "SECRET";
|
|
125
125
|
/**
|
|
126
126
|
* Sets the number of items this notification represents.
|
|
127
127
|
*/
|
|
128
|
-
|
|
128
|
+
notification_count?: number;
|
|
129
129
|
/**
|
|
130
130
|
* Contains the URL of an image that is going to be displayed in a notification.
|
|
131
131
|
*/
|
|
@@ -141,26 +141,46 @@ export declare interface AdmNotification extends JsonNotification {
|
|
|
141
141
|
platform: "adm";
|
|
142
142
|
}
|
|
143
143
|
/**
|
|
144
|
-
*
|
|
144
|
+
* Describes an ADM Registration channel query.
|
|
145
145
|
*/
|
|
146
|
-
export declare interface
|
|
146
|
+
export declare interface AdmRegistrationChannel {
|
|
147
147
|
/**
|
|
148
|
-
* The
|
|
148
|
+
* The ADM Registration ID.
|
|
149
149
|
*/
|
|
150
150
|
admRegistrationId: string;
|
|
151
151
|
/**
|
|
152
|
-
* The
|
|
152
|
+
* The kind of the registration channel.
|
|
153
153
|
*/
|
|
154
|
-
|
|
154
|
+
kind: "adm";
|
|
155
|
+
}
|
|
156
|
+
/**
|
|
157
|
+
* Represents the description of the Amazon Device Messaging (ADM) registration.
|
|
158
|
+
*/
|
|
159
|
+
export declare interface AdmRegistrationDescription extends AdmRegistrationDescriptionCommon {
|
|
160
|
+
/**
|
|
161
|
+
* The kind of the registration.
|
|
162
|
+
*/
|
|
163
|
+
kind: "Adm";
|
|
164
|
+
}
|
|
165
|
+
export declare interface AdmRegistrationDescriptionCommon extends RegistrationDescriptionCommon {
|
|
166
|
+
/**
|
|
167
|
+
* The Amazon Device Messaging registration identifier.
|
|
168
|
+
*/
|
|
169
|
+
admRegistrationId: string;
|
|
155
170
|
}
|
|
156
171
|
/**
|
|
157
172
|
* Represents the description of the Amazon Device Messaging (ADM) template registration.
|
|
158
173
|
*/
|
|
159
|
-
export declare interface AdmTemplateRegistrationDescription extends
|
|
174
|
+
export declare interface AdmTemplateRegistrationDescription extends AdmTemplateRegistrationDescriptionCommon {
|
|
160
175
|
/**
|
|
161
|
-
* The
|
|
176
|
+
* The kind of the registration.
|
|
162
177
|
*/
|
|
163
|
-
|
|
178
|
+
kind: "AdmTemplate";
|
|
179
|
+
}
|
|
180
|
+
/**
|
|
181
|
+
* Represents the description of the Amazon Device Messaging (ADM) template registration.
|
|
182
|
+
*/
|
|
183
|
+
export declare interface AdmTemplateRegistrationDescriptionCommon extends AdmRegistrationDescriptionCommon, TemplateRegistrationDescription {
|
|
164
184
|
}
|
|
165
185
|
/**
|
|
166
186
|
* Represents what is in the APNs alert body.
|
|
@@ -183,45 +203,45 @@ export declare interface AppleAlert {
|
|
|
183
203
|
* The name of the launch image file to display. If the user chooses to launch your app,
|
|
184
204
|
* the contents of the specified image or storyboard file are displayed instead of your app’s normal launch image.
|
|
185
205
|
*/
|
|
186
|
-
|
|
206
|
+
"launch-image"?: string;
|
|
187
207
|
/**
|
|
188
208
|
* The key for a localized title string. Specify this key instead of the title key to retrieve
|
|
189
209
|
* the title from your app’s Localizable.strings files. The value must contain the name of a key in your strings file.
|
|
190
210
|
*/
|
|
191
|
-
|
|
211
|
+
"title-loc-key"?: string;
|
|
192
212
|
/**
|
|
193
213
|
* An array of strings containing replacement values for variables in your title string.
|
|
194
214
|
* Each %\@ character in the string specified by the title-loc-key is replaced by a value
|
|
195
215
|
* from this array. The first item in the array replaces the first instance
|
|
196
216
|
* of the %\@ character in the string, the second item replaces the second instance, and so on.
|
|
197
217
|
*/
|
|
198
|
-
|
|
218
|
+
"title-loc-args"?: string[];
|
|
199
219
|
/**
|
|
200
220
|
* The key for a localized subtitle string. Use this key, instead of the subtitle key, to
|
|
201
221
|
* retrieve the subtitle from your app’s Localizable.strings file.
|
|
202
222
|
* The value must contain the name of a key in your strings file.
|
|
203
223
|
*/
|
|
204
|
-
|
|
224
|
+
"subtitle-loc-key"?: string;
|
|
205
225
|
/**
|
|
206
226
|
* An array of strings containing replacement values for variables in your title string.
|
|
207
227
|
* Each %\@ character in the string specified by subtitle-loc-key is replaced by a value
|
|
208
228
|
* from this array. The first item in the array replaces the first instance of the
|
|
209
229
|
* %\@ character in the string, the second item replaces the second instance, and so on.
|
|
210
230
|
*/
|
|
211
|
-
|
|
231
|
+
"subtitle-loc-args"?: string[];
|
|
212
232
|
/**
|
|
213
233
|
* The key for a localized message string. Use this key, instead of the body key, to
|
|
214
234
|
* retrieve the message text from your app’s Localizable.strings file. The value must contain
|
|
215
235
|
* the name of a key in your strings file.
|
|
216
236
|
*/
|
|
217
|
-
|
|
237
|
+
"loc-key"?: string;
|
|
218
238
|
/**
|
|
219
239
|
* An array of strings containing replacement values for variables in your message text.
|
|
220
240
|
* Each %\@ character in the string specified by loc-key is replaced by a value from
|
|
221
241
|
* this array. The first item in the array replaces the first instance of the %\@ character
|
|
222
242
|
* in the string, the second item replaces the second instance, and so on.
|
|
223
243
|
*/
|
|
224
|
-
|
|
244
|
+
"loc-args"?: string[];
|
|
225
245
|
}
|
|
226
246
|
/**
|
|
227
247
|
* Represents an APNs critical sound
|
|
@@ -272,7 +292,7 @@ export declare interface AppleNativeMessage extends Record<string, any> {
|
|
|
272
292
|
/**
|
|
273
293
|
* An app-specific identifier for grouping related notifications.
|
|
274
294
|
*/
|
|
275
|
-
|
|
295
|
+
"thread-id"?: string;
|
|
276
296
|
/**
|
|
277
297
|
* The notification’s type.
|
|
278
298
|
*/
|
|
@@ -281,29 +301,29 @@ export declare interface AppleNativeMessage extends Record<string, any> {
|
|
|
281
301
|
* The background notification flag. To perform a silent background update,
|
|
282
302
|
* specify the value 1 and don’t include the alert, badge, or sound keys in your payload.
|
|
283
303
|
*/
|
|
284
|
-
|
|
304
|
+
"content-available"?: number;
|
|
285
305
|
/**
|
|
286
306
|
* The notification service app extension flag. If the value is 1, the system passes
|
|
287
307
|
* the notification to your notification service app extension before delivery.
|
|
288
308
|
*/
|
|
289
|
-
|
|
309
|
+
"mutable-content"?: number;
|
|
290
310
|
/**
|
|
291
311
|
* The identifier of the window brought forward.
|
|
292
312
|
*/
|
|
293
|
-
|
|
313
|
+
"target-content-id"?: string;
|
|
294
314
|
/**
|
|
295
315
|
* The importance and delivery timing of a notification.
|
|
296
316
|
*/
|
|
297
|
-
|
|
317
|
+
"interruption-level"?: "passive" | "active" | "time-sensitive" | "critical";
|
|
298
318
|
/**
|
|
299
319
|
* The relevance score, a number between 0 and 1, that the system uses to sort the
|
|
300
320
|
* notifications from your app. The highest score gets featured in the notification summary.
|
|
301
321
|
*/
|
|
302
|
-
|
|
322
|
+
"relevance-score"?: number;
|
|
303
323
|
/**
|
|
304
324
|
* The criteria the system evaluates to determine if it displays the notification in the current Focus.
|
|
305
325
|
*/
|
|
306
|
-
|
|
326
|
+
"filter-criteria"?: string;
|
|
307
327
|
}
|
|
308
328
|
/**
|
|
309
329
|
* Represents an Apple APNs push notification.
|
|
@@ -315,26 +335,49 @@ export declare interface AppleNotification extends JsonNotification {
|
|
|
315
335
|
platform: "apple";
|
|
316
336
|
}
|
|
317
337
|
/**
|
|
318
|
-
*
|
|
338
|
+
* Describes an Apple Registration channel query.
|
|
339
|
+
*/
|
|
340
|
+
export declare interface AppleRegistrationChannel {
|
|
341
|
+
/**
|
|
342
|
+
* The APNs device token.
|
|
343
|
+
*/
|
|
344
|
+
deviceToken: string;
|
|
345
|
+
/**
|
|
346
|
+
* The kind of the registration channel.
|
|
347
|
+
*/
|
|
348
|
+
kind: "apple";
|
|
349
|
+
}
|
|
350
|
+
/**
|
|
351
|
+
* Represents the description of apple registration.
|
|
319
352
|
*/
|
|
320
|
-
export declare
|
|
353
|
+
export declare interface AppleRegistrationDescription extends AppleRegistrationDescriptionCommon {
|
|
354
|
+
/**
|
|
355
|
+
* The kind of the registration.
|
|
356
|
+
*/
|
|
357
|
+
kind: "Apple";
|
|
358
|
+
}
|
|
321
359
|
/**
|
|
322
360
|
* Represents the description of apple registration.
|
|
323
361
|
*/
|
|
324
|
-
export declare interface
|
|
362
|
+
export declare interface AppleRegistrationDescriptionCommon extends RegistrationDescriptionCommon {
|
|
325
363
|
/**
|
|
326
364
|
* The APNs device token.
|
|
327
365
|
*/
|
|
328
366
|
deviceToken: string;
|
|
367
|
+
}
|
|
368
|
+
/**
|
|
369
|
+
* Represents the description of the Apple template registration.
|
|
370
|
+
*/
|
|
371
|
+
export declare interface AppleTemplateRegistrationDescription extends AppleTemplateRegistrationDescriptionCommon {
|
|
329
372
|
/**
|
|
330
|
-
* The
|
|
373
|
+
* The kind of the registration.
|
|
331
374
|
*/
|
|
332
|
-
|
|
375
|
+
kind: "AppleTemplate";
|
|
333
376
|
}
|
|
334
377
|
/**
|
|
335
378
|
* Represents the description of the Apple template registration.
|
|
336
379
|
*/
|
|
337
|
-
export declare interface
|
|
380
|
+
export declare interface AppleTemplateRegistrationDescriptionCommon extends AppleRegistrationDescriptionCommon, TemplateRegistrationDescription {
|
|
338
381
|
/**
|
|
339
382
|
* The expiry date.
|
|
340
383
|
*/
|
|
@@ -342,15 +385,11 @@ export declare interface AppleTemplateRegistrationDescription extends Pick<Apple
|
|
|
342
385
|
/**
|
|
343
386
|
* The notification priority.
|
|
344
387
|
*/
|
|
345
|
-
priority?:
|
|
388
|
+
priority?: "10" | "5";
|
|
346
389
|
/**
|
|
347
390
|
* The APNS headers.
|
|
348
391
|
*/
|
|
349
392
|
apnsHeaders?: Record<string, string>;
|
|
350
|
-
/**
|
|
351
|
-
* The type of the registration.
|
|
352
|
-
*/
|
|
353
|
-
type: "AppleTemplate";
|
|
354
393
|
}
|
|
355
394
|
/**
|
|
356
395
|
* Represents the Baidu Apple native payload.
|
|
@@ -395,23 +434,23 @@ export declare interface BaiduNativeMessage extends Record<string, any> {
|
|
|
395
434
|
/**
|
|
396
435
|
* Baidu Notification builder ID.
|
|
397
436
|
*/
|
|
398
|
-
|
|
437
|
+
notification_builder_id?: number;
|
|
399
438
|
/**
|
|
400
439
|
* Baidu Notification Android basic style.
|
|
401
440
|
*/
|
|
402
|
-
|
|
441
|
+
notification_basic_style?: number;
|
|
403
442
|
/**
|
|
404
443
|
* Baidu Android open type.
|
|
405
444
|
*/
|
|
406
|
-
|
|
445
|
+
open_type?: number;
|
|
407
446
|
/**
|
|
408
447
|
* Baidu Android net support option.
|
|
409
448
|
*/
|
|
410
|
-
|
|
449
|
+
net_support?: number;
|
|
411
450
|
/**
|
|
412
451
|
* Baidu Android user confirm.
|
|
413
452
|
*/
|
|
414
|
-
|
|
453
|
+
user_confirm?: number;
|
|
415
454
|
/**
|
|
416
455
|
* Baidu Android URL.
|
|
417
456
|
*/
|
|
@@ -419,15 +458,15 @@ export declare interface BaiduNativeMessage extends Record<string, any> {
|
|
|
419
458
|
/**
|
|
420
459
|
* Baidu Android package content.
|
|
421
460
|
*/
|
|
422
|
-
|
|
461
|
+
pkg_content?: string;
|
|
423
462
|
/**
|
|
424
463
|
* Baidu Android package version.
|
|
425
464
|
*/
|
|
426
|
-
|
|
465
|
+
pkg_version?: string;
|
|
427
466
|
/**
|
|
428
467
|
* Baidu Android custom content dictionary.
|
|
429
468
|
*/
|
|
430
|
-
|
|
469
|
+
custom_content?: Record<string, any>;
|
|
431
470
|
/**
|
|
432
471
|
* Baidu APNs support.
|
|
433
472
|
*/
|
|
@@ -442,10 +481,33 @@ export declare interface BaiduNotification extends JsonNotification {
|
|
|
442
481
|
*/
|
|
443
482
|
platform: "baidu";
|
|
444
483
|
}
|
|
484
|
+
/**
|
|
485
|
+
* Describes an Baidu Registration channel query.
|
|
486
|
+
*/
|
|
487
|
+
export declare interface BaiduRegistrationChannel {
|
|
488
|
+
/**
|
|
489
|
+
* The Baidu Channel ID.
|
|
490
|
+
*/
|
|
491
|
+
baiduChannelId: string;
|
|
492
|
+
/**
|
|
493
|
+
* The Baidu User ID.
|
|
494
|
+
*/
|
|
495
|
+
baiduUserId: string;
|
|
496
|
+
/**
|
|
497
|
+
* The kind of the registration channel.
|
|
498
|
+
*/
|
|
499
|
+
kind: "baidu";
|
|
500
|
+
}
|
|
445
501
|
/**
|
|
446
502
|
* Represents a Baidu registration description.
|
|
447
503
|
*/
|
|
448
|
-
export declare interface BaiduRegistrationDescription extends
|
|
504
|
+
export declare interface BaiduRegistrationDescription extends BaiduRegistrationDescriptionCommon {
|
|
505
|
+
/**
|
|
506
|
+
* The kind of the registration.
|
|
507
|
+
*/
|
|
508
|
+
kind: "Baidu";
|
|
509
|
+
}
|
|
510
|
+
export declare interface BaiduRegistrationDescriptionCommon extends RegistrationDescriptionCommon {
|
|
449
511
|
/**
|
|
450
512
|
* The Baidu user identifier.
|
|
451
513
|
*/
|
|
@@ -454,32 +516,38 @@ export declare interface BaiduRegistrationDescription extends RegistrationDescri
|
|
|
454
516
|
* The Baidu channel identifier.
|
|
455
517
|
*/
|
|
456
518
|
baiduChannelId: string;
|
|
519
|
+
}
|
|
520
|
+
/**
|
|
521
|
+
* Represents a Baidu template registration description.
|
|
522
|
+
*/
|
|
523
|
+
export declare interface BaiduTemplateRegistrationDescription extends BaiduTemplateRegistrationDescriptionCommon {
|
|
457
524
|
/**
|
|
458
|
-
* The
|
|
525
|
+
* The kind of the registration.
|
|
459
526
|
*/
|
|
460
|
-
|
|
527
|
+
kind: "BaiduTemplate";
|
|
461
528
|
}
|
|
462
529
|
/**
|
|
463
530
|
* Represents a Baidu template registration description.
|
|
464
531
|
*/
|
|
465
|
-
export declare interface
|
|
532
|
+
export declare interface BaiduTemplateRegistrationDescriptionCommon extends BaiduRegistrationDescriptionCommon, TemplateRegistrationDescription {
|
|
533
|
+
}
|
|
534
|
+
/**
|
|
535
|
+
* Represents a Browser/Web Push based installation.
|
|
536
|
+
*/
|
|
537
|
+
export declare interface BrowserInstallation extends BrowserInstallationCommon {
|
|
466
538
|
/**
|
|
467
|
-
* The
|
|
539
|
+
* The platform for the installation.
|
|
468
540
|
*/
|
|
469
|
-
|
|
541
|
+
platform: "browser";
|
|
470
542
|
}
|
|
471
543
|
/**
|
|
472
544
|
* Represents a Browser/Web Push based installation.
|
|
473
545
|
*/
|
|
474
|
-
export declare interface
|
|
546
|
+
export declare interface BrowserInstallationCommon extends InstallationCommon {
|
|
475
547
|
/**
|
|
476
548
|
* The push channel for the Web Push API.
|
|
477
549
|
*/
|
|
478
550
|
pushChannel: BrowserPushChannel;
|
|
479
|
-
/**
|
|
480
|
-
* The platform for the installation.
|
|
481
|
-
*/
|
|
482
|
-
platform: "browser";
|
|
483
551
|
}
|
|
484
552
|
/**
|
|
485
553
|
* Represents a Browser push notification.
|
|
@@ -508,235 +576,271 @@ export declare interface BrowserPushChannel {
|
|
|
508
576
|
endpoint: string;
|
|
509
577
|
}
|
|
510
578
|
/**
|
|
511
|
-
*
|
|
579
|
+
* Describes an Browser Registration channel query.
|
|
512
580
|
*/
|
|
513
|
-
export declare interface
|
|
581
|
+
export declare interface BrowserRegistrationChannel {
|
|
514
582
|
/**
|
|
515
|
-
* The
|
|
583
|
+
* The Web Push endpoint URL.
|
|
516
584
|
*/
|
|
517
585
|
endpoint: string;
|
|
518
586
|
/**
|
|
519
|
-
* The
|
|
587
|
+
* The Web Push subscription P256DH.
|
|
520
588
|
*/
|
|
521
589
|
p256dh: string;
|
|
522
590
|
/**
|
|
523
|
-
* The
|
|
591
|
+
* The Web Push subscription auth secret.
|
|
524
592
|
*/
|
|
525
593
|
auth: string;
|
|
526
594
|
/**
|
|
527
|
-
* The
|
|
595
|
+
* The kind of the registration channel.
|
|
528
596
|
*/
|
|
529
|
-
|
|
597
|
+
kind: "browser";
|
|
530
598
|
}
|
|
531
599
|
/**
|
|
532
|
-
* Represents a Browser Push
|
|
600
|
+
* Represents a Browser Push registration description.
|
|
533
601
|
*/
|
|
534
|
-
export declare interface
|
|
602
|
+
export declare interface BrowserRegistrationDescription extends BrowserRegistrationDescriptionCommon {
|
|
535
603
|
/**
|
|
536
|
-
* The
|
|
604
|
+
* The kind of the registration.
|
|
537
605
|
*/
|
|
538
|
-
|
|
606
|
+
kind: "Browser";
|
|
539
607
|
}
|
|
540
608
|
/**
|
|
541
|
-
*
|
|
542
|
-
* @param nativeMessage - The native message payload to send to Notification Hubs.
|
|
543
|
-
* @returns The AdmNotification to send to Notification Hubs.
|
|
544
|
-
*/
|
|
545
|
-
export declare function buildAdmNativeMessage(nativeMessage: AdmNativeMessage): AdmNotification;
|
|
546
|
-
/**
|
|
547
|
-
* Creates an APNs native message to send to Notification Hubs.
|
|
548
|
-
* @param nativeMessage - The Apple native message properties to set.
|
|
549
|
-
* @param additionalProperties - Additional properties for Apple messages.
|
|
550
|
-
* @returns An AppleNotification to send to Notification Hubs.
|
|
551
|
-
*/
|
|
552
|
-
export declare function buildAppleNativeMessage(nativeMessage: AppleNativeMessage, additionalProperties?: Record<string, any>): AppleNotification;
|
|
553
|
-
/**
|
|
554
|
-
* Creates a BaiduNotification from a native Baidu payload.
|
|
555
|
-
* @param nativeMessage - The native message payload to send to Notification Hubs.
|
|
556
|
-
* @param additionalProperties - Additional properties for Apple Baidu messages.
|
|
557
|
-
* @returns The BaiduNotification to send to Notification Hubs.
|
|
609
|
+
* Represents a Browser Push registration description.
|
|
558
610
|
*/
|
|
559
|
-
export declare
|
|
611
|
+
export declare interface BrowserRegistrationDescriptionCommon extends RegistrationDescriptionCommon {
|
|
612
|
+
/**
|
|
613
|
+
* The Browser push endpoint.
|
|
614
|
+
*/
|
|
615
|
+
endpoint: string;
|
|
616
|
+
/**
|
|
617
|
+
* The Browser push P256DH.
|
|
618
|
+
*/
|
|
619
|
+
p256dh: string;
|
|
620
|
+
/**
|
|
621
|
+
* The Browser push auth secret.
|
|
622
|
+
*/
|
|
623
|
+
auth: string;
|
|
624
|
+
}
|
|
560
625
|
/**
|
|
561
|
-
*
|
|
562
|
-
* @param nativeMessage - The native message payload to send to Notification Hubs.
|
|
563
|
-
* @returns The FcmLegacyNotification to send to Notification Hubs.
|
|
626
|
+
* Represents a Browser Push remplate registration description.
|
|
564
627
|
*/
|
|
565
|
-
export declare
|
|
628
|
+
export declare interface BrowserTemplateRegistrationDescription extends BrowserTemplateRegistrationDescriptionCommon {
|
|
629
|
+
/**
|
|
630
|
+
* The kind of the registration.
|
|
631
|
+
*/
|
|
632
|
+
kind: "BrowserTemplate";
|
|
633
|
+
}
|
|
566
634
|
/**
|
|
567
|
-
*
|
|
568
|
-
* @param nativeMessage - The Windows Badge Message to build.
|
|
569
|
-
* @returns A WindowsNotification created with the badge information.
|
|
635
|
+
* Represents a Browser Push remplate registration description.
|
|
570
636
|
*/
|
|
571
|
-
export declare
|
|
637
|
+
export declare interface BrowserTemplateRegistrationDescriptionCommon extends BrowserRegistrationDescriptionCommon, TemplateRegistrationDescription {
|
|
638
|
+
}
|
|
572
639
|
/**
|
|
573
640
|
* Creates an Amazon Device Messaging (ADM) based installation.
|
|
574
641
|
* @param installation - A partial installation used to create the ADM installation.
|
|
575
642
|
* @returns The newly created ADM installation.
|
|
576
643
|
*/
|
|
577
|
-
export declare function createAdmInstallation(installation:
|
|
644
|
+
export declare function createAdmInstallation(installation: DeviceTokenInstallation): AdmInstallation;
|
|
578
645
|
/**
|
|
579
646
|
* Creates a notification to send to an Amazon Device Messaging device.
|
|
580
647
|
* @param notification - A partial message used to create a message for Amazon Device Messaging.
|
|
581
648
|
* @returns A newly created Amazon Device Messaging.
|
|
582
649
|
*/
|
|
583
|
-
export declare function createAdmNotification(notification:
|
|
650
|
+
export declare function createAdmNotification(notification: NotificationCommon): AdmNotification;
|
|
651
|
+
/**
|
|
652
|
+
* Creates a AdmNotification from a native ADM payload.
|
|
653
|
+
* @param nativeMessage - The native message payload to send to Notification Hubs.
|
|
654
|
+
* @returns The AdmNotification to send to Notification Hubs.
|
|
655
|
+
*/
|
|
656
|
+
export declare function createAdmNotificationBody(nativeMessage: AdmNativeMessage): string;
|
|
584
657
|
/**
|
|
585
658
|
* Creates an ADM registration description.
|
|
586
659
|
* @param description - A partial ADM registration description.
|
|
587
660
|
* @returns A created ADM registration description.
|
|
588
661
|
*/
|
|
589
|
-
export declare function createAdmRegistrationDescription(description:
|
|
662
|
+
export declare function createAdmRegistrationDescription(description: AdmRegistrationDescriptionCommon): AdmRegistrationDescription;
|
|
590
663
|
/**
|
|
591
664
|
* Creates an ADM template registration description.
|
|
592
665
|
* @param description - A partial ADM template registration description.
|
|
593
666
|
* @returns A created ADM template registration description.
|
|
594
667
|
*/
|
|
595
|
-
export declare function createAdmTemplateRegistrationDescription(description:
|
|
668
|
+
export declare function createAdmTemplateRegistrationDescription(description: AdmTemplateRegistrationDescriptionCommon): AdmTemplateRegistrationDescription;
|
|
596
669
|
/**
|
|
597
670
|
* Creates an Apple based installation.
|
|
598
671
|
* @param installation - A partial installation used to create the Apple installation.
|
|
599
672
|
* @returns The newly created Apple installation.
|
|
600
673
|
*/
|
|
601
|
-
export declare function createAppleInstallation(installation:
|
|
674
|
+
export declare function createAppleInstallation(installation: DeviceTokenInstallation): AppleInstallation;
|
|
602
675
|
/**
|
|
603
676
|
* Creates a notification to send to an Apple device.
|
|
604
677
|
* @param notification - A partial message used to create a message for Apple.
|
|
605
678
|
* @returns A newly created Apple.
|
|
606
679
|
*/
|
|
607
|
-
export declare function createAppleNotification(notification:
|
|
680
|
+
export declare function createAppleNotification(notification: NotificationCommon): AppleNotification;
|
|
681
|
+
/**
|
|
682
|
+
* Creates an APNs native message to send to Notification Hubs.
|
|
683
|
+
* @param nativeMessage - The Apple native message properties to set.
|
|
684
|
+
* @param additionalProperties - Additional properties for Apple messages.
|
|
685
|
+
* @returns An AppleNotification to send to Notification Hubs.
|
|
686
|
+
*/
|
|
687
|
+
export declare function createAppleNotificationBody(nativeMessage: AppleNativeMessage): string;
|
|
608
688
|
/**
|
|
609
689
|
* Creates an Apple registration description.
|
|
610
690
|
* @param description - A partial Apple registration description.
|
|
611
691
|
* @returns A created Apple registration description.
|
|
612
692
|
*/
|
|
613
|
-
export declare function createAppleRegistrationDescription(description:
|
|
693
|
+
export declare function createAppleRegistrationDescription(description: AppleRegistrationDescriptionCommon): AppleRegistrationDescription;
|
|
614
694
|
/**
|
|
615
695
|
* Creates an Apple template registration description.
|
|
616
696
|
* @param description - A partial Apple template registration description.
|
|
617
697
|
* @returns A created Apple template registration description.
|
|
618
698
|
*/
|
|
619
|
-
export declare function createAppleTemplateRegistrationDescription(description:
|
|
699
|
+
export declare function createAppleTemplateRegistrationDescription(description: AppleTemplateRegistrationDescriptionCommon): AppleTemplateRegistrationDescription;
|
|
620
700
|
/**
|
|
621
701
|
* Creates a Baidu based installation.
|
|
622
702
|
* @param installation - A partial installation used to create the Baidu installation.
|
|
623
703
|
* @returns The newly created Baidu installation.
|
|
624
704
|
*/
|
|
625
|
-
export declare function createBaiduInstallation(installation:
|
|
705
|
+
export declare function createBaiduInstallation(installation: DeviceTokenInstallation): BaiduInstallation;
|
|
626
706
|
/**
|
|
627
707
|
* Creates a notification to send to a Baidu registered device.
|
|
628
708
|
* @param notification - A partial message used to create a message for Baidu.
|
|
629
709
|
* @returns A newly created Baidu.
|
|
630
710
|
*/
|
|
631
|
-
export declare function createBaiduNotification(notification:
|
|
711
|
+
export declare function createBaiduNotification(notification: NotificationCommon): BaiduNotification;
|
|
712
|
+
/**
|
|
713
|
+
* Creates a BaiduNotification from a native Baidu payload.
|
|
714
|
+
* @param nativeMessage - The native message payload to send to Notification Hubs.
|
|
715
|
+
* @returns The JSON body to send to Notification Hubs.
|
|
716
|
+
*/
|
|
717
|
+
export declare function createBaiduNotificationBody(nativeMessage: BaiduNativeMessage): string;
|
|
632
718
|
/**
|
|
633
719
|
* Creates a Baidu registration description.
|
|
634
720
|
* @param description - A partial Baidu registration description.
|
|
635
721
|
* @returns A created Baidu registration description.
|
|
636
722
|
*/
|
|
637
|
-
export declare function createBaiduRegistrationDescription(description:
|
|
723
|
+
export declare function createBaiduRegistrationDescription(description: BaiduRegistrationDescriptionCommon): BaiduRegistrationDescription;
|
|
638
724
|
/**
|
|
639
725
|
* Creates a Baidu template registration description.
|
|
640
726
|
* @param description - A partial Baidu template registration description.
|
|
641
727
|
* @returns A created Baidu template registration description.
|
|
642
728
|
*/
|
|
643
|
-
export declare function createBaiduTemplateRegistrationDescription(description:
|
|
729
|
+
export declare function createBaiduTemplateRegistrationDescription(description: BaiduTemplateRegistrationDescriptionCommon): BaiduTemplateRegistrationDescription;
|
|
644
730
|
/**
|
|
645
731
|
* Creates a Web Push based installation.
|
|
646
732
|
* @param installation - A partial installation used to create the Web Push installation.
|
|
647
733
|
* @returns The newly created Web Push installation.
|
|
648
734
|
*/
|
|
649
|
-
export declare function createBrowserInstallation(installation:
|
|
735
|
+
export declare function createBrowserInstallation(installation: BrowserInstallationCommon): BrowserInstallation;
|
|
650
736
|
/**
|
|
651
737
|
* Creates a notification to send to a browser.
|
|
652
738
|
* @param notification - A partial message used to create a message for a browser.
|
|
653
739
|
* @returns A newly created Web Push browser.
|
|
654
740
|
*/
|
|
655
|
-
export declare function createBrowserNotification(notification:
|
|
741
|
+
export declare function createBrowserNotification(notification: NotificationCommon): BrowserNotification;
|
|
656
742
|
/**
|
|
657
743
|
* Creates a Web Push registration description.
|
|
658
744
|
* @param description - A partial Web Push registration description.
|
|
659
745
|
* @returns A created Web Push registration description.
|
|
660
746
|
*/
|
|
661
|
-
export declare function createBrowserRegistrationDescription(description:
|
|
747
|
+
export declare function createBrowserRegistrationDescription(description: BrowserRegistrationDescriptionCommon): BrowserRegistrationDescription;
|
|
662
748
|
/**
|
|
663
749
|
* Creates a Web Push registration description.
|
|
664
750
|
* @param description - A partial Web Push template registration description.
|
|
665
751
|
* @returns A created Web Push template registration description.
|
|
666
752
|
*/
|
|
667
|
-
export declare function createBrowserTemplateRegistrationDescription(description:
|
|
753
|
+
export declare function createBrowserTemplateRegistrationDescription(description: BrowserTemplateRegistrationDescriptionCommon): BrowserTemplateRegistrationDescription;
|
|
668
754
|
/**
|
|
669
755
|
* Creates a Firebase legacy HTTP based installation.
|
|
670
756
|
* @param installation - A partial installation used to create the Firebase Legacy HTTP installation.
|
|
671
757
|
* @returns The newly created Baidu installation.
|
|
672
758
|
*/
|
|
673
|
-
export declare function createFcmLegacyInstallation(installation:
|
|
759
|
+
export declare function createFcmLegacyInstallation(installation: DeviceTokenInstallation): FcmLegacyInstallation;
|
|
674
760
|
/**
|
|
675
761
|
* Creates a notification to send to Firebase.
|
|
676
762
|
* @param notification - A partial message used to create a message for Firebase.
|
|
677
763
|
* @returns A newly created Firebase.
|
|
678
764
|
*/
|
|
679
|
-
export declare function createFcmLegacyNotification(notification:
|
|
765
|
+
export declare function createFcmLegacyNotification(notification: NotificationCommon): FcmLegacyNotification;
|
|
680
766
|
/**
|
|
681
767
|
* Creates a Firebase Legacy registration description.
|
|
682
768
|
* @param description - A partial GCM registration description.
|
|
683
769
|
* @returns A created GCM registration description.
|
|
684
770
|
*/
|
|
685
|
-
export declare function createFcmLegacyRegistrationDescription(description:
|
|
771
|
+
export declare function createFcmLegacyRegistrationDescription(description: GcmRegistrationDescriptionCommon): GcmRegistrationDescription;
|
|
686
772
|
/**
|
|
687
773
|
* Creates a GCM template registration description.
|
|
688
774
|
* @param description - A partial GCM template registration description.
|
|
689
775
|
* @returns A created GCM template registration description.
|
|
690
776
|
*/
|
|
691
|
-
export declare function createFcmLegacyTemplateRegistrationDescription(description:
|
|
777
|
+
export declare function createFcmLegacyTemplateRegistrationDescription(description: GcmTemplateRegistrationDescriptionCommon): GcmTemplateRegistrationDescription;
|
|
778
|
+
/**
|
|
779
|
+
* Creates a FcmLegacyNotification from a native Firebase payload.
|
|
780
|
+
* @param nativeMessage - The native message payload to send to Notification Hubs.
|
|
781
|
+
* @returns The JSON body to send to Notification Hubs.
|
|
782
|
+
*/
|
|
783
|
+
export declare function createFirebaseLegacyNotificationBody(nativeMessage: FirebaseLegacyNativeMessage): string;
|
|
784
|
+
/**
|
|
785
|
+
* Creates a tag expression from a list of tags as a || expression.
|
|
786
|
+
* @param tags - The tags to create the || expression
|
|
787
|
+
* @returns The tag expression made from the array of strings into an || expression.
|
|
788
|
+
*/
|
|
789
|
+
export declare function createTagExpression(tags: string[]): string;
|
|
692
790
|
/**
|
|
693
791
|
* Creates a notification to send to Firebase.
|
|
694
792
|
* @param notification - A partial message used to create a message for Firebase.
|
|
695
793
|
* @returns A newly created Firebase.
|
|
696
794
|
*/
|
|
697
|
-
export declare function createTemplateNotification(notification:
|
|
795
|
+
export declare function createTemplateNotification(notification: NotificationCommon): TemplateNotification;
|
|
698
796
|
/**
|
|
699
797
|
* Creates a badge message to send to WNS.
|
|
700
798
|
* @param notification - A partial message used to create a badge message for WNS.
|
|
701
799
|
* @returns A newly created WNS badge.
|
|
702
800
|
*/
|
|
703
|
-
export declare function createWindowsBadgeNotification(notification:
|
|
801
|
+
export declare function createWindowsBadgeNotification(notification: NotificationCommon): WindowsNotification;
|
|
802
|
+
/**
|
|
803
|
+
* Builds a WindowsNotification from a Windows Badge.
|
|
804
|
+
* @param nativeMessage - The Windows Badge Message to build.
|
|
805
|
+
* @returns The WNS XML created with the badge information.
|
|
806
|
+
*/
|
|
807
|
+
export declare function createWindowsBadgeNotificationBody(nativeMessage: WindowsBadgeNativeMessage): string;
|
|
704
808
|
/**
|
|
705
809
|
* Creates a Windows Notification Services (WNS) based installation.
|
|
706
810
|
* @param installation - A partial installation used to create the WNS installation.
|
|
707
811
|
* @returns The newly created WNS installation.
|
|
708
812
|
*/
|
|
709
|
-
export declare function createWindowsInstallation(installation:
|
|
813
|
+
export declare function createWindowsInstallation(installation: DeviceTokenInstallation): WindowsInstallation;
|
|
710
814
|
/**
|
|
711
815
|
* Creates a notification to send to WNS in wns/raw format..
|
|
712
816
|
* @param notification - A partial message used to create a message for WNS in XML format.
|
|
713
817
|
* @returns A newly created WNS message using XML.
|
|
714
818
|
*/
|
|
715
|
-
export declare function createWindowsRawNotification(notification:
|
|
819
|
+
export declare function createWindowsRawNotification(notification: NotificationCommon): WindowsNotification;
|
|
716
820
|
/**
|
|
717
821
|
* Creates a Windows registration description.
|
|
718
822
|
* @param description - A partial Windows registration description.
|
|
719
823
|
* @returns A created Windows registration description.
|
|
720
824
|
*/
|
|
721
|
-
export declare function createWindowsRegistrationDescription(description:
|
|
825
|
+
export declare function createWindowsRegistrationDescription(description: WindowsRegistrationDescriptionCommon): WindowsRegistrationDescription;
|
|
722
826
|
/**
|
|
723
827
|
* Creates a Windows template registration description.
|
|
724
828
|
* @param description - A partial Windows template registration description.
|
|
725
829
|
* @returns A created Windows template registration description.
|
|
726
830
|
*/
|
|
727
|
-
export declare function createWindowsTemplateRegistrationDescription(description:
|
|
831
|
+
export declare function createWindowsTemplateRegistrationDescription(description: WindowsTemplateRegistrationDescriptionCommon): WindowsTemplateRegistrationDescription;
|
|
728
832
|
/**
|
|
729
833
|
* Creates a tile message to send to WNS.
|
|
730
834
|
* @param notification - A partial message used to create a tile message for WNS.
|
|
731
835
|
* @returns A newly created WNS tile.
|
|
732
836
|
*/
|
|
733
|
-
export declare function createWindowsTileNotification(notification:
|
|
837
|
+
export declare function createWindowsTileNotification(notification: NotificationCommon): WindowsNotification;
|
|
734
838
|
/**
|
|
735
839
|
* Creates a toast message to send to WNS.
|
|
736
840
|
* @param notification - A partial message used to create a toast message for WNS.
|
|
737
841
|
* @returns A newly created WNS toast.
|
|
738
842
|
*/
|
|
739
|
-
export declare function createWindowsToastNotification(notification:
|
|
843
|
+
export declare function createWindowsToastNotification(notification: NotificationCommon): WindowsNotification;
|
|
740
844
|
/**
|
|
741
845
|
* Represents an installation with a string based device token.
|
|
742
846
|
*/
|
|
@@ -797,7 +901,7 @@ export declare interface FirebaseLegacyAndroidNativePayload {
|
|
|
797
901
|
/**
|
|
798
902
|
* The notification's channel ID.
|
|
799
903
|
*/
|
|
800
|
-
|
|
904
|
+
android_channel_id?: string;
|
|
801
905
|
/**
|
|
802
906
|
* The notification's icon.
|
|
803
907
|
*/
|
|
@@ -817,23 +921,23 @@ export declare interface FirebaseLegacyAndroidNativePayload {
|
|
|
817
921
|
/**
|
|
818
922
|
* The action associated with a user click on the notification.
|
|
819
923
|
*/
|
|
820
|
-
|
|
924
|
+
click_action?: string;
|
|
821
925
|
/**
|
|
822
926
|
* 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.
|
|
823
927
|
*/
|
|
824
|
-
|
|
928
|
+
body_loc_key?: string;
|
|
825
929
|
/**
|
|
826
930
|
* 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.
|
|
827
931
|
*/
|
|
828
|
-
|
|
932
|
+
body_loc_args?: string[];
|
|
829
933
|
/**
|
|
830
934
|
* 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.
|
|
831
935
|
*/
|
|
832
|
-
|
|
936
|
+
title_loc_key?: string;
|
|
833
937
|
/**
|
|
834
938
|
* 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.
|
|
835
939
|
*/
|
|
836
|
-
|
|
940
|
+
title_loc_args?: string[];
|
|
837
941
|
}
|
|
838
942
|
/**
|
|
839
943
|
* Represents an APNs native payload for the Firebase Legacy HTTP interface.
|
|
@@ -858,7 +962,7 @@ export declare interface FirebaseLegacyAppleNativePayload {
|
|
|
858
962
|
/**
|
|
859
963
|
* The action associated with a user click on the notification which corresponds to the APNs category.
|
|
860
964
|
*/
|
|
861
|
-
|
|
965
|
+
click_action?: string;
|
|
862
966
|
/**
|
|
863
967
|
* The notification's subtitle.
|
|
864
968
|
*/
|
|
@@ -866,19 +970,19 @@ export declare interface FirebaseLegacyAppleNativePayload {
|
|
|
866
970
|
/**
|
|
867
971
|
* 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.
|
|
868
972
|
*/
|
|
869
|
-
|
|
973
|
+
body_loc_key?: string;
|
|
870
974
|
/**
|
|
871
975
|
* 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.
|
|
872
976
|
*/
|
|
873
|
-
|
|
977
|
+
body_loc_args?: string[];
|
|
874
978
|
/**
|
|
875
979
|
* 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.
|
|
876
980
|
*/
|
|
877
|
-
|
|
981
|
+
title_loc_key?: string;
|
|
878
982
|
/**
|
|
879
983
|
* 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.
|
|
880
984
|
*/
|
|
881
|
-
|
|
985
|
+
title_loc_args?: string[];
|
|
882
986
|
}
|
|
883
987
|
/**
|
|
884
988
|
* Represents the targets, options, and payload for HTTP JSON messages for the Firebase Legacy HTTP interface.
|
|
@@ -891,7 +995,7 @@ export declare interface FirebaseLegacyNativeMessage {
|
|
|
891
995
|
/**
|
|
892
996
|
* The recipient of a multicast message, a message sent to more than one registration token.
|
|
893
997
|
*/
|
|
894
|
-
|
|
998
|
+
registration_ids?: string[];
|
|
895
999
|
/**
|
|
896
1000
|
* A logical expression of conditions that determine the message target.
|
|
897
1001
|
*/
|
|
@@ -899,7 +1003,7 @@ export declare interface FirebaseLegacyNativeMessage {
|
|
|
899
1003
|
/**
|
|
900
1004
|
* Used to identify a group of messages.
|
|
901
1005
|
*/
|
|
902
|
-
|
|
1006
|
+
collapse_key?: string;
|
|
903
1007
|
/**
|
|
904
1008
|
* The priority of the message.
|
|
905
1009
|
*/
|
|
@@ -908,24 +1012,24 @@ export declare interface FirebaseLegacyNativeMessage {
|
|
|
908
1012
|
* The background notification flag. To perform a silent background update,
|
|
909
1013
|
* specify the value 1 and don’t include the alert, badge, or sound keys in your payload.
|
|
910
1014
|
*/
|
|
911
|
-
|
|
1015
|
+
content_available?: boolean;
|
|
912
1016
|
/**
|
|
913
1017
|
* The notification service app extension flag. If the value is 1, the system passes
|
|
914
1018
|
* the notification to your notification service app extension before delivery.
|
|
915
1019
|
*/
|
|
916
|
-
|
|
1020
|
+
mutable_content?: number;
|
|
917
1021
|
/**
|
|
918
1022
|
* Specifies how long (in seconds) the message should be kept in FCM storage if the device is offline
|
|
919
1023
|
*/
|
|
920
|
-
|
|
1024
|
+
time_to_live?: number;
|
|
921
1025
|
/**
|
|
922
1026
|
* The package name of the application where the registration tokens must match in order to receive the message.
|
|
923
1027
|
*/
|
|
924
|
-
|
|
1028
|
+
restricted_package_name?: string;
|
|
925
1029
|
/**
|
|
926
1030
|
* When set to true, allows developers to test a request without actually sending a message.
|
|
927
1031
|
*/
|
|
928
|
-
|
|
1032
|
+
dry_run?: boolean;
|
|
929
1033
|
/**
|
|
930
1034
|
* Custom key-value pairs of the message's payload.
|
|
931
1035
|
*/
|
|
@@ -935,6 +1039,19 @@ export declare interface FirebaseLegacyNativeMessage {
|
|
|
935
1039
|
*/
|
|
936
1040
|
notification?: FirebaseLegacyAppleNativePayload | FirebaseLegacyAndroidNativePayload | FirebaseLegacyWebNativePayload;
|
|
937
1041
|
}
|
|
1042
|
+
/**
|
|
1043
|
+
* Describes an Firebase Legacy Registration channel query.
|
|
1044
|
+
*/
|
|
1045
|
+
export declare interface FirebaseLegacyRegistrationChannel {
|
|
1046
|
+
/**
|
|
1047
|
+
* The FCM Legacy registration ID.
|
|
1048
|
+
*/
|
|
1049
|
+
gcmRegistrationId: string;
|
|
1050
|
+
/**
|
|
1051
|
+
* The kind of the registration channel.
|
|
1052
|
+
*/
|
|
1053
|
+
kind: "gcm";
|
|
1054
|
+
}
|
|
938
1055
|
/**
|
|
939
1056
|
* Represents an Web Push native payload for the Firebase Legacy HTTP interface.
|
|
940
1057
|
*/
|
|
@@ -954,29 +1071,39 @@ export declare interface FirebaseLegacyWebNativePayload {
|
|
|
954
1071
|
/**
|
|
955
1072
|
* The action associated with a user click on the notification.
|
|
956
1073
|
*/
|
|
957
|
-
|
|
1074
|
+
click_action?: string;
|
|
958
1075
|
}
|
|
959
1076
|
/**
|
|
960
1077
|
* Represents Notification Hub registration description for Google Cloud Messaging.
|
|
961
1078
|
*/
|
|
962
|
-
export declare interface GcmRegistrationDescription extends
|
|
1079
|
+
export declare interface GcmRegistrationDescription extends GcmRegistrationDescriptionCommon {
|
|
963
1080
|
/**
|
|
964
|
-
*
|
|
1081
|
+
* The kind of the registration.
|
|
965
1082
|
*/
|
|
966
|
-
|
|
1083
|
+
kind: "Gcm";
|
|
1084
|
+
}
|
|
1085
|
+
/**
|
|
1086
|
+
* Represents Notification Hub registration description for Google Cloud Messaging.
|
|
1087
|
+
*/
|
|
1088
|
+
export declare interface GcmRegistrationDescriptionCommon extends RegistrationDescriptionCommon {
|
|
967
1089
|
/**
|
|
968
|
-
*
|
|
1090
|
+
* Registration id obtained from the Google Cloud Messaging service.
|
|
969
1091
|
*/
|
|
970
|
-
|
|
1092
|
+
gcmRegistrationId: string;
|
|
971
1093
|
}
|
|
972
1094
|
/**
|
|
973
1095
|
* Represents Notification Hub template registration description for Firebase Legacy Cloud Messaging.
|
|
974
1096
|
*/
|
|
975
|
-
export declare interface GcmTemplateRegistrationDescription extends
|
|
1097
|
+
export declare interface GcmTemplateRegistrationDescription extends GcmTemplateRegistrationDescriptionCommon {
|
|
976
1098
|
/**
|
|
977
|
-
* The
|
|
1099
|
+
* The kind of the registration.
|
|
978
1100
|
*/
|
|
979
|
-
|
|
1101
|
+
kind: "GcmTemplate";
|
|
1102
|
+
}
|
|
1103
|
+
/**
|
|
1104
|
+
* Represents Notification Hub template registration description for Firebase Legacy Cloud Messaging.
|
|
1105
|
+
*/
|
|
1106
|
+
export declare interface GcmTemplateRegistrationDescriptionCommon extends GcmRegistrationDescriptionCommon, TemplateRegistrationDescription {
|
|
980
1107
|
}
|
|
981
1108
|
/**
|
|
982
1109
|
* Represents the types of installations available in Notification Hubs.
|
|
@@ -1002,10 +1129,6 @@ export declare interface InstallationCommon {
|
|
|
1002
1129
|
* The last update date of the installation.
|
|
1003
1130
|
*/
|
|
1004
1131
|
readonly lastUpdate?: string;
|
|
1005
|
-
/**
|
|
1006
|
-
* The platform for the installation.
|
|
1007
|
-
*/
|
|
1008
|
-
platform: "apns" | "adm" | "baidu" | "browser" | "gcm" | "wns";
|
|
1009
1132
|
/**
|
|
1010
1133
|
* The tags used for targeting this installation.
|
|
1011
1134
|
*/
|
|
@@ -1066,29 +1189,55 @@ export declare type JsonPatchOperation = "add" | "remove" | "replace";
|
|
|
1066
1189
|
* Represents a Windows Phone Notification Services registration description.
|
|
1067
1190
|
* @deprecated Windows Phone is no longer supported.
|
|
1068
1191
|
*/
|
|
1069
|
-
export declare interface MpnsRegistrationDescription extends
|
|
1192
|
+
export declare interface MpnsRegistrationDescription extends MpnsRegistrationDescriptionCommon {
|
|
1070
1193
|
/**
|
|
1071
|
-
* The
|
|
1194
|
+
* The kind of the registration.
|
|
1072
1195
|
*/
|
|
1073
|
-
|
|
1196
|
+
kind: "Mpns";
|
|
1197
|
+
}
|
|
1198
|
+
/**
|
|
1199
|
+
* Represents a Windows Phone Notification Services registration description.
|
|
1200
|
+
* @deprecated Windows Phone is no longer supported.
|
|
1201
|
+
*/
|
|
1202
|
+
export declare interface MpnsRegistrationDescriptionCommon extends RegistrationDescriptionCommon {
|
|
1074
1203
|
/**
|
|
1075
|
-
* The
|
|
1204
|
+
* The channel URI.
|
|
1076
1205
|
*/
|
|
1077
|
-
|
|
1206
|
+
channelUri: string;
|
|
1078
1207
|
}
|
|
1079
1208
|
/**
|
|
1080
1209
|
* Represents a Windows Phone Notification Services template registration.
|
|
1081
1210
|
* @deprecated Windows Phone is no longer supported.
|
|
1082
1211
|
*/
|
|
1083
|
-
export declare interface MpnsTemplateRegistrationDescription extends
|
|
1212
|
+
export declare interface MpnsTemplateRegistrationDescription extends MpnsRegistrationDescriptionCommon, TemplateRegistrationDescription {
|
|
1084
1213
|
/**
|
|
1085
1214
|
* The WNS headers.
|
|
1086
1215
|
*/
|
|
1087
1216
|
mpnsHeaders?: Record<string, string>;
|
|
1088
1217
|
/**
|
|
1089
|
-
* The
|
|
1218
|
+
* The kind of the registration.
|
|
1219
|
+
*/
|
|
1220
|
+
kind: "MpnsTemplate";
|
|
1221
|
+
}
|
|
1222
|
+
/**
|
|
1223
|
+
* Represents a Windows Phone Notification Services template registration.
|
|
1224
|
+
* @deprecated Windows Phone is no longer supported.
|
|
1225
|
+
*/
|
|
1226
|
+
export declare interface MpnsTemplateRegistrationDescription extends MpnsTemplateRegistrationDescriptionCommon {
|
|
1227
|
+
/**
|
|
1228
|
+
* The kind of the registration.
|
|
1090
1229
|
*/
|
|
1091
|
-
|
|
1230
|
+
kind: "MpnsTemplate";
|
|
1231
|
+
}
|
|
1232
|
+
/**
|
|
1233
|
+
* Represents a Windows Phone Notification Services template registration.
|
|
1234
|
+
* @deprecated Windows Phone is no longer supported.
|
|
1235
|
+
*/
|
|
1236
|
+
export declare interface MpnsTemplateRegistrationDescriptionCommon extends MpnsRegistrationDescriptionCommon, TemplateRegistrationDescription {
|
|
1237
|
+
/**
|
|
1238
|
+
* The WNS headers.
|
|
1239
|
+
*/
|
|
1240
|
+
mpnsHeaders?: Record<string, string>;
|
|
1092
1241
|
}
|
|
1093
1242
|
/**
|
|
1094
1243
|
* Represents the possible push notification messages types.
|
|
@@ -1106,14 +1255,6 @@ export declare interface NotificationCommon {
|
|
|
1106
1255
|
* The headers to include for the push notification.
|
|
1107
1256
|
*/
|
|
1108
1257
|
headers?: Record<string, string>;
|
|
1109
|
-
/**
|
|
1110
|
-
* The platform for the push notification.
|
|
1111
|
-
*/
|
|
1112
|
-
platform: string;
|
|
1113
|
-
/**
|
|
1114
|
-
* The content type for the push notification.
|
|
1115
|
-
*/
|
|
1116
|
-
contentType: string;
|
|
1117
1258
|
}
|
|
1118
1259
|
/**
|
|
1119
1260
|
* Represents Notification details.
|
|
@@ -1162,27 +1303,27 @@ export declare interface NotificationDetails {
|
|
|
1162
1303
|
/**
|
|
1163
1304
|
* APNs outcomes counts per state.
|
|
1164
1305
|
*/
|
|
1165
|
-
apnsOutcomeCounts?:
|
|
1306
|
+
apnsOutcomeCounts?: NotificationOutcome[];
|
|
1166
1307
|
/**
|
|
1167
1308
|
* WNS outcomes counts per state.
|
|
1168
1309
|
*/
|
|
1169
|
-
wnsOutcomeCounts?:
|
|
1310
|
+
wnsOutcomeCounts?: NotificationOutcome[];
|
|
1170
1311
|
/**
|
|
1171
1312
|
* FCM outcome counts per state.
|
|
1172
1313
|
*/
|
|
1173
|
-
fcmOutcomeCounts?:
|
|
1314
|
+
fcmOutcomeCounts?: NotificationOutcome[];
|
|
1174
1315
|
/**
|
|
1175
1316
|
* ADM outcome counts per state.
|
|
1176
1317
|
*/
|
|
1177
|
-
admOutcomeCounts?:
|
|
1318
|
+
admOutcomeCounts?: NotificationOutcome[];
|
|
1178
1319
|
/**
|
|
1179
1320
|
* Baidu outcome counts per state.
|
|
1180
1321
|
*/
|
|
1181
|
-
baiduOutcomeCounts?:
|
|
1322
|
+
baiduOutcomeCounts?: NotificationOutcome[];
|
|
1182
1323
|
/**
|
|
1183
1324
|
* Web Push outcome counts per state.
|
|
1184
1325
|
*/
|
|
1185
|
-
browserOutcomeCounts?:
|
|
1326
|
+
browserOutcomeCounts?: NotificationOutcome[];
|
|
1186
1327
|
}
|
|
1187
1328
|
/**
|
|
1188
1329
|
* Represents a Notification Hub Job.
|
|
@@ -1291,58 +1432,11 @@ export declare type NotificationHubJobType =
|
|
|
1291
1432
|
* Job type to bulk upsert registrations.
|
|
1292
1433
|
*/
|
|
1293
1434
|
| "ImportUpsertRegistrations";
|
|
1294
|
-
/**
|
|
1295
|
-
* Describes the options that can be provided while creating the NotificationHubsClientContext.
|
|
1296
|
-
*/
|
|
1297
|
-
export declare interface NotificationHubsClientOptions extends CommonClientOptions {
|
|
1298
|
-
}
|
|
1299
|
-
/**
|
|
1300
|
-
* Describes a response from the Notification Hubs service for send operations.
|
|
1301
|
-
*/
|
|
1302
|
-
export declare interface NotificationHubsMessageResponse extends NotificationHubsResponse {
|
|
1303
|
-
/**
|
|
1304
|
-
* The notification ID from the operation. Note this is only available in Standard SKU and above.
|
|
1305
|
-
*/
|
|
1306
|
-
notificationId?: string;
|
|
1307
|
-
/**
|
|
1308
|
-
* The number of devices that successfully received the notification.
|
|
1309
|
-
*/
|
|
1310
|
-
success: number;
|
|
1311
|
-
/**
|
|
1312
|
-
* The number of devices that failed to receive a notification.
|
|
1313
|
-
*/
|
|
1314
|
-
failure: number;
|
|
1315
|
-
/**
|
|
1316
|
-
* The list of notification outcome results for each device registered with the hub, to which this notification was sent.
|
|
1317
|
-
*/
|
|
1318
|
-
results: RegistrationResult[];
|
|
1319
|
-
/**
|
|
1320
|
-
* The state of this notification outcome.
|
|
1321
|
-
*/
|
|
1322
|
-
state: NotificationOutcomeState;
|
|
1323
|
-
}
|
|
1324
|
-
/**
|
|
1325
|
-
* Describes a response from the Notification Hubs which includes a tracking ID, correlation ID and location.
|
|
1326
|
-
*/
|
|
1327
|
-
export declare interface NotificationHubsResponse {
|
|
1328
|
-
/**
|
|
1329
|
-
* The Tracking ID of the operation.
|
|
1330
|
-
*/
|
|
1331
|
-
trackingId?: string;
|
|
1332
|
-
/**
|
|
1333
|
-
* The correlation ID of the operation.
|
|
1334
|
-
*/
|
|
1335
|
-
correlationId?: string;
|
|
1336
|
-
/**
|
|
1337
|
-
* The location of the operation.
|
|
1338
|
-
*/
|
|
1339
|
-
location?: string;
|
|
1340
|
-
}
|
|
1341
1435
|
/**
|
|
1342
1436
|
* This represents a client for Azure Notification Hubs to manage installations and send
|
|
1343
1437
|
* messages to devices.
|
|
1344
1438
|
*/
|
|
1345
|
-
export declare class
|
|
1439
|
+
export declare class NotificationHubsClient {
|
|
1346
1440
|
private _client;
|
|
1347
1441
|
/**
|
|
1348
1442
|
* Creates a new instance of the NotificationClient with a connection string, hub name and options.
|
|
@@ -1425,10 +1519,17 @@ export declare class NotificationHubsServiceClient {
|
|
|
1425
1519
|
getRegistration(registrationId: string, options?: OperationOptions): Promise<RegistrationDescription>;
|
|
1426
1520
|
/**
|
|
1427
1521
|
* Gets all registrations for the notification hub with the given query options.
|
|
1428
|
-
* @param options - The options for querying the registrations such as $top
|
|
1522
|
+
* @param options - The options for querying the registrations such as $top.
|
|
1523
|
+
* @returns A paged async iterable containing all of the registrations for the notification hub.
|
|
1524
|
+
*/
|
|
1525
|
+
listRegistrations(options?: RegistrationQueryLimitOptions): PagedAsyncIterableIterator<RegistrationDescription>;
|
|
1526
|
+
/**
|
|
1527
|
+
* Gets all registrations for the notification hub with the given device information and options.
|
|
1528
|
+
* @param channel - The registration channel information to query per PNS type.
|
|
1529
|
+
* @param options - The options for querying the registrations such as $top.
|
|
1429
1530
|
* @returns A paged async iterable containing all of the registrations for the notification hub.
|
|
1430
1531
|
*/
|
|
1431
|
-
|
|
1532
|
+
listRegistrationsByChannel(channel: RegistrationChannel, options?: RegistrationQueryLimitOptions): PagedAsyncIterableIterator<RegistrationDescription>;
|
|
1432
1533
|
/**
|
|
1433
1534
|
* Lists all registrations with the matching tag.
|
|
1434
1535
|
* @param tag - The tag to query for matching registrations.
|
|
@@ -1502,10 +1603,57 @@ export declare class NotificationHubsServiceClient {
|
|
|
1502
1603
|
*/
|
|
1503
1604
|
listNotificationHubJobs(options?: OperationOptions): Promise<NotificationHubJob[]>;
|
|
1504
1605
|
}
|
|
1606
|
+
/**
|
|
1607
|
+
* Describes the options that can be provided while creating the NotificationHubsClientContext.
|
|
1608
|
+
*/
|
|
1609
|
+
export declare interface NotificationHubsClientOptions extends CommonClientOptions {
|
|
1610
|
+
}
|
|
1611
|
+
/**
|
|
1612
|
+
* Describes a response from the Notification Hubs service for send operations.
|
|
1613
|
+
*/
|
|
1614
|
+
export declare interface NotificationHubsMessageResponse extends NotificationHubsResponse {
|
|
1615
|
+
/**
|
|
1616
|
+
* The notification ID from the operation. Note this is only available in Standard SKU and above.
|
|
1617
|
+
*/
|
|
1618
|
+
notificationId?: string;
|
|
1619
|
+
/**
|
|
1620
|
+
* The number of devices that successfully received the notification.
|
|
1621
|
+
*/
|
|
1622
|
+
successCount: number;
|
|
1623
|
+
/**
|
|
1624
|
+
* The number of devices that failed to receive a notification.
|
|
1625
|
+
*/
|
|
1626
|
+
failureCount: number;
|
|
1627
|
+
/**
|
|
1628
|
+
* The list of notification outcome results for each device registered with the hub, to which this notification was sent.
|
|
1629
|
+
*/
|
|
1630
|
+
results: RegistrationResult[];
|
|
1631
|
+
/**
|
|
1632
|
+
* The state of this notification outcome.
|
|
1633
|
+
*/
|
|
1634
|
+
state: NotificationOutcomeState;
|
|
1635
|
+
}
|
|
1636
|
+
/**
|
|
1637
|
+
* Describes a response from the Notification Hubs which includes a tracking ID, correlation ID and location.
|
|
1638
|
+
*/
|
|
1639
|
+
export declare interface NotificationHubsResponse {
|
|
1640
|
+
/**
|
|
1641
|
+
* The Tracking ID of the operation.
|
|
1642
|
+
*/
|
|
1643
|
+
trackingId?: string;
|
|
1644
|
+
/**
|
|
1645
|
+
* The correlation ID of the operation.
|
|
1646
|
+
*/
|
|
1647
|
+
correlationId?: string;
|
|
1648
|
+
/**
|
|
1649
|
+
* The location of the operation.
|
|
1650
|
+
*/
|
|
1651
|
+
location?: string;
|
|
1652
|
+
}
|
|
1505
1653
|
/**
|
|
1506
1654
|
* The per platform count per state.
|
|
1507
1655
|
*/
|
|
1508
|
-
export declare interface
|
|
1656
|
+
export declare interface NotificationOutcome {
|
|
1509
1657
|
/**
|
|
1510
1658
|
* The state of the notification.
|
|
1511
1659
|
*/
|
|
@@ -1532,6 +1680,10 @@ export declare interface PolledOperationOptions extends OperationOptions {
|
|
|
1532
1680
|
* Represents the types of push channels available for Notification Hubs.
|
|
1533
1681
|
*/
|
|
1534
1682
|
export declare type PushHandle = BrowserPushChannel | string;
|
|
1683
|
+
/**
|
|
1684
|
+
* Describes a Registration query.
|
|
1685
|
+
*/
|
|
1686
|
+
export declare type RegistrationChannel = AdmRegistrationChannel | AppleRegistrationChannel | BaiduRegistrationChannel | BrowserRegistrationChannel | FirebaseLegacyRegistrationChannel | WindowsRegistrationChannel;
|
|
1535
1687
|
/**
|
|
1536
1688
|
* Describes the types of registration descriptions.
|
|
1537
1689
|
*/
|
|
@@ -1560,10 +1712,6 @@ export declare interface RegistrationDescriptionCommon {
|
|
|
1560
1712
|
* A dictionary of push variables associated with property bag.
|
|
1561
1713
|
*/
|
|
1562
1714
|
pushVariables?: Record<string, string>;
|
|
1563
|
-
/**
|
|
1564
|
-
* The type of the registration.
|
|
1565
|
-
*/
|
|
1566
|
-
type: RegistrationType;
|
|
1567
1715
|
}
|
|
1568
1716
|
/**
|
|
1569
1717
|
* Represents query options to include $top support.
|
|
@@ -1626,20 +1774,20 @@ export declare type RegistrationType = "Adm" | "AdmTemplate" | "Apple" | "AppleT
|
|
|
1626
1774
|
*/
|
|
1627
1775
|
export declare interface ScheduleNotificationOptions extends OperationOptions {
|
|
1628
1776
|
/**
|
|
1629
|
-
*
|
|
1777
|
+
* A tag expression used to target devices. Use the `createTagExpression` function to create a tag expression from an array of tags.
|
|
1630
1778
|
* If not set, this results in a broadcast notification to be scheduled.
|
|
1631
1779
|
*/
|
|
1632
|
-
|
|
1780
|
+
tagExpression?: string;
|
|
1633
1781
|
}
|
|
1634
1782
|
/**
|
|
1635
1783
|
* Options for sending notifications for both tag based send and broadcast send.
|
|
1636
1784
|
*/
|
|
1637
1785
|
export declare interface SendNotificationOptions extends OperationOptions {
|
|
1638
1786
|
/**
|
|
1639
|
-
*
|
|
1787
|
+
* A tag expression used to target devices. Use the `createTagExpression` function to create a tag expression from an array of tags.
|
|
1640
1788
|
* If not set, this results in a broadcast notification to be sent.
|
|
1641
1789
|
*/
|
|
1642
|
-
|
|
1790
|
+
tagExpression?: string;
|
|
1643
1791
|
/**
|
|
1644
1792
|
* Set to true to enable test send.
|
|
1645
1793
|
*/
|
|
@@ -1706,30 +1854,53 @@ export declare interface WindowsNotification extends NotificationCommon {
|
|
|
1706
1854
|
*/
|
|
1707
1855
|
contentType: WindowsContentType;
|
|
1708
1856
|
}
|
|
1857
|
+
/**
|
|
1858
|
+
* Describes an Windows Notification Services Registration channel query.
|
|
1859
|
+
*/
|
|
1860
|
+
export declare interface WindowsRegistrationChannel {
|
|
1861
|
+
/**
|
|
1862
|
+
* The WNS Channel URI.
|
|
1863
|
+
*/
|
|
1864
|
+
channelUri: string;
|
|
1865
|
+
/**
|
|
1866
|
+
* The kind of the registration channel.
|
|
1867
|
+
*/
|
|
1868
|
+
kind: "windows";
|
|
1869
|
+
}
|
|
1870
|
+
/**
|
|
1871
|
+
* Represents a Windows Notification Services (WNS) registration description.
|
|
1872
|
+
*/
|
|
1873
|
+
export declare interface WindowsRegistrationDescription extends WindowsRegistrationDescriptionCommon {
|
|
1874
|
+
/**
|
|
1875
|
+
* The kind of the registration.
|
|
1876
|
+
*/
|
|
1877
|
+
kind: "Windows";
|
|
1878
|
+
}
|
|
1709
1879
|
/**
|
|
1710
1880
|
* Represents a Windows Notification Services (WNS) registration description.
|
|
1711
1881
|
*/
|
|
1712
|
-
export declare interface
|
|
1882
|
+
export declare interface WindowsRegistrationDescriptionCommon extends RegistrationDescriptionCommon {
|
|
1713
1883
|
/**
|
|
1714
1884
|
* The channel URI.
|
|
1715
1885
|
*/
|
|
1716
1886
|
channelUri: string;
|
|
1887
|
+
}
|
|
1888
|
+
/**
|
|
1889
|
+
* Represents a Windows Notification Services (WNS) template registration.
|
|
1890
|
+
*/
|
|
1891
|
+
export declare interface WindowsTemplateRegistrationDescription extends WindowsTemplateRegistrationDescriptionCommon {
|
|
1717
1892
|
/**
|
|
1718
|
-
* The
|
|
1893
|
+
* The kind of the registration.
|
|
1719
1894
|
*/
|
|
1720
|
-
|
|
1895
|
+
kind: "WindowsTemplate";
|
|
1721
1896
|
}
|
|
1722
1897
|
/**
|
|
1723
1898
|
* Represents a Windows Notification Services (WNS) template registration.
|
|
1724
1899
|
*/
|
|
1725
|
-
export declare interface
|
|
1900
|
+
export declare interface WindowsTemplateRegistrationDescriptionCommon extends WindowsRegistrationDescriptionCommon, TemplateRegistrationDescription {
|
|
1726
1901
|
/**
|
|
1727
1902
|
* The WNS headers.
|
|
1728
1903
|
*/
|
|
1729
1904
|
wnsHeaders?: Record<string, string>;
|
|
1730
|
-
/**
|
|
1731
|
-
* The type of the registration.
|
|
1732
|
-
*/
|
|
1733
|
-
type: "WindowsTemplate";
|
|
1734
1905
|
}
|
|
1735
1906
|
export {};
|