@awesome-cordova-plugins/urbanairship 7.0.1 → 8.0.2

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/index.d.ts CHANGED
@@ -24,7 +24,7 @@ export interface ChannelSubscriptionListEditor {
24
24
  unsubscribe(subscriptionListID: string): ChannelSubscriptionListEditor;
25
25
  apply(success: () => void, failure: (message: string) => void): ChannelSubscriptionListEditor;
26
26
  }
27
- export type ContactSubscriptionScope = 'app' | 'email' | 'push' | 'sms';
27
+ export declare type ContactSubscriptionScope = 'app' | 'email' | 'push' | 'sms';
28
28
  /**
29
29
  * Interface for UAirship ContactSubscriptionList Editor
30
30
  */
@@ -35,6 +35,7 @@ export interface ContactSubscriptionListEditor {
35
35
  }
36
36
  /**
37
37
  * Enum for notification types.
38
+ *
38
39
  * @readonly
39
40
  * @enum {number}
40
41
  */
@@ -46,6 +47,7 @@ export declare enum NotificationType {
46
47
  }
47
48
  /**
48
49
  * Enum for presentation options.
50
+ *
49
51
  * @readonly
50
52
  * @enum {number}
51
53
  */
@@ -75,9 +77,10 @@ export declare enum PresentationOptions {
75
77
  *
76
78
  * ```
77
79
  */
78
- export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
80
+ export declare class UrbanAirShipOriginal extends AwesomeCordovaNativePlugin {
79
81
  /**
80
82
  * Event fired when a new deep link is received.
83
+ *
81
84
  * @event deep_link
82
85
  * @type {object}
83
86
  * @param {string} [deepLink] The deep link.
@@ -85,6 +88,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
85
88
  onDeepLink(): Observable<any>;
86
89
  /**
87
90
  * Event fired when a channel registration occurs.
91
+ *
88
92
  * @event registration
89
93
  * @type {object}
90
94
  * @param {string} [channelID] The channel ID.
@@ -94,12 +98,14 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
94
98
  onRegistration(): Observable<any>;
95
99
  /**
96
100
  * Event fired when the inbox is updated.
101
+ *
97
102
  * @event inbox_updated
98
103
  */
99
104
  onInboxUpdated(): Observable<any>;
100
105
  /**
101
106
  * Event fired when the inbox needs to be displayed. This event is only emitted if auto
102
107
  * launch message center is disabled.
108
+ *
103
109
  * @event show_inbox
104
110
  * @type {object}
105
111
  * @param {string} [messageId] The optional message ID.
@@ -107,6 +113,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
107
113
  onShowInbox(): Observable<any>;
108
114
  /**
109
115
  * Event fired when a push is received.
116
+ *
110
117
  * @event push
111
118
  * @type {object}
112
119
  * @param {string} message The push alert message.
@@ -120,6 +127,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
120
127
  onPushReceived(): Observable<any>;
121
128
  /**
122
129
  * Event fired when notification opened.
130
+ *
123
131
  * @event notification_opened
124
132
  * @type {object}
125
133
  * @param {string} message The push alert message.
@@ -132,6 +140,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
132
140
  onNotificationOpened(): Observable<any>;
133
141
  /**
134
142
  * Event fired when the user notification opt-in status changes.
143
+ *
135
144
  * @event notification_opt_in_status
136
145
  * @type {object}
137
146
  * @param {boolean} optIn If the user is opted in or not to user notifications.
@@ -155,6 +164,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
155
164
  * order to properly handle incoming push. If takeOff is called multiple times
156
165
  * in a session, or if the config is different than the previous sesssion, the
157
166
  * new config will not be used until the next app start.
167
+ *
158
168
  * @param {object} config The Urban Airship config.
159
169
  * @param {string} config.site Sets the cloud site, must be either EU or US.
160
170
  * @param {object} config.development The Urban Airship development config.
@@ -167,6 +177,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
167
177
  takeOff(config: any): Promise<any>;
168
178
  /**
169
179
  * Sets the Android notification config. Values not set will fallback to any values set in the config.xml.
180
+ *
170
181
  * @param {object} config The notification config.
171
182
  * @param {string} [config.icon] The name of the drawable resource to use as the notification icon.
172
183
  * @param {string} [config.largeIcon] The name of the drawable resource to use as the notification large icon.
@@ -176,6 +187,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
176
187
  /**
177
188
  * Sets the default behavior when the message center is launched from a push
178
189
  * notification. If set to false the message center must be manually launched.
190
+ *
179
191
  * @param {boolean} enabled true to automatically launch the default message center, false to disable.
180
192
  * @param {Function} [success] Success callback.
181
193
  * @param {function(message)} [failure] Failure callback.
@@ -184,6 +196,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
184
196
  setAutoLaunchDefaultMessageCenter(enabled: boolean): Promise<any>;
185
197
  /**
186
198
  * Enables or disables user notifications.
199
+ *
187
200
  * @param {boolean} enabled true to enable notifications, false to disable.
188
201
  * @param {Function} [success] Success callback.
189
202
  * @param {function(message)} [failure] Failure callback.
@@ -192,6 +205,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
192
205
  setUserNotificationsEnabled(enabled: boolean): Promise<any>;
193
206
  /**
194
207
  * Checks if user notifications are enabled or not.
208
+ *
195
209
  * @param {function(enabled)} success Success callback.
196
210
  * @param {boolean} success.enabled Flag indicating if user notifications is enabled or not.
197
211
  * @param {function(message)} [failure] Failure callback.
@@ -201,6 +215,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
201
215
  /**
202
216
  * Checks if app notifications are enabled or not. Its possible to have `userNotificationsEnabled`
203
217
  * but app notifications being disabled if the user opted out of notifications.
218
+ *
204
219
  * @param {function(enabled)} success Success callback.
205
220
  * @param {boolean} success.enabled Flag indicating if app notifications is enabled or not.
206
221
  * @param {function(message)} [failure] Failure callback.
@@ -209,6 +224,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
209
224
  isAppNotificationsEnabled(): Promise<any>;
210
225
  /**
211
226
  * Returns the channel ID.
227
+ *
212
228
  * @param {function(ID)} success The function to call on success.
213
229
  * @param {string} success.ID The channel ID string
214
230
  * @param {failureCallback} [failure] The function to call on failure.
@@ -217,6 +233,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
217
233
  getChannelID(): Promise<any>;
218
234
  /**
219
235
  * Returns the last notification that launched the application.
236
+ *
220
237
  * @param {boolean} clear true to clear the notification.
221
238
  * @param {function(push)} success The function to call on success.
222
239
  * @param {object} success.push The push message object containing data associated with a push notification.
@@ -229,6 +246,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
229
246
  getLaunchNotification(clear: boolean): Promise<any>;
230
247
  /**
231
248
  * Returns the last received deep link.
249
+ *
232
250
  * @param {boolean} clear true to clear the deep link.
233
251
  * @param {function(push)} success The function to call on success.
234
252
  * @param {string} success.deepLink The deep link.
@@ -238,6 +256,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
238
256
  getDeepLink(clear: boolean): Promise<any>;
239
257
  /**
240
258
  * Returns the tags as an array.
259
+ *
241
260
  * @param {function(tags)} success The function to call on success.
242
261
  * @param {Array} success.tags The tags as an array.
243
262
  * @param {failureCallback} [failure] The function to call on failure.
@@ -246,6 +265,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
246
265
  getTags(): Promise<any>;
247
266
  /**
248
267
  * Sets the tags.
268
+ *
249
269
  * @param {Array} tags an array of strings.
250
270
  * @param {Function} [success] Success callback.
251
271
  * @param {function(message)} [failure] Failure callback.
@@ -254,6 +274,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
254
274
  setTags(tags: string[]): Promise<any>;
255
275
  /**
256
276
  * Returns the alias.
277
+ *
257
278
  * @deprecated Deprecated since 6.7.0 - to be removed in a future version of the plugin - please use getNamedUser
258
279
  * @param {function(currentAlias)} success The function to call on success.
259
280
  * @param {string} success.currentAlias The alias as a string.
@@ -263,6 +284,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
263
284
  getAlias(): Promise<any>;
264
285
  /**
265
286
  * Sets the alias.
287
+ *
266
288
  * @deprecated Deprecated since 6.7.0 - to be removed in a future version of the plugin - please use setNamedUser
267
289
  * @param {string} alias string
268
290
  * @param {Function} [success] Success callback.
@@ -272,6 +294,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
272
294
  setAlias(alias: string): Promise<any>;
273
295
  /**
274
296
  * Checks if quiet time is enabled or not.
297
+ *
275
298
  * @param {function(enabled)} success Success callback.
276
299
  * @param {boolean} success.enabled Flag indicating if quiet time is enabled or not.
277
300
  * @param {function(message)} [failure] Failure callback.
@@ -280,6 +303,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
280
303
  isQuietTimeEnabled(): Promise<any>;
281
304
  /**
282
305
  * Enables or disables quiet time.
306
+ *
283
307
  * @param {boolean} enabled true to enable quiet time, false to disable.
284
308
  * @param {Function} [success] Success callback.
285
309
  * @param {function(message)} [failure] Failure callback.
@@ -288,6 +312,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
288
312
  setQuietTimeEnabled(enabled: boolean): Promise<any>;
289
313
  /**
290
314
  * Checks if the device is currently in quiet time.
315
+ *
291
316
  * @param {function(inQuietTime)} success Success callback.
292
317
  * @param {boolean} success.inQuietTime Flag indicating if quiet time is currently in effect.
293
318
  * @param {function(message)} [failure] Failure callback.
@@ -300,6 +325,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
300
325
  * "startMinute": Number,
301
326
  * "endHour": Number,
302
327
  * "endMinute": Number
328
+ *
303
329
  * @param {function(quietTime)} success The function to call on success.
304
330
  * @param {object} success.quietTime The quietTime object represents a timespan during
305
331
  * which notifications should be silenced.
@@ -309,6 +335,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
309
335
  getQuietTime(): Promise<any>;
310
336
  /**
311
337
  * Sets the quiet time.
338
+ *
312
339
  * @param {number} startHour for quiet time.
313
340
  * @param {number} startMinute for quiet time.
314
341
  * @param {number} endHour for quiet time.
@@ -325,6 +352,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
325
352
  * and prevent any events from uploading. Features that depend on analytics being
326
353
  * enabled may not work properly if it's disabled (reports, region triggers,
327
354
  * location segmentation, push to local time).
355
+ *
328
356
  * @param {boolean} enabled true to enable analytics, false to disable.
329
357
  * @param {Function} [success] Success callback.
330
358
  * @param {function(message)} [failure] Failure callback.
@@ -333,6 +361,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
333
361
  setAnalyticsEnabled(enabled: boolean): Promise<any>;
334
362
  /**
335
363
  * Checks if analytics is enabled or not.
364
+ *
336
365
  * @param {function(enabled)} success Success callback.
337
366
  * @param {boolean} success.enabled Flag indicating if analytics is enabled or not.
338
367
  * @param {function(message)} [failure] Failure callback.
@@ -341,6 +370,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
341
370
  isAnalyticsEnabled(): Promise<any>;
342
371
  /**
343
372
  * Returns the named user ID.
373
+ *
344
374
  * @param {function(namedUser)} success The function to call on success.
345
375
  * @param {string} success.namedUser The named user ID as a string.
346
376
  * @param {function(message)} [failure] Failure callback.
@@ -349,6 +379,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
349
379
  getNamedUser(): Promise<string>;
350
380
  /**
351
381
  * Sets the named user ID.
382
+ *
352
383
  * @param {string} namedUser identifier string.
353
384
  * @param {Function} [success] Success callback.
354
385
  * @param {function(message)} [failure] Failure callback.
@@ -357,6 +388,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
357
388
  setNamedUser(namedUser: string): Promise<any>;
358
389
  /**
359
390
  * Runs an Urban Airship action.
391
+ *
360
392
  * @param {string} actionName action as a string.
361
393
  * @param {*} actionValue
362
394
  * @param {function(result)} [success] The function to call on success.
@@ -383,12 +415,14 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
383
415
  editNamedUserAttributes(): AttributesEditor;
384
416
  /**
385
417
  * Creates an editor to modify the channel subscription lists.
418
+ *
386
419
  * @returns {ChannelSubscriptionListEditor} A subscription list editor instance.
387
420
  * @since 13.3.0
388
421
  */
389
422
  editChannelSubscriptionLists(): ChannelSubscriptionListEditor;
390
423
  /**
391
424
  * Creates an editor to modify the contact subscription lists.
425
+ *
392
426
  * @returns {ContactSubscriptionListEditor} A subscription list editor instance.
393
427
  * @since 13.3.0
394
428
  */
@@ -397,6 +431,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
397
431
  * Returns the current set of subscription lists for the current channel,
398
432
  * optionally applying pending subscription list changes that will be applied during the next channel update.
399
433
  * An empty set indicates that this contact is not subscribed to any lists.
434
+ *
400
435
  * @param {Function} [success] Success callback.
401
436
  * @param {string} failure.message The error message.
402
437
  */
@@ -405,12 +440,14 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
405
440
  * Returns the current set of subscription lists for the current contact,
406
441
  * optionally applying pending subscription list changes that will be applied during the next contact update.
407
442
  * An empty set indicates that this contact is not subscribed to any lists.
443
+ *
408
444
  * @param {Function} [success] Success callback.
409
445
  * @param {string} failure.message The error message.
410
446
  */
411
447
  getContactSubscriptionLists(): Promise<string[]>;
412
448
  /**
413
449
  * Sets an associated identifier for the Connect data stream.
450
+ *
414
451
  * @param key Custom key for identifier.
415
452
  * @param identifier The identifier value.
416
453
  * @param {Function} [success] Success callback.
@@ -420,6 +457,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
420
457
  setAssociatedIdentifier(key: string, identifier: string): Promise<void>;
421
458
  /**
422
459
  * Enables or disables Urban Airship location services.
460
+ *
423
461
  * @param {boolean} enabled true to enable location, false to disable.
424
462
  * @param {Function} [success] Success callback.
425
463
  * @param {function(message)} [failure] Failure callback.
@@ -428,6 +466,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
428
466
  setLocationEnabled(enabled: boolean): Promise<any>;
429
467
  /**
430
468
  * Checks if location is enabled or not.
469
+ *
431
470
  * @param {function(enabled)} success Success callback.
432
471
  * @param {boolean} success.enabled Flag indicating if location is enabled or not.
433
472
  * @param {function(message)} [failure] Failure callback.
@@ -437,6 +476,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
437
476
  isLocationEnabled(): Promise<any>;
438
477
  /**
439
478
  * Enables or disables background location.
479
+ *
440
480
  * @param {boolean} enabled true to enable background location, false to disable.
441
481
  * @param {Function} [success] Success callback.
442
482
  * @param {function(message)} [failure] Failure callback.
@@ -446,6 +486,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
446
486
  setBackgroundLocationEnabled(enabled: boolean): Promise<any>;
447
487
  /**
448
488
  * Checks if background location is enabled or not.
489
+ *
449
490
  * @param {function(enabled)} success Success callback.
450
491
  * @param {boolean} success.enabled Flag indicating if background location updates are enabled or not.
451
492
  * @param {function(message)} [failure] Failure callback.
@@ -455,6 +496,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
455
496
  isBackgroundLocationEnabled(): Promise<any>;
456
497
  /**
457
498
  * Displays the message center.
499
+ *
458
500
  * @param {Function} [success] Success callback.
459
501
  * @param {function(message)} [failure] Failure callback.
460
502
  * @param {string} failure.message The error message.
@@ -462,6 +504,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
462
504
  displayMessageCenter(): Promise<any>;
463
505
  /**
464
506
  * Dismiss the message center.
507
+ *
465
508
  * @param {Function} [success] Success callback.
466
509
  * @param {function(message)} [failure] Failure callback.
467
510
  * @param {string} failure.message The error message.
@@ -469,6 +512,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
469
512
  dismissMessageCenter(): Promise<any>;
470
513
  /**
471
514
  * Dismiss the inbox message.
515
+ *
472
516
  * @param {Function} [success] Success callback.
473
517
  * @param {function(message)} [failure] Failure callback.
474
518
  * @param {string} failure.message The error message.
@@ -476,6 +520,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
476
520
  dismissInboxMessage(): Promise<any>;
477
521
  /**
478
522
  * Dismiss the inbox message in the overlay.
523
+ *
479
524
  * @param {Function} [success] Success callback.
480
525
  * @param {function(message)} [failure] Failure callback.
481
526
  * @param {string} failure.message The error message.
@@ -490,6 +535,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
490
535
  * "listIconUrl": string, optional - The icon url for the message.
491
536
  * "isRead": boolean - The unread/read status of the message.
492
537
  * "extras": object - String to String map of any message extras.
538
+ *
493
539
  * @param {function(messages)} success The function to call on success.
494
540
  * @param {Array} success.messages The array of inbox messages.
495
541
  * @param {function(message)} [failure] Failure callback.
@@ -498,6 +544,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
498
544
  getInboxMessages(): Promise<any>;
499
545
  /**
500
546
  * Marks an inbox message read.
547
+ *
501
548
  * @param {string} messageId The ID of the message to mark as read.
502
549
  * @param {Function} [success] Success callback.
503
550
  * @param {function(message)} [failure] Failure callback.
@@ -506,6 +553,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
506
553
  markInboxMessageRead(messageId: string): Promise<any>;
507
554
  /**
508
555
  * Deletes an inbox message.
556
+ *
509
557
  * @param {string} messageId The ID of the message to delete.
510
558
  * @param {Function} [success] Success callback.
511
559
  * @param {function(message)} [failure] Failure callback.
@@ -514,6 +562,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
514
562
  deleteInboxMessage(messageId: string): Promise<any>;
515
563
  /**
516
564
  * Displays the inbox message using a full screen view.
565
+ *
517
566
  * @param {string} messageId The ID of the message to display.
518
567
  * @param {Function} [success] Success callback.
519
568
  * @param {function(message)} [failure] Failure callback.
@@ -525,6 +574,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
525
574
  * will automatically refresh on foreground or when a push arrives thats
526
575
  * associated with a message, but it can be useful when providing a refresh
527
576
  * button for the message listing.
577
+ *
528
578
  * @param {Function} [success] Success callback.
529
579
  * @param {function(message)} [failure] Failure callback.
530
580
  * @param {string} failure.message The error message.
@@ -532,6 +582,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
532
582
  refreshInbox(): Promise<any>;
533
583
  /**
534
584
  * Displays the inbox message using an overlay display.
585
+ *
535
586
  * @param {string} messageId The ID of the message to display.
536
587
  * @param {Function} [success] Success callback.
537
588
  * @param {function(message)} [failure] Failure callback.
@@ -541,6 +592,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
541
592
  overlayInboxMessage(messageId: string): Promise<any>;
542
593
  /**
543
594
  * Clears a notification by identifier.
595
+ *
544
596
  * @param {string} identifier The notification identifier.
545
597
  * @param {Function} [success] Success callback.
546
598
  * @param {function(message)} [failure] Failure callback.
@@ -548,6 +600,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
548
600
  clearNotification(identifier: string): Promise<any>;
549
601
  /**
550
602
  * Clears all notifications posted by the application.
603
+ *
551
604
  * @param {Function} [success] Success callback.
552
605
  * @param {function(message)} [failure] Failure callback.
553
606
  * @param {string} failure.message The error message.
@@ -557,12 +610,14 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
557
610
  * Gets currently active notifications.
558
611
  *
559
612
  * Note: On Android this functionality is only supported on Android M or higher.
613
+ *
560
614
  * @param {function(messages)} [success] Success callback.
561
615
  * @param {function(message)} [failure] Failure callback.
562
616
  */
563
617
  getActiveNotifications(): Promise<any>;
564
618
  /**
565
619
  * Enables or disables auto badge. Defaults to `NO`.
620
+ *
566
621
  * @param {boolean} enabled true to enable auto badge, false to disable.
567
622
  * @param {Function} [success] Success callback.
568
623
  * @param {function(message)} [failure] Failure callback.
@@ -571,6 +626,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
571
626
  setAutobadgeEnabled(enabled: boolean): Promise<any>;
572
627
  /**
573
628
  * Sets the badge number.
629
+ *
574
630
  * @param count number specified badge to set.
575
631
  * @param {Function} [success] Success callback.
576
632
  * @param {function(message)} [failure] Failure callback.
@@ -579,6 +635,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
579
635
  setBadgeNumber(count: number): Promise<any>;
580
636
  /**
581
637
  * Returns the current badge number.
638
+ *
582
639
  * @param {function(badgeNumber)} success The function to call on success.
583
640
  * @param {int} success.badgeNumber The current application badge number.
584
641
  * @param {function(message)} [failure] Failure callback.
@@ -587,6 +644,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
587
644
  getBadgeNumber(): Promise<any>;
588
645
  /**
589
646
  * Clears the badge.
647
+ *
590
648
  * @param {Function} [success] Success callback.
591
649
  * @param {function(message)} [failure] Failure callback.
592
650
  * @param {string} failure.message The error message.
@@ -595,6 +653,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
595
653
  /**
596
654
  * Sets the iOS notification types. Specify the combination of
597
655
  * badges, sound and alerts that are desired.
656
+ *
598
657
  * @param types specified notification types.
599
658
  * @param {Function} [success] Success callback.
600
659
  * @param {function(message)} [failure] Failure callback.
@@ -604,6 +663,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
604
663
  /**
605
664
  * Sets the iOS presentation options. Specify the combination of
606
665
  * badges, sound and alerts that are desired.
666
+ *
607
667
  * @param options types specified presentation options.
608
668
  * @param {Function} [success] Success callback.
609
669
  * @param {function(message)} [failure] Failure callback.
@@ -612,6 +672,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
612
672
  setPresentationOptions(options: PresentationOptions): Promise<any>;
613
673
  /**
614
674
  * Checks if notification sound is enabled or not.
675
+ *
615
676
  * @param {function(enabled)} success Success callback.
616
677
  * @param {boolean} success.enabled Flag indicating if sound is enabled or not.
617
678
  * @param {function(message)} [failure] Failure callback.
@@ -620,6 +681,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
620
681
  isSoundEnabled(): Promise<any>;
621
682
  /**
622
683
  * Enables or disables notification sound.
684
+ *
623
685
  * @param {boolean} enabled true to enable sound, false to disable.
624
686
  * @param {Function} [success] Success callback.
625
687
  * @param {function(message)} [failure] Failure callback.
@@ -628,6 +690,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
628
690
  setSoundEnabled(enabled: boolean): Promise<any>;
629
691
  /**
630
692
  * Checks if notification vibration is enabled or not.
693
+ *
631
694
  * @param {function(enabled)} success Success callback.
632
695
  * @param {boolean} success.enabled Flag indicating if vibration is enabled or not.
633
696
  * @param {function(message)} [failure] Failure callback.
@@ -636,6 +699,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
636
699
  isVibrateEnabled(): Promise<any>;
637
700
  /**
638
701
  * Enables or disables notification vibration.
702
+ *
639
703
  * @param {boolean} enabled true to enable vibration, false to disable.
640
704
  * @param {Function} [success] Success callback.
641
705
  * @param {function(message)} [failure] Failure callback.
@@ -644,6 +708,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
644
708
  setVibrateEnabled(enabled: boolean): Promise<any>;
645
709
  /**
646
710
  * Adds a custom event.
711
+ *
647
712
  * @param {object} event The custom event object.
648
713
  * @param {string} event.name The event's name.
649
714
  * @param {number} [event.value] The event's value.
@@ -656,6 +721,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
656
721
  addCustomEvent(event: object): Promise<any>;
657
722
  /**
658
723
  * Initiates screen tracking for a specific app screen, must be called once per tracked screen.
724
+ *
659
725
  * @param {string} screen The screen's string identifier.
660
726
  * @param {Function} [success] Success callback.
661
727
  * @param {function(message)} [failure] Failure callback.
@@ -665,6 +731,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
665
731
  trackScreen(screen: string): Promise<any>;
666
732
  /**
667
733
  * Enables features, adding them to the set of currently enabled features.
734
+ *
668
735
  * @param {Array<string>} features The features to enable.
669
736
  * @param {Function} [success] Success callback.
670
737
  * @param {function(message)} [failure] Failure callback.
@@ -674,6 +741,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
674
741
  enableFeature(features: string[]): Promise<any>;
675
742
  /**
676
743
  * Disables features, removing them from the set of currently enabled features.
744
+ *
677
745
  * @param {Array<string>} features The features to disable.
678
746
  * @param {Function} [success] Success callback.
679
747
  * @param {function(message)} [failure] Failure callback.
@@ -683,6 +751,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
683
751
  disableFeature(features: string[]): Promise<any>;
684
752
  /**
685
753
  * Sets the current enabled features, replacing any currently enabled features with the given set.
754
+ *
686
755
  * @param {Array<string>} features The features to set as enabled.
687
756
  * @param {Function} [success] Success callback.
688
757
  * @param {function(message)} [failure] Failure callback.
@@ -692,6 +761,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
692
761
  setEnabledFeatures(features: string[]): Promise<any>;
693
762
  /**
694
763
  * Gets the current enabled features.
764
+ *
695
765
  * @param {Function} [success] Success callback.
696
766
  * @param {function(message)} [failure] Failure callback.
697
767
  * @param {string} failure.message The error message.
@@ -700,6 +770,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
700
770
  getEnabledFeatures(): Promise<any>;
701
771
  /**
702
772
  * Checks if all of the given features are enabled.
773
+ *
703
774
  * @param {Array<string>} features The features to check.
704
775
  * @param {Function} [success] Success callback.
705
776
  * @param {function(message)} [failure] Failure callback.
@@ -709,6 +780,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
709
780
  isFeatureEnabled(features: string[]): Promise<any>;
710
781
  /**
711
782
  * Returns the configuration of the Preference Center with the given ID trough a callback method.
783
+ *
712
784
  * @param {string} preferenceCenterId The preference center ID.
713
785
  * @param {Function} [success] Success callback.
714
786
  * @param {function(message)} [failure] Failure callback.
@@ -718,6 +790,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
718
790
  getPreferenceCenterConfig(preferenceCenterId: string): Promise<any>;
719
791
  /**
720
792
  * Opens the Preference Center with the given preferenceCenterId.
793
+ *
721
794
  * @param {string} prenferenceCenterId The preference center ID.
722
795
  * @param {Function} [success] Success callback.
723
796
  * @param {function(message)} [failure] Failure callback.
@@ -727,6 +800,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
727
800
  openPreferenceCenter(prenferenceCenterId: string): Promise<any>;
728
801
  /**
729
802
  * Overrides the locale setting.
803
+ *
730
804
  * @param {string} locale language and optional country code.
731
805
  * @param {function} [success] Success callback.
732
806
  * @param {function(message)} [failure] Failure callback.
@@ -736,6 +810,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
736
810
  setCurrentLocale(locale: string): Promise<any>;
737
811
  /**
738
812
  * Returns the currently set locale.
813
+ *
739
814
  * @param {function(locale)} [success] Success callback.
740
815
  * @param {string} success.locale The locale as a string.
741
816
  * @param {function(message)} [failure] Failure callback.
@@ -745,6 +820,7 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
745
820
  getCurrentLocale(): Promise<string>;
746
821
  /**
747
822
  * Resets the current locale.
823
+ *
748
824
  * @param {function} [success] Success callback.
749
825
  * @param {function(message)} [failure] Failure callback.
750
826
  * @param {string} failure.message The error message.
@@ -752,3 +828,5 @@ export declare class UrbanAirShip extends AwesomeCordovaNativePlugin {
752
828
  */
753
829
  clearLocale(): Promise<any>;
754
830
  }
831
+
832
+ export declare const UrbanAirShip: UrbanAirShipOriginal;