개정판 9d5b4bc2
auto Update 기능 추가
Change-Id: I195d4506bd1dd9cfd58dbdeada74e89a1b9d307e
AppCast/NetSparkle.xml | ||
---|---|---|
1 |
<?xml version="1.0"?> |
|
2 |
<doc> |
|
3 |
<assembly> |
|
4 |
<name>NetSparkle</name> |
|
5 |
</assembly> |
|
6 |
<members> |
|
7 |
<member name="T:NetSparkleUpdater.AppCastHandlers.XMLAppCast"> |
|
8 |
<summary> |
|
9 |
An XML-based appcast document downloader and handler |
|
10 |
</summary> |
|
11 |
</member> |
|
12 |
<member name="F:NetSparkleUpdater.AppCastHandlers.XMLAppCast.SparkleNamespace"> |
|
13 |
<summary> |
|
14 |
Sparkle XML namespace |
|
15 |
</summary> |
|
16 |
</member> |
|
17 |
<member name="P:NetSparkleUpdater.AppCastHandlers.XMLAppCast.Title"> |
|
18 |
<summary> |
|
19 |
AppCast Title |
|
20 |
</summary> |
|
21 |
</member> |
|
22 |
<member name="P:NetSparkleUpdater.AppCastHandlers.XMLAppCast.Language"> |
|
23 |
<summary> |
|
24 |
AppCast Language |
|
25 |
</summary> |
|
26 |
</member> |
|
27 |
<member name="F:NetSparkleUpdater.AppCastHandlers.XMLAppCast.Items"> |
|
28 |
<summary> |
|
29 |
AppCastItems from the appcast |
|
30 |
</summary> |
|
31 |
</member> |
|
32 |
<member name="M:NetSparkleUpdater.AppCastHandlers.XMLAppCast.#ctor"> |
|
33 |
<summary> |
|
34 |
Constructor |
|
35 |
</summary> |
|
36 |
</member> |
|
37 |
<member name="M:NetSparkleUpdater.AppCastHandlers.XMLAppCast.SetupAppCastHandler(NetSparkleUpdater.Interfaces.IAppCastDataDownloader,System.String,NetSparkleUpdater.Configurations.Configuration,NetSparkleUpdater.Interfaces.ISignatureVerifier,NetSparkleUpdater.Interfaces.ILogger)"> |
|
38 |
<summary> |
|
39 |
Setup the app cast handler info for downloading and parsing app cast information |
|
40 |
</summary> |
|
41 |
<param name="dataDownloader">downloader that will manage the app cast download |
|
42 |
(provided by <see cref="T:NetSparkleUpdater.SparkleUpdater"/> via the |
|
43 |
<see cref="P:NetSparkleUpdater.SparkleUpdater.AppCastDataDownloader"/> property.</param> |
|
44 |
<param name="castUrl">full URL to the app cast file</param> |
|
45 |
<param name="config">configuration for handling update intervals/checks |
|
46 |
(user skipped versions, etc.)</param> |
|
47 |
<param name="signatureVerifier">Object to check signatures of app cast information</param> |
|
48 |
<param name="logWriter">object that you can utilize to do any necessary logging</param> |
|
49 |
</member> |
|
50 |
<member name="M:NetSparkleUpdater.AppCastHandlers.XMLAppCast.DownloadAndParse"> |
|
51 |
<summary> |
|
52 |
Download castUrl resource and parse it |
|
53 |
</summary> |
|
54 |
</member> |
|
55 |
<member name="M:NetSparkleUpdater.AppCastHandlers.XMLAppCast.ParseAppCast(System.String)"> |
|
56 |
<summary> |
|
57 |
Parse the app cast XML string into a list of <see cref="T:NetSparkleUpdater.AppCastItem"/> objects. |
|
58 |
When complete, the Items list should contain the parsed information |
|
59 |
as <see cref="T:NetSparkleUpdater.AppCastItem"/> objects. |
|
60 |
</summary> |
|
61 |
<param name="appcast">the non-null string XML app cast</param> |
|
62 |
</member> |
|
63 |
<member name="M:NetSparkleUpdater.AppCastHandlers.XMLAppCast.GetAvailableUpdates"> |
|
64 |
<summary> |
|
65 |
Returns sorted list of updates between current and latest. Installed is not included. |
|
66 |
</summary> |
|
67 |
</member> |
|
68 |
<member name="M:NetSparkleUpdater.AppCastHandlers.XMLAppCast.GenerateAppCastXml(System.Collections.Generic.List{NetSparkleUpdater.AppCastItem},System.String,System.String,System.String,System.String)"> |
|
69 |
<summary> |
|
70 |
Create AppCast XML |
|
71 |
</summary> |
|
72 |
<param name="items">The AppCastItems to include in the AppCast</param> |
|
73 |
<param name="title">AppCast application title</param> |
|
74 |
<param name="link">AppCast link</param> |
|
75 |
<param name="description">AppCast description</param> |
|
76 |
<param name="language">AppCast language</param> |
|
77 |
<returns>AppCast xml document</returns> |
|
78 |
</member> |
|
79 |
<member name="T:NetSparkleUpdater.AppCastItem"> |
|
80 |
<summary> |
|
81 |
Item from a Sparkle AppCast file |
|
82 |
</summary> |
|
83 |
</member> |
|
84 |
<member name="P:NetSparkleUpdater.AppCastItem.AppName"> |
|
85 |
<summary> |
|
86 |
The application name |
|
87 |
</summary> |
|
88 |
</member> |
|
89 |
<member name="P:NetSparkleUpdater.AppCastItem.AppVersionInstalled"> |
|
90 |
<summary> |
|
91 |
The installed version |
|
92 |
</summary> |
|
93 |
</member> |
|
94 |
<member name="P:NetSparkleUpdater.AppCastItem.Title"> |
|
95 |
<summary> |
|
96 |
The item title |
|
97 |
</summary> |
|
98 |
</member> |
|
99 |
<member name="P:NetSparkleUpdater.AppCastItem.Version"> |
|
100 |
<summary> |
|
101 |
The available version |
|
102 |
</summary> |
|
103 |
</member> |
|
104 |
<member name="P:NetSparkleUpdater.AppCastItem.ShortVersion"> |
|
105 |
<summary> |
|
106 |
Shortened version |
|
107 |
</summary> |
|
108 |
</member> |
|
109 |
<member name="P:NetSparkleUpdater.AppCastItem.ReleaseNotesLink"> |
|
110 |
<summary> |
|
111 |
The release notes link |
|
112 |
</summary> |
|
113 |
</member> |
|
114 |
<member name="P:NetSparkleUpdater.AppCastItem.ReleaseNotesSignature"> |
|
115 |
<summary> |
|
116 |
The signature of the Release Notes file |
|
117 |
</summary> |
|
118 |
</member> |
|
119 |
<member name="P:NetSparkleUpdater.AppCastItem.Description"> |
|
120 |
<summary> |
|
121 |
The embedded description |
|
122 |
</summary> |
|
123 |
</member> |
|
124 |
<member name="P:NetSparkleUpdater.AppCastItem.DownloadLink"> |
|
125 |
<summary> |
|
126 |
The download link |
|
127 |
</summary> |
|
128 |
</member> |
|
129 |
<member name="P:NetSparkleUpdater.AppCastItem.DownloadSignature"> |
|
130 |
<summary> |
|
131 |
The signature of the download file |
|
132 |
</summary> |
|
133 |
</member> |
|
134 |
<member name="P:NetSparkleUpdater.AppCastItem.PublicationDate"> |
|
135 |
<summary> |
|
136 |
Date item was published |
|
137 |
</summary> |
|
138 |
</member> |
|
139 |
<member name="P:NetSparkleUpdater.AppCastItem.IsCriticalUpdate"> |
|
140 |
<summary> |
|
141 |
Whether the update was marked critical or not via sparkle:critical |
|
142 |
</summary> |
|
143 |
</member> |
|
144 |
<member name="P:NetSparkleUpdater.AppCastItem.UpdateSize"> |
|
145 |
<summary> |
|
146 |
Length of update set via sparkle:length |
|
147 |
</summary> |
|
148 |
</member> |
|
149 |
<member name="P:NetSparkleUpdater.AppCastItem.OperatingSystemString"> |
|
150 |
<summary> |
|
151 |
Operating system that this update applies to |
|
152 |
</summary> |
|
153 |
</member> |
|
154 |
<member name="P:NetSparkleUpdater.AppCastItem.IsWindowsUpdate"> |
|
155 |
<summary> |
|
156 |
True if this update is a windows update; false otherwise. |
|
157 |
Acceptable OS strings are: "win" or "windows" (this is |
|
158 |
checked with a case-insensitive check). If not specified, |
|
159 |
assumed to be a Windows update. |
|
160 |
</summary> |
|
161 |
</member> |
|
162 |
<member name="P:NetSparkleUpdater.AppCastItem.IsMacOSUpdate"> |
|
163 |
<summary> |
|
164 |
True if this update is a macOS update; false otherwise. |
|
165 |
Acceptable OS strings are: "mac", "osx", or "macos" (this is |
|
166 |
checked with a case-insensitive check). If not specified, |
|
167 |
assumed to be a Windows update. |
|
168 |
</summary> |
|
169 |
</member> |
|
170 |
<member name="P:NetSparkleUpdater.AppCastItem.IsLinuxUpdate"> |
|
171 |
<summary> |
|
172 |
True if this update is a macOS update; false otherwise. |
|
173 |
Acceptable OS strings are: "linux" (this is |
|
174 |
checked with a case-insensitive check). If not specified, |
|
175 |
assumed to be a Linux update. |
|
176 |
</summary> |
|
177 |
</member> |
|
178 |
<member name="P:NetSparkleUpdater.AppCastItem.MIMEType"> |
|
179 |
<summary> |
|
180 |
MIME type for file as specified in the closure tag. Defaults to "application/octet-stream". |
|
181 |
</summary> |
|
182 |
</member> |
|
183 |
<member name="M:NetSparkleUpdater.AppCastItem.Parse(System.String,System.String,System.String,System.Xml.Linq.XElement,NetSparkleUpdater.Interfaces.ILogger)"> |
|
184 |
<summary> |
|
185 |
Parse item Xml Node to AppCastItem |
|
186 |
</summary> |
|
187 |
<param name="installedVersion">Currently installed version</param> |
|
188 |
<param name="applicationName">Application name</param> |
|
189 |
<param name="castUrl">The url of the appcast</param> |
|
190 |
<param name="item">The item XML node</param> |
|
191 |
<param name="logWriter">logwriter instance</param> |
|
192 |
<returns>AppCastItem from Xml Node</returns> |
|
193 |
</member> |
|
194 |
<member name="M:NetSparkleUpdater.AppCastItem.GetXElement"> |
|
195 |
<summary> |
|
196 |
Create Xml node from this instance of AppCastItem |
|
197 |
</summary> |
|
198 |
<returns>An XML node</returns> |
|
199 |
</member> |
|
200 |
<member name="M:NetSparkleUpdater.AppCastItem.CompareTo(NetSparkleUpdater.AppCastItem)"> |
|
201 |
<summary> |
|
202 |
Compares this instance to another |
|
203 |
</summary> |
|
204 |
<param name="other">the other instance</param> |
|
205 |
<returns>-1, 0, 1 if this instance is less than, equal to, or greater than the <paramref name="other"/></returns> |
|
206 |
</member> |
|
207 |
<member name="M:NetSparkleUpdater.AppCastItem.Equals(System.Object)"> |
|
208 |
<summary> |
|
209 |
Equality check to another instance |
|
210 |
</summary> |
|
211 |
<param name="obj">the instance to compare to</param> |
|
212 |
<returns></returns> |
|
213 |
</member> |
|
214 |
<member name="M:NetSparkleUpdater.AppCastItem.GetHashCode"> |
|
215 |
<summary> |
|
216 |
Derive hashcode from immutable variables |
|
217 |
</summary> |
|
218 |
<returns></returns> |
|
219 |
</member> |
|
220 |
<member name="M:NetSparkleUpdater.AppCastItem.op_Equality(NetSparkleUpdater.AppCastItem,NetSparkleUpdater.AppCastItem)"> |
|
221 |
<summary> |
|
222 |
Check equality of two AppCastItem instances |
|
223 |
</summary> |
|
224 |
<param name="left">AppCastItem to compare</param> |
|
225 |
<param name="right">AppCastItem to compare</param> |
|
226 |
<returns>True if items are the same</returns> |
|
227 |
</member> |
|
228 |
<member name="M:NetSparkleUpdater.AppCastItem.op_Inequality(NetSparkleUpdater.AppCastItem,NetSparkleUpdater.AppCastItem)"> |
|
229 |
<summary> |
|
230 |
Check if two AppCastItem instances are different |
|
231 |
</summary> |
|
232 |
<param name="left">AppCastItem to compare</param> |
|
233 |
<param name="right">AppCastItem to compare</param> |
|
234 |
<returns>True if items are different</returns> |
|
235 |
</member> |
|
236 |
<member name="M:NetSparkleUpdater.AppCastItem.op_LessThan(NetSparkleUpdater.AppCastItem,NetSparkleUpdater.AppCastItem)"> |
|
237 |
<summary> |
|
238 |
Less than comparison of version between two AppCastItem instances |
|
239 |
</summary> |
|
240 |
<param name="left">AppCastItem to compare</param> |
|
241 |
<param name="right">AppCastItem to compare</param> |
|
242 |
<returns>True if left version is less than right version</returns> |
|
243 |
</member> |
|
244 |
<member name="M:NetSparkleUpdater.AppCastItem.op_LessThanOrEqual(NetSparkleUpdater.AppCastItem,NetSparkleUpdater.AppCastItem)"> |
|
245 |
<summary> |
|
246 |
Less than or equal to comparison of version between two AppCastItem instances |
|
247 |
</summary> |
|
248 |
<param name="left">AppCastItem to compare</param> |
|
249 |
<param name="right">AppCastItem to compare</param> |
|
250 |
<returns>True if left version is less than or equal to right version</returns> |
|
251 |
</member> |
|
252 |
<member name="M:NetSparkleUpdater.AppCastItem.op_GreaterThan(NetSparkleUpdater.AppCastItem,NetSparkleUpdater.AppCastItem)"> |
|
253 |
<summary> |
|
254 |
Greater than comparison of version between two AppCastItem instances |
|
255 |
</summary> |
|
256 |
<param name="left">AppCastItem to compare</param> |
|
257 |
<param name="right">AppCastItem to compare</param> |
|
258 |
<returns>True if left version is greater than right version</returns> |
|
259 |
</member> |
|
260 |
<member name="M:NetSparkleUpdater.AppCastItem.op_GreaterThanOrEqual(NetSparkleUpdater.AppCastItem,NetSparkleUpdater.AppCastItem)"> |
|
261 |
<summary> |
|
262 |
Greater than or equal to comparison of version between two AppCastItem instances |
|
263 |
</summary> |
|
264 |
<param name="left">AppCastItem to compare</param> |
|
265 |
<param name="right">AppCastItem to compare</param> |
|
266 |
<returns>True if left version is greater than or equal to right version</returns> |
|
267 |
</member> |
|
268 |
<member name="T:NetSparkleUpdater.AssemblyAccessors.AssemblyDiagnosticsAccessor"> |
|
269 |
<summary> |
|
270 |
A diagnostic accessor |
|
271 |
</summary> |
|
272 |
</member> |
|
273 |
<member name="M:NetSparkleUpdater.AssemblyAccessors.AssemblyDiagnosticsAccessor.#ctor(System.String)"> |
|
274 |
<summary> |
|
275 |
Constructor |
|
276 |
</summary> |
|
277 |
<param name="assemblyName">the assembly name</param> |
|
278 |
</member> |
|
279 |
<member name="P:NetSparkleUpdater.AssemblyAccessors.AssemblyDiagnosticsAccessor.AssemblyTitle"> |
|
280 |
<summary> |
|
281 |
Gets the Title |
|
282 |
</summary> |
|
283 |
</member> |
|
284 |
<member name="P:NetSparkleUpdater.AssemblyAccessors.AssemblyDiagnosticsAccessor.AssemblyVersion"> |
|
285 |
<summary> |
|
286 |
Gets the version |
|
287 |
</summary> |
|
288 |
</member> |
|
289 |
<member name="P:NetSparkleUpdater.AssemblyAccessors.AssemblyDiagnosticsAccessor.AssemblyDescription"> |
|
290 |
<summary> |
|
291 |
Gets the description |
|
292 |
</summary> |
|
293 |
</member> |
|
294 |
<member name="P:NetSparkleUpdater.AssemblyAccessors.AssemblyDiagnosticsAccessor.AssemblyProduct"> |
|
295 |
<summary> |
|
296 |
gets the product |
|
297 |
</summary> |
|
298 |
</member> |
|
299 |
<member name="P:NetSparkleUpdater.AssemblyAccessors.AssemblyDiagnosticsAccessor.AssemblyCopyright"> |
|
300 |
<summary> |
|
301 |
Gets the copyright |
|
302 |
</summary> |
|
303 |
</member> |
|
304 |
<member name="P:NetSparkleUpdater.AssemblyAccessors.AssemblyDiagnosticsAccessor.AssemblyCompany"> |
|
305 |
<summary> |
|
306 |
Gets the company |
|
307 |
</summary> |
|
308 |
</member> |
|
309 |
<member name="T:NetSparkleUpdater.AssemblyAccessors.AssemblyReflectionAccessor"> |
|
310 |
<summary> |
|
311 |
Assembly reflection accessor |
|
312 |
</summary> |
|
313 |
</member> |
|
314 |
<member name="M:NetSparkleUpdater.AssemblyAccessors.AssemblyReflectionAccessor.#ctor(System.String)"> |
|
315 |
<summary> |
|
316 |
Constructor |
|
317 |
</summary> |
|
318 |
<param name="assemblyName">the assembly name</param> |
|
319 |
</member> |
|
320 |
<member name="M:NetSparkleUpdater.AssemblyAccessors.AssemblyReflectionAccessor.CreateAttribute(System.Reflection.CustomAttributeData)"> |
|
321 |
<summary> |
|
322 |
This methods creates an attribute instance from the attribute data |
|
323 |
information |
|
324 |
</summary> |
|
325 |
</member> |
|
326 |
<member name="P:NetSparkleUpdater.AssemblyAccessors.AssemblyReflectionAccessor.AssemblyTitle"> |
|
327 |
<summary> |
|
328 |
Gets the assembly title |
|
329 |
</summary> |
|
330 |
</member> |
|
331 |
<member name="P:NetSparkleUpdater.AssemblyAccessors.AssemblyReflectionAccessor.AssemblyVersion"> |
|
332 |
<summary> |
|
333 |
Gets the version |
|
334 |
</summary> |
|
335 |
</member> |
|
336 |
<member name="P:NetSparkleUpdater.AssemblyAccessors.AssemblyReflectionAccessor.AssemblyDescription"> |
|
337 |
<summary> |
|
338 |
Gets the description |
|
339 |
</summary> |
|
340 |
</member> |
|
341 |
<member name="P:NetSparkleUpdater.AssemblyAccessors.AssemblyReflectionAccessor.AssemblyProduct"> |
|
342 |
<summary> |
|
343 |
Gets the product |
|
344 |
</summary> |
|
345 |
</member> |
|
346 |
<member name="P:NetSparkleUpdater.AssemblyAccessors.AssemblyReflectionAccessor.AssemblyCopyright"> |
|
347 |
<summary> |
|
348 |
Gets the copyright |
|
349 |
</summary> |
|
350 |
</member> |
|
351 |
<member name="P:NetSparkleUpdater.AssemblyAccessors.AssemblyReflectionAccessor.AssemblyCompany"> |
|
352 |
<summary> |
|
353 |
Gets the company |
|
354 |
</summary> |
|
355 |
</member> |
|
356 |
<member name="T:NetSparkleUpdater.Configurations.Configuration"> |
|
357 |
<summary> |
|
358 |
Abstract class to handle |
|
359 |
update intervals. |
|
360 |
|
|
361 |
CheckForUpdate - Boolean - Whether NetSparkle should check for updates |
|
362 |
LastCheckTime - time_t - Time of last check |
|
363 |
SkipThisVersion - String - If the user skipped an update, then the version to ignore is stored here (e.g. "1.4.3") |
|
364 |
DidRunOnce - Boolean - Check only one time when the app launched |
|
365 |
</summary> |
|
366 |
</member> |
|
367 |
<member name="P:NetSparkleUpdater.Configurations.Configuration.ApplicationName"> |
|
368 |
<summary> |
|
369 |
The application name |
|
370 |
</summary> |
|
371 |
</member> |
|
372 |
<member name="P:NetSparkleUpdater.Configurations.Configuration.PreviousVersionOfSoftwareRan"> |
|
373 |
<summary> |
|
374 |
The previous version of the software that the user ran |
|
375 |
</summary> |
|
376 |
</member> |
|
377 |
<member name="P:NetSparkleUpdater.Configurations.Configuration.InstalledVersion"> |
|
378 |
<summary> |
|
379 |
The currently-installed version |
|
380 |
</summary> |
|
381 |
</member> |
|
382 |
<member name="P:NetSparkleUpdater.Configurations.Configuration.CheckForUpdate"> |
|
383 |
<summary> |
|
384 |
Flag to indicate if we should check for updates |
|
385 |
</summary> |
|
386 |
</member> |
|
387 |
<member name="P:NetSparkleUpdater.Configurations.Configuration.IsFirstRun"> |
|
388 |
<summary> |
|
389 |
True if this is the first time the application has been run based on save config data; false otherwise |
|
390 |
</summary> |
|
391 |
</member> |
|
392 |
<member name="P:NetSparkleUpdater.Configurations.Configuration.LastCheckTime"> |
|
393 |
<summary> |
|
394 |
Last check time |
|
395 |
</summary> |
|
396 |
</member> |
|
397 |
<member name="P:NetSparkleUpdater.Configurations.Configuration.LastVersionSkipped"> |
|
398 |
<summary> |
|
399 |
The last-skipped version number |
|
400 |
</summary> |
|
401 |
</member> |
|
402 |
<member name="P:NetSparkleUpdater.Configurations.Configuration.DidRunOnce"> |
|
403 |
<summary> |
|
404 |
Whether or not the application has run at least one time |
|
405 |
</summary> |
|
406 |
</member> |
|
407 |
<member name="P:NetSparkleUpdater.Configurations.Configuration.LastConfigUpdate"> |
|
408 |
<summary> |
|
409 |
Last profile update |
|
410 |
</summary> |
|
411 |
</member> |
|
412 |
<member name="P:NetSparkleUpdater.Configurations.Configuration.AssemblyAccessor"> |
|
413 |
<summary> |
|
414 |
Object that accesses version, title, etc. info for the currently running application |
|
415 |
(or some other application) |
|
416 |
</summary> |
|
417 |
</member> |
|
418 |
<member name="M:NetSparkleUpdater.Configurations.Configuration.#ctor(NetSparkleUpdater.Interfaces.IAssemblyAccessor)"> |
|
419 |
<summary> |
|
420 |
Constructor for Configuration -- should load values by the end of the constructor! |
|
421 |
</summary> |
|
422 |
<param name="assemblyAccessor">Object that accesses version, title, etc. info for the application |
|
423 |
you would like to check for updates for</param> |
|
424 |
</member> |
|
425 |
<member name="M:NetSparkleUpdater.Configurations.Configuration.TouchProfileTime"> |
|
426 |
<summary> |
|
427 |
Touches to profile time |
|
428 |
</summary> |
|
429 |
</member> |
|
430 |
<member name="M:NetSparkleUpdater.Configurations.Configuration.TouchCheckTime"> |
|
431 |
<summary> |
|
432 |
Touches the check time to now, should be used after a check directly |
|
433 |
</summary> |
|
434 |
</member> |
|
435 |
<member name="M:NetSparkleUpdater.Configurations.Configuration.SetVersionToSkip(System.String)"> |
|
436 |
<summary> |
|
437 |
This method allows to skip a specific version |
|
438 |
</summary> |
|
439 |
<param name="version">the version to skeip</param> |
|
440 |
</member> |
|
441 |
<member name="M:NetSparkleUpdater.Configurations.Configuration.Reload"> |
|
442 |
<summary> |
|
443 |
Reloads the configuration object |
|
444 |
</summary> |
|
445 |
</member> |
|
446 |
<member name="M:NetSparkleUpdater.Configurations.Configuration.InitWithDefaultValues"> |
|
447 |
<summary> |
|
448 |
This method sets default values for the config |
|
449 |
</summary> |
|
450 |
</member> |
|
451 |
<member name="M:NetSparkleUpdater.Configurations.JSONConfiguration.#ctor(NetSparkleUpdater.Interfaces.IAssemblyAccessor)"> |
|
452 |
<summary> |
|
453 |
Constructor for a configuration that saves and loads its configuration data to and |
|
454 |
from a JSON file that resides on disk. This Configuration can be used on any |
|
455 |
operating system. |
|
456 |
</summary> |
|
457 |
<param name="assemblyAccessor">Object that accesses version, title, etc. info for the application |
|
458 |
you would like to check for updates for</param> |
|
459 |
</member> |
|
460 |
<member name="M:NetSparkleUpdater.Configurations.JSONConfiguration.#ctor(NetSparkleUpdater.Interfaces.IAssemblyAccessor,System.String)"> |
|
461 |
<summary> |
|
462 |
Constructor for a configuration that saves and loads its configuration data to and |
|
463 |
from a JSON file that resides on disk. This Configuration can be used on any |
|
464 |
operating system. |
|
465 |
</summary> |
|
466 |
<param name="assemblyAccessor">Object that accesses version, title, etc. info for the application |
|
467 |
you would like to check for updates for</param> |
|
468 |
<param name="savePath">location to save the JSON configuration data to; can be null or empty string. |
|
469 |
If not null or empty string, must represent a valid path on disk (directories must already be created). |
|
470 |
This class will take care of creating/overwriting the file at that path if necessary.</param> |
|
471 |
</member> |
|
472 |
<member name="M:NetSparkleUpdater.Configurations.JSONConfiguration.TouchProfileTime"> |
|
473 |
<summary> |
|
474 |
Touches to profile time |
|
475 |
</summary> |
|
476 |
</member> |
|
477 |
<member name="M:NetSparkleUpdater.Configurations.JSONConfiguration.TouchCheckTime"> |
|
478 |
<summary> |
|
479 |
Touches the check time to now, should be used after a check directly |
|
480 |
</summary> |
|
481 |
</member> |
|
482 |
<member name="M:NetSparkleUpdater.Configurations.JSONConfiguration.SetVersionToSkip(System.String)"> |
|
483 |
<summary> |
|
484 |
This method allows to skip a specific version |
|
485 |
</summary> |
|
486 |
<param name="version">the version to skeip</param> |
|
487 |
</member> |
|
488 |
<member name="M:NetSparkleUpdater.Configurations.JSONConfiguration.Reload"> |
|
489 |
<summary> |
|
490 |
Reloads the configuration object |
|
491 |
</summary> |
|
492 |
</member> |
|
493 |
<member name="M:NetSparkleUpdater.Configurations.JSONConfiguration.GetSavePath"> |
|
494 |
<summary> |
|
495 |
This function build a valid registry path in dependecy to the |
|
496 |
assembly information |
|
497 |
</summary> |
|
498 |
</member> |
|
499 |
<member name="M:NetSparkleUpdater.Configurations.JSONConfiguration.LoadValuesFromPath(System.String)"> |
|
500 |
<summary> |
|
501 |
This method loads the values from registry |
|
502 |
</summary> |
|
503 |
<param name="saveLocation">the saved file location</param> |
|
504 |
<returns><c>true</c> if the items were loaded</returns> |
|
505 |
</member> |
|
506 |
<member name="M:NetSparkleUpdater.Configurations.JSONConfiguration.SaveValuesToPath(System.String)"> |
|
507 |
<summary> |
|
508 |
This method stores the information to disk as json |
|
509 |
</summary> |
|
510 |
<param name="savePath">the save path to the json file</param> |
|
511 |
<returns><c>true</c> if the values were saved to disk</returns> |
|
512 |
</member> |
|
513 |
<member name="T:NetSparkleUpdater.Configurations.RegistryConfiguration"> |
|
514 |
<summary> |
|
515 |
This class handles all registry values which are used from sparkle to handle |
|
516 |
update intervalls. All values are stored in HKCU\Software\Vendor\AppName which |
|
517 |
will be read ot from the assembly information. All values are of the REG_SZ |
|
518 |
type, no matter what their "logical" type is. The following options are |
|
519 |
available: |
|
520 |
|
|
521 |
CheckForUpdate - Boolean - Whether NetSparkle should check for updates |
|
522 |
LastCheckTime - time_t - Time of last check |
|
523 |
SkipThisVersion - String - If the user skipped an update, then the version to ignore is stored here (e.g. "1.4.3") |
|
524 |
DidRunOnce - Boolean - Check only one time when the app launched |
|
525 |
</summary> |
|
526 |
</member> |
|
527 |
<member name="M:NetSparkleUpdater.Configurations.RegistryConfiguration.#ctor(NetSparkleUpdater.Interfaces.IAssemblyAccessor)"> |
|
528 |
<summary> |
|
529 |
Constructor for a configuration that saves and loads information from the Windows registry. |
|
530 |
This should only be used on Windows! |
|
531 |
</summary> |
|
532 |
<param name="assemblyAccessor">Object that accesses version, title, etc. info for the application |
|
533 |
you would like to check for updates for</param> |
|
534 |
</member> |
|
535 |
<member name="M:NetSparkleUpdater.Configurations.RegistryConfiguration.#ctor(NetSparkleUpdater.Interfaces.IAssemblyAccessor,System.String)"> |
|
536 |
<summary> |
|
537 |
Constructor for a configuration that saves and loads information from the Windows registry. |
|
538 |
This should only be used on Windows! |
|
539 |
</summary> |
|
540 |
<param name="assemblyAccessor">Object that accesses version, title, etc. info for the application |
|
541 |
you would like to check for updates for</param> |
|
542 |
<param name="registryPath">Location in the registry where configuration data should be stored and |
|
543 |
loaded from</param> |
|
544 |
</member> |
|
545 |
<member name="M:NetSparkleUpdater.Configurations.RegistryConfiguration.TouchProfileTime"> |
|
546 |
<summary> |
|
547 |
Touches to profile time |
|
548 |
</summary> |
|
549 |
</member> |
|
550 |
<member name="M:NetSparkleUpdater.Configurations.RegistryConfiguration.TouchCheckTime"> |
|
551 |
<summary> |
|
552 |
Touches the check time to now, should be used after a check directly |
|
553 |
</summary> |
|
554 |
</member> |
|
555 |
<member name="M:NetSparkleUpdater.Configurations.RegistryConfiguration.SetVersionToSkip(System.String)"> |
|
556 |
<summary> |
|
557 |
This method allows to skip a specific version |
|
558 |
</summary> |
|
559 |
<param name="version">the version to skeip</param> |
|
560 |
</member> |
|
561 |
<member name="M:NetSparkleUpdater.Configurations.RegistryConfiguration.Reload"> |
|
562 |
<summary> |
|
563 |
Reloads the configuration object |
|
564 |
</summary> |
|
565 |
</member> |
|
566 |
<member name="M:NetSparkleUpdater.Configurations.RegistryConfiguration.BuildRegistryPath"> |
|
567 |
<summary> |
|
568 |
This function build a valid registry path in dependecy to the |
|
569 |
assembly information |
|
570 |
</summary> |
|
571 |
</member> |
|
572 |
<member name="M:NetSparkleUpdater.Configurations.RegistryConfiguration.LoadValuesFromPath(System.String)"> |
|
573 |
<summary> |
|
574 |
This method loads the values from registry |
|
575 |
</summary> |
|
576 |
<param name="regPath">the registry path</param> |
|
577 |
<returns><c>true</c> if the items were loaded</returns> |
|
578 |
</member> |
|
579 |
<member name="M:NetSparkleUpdater.Configurations.RegistryConfiguration.SaveValuesToPath(System.String)"> |
|
580 |
<summary> |
|
581 |
This method store the information into registry |
|
582 |
</summary> |
|
583 |
<param name="regPath">the registry path</param> |
|
584 |
<returns><c>true</c> if the values were saved to the registry</returns> |
|
585 |
</member> |
|
586 |
<member name="T:NetSparkleUpdater.Configurations.SavedConfigurationData"> |
|
587 |
<summary> |
|
588 |
Configuration data for this software and NetSparkle instance. |
|
589 |
Allows you to get information on the versions that the user |
|
590 |
skipped, when the last update was performed, etc. |
|
591 |
</summary> |
|
592 |
</member> |
|
593 |
<member name="P:NetSparkleUpdater.Configurations.SavedConfigurationData.CheckForUpdate"> |
|
594 |
<summary> |
|
595 |
Whether or not to check for an update |
|
596 |
</summary> |
|
597 |
</member> |
|
598 |
<member name="P:NetSparkleUpdater.Configurations.SavedConfigurationData.LastCheckTime"> |
|
599 |
<summary> |
|
600 |
The last DateTime that an update check was performed |
|
601 |
</summary> |
|
602 |
</member> |
|
603 |
<member name="P:NetSparkleUpdater.Configurations.SavedConfigurationData.PreviousVersionOfSoftwareRan"> |
|
604 |
<summary> |
|
605 |
The previous version of the software that the user ran |
|
606 |
</summary> |
|
607 |
</member> |
|
608 |
<member name="P:NetSparkleUpdater.Configurations.SavedConfigurationData.LastVersionSkipped"> |
|
609 |
<summary> |
|
610 |
The last version (as a string) that the user chose |
|
611 |
to skip. |
|
612 |
Can be blank. |
|
613 |
</summary> |
|
614 |
</member> |
|
615 |
<member name="P:NetSparkleUpdater.Configurations.SavedConfigurationData.DidRunOnce"> |
|
616 |
<summary> |
|
617 |
Whether or not the software has run at least one time. |
|
618 |
</summary> |
|
619 |
</member> |
|
620 |
<member name="P:NetSparkleUpdater.Configurations.SavedConfigurationData.LastConfigUpdate"> |
|
621 |
<summary> |
|
622 |
Last DateTime that the configuration data was updated. |
|
623 |
</summary> |
|
624 |
</member> |
|
625 |
<member name="T:NetSparkleUpdater.Downloaders.WebClientFileDownloader"> |
|
626 |
<summary> |
|
627 |
Class that downloads files from the internet and reports |
|
628 |
progress on those files being downloaded. Uses a WebClient |
|
629 |
object as its main method for downloading. |
|
630 |
</summary> |
|
631 |
</member> |
|
632 |
<member name="M:NetSparkleUpdater.Downloaders.WebClientFileDownloader.#ctor"> |
|
633 |
<summary> |
|
634 |
Default constructor for the web client file downloader. |
|
635 |
Uses default credentials and default proxy. |
|
636 |
</summary> |
|
637 |
</member> |
|
638 |
<member name="P:NetSparkleUpdater.Downloaders.WebClientFileDownloader.IsDownloading"> |
|
639 |
<inheritdoc/> |
|
640 |
</member> |
|
641 |
<member name="E:NetSparkleUpdater.Downloaders.WebClientFileDownloader.DownloadProgressChanged"> |
|
642 |
<inheritdoc/> |
|
643 |
</member> |
|
644 |
<member name="E:NetSparkleUpdater.Downloaders.WebClientFileDownloader.DownloadFileCompleted"> |
|
645 |
<inheritdoc/> |
|
646 |
</member> |
|
647 |
<member name="M:NetSparkleUpdater.Downloaders.WebClientFileDownloader.Dispose"> |
|
648 |
<inheritdoc/> |
|
649 |
</member> |
|
650 |
<member name="M:NetSparkleUpdater.Downloaders.WebClientFileDownloader.StartFileDownload(System.Uri,System.String)"> |
|
651 |
<inheritdoc/> |
|
652 |
</member> |
|
653 |
<member name="M:NetSparkleUpdater.Downloaders.WebClientFileDownloader.CancelDownload"> |
|
654 |
<inheritdoc/> |
|
655 |
</member> |
|
656 |
<member name="M:NetSparkleUpdater.Downloaders.WebClientFileDownloader.RetrieveDestinationFileNameAsync(NetSparkleUpdater.AppCastItem)"> |
|
657 |
<inheritdoc/> |
|
658 |
</member> |
|
659 |
<member name="T:NetSparkleUpdater.Downloaders.WebRequestAppCastDataDownloader"> |
|
660 |
<summary> |
|
661 |
Class that takes care of downloading data for an app cast. Allows |
|
662 |
you to send extra JSON with your request for the app cast information. |
|
663 |
</summary> |
|
664 |
</member> |
|
665 |
<member name="M:NetSparkleUpdater.Downloaders.WebRequestAppCastDataDownloader.#ctor"> |
|
666 |
<summary> |
|
667 |
Default constructor for the app cast data downloader. Basically |
|
668 |
does nothing. :) |
|
669 |
</summary> |
|
670 |
</member> |
|
671 |
<member name="P:NetSparkleUpdater.Downloaders.WebRequestAppCastDataDownloader.TrustEverySSLConnection"> |
|
672 |
<summary> |
|
673 |
If true, don't check the validity of SSL certificates |
|
674 |
</summary> |
|
675 |
</member> |
|
676 |
<member name="P:NetSparkleUpdater.Downloaders.WebRequestAppCastDataDownloader.ExtraJsonData"> |
|
677 |
<summary> |
|
678 |
If not "", sends extra JSON via POST to server with the web request for update information and for the DSA signature. |
|
679 |
</summary> |
|
680 |
</member> |
|
681 |
<member name="M:NetSparkleUpdater.Downloaders.WebRequestAppCastDataDownloader.DownloadAndGetAppCastData(System.String)"> |
|
682 |
<inheritdoc/> |
|
683 |
</member> |
|
684 |
<member name="M:NetSparkleUpdater.Downloaders.WebRequestAppCastDataDownloader.GetAppCastEncoding"> |
|
685 |
<inheritdoc/> |
|
686 |
</member> |
|
687 |
<member name="M:NetSparkleUpdater.Downloaders.WebRequestAppCastDataDownloader.GetWebContentResponse(System.String)"> |
|
688 |
<summary> |
|
689 |
Download the app cast from the given URL. |
|
690 |
Performs a GET request by default. If ExtraJsonData is set, |
|
691 |
uses a POST request and sends the JSON data along with the |
|
692 |
request. |
|
693 |
</summary> |
|
694 |
<param name="url">the URL to download the app cast from</param> |
|
695 |
<returns>the response from the web server if creating the request |
|
696 |
succeeded; null otherwise. The response is not guaranteed to have |
|
697 |
succeeded!</returns> |
|
698 |
</member> |
|
699 |
<member name="M:NetSparkleUpdater.Downloaders.WebRequestAppCastDataDownloader.ValidateRemoteCertificate(System.Object,System.Security.Cryptography.X509Certificates.X509Certificate,System.Security.Cryptography.X509Certificates.X509Chain,System.Net.Security.SslPolicyErrors)"> |
|
700 |
<summary> |
|
701 |
Determine if the remote X509 certificate is valid |
|
702 |
</summary> |
|
703 |
<param name="sender">the web request</param> |
|
704 |
<param name="certificate">the certificate</param> |
|
705 |
<param name="chain">the chain</param> |
|
706 |
<param name="sslPolicyErrors">how to handle policy errors</param> |
|
707 |
<returns><c>true</c> if the cert is valid</returns> |
|
708 |
</member> |
|
709 |
<member name="T:NetSparkleUpdater.Enums.NextUpdateAction"> |
|
710 |
<summary> |
|
711 |
Everytime when NetSparkleUpdater detects an update, the |
|
712 |
consumer can decide what should happen next with the help |
|
713 |
of the <see cref="T:NetSparkleUpdater.UpdateDetected"/> event |
|
714 |
</summary> |
|
715 |
</member> |
|
716 |
<member name="F:NetSparkleUpdater.Enums.NextUpdateAction.ShowStandardUserInterface"> |
|
717 |
<summary> |
|
718 |
Show the user interface |
|
719 |
</summary> |
|
720 |
</member> |
|
721 |
<member name="F:NetSparkleUpdater.Enums.NextUpdateAction.PerformUpdateUnattended"> |
|
722 |
<summary> |
|
723 |
Perform an unattended install |
|
724 |
</summary> |
|
725 |
</member> |
|
726 |
<member name="F:NetSparkleUpdater.Enums.NextUpdateAction.ProhibitUpdate"> |
|
727 |
<summary> |
|
728 |
Prohibit the update |
|
729 |
</summary> |
|
730 |
</member> |
|
731 |
<member name="T:NetSparkleUpdater.Enums.SecurityMode"> |
|
732 |
<summary> |
|
733 |
Controls the situations where files have to be signed with the private key. |
|
734 |
If both a public key and a signature are present, they always have to be valid. |
|
735 |
|
|
736 |
We recommend using SecurityMode.Strict if at all possible. |
|
737 |
|
|
738 |
Note that <see cref="T:NetSparkleUpdater.ReleaseNotesGrabber"/> needs to have |
|
739 |
<see cref="P:NetSparkleUpdater.ReleaseNotesGrabber.ChecksReleaseNotesSignature"/> set to true in order |
|
740 |
to verify signatures. |
|
741 |
</summary> |
|
742 |
</member> |
|
743 |
<member name="F:NetSparkleUpdater.Enums.SecurityMode.Unsafe"> |
|
744 |
<summary> |
|
745 |
All files (with or without signature) will be accepted. |
|
746 |
This mode is strongly NOT recommended. It can cause critical security issues. |
|
747 |
</summary> |
|
748 |
</member> |
|
749 |
<member name="F:NetSparkleUpdater.Enums.SecurityMode.UseIfPossible"> |
|
750 |
<summary> |
|
751 |
If there is a public key, the app cast and download file have to be signed. |
|
752 |
If there isn't a public key, files without a signature will also be accepted. |
|
753 |
This mode is a mix between Unsafe and Strict and can have some security issues if the |
|
754 |
public key gets lost in the application. |
|
755 |
</summary> |
|
756 |
</member> |
|
757 |
<member name="F:NetSparkleUpdater.Enums.SecurityMode.Strict"> |
|
758 |
<summary> |
|
759 |
The app cast and download file have to be signed. This means the public key must exist. This is the default mode. |
|
760 |
</summary> |
|
761 |
</member> |
|
762 |
<member name="F:NetSparkleUpdater.Enums.SecurityMode.OnlyVerifySoftwareDownloads"> |
|
763 |
<summary> |
|
764 |
Only verify the signature of software downloads (via an ISignatureVerifier). |
|
765 |
Do not verify the signature of anything else: app casts, release notes, etc. |
|
766 |
</summary> |
|
767 |
</member> |
|
768 |
<member name="T:NetSparkleUpdater.Enums.UpdateAvailableResult"> |
|
769 |
<summary> |
|
770 |
Possible Result values for IUpdateAvailable implementation. |
|
771 |
</summary> |
|
772 |
</member> |
|
773 |
<member name="F:NetSparkleUpdater.Enums.UpdateAvailableResult.None"> |
|
774 |
<summary> |
|
775 |
No result specified. Default value. |
|
776 |
</summary> |
|
777 |
</member> |
|
778 |
<member name="F:NetSparkleUpdater.Enums.UpdateAvailableResult.InstallUpdate"> |
|
779 |
<summary> |
|
780 |
User chose to install the update immediately. |
|
781 |
</summary> |
|
782 |
</member> |
|
783 |
<member name="F:NetSparkleUpdater.Enums.UpdateAvailableResult.SkipUpdate"> |
|
784 |
<summary> |
|
785 |
User chose to skip the update. |
|
786 |
</summary> |
|
787 |
</member> |
|
788 |
<member name="F:NetSparkleUpdater.Enums.UpdateAvailableResult.RemindMeLater"> |
|
789 |
<summary> |
|
790 |
User chose to remind them later about this update. |
|
791 |
</summary> |
|
792 |
</member> |
|
793 |
<member name="T:NetSparkleUpdater.Enums.UpdateStatus"> |
|
794 |
<summary> |
|
795 |
Possibilities for the status of an update request |
|
796 |
</summary> |
|
797 |
</member> |
|
798 |
<member name="F:NetSparkleUpdater.Enums.UpdateStatus.UpdateAvailable"> |
|
799 |
<summary> |
|
800 |
An update is available |
|
801 |
</summary> |
|
802 |
</member> |
|
803 |
<member name="F:NetSparkleUpdater.Enums.UpdateStatus.UpdateNotAvailable"> |
|
804 |
<summary> |
|
805 |
No updates are available |
|
806 |
</summary> |
|
807 |
</member> |
|
808 |
<member name="F:NetSparkleUpdater.Enums.UpdateStatus.UserSkipped"> |
|
809 |
<summary> |
|
810 |
An update is available, but the user has chosen to skip this version |
|
811 |
</summary> |
|
812 |
</member> |
|
813 |
<member name="F:NetSparkleUpdater.Enums.UpdateStatus.CouldNotDetermine"> |
|
814 |
<summary> |
|
815 |
There was a problem fetching the appcast |
|
816 |
</summary> |
|
817 |
</member> |
|
818 |
<member name="T:NetSparkleUpdater.Enums.UserInteractionMode"> |
|
819 |
<summary> |
|
820 |
Allows for updating the application with or without user interaction. |
|
821 |
</summary> |
|
822 |
</member> |
|
823 |
<member name="F:NetSparkleUpdater.Enums.UserInteractionMode.NotSilent"> |
|
824 |
<summary> |
|
825 |
Shows the changelog UI automatically (this is the default) |
|
826 |
</summary> |
|
827 |
</member> |
|
828 |
<member name="F:NetSparkleUpdater.Enums.UserInteractionMode.DownloadNoInstall"> |
|
829 |
<summary> |
|
830 |
Downloads the latest update file and changelog automatically, but does not |
|
831 |
show any UI until asked to show UI. |
|
832 |
</summary> |
|
833 |
</member> |
|
834 |
<member name="F:NetSparkleUpdater.Enums.UserInteractionMode.DownloadAndInstall"> |
|
835 |
<summary> |
|
836 |
Downloads the latest update file and automatically runs it as an installer file. |
|
837 |
<para>WARNING: if you don't tell the user that the application is about to quit |
|
838 |
to update/run an installer, this setting might be quite the shock to the user! |
|
839 |
Make sure to implement AboutToExitForInstallerRun or AboutToExitForInstallerRunAsync |
|
840 |
so that you can show your users what is about to happen.</para> |
|
841 |
</summary> |
|
842 |
</member> |
|
843 |
<member name="T:NetSparkleUpdater.Enums.ValidationResult"> |
|
844 |
<summary> |
|
845 |
Return value of the DSA verification check functions. |
|
846 |
</summary> |
|
847 |
</member> |
|
848 |
<member name="F:NetSparkleUpdater.Enums.ValidationResult.Valid"> |
|
849 |
<summary> |
|
850 |
The DSA public key and signature exists and they are valid. |
|
851 |
</summary> |
|
852 |
</member> |
|
853 |
<member name="F:NetSparkleUpdater.Enums.ValidationResult.Invalid"> |
|
854 |
<summary> |
|
855 |
Depending on the SecurityMode at least one of DSA public key or the signature dosn't exist or |
|
856 |
they exists but they are not valid. In this case the file will be rejected. |
|
857 |
</summary> |
|
858 |
</member> |
|
859 |
<member name="F:NetSparkleUpdater.Enums.ValidationResult.Unchecked"> |
|
860 |
<summary> |
|
861 |
There wasn't any DSA public key or signature and SecurityMode said this is okay. |
|
862 |
</summary> |
|
863 |
</member> |
|
864 |
<member name="T:NetSparkleUpdater.Events.DownloadInstallEventHandler"> |
|
865 |
<summary> |
|
866 |
Event called when the download/install window closes |
|
867 |
</summary> |
|
868 |
<param name="sender">Sender of this event</param> |
|
869 |
<param name="args">DownloadInstallArgs with info on whether to install or not</param> |
|
870 |
</member> |
|
871 |
<member name="T:NetSparkleUpdater.Events.DownloadInstallEventArgs"> |
|
872 |
<summary> |
|
873 |
Args sent via the DownloadInstallEventHandler when the download/install window closes |
|
874 |
</summary> |
|
875 |
</member> |
|
876 |
<member name="P:NetSparkleUpdater.Events.DownloadInstallEventArgs.ShouldInstall"> |
|
877 |
<summary> |
|
878 |
Whether or not the listener should perform the installation process |
|
879 |
</summary> |
|
880 |
</member> |
|
881 |
<member name="P:NetSparkleUpdater.Events.DownloadInstallEventArgs.WasHandled"> |
|
882 |
<summary> |
|
883 |
True if the download/install event was already handled; false otherwise |
|
884 |
</summary> |
|
885 |
</member> |
|
886 |
<member name="M:NetSparkleUpdater.Events.DownloadInstallEventArgs.#ctor(System.Boolean)"> |
|
887 |
<summary> |
|
888 |
Constructor for DownloadInstallArgs |
|
889 |
</summary> |
|
890 |
<param name="shouldInstall">True if the listener should start the download process; false otherwise</param> |
|
891 |
</member> |
|
892 |
<member name="T:NetSparkleUpdater.Events.ItemDownloadProgressEventArgs"> |
|
893 |
<summary> |
|
894 |
Provides data for a progress event for downloading an AppCastItem from a |
|
895 |
web server. |
|
896 |
</summary> |
|
897 |
</member> |
|
898 |
<member name="M:NetSparkleUpdater.Events.ItemDownloadProgressEventArgs.#ctor(System.Int32,System.Object)"> |
|
899 |
<summary> |
|
900 |
Create an <see cref="T:NetSparkleUpdater.Events.ItemDownloadProgressEventArgs"/> object based on |
|
901 |
the total percentage (0-100, inclusive) and the custom user state. |
|
902 |
</summary> |
|
903 |
<param name="progressPercentage">the total download progress as an int (between 0-100)</param> |
|
904 |
<param name="userState">the custom user state sent along with the download progress</param> |
|
905 |
</member> |
|
906 |
<member name="M:NetSparkleUpdater.Events.ItemDownloadProgressEventArgs.#ctor(System.Int32,System.Object,System.Int64,System.Int64)"> |
|
907 |
<summary> |
|
908 |
Create an <see cref="T:NetSparkleUpdater.Events.ItemDownloadProgressEventArgs"/> object based on |
|
909 |
the total percentage (0-100, inclusive), the custom user state, the |
|
910 |
number of bytes received, and the number of total bytes that need to |
|
911 |
be downloaded. |
|
912 |
</summary> |
|
913 |
<param name="progressPercentage">the total download progress as an int (between 0-100)</param> |
|
914 |
<param name="userState">the custom user state sent along with the download progress</param> |
|
915 |
<param name="bytesReceived">the number of bytes received by the downloader</param> |
|
916 |
<param name="totalBytesToReceive">the total number of bytes that need to be downloadeds</param> |
|
917 |
</member> |
|
918 |
<member name="P:NetSparkleUpdater.Events.ItemDownloadProgressEventArgs.BytesReceived"> |
|
919 |
<summary> |
|
920 |
The number of bytes received by the downloader |
|
921 |
</summary> |
|
922 |
</member> |
|
923 |
<member name="P:NetSparkleUpdater.Events.ItemDownloadProgressEventArgs.TotalBytesToReceive"> |
|
924 |
<summary> |
|
925 |
The total number of bytes that need to be downloaded |
|
926 |
</summary> |
|
927 |
</member> |
|
928 |
<member name="T:NetSparkleUpdater.Events.UpdateDetectedEventArgs"> |
|
929 |
<summary> |
|
930 |
Contains all information for the update detected event |
|
931 |
</summary> |
|
932 |
</member> |
|
933 |
<member name="P:NetSparkleUpdater.Events.UpdateDetectedEventArgs.NextAction"> |
|
934 |
<summary> |
|
935 |
The next action |
|
936 |
</summary> |
|
937 |
</member> |
|
938 |
<member name="P:NetSparkleUpdater.Events.UpdateDetectedEventArgs.ApplicationConfig"> |
|
939 |
<summary> |
|
940 |
The application configuration |
|
941 |
</summary> |
|
942 |
</member> |
|
943 |
<member name="P:NetSparkleUpdater.Events.UpdateDetectedEventArgs.LatestVersion"> |
|
944 |
<summary> |
|
945 |
The latest available version |
|
946 |
</summary> |
|
947 |
</member> |
|
948 |
<member name="P:NetSparkleUpdater.Events.UpdateDetectedEventArgs.AppCastItems"> |
|
949 |
<summary> |
|
950 |
All app cast items that were sent in the appcast |
|
951 |
</summary> |
|
952 |
</member> |
|
953 |
<member name="T:NetSparkleUpdater.Events.UpdateResponseEventArgs"> |
|
954 |
<summary> |
|
955 |
Event arguments for when a user responds to an available update UI |
|
956 |
</summary> |
|
957 |
</member> |
|
958 |
<member name="P:NetSparkleUpdater.Events.UpdateResponseEventArgs.Result"> |
|
959 |
<summary> |
|
960 |
The user's response to the update |
|
961 |
</summary> |
|
962 |
</member> |
|
963 |
<member name="P:NetSparkleUpdater.Events.UpdateResponseEventArgs.UpdateItem"> |
|
964 |
<summary> |
|
965 |
The AppCastItem that the user is responding to an update notice for |
|
966 |
</summary> |
|
967 |
</member> |
|
968 |
<member name="M:NetSparkleUpdater.Events.UpdateResponseEventArgs.#ctor(NetSparkleUpdater.Enums.UpdateAvailableResult,NetSparkleUpdater.AppCastItem)"> |
|
969 |
<summary> |
|
970 |
Constructor for UpdateResponseArgs that allows for easy setting |
|
971 |
of the result |
|
972 |
</summary> |
|
973 |
<param name="result">User's response of type UpdateAvailableResult</param> |
|
974 |
<param name="item">Item that the user is responding to an update message for</param> |
|
975 |
</member> |
|
976 |
<member name="T:NetSparkleUpdater.Interfaces.IAppCastDataDownloader"> |
|
977 |
<summary> |
|
978 |
Interface used by objects that can download app casts from the internet. |
|
979 |
Use this interface to provide a custom method of grabbing your app cast |
|
980 |
from the internet or from a local file. |
|
981 |
</summary> |
|
982 |
</member> |
|
983 |
<member name="M:NetSparkleUpdater.Interfaces.IAppCastDataDownloader.DownloadAndGetAppCastData(System.String)"> |
|
984 |
<summary> |
|
985 |
Used for both downloading app cast and the app cast's .dsa file. |
|
986 |
Note that you must handle your own exceptions if they occur. Otherwise, SparkleUpdater |
|
987 |
will act as though the appcast failed to download. |
|
988 |
</summary> |
|
989 |
<param name="url"></param> |
|
990 |
<returns></returns> |
|
991 |
</member> |
|
992 |
<member name="M:NetSparkleUpdater.Interfaces.IAppCastDataDownloader.GetAppCastEncoding"> |
|
993 |
<summary> |
|
994 |
Get the string encoding (e.g. UTF8 or ASCII) of the |
|
995 |
app cast file so that it can be converted to bytes. |
|
996 |
(WebRequestAppCastDataDownloader defaults to UTF8.) |
|
997 |
</summary> |
|
998 |
<returns></returns> |
|
999 |
</member> |
|
1000 |
<member name="T:NetSparkleUpdater.Interfaces.IAppCastHandler"> |
|
1001 |
<summary> |
|
1002 |
Interface used by objects that initiate a download process |
|
1003 |
for an app cast, perform any needed signature verification on |
|
1004 |
the app cast, and parse the app cast's items into a list of |
|
1005 |
<see cref="T:NetSparkleUpdater.AppCastItem"/>. |
|
1006 |
Implement this interface if you would like to use a custom parsing |
|
1007 |
method for your app cast that isn't yet built into NetSparkle. |
|
1008 |
</summary> |
|
1009 |
</member> |
|
1010 |
<member name="M:NetSparkleUpdater.Interfaces.IAppCastHandler.SetupAppCastHandler(NetSparkleUpdater.Interfaces.IAppCastDataDownloader,System.String,NetSparkleUpdater.Configurations.Configuration,NetSparkleUpdater.Interfaces.ISignatureVerifier,NetSparkleUpdater.Interfaces.ILogger)"> |
|
1011 |
<summary> |
|
1012 |
Setup the app cast handler info for downloading and parsing app cast information |
|
1013 |
</summary> |
|
1014 |
<param name="dataDownloader">downloader that will manage the app cast download |
|
1015 |
(provided by <see cref="T:NetSparkleUpdater.SparkleUpdater"/> via the |
|
1016 |
<see cref="P:NetSparkleUpdater.SparkleUpdater.AppCastDataDownloader"/> property.</param> |
|
1017 |
<param name="castUrl">full URL to the app cast file</param> |
|
1018 |
<param name="config">configuration for handling update intervals/checks |
|
1019 |
(user skipped versions, etc.)</param> |
|
1020 |
<param name="signatureVerifier">Object to check signatures of app cast information</param> |
|
1021 |
<param name="logWriter">object that you can utilize to do any necessary logging</param> |
|
1022 |
</member> |
|
1023 |
<member name="M:NetSparkleUpdater.Interfaces.IAppCastHandler.DownloadAndParse"> |
|
1024 |
<summary> |
|
1025 |
Download the app cast file via the <see cref="T:NetSparkleUpdater.Interfaces.IAppCastDataDownloader"/> |
|
1026 |
object and parse the downloaded information. |
|
1027 |
If this function is successful, <see cref="T:NetSparkleUpdater.SparkleUpdater"/> will call <see cref="M:NetSparkleUpdater.Interfaces.IAppCastHandler.GetAvailableUpdates"/> |
|
1028 |
to get the <see cref="T:NetSparkleUpdater.AppCastItem"/> information. |
|
1029 |
Note that you must handle your own exceptions if they occur. Otherwise, <see cref="T:NetSparkleUpdater.SparkleUpdater"/> |
|
1030 |
will act as though the appc ast failed to download. |
|
1031 |
</summary> |
|
1032 |
<returns>true if downloading and parsing succeeded; false otherwise</returns> |
|
1033 |
</member> |
|
1034 |
<member name="M:NetSparkleUpdater.Interfaces.IAppCastHandler.GetAvailableUpdates"> |
|
1035 |
<summary> |
|
1036 |
Retrieve the available updates from the app cast. |
|
1037 |
This should be called after <see cref="M:NetSparkleUpdater.Interfaces.IAppCastHandler.DownloadAndParse"/> has |
|
1038 |
successfully completed. |
|
1039 |
</summary> |
|
1040 |
<returns>a list of <see cref="T:NetSparkleUpdater.AppCastItem"/> updates. Can be empty if no updates are available.</returns> |
|
1041 |
</member> |
|
1042 |
<member name="T:NetSparkleUpdater.Interfaces.IAssemblyAccessor"> |
|
1043 |
<summary> |
|
1044 |
An assembly accessor grabs details on the current version |
|
1045 |
and publisher information for a C# application (presumably |
|
1046 |
the one that is currently running). This is intended to be |
|
1047 |
used in conjunction with a Configuration subclass in order |
|
1048 |
to retrieve and store info on the latest version of the app |
|
1049 |
that was used, whether the app has run 1x or not, etc. |
|
1050 |
These fields may or may not be required based on the specific |
|
1051 |
Configuration that you use. At the very least, make sure |
|
1052 |
your IAssemblyAccessor can grab valid info for the title of the |
|
1053 |
application, the product name (which may or may not be the same |
|
1054 |
as the title), and the version of the application (e.g. 3.1.2.0). |
|
1055 |
</summary> |
|
1056 |
</member> |
|
1057 |
<member name="P:NetSparkleUpdater.Interfaces.IAssemblyAccessor.AssemblyCompany"> |
|
1058 |
<summary> |
|
1059 |
The publisher of the application. Might be "". |
|
1060 |
</summary> |
|
1061 |
</member> |
|
1062 |
<member name="P:NetSparkleUpdater.Interfaces.IAssemblyAccessor.AssemblyCopyright"> |
|
1063 |
<summary> |
|
1064 |
The copyright for the application (e.g. ?2020) |
|
1065 |
</summary> |
|
1066 |
</member> |
|
1067 |
<member name="P:NetSparkleUpdater.Interfaces.IAssemblyAccessor.AssemblyDescription"> |
|
1068 |
<summary> |
|
1069 |
Description of the assembly. |
|
1070 |
</summary> |
|
1071 |
</member> |
|
1072 |
<member name="P:NetSparkleUpdater.Interfaces.IAssemblyAccessor.AssemblyTitle"> |
|
1073 |
<summary> |
|
1074 |
Title of the assembly, e.g. "My Best Product" |
|
1075 |
</summary> |
|
1076 |
</member> |
|
1077 |
<member name="P:NetSparkleUpdater.Interfaces.IAssemblyAccessor.AssemblyProduct"> |
|
1078 |
<summary> |
|
1079 |
Product for the assembly. Might be the same as |
|
1080 |
the title, but also could be more specific than the |
|
1081 |
title. |
|
1082 |
</summary> |
|
1083 |
</member> |
|
1084 |
<member name="P:NetSparkleUpdater.Interfaces.IAssemblyAccessor.AssemblyVersion"> |
|
1085 |
<summary> |
|
1086 |
Version of the item that's running. E.g. 3.1.2.1. |
|
1087 |
</summary> |
|
1088 |
</member> |
|
1089 |
<member name="T:NetSparkleUpdater.Interfaces.ICheckingForUpdates"> |
|
1090 |
<summary> |
|
1091 |
Interface for UIs that tell the user that NetSparkle is checking for updates |
|
1092 |
</summary> |
|
1093 |
</member> |
|
1094 |
<member name="E:NetSparkleUpdater.Interfaces.ICheckingForUpdates.UpdatesUIClosing"> |
|
1095 |
<summary> |
|
1096 |
Event to fire when the checking for updates UI is closing |
|
1097 |
</summary> |
|
1098 |
</member> |
|
1099 |
<member name="M:NetSparkleUpdater.Interfaces.ICheckingForUpdates.Show"> |
|
1100 |
<summary> |
|
1101 |
Show the UI |
|
1102 |
</summary> |
|
1103 |
</member> |
|
1104 |
<member name="M:NetSparkleUpdater.Interfaces.ICheckingForUpdates.Close"> |
|
1105 |
<summary> |
|
1106 |
Close the form |
|
1107 |
</summary> |
|
1108 |
</member> |
|
1109 |
<member name="T:NetSparkleUpdater.Interfaces.IDownloadProgress"> |
|
1110 |
<summary> |
|
1111 |
Interface for UI element that shows the progress bar |
|
1112 |
and a method to install and relaunch the appliction |
|
1113 |
</summary> |
|
1114 |
</member> |
|
1115 |
<member name="E:NetSparkleUpdater.Interfaces.IDownloadProgress.DownloadProcessCompleted"> |
|
1116 |
<summary> |
|
1117 |
Event to fire when the download UI is complete; tells you |
|
1118 |
if the install process should happen or not |
|
1119 |
</summary> |
|
1120 |
</member> |
|
1121 |
<member name="M:NetSparkleUpdater.Interfaces.IDownloadProgress.SetDownloadAndInstallButtonEnabled(System.Boolean)"> |
|
1122 |
<summary> |
|
1123 |
Enable or disable the download and install button (such as when your "Can I gracefully close the window?" function is async and you don't |
|
1124 |
want your user to click the button multiple times) |
|
1125 |
</summary> |
|
1126 |
<param name="shouldBeEnabled">True if the button should be enabled; false otherwise</param> |
|
1127 |
</member> |
|
1128 |
<member name="M:NetSparkleUpdater.Interfaces.IDownloadProgress.Show(System.Boolean)"> |
|
1129 |
<summary> |
|
1130 |
Show the UI for download progress |
|
1131 |
</summary> |
|
1132 |
<returns>True if download was successful; false otherwise</returns> |
|
1133 |
</member> |
|
1134 |
<member name="M:NetSparkleUpdater.Interfaces.IDownloadProgress.OnDownloadProgressChanged(System.Object,NetSparkleUpdater.Events.ItemDownloadProgressEventArgs)"> |
|
1135 |
<summary> |
|
1136 |
Called when the download progress changes |
|
1137 |
</summary> |
|
1138 |
<param name="sender">sender of the progress update</param> |
|
1139 |
<param name="args">used to deliver info on download progress (e.g. |
|
1140 |
total bytes downloaded)</param> |
|
1141 |
</member> |
|
1142 |
<member name="M:NetSparkleUpdater.Interfaces.IDownloadProgress.Close"> |
|
1143 |
<summary> |
|
1144 |
Close the download progress UI |
|
1145 |
</summary> |
|
1146 |
</member> |
|
1147 |
<member name="M:NetSparkleUpdater.Interfaces.IDownloadProgress.FinishedDownloadingFile(System.Boolean)"> |
|
1148 |
<summary> |
|
1149 |
Update UI to show file is downloaded and signature check result |
|
1150 |
</summary> |
|
1151 |
</member> |
|
1152 |
<member name="M:NetSparkleUpdater.Interfaces.IDownloadProgress.DisplayErrorMessage(System.String)"> |
|
1153 |
<summary> |
|
1154 |
Show an error message in the download progress window if possible. |
|
1155 |
</summary> |
|
1156 |
<param name="errorMessage">Error message to display</param> |
|
1157 |
<returns>True if message displayed; false otherwise</returns> |
|
1158 |
</member> |
|
1159 |
<member name="T:NetSparkleUpdater.Interfaces.ILogger"> |
|
1160 |
<summary> |
|
1161 |
Interface for objects that can handle log information output |
|
1162 |
(e.g. to a console or a file or something else) |
|
1163 |
</summary> |
|
1164 |
</member> |
|
1165 |
<member name="M:NetSparkleUpdater.Interfaces.ILogger.PrintMessage(System.String,System.Object[])"> |
|
1166 |
<summary> |
|
1167 |
Print a message to the log output. |
|
1168 |
</summary> |
|
1169 |
<param name="message">Message to print</param> |
|
1170 |
<param name="arguments">Arguments to print (e.g. if using {0} format arguments)</param> |
|
1171 |
</member> |
|
1172 |
<member name="T:NetSparkleUpdater.Interfaces.ISignatureVerifier"> |
|
1173 |
<summary> |
|
1174 |
Interface for objects that can verify a signature for an app cast, a |
|
1175 |
downloaded file, or some other item. This is used to verify that the |
|
1176 |
correct data was downloaded from the internet and there wasn't any |
|
1177 |
nefarious play or manipulation of items when something was delivered |
|
1178 |
to the end user. |
|
1179 |
</summary> |
|
1180 |
</member> |
|
1181 |
<member name="P:NetSparkleUpdater.Interfaces.ISignatureVerifier.SecurityMode"> |
|
1182 |
<summary> |
|
1183 |
The <see cref="P:NetSparkleUpdater.Interfaces.ISignatureVerifier.SecurityMode"/> for the signature verifier. This determines |
|
1184 |
the level of security for the application and the items that it downloads |
|
1185 |
from the internet. |
|
1186 |
</summary> |
|
1187 |
</member> |
|
1188 |
<member name="M:NetSparkleUpdater.Interfaces.ISignatureVerifier.HasValidKeyInformation"> |
|
1189 |
<summary> |
|
1190 |
Check to see if we have valid public (or other) key information so |
|
1191 |
that we can verify signatures properly. |
|
1192 |
</summary> |
|
1193 |
<returns>true if this object has valid public/other key information |
|
1194 |
and can safely verify the signature of a given item; false otherwise</returns> |
|
1195 |
</member> |
|
1196 |
<member name="M:NetSparkleUpdater.Interfaces.ISignatureVerifier.VerifySignature(System.String,System.Byte[])"> |
|
1197 |
<summary> |
|
1198 |
Verify that the given data has the same signature as the passed-in signature |
|
1199 |
</summary> |
|
1200 |
<param name="signature">the base 64 signature to validate against dataToVerify's signature</param> |
|
1201 |
<param name="dataToVerify">the data that should be used to obtain a signature and |
|
1202 |
checked against the passed-in signature</param> |
|
1203 |
<returns>the <see cref="T:NetSparkleUpdater.Enums.ValidationResult"/> result of the verification process</returns> |
|
1204 |
</member> |
|
1205 |
<member name="M:NetSparkleUpdater.Interfaces.ISignatureVerifier.VerifySignatureOfFile(System.String,System.String)"> |
|
1206 |
<summary> |
|
1207 |
Verify that the file at the given path has the same signature as the passed-in |
|
1208 |
signature |
|
1209 |
</summary> |
|
1210 |
<param name="signature">the base 64 signature to validate against the signature of |
|
1211 |
the file at binaryPath</param> |
|
1212 |
<param name="binaryPath">the file path to the file whose signature you want to verify</param> |
|
1213 |
<returns>the <see cref="T:NetSparkleUpdater.Enums.ValidationResult"/> result of the verification process</returns> |
|
1214 |
</member> |
|
1215 |
<member name="M:NetSparkleUpdater.Interfaces.ISignatureVerifier.VerifySignatureOfString(System.String,System.String)"> |
|
1216 |
<summary> |
|
1217 |
Verify that the file at the given path has the same signature as the passed-in |
|
1218 |
string |
|
1219 |
</summary> |
|
1220 |
<param name="signature">the base 64 signature to validate against the signature |
|
1221 |
of the passed-in string</param> |
|
1222 |
<param name="data">the string whose signature you want to verify</param> |
|
1223 |
<returns>the <see cref="T:NetSparkleUpdater.Enums.ValidationResult"/> result of the verification process</returns> |
|
1224 |
</member> |
|
1225 |
<member name="T:NetSparkleUpdater.Interfaces.IUIFactory"> |
|
1226 |
<summary> |
|
1227 |
Universal interface for creating UI utilized by SparkleUpdater |
|
1228 |
</summary> |
|
1229 |
</member> |
|
1230 |
<member name="M:NetSparkleUpdater.Interfaces.IUIFactory.CreateUpdateAvailableWindow(NetSparkleUpdater.SparkleUpdater,System.Collections.Generic.List{NetSparkleUpdater.AppCastItem},System.Boolean)"> |
|
1231 |
<summary> |
|
1232 |
Create sparkle form implementation. This is the form that tells the user that an update is available, shows changelogs if necessary, etc. |
|
1233 |
</summary> |
|
1234 |
<param name="sparkle">The <see cref="T:NetSparkleUpdater.SparkleUpdater"/> instance to use</param> |
|
1235 |
<param name="updates">Sorted array of updates from latest to previous</param> |
|
1236 |
<param name="isUpdateAlreadyDownloaded">If true, make sure UI text shows that the user is about to install the file instead of download it.</param> |
|
1237 |
</member> |
|
1238 |
<member name="M:NetSparkleUpdater.Interfaces.IUIFactory.CreateProgressWindow(NetSparkleUpdater.AppCastItem)"> |
|
1239 |
<summary> |
|
1240 |
Create download progress window |
|
1241 |
</summary> |
|
1242 |
<param name="item">Appcast item to download</param> |
|
1243 |
</member> |
|
1244 |
<member name="M:NetSparkleUpdater.Interfaces.IUIFactory.ShowCheckingForUpdates"> |
|
1245 |
<summary> |
|
1246 |
Inform user in some way that NetSparkle is checking for updates |
|
1247 |
</summary> |
|
1248 |
</member> |
|
1249 |
<member name="M:NetSparkleUpdater.Interfaces.IUIFactory.Init"> |
|
1250 |
<summary> |
|
1251 |
Initialize UI. Called when Sparkle is constructed and/or when the UIFactory is set. |
|
1252 |
</summary> |
|
1253 |
</member> |
|
1254 |
<member name="M:NetSparkleUpdater.Interfaces.IUIFactory.ShowUnknownInstallerFormatMessage(System.String)"> |
|
1255 |
<summary> |
|
1256 |
Show user a message saying downloaded update format is unknown |
|
1257 |
</summary> |
|
1258 |
</member> |
|
1259 |
<member name="M:NetSparkleUpdater.Interfaces.IUIFactory.ShowVersionIsUpToDate"> |
|
1260 |
<summary> |
|
1261 |
Show user that current installed version is up-to-date |
|
1262 |
</summary> |
|
1263 |
</member> |
|
1264 |
<member name="M:NetSparkleUpdater.Interfaces.IUIFactory.ShowVersionIsSkippedByUserRequest"> |
|
1265 |
<summary> |
|
1266 |
Show message that latest update was skipped by user |
|
1267 |
</summary> |
|
1268 |
</member> |
|
1269 |
<member name="M:NetSparkleUpdater.Interfaces.IUIFactory.ShowCannotDownloadAppcast(System.String)"> |
|
1270 |
<summary> |
|
1271 |
Show message that appcast is not available |
|
1272 |
</summary> |
|
1273 |
</member> |
|
1274 |
<member name="M:NetSparkleUpdater.Interfaces.IUIFactory.CanShowToastMessages"> |
|
1275 |
<summary> |
|
1276 |
See if this UIFactory can show toast messages |
|
1277 |
</summary> |
|
1278 |
<returns>true if the UIFactory can show for toast messages; false otherwise</returns> |
|
1279 |
</member> |
|
1280 |
<member name="M:NetSparkleUpdater.Interfaces.IUIFactory.ShowToast(System.Collections.Generic.List{NetSparkleUpdater.AppCastItem},System.Action{System.Collections.Generic.List{NetSparkleUpdater.AppCastItem}})"> |
|
1281 |
<summary> |
|
1282 |
Show 'toast' window to notify new version is available |
|
1283 |
</summary> |
|
1284 |
<param name="updates">Appcast updates</param> |
|
1285 |
<param name="clickHandler">handler for click</param> |
|
1286 |
</member> |
|
1287 |
<member name="M:NetSparkleUpdater.Interfaces.IUIFactory.ShowDownloadErrorMessage(System.String,System.String)"> |
|
1288 |
<summary> |
|
1289 |
Show message on download error |
|
1290 |
</summary> |
|
1291 |
<param name="message">Error message from exception</param> |
|
1292 |
<param name="appcastUrl">the URL for the appcast file</param> |
|
1293 |
</member> |
|
1294 |
<member name="M:NetSparkleUpdater.Interfaces.IUIFactory.Shutdown"> |
|
1295 |
<summary> |
|
1296 |
Shut down the UI so we can run an update. |
|
1297 |
If in WPF, System.Windows.Application.Current.Shutdown(). |
|
1298 |
If in WinForms, Application.Exit(). |
|
1299 |
</summary> |
|
1300 |
</member> |
|
1301 |
<member name="P:NetSparkleUpdater.Interfaces.IUIFactory.HideReleaseNotes"> |
|
1302 |
<summary> |
|
1303 |
Hides the release notes view when an update is found. |
|
1304 |
</summary> |
|
1305 |
</member> |
|
1306 |
<member name="P:NetSparkleUpdater.Interfaces.IUIFactory.HideSkipButton"> |
|
1307 |
<summary> |
|
1308 |
Hides the skip this update button when an update is found. |
|
1309 |
</summary> |
|
1310 |
</member> |
|
1311 |
<member name="P:NetSparkleUpdater.Interfaces.IUIFactory.HideRemindMeLaterButton"> |
|
1312 |
<summary> |
|
1313 |
Hides the remind me later button when an update is found. |
|
1314 |
</summary> |
|
1315 |
</member> |
|
1316 |
<member name="T:NetSparkleUpdater.Interfaces.IUpdateAvailable"> |
|
1317 |
<summary> |
|
1318 |
Interface for UI element that shows the release notes, |
|
1319 |
and the skip, install, and later buttons |
|
1320 |
</summary> |
|
1321 |
</member> |
|
1322 |
<member name="E:NetSparkleUpdater.Interfaces.IUpdateAvailable.UserResponded"> |
|
1323 |
<summary> |
|
1324 |
Event fired when the user has responded to the |
|
1325 |
skip, later, install question. |
|
1326 |
</summary> |
|
1327 |
</member> |
|
1328 |
<member name="M:NetSparkleUpdater.Interfaces.IUpdateAvailable.Show(System.Boolean)"> |
|
1329 |
<summary> |
|
1330 |
Show the UI |
|
1331 |
</summary> |
|
1332 |
</member> |
|
1333 |
<member name="M:NetSparkleUpdater.Interfaces.IUpdateAvailable.HideReleaseNotes"> |
|
1334 |
<summary> |
|
1335 |
Hides the release notes |
|
1336 |
</summary> |
|
1337 |
</member> |
|
1338 |
<member name="M:NetSparkleUpdater.Interfaces.IUpdateAvailable.HideRemindMeLaterButton"> |
|
1339 |
<summary> |
|
1340 |
Hides the remind me later button |
|
1341 |
</summary> |
|
1342 |
</member> |
|
1343 |
<member name="M:NetSparkleUpdater.Interfaces.IUpdateAvailable.HideSkipButton"> |
|
1344 |
<summary> |
|
1345 |
Hides the skip update button |
|
1346 |
</summary> |
|
1347 |
</member> |
|
1348 |
<member name="P:NetSparkleUpdater.Interfaces.IUpdateAvailable.Result"> |
|
1349 |
<summary> |
|
1350 |
Gets the result for skip, later, or install |
|
1351 |
</summary> |
|
1352 |
</member> |
|
1353 |
<member name="P:NetSparkleUpdater.Interfaces.IUpdateAvailable.CurrentItem"> |
|
1354 |
<summary> |
|
1355 |
Gets or sets the current item being installed |
|
1356 |
</summary> |
|
1357 |
</member> |
|
1358 |
<member name="M:NetSparkleUpdater.Interfaces.IUpdateAvailable.BringToFront"> |
|
1359 |
<summary> |
|
1360 |
Brings the form to the front of all windows |
|
1361 |
</summary> |
|
1362 |
</member> |
|
1363 |
<member name="M:NetSparkleUpdater.Interfaces.IUpdateAvailable.Close"> |
|
1364 |
<summary> |
|
1365 |
Close the form |
|
1366 |
</summary> |
|
1367 |
</member> |
|
1368 |
<member name="T:NetSparkleUpdater.Interfaces.IUpdateDownloader"> |
|
1369 |
<summary> |
|
1370 |
Interface for objects that can download (or otherwise obtain) update files |
|
1371 |
for a given <see cref="T:NetSparkleUpdater.AppCastItem"/>. These objects should send back |
|
1372 |
progress updates and handle other excepctions or other event changes as necessary. |
|
1373 |
</summary> |
|
1374 |
</member> |
|
1375 |
<member name="P:NetSparkleUpdater.Interfaces.IUpdateDownloader.IsDownloading"> |
|
1376 |
<summary> |
|
1377 |
Return true if the update downloader is currently downloading the update |
|
1378 |
</summary> |
|
1379 |
</member> |
|
1380 |
<member name="E:NetSparkleUpdater.Interfaces.IUpdateDownloader.DownloadProgressChanged"> |
|
1381 |
<summary> |
|
1382 |
Event to call when some progress has been made on the download |
|
1383 |
</summary> |
|
1384 |
</member> |
|
1385 |
<member name="E:NetSparkleUpdater.Interfaces.IUpdateDownloader.DownloadFileCompleted"> |
|
1386 |
<summary> |
|
1387 |
Event to call when the download of the update file has been completed |
|
1388 |
</summary> |
|
1389 |
</member> |
|
1390 |
<member name="M:NetSparkleUpdater.Interfaces.IUpdateDownloader.StartFileDownload(System.Uri,System.String)"> |
|
1391 |
<summary> |
|
1392 |
Start the download of the file. The file download should be asynchronous! |
|
1393 |
</summary> |
|
1394 |
<param name="uri">URL for the download</param> |
|
1395 |
<param name="downloadFilePath">Where to download the file</param> |
|
1396 |
</member> |
|
1397 |
<member name="M:NetSparkleUpdater.Interfaces.IUpdateDownloader.CancelDownload"> |
|
1398 |
<summary> |
|
1399 |
Cancel the download. |
|
1400 |
</summary> |
|
1401 |
</member> |
|
1402 |
<member name="M:NetSparkleUpdater.Interfaces.IUpdateDownloader.Dispose"> |
|
1403 |
<summary> |
|
1404 |
Clean up and dispose of anything that has to be disposed of |
|
1405 |
(cancel the download if needed, etc.) |
|
1406 |
</summary> |
|
1407 |
</member> |
|
1408 |
<member name="M:NetSparkleUpdater.Interfaces.IUpdateDownloader.RetrieveDestinationFileNameAsync(NetSparkleUpdater.AppCastItem)"> |
|
1409 |
<summary> |
|
1410 |
Retrieve the download file name of the app cast item from the server. |
|
1411 |
This is useful if the server has any sort of redirects that take place |
|
1412 |
when starting the download process. The client will use this file name |
|
1413 |
when saving the file on disk. |
|
1414 |
NetSparkle.CheckServerFileName = false can be set to avoid this call. |
|
1415 |
</summary> |
|
1416 |
<param name="item">The AppCastItem that will be downloaded</param> |
|
1417 |
<returns>The file name of the file to download from the server |
|
1418 |
(including file extension). Null if not found/had error/not applicable.</returns> |
|
1419 |
</member> |
|
1420 |
<member name="T:NetSparkleUpdater.LogWriter"> |
|
1421 |
<summary> |
|
1422 |
A simple class to handle log information for NetSparkleUPdater. |
|
1423 |
Make sure to do any setup for this class that you want |
|
1424 |
to do before calling StartLoop on your SparkleUpdater object. |
|
1425 |
</summary> |
|
1426 |
</member> |
|
1427 |
<member name="F:NetSparkleUpdater.LogWriter.tag"> |
|
1428 |
<summary> |
|
1429 |
Tag to show before any log statements |
|
1430 |
</summary> |
|
1431 |
</member> |
|
1432 |
<member name="M:NetSparkleUpdater.LogWriter.#ctor"> |
|
1433 |
<summary> |
|
1434 |
Empty constructor -> sets PrintDiagnosticToConsole to false |
|
1435 |
</summary> |
|
1436 |
</member> |
|
1437 |
<member name="M:NetSparkleUpdater.LogWriter.#ctor(System.Boolean)"> |
|
1438 |
<summary> |
|
1439 |
LogWriter constructor that takes a bool to determine |
|
1440 |
the value for printDiagnosticToConsole |
|
1441 |
</summary> |
|
1442 |
<param name="printDiagnosticToConsole">Whether this object should print via Debug.WriteLine or Console.WriteLine</param> |
|
1443 |
</member> |
|
1444 |
<member name="P:NetSparkleUpdater.LogWriter.PrintDiagnosticToConsole"> |
|
1445 |
<summary> |
|
1446 |
True if this class should print to Console.WriteLine; |
|
1447 |
false if this object should print to Debug.WriteLine. |
|
1448 |
Defaults to false. |
|
1449 |
</summary> |
|
1450 |
</member> |
|
1451 |
<member name="M:NetSparkleUpdater.LogWriter.PrintMessage(System.String,System.Object[])"> |
|
1452 |
<inheritdoc/> |
|
1453 |
</member> |
|
1454 |
<member name="T:NetSparkleUpdater.LoopStartedOperation"> |
|
1455 |
<summary> |
|
1456 |
The operation has started |
|
1457 |
</summary> |
|
1458 |
<param name="sender">the sender</param> |
|
1459 |
</member> |
|
1460 |
<member name="T:NetSparkleUpdater.LoopFinishedOperation"> |
|
1461 |
<summary> |
|
1462 |
The operation has ended |
|
1463 |
</summary> |
|
1464 |
<param name="sender">the sender</param> |
|
1465 |
<param name="updateRequired"><c>true</c> if an update is required</param> |
|
1466 |
</member> |
|
1467 |
<member name="T:NetSparkleUpdater.UpdateDetected"> |
|
1468 |
<summary> |
|
1469 |
This delegate will be used when an update was detected to allow library |
|
1470 |
consumer to add own user interface capabilities. |
|
1471 |
</summary> |
|
1472 |
</member> |
|
1473 |
<member name="T:NetSparkleUpdater.UpdateCheckStarted"> |
|
1474 |
<summary> |
|
1475 |
Update check has started. |
|
1476 |
</summary> |
|
1477 |
<param name="sender">Sparkle updater that is checking for an update.</param> |
|
1478 |
</member> |
|
1479 |
<member name="T:NetSparkleUpdater.UpdateCheckFinished"> |
|
1480 |
<summary> |
|
1481 |
Update check has finished. |
|
1482 |
</summary> |
|
1483 |
<param name="sender">Sparkle updater that finished checking for an update.</param> |
|
1484 |
<param name="status">Update status</param> |
|
1485 |
</member> |
|
1486 |
<member name="T:NetSparkleUpdater.CancelEventHandlerAsync"> |
|
1487 |
<summary> |
내보내기 Unified diff