aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/bin/Mono.Addins.Setup.xml
diff options
context:
space:
mode:
Diffstat (limited to 'bin/Mono.Addins.Setup.xml')
-rw-r--r--bin/Mono.Addins.Setup.xml1140
1 files changed, 1140 insertions, 0 deletions
diff --git a/bin/Mono.Addins.Setup.xml b/bin/Mono.Addins.Setup.xml
new file mode 100644
index 0000000..f5ce70a
--- /dev/null
+++ b/bin/Mono.Addins.Setup.xml
@@ -0,0 +1,1140 @@
1<?xml version="1.0"?>
2<doc>
3 <assembly>
4 <name>Mono.Addins.Setup</name>
5 </assembly>
6 <members>
7 <member name="T:Mono.Addins.Setup.ConsoleAddinInstaller">
8 <summary>
9 An IAddinInstaller implementation which interacts with the user through the console
10 </summary>
11 </member>
12 <member name="M:Mono.Addins.Setup.ConsoleAddinInstaller.#ctor">
13 <summary>
14 Initializes a new instance of the <see cref="T:Mono.Addins.Setup.ConsoleAddinInstaller"/> class.
15 </summary>
16 </member>
17 <member name="P:Mono.Addins.Setup.ConsoleAddinInstaller.UserPrompt">
18 <summary>
19 Gets or sets whether the installer can ask questions to the user
20 </summary>
21 </member>
22 <member name="P:Mono.Addins.Setup.ConsoleAddinInstaller.LogLevel">
23 <summary>
24 Log level (0:normal, 1+:verbose);
25 </summary>
26 </member>
27 <member name="T:Mono.Addins.Setup.Package">
28 <summary>
29 An add-in package
30 </summary>
31 </member>
32 <member name="M:Mono.Addins.Setup.Package.FromRepository(Mono.Addins.Setup.AddinRepositoryEntry)">
33 <summary>
34 Creates a package object for an add-in available in an on-line repository
35 </summary>
36 <param name="repAddin">
37 An add-in reference
38 </param>
39 <returns>
40 The package
41 </returns>
42 </member>
43 <member name="M:Mono.Addins.Setup.Package.FromFile(System.String)">
44 <summary>
45 Creates a package object for a local package file
46 </summary>
47 <param name="file">
48 Package file path
49 </param>
50 <returns>
51 The package
52 </returns>
53 </member>
54 <member name="P:Mono.Addins.Setup.Package.Name">
55 <summary>
56 Name of the package
57 </summary>
58 </member>
59 <member name="P:Mono.Addins.Setup.Package.SharedInstall">
60 <summary>
61 Returns true if the package will be installed in the shared directory,
62 false if it will be installed in the user directory.
63 </summary>
64 </member>
65 <member name="T:Mono.Addins.Setup.AddinRepositoryEntry">
66 <summary>
67 A reference to an add-in available in an on-line repository
68 </summary>
69 </member>
70 <member name="M:Mono.Addins.Setup.AddinRepositoryEntry.BeginDownloadSupportFile(System.String,System.AsyncCallback,System.Object)">
71 <summary>
72 Begins downloading a support file
73 </summary>
74 <returns>
75 Result of the asynchronous operation, to be used when calling EndDownloadSupportFile to
76 get the download result.
77 </returns>
78 <param name='name'>
79 Name of the file.
80 </param>
81 <param name='cb'>
82 Callback to be called when the download operation ends.
83 </param>
84 <param name='state'>
85 Custom state object provided by the caller.
86 </param>
87 <remarks>
88 This method can be used to get the contents of a support file of an add-in.
89 A support file is a file referenced in the custom properties of an add-in.
90 </remarks>
91 </member>
92 <member name="M:Mono.Addins.Setup.AddinRepositoryEntry.EndDownloadSupportFile(System.IAsyncResult)">
93 <summary>
94 Gets the result of the asynchronous download of a file
95 </summary>
96 <returns>
97 The downloaded file.
98 </returns>
99 <param name='ares'>
100 The async result object returned by BeginDownloadSupportFile.
101 </param>
102 </member>
103 <member name="P:Mono.Addins.Setup.AddinRepositoryEntry.Addin">
104 <summary>
105 Add-in information
106 </summary>
107 </member>
108 <member name="P:Mono.Addins.Setup.AddinRepositoryEntry.Url">
109 <summary>
110 Url to the add-in package
111 </summary>
112 </member>
113 <member name="P:Mono.Addins.Setup.AddinRepositoryEntry.RepositoryUrl">
114 <summary>
115 The URL of the repository
116 </summary>
117 </member>
118 <member name="P:Mono.Addins.Setup.AddinRepositoryEntry.RepositoryName">
119 <summary>
120 Name of the repository
121 </summary>
122 </member>
123 <member name="T:Mono.Addins.Setup.InstallException">
124 <summary>
125 An installation exception
126 </summary>
127 </member>
128 <member name="M:Mono.Addins.Setup.InstallException.#ctor(System.String)">
129 <summary>
130 Initializes the exception
131 </summary>
132 <param name="msg">
133 Error message
134 </param>
135 </member>
136 <member name="M:Mono.Addins.Setup.InstallException.#ctor(System.String,System.Exception)">
137 <summary>
138 Initializes the exception
139 </summary>
140 <param name="msg">
141 Error message
142 </param>
143 <param name="ex">
144 Inner exception
145 </param>
146 </member>
147 <member name="T:Mono.Addins.Setup.SetupTool">
148 <summary>
149 A command line add-in manager.
150 </summary>
151 <remarks>
152 This class can be used to provide an add-in management command line tool to applications.
153 </remarks>
154 </member>
155 <member name="M:Mono.Addins.Setup.SetupTool.#ctor(Mono.Addins.AddinRegistry)">
156 <summary>
157 Creates a new instance
158 </summary>
159 <param name="registry">
160 Add-in registry to manage.
161 </param>
162 </member>
163 <member name="M:Mono.Addins.Setup.SetupTool.Run(System.String[],System.Int32)">
164 <summary>
165 Runs the command line tool.
166 </summary>
167 <param name="args">
168 Array that contains the command line arguments
169 </param>
170 <param name="firstArgumentIndex">
171 Index of the arguments array that has the first argument for the management tool
172 </param>
173 <returns>
174 0 if it succeeds. != 0 otherwise
175 </returns>
176 </member>
177 <member name="M:Mono.Addins.Setup.SetupTool.Run(System.String[])">
178 <summary>
179 Runs the command line tool.
180 </summary>
181 <param name="args">
182 Command line arguments
183 </param>
184 <returns>
185 0 if it succeeds. != 0 otherwise
186 </returns>
187 </member>
188 <member name="M:Mono.Addins.Setup.SetupTool.AddCommand(System.String,System.String,System.String,System.String,System.String,System.String,Mono.Addins.Setup.SetupCommandHandler)">
189 <summary>
190 Adds a custom command to the add-in manager
191 </summary>
192 <param name="category">
193 Category under which the command has to be shown in the help text
194 </param>
195 <param name="command">
196 Name of the command
197 </param>
198 <param name="shortName">
199 Short name of the command (it's an alias of the normal name)
200 </param>
201 <param name="arguments">
202 Formal description of the arguments that the command accepts. For example: "[addin-id|addin-file] [--xml] [--all] [--full] [--namespace &lt;namespace&gt;]"
203 </param>
204 <param name="description">
205 Short description of the command
206 </param>
207 <param name="longDescription">
208 Long description of the command
209 </param>
210 <param name="handler">
211 Delegate to be invoked to run the command
212 </param>
213 </member>
214 <member name="M:Mono.Addins.Setup.SetupTool.PrintHelp(System.String[])">
215 <summary>
216 Prints help about the add-in management tool, or about a specific command
217 </summary>
218 <param name="parms">
219 Optional command name and arguments
220 </param>
221 </member>
222 <member name="P:Mono.Addins.Setup.SetupTool.ApplicationName">
223 <summary>
224 Display name of the host application
225 </summary>
226 </member>
227 <member name="P:Mono.Addins.Setup.SetupTool.ApplicationNamespace">
228 <summary>
229 Default add-in namespace of the application (optional). If set, only add-ins that belong to that namespace
230 will be shown in add-in lists.
231 </summary>
232 </member>
233 <member name="P:Mono.Addins.Setup.SetupTool.VerboseOutput">
234 <summary>
235 Enables or disables verbose output
236 </summary>
237 </member>
238 <member name="P:Mono.Addins.Setup.SetupTool.VerboseOutputLevel">
239 <summary>
240 Sets or gets the verbose output level (0: normal output, 1:verbose, 2+:extra verbose)
241 </summary>
242 </member>
243 <member name="T:Mono.Addins.Setup.SetupCommandHandler">
244 <summary>
245 A command handler
246 </summary>
247 </member>
248 <member name="T:Mono.Addins.Setup.PackageCollection">
249 <summary>
250 A collection of packages
251 </summary>
252 </member>
253 <member name="M:Mono.Addins.Setup.PackageCollection.#ctor">
254 <summary>
255 Initializes a new instance of the <see cref="T:Mono.Addins.Setup.PackageCollection"/> class.
256 </summary>
257 </member>
258 <member name="M:Mono.Addins.Setup.PackageCollection.#ctor(System.Collections.ICollection)">
259 <summary>
260 Copy constructor
261 </summary>
262 <param name="col">
263 Collection where to copy from
264 </param>
265 </member>
266 <member name="M:Mono.Addins.Setup.PackageCollection.Add(Mono.Addins.Setup.Package)">
267 <summary>
268 Adds a package
269 </summary>
270 <param name="p">
271 A package
272 </param>
273 </member>
274 <member name="M:Mono.Addins.Setup.PackageCollection.Contains(Mono.Addins.Setup.Package)">
275 <summary>
276 Checks if a package is present in the collection
277 </summary>
278 <param name="p">
279 The package
280 </param>
281 <returns>
282 True if the package is preent
283 </returns>
284 </member>
285 <member name="M:Mono.Addins.Setup.PackageCollection.AddRange(System.Collections.ICollection)">
286 <summary>
287 Adds a list of packages to the collection
288 </summary>
289 <param name="col">
290 The list of packages to add
291 </param>
292 </member>
293 <member name="P:Mono.Addins.Setup.PackageCollection.Item(System.Int32)">
294 <summary>
295 Gets a package
296 </summary>
297 <param name="n">
298 Package index
299 </param>
300 </member>
301 <member name="T:Mono.Addins.Setup.AddinHeader">
302 <summary>
303 Basic add-in information
304 </summary>
305 </member>
306 <member name="M:Mono.Addins.Setup.AddinHeader.CompareVersionTo(Mono.Addins.Setup.AddinHeader)">
307 <summary>
308 Compares the versions of two add-ins
309 </summary>
310 <param name="other">
311 Another add-in
312 </param>
313 <returns>
314 Result of comparison
315 </returns>
316 </member>
317 <member name="P:Mono.Addins.Setup.AddinHeader.Id">
318 <summary>
319 Full identifier of the add-in
320 </summary>
321 </member>
322 <member name="P:Mono.Addins.Setup.AddinHeader.Name">
323 <summary>
324 Display name of the add-in
325 </summary>
326 </member>
327 <member name="P:Mono.Addins.Setup.AddinHeader.Namespace">
328 <summary>
329 Namespace of the add-in
330 </summary>
331 </member>
332 <member name="P:Mono.Addins.Setup.AddinHeader.Version">
333 <summary>
334 Version of the add-in
335 </summary>
336 </member>
337 <member name="P:Mono.Addins.Setup.AddinHeader.BaseVersion">
338 <summary>
339 Version with which this add-in is compatible
340 </summary>
341 </member>
342 <member name="P:Mono.Addins.Setup.AddinHeader.Author">
343 <summary>
344 Add-in author
345 </summary>
346 </member>
347 <member name="P:Mono.Addins.Setup.AddinHeader.Copyright">
348 <summary>
349 Add-in copyright
350 </summary>
351 </member>
352 <member name="P:Mono.Addins.Setup.AddinHeader.Url">
353 <summary>
354 Web page URL with more information about the add-in
355 </summary>
356 </member>
357 <member name="P:Mono.Addins.Setup.AddinHeader.Description">
358 <summary>
359 Description of the add-in
360 </summary>
361 </member>
362 <member name="P:Mono.Addins.Setup.AddinHeader.Category">
363 <summary>
364 Category of the add-in
365 </summary>
366 </member>
367 <member name="P:Mono.Addins.Setup.AddinHeader.Dependencies">
368 <summary>
369 Dependencies of the add-in
370 </summary>
371 </member>
372 <member name="P:Mono.Addins.Setup.AddinHeader.OptionalDependencies">
373 <summary>
374 Optional dependencies of the add-in
375 </summary>
376 </member>
377 <member name="P:Mono.Addins.Setup.AddinHeader.Properties">
378 <summary>
379 Custom properties specified in the add-in header
380 </summary>
381 </member>
382 <member name="T:Mono.Addins.Setup.RepositoryRegistry">
383 <summary>
384 A registry of on-line repositories
385 </summary>
386 <remarks>
387 This class can be used to manage on-line repository subscriptions.
388 </remarks>
389 </member>
390 <member name="M:Mono.Addins.Setup.RepositoryRegistry.RegisterRepository(Mono.Addins.IProgressStatus,System.String)">
391 <summary>
392 Subscribes to an on-line repository
393 </summary>
394 <param name="monitor">
395 Progress monitor where to show progress status and log
396 </param>
397 <param name="url">
398 URL of the repository
399 </param>
400 <returns>
401 A repository reference
402 </returns>
403 <remarks>
404 The repository index is not downloaded by default. It can be downloaded
405 by calling UpdateRepository.
406 </remarks>
407 </member>
408 <member name="M:Mono.Addins.Setup.RepositoryRegistry.RegisterRepository(Mono.Addins.IProgressStatus,System.String,System.Boolean)">
409 <summary>
410 Subscribes to an on-line repository
411 </summary>
412 <param name="monitor">
413 Progress monitor where to show progress status and log
414 </param>
415 <param name="url">
416 URL of the repository
417 </param>
418 <param name="updateNow">
419 When set to True, the repository index will be downloaded.
420 </param>
421 <returns>
422 A repository reference
423 </returns>
424 </member>
425 <member name="M:Mono.Addins.Setup.RepositoryRegistry.RemoveRepository(System.String)">
426 <summary>
427 Removes an on-line repository subscription.
428 </summary>
429 <param name="url">
430 URL of the repository.
431 </param>
432 </member>
433 <member name="M:Mono.Addins.Setup.RepositoryRegistry.SetRepositoryEnabled(System.String,System.Boolean)">
434 <summary>
435 Enables or disables a repository
436 </summary>
437 <param name='url'>
438 URL of the repository
439 </param>
440 <param name='enabled'>
441 'true' if the repository has to be enabled.
442 </param>
443 <remarks>
444 Disabled repositories are ignored when calling UpdateAllRepositories.
445 </remarks>
446 </member>
447 <member name="M:Mono.Addins.Setup.RepositoryRegistry.ContainsRepository(System.String)">
448 <summary>
449 Checks if a repository is already subscribed.
450 </summary>
451 <param name="url">
452 URL of the repository
453 </param>
454 <returns>
455 True if the repository is already subscribed.
456 </returns>
457 </member>
458 <member name="M:Mono.Addins.Setup.RepositoryRegistry.GetRepositories">
459 <summary>
460 Gets a list of subscribed repositories
461 </summary>
462 <returns>
463 A list of repositories.
464 </returns>
465 </member>
466 <member name="M:Mono.Addins.Setup.RepositoryRegistry.UpdateAllRepositories(Mono.Addins.IProgressStatus)">
467 <summary>
468 Updates the add-in index of all subscribed repositories.
469 </summary>
470 <param name="monitor">
471 Progress monitor where to show progress status and log
472 </param>
473 </member>
474 <member name="M:Mono.Addins.Setup.RepositoryRegistry.UpdateRepository(Mono.Addins.IProgressStatus,System.String)">
475 <summary>
476 Updates the add-in index of the provided repository
477 </summary>
478 <param name="statusMonitor">
479 Progress monitor where to show progress status and log
480 </param>
481 <param name="url">
482 URL of the repository
483 </param>
484 </member>
485 <member name="M:Mono.Addins.Setup.RepositoryRegistry.GetAvailableUpdates">
486 <summary>
487 Gets a list of available add-in updates.
488 </summary>
489 <returns>
490 A list of add-in references.
491 </returns>
492 <remarks>
493 The list is generated by looking at the add-ins currently installed and checking if there is any
494 add-in with a newer version number in any of the subscribed repositories. This method uses cached
495 information from on-line repositories. Make sure you call UpdateRepository or UpdateAllRepositories
496 before using this method to ensure that the latest information is available.
497 </remarks>
498 </member>
499 <member name="M:Mono.Addins.Setup.RepositoryRegistry.GetAvailableUpdates(Mono.Addins.Setup.RepositorySearchFlags)">
500 <summary>
501 Gets a list of available add-in updates.
502 </summary>
503 <param name="flags">
504 Search flags
505 </param>
506 <returns>
507 A list of add-in references.
508 </returns>
509 <remarks>
510 The list is generated by looking at the add-ins currently installed and checking if there is any
511 add-in with a newer version number in any of the subscribed repositories. This method uses cached
512 information from on-line repositories. Make sure you call UpdateRepository or UpdateAllRepositories
513 before using this method to ensure that the latest information is available.
514 </remarks>
515 </member>
516 <member name="M:Mono.Addins.Setup.RepositoryRegistry.GetAvailableUpdates(System.String)">
517 <summary>
518 Gets a list of available add-in updates in a specific repository.
519 </summary>
520 <param name="repositoryUrl">
521 The repository URL
522 </param>
523 <returns>
524 A list of add-in references.
525 </returns>
526 <remarks>
527 The list is generated by looking at the add-ins currently installed and checking if there is any
528 add-in with a newer version number in the provided repository. This method uses cached
529 information from on-line repositories. Make sure you call UpdateRepository or UpdateAllRepositories
530 before using this method to ensure that the latest information is available.
531 </remarks>
532 </member>
533 <member name="M:Mono.Addins.Setup.RepositoryRegistry.GetAvailableAddinUpdates(System.String)">
534 <summary>
535 Gets a list of available updates for an add-in.
536 </summary>
537 <param name="id">
538 Identifier of the add-in.
539 </param>
540 <returns>
541 List of updates for the specified add-in.
542 </returns>
543 <remarks>
544 The list is generated by checking if there is any
545 add-in with a newer version number in any of the subscribed repositories. This method uses cached
546 information from on-line repositories. Make sure you call UpdateRepository or UpdateAllRepositories
547 before using this method to ensure that the latest information is available.
548 </remarks>
549 </member>
550 <member name="M:Mono.Addins.Setup.RepositoryRegistry.GetAvailableAddinUpdates(System.String,Mono.Addins.Setup.RepositorySearchFlags)">
551 <summary>
552 Gets a list of available updates for an add-in.
553 </summary>
554 <param name="id">
555 Identifier of the add-in.
556 </param>
557 <param name='flags'>
558 Search flags.
559 </param>
560 <returns>
561 List of updates for the specified add-in.
562 </returns>
563 <remarks>
564 The list is generated by checking if there is any
565 add-in with a newer version number in any of the subscribed repositories. This method uses cached
566 information from on-line repositories. Make sure you call UpdateRepository or UpdateAllRepositories
567 before using this method to ensure that the latest information is available.
568 </remarks>
569 </member>
570 <member name="M:Mono.Addins.Setup.RepositoryRegistry.GetAvailableAddinUpdates(System.String,System.String)">
571 <summary>
572 Gets a list of available updates for an add-in in a specific repository
573 </summary>
574 <param name="repositoryUrl">
575 Identifier of the add-in.
576 </param>
577 <param name="id">
578 Identifier of the add-in.
579 </param>
580 <returns>
581 List of updates for the specified add-in.
582 </returns>
583 <remarks>
584 The list is generated by checking if there is any
585 add-in with a newer version number in the provided repository. This method uses cached
586 information from on-line repositories. Make sure you call UpdateRepository or UpdateAllRepositories
587 before using this method to ensure that the latest information is available.
588 </remarks>
589 </member>
590 <member name="M:Mono.Addins.Setup.RepositoryRegistry.GetAvailableAddinUpdates(System.String,System.String,Mono.Addins.Setup.RepositorySearchFlags)">
591 <summary>
592 Gets a list of available updates for an add-in in a specific repository
593 </summary>
594 <param name="repositoryUrl">
595 Identifier of the add-in.
596 </param>
597 <param name="id">
598 Identifier of the add-in.
599 </param>
600 <param name='flags'>
601 Search flags.
602 </param>
603 <returns>
604 List of updates for the specified add-in.
605 </returns>
606 <remarks>
607 The list is generated by checking if there is any
608 add-in with a newer version number in the provided repository. This method uses cached
609 information from on-line repositories. Make sure you call UpdateRepository or UpdateAllRepositories
610 before using this method to ensure that the latest information is available.
611 </remarks>
612 </member>
613 <member name="M:Mono.Addins.Setup.RepositoryRegistry.GetAvailableAddins">
614 <summary>
615 Gets a list of all available add-ins
616 </summary>
617 <returns>
618 A list of add-ins
619 </returns>
620 <remarks>
621 This method uses cached
622 information from on-line repositories. Make sure you call UpdateRepository or UpdateAllRepositories
623 before using this method to ensure that the latest information is available.
624 </remarks>
625 </member>
626 <member name="M:Mono.Addins.Setup.RepositoryRegistry.GetAvailableAddins(Mono.Addins.Setup.RepositorySearchFlags)">
627 <summary>
628 Gets a list of all available add-ins
629 </summary>
630 <returns>
631 The available addins.
632 </returns>
633 <param name='flags'>
634 Search flags.
635 </param>
636 <remarks>
637 This method uses cached
638 information from on-line repositories. Make sure you call UpdateRepository or UpdateAllRepositories
639 before using this method to ensure that the latest information is available.
640 </remarks>
641 </member>
642 <member name="M:Mono.Addins.Setup.RepositoryRegistry.GetAvailableAddins(System.String)">
643 <summary>
644 Gets a list of all available add-ins in a repository
645 </summary>
646 <param name="repositoryUrl">
647 A repository URL
648 </param>
649 <returns>
650 A list of add-ins
651 </returns>
652 <remarks>
653 This method uses cached
654 information from on-line repositories. Make sure you call UpdateRepository or UpdateAllRepositories
655 before using this method to ensure that the latest information is available.
656 </remarks>
657 </member>
658 <member name="M:Mono.Addins.Setup.RepositoryRegistry.GetAvailableAddins(System.String,Mono.Addins.Setup.RepositorySearchFlags)">
659 <summary>
660 Gets a list of all available add-ins in a repository
661 </summary>
662 <param name="repositoryUrl">
663 A repository URL
664 </param>
665 <param name='flags'>
666 Search flags.
667 </param>
668 <returns>
669 A list of add-ins
670 </returns>
671 <remarks>
672 This method uses cached
673 information from on-line repositories. Make sure you call UpdateRepository or UpdateAllRepositories
674 before using this method to ensure that the latest information is available.
675 </remarks>
676 </member>
677 <member name="M:Mono.Addins.Setup.RepositoryRegistry.GetAvailableAddin(System.String,System.String)">
678 <summary>
679 Checks if an add-in is available to be installed
680 </summary>
681 <param name="id">
682 Identifier of the add-in
683 </param>
684 <param name="version">
685 Version of the add-in (optional, it can be null)
686 </param>
687 <returns>
688 A list of add-ins
689 </returns>
690 <remarks>
691 List of references to add-ins available in on-line repositories. This method uses cached
692 information from on-line repositories. Make sure you call UpdateRepository or UpdateAllRepositories
693 before using this method to ensure that the latest information is available.
694 </remarks>
695 </member>
696 <member name="M:Mono.Addins.Setup.RepositoryRegistry.GetAvailableAddin(System.String,System.String,System.String)">
697 <summary>
698 Checks if an add-in is available to be installed from a repository
699 </summary>
700 <param name="repositoryUrl">
701 A repository URL
702 </param>
703 <param name="id">
704 Identifier of the add-in
705 </param>
706 <param name="version">
707 Version of the add-in (optional, it can be null)
708 </param>
709 <returns>
710 A list of add-ins
711 </returns>
712 <remarks>
713 List of references to add-ins available in the repository. This method uses cached
714 information from on-line repositories. Make sure you call UpdateRepository or UpdateAllRepositories
715 before using this method to ensure that the latest information is available.
716 </remarks>
717 </member>
718 <member name="T:Mono.Addins.Setup.RepositorySearchFlags">
719 <summary>
720 Repository search flags.
721 </summary>
722 </member>
723 <member name="F:Mono.Addins.Setup.RepositorySearchFlags.None">
724 <summary>
725 No special search options
726 </summary>
727 </member>
728 <member name="F:Mono.Addins.Setup.RepositorySearchFlags.LatestVersionsOnly">
729 <summary>
730 Only the latest version of every add-in is included in the search
731 </summary>
732 </member>
733 <member name="T:Mono.Addins.Setup.AddinRepository">
734 <summary>
735 An on-line add-in repository
736 </summary>
737 </member>
738 <member name="P:Mono.Addins.Setup.AddinRepository.File">
739 <summary>
740 Path to the cached add-in repository file
741 </summary>
742 </member>
743 <member name="P:Mono.Addins.Setup.AddinRepository.Url">
744 <summary>
745 Url of the repository
746 </summary>
747 </member>
748 <member name="P:Mono.Addins.Setup.AddinRepository.Name">
749 <summary>
750 Do not use. Use Title instead.
751 </summary>
752 </member>
753 <member name="P:Mono.Addins.Setup.AddinRepository.Title">
754 <summary>
755 Title of the repository
756 </summary>
757 </member>
758 <member name="P:Mono.Addins.Setup.AddinRepository.LastModified">
759 <summary>
760 Last change timestamp
761 </summary>
762 </member>
763 <member name="P:Mono.Addins.Setup.AddinRepository.Enabled">
764 <summary>
765 Gets a value indicating whether this <see cref="T:Mono.Addins.Setup.AddinRepository"/> is enabled.
766 </summary>
767 <value>
768 <c>true</c> if enabled; otherwise, <c>false</c>.
769 </value>
770 </member>
771 <member name="T:Mono.Addins.Setup.WebRequestHelper">
772 <summary>
773 Helper for making web requests with support for authenticated proxies.
774 </summary>
775 </member>
776 <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})">
777 <summary>
778 Sets a custom request handler that can handle requests for authenticated proxy servers.
779 </summary>
780 <param name="handler">The custom request handler.</param>
781 </member>
782 <member name="M:Mono.Addins.Setup.WebRequestHelper.GetResponseAsync(System.Func{System.Net.HttpWebRequest},System.Action{System.Net.HttpWebRequest},System.Threading.CancellationToken)">
783 <summary>
784 Gets the web response, using the request handler to handle proxy authentication
785 if necessary.
786 </summary>
787 <returns>The response.</returns>
788 <param name="createRequest">Callback for creating the request.</param>
789 <param name="prepareRequest">Callback for preparing the request, e.g. writing the request stream.</param>
790 <param name="token">Cancellation token.</param>
791 <remarks>
792 Keeps sending requests until a response code that doesn't require authentication happens or if the request
793 requires authentication and the user has stopped trying to enter them (i.e. they hit cancel when they are prompted).
794 </remarks>
795 </member>
796 <member name="M:Mono.Addins.Setup.WebRequestHelper.GetResponse(System.Func{System.Net.HttpWebRequest},System.Action{System.Net.HttpWebRequest},System.Threading.CancellationToken)">
797 <summary>
798 Gets the web response, using the request handler to handle proxy authentication
799 if necessary.
800 </summary>
801 <returns>The response.</returns>
802 <param name="createRequest">Callback for creating the request.</param>
803 <param name="prepareRequest">Callback for preparing the request, e.g. writing the request stream.</param>
804 <param name="token">Cancellation token.</param>
805 <remarks>
806 Keeps sending requests until a response code that doesn't require authentication happens or if the request
807 requires authentication and the user has stopped trying to enter them (i.e. they hit cancel when they are prompted).
808 </remarks>
809 </member>
810 <member name="M:Mono.Addins.Setup.WebRequestHelper.IsCannotReachInternetError(System.Net.WebExceptionStatus)">
811 <summary>
812 Determines whether an error code is likely to have been caused by internet reachability problems.
813 </summary>
814 </member>
815 <member name="T:Mono.Addins.Setup.SetupService">
816 <summary>
817 Provides tools for managing add-ins
818 </summary>
819 <remarks>
820 This class can be used to manage the add-ins of an application. It allows installing and uninstalling
821 add-ins, taking into account add-in dependencies. It provides methods for installing add-ins from on-line
822 repositories and tools for generating those repositories.
823 </remarks>
824 </member>
825 <member name="M:Mono.Addins.Setup.SetupService.#ctor">
826 <summary>
827 Initializes a new instance
828 </summary>
829 <remarks>
830 If the add-in manager is initialized (AddinManager.Initialize has been called), then this instance
831 will manage the add-in registry of the initialized engine.
832 </remarks>
833 </member>
834 <member name="M:Mono.Addins.Setup.SetupService.#ctor(Mono.Addins.AddinRegistry)">
835 <summary>
836 Initializes a new instance
837 </summary>
838 <param name="registry">
839 Add-in registry to manage
840 </param>
841 </member>
842 <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@)">
843 <summary>
844 Resolves add-in dependencies.
845 </summary>
846 <param name="statusMonitor">
847 Progress monitor where to show progress status
848 </param>
849 <param name="addins">
850 List of add-ins to check
851 </param>
852 <param name="resolved">
853 Packages that need to be installed.
854 </param>
855 <param name="toUninstall">
856 Packages that need to be uninstalled.
857 </param>
858 <param name="unresolved">
859 Add-in dependencies that could not be resolved.
860 </param>
861 <returns>
862 True if all dependencies could be resolved.
863 </returns>
864 <remarks>
865 This method can be used to get a list of all packages that have to be installed in order to install
866 an add-in or set of add-ins. The list of packages to install will include the package that provides the
867 add-in, and all packages that provide the add-in dependencies. In some cases, packages may need to
868 be installed (for example, when an installed add-in needs to be upgraded).
869 </remarks>
870 </member>
871 <member name="M:Mono.Addins.Setup.SetupService.ResolveDependencies(Mono.Addins.IProgressStatus,Mono.Addins.Setup.PackageCollection,Mono.Addins.Setup.PackageCollection@,Mono.Addins.Description.DependencyCollection@)">
872 <summary>
873 Resolves add-in dependencies.
874 </summary>
875 <param name="statusMonitor">
876 Progress monitor where to show progress status
877 </param>
878 <param name="packages">
879 Packages that need to be installed.
880 </param>
881 <param name="toUninstall">
882 Packages that need to be uninstalled.
883 </param>
884 <param name="unresolved">
885 Add-in dependencies that could not be resolved.
886 </param>
887 <returns>
888 True if all dependencies could be resolved.
889 </returns>
890 <remarks>
891 This method can be used to get a list of all packages that have to be installed in order to satisfy
892 the dependencies of a package or set of packages. The 'packages' argument must have the list of packages
893 to be resolved. When resolving dependencies, if there is any additional package that needs to be installed,
894 it will be added to the same 'packages' collection. In some cases, packages may need to
895 be installed (for example, when an installed add-in needs to be upgraded). Those packages will be added
896 to the 'toUninstall' collection. Packages that could not be resolved are added to the 'unresolved'
897 collection.
898 </remarks>
899 </member>
900 <member name="M:Mono.Addins.Setup.SetupService.Install(Mono.Addins.IProgressStatus,System.String[])">
901 <summary>
902 Installs add-in packages
903 </summary>
904 <param name="statusMonitor">
905 Progress monitor where to show progress status
906 </param>
907 <param name="files">
908 Paths to the packages to install
909 </param>
910 <returns>
911 True if the installation succeeded
912 </returns>
913 </member>
914 <member name="M:Mono.Addins.Setup.SetupService.Install(Mono.Addins.IProgressStatus,Mono.Addins.Setup.AddinRepositoryEntry[])">
915 <summary>
916 Installs add-in packages from on-line repositories
917 </summary>
918 <param name="statusMonitor">
919 Progress monitor where to show progress status
920 </param>
921 <param name="addins">
922 References to the add-ins to be installed
923 </param>
924 <returns>
925 True if the installation succeeded
926 </returns>
927 </member>
928 <member name="M:Mono.Addins.Setup.SetupService.Install(Mono.Addins.IProgressStatus,Mono.Addins.Setup.PackageCollection)">
929 <summary>
930 Installs add-in packages
931 </summary>
932 <param name="statusMonitor">
933 Progress monitor where to show progress status
934 </param>
935 <param name="packages">
936 Packages to install
937 </param>
938 <returns>
939 True if the installation succeeded
940 </returns>
941 </member>
942 <member name="M:Mono.Addins.Setup.SetupService.Uninstall(Mono.Addins.IProgressStatus,System.String)">
943 <summary>
944 Uninstalls an add-in.
945 </summary>
946 <param name="statusMonitor">
947 Progress monitor where to show progress status
948 </param>
949 <param name="id">
950 Full identifier of the add-in to uninstall.
951 </param>
952 </member>
953 <member name="M:Mono.Addins.Setup.SetupService.Uninstall(Mono.Addins.IProgressStatus,System.Collections.Generic.IEnumerable{System.String})">
954 <summary>
955 Uninstalls a set of add-ins
956 </summary>
957 <param name='statusMonitor'>
958 Progress monitor where to show progress status
959 </param>
960 <param name='ids'>
961 Full identifiers of the add-ins to uninstall.
962 </param>
963 </member>
964 <member name="M:Mono.Addins.Setup.SetupService.GetAddinHeader(Mono.Addins.Addin)">
965 <summary>
966 Gets information about an add-in
967 </summary>
968 <param name="addin">
969 The add-in
970 </param>
971 <returns>
972 Add-in header data
973 </returns>
974 </member>
975 <member name="M:Mono.Addins.Setup.SetupService.GetDependentAddins(System.String,System.Boolean)">
976 <summary>
977 Gets a list of add-ins which depend on an add-in
978 </summary>
979 <param name="id">
980 Full identifier of an add-in.
981 </param>
982 <param name="recursive">
983 When set to True, dependencies will be gathered recursivelly
984 </param>
985 <returns>
986 List of dependent add-ins.
987 </returns>
988 <remarks>
989 This methods returns a list of add-ins which have the add-in identified by 'id' as a direct
990 (or indirect if recursive=True) dependency.
991 </remarks>
992 </member>
993 <member name="M:Mono.Addins.Setup.SetupService.BuildPackage(Mono.Addins.IProgressStatus,System.String,System.String[])">
994 <summary>
995 Packages an add-in
996 </summary>
997 <param name="statusMonitor">
998 Progress monitor where to show progress status
999 </param>
1000 <param name="targetDirectory">
1001 Directory where to generate the package
1002 </param>
1003 <param name="filePaths">
1004 Paths to the add-ins to be packaged. Paths can be either the main assembly of an add-in, or an add-in
1005 manifest (.addin or .addin.xml).
1006 </param>
1007 <remarks>
1008 This method can be used to create a package for an add-in, which can then be pushed to an on-line
1009 repository. The package will include the main assembly or manifest of the add-in and any external
1010 file declared in the add-in metadata.
1011 </remarks>
1012 </member>
1013 <member name="M:Mono.Addins.Setup.SetupService.BuildRepository(Mono.Addins.IProgressStatus,System.String)">
1014 <summary>
1015 Generates an on-line repository
1016 </summary>
1017 <param name="statusMonitor">
1018 Progress monitor where to show progress status
1019 </param>
1020 <param name="path">
1021 Path to the directory that contains the add-ins and that is going to be published
1022 </param>
1023 <remarks>
1024 This method generates the index files required to publish a directory as an online repository
1025 of add-ins.
1026 </remarks>
1027 </member>
1028 <member name="M:Mono.Addins.Setup.SetupService.GetExtensibleApplication(System.String)">
1029 <summary>
1030 Gets a reference to an extensible application
1031 </summary>
1032 <param name="name">
1033 Name of the application
1034 </param>
1035 <returns>
1036 The Application object. Null if not found.
1037 </returns>
1038 </member>
1039 <member name="M:Mono.Addins.Setup.SetupService.GetExtensibleApplication(System.String,System.Collections.Generic.IEnumerable{System.String})">
1040 <summary>
1041 Gets a reference to an extensible application
1042 </summary>
1043 <param name="name">
1044 Name of the application
1045 </param>
1046 <param name="searchPaths">
1047 Custom paths where to look for the application.
1048 </param>
1049 <returns>
1050 The Application object. Null if not found.
1051 </returns>
1052 </member>
1053 <member name="M:Mono.Addins.Setup.SetupService.GetExtensibleApplications">
1054 <summary>
1055 Gets a lis of all known extensible applications
1056 </summary>
1057 <returns>
1058 A list of applications.
1059 </returns>
1060 </member>
1061 <member name="M:Mono.Addins.Setup.SetupService.GetExtensibleApplications(System.Collections.Generic.IEnumerable{System.String})">
1062 <summary>
1063 Gets a lis of all known extensible applications
1064 </summary>
1065 <param name="searchPaths">
1066 Custom paths where to look for applications.
1067 </param>
1068 <returns>
1069 A list of applications.
1070 </returns>
1071 </member>
1072 <member name="P:Mono.Addins.Setup.SetupService.Registry">
1073 <summary>
1074 The add-in registry being managed
1075 </summary>
1076 </member>
1077 <member name="P:Mono.Addins.Setup.SetupService.ApplicationNamespace">
1078 <summary>
1079 Default add-in namespace of the application (optional). If set, only add-ins that belong to that namespace
1080 will be shown in add-in lists.
1081 </summary>
1082 </member>
1083 <member name="P:Mono.Addins.Setup.SetupService.InstallDirectory">
1084 <summary>
1085 Directory where to install add-ins. If not specified, the 'addins' subdirectory of the
1086 registry location is used.
1087 </summary>
1088 </member>
1089 <member name="P:Mono.Addins.Setup.SetupService.Repositories">
1090 <summary>
1091 Returns a RepositoryRegistry which can be used to manage on-line repository references
1092 </summary>
1093 </member>
1094 <member name="T:Mono.Addins.Setup.Application">
1095 <summary>
1096 A registered extensible application
1097 </summary>
1098 </member>
1099 <member name="P:Mono.Addins.Setup.Application.Registry">
1100 <summary>
1101 Add-in registry of the application
1102 </summary>
1103 </member>
1104 <member name="P:Mono.Addins.Setup.Application.Description">
1105 <summary>
1106 Description of the application
1107 </summary>
1108 </member>
1109 <member name="P:Mono.Addins.Setup.Application.Name">
1110 <summary>
1111 Name of the application
1112 </summary>
1113 </member>
1114 <member name="P:Mono.Addins.Setup.Application.RegistryPath">
1115 <summary>
1116 Path to the add-in registry
1117 </summary>
1118 </member>
1119 <member name="P:Mono.Addins.Setup.Application.StartupPath">
1120 <summary>
1121 Path to the directory that contains the main executable assembly of the application
1122 </summary>
1123 </member>
1124 <member name="P:Mono.Addins.Setup.Application.TestCommand">
1125 <summary>
1126 Command to be used to execute the application in add-in development mode.
1127 </summary>
1128 </member>
1129 <member name="P:Mono.Addins.Setup.Application.AddinsPath">
1130 <summary>
1131 Path to the default add-ins directory for the aplpication
1132 </summary>
1133 </member>
1134 <member name="P:Mono.Addins.Setup.Application.AddinCachePath">
1135 <summary>
1136 Path to the add-in cache for the application
1137 </summary>
1138 </member>
1139 </members>
1140</doc>
generated by cgit v1.1 at 2024-06-26 00:16:39 +0000