@blackbaud/skyux-lib-addin-client 3.1.1 → 4.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.
Files changed (30) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +2 -1
  3. package/blackbaud-skyux-lib-addin-client.d.ts +2 -1
  4. package/bundles/blackbaud-skyux-lib-addin-client.umd.js +37 -225
  5. package/bundles/blackbaud-skyux-lib-addin-client.umd.js.map +1 -1
  6. package/documentation.json +1298 -0
  7. package/esm2015/blackbaud-skyux-lib-addin-client.js +2 -2
  8. package/esm2015/public-api.js +4 -0
  9. package/esm2015/src/addin-client.service.js +9 -8
  10. package/esm2015/src/events/addin-event-handler-instance.js +1 -1
  11. package/esm2015/src/events/addin-event.js +1 -1
  12. package/esm2015/src/events/index.js +1 -1
  13. package/fesm2015/blackbaud-skyux-lib-addin-client.js +8 -6
  14. package/fesm2015/blackbaud-skyux-lib-addin-client.js.map +1 -1
  15. package/package.json +9 -16
  16. package/{public_api.d.ts → public-api.d.ts} +0 -0
  17. package/src/addin-client.service.d.ts +3 -0
  18. package/CHANGELOG.md +0 -80
  19. package/blackbaud-skyux-lib-addin-client.metadata.json +0 -1
  20. package/bundles/blackbaud-skyux-lib-addin-client.umd.min.js +0 -16
  21. package/bundles/blackbaud-skyux-lib-addin-client.umd.min.js.map +0 -1
  22. package/esm2015/public_api.js +0 -4
  23. package/esm5/blackbaud-skyux-lib-addin-client.js +0 -5
  24. package/esm5/public_api.js +0 -4
  25. package/esm5/src/addin-client.service.js +0 -200
  26. package/esm5/src/events/addin-event-handler-instance.js +0 -10
  27. package/esm5/src/events/addin-event.js +0 -11
  28. package/esm5/src/events/index.js +0 -3
  29. package/fesm5/blackbaud-skyux-lib-addin-client.js +0 -224
  30. package/fesm5/blackbaud-skyux-lib-addin-client.js.map +0 -1
