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
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
|
<?xml version="1.0"?>
<doc>
<assembly>
<name>Mono.Addins.Setup</name>
</assembly>
<members>
<member name="T:Mono.Addins.Setup.ConsoleAddinInstaller">
<summary>
An IAddinInstaller implementation which interacts with the user through the console
</summary>
</member>
<member name="M:Mono.Addins.Setup.ConsoleAddinInstaller.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Mono.Addins.Setup.ConsoleAddinInstaller"/> class.
</summary>
</member>
<member name="P:Mono.Addins.Setup.ConsoleAddinInstaller.UserPrompt">
<summary>
Gets or sets whether the installer can ask questions to the user
</summary>
</member>
<member name="P:Mono.Addins.Setup.ConsoleAddinInstaller.LogLevel">
<summary>
Log level (0:normal, 1+:verbose);
</summary>
</member>
<member name="T:Mono.Addins.Setup.Package">
<summary>
An add-in package
</summary>
</member>
<member name="M:Mono.Addins.Setup.Package.FromRepository(Mono.Addins.Setup.AddinRepositoryEntry)">
<summary>
Creates a package object for an add-in available in an on-line repository
</summary>
<param name="repAddin">
An add-in reference
</param>
<returns>
The package
</returns>
</member>
<member name="M:Mono.Addins.Setup.Package.FromFile(System.String)">
<summary>
Creates a package object for a local package file
</summary>
<param name="file">
Package file path
</param>
<returns>
The package
</returns>
</member>
<member name="P:Mono.Addins.Setup.Package.Name">
<summary>
Name of the package
</summary>
</member>
<member name="P:Mono.Addins.Setup.Package.SharedInstall">
<summary>
Returns true if the package will be installed in the shared directory,
false if it will be installed in the user directory.
</summary>
</member>
<member name="T:Mono.Addins.Setup.AddinRepositoryEntry">
<summary>
A reference to an add-in available in an on-line repository
</summary>
</member>
<member name="M:Mono.Addins.Setup.AddinRepositoryEntry.BeginDownloadSupportFile(System.String,System.AsyncCallback,System.Object)">
<summary>
Begins downloading a support file
</summary>
<returns>
Result of the asynchronous operation, to be used when calling EndDownloadSupportFile to
get the download result.
</returns>
<param name='name'>
Name of the file.
</param>
<param name='cb'>
Callback to be called when the download operation ends.
</param>
<param name='state'>
Custom state object provided by the caller.
</param>
<remarks>
This method can be used to get the contents of a support file of an add-in.
A support file is a file referenced in the custom properties of an add-in.
</remarks>
</member>
<member name="M:Mono.Addins.Setup.AddinRepositoryEntry.EndDownloadSupportFile(System.IAsyncResult)">
<summary>
Gets the result of the asynchronous download of a file
</summary>
<returns>
The downloaded file.
</returns>
<param name='ares'>
The async result object returned by BeginDownloadSupportFile.
</param>
</member>
<member name="P:Mono.Addins.Setup.AddinRepositoryEntry.Addin">
<summary>
Add-in information
</summary>
</member>
<member name="P:Mono.Addins.Setup.AddinRepositoryEntry.Url">
<summary>
Url to the add-in package
</summary>
</member>
<member name="P:Mono.Addins.Setup.AddinRepositoryEntry.RepositoryUrl">
<summary>
The URL of the repository
</summary>
</member>
<member name="P:Mono.Addins.Setup.AddinRepositoryEntry.RepositoryName">
<summary>
Name of the repository
</summary>
</member>
<member name="T:Mono.Addins.Setup.InstallException">
<summary>
An installation exception
</summary>
</member>
<member name="M:Mono.Addins.Setup.InstallException.#ctor(System.String)">
<summary>
Initializes the exception
</summary>
<param name="msg">
Error message
</param>
</member>
<member name="M:Mono.Addins.Setup.InstallException.#ctor(System.String,System.Exception)">
<summary>
Initializes the exception
</summary>
<param name="msg">
Error message
</param>
<param name="ex">
Inner exception
</param>
</member>
<member name="T:Mono.Addins.Setup.SetupTool">
<summary>
A command line add-in manager.
</summary>
<remarks>
This class can be used to provide an add-in management command line tool to applications.
</remarks>
</member>
<member name="M:Mono.Addins.Setup.SetupTool.#ctor(Mono.Addins.AddinRegistry)">
<summary>
Creates a new instance
</summary>
<param name="registry">
Add-in registry to manage.
</param>
</member>
<member name="M:Mono.Addins.Setup.SetupTool.Run(System.String[],System.Int32)">
<summary>
Runs the command line tool.
</summary>
<param name="args">
Array that contains the command line arguments
</param>
<param name="firstArgumentIndex">
Index of the arguments array that has the first argument for the management tool
</param>
<returns>
0 if it succeeds. != 0 otherwise
</returns>
</member>
<member name="M:Mono.Addins.Setup.SetupTool.Run(System.String[])">
<summary>
Runs the command line tool.
</summary>
<param name="args">
Command line arguments
</param>
<returns>
0 if it succeeds. != 0 otherwise
</returns>
</member>
<member name="M:Mono.Addins.Setup.SetupTool.AddCommand(System.String,System.String,System.String,System.String,System.String,System.String,Mono.Addins.Setup.SetupCommandHandler)">
<summary>
Adds a custom command to the add-in manager
</summary>
<param name="category">
Category under which the command has to be shown in the help text
</param>
<param name="command">
Name of the command
</param>
<param name="shortName">
Short name of the command (it's an alias of the normal name)
</param>
<param name="arguments">
Formal description of the arguments that the command accepts. For example: "[addin-id|addin-file] [--xml] [--all] [--full] [--namespace <namespace>]"
</param>
<param name="description">
Short description of the command
</param>
<param name="longDescription">
Long description of the command
</param>
<param name="handler">
Delegate to be invoked to run the command
</param>
</member>
<member name="M:Mono.Addins.Setup.SetupTool.PrintHelp(System.String[])">
<summary>
Prints help about the add-in management tool, or about a specific command
</summary>
<param name="parms">
Optional command name and arguments
</param>
</member>
<member name="P:Mono.Addins.Setup.SetupTool.ApplicationName">
<summary>
Display name of the host application
</summary>
</member>
<member name="P:Mono.Addins.Setup.SetupTool.ApplicationNamespace">
<summary>
Default add-in namespace of the application (optional). If set, only add-ins that belong to that namespace
will be shown in add-in lists.
</summary>
</member>
<member name="P:Mono.Addins.Setup.SetupTool.VerboseOutput">
<summary>
Enables or disables verbose output
</summary>
</member>
<member name="P:Mono.Addins.Setup.SetupTool.VerboseOutputLevel">
<summary>
Sets or gets the verbose output level (0: normal output, 1:verbose, 2+:extra verbose)
</summary>
</member>
<member name="T:Mono.Addins.Setup.SetupCommandHandler">
<summary>
A command handler
</summary>
</member>
<member name="T:Mono.Addins.Setup.PackageCollection">
<summary>
A collection of packages
</summary>
</member>
<member name="M:Mono.Addins.Setup.PackageCollection.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Mono.Addins.Setup.PackageCollection"/> class.
</summary>
</member>
<member name="M:Mono.Addins.Setup.PackageCollection.#ctor(System.Collections.ICollection)">
<summary>
Copy constructor
</summary>
<param name="col">
Collection where to copy from
</param>
</member>
<member name="M:Mono.Addins.Setup.PackageCollection.Add(Mono.Addins.Setup.Package)">
<summary>
Adds a package
</summary>
<param name="p">
A package
</param>
</member>
<member name="M:Mono.Addins.Setup.PackageCollection.Contains(Mono.Addins.Setup.Package)">
<summary>
Checks if a package is present in the collection
</summary>
<param name="p">
The package
</param>
<returns>
True if the package is preent
</returns>
</member>
<member name="M:Mono.Addins.Setup.PackageCollection.AddRange(System.Collections.ICollection)">
<summary>
Adds a list of packages to the collection
</summary>
<param name="col">
The list of packages to add
</param>
</member>
<member name="P:Mono.Addins.Setup.PackageCollection.Item(System.Int32)">
<summary>
Gets a package
</summary>
<param name="n">
Package index
</param>
</member>
<member name="T:Mono.Addins.Setup.AddinHeader">
<summary>
Basic add-in information
</summary>
</member>
<member name="M:Mono.Addins.Setup.AddinHeader.CompareVersionTo(Mono.Addins.Setup.AddinHeader)">
<summary>
Compares the versions of two add-ins
</summary>
<param name="other">
Another add-in
</param>
<returns>
Result of comparison
</returns>
</member>
<member name="P:Mono.Addins.Setup.AddinHeader.Id">
<summary>
Full identifier of the add-in
</summary>
</member>
<member name="P:Mono.Addins.Setup.AddinHeader.Name">
<summary>
Display name of the add-in
</summary>
</member>
<member name="P:Mono.Addins.Setup.AddinHeader.Namespace">
<summary>
Namespace of the add-in
</summary>
</member>
<member name="P:Mono.Addins.Setup.AddinHeader.Version">
<summary>
Version of the add-in
</summary>
</member>
<member name="P:Mono.Addins.Setup.AddinHeader.BaseVersion">
<summary>
Version with which this add-in is compatible
</summary>
</member>
<member name="P:Mono.Addins.Setup.AddinHeader.Author">
<summary>
Add-in author
</summary>
</member>
<member name="P:Mono.Addins.Setup.AddinHeader.Copyright">
<summary>
Add-in copyright
</summary>
</member>
<member name="P:Mono.Addins.Setup.AddinHeader.Url">
<summary>
Web page URL with more information about the add-in
</summary>
</member>
<member name="P:Mono.Addins.Setup.AddinHeader.Description">
<summary>
Description of the add-in
</summary>
</member>
<member name="P:Mono.Addins.Setup.AddinHeader.Category">
<summary>
Category of the add-in
</summary>
</member>
<member name="P:Mono.Addins.Setup.AddinHeader.Dependencies">
<summary>
Dependencies of the add-in
</summary>
</member>
<member name="P:Mono.Addins.Setup.AddinHeader.OptionalDependencies">
<summary>
Optional dependencies of the add-in
</summary>
</member>
<member name="P:Mono.Addins.Setup.AddinHeader.Properties">
<summary>
Custom properties specified in the add-in header
</summary>
</member>
<member name="T:Mono.Addins.Setup.RepositoryRegistry">
<summary>
A registry of on-line repositories
</summary>
<remarks>
This class can be used to manage on-line repository subscriptions.
</remarks>
</member>
<member name="M:Mono.Addins.Setup.RepositoryRegistry.RegisterRepository(Mono.Addins.IProgressStatus,System.String)">
<summary>
Subscribes to an on-line repository
</summary>
<param name="monitor">
Progress monitor where to show progress status and log
</param>
<param name="url">
URL of the repository
</param>
<returns>
A repository reference
</returns>
<remarks>
The repository index is not downloaded by default. It can be downloaded
by calling UpdateRepository.
</remarks>
</member>
<member name="M:Mono.Addins.Setup.RepositoryRegistry.RegisterRepository(Mono.Addins.IProgressStatus,System.String,System.Boolean)">
<summary>
Subscribes to an on-line repository
</summary>
<param name="monitor">
Progress monitor where to show progress status and log
</param>
<param name="url">
URL of the repository
</param>
<param name="updateNow">
When set to True, the repository index will be downloaded.
</param>
<returns>
A repository reference
</returns>
</member>
<member name="M:Mono.Addins.Setup.RepositoryRegistry.RemoveRepository(System.String)">
<summary>
Removes an on-line repository subscription.
</summary>
<param name="url">
URL of the repository.
</param>
</member>
<member name="M:Mono.Addins.Setup.RepositoryRegistry.SetRepositoryEnabled(System.String,System.Boolean)">
<summary>
Enables or disables a repository
</summary>
<param name='url'>
URL of the repository
</param>
<param name='enabled'>
'true' if the repository has to be enabled.
</param>
<remarks>
Disabled repositories are ignored when calling UpdateAllRepositories.
</remarks>
</member>
<member name="M:Mono.Addins.Setup.RepositoryRegistry.ContainsRepository(System.String)">
<summary>
Checks if a repository is already subscribed.
</summary>
<param name="url">
URL of the repository
</param>
<returns>
True if the repository is already subscribed.
</returns>
</member>
<member name="M:Mono.Addins.Setup.RepositoryRegistry.GetRepositories">
<summary>
Gets a list of subscribed repositories
</summary>
<returns>
A list of repositories.
</returns>
</member>
<member name="M:Mono.Addins.Setup.RepositoryRegistry.UpdateAllRepositories(Mono.Addins.IProgressStatus)">
<summary>
Updates the add-in index of all subscribed repositories.
</summary>
<param name="monitor">
Progress monitor where to show progress status and log
</param>
</member>
<member name="M:Mono.Addins.Setup.RepositoryRegistry.UpdateRepository(Mono.Addins.IProgressStatus,System.String)">
<summary>
Updates the add-in index of the provided repository
</summary>
<param name="statusMonitor">
Progress monitor where to show progress status and log
</param>
<param name="url">
URL of the repository
</param>
</member>
<member name="M:Mono.Addins.Setup.RepositoryRegistry.GetAvailableUpdates">
<summary>
Gets a list of available add-in updates.
</summary>
<returns>
A list of add-in references.
</returns>
<remarks>
The list is generated by looking at the add-ins currently installed and checking if there is any
add-in with a newer version number in any of the subscribed repositories. This method uses cached
information from on-line repositories. Make sure you call UpdateRepository or UpdateAllRepositories
before using this method to ensure that the latest information is available.
</remarks>
</member>
<member name="M:Mono.Addins.Setup.RepositoryRegistry.GetAvailableUpdates(Mono.Addins.Setup.RepositorySearchFlags)">
<summary>
Gets a list of available add-in updates.
</summary>
<param name="flags">
Search flags
</param>
<returns>
A list of add-in references.
</returns>
<remarks>
The list is generated by looking at the add-ins currently installed and checking if there is any
add-in with a newer version number in any of the subscribed repositories. This method uses cached
information from on-line repositories. Make sure you call UpdateRepository or UpdateAllRepositories
before using this method to ensure that the latest information is available.
</remarks>
</member>
<member name="M:Mono.Addins.Setup.RepositoryRegistry.GetAvailableUpdates(System.String)">
<summary>
Gets a list of available add-in updates in a specific repository.
</summary>
<param name="repositoryUrl">
The repository URL
</param>
<returns>
A list of add-in references.
</returns>
<remarks>
The list is generated by looking at the add-ins currently installed and checking if there is any
add-in with a newer version number in the provided repository. This method uses cached
information from on-line repositories. Make sure you call UpdateRepository or UpdateAllRepositories
before using this method to ensure that the latest information is available.
</remarks>
</member>
<member name="M:Mono.Addins.Setup.RepositoryRegistry.GetAvailableAddinUpdates(System.String)">
<summary>
Gets a list of available updates for an add-in.
</summary>
<param name="id">
Identifier of the add-in.
</param>
<returns>
List of updates for the specified add-in.
</returns>
<remarks>
The list is generated by checking if there is any
add-in with a newer version number in any of the subscribed repositories. This method uses cached
information from on-line repositories. Make sure you call UpdateRepository or UpdateAllRepositories
before using this method to ensure that the latest information is available.
</remarks>
</member>
<member name="M:Mono.Addins.Setup.RepositoryRegistry.GetAvailableAddinUpdates(System.String,Mono.Addins.Setup.RepositorySearchFlags)">
<summary>
Gets a list of available updates for an add-in.
</summary>
<param name="id">
Identifier of the add-in.
</param>
<param name='flags'>
Search flags.
</param>
<returns>
List of updates for the specified add-in.
</returns>
<remarks>
The list is generated by checking if there is any
add-in with a newer version number in any of the subscribed repositories. This method uses cached
information from on-line repositories. Make sure you call UpdateRepository or UpdateAllRepositories
before using this method to ensure that the latest information is available.
</remarks>
</member>
<member name="M:Mono.Addins.Setup.RepositoryRegistry.GetAvailableAddinUpdates(System.String,System.String)">
<summary>
Gets a list of available updates for an add-in in a specific repository
</summary>
<param name="repositoryUrl">
Identifier of the add-in.
</param>
<param name="id">
Identifier of the add-in.
</param>
<returns>
List of updates for the specified add-in.
</returns>
<remarks>
The list is generated by checking if there is any
add-in with a newer version number in the provided repository. This method uses cached
information from on-line repositories. Make sure you call UpdateRepository or UpdateAllRepositories
before using this method to ensure that the latest information is available.
</remarks>
</member>
<member name="M:Mono.Addins.Setup.RepositoryRegistry.GetAvailableAddinUpdates(System.String,System.String,Mono.Addins.Setup.RepositorySearchFlags)">
<summary>
Gets a list of available updates for an add-in in a specific repository
</summary>
<param name="repositoryUrl">
Identifier of the add-in.
</param>
<param name="id">
Identifier of the add-in.
</param>
<param name='flags'>
Search flags.
</param>
<returns>
List of updates for the specified add-in.
</returns>
<remarks>
The list is generated by checking if there is any
add-in with a newer version number in the provided repository. This method uses cached
information from on-line repositories. Make sure you call UpdateRepository or UpdateAllRepositories
before using this method to ensure that the latest information is available.
</remarks>
</member>
<member name="M:Mono.Addins.Setup.RepositoryRegistry.GetAvailableAddins">
<summary>
Gets a list of all available add-ins
</summary>
<returns>
A list of add-ins
</returns>
<remarks>
This method uses cached
information from on-line repositories. Make sure you call UpdateRepository or UpdateAllRepositories
before using this method to ensure that the latest information is available.
</remarks>
</member>
<member name="M:Mono.Addins.Setup.RepositoryRegistry.GetAvailableAddins(Mono.Addins.Setup.RepositorySearchFlags)">
<summary>
Gets a list of all available add-ins
</summary>
<returns>
The available addins.
</returns>
<param name='flags'>
Search flags.
</param>
<remarks>
This method uses cached
information from on-line repositories. Make sure you call UpdateRepository or UpdateAllRepositories
before using this method to ensure that the latest information is available.
</remarks>
</member>
<member name="M:Mono.Addins.Setup.RepositoryRegistry.GetAvailableAddins(System.String)">
<summary>
Gets a list of all available add-ins in a repository
</summary>
<param name="repositoryUrl">
A repository URL
</param>
<returns>
A list of add-ins
</returns>
<remarks>
This method uses cached
information from on-line repositories. Make sure you call UpdateRepository or UpdateAllRepositories
before using this method to ensure that the latest information is available.
</remarks>
</member>
<member name="M:Mono.Addins.Setup.RepositoryRegistry.GetAvailableAddins(System.String,Mono.Addins.Setup.RepositorySearchFlags)">
<summary>
Gets a list of all available add-ins in a repository
</summary>
<param name="repositoryUrl">
A repository URL
</param>
<param name='flags'>
Search flags.
</param>
<returns>
A list of add-ins
</returns>
<remarks>
This method uses cached
information from on-line repositories. Make sure you call UpdateRepository or UpdateAllRepositories
before using this method to ensure that the latest information is available.
</remarks>
</member>
<member name="M:Mono.Addins.Setup.RepositoryRegistry.GetAvailableAddin(System.String,System.String)">
<summary>
Checks if an add-in is available to be installed
</summary>
<param name="id">
Identifier of the add-in
</param>
<param name="version">
Version of the add-in (optional, it can be null)
</param>
<returns>
A list of add-ins
</returns>
<remarks>
List of references to add-ins available in on-line repositories. This method uses cached
information from on-line repositories. Make sure you call UpdateRepository or UpdateAllRepositories
before using this method to ensure that the latest information is available.
</remarks>
</member>
<member name="M:Mono.Addins.Setup.RepositoryRegistry.GetAvailableAddin(System.String,System.String,System.String)">
<summary>
Checks if an add-in is available to be installed from a repository
</summary>
<param name="repositoryUrl">
A repository URL
</param>
<param name="id">
Identifier of the add-in
</param>
<param name="version">
Version of the add-in (optional, it can be null)
</param>
<returns>
A list of add-ins
</returns>
<remarks>
List of references to add-ins available in the repository. This method uses cached
information from on-line repositories. Make sure you call UpdateRepository or UpdateAllRepositories
before using this method to ensure that the latest information is available.
</remarks>
</member>
<member name="T:Mono.Addins.Setup.RepositorySearchFlags">
<summary>
Repository search flags.
</summary>
</member>
<member name="F:Mono.Addins.Setup.RepositorySearchFlags.None">
<summary>
No special search options
</summary>
</member>
<member name="F:Mono.Addins.Setup.RepositorySearchFlags.LatestVersionsOnly">
<summary>
Only the latest version of every add-in is included in the search
</summary>
</member>
<member name="T:Mono.Addins.Setup.AddinRepository">
<summary>
An on-line add-in repository
</summary>
</member>
<member name="P:Mono.Addins.Setup.AddinRepository.File">
<summary>
Path to the cached add-in repository file
</summary>
</member>
<member name="P:Mono.Addins.Setup.AddinRepository.Url">
<summary>
Url of the repository
</summary>
</member>
<member name="P:Mono.Addins.Setup.AddinRepository.Name">
<summary>
Do not use. Use Title instead.
</summary>
</member>
<member name="P:Mono.Addins.Setup.AddinRepository.Title">
<summary>
Title of the repository
</summary>
</member>
<member name="P:Mono.Addins.Setup.AddinRepository.LastModified">
<summary>
Last change timestamp
</summary>
</member>
<member name="P:Mono.Addins.Setup.AddinRepository.Enabled">
<summary>
Gets a value indicating whether this <see cref="T:Mono.Addins.Setup.AddinRepository"/> is enabled.
</summary>
<value>
<c>true</c> if enabled; otherwise, <c>false</c>.
</value>
</member>
<member name="T:Mono.Addins.Setup.WebRequestHelper">
<summary>
Helper for making web requests with support for authenticated proxies.
</summary>
</member>
<member name="M:Mono.Addins.Setup.WebRequestHelper.SetRequestHandler(System.Func{System.Func{System.Net.HttpWebRequest},System.Action{System.Net.HttpWebRequest},System.Threading.CancellationToken,System.Net.HttpWebResponse})">
<summary>
Sets a custom request handler that can handle requests for authenticated proxy servers.
</summary>
<param name="handler">The custom request handler.</param>
</member>
<member name="M:Mono.Addins.Setup.WebRequestHelper.GetResponseAsync(System.Func{System.Net.HttpWebRequest},System.Action{System.Net.HttpWebRequest},System.Threading.CancellationToken)">
<summary>
Gets the web response, using the request handler to handle proxy authentication
if necessary.
</summary>
<returns>The response.</returns>
<param name="createRequest">Callback for creating the request.</param>
<param name="prepareRequest">Callback for preparing the request, e.g. writing the request stream.</param>
<param name="token">Cancellation token.</param>
<remarks>
Keeps sending requests until a response code that doesn't require authentication happens or if the request
requires authentication and the user has stopped trying to enter them (i.e. they hit cancel when they are prompted).
</remarks>
</member>
<member name="M:Mono.Addins.Setup.WebRequestHelper.GetResponse(System.Func{System.Net.HttpWebRequest},System.Action{System.Net.HttpWebRequest},System.Threading.CancellationToken)">
<summary>
Gets the web response, using the request handler to handle proxy authentication
if necessary.
</summary>
<returns>The response.</returns>
<param name="createRequest">Callback for creating the request.</param>
<param name="prepareRequest">Callback for preparing the request, e.g. writing the request stream.</param>
<param name="token">Cancellation token.</param>
<remarks>
Keeps sending requests until a response code that doesn't require authentication happens or if the request
requires authentication and the user has stopped trying to enter them (i.e. they hit cancel when they are prompted).
</remarks>
</member>
<member name="M:Mono.Addins.Setup.WebRequestHelper.IsCannotReachInternetError(System.Net.WebExceptionStatus)">
<summary>
Determines whether an error code is likely to have been caused by internet reachability problems.
</summary>
</member>
<member name="T:Mono.Addins.Setup.SetupService">
<summary>
Provides tools for managing add-ins
</summary>
<remarks>
This class can be used to manage the add-ins of an application. It allows installing and uninstalling
add-ins, taking into account add-in dependencies. It provides methods for installing add-ins from on-line
repositories and tools for generating those repositories.
</remarks>
</member>
<member name="M:Mono.Addins.Setup.SetupService.#ctor">
<summary>
Initializes a new instance
</summary>
<remarks>
If the add-in manager is initialized (AddinManager.Initialize has been called), then this instance
will manage the add-in registry of the initialized engine.
</remarks>
</member>
<member name="M:Mono.Addins.Setup.SetupService.#ctor(Mono.Addins.AddinRegistry)">
<summary>
Initializes a new instance
</summary>
<param name="registry">
Add-in registry to manage
</param>
</member>
<member name="M:Mono.Addins.Setup.SetupService.ResolveDependencies(Mono.Addins.IProgressStatus,Mono.Addins.Setup.AddinRepositoryEntry[],Mono.Addins.Setup.PackageCollection@,Mono.Addins.Setup.PackageCollection@,Mono.Addins.Description.DependencyCollection@)">
<summary>
Resolves add-in dependencies.
</summary>
<param name="statusMonitor">
Progress monitor where to show progress status
</param>
<param name="addins">
List of add-ins to check
</param>
<param name="resolved">
Packages that need to be installed.
</param>
<param name="toUninstall">
Packages that need to be uninstalled.
</param>
<param name="unresolved">
Add-in dependencies that could not be resolved.
</param>
<returns>
True if all dependencies could be resolved.
</returns>
<remarks>
This method can be used to get a list of all packages that have to be installed in order to install
an add-in or set of add-ins. The list of packages to install will include the package that provides the
add-in, and all packages that provide the add-in dependencies. In some cases, packages may need to
be installed (for example, when an installed add-in needs to be upgraded).
</remarks>
</member>
<member name="M:Mono.Addins.Setup.SetupService.ResolveDependencies(Mono.Addins.IProgressStatus,Mono.Addins.Setup.PackageCollection,Mono.Addins.Setup.PackageCollection@,Mono.Addins.Description.DependencyCollection@)">
<summary>
Resolves add-in dependencies.
</summary>
<param name="statusMonitor">
Progress monitor where to show progress status
</param>
<param name="packages">
Packages that need to be installed.
</param>
<param name="toUninstall">
Packages that need to be uninstalled.
</param>
<param name="unresolved">
Add-in dependencies that could not be resolved.
</param>
<returns>
True if all dependencies could be resolved.
</returns>
<remarks>
This method can be used to get a list of all packages that have to be installed in order to satisfy
the dependencies of a package or set of packages. The 'packages' argument must have the list of packages
to be resolved. When resolving dependencies, if there is any additional package that needs to be installed,
it will be added to the same 'packages' collection. In some cases, packages may need to
be installed (for example, when an installed add-in needs to be upgraded). Those packages will be added
to the 'toUninstall' collection. Packages that could not be resolved are added to the 'unresolved'
collection.
</remarks>
</member>
<member name="M:Mono.Addins.Setup.SetupService.Install(Mono.Addins.IProgressStatus,System.String[])">
<summary>
Installs add-in packages
</summary>
<param name="statusMonitor">
Progress monitor where to show progress status
</param>
<param name="files">
Paths to the packages to install
</param>
<returns>
True if the installation succeeded
</returns>
</member>
<member name="M:Mono.Addins.Setup.SetupService.Install(Mono.Addins.IProgressStatus,Mono.Addins.Setup.AddinRepositoryEntry[])">
<summary>
Installs add-in packages from on-line repositories
</summary>
<param name="statusMonitor">
Progress monitor where to show progress status
</param>
<param name="addins">
References to the add-ins to be installed
</param>
<returns>
True if the installation succeeded
</returns>
</member>
<member name="M:Mono.Addins.Setup.SetupService.Install(Mono.Addins.IProgressStatus,Mono.Addins.Setup.PackageCollection)">
<summary>
Installs add-in packages
</summary>
<param name="statusMonitor">
Progress monitor where to show progress status
</param>
<param name="packages">
Packages to install
</param>
<returns>
True if the installation succeeded
</returns>
</member>
<member name="M:Mono.Addins.Setup.SetupService.Uninstall(Mono.Addins.IProgressStatus,System.String)">
<summary>
Uninstalls an add-in.
</summary>
<param name="statusMonitor">
Progress monitor where to show progress status
</param>
<param name="id">
Full identifier of the add-in to uninstall.
</param>
</member>
<member name="M:Mono.Addins.Setup.SetupService.Uninstall(Mono.Addins.IProgressStatus,System.Collections.Generic.IEnumerable{System.String})">
<summary>
Uninstalls a set of add-ins
</summary>
<param name='statusMonitor'>
Progress monitor where to show progress status
</param>
<param name='ids'>
Full identifiers of the add-ins to uninstall.
</param>
</member>
<member name="M:Mono.Addins.Setup.SetupService.GetAddinHeader(Mono.Addins.Addin)">
<summary>
Gets information about an add-in
</summary>
<param name="addin">
The add-in
</param>
<returns>
Add-in header data
</returns>
</member>
<member name="M:Mono.Addins.Setup.SetupService.GetDependentAddins(System.String,System.Boolean)">
<summary>
Gets a list of add-ins which depend on an add-in
</summary>
<param name="id">
Full identifier of an add-in.
</param>
<param name="recursive">
When set to True, dependencies will be gathered recursivelly
</param>
<returns>
List of dependent add-ins.
</returns>
<remarks>
This methods returns a list of add-ins which have the add-in identified by 'id' as a direct
(or indirect if recursive=True) dependency.
</remarks>
</member>
<member name="M:Mono.Addins.Setup.SetupService.BuildPackage(Mono.Addins.IProgressStatus,System.String,System.String[])">
<summary>
Packages an add-in
</summary>
<param name="statusMonitor">
Progress monitor where to show progress status
</param>
<param name="targetDirectory">
Directory where to generate the package
</param>
<param name="filePaths">
Paths to the add-ins to be packaged. Paths can be either the main assembly of an add-in, or an add-in
manifest (.addin or .addin.xml).
</param>
<remarks>
This method can be used to create a package for an add-in, which can then be pushed to an on-line
repository. The package will include the main assembly or manifest of the add-in and any external
file declared in the add-in metadata.
</remarks>
</member>
<member name="M:Mono.Addins.Setup.SetupService.BuildRepository(Mono.Addins.IProgressStatus,System.String)">
<summary>
Generates an on-line repository
</summary>
<param name="statusMonitor">
Progress monitor where to show progress status
</param>
<param name="path">
Path to the directory that contains the add-ins and that is going to be published
</param>
<remarks>
This method generates the index files required to publish a directory as an online repository
of add-ins.
</remarks>
</member>
<member name="M:Mono.Addins.Setup.SetupService.GetExtensibleApplication(System.String)">
<summary>
Gets a reference to an extensible application
</summary>
<param name="name">
Name of the application
</param>
<returns>
The Application object. Null if not found.
</returns>
</member>
<member name="M:Mono.Addins.Setup.SetupService.GetExtensibleApplication(System.String,System.Collections.Generic.IEnumerable{System.String})">
<summary>
Gets a reference to an extensible application
</summary>
<param name="name">
Name of the application
</param>
<param name="searchPaths">
Custom paths where to look for the application.
</param>
<returns>
The Application object. Null if not found.
</returns>
</member>
<member name="M:Mono.Addins.Setup.SetupService.GetExtensibleApplications">
<summary>
Gets a lis of all known extensible applications
</summary>
<returns>
A list of applications.
</returns>
</member>
<member name="M:Mono.Addins.Setup.SetupService.GetExtensibleApplications(System.Collections.Generic.IEnumerable{System.String})">
<summary>
Gets a lis of all known extensible applications
</summary>
<param name="searchPaths">
Custom paths where to look for applications.
</param>
<returns>
A list of applications.
</returns>
</member>
<member name="P:Mono.Addins.Setup.SetupService.Registry">
<summary>
The add-in registry being managed
</summary>
</member>
<member name="P:Mono.Addins.Setup.SetupService.ApplicationNamespace">
<summary>
Default add-in namespace of the application (optional). If set, only add-ins that belong to that namespace
will be shown in add-in lists.
</summary>
</member>
<member name="P:Mono.Addins.Setup.SetupService.InstallDirectory">
<summary>
Directory where to install add-ins. If not specified, the 'addins' subdirectory of the
registry location is used.
</summary>
</member>
<member name="P:Mono.Addins.Setup.SetupService.Repositories">
<summary>
Returns a RepositoryRegistry which can be used to manage on-line repository references
</summary>
</member>
<member name="T:Mono.Addins.Setup.Application">
<summary>
A registered extensible application
</summary>
</member>
<member name="P:Mono.Addins.Setup.Application.Registry">
<summary>
Add-in registry of the application
</summary>
</member>
<member name="P:Mono.Addins.Setup.Application.Description">
<summary>
Description of the application
</summary>
</member>
<member name="P:Mono.Addins.Setup.Application.Name">
<summary>
Name of the application
</summary>
</member>
<member name="P:Mono.Addins.Setup.Application.RegistryPath">
<summary>
Path to the add-in registry
</summary>
</member>
<member name="P:Mono.Addins.Setup.Application.StartupPath">
<summary>
Path to the directory that contains the main executable assembly of the application
</summary>
</member>
<member name="P:Mono.Addins.Setup.Application.TestCommand">
<summary>
Command to be used to execute the application in add-in development mode.
</summary>
</member>
<member name="P:Mono.Addins.Setup.Application.AddinsPath">
<summary>
Path to the default add-ins directory for the aplpication
</summary>
</member>
<member name="P:Mono.Addins.Setup.Application.AddinCachePath">
<summary>
Path to the add-in cache for the application
</summary>
</member>
</members>
</doc>
|