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