forked from DefinitelyTyped/DefinitelyTyped
-
Notifications
You must be signed in to change notification settings - Fork 0
/
urbanairship-cordova.d.ts
477 lines (412 loc) · 15.7 KB
/
urbanairship-cordova.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
// Type definitions for phonegap-ua-push 3.4.1
// Project: https://github.com/urbanairship/phonegap-ua-push
// Definitions by: Justin Unterreiner <https://github.com/Justin-Credible>
// Definitions: https://github.com/borisyankov/DefinitelyTyped
//#region API Types
/**
* This is a wrapper "namespace" for the various types used by the UAirship module.
*/
declare module UrbanAirshipPlugin {
//#region API Definitions
interface UrbanAirshipStatic {
/**
* The enumeration values for use with setNotificationTypes().
*/
notificationType: {
none: number;
badge: number;
sound: number;
alert: number;
}
/**
* Enables or disables user notifications on the device.
* This will prompt users to opt-in to notifications on iOS.
*
* @param enabled Set to true to enable notifications, false to disable.
* @param callback The function to call on completion.
*/
setUserNotificationsEnabled(enabled: boolean, callback: (status: string) => void): void;
/**
* Checks if user notifications are enabled or not.
*
* @param callback The function to call on completion.
*/
isUserNotificationsEnabled(callback: (enabled: boolean) => void): void;
/**
* Get the push identifier for the device. The channel ID is used to send
* messages to the device for testing, and is the canonical identifier for
* the device in Urban Airship.
*
* @param callback The function to call on completion.
*/
getChannelID(callback: (id: string) => void): void;
/**
* Returns the push message object that contains the data associated with a
* push notification. The extras dictionary can contain arbitrary key/value
* data that you use in your application.
*
* @param clear Set to true to clear the notification.
* @param callback The function to call on completion.
*/
getLaunchNotification(clear: boolean, callback: (push: UrbanAirshipPlugin.PushEvent) => void): void;
/**
* Enables or disables quiet time.
*
* @param enabled Set to true to enable quiet time, false to disable.
* @param callback The function to call on completion.
*/
setQuietTimeEnabled(enabled: boolean, callback: () => void): void;
/**
* Checks if quiet time is enabled or not.
*
* @param callback The function to call on completion.
*/
isQuietTimeEnabled(callback: (enabled: boolean) => void): void;
/**
* Set the quiet time for the device.
*
* @param startHour The start hour for quiet time.
* @param startMinute The start minute for quiet time.
* @param endHour The end hour for quiet time.
* @param endMinute the end minute for quiet time.
* @param callback The function to call on completion.
*/
setQuietTime(startHour: number, startMinute: number, endHour: number, endMinute: number, callback: () => void): void;
/**
* Get the current quiet time. The quietTime object represents a timespan
* during which notifications should be silenced. The typical use case is
* to expose a preference to your users so that they can enable this setting
* and specify an interval during which they do not wish to be disturbed.
*
* @param callback The function to call on completion.
*/
getQuietTime(callback: (quietTime: UrbanAirshipPlugin.QuietTimeTimeSpan) => void): void;
/**
* Checks if quiet time is currently in effect.
*
* @param callback The function to call on completion.
*/
isInQuietTime(callback: (inQuietTime: boolean) => void): void;
/**
* (iOS Only)
*
* On iOS, registration for push requires specifying what
* combination of badges, sound and alerts are desired. This function
* must be explicitly called in order to begin the registration process.
*
* For example:
*
* UAirship.setNotificationTypes(UAirship.notificationType.sound |
* UAirship.notificationType.alert);
*
* @param bitmask The notification types to set.
* @param callback The function to call on completion.
*/
setNotificationTypes(bitmask: number, callback: () => void): void;
/**
* (iOS Only)
*
* Set whether the UA Autobadge feature is enabled.
*
* @param enabled Set to true to enable Autobadge, false to disable.
* @param callback The function to call on completion.
*/
setAutobadgeEnabled(enabled: boolean, callback: () => void): void;
/**
* (iOS Only)
*
* Set the current application badge number.
*
* @param badge The number to use for the badge.
* @param callback The function to call on completion.
*/
setBadgeNumber(badge: number, callback: () => void): void;
/**
* (iOS Only)
*
* Gets the current application badge number.
*
* @param callback The function to call on completion.
*/
getBadgeNumber(callback: (badgeNumber: number) => void): void;
/**
* (iOS Only)
*
* Reset the badge number to zero.
*
* @param callback The function to call on completion.
*/
resetBadge(callback: () => void): void;
/**
* (Android Only)
*
* Clears the notifications posted by the application.
*
* @param callback The function to call on completion.
*/
clearNotifications(callback: () => void): void;
/**
* (Android only, iOS sound settings come in the push)
*
* Set whether the device makes sound on push.
*
* @param enabled Set to true to enable sound, false to disable.
* @param callback The function to call on completion.
*/
setSoundEnabled(enabled: boolean, callback: () => void): void;
/**
* (Android Only)
*
* Checks if sound is enabled or not.
*
* @param callback The function to call on completion.
*/
isSoundEnabled(callback: (enabled: boolean) => void): void;
/**
* (Android Only)
*
* Set whether the device vibrates on push.
*
* @param enabled Set to true to enable vibration, false to disable.
* @param callback The function to call on completion.
*/
setVibrateEnabled(enabled: boolean, callback: () => void): void;
/**
* (Android Only)
*
* Checks if vibration is enabled or not.
*
* @param callback The function to call on completion.
*/
isVibrateEnabled(callback: (enabled: boolean) => void): void;
/**
* Sets tags for the device.
*
* @param tags An array of tags.
* @param callback The function to call on completion.
*/
setTags(tags: string[], callback: () => void): void;
/**
* Returns the tags for the device.
*
* @param callback The function to call on completion.
*/
getTags(callback: (tags: string[]) => void): void;
/**
* Set alias for the device.
*
* @param alias The alias to set for this device.
* @param callback The function to call on completion.
*/
setAlias(alias: string, callback: () => void): void;
/**
* Gets the alias for this device.
*
* @param callback The function to call on completion.
*/
getAlias(callback: (alias: string) => void): void;
/**
* Set the named user ID for this device.
*
* @param namedUser The named user ID.
* @param callback The function to call on completion.
*/
setNamedUser(namedUserId: string, callback: () => void): void;
/**
* Gets the named user ID for this device.
*
* @param callback The function to call on completion.
*/
getNamedUser(callback: (namedUserId: string) => void): void;
/**
* Fluent API to edit the named user tag groups by adding or removing
* tags, then applying the changes.
*
* For example:
*
* UAirship.editNamedUserTagGroups()
* .addTags("loyalty", ["platinum-member", "gold-member"])
* .removeTags("loyalty", ["silver-member", "bronze-member"])
* .apply()
*
* @returns The chainable API instance.
*/
editNamedUserTagGroups(): UrbanAirshipPlugin.EditNamedUserTagGroupsApi;
/**
* Fluent API to edit the channel tag groups by adding or removing tags,
* then applying the changes.
*
* For exmaple:
*
* UAirship.editChannelTagGroups()
* .addTags("loyalty", ["platinum-member", "gold-member"])
* .removeTags("loyalty", ["silver-member", "bronze-member"])
* .apply()
*/
editChannelTagGroups(): UrbanAirshipPlugin.EditChannelTagGroupsApi;
/**
* Enables or disables analytics. Disabling analytics will delete any
* locally stored events and prevent any events from uploading. Features
* that depend on analytics being enabled may not work properly if it’s
* disabled (reports, region triggers, location segmentation, push to
* local time).
*
* @param enabled Set to true to enable analytics, false to disable.
* @param callback The function to call on completion.
*/
setAnalyticsEnabled(enabled: boolean, callback: () => void): void;
/**
* Checks if analytics is enabled or not.
*
* @param callback The function to call on completion.
*/
isAnalyticsEnabled(callback: (enabled: boolean) => void): void;
/**
* Runs an Urban Airship action.
*
* @param actionName The name of the action to run.
* @param actionValue The value for the action.
* @param callback The function to call on completion.
*/
runAction(actionName: string, actionValue: string, callback: (result: UrbanAirshipPlugin.RunActionResult) => void): void;
/**
* Enables or disables Urban Airship location services on the device.
*
* @param enabled Set to true to enable location, false to disable.
* @param callback The function to call on completion.
*/
setLocationEnabled(enabled: boolean, callback: () => void): void;
/**
* Checks if location is enabled or not.
*
* @param callback The function to call on completion.
*/
isLocationEnabled(callback: (enabled: boolean) => void): void;
/**
* Enables or disables background location on the device.
*
* @param enabled Set to true to enable background location, false to disable.
* @param callback The function to call on completion.
*/
setBackgroundLocationEnabled(enabled: boolean, callback: () => void): void;
/**
* Checks if background location updates are enabled or not.
*
* @param callback The function to call on completion.
*/
isBackgroundLocationEnabled(callback: () => void): void;
/**
* Records the current location of the device.
*
* @param callback The function to call on completion.
*/
recordCurrentLocation(callback: () => void): void;
}
/**
* Describes the chainable API object returned by editNamedUserTagGroups().
*/
interface EditNamedUserTagGroupsApi {
/**
* Used to add the given tags to the given tag group.
*
* @param tagGroup The tag group to add tags to.
* @param tags The tags to add to the group.
*
* @returns The chainable API instance.
*/
addTags: (tagGroup: string, tags: string[]) => EditNamedUserTagGroupsApi;
/**
* Used to remove the given tags from the given tag group.
*
* @param tagGroup The tag group to remove tags from.
* @param tags The tags to remove from the group.
*
* @returns The chainable API instance.
*/
removeTags: (tagGroup: string, tags: string[]) => EditNamedUserTagGroupsApi;
/**
* Used to apply the changes from the chained API call.
*
* @param callback The optional function to call on completion.
*/
apply: (callback?: () => void) => void;
}
/**
* Describes the chainable API object returned by editChannelTagGroups().
*/
interface EditChannelTagGroupsApi {
/**
* Used to add the given tags to the given tag group.
*
* @param tagGroup The tag group to add tags to.
* @param tags The tags to add to the group.
*
* @returns The chainable API instance.
*/
addTags: (tagGroup: string, tags: string[]) => EditChannelTagGroupsApi;
/**
* Used to remove the given tags from the given tag group.
*
* @param tagGroup The tag group to remove tags from.
* @param tags The tags to remove from the group.
*
* @returns The chainable API instance.
*/
removeTags: (tagGroup: string, tags: string[]) => EditChannelTagGroupsApi;
/**
* Used to apply the changes from the chained API call.
*
* @param callback The optional function to call on completion.
*/
apply: (callback?: () => void) => void;
}
//#endregion
//#region Data Types
interface PushEvent extends Event {
message: string;
extras: { [key: string]: any };
}
interface RegistrationEvent extends Event {
error: string;
/**
* The channel ID for the device.
*/
channelID: string;
/**
* (iOS Only)
*
* The push token for the device.
*/
deviceToken: string;
}
/**
* Represents a timespan during which notifications should be silenced.
*
* For example, 10PM - 6AM would be:
* { startHour: 22, startMinute: 0, endHour: 6, endMinute: 0 }
*/
interface QuietTimeTimeSpan {
startHour: number,
startMinute: number,
endHour: number,
endMinute: number
}
/**
* The result of the runAction() call.
*/
interface RunActionResult {
error: string;
value: any;
}
//#endregion
}
//#endregion
//#region UAirship Global Variable Declaration
declare var UAirship: UrbanAirshipPlugin.UrbanAirshipStatic;
//#endregion
//#region Additional Document Events
interface Document {
addEventListener(type: "urbanairship.push", listener: (ev: UrbanAirshipPlugin.PushEvent) => void, useCapture?: boolean): void;
addEventListener(type: "urbanairship.registration", listener: (ev: UrbanAirshipPlugin.RegistrationEvent) => void, useCapture?: boolean): void;
}
//#endregion