package/documentation.json ADDED
@@ -0,0 +1,1298 @@
1
+ {
2
+ "anchorIds": {
3
+ "AddinClientService": "class-addinclientservice",
4
+ "AddinEvent": "class-addinevent",
5
+ "AddinEventHandlerInstance": "class-addineventhandlerinstance"
6
+ },
7
+ "typedoc": {
8
+ "id": 0,
9
+ "name": "@blackbaud/skyux-lib-addin-client",
10
+ "kind": 1,
11
+ "kindString": "Project",
12
+ "flags": {},
13
+ "originalName": "",
14
+ "children": [
15
+ {
16
+ "id": 1,
17
+ "name": "AddinClientService",
18
+ "kind": 128,
19
+ "kindString": "Class",
20
+ "flags": {},
21
+ "decorators": [
22
+ {
23
+ "name": "Injectable",
24
+ "type": {
25
+ "type": "reference",
26
+ "name": "Injectable"
27
+ },
28
+ "arguments": {}
29
+ }
30
+ ],
31
+ "children": [
32
+ {
33
+ "id": 2,
34
+ "name": "constructor",
35
+ "kind": 512,
36
+ "kindString": "Constructor",
37
+ "flags": {},
38
+ "sources": [
39
+ {
40
+ "fileName": "projects/addin-client/src/src/addin-client.service.ts",
41
+ "line": 73,
42
+ "character": 2
43
+ }
44
+ ],
45
+ "signatures": [
46
+ {
47
+ "id": 3,
48
+ "name": "new AddinClientService",
49
+ "kind": 16384,
50
+ "kindString": "Constructor signature",
51
+ "flags": {},
52
+ "type": {
53
+ "type": "reference",
54
+ "id": 1,
55
+ "name": "AddinClientService"
56
+ }
57
+ }
58
+ ]
59
+ },
60
+ {
61
+ "id": 4,
62
+ "name": "addinClient",
63
+ "kind": 1024,
64
+ "kindString": "Property",
65
+ "flags": {
66
+ "isPublic": true,
67
+ "isReadonly": true
68
+ },
69
+ "sources": [
70
+ {
71
+ "fileName": "projects/addin-client/src/src/addin-client.service.ts",
72
+ "line": 36,
73
+ "character": 18
74
+ }
75
+ ],
76
+ "type": {
77
+ "type": "reference",
78
+ "name": "AddinClient"
79
+ }
80
+ },
81
+ {
82
+ "id": 6,
83
+ "name": "args",
84
+ "kind": 1024,
85
+ "kindString": "Property",
86
+ "flags": {
87
+ "isPublic": true
88
+ },
89
+ "sources": [
90
+ {
91
+ "fileName": "projects/addin-client/src/src/addin-client.service.ts",
92
+ "line": 40,
93
+ "character": 9
94
+ }
95
+ ],
96
+ "type": {
97
+ "type": "reference",
98
+ "typeArguments": [
99
+ {
100
+ "type": "reference",
101
+ "name": "AddinClientInitArgs"
102
+ }
103
+ ],
104
+ "name": "Observable"
105
+ },
106
+ "defaultValue": "..."
107
+ },
108
+ {
109
+ "id": 7,
110
+ "name": "buttonClick",
111
+ "kind": 1024,
112
+ "kindString": "Property",
113
+ "flags": {
114
+ "isPublic": true
115
+ },
116
+ "comment": {
117
+ "shortText": "Event emitted for button add-ins indicating that the button was clicked."
118
+ },
119
+ "sources": [
120
+ {
121
+ "fileName": "projects/addin-client/src/src/addin-client.service.ts",
122
+ "line": 46,
123
+ "character": 9
124
+ }
125
+ ],
126
+ "type": {
127
+ "type": "reference",
128
+ "typeArguments": [
129
+ {
130
+ "type": "intrinsic",
131
+ "name": "any"
132
+ }
133
+ ],
134
+ "name": "EventEmitter"
135
+ },
136
+ "defaultValue": "..."
137
+ },
138
+ {
139
+ "id": 9,
140
+ "name": "flyoutNextClick",
141
+ "kind": 1024,
142
+ "kindString": "Property",
143
+ "flags": {
144
+ "isPublic": true
145
+ },
146
+ "comment": {
147
+ "shortText": "Event emitted for flyout add-ins indicating that the next button was clicked."
148
+ },
149
+ "sources": [
150
+ {
151
+ "fileName": "projects/addin-client/src/src/addin-client.service.ts",
152
+ "line": 56,
153
+ "character": 9
154
+ }
155
+ ],
156
+ "type": {
157
+ "type": "reference",
158
+ "typeArguments": [
159
+ {
160
+ "type": "intrinsic",
161
+ "name": "any"
162
+ }
163
+ ],
164
+ "name": "EventEmitter"
165
+ },
166
+ "defaultValue": "..."
167
+ },
168
+ {
169
+ "id": 10,
170
+ "name": "flyoutPreviousClick",
171
+ "kind": 1024,
172
+ "kindString": "Property",
173
+ "flags": {
174
+ "isPublic": true
175
+ },
176
+ "comment": {
177
+ "shortText": "Event emitted for flyout add-ins indicating that the previous button was clicked."
178
+ },
179
+ "sources": [
180
+ {
181
+ "fileName": "projects/addin-client/src/src/addin-client.service.ts",
182
+ "line": 61,
183
+ "character": 9
184
+ }
185
+ ],
186
+ "type": {
187
+ "type": "reference",
188
+ "typeArguments": [
189
+ {
190
+ "type": "intrinsic",
191
+ "name": "any"
192
+ }
193
+ ],
194
+ "name": "EventEmitter"
195
+ },
196
+ "defaultValue": "..."
197
+ },
198
+ {
199
+ "id": 11,
200
+ "name": "helpClick",
201
+ "kind": 1024,
202
+ "kindString": "Property",
203
+ "flags": {
204
+ "isPublic": true
205
+ },
206
+ "comment": {
207
+ "shortText": "Event emitted for tile add-ins indicating that the help button was clicked."
208
+ },
209
+ "sources": [
210
+ {
211
+ "fileName": "projects/addin-client/src/src/addin-client.service.ts",
212
+ "line": 66,
213
+ "character": 9
214
+ }
215
+ ],
216
+ "type": {
217
+ "type": "reference",
218
+ "typeArguments": [
219
+ {
220
+ "type": "intrinsic",
221
+ "name": "any"
222
+ }
223
+ ],
224
+ "name": "EventEmitter"
225
+ },
226
+ "defaultValue": "..."
227
+ },
228
+ {
229
+ "id": 12,
230
+ "name": "settingsClick",
231
+ "kind": 1024,
232
+ "kindString": "Property",
233
+ "flags": {
234
+ "isPublic": true
235
+ },
236
+ "comment": {
237
+ "shortText": "Event emitted for tile add-ins indicating that the settings button was clicked."
238
+ },
239
+ "sources": [
240
+ {
241
+ "fileName": "projects/addin-client/src/src/addin-client.service.ts",
242
+ "line": 71,
243
+ "character": 9
244
+ }
245
+ ],
246
+ "type": {
247
+ "type": "reference",
248
+ "typeArguments": [
249
+ {
250
+ "type": "intrinsic",
251
+ "name": "any"
252
+ }
253
+ ],
254
+ "name": "EventEmitter"
255
+ },
256
+ "defaultValue": "..."
257
+ },
258
+ {
259
+ "id": 8,
260
+ "name": "updateContext",
261
+ "kind": 1024,
262
+ "kindString": "Property",
263
+ "flags": {
264
+ "isPublic": true
265
+ },
266
+ "comment": {
267
+ "shortText": "Event emitted for add-ins when context information has been updated"
268
+ },
269
+ "sources": [
270
+ {
271
+ "fileName": "projects/addin-client/src/src/addin-client.service.ts",
272
+ "line": 51,
273
+ "character": 9
274
+ }
275
+ ],
276
+ "type": {
277
+ "type": "reference",
278
+ "typeArguments": [
279
+ {
280
+ "type": "intrinsic",
281
+ "name": "any"
282
+ }
283
+ ],
284
+ "name": "EventEmitter"
285
+ },
286
+ "defaultValue": "..."
287
+ },
288
+ {
289
+ "id": 49,
290
+ "name": "addEventHandler",
291
+ "kind": 2048,
292
+ "kindString": "Method",
293
+ "flags": {
294
+ "isPublic": true
295
+ },
296
+ "sources": [
297
+ {
298
+ "fileName": "projects/addin-client/src/src/addin-client.service.ts",
299
+ "line": 221,
300
+ "character": 9
301
+ }
302
+ ],
303
+ "signatures": [
304
+ {
305
+ "id": 50,
306
+ "name": "addEventHandler",
307
+ "kind": 4096,
308
+ "kindString": "Call signature",
309
+ "flags": {},
310
+ "comment": {
311
+ "shortText": "Registers an event handler for the provided event type.",
312
+ "returns": "AddinEventHandlerInstance\n"
313
+ },
314
+ "parameters": [
315
+ {
316
+ "id": 51,
317
+ "name": "eventType",
318
+ "kind": 32768,
319
+ "kindString": "Parameter",
320
+ "flags": {},
321
+ "comment": {
322
+ "shortText": "The event type to register."
323
+ },
324
+ "type": {
325
+ "type": "intrinsic",
326
+ "name": "string"
327
+ }
328
+ }
329
+ ],
330
+ "type": {
331
+ "type": "reference",
332
+ "id": 62,
333
+ "name": "AddinEventHandlerInstance"
334
+ }
335
+ }
336
+ ]
337
+ },
338
+ {
339
+ "id": 37,
340
+ "name": "closeFlyout",
341
+ "kind": 2048,
342
+ "kindString": "Method",
343
+ "flags": {
344
+ "isPublic": true
345
+ },
346
+ "sources": [
347
+ {
348
+ "fileName": "projects/addin-client/src/src/addin-client.service.ts",
349
+ "line": 181,
350
+ "character": 9
351
+ }
352
+ ],
353
+ "signatures": [
354
+ {
355
+ "id": 38,
356
+ "name": "closeFlyout",
357
+ "kind": 4096,
358
+ "kindString": "Call signature",
359
+ "flags": {},
360
+ "comment": {
361
+ "shortText": "Requests the host page to close the flyout add-in."
362
+ },
363
+ "type": {
364
+ "type": "intrinsic",
365
+ "name": "void"
366
+ }
367
+ }
368
+ ]
369
+ },
370
+ {
371
+ "id": 13,
372
+ "name": "closeModal",
373
+ "kind": 2048,
374
+ "kindString": "Method",
375
+ "flags": {
376
+ "isPublic": true
377
+ },
378
+ "sources": [
379
+ {
380
+ "fileName": "projects/addin-client/src/src/addin-client.service.ts",
381
+ "line": 107,
382
+ "character": 9
383
+ }
384
+ ],
385
+ "signatures": [
386
+ {
387
+ "id": 14,
388
+ "name": "closeModal",
389
+ "kind": 4096,
390
+ "kindString": "Call signature",
391
+ "flags": {},
392
+ "comment": {
393
+ "shortText": "Informs the host to close this modal add-in.\nShould only be used from within the modal add-in and not the parent add-in."
394
+ },
395
+ "parameters": [
396
+ {
397
+ "id": 15,
398
+ "name": "args",
399
+ "kind": 32768,
400
+ "kindString": "Parameter",
401
+ "flags": {},
402
+ "comment": {
403
+ "shortText": "Arguments to provide a context object back to the parent add-in.\n"
404
+ },
405
+ "type": {
406
+ "type": "reference",
407
+ "name": "AddinClientCloseModalArgs"
408
+ }
409
+ }
410
+ ],
411
+ "type": {
412
+ "type": "intrinsic",
413
+ "name": "void"
414
+ }
415
+ }
416
+ ]
417
+ },
418
+ {
419
+ "id": 19,
420
+ "name": "destroy",
421
+ "kind": 2048,
422
+ "kindString": "Method",
423
+ "flags": {
424
+ "isPublic": true
425
+ },
426
+ "sources": [
427
+ {
428
+ "fileName": "projects/addin-client/src/src/addin-client.service.ts",
429
+ "line": 125,
430
+ "character": 9
431
+ }
432
+ ],
433
+ "signatures": [
434
+ {
435
+ "id": 20,
436
+ "name": "destroy",
437
+ "kind": 4096,
438
+ "kindString": "Call signature",
439
+ "flags": {},
440
+ "comment": {
441
+ "shortText": "Cleans up the AddinClient, releasing all resources."
442
+ },
443
+ "type": {
444
+ "type": "intrinsic",
445
+ "name": "void"
446
+ }
447
+ }
448
+ ]
449
+ },
450
+ {
451
+ "id": 29,
452
+ "name": "getAuthToken",
453
+ "kind": 2048,
454
+ "kindString": "Method",
455
+ "flags": {
456
+ "isPublic": true
457
+ },
458
+ "sources": [
459
+ {
460
+ "fileName": "projects/addin-client/src/src/addin-client.service.ts",
461
+ "line": 156,
462
+ "character": 9
463
+ }
464
+ ],
465
+ "signatures": [
466
+ {
467
+ "id": 30,
468
+ "name": "getAuthToken",
469
+ "kind": 4096,
470
+ "kindString": "Call signature",
471
+ "flags": {},
472
+ "comment": {
473
+ "tags": [
474
+ {
475
+ "tag": "deprecated",
476
+ "text": "Use getUserIdentityToken\n"
477
+ }
478
+ ]
479
+ },
480
+ "type": {
481
+ "type": "reference",
482
+ "typeArguments": [
483
+ {
484
+ "type": "intrinsic",
485
+ "name": "string"
486
+ }
487
+ ],
488
+ "name": "Observable"
489
+ }
490
+ }
491
+ ]
492
+ },
493
+ {
494
+ "id": 27,
495
+ "name": "getUserIdentityToken",
496
+ "kind": 2048,
497
+ "kindString": "Method",
498
+ "flags": {
499
+ "isPublic": true
500
+ },
501
+ "sources": [
502
+ {
503
+ "fileName": "projects/addin-client/src/src/addin-client.service.ts",
504
+ "line": 149,
505
+ "character": 9
506
+ }
507
+ ],
508
+ "signatures": [
509
+ {
510
+ "id": 28,
511
+ "name": "getUserIdentityToken",
512
+ "kind": 4096,
513
+ "kindString": "Call signature",
514
+ "flags": {},
515
+ "comment": {
516
+ "shortText": "Requests a user identity token for the current user.",
517
+ "returns": "Returns an observable which will publish the token value.\n"
518
+ },
519
+ "type": {
520
+ "type": "reference",
521
+ "typeArguments": [
522
+ {
523
+ "type": "intrinsic",
524
+ "name": "string"
525
+ }
526
+ ],
527
+ "name": "Observable"
528
+ }
529
+ }
530
+ ]
531
+ },
532
+ {
533
+ "id": 47,
534
+ "name": "hideWait",
535
+ "kind": 2048,
536
+ "kindString": "Method",
537
+ "flags": {
538
+ "isPublic": true
539
+ },
540
+ "sources": [
541
+ {
542
+ "fileName": "projects/addin-client/src/src/addin-client.service.ts",
543
+ "line": 212,
544
+ "character": 9
545
+ }
546
+ ],
547
+ "signatures": [
548
+ {
549
+ "id": 48,
550
+ "name": "hideWait",
551
+ "kind": 4096,
552
+ "kindString": "Call signature",
553
+ "flags": {},
554
+ "comment": {
555
+ "shortText": "Requests the host page to hide a page blocking wait indicator."
556
+ },
557
+ "type": {
558
+ "type": "intrinsic",
559
+ "name": "void"
560
+ }
561
+ }
562
+ ]
563
+ },
564
+ {
565
+ "id": 21,
566
+ "name": "navigate",
567
+ "kind": 2048,
568
+ "kindString": "Method",
569
+ "flags": {
570
+ "isPublic": true
571
+ },
572
+ "sources": [
573
+ {
574
+ "fileName": "projects/addin-client/src/src/addin-client.service.ts",
575
+ "line": 133,
576
+ "character": 9
577
+ }
578
+ ],
579
+ "signatures": [
580
+ {
581
+ "id": 22,
582
+ "name": "navigate",
583
+ "kind": 4096,
584
+ "kindString": "Call signature",
585
+ "flags": {},
586
+ "comment": {
587
+ "shortText": "Requests the host page to navigate."
588
+ },
589
+ "parameters": [
590
+ {
591
+ "id": 23,
592
+ "name": "args",
593
+ "kind": 32768,
594
+ "kindString": "Parameter",
595
+ "flags": {},
596
+ "comment": {
597
+ "shortText": "Arguments describing the navigation request.\n"
598
+ },
599
+ "type": {
600
+ "type": "reference",
601
+ "name": "AddinClientNavigateArgs"
602
+ }
603
+ }
604
+ ],
605
+ "type": {
606
+ "type": "intrinsic",
607
+ "name": "void"
608
+ }
609
+ }
610
+ ]
611
+ },
612
+ {
613
+ "id": 24,
614
+ "name": "openHelp",
615
+ "kind": 2048,
616
+ "kindString": "Method",
617
+ "flags": {
618
+ "isPublic": true
619
+ },
620
+ "sources": [
621
+ {
622
+ "fileName": "projects/addin-client/src/src/addin-client.service.ts",
623
+ "line": 141,
624
+ "character": 9
625
+ }
626
+ ],
627
+ "signatures": [
628
+ {
629
+ "id": 25,
630
+ "name": "openHelp",
631
+ "kind": 4096,
632
+ "kindString": "Call signature",
633
+ "flags": {},
634
+ "comment": {
635
+ "shortText": "Informs the host to open the help tab with the specified help key."
636
+ },
637
+ "parameters": [
638
+ {
639
+ "id": 26,
640
+ "name": "args",
641
+ "kind": 32768,
642
+ "kindString": "Parameter",
643
+ "flags": {},
644
+ "comment": {
645
+ "shortText": "Arguments for launching the help tab.\n"
646
+ },
647
+ "type": {
648
+ "type": "reference",
649
+ "name": "AddinClientOpenHelpArgs"
650
+ }
651
+ }
652
+ ],
653
+ "type": {
654
+ "type": "intrinsic",
655
+ "name": "void"
656
+ }
657
+ }
658
+ ]
659
+ },
660
+ {
661
+ "id": 52,
662
+ "name": "sendEvent",
663
+ "kind": 2048,
664
+ "kindString": "Method",
665
+ "flags": {
666
+ "isPublic": true
667
+ },
668
+ "sources": [
669
+ {
670
+ "fileName": "projects/addin-client/src/src/addin-client.service.ts",
671
+ "line": 246,
672
+ "character": 9
673
+ }
674
+ ],
675
+ "signatures": [
676
+ {
677
+ "id": 53,
678
+ "name": "sendEvent",
679
+ "kind": 4096,
680
+ "kindString": "Call signature",
681
+ "flags": {},
682
+ "comment": {
683
+ "shortText": "Sends an event to be handled by the host page.\nSupported for Blackbaud internal only",
684
+ "returns": "Returns an observable which will complete when the add-in host page receives the\nmessage. The request will fail if a subsequent event occurs, for the same event type, within\n200 milliseconds. A failure can also occur if an event type is not one of the supported types\nfrom the host page.",
685
+ "tags": [
686
+ {
687
+ "tag": "see",
688
+ "text": "AddinClientInitArgs#supportedEventTypes\n"
689
+ }
690
+ ]
691
+ },
692
+ "parameters": [
693
+ {
694
+ "id": 54,
695
+ "name": "args",
696
+ "kind": 32768,
697
+ "kindString": "Parameter",
698
+ "flags": {},
699
+ "comment": {
700
+ "shortText": "The event arguments to be sent to the host page."
701
+ },
702
+ "type": {
703
+ "type": "reference",
704
+ "name": "AddinClientEventArgs"
705
+ }
706
+ }
707
+ ],
708
+ "type": {
709
+ "type": "reference",
710
+ "typeArguments": [
711
+ {
712
+ "type": "intrinsic",
713
+ "name": "void"
714
+ }
715
+ ],
716
+ "name": "Observable"
717
+ }
718
+ }
719
+ ]
720
+ },
721
+ {
722
+ "id": 39,
723
+ "name": "showConfirm",
724
+ "kind": 2048,
725
+ "kindString": "Method",
726
+ "flags": {
727
+ "isPublic": true
728
+ },
729
+ "sources": [
730
+ {
731
+ "fileName": "projects/addin-client/src/src/addin-client.service.ts",
732
+ "line": 190,
733
+ "character": 9
734
+ }
735
+ ],
736
+ "signatures": [
737
+ {
738
+ "id": 40,
739
+ "name": "showConfirm",
740
+ "kind": 4096,
741
+ "kindString": "Call signature",
742
+ "flags": {},
743
+ "comment": {
744
+ "shortText": "Requests the host page to show a confirm dialog.",
745
+ "returns": "Returns an observable which will publish the confirm action value.\n"
746
+ },
747
+ "parameters": [
748
+ {
749
+ "id": 41,
750
+ "name": "args",
751
+ "kind": 32768,
752
+ "kindString": "Parameter",
753
+ "flags": {},
754
+ "comment": {
755
+ "shortText": "Arguments for showing a confirm dialog."
756
+ },
757
+ "type": {
758
+ "type": "reference",
759
+ "name": "AddinClientShowConfirmArgs"
760
+ }
761
+ }
762
+ ],
763
+ "type": {
764
+ "type": "reference",
765
+ "typeArguments": [
766
+ {
767
+ "type": "intrinsic",
768
+ "name": "string"
769
+ }
770
+ ],
771
+ "name": "Observable"
772
+ }
773
+ }
774
+ ]
775
+ },
776
+ {
777
+ "id": 42,
778
+ "name": "showError",
779
+ "kind": 2048,
780
+ "kindString": "Method",
781
+ "flags": {
782
+ "isPublic": true
783
+ },
784
+ "sources": [
785
+ {
786
+ "fileName": "projects/addin-client/src/src/addin-client.service.ts",
787
+ "line": 198,
788
+ "character": 9
789
+ }
790
+ ],
791
+ "signatures": [
792
+ {
793
+ "id": 43,
794
+ "name": "showError",
795
+ "kind": 4096,
796
+ "kindString": "Call signature",
797
+ "flags": {},
798
+ "comment": {
799
+ "shortText": "Informs the host to show an error dialog."
800
+ },
801
+ "parameters": [
802
+ {
803
+ "id": 44,
804
+ "name": "args",
805
+ "kind": 32768,
806
+ "kindString": "Parameter",
807
+ "flags": {},
808
+ "comment": {
809
+ "shortText": "Arguments for showing an error dialog.\n"
810
+ },
811
+ "type": {
812
+ "type": "reference",
813
+ "name": "AddinClientShowErrorArgs"
814
+ }
815
+ }
816
+ ],
817
+ "type": {
818
+ "type": "intrinsic",
819
+ "name": "void"
820
+ }
821
+ }
822
+ ]
823
+ },
824
+ {
825
+ "id": 34,
826
+ "name": "showFlyout",
827
+ "kind": 2048,
828
+ "kindString": "Method",
829
+ "flags": {
830
+ "isPublic": true
831
+ },
832
+ "sources": [
833
+ {
834
+ "fileName": "projects/addin-client/src/src/addin-client.service.ts",
835
+ "line": 173,
836
+ "character": 9
837
+ }
838
+ ],
839
+ "signatures": [
840
+ {
841
+ "id": 35,
842
+ "name": "showFlyout",
843
+ "kind": 4096,
844
+ "kindString": "Call signature",
845
+ "flags": {},
846
+ "comment": {
847
+ "shortText": "Requests the host page to launch a flyout add-in.",
848
+ "returns": "Returns an observable that will notify when the flyout add-in is closed.\n"
849
+ },
850
+ "parameters": [
851
+ {
852
+ "id": 36,
853
+ "name": "args",
854
+ "kind": 32768,
855
+ "kindString": "Parameter",
856
+ "flags": {},
857
+ "comment": {
858
+ "shortText": "Arguments for launching the flyout."
859
+ },
860
+ "type": {
861
+ "type": "reference",
862
+ "name": "AddinClientShowFlyoutArgs"
863
+ }
864
+ }
865
+ ],
866
+ "type": {
867
+ "type": "reference",
868
+ "typeArguments": [
869
+ {
870
+ "type": "intrinsic",
871
+ "name": "void"
872
+ }
873
+ ],
874
+ "name": "Observable"
875
+ }
876
+ }
877
+ ]
878
+ },
879
+ {
880
+ "id": 16,
881
+ "name": "showModal",
882
+ "kind": 2048,
883
+ "kindString": "Method",
884
+ "flags": {
885
+ "isPublic": true
886
+ },
887
+ "sources": [
888
+ {
889
+ "fileName": "projects/addin-client/src/src/addin-client.service.ts",
890
+ "line": 117,
891
+ "character": 9
892
+ }
893
+ ],
894
+ "signatures": [
895
+ {
896
+ "id": 17,
897
+ "name": "showModal",
898
+ "kind": 4096,
899
+ "kindString": "Call signature",
900
+ "flags": {},
901
+ "comment": {
902
+ "shortText": "Requests the host page to launch a modal add-in.",
903
+ "returns": "Returns an observable that will publish a value when the modal add-in is closed.\nObservables will publish values with context data passed from the modal add-in's closeModal call.\n"
904
+ },
905
+ "parameters": [
906
+ {
907
+ "id": 18,
908
+ "name": "args",
909
+ "kind": 32768,
910
+ "kindString": "Parameter",
911
+ "flags": {},
912
+ "comment": {
913
+ "shortText": "Arguments for launching the modal."
914
+ },
915
+ "type": {
916
+ "type": "reference",
917
+ "name": "AddinClientShowModalArgs"
918
+ }
919
+ }
920
+ ],
921
+ "type": {
922
+ "type": "reference",
923
+ "typeArguments": [
924
+ {
925
+ "type": "intrinsic",
926
+ "name": "any"
927
+ }
928
+ ],
929
+ "name": "Observable"
930
+ }
931
+ }
932
+ ]
933
+ },
934
+ {
935
+ "id": 31,
936
+ "name": "showToast",
937
+ "kind": 2048,
938
+ "kindString": "Method",
939
+ "flags": {
940
+ "isPublic": true
941
+ },
942
+ "sources": [
943
+ {
944
+ "fileName": "projects/addin-client/src/src/addin-client.service.ts",
945
+ "line": 164,
946
+ "character": 9
947
+ }
948
+ ],
949
+ "signatures": [
950
+ {
951
+ "id": 32,
952
+ "name": "showToast",
953
+ "kind": 4096,
954
+ "kindString": "Call signature",
955
+ "flags": {},
956
+ "comment": {
957
+ "shortText": "Informs the host to show a toast message."
958
+ },
959
+ "parameters": [
960
+ {
961
+ "id": 33,
962
+ "name": "args",
963
+ "kind": 32768,
964
+ "kindString": "Parameter",
965
+ "flags": {},
966
+ "comment": {
967
+ "shortText": "Arguments for showing a toast.\n"
968
+ },
969
+ "type": {
970
+ "type": "reference",
971
+ "name": "AddinClientShowToastArgs"
972
+ }
973
+ }
974
+ ],
975
+ "type": {
976
+ "type": "intrinsic",
977
+ "name": "void"
978
+ }
979
+ }
980
+ ]
981
+ },
982
+ {
983
+ "id": 45,
984
+ "name": "showWait",
985
+ "kind": 2048,
986
+ "kindString": "Method",
987
+ "flags": {
988
+ "isPublic": true
989
+ },
990
+ "sources": [
991
+ {
992
+ "fileName": "projects/addin-client/src/src/addin-client.service.ts",
993
+ "line": 205,
994
+ "character": 9
995
+ }
996
+ ],
997
+ "signatures": [
998
+ {
999
+ "id": 46,
1000
+ "name": "showWait",
1001
+ "kind": 4096,
1002
+ "kindString": "Call signature",
1003
+ "flags": {},
1004
+ "comment": {
1005
+ "shortText": "Requests the host page to show a page blocking wait indicator."
1006
+ },
1007
+ "type": {
1008
+ "type": "intrinsic",
1009
+ "name": "void"
1010
+ }
1011
+ }
1012
+ ]
1013
+ }
1014
+ ],
1015
+ "groups": [
1016
+ {
1017
+ "title": "Constructors",
1018
+ "kind": 512,
1019
+ "children": [
1020
+ 2
1021
+ ]
1022
+ },
1023
+ {
1024
+ "title": "Properties",
1025
+ "kind": 1024,
1026
+ "children": [
1027
+ 4,
1028
+ 6,
1029
+ 7,
1030
+ 9,
1031
+ 10,
1032
+ 11,
1033
+ 12,
1034
+ 8
1035
+ ]
1036
+ },
1037
+ {
1038
+ "title": "Methods",
1039
+ "kind": 2048,
1040
+ "children": [
1041
+ 49,
1042
+ 37,
1043
+ 13,
1044
+ 19,
1045
+ 29,
1046
+ 27,
1047
+ 47,
1048
+ 21,
1049
+ 24,
1050
+ 52,
1051
+ 39,
1052
+ 42,
1053
+ 34,
1054
+ 16,
1055
+ 31,
1056
+ 45
1057
+ ]
1058
+ }
1059
+ ],
1060
+ "sources": [
1061
+ {
1062
+ "fileName": "projects/addin-client/src/src/addin-client.service.ts",
1063
+ "line": 35,
1064
+ "character": 13
1065
+ }
1066
+ ]
1067
+ },
1068
+ {
1069
+ "id": 55,
1070
+ "name": "AddinEvent",
1071
+ "kind": 128,
1072
+ "kindString": "Class",
1073
+ "flags": {},
1074
+ "comment": {
1075
+ "shortText": "Contains data for an add-in event and allows you to indicate that an event\nhas been processed"
1076
+ },
1077
+ "children": [
1078
+ {
1079
+ "id": 56,
1080
+ "name": "constructor",
1081
+ "kind": 512,
1082
+ "kindString": "Constructor",
1083
+ "flags": {},
1084
+ "signatures": [
1085
+ {
1086
+ "id": 57,
1087
+ "name": "new AddinEvent",
1088
+ "kind": 16384,
1089
+ "kindString": "Constructor signature",
1090
+ "flags": {},
1091
+ "type": {
1092
+ "type": "reference",
1093
+ "id": 55,
1094
+ "name": "AddinEvent"
1095
+ }
1096
+ }
1097
+ ]
1098
+ },
1099
+ {
1100
+ "id": 58,
1101
+ "name": "context",
1102
+ "kind": 1024,
1103
+ "kindString": "Property",
1104
+ "flags": {
1105
+ "isPublic": true
1106
+ },
1107
+ "comment": {
1108
+ "shortText": "The data that an add-in event has returned."
1109
+ },
1110
+ "sources": [
1111
+ {
1112
+ "fileName": "projects/addin-client/src/src/events/addin-event.ts",
1113
+ "line": 10,
1114
+ "character": 9
1115
+ }
1116
+ ],
1117
+ "type": {
1118
+ "type": "intrinsic",
1119
+ "name": "any"
1120
+ }
1121
+ },
1122
+ {
1123
+ "id": 59,
1124
+ "name": "done",
1125
+ "kind": 1024,
1126
+ "kindString": "Property",
1127
+ "flags": {
1128
+ "isPublic": true,
1129
+ "isOptional": true
1130
+ },
1131
+ "sources": [
1132
+ {
1133
+ "fileName": "projects/addin-client/src/src/events/addin-event.ts",
1134
+ "line": 15,
1135
+ "character": 9
1136
+ }
1137
+ ],
1138
+ "type": {
1139
+ "type": "reflection",
1140
+ "declaration": {
1141
+ "id": 60,
1142
+ "name": "__type",
1143
+ "kind": 65536,
1144
+ "kindString": "Type literal",
1145
+ "flags": {},
1146
+ "signatures": [
1147
+ {
1148
+ "id": 61,
1149
+ "name": "__type",
1150
+ "kind": 4096,
1151
+ "kindString": "Call signature",
1152
+ "flags": {},
1153
+ "comment": {
1154
+ "shortText": "A function to call indicating that the add-in event is processed."
1155
+ },
1156
+ "type": {
1157
+ "type": "intrinsic",
1158
+ "name": "void"
1159
+ }
1160
+ }
1161
+ ]
1162
+ }
1163
+ }
1164
+ }
1165
+ ],
1166
+ "groups": [
1167
+ {
1168
+ "title": "Constructors",
1169
+ "kind": 512,
1170
+ "children": [
1171
+ 56
1172
+ ]
1173
+ },
1174
+ {
1175
+ "title": "Properties",
1176
+ "kind": 1024,
1177
+ "children": [
1178
+ 58,
1179
+ 59
1180
+ ]
1181
+ }
1182
+ ],
1183
+ "sources": [
1184
+ {
1185
+ "fileName": "projects/addin-client/src/src/events/addin-event.ts",
1186
+ "line": 5,
1187
+ "character": 13
1188
+ }
1189
+ ]
1190
+ },
1191
+ {
1192
+ "id": 62,
1193
+ "name": "AddinEventHandlerInstance",
1194
+ "kind": 128,
1195
+ "kindString": "Class",
1196
+ "flags": {},
1197
+ "comment": {
1198
+ "shortText": "Allows you to process events from an event handler."
1199
+ },
1200
+ "children": [
1201
+ {
1202
+ "id": 63,
1203
+ "name": "constructor",
1204
+ "kind": 512,
1205
+ "kindString": "Constructor",
1206
+ "flags": {},
1207
+ "signatures": [
1208
+ {
1209
+ "id": 64,
1210
+ "name": "new AddinEventHandlerInstance",
1211
+ "kind": 16384,
1212
+ "kindString": "Constructor signature",
1213
+ "flags": {},
1214
+ "type": {
1215
+ "type": "reference",
1216
+ "id": 62,
1217
+ "name": "AddinEventHandlerInstance"
1218
+ }
1219
+ }
1220
+ ]
1221
+ },
1222
+ {
1223
+ "id": 65,
1224
+ "name": "addinEvent",
1225
+ "kind": 1024,
1226
+ "kindString": "Property",
1227
+ "flags": {
1228
+ "isPublic": true
1229
+ },
1230
+ "comment": {
1231
+ "shortText": "An event that emits when a new add-in event has occurred."
1232
+ },
1233
+ "sources": [
1234
+ {
1235
+ "fileName": "projects/addin-client/src/src/events/addin-event-handler-instance.ts",
1236
+ "line": 17,
1237
+ "character": 9
1238
+ }
1239
+ ],
1240
+ "type": {
1241
+ "type": "reference",
1242
+ "typeArguments": [
1243
+ {
1244
+ "type": "reference",
1245
+ "id": 55,
1246
+ "name": "AddinEvent"
1247
+ }
1248
+ ],
1249
+ "name": "EventEmitter"
1250
+ }
1251
+ }
1252
+ ],
1253
+ "groups": [
1254
+ {
1255
+ "title": "Constructors",
1256
+ "kind": 512,
1257
+ "children": [
1258
+ 63
1259
+ ]
1260
+ },
1261
+ {
1262
+ "title": "Properties",
1263
+ "kind": 1024,
1264
+ "children": [
1265
+ 65
1266
+ ]
1267
+ }
1268
+ ],
1269
+ "sources": [
1270
+ {
1271
+ "fileName": "projects/addin-client/src/src/events/addin-event-handler-instance.ts",
1272
+ "line": 12,
1273
+ "character": 13
1274
+ }
1275
+ ]
1276
+ }
1277
+ ],
1278
+ "groups": [
1279
+ {
1280
+ "title": "Classes",
1281
+ "kind": 128,
1282
+ "children": [
1283
+ 1,
1284
+ 55,
1285
+ 62
1286
+ ]
1287
+ }
1288
+ ],
1289
+ "sources": [
1290
+ {
1291
+ "fileName": "projects/addin-client/src/public-api.ts",
1292
+ "line": 1,
1293
+ "character": 0
1294
+ }
1295
+ ]
1296
+ },
1297
+ "codeExamples": []
1298
+ }