capacitor-jpush-core 0.0.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/dist/docs.json ADDED
@@ -0,0 +1,651 @@
1
+ {
2
+ "api": {
3
+ "name": "JPushPlugin",
4
+ "slug": "jpushplugin",
5
+ "docs": "",
6
+ "tags": [],
7
+ "methods": [
8
+ {
9
+ "name": "setupJPush",
10
+ "signature": "() => Promise<void>",
11
+ "parameters": [],
12
+ "returns": "Promise<void>",
13
+ "tags": [],
14
+ "docs": "",
15
+ "complexTypes": [],
16
+ "slug": "setupjpush"
17
+ },
18
+ {
19
+ "name": "getRegistrationID",
20
+ "signature": "() => Promise<RegistrationIDResult>",
21
+ "parameters": [],
22
+ "returns": "Promise<RegistrationIDResult>",
23
+ "tags": [],
24
+ "docs": "",
25
+ "complexTypes": [
26
+ "RegistrationIDResult"
27
+ ],
28
+ "slug": "getregistrationid"
29
+ },
30
+ {
31
+ "name": "setAlias",
32
+ "signature": "(options: AliasOptions) => Promise<void>",
33
+ "parameters": [
34
+ {
35
+ "name": "options",
36
+ "docs": "",
37
+ "type": "AliasOptions"
38
+ }
39
+ ],
40
+ "returns": "Promise<void>",
41
+ "tags": [],
42
+ "docs": "",
43
+ "complexTypes": [
44
+ "AliasOptions"
45
+ ],
46
+ "slug": "setalias"
47
+ },
48
+ {
49
+ "name": "deleteAlias",
50
+ "signature": "(options?: DeleteAlias | undefined) => Promise<void>",
51
+ "parameters": [
52
+ {
53
+ "name": "options",
54
+ "docs": "",
55
+ "type": "DeleteAlias | undefined"
56
+ }
57
+ ],
58
+ "returns": "Promise<void>",
59
+ "tags": [],
60
+ "docs": "",
61
+ "complexTypes": [
62
+ "DeleteAlias"
63
+ ],
64
+ "slug": "deletealias"
65
+ },
66
+ {
67
+ "name": "setTags",
68
+ "signature": "(options: SetTagsOptions) => Promise<void>",
69
+ "parameters": [
70
+ {
71
+ "name": "options",
72
+ "docs": "",
73
+ "type": "SetTagsOptions"
74
+ }
75
+ ],
76
+ "returns": "Promise<void>",
77
+ "tags": [],
78
+ "docs": "",
79
+ "complexTypes": [
80
+ "SetTagsOptions"
81
+ ],
82
+ "slug": "settags"
83
+ },
84
+ {
85
+ "name": "addTags",
86
+ "signature": "(options: SetTagsOptions) => Promise<void>",
87
+ "parameters": [
88
+ {
89
+ "name": "options",
90
+ "docs": "",
91
+ "type": "SetTagsOptions"
92
+ }
93
+ ],
94
+ "returns": "Promise<void>",
95
+ "tags": [],
96
+ "docs": "",
97
+ "complexTypes": [
98
+ "SetTagsOptions"
99
+ ],
100
+ "slug": "addtags"
101
+ },
102
+ {
103
+ "name": "deleteTags",
104
+ "signature": "(options: SetTagsOptions) => Promise<void>",
105
+ "parameters": [
106
+ {
107
+ "name": "options",
108
+ "docs": "",
109
+ "type": "SetTagsOptions"
110
+ }
111
+ ],
112
+ "returns": "Promise<void>",
113
+ "tags": [],
114
+ "docs": "",
115
+ "complexTypes": [
116
+ "SetTagsOptions"
117
+ ],
118
+ "slug": "deletetags"
119
+ },
120
+ {
121
+ "name": "cleanTags",
122
+ "signature": "() => Promise<void>",
123
+ "parameters": [],
124
+ "returns": "Promise<void>",
125
+ "tags": [],
126
+ "docs": "",
127
+ "complexTypes": [],
128
+ "slug": "cleantags"
129
+ },
130
+ {
131
+ "name": "checkPermissions",
132
+ "signature": "() => Promise<PermissionStatus>",
133
+ "parameters": [],
134
+ "returns": "Promise<PermissionStatus>",
135
+ "tags": [],
136
+ "docs": "",
137
+ "complexTypes": [
138
+ "PermissionStatus"
139
+ ],
140
+ "slug": "checkpermissions"
141
+ },
142
+ {
143
+ "name": "requestPermissions",
144
+ "signature": "() => Promise<PermissionStatus>",
145
+ "parameters": [],
146
+ "returns": "Promise<PermissionStatus>",
147
+ "tags": [],
148
+ "docs": "",
149
+ "complexTypes": [
150
+ "PermissionStatus"
151
+ ],
152
+ "slug": "requestpermissions"
153
+ },
154
+ {
155
+ "name": "setBadge",
156
+ "signature": "(options: SetBadgeOptions) => Promise<void>",
157
+ "parameters": [
158
+ {
159
+ "name": "options",
160
+ "docs": "",
161
+ "type": "SetBadgeOptions"
162
+ }
163
+ ],
164
+ "returns": "Promise<void>",
165
+ "tags": [],
166
+ "docs": "",
167
+ "complexTypes": [
168
+ "SetBadgeOptions"
169
+ ],
170
+ "slug": "setbadge"
171
+ },
172
+ {
173
+ "name": "addListener",
174
+ "signature": "(eventName: JPushEventName.NotificationReceived, listener: (data: PushNotificationData) => void) => Promise<PluginListenerHandle>",
175
+ "parameters": [
176
+ {
177
+ "name": "eventName",
178
+ "docs": "",
179
+ "type": "JPushEventName.NotificationReceived"
180
+ },
181
+ {
182
+ "name": "listener",
183
+ "docs": "",
184
+ "type": "(data: PushNotificationData) => void"
185
+ }
186
+ ],
187
+ "returns": "Promise<PluginListenerHandle>",
188
+ "tags": [],
189
+ "docs": "",
190
+ "complexTypes": [
191
+ "PluginListenerHandle",
192
+ "JPushEventName",
193
+ "PushNotificationData"
194
+ ],
195
+ "slug": "addlistenerjpusheventnamenotificationreceived-"
196
+ },
197
+ {
198
+ "name": "addListener",
199
+ "signature": "(eventName: JPushEventName.NotificationOpened, listener: (data: PushNotificationData) => void) => Promise<PluginListenerHandle>",
200
+ "parameters": [
201
+ {
202
+ "name": "eventName",
203
+ "docs": "",
204
+ "type": "JPushEventName.NotificationOpened"
205
+ },
206
+ {
207
+ "name": "listener",
208
+ "docs": "",
209
+ "type": "(data: PushNotificationData) => void"
210
+ }
211
+ ],
212
+ "returns": "Promise<PluginListenerHandle>",
213
+ "tags": [],
214
+ "docs": "",
215
+ "complexTypes": [
216
+ "PluginListenerHandle",
217
+ "JPushEventName",
218
+ "PushNotificationData"
219
+ ],
220
+ "slug": "addlistenerjpusheventnamenotificationopened-"
221
+ },
222
+ {
223
+ "name": "addListener",
224
+ "signature": "(eventName: JPushEventName.CustomMessageReceived, listener: (data: CustomMessageData) => void) => Promise<PluginListenerHandle>",
225
+ "parameters": [
226
+ {
227
+ "name": "eventName",
228
+ "docs": "",
229
+ "type": "JPushEventName.CustomMessageReceived"
230
+ },
231
+ {
232
+ "name": "listener",
233
+ "docs": "",
234
+ "type": "(data: CustomMessageData) => void"
235
+ }
236
+ ],
237
+ "returns": "Promise<PluginListenerHandle>",
238
+ "tags": [],
239
+ "docs": "",
240
+ "complexTypes": [
241
+ "PluginListenerHandle",
242
+ "JPushEventName",
243
+ "CustomMessageData"
244
+ ],
245
+ "slug": "addlistenerjpusheventnamecustommessagereceived-"
246
+ },
247
+ {
248
+ "name": "addListener",
249
+ "signature": "(eventName: JPushEventName.RegistrationCompleted, listener: (data: RegistrationCompletedData) => void) => Promise<PluginListenerHandle>",
250
+ "parameters": [
251
+ {
252
+ "name": "eventName",
253
+ "docs": "",
254
+ "type": "JPushEventName.RegistrationCompleted"
255
+ },
256
+ {
257
+ "name": "listener",
258
+ "docs": "",
259
+ "type": "(data: RegistrationCompletedData) => void"
260
+ }
261
+ ],
262
+ "returns": "Promise<PluginListenerHandle>",
263
+ "tags": [],
264
+ "docs": "",
265
+ "complexTypes": [
266
+ "PluginListenerHandle",
267
+ "JPushEventName",
268
+ "RegistrationCompletedData"
269
+ ],
270
+ "slug": "addlistenerjpusheventnameregistrationcompleted-"
271
+ },
272
+ {
273
+ "name": "addListener",
274
+ "signature": "(eventName: JPushEventName.RegistrationFailed, listener: (data: RegistrationFailedData) => void) => Promise<PluginListenerHandle>",
275
+ "parameters": [
276
+ {
277
+ "name": "eventName",
278
+ "docs": "",
279
+ "type": "JPushEventName.RegistrationFailed"
280
+ },
281
+ {
282
+ "name": "listener",
283
+ "docs": "",
284
+ "type": "(data: RegistrationFailedData) => void"
285
+ }
286
+ ],
287
+ "returns": "Promise<PluginListenerHandle>",
288
+ "tags": [],
289
+ "docs": "",
290
+ "complexTypes": [
291
+ "PluginListenerHandle",
292
+ "JPushEventName",
293
+ "RegistrationFailedData"
294
+ ],
295
+ "slug": "addlistenerjpusheventnameregistrationfailed-"
296
+ }
297
+ ],
298
+ "properties": []
299
+ },
300
+ "interfaces": [
301
+ {
302
+ "name": "RegistrationIDResult",
303
+ "slug": "registrationidresult",
304
+ "docs": "",
305
+ "tags": [],
306
+ "methods": [],
307
+ "properties": [
308
+ {
309
+ "name": "registrationID",
310
+ "tags": [],
311
+ "docs": "",
312
+ "complexTypes": [],
313
+ "type": "string"
314
+ }
315
+ ]
316
+ },
317
+ {
318
+ "name": "AliasOptions",
319
+ "slug": "aliasoptions",
320
+ "docs": "",
321
+ "tags": [],
322
+ "methods": [],
323
+ "properties": [
324
+ {
325
+ "name": "alias",
326
+ "tags": [],
327
+ "docs": "",
328
+ "complexTypes": [],
329
+ "type": "string"
330
+ },
331
+ {
332
+ "name": "seq",
333
+ "tags": [],
334
+ "docs": "",
335
+ "complexTypes": [],
336
+ "type": "number | undefined"
337
+ }
338
+ ]
339
+ },
340
+ {
341
+ "name": "DeleteAlias",
342
+ "slug": "deletealias",
343
+ "docs": "",
344
+ "tags": [],
345
+ "methods": [],
346
+ "properties": [
347
+ {
348
+ "name": "seq",
349
+ "tags": [],
350
+ "docs": "",
351
+ "complexTypes": [],
352
+ "type": "number | undefined"
353
+ }
354
+ ]
355
+ },
356
+ {
357
+ "name": "SetTagsOptions",
358
+ "slug": "settagsoptions",
359
+ "docs": "",
360
+ "tags": [],
361
+ "methods": [],
362
+ "properties": [
363
+ {
364
+ "name": "tags",
365
+ "tags": [],
366
+ "docs": "",
367
+ "complexTypes": [],
368
+ "type": "string[]"
369
+ },
370
+ {
371
+ "name": "seq",
372
+ "tags": [],
373
+ "docs": "",
374
+ "complexTypes": [],
375
+ "type": "number | undefined"
376
+ }
377
+ ]
378
+ },
379
+ {
380
+ "name": "PermissionStatus",
381
+ "slug": "permissionstatus",
382
+ "docs": "权限状态接口",
383
+ "tags": [],
384
+ "methods": [],
385
+ "properties": [
386
+ {
387
+ "name": "permission",
388
+ "tags": [],
389
+ "docs": "权限状态\n- prompt: 首次申请,询问\n- prompt-with-rationale:每次都询问\n- granted:已获取权限\n- denied:权限已拒绝",
390
+ "complexTypes": [],
391
+ "type": "'prompt' | 'prompt-with-rationale' | 'granted' | 'denied'"
392
+ }
393
+ ]
394
+ },
395
+ {
396
+ "name": "SetBadgeOptions",
397
+ "slug": "setbadgeoptions",
398
+ "docs": "",
399
+ "tags": [],
400
+ "methods": [],
401
+ "properties": [
402
+ {
403
+ "name": "badge",
404
+ "tags": [],
405
+ "docs": "",
406
+ "complexTypes": [],
407
+ "type": "number"
408
+ }
409
+ ]
410
+ },
411
+ {
412
+ "name": "PluginListenerHandle",
413
+ "slug": "pluginlistenerhandle",
414
+ "docs": "",
415
+ "tags": [],
416
+ "methods": [],
417
+ "properties": [
418
+ {
419
+ "name": "remove",
420
+ "tags": [],
421
+ "docs": "",
422
+ "complexTypes": [],
423
+ "type": "() => Promise<void>"
424
+ }
425
+ ]
426
+ },
427
+ {
428
+ "name": "PushNotificationData",
429
+ "slug": "pushnotificationdata",
430
+ "docs": "",
431
+ "tags": [],
432
+ "methods": [],
433
+ "properties": [
434
+ {
435
+ "name": "title",
436
+ "tags": [],
437
+ "docs": "",
438
+ "complexTypes": [],
439
+ "type": "string | undefined"
440
+ },
441
+ {
442
+ "name": "body",
443
+ "tags": [],
444
+ "docs": "",
445
+ "complexTypes": [],
446
+ "type": "string | undefined"
447
+ },
448
+ {
449
+ "name": "subtitle",
450
+ "tags": [],
451
+ "docs": "",
452
+ "complexTypes": [],
453
+ "type": "string | undefined"
454
+ },
455
+ {
456
+ "name": "badge",
457
+ "tags": [],
458
+ "docs": "",
459
+ "complexTypes": [],
460
+ "type": "number | undefined"
461
+ },
462
+ {
463
+ "name": "sound",
464
+ "tags": [],
465
+ "docs": "",
466
+ "complexTypes": [],
467
+ "type": "string | undefined"
468
+ },
469
+ {
470
+ "name": "extras",
471
+ "tags": [],
472
+ "docs": "",
473
+ "complexTypes": [
474
+ "Record"
475
+ ],
476
+ "type": "Record<string, any>"
477
+ },
478
+ {
479
+ "name": "messageId",
480
+ "tags": [],
481
+ "docs": "",
482
+ "complexTypes": [],
483
+ "type": "string | undefined"
484
+ },
485
+ {
486
+ "name": "notificationId",
487
+ "tags": [],
488
+ "docs": "",
489
+ "complexTypes": [],
490
+ "type": "number | undefined"
491
+ },
492
+ {
493
+ "name": "type",
494
+ "tags": [],
495
+ "docs": "",
496
+ "complexTypes": [],
497
+ "type": "'notification' | 'custom' | 'silent' | undefined"
498
+ },
499
+ {
500
+ "name": "rawData",
501
+ "tags": [],
502
+ "docs": "",
503
+ "complexTypes": [
504
+ "Record"
505
+ ],
506
+ "type": "Record<string, any>"
507
+ }
508
+ ]
509
+ },
510
+ {
511
+ "name": "CustomMessageData",
512
+ "slug": "custommessagedata",
513
+ "docs": "",
514
+ "tags": [],
515
+ "methods": [],
516
+ "properties": [
517
+ {
518
+ "name": "title",
519
+ "tags": [],
520
+ "docs": "",
521
+ "complexTypes": [],
522
+ "type": "string | undefined"
523
+ },
524
+ {
525
+ "name": "body",
526
+ "tags": [],
527
+ "docs": "",
528
+ "complexTypes": [],
529
+ "type": "string | undefined"
530
+ },
531
+ {
532
+ "name": "extras",
533
+ "tags": [],
534
+ "docs": "",
535
+ "complexTypes": [
536
+ "Record"
537
+ ],
538
+ "type": "Record<string, any>"
539
+ },
540
+ {
541
+ "name": "messageId",
542
+ "tags": [],
543
+ "docs": "",
544
+ "complexTypes": [],
545
+ "type": "string | undefined"
546
+ },
547
+ {
548
+ "name": "type",
549
+ "tags": [],
550
+ "docs": "",
551
+ "complexTypes": [],
552
+ "type": "'notification' | 'custom' | 'silent' | undefined"
553
+ }
554
+ ]
555
+ },
556
+ {
557
+ "name": "RegistrationCompletedData",
558
+ "slug": "registrationcompleteddata",
559
+ "docs": "",
560
+ "tags": [],
561
+ "methods": [],
562
+ "properties": [
563
+ {
564
+ "name": "registrationID",
565
+ "tags": [],
566
+ "docs": "",
567
+ "complexTypes": [],
568
+ "type": "string"
569
+ }
570
+ ]
571
+ },
572
+ {
573
+ "name": "RegistrationFailedData",
574
+ "slug": "registrationfaileddata",
575
+ "docs": "",
576
+ "tags": [],
577
+ "methods": [],
578
+ "properties": [
579
+ {
580
+ "name": "errorCode",
581
+ "tags": [],
582
+ "docs": "",
583
+ "complexTypes": [],
584
+ "type": "number"
585
+ },
586
+ {
587
+ "name": "errorMessage",
588
+ "tags": [],
589
+ "docs": "",
590
+ "complexTypes": [],
591
+ "type": "string"
592
+ }
593
+ ]
594
+ }
595
+ ],
596
+ "enums": [
597
+ {
598
+ "name": "JPushEventName",
599
+ "slug": "jpusheventname",
600
+ "members": [
601
+ {
602
+ "name": "NotificationReceived",
603
+ "value": "'notificationReceived'",
604
+ "tags": [],
605
+ "docs": "通知接收事件"
606
+ },
607
+ {
608
+ "name": "NotificationOpened",
609
+ "value": "'notificationOpened'",
610
+ "tags": [],
611
+ "docs": "通知点击事件"
612
+ },
613
+ {
614
+ "name": "CustomMessageReceived",
615
+ "value": "'customMessageReceived'",
616
+ "tags": [],
617
+ "docs": "自定义消息接收事件"
618
+ },
619
+ {
620
+ "name": "RegistrationCompleted",
621
+ "value": "'registrationCompleted'",
622
+ "tags": [],
623
+ "docs": "注册完成事件"
624
+ },
625
+ {
626
+ "name": "RegistrationFailed",
627
+ "value": "'registrationFailed'",
628
+ "tags": [],
629
+ "docs": "注册失败事件"
630
+ }
631
+ ]
632
+ }
633
+ ],
634
+ "typeAliases": [
635
+ {
636
+ "name": "Record",
637
+ "slug": "record",
638
+ "docs": "Construct a type with a set of properties K of type T",
639
+ "types": [
640
+ {
641
+ "text": "{\r\n [P in K]: T;\r\n}",
642
+ "complexTypes": [
643
+ "K",
644
+ "T"
645
+ ]
646
+ }
647
+ ]
648
+ }
649
+ ],
650
+ "pluginConfigs": []
651
+ }