@azure/notification-hubs 1.0.0-beta.1
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/LICENSE +21 -0
- package/README.md +749 -0
- package/dist/index.js +2235 -0
- package/dist/index.js.map +1 -0
- package/dist-esm/src/client/cancelScheduledNotification.js +23 -0
- package/dist-esm/src/client/cancelScheduledNotification.js.map +1 -0
- package/dist-esm/src/client/createOrUpdateInstallation.js +24 -0
- package/dist-esm/src/client/createOrUpdateInstallation.js.map +1 -0
- package/dist-esm/src/client/createOrUpdateRegistration.js +17 -0
- package/dist-esm/src/client/createOrUpdateRegistration.js.map +1 -0
- package/dist-esm/src/client/createRegistration.js +24 -0
- package/dist-esm/src/client/createRegistration.js.map +1 -0
- package/dist-esm/src/client/createRegistrationId.js +26 -0
- package/dist-esm/src/client/createRegistrationId.js.map +1 -0
- package/dist-esm/src/client/deleteInstallation.js +22 -0
- package/dist-esm/src/client/deleteInstallation.js.map +1 -0
- package/dist-esm/src/client/deleteRegistration.js +25 -0
- package/dist-esm/src/client/deleteRegistration.js.map +1 -0
- package/dist-esm/src/client/getFeedbackContainerUrl.js +23 -0
- package/dist-esm/src/client/getFeedbackContainerUrl.js.map +1 -0
- package/dist-esm/src/client/getInstallation.js +23 -0
- package/dist-esm/src/client/getInstallation.js.map +1 -0
- package/dist-esm/src/client/getNotificationHubJob.js +24 -0
- package/dist-esm/src/client/getNotificationHubJob.js.map +1 -0
- package/dist-esm/src/client/getNotificationOutcomeDetails.js +24 -0
- package/dist-esm/src/client/getNotificationOutcomeDetails.js.map +1 -0
- package/dist-esm/src/client/getRegistration.js +24 -0
- package/dist-esm/src/client/getRegistration.js.map +1 -0
- package/dist-esm/src/client/index.js +44 -0
- package/dist-esm/src/client/index.js.map +1 -0
- package/dist-esm/src/client/internal/_client.js +75 -0
- package/dist-esm/src/client/internal/_client.js.map +1 -0
- package/dist-esm/src/client/internal/_createOrUpdateRegistrationDescription.js +31 -0
- package/dist-esm/src/client/internal/_createOrUpdateRegistrationDescription.js.map +1 -0
- package/dist-esm/src/client/internal/_scheduleNotificationPayload.js +37 -0
- package/dist-esm/src/client/internal/_scheduleNotificationPayload.js.map +1 -0
- package/dist-esm/src/client/internal/_sendNotificationPayload.js +51 -0
- package/dist-esm/src/client/internal/_sendNotificationPayload.js.map +1 -0
- package/dist-esm/src/client/listNotificationHubJobs.js +23 -0
- package/dist-esm/src/client/listNotificationHubJobs.js.map +1 -0
- package/dist-esm/src/client/listRegistrations.js +89 -0
- package/dist-esm/src/client/listRegistrations.js.map +1 -0
- package/dist-esm/src/client/listRegistrationsByTag.js +87 -0
- package/dist-esm/src/client/listRegistrationsByTag.js.map +1 -0
- package/dist-esm/src/client/scheduleBroadcastNotification.js +17 -0
- package/dist-esm/src/client/scheduleBroadcastNotification.js.map +1 -0
- package/dist-esm/src/client/scheduleNotification.js +18 -0
- package/dist-esm/src/client/scheduleNotification.js.map +1 -0
- package/dist-esm/src/client/sendBroadcastNotification.js +15 -0
- package/dist-esm/src/client/sendBroadcastNotification.js.map +1 -0
- package/dist-esm/src/client/sendDirectNotification.js +16 -0
- package/dist-esm/src/client/sendDirectNotification.js.map +1 -0
- package/dist-esm/src/client/sendNotification.js +16 -0
- package/dist-esm/src/client/sendNotification.js.map +1 -0
- package/dist-esm/src/client/submitNotificationHubJob.js +26 -0
- package/dist-esm/src/client/submitNotificationHubJob.js.map +1 -0
- package/dist-esm/src/client/updateInstallation.js +25 -0
- package/dist-esm/src/client/updateInstallation.js.map +1 -0
- package/dist-esm/src/client/updateRegistration.js +21 -0
- package/dist-esm/src/client/updateRegistration.js.map +1 -0
- package/dist-esm/src/index.js +12 -0
- package/dist-esm/src/index.js.map +1 -0
- package/dist-esm/src/models/installation.js +51 -0
- package/dist-esm/src/models/installation.js.map +1 -0
- package/dist-esm/src/models/notification.js +104 -0
- package/dist-esm/src/models/notification.js.map +1 -0
- package/dist-esm/src/models/notificationBuilder.js +169 -0
- package/dist-esm/src/models/notificationBuilder.js.map +1 -0
- package/dist-esm/src/models/notificationDetails.js +4 -0
- package/dist-esm/src/models/notificationDetails.js.map +1 -0
- package/dist-esm/src/models/notificationHubJob.js +4 -0
- package/dist-esm/src/models/notificationHubJob.js.map +1 -0
- package/dist-esm/src/models/options.js +4 -0
- package/dist-esm/src/models/options.js.map +1 -0
- package/dist-esm/src/models/registration.js +135 -0
- package/dist-esm/src/models/registration.js.map +1 -0
- package/dist-esm/src/models/response.js +4 -0
- package/dist-esm/src/models/response.js.map +1 -0
- package/dist-esm/src/notificationHubsClient.js +251 -0
- package/dist-esm/src/notificationHubsClient.js.map +1 -0
- package/dist-esm/src/serializers/notificationDetailsSerializer.js +58 -0
- package/dist-esm/src/serializers/notificationDetailsSerializer.js.map +1 -0
- package/dist-esm/src/serializers/notificationHubJobSerializer.js +74 -0
- package/dist-esm/src/serializers/notificationHubJobSerializer.js.map +1 -0
- package/dist-esm/src/serializers/registrationSerializer.js +375 -0
- package/dist-esm/src/serializers/registrationSerializer.js.map +1 -0
- package/dist-esm/src/utils/connectionStringUtils.js +37 -0
- package/dist-esm/src/utils/connectionStringUtils.js.map +1 -0
- package/dist-esm/src/utils/constants.js +11 -0
- package/dist-esm/src/utils/constants.js.map +1 -0
- package/dist-esm/src/utils/retryPolicy.js +144 -0
- package/dist-esm/src/utils/retryPolicy.js.map +1 -0
- package/dist-esm/src/utils/tracing.js +13 -0
- package/dist-esm/src/utils/tracing.js.map +1 -0
- package/dist-esm/src/utils/utils.js +130 -0
- package/dist-esm/src/utils/utils.js.map +1 -0
- package/dist-esm/src/utils/xmlUtils.js +101 -0
- package/dist-esm/src/utils/xmlUtils.js.map +1 -0
- package/package.json +144 -0
- package/types/3.1/notification-hubs.d.ts +1728 -0
- package/types/latest/notification-hubs.d.ts +1840 -0
- package/types/latest/tsdoc-metadata.json +11 -0
- package/types/src/client/cancelScheduledNotification.d.ts +13 -0
- package/types/src/client/cancelScheduledNotification.d.ts.map +1 -0
- package/types/src/client/createOrUpdateInstallation.d.ts +13 -0
- package/types/src/client/createOrUpdateInstallation.d.ts.map +1 -0
- package/types/src/client/createOrUpdateRegistration.d.ts +12 -0
- package/types/src/client/createOrUpdateRegistration.d.ts.map +1 -0
- package/types/src/client/createRegistration.d.ts +13 -0
- package/types/src/client/createRegistration.d.ts.map +1 -0
- package/types/src/client/createRegistrationId.d.ts +10 -0
- package/types/src/client/createRegistrationId.d.ts.map +1 -0
- package/types/src/client/deleteInstallation.d.ts +12 -0
- package/types/src/client/deleteInstallation.d.ts.map +1 -0
- package/types/src/client/deleteRegistration.d.ts +12 -0
- package/types/src/client/deleteRegistration.d.ts.map +1 -0
- package/types/src/client/getFeedbackContainerUrl.d.ts +11 -0
- package/types/src/client/getFeedbackContainerUrl.d.ts.map +1 -0
- package/types/src/client/getInstallation.d.ts +12 -0
- package/types/src/client/getInstallation.d.ts.map +1 -0
- package/types/src/client/getNotificationHubJob.d.ts +12 -0
- package/types/src/client/getNotificationHubJob.d.ts.map +1 -0
- package/types/src/client/getNotificationOutcomeDetails.d.ts +13 -0
- package/types/src/client/getNotificationOutcomeDetails.d.ts.map +1 -0
- package/types/src/client/getRegistration.d.ts +12 -0
- package/types/src/client/getRegistration.d.ts.map +1 -0
- package/types/src/client/index.d.ts +41 -0
- package/types/src/client/index.d.ts.map +1 -0
- package/types/src/client/internal/_client.d.ts +26 -0
- package/types/src/client/internal/_client.d.ts.map +1 -0
- package/types/src/client/internal/_createOrUpdateRegistrationDescription.d.ts +8 -0
- package/types/src/client/internal/_createOrUpdateRegistrationDescription.d.ts.map +1 -0
- package/types/src/client/internal/_scheduleNotificationPayload.d.ts +9 -0
- package/types/src/client/internal/_scheduleNotificationPayload.d.ts.map +1 -0
- package/types/src/client/internal/_sendNotificationPayload.d.ts +10 -0
- package/types/src/client/internal/_sendNotificationPayload.d.ts.map +1 -0
- package/types/src/client/listNotificationHubJobs.d.ts +11 -0
- package/types/src/client/listNotificationHubJobs.d.ts.map +1 -0
- package/types/src/client/listRegistrations.d.ts +12 -0
- package/types/src/client/listRegistrations.d.ts.map +1 -0
- package/types/src/client/listRegistrationsByTag.d.ts +13 -0
- package/types/src/client/listRegistrationsByTag.d.ts.map +1 -0
- package/types/src/client/scheduleBroadcastNotification.d.ts +16 -0
- package/types/src/client/scheduleBroadcastNotification.d.ts.map +1 -0
- package/types/src/client/scheduleNotification.d.ts +17 -0
- package/types/src/client/scheduleNotification.d.ts.map +1 -0
- package/types/src/client/sendBroadcastNotification.d.ts +14 -0
- package/types/src/client/sendBroadcastNotification.d.ts.map +1 -0
- package/types/src/client/sendDirectNotification.d.ts +16 -0
- package/types/src/client/sendDirectNotification.d.ts.map +1 -0
- package/types/src/client/sendNotification.d.ts +15 -0
- package/types/src/client/sendNotification.d.ts.map +1 -0
- package/types/src/client/submitNotificationHubJob.d.ts +13 -0
- package/types/src/client/submitNotificationHubJob.d.ts.map +1 -0
- package/types/src/client/updateInstallation.d.ts +14 -0
- package/types/src/client/updateInstallation.d.ts.map +1 -0
- package/types/src/client/updateRegistration.d.ts +12 -0
- package/types/src/client/updateRegistration.d.ts.map +1 -0
- package/types/src/index.d.ts +10 -0
- package/types/src/index.d.ts.map +1 -0
- package/types/src/models/installation.d.ts +200 -0
- package/types/src/models/installation.d.ts.map +1 -0
- package/types/src/models/notification.d.ts +166 -0
- package/types/src/models/notification.d.ts.map +1 -0
- package/types/src/models/notificationBuilder.d.ts +546 -0
- package/types/src/models/notificationBuilder.d.ts.map +1 -0
- package/types/src/models/notificationDetails.d.ts +87 -0
- package/types/src/models/notificationDetails.d.ts.map +1 -0
- package/types/src/models/notificationHubJob.d.ts +104 -0
- package/types/src/models/notificationHubJob.d.ts.map +1 -0
- package/types/src/models/options.d.ts +43 -0
- package/types/src/models/options.d.ts.map +1 -0
- package/types/src/models/registration.d.ts +368 -0
- package/types/src/models/registration.d.ts.map +1 -0
- package/types/src/models/response.d.ts +41 -0
- package/types/src/models/response.d.ts.map +1 -0
- package/types/src/notificationHubsClient.d.ts +190 -0
- package/types/src/notificationHubsClient.d.ts.map +1 -0
- package/types/src/serializers/notificationDetailsSerializer.d.ts +7 -0
- package/types/src/serializers/notificationDetailsSerializer.d.ts.map +1 -0
- package/types/src/serializers/notificationHubJobSerializer.d.ts +21 -0
- package/types/src/serializers/notificationHubJobSerializer.d.ts.map +1 -0
- package/types/src/serializers/registrationSerializer.d.ts +193 -0
- package/types/src/serializers/registrationSerializer.d.ts.map +1 -0
- package/types/src/utils/connectionStringUtils.d.ts +37 -0
- package/types/src/utils/connectionStringUtils.d.ts.map +1 -0
- package/types/src/utils/constants.d.ts +9 -0
- package/types/src/utils/constants.d.ts.map +1 -0
- package/types/src/utils/retryPolicy.d.ts +72 -0
- package/types/src/utils/retryPolicy.d.ts.map +1 -0
- package/types/src/utils/tracing.d.ts +6 -0
- package/types/src/utils/tracing.d.ts.map +1 -0
- package/types/src/utils/utils.d.ts +65 -0
- package/types/src/utils/utils.d.ts.map +1 -0
- package/types/src/utils/xmlUtils.d.ts +46 -0
- package/types/src/utils/xmlUtils.d.ts.map +1 -0
|
@@ -0,0 +1,190 @@
|
|
|
1
|
+
import { Installation, JsonPatch, PushHandle } from "./models/installation.js";
|
|
2
|
+
import { NotificationHubsClientOptions, RegistrationQueryLimitOptions, RegistrationQueryOptions, SendOperationOptions } from "./models/options.js";
|
|
3
|
+
import { NotificationHubsMessageResponse, NotificationHubsResponse } from "./models/response.js";
|
|
4
|
+
import { Notification } from "./models/notification.js";
|
|
5
|
+
import { NotificationDetails } from "./models/notificationDetails.js";
|
|
6
|
+
import { NotificationHubJob } from "./models/notificationHubJob.js";
|
|
7
|
+
import { OperationOptions } from "@azure/core-client";
|
|
8
|
+
import { PagedAsyncIterableIterator } from "@azure/core-paging";
|
|
9
|
+
import { RegistrationDescription } from "./models/registration.js";
|
|
10
|
+
/**
|
|
11
|
+
* This represents a client for Azure Notification Hubs to manage installations and send
|
|
12
|
+
* messages to devices.
|
|
13
|
+
*/
|
|
14
|
+
export declare class NotificationHubsServiceClient {
|
|
15
|
+
private _client;
|
|
16
|
+
/**
|
|
17
|
+
* Creates a new instance of the NotificationClient with a connection string, hub name and options.
|
|
18
|
+
* @param connectionString - The Notification Hub Access Policy connection string.
|
|
19
|
+
* @param hubName - The name of the Azure Notification Hub.
|
|
20
|
+
* @param options - Options for configuring the Azure Notification Hubs client.
|
|
21
|
+
*/
|
|
22
|
+
constructor(connectionString: string, hubName: string, options?: NotificationHubsClientOptions);
|
|
23
|
+
/**
|
|
24
|
+
* Creates or overwrites an installation to a Notification Hub.
|
|
25
|
+
* @param installation - The installation to create or overwrite.
|
|
26
|
+
* @param options - Configuration options for the create or update installation operation.
|
|
27
|
+
* @returns A NotificationHubResponse with the tracking ID, correlation ID and location.
|
|
28
|
+
*/
|
|
29
|
+
createOrUpdateInstallation(installation: Installation, options?: OperationOptions): Promise<NotificationHubsResponse>;
|
|
30
|
+
/**
|
|
31
|
+
* Deletes an installation from a Notification Hub.
|
|
32
|
+
* @param installationId - The installation ID of the installation to delete.
|
|
33
|
+
* @param options - Configuration options for the installation delete operation.
|
|
34
|
+
* @returns A NotificationHubResponse with the tracking ID, correlation ID and location.
|
|
35
|
+
*/
|
|
36
|
+
deleteInstallation(installationId: string, options?: OperationOptions): Promise<NotificationHubsResponse>;
|
|
37
|
+
/**
|
|
38
|
+
* Gets an Azure Notification Hub installation by the installation ID.
|
|
39
|
+
* @param installationId - The ID of the installation to get.
|
|
40
|
+
* @param options - Configuration options for the get installation operation.
|
|
41
|
+
* @returns The installation that matches the installation ID.
|
|
42
|
+
*/
|
|
43
|
+
getInstallation(installationId: string, options?: OperationOptions): Promise<Installation>;
|
|
44
|
+
/**
|
|
45
|
+
* Updates an installation using the JSON-Patch standard in RFC6902.
|
|
46
|
+
* @param installationId - The ID of the installation to update.
|
|
47
|
+
* @param patches - An array of patches following the JSON-Patch standard.
|
|
48
|
+
* @param options - Configuration options for the patch installation operation.
|
|
49
|
+
* @returns A NotificationHubResponse with the tracking ID, correlation ID and location.
|
|
50
|
+
*/
|
|
51
|
+
updateInstallation(installationId: string, patches: JsonPatch[], options?: OperationOptions): Promise<NotificationHubsResponse>;
|
|
52
|
+
/**
|
|
53
|
+
* Creates a new registration ID.
|
|
54
|
+
* @param options - The options for creating a new registration ID.
|
|
55
|
+
* @returns The newly created registration ID.
|
|
56
|
+
*/
|
|
57
|
+
createRegistrationId(options?: OperationOptions): Promise<string>;
|
|
58
|
+
/**
|
|
59
|
+
* Creates a new registration. This method generates a registration ID,
|
|
60
|
+
* which you can subsequently use to retrieve, update, and delete this registration.
|
|
61
|
+
* @param registration - The registration to create.
|
|
62
|
+
* @param options - Options for creating a new registration.
|
|
63
|
+
* @returns The newly created registration description.
|
|
64
|
+
*/
|
|
65
|
+
createRegistration(registration: RegistrationDescription, options?: OperationOptions): Promise<RegistrationDescription>;
|
|
66
|
+
/**
|
|
67
|
+
* Creates or updates a registration.
|
|
68
|
+
* @param registration - The registration to create or update.
|
|
69
|
+
* @param options - The operation options.
|
|
70
|
+
* @returns The created or updated registration description.
|
|
71
|
+
*/
|
|
72
|
+
createOrUpdateRegistration(registration: RegistrationDescription, options?: OperationOptions): Promise<RegistrationDescription>;
|
|
73
|
+
/**
|
|
74
|
+
* Updates an existing registration.
|
|
75
|
+
* @param registration - The registration to update.
|
|
76
|
+
* @param options - The operation options.
|
|
77
|
+
* @returns The updated registration description.
|
|
78
|
+
*/
|
|
79
|
+
updateRegistration(registration: RegistrationDescription, options?: OperationOptions): Promise<RegistrationDescription>;
|
|
80
|
+
/**
|
|
81
|
+
* Gets a registration by the given registration ID.
|
|
82
|
+
* @param registrationId - The ID of the registration to get.
|
|
83
|
+
* @param options - The options for getting a registration by ID.
|
|
84
|
+
* @returns A RegistrationDescription that has the given registration ID.
|
|
85
|
+
*/
|
|
86
|
+
getRegistration(registrationId: string, options?: OperationOptions): Promise<RegistrationDescription>;
|
|
87
|
+
/**
|
|
88
|
+
* Gets all registrations for the notification hub with the given query options.
|
|
89
|
+
* @param options - The options for querying the registrations such as $top and $filter.
|
|
90
|
+
* @returns A paged async iterable containing all of the registrations for the notification hub.
|
|
91
|
+
*/
|
|
92
|
+
listRegistrations(options?: RegistrationQueryOptions): PagedAsyncIterableIterator<RegistrationDescription>;
|
|
93
|
+
/**
|
|
94
|
+
* Lists all registrations with the matching tag.
|
|
95
|
+
* @param tag - The tag to query for matching registrations.
|
|
96
|
+
* @param options - The query options such as $top.
|
|
97
|
+
* @returns A paged async iterable containing the matching registrations for the notification hub.
|
|
98
|
+
*/
|
|
99
|
+
listRegistrationsByTag(tag: string, options?: RegistrationQueryLimitOptions): PagedAsyncIterableIterator<RegistrationDescription>;
|
|
100
|
+
/**
|
|
101
|
+
* Sends a direct push notification to a device with the given push handle.
|
|
102
|
+
* @param pushHandle - The push handle which is the unique identifier for the device.
|
|
103
|
+
* @param notification - The notification to send to the device.
|
|
104
|
+
* @param options - Configuration options for the direct send operation which can contain custom headers
|
|
105
|
+
* which may include APNs specific such as apns-topic or for WNS, X-WNS-TYPE.
|
|
106
|
+
* @returns A NotificationHubResponse with the tracking ID, correlation ID and location.
|
|
107
|
+
*/
|
|
108
|
+
sendDirectNotification(pushHandle: PushHandle, notification: Notification, options?: SendOperationOptions): Promise<NotificationHubsMessageResponse>;
|
|
109
|
+
/**
|
|
110
|
+
* Sends push notifications to devices that match the given tags or tag expression.
|
|
111
|
+
* @param tags - The tags used to target the device for push notifications in either an array or tag expression.
|
|
112
|
+
* @param notification - The notification to send to the matching devices.
|
|
113
|
+
* @param options - Configuration options for the direct send operation which can contain custom headers
|
|
114
|
+
* which may include APNs specific such as apns-topic or for WNS, X-WNS-TYPE.
|
|
115
|
+
* @returns A NotificationHubResponse with the tracking ID, correlation ID and location.
|
|
116
|
+
*/
|
|
117
|
+
sendNotification(tags: string[] | string, notification: Notification, options?: SendOperationOptions): Promise<NotificationHubsMessageResponse>;
|
|
118
|
+
/**
|
|
119
|
+
* Sends push notifications to all devices on the Notification Hub.
|
|
120
|
+
* @param notification - The notification to send to all devices.
|
|
121
|
+
* @param options - Configuration options for the direct send operation which can contain custom headers
|
|
122
|
+
* which may include APNs specific such as apns-topic or for WNS, X-WNS-TYPE.
|
|
123
|
+
* @returns A NotificationHubResponse with the tracking ID, correlation ID and location.
|
|
124
|
+
*/
|
|
125
|
+
sendBroadcastNotification(notification: Notification, options?: SendOperationOptions): Promise<NotificationHubsMessageResponse>;
|
|
126
|
+
/**
|
|
127
|
+
* Schedules a push notification to devices that match the given tags or tag expression at the specified time.
|
|
128
|
+
* NOTE: This is only available in Standard SKU Azure Notification Hubs.
|
|
129
|
+
* @param scheduledTime - The Date to send the push notification.
|
|
130
|
+
* @param tags - The tags used to target the device for push notifications in either an array or tag expression.
|
|
131
|
+
* @param notification - The notification to send to the matching devices.
|
|
132
|
+
* @param options - Configuration options for the direct send operation which can contain custom headers
|
|
133
|
+
* which may include APNs specific such as apns-topic or for WNS, X-WNS-TYPE.
|
|
134
|
+
* @returns A NotificationHubResponse with the tracking ID, correlation ID and location.
|
|
135
|
+
*/
|
|
136
|
+
scheduleNotification(scheduledTime: Date, tags: string[] | string, notification: Notification, options?: OperationOptions): Promise<NotificationHubsMessageResponse>;
|
|
137
|
+
/**
|
|
138
|
+
* Schedules a push notification to all devices registered on the Notification Hub.
|
|
139
|
+
* NOTE: This is only available in Standard SKU Azure Notification Hubs.
|
|
140
|
+
* @param scheduledTime - The Date to send the push notification.
|
|
141
|
+
* @param notification - The notification to send to the matching devices.
|
|
142
|
+
* @param options - Configuration options for the direct send operation which can contain custom headers
|
|
143
|
+
* which may include APNs specific such as apns-topic or for WNS, X-WNS-TYPE.
|
|
144
|
+
* @returns A NotificationHubResponse with the tracking ID, correlation ID and location.
|
|
145
|
+
*/
|
|
146
|
+
scheduleBroadcastNotification(scheduledTime: Date, notification: Notification, options?: OperationOptions): Promise<NotificationHubsMessageResponse>;
|
|
147
|
+
/**
|
|
148
|
+
* Cancels the scheduled notification with the given notification ID.
|
|
149
|
+
* @param notificationId - The notification ID from the scheduled notification.
|
|
150
|
+
* @param options - The operation options.
|
|
151
|
+
* @returns A notification hub response with correlation ID and tracking ID.
|
|
152
|
+
*/
|
|
153
|
+
cancelScheduledNotification(notificationId: string, options?: OperationOptions): Promise<NotificationHubsResponse>;
|
|
154
|
+
/**
|
|
155
|
+
* Retrieves an Azure Storage container URL. The container has feedback data for the notification hub.
|
|
156
|
+
* The caller can then use the Azure Storage Services SDK to retrieve the contents of the container.
|
|
157
|
+
* @param options - The options for getting the push notification feedback container URL.
|
|
158
|
+
* @returns The URL of the Azure Storage Container containing the feedback data.
|
|
159
|
+
*/
|
|
160
|
+
getFeedbackContainerUrl(options?: OperationOptions): Promise<string>;
|
|
161
|
+
/**
|
|
162
|
+
* Retrieves the results of a send operation. This can retrieve intermediate results if the send is being processed
|
|
163
|
+
* or final results if the Send* has completed. This API can only be called for Standard SKU and above.
|
|
164
|
+
* @param notificationId - The notification ID returned from the send operation.
|
|
165
|
+
* @param options - The operation options.
|
|
166
|
+
* @returns The results of the send operation.
|
|
167
|
+
*/
|
|
168
|
+
getNotificationOutcomeDetails(notificationId: string, options?: OperationOptions): Promise<NotificationDetails>;
|
|
169
|
+
/**
|
|
170
|
+
* Gets a Notification Hub Job by the ID.
|
|
171
|
+
* @param jobId - The Notification Hub Job ID.
|
|
172
|
+
* @param options - The operation options.
|
|
173
|
+
* @returns The Notification Hub Job with the matching ID.
|
|
174
|
+
*/
|
|
175
|
+
getNotificationHubJob(jobId: string, options?: OperationOptions): Promise<NotificationHubJob>;
|
|
176
|
+
/**
|
|
177
|
+
* Submits a Notification Hub Job. Note this is available to Standard SKU namespace and above.
|
|
178
|
+
* @param job - The notification hub job to submit.
|
|
179
|
+
* @param options - The operation options.
|
|
180
|
+
* @returns The notification hub job details including job ID and status.
|
|
181
|
+
*/
|
|
182
|
+
submitNotificationHubJob(job: NotificationHubJob, options?: OperationOptions): Promise<NotificationHubJob>;
|
|
183
|
+
/**
|
|
184
|
+
* Gets all Notification Hub Jobs for this Notification Hub.
|
|
185
|
+
* @param options - The operation options.
|
|
186
|
+
* @returns An array of all Notification Hub Jobs for this Notification Hub.
|
|
187
|
+
*/
|
|
188
|
+
listNotificationHubJobs(options?: OperationOptions): Promise<NotificationHubJob[]>;
|
|
189
|
+
}
|
|
190
|
+
//# sourceMappingURL=notificationHubsClient.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"notificationHubsClient.d.ts","sourceRoot":"","sources":["../../src/notificationHubsClient.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AAE/E,OAAO,EACL,6BAA6B,EAC7B,6BAA6B,EAC7B,wBAAwB,EACxB,oBAAoB,EACrB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,+BAA+B,EAAE,wBAAwB,EAAE,MAAM,sBAAsB,CAAC;AACjG,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AACtE,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACpE,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,0BAA0B,EAAE,MAAM,oBAAoB,CAAC;AAChE,OAAO,EAAE,uBAAuB,EAAE,MAAM,0BAA0B,CAAC;AAwBnE;;;GAGG;AACH,qBAAa,6BAA6B;IACxC,OAAO,CAAC,OAAO,CAAgC;IAE/C;;;;;OAKG;gBAED,gBAAgB,EAAE,MAAM,EACxB,OAAO,EAAE,MAAM,EACf,OAAO,GAAE,6BAAkC;IAK7C;;;;;OAKG;IACH,0BAA0B,CACxB,YAAY,EAAE,YAAY,EAC1B,OAAO,GAAE,gBAAqB,GAC7B,OAAO,CAAC,wBAAwB,CAAC;IAIpC;;;;;OAKG;IACH,kBAAkB,CAChB,cAAc,EAAE,MAAM,EACtB,OAAO,GAAE,gBAAqB,GAC7B,OAAO,CAAC,wBAAwB,CAAC;IAIpC;;;;;OAKG;IACH,eAAe,CAAC,cAAc,EAAE,MAAM,EAAE,OAAO,GAAE,gBAAqB,GAAG,OAAO,CAAC,YAAY,CAAC;IAI9F;;;;;;OAMG;IACH,kBAAkB,CAChB,cAAc,EAAE,MAAM,EACtB,OAAO,EAAE,SAAS,EAAE,EACpB,OAAO,GAAE,gBAAqB,GAC7B,OAAO,CAAC,wBAAwB,CAAC;IAIpC;;;;OAIG;IACH,oBAAoB,CAAC,OAAO,GAAE,gBAAqB,GAAG,OAAO,CAAC,MAAM,CAAC;IAIrE;;;;;;OAMG;IACH,kBAAkB,CAChB,YAAY,EAAE,uBAAuB,EACrC,OAAO,GAAE,gBAAqB,GAC7B,OAAO,CAAC,uBAAuB,CAAC;IAInC;;;;;OAKG;IACH,0BAA0B,CACxB,YAAY,EAAE,uBAAuB,EACrC,OAAO,GAAE,gBAAqB,GAC7B,OAAO,CAAC,uBAAuB,CAAC;IAInC;;;;;OAKG;IACH,kBAAkB,CAChB,YAAY,EAAE,uBAAuB,EACrC,OAAO,GAAE,gBAAqB,GAC7B,OAAO,CAAC,uBAAuB,CAAC;IAInC;;;;;OAKG;IACH,eAAe,CACb,cAAc,EAAE,MAAM,EACtB,OAAO,GAAE,gBAAqB,GAC7B,OAAO,CAAC,uBAAuB,CAAC;IAInC;;;;OAIG;IACH,iBAAiB,CACf,OAAO,GAAE,wBAA6B,GACrC,0BAA0B,CAAC,uBAAuB,CAAC;IAItD;;;;;OAKG;IACH,sBAAsB,CACpB,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,6BAAkC,GAC1C,0BAA0B,CAAC,uBAAuB,CAAC;IAItD;;;;;;;OAOG;IACH,sBAAsB,CACpB,UAAU,EAAE,UAAU,EACtB,YAAY,EAAE,YAAY,EAC1B,OAAO,GAAE,oBAAyB,GACjC,OAAO,CAAC,+BAA+B,CAAC;IAI3C;;;;;;;OAOG;IACH,gBAAgB,CACd,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM,EACvB,YAAY,EAAE,YAAY,EAC1B,OAAO,GAAE,oBAAyB,GACjC,OAAO,CAAC,+BAA+B,CAAC;IAI3C;;;;;;OAMG;IACH,yBAAyB,CACvB,YAAY,EAAE,YAAY,EAC1B,OAAO,GAAE,oBAAyB,GACjC,OAAO,CAAC,+BAA+B,CAAC;IAI3C;;;;;;;;;OASG;IACH,oBAAoB,CAClB,aAAa,EAAE,IAAI,EACnB,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM,EACvB,YAAY,EAAE,YAAY,EAC1B,OAAO,GAAE,gBAAqB,GAC7B,OAAO,CAAC,+BAA+B,CAAC;IAI3C;;;;;;;;OAQG;IACH,6BAA6B,CAC3B,aAAa,EAAE,IAAI,EACnB,YAAY,EAAE,YAAY,EAC1B,OAAO,GAAE,gBAAqB,GAC7B,OAAO,CAAC,+BAA+B,CAAC;IAI3C;;;;;OAKG;IACH,2BAA2B,CACzB,cAAc,EAAE,MAAM,EACtB,OAAO,GAAE,gBAAqB,GAC7B,OAAO,CAAC,wBAAwB,CAAC;IAIpC;;;;;OAKG;IACH,uBAAuB,CAAC,OAAO,GAAE,gBAAqB,GAAG,OAAO,CAAC,MAAM,CAAC;IAIxE;;;;;;OAMG;IACH,6BAA6B,CAC3B,cAAc,EAAE,MAAM,EACtB,OAAO,GAAE,gBAAqB,GAC7B,OAAO,CAAC,mBAAmB,CAAC;IAI/B;;;;;OAKG;IACH,qBAAqB,CACnB,KAAK,EAAE,MAAM,EACb,OAAO,GAAE,gBAAqB,GAC7B,OAAO,CAAC,kBAAkB,CAAC;IAI9B;;;;;OAKG;IACH,wBAAwB,CACtB,GAAG,EAAE,kBAAkB,EACvB,OAAO,GAAE,gBAAqB,GAC7B,OAAO,CAAC,kBAAkB,CAAC;IAI9B;;;;OAIG;IACH,uBAAuB,CAAC,OAAO,GAAE,gBAAqB,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC;CAGvF"}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { NotificationDetails } from "../models/notificationDetails.js";
|
|
2
|
+
/**
|
|
3
|
+
* @internal
|
|
4
|
+
* Parses a NotificationDetails from incoming XML.
|
|
5
|
+
*/
|
|
6
|
+
export declare function parseNotificationDetails(bodyText: string): Promise<NotificationDetails>;
|
|
7
|
+
//# sourceMappingURL=notificationDetailsSerializer.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"notificationDetailsSerializer.d.ts","sourceRoot":"","sources":["../../../src/serializers/notificationDetailsSerializer.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,mBAAmB,EAGpB,MAAM,kCAAkC,CAAC;AAI1C;;;GAGG;AACH,wBAAsB,wBAAwB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,CA+C7F"}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import { NotificationHubJob } from "../models/notificationHubJob.js";
|
|
2
|
+
/**
|
|
3
|
+
* @internal
|
|
4
|
+
* Serializes a NotificationHubJob into an Atom XML entry.
|
|
5
|
+
* @param entry - The NotificationHubJob to turn into an Atom XML entry.
|
|
6
|
+
* @returns An Atom XML entry containing the notification hub job.
|
|
7
|
+
*/
|
|
8
|
+
export declare function serializeNotificationHubJobEntry(entry: NotificationHubJob): string;
|
|
9
|
+
/**
|
|
10
|
+
* Parses an Atom XML of an notification hub job entry.
|
|
11
|
+
* @param bodyText - The incoming Atom XML entry to parse into a notification hub job.
|
|
12
|
+
* @returns A parsed NotificationHubJob.
|
|
13
|
+
*/
|
|
14
|
+
export declare function parseNotificationHubJobEntry(bodyText: string): Promise<NotificationHubJob>;
|
|
15
|
+
/**
|
|
16
|
+
* Parses an Atom XML feed of notification hub jobs.
|
|
17
|
+
* @param bodyText - The incoming Atom XML feed to parse into notification hub jobs.
|
|
18
|
+
* @returns A list of notification hub jobs.
|
|
19
|
+
*/
|
|
20
|
+
export declare function parseNotificationHubJobFeed(bodyText: string): Promise<NotificationHubJob[]>;
|
|
21
|
+
//# sourceMappingURL=notificationHubJobSerializer.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"notificationHubJobSerializer.d.ts","sourceRoot":"","sources":["../../../src/serializers/notificationHubJobSerializer.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,kBAAkB,EAGnB,MAAM,iCAAiC,CAAC;AAWzC;;;;;GAKG;AACH,wBAAgB,gCAAgC,CAAC,KAAK,EAAE,kBAAkB,GAAG,MAAM,CAUlF;AAED;;;;GAIG;AACH,wBAAsB,4BAA4B,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAIhG;AAED;;;;GAIG;AACH,wBAAsB,2BAA2B,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAQjG"}
|
|
@@ -0,0 +1,193 @@
|
|
|
1
|
+
import { AdmRegistrationDescription, AdmTemplateRegistrationDescription, AppleRegistrationDescription, AppleTemplateRegistrationDescription, BaiduRegistrationDescription, BaiduTemplateRegistrationDescription, BrowserRegistrationDescription, BrowserTemplateRegistrationDescription, FcmRegistrationDescription, FcmTemplateRegistrationDescription, GcmRegistrationDescription, GcmTemplateRegistrationDescription, MpnsRegistrationDescription, MpnsTemplateRegistrationDescription, RegistrationDescription, WindowsRegistrationDescription, WindowsTemplateRegistrationDescription } from "../models/registration.js";
|
|
2
|
+
/**
|
|
3
|
+
* Represents a registration description parser from the incoming XML.
|
|
4
|
+
*/
|
|
5
|
+
export interface RegistrationDescriptionParser {
|
|
6
|
+
/**
|
|
7
|
+
* @internal
|
|
8
|
+
* Creates a registration type from the incoming entry.
|
|
9
|
+
*/
|
|
10
|
+
parseRegistrationEntry: (bodyText: string) => Promise<RegistrationDescription>;
|
|
11
|
+
/**
|
|
12
|
+
* @internal
|
|
13
|
+
* Creates a list of registrations from an incoming ATOM XML Feed.
|
|
14
|
+
*/
|
|
15
|
+
parseRegistrationFeed: (bodyText: string) => Promise<RegistrationDescription[]>;
|
|
16
|
+
/**
|
|
17
|
+
* @internal
|
|
18
|
+
* Creates an Amazon Device Messaging (ADM) registration description from the incoming parsed XML.
|
|
19
|
+
*/
|
|
20
|
+
createAdmRegistrationDescription: (rawRegistrationDescription: Record<string, any>) => AdmRegistrationDescription;
|
|
21
|
+
/**
|
|
22
|
+
* @internal
|
|
23
|
+
* Creates an Amazon Device Messaging (ADM) template registration description from the incoming parsed XML.
|
|
24
|
+
*/
|
|
25
|
+
createAdmTemplateRegistrationDescription: (rawRegistrationDescription: Record<string, any>) => AdmTemplateRegistrationDescription;
|
|
26
|
+
/**
|
|
27
|
+
* @internal
|
|
28
|
+
* Creates an Apple Platform Notification Services (APNs) registration description from the incoming parsed XML.
|
|
29
|
+
*/
|
|
30
|
+
createAppleRegistrationDescription: (rawRegistrationDescription: Record<string, any>) => AppleRegistrationDescription;
|
|
31
|
+
/**
|
|
32
|
+
* @internal
|
|
33
|
+
* Creates an Apple Platform Notification Services (APNs) template registration description from the incoming parsed XML.
|
|
34
|
+
*/
|
|
35
|
+
createAppleTemplateRegistrationDescription: (rawRegistrationDescription: Record<string, any>) => AppleTemplateRegistrationDescription;
|
|
36
|
+
/**
|
|
37
|
+
* @internal
|
|
38
|
+
* Creates a Baidu registration description from the incoming parsed XML.
|
|
39
|
+
*/
|
|
40
|
+
createBaiduRegistrationDescription: (rawRegistrationDescription: Record<string, any>) => BaiduRegistrationDescription;
|
|
41
|
+
/**
|
|
42
|
+
* @internal
|
|
43
|
+
* Creates a Baidu template registration description from the incoming parsed XML.
|
|
44
|
+
*/
|
|
45
|
+
createBaiduTemplateRegistrationDescription: (rawRegistrationDescription: Record<string, any>) => BaiduTemplateRegistrationDescription;
|
|
46
|
+
/**
|
|
47
|
+
* @internal
|
|
48
|
+
* Creates a Web Push registration description from the incoming parsed XML.
|
|
49
|
+
*/
|
|
50
|
+
createBrowserRegistrationDescription: (rawRegistrationDescription: Record<string, any>) => BrowserRegistrationDescription;
|
|
51
|
+
/**
|
|
52
|
+
* @internal
|
|
53
|
+
* Creates a Web Push template registration description from the incoming parsed XML.
|
|
54
|
+
*/
|
|
55
|
+
createBrowserTemplateRegistrationDescription: (rawRegistrationDescription: Record<string, any>) => BrowserTemplateRegistrationDescription;
|
|
56
|
+
/**
|
|
57
|
+
* @internal
|
|
58
|
+
* Creates a Google Cloud Messaging (GCM) registration description from the incoming parsed XML.
|
|
59
|
+
*/
|
|
60
|
+
createGcmRegistrationDescription: (rawRegistrationDescription: Record<string, any>) => GcmRegistrationDescription;
|
|
61
|
+
/**
|
|
62
|
+
* @internal
|
|
63
|
+
* Creates a Google Cloud Messaging (GCM) template registration description from the incoming parsed XML.
|
|
64
|
+
*/
|
|
65
|
+
createGcmTemplateRegistrationDescription: (rawRegistrationDescription: Record<string, any>) => GcmTemplateRegistrationDescription;
|
|
66
|
+
/**
|
|
67
|
+
* @internal
|
|
68
|
+
* Creates a Firebase Cloud Messaging (GCM) registration description from the incoming parsed XML.
|
|
69
|
+
*/
|
|
70
|
+
createFcmRegistrationDescription: (rawRegistrationDescription: Record<string, any>) => FcmRegistrationDescription;
|
|
71
|
+
/**
|
|
72
|
+
* @internal
|
|
73
|
+
* Creates a Firebase Cloud Messaging (GCM) template registration description from the incoming parsed XML.
|
|
74
|
+
*/
|
|
75
|
+
createFcmTemplateRegistrationDescription: (rawRegistrationDescription: Record<string, any>) => FcmTemplateRegistrationDescription;
|
|
76
|
+
/**
|
|
77
|
+
* @internal
|
|
78
|
+
* Creates a Microsoft Phone Notification Services (MPNS) registration description from the incoming parsed XML.
|
|
79
|
+
*/
|
|
80
|
+
createMpnsRegistrationDescription: (rawRegistrationDescription: Record<string, any>) => MpnsRegistrationDescription;
|
|
81
|
+
/**
|
|
82
|
+
* @internal
|
|
83
|
+
* Creates a Microsoft Phone Notification Services (MPNS) template registration description from the incoming parsed XML.
|
|
84
|
+
*/
|
|
85
|
+
createMpnsTemplateRegistrationDescription: (rawRegistrationDescription: Record<string, any>) => MpnsTemplateRegistrationDescription;
|
|
86
|
+
/**
|
|
87
|
+
* @internal
|
|
88
|
+
* Creates a Windows Notification Services (WNS) registration description from the incoming parsed XML.
|
|
89
|
+
*/
|
|
90
|
+
createWindowsRegistrationDescription: (rawRegistrationDescription: Record<string, any>) => WindowsRegistrationDescription;
|
|
91
|
+
/**
|
|
92
|
+
* @internal
|
|
93
|
+
* Creates a Windows Notification Services (WNS) template registration description from the incoming parsed XML.
|
|
94
|
+
*/
|
|
95
|
+
createWindowsTemplateRegistrationDescription: (rawRegistrationDescription: Record<string, any>) => WindowsTemplateRegistrationDescription;
|
|
96
|
+
}
|
|
97
|
+
export declare const registrationDescriptionParser: RegistrationDescriptionParser;
|
|
98
|
+
/**
|
|
99
|
+
* @internal
|
|
100
|
+
* Represents a serializer for all registration descriptions.
|
|
101
|
+
*/
|
|
102
|
+
export interface RegistrationDescriptionSerializer {
|
|
103
|
+
/**
|
|
104
|
+
* @internal
|
|
105
|
+
* Serializes a registration description into an ATOM XML string.
|
|
106
|
+
*/
|
|
107
|
+
serializeRegistrationDescription(description: RegistrationDescription): string;
|
|
108
|
+
/**
|
|
109
|
+
* @internal
|
|
110
|
+
* Serializes an Amazon Device Messaging (ADM) registration description into an XML object for serialization.
|
|
111
|
+
*/
|
|
112
|
+
serializeAdmRegistrationDescription(description: Omit<AdmRegistrationDescription, "type">): Record<string, any>;
|
|
113
|
+
/**
|
|
114
|
+
* @internal
|
|
115
|
+
* Serializes an Amazon Device Messaging (ADM) template registration description into an XML object for serialization.
|
|
116
|
+
*/
|
|
117
|
+
serializeAdmTemplateRegistrationDescription(description: Omit<AdmTemplateRegistrationDescription, "type">): Record<string, any>;
|
|
118
|
+
/**
|
|
119
|
+
* @internal
|
|
120
|
+
* Serializes an Apple registration description into an XML object for serialization.
|
|
121
|
+
*/
|
|
122
|
+
serializeAppleRegistrationDescription(description: Omit<AppleRegistrationDescription, "type">): Record<string, any>;
|
|
123
|
+
/**
|
|
124
|
+
* @internal
|
|
125
|
+
* Serializes an Apple template registration description into an XML object for serialization.
|
|
126
|
+
*/
|
|
127
|
+
serializeAppleTemplateRegistrationDescription(description: Omit<AppleRegistrationDescription, "type">): Record<string, any>;
|
|
128
|
+
/**
|
|
129
|
+
* @internal
|
|
130
|
+
* Serializes a Baidu registration description into an XML object for serialization.
|
|
131
|
+
*/
|
|
132
|
+
serializeBaiduRegistrationDescription(description: Omit<BaiduRegistrationDescription, "type">): Record<string, any>;
|
|
133
|
+
/**
|
|
134
|
+
* @internal
|
|
135
|
+
* Serializes a Baidu template registration description into an XML object for serialization.
|
|
136
|
+
*/
|
|
137
|
+
serializeBaiduTemplateRegistrationDescription(description: Omit<BaiduTemplateRegistrationDescription, "type">): Record<string, any>;
|
|
138
|
+
/**
|
|
139
|
+
* @internal
|
|
140
|
+
* Serializes a Web Push registration description into an XML object for serialization.
|
|
141
|
+
*/
|
|
142
|
+
serializeBrowserRegistrationDescription(description: Omit<BrowserRegistrationDescription, "type">): Record<string, any>;
|
|
143
|
+
/**
|
|
144
|
+
* @internal
|
|
145
|
+
* Serializes a Web Push template registration description into an XML object for serialization.
|
|
146
|
+
*/
|
|
147
|
+
serializeBrowserTemplateRegistrationDescription(description: Omit<BrowserTemplateRegistrationDescription, "type">): Record<string, any>;
|
|
148
|
+
/**
|
|
149
|
+
* @internal
|
|
150
|
+
* Serializes a Google Cloud Messaging (GCM) registration description into an XML object for serialization.
|
|
151
|
+
*/
|
|
152
|
+
serializeGcmRegistrationDescription(description: Omit<GcmRegistrationDescription, "type">): Record<string, any>;
|
|
153
|
+
/**
|
|
154
|
+
* @internal
|
|
155
|
+
* Serializes a Google Cloud Messaging (GCM) template registration description into an XML object for serialization.
|
|
156
|
+
*/
|
|
157
|
+
serializeGcmTemplateRegistrationDescription(description: Omit<GcmTemplateRegistrationDescription, "type">): Record<string, any>;
|
|
158
|
+
/**
|
|
159
|
+
* @internal
|
|
160
|
+
* Serializes a Firebase registration description into an XML object for serialization.
|
|
161
|
+
*/
|
|
162
|
+
serializeFcmRegistrationDescription(description: Omit<FcmRegistrationDescription, "type">): Record<string, any>;
|
|
163
|
+
/**
|
|
164
|
+
* @internal
|
|
165
|
+
* Serializes a Firebase template registration description into an XML object for serialization.
|
|
166
|
+
*/
|
|
167
|
+
serializeFcmTemplateRegistrationDescription(description: Omit<FcmRegistrationDescription, "type">): Record<string, any>;
|
|
168
|
+
/**
|
|
169
|
+
* @internal
|
|
170
|
+
* Serializes a Windows Phone registration description into an XML object for serialization.
|
|
171
|
+
*/
|
|
172
|
+
serializeMpnsRegistrationDescription(description: Omit<MpnsRegistrationDescription, "type">): Record<string, any>;
|
|
173
|
+
/**
|
|
174
|
+
* @internal
|
|
175
|
+
* Serializes a Windows Phone template registration description into an XML object for serialization.
|
|
176
|
+
*/
|
|
177
|
+
serializeMpnsTemplateRegistrationDescription(description: Omit<MpnsTemplateRegistrationDescription, "type">): Record<string, any>;
|
|
178
|
+
/**
|
|
179
|
+
* @internal
|
|
180
|
+
* Serializes a Windows Notification Services (WNS) registration description into an XML object for serialization.
|
|
181
|
+
*/
|
|
182
|
+
serializeWindowsRegistrationDescription(description: Omit<WindowsRegistrationDescription, "type">): Record<string, any>;
|
|
183
|
+
/**
|
|
184
|
+
* @internal
|
|
185
|
+
* Serializes a Windows Notification Services (WNS) template registration description into an XML object for serialization.
|
|
186
|
+
*/
|
|
187
|
+
serializeWindowsTemplateRegistrationDescription(description: Omit<WindowsTemplateRegistrationDescription, "type">): Record<string, any>;
|
|
188
|
+
}
|
|
189
|
+
/**
|
|
190
|
+
* Represents a RegistrationDescription serializer.
|
|
191
|
+
*/
|
|
192
|
+
export declare const registrationDescriptionSerializer: RegistrationDescriptionSerializer;
|
|
193
|
+
//# sourceMappingURL=registrationSerializer.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"registrationSerializer.d.ts","sourceRoot":"","sources":["../../../src/serializers/registrationSerializer.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,0BAA0B,EAC1B,kCAAkC,EAElC,4BAA4B,EAC5B,oCAAoC,EACpC,4BAA4B,EAC5B,oCAAoC,EACpC,8BAA8B,EAC9B,sCAAsC,EACtC,0BAA0B,EAC1B,kCAAkC,EAClC,0BAA0B,EAC1B,kCAAkC,EAClC,2BAA2B,EAC3B,mCAAmC,EACnC,uBAAuB,EAGvB,8BAA8B,EAC9B,sCAAsC,EACvC,MAAM,2BAA2B,CAAC;AAYnC;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C;;;OAGG;IACH,sBAAsB,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAC/E;;;OAGG;IACH,qBAAqB,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC,uBAAuB,EAAE,CAAC,CAAC;IAChF;;;OAGG;IACH,gCAAgC,EAAE,CAChC,0BAA0B,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAC5C,0BAA0B,CAAC;IAChC;;;OAGG;IACH,wCAAwC,EAAE,CACxC,0BAA0B,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAC5C,kCAAkC,CAAC;IACxC;;;OAGG;IACH,kCAAkC,EAAE,CAClC,0BAA0B,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAC5C,4BAA4B,CAAC;IAClC;;;OAGG;IACH,0CAA0C,EAAE,CAC1C,0BAA0B,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAC5C,oCAAoC,CAAC;IAC1C;;;OAGG;IACH,kCAAkC,EAAE,CAClC,0BAA0B,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAC5C,4BAA4B,CAAC;IAClC;;;OAGG;IACH,0CAA0C,EAAE,CAC1C,0BAA0B,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAC5C,oCAAoC,CAAC;IAC1C;;;OAGG;IACH,oCAAoC,EAAE,CACpC,0BAA0B,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAC5C,8BAA8B,CAAC;IACpC;;;OAGG;IACH,4CAA4C,EAAE,CAC5C,0BAA0B,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAC5C,sCAAsC,CAAC;IAC5C;;;OAGG;IACH,gCAAgC,EAAE,CAChC,0BAA0B,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAC5C,0BAA0B,CAAC;IAChC;;;OAGG;IACH,wCAAwC,EAAE,CACxC,0BAA0B,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAC5C,kCAAkC,CAAC;IACxC;;;OAGG;IACH,gCAAgC,EAAE,CAChC,0BAA0B,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAC5C,0BAA0B,CAAC;IAChC;;;OAGG;IACH,wCAAwC,EAAE,CACxC,0BAA0B,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAC5C,kCAAkC,CAAC;IACxC;;;OAGG;IACH,iCAAiC,EAAE,CACjC,0BAA0B,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAC5C,2BAA2B,CAAC;IACjC;;;OAGG;IACH,yCAAyC,EAAE,CACzC,0BAA0B,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAC5C,mCAAmC,CAAC;IACzC;;;OAGG;IACH,oCAAoC,EAAE,CACpC,0BAA0B,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAC5C,8BAA8B,CAAC;IACpC;;;OAGG;IACH,4CAA4C,EAAE,CAC5C,0BAA0B,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAC5C,sCAAsC,CAAC;CAC7C;AAED,eAAO,MAAM,6BAA6B,EAAE,6BA0R3C,CAAC;AA6CF;;;GAGG;AACH,MAAM,WAAW,iCAAiC;IAChD;;;OAGG;IACH,gCAAgC,CAAC,WAAW,EAAE,uBAAuB,GAAG,MAAM,CAAC;IAC/E;;;OAGG;IACH,mCAAmC,CACjC,WAAW,EAAE,IAAI,CAAC,0BAA0B,EAAE,MAAM,CAAC,GACpD,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACvB;;;OAGG;IACH,2CAA2C,CACzC,WAAW,EAAE,IAAI,CAAC,kCAAkC,EAAE,MAAM,CAAC,GAC5D,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACvB;;;OAGG;IACH,qCAAqC,CACnC,WAAW,EAAE,IAAI,CAAC,4BAA4B,EAAE,MAAM,CAAC,GACtD,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACvB;;;OAGG;IACH,6CAA6C,CAC3C,WAAW,EAAE,IAAI,CAAC,4BAA4B,EAAE,MAAM,CAAC,GACtD,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACvB;;;OAGG;IACH,qCAAqC,CACnC,WAAW,EAAE,IAAI,CAAC,4BAA4B,EAAE,MAAM,CAAC,GACtD,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACvB;;;OAGG;IACH,6CAA6C,CAC3C,WAAW,EAAE,IAAI,CAAC,oCAAoC,EAAE,MAAM,CAAC,GAC9D,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACvB;;;OAGG;IACH,uCAAuC,CACrC,WAAW,EAAE,IAAI,CAAC,8BAA8B,EAAE,MAAM,CAAC,GACxD,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACvB;;;OAGG;IACH,+CAA+C,CAC7C,WAAW,EAAE,IAAI,CAAC,sCAAsC,EAAE,MAAM,CAAC,GAChE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACvB;;;OAGG;IACH,mCAAmC,CACjC,WAAW,EAAE,IAAI,CAAC,0BAA0B,EAAE,MAAM,CAAC,GACpD,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACvB;;;OAGG;IACH,2CAA2C,CACzC,WAAW,EAAE,IAAI,CAAC,kCAAkC,EAAE,MAAM,CAAC,GAC5D,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACvB;;;OAGG;IACH,mCAAmC,CACjC,WAAW,EAAE,IAAI,CAAC,0BAA0B,EAAE,MAAM,CAAC,GACpD,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACvB;;;OAGG;IACH,2CAA2C,CACzC,WAAW,EAAE,IAAI,CAAC,0BAA0B,EAAE,MAAM,CAAC,GACpD,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACvB;;;OAGG;IACH,oCAAoC,CAClC,WAAW,EAAE,IAAI,CAAC,2BAA2B,EAAE,MAAM,CAAC,GACrD,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACvB;;;OAGG;IACH,4CAA4C,CAC1C,WAAW,EAAE,IAAI,CAAC,mCAAmC,EAAE,MAAM,CAAC,GAC7D,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACvB;;;OAGG;IACH,uCAAuC,CACrC,WAAW,EAAE,IAAI,CAAC,8BAA8B,EAAE,MAAM,CAAC,GACxD,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACvB;;;OAGG;IACH,+CAA+C,CAC7C,WAAW,EAAE,IAAI,CAAC,sCAAsC,EAAE,MAAM,CAAC,GAChE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CACxB;AAED;;GAEG;AACH,eAAO,MAAM,iCAAiC,EAAE,iCAsR/C,CAAC"}
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
import { SasTokenProvider } from "@azure/core-amqp";
|
|
2
|
+
/**
|
|
3
|
+
* The set of properties that comprise a Notification Hubs connection string.
|
|
4
|
+
*/
|
|
5
|
+
export interface NotificationHubsConnectionStringProperties {
|
|
6
|
+
/**
|
|
7
|
+
* The value for "Endpoint" in the connection string.
|
|
8
|
+
*/
|
|
9
|
+
endpoint: string;
|
|
10
|
+
/**
|
|
11
|
+
* The value for "SharedAccessKey" in the connection string. This along with the "SharedAccessKeyName"
|
|
12
|
+
* in the connection string is used to generate a SharedAccessSignature which can be used authorize
|
|
13
|
+
* the connection to the service.
|
|
14
|
+
*/
|
|
15
|
+
sharedAccessKey: string;
|
|
16
|
+
/**
|
|
17
|
+
* The value for "SharedAccessKeyName" in the connection string. This along with the "SharedAccessKey"
|
|
18
|
+
* in the connection string is used to generate a SharedAccessSignature which can be used authorize
|
|
19
|
+
* the connection to the service.
|
|
20
|
+
*/
|
|
21
|
+
sharedAccessKeyName: string;
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* Creates a SasTokenProvider from a shared access key and shared access key name.
|
|
25
|
+
* @param sharedAccessKey - The shared access key value.
|
|
26
|
+
* @param sharedAccessKeyName - The shared access key name.
|
|
27
|
+
* @returns A SasTokenProvider with the given shared access token information.
|
|
28
|
+
*/
|
|
29
|
+
export declare function createTokenProviderFromConnection(sharedAccessKey: string, sharedAccessKeyName: string): SasTokenProvider;
|
|
30
|
+
/**
|
|
31
|
+
* Parses given connection string into the different properties applicable to Azure Service Bus.
|
|
32
|
+
* The properties are useful to then construct a ServiceBusClient.
|
|
33
|
+
* @param connectionString - The connection string associated with the Shared Access Policy created
|
|
34
|
+
* for the Service Bus namespace, queue or topic.
|
|
35
|
+
*/
|
|
36
|
+
export declare function parseNotificationHubsConnectionString(connectionString: string): NotificationHubsConnectionStringProperties;
|
|
37
|
+
//# sourceMappingURL=connectionStringUtils.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"connectionStringUtils.d.ts","sourceRoot":"","sources":["../../../src/utils/connectionStringUtils.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,gBAAgB,EAAiD,MAAM,kBAAkB,CAAC;AAEnG;;GAEG;AACH,MAAM,WAAW,0CAA0C;IACzD;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;;;OAIG;IACH,mBAAmB,EAAE,MAAM,CAAC;CAC7B;AAED;;;;;GAKG;AACH,wBAAgB,iCAAiC,CAC/C,eAAe,EAAE,MAAM,EACvB,mBAAmB,EAAE,MAAM,GAC1B,gBAAgB,CAElB;AAED;;;;;GAKG;AACH,wBAAgB,qCAAqC,CACnD,gBAAgB,EAAE,MAAM,GACvB,0CAA0C,CAyB5C"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
export declare const JSON_CONTENT_TYPE = "application/json;charset=utf-8";
|
|
2
|
+
export declare const XML_CONTENT_TYPE = "application/xml";
|
|
3
|
+
export declare const STREAM_CONTENT_TYPE = "application/octet-stream";
|
|
4
|
+
export declare const WNS_TYPE_NAME = "X-WNS-Type";
|
|
5
|
+
export declare const WNS_RAW = "wns/raw";
|
|
6
|
+
export declare const WNS_BADGE = "wns/badge";
|
|
7
|
+
export declare const WNS_TITLE = "wns/tile";
|
|
8
|
+
export declare const WNS_TOAST = "wns/toast";
|
|
9
|
+
//# sourceMappingURL=constants.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../src/utils/constants.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,iBAAiB,mCAAmC,CAAC;AAClE,eAAO,MAAM,gBAAgB,oBAAoB,CAAC;AAClD,eAAO,MAAM,mBAAmB,6BAA6B,CAAC;AAE9D,eAAO,MAAM,aAAa,eAAe,CAAC;AAC1C,eAAO,MAAM,OAAO,YAAY,CAAC;AACjC,eAAO,MAAM,SAAS,cAAc,CAAC;AACrC,eAAO,MAAM,SAAS,aAAa,CAAC;AACpC,eAAO,MAAM,SAAS,cAAc,CAAC"}
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
import { AbortSignal } from "@azure/abort-controller";
|
|
2
|
+
/**
|
|
3
|
+
* Represents the retry delay calculation either fixed or exponential.
|
|
4
|
+
*/
|
|
5
|
+
export declare enum RetryMode {
|
|
6
|
+
/**
|
|
7
|
+
* Fixed interval between retries.
|
|
8
|
+
*/
|
|
9
|
+
Fixed = 0,
|
|
10
|
+
/**
|
|
11
|
+
* Exporation interval between retries.
|
|
12
|
+
*/
|
|
13
|
+
Exponential = 1
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* Represents the retry options for an operation.
|
|
17
|
+
*/
|
|
18
|
+
export interface RetryOptions {
|
|
19
|
+
/**
|
|
20
|
+
* The retry mode.
|
|
21
|
+
*/
|
|
22
|
+
mode: RetryMode;
|
|
23
|
+
/**
|
|
24
|
+
* The number of maximum retries.
|
|
25
|
+
*/
|
|
26
|
+
maxRetries: number;
|
|
27
|
+
/**
|
|
28
|
+
* The delay in milliseconds between retries.
|
|
29
|
+
*/
|
|
30
|
+
delay: number;
|
|
31
|
+
/**
|
|
32
|
+
* The maximum delay in milliseconds between retries.
|
|
33
|
+
*/
|
|
34
|
+
maxDelay: number;
|
|
35
|
+
}
|
|
36
|
+
/**
|
|
37
|
+
* Creates a set of retry options with defaults.
|
|
38
|
+
* @param options - The options for the retry behavior.
|
|
39
|
+
* @returns The retry options.
|
|
40
|
+
*/
|
|
41
|
+
export declare function createRetryOptions(options?: Partial<RetryOptions>): RetryOptions;
|
|
42
|
+
/**
|
|
43
|
+
* Represents a retry policy with a run operation and define a retry time calculation.
|
|
44
|
+
*/
|
|
45
|
+
export interface RetryPolicy {
|
|
46
|
+
/**
|
|
47
|
+
* Calculates the retry delay based upon the error and retry attempt.
|
|
48
|
+
* @param error - The error from the operation.
|
|
49
|
+
* @param attempt - The retry attempt number.
|
|
50
|
+
*/
|
|
51
|
+
calculateRetryDelay: (error: unknown, attempt: number) => number | undefined;
|
|
52
|
+
/**
|
|
53
|
+
* Runs an operation and retries based upon the retry policy.
|
|
54
|
+
* @param operation - The operation to run and retry if necessary.
|
|
55
|
+
* @param signal - An AbortSignal to check for cancellation.
|
|
56
|
+
* @returns The result of the operation.
|
|
57
|
+
*/
|
|
58
|
+
runOperation<TResult>(operation: (signal?: AbortSignal) => Promise<TResult>, signal?: AbortSignal): Promise<TResult>;
|
|
59
|
+
}
|
|
60
|
+
/**
|
|
61
|
+
* Creates a base retry policy with the incoming calculateRetryDelay method.
|
|
62
|
+
* @param calculateRetryDelay - The retry calculation behavior based upon attempt number and error.
|
|
63
|
+
* @returns A retry policy with the given calculateRetryDelay method.
|
|
64
|
+
*/
|
|
65
|
+
export declare function createBaseRetryPolicy(calculateRetryDelay: (error: unknown, attempt: number) => number | undefined): RetryPolicy;
|
|
66
|
+
/**
|
|
67
|
+
* Creates a retry policy configured with the given retry options.
|
|
68
|
+
* @param options - The retry options including delay, max attempts and backoff behavior.
|
|
69
|
+
* @returns A retry policy configured with the given options.
|
|
70
|
+
*/
|
|
71
|
+
export declare function createDefaultRetryPolicy(options: RetryOptions): RetryPolicy;
|
|
72
|
+
//# sourceMappingURL=retryPolicy.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"retryPolicy.d.ts","sourceRoot":"","sources":["../../../src/utils/retryPolicy.ts"],"names":[],"mappings":"AAGA,OAAO,EAAc,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAgBlE;;GAEG;AACH,oBAAY,SAAS;IACnB;;OAEG;IACH,KAAK,IAAA;IACL;;OAEG;IACH,WAAW,IAAA;CACZ;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,IAAI,EAAE,SAAS,CAAC;IAEhB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC,GAAG,YAAY,CAQhF;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;;;OAIG;IACH,mBAAmB,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,KAAK,MAAM,GAAG,SAAS,CAAC;IAE7E;;;;;OAKG;IACH,YAAY,CAAC,OAAO,EAClB,SAAS,EAAE,CAAC,MAAM,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,OAAO,CAAC,EACrD,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,OAAO,CAAC,CAAC;CACrB;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CACnC,mBAAmB,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,KAAK,MAAM,GAAG,SAAS,GAC3E,WAAW,CA4Bb;AAED;;;;GAIG;AACH,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,YAAY,GAAG,WAAW,CAmC3E"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"tracing.d.ts","sourceRoot":"","sources":["../../../src/utils/tracing.ts"],"names":[],"mappings":"AAKA;;;GAGG;AACH,eAAO,MAAM,aAAa,6CAIxB,CAAC"}
|