markus / AppCast / NetSparkle.xml @ 9d5b4bc2
이력 | 보기 | 이력해설 | 다운로드 (137 KB)
| 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>
|
| 1488 |
An asynchronous cancel event handler. |
| 1489 |
</summary>
|
| 1490 |
<param name="sender">The source of the event.</param> |
| 1491 |
<param name="e">A System.ComponentModel.CancelEventArgs that contains the event data.</param> |
| 1492 |
</member>
|
| 1493 |
<member name="T:NetSparkleUpdater.CloseApplication"> |
| 1494 |
<summary>
|
| 1495 |
Delegate for custom application shutdown logic |
| 1496 |
</summary>
|
| 1497 |
</member>
|
| 1498 |
<member name="T:NetSparkleUpdater.CloseApplicationAsync"> |
| 1499 |
<summary>
|
| 1500 |
Async version of CloseApplication(). |
| 1501 |
Delegate for custom application shutdown logic |
| 1502 |
</summary>
|
| 1503 |
</member>
|
| 1504 |
<member name="T:NetSparkleUpdater.DownloadEvent"> |
| 1505 |
<summary>
|
| 1506 |
A delegate for download events (start, canceled). |
| 1507 |
</summary>
|
| 1508 |
</member>
|
| 1509 |
<member name="T:NetSparkleUpdater.DownloadProgressEvent"> |
| 1510 |
<summary>
|
| 1511 |
A delegate for download progress events (TODO: docs update) |
| 1512 |
</summary>
|
| 1513 |
<param name="sender"></param> |
| 1514 |
<param name="args"></param> |
| 1515 |
</member>
|
| 1516 |
<member name="T:NetSparkleUpdater.ItemDownloadProgressEvent"> |
| 1517 |
<summary>
|
| 1518 |
A delegate for download progress events for a given item (TODO: docs update) |
| 1519 |
</summary>
|
| 1520 |
<param name="sender"></param> |
| 1521 |
<param name="item"></param> |
| 1522 |
<param name="args"></param> |
| 1523 |
</member>
|
| 1524 |
<member name="T:NetSparkleUpdater.UserRespondedToUpdate"> |
| 1525 |
<summary>
|
| 1526 |
A handler called when the user responsed to an available update |
| 1527 |
</summary>
|
| 1528 |
<param name="sender">The source of the event.</param> |
| 1529 |
<param name="e">An UpdateResponse object that contains the event data.</param> |
| 1530 |
</member>
|
| 1531 |
<member name="T:NetSparkleUpdater.DownloadErrorEvent"> |
| 1532 |
<summary>
|
| 1533 |
A delegate for a download error |
| 1534 |
</summary>
|
| 1535 |
</member>
|
| 1536 |
<member name="T:NetSparkleUpdater.NetSparkleException"> |
| 1537 |
<summary>
|
| 1538 |
A NetSparkle exception |
| 1539 |
</summary>
|
| 1540 |
</member>
|
| 1541 |
<member name="M:NetSparkleUpdater.NetSparkleException.#ctor(System.String)"> |
| 1542 |
<summary>
|
| 1543 |
Constructor |
| 1544 |
</summary>
|
| 1545 |
<param name="message">exception message</param> |
| 1546 |
</member>
|
| 1547 |
<member name="M:NetSparkleUpdater.NetSparkleException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> |
| 1548 |
<summary>
|
| 1549 |
Constructor |
| 1550 |
</summary>
|
| 1551 |
<param name="info">serialization info</param> |
| 1552 |
<param name="context">the context</param> |
| 1553 |
</member>
|
| 1554 |
<member name="T:NetSparkleUpdater.Properties.Resources"> |
| 1555 |
<summary>
|
| 1556 |
A strongly-typed resource class, for looking up localized strings, etc. |
| 1557 |
</summary>
|
| 1558 |
</member>
|
| 1559 |
<member name="P:NetSparkleUpdater.Properties.Resources.ResourceManager"> |
| 1560 |
<summary>
|
| 1561 |
Returns the cached ResourceManager instance used by this class. |
| 1562 |
</summary>
|
| 1563 |
</member>
|
| 1564 |
<member name="P:NetSparkleUpdater.Properties.Resources.Culture"> |
| 1565 |
<summary>
|
| 1566 |
Overrides the current thread's CurrentUICulture property for all |
| 1567 |
resource lookups using this strongly typed resource class. |
| 1568 |
</summary>
|
| 1569 |
</member>
|
| 1570 |
<member name="P:NetSparkleUpdater.Properties.Resources.DefaultUIFactory_ErrorTitle"> |
| 1571 |
<summary>
|
| 1572 |
Looks up a localized string similar to Error!. |
| 1573 |
</summary>
|
| 1574 |
</member>
|
| 1575 |
<member name="P:NetSparkleUpdater.Properties.Resources.DefaultUIFactory_MessageTitle"> |
| 1576 |
<summary>
|
| 1577 |
Looks up a localized string similar to Info. |
| 1578 |
</summary>
|
| 1579 |
</member>
|
| 1580 |
<member name="P:NetSparkleUpdater.Properties.Resources.DefaultUIFactory_ShowCannotDownloadAppcastMessage"> |
| 1581 |
<summary>
|
| 1582 |
Looks up a localized string similar to Sorry, either you aren't connected to the internet, or our server is having a problem..
|
| 1583 |
</summary>
|
| 1584 |
</member>
|
| 1585 |
<member name="P:NetSparkleUpdater.Properties.Resources.DefaultUIFactory_ShowDownloadErrorMessage"> |
| 1586 |
<summary>
|
| 1587 |
Looks up a localized string similar to Sorry, there was a problem attempting to download the update |
| 1588 |
|
| 1589 |
{0}.
|
| 1590 |
</summary>
|
| 1591 |
</member>
|
| 1592 |
<member name="P:NetSparkleUpdater.Properties.Resources.DefaultUIFactory_ShowUnknownInstallerFormatMessageText"> |
| 1593 |
<summary>
|
| 1594 |
Looks up a localized string similar to Updater not supported, please execute {0} manually.
|
| 1595 |
</summary>
|
| 1596 |
</member>
|
| 1597 |
<member name="P:NetSparkleUpdater.Properties.Resources.DefaultUIFactory_ShowVersionIsSkippedByUserRequestMessage"> |
| 1598 |
<summary>
|
| 1599 |
Looks up a localized string similar to You have elected to skip this version.. |
| 1600 |
</summary>
|
| 1601 |
</member>
|
| 1602 |
<member name="P:NetSparkleUpdater.Properties.Resources.DefaultUIFactory_ShowVersionIsUpToDateMessage"> |
| 1603 |
<summary>
|
| 1604 |
Looks up a localized string similar to Your current version is up to date.. |
| 1605 |
</summary>
|
| 1606 |
</member>
|
| 1607 |
<member name="P:NetSparkleUpdater.Properties.Resources.DefaultUIFactory_ToastCallToAction"> |
| 1608 |
<summary>
|
| 1609 |
Looks up a localized string similar to More information. |
| 1610 |
</summary>
|
| 1611 |
</member>
|
| 1612 |
<member name="P:NetSparkleUpdater.Properties.Resources.DefaultUIFactory_ToastMessage"> |
| 1613 |
<summary>
|
| 1614 |
Looks up a localized string similar to New Version Available. |
| 1615 |
</summary>
|
| 1616 |
</member>
|
| 1617 |
<member name="T:NetSparkleUpdater.ReleaseNotesGrabber"> |
| 1618 |
<summary>
|
| 1619 |
Grabs release notes formatted as Markdown from the server and allows you to view them as HTML |
| 1620 |
</summary>
|
| 1621 |
</member>
|
| 1622 |
<member name="F:NetSparkleUpdater.ReleaseNotesGrabber._separatorTemplate"> |
| 1623 |
<summary>
|
| 1624 |
The HTML template to use between each changelog for every update between the |
| 1625 |
most current update and the one that the user is going to install |
| 1626 |
</summary>
|
| 1627 |
</member>
|
| 1628 |
<member name="F:NetSparkleUpdater.ReleaseNotesGrabber._initialHTML"> |
| 1629 |
<summary>
|
| 1630 |
The initial HTML to use for the changelog. This is everything before the |
| 1631 |
body tag and includes the html and head elements/tags. |
| 1632 |
</summary>
|
| 1633 |
</member>
|
| 1634 |
<member name="F:NetSparkleUpdater.ReleaseNotesGrabber._sparkle"> |
| 1635 |
<summary>
|
| 1636 |
The <see cref="T:NetSparkleUpdater.SparkleUpdater"/> for this ReleaseNotesGrabber. Mostly |
| 1637 |
used for logging via <see cref="T:NetSparkleUpdater.LogWriter"/>, but also can be used |
| 1638 |
to grab other information about updates, etc. |
| 1639 |
</summary>
|
| 1640 |
</member>
|
| 1641 |
<member name="F:NetSparkleUpdater.ReleaseNotesGrabber.MarkdownExtensions"> |
| 1642 |
<summary>
|
| 1643 |
List of supported extensions for markdown files (.md, .mkdn, .mkd, .markdown) |
| 1644 |
</summary>
|
| 1645 |
</member>
|
| 1646 |
<member name="P:NetSparkleUpdater.ReleaseNotesGrabber.ChecksReleaseNotesSignature"> |
| 1647 |
<summary>
|
| 1648 |
Whether or not to check the signature of the release notes |
| 1649 |
after they've been downloaded. Defaults to false. |
| 1650 |
</summary>
|
| 1651 |
</member>
|
| 1652 |
<member name="M:NetSparkleUpdater.ReleaseNotesGrabber.#ctor(System.String,System.String,NetSparkleUpdater.SparkleUpdater)"> |
| 1653 |
<summary>
|
| 1654 |
Base constructor for ReleaseNotesGrabber |
| 1655 |
</summary>
|
| 1656 |
<param name="separatorTemplate">Template to use for separating each item in the HTML</param> |
| 1657 |
<param name="htmlHeadAddition">Any additional header information to stick in the HTML that will show up in the release notes</param> |
| 1658 |
<param name="sparkle">Sparkle updater being used</param> |
| 1659 |
</member>
|
| 1660 |
<member name="M:NetSparkleUpdater.ReleaseNotesGrabber.GetLoadingText"> |
| 1661 |
<summary>
|
| 1662 |
Generates the text to display while release notes are loading |
| 1663 |
</summary>
|
| 1664 |
<returns>HTML to show to the user while release notes are loading</returns> |
| 1665 |
</member>
|
| 1666 |
<member name="M:NetSparkleUpdater.ReleaseNotesGrabber.DownloadAllReleaseNotes(System.Collections.Generic.List{NetSparkleUpdater.AppCastItem},NetSparkleUpdater.AppCastItem,System.Threading.CancellationToken)"> |
| 1667 |
<summary>
|
| 1668 |
Download all of the release notes provided to this function and convert them to HTML |
| 1669 |
</summary>
|
| 1670 |
<param name="items">List of items that you want to display in the release notes</param> |
| 1671 |
<param name="latestVersion">The latest version (most current version) of your releases</param> |
| 1672 |
<param name="cancellationToken">Token to cancel the async download requests</param> |
| 1673 |
<returns></returns> |
| 1674 |
</member>
|
| 1675 |
<member name="M:NetSparkleUpdater.ReleaseNotesGrabber.GetReleaseNotes(NetSparkleUpdater.AppCastItem,NetSparkleUpdater.SparkleUpdater,System.Threading.CancellationToken)"> |
| 1676 |
<summary>
|
| 1677 |
Grab the release notes for the given item and return their release notes |
| 1678 |
in HTML format so that they can be displayed to the user. |
| 1679 |
</summary>
|
| 1680 |
<param name="item"><see cref="T:NetSparkleUpdater.AppCastItem"/>item to download the release notes for</param> |
| 1681 |
<param name="sparkle"><see cref="T:NetSparkleUpdater.SparkleUpdater"/> that can be used for logging information |
| 1682 |
about the release notes grabbing process (or its failures)</param>
|
| 1683 |
<param name="cancellationToken">token that can be used to cancel a release notes |
| 1684 |
grabbing operation</param>
|
| 1685 |
<returns></returns> |
| 1686 |
</member>
|
| 1687 |
<member name="M:NetSparkleUpdater.ReleaseNotesGrabber.DownloadReleaseNotes(System.String,System.Threading.CancellationToken,NetSparkleUpdater.SparkleUpdater)"> |
| 1688 |
<summary>
|
| 1689 |
Download the release notes at the given link. Does not do anything else |
| 1690 |
for the release notes (verification, display, etc.) -- just downloads the |
| 1691 |
release notes and passes them back as a string. |
| 1692 |
</summary>
|
| 1693 |
<param name="link">string URL to the release notes to download</param> |
| 1694 |
<param name="cancellationToken">token that can be used to cancel a download operation</param> |
| 1695 |
<param name="sparkle"><see cref="T:NetSparkleUpdater.SparkleUpdater"/> that can be used for logging information |
| 1696 |
about the download process (or its failures)</param>
|
| 1697 |
<returns></returns> |
| 1698 |
</member>
|
| 1699 |
<member name="T:NetSparkleUpdater.SignatureVerifiers.DSAChecker"> |
| 1700 |
<summary>
|
| 1701 |
Class to verify a DSA signature |
| 1702 |
</summary>
|
| 1703 |
</member>
|
| 1704 |
<member name="M:NetSparkleUpdater.SignatureVerifiers.DSAChecker.HasValidKeyInformation"> |
| 1705 |
<summary>
|
| 1706 |
Determines if a public key exists |
| 1707 |
</summary>
|
| 1708 |
<returns><c>bool</c></returns> |
| 1709 |
</member>
|
| 1710 |
<member name="M:NetSparkleUpdater.SignatureVerifiers.DSAChecker.#ctor(NetSparkleUpdater.Enums.SecurityMode,System.String,System.String)"> |
| 1711 |
<summary>
|
| 1712 |
Create a DSAChecker object from the given parameters |
| 1713 |
</summary>
|
| 1714 |
<param name="mode">The security mode of the validator. Controls what needs to be set in order to validate |
| 1715 |
an app cast and its items.</param>
|
| 1716 |
<param name="publicKey">the public key as string (will be preferred before the file)</param> |
| 1717 |
<param name="publicKeyFile">the public key file</param> |
| 1718 |
</member>
|
| 1719 |
<member name="P:NetSparkleUpdater.SignatureVerifiers.DSAChecker.SecurityMode"> |
| 1720 |
<summary>
|
| 1721 |
<inheritdoc/> |
| 1722 |
</summary>
|
| 1723 |
</member>
|
| 1724 |
<member name="M:NetSparkleUpdater.SignatureVerifiers.DSAChecker.VerifySignature(System.String,System.Byte[])"> |
| 1725 |
<inheritdoc/> |
| 1726 |
</member>
|
| 1727 |
<member name="M:NetSparkleUpdater.SignatureVerifiers.DSAChecker.VerifySignatureOfFile(System.String,System.String)"> |
| 1728 |
<inheritdoc/> |
| 1729 |
</member>
|
| 1730 |
<member name="M:NetSparkleUpdater.SignatureVerifiers.DSAChecker.VerifySignatureOfString(System.String,System.String)"> |
| 1731 |
<inheritdoc/> |
| 1732 |
</member>
|
| 1733 |
<member name="M:NetSparkleUpdater.SignatureVerifiers.DSAChecker.TryGetFileResource(System.String,System.IO.Stream)"> |
| 1734 |
<summary>
|
| 1735 |
Gets a file resource |
| 1736 |
</summary>
|
| 1737 |
<param name="publicKey">the public key</param> |
| 1738 |
<param name="data">the data stream</param> |
| 1739 |
<returns>the data stream</returns> |
| 1740 |
</member>
|
| 1741 |
<member name="M:NetSparkleUpdater.SignatureVerifiers.DSAChecker.TryGetResourceStream(System.String)"> |
| 1742 |
<summary>
|
| 1743 |
Get a resource stream |
| 1744 |
</summary>
|
| 1745 |
<param name="publicKey">the public key</param> |
| 1746 |
<returns>a stream</returns> |
| 1747 |
</member>
|
| 1748 |
<member name="T:NetSparkleUpdater.SignatureVerifiers.Ed25519Checker"> |
| 1749 |
<summary>
|
| 1750 |
Class to verify a Ed25519 signature |
| 1751 |
</summary>
|
| 1752 |
</member>
|
| 1753 |
<member name="M:NetSparkleUpdater.SignatureVerifiers.Ed25519Checker.HasValidKeyInformation"> |
| 1754 |
<summary>
|
| 1755 |
Determines if a public key exists |
| 1756 |
</summary>
|
| 1757 |
<returns><c>bool</c></returns> |
| 1758 |
</member>
|
| 1759 |
<member name="M:NetSparkleUpdater.SignatureVerifiers.Ed25519Checker.#ctor(NetSparkleUpdater.Enums.SecurityMode,System.String,System.String)"> |
| 1760 |
<summary>
|
| 1761 |
Create a Ed25519Checker object from the given parameters |
| 1762 |
</summary>
|
| 1763 |
<param name="mode">The security mode of the validator. Controls what needs to be set in order to validate |
| 1764 |
an app cast and its items.</param>
|
| 1765 |
<param name="publicKey">the base 64 public key as a string</param> |
| 1766 |
<param name="publicKeyFile">the public key file</param> |
| 1767 |
</member>
|
| 1768 |
<member name="P:NetSparkleUpdater.SignatureVerifiers.Ed25519Checker.SecurityMode"> |
| 1769 |
<summary>
|
| 1770 |
<inheritdoc/> |
| 1771 |
</summary>
|
| 1772 |
</member>
|
| 1773 |
<member name="M:NetSparkleUpdater.SignatureVerifiers.Ed25519Checker.VerifySignature(System.String,System.Byte[])"> |
| 1774 |
<inheritdoc/> |
| 1775 |
</member>
|
| 1776 |
<member name="M:NetSparkleUpdater.SignatureVerifiers.Ed25519Checker.VerifySignatureOfFile(System.String,System.String)"> |
| 1777 |
<inheritdoc/> |
| 1778 |
</member>
|
| 1779 |
<member name="M:NetSparkleUpdater.SignatureVerifiers.Ed25519Checker.VerifySignatureOfString(System.String,System.String)"> |
| 1780 |
<inheritdoc/> |
| 1781 |
</member>
|
| 1782 |
<member name="M:NetSparkleUpdater.SignatureVerifiers.Ed25519Checker.TryGetFileResource(System.String,System.IO.Stream)"> |
| 1783 |
<summary>
|
| 1784 |
Gets a file resource |
| 1785 |
</summary>
|
| 1786 |
<param name="publicKey">the public key</param> |
| 1787 |
<param name="data">the data stream</param> |
| 1788 |
<returns>the data stream</returns> |
| 1789 |
</member>
|
| 1790 |
<member name="M:NetSparkleUpdater.SignatureVerifiers.Ed25519Checker.TryGetResourceStream(System.String)"> |
| 1791 |
<summary>
|
| 1792 |
Get a resource stream |
| 1793 |
</summary>
|
| 1794 |
<param name="publicKey">the public key</param> |
| 1795 |
<returns>a stream</returns> |
| 1796 |
</member>
|
| 1797 |
<member name="T:NetSparkleUpdater.SparkleUpdater"> |
| 1798 |
<summary>
|
| 1799 |
Class to communicate with a sparkle-based appcast to download |
| 1800 |
and install updates to an application |
| 1801 |
</summary>
|
| 1802 |
</member>
|
| 1803 |
<member name="F:NetSparkleUpdater.SparkleUpdater._installerProcess"> |
| 1804 |
<summary>
|
| 1805 |
The <see cref="T:System.Diagnostics.Process"/> responsible for launching the downloaded update. |
| 1806 |
Only valid once the application is about to quit and the update is going to |
| 1807 |
be launched. |
| 1808 |
</summary>
|
| 1809 |
</member>
|
| 1810 |
<member name="M:NetSparkleUpdater.SparkleUpdater.#ctor(System.String,NetSparkleUpdater.Interfaces.ISignatureVerifier)"> |
| 1811 |
<summary>
|
| 1812 |
ctor which needs the appcast url |
| 1813 |
</summary>
|
| 1814 |
<param name="appcastUrl">the URL of the appcast file</param> |
| 1815 |
<param name="signatureVerifier">the object that will verify your appcast signatures.</param> |
| 1816 |
</member>
|
| 1817 |
<member name="M:NetSparkleUpdater.SparkleUpdater.#ctor(System.String,NetSparkleUpdater.Interfaces.ISignatureVerifier,System.String)"> |
| 1818 |
<summary>
|
| 1819 |
ctor which needs the appcast url and a referenceassembly |
| 1820 |
</summary>
|
| 1821 |
<param name="appcastUrl">the URL of the appcast file</param> |
| 1822 |
<param name="signatureVerifier">the object that will verify your appcast signatures.</param> |
| 1823 |
<param name="referenceAssembly">the name of the assembly to use for comparison when checking update versions</param> |
| 1824 |
</member>
|
| 1825 |
<member name="M:NetSparkleUpdater.SparkleUpdater.#ctor(System.String,NetSparkleUpdater.Interfaces.ISignatureVerifier,System.String,NetSparkleUpdater.Interfaces.IUIFactory)"> |
| 1826 |
<summary>
|
| 1827 |
ctor which needs the appcast url and a referenceassembly |
| 1828 |
</summary>
|
| 1829 |
<param name="appcastUrl">the URL of the appcast file</param> |
| 1830 |
<param name="signatureVerifier">the object that will verify your appcast signatures.</param> |
| 1831 |
<param name="referenceAssembly">the name of the assembly to use for comparison when checking update versions</param> |
| 1832 |
<param name="factory">a UI factory to use in place of the default UI</param> |
| 1833 |
</member>
|
| 1834 |
<member name="P:NetSparkleUpdater.SparkleUpdater.SecurityProtocolType"> |
| 1835 |
<summary>
|
| 1836 |
The security protocol used by NetSparkle. Setting this property will also set this |
| 1837 |
for the current AppDomain of the caller. Needs to be set to |
| 1838 |
SecurityProtocolType.Tls12 for some cases (such as when downloading from GitHub). |
| 1839 |
</summary>
|
| 1840 |
</member>
|
| 1841 |
<member name="P:NetSparkleUpdater.SparkleUpdater.UserInteractionMode"> |
| 1842 |
<summary>
|
| 1843 |
Set the user interaction mode for Sparkle to use when there is a valid update for the software |
| 1844 |
</summary>
|
| 1845 |
</member>
|
| 1846 |
<member name="P:NetSparkleUpdater.SparkleUpdater.TmpDownloadFilePath"> |
| 1847 |
<summary>
|
| 1848 |
If set, downloads files to this path. If the folder doesn't already exist, creates |
| 1849 |
the folder at download time (and not before). |
| 1850 |
Note that this variable is a path, not a full file name. |
| 1851 |
</summary>
|
| 1852 |
</member>
|
| 1853 |
<member name="P:NetSparkleUpdater.SparkleUpdater.RelaunchAfterUpdate"> |
| 1854 |
<summary>
|
| 1855 |
Defines if the application needs to be relaunched after executing the downloaded installer |
| 1856 |
</summary>
|
| 1857 |
</member>
|
| 1858 |
<member name="P:NetSparkleUpdater.SparkleUpdater.CustomInstallerArguments"> |
| 1859 |
<summary>
|
| 1860 |
Run the downloaded installer with these arguments |
| 1861 |
</summary>
|
| 1862 |
</member>
|
| 1863 |
<member name="P:NetSparkleUpdater.SparkleUpdater.ClearOldInstallers"> |
| 1864 |
<summary>
|
| 1865 |
Function that is called asynchronously to clean up old installers that have been |
| 1866 |
downloaded with SilentModeTypes.DownloadNoInstall or SilentModeTypes.DownloadAndInstall. |
| 1867 |
</summary>
|
| 1868 |
</member>
|
| 1869 |
<member name="P:NetSparkleUpdater.SparkleUpdater.IsUpdateLoopRunning"> |
| 1870 |
<summary>
|
| 1871 |
Whether or not the update loop is running |
| 1872 |
</summary>
|
| 1873 |
</member>
|
| 1874 |
<member name="P:NetSparkleUpdater.SparkleUpdater.UIFactory"> |
| 1875 |
<summary>
|
| 1876 |
Factory for creating UI elements like progress window, etc. |
| 1877 |
</summary>
|
| 1878 |
</member>
|
| 1879 |
<member name="P:NetSparkleUpdater.SparkleUpdater.UpdateAvailableWindow"> |
| 1880 |
<summary>
|
| 1881 |
The user interface window that shows the release notes and |
| 1882 |
asks the user to skip, remind me later, or update |
| 1883 |
</summary>
|
| 1884 |
</member>
|
| 1885 |
<member name="P:NetSparkleUpdater.SparkleUpdater.ProgressWindow"> |
| 1886 |
<summary>
|
| 1887 |
The user interface window that shows a download progress bar, |
| 1888 |
and then asks to install and relaunch the application |
| 1889 |
</summary>
|
| 1890 |
</member>
|
| 1891 |
<member name="P:NetSparkleUpdater.SparkleUpdater.CheckingForUpdatesWindow"> |
| 1892 |
<summary>
|
| 1893 |
The user interface window that shows the 'Checking for Updates...' |
| 1894 |
form. |
| 1895 |
</summary>
|
| 1896 |
</member>
|
| 1897 |
<member name="P:NetSparkleUpdater.SparkleUpdater.Configuration"> |
| 1898 |
<summary>
|
| 1899 |
The NetSparkle configuration object for the current assembly. |
| 1900 |
</summary>
|
| 1901 |
</member>
|
| 1902 |
<member name="P:NetSparkleUpdater.SparkleUpdater.SignatureVerifier"> |
| 1903 |
<summary>
|
| 1904 |
The object that verifies signatures (DSA or otherwise) of downloaded items |
| 1905 |
</summary>
|
| 1906 |
</member>
|
| 1907 |
<member name="P:NetSparkleUpdater.SparkleUpdater.AppCastUrl"> |
| 1908 |
<summary>
|
| 1909 |
Gets or sets the appcast URL |
| 1910 |
</summary>
|
| 1911 |
</member>
|
| 1912 |
<member name="P:NetSparkleUpdater.SparkleUpdater.UseNotificationToast"> |
| 1913 |
<summary>
|
| 1914 |
Specifies if you want to use the notification toast |
| 1915 |
</summary>
|
| 1916 |
</member>
|
| 1917 |
<member name="P:NetSparkleUpdater.SparkleUpdater.ShowsUIOnMainThread"> |
| 1918 |
<summary>
|
| 1919 |
WinForms/WPF only. |
| 1920 |
If true, tries to run UI code on the main thread using <see cref="T:System.Threading.SynchronizationContext"/>. |
| 1921 |
Must be set to true if using NetSparkleUpdater from Avalonia. |
| 1922 |
</summary>
|
| 1923 |
</member>
|
| 1924 |
<member name="P:NetSparkleUpdater.SparkleUpdater.LogWriter"> |
| 1925 |
<summary>
|
| 1926 |
Object that handles any diagnostic messages for NetSparkle. |
| 1927 |
If you want to use your own class for this, you should just |
| 1928 |
need to override <see cref="M:NetSparkleUpdater.LogWriter.PrintMessage(System.String,System.Object[])"/> in your own class. |
| 1929 |
Make sure to set this object before calling <see cref="M:NetSparkleUpdater.SparkleUpdater.StartLoop(System.Boolean)"/> to guarantee |
| 1930 |
that all messages will get sent to the right place! |
| 1931 |
</summary>
|
| 1932 |
</member>
|
| 1933 |
<member name="P:NetSparkleUpdater.SparkleUpdater.CheckServerFileName"> |
| 1934 |
<summary>
|
| 1935 |
Whether or not to check with the online server to verify download |
| 1936 |
file names. |
| 1937 |
</summary>
|
| 1938 |
</member>
|
| 1939 |
<member name="P:NetSparkleUpdater.SparkleUpdater.LatestAppCastItems"> |
| 1940 |
<summary>
|
| 1941 |
Returns the latest appcast items to the caller. Might be null. |
| 1942 |
</summary>
|
| 1943 |
</member>
|
| 1944 |
<member name="P:NetSparkleUpdater.SparkleUpdater.UpdateMarkedCritical"> |
| 1945 |
<summary>
|
| 1946 |
Loops through all of the most recently grabbed app cast items |
| 1947 |
and checks if any of them are marked as critical |
| 1948 |
</summary>
|
| 1949 |
</member>
|
| 1950 |
<member name="P:NetSparkleUpdater.SparkleUpdater.UpdateDownloader"> |
| 1951 |
<summary>
|
| 1952 |
The object responsable for downloading update files for your application |
| 1953 |
</summary>
|
| 1954 |
</member>
|
| 1955 |
<member name="P:NetSparkleUpdater.SparkleUpdater.AppCastDataDownloader"> |
| 1956 |
<summary>
|
| 1957 |
The object responsible for downloading app cast and app cast signature |
| 1958 |
information for your application |
| 1959 |
</summary>
|
| 1960 |
</member>
|
| 1961 |
<member name="P:NetSparkleUpdater.SparkleUpdater.AppCastHandler"> |
| 1962 |
<summary>
|
| 1963 |
The object responsible for parsing app cast information and checking to |
| 1964 |
see if any updates are available in a given app cast |
| 1965 |
</summary>
|
| 1966 |
</member>
|
| 1967 |
<member name="M:NetSparkleUpdater.SparkleUpdater.StartLoop(System.Boolean)"> |
| 1968 |
<summary>
|
| 1969 |
Starts a NetSparkle background loop to check for updates every 24 hours. |
| 1970 |
<para>You should only call this function when your app is initialized and shows its main window.</para> |
| 1971 |
</summary>
|
| 1972 |
<param name="doInitialCheck">whether the first check should happen before or after the first interval</param> |
| 1973 |
</member>
|
| 1974 |
<member name="M:NetSparkleUpdater.SparkleUpdater.StartLoop(System.Boolean,System.TimeSpan)"> |
| 1975 |
<summary>
|
| 1976 |
Starts a NetSparkle background loop to check for updates on a given interval. |
| 1977 |
<para>You should only call this function when your app is initialized and shows its main window.</para> |
| 1978 |
</summary>
|
| 1979 |
<param name="doInitialCheck">whether the first check should happen before or after the first interval</param> |
| 1980 |
<param name="checkFrequency">the interval to wait between update checks</param> |
| 1981 |
</member>
|
| 1982 |
<member name="M:NetSparkleUpdater.SparkleUpdater.StartLoop(System.Boolean,System.Boolean)"> |
| 1983 |
<summary>
|
| 1984 |
Starts a NetSparkle background loop to check for updates every 24 hours. |
| 1985 |
<para>You should only call this function when your app is initialized and shows its main window.</para> |
| 1986 |
</summary>
|
| 1987 |
<param name="doInitialCheck">whether the first check should happen before or after the first interval</param> |
| 1988 |
<param name="forceInitialCheck">if <paramref name="doInitialCheck"/> is true, whether the first check |
| 1989 |
should happen even if the last check was less than 24 hours ago</param>
|
| 1990 |
</member>
|
| 1991 |
<member name="M:NetSparkleUpdater.SparkleUpdater.StartLoop(System.Boolean,System.Boolean,System.TimeSpan)"> |
| 1992 |
<summary>
|
| 1993 |
Starts a NetSparkle background loop to check for updates on a given interval. |
| 1994 |
<para>You should only call this function when your app is initialized and shows its main window.</para> |
| 1995 |
</summary>
|
| 1996 |
<param name="doInitialCheck">whether the first check should happen before or after the first period</param> |
| 1997 |
<param name="forceInitialCheck">if <paramref name="doInitialCheck"/> is true, whether the first check |
| 1998 |
should happen even if the last check was within the last <paramref name="checkFrequency"/> interval</param> |
| 1999 |
<param name="checkFrequency">the interval to wait between update checks</param> |
| 2000 |
</member>
|
| 2001 |
<member name="M:NetSparkleUpdater.SparkleUpdater.StopLoop"> |
| 2002 |
<summary>
|
| 2003 |
Stops the Sparkle background loop. Called automatically by <see cref="M:NetSparkleUpdater.SparkleUpdater.Dispose"/>. |
| 2004 |
</summary>
|
| 2005 |
</member>
|
| 2006 |
<member name="M:NetSparkleUpdater.SparkleUpdater.Finalize"> |
| 2007 |
<summary>
|
| 2008 |
Finalizer |
| 2009 |
</summary>
|
| 2010 |
</member>
|
| 2011 |
<member name="M:NetSparkleUpdater.SparkleUpdater.Dispose"> |
| 2012 |
<summary>
|
| 2013 |
Inherited from IDisposable. Stops all background activities. |
| 2014 |
</summary>
|
| 2015 |
</member>
|
| 2016 |
<member name="M:NetSparkleUpdater.SparkleUpdater.Dispose(System.Boolean)"> |
| 2017 |
<summary>
|
| 2018 |
Dispose of managed and unmanaged resources |
| 2019 |
</summary>
|
| 2020 |
<param name="disposing"></param> |
| 2021 |
</member>
|
| 2022 |
<member name="M:NetSparkleUpdater.SparkleUpdater.UnregisterEvents"> |
| 2023 |
<summary>
|
| 2024 |
Unregisters events so that we don't have multiple items updating |
| 2025 |
</summary>
|
| 2026 |
</member>
|
| 2027 |
<member name="M:NetSparkleUpdater.SparkleUpdater.GetUpdateStatus(NetSparkleUpdater.Configurations.Configuration)"> |
| 2028 |
<summary>
|
| 2029 |
This method checks if an update is required. During this process the appcast |
| 2030 |
will be downloaded and checked against the reference assembly. Ensure that |
| 2031 |
the calling process has read access to the reference assembly. |
| 2032 |
This method is also called from the background loops. |
| 2033 |
</summary>
|
| 2034 |
<param name="config">the NetSparkle configuration for the reference assembly</param> |
| 2035 |
<returns><see cref="T:NetSparkleUpdater.UpdateInfo"/> with information on whether there is an update available or not.</returns> |
| 2036 |
</member>
|
| 2037 |
<member name="M:NetSparkleUpdater.SparkleUpdater.ShowUpdateNeededUI(System.Collections.Generic.List{NetSparkleUpdater.AppCastItem},System.Boolean)"> |
| 2038 |
<summary>
|
| 2039 |
Shows the update needed UI with the given set of updates. |
| 2040 |
</summary>
|
| 2041 |
<param name="updates">updates to show UI for</param> |
| 2042 |
<param name="isUpdateAlreadyDownloaded">If true, make sure UI text shows that the user is about to install the file instead of download it.</param> |
| 2043 |
</member>
|
| 2044 |
<member name="M:NetSparkleUpdater.SparkleUpdater.ShowUpdateNeededUI(System.Boolean)"> |
| 2045 |
<summary>
|
| 2046 |
Shows the update UI with the latest downloaded update information. |
| 2047 |
</summary>
|
| 2048 |
<param name="isUpdateAlreadyDownloaded">If true, make sure UI text shows that the user is about to install the file instead of download it.</param> |
| 2049 |
</member>
|
| 2050 |
<member name="M:NetSparkleUpdater.SparkleUpdater.GetDownloadPathForAppCastItem(NetSparkleUpdater.AppCastItem)"> |
| 2051 |
<summary>
|
| 2052 |
Get the download path for a given app cast item. |
| 2053 |
If any directories need to be created, this function |
| 2054 |
will create those directories. |
| 2055 |
</summary>
|
| 2056 |
<param name="item">The item that you want to generate a download path for</param> |
| 2057 |
<returns>The download path for an app cast item if item is not null and has valid download link
|
| 2058 |
Otherwise returns null.</returns>
|
| 2059 |
</member>
|
| 2060 |
<member name="M:NetSparkleUpdater.SparkleUpdater.InitAndBeginDownload(NetSparkleUpdater.AppCastItem)"> |
| 2061 |
<summary>
|
| 2062 |
Starts the download process by grabbing the download path for |
| 2063 |
the app cast item (asynchronous so that it can get the server's |
| 2064 |
download name in case there is a redirect; cancel this by setting |
| 2065 |
CheckServerFileName to false), then beginning the download |
| 2066 |
process if the download file doesn't already exist |
| 2067 |
</summary>
|
| 2068 |
<param name="item">the appcast item to download</param> |
| 2069 |
</member>
|
| 2070 |
<member name="M:NetSparkleUpdater.SparkleUpdater.OnDownloadFinished(System.Object,System.ComponentModel.AsyncCompletedEventArgs)"> |
| 2071 |
<summary>
|
| 2072 |
Called when the installer is downloaded |
| 2073 |
</summary>
|
| 2074 |
<param name="sender">not used.</param> |
| 2075 |
<param name="e">used to determine if the download was successful.</param> |
| 2076 |
</member>
|
| 2077 |
<member name="M:NetSparkleUpdater.SparkleUpdater.InstallUpdate(NetSparkleUpdater.AppCastItem,System.String)"> |
| 2078 |
<summary>
|
| 2079 |
Run the provided app cast item update regardless of what else is going on. |
| 2080 |
Note that a more up to date download may be taking place, so if you don't |
| 2081 |
want to run a potentially out-of-date installer, don't use this. This should |
| 2082 |
only be used if your user wants to update before another update has been |
| 2083 |
installed AND the file is already downloaded. |
| 2084 |
This function will verify that the file exists and that the DSA |
| 2085 |
signature is valid before running. It will also utilize the |
| 2086 |
PreparingToExit event to ensure that the application can close. |
| 2087 |
</summary>
|
| 2088 |
<param name="item">AppCastItem to install</param> |
| 2089 |
<param name="installPath">Install path to the executable. If not provided, will ask the server for the download path.</param> |
| 2090 |
</member>
|
| 2091 |
<member name="M:NetSparkleUpdater.SparkleUpdater.IsDownloadingItem(NetSparkleUpdater.AppCastItem)"> |
| 2092 |
<summary>
|
| 2093 |
Checks to see |
| 2094 |
</summary>
|
| 2095 |
<param name="item"></param> |
| 2096 |
<returns></returns> |
| 2097 |
</member>
|
| 2098 |
<member name="M:NetSparkleUpdater.SparkleUpdater.IsDownloadingSilently"> |
| 2099 |
<summary>
|
| 2100 |
True if the user has silent updates enabled; false otherwise. |
| 2101 |
</summary>
|
| 2102 |
</member>
|
| 2103 |
<member name="M:NetSparkleUpdater.SparkleUpdater.DoExtensionsMatch(System.String,System.String)"> |
| 2104 |
<summary>
|
| 2105 |
Checks to see if two extensions match (this is basically just a |
| 2106 |
convenient string comparison). Both extensions should include the |
| 2107 |
initial . (full-stop/period) in the extension. |
| 2108 |
</summary>
|
| 2109 |
<param name="extension">first extension to check</param> |
| 2110 |
<param name="otherExtension">other extension to check</param> |
| 2111 |
<returns>true if the extensions match; false otherwise</returns> |
| 2112 |
</member>
|
| 2113 |
<member name="M:NetSparkleUpdater.SparkleUpdater.GetWindowsInstallerCommand(System.String)"> |
| 2114 |
<summary>
|
| 2115 |
Get the install command for the file at the given path. Figures out which |
| 2116 |
command to use based on the download file path's file extension. |
| 2117 |
Currently supports .exe, .msi, and .msp. |
| 2118 |
</summary>
|
| 2119 |
<param name="downloadFilePath">Path to the downloaded update file</param> |
| 2120 |
<returns>the installer command if the file has one of the given
|
| 2121 |
extensions; the initial downloadFilePath if not.</returns>
|
| 2122 |
</member>
|
| 2123 |
<member name="M:NetSparkleUpdater.SparkleUpdater.GetInstallerCommand(System.String)"> |
| 2124 |
<summary>
|
| 2125 |
Get the install command for the file at the given path. Figures out which |
| 2126 |
command to use based on the download file path's file extension. |
| 2127 |
<para>Windows: currently supports .exe, .msi, and .msp.</para> |
| 2128 |
<para>macOS: currently supports .pkg, .dmg, and .zip.</para> |
| 2129 |
<para>Linux: currently supports .tar.gz, .deb, and .rpm.</para> |
| 2130 |
</summary>
|
| 2131 |
<param name="downloadFilePath">Path to the downloaded update file</param> |
| 2132 |
<returns>the installer command if the file has one of the given
|
| 2133 |
extensions; the initial downloadFilePath if not.</returns>
|
| 2134 |
</member>
|
| 2135 |
<member name="M:NetSparkleUpdater.SparkleUpdater.RunDownloadedInstaller(System.String)"> |
| 2136 |
<summary>
|
| 2137 |
Updates the application via the file at the given path. Figures out which command needs |
| 2138 |
to be run, sets up the application so that it will start the downloaded file once the |
| 2139 |
main application stops, and then waits to start the downloaded update. |
| 2140 |
</summary>
|
| 2141 |
<param name="downloadFilePath">path to the downloaded installer/updater</param> |
| 2142 |
<returns>the awaitable <see cref="T:System.Threading.Tasks.Task"/> for the application quitting</returns> |
| 2143 |
</member>
|
| 2144 |
<member name="M:NetSparkleUpdater.SparkleUpdater.QuitApplication"> |
| 2145 |
<summary>
|
| 2146 |
Quits the application (host application) |
| 2147 |
</summary>
|
| 2148 |
<returns>Runs asynchrously, so returns a Task</returns> |
| 2149 |
</member>
|
| 2150 |
<member name="M:NetSparkleUpdater.SparkleUpdater.AskApplicationToSafelyCloseUp"> |
| 2151 |
<summary>
|
| 2152 |
Apps may need, for example, to let user save their work |
| 2153 |
</summary>
|
| 2154 |
<returns>true if it's OK to run the installer</returns> |
| 2155 |
</member>
|
| 2156 |
<member name="M:NetSparkleUpdater.SparkleUpdater.CheckForUpdatesAtUserRequest"> |
| 2157 |
<summary>
|
| 2158 |
Check for updates, using UI interaction appropriate for if the user initiated the update request |
| 2159 |
</summary>
|
| 2160 |
</member>
|
| 2161 |
<member name="M:NetSparkleUpdater.SparkleUpdater.CheckForUpdatesQuietly"> |
| 2162 |
<summary>
|
| 2163 |
Check for updates, using interaction appropriate for where the user doesn't know you're doing it, so be polite. |
| 2164 |
Basically, this checks for updates without showing a UI. However, if a UIFactory is set and an update |
| 2165 |
is found, an update UI will be shown! |
| 2166 |
</summary>
|
| 2167 |
</member>
|
| 2168 |
<member name="M:NetSparkleUpdater.SparkleUpdater.CheckForUpdates"> |
| 2169 |
<summary>
|
| 2170 |
Does a one-off check for updates |
| 2171 |
</summary>
|
| 2172 |
</member>
|
| 2173 |
<member name="M:NetSparkleUpdater.SparkleUpdater.CancelFileDownload"> |
| 2174 |
<summary>
|
| 2175 |
Cancels an in-progress download and deletes the temporary file. |
| 2176 |
</summary>
|
| 2177 |
</member>
|
| 2178 |
<member name="M:NetSparkleUpdater.SparkleUpdater.CallFuncConsideringUIThreads(System.Action)"> |
| 2179 |
<summary>
|
| 2180 |
Events should always be fired on the thread that started the Sparkle object. |
| 2181 |
Used for events that are fired after coming from an update available window |
| 2182 |
or the download progress window. |
| 2183 |
Basically, if ShowsUIOnMainThread, just invokes the action. Otherwise, |
| 2184 |
uses the SynchronizationContext to call the action. Ensures that the action |
| 2185 |
is always on the main thread. |
| 2186 |
</summary>
|
| 2187 |
<param name="action"></param> |
| 2188 |
</member>
|
| 2189 |
<member name="M:NetSparkleUpdater.SparkleUpdater.CallFuncConsideringUIThreadsAsync(System.Func{System.Threading.Tasks.Task})"> |
| 2190 |
<summary>
|
| 2191 |
Events should always be fired on the thread that started the Sparkle object. |
| 2192 |
Used for events that are fired after coming from an update available window |
| 2193 |
or the download progress window. |
| 2194 |
Basically, if ShowsUIOnMainThread, just invokes the action. Otherwise, |
| 2195 |
uses the SynchronizationContext to call the action. Ensures that the action |
| 2196 |
is always on the main thread. |
| 2197 |
</summary>
|
| 2198 |
<param name="action"></param> |
| 2199 |
</member>
|
| 2200 |
<member name="M:NetSparkleUpdater.SparkleUpdater.OnUserWindowUserResponded(System.Object,NetSparkleUpdater.Events.UpdateResponseEventArgs)"> |
| 2201 |
<summary>
|
| 2202 |
</summary>
|
| 2203 |
<param name="sender">not used.</param> |
| 2204 |
<param name="args">Info on the user response and what update item they responded to</param> |
| 2205 |
</member>
|
| 2206 |
<member name="M:NetSparkleUpdater.SparkleUpdater.OnWorkerDoWork(System.Object,System.ComponentModel.DoWorkEventArgs)"> |
| 2207 |
<summary>
|
| 2208 |
This method will be executed as worker thread |
| 2209 |
</summary>
|
| 2210 |
</member>
|
| 2211 |
<member name="M:NetSparkleUpdater.SparkleUpdater.OnWorkerProgressChanged(System.Object,System.ComponentModel.ProgressChangedEventArgs)"> |
| 2212 |
<summary>
|
| 2213 |
This method will be notified by the SparkleUpdater loop when |
| 2214 |
some update info has been downloaded. If the info has been |
| 2215 |
downloaded fully (e.ProgressPercentage == 1), the UI |
| 2216 |
for downloading updates will be shown (if not downloading silently) |
| 2217 |
or the download will be performed (if downloading silently). |
| 2218 |
</summary>
|
| 2219 |
</member>
|
| 2220 |
<member name="M:NetSparkleUpdater.SparkleUpdater.UpdatesHaveBeenDownloaded(System.Collections.Generic.List{NetSparkleUpdater.AppCastItem})"> |
| 2221 |
<summary>
|
| 2222 |
Updates from appcast have been downloaded from the server |
| 2223 |
</summary>
|
| 2224 |
<param name="updates">updates to be installed</param> |
| 2225 |
</member>
|
| 2226 |
<member name="E:NetSparkleUpdater.SparkleUpdater.LoopStarted"> |
| 2227 |
<summary>
|
| 2228 |
This event will be raised when a check loop will be started |
| 2229 |
</summary>
|
| 2230 |
</member>
|
| 2231 |
<member name="E:NetSparkleUpdater.SparkleUpdater.LoopFinished"> |
| 2232 |
<summary>
|
| 2233 |
This event will be raised when a check loop is finished |
| 2234 |
</summary>
|
| 2235 |
</member>
|
| 2236 |
<member name="E:NetSparkleUpdater.SparkleUpdater.UpdateCheckStarted"> |
| 2237 |
<summary>
|
| 2238 |
Called when update check has just started |
| 2239 |
</summary>
|
| 2240 |
</member>
|
| 2241 |
<member name="E:NetSparkleUpdater.SparkleUpdater.UpdateDetected"> |
| 2242 |
<summary>
|
| 2243 |
This event can be used to override the standard user interface |
| 2244 |
process when an update is detected |
| 2245 |
</summary>
|
| 2246 |
</member>
|
| 2247 |
<member name="E:NetSparkleUpdater.SparkleUpdater.UpdateCheckFinished"> |
| 2248 |
<summary>
|
| 2249 |
Called when update check is all done. May or may not have called <see cref="E:NetSparkleUpdater.SparkleUpdater.UpdateDetected"/> in the middle. |
| 2250 |
</summary>
|
| 2251 |
</member>
|
| 2252 |
<member name="E:NetSparkleUpdater.SparkleUpdater.UserRespondedToUpdate"> |
| 2253 |
<summary>
|
| 2254 |
The user responded to the update UI with a given response. |
| 2255 |
This is called _after_ NetSparkle handles the response in all cases EXCEPT |
| 2256 |
when the result is UpdateAvailableResult.InstallUpdate -- in that case, this |
| 2257 |
event is called BEFORE downloading the update begins. |
| 2258 |
</summary>
|
| 2259 |
</member>
|
| 2260 |
<member name="E:NetSparkleUpdater.SparkleUpdater.DownloadStarted"> |
| 2261 |
<summary>
|
| 2262 |
Called when the download has just started |
| 2263 |
</summary>
|
| 2264 |
</member>
|
| 2265 |
<member name="E:NetSparkleUpdater.SparkleUpdater.DownloadCanceled"> |
| 2266 |
<summary>
|
| 2267 |
Called when the download has been canceled |
| 2268 |
</summary>
|
| 2269 |
</member>
|
| 2270 |
<member name="E:NetSparkleUpdater.SparkleUpdater.DownloadHadError"> |
| 2271 |
<summary>
|
| 2272 |
Called when the download has downloaded but has an error other than corruption |
| 2273 |
</summary>
|
| 2274 |
</member>
|
| 2275 |
<member name="E:NetSparkleUpdater.SparkleUpdater.DownloadMadeProgress"> |
| 2276 |
<summary>
|
| 2277 |
Called when the download has made some progress. Also sent to the progress window |
| 2278 |
if one is available. |
| 2279 |
</summary>
|
| 2280 |
</member>
|
| 2281 |
<member name="E:NetSparkleUpdater.SparkleUpdater.DownloadFinished"> |
| 2282 |
<summary>
|
| 2283 |
Called when the downloaded file is fully downloaded and verified regardless of the value for |
| 2284 |
SilentMode. Note that if you are installing fully silently, this will be called before the |
| 2285 |
install file is executed, so don't manually initiate the file or anything. Useful when using |
| 2286 |
SilentModeTypes.DownloadNoInstall so you can let your user know when the downloaded |
| 2287 |
update is ready. |
| 2288 |
</summary>
|
| 2289 |
</member>
|
| 2290 |
<member name="E:NetSparkleUpdater.SparkleUpdater.DownloadedFileIsCorrupt"> |
| 2291 |
<summary>
|
| 2292 |
Called when the downloaded file is already downloaded (or at least partially on disk) and the DSA |
| 2293 |
signature doesn't match. When this is called, Sparkle is not taking any further action to |
| 2294 |
try to download the install file during this instance of the software. In order to make Sparkle |
| 2295 |
try again, you must delete the file off disk yourself. Sparkle will try again after the software |
| 2296 |
is restarted. This event could allow you to tell the user what happened if updates are silent. |
| 2297 |
</summary>
|
| 2298 |
</member>
|
| 2299 |
<member name="E:NetSparkleUpdater.SparkleUpdater.PreparingToExit"> |
| 2300 |
<summary>
|
| 2301 |
Subscribe to this to get a chance to shut down gracefully before quitting. |
| 2302 |
If <see cref="E:NetSparkleUpdater.SparkleUpdater.PreparingToExitAsync"/> is set, this has no effect. |
| 2303 |
</summary>
|
| 2304 |
</member>
|
| 2305 |
<member name="E:NetSparkleUpdater.SparkleUpdater.PreparingToExitAsync"> |
| 2306 |
<summary>
|
| 2307 |
Subscribe to this to get a chance to asynchronously shut down gracefully before quitting. |
| 2308 |
This overrides <see cref="E:NetSparkleUpdater.SparkleUpdater.PreparingToExit"/>. |
| 2309 |
</summary>
|
| 2310 |
</member>
|
| 2311 |
<member name="E:NetSparkleUpdater.SparkleUpdater.CloseApplication"> |
| 2312 |
<summary>
|
| 2313 |
Event for custom shutdown logic. If this is set, it is called instead of |
| 2314 |
Application.Current.Shutdown or Application.Exit. |
| 2315 |
If <see cref="E:NetSparkleUpdater.SparkleUpdater.CloseApplicationAsync"/> is set, this has no effect. |
| 2316 |
<para>Warning: The script that launches your executable only waits for 90 seconds before
|
| 2317 |
giving up! Make sure that your software closes within 90 seconds if you implement this event! |
| 2318 |
If you need an event that can be canceled, use <see cref="E:NetSparkleUpdater.SparkleUpdater.PreparingToExit"/>.</para> |
| 2319 |
</summary>
|
| 2320 |
</member>
|
| 2321 |
<member name="E:NetSparkleUpdater.SparkleUpdater.CloseApplicationAsync"> |
| 2322 |
<summary>
|
| 2323 |
Event for asynchronous custom shutdown logic. If this is set, it is called instead of |
| 2324 |
Application.Current.Shutdown or Application.Exit. |
| 2325 |
This overrides <see cref="E:NetSparkleUpdater.SparkleUpdater.CloseApplication"/>. |
| 2326 |
<para>Warning: The script that launches your executable only waits for 90 seconds before
|
| 2327 |
giving up! Make sure that your software closes within 90 seconds if you implement this event! |
| 2328 |
If you need an event that can be canceled, use <see cref="E:NetSparkleUpdater.SparkleUpdater.PreparingToExitAsync"/>.</para> |
| 2329 |
</summary>
|
| 2330 |
</member>
|
| 2331 |
<member name="T:NetSparkleUpdater.UpdateInfo"> |
| 2332 |
<summary>
|
| 2333 |
A simple class to hold information on potential updates to a software product. |
| 2334 |
</summary>
|
| 2335 |
</member>
|
| 2336 |
<member name="P:NetSparkleUpdater.UpdateInfo.Status"> |
| 2337 |
<summary>
|
| 2338 |
Update availability. |
| 2339 |
</summary>
|
| 2340 |
</member>
|
| 2341 |
<member name="P:NetSparkleUpdater.UpdateInfo.Updates"> |
| 2342 |
<summary>
|
| 2343 |
Any available updates for the product. |
| 2344 |
</summary>
|
| 2345 |
</member>
|
| 2346 |
<member name="M:NetSparkleUpdater.UpdateInfo.#ctor(NetSparkleUpdater.Enums.UpdateStatus,System.Collections.Generic.List{NetSparkleUpdater.AppCastItem})"> |
| 2347 |
<summary>
|
| 2348 |
Constructor for SparkleUpdate when there are some updates available. |
| 2349 |
</summary>
|
| 2350 |
</member>
|
| 2351 |
<member name="M:NetSparkleUpdater.UpdateInfo.#ctor(NetSparkleUpdater.Enums.UpdateStatus)"> |
| 2352 |
<summary>
|
| 2353 |
Constructor for SparkleUpdate for when there aren't any updates available. Updates are automatically set to null. |
| 2354 |
</summary>
|
| 2355 |
</member>
|
| 2356 |
<member name="T:NetSparkleUpdater.Utilities"> |
| 2357 |
<summary>
|
| 2358 |
Provides commonly used utility functions. |
| 2359 |
</summary>
|
| 2360 |
</member>
|
| 2361 |
<member name="M:NetSparkleUpdater.Utilities.GetVersionString(System.Version)"> |
| 2362 |
<summary>
|
| 2363 |
Removes trailing 0 components from the given version. |
| 2364 |
</summary>
|
| 2365 |
<param name="version">Version object</param> |
| 2366 |
<returns>Version string</returns> |
| 2367 |
</member>
|
| 2368 |
<member name="M:NetSparkleUpdater.Utilities.GetDSASignature(System.String,System.String)"> |
| 2369 |
<summary>
|
| 2370 |
Gets the signature of a file with the given DSA private key. |
| 2371 |
</summary>
|
| 2372 |
<param name="fileToSignPath">Path to the file you want to sign</param> |
| 2373 |
<param name="privateKeyFilePath">Path to the private key file</param> |
| 2374 |
<returns>DSA signature as base64 string</returns> |
| 2375 |
</member>
|
| 2376 |
<member name="M:NetSparkleUpdater.Utilities.GetAbsoluteURL(System.String,System.String)"> |
| 2377 |
<summary>
|
| 2378 |
Creates a <see cref="T:System.Uri"/> from a URL string. If the URL is relative, converts it to an absolute URL based on the appcast URL. |
| 2379 |
</summary>
|
| 2380 |
<param name="url">relative or absolute URL</param> |
| 2381 |
<param name="appcastURL">URL to appcast</param> |
| 2382 |
</member>
|
| 2383 |
<member name="M:NetSparkleUpdater.Utilities.ConvertNumBytesToUserReadableString(System.Int64)"> |
| 2384 |
<summary>
|
| 2385 |
Convert a number of bytes to a user-readable string |
| 2386 |
</summary>
|
| 2387 |
<param name="numBytes">Number of bytes to convert</param> |
| 2388 |
<returns>A string that represents the number of bytes in KB, MB, or GB if numBytes > 1024. |
| 2389 |
If numBytes is less than 1024, returns numBytes.</returns>
|
| 2390 |
</member>
|
| 2391 |
<member name="M:NetSparkleUpdater.Utilities.GetFullBaseDirectory"> |
| 2392 |
<summary>
|
| 2393 |
Get the full base (running) directory for this application including a trailing slash. |
| 2394 |
From WalletWasabi: |
| 2395 |
https://github.com/zkSNACKs/WalletWasabi/blob/8d42bce976605cca3326ea6c998b2294494900e6/WalletWasabi/Helpers/EnvironmentHelpers.cs |
| 2396 |
</summary>
|
| 2397 |
<returns>the full running directory path including trailing slash for this application</returns> |
| 2398 |
</member>
|
| 2399 |
<member name="M:NetSparkleUpdater.Utilities.ConvertStreamToByteArray(System.IO.Stream)"> |
| 2400 |
<summary>
|
| 2401 |
Convert a given <see cref="T:System.IO.Stream"/> to a byte array |
| 2402 |
</summary>
|
| 2403 |
<param name="stream">the <see cref="T:System.IO.Stream"/> to convert</param> |
| 2404 |
<returns>a byte[] array of the data in the given stream</returns> |
| 2405 |
</member>
|
| 2406 |
<member name="M:NetSparkleUpdater.Utilities.IsSignatureNeeded(NetSparkleUpdater.Enums.SecurityMode,System.Boolean,System.Boolean)"> |
| 2407 |
<summary>
|
| 2408 |
Checks to see whether a signature is ncessary given the provided |
| 2409 |
info on the <see cref="T:NetSparkleUpdater.Enums.SecurityMode"/> and whether or not valid |
| 2410 |
key information exists at the moment. |
| 2411 |
</summary>
|
| 2412 |
<param name="securityMode">the <see cref="T:NetSparkleUpdater.Enums.SecurityMode"/> for the signature check</param> |
| 2413 |
<param name="doesKeyInfoExist">true if the application has appropriate key |
| 2414 |
information in order to run signature checks; false otherwise</param>
|
| 2415 |
<param name="isCheckingSoftwareDownload">True if the caller is checking on the signature of a software |
| 2416 |
download; false if the caller is checking on the signature of something else (e.g. release notes, |
| 2417 |
app cast)</param>
|
| 2418 |
<returns>true if an item's signature needs to be checked; false otherwise</returns> |
| 2419 |
</member>
|
| 2420 |
<member name="T:MarkdownSharp.MarkdownOptions"> |
| 2421 |
<summary>
|
| 2422 |
|
| 2423 |
</summary>
|
| 2424 |
</member>
|
| 2425 |
<member name="P:MarkdownSharp.MarkdownOptions.AutoHyperlink"> |
| 2426 |
<summary>
|
| 2427 |
when true, (most) bare plain URLs are auto-hyperlinked |
| 2428 |
WARNING: this is a significant deviation from the markdown spec |
| 2429 |
</summary>
|
| 2430 |
</member>
|
| 2431 |
<member name="P:MarkdownSharp.MarkdownOptions.AutoNewlines"> |
| 2432 |
<summary>
|
| 2433 |
when true, RETURN becomes a literal newline |
| 2434 |
WARNING: this is a significant deviation from the markdown spec |
| 2435 |
</summary>
|
| 2436 |
</member>
|
| 2437 |
<member name="P:MarkdownSharp.MarkdownOptions.EmptyElementSuffix"> |
| 2438 |
<summary>
|
| 2439 |
use ">" for HTML output, or " />" for XHTML output |
| 2440 |
</summary>
|
| 2441 |
</member>
|
| 2442 |
<member name="P:MarkdownSharp.MarkdownOptions.EncodeProblemUrlCharacters"> |
| 2443 |
<summary>
|
| 2444 |
when true, problematic URL characters like [, ], (, and so forth will be encoded |
| 2445 |
WARNING: this is a significant deviation from the markdown spec |
| 2446 |
</summary>
|
| 2447 |
</member>
|
| 2448 |
<member name="P:MarkdownSharp.MarkdownOptions.LinkEmails"> |
| 2449 |
<summary>
|
| 2450 |
when false, email addresses will never be auto-linked |
| 2451 |
WARNING: this is a significant deviation from the markdown spec |
| 2452 |
</summary>
|
| 2453 |
</member>
|
| 2454 |
<member name="P:MarkdownSharp.MarkdownOptions.StrictBoldItalic"> |
| 2455 |
<summary>
|
| 2456 |
when true, bold and italic require non-word characters on either side |
| 2457 |
WARNING: this is a significant deviation from the markdown spec |
| 2458 |
</summary>
|
| 2459 |
</member>
|
| 2460 |
<member name="T:MarkdownSharp.Markdown"> |
| 2461 |
<summary>
|
| 2462 |
Markdown is a text-to-HTML conversion tool for web writers. |
| 2463 |
Markdown allows you to write using an easy-to-read, easy-to-write plain text format, |
| 2464 |
then convert it to structurally valid XHTML (or HTML). |
| 2465 |
</summary>
|
| 2466 |
</member>
|
| 2467 |
<member name="M:MarkdownSharp.Markdown.#ctor"> |
| 2468 |
<summary>
|
| 2469 |
Create a new Markdown instance using default options |
| 2470 |
</summary>
|
| 2471 |
</member>
|
| 2472 |
<member name="M:MarkdownSharp.Markdown.#ctor(System.Boolean)"> |
| 2473 |
<summary>
|
| 2474 |
Create a new Markdown instance and optionally load options from a configuration |
| 2475 |
file. There they should be stored in the appSettings section, available options are: |
| 2476 |
|
| 2477 |
Markdown.StrictBoldItalic (true/false) |
| 2478 |
Markdown.EmptyElementSuffix (">" or " />" without the quotes)
|
| 2479 |
Markdown.LinkEmails (true/false) |
| 2480 |
Markdown.AutoNewLines (true/false) |
| 2481 |
Markdown.AutoHyperlink (true/false) |
| 2482 |
Markdown.EncodeProblemUrlCharacters (true/false) |
| 2483 |
|
| 2484 |
</summary>
|
| 2485 |
</member>
|
| 2486 |
<member name="M:MarkdownSharp.Markdown.#ctor(MarkdownSharp.MarkdownOptions)"> |
| 2487 |
<summary>
|
| 2488 |
Create a new Markdown instance and set the options from the MarkdownOptions object. |
| 2489 |
</summary>
|
| 2490 |
</member>
|
| 2491 |
<member name="P:MarkdownSharp.Markdown.EmptyElementSuffix"> |
| 2492 |
<summary>
|
| 2493 |
use ">" for HTML output, or " />" for XHTML output |
| 2494 |
</summary>
|
| 2495 |
</member>
|
| 2496 |
<member name="P:MarkdownSharp.Markdown.LinkEmails"> |
| 2497 |
<summary>
|
| 2498 |
when false, email addresses will never be auto-linked |
| 2499 |
WARNING: this is a significant deviation from the markdown spec |
| 2500 |
</summary>
|
| 2501 |
</member>
|
| 2502 |
<member name="P:MarkdownSharp.Markdown.StrictBoldItalic"> |
| 2503 |
<summary>
|
| 2504 |
when true, bold and italic require non-word characters on either side |
| 2505 |
WARNING: this is a significant deviation from the markdown spec |
| 2506 |
</summary>
|
| 2507 |
</member>
|
| 2508 |
<member name="P:MarkdownSharp.Markdown.AutoNewLines"> |
| 2509 |
<summary>
|
| 2510 |
when true, RETURN becomes a literal newline |
| 2511 |
WARNING: this is a significant deviation from the markdown spec |
| 2512 |
</summary>
|
| 2513 |
</member>
|
| 2514 |
<member name="P:MarkdownSharp.Markdown.AutoHyperlink"> |
| 2515 |
<summary>
|
| 2516 |
when true, (most) bare plain URLs are auto-hyperlinked |
| 2517 |
WARNING: this is a significant deviation from the markdown spec |
| 2518 |
</summary>
|
| 2519 |
</member>
|
| 2520 |
<member name="P:MarkdownSharp.Markdown.EncodeProblemUrlCharacters"> |
| 2521 |
<summary>
|
| 2522 |
when true, problematic URL characters like [, ], (, and so forth will be encoded |
| 2523 |
WARNING: this is a significant deviation from the markdown spec |
| 2524 |
</summary>
|
| 2525 |
</member>
|
| 2526 |
<member name="F:MarkdownSharp.Markdown._nestDepth"> |
| 2527 |
<summary>
|
| 2528 |
maximum nested depth of [] and () supported by the transform; implementation detail |
| 2529 |
</summary>
|
| 2530 |
</member>
|
| 2531 |
<member name="F:MarkdownSharp.Markdown._tabWidth"> |
| 2532 |
<summary>
|
| 2533 |
Tabs are automatically converted to spaces as part of the transform |
| 2534 |
this constant determines how "wide" those tabs become in spaces |
| 2535 |
</summary>
|
| 2536 |
</member>
|
| 2537 |
<member name="M:MarkdownSharp.Markdown.#cctor"> |
| 2538 |
<summary>
|
| 2539 |
In the static constuctor we'll initialize what stays the same across all transforms. |
| 2540 |
</summary>
|
| 2541 |
</member>
|
| 2542 |
<member name="P:MarkdownSharp.Markdown.Version"> |
| 2543 |
<summary>
|
| 2544 |
current version of MarkdownSharp; |
| 2545 |
see http://code.google.com/p/markdownsharp/ for the latest code or to contribute |
| 2546 |
</summary>
|
| 2547 |
</member>
|
| 2548 |
<member name="M:MarkdownSharp.Markdown.Transform(System.String)"> |
| 2549 |
<summary>
|
| 2550 |
Transforms the provided Markdown-formatted text to HTML; |
| 2551 |
see http://en.wikipedia.org/wiki/Markdown |
| 2552 |
</summary>
|
| 2553 |
<remarks>
|
| 2554 |
The order in which other subs are called here is |
| 2555 |
essential. Link and image substitutions need to happen before |
| 2556 |
EscapeSpecialChars(), so that any *'s or _'s in the a |
| 2557 |
and img tags get encoded. |
| 2558 |
</remarks>
|
| 2559 |
</member>
|
| 2560 |
<member name="M:MarkdownSharp.Markdown.RunBlockGamut(System.String,System.Boolean)"> |
| 2561 |
<summary>
|
| 2562 |
Perform transformations that form block-level tags like paragraphs, headers, and list items. |
| 2563 |
</summary>
|
| 2564 |
</member>
|
| 2565 |
<member name="M:MarkdownSharp.Markdown.RunSpanGamut(System.String)"> |
| 2566 |
<summary>
|
| 2567 |
Perform transformations that occur *within* block-level tags like paragraphs, headers, and list items. |
| 2568 |
</summary>
|
| 2569 |
</member>
|
| 2570 |
<member name="M:MarkdownSharp.Markdown.FormParagraphs(System.String,System.Boolean)"> |
| 2571 |
<summary>
|
| 2572 |
splits on two or more newlines, to form "paragraphs"; |
| 2573 |
each paragraph is then unhashed (if it is a hash and unhashing isn't turned off) or wrapped in HTML p tag |
| 2574 |
</summary>
|
| 2575 |
</member>
|
| 2576 |
<member name="M:MarkdownSharp.Markdown.GetNestedBracketsPattern"> |
| 2577 |
<summary>
|
| 2578 |
Reusable pattern to match balanced [brackets]. See Friedl's |
| 2579 |
"Mastering Regular Expressions", 2nd Ed., pp. 328-331. |
| 2580 |
</summary>
|
| 2581 |
</member>
|
| 2582 |
<member name="M:MarkdownSharp.Markdown.GetNestedParensPattern"> |
| 2583 |
<summary>
|
| 2584 |
Reusable pattern to match balanced (parens). See Friedl's |
| 2585 |
"Mastering Regular Expressions", 2nd Ed., pp. 328-331. |
| 2586 |
</summary>
|
| 2587 |
</member>
|
| 2588 |
<member name="M:MarkdownSharp.Markdown.StripLinkDefinitions(System.String)"> |
| 2589 |
<summary>
|
| 2590 |
Strips link definitions from text, stores the URLs and titles in hash references. |
| 2591 |
</summary>
|
| 2592 |
<remarks>
|
| 2593 |
^[id]: url "optional title" |
| 2594 |
</remarks>
|
| 2595 |
</member>
|
| 2596 |
<member name="M:MarkdownSharp.Markdown.GetBlockPattern"> |
| 2597 |
<summary>
|
| 2598 |
derived pretty much verbatim from PHP Markdown |
| 2599 |
</summary>
|
| 2600 |
</member>
|
| 2601 |
<member name="M:MarkdownSharp.Markdown.HashHTMLBlocks(System.String)"> |
| 2602 |
<summary>
|
| 2603 |
replaces any block-level HTML blocks with hash entries |
| 2604 |
</summary>
|
| 2605 |
</member>
|
| 2606 |
<member name="M:MarkdownSharp.Markdown.TokenizeHTML(System.String)"> |
| 2607 |
<summary>
|
| 2608 |
returns an array of HTML tokens comprising the input string. Each token is |
| 2609 |
either a tag (possibly with nested, tags contained therein, such |
| 2610 |
as <a href="<MTFoo>">, or a run of text between tags. Each element of the |
| 2611 |
array is a two-element array; the first is either 'tag' or 'text'; the second is |
| 2612 |
the actual value. |
| 2613 |
</summary>
|
| 2614 |
</member>
|
| 2615 |
<member name="M:MarkdownSharp.Markdown.DoAnchors(System.String)"> |
| 2616 |
<summary>
|
| 2617 |
Turn Markdown link shortcuts into HTML anchor tags |
| 2618 |
</summary>
|
| 2619 |
<remarks>
|
| 2620 |
[link text](url "title") |
| 2621 |
[link text][id] |
| 2622 |
[id] |
| 2623 |
</remarks>
|
| 2624 |
</member>
|
| 2625 |
<member name="M:MarkdownSharp.Markdown.DoImages(System.String)"> |
| 2626 |
<summary>
|
| 2627 |
Turn Markdown image shortcuts into HTML img tags. |
| 2628 |
</summary>
|
| 2629 |
<remarks>
|
| 2630 |
![alt text][id] |
| 2631 |
 |
| 2632 |
</remarks>
|
| 2633 |
</member>
|
| 2634 |
<member name="M:MarkdownSharp.Markdown.DoHeaders(System.String)"> |
| 2635 |
<summary>
|
| 2636 |
Turn Markdown headers into HTML header tags |
| 2637 |
</summary>
|
| 2638 |
<remarks>
|
| 2639 |
Header 1 |
| 2640 |
======== |
| 2641 |
|
| 2642 |
Header 2 |
| 2643 |
-------- |
| 2644 |
|
| 2645 |
# Header 1 |
| 2646 |
## Header 2 |
| 2647 |
## Header 2 with closing hashes ## |
| 2648 |
... |
| 2649 |
###### Header 6 |
| 2650 |
</remarks>
|
| 2651 |
</member>
|
| 2652 |
<member name="M:MarkdownSharp.Markdown.DoHorizontalRules(System.String)"> |
| 2653 |
<summary>
|
| 2654 |
Turn Markdown horizontal rules into HTML hr tags |
| 2655 |
</summary>
|
| 2656 |
<remarks>
|
| 2657 |
*** |
| 2658 |
* * * |
| 2659 |
--- |
| 2660 |
- - - |
| 2661 |
</remarks>
|
| 2662 |
</member>
|
| 2663 |
<member name="M:MarkdownSharp.Markdown.DoLists(System.String)"> |
| 2664 |
<summary>
|
| 2665 |
Turn Markdown lists into HTML ul and ol and li tags |
| 2666 |
</summary>
|
| 2667 |
</member>
|
| 2668 |
<member name="M:MarkdownSharp.Markdown.ProcessListItems(System.String,System.String)"> |
| 2669 |
<summary>
|
| 2670 |
Process the contents of a single ordered or unordered list, splitting it |
| 2671 |
into individual list items. |
| 2672 |
</summary>
|
| 2673 |
</member>
|
| 2674 |
<member name="M:MarkdownSharp.Markdown.DoCodeBlocks(System.String)"> |
| 2675 |
<summary>
|
| 2676 |
/// Turn Markdown 4-space indented code into HTML pre code blocks |
| 2677 |
</summary>
|
| 2678 |
</member>
|
| 2679 |
<member name="M:MarkdownSharp.Markdown.DoCodeSpans(System.String)"> |
| 2680 |
<summary>
|
| 2681 |
Turn Markdown `code spans` into HTML code tags |
| 2682 |
</summary>
|
| 2683 |
</member>
|
| 2684 |
<member name="M:MarkdownSharp.Markdown.DoItalicsAndBold(System.String)"> |
| 2685 |
<summary>
|
| 2686 |
Turn Markdown *italics* and **bold** into HTML strong and em tags |
| 2687 |
</summary>
|
| 2688 |
</member>
|
| 2689 |
<member name="M:MarkdownSharp.Markdown.DoHardBreaks(System.String)"> |
| 2690 |
<summary>
|
| 2691 |
Turn markdown line breaks (two space at end of line) into HTML break tags |
| 2692 |
</summary>
|
| 2693 |
</member>
|
| 2694 |
<member name="M:MarkdownSharp.Markdown.DoBlockQuotes(System.String)"> |
| 2695 |
<summary>
|
| 2696 |
Turn Markdown > quoted blocks into HTML blockquote blocks
|
| 2697 |
</summary>
|
| 2698 |
</member>
|
| 2699 |
<member name="M:MarkdownSharp.Markdown.DoAutoLinks(System.String)"> |
| 2700 |
<summary>
|
| 2701 |
Turn angle-delimited URLs into HTML anchor tags |
| 2702 |
</summary>
|
| 2703 |
<remarks>
|
| 2704 |
<http://www.example.com> |
| 2705 |
</remarks>
|
| 2706 |
</member>
|
| 2707 |
<member name="M:MarkdownSharp.Markdown.Outdent(System.String)"> |
| 2708 |
<summary>
|
| 2709 |
Remove one level of line-leading spaces |
| 2710 |
</summary>
|
| 2711 |
</member>
|
| 2712 |
<member name="M:MarkdownSharp.Markdown.EncodeEmailAddress(System.String)"> |
| 2713 |
<summary>
|
| 2714 |
encodes email address randomly |
| 2715 |
roughly 10% raw, 45% hex, 45% dec |
| 2716 |
note that @ is always encoded and : never is |
| 2717 |
</summary>
|
| 2718 |
</member>
|
| 2719 |
<member name="M:MarkdownSharp.Markdown.EncodeCode(System.String)"> |
| 2720 |
<summary>
|
| 2721 |
Encode/escape certain Markdown characters inside code blocks and spans where they are literals |
| 2722 |
</summary>
|
| 2723 |
</member>
|
| 2724 |
<member name="M:MarkdownSharp.Markdown.EncodeAmpsAndAngles(System.String)"> |
| 2725 |
<summary>
|
| 2726 |
Encode any ampersands (that aren't part of an HTML entity) and left or right angle brackets |
| 2727 |
</summary>
|
| 2728 |
</member>
|
| 2729 |
<member name="M:MarkdownSharp.Markdown.EscapeBackslashes(System.String)"> |
| 2730 |
<summary>
|
| 2731 |
Encodes any escaped characters such as \`, \*, \[ etc |
| 2732 |
</summary>
|
| 2733 |
</member>
|
| 2734 |
<member name="M:MarkdownSharp.Markdown.Unescape(System.String)"> |
| 2735 |
<summary>
|
| 2736 |
swap back in all the special characters we've hidden |
| 2737 |
</summary>
|
| 2738 |
</member>
|
| 2739 |
<member name="M:MarkdownSharp.Markdown.EscapeBoldItalic(System.String)"> |
| 2740 |
<summary>
|
| 2741 |
escapes Bold [ * ] and Italic [ _ ] characters |
| 2742 |
</summary>
|
| 2743 |
</member>
|
| 2744 |
<member name="M:MarkdownSharp.Markdown.EncodeProblemUrlChars(System.String)"> |
| 2745 |
<summary>
|
| 2746 |
hex-encodes some unusual "problem" chars in URLs to avoid URL detection problems |
| 2747 |
</summary>
|
| 2748 |
</member>
|
| 2749 |
<member name="M:MarkdownSharp.Markdown.EscapeSpecialCharsWithinTagAttributes(System.String)"> |
| 2750 |
<summary>
|
| 2751 |
Within tags -- meaning between < and > -- encode [\ ` * _] so they |
| 2752 |
don't conflict with their use in Markdown for code, italics and strong. |
| 2753 |
We're replacing each such character with its corresponding hash |
| 2754 |
value; this is likely overkill, but it should prevent us from colliding |
| 2755 |
with the escape values by accident. |
| 2756 |
</summary>
|
| 2757 |
</member>
|
| 2758 |
<member name="M:MarkdownSharp.Markdown.Normalize(System.String)"> |
| 2759 |
<summary>
|
| 2760 |
convert all tabs to _tabWidth spaces; |
| 2761 |
standardizes line endings from DOS (CR LF) or Mac (CR) to UNIX (LF); |
| 2762 |
makes sure text ends with a couple of newlines; |
| 2763 |
removes any blank lines (only spaces) in the text |
| 2764 |
</summary>
|
| 2765 |
</member>
|
| 2766 |
<member name="M:MarkdownSharp.Markdown.RepeatString(System.String,System.Int32)"> |
| 2767 |
<summary>
|
| 2768 |
this is to emulate what's evailable in PHP |
| 2769 |
</summary>
|
| 2770 |
</member>
|
| 2771 |
</members>
|
| 2772 |
</doc>
|
