Downloads:
2,455
Downloads of v 0.13.0:
142
Last Update:
09 Nov 2022
Package Maintainer(s):
Software Author(s):
- Patrik Svensson
- Mattias Karlsson
- Gary Ewan Park
- Alistair Chapman
- Martin Björkström
- Dave Glick
- Pascal Berger and contributors
Tags:
cake script build bakery- Software Specific:
- Software Site
- Software Source
- Software License
- Software Docs
- Software Issues
- Package Specific:
- Package Source
- Package outdated?
- Package broken?
- Contact Maintainers
- Contact Site Admins
- Software Vendor?
- Report Abuse
- Download
Cake-Bakery.Portable
This is not the latest version of Cake-Bakery.Portable available.
- 1
- 2
- 3
0.13.0 | Updated: 09 Nov 2022
- Software Specific:
- Software Site
- Software Source
- Software License
- Software Docs
- Software Issues
- Package Specific:
- Package Source
- Package outdated?
- Package broken?
- Contact Maintainers
- Contact Site Admins
- Software Vendor?
- Report Abuse
- Download
Downloads:
2,455
Downloads of v 0.13.0:
142
Maintainer(s):
Software Author(s):
- Patrik Svensson
- Mattias Karlsson
- Gary Ewan Park
- Alistair Chapman
- Martin Björkström
- Dave Glick
- Pascal Berger and contributors
Cake-Bakery.Portable 0.13.0
This is not the latest version of Cake-Bakery.Portable available.
- 1
- 2
- 3
Some Checks Have Failed or Are Not Yet Complete
Not All Tests Have Passed
Deployment Method: Individual Install, Upgrade, & Uninstall
To install Cake-Bakery.Portable, run the following command from the command line or from PowerShell:
To upgrade Cake-Bakery.Portable, run the following command from the command line or from PowerShell:
To uninstall Cake-Bakery.Portable, run the following command from the command line or from PowerShell:
Deployment Method:
This applies to both open source and commercial editions of Chocolatey.
1. Enter Your Internal Repository Url
(this should look similar to https://community.chocolatey.org/api/v2/)
2. Setup Your Environment
1. Ensure you are set for organizational deployment
Please see the organizational deployment guide
2. Get the package into your environment
Option 1: Cached Package (Unreliable, Requires Internet - Same As Community)-
Open Source or Commercial:
- Proxy Repository - Create a proxy nuget repository on Nexus, Artifactory Pro, or a proxy Chocolatey repository on ProGet. Point your upstream to https://community.chocolatey.org/api/v2/. Packages cache on first access automatically. Make sure your choco clients are using your proxy repository as a source and NOT the default community repository. See source command for more information.
- You can also just download the package and push it to a repository Download
-
Open Source
-
Download the package:
Download - Follow manual internalization instructions
-
-
Package Internalizer (C4B)
-
Run: (additional options)
choco download cake-bakery.portable --internalize --version=0.13.0 --source=https://community.chocolatey.org/api/v2/
-
For package and dependencies run:
choco push --source="'INTERNAL REPO URL'"
- Automate package internalization
-
Run: (additional options)
3. Copy Your Script
choco upgrade cake-bakery.portable -y --source="'INTERNAL REPO URL'" --version="'0.13.0'" [other options]
See options you can pass to upgrade.
See best practices for scripting.
Add this to a PowerShell script or use a Batch script with tools and in places where you are calling directly to Chocolatey. If you are integrating, keep in mind enhanced exit codes.
If you do use a PowerShell script, use the following to ensure bad exit codes are shown as failures:
choco upgrade cake-bakery.portable -y --source="'INTERNAL REPO URL'" --version="'0.13.0'"
$exitCode = $LASTEXITCODE
Write-Verbose "Exit code was $exitCode"
$validExitCodes = @(0, 1605, 1614, 1641, 3010)
if ($validExitCodes -contains $exitCode) {
Exit 0
}
Exit $exitCode
- name: Install cake-bakery.portable
win_chocolatey:
name: cake-bakery.portable
version: '0.13.0'
source: INTERNAL REPO URL
state: present
See docs at https://docs.ansible.com/ansible/latest/modules/win_chocolatey_module.html.
chocolatey_package 'cake-bakery.portable' do
action :install
source 'INTERNAL REPO URL'
version '0.13.0'
end
See docs at https://docs.chef.io/resource_chocolatey_package.html.
cChocoPackageInstaller cake-bakery.portable
{
Name = "cake-bakery.portable"
Version = "0.13.0"
Source = "INTERNAL REPO URL"
}
Requires cChoco DSC Resource. See docs at https://github.com/chocolatey/cChoco.
package { 'cake-bakery.portable':
ensure => '0.13.0',
provider => 'chocolatey',
source => 'INTERNAL REPO URL',
}
Requires Puppet Chocolatey Provider module. See docs at https://forge.puppet.com/puppetlabs/chocolatey.
4. If applicable - Chocolatey configuration/installation
See infrastructure management matrix for Chocolatey configuration elements and examples.
This package is likely a meta/virtual (*) or an installer (*.install) or portable (*.portable) application package.
- Meta/virtual (*) - has a dependency on the *.install or the *.portable package - it is provided for discoverability and for other packages to take a dependency on.
- Portable (*.portable/*.commandline (deprecated naming convention)/*.tool (deprecated naming convention)) - usually zips or archives that require no administrative access to install.
- Install (*.install/*.app (deprecated naming convention)) - uses native installers, usually requires administrative access to install.
Learn more about chocolatey's distinction of installed versus portable apps and/or learn about this kind of package.
This package was approved as a trusted package on 09 Nov 2022.
The Cake script analyzer and code generator.
md5: 6D8B9F5966D754064C978EF87ACE5367 | sha1: 678BDC7ABD5DC36F3548730ABFD580FA7ABFF0EE | sha256: BCAA3FC9040D2ACB8AA24CE3EE33BCE0C37C1134166861C69F2374EDF0A20711 | sha512: F9EE69B19111A84CCF10CE8322C828B8E884271D056857DC9C92DFED880CCA412B0861864A6C81B5DC73E0B1E30A75EF72C14D9A7233EBE2B69D1CACCE7F21B9
{
"runtimeTarget": {
"name": ".NETCoreApp,Version=v6.0",
"signature": ""
},
"compilationOptions": {},
"targets": {
".NETCoreApp,Version=v6.0": {
"Cake.Bakery/0.13.0": {
"dependencies": {
"Cake.Core": "3.0.0",
"Cake.NuGet": "3.0.0",
"Cake.Scripting": "0.13.0",
"Cake.Scripting.Abstractions": "0.13.0",
"Cake.Scripting.Transport": "0.13.0",
"Microsoft.Extensions.Logging": "7.0.0",
"Microsoft.NETFramework.ReferenceAssemblies": "1.0.3",
"Microsoft.SourceLink.GitHub": "1.1.1",
"StyleCop.Analyzers": "1.1.118"
},
"runtime": {
"Cake.Bakery.dll": {}
}
},
"Basic.Reference.Assemblies.Net60/1.4.1": {
"dependencies": {
"Microsoft.CodeAnalysis.Common": "3.9.0"
},
"runtime": {
"lib/netstandard2.0/Basic.Reference.Assemblies.Net60.dll": {
"assemblyVersion": "1.0.0.0",
"fileVersion": "1.0.0.0"
}
}
},
"Cake.Common/3.0.0": {
"dependencies": {
"Cake.Core": "3.0.0"
},
"runtime": {
"lib/net6.0/Cake.Common.dll": {
"assemblyVersion": "3.0.0.0",
"fileVersion": "3.0.0.0"
}
}
},
"Cake.Core/3.0.0": {
"dependencies": {
"Microsoft.CSharp": "4.7.0",
"Microsoft.Win32.Registry": "5.0.0"
},
"runtime": {
"lib/net6.0/Cake.Core.dll": {
"assemblyVersion": "3.0.0.0",
"fileVersion": "3.0.0.0"
}
}
},
"Cake.NuGet/3.0.0": {
"dependencies": {
"Cake.Core": "3.0.0",
"Newtonsoft.Json": "13.0.1",
"NuGet.Common": "6.3.1",
"NuGet.Frameworks": "6.3.1",
"NuGet.Packaging": "6.3.1",
"NuGet.Protocol": "6.3.1",
"NuGet.Resolver": "6.3.1",
"NuGet.Versioning": "6.3.1"
},
"runtime": {
"lib/net6.0/Cake.NuGet.dll": {
"assemblyVersion": "3.0.0.0",
"fileVersion": "3.0.0.0"
}
}
},
"Microsoft.Build.Tasks.Git/1.1.1": {},
"Microsoft.CodeAnalysis.Analyzers/3.0.0": {},
"Microsoft.CodeAnalysis.Common/3.9.0": {
"dependencies": {
"Microsoft.CodeAnalysis.Analyzers": "3.0.0",
"System.Collections.Immutable": "5.0.0",
"System.Memory": "4.5.4",
"System.Reflection.Metadata": "5.0.0",
"System.Runtime.CompilerServices.Unsafe": "6.0.0",
"System.Text.Encoding.CodePages": "4.5.1",
"System.Threading.Tasks.Extensions": "4.5.4"
},
"runtime": {
"lib/netcoreapp3.1/Microsoft.CodeAnalysis.dll": {
"assemblyVersion": "3.9.0.0",
"fileVersion": "3.900.21.12420"
}
},
"resources": {
"lib/netcoreapp3.1/cs/Microsoft.CodeAnalysis.resources.dll": {
"locale": "cs"
},
"lib/netcoreapp3.1/de/Microsoft.CodeAnalysis.resources.dll": {
"locale": "de"
},
"lib/netcoreapp3.1/es/Microsoft.CodeAnalysis.resources.dll": {
"locale": "es"
},
"lib/netcoreapp3.1/fr/Microsoft.CodeAnalysis.resources.dll": {
"locale": "fr"
},
"lib/netcoreapp3.1/it/Microsoft.CodeAnalysis.resources.dll": {
"locale": "it"
},
"lib/netcoreapp3.1/ja/Microsoft.CodeAnalysis.resources.dll": {
"locale": "ja"
},
"lib/netcoreapp3.1/ko/Microsoft.CodeAnalysis.resources.dll": {
"locale": "ko"
},
"lib/netcoreapp3.1/pl/Microsoft.CodeAnalysis.resources.dll": {
"locale": "pl"
},
"lib/netcoreapp3.1/pt-BR/Microsoft.CodeAnalysis.resources.dll": {
"locale": "pt-BR"
},
"lib/netcoreapp3.1/ru/Microsoft.CodeAnalysis.resources.dll": {
"locale": "ru"
},
"lib/netcoreapp3.1/tr/Microsoft.CodeAnalysis.resources.dll": {
"locale": "tr"
},
"lib/netcoreapp3.1/zh-Hans/Microsoft.CodeAnalysis.resources.dll": {
"locale": "zh-Hans"
},
"lib/netcoreapp3.1/zh-Hant/Microsoft.CodeAnalysis.resources.dll": {
"locale": "zh-Hant"
}
}
},
"Microsoft.CSharp/4.7.0": {},
"Microsoft.Extensions.DependencyInjection/7.0.0": {
"dependencies": {
"Microsoft.Extensions.DependencyInjection.Abstractions": "7.0.0"
},
"runtime": {
"lib/net6.0/Microsoft.Extensions.DependencyInjection.dll": {
"assemblyVersion": "7.0.0.0",
"fileVersion": "7.0.22.51805"
}
}
},
"Microsoft.Extensions.DependencyInjection.Abstractions/7.0.0": {
"runtime": {
"lib/net6.0/Microsoft.Extensions.DependencyInjection.Abstractions.dll": {
"assemblyVersion": "7.0.0.0",
"fileVersion": "7.0.22.51805"
}
}
},
"Microsoft.Extensions.Logging/7.0.0": {
"dependencies": {
"Microsoft.Extensions.DependencyInjection": "7.0.0",
"Microsoft.Extensions.DependencyInjection.Abstractions": "7.0.0",
"Microsoft.Extensions.Logging.Abstractions": "7.0.0",
"Microsoft.Extensions.Options": "7.0.0"
},
"runtime": {
"lib/net6.0/Microsoft.Extensions.Logging.dll": {
"assemblyVersion": "7.0.0.0",
"fileVersion": "7.0.22.51805"
}
}
},
"Microsoft.Extensions.Logging.Abstractions/7.0.0": {
"runtime": {
"lib/net6.0/Microsoft.Extensions.Logging.Abstractions.dll": {
"assemblyVersion": "7.0.0.0",
"fileVersion": "7.0.22.51805"
}
}
},
"Microsoft.Extensions.Options/7.0.0": {
"dependencies": {
"Microsoft.Extensions.DependencyInjection.Abstractions": "7.0.0",
"Microsoft.Extensions.Primitives": "7.0.0"
},
"runtime": {
"lib/net6.0/Microsoft.Extensions.Options.dll": {
"assemblyVersion": "7.0.0.0",
"fileVersion": "7.0.22.51805"
}
}
},
"Microsoft.Extensions.Primitives/7.0.0": {
"dependencies": {
"System.Runtime.CompilerServices.Unsafe": "6.0.0"
},
"runtime": {
"lib/net6.0/Microsoft.Extensions.Primitives.dll": {
"assemblyVersion": "7.0.0.0",
"fileVersion": "7.0.22.51805"
}
}
},
"Microsoft.NETCore.Platforms/5.0.0": {},
"Microsoft.NETFramework.ReferenceAssemblies/1.0.3": {
"dependencies": {
"Microsoft.NETFramework.ReferenceAssemblies.net461": "1.0.3"
}
},
"Microsoft.NETFramework.ReferenceAssemblies.net461/1.0.3": {},
"Microsoft.SourceLink.Common/1.1.1": {},
"Microsoft.SourceLink.GitHub/1.1.1": {
"dependencies": {
"Microsoft.Build.Tasks.Git": "1.1.1",
"Microsoft.SourceLink.Common": "1.1.1"
}
},
"Microsoft.Win32.Registry/5.0.0": {
"dependencies": {
"System.Security.AccessControl": "5.0.0",
"System.Security.Principal.Windows": "5.0.0"
}
},
"Mono.Cecil/0.11.4": {
"runtime": {
"lib/netstandard2.0/Mono.Cecil.Mdb.dll": {
"assemblyVersion": "0.11.4.0",
"fileVersion": "0.11.4.0"
},
"lib/netstandard2.0/Mono.Cecil.Pdb.dll": {
"assemblyVersion": "0.11.4.0",
"fileVersion": "0.11.4.0"
},
"lib/netstandard2.0/Mono.Cecil.Rocks.dll": {
"assemblyVersion": "0.11.4.0",
"fileVersion": "0.11.4.0"
},
"lib/netstandard2.0/Mono.Cecil.dll": {
"assemblyVersion": "0.11.4.0",
"fileVersion": "0.11.4.0"
}
}
},
"Newtonsoft.Json/13.0.1": {
"runtime": {
"lib/netstandard2.0/Newtonsoft.Json.dll": {
"assemblyVersion": "13.0.0.0",
"fileVersion": "13.0.1.25517"
}
}
},
"NuGet.Common/6.3.1": {
"dependencies": {
"NuGet.Frameworks": "6.3.1"
},
"runtime": {
"lib/netstandard2.0/NuGet.Common.dll": {
"assemblyVersion": "6.3.1.1",
"fileVersion": "6.3.1.1"
}
}
},
"NuGet.Configuration/6.3.1": {
"dependencies": {
"NuGet.Common": "6.3.1",
"System.Security.Cryptography.ProtectedData": "4.4.0"
},
"runtime": {
"lib/netstandard2.0/NuGet.Configuration.dll": {
"assemblyVersion": "6.3.1.1",
"fileVersion": "6.3.1.1"
}
}
},
"NuGet.Frameworks/6.3.1": {
"runtime": {
"lib/netstandard2.0/NuGet.Frameworks.dll": {
"assemblyVersion": "6.3.1.1",
"fileVersion": "6.3.1.1"
}
}
},
"NuGet.Packaging/6.3.1": {
"dependencies": {
"Newtonsoft.Json": "13.0.1",
"NuGet.Configuration": "6.3.1",
"NuGet.Versioning": "6.3.1",
"System.Security.Cryptography.Cng": "5.0.0",
"System.Security.Cryptography.Pkcs": "5.0.0"
},
"runtime": {
"lib/net5.0/NuGet.Packaging.dll": {
"assemblyVersion": "6.3.1.1",
"fileVersion": "6.3.1.1"
}
}
},
"NuGet.Protocol/6.3.1": {
"dependencies": {
"NuGet.Packaging": "6.3.1"
},
"runtime": {
"lib/net5.0/NuGet.Protocol.dll": {
"assemblyVersion": "6.3.1.1",
"fileVersion": "6.3.1.1"
}
}
},
"NuGet.Resolver/6.3.1": {
"dependencies": {
"NuGet.Protocol": "6.3.1"
},
"runtime": {
"lib/net5.0/NuGet.Resolver.dll": {
"assemblyVersion": "6.3.1.1",
"fileVersion": "6.3.1.1"
}
}
},
"NuGet.Versioning/6.3.1": {
"runtime": {
"lib/netstandard2.0/NuGet.Versioning.dll": {
"assemblyVersion": "6.3.1.1",
"fileVersion": "6.3.1.1"
}
}
},
"StyleCop.Analyzers/1.1.118": {},
"System.Collections.Immutable/5.0.0": {},
"System.Formats.Asn1/5.0.0": {},
"System.Memory/4.5.4": {},
"System.Reflection.Metadata/5.0.0": {},
"System.Runtime.CompilerServices.Unsafe/6.0.0": {},
"System.Security.AccessControl/5.0.0": {
"dependencies": {
"Microsoft.NETCore.Platforms": "5.0.0",
"System.Security.Principal.Windows": "5.0.0"
}
},
"System.Security.Cryptography.Cng/5.0.0": {
"dependencies": {
"System.Formats.Asn1": "5.0.0"
}
},
"System.Security.Cryptography.Pkcs/5.0.0": {
"dependencies": {
"System.Formats.Asn1": "5.0.0",
"System.Security.Cryptography.Cng": "5.0.0"
},
"runtime": {
"lib/netcoreapp3.0/System.Security.Cryptography.Pkcs.dll": {
"assemblyVersion": "5.0.0.0",
"fileVersion": "5.0.20.51904"
}
},
"runtimeTargets": {
"runtimes/win/lib/netcoreapp3.0/System.Security.Cryptography.Pkcs.dll": {
"rid": "win",
"assetType": "runtime",
"assemblyVersion": "5.0.0.0",
"fileVersion": "5.0.20.51904"
}
}
},
"System.Security.Cryptography.ProtectedData/4.4.0": {
"runtime": {
"lib/netstandard2.0/System.Security.Cryptography.ProtectedData.dll": {
"assemblyVersion": "4.0.2.0",
"fileVersion": "4.6.25519.3"
}
},
"runtimeTargets": {
"runtimes/win/lib/netstandard2.0/System.Security.Cryptography.ProtectedData.dll": {
"rid": "win",
"assetType": "runtime",
"assemblyVersion": "4.0.2.0",
"fileVersion": "4.6.25519.3"
}
}
},
"System.Security.Principal.Windows/5.0.0": {},
"System.Text.Encoding.CodePages/4.5.1": {
"dependencies": {
"Microsoft.NETCore.Platforms": "5.0.0",
"System.Runtime.CompilerServices.Unsafe": "6.0.0"
}
},
"System.Threading.Tasks.Extensions/4.5.4": {},
"Cake.Scripting/0.13.0": {
"dependencies": {
"Basic.Reference.Assemblies.Net60": "1.4.1",
"Cake.Common": "3.0.0",
"Cake.Core": "3.0.0",
"Cake.Scripting.Abstractions": "0.13.0",
"Mono.Cecil": "0.11.4"
},
"runtime": {
"Cake.Scripting.dll": {}
}
},
"Cake.Scripting.Abstractions/0.13.0": {
"runtime": {
"Cake.Scripting.Abstractions.dll": {}
}
},
"Cake.Scripting.Transport/0.13.0": {
"dependencies": {
"Cake.Scripting.Abstractions": "0.13.0",
"Microsoft.Extensions.Logging.Abstractions": "7.0.0"
},
"runtime": {
"Cake.Scripting.Transport.dll": {}
}
}
}
},
"libraries": {
"Cake.Bakery/0.13.0": {
"type": "project",
"serviceable": false,
"sha512": ""
},
"Basic.Reference.Assemblies.Net60/1.4.1": {
"type": "package",
"serviceable": true,
"sha512": "sha512-WysJzntzUCxVdq0AjDHHRMvP7eVo+xliN2iqkpYBIcrZI/wZD8grd7VW1yDkF7IxDJX4wsDhColArLJEhmDdEw==",
"path": "basic.reference.assemblies.net60/1.4.1",
"hashPath": "basic.reference.assemblies.net60.1.4.1.nupkg.sha512"
},
"Cake.Common/3.0.0": {
"type": "package",
"serviceable": true,
"sha512": "sha512-gs4/iOhCQTGH39TiYElQOt/VZx4E1Vq/IW2ePsxw5xQz5GKSzwv9dfqG7giHic9Wst7qZngFN7mzFCIvuG7e/Q==",
"path": "cake.common/3.0.0",
"hashPath": "cake.common.3.0.0.nupkg.sha512"
},
"Cake.Core/3.0.0": {
"type": "package",
"serviceable": true,
"sha512": "sha512-d1/NImObNEiTe1BLX16Rfi0KK3oCVIMvLbFzEy8xlTh9wDCI/yTDwLZ8YgjhOG32MpBm0WbVDsJklK6nFvBcQg==",
"path": "cake.core/3.0.0",
"hashPath": "cake.core.3.0.0.nupkg.sha512"
},
"Cake.NuGet/3.0.0": {
"type": "package",
"serviceable": true,
"sha512": "sha512-BBTVidyFbU3egGwAOdhNE3PZ3TYchOAXJdQnTkcBbUCrX0iTO+Vp1sDRKRCMPji9OxSNDUVlBAia1C2XnNJ/lw==",
"path": "cake.nuget/3.0.0",
"hashPath": "cake.nuget.3.0.0.nupkg.sha512"
},
"Microsoft.Build.Tasks.Git/1.1.1": {
"type": "package",
"serviceable": true,
"sha512": "sha512-AT3HlgTjsqHnWpBHSNeR0KxbLZD7bztlZVj7I8vgeYG9SYqbeFGh0TM/KVtC6fg53nrWHl3VfZFvb5BiQFcY6Q==",
"path": "microsoft.build.tasks.git/1.1.1",
"hashPath": "microsoft.build.tasks.git.1.1.1.nupkg.sha512"
},
"Microsoft.CodeAnalysis.Analyzers/3.0.0": {
"type": "package",
"serviceable": true,
"sha512": "sha512-ojG5pGAhTPmjxRGTNvuszO3H8XPZqksDwr9xLd4Ae/JBjZZdl6GuoLk7uLMf+o7yl5wO0TAqoWcEKkEWqrZE5g==",
"path": "microsoft.codeanalysis.analyzers/3.0.0",
"hashPath": "microsoft.codeanalysis.analyzers.3.0.0.nupkg.sha512"
},
"Microsoft.CodeAnalysis.Common/3.9.0": {
"type": "package",
"serviceable": true,
"sha512": "sha512-HiWjF7PNIEngmFg2Xk8cZ/83lRIRkk9v+5ibbY5B7VvjNGdClGAMuWtZER9F5rGRR41VbJLco9ah73jFTh4vPw==",
"path": "microsoft.codeanalysis.common/3.9.0",
"hashPath": "microsoft.codeanalysis.common.3.9.0.nupkg.sha512"
},
"Microsoft.CSharp/4.7.0": {
"type": "package",
"serviceable": true,
"sha512": "sha512-pTj+D3uJWyN3My70i2Hqo+OXixq3Os2D1nJ2x92FFo6sk8fYS1m1WLNTs0Dc1uPaViH0YvEEwvzddQ7y4rhXmA==",
"path": "microsoft.csharp/4.7.0",
"hashPath": "microsoft.csharp.4.7.0.nupkg.sha512"
},
"Microsoft.Extensions.DependencyInjection/7.0.0": {
"type": "package",
"serviceable": true,
"sha512": "sha512-elNeOmkeX3eDVG6pYVeV82p29hr+UKDaBhrZyWvWLw/EVZSYEkZlQdkp0V39k/Xehs2Qa0mvoCvkVj3eQxNQ1Q==",
"path": "microsoft.extensions.dependencyinjection/7.0.0",
"hashPath": "microsoft.extensions.dependencyinjection.7.0.0.nupkg.sha512"
},
"Microsoft.Extensions.DependencyInjection.Abstractions/7.0.0": {
"type": "package",
"serviceable": true,
"sha512": "sha512-h3j/QfmFN4S0w4C2A6X7arXij/M/OVw3uQHSOFxnND4DyAzO1F9eMX7Eti7lU/OkSthEE0WzRsfT/Dmx86jzCw==",
"path": "microsoft.extensions.dependencyinjection.abstractions/7.0.0",
"hashPath": "microsoft.extensions.dependencyinjection.abstractions.7.0.0.nupkg.sha512"
},
"Microsoft.Extensions.Logging/7.0.0": {
"type": "package",
"serviceable": true,
"sha512": "sha512-Nw2muoNrOG5U5qa2ZekXwudUn2BJcD41e65zwmDHb1fQegTX66UokLWZkJRpqSSHXDOWZ5V0iqhbxOEky91atA==",
"path": "microsoft.extensions.logging/7.0.0",
"hashPath": "microsoft.extensions.logging.7.0.0.nupkg.sha512"
},
"Microsoft.Extensions.Logging.Abstractions/7.0.0": {
"type": "package",
"serviceable": true,
"sha512": "sha512-kmn78+LPVMOWeITUjIlfxUPDsI0R6G0RkeAMBmQxAJ7vBJn4q2dTva7pWi65ceN5vPGjJ9q/Uae2WKgvfktJAw==",
"path": "microsoft.extensions.logging.abstractions/7.0.0",
"hashPath": "microsoft.extensions.logging.abstractions.7.0.0.nupkg.sha512"
},
"Microsoft.Extensions.Options/7.0.0": {
"type": "package",
"serviceable": true,
"sha512": "sha512-lP1yBnTTU42cKpMozuafbvNtQ7QcBjr/CcK3bYOGEMH55Fjt+iecXjT6chR7vbgCMqy3PG3aNQSZgo/EuY/9qQ==",
"path": "microsoft.extensions.options/7.0.0",
"hashPath": "microsoft.extensions.options.7.0.0.nupkg.sha512"
},
"Microsoft.Extensions.Primitives/7.0.0": {
"type": "package",
"serviceable": true,
"sha512": "sha512-um1KU5kxcRp3CNuI8o/GrZtD4AIOXDk+RLsytjZ9QPok3ttLUelLKpilVPuaFT3TFjOhSibUAso0odbOaCDj3Q==",
"path": "microsoft.extensions.primitives/7.0.0",
"hashPath": "microsoft.extensions.primitives.7.0.0.nupkg.sha512"
},
"Microsoft.NETCore.Platforms/5.0.0": {
"type": "package",
"serviceable": true,
"sha512": "sha512-VyPlqzH2wavqquTcYpkIIAQ6WdenuKoFN0BdYBbCWsclXacSOHNQn66Gt4z5NBqEYW0FAPm5rlvki9ZiCij5xQ==",
"path": "microsoft.netcore.platforms/5.0.0",
"hashPath": "microsoft.netcore.platforms.5.0.0.nupkg.sha512"
},
"Microsoft.NETFramework.ReferenceAssemblies/1.0.3": {
"type": "package",
"serviceable": true,
"sha512": "sha512-vUc9Npcs14QsyOD01tnv/m8sQUnGTGOw1BCmKcv77LBJY7OxhJ+zJF7UD/sCL3lYNFuqmQEVlkfS4Quif6FyYg==",
"path": "microsoft.netframework.referenceassemblies/1.0.3",
"hashPath": "microsoft.netframework.referenceassemblies.1.0.3.nupkg.sha512"
},
"Microsoft.NETFramework.ReferenceAssemblies.net461/1.0.3": {
"type": "package",
"serviceable": true,
"sha512": "sha512-AmOJZwCqnOCNp6PPcf9joyogScWLtwy0M1WkqfEQ0M9nYwyDD7EX9ZjscKS5iYnyvteX7kzSKFCKt9I9dXA6mA==",
"path": "microsoft.netframework.referenceassemblies.net461/1.0.3",
"hashPath": "microsoft.netframework.referenceassemblies.net461.1.0.3.nupkg.sha512"
},
"Microsoft.SourceLink.Common/1.1.1": {
"type": "package",
"serviceable": true,
"sha512": "sha512-WMcGpWKrmJmzrNeuaEb23bEMnbtR/vLmvZtkAP5qWu7vQsY59GqfRJd65sFpBszbd2k/bQ8cs8eWawQKAabkVg==",
"path": "microsoft.sourcelink.common/1.1.1",
"hashPath": "microsoft.sourcelink.common.1.1.1.nupkg.sha512"
},
"Microsoft.SourceLink.GitHub/1.1.1": {
"type": "package",
"serviceable": true,
"sha512": "sha512-IaJGnOv/M7UQjRJks7B6p7pbPnOwisYGOIzqCz5ilGFTApZ3ktOR+6zJ12ZRPInulBmdAf1SrGdDG2MU8g6XTw==",
"path": "microsoft.sourcelink.github/1.1.1",
"hashPath": "microsoft.sourcelink.github.1.1.1.nupkg.sha512"
},
"Microsoft.Win32.Registry/5.0.0": {
"type": "package",
"serviceable": true,
"sha512": "sha512-dDoKi0PnDz31yAyETfRntsLArTlVAVzUzCIvvEDsDsucrl33Dl8pIJG06ePTJTI3tGpeyHS9Cq7Foc/s4EeKcg==",
"path": "microsoft.win32.registry/5.0.0",
"hashPath": "microsoft.win32.registry.5.0.0.nupkg.sha512"
},
"Mono.Cecil/0.11.4": {
"type": "package",
"serviceable": true,
"sha512": "sha512-IC1h5g0NeJGHIUgzM1P82ld57knhP0IcQfrYITDPXlNpMYGUrsG5TxuaWTjaeqDNQMBDNZkB8L0rBnwsY6JHuQ==",
"path": "mono.cecil/0.11.4",
"hashPath": "mono.cecil.0.11.4.nupkg.sha512"
},
"Newtonsoft.Json/13.0.1": {
"type": "package",
"serviceable": true,
"sha512": "sha512-ppPFpBcvxdsfUonNcvITKqLl3bqxWbDCZIzDWHzjpdAHRFfZe0Dw9HmA0+za13IdyrgJwpkDTDA9fHaxOrt20A==",
"path": "newtonsoft.json/13.0.1",
"hashPath": "newtonsoft.json.13.0.1.nupkg.sha512"
},
"NuGet.Common/6.3.1": {
"type": "package",
"serviceable": true,
"sha512": "sha512-/WgxNyc9dXl+ZrQJDf5BXaqtMbl0CcDC5GEQITecbHZBQHApTMuxeTMMEqa0Y+PD1CIxTtbRY4jmotKS5dsLuA==",
"path": "nuget.common/6.3.1",
"hashPath": "nuget.common.6.3.1.nupkg.sha512"
},
"NuGet.Configuration/6.3.1": {
"type": "package",
"serviceable": true,
"sha512": "sha512-ja227AmXuDVgPXi3p2VTZFTYI/4xwwLSPYtd9Y9WIfCrRqSNDa96J5hm70wXhBCOQYvoRVDjp3ufgDnnqZ0bYA==",
"path": "nuget.configuration/6.3.1",
"hashPath": "nuget.configuration.6.3.1.nupkg.sha512"
},
"NuGet.Frameworks/6.3.1": {
"type": "package",
"serviceable": true,
"sha512": "sha512-Ae1vRjHDbNU7EQwQnDlxFRl+O9iQLp2H9Z/sRB/EAmO8+neUOeOfbkLClO7ZNcTcW5p1FDABrPakXICtQ0JCRw==",
"path": "nuget.frameworks/6.3.1",
"hashPath": "nuget.frameworks.6.3.1.nupkg.sha512"
},
"NuGet.Packaging/6.3.1": {
"type": "package",
"serviceable": true,
"sha512": "sha512-/GI2ujy3t00I8qFGvuLrVMNAEMFgEHfW+GNACZna2zgjADrxqrCeONStYZR2hHt3eI2/5HbiaoX4NCP17JCYzw==",
"path": "nuget.packaging/6.3.1",
"hashPath": "nuget.packaging.6.3.1.nupkg.sha512"
},
"NuGet.Protocol/6.3.1": {
"type": "package",
"serviceable": true,
"sha512": "sha512-1x3jozJNwoECAo88hrhYNuKkRrv9V2VoVxlCntpwr9jX5h6sTV3uHnXAN7vaVQ2/NRX9LLRIiD8K0NOTCG5EmQ==",
"path": "nuget.protocol/6.3.1",
"hashPath": "nuget.protocol.6.3.1.nupkg.sha512"
},
"NuGet.Resolver/6.3.1": {
"type": "package",
"serviceable": true,
"sha512": "sha512-MzEyVi4ObiRSPfb00OvfXdnTHVg11VdfXBhootJlAo3D2XJ1jSUYGS2WwFi+4lL1IreMUmAO12pjhbGsPg/QLA==",
"path": "nuget.resolver/6.3.1",
"hashPath": "nuget.resolver.6.3.1.nupkg.sha512"
},
"NuGet.Versioning/6.3.1": {
"type": "package",
"serviceable": true,
"sha512": "sha512-T/igBDLXCd+pH3YTWgGVNvYSOwbwaT30NyyM9ONjvlHlmaUjKBJpr9kH0AeL+Ado4EJsBhU3qxXVc6lyrpRcMw==",
"path": "nuget.versioning/6.3.1",
"hashPath": "nuget.versioning.6.3.1.nupkg.sha512"
},
"StyleCop.Analyzers/1.1.118": {
"type": "package",
"serviceable": true,
"sha512": "sha512-Onx6ovGSqXSK07n/0eM3ZusiNdB6cIlJdabQhWGgJp3Vooy9AaLS/tigeybOJAobqbtggTamoWndz72JscZBvw==",
"path": "stylecop.analyzers/1.1.118",
"hashPath": "stylecop.analyzers.1.1.118.nupkg.sha512"
},
"System.Collections.Immutable/5.0.0": {
"type": "package",
"serviceable": true,
"sha512": "sha512-FXkLXiK0sVVewcso0imKQoOxjoPAj42R8HtjjbSjVPAzwDfzoyoznWxgA3c38LDbN9SJux1xXoXYAhz98j7r2g==",
"path": "system.collections.immutable/5.0.0",
"hashPath": "system.collections.immutable.5.0.0.nupkg.sha512"
},
"System.Formats.Asn1/5.0.0": {
"type": "package",
"serviceable": true,
"sha512": "sha512-MTvUIktmemNB+El0Fgw9egyqT9AYSIk6DTJeoDSpc3GIHxHCMo8COqkWT1mptX5tZ1SlQ6HJZ0OsSvMth1c12w==",
"path": "system.formats.asn1/5.0.0",
"hashPath": "system.formats.asn1.5.0.0.nupkg.sha512"
},
"System.Memory/4.5.4": {
"type": "package",
"serviceable": true,
"sha512": "sha512-1MbJTHS1lZ4bS4FmsJjnuGJOu88ZzTT2rLvrhW7Ygic+pC0NWA+3hgAen0HRdsocuQXCkUTdFn9yHJJhsijDXw==",
"path": "system.memory/4.5.4",
"hashPath": "system.memory.4.5.4.nupkg.sha512"
},
"System.Reflection.Metadata/5.0.0": {
"type": "package",
"serviceable": true,
"sha512": "sha512-5NecZgXktdGg34rh1OenY1rFNDCI8xSjFr+Z4OU4cU06AQHUdRnIIEeWENu3Wl4YowbzkymAIMvi3WyK9U53pQ==",
"path": "system.reflection.metadata/5.0.0",
"hashPath": "system.reflection.metadata.5.0.0.nupkg.sha512"
},
"System.Runtime.CompilerServices.Unsafe/6.0.0": {
"type": "package",
"serviceable": true,
"sha512": "sha512-/iUeP3tq1S0XdNNoMz5C9twLSrM/TH+qElHkXWaPvuNOt+99G75NrV0OS2EqHx5wMN7popYjpc8oTjC1y16DLg==",
"path": "system.runtime.compilerservices.unsafe/6.0.0",
"hashPath": "system.runtime.compilerservices.unsafe.6.0.0.nupkg.sha512"
},
"System.Security.AccessControl/5.0.0": {
"type": "package",
"serviceable": true,
"sha512": "sha512-dagJ1mHZO3Ani8GH0PHpPEe/oYO+rVdbQjvjJkBRNQkX4t0r1iaeGn8+/ybkSLEan3/slM0t59SVdHzuHf2jmw==",
"path": "system.security.accesscontrol/5.0.0",
"hashPath": "system.security.accesscontrol.5.0.0.nupkg.sha512"
},
"System.Security.Cryptography.Cng/5.0.0": {
"type": "package",
"serviceable": true,
"sha512": "sha512-jIMXsKn94T9JY7PvPq/tMfqa6GAaHpElRDpmG+SuL+D3+sTw2M8VhnibKnN8Tq+4JqbPJ/f+BwtLeDMEnzAvRg==",
"path": "system.security.cryptography.cng/5.0.0",
"hashPath": "system.security.cryptography.cng.5.0.0.nupkg.sha512"
},
"System.Security.Cryptography.Pkcs/5.0.0": {
"type": "package",
"serviceable": true,
"sha512": "sha512-9TPLGjBCGKmNvG8pjwPeuYy0SMVmGZRwlTZvyPHDbYv/DRkoeumJdfumaaDNQzVGMEmbWtg07zUpSW9q70IlDQ==",
"path": "system.security.cryptography.pkcs/5.0.0",
"hashPath": "system.security.cryptography.pkcs.5.0.0.nupkg.sha512"
},
"System.Security.Cryptography.ProtectedData/4.4.0": {
"type": "package",
"serviceable": true,
"sha512": "sha512-cJV7ScGW7EhatRsjehfvvYVBvtiSMKgN8bOVI0bQhnF5bU7vnHVIsH49Kva7i7GWaWYvmEzkYVk1TC+gZYBEog==",
"path": "system.security.cryptography.protecteddata/4.4.0",
"hashPath": "system.security.cryptography.protecteddata.4.4.0.nupkg.sha512"
},
"System.Security.Principal.Windows/5.0.0": {
"type": "package",
"serviceable": true,
"sha512": "sha512-t0MGLukB5WAVU9bO3MGzvlGnyJPgUlcwerXn1kzBRjwLKixT96XV0Uza41W49gVd8zEMFu9vQEFlv0IOrytICA==",
"path": "system.security.principal.windows/5.0.0",
"hashPath": "system.security.principal.windows.5.0.0.nupkg.sha512"
},
"System.Text.Encoding.CodePages/4.5.1": {
"type": "package",
"serviceable": true,
"sha512": "sha512-4J2JQXbftjPMppIHJ7IC+VXQ9XfEagN92vZZNoG12i+zReYlim5dMoXFC1Zzg7tsnKDM7JPo5bYfFK4Jheq44w==",
"path": "system.text.encoding.codepages/4.5.1",
"hashPath": "system.text.encoding.codepages.4.5.1.nupkg.sha512"
},
"System.Threading.Tasks.Extensions/4.5.4": {
"type": "package",
"serviceable": true,
"sha512": "sha512-zteT+G8xuGu6mS+mzDzYXbzS7rd3K6Fjb9RiZlYlJPam2/hU7JCBZBVEcywNuR+oZ1ncTvc/cq0faRr3P01OVg==",
"path": "system.threading.tasks.extensions/4.5.4",
"hashPath": "system.threading.tasks.extensions.4.5.4.nupkg.sha512"
},
"Cake.Scripting/0.13.0": {
"type": "project",
"serviceable": false,
"sha512": ""
},
"Cake.Scripting.Abstractions/0.13.0": {
"type": "project",
"serviceable": false,
"sha512": ""
},
"Cake.Scripting.Transport/0.13.0": {
"type": "project",
"serviceable": false,
"sha512": ""
}
}
}
md5: 9B1ED292B6ED5664B312F6543C198866 | sha1: 7DD92A4CAB48AACDE46581CC0AE29FE989BC2173 | sha256: 0F41319F900FC87FFF8310BF20DF8AEC8EE6AF03163CF19AE5BBF3695F880595 | sha512: 17D2A71159128EA061265BE26A0EC69175F3A4816E74357DD0D3A717587D8537D8B7DBBCF0D97D6192F9395B3D13E1D80A52F1284975226654EE01E7EC0C1235
md5: 12FF2988D690C90281F5C40A0D04B808 | sha1: 453790682C17946B2BEFBED3BD25D3C3198B1C61 | sha256: 2CB0886E68A3270CD136FE01EE8688BB4FE4F1660D20A17C44CE02A75857FA5E | sha512: 99FE50EAACE24C65C7D868B6D4A16D901C183BBE8F05F15C46AADEE38B48EB88D6EEA92A60774DB9CE0E519A8F2FF6FAFBF316B6CCFEDDC203176CF8FBCAAF31
{
"runtimeOptions": {
"tfm": "net6.0",
"framework": {
"name": "Microsoft.NETCore.App",
"version": "6.0.0"
},
"configProperties": {
"System.Reflection.Metadata.MetadataUpdater.IsSupported": false
}
}
}
<?xml version="1.0"?>
<doc>
<assembly>
<name>Cake.Bakery</name>
</assembly>
<members>
</members>
</doc>
md5: 8B6FF5A84A55A243F8937E16B443A5E2 | sha1: 622B7E0665762673F2DBA70E168B134D4A269633 | sha256: B29998F8D87A727C58629967179E5A01095EBDFE5380D6F7A5023B064A5BDD6F | sha512: E0FB2B2712EDE91C067F46CA1D9AC8F9F0BB160F85620A85E11701C8E6E64EC732DC5AF850BB31FA584A1A7B51ADDA4CB7ACF98D0DC255EE11C84DA6E1F1CA12
<?xml version="1.0"?>
<doc>
<assembly>
<name>Cake.Common</name>
</assembly>
<members>
<member name="T:Cake.Common.ArgumentAliases">
<summary>
Contains functionality related to arguments.
</summary>
</member>
<member name="M:Cake.Common.ArgumentAliases.HasArgument(Cake.Core.ICakeContext,System.String)">
<summary>
Determines whether or not the specified argument exist.
</summary>
<param name="context">The context.</param>
<param name="name">The argument name.</param>
<returns>Whether or not the specified argument exist.</returns>
<example>
This sample shows how to call the <see cref="M:Cake.Common.ArgumentAliases.HasArgument(Cake.Core.ICakeContext,System.String)"/> method.
<code>
var argumentName = "myArgument";
// Cake.exe .\hasargument.cake -myArgument="is specified"
if (HasArgument(argumentName))
{
Information("{0} is specified", argumentName);
}
// Cake.exe .\hasargument.cake
else
{
Warning("{0} not specified", argumentName);
}
</code>
</example>
</member>
<member name="M:Cake.Common.ArgumentAliases.Argument``1(Cake.Core.ICakeContext,System.String)">
<summary>
Gets an argument and throws if the argument is missing.
</summary>
<typeparam name="T">The argument type.</typeparam>
<param name="context">The context.</param>
<param name="name">The argument name.</param>
<returns>The value of the argument.</returns>
<example>
<code>
// Cake.exe .\argument.cake --myArgument="is valid" --loopCount=5
Information("Argument {0}", Argument<string>("myArgument"));
var loopCount = Argument<int>("loopCount");
for(var index = 0;index<loopCount; index++)
{
Information("Index {0}", index);
}
</code>
</example>
<exception cref="T:Cake.Core.CakeException">Argument value is null.</exception>
<exception cref="T:System.ArgumentNullException"><paramref name="context"/> is null.</exception>
</member>
<member name="M:Cake.Common.ArgumentAliases.Arguments``1(Cake.Core.ICakeContext,System.String)">
<summary>
Gets all arguments with the specific name and throws if the argument is missing.
</summary>
<typeparam name="T">The argument type.</typeparam>
<param name="context">The context.</param>
<param name="name">The argument name.</param>
<returns>The argument values.</returns>
<example>
<code>
// Cake.exe .\argument.cake --foo="foo" --foo="bar"
var arguments = Arguments<string>("foo");
Information("Arguments: {0}", string.Join(", ", arguments));
</code>
</example>
</member>
<member name="M:Cake.Common.ArgumentAliases.Arguments``1(Cake.Core.ICakeContext,System.String,``0)">
<summary>
Gets all arguments with the specific name and returns the
provided <paramref name="defaultValue"/> if the argument is missing.
</summary>
<typeparam name="T">The argument type.</typeparam>
<param name="context">The context.</param>
<param name="name">The argument name.</param>
<param name="defaultValue">The value to return if the argument is missing.</param>
<returns>The argument values.</returns>
<example>
<code>
// Cake.exe .\argument.cake --foo="foo" --foo="bar"
var arguments = Arguments<string>("foo", "default");
Information("Arguments: {0}", string.Join(", ", arguments));
</code>
</example>
</member>
<member name="M:Cake.Common.ArgumentAliases.Arguments``1(Cake.Core.ICakeContext,System.String,System.Collections.Generic.ICollection{``0})">
<summary>
Gets all arguments with the specific name and returns the
provided <paramref name="defaultValues"/> if the argument is missing.
</summary>
<typeparam name="T">The argument type.</typeparam>
<param name="context">The context.</param>
<param name="name">The argument name.</param>
<param name="defaultValues">The values to return if the argument is missing.</param>
<returns>The argument values.</returns>
<example>
<code>
// Cake.exe .\argument.cake --foo="foo" --foo="bar"
var arguments = Arguments<string>("foo", new [] { "default" });
Information("Arguments: {0}", string.Join(", ", arguments));
</code>
</example>
</member>
<member name="M:Cake.Common.ArgumentAliases.Arguments``1(Cake.Core.ICakeContext,System.String,System.Func{Cake.Core.ICakeContext,System.Collections.Generic.ICollection{``0}})">
<summary>
Gets all arguments with the specific name, evaluates and returns the
provided <paramref name="defaultValues"/> if the argument is missing.
</summary>
<typeparam name="T">The argument type.</typeparam>
<param name="context">The context.</param>
<param name="name">The argument name.</param>
<param name="defaultValues">The values to return if the argument is missing.</param>
<returns>The argument values.</returns>
<example>
<code>
// Cake.exe .\argument.cake --foo="foo" --foo="bar"
var arguments = Arguments<string>("foo", ctx => new [] { "default" });
Information("Arguments: {0}", string.Join(", ", arguments));
</code>
</example>
</member>
<member name="M:Cake.Common.ArgumentAliases.Argument``1(Cake.Core.ICakeContext,System.String,``0)">
<summary>
Gets an argument and returns the provided <paramref name="defaultValue"/> if the argument is missing.
</summary>
<typeparam name="T">The argument type.</typeparam>
<param name="context">The context.</param>
<param name="name">The argument name.</param>
<param name="defaultValue">The value to return if the argument is missing.</param>
<returns>The value of the argument if it exist; otherwise <paramref name="defaultValue"/>.</returns>
<example>
<code>
// Cake.exe .\argument.cake --myArgument="is valid" --loopCount=5
Information("Argument {0}", Argument<string>("myArgument", "is NOT valid"));
var loopCount = Argument<int>("loopCount", 10);
for(var index = 0;index<loopCount; index++)
{
Information("Index {0}", index);
}
</code>
</example>
</member>
<member name="M:Cake.Common.ArgumentAliases.Arguments(Cake.Core.ICakeContext)">
<summary>
Retrieves all command line arguments.
</summary>
<example>
<code>
var args = context.Arguments();
if (args.ContainsKey("verbose"))
{
Information("Verbose output enabled");
}
foreach(var arg in args)
{
Information(
"Key: {0}\tValue: \"{1}\"",
arg.Key,
string.Join(";", arg.Value)
);
}
</code>
</example>
<param name="context">The context.</param>
<returns>The command line arguments.</returns>
</member>
<member name="T:Cake.Common.Build.AppVeyor.AppVeyorInfo">
<summary>
Base class used to provide information about the AppVeyor environment.
</summary>
</member>
<member name="M:Cake.Common.Build.AppVeyor.AppVeyorInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.AppVeyor.AppVeyorInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="M:Cake.Common.Build.AppVeyor.AppVeyorInfo.GetEnvironmentString(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.String"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.AppVeyor.AppVeyorInfo.GetEnvironmentInteger(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Int32"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.AppVeyor.AppVeyorInfo.GetEnvironmentBoolean(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Boolean"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="T:Cake.Common.Build.AppVeyor.AppVeyorMessageCategoryType">
<summary>
AppVeyor AddMessage categories.
</summary>
</member>
<member name="F:Cake.Common.Build.AppVeyor.AppVeyorMessageCategoryType.Information">
<summary>
Informational message
</summary>
</member>
<member name="F:Cake.Common.Build.AppVeyor.AppVeyorMessageCategoryType.Warning">
<summary>
Warning message
</summary>
</member>
<member name="F:Cake.Common.Build.AppVeyor.AppVeyorMessageCategoryType.Error">
<summary>
Error message
</summary>
</member>
<member name="T:Cake.Common.Build.AppVeyor.AppVeyorProvider">
<summary>
Responsible for communicating with AppVeyor.
</summary>
</member>
<member name="P:Cake.Common.Build.AppVeyor.AppVeyorProvider.IsRunningOnAppVeyor">
<inheritdoc/>
</member>
<member name="P:Cake.Common.Build.AppVeyor.AppVeyorProvider.Environment">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AppVeyor.AppVeyorProvider.#ctor(Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Diagnostics.ICakeLog)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.AppVeyor.AppVeyorProvider"/> class.
</summary>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="log">The cake log.</param>
</member>
<member name="M:Cake.Common.Build.AppVeyor.AppVeyorProvider.UploadArtifact(Cake.Core.IO.FilePath)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AppVeyor.AppVeyorProvider.UploadArtifact(Cake.Core.IO.FilePath,Cake.Common.Build.AppVeyor.AppVeyorUploadArtifactsSettings)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AppVeyor.AppVeyorProvider.UploadArtifact(Cake.Core.IO.FilePath,System.Action{Cake.Common.Build.AppVeyor.AppVeyorUploadArtifactsSettings})">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AppVeyor.AppVeyorProvider.UploadTestResults(Cake.Core.IO.FilePath,Cake.Common.Build.AppVeyor.AppVeyorTestResultsType)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AppVeyor.AppVeyorProvider.UpdateBuildVersion(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AppVeyor.AppVeyorProvider.AddMessage(System.String,Cake.Common.Build.AppVeyor.AppVeyorMessageCategoryType,System.String)">
<inheritdoc/>
</member>
<member name="T:Cake.Common.Build.AppVeyor.AppVeyorProviderAddMessageExtensions">
<summary>
AddMessage extension methods for the IAppVeyorProvider.
</summary>
</member>
<member name="M:Cake.Common.Build.AppVeyor.AppVeyorProviderAddMessageExtensions.AddInformationalMessage(Cake.Common.Build.AppVeyor.IAppVeyorProvider,System.String,System.Object[])">
<summary>
Adds an informational message to the AppVeyor build log.
</summary>
<param name="provider">The AppVeyor provider.</param>
<param name="format">The message.</param>
<param name="args">The args.</param>
</member>
<member name="M:Cake.Common.Build.AppVeyor.AppVeyorProviderAddMessageExtensions.AddWarningMessage(Cake.Common.Build.AppVeyor.IAppVeyorProvider,System.String,System.Object[])">
<summary>
Adds a warning message to the AppVeyor build log.
</summary>
<param name="provider">The AppVeyor provider.</param>
<param name="format">The message.</param>
<param name="args">The args.</param>
</member>
<member name="M:Cake.Common.Build.AppVeyor.AppVeyorProviderAddMessageExtensions.AddErrorMessage(Cake.Common.Build.AppVeyor.IAppVeyorProvider,System.String,System.Object[])">
<summary>
Adds a warning message to the AppVeyor build log.
</summary>
<param name="provider">The AppVeyor provider.</param>
<param name="format">The message.</param>
<param name="args">The args.</param>
</member>
<member name="M:Cake.Common.Build.AppVeyor.AppVeyorProviderAddMessageExtensions.AddErrorMessage(Cake.Common.Build.AppVeyor.IAppVeyorProvider,System.String,System.Exception)">
<summary>
Adds a warning message to the AppVeyor build log.
</summary>
<param name="provider">The AppVeyor provider.</param>
<param name="message">The message.</param>
<param name="exception">The exception.</param>
</member>
<member name="T:Cake.Common.Build.AppVeyor.AppVeyorTestResultsType">
<summary>
Provides the known values for the AppVeyor test results types.
</summary>
</member>
<member name="F:Cake.Common.Build.AppVeyor.AppVeyorTestResultsType.MSTest">
<summary>
MSTest test results.
</summary>
</member>
<member name="F:Cake.Common.Build.AppVeyor.AppVeyorTestResultsType.XUnit">
<summary>
XUnit test results.
</summary>
</member>
<member name="F:Cake.Common.Build.AppVeyor.AppVeyorTestResultsType.NUnit">
<summary>
NUnit test results.
</summary>
</member>
<member name="F:Cake.Common.Build.AppVeyor.AppVeyorTestResultsType.NUnit3">
<summary>
NUnit v3 test results.
</summary>
</member>
<member name="F:Cake.Common.Build.AppVeyor.AppVeyorTestResultsType.JUnit">
<summary>
JUnit test results.
</summary>
</member>
<member name="T:Cake.Common.Build.AppVeyor.AppVeyorUploadArtifactsSettings">
<summary>
AppVeyor upload artifacts settings.
</summary>
</member>
<member name="P:Cake.Common.Build.AppVeyor.AppVeyorUploadArtifactsSettings.ArtifactType">
<summary>
Gets or sets a value indicating the type of artifact being uploaded to AppVeyor.
</summary>
</member>
<member name="P:Cake.Common.Build.AppVeyor.AppVeyorUploadArtifactsSettings.DeploymentName">
<summary>
Gets or sets a value indicating a deployment name to set for the uploaded artifact.
</summary>
</member>
<member name="M:Cake.Common.Build.AppVeyor.AppVeyorUploadArtifactsSettings.SetArtifactType(Cake.Common.Build.AppVeyor.AppVeyorUploadArtifactType)">
<summary>
Sets the type of artifact being uploaded to AppVeyor.
</summary>
<param name="type">The type of artifact being uploaded.</param>
<returns>The settings.</returns>
</member>
<member name="M:Cake.Common.Build.AppVeyor.AppVeyorUploadArtifactsSettings.SetDeploymentName(System.String)">
<summary>
Sets the deployment name.
</summary>
<param name="deploymentName">The deployment name to attach to the artifact, required when using the AppVeyor deployment agent. <paramref name="deploymentName"/> should not have any spaces.</param>
<returns>The settings.</returns>
</member>
<member name="T:Cake.Common.Build.AppVeyor.AppVeyorUploadArtifactType">
<summary>
Provides the known artifact upload types for the AppVeyor.
</summary>
</member>
<member name="F:Cake.Common.Build.AppVeyor.AppVeyorUploadArtifactType.Auto">
<summary>
Automatically deploy artifact type
</summary>
</member>
<member name="F:Cake.Common.Build.AppVeyor.AppVeyorUploadArtifactType.WebDeployPackage">
<summary>
The artifact is a web deploy package (.zip)
</summary>
</member>
<member name="F:Cake.Common.Build.AppVeyor.AppVeyorUploadArtifactType.NuGetPackage">
<summary>
The artifact is a NuGet package (.nupkg)
</summary>
</member>
<member name="T:Cake.Common.Build.AppVeyor.Data.AppVeyorBuildInfo">
<summary>
Provides AppVeyor build information for a current build.
</summary>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorBuildInfo.Folder">
<summary>
Gets the path to the clone directory.
</summary>
<value>
The path to the clone directory.
</value>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorBuildInfo.Id">
<summary>
Gets the AppVeyor unique build ID.
</summary>
<value>
The AppVeyor unique build ID.
</value>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorBuildInfo.Number">
<summary>
Gets the build number.
</summary>
<value>
The build number.
</value>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorBuildInfo.Version">
<summary>
Gets the build version.
</summary>
<value>
The build version.
</value>
</member>
<member name="M:Cake.Common.Build.AppVeyor.Data.AppVeyorBuildInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.AppVeyor.Data.AppVeyorBuildInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.AppVeyor.Data.AppVeyorCommitInfo">
<summary>
Provides AppVeyor commit information for a current build.
</summary>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorCommitInfo.Id">
<summary>
Gets commit ID (SHA).
</summary>
<value>
The commit ID (SHA).
</value>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorCommitInfo.Author">
<summary>
Gets the commit author's name.
</summary>
<value>
The commit author's name.
</value>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorCommitInfo.Email">
<summary>
Gets the commit author's email address.
</summary>
<value>
The commit author's email address.
</value>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorCommitInfo.Timestamp">
<summary>
Gets the commit date/time.
</summary>
<value>
The commit date/time.
</value>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorCommitInfo.Message">
<summary>
Gets the commit message.
</summary>
<value>
The commit message.
</value>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorCommitInfo.ExtendedMessage">
<summary>
Gets the rest of commit message after line break (if exists).
</summary>
<value>
The rest of commit message after line break (if exists).
</value>
</member>
<member name="M:Cake.Common.Build.AppVeyor.Data.AppVeyorCommitInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.AppVeyor.Data.AppVeyorCommitInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.AppVeyor.Data.AppVeyorEnvironmentInfo">
<summary>
Provides AppVeyor environment information for a current build.
</summary>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorEnvironmentInfo.ApiUrl">
<summary>
Gets the AppVeyor build agent API URL.
</summary>
<value>
The AppVeyor build agent API URL.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.AppVeyor.IsRunningOnAppVeyor)
{
Information(
@"API URL:{0},
BuildSystem.AppVeyor.Environment.ApiUrl
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
<para>Via AppVeyor.</para>
<example>
<code>
if (AppVeyor.IsRunningOnAppVeyor)
{
Information(
@"API URL:{0},
AppVeyor.Environment.ApiUrl
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorEnvironmentInfo.JobId">
<summary>
Gets the AppVeyor unique job ID.
</summary>
<value>
The AppVeyor unique job ID.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.AppVeyor.IsRunningOnAppVeyor)
{
Information(
@"Job Id:{0},
BuildSystem.AppVeyor.Environment.JobId
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
<para>Via AppVeyor.</para>
<example>
<code>
if (AppVeyor.IsRunningOnAppVeyor)
{
Information(
@"Job Id:{0},
AppVeyor.Environment.JobId
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorEnvironmentInfo.JobName">
<summary>
Gets the AppVeyor Job Name.
</summary>
<value>
The AppVeyor Job Name.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.AppVeyor.IsRunningOnAppVeyor)
{
Information(
@"Job Name:{0},
BuildSystem.AppVeyor.Environment.JobName
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
<para>Via AppVeyor.</para>
<example>
<code>
if (AppVeyor.IsRunningOnAppVeyor)
{
Information(
@"Job Name:{0},
AppVeyor.Environment.JobName
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorEnvironmentInfo.ScheduledBuild">
<summary>
Gets a value indicating whether the build runs by scheduler.
</summary>
<value>
<c>true</c> if the build runs by scheduler; otherwise, <c>false</c>.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.AppVeyor.IsRunningOnAppVeyor)
{
Information(
@"Scheduled Build:{0},
BuildSystem.AppVeyor.Environment.ScheduledBuild
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
<para>Via AppVeyor.</para>
<example>
<code>
if (AppVeyor.IsRunningOnAppVeyor)
{
Information(
@"Scheduled Build:{0},
AppVeyor.Environment.ScheduledBuild
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorEnvironmentInfo.Platform">
<summary>
Gets the platform name set on build tab of project settings (or through platform parameter in appveyor.yml).
</summary>
<value>
The platform name set on build tab of project settings (or through platform parameter in appveyor.yml).
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.AppVeyor.IsRunningOnAppVeyor)
{
Information(
@"Platform:{0},
BuildSystem.AppVeyor.Environment.Platform
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
<para>Via AppVeyor.</para>
<example>
<code>
if (AppVeyor.IsRunningOnAppVeyor)
{
Information(
@"Platform:{0},
AppVeyor.Environment.Platform
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorEnvironmentInfo.Configuration">
<summary>
Gets the configuration name set on build tab of project settings (or through configuration parameter in appveyor.yml).
</summary>
<value>
The configuration name set on build tab of project settings (or through configuration parameter in appveyor.yml).
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.AppVeyor.IsRunningOnAppVeyor)
{
Information(
@"Configuration:{0},
BuildSystem.AppVeyor.Environment.Configuration
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
<para>Via AppVeyor.</para>
<example>
<code>
if (AppVeyor.IsRunningOnAppVeyor)
{
Information(
@"Configuration:{0},
AppVeyor.Environment.Configuration
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorEnvironmentInfo.Project">
<summary>
Gets AppVeyor project information.
</summary>
<value>
The AppVeyor project information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.AppVeyor.IsRunningOnAppVeyor)
{
Information(
@"Project:
Id: {0}
Name: {1}
Slug: {2}",
BuildSystem.AppVeyor.Environment.Project.Id,
BuildSystem.AppVeyor.Environment.Project.Name,
BuildSystem.AppVeyor.Environment.Project.Slug
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
<para>Via AppVeyor.</para>
<example>
<code>
// via AppVeyor
if (AppVeyor.IsRunningOnAppVeyor)
{
Information(
@"Project:
Id: {0}
Name: {1}
Slug: {2}",
AppVeyor.Environment.Project.Id,
AppVeyor.Environment.Project.Name,
AppVeyor.Environment.Project.Slug
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorEnvironmentInfo.Build">
<summary>
Gets AppVeyor build information.
</summary>
<value>
The AppVeyor build information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.AppVeyor.IsRunningOnAppVeyor)
{
Information(
@"Build:
Folder: {0}
Id: {1}
Number: {2}
Version: {3}",
BuildSystem.AppVeyor.Environment.Build.Folder,
BuildSystem.AppVeyor.Environment.Build.Id,
BuildSystem.AppVeyor.Environment.Build.Number,
BuildSystem.AppVeyor.Environment.Build.Version
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
<para>Via AppVeyor.</para>
<example>
<code>
if (AppVeyor.IsRunningOnAppVeyor)
{
Information(
@"Build:
Folder: {0}
Id: {1}
Number: {2}
Version: {3}",
AppVeyor.Environment.Build.Folder,
AppVeyor.Environment.Build.Id,
AppVeyor.Environment.Build.Number,
AppVeyor.Environment.Build.Version
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorEnvironmentInfo.PullRequest">
<summary>
Gets AppVeyor pull request information.
</summary>
<value>
The AppVeyor pull request information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.AppVeyor.IsRunningOnAppVeyor)
{
Information(
@"PullRequest:
IsPullRequest: {0}
Number: {1}
Title: {2}",
BuildSystem.AppVeyor.Environment.PullRequest.IsPullRequest,
BuildSystem.AppVeyor.Environment.PullRequest.Number,
BuildSystem.AppVeyor.Environment.PullRequest.Title
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
<para>Via AppVeyor.</para>
<example>
<code>
if (AppVeyor.IsRunningOnAppVeyor)
{
Information(
@"PullRequest:
IsPullRequest: {0}
Number: {1}
Title: {2}",
AppVeyor.Environment.PullRequest.IsPullRequest,
AppVeyor.Environment.PullRequest.Number,
AppVeyor.Environment.PullRequest.Title
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorEnvironmentInfo.Repository">
<summary>
Gets AppVeyor repository information.
</summary>
<value>
The AppVeyor repository information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.AppVeyor.IsRunningOnAppVeyor)
{
Information(
@"Repository:
Branch: {0}
Name: {1}
Provider: {2}
Scm: {3}",
BuildSystem.AppVeyor.Environment.Repository.Branch,
BuildSystem.AppVeyor.Environment.Repository.Name,
BuildSystem.AppVeyor.Environment.Repository.Provider,
BuildSystem.AppVeyor.Environment.Repository.Scm
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
<para>Via AppVeyor.</para>
<example>
<code>
if (AppVeyor.IsRunningOnAppVeyor)
{
Information(
@"Repository:
Branch: {0}
Name: {1}
Provider: {2}
Scm: {3}",
AppVeyor.Environment.Repository.Branch,
AppVeyor.Environment.Repository.Name,
AppVeyor.Environment.Repository.Provider,
AppVeyor.Environment.Repository.Scm
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
</member>
<member name="M:Cake.Common.Build.AppVeyor.Data.AppVeyorEnvironmentInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.AppVeyor.Data.AppVeyorEnvironmentInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.AppVeyor.Data.AppVeyorProjectInfo">
<summary>
Provides AppVeyor project information for a current build.
</summary>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorProjectInfo.Id">
<summary>
Gets the AppVeyor unique project ID.
</summary>
<value>
The AppVeyor unique project ID.
</value>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorProjectInfo.Name">
<summary>
Gets the project name.
</summary>
<value>
The project name.
</value>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorProjectInfo.Slug">
<summary>
Gets the project slug (as seen in project details URL).
</summary>
<value>
The project slug (as seen in project details URL).
</value>
</member>
<member name="M:Cake.Common.Build.AppVeyor.Data.AppVeyorProjectInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.AppVeyor.Data.AppVeyorProjectInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.AppVeyor.Data.AppVeyorPullRequestInfo">
<summary>
Provides AppVeyor pull request information for a current build.
</summary>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorPullRequestInfo.IsPullRequest">
<summary>
Gets a value indicating whether the current build was started by a pull request.
</summary>
<value>
<c>true</c> if the current build was started by a pull request; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorPullRequestInfo.Number">
<summary>
Gets the GitHub pull request number.
</summary>
<value>
The GitHub pull request number.
</value>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorPullRequestInfo.Title">
<summary>
Gets the GitHub pull request title.
</summary>
<value>
The GitHub pull request title.
</value>
</member>
<member name="M:Cake.Common.Build.AppVeyor.Data.AppVeyorPullRequestInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.AppVeyor.Data.AppVeyorPullRequestInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.AppVeyor.Data.AppVeyorRepositoryInfo">
<summary>
Provides AppVeyor repository information for a current build.
</summary>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorRepositoryInfo.Provider">
<summary>
Gets the repository provider.
<list type="bullet">
<item>
<description>github</description>
</item>
<item>
<description>bitbucket</description>
</item>
<item>
<description>kiln</description>
</item>
<item>
<description>vso</description>
</item>
<item>
<description>gitlab</description>
</item>
</list>
</summary>
<value>
The repository provider.
</value>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorRepositoryInfo.Scm">
<summary>
Gets the revision control system.
<list type="bullet">
<item>
<description>git</description>
</item>
<item>
<description>mercurial</description>
</item>
</list>
</summary>
<value>
The revision control system.
</value>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorRepositoryInfo.Name">
<summary>
Gets the repository name in format owner-name/repo-name.
</summary>
<value>
The repository name.
</value>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorRepositoryInfo.Branch">
<summary>
Gets the build branch. For pull request commits it is base branch PR is merging into.
</summary>
<value>
The build branch.
</value>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorRepositoryInfo.Tag">
<summary>
Gets the tag information for the build.
</summary>
<value>
The tag information for the build.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.AppVeyor.IsRunningOnAppVeyor)
{
Information(
@"Repository:
IsTag: {0}
Name: {1}",
BuildSystem.AppVeyor.Environment.Repository.Tag.IsTag,
BuildSystem.AppVeyor.Environment.Repository.Tag.Name
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
<para>Via AppVeyor.</para>
<example>
<code>
if (AppVeyor.IsRunningOnAppVeyor)
{
Information(
@"Repository:
IsTag: {0}
Name: {1}",
AppVeyor.Environment.Repository.Tag.IsTag,
AppVeyor.Environment.Repository.Tag.Name
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorRepositoryInfo.Commit">
<summary>
Gets the commit information for the build.
</summary>
<value>
The commit information for the build.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.AppVeyor.IsRunningOnAppVeyor)
{
Information(
@"Repository:
Author: {0}
Email: {1}
ExtendedMessage: {2}
Id: {3}
Message: {4}
Timestamp: {5}",
BuildSystem.AppVeyor.Environment.Repository.Commit.Author,
BuildSystem.AppVeyor.Environment.Repository.Commit.Email,
BuildSystem.AppVeyor.Environment.Repository.Commit.ExtendedMessage,
BuildSystem.AppVeyor.Environment.Repository.Commit.Id,
BuildSystem.AppVeyor.Environment.Repository.Commit.Message,
BuildSystem.AppVeyor.Environment.Repository.Commit.Timestamp
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
<para>Via AppVeyor.</para>
<example>
<code>
if (AppVeyor.IsRunningOnAppVeyor)
{
Information(
@"Repository:
Author: {0}
Email: {1}
ExtendedMessage: {2}
Id: {3}
Message: {4}
Timestamp: {5}",
AppVeyor.Environment.Repository.Commit.Author,
AppVeyor.Environment.Repository.Commit.Email,
AppVeyor.Environment.Repository.Commit.ExtendedMessage,
AppVeyor.Environment.Repository.Commit.Id,
AppVeyor.Environment.Repository.Commit.Message,
AppVeyor.Environment.Repository.Commit.Timestamp
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
</member>
<member name="M:Cake.Common.Build.AppVeyor.Data.AppVeyorRepositoryInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.AppVeyor.Data.AppVeyorRepositoryInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.AppVeyor.Data.AppVeyorTagInfo">
<summary>
Provides AppVeyor tag information for a current build.
</summary>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorTagInfo.IsTag">
<summary>
Gets a value indicating whether build was started by pushed tag.
</summary>
<value>
<c>true</c> if build was started by pushed tag; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.AppVeyor.Data.AppVeyorTagInfo.Name">
<summary>
Gets the name for builds started by tag; otherwise this variable is undefined.
</summary>
<value>
The name of the tag.
</value>
</member>
<member name="M:Cake.Common.Build.AppVeyor.Data.AppVeyorTagInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.AppVeyor.Data.AppVeyorTagInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.AppVeyor.Data.NamespaceDoc">
<summary>
This namespace contain types
representing data used for interaction with AppVeyor.
</summary>
</member>
<member name="T:Cake.Common.Build.AppVeyor.IAppVeyorProvider">
<summary>
Represents a service that communicates with AppVeyor.
</summary>
</member>
<member name="P:Cake.Common.Build.AppVeyor.IAppVeyorProvider.IsRunningOnAppVeyor">
<summary>
Gets a value indicating whether the current build is running on AppVeyor.
</summary>
<value>
<c>true</c> if the current build is running on AppVeyor.; otherwise, <c>false</c>.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.AppVeyor.IsRunningOnAppVeyor)
{
Information("Running on AppVeyor");
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
<para>Via AppVeyor.</para>
<example>
<code>
if (AppVeyor.IsRunningOnAppVeyor)
{
Information("Running on AppVeyor");
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.AppVeyor.IAppVeyorProvider.Environment">
<summary>
Gets the AppVeyor environment.
</summary>
<value>
The AppVeyor environment.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.AppVeyor.IsRunningOnAppVeyor)
{
Information(
@"Environment:
ApiUrl: {0}
Configuration: {1}
JobId: {2}
JobName: {3}
Platform: {4}
ScheduledBuild: {5}",
BuildSystem.AppVeyor.Environment.ApiUrl,
BuildSystem.AppVeyor.Environment.Configuration,
BuildSystem.AppVeyor.Environment.JobId,
BuildSystem.AppVeyor.Environment.JobName,
BuildSystem.AppVeyor.Environment.Platform,
BuildSystem.AppVeyor.Environment.ScheduledBuild
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
<para>Via AppVeyor.</para>
<example>
<code>
if (AppVeyor.IsRunningOnAppVeyor)
{
Information(
@"Environment:
ApiUrl: {0}
Configuration: {1}
JobId: {2}
JobName: {3}
Platform: {4}
ScheduledBuild: {5}",
AppVeyor.Environment.ApiUrl,
AppVeyor.Environment.Configuration,
AppVeyor.Environment.JobId,
AppVeyor.Environment.JobName,
AppVeyor.Environment.Platform,
AppVeyor.Environment.ScheduledBuild
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
</member>
<member name="M:Cake.Common.Build.AppVeyor.IAppVeyorProvider.UploadArtifact(Cake.Core.IO.FilePath)">
<summary>
Uploads an AppVeyor artifact.
</summary>
<param name="path">The file path of the artifact to upload.</param>
</member>
<member name="M:Cake.Common.Build.AppVeyor.IAppVeyorProvider.UploadArtifact(Cake.Core.IO.FilePath,Cake.Common.Build.AppVeyor.AppVeyorUploadArtifactsSettings)">
<summary>
Uploads an AppVeyor artifact.
</summary>
<param name="path">The file path of the artifact to upload.</param>
<param name="settings">The settings to apply when uploading an artifact.</param>
</member>
<member name="M:Cake.Common.Build.AppVeyor.IAppVeyorProvider.UploadArtifact(Cake.Core.IO.FilePath,System.Action{Cake.Common.Build.AppVeyor.AppVeyorUploadArtifactsSettings})">
<summary>
Uploads an AppVeyor artifact.
</summary>
<param name="path">The file path of the artifact to upload.</param>
<param name="settingsAction">The settings to apply when uploading an artifact.</param>
</member>
<member name="M:Cake.Common.Build.AppVeyor.IAppVeyorProvider.UploadTestResults(Cake.Core.IO.FilePath,Cake.Common.Build.AppVeyor.AppVeyorTestResultsType)">
<summary>
Uploads test results XML file to AppVeyor. Results type can be one of the following: mstest, xunit, nunit, nunit3, junit.
</summary>
<param name="path">The file path of the test results XML to upload.</param>
<param name="resultsType">The results type. Can be mstest, xunit, nunit, nunit3 or junit.</param>
</member>
<member name="M:Cake.Common.Build.AppVeyor.IAppVeyorProvider.UpdateBuildVersion(System.String)">
<summary>
Updates the build version.
</summary>
<param name="version">The new build version.</param>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.AppVeyor.IsRunningOnAppVeyor)
{
BuildSystem.AppVeyor.UpdateBuildVersion("2.0.0.0");
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
<para>Via AppVeyor.</para>
<example>
<code>
if (AppVeyor.IsRunningOnAppVeyor)
{
AppVeyor.UpdateBuildVersion("2.0.0.0");
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
</member>
<member name="M:Cake.Common.Build.AppVeyor.IAppVeyorProvider.AddMessage(System.String,Cake.Common.Build.AppVeyor.AppVeyorMessageCategoryType,System.String)">
<summary>
Adds a message to the AppVeyor build log. Messages can be categorised as: Information, Warning or Error.
</summary>
<param name="message">A short message to display.</param>
<param name="category">The category of the message.</param>
<param name="details">Additional message details.</param>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.AppVeyor.IsRunningOnAppVeyor)
{
BuildSystem.AppVeyor.AddMessage(
"This is a error message.",
AppVeyorMessageCategoryType.Error,
"Error details."
);
BuildSystem.AppVeyor.AddMessage(
"This is a information message.",
AppVeyorMessageCategoryType.Information,
"Information details."
);
BuildSystem.AppVeyor.AddMessage(
"This is a warning message.",
AppVeyorMessageCategoryType.Warning,
"Warning details."
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
<para>Via AppVeyor.</para>
<example>
<code>
if (AppVeyor.IsRunningOnAppVeyor)
{
AppVeyor.AddMessage(
"This is a error message.",
AppVeyorMessageCategoryType.Error,
"Error details."
);
AppVeyor.AddMessage(
"This is a information message.",
AppVeyorMessageCategoryType.Information,
"Information details."
);
AppVeyor.AddMessage(
"This is a warning message.",
AppVeyorMessageCategoryType.Warning,
"Warning details."
);
}
else
{
Information("Not running on AppVeyor");
}
</code>
</example>
</member>
<member name="T:Cake.Common.Build.AppVeyor.NamespaceDoc">
<summary>
This namespace contain types used
to interact with AppVeyor.
</summary>
</member>
<member name="T:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands">
<summary>
Responsible for issuing Azure Pipelines agent commands (see <see href="https://github.com/microsoft/azure-pipelines-tasks/blob/master/docs/authoring/commands.md"/>).
</summary>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.#ctor(Cake.Core.ICakeEnvironment,Cake.Common.Build.IBuildSystemServiceMessageWriter)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands"/> class.
</summary>
<param name="environment">The environment.</param>
<param name="writer">The build system service message writer.</param>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.WriteWarning(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.WriteWarning(System.String,Cake.Common.Build.AzurePipelines.Data.AzurePipelinesMessageData)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.WriteError(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.WriteError(System.String,Cake.Common.Build.AzurePipelines.Data.AzurePipelinesMessageData)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.SetProgress(System.Int32,System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.CompleteCurrentTask">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.CompleteCurrentTask(Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTaskResult)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.CreateNewRecord(System.String,System.String,System.Int32)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.CreateNewRecord(System.String,System.String,System.Int32,Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRecordData)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.UpdateRecord(System.Guid,Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRecordData)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.SetVariable(System.String,System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.SetOutputVariable(System.String,System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.SetSecretVariable(System.String,System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.UploadTaskSummary(Cake.Core.IO.FilePath)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.UploadTaskLogFile(Cake.Core.IO.FilePath)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.LinkArtifact(System.String,Cake.Common.Build.AzurePipelines.Data.AzurePipelinesArtifactType,System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.UploadArtifact(System.String,Cake.Core.IO.FilePath)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.UploadArtifact(System.String,Cake.Core.IO.FilePath,System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.UploadArtifactDirectory(Cake.Core.IO.DirectoryPath)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.UploadArtifactDirectory(Cake.Core.IO.DirectoryPath,System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.UploadBuildLogFile(Cake.Core.IO.FilePath)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.UpdateBuildNumber(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.AddBuildTag(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.PublishTestResults(Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPublishTestResultsData)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.PublishCodeCoverage(Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPublishCodeCoverageData)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.PublishCodeCoverage(Cake.Core.IO.FilePath,Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPublishCodeCoverageData)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesCommands.PublishCodeCoverage(Cake.Core.IO.FilePath,System.Action{Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPublishCodeCoverageData})">
<inheritdoc/>
</member>
<member name="T:Cake.Common.Build.AzurePipelines.AzurePipelinesInfo">
<summary>
Base class used to provide information about the Azure Pipelines environment.
</summary>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.AzurePipelines.AzurePipelinesInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesInfo.GetEnvironmentString(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.String"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesInfo.GetEnvironmentInteger(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Int32"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesInfo.GetEnvironmentBoolean(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Boolean"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesInfo.GetEnvironmentUri(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Uri"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesInfo.GetRepositoryType(System.String)">
<summary>
Gets the current repository type as a <see cref="T:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRepositoryType"/> from an environment variable.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The current repository type.</returns>
</member>
<member name="T:Cake.Common.Build.AzurePipelines.AzurePipelinesProvider">
<summary>
Responsible for communicating with Azure Pipelines.
</summary>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.AzurePipelinesProvider.#ctor(Cake.Core.ICakeEnvironment,Cake.Common.Build.IBuildSystemServiceMessageWriter)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.AzurePipelines.AzurePipelinesProvider"/> class.
</summary>
<param name="environment">The environment.</param>
<param name="writer">The build system service message writer.</param>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.AzurePipelinesProvider.IsRunningOnAzurePipelines">
<inheritdoc/>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.AzurePipelinesProvider.Environment">
<inheritdoc/>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.AzurePipelinesProvider.Commands">
<inheritdoc/>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.AzurePipelinesProvider.IsHostedAgent">
<summary>
Gets a value indicating whether the current build is running on a hosted build agent.
</summary>
<value>
<c>true</c> if the current build is running on a hosted agent; otherwise, <c>false</c>.
</value>
</member>
<member name="T:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesAgentInfo">
<summary>
Provides Azure Pipelines agent info for the current build and build agent.
</summary>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesAgentInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesAgentInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesAgentInfo.BuildDirectory">
<summary>
Gets the local path on the agent where all folders for a given build definition are created.
</summary>
<value>
The local path on the agent where all folders for a given build definition are created.
</value>
<example><c>c:\agent\_work\1</c>.</example>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesAgentInfo.HomeDirectory">
<summary>
Gets the directory the agent is installed into. This contains the agent software.
</summary>
<remarks>If you are using a self-hosted agent, this directory is specified by you.</remarks>
<value>
The directory the agent is installed into.
</value>
<example><c>c:\agent\</c>.</example>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesAgentInfo.WorkingDirectory">
<summary>
Gets the working directory for this agent.
</summary>
<value>
The working directory for this agent.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesAgentInfo.Id">
<summary>
Gets the ID of the agent.
</summary>
<value>
The ID of the agent.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesAgentInfo.JobName">
<summary>
Gets the display name of the running job.
</summary>
<value>
The display name of the running job.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesAgentInfo.JobStatus">
<summary>
Gets the status of the build.
</summary>
<value>
The status of the build.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesAgentInfo.Name">
<summary>
Gets the name of the agent that is registered with the pool.
</summary>
<remarks>If you are using a self-hosted agent, this is specified by you.</remarks>
<value>
The name of the agent that is registered with the pool.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesAgentInfo.MachineName">
<summary>
Gets the name of the machine on which the agent is installed.
</summary>
<value>
The name of the machine on which the agent is installed.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesAgentInfo.ToolsDirectory">
<summary>
Gets the directory used by tasks such as Node Tool Installer and Use Python Version to switch between multiple versions of a tool.
</summary>
<remarks>
These tasks will add tools from this directory to PATH so that subsequent build steps can use them.
</remarks>
<value>
The task directory.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesAgentInfo.IsHosted">
<summary>
Gets a value indicating whether the current agent is a Microsoft hosted agent.
</summary>
<value>
<c>true</c> if the current agent is a Microsoft hosted agent. <c>false</c> if the current agent is a self hosted agent.
</value>
</member>
<member name="T:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesArtifactType">
<summary>
Provides the type of an Azure Pipelines artifact.
</summary>
</member>
<member name="F:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesArtifactType.Container">
<summary>
The container type.
</summary>
</member>
<member name="F:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesArtifactType.FilePath">
<summary>
The file path type.
</summary>
</member>
<member name="F:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesArtifactType.VersionControl">
<summary>
The version control path type.
</summary>
</member>
<member name="F:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesArtifactType.GitRef">
<summary>
The Git reference type.
</summary>
</member>
<member name="F:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesArtifactType.TFVCLabel">
<summary>
The TFVC label type.
</summary>
</member>
<member name="T:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesBuildInfo">
<summary>
Provides Azure Pipelines Build info for the current build.
</summary>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesBuildInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesBuildInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesBuildInfo.AccessToken">
<summary>
Gets the a special variable that carries the security token used by the running build.
</summary>
<value>
The security token.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesBuildInfo.Debug">
<summary>
Gets a value indicating whether more detailed logs to debug pipeline problems is enabled.
</summary>
<value>
True if more detailed logs are enabled.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesBuildInfo.ArtifactStagingDirectory">
<summary>
Gets the local path on the agent where any artifacts are copied to before being pushed to their destination.
</summary>
<value>
The path of the staging directory.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesBuildInfo.BinariesDirectory">
<summary>
Gets the local path on the agent you can use as an output folder for compiled binaries.
</summary>
<value>
The path to the binaries directory.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesBuildInfo.Id">
<summary>
Gets the ID of the record for the completed build.
</summary>
<value>
The ID of the record for the completed build.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesBuildInfo.Number">
<summary>
Gets the name of the completed build.
</summary>
<remarks>You can specify the build number format that generates this value in the build definition.</remarks>
<value>
The name of the completed build.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesBuildInfo.Uri">
<summary>
Gets the URI for the build.
</summary>
<example><c>vstfs:///Build/Build/1430</c>.</example>
<value>
The URI for the build.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesBuildInfo.QueuedBy">
<summary>
Gets the user who queued the build.
</summary>
<value>
The user who queued the build.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesBuildInfo.Reason">
<summary>
Gets the event that caused the build to run.
</summary>
<value>
The event name.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesBuildInfo.RequestedFor">
<summary>
Gets the user the build was requested for.
</summary>
<value>
The user the build was requested for.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesBuildInfo.RequestedForEmail">
<summary>
Gets the email of the user the build was requested for.
</summary>
<value>
The email of the user the build was requested for.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesBuildInfo.SourcesDirectory">
<summary>
Gets the local path on the agent where your source code files are downloaded.
</summary>
<value>
The source code directory.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesBuildInfo.StagingDirectory">
<summary>
Gets the local path on the agent where any artifacts are copied to before being pushed to their destination.
</summary>
<value>
The staging directory.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesBuildInfo.TestResultsDirectory">
<summary>
Gets local path on the agent where the test results are created.
</summary>
<value>
The test result directory.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesBuildInfo.TriggeredBy">
<summary>
Gets Azure Pipelines Build TriggeredBy information.
</summary>
<remarks>
This is only populated if the build was triggered by another build.
</remarks>
<value>
The Azure Pipelines Build Trigger information.
</value>
</member>
<member name="T:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesCodeCoverageToolType">
<summary>
Provides the known values for the Code Coverage tool formats.
</summary>
</member>
<member name="F:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesCodeCoverageToolType.JaCoCo">
<summary>
JaCoCo code coverage format
</summary>
</member>
<member name="F:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesCodeCoverageToolType.Cobertura">
<summary>
Cobertura code coverage format
</summary>
</member>
<member name="T:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesDefinitionInfo">
<summary>
Provides Azure Pipelines definition information for the current build.
</summary>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesDefinitionInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesDefinitionInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesDefinitionInfo.Id">
<summary>
Gets the build definition ID.
</summary>
<value>
The build definition ID.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesDefinitionInfo.Name">
<summary>
Gets the build definition name.
</summary>
<value>
The build definition name.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesDefinitionInfo.Version">
<summary>
Gets the build definition version.
</summary>
<value>
The build definition version.
</value>
</member>
<member name="T:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesEnvironmentInfo">
<summary>
Provides Azure Pipelines environment information for the current build.
</summary>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesEnvironmentInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesEnvironmentInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesEnvironmentInfo.Repository">
<summary>
Gets Azure Pipelines repository information.
</summary>
<value>
The Azure Pipelines repository information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.AzurePipelines.IsRunningOnAzurePipelines)
{
Information(
@"Repository:
Branch: {0}
SourceVersion: {1}
Shelveset: {2}",
BuildSystem.AzurePipelines.Environment.Repository.Branch,
BuildSystem.AzurePipelines.Environment.Repository.SourceVersion,
BuildSystem.AzurePipelines.Environment.Repository.Shelveset
);
}
else
{
Information("Not running on Azure Pipelines");
}
</code>
</example>
<para>Via AzurePipelines.</para>
<example>
<code>
if (AzurePipelines.IsRunningOnAzurePipelines)
{
Information(
@"Repository:
Branch: {0}
SourceVersion: {1}
Shelveset: {2}",
AzurePipelines.Environment.Repository.Branch,
AzurePipelines.Environment.Repository.SourceVersion,
AzurePipelines.Environment.Repository.Shelveset
);
}
else
{
Information("Not running on Azure Pipelines");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesEnvironmentInfo.BuildDefinition">
<summary>
Gets Azure Pipelines Build Definition information.
</summary>
<value>
The Azure Pipelines Build Definition.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.AzurePipelines.IsRunningOnAzurePipelines)
{
Information(
@"BuildDefinition:
Id: {0}
Name: {1}
Version: {2}",
BuildSystem.AzurePipelines.Environment.BuildDefinition.Id,
BuildSystem.AzurePipelines.Environment.BuildDefinition.Name,
BuildSystem.AzurePipelines.Environment.BuildDefinition.Version
);
}
else
{
Information("Not running on AzurePipelines");
}
</code>
</example>
<para>Via AzurePipelines.</para>
<example>
<code>
if (AzurePipelines.IsRunningOnAzurePipelines)
{
Information(
@"BuildDefinition:
Id: {0}
Name: {1}
Version: {2}",
AzurePipelines.Environment.BuildDefinition.Id,
AzurePipelines.Environment.BuildDefinition.Name,
AzurePipelines.Environment.BuildDefinition.Version
);
}
else
{
Information("Not running on AzurePipelines");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesEnvironmentInfo.Build">
<summary>
Gets Azure Pipelines Build information.
</summary>
<value>
The Azure Pipelines Build.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.AzurePipelines.IsRunningOnAzurePipelines)
{
Information(
@"Build:
Id: {0}
Number: {1}
QueuedBy: {2}",
BuildSystem.AzurePipelines.Environment.Build.Id,
BuildSystem.AzurePipelines.Environment.Build.Number,
BuildSystem.AzurePipelines.Environment.Build.QueuedBy
);
}
else
{
Information("Not running on Azure Pipelines");
}
</code>
</example>
<para>Via AzurePipelines.</para>
<example>
<code>
if (AzurePipelines.IsRunningOnAzurePipelines)
{
Information(
@"Build:
Id: {0}
Number: {1}
QueuedBy: {2}",
AzurePipelines.Environment.Build.Id,
AzurePipelines.Environment.Build.Number,
AzurePipelines.Environment.Build.QueuedBy
);
}
else
{
Information("Not running on Azure Pipelines");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesEnvironmentInfo.PullRequest">
<summary>
Gets Azure Pipelines pull request information.
</summary>
<value>
The Azure Pipelines pull request information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.AzurePipelines.IsRunningOnAzurePipelines)
{
Information(
@"PullRequest:
IsPullRequest: {0}
Id: {1}
Number: {2}",
BuildSystem.AzurePipelines.Environment.PullRequest.IsPullRequest,
BuildSystem.AzurePipelines.Environment.PullRequest.Id,
BuildSystem.AzurePipelines.Environment.PullRequest.Number
);
}
else
{
Information("Not running on Azure Pipelines");
}
</code>
</example>
<para>Via AzurePipelines.</para>
<example>
<code>
if (AzurePipelines.IsRunningOnAzurePipelines)
{
Information(
@"PullRequest:
IsPullRequest: {0}
Id: {1}
Number: {2}",
AzurePipelines.Environment.PullRequest.IsPullRequest,
AzurePipelines.Environment.PullRequest.Id,
AzurePipelines.Environment.PullRequest.Number
);
}
else
{
Information("Not running on Azure Pipelines");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesEnvironmentInfo.TeamProject">
<summary>
Gets Azure Pipeline Team Project information.
</summary>
<value>
The Azure Pipelines Team Project.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.AzurePipelines.IsRunningOnAzurePipelines)
{
Information(
@"TeamProject:
Id: {0}
Name: {1}",
BuildSystem.AzurePipelines.Environment.TeamProject.Id,
BuildSystem.AzurePipelines.Environment.TeamProject.Name
);
}
else
{
Information("Not running on Azure Pipelines");
}
</code>
</example>
<para>Via AzurePipelines.</para>
<example>
<code>
if (AzurePipelines.IsRunningOnAzurePipelines)
{
Information(
@"TeamProject:
Id: {0}
Name: {1}",
AzurePipelines.Environment.TeamProject.Id,
AzurePipelines.Environment.TeamProject.Name
);
}
else
{
Information("Not running on Azure Pipelines");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesEnvironmentInfo.Agent">
<summary>
Gets Azure Pipelines agent information.
</summary>
<value>
The Azure Pipelines agent.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.AzurePipelines.IsRunningOnAzurePipelines)
{
Information(
@"Agent:
Id: {0}
Name: {1}",
BuildSystem.AzurePipelines.Environment.Agent.Id,
BuildSystem.AzurePipelines.Environment.Agent.Name
);
}
else
{
Information("Not running on Azure Pipelines");
}
</code>
</example>
<para>Via AzurePipelines.</para>
<example>
<code>
if (AzurePipelines.IsRunningOnAzurePipelines)
{
Information(
@"Agent:
Id: {0}
Name: {1}",
AzurePipelines.Environment.Agent.Id,
AzurePipelines.Environment.Agent.Name
);
}
else
{
Information("Not running on Azure Pipelines");
}
</code>
</example>
</member>
<member name="T:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesMessageData">
<summary>
Provides optional data associated with a Azure Pipelines logging message.
</summary>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesMessageData.SourcePath">
<summary>
Gets or sets the source file path the message should originate from.
</summary>
<value>
The path of the originating file.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesMessageData.LineNumber">
<summary>
Gets or sets the line number the message relates to.
</summary>
<value>
The line number.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesMessageData.ColumnNumber">
<summary>
Gets or sets the column number the message relates to.
</summary>
<value>
The column number.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesMessageData.ErrorCode">
<summary>
Gets or sets the error code of the warning or error message.
</summary>
<value>
The error code of the warning or error.
</value>
</member>
<member name="T:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPublishCodeCoverageData">
<summary>
Description of code coverage information to publish to Azure Pipelines.
</summary>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPublishCodeCoverageData.CodeCoverageTool">
<summary>
Gets or sets the tool from which code coverage results are generated.
</summary>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPublishCodeCoverageData.SummaryFileLocation">
<summary>
Gets or sets the path of the summary file containing code coverage statistics, such as line, method, and class coverage.
</summary>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPublishCodeCoverageData.ReportDirectory">
<summary>
Gets or sets the path of the code coverage HTML report directory. The report directory is published for later viewing as an artifact of the build.
</summary>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPublishCodeCoverageData.AdditionalCodeCoverageFiles">
<summary>
Gets or sets the file paths for any additional code coverage files to be published as artifacts of the build.
</summary>
</member>
<member name="T:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPublishTestResultsData">
<summary>
Description of test result information to publish to Azure Pipelines.
</summary>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPublishTestResultsData.TestRunner">
<summary>
Gets or sets the type test runner the results are formatted in.
</summary>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPublishTestResultsData.TestResultsFiles">
<summary>
Gets or sets the list of test result files to publish.
</summary>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPublishTestResultsData.MergeTestResults">
<summary>
Gets or sets whether to merge all test result files into one run.
</summary>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPublishTestResultsData.Platform">
<summary>
Gets or sets the platform for which the tests were run on.
</summary>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPublishTestResultsData.Configuration">
<summary>
Gets or sets the configuration for which the tests were run on.
</summary>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPublishTestResultsData.TestRunTitle">
<summary>
Gets or sets a name for the test run.
</summary>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPublishTestResultsData.PublishRunAttachments">
<summary>
Gets or sets whether to opt in/out of publishing test run level attachments.
</summary>
</member>
<member name="T:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPullRequestInfo">
<summary>
Provides Azure Pipelines pull request information for the current build.
</summary>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPullRequestInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPullRequestInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPullRequestInfo.IsFork">
<summary>
Gets a value indicating whether the pull request is from a fork of the repository.
</summary>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPullRequestInfo.IsPullRequest">
<summary>
Gets a value indicating whether the current build was started by a pull request.
</summary>
<value>
<c>true</c> if the current build was started by a pull request; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPullRequestInfo.Id">
<summary>
Gets the ID of the pull request that caused this build.
This value is set only if the build ran because of a Git PR affected by a branch policy.
</summary>
<value>
The ID of the pull request that caused this build.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPullRequestInfo.Number">
<summary>
Gets the number of the pull request that caused this build.
This value is set for pull requests from GitHub which have a different pull request ID and pull request number.
</summary>
<value>
The number of the pull request that caused this build.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPullRequestInfo.SourceBranch">
<summary>
Gets the branch that is being reviewed in a pull request.
</summary>
<remarks>
This property is populated only if the build ran because of a Git PR affected by a branch policy.
</remarks>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPullRequestInfo.SourceRepositoryUri">
<summary>
Gets the URL to the repo that contains the pull requests.
</summary>
<remarks>
This property is populated only if the build ran because of a Git PR affected by a branch policy. It is not initialized for GitHub PRs.
</remarks>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPullRequestInfo.TargetBranch">
<summary>
Gets the branch that is the target of a pull request.
</summary>
<remarks>
This property is populated only if the build ran because of a Git PR affected by a branch policy.
</remarks>
</member>
<member name="T:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRecordData">
<summary>
Provides optional data associated with an Azure Pipelines timeline record.
</summary>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRecordData.ParentRecord">
<summary>
Gets or sets the parent record of a new or existing timeline record.
</summary>
<value>
The ID of the parent record.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRecordData.StartTime">
<summary>
Gets or sets the start time of this record.
</summary>
<value>
The start time of this record.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRecordData.FinishTime">
<summary>
Gets or sets the finish time of this record.
</summary>
<value>
The finish time of this record.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRecordData.Progress">
<summary>
Gets or sets the current progress of this record.
</summary>
<value>
The current progress of this record.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRecordData.Status">
<summary>
Gets or sets the current status of this record.
</summary>
<value>
The current status of this record.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRecordData.Result">
<summary>
Gets or sets the result of this record.
</summary>
<value>
The result of this record.
</value>
</member>
<member name="T:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRepositoryInfo">
<summary>
Provides Azure Pipelines Repository information for the current build.
</summary>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRepositoryInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRepositoryInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRepositoryInfo.SourceBranch">
<summary>
Gets the branch the build was queued for.
</summary>
<value>
The full SCM branch.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRepositoryInfo.SourceBranchName">
<summary>
Gets name of the branch the build was queued for.
</summary>
<value>
The SCM branch name.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRepositoryInfo.SourceVersion">
<summary>
Gets the latest version control change that is included in this build.
</summary>
<remarks>Note: for Git this is the commit ID. For TFVC this is the changeset.</remarks>
<value>
The SCM source version.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRepositoryInfo.SourceVersionMessage">
<summary>
Gets the comment of the commit or changeset.
</summary>
<remarks>Note: This variable is available in TFS 2015.4.</remarks>
<value>
The comment.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRepositoryInfo.Shelveset">
<summary>
Gets the name of the shelveset you are building, if you are running a gated build or a shelveset build.
</summary>
<remarks>Defined only if your repository is Team Foundation Version Control.</remarks>
<value>
The shelveset name.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRepositoryInfo.RepoName">
<summary>
Gets the name of the repository.
</summary>
<value>
The name of the repository.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRepositoryInfo.Provider">
<summary>
Gets the type of the current repository.
</summary>
<value>
The type of the current repository.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRepositoryInfo.GitSubmoduleCheckout">
<summary>
Gets the value you've selected for Checkout submodules on the repository tab.
</summary>
<value>
The checkout submodule value.
</value>
</member>
<member name="T:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRepositoryType">
<summary>
Provides the known values for the Azure Pipelines Repository types.
</summary>
</member>
<member name="F:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRepositoryType.TfsGit">
<summary>
TFS Git repository.
</summary>
</member>
<member name="F:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRepositoryType.TfsVersionControl">
<summary>
Team Foundation Version Control repository.
</summary>
</member>
<member name="F:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRepositoryType.Git">
<summary>
Git repository hosted on an external server.
</summary>
</member>
<member name="F:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRepositoryType.GitHub">
<summary>
GitHub repository.
</summary>
</member>
<member name="F:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRepositoryType.Svn">
<summary>
Subversion repository.
</summary>
</member>
<member name="T:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTaskResult">
<summary>
Provides the result of an Azure Pipelines task record.
</summary>
</member>
<member name="F:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTaskResult.Succeeded">
<summary>
Succeeded status.
</summary>
</member>
<member name="F:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTaskResult.SucceededWithIssues">
<summary>
Succeeded with issues status.
</summary>
</member>
<member name="F:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTaskResult.Failed">
<summary>
Failed status.
</summary>
</member>
<member name="F:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTaskResult.Cancelled">
<summary>
Cancelled status.
</summary>
</member>
<member name="F:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTaskResult.Skipped">
<summary>
Skipped status.
</summary>
</member>
<member name="T:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTaskStatus">
<summary>
Provides the status of an Azure Pipelines task record.
</summary>
</member>
<member name="F:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTaskStatus.Unknown">
<summary>
Unknown status.
</summary>
</member>
<member name="F:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTaskStatus.Initialized">
<summary>
Initialized status.
</summary>
</member>
<member name="F:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTaskStatus.InProgress">
<summary>
In progress status.
</summary>
</member>
<member name="F:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTaskStatus.Completed">
<summary>
Completed status.
</summary>
</member>
<member name="T:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTeamProjectInfo">
<summary>
Provides Azure Pipelines Team Project information for the current build.
</summary>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTeamProjectInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTeamProjectInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTeamProjectInfo.Name">
<summary>
Gets the name of the team project that contains this build.
</summary>
<value>
The name of the team project that contains this build.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTeamProjectInfo.Id">
<summary>
Gets the ID of the team project that contains this build.
</summary>
<value>
The ID of the team project that contains this build.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTeamProjectInfo.CollectionUri">
<summary>
Gets the URI of the team foundation collection.
</summary>
<value>
The URI of the team foundation collection.
</value>
</member>
<member name="T:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTestRunnerType">
<summary>
Test runner file formats supported on Azure Pipelines.
</summary>
</member>
<member name="F:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTestRunnerType.JUnit">
<summary>
JUnit Test Result Format
</summary>
</member>
<member name="F:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTestRunnerType.NUnit">
<summary>
NUnit (v2) Test Result Format
</summary>
</member>
<member name="F:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTestRunnerType.VSTest">
<summary>
Visual Studio (MSTest) Test Result Format
</summary>
</member>
<member name="F:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTestRunnerType.XUnit">
<summary>
XUnit Test Result Format
</summary>
</member>
<member name="T:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTriggeredBy">
<summary>
Provides Azure Pipelines Trigger information for the current build.
</summary>
<remarks>
Only populated if the build was triggered by another build.
</remarks>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTriggeredBy.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTriggeredBy"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTriggeredBy.BuildId">
<summary>
Gets the BuildID of the triggering build.
</summary>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTriggeredBy.DefinitionId">
<summary>
Gets the DefinitionID of the triggering build.
</summary>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTriggeredBy.DefinitionName">
<summary>
Gets the name of the triggering build pipeline.
</summary>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTriggeredBy.BuildNumber">
<summary>
Gets the number of the triggering build.
</summary>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTriggeredBy.ProjectId">
<summary>
Gets the ID of the project that contains the triggering build.
</summary>
</member>
<member name="T:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands">
<summary>
Represents an Azure Pipelines command provider.
</summary>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands.WriteWarning(System.String)">
<summary>
Log a warning issue to timeline record of current task.
</summary>
<param name="message">The warning message.</param>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands.WriteWarning(System.String,Cake.Common.Build.AzurePipelines.Data.AzurePipelinesMessageData)">
<summary>
Log a warning issue with detailed data to timeline record of current task.
</summary>
<param name="message">The warning message.</param>
<param name="data">The message data.</param>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands.WriteError(System.String)">
<summary>
Log an error to timeline record of current task.
</summary>
<param name="message">The error message.</param>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands.WriteError(System.String,Cake.Common.Build.AzurePipelines.Data.AzurePipelinesMessageData)">
<summary>
Log an error with detailed data to timeline record of current task.
</summary>
<param name="message">The error message.</param>
<param name="data">The message data.</param>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands.SetProgress(System.Int32,System.String)">
<summary>
Set progress and current operation for current task.
</summary>
<param name="progress">Current progress as percentage.</param>
<param name="currentOperation">The current operation.</param>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands.CompleteCurrentTask">
<summary>
Finish timeline record for current task and set task result to succeeded.
</summary>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands.CompleteCurrentTask(Cake.Common.Build.AzurePipelines.Data.AzurePipelinesTaskResult)">
<summary>
Finish timeline record for current task and set task result.
</summary>
<param name="result">The task result status.</param>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands.CreateNewRecord(System.String,System.String,System.Int32)">
<summary>
Create detail timeline record.
</summary>
<param name="name">Name of the new timeline record.</param>
<param name="type">Type of the new timeline record.</param>
<param name="order">Order of the timeline record.</param>
<returns>The timeline record ID.</returns>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands.CreateNewRecord(System.String,System.String,System.Int32,Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRecordData)">
<summary>
Create detail timeline record.
</summary>
<param name="name">Name of the new timeline record.</param>
<param name="type">Type of the new timeline record.</param>
<param name="order">Order of the timeline record.</param>
<param name="data">Additional data for the new timeline record.</param>
<returns>The timeline record ID.</returns>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands.UpdateRecord(System.Guid,Cake.Common.Build.AzurePipelines.Data.AzurePipelinesRecordData)">
<summary>
Update an existing detail timeline record.
</summary>
<param name="id">The ID of the existing timeline record.</param>
<param name="data">Additional data for the timeline record.</param>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands.SetVariable(System.String,System.String)">
<summary>
Sets a variable in the variable service of the task context.
</summary>
<remarks>
The variable is exposed to following tasks as an environment variable.
</remarks>
<param name="name">The variable name.</param>
<param name="value">The variable value.</param>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands.SetOutputVariable(System.String,System.String)">
<summary>
Sets a output variable in the variable service of the task context.
</summary>
<remarks>
The variable is exposed to following tasks as an environment variable.
</remarks>
<param name="name">The variable name.</param>
<param name="value">The variable value.</param>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands.SetSecretVariable(System.String,System.String)">
<summary>
Sets a secret variable in the variable service of the task context.
</summary>
<remarks>
The variable is not exposed to following tasks as an environment variable, and must be passed as inputs.
</remarks>
<param name="name">The variable name.</param>
<param name="value">The variable value.</param>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands.UploadTaskSummary(Cake.Core.IO.FilePath)">
<summary>
Upload and attach summary markdown to current timeline record.
</summary>
<remarks>
This summary is added to the build/release summary and is not available for download with logs.
</remarks>
<param name="markdownPath">Path to the summary markdown file.</param>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands.UploadTaskLogFile(Cake.Core.IO.FilePath)">
<summary>
Upload file as additional log information to the current timeline record.
</summary>
<remarks>
<para>
The file shall be available for download along with task logs.
</para>
<para>
Requires agent version 1.101.
</para>
</remarks>
<param name="logFile">Path to the additional log file.</param>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands.LinkArtifact(System.String,Cake.Common.Build.AzurePipelines.Data.AzurePipelinesArtifactType,System.String)">
<summary>
Create an artifact link, such as a file or folder path or a version control path.
</summary>
<param name="name">The artifact name.</param>
<param name="type">The artifact type.</param>
<param name="location">The link path or value.</param>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands.UploadArtifact(System.String,Cake.Core.IO.FilePath)">
<summary>
Upload local file into a file container folder.
</summary>
<param name="folderName">Folder that the file will upload to.</param>
<param name="file">Path to the local file.</param>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands.UploadArtifact(System.String,Cake.Core.IO.FilePath,System.String)">
<summary>
Upload local file into a file container folder, and create an artifact.
</summary>
<param name="folderName">Folder that the file will upload to.</param>
<param name="file">Path to the local file.</param>
<param name="artifactName">The artifact name.</param>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands.UploadArtifactDirectory(Cake.Core.IO.DirectoryPath)">
<summary>
Upload local directory as a container folder, and create an artifact.
</summary>
<param name="directory">Path to the local directory.</param>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands.UploadArtifactDirectory(Cake.Core.IO.DirectoryPath,System.String)">
<summary>
Upload local directory as a container folder, and create an artifact with the specified name.
</summary>
<param name="directory">Path to the local directory.</param>
<param name="artifactName">The artifact name.</param>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands.UploadBuildLogFile(Cake.Core.IO.FilePath)">
<summary>
Upload additional log to build container's <c>logs/tool</c> folder.
</summary>
<param name="logFile">The log file.</param>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands.UpdateBuildNumber(System.String)">
<summary>
Update build number for current build.
</summary>
<remarks>
Requires agent version 1.88.
</remarks>
<param name="buildNumber">The build number.</param>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands.AddBuildTag(System.String)">
<summary>
Add a tag for current build.
</summary>
<remarks>
Requires agent version 1.95.
</remarks>
<param name="tag">The tag.</param>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands.PublishTestResults(Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPublishTestResultsData)">
<summary>
Publishes and uploads tests results.
</summary>
<param name="data">The publish test results data.</param>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands.PublishCodeCoverage(Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPublishCodeCoverageData)">
<summary>
Publishes and uploads code coverage results.
</summary>
<param name="data">The code coverage data.</param>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands.PublishCodeCoverage(Cake.Core.IO.FilePath,Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPublishCodeCoverageData)">
<summary>
Publishes and uploads code coverage results.
</summary>
<param name="summaryFilePath">The code coverage summary file path.</param>
<param name="data">The code coverage data.</param>
</member>
<member name="M:Cake.Common.Build.AzurePipelines.IAzurePipelinesCommands.PublishCodeCoverage(Cake.Core.IO.FilePath,System.Action{Cake.Common.Build.AzurePipelines.Data.AzurePipelinesPublishCodeCoverageData})">
<summary>
Publishes and uploads code coverage results.
</summary>
<param name="summaryFilePath">The code coverage summary file path.</param>
<param name="action">The configuration action for the code coverage data.</param>
</member>
<member name="T:Cake.Common.Build.AzurePipelines.IAzurePipelinesProvider">
<summary>
Represents a Azure Pipelines provider.
</summary>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.IAzurePipelinesProvider.IsRunningOnAzurePipelines">
<summary>
Gets a value indicating whether the current build is running on Azure Pipelines.
</summary>
<value>
<c>true</c> if the current build is running on Azure Pipelines; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.IAzurePipelinesProvider.Environment">
<summary>
Gets the Azure Pipelines environment.
</summary>
<value>
The Azure Pipelines environment.
</value>
</member>
<member name="P:Cake.Common.Build.AzurePipelines.IAzurePipelinesProvider.Commands">
<summary>
Gets the Azure Pipelines Commands provider.
</summary>
<value>
The Azure Pipelines commands provider.
</value>
</member>
<member name="T:Cake.Common.Build.Bamboo.BambooInfo">
<summary>
Base class used to provide information about the Bamboo environment.
</summary>
</member>
<member name="M:Cake.Common.Build.Bamboo.BambooInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.Bamboo.BambooInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="M:Cake.Common.Build.Bamboo.BambooInfo.GetEnvironmentString(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.String"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.Bamboo.BambooInfo.GetEnvironmentInteger(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Int32"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.Bamboo.BambooInfo.GetEnvironmentBoolean(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Boolean"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="T:Cake.Common.Build.Bamboo.BambooProvider">
<summary>
Responsible for communicating with Bamboo.
</summary>
</member>
<member name="M:Cake.Common.Build.Bamboo.BambooProvider.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.Bamboo.BambooProvider"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.Bamboo.BambooProvider.IsRunningOnBamboo">
<inheritdoc/>
</member>
<member name="P:Cake.Common.Build.Bamboo.BambooProvider.Environment">
<inheritdoc/>
</member>
<member name="T:Cake.Common.Build.Bamboo.Data.BambooBuildInfo">
<summary>
Provides Bamboo build information for a current build.
</summary>
</member>
<member name="P:Cake.Common.Build.Bamboo.Data.BambooBuildInfo.Folder">
<summary>
Gets the path to the clone directory.
</summary>
<value>
The path to the clone directory.
</value>
</member>
<member name="P:Cake.Common.Build.Bamboo.Data.BambooBuildInfo.Number">
<summary>
Gets the build number.
</summary>
<value>
The build number.
</value>
</member>
<member name="P:Cake.Common.Build.Bamboo.Data.BambooBuildInfo.BuildKey">
<summary>
Gets the job key for the current job, in the form PROJECT-PLAN-JOB, e.g. BAM-MAIN-JOBX.
</summary>
<value>
The Bamboo Build Key.
</value>
</member>
<member name="P:Cake.Common.Build.Bamboo.Data.BambooBuildInfo.ResultKey">
<summary>
Gets the Bamboo Build Result Key.
The result key when this job executes, in the form PROJECT-PLAN-JOB-BUILD e.g. BAM-BOO-JOB1-8, where '8' is the build number.
For deployment projects this variable will not have the JOB component e.g. PROJ-TP-6.
</summary>
<value>
The Build Result Key.
</value>
</member>
<member name="P:Cake.Common.Build.Bamboo.Data.BambooBuildInfo.ResultsUrl">
<summary>
Gets the URL of the result in Bamboo once the job has finished executing.
</summary>
<value>
The Bamboo build result url.
</value>
</member>
<member name="P:Cake.Common.Build.Bamboo.Data.BambooBuildInfo.BuildTimestamp">
<summary>
Gets the time when build was started in ISO 8601 format e.g. 2010-01-01T01:00:00.000+01:00.
</summary>
<value>
The Bamboo build timestamp.
</value>
</member>
<member name="P:Cake.Common.Build.Bamboo.Data.BambooBuildInfo.CustomBuild">
<summary>
Gets Bamboo custom build information.
</summary>
<value>
The Bamboo custom build information.
</value>
</member>
<member name="M:Cake.Common.Build.Bamboo.Data.BambooBuildInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.Bamboo.Data.BambooBuildInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.Bamboo.Data.BambooCommitInfo">
<summary>
Provides Bamboo commit information for a current build.
</summary>
</member>
<member name="P:Cake.Common.Build.Bamboo.Data.BambooCommitInfo.RepositoryRevision">
<summary>
Gets the revision use to build this release. Format depends on the VCS used.
</summary>
<value>
The commit ID (SHA).
</value>
</member>
<member name="M:Cake.Common.Build.Bamboo.Data.BambooCommitInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.Bamboo.Data.BambooCommitInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.Bamboo.Data.BambooCustomBuildInfo">
<summary>
Provides Bamboo tag information for a current build.
</summary>
</member>
<member name="P:Cake.Common.Build.Bamboo.Data.BambooCustomBuildInfo.IsCustomBuild">
<summary>
Gets a value indicating whether build was started by pushed tag.
</summary>
<value>
<c>true</c> if build was started by pushed tag; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.Bamboo.Data.BambooCustomBuildInfo.RevisonName">
<summary>
Gets the name for builds started by tag; otherwise this variable is undefined.
</summary>
<value>
The name of the tag.
</value>
</member>
<member name="M:Cake.Common.Build.Bamboo.Data.BambooCustomBuildInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.Bamboo.Data.BambooCustomBuildInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.Bamboo.Data.BambooEnvironmentInfo">
<summary>
Provides Bamboo environment information for a current build.
</summary>
</member>
<member name="P:Cake.Common.Build.Bamboo.Data.BambooEnvironmentInfo.Plan">
<summary>
Gets Bamboo plan information.
</summary>
<value>
The Bamboo plan information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.Bamboo.IsRunningOnBamboo)
{
Information(
@"Build:
Plan Name: {0}
Short Plan Name: {1}
Plan Key: {2}
Short Plan Key: {3}
Short Job Key: {4}
Short Job Name: {5}",
BuildSystem.Bamboo.Environment.Plan.PlanName,
BuildSystem.Bamboo.Environment.Plan.ShortPlanName,
BuildSystem.Bamboo.Environment.Plan.PlanKey,
BuildSystem.Bamboo.Environment.Plan.ShortPlanKey,
BuildSystem.Bamboo.Environment.Plan.ShortJobKey,
BuildSystem.Bamboo.Environment.Plan.ShortJobName
);
}
else
{
Information("Not running on Bamboo");
}
</code>
</example>
<para>Via Bamboo.</para>
<example>
<code>
if (Bamboo.IsRunningOnBamboo)
{
Information(
@"Build:
Plan Name: {0}
Short Plan Name: {1}
Plan Key: {2}
Short Plan Key: {3}
Short Job Key: {4}
Short Job Name: {5}",
Bamboo.Environment.Plan.PlanName,
Bamboo.Environment.Plan.ShortPlanName,
Bamboo.Environment.Plan.PlanKey,
Bamboo.Environment.Plan.ShortPlanKey,
Bamboo.Environment.Plan.ShortJobKey,
Bamboo.Environment.Plan.ShortJobName
);
}
else
{
Information("Not running on Bamboo");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.Bamboo.Data.BambooEnvironmentInfo.Build">
<summary>
Gets Bamboo build information.
</summary>
<value>
The Bamboo build information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.Bamboo.IsRunningOnBamboo)
{
Information(
@"Build:
Folder: {0}
Number: {1}
Build Key: {2}
Result Key: {3}
Results Url: {4}
Build Timestamp: {5}
Is Custom: {6}
Revision Name: {7}",
BuildSystem.Bamboo.Environment.Build.Folder,
BuildSystem.Bamboo.Environment.Build.Number,
BuildSystem.Bamboo.Environment.Build.BuildKey,
BuildSystem.Bamboo.Environment.Build.ResultKey,
BuildSystem.Bamboo.Environment.Build.ResultsUrl,
BuildSystem.Bamboo.Environment.Build.BuildTimestamp,
BuildSystem.Bamboo.Environment.Build.CustomBuild.IsCustomBuild,
BuildSystem.Bamboo.Environment.Build.CustomBuild.RevisionName);
}
else
{
Information("Not running on Bamboo");
}
</code>
</example>
<para>Via Bamboo.</para>
<example>
<code>
if (Bamboo.IsRunningOnBamboo)
{
Information(
@"Build:
Folder: {0}
Number: {1}
Build Key: {2}
Result Key: {3}
Results Url: {4}
Build Timestamp: {5}
Is Custom: {6}
Revision Name: {7}",
Bamboo.Environment.Build.Folder,
Bamboo.Environment.Build.Number,
Bamboo.Environment.Build.BuildKey,
Bamboo.Environment.Build.ResultKey,
Bamboo.Environment.Build.ResultsUrl,
Bamboo.Environment.Build.BuildTimestamp,
Bamboo.Environment.Build.CustomBuild.IsCustomBuild,
Bamboo.Environment.Build.CustomBuild.RevisionName);
}
else
{
Information("Not running on Bamboo");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.Bamboo.Data.BambooEnvironmentInfo.Repository">
<summary>
Gets Bamboo repository information.
</summary>
<value>
The Bamboo repository information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.Bamboo.IsRunningOnBamboo)
{
Information(
@"Repository:
Branch: {0}
Name: {1}
Repository Revision: {2}
Scm: {3}",
BuildSystem.Bamboo.Environment.Repository.Branch,
BuildSystem.Bamboo.Environment.Repository.Name,
BuildSystem.Bamboo.Environment.Repository.Commit.RepositoryRevision,
BuildSystem.Bamboo.Environment.Repository.Scm
);
}
else
{
Information("Not running on Bamboo");
}
</code>
</example>
<para>Via Bamboo.</para>
<example>
<code>
if (Bamboo.IsRunningOnBamboo)
{
Information(
@"Repository:
Branch: {0}
Name: {1}
Repository Revision: {2}
Scm: {3}",
Bamboo.Environment.Repository.Branch,
Bamboo.Environment.Repository.Name,
Bamboo.Environment.Repository.Commit.RepositoryRevision,
Bamboo.Environment.Repository.Scm
);
}
else
{
Information("Not running on Bamboo");
}
</code>
</example>
</member>
<member name="M:Cake.Common.Build.Bamboo.Data.BambooEnvironmentInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.Bamboo.Data.BambooEnvironmentInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.Bamboo.Data.BambooPlanInfo">
<summary>
Provides Bamboo project information for a current build.
</summary>
</member>
<member name="P:Cake.Common.Build.Bamboo.Data.BambooPlanInfo.PlanName">
<summary>
Gets the Bamboo Plan Name.
</summary>
<value>
The Bamboo Plan Name.
</value>
</member>
<member name="P:Cake.Common.Build.Bamboo.Data.BambooPlanInfo.ShortPlanName">
<summary>
Gets the Bamboo short Plan Name.
</summary>
<value>
The Bamboo Plan Name in its short form.
</value>
</member>
<member name="P:Cake.Common.Build.Bamboo.Data.BambooPlanInfo.PlanKey">
<summary>
Gets the key of the current plan, in the form PROJECT-PLAN, e.g. BAM-MAIN.
</summary>
<value>
The project name.
</value>
</member>
<member name="P:Cake.Common.Build.Bamboo.Data.BambooPlanInfo.ShortPlanKey">
<summary>
Gets the Bamboo short Plan Key.
</summary>
<value>
The Bamboo Plan Key in its short form.
</value>
</member>
<member name="P:Cake.Common.Build.Bamboo.Data.BambooPlanInfo.ShortJobKey">
<summary>
Gets the Bamboo short job key.
</summary>
<value>
The Bamboo job key in its short form.
</value>
</member>
<member name="P:Cake.Common.Build.Bamboo.Data.BambooPlanInfo.ShortJobName">
<summary>
Gets the Bamboo short Job Name.
</summary>
<value>
The Bamboo Job Name in its short form.
</value>
</member>
<member name="M:Cake.Common.Build.Bamboo.Data.BambooPlanInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.Bamboo.Data.BambooPlanInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.Bamboo.Data.BambooRepositoryInfo">
<summary>
Provides Bamboo repository information for a current build.
</summary>
</member>
<member name="P:Cake.Common.Build.Bamboo.Data.BambooRepositoryInfo.Scm">
<summary>
Gets the revision control system.
<list type="bullet">
<item>
<description>Subversion</description>
</item>
<item>
<description>CVS</description>
</item>
<item>
<description>Perforce</description>
</item>
<item>
<description>Git</description>
</item>
<item>
<description>Mercurial</description>
</item>
</list>
</summary>
<value>
The revision control system.
</value>
</member>
<member name="P:Cake.Common.Build.Bamboo.Data.BambooRepositoryInfo.Name">
<summary>
Gets the repository name as named in Bamboo.
</summary>
<value>
The bamboo repository name.
</value>
</member>
<member name="P:Cake.Common.Build.Bamboo.Data.BambooRepositoryInfo.Branch">
<summary>
Gets the build branch.
</summary>
<value>
The build branch.
</value>
</member>
<member name="P:Cake.Common.Build.Bamboo.Data.BambooRepositoryInfo.Commit">
<summary>
Gets the commit information for the build.
</summary>
<value>
The commit information for the build.
</value>
</member>
<member name="M:Cake.Common.Build.Bamboo.Data.BambooRepositoryInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.Bamboo.Data.BambooRepositoryInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.Bamboo.IBambooProvider">
<summary>
Represents a Bamboo provider.
</summary>
</member>
<member name="P:Cake.Common.Build.Bamboo.IBambooProvider.IsRunningOnBamboo">
<summary>
Gets a value indicating whether the current build is running on Bamboo.
</summary>
<value>
<c>true</c> if the current build is running on Bamboo; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.Bamboo.IBambooProvider.Environment">
<summary>
Gets the Bamboo environment.
</summary>
<value>
The Bamboo environment.
</value>
</member>
<member name="T:Cake.Common.Build.BitbucketPipelines.BitbucketPipelinesInfo">
<summary>
Base class used to provide information about the Bitbucket Pipelines environment.
</summary>
</member>
<member name="M:Cake.Common.Build.BitbucketPipelines.BitbucketPipelinesInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.BitbucketPipelines.BitbucketPipelinesInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="M:Cake.Common.Build.BitbucketPipelines.BitbucketPipelinesInfo.GetEnvironmentString(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.String"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.BitbucketPipelines.BitbucketPipelinesInfo.GetEnvironmentInteger(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Int32"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="T:Cake.Common.Build.BitbucketPipelines.BitbucketPipelinesProvider">
<summary>
Responsible for communicating with Pipelines.
</summary>
</member>
<member name="P:Cake.Common.Build.BitbucketPipelines.BitbucketPipelinesProvider.IsRunningOnBitbucketPipelines">
<inheritdoc/>
</member>
<member name="P:Cake.Common.Build.BitbucketPipelines.BitbucketPipelinesProvider.Environment">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.BitbucketPipelines.BitbucketPipelinesProvider.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.BitbucketPipelines.BitbucketPipelinesProvider"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.BitbucketPipelines.Data.BitbucketPipelinesEnvironmentInfo">
<summary>
Provides Bitbucket Pipelines environment information for the current build.
</summary>
</member>
<member name="P:Cake.Common.Build.BitbucketPipelines.Data.BitbucketPipelinesEnvironmentInfo.Repository">
<summary>
Gets Bitbucket Pipelines repository information.
</summary>
<value>
The repository.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.BitbucketPipelines.IsRunningOnBitbucketPipelines)
{
Information(
@"Repository:
Branch: {0}
Tag: {1}
Commit: {2}
Repo Owner: {3}
Repo Slug: {4}",
BuildSystem.BitbucketPipelines.Environment.Repository.Branch,
BuildSystem.BitbucketPipelines.Environment.Repository.Tag,
BuildSystem.BitbucketPipelines.Environment.Repository.Commit,
BuildSystem.BitbucketPipelines.Environment.Repository.RepoOwner,
BuildSystem.BitbucketPipelines.Environment.Repository.RepoSlug
);
}
else
{
Information("Not running on BitbucketPipelines");
}
</code>
</example>
<para>Via BitbucketPipelines.</para>
<example>
<code>
if (BitbucketPipelines.IsRunningOnBitbucketPipelines)
{
Information(
@"Repository:
Branch: {0}
Tag: {1}
Commit: {2}
Repo Owner: {3}
Repo Slug: {4}",
BitbucketPipelines.Environment.Repository.Branch,
BitbucketPipelines.Environment.Repository.Tag,
BitbucketPipelines.Environment.Repository.Commit,
BitbucketPipelines.Environment.Repository.RepoOwner,
BitbucketPipelines.Environment.Repository.RepoSlug
);
}
else
{
Information("Not running on BitbucketPipelines");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.BitbucketPipelines.Data.BitbucketPipelinesEnvironmentInfo.PullRequest">
<summary>
Gets Bitbucket Pipelines pull request information.
</summary>
<value>
The Bitbucket Pipelines pull request information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.BitbucketPipelines.IsRunningOnBitbucketPipelines)
{
Information(
@"PullRequest:
IsPullRequest: {0}
Id: {1}",
BuildSystem.BitbucketPipelines.Environment.PullRequest.IsPullRequest,
BuildSystem.BitbucketPipelines.Environment.PullRequest.Id
);
}
else
{
Information("Not running on BitbucketPipelines");
}
</code>
</example>
<para>Via BitbucketPipelines.</para>
<example>
<code>
if (BitbucketPipelines.IsRunningOnBitbucketPipelines)
{
Information(
@"PullRequest:
IsPullRequest: {0}
Id: {1}",
BitbucketPipelines.Environment.PullRequest.IsPullRequest,
BitbucketPipelines.Environment.PullRequest.Id
);
}
else
{
Information("Not running on BitbucketPipelines");
}
</code>
</example>
</member>
<member name="M:Cake.Common.Build.BitbucketPipelines.Data.BitbucketPipelinesEnvironmentInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.BitbucketPipelines.Data.BitbucketPipelinesEnvironmentInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.BitbucketPipelines.Data.BitbucketPipelinesPullRequestInfo">
<summary>
Provides BitbucketPipelines pull request information for a current build.
</summary>
</member>
<member name="M:Cake.Common.Build.BitbucketPipelines.Data.BitbucketPipelinesPullRequestInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.BitbucketPipelines.Data.BitbucketPipelinesPullRequestInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.BitbucketPipelines.Data.BitbucketPipelinesPullRequestInfo.IsPullRequest">
<summary>
Gets a value indicating whether the current build was started by a pull request.
</summary>
<value>
<c>true</c> if the current build was started by a pull request; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.BitbucketPipelines.Data.BitbucketPipelinesPullRequestInfo.Id">
<summary>
Gets the pull request id.
</summary>
<value>
The pull request id.
</value>
</member>
<member name="T:Cake.Common.Build.BitbucketPipelines.Data.BitbucketPipelinesRepositoryInfo">
<summary>
Provides Bitbucket Pipelines repository information for the current build.
</summary>
</member>
<member name="P:Cake.Common.Build.BitbucketPipelines.Data.BitbucketPipelinesRepositoryInfo.Branch">
<summary>
Gets the branch on which the build was kicked off. This value is only available on branches.
</summary>
<remarks>Note: <see cref="P:Cake.Common.Build.BitbucketPipelines.Data.BitbucketPipelinesRepositoryInfo.Branch"/> and <see cref="P:Cake.Common.Build.BitbucketPipelines.Data.BitbucketPipelinesRepositoryInfo.Tag"/> are mutually exclusive. If you use both, only one will have a value.</remarks>
<value>
The SCM branch.
</value>
</member>
<member name="P:Cake.Common.Build.BitbucketPipelines.Data.BitbucketPipelinesRepositoryInfo.Tag">
<summary>
Gets the tag on which the build was kicked off. This value is only available when tagged.
</summary>
<remarks>Note: <see cref="P:Cake.Common.Build.BitbucketPipelines.Data.BitbucketPipelinesRepositoryInfo.Branch"/> and <see cref="P:Cake.Common.Build.BitbucketPipelines.Data.BitbucketPipelinesRepositoryInfo.Tag"/> are mutually exclusive. If you use both, only one will have a value.</remarks>
<value>
The SCM tag.
</value>
</member>
<member name="P:Cake.Common.Build.BitbucketPipelines.Data.BitbucketPipelinesRepositoryInfo.Commit">
<summary>
Gets the commit hash of a commit that kicked off the build.
</summary>
<value>
The SCM commit.
</value>
</member>
<member name="P:Cake.Common.Build.BitbucketPipelines.Data.BitbucketPipelinesRepositoryInfo.RepoOwner">
<summary>
Gets the name of the account in which the repository lives.
</summary>
<value>
The repository owner account.
</value>
</member>
<member name="P:Cake.Common.Build.BitbucketPipelines.Data.BitbucketPipelinesRepositoryInfo.RepoSlug">
<summary>
Gets the URL-friendly version of a repository name.
</summary>
<value>
The URL-friendly repository name.
</value>
</member>
<member name="M:Cake.Common.Build.BitbucketPipelines.Data.BitbucketPipelinesRepositoryInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.BitbucketPipelines.Data.BitbucketPipelinesRepositoryInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.BitbucketPipelines.IBitbucketPipelinesProvider">
<summary>
Represents a Bitrise provider.
</summary>
</member>
<member name="P:Cake.Common.Build.BitbucketPipelines.IBitbucketPipelinesProvider.IsRunningOnBitbucketPipelines">
<summary>
Gets a value indicating whether the current build is running on Bitbucket Pipelines.
</summary>
<value>
<c>true</c> if the current build is running on Bitbucket Pipelines; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.BitbucketPipelines.IBitbucketPipelinesProvider.Environment">
<summary>
Gets the Bitbucket Pipelines environment.
</summary>
<value>
The Bitbucket Pipelines environment.
</value>
</member>
<member name="T:Cake.Common.Build.Bitrise.BitriseInfo">
<summary>
Base class used to provide information about the Bamboo environment.
</summary>
</member>
<member name="M:Cake.Common.Build.Bitrise.BitriseInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.Bitrise.BitriseInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="M:Cake.Common.Build.Bitrise.BitriseInfo.GetEnvironmentString(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.String"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.Bitrise.BitriseInfo.GetEnvironmentInteger(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Int32"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.Bitrise.BitriseInfo.GetEnvironmentBoolean(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Boolean"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="T:Cake.Common.Build.Bitrise.BitriseProvider">
<summary>
Responsible for communicating with Bitrise.
</summary>
</member>
<member name="P:Cake.Common.Build.Bitrise.BitriseProvider.IsRunningOnBitrise">
<inheritdoc/>
</member>
<member name="P:Cake.Common.Build.Bitrise.BitriseProvider.Environment">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.Bitrise.BitriseProvider.#ctor(Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.Bitrise.BitriseProvider"/> class.
</summary>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
</member>
<member name="M:Cake.Common.Build.Bitrise.BitriseProvider.SetEnvironmentString(System.String,System.String)">
<inheritdoc/>
</member>
<member name="T:Cake.Common.Build.Bitrise.Data.BitriseApplicationInfo">
<summary>
Provides Bitrise application information for the current build.
</summary>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitriseApplicationInfo.ApplicationTitle">
<summary>
Gets the application title.
</summary>
<value>
The application title.
</value>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitriseApplicationInfo.ApplicationUrl">
<summary>
Gets the application URL.
</summary>
<value>
The application URL.
</value>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitriseApplicationInfo.AppSlug">
<summary>
Gets the application slug.
</summary>
<value>
The application slug.
</value>
</member>
<member name="M:Cake.Common.Build.Bitrise.Data.BitriseApplicationInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.Bitrise.Data.BitriseApplicationInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.Bitrise.Data.BitriseBuildInfo">
<summary>
Provides Bitrise build information for the current build.
</summary>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitriseBuildInfo.BuildNumber">
<summary>
Gets the build number.
</summary>
<value>
The build number.
</value>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitriseBuildInfo.BuildUrl">
<summary>
Gets the build URL.
</summary>
<value>
The build URL.
</value>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitriseBuildInfo.BuildSlug">
<summary>
Gets the build slug.
</summary>
<value>
The build slug.
</value>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitriseBuildInfo.BuildTriggerTimestamp">
<summary>
Gets the build trigger timestamp.
</summary>
<value>
The build trigger timestamp.
</value>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitriseBuildInfo.BuildStatus">
<summary>
Gets a value indicating whether the build is passing.
</summary>
<value>
<c>true</c> if [build status]; otherwise, <c>false</c>.
</value>
</member>
<member name="M:Cake.Common.Build.Bitrise.Data.BitriseBuildInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.Bitrise.Data.BitriseBuildInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.Bitrise.Data.BitriseDirectoryInfo">
<summary>
Provides Bitrise directory information for the current build.
</summary>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitriseDirectoryInfo.SourceDirectory">
<summary>
Gets the source directory.
</summary>
<value>
The source directory.
</value>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitriseDirectoryInfo.DeployDirectory">
<summary>
Gets the deploy directory.
</summary>
<value>
The deploy directory.
</value>
</member>
<member name="M:Cake.Common.Build.Bitrise.Data.BitriseDirectoryInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.Bitrise.Data.BitriseDirectoryInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.Bitrise.Data.BitriseEnvironmentInfo">
<summary>
Provides Bitrise environment information for the current build.
</summary>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitriseEnvironmentInfo.Application">
<summary>
Gets Bitrise application information.
</summary>
<value>
The application.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.Bitrise.IsRunningOnBitrise)
{
Information(
@"Application:
Title: {0}
Url: {1}
Slug: {2}",
BuildSystem.Bitrise.Environment.Application.ApplicationTitle,
BuildSystem.Bitrise.Environment.Application.ApplicationUrl,
BuildSystem.Bitrise.Environment.Application.AppSlug
);
}
else
{
Information("Not running on Bitrise");
}
</code>
</example>
<para>Via Bitrise.</para>
<example>
<code>
if (Bitrise.IsRunningOnBitrise)
{
Information(
@"Application:
Title: {0}
Url: {1}
Slug: {2}",
Bitrise.Environment.Application.ApplicationTitle,
Bitrise.Environment.Application.ApplicationUrl,
Bitrise.Environment.Application.AppSlug
);
}
else
{
Information("Not running on Bitrise");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitriseEnvironmentInfo.Build">
<summary>
Gets Bitrise build information.
</summary>
<value>
The build.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.Bitrise.IsRunningOnBitrise)
{
Information(
@"Build:
Build Number: {0}
Build Url: {1}
Build Slug: {2}
Build Trigger Timestamp: {3}
Build Status: {4}",
BuildSystem.Bitrise.Environment.Build.BuildNumber,
BuildSystem.Bitrise.Environment.Build.BuildUrl,
BuildSystem.Bitrise.Environment.Build.BuildSlug,
BuildSystem.Bitrise.Environment.Build.BuildTriggerTimestamp,
BuildSystem.Bitrise.Environment.Build.BuildStatus
);
}
else
{
Information("Not running on Bitrise");
}
</code>
</example>
<para>Via Bitrise.</para>
<example>
<code>
if (Bitrise.IsRunningOnBitrise)
{
Information(
@"Build:
Build Number: {0}
Build Url: {1}
Build Slug: {2}
Build Trigger Timestamp: {3}
Build Status: {4}",
Bitrise.Environment.Build.BuildNumber,
Bitrise.Environment.Build.BuildUrl,
Bitrise.Environment.Build.BuildSlug,
Bitrise.Environment.Build.BuildTriggerTimestamp,
Bitrise.Environment.Build.BuildStatus
);
}
else
{
Information("Not running on Bitrise");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitriseEnvironmentInfo.PullRequest">
<summary>
Gets Bitrise pull request information.
</summary>
<value>
The Bitrise pull request information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.Bitrise.IsRunningOnBitrise)
{
Information(
@"PullRequest:
IsPullRequest: {0}
Id: {1}",
BuildSystem.Bitrise.Environment.PullRequest.IsPullRequest,
BuildSystem.Bitrise.Environment.PullRequest.Id
);
}
else
{
Information("Not running on Bitrise");
}
</code>
</example>
<para>Via Bitrise.</para>
<example>
<code>
if (Bitrise.IsRunningOnBitrise)
{
Information(
@"PullRequest:
IsPullRequest: {0}
Id: {1}",
Bitrise.Environment.PullRequest.IsPullRequest,
Bitrise.Environment.PullRequest.Id
);
}
else
{
Information("Not running on Bitrise");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitriseEnvironmentInfo.Directory">
<summary>
Gets Bitrise directory information.
</summary>
<value>
The directory.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.Bitrise.IsRunningOnBitrise)
{
Information(
@"Directory:
Source Directory: {0}
Deploy Directory: {1}",
BuildSystem.Bitrise.Environment.Directory.SourceDirectory,
BuildSystem.Bitrise.Environment.Directory.DeployDirectory
);
}
else
{
Information("Not running on Bitrise");
}
</code>
</example>
<para>Via Bitrise.</para>
<example>
<code>
if (Bitrise.IsRunningOnBitrise)
{
Information(
@"Directory:
Source Directory: {0}
Deploy Directory: {1}",
Bitrise.Environment.Directory.SourceDirectory,
Bitrise.Environment.Directory.DeployDirectory
);
}
else
{
Information("Not running on Bitrise");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitriseEnvironmentInfo.Provisioning">
<summary>
Gets Bitrise provisioning information.
</summary>
<value>
The provisioning.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.Bitrise.IsRunningOnBitrise)
{
Information(
@"Provisioning:
Provision Url: {0}
Certificate Url: {1}
Certificate Passphrase: {2}",
BuildSystem.Bitrise.Environment.Provisioning.ProvisionUrl,
BuildSystem.Bitrise.Environment.Provisioning.CertificateUrl,
BuildSystem.Bitrise.Environment.Provisioning.CertificatePassphrase
);
}
else
{
Information("Not running on Bitrise");
}
</code>
</example>
<para>Via Bitrise.</para>
<example>
<code>
if (Bitrise.IsRunningOnBitrise)
{
Information(
@"Provisioning:
Provision Url: {0}
Certificate Url: {1}
Certificate Passphrase: {2}",
Bitrise.Environment.Provisioning.ProvisionUrl,
Bitrise.Environment.Provisioning.CertificateUrl,
Bitrise.Environment.Provisioning.CertificatePassphrase
);
}
else
{
Information("Not running on Bitrise");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitriseEnvironmentInfo.Repository">
<summary>
Gets Bitrise repository information.
</summary>
<value>
The repository.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.Bitrise.IsRunningOnBitrise)
{
Information(
@"Repository:
Git Repository Url: {0}
Git Branch: {1}
Git Tag: {2}
Git Commit: {3}
Pull Request: {4}",
BuildSystem.Bitrise.Environment.Repository.GitRepositoryUrl,
BuildSystem.Bitrise.Environment.Repository.GitBranch,
BuildSystem.Bitrise.Environment.Repository.GitTag,
BuildSystem.Bitrise.Environment.Repository.GitCommit,
BuildSystem.Bitrise.Environment.Repository.PullRequest
);
}
else
{
Information("Not running on Bitrise");
}
</code>
</example>
<para>Via Bitrise.</para>
<example>
<code>
if (Bitrise.IsRunningOnBitrise)
{
Information(
@"Repository:
Git Repository Url: {0}
Git Branch: {1}
Git Tag: {2}
Git Commit: {3}
Pull Request: {4}",
Bitrise.Environment.Repository.GitRepositoryUrl,
Bitrise.Environment.Repository.GitBranch,
Bitrise.Environment.Repository.GitTag,
Bitrise.Environment.Repository.GitCommit,
Bitrise.Environment.Repository.PullRequest
);
}
else
{
Information("Not running on Bitrise");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitriseEnvironmentInfo.Workflow">
<summary>
Gets Bitrise workflow information.
</summary>
<value>
The workflow.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.Bitrise.IsRunningOnBitrise)
{
Information(
@"Workflow:
Workflow Id: {0}
Workflow Title: {1}",
BuildSystem.Bitrise.Environment.Workflow.WorkflowId,
BuildSystem.Bitrise.Environment.Workflow.WorkflowTitle
);
}
else
{
Information("Not running on Bitrise");
}
</code>
</example>
<para>Via Bitrise.</para>
<example>
<code>
if (Bitrise.IsRunningOnBitrise)
{
Information(
@"Workflow:
Workflow Id: {0}
Workflow Title: {1}",
Bitrise.Environment.Workflow.WorkflowId,
Bitrise.Environment.Workflow.WorkflowTitle
);
}
else
{
Information("Not running on Bitrise");
}
</code>
</example>
</member>
<member name="M:Cake.Common.Build.Bitrise.Data.BitriseEnvironmentInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.Bitrise.Data.BitriseEnvironmentInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.Bitrise.Data.BitriseProvisioningInfo">
<summary>
Provides Bitrise provisioning information for the current build.
</summary>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitriseProvisioningInfo.ProvisionUrl">
<summary>
Gets the provision URL.
</summary>
<value>
The provision URL.
</value>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitriseProvisioningInfo.CertificateUrl">
<summary>
Gets the certificate URL.
</summary>
<value>
The certificate URL.
</value>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitriseProvisioningInfo.CertificatePassphrase">
<summary>
Gets the certificate passphrase.
</summary>
<value>
The certificate passphrase.
</value>
</member>
<member name="M:Cake.Common.Build.Bitrise.Data.BitriseProvisioningInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.Bitrise.Data.BitriseProvisioningInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.Bitrise.Data.BitrisePullRequestInfo">
<summary>
Provides Bitrise pull request information for a current build.
</summary>
</member>
<member name="M:Cake.Common.Build.Bitrise.Data.BitrisePullRequestInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.Bitrise.Data.BitrisePullRequestInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitrisePullRequestInfo.IsPullRequest">
<summary>
Gets a value indicating whether the current build was started by a pull request.
</summary>
<value>
<c>true</c> if the current build was started by a pull request; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitrisePullRequestInfo.Id">
<summary>
Gets the pull request id.
</summary>
<value>
The pull request id.
</value>
</member>
<member name="T:Cake.Common.Build.Bitrise.Data.BitriseRepositoryInfo">
<summary>
Provides Bitrise repository information for the current build.
</summary>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitriseRepositoryInfo.GitRepositoryUrl">
<summary>
Gets the Git repository URL.
</summary>
<value>
The Git repository URL.
</value>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitriseRepositoryInfo.GitBranch">
<summary>
Gets the Git branch.
</summary>
<value>
The Git branch.
</value>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitriseRepositoryInfo.GitTag">
<summary>
Gets the Git tag.
</summary>
<value>
The Git tag.
</value>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitriseRepositoryInfo.GitCommit">
<summary>
Gets the Git commit.
</summary>
<value>
The Git commit.
</value>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitriseRepositoryInfo.PullRequest">
<summary>
Gets the pull request.
</summary>
<value>
The pull request.
</value>
</member>
<member name="M:Cake.Common.Build.Bitrise.Data.BitriseRepositoryInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.Bitrise.Data.BitriseRepositoryInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.Bitrise.Data.BitriseWorkflowInfo">
<summary>
Provides Bitrise workflow information for the current build.
</summary>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitriseWorkflowInfo.WorkflowId">
<summary>
Gets the workflow identifier.
</summary>
<value>
The workflow identifier.
</value>
</member>
<member name="P:Cake.Common.Build.Bitrise.Data.BitriseWorkflowInfo.WorkflowTitle">
<summary>
Gets the workflow title.
</summary>
<value>
The workflow title.
</value>
</member>
<member name="M:Cake.Common.Build.Bitrise.Data.BitriseWorkflowInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.Bitrise.Data.BitriseWorkflowInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.Bitrise.IBitriseProvider">
<summary>
Represents a Bitrise provider.
</summary>
</member>
<member name="P:Cake.Common.Build.Bitrise.IBitriseProvider.IsRunningOnBitrise">
<summary>
Gets a value indicating whether the current build is running on Bitrise.
</summary>
<value>
<c>true</c> if the current build is running on Bitrise; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.Bitrise.IBitriseProvider.Environment">
<summary>
Gets the Bitrise environment.
</summary>
<value>
The Bitrise environment.
</value>
</member>
<member name="M:Cake.Common.Build.Bitrise.IBitriseProvider.SetEnvironmentString(System.String,System.String)">
<summary>
Sets and environment variable that can be used in next steps on Bitrise.
</summary>
<param name="variable">The variable.</param>
<param name="value">The value.</param>
</member>
<member name="T:Cake.Common.Build.BuildProvider">
<summary>
Represents a build provider.
</summary>
</member>
<member name="F:Cake.Common.Build.BuildProvider.Local">
<summary>
Local build provider.
</summary>
</member>
<member name="F:Cake.Common.Build.BuildProvider.AppVeyor">
<summary>
AppVeyor build provider.
</summary>
</member>
<member name="F:Cake.Common.Build.BuildProvider.TeamCity">
<summary>
TeamCity build provider.
</summary>
</member>
<member name="F:Cake.Common.Build.BuildProvider.MyGet">
<summary>
MyGet build provider.
</summary>
</member>
<member name="F:Cake.Common.Build.BuildProvider.Bamboo">
<summary>
Bamboo build provider.
</summary>
</member>
<member name="F:Cake.Common.Build.BuildProvider.ContinuaCI">
<summary>
ContinuaCI build provider.
</summary>
</member>
<member name="F:Cake.Common.Build.BuildProvider.Jenkins">
<summary>
Jenkins build provider.
</summary>
</member>
<member name="F:Cake.Common.Build.BuildProvider.Bitrise">
<summary>
Bitrise build provider.
</summary>
</member>
<member name="F:Cake.Common.Build.BuildProvider.TravisCI">
<summary>
TravisCI build provider.
</summary>
</member>
<member name="F:Cake.Common.Build.BuildProvider.BitbucketPipelines">
<summary>
BitbucketPipelines build provider.
</summary>
</member>
<member name="F:Cake.Common.Build.BuildProvider.GoCD">
<summary>
GoCD build provider.
</summary>
</member>
<member name="F:Cake.Common.Build.BuildProvider.GitLabCI">
<summary>
GitLabCI build provider.
</summary>
</member>
<member name="F:Cake.Common.Build.BuildProvider.AzurePipelines">
<summary>
AzurePipelines build provider.
</summary>
</member>
<member name="F:Cake.Common.Build.BuildProvider.GitHubActions">
<summary>
GitHubActions build provider.
</summary>
</member>
<member name="T:Cake.Common.Build.BuildSystem">
<summary>
Provides functionality for interacting with
different build systems.
</summary>
</member>
<member name="M:Cake.Common.Build.BuildSystem.#ctor(Cake.Common.Build.AppVeyor.IAppVeyorProvider,Cake.Common.Build.TeamCity.ITeamCityProvider,Cake.Common.Build.MyGet.IMyGetProvider,Cake.Common.Build.Bamboo.IBambooProvider,Cake.Common.Build.ContinuaCI.IContinuaCIProvider,Cake.Common.Build.Jenkins.IJenkinsProvider,Cake.Common.Build.Bitrise.IBitriseProvider,Cake.Common.Build.TravisCI.ITravisCIProvider,Cake.Common.Build.BitbucketPipelines.IBitbucketPipelinesProvider,Cake.Common.Build.GoCD.IGoCDProvider,Cake.Common.Build.GitLabCI.IGitLabCIProvider,Cake.Common.Build.GitHubActions.IGitHubActionsProvider,Cake.Common.Build.AzurePipelines.IAzurePipelinesProvider)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.BuildSystem" /> class.
</summary>
<param name="appVeyorProvider">The AppVeyor Provider.</param>
<param name="teamCityProvider">The TeamCity Provider.</param>
<param name="myGetProvider">The MyGet Provider.</param>
<param name="bambooProvider">The Bamboo Provider.</param>
<param name="continuaCIProvider">The Continua CI Provider.</param>
<param name="jenkinsProvider">The Jenkins Provider.</param>
<param name="bitriseProvider">The Bitrise Provider.</param>
<param name="travisCIProvider">The Travis CI provider.</param>
<param name="bitbucketPipelinesProvider">The Bitbucket Pipelines provider.</param>
<param name="goCDProvider">The Go.CD provider.</param>
<param name="gitLabCIProvider">The GitLab CI provider.</param>
<param name="gitHubActionsProvider">The GitHub Actions provider.</param>
<param name="azurePipelinesProvider">The Azure Pipelines provider.</param>
</member>
<member name="P:Cake.Common.Build.BuildSystem.IsRunningOnAppVeyor">
<summary>
Gets a value indicating whether the current build is running on AppVeyor.
</summary>
<example>
<code>
if (BuildSystem.IsRunningOnAppVeyor)
{
// Upload artifact to AppVeyor.
AppVeyor.UploadArtifact("./build/release_x86.zip");
}
</code>
</example>
<value>
<c>true</c> if the build currently is running on AppVeyor; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.BuildSystem.AppVeyor">
<summary>
Gets the AppVeyor Provider.
</summary>
<example>
<code>
if (BuildSystem.IsRunningOnAppVeyor)
{
// Upload artifact to AppVeyor.
BuildSystem.AppVeyor.UploadArtifact("./build/release_x86.zip");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.BuildSystem.IsRunningOnTeamCity">
<summary>
Gets a value indicating whether the current build is running on TeamCity.
</summary>
<example>
<code>
if (BuildSystem.IsRunningOnTeamCity)
{
TeamCity.ProgressMessage("Doing an action...");
// Do action...
}
</code>
</example>
<value>
<c>true</c> if the build currently is running on TeamCity; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.BuildSystem.TeamCity">
<summary>
Gets the TeamCity Provider.
</summary>
<example>
<code>
if (BuildSystem.IsRunningOnTeamCity)
{
// Set the build number.
BuildSystem.TeamCity.SetBuildNumber("1.2.3.4");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.BuildSystem.IsRunningOnMyGet">
<summary>
Gets a value indicating whether the current build is running on MyGet.
</summary>
<example>
<code>
if (BuildSystem.IsRunningOnMyGet)
{
MyGet.BuildProblem("Something went wrong...");
// Do action...
}
</code>
</example>
<value>
<c>true</c> if the build currently is running on MyGet; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.BuildSystem.MyGet">
<summary>
Gets the MyGet Provider.
</summary>
<example>
<code>
if (BuildSystem.IsRunningOnMyGet)
{
// Set the build number.
BuildSystem.MyGet.SetBuildNumber("1.2.3.4");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.BuildSystem.IsRunningOnBamboo">
<summary>
Gets a value indicating whether the current build is running on Bamboo.
</summary>
<example>
<code>
if (BuildSystem.IsRunningOnBamboo)
{
// Get the build number.
var buildNumber = BuildSystem.Bamboo.Number;
}
</code>
</example>
<value>
<c>true</c> if the build currently is running on Bamboo; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.BuildSystem.Bamboo">
<summary>
Gets the Bamboo Provider.
</summary>
<example>
<code>
if (BuildSystem.IsRunningOnBamboo)
{
//Get the Bamboo Plan Name
var planName = BuildSystem.Bamboo.Project.PlanName
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.BuildSystem.IsRunningOnContinuaCI">
<summary>
Gets a value indicating whether the current build is running on Continua CI.
</summary>
<example>
<code>
if (BuildSystem.IsRunningOnContinuaCI)
{
// Get the build version.
var buildVersion = BuildSystem.ContinuaCI.Environment.Build.Version;
}
</code>
</example>
<value>
<c>true</c> if the build currently is running on Continua CI; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.BuildSystem.ContinuaCI">
<summary>
Gets the Continua CI Provider.
</summary>
<example>
<code>
if (BuildSystem.IsRunningOnContinuaCI)
{
//Get the Continua CI Project Name
var projectName = BuildSystem.ContinuaCI.Environment.Project.Name;
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.BuildSystem.IsRunningOnJenkins">
<summary>
Gets a value indicating whether this instance is running on Jenkins.
</summary>
<example>
<code>
if (BuildSystem.IsRunningOnJenkins)
{
// Get the build number.
var buildNumber = BuildSystem.Jenkins.Environment.Build.BuildNumber;
}
</code>
</example>
<value>
<c>true</c> if this instance is running on jenkins; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.BuildSystem.Jenkins">
<summary>
Gets the Jenkins Provider.
</summary>
<value>
The jenkins.
</value>
<example>
<code>
if (BuildSystem.IsRunningOnJenkins)
{
// Get the job name.
var jobName = BuildSystem.Jenkins.Environment.Build.JobName;
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.BuildSystem.IsRunningOnBitrise">
<summary>
Gets a value indicating whether this instance is running on Bitrise.
</summary>
<example>
<code>
if (BuildSystem.IsRunningOnBitrise)
{
// Get the build number.
var buildNumber = BuildSystem.Bitrise.Environment.Build.BuildNumber;
}
</code>
</example>
<value>
<c>true</c> if this instance is running on bitrise; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.BuildSystem.Bitrise">
<summary>
Gets the Bitrise Provider.
</summary>
<example>
<code>
if (BuildSystem.IsRunningOnBitrise)
{
// Get the provision profile url.
var buildNumber = BuildSystem.Bitrise.Environment.Provisioning.ProvisionUrl;
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.BuildSystem.IsRunningOnTravisCI">
<summary>
Gets a value indicating whether this instance is running on Travis CI.
</summary>
<example>
<code>
if (BuildSystem.IsRunningOnTravisCI)
{
// Get the build directory.
var buildDirectory = BuildSystem.TravisCI.Environment.Build.BuildDirectory;
}
</code>
</example>
<value>
<c>true</c> if this instance is running on Travis CI; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.BuildSystem.TravisCI">
<summary>
Gets the Travis CI provider.
</summary>
<example>
<code>
if (BuildSystem.IsRunningOnTravisCI)
{
// Get the operating system name.
var osName = BuildSystem.TravisCI.Environment.Job.OSName;
}
</code>
</example>
<value>
The Travis CI.
</value>
</member>
<member name="P:Cake.Common.Build.BuildSystem.IsRunningOnBitbucketPipelines">
<summary>
Gets a value indicating whether this instance is running on Bitbucket Pipelines.
</summary>
<example>
<code>
if (BuildSystem.IsRunningOnBitbucketPipelines)
{
// Get the build commit hash.
var commitHash = BuildSystem.BitbucketPipelines.Environment.Repository.Commit;
}
</code>
</example>
<value>
<c>true</c> if this instance is running on Bitbucket Pipelines; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.BuildSystem.BitbucketPipelines">
<summary>
Gets the Bitbucket Pipelines Provider.
</summary>
<example>
<code>
if (BuildSystem.IsRunningOnBitbucketPipelines)
{
// Get the URL friendly repo name.
var repoSlug = BuildSystem.BitbucketPipelines.Environment.Repository.RepoSlug;
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.BuildSystem.IsRunningOnGoCD">
<summary>
Gets a value indicating whether the current build is running on Go.CD.
</summary>
<example>
<code>
if (BuildSystem.IsRunningOnGoCD)
{
// Get the build counter.
var counter = BuildSystem.GoCD.Environment.Pipeline.Counter;
}
</code>
</example>
<value>
<c>true</c> if the build currently is running on Go.CD; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.BuildSystem.GoCD">
<summary>
Gets the Go.CD Provider.
</summary>
<example>
<code>
if (BuildSystem.IsRunningOnGoCD)
{
// Get the pipeline counter.
var counter = BuildSystem.GoCD.Environment.Environment.Pipeline.Counter;
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.BuildSystem.GitLabCI">
<summary>
Gets the GitLab CI Provider.
</summary>
<example>
<code>
if (BuildSystem.IsRunningOnGitLabCI)
{
// Get the build commit hash.
var commitHash = BuildSystem.GitLabCI.Environment.Build.Reference;
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.BuildSystem.IsRunningOnGitLabCI">
<summary>
Gets a value indicating whether this instance is running on GitLab CI.
</summary>
<example>
<code>
if (BuildSystem.IsRunningOnGitLabCI)
{
// Get the build commit hash.
var commitHash = BuildSystem.GitLabCI.Environment.Build.Reference;
}
</code>
</example>
<value>
<c>true</c> if this instance is running on GitLab CI; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.BuildSystem.IsRunningOnAzurePipelines">
<summary>
Gets a value indicating whether this instance is running on Azure Pipelines.
</summary>
<example>
<code>
if (BuildSystem.IsRunningOnAzurePipelines)
{
// Get the build commit hash.
var commitHash = BuildSystem.AzurePipelines.Environment.Repository.SourceVersion;
}
</code>
</example>
<value>
<c>true</c> if this instance is running on Azure Pipelines; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.BuildSystem.AzurePipelines">
<summary>
Gets the Azure Pipelines Provider.
</summary>
<example>
<code>
if (BuildSystem.IsRunningOnAzurePipelines)
{
// Get the build definition name.
var definitionName = BuildSystem.AzurePipelines.Environment.BuildDefinition.Name;
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.BuildSystem.IsRunningOnGitHubActions">
<summary>
Gets a value indicating whether this instance is running on GitHub Actions.
</summary>
<example>
<code>
if (BuildSystem.IsRunningOnGitHubActions)
{
// Get the workflow name.
var workflow = BuildSystem.GitHubActions.Environment.Workflow.Workflow;
}
</code>
</example>
<value>
<c>true</c> if this instance is running on GitHub Actions; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.BuildSystem.GitHubActions">
<summary>
Gets the GitHub Actions Provider.
</summary>
<example>
<code>
if (BuildSystem.IsRunningOnGitHubActions)
{
// Get the workflow name.
var workflow = BuildSystem.GitHubActions.Environment.Workflow.Workflow;
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.BuildSystem.Provider">
<summary>
Gets the current build provider.
</summary>
<value>The current build provider.</value>
</member>
<member name="P:Cake.Common.Build.BuildSystem.IsLocalBuild">
<summary>
Gets a value indicating whether the current build is local build.
</summary>
<example>
<code>
// Gets a flag telling us if this is a local build or not.
var isLocal = BuildSystem.IsLocalBuild;
// Define a task that only runs locally.
Task("LocalOnly")
.WithCriteria(isLocal)
.Does(() =>
{
});
</code>
</example>
<value>
<c>true</c> if the current build is local build; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.BuildSystem.IsPullRequest">
<summary>
Gets a value indicating whether the current build was started by a pull request.
</summary>
<value>
<c>true</c> if the current build was started by a pull request; otherwise, <c>false</c>.
</value>
</member>
<member name="T:Cake.Common.Build.BuildSystemAliases">
<summary>
Contains functionality related to build systems.
</summary>
</member>
<member name="M:Cake.Common.Build.BuildSystemAliases.BuildSystem(Cake.Core.ICakeContext)">
<summary>
Gets a <see cref="T:Cake.Common.Build.BuildSystem"/> instance that can
be used to query for information about the current build system.
</summary>
<example>
<code>
var isLocal = BuildSystem.IsLocalBuild;
</code>
</example>
<param name="context">The context.</param>
<returns>A <see cref="T:Cake.Common.Build.BuildSystem"/> instance.</returns>
</member>
<member name="M:Cake.Common.Build.BuildSystemAliases.AppVeyor(Cake.Core.ICakeContext)">
<summary>
Gets a <see cref="T:Cake.Common.Build.AppVeyor.AppVeyorProvider"/> instance that can
be used to manipulate the AppVeyor environment.
</summary>
<example>
<code>
var isAppVeyorBuild = AppVeyor.IsRunningOnAppVeyor;
</code>
</example>
<param name="context">The context.</param>
<returns>A <see cref="N:Cake.Common.Build.AppVeyor"/> instance.</returns>
</member>
<member name="M:Cake.Common.Build.BuildSystemAliases.TeamCity(Cake.Core.ICakeContext)">
<summary>
Gets a <see cref="T:Cake.Common.Build.TeamCity.TeamCityProvider"/> instance that can
be used to manipulate the TeamCity environment.
</summary>
<example>
<code>
var isTeamCityBuild = TeamCity.IsRunningOnTeamCity;
</code>
</example>
<param name="context">The context.</param>
<returns>A <see cref="N:Cake.Common.Build.TeamCity"/> instance.</returns>
</member>
<member name="M:Cake.Common.Build.BuildSystemAliases.MyGet(Cake.Core.ICakeContext)">
<summary>
Gets a <see cref="T:Cake.Common.Build.MyGet.MyGetProvider"/> instance that can
be used to manipulate the MyGet environment.
</summary>
<example>
<code>
var isMyGetBuild = MyGet.IsRunningOnMyGet;
</code>
</example>
<param name="context">The context.</param>
<returns>A <see cref="N:Cake.Common.Build.MyGet"/> instance.</returns>
</member>
<member name="M:Cake.Common.Build.BuildSystemAliases.Bamboo(Cake.Core.ICakeContext)">
<summary>
Gets a <see cref="T:Cake.Common.Build.Bamboo.BambooProvider"/> instance that can
be used to manipulate the Bamboo environment.
</summary>
<example>
<code>
var isBambooBuild = Bamboo.IsRunningOnBamboo;
</code>
</example>
<param name="context">The context.</param>
<returns>A <see cref="N:Cake.Common.Build.Bamboo"/> instance.</returns>
</member>
<member name="M:Cake.Common.Build.BuildSystemAliases.ContinuaCI(Cake.Core.ICakeContext)">
<summary>
Gets a <see cref="T:Cake.Common.Build.ContinuaCI.ContinuaCIProvider"/> instance that can
be used to manipulate the Continua CI environment.
</summary>
<example>
<code>
var isContinuaCIBuild = ContinuaCI.IsRunningContinuaCI;
</code>
</example>
<param name="context">The context.</param>
<returns>A <see cref="N:Cake.Common.Build.ContinuaCI"/> instance.</returns>
</member>
<member name="M:Cake.Common.Build.BuildSystemAliases.Jenkins(Cake.Core.ICakeContext)">
<summary>
Gets a <see cref="T:Cake.Common.Build.Jenkins.JenkinsProvider"/> instance that can be used to
obtain information from the Jenkins environment.
</summary>
<example>
<code>
var isJenkinsBuild = Jenkins.IsRunningOnJenkins;
</code>
</example>
<param name="context">The context.</param>
<returns>A <see cref="N:Cake.Common.Build.Jenkins"/> instance.</returns>
</member>
<member name="M:Cake.Common.Build.BuildSystemAliases.Bitrise(Cake.Core.ICakeContext)">
<summary>
Gets a <see cref="T:Cake.Common.Build.Bitrise.BitriseProvider"/> instance that can be used to
obtain information from the Bitrise environment.
</summary>
<example>
<code>
var isBitriseBuild = Bitrise.IsRunningOnBitrise;
</code>
</example>
<param name="context">The context.</param>
<returns>A <see cref="N:Cake.Common.Build.Bitrise"/> instance.</returns>
</member>
<member name="M:Cake.Common.Build.BuildSystemAliases.TravisCI(Cake.Core.ICakeContext)">
<summary>
Gets a <see cref="T:Cake.Common.Build.TravisCI.TravisCIProvider"/> instance that can be used to
obtain information from the Travis CI environment.
</summary>
<example>
<code>
var isTravisCIBuild = TravisCI.IsRunningOnTravisCI;
</code>
</example>
<param name="context">The context.</param>
<returns>A <see cref="N:Cake.Common.Build.TravisCI"/> instance.</returns>
</member>
<member name="M:Cake.Common.Build.BuildSystemAliases.BitbucketPipelines(Cake.Core.ICakeContext)">
<summary>
Gets a <see cref="T:Cake.Common.Build.BitbucketPipelines.BitbucketPipelinesProvider"/> instance that can be used to
obtain information from the Bitbucket Pipelines environment.
</summary>
<example>
<code>
var isBitbucketPipelinesBuild = BitbucketPipelines.IsRunningOnBitbucketPipelines;
</code>
</example>
<param name="context">The context.</param>
<returns>A <see cref="N:Cake.Common.Build.BitbucketPipelines"/> instance.</returns>
</member>
<member name="M:Cake.Common.Build.BuildSystemAliases.GoCD(Cake.Core.ICakeContext)">
<summary>
Gets a <see cref="T:Cake.Common.Build.GoCD.GoCDProvider"/> instance that can be used to
obtain information from the Go.CD environment.
</summary>
<example>
<code>
var isGoCDBuild = GoCD.IsRunningOnGoCD;
</code>
</example>
<param name="context">The context.</param>
<returns>A <see cref="N:Cake.Common.Build.GoCD"/> instance.</returns>
</member>
<member name="M:Cake.Common.Build.BuildSystemAliases.GitLabCI(Cake.Core.ICakeContext)">
<summary>
Gets a <see cref="T:Cake.Common.Build.GitLabCI.GitLabCIProvider"/> instance that can be used to
obtain information from the GitLab CI environment.
</summary>
<example>
<code>
var isGitLabCIBuild = GitLabCI.IsRunningOnGitLabCI;
</code>
</example>
<param name="context">The context.</param>
<returns>A <see cref="N:Cake.Common.Build.GitLabCI"/> instance.</returns>
</member>
<member name="M:Cake.Common.Build.BuildSystemAliases.GitHubActions(Cake.Core.ICakeContext)">
<summary>
Gets a <see cref="T:Cake.Common.Build.GitHubActions.GitHubActionsProvider"/> instance that can be used to
obtain information from the GitHub Actions environment.
</summary>
<example>
<code>
var isGitHubActionsBuild = GitHubActions.IsRunningOnGitHubActions;
</code>
</example>
<param name="context">The context.</param>
<returns>A <see cref="N:Cake.Common.Build.GitHubActions"/> instance.</returns>
</member>
<member name="M:Cake.Common.Build.BuildSystemAliases.AzurePipelines(Cake.Core.ICakeContext)">
<summary>
Gets a <see cref="T:Cake.Common.Build.AzurePipelines.AzurePipelinesProvider"/> instance that can be used to
obtain information from the Azure Pipelines environment.
</summary>
<example>
<code>
var isAzurePipelines = AzurePipelines.IsRunningOnAzurePipelines;
</code>
</example>
<param name="context">The context.</param>
<returns>A <see cref="N:Cake.Common.Build.AzurePipelines"/> instance.</returns>
</member>
<member name="T:Cake.Common.Build.ContinuaCI.ContinuaCIInfo">
<summary>
Base class used to provide information about the Continua CI environment.
</summary>
</member>
<member name="M:Cake.Common.Build.ContinuaCI.ContinuaCIInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.ContinuaCI.ContinuaCIInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="M:Cake.Common.Build.ContinuaCI.ContinuaCIInfo.GetEnvironmentString(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.String"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.ContinuaCI.ContinuaCIInfo.GetEnvironmentInteger(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Int32"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.ContinuaCI.ContinuaCIInfo.GetEnvironmentBoolean(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Boolean"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.ContinuaCI.ContinuaCIInfo.GetEnvironmentDateTime(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.DateTime"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.ContinuaCI.ContinuaCIInfo.GetEnvironmentLong(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Int64"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.ContinuaCI.ContinuaCIInfo.GetEnvironmentTimeSpan(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.TimeSpan"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.ContinuaCI.ContinuaCIInfo.GetEnvironmentStringList(System.String)">
<summary>
Gets an environment variable as an array of <see cref="T:System.String"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable value split by comma into an array of values.</returns>
</member>
<member name="M:Cake.Common.Build.ContinuaCI.ContinuaCIInfo.GetEnvironmentStringDictionary(System.String)">
<summary>
Gets matching list of environment variables as an dictionary of <see cref="T:System.String"/>.
</summary>
<param name="variablePrefix">The prefix for the environment variables name.</param>
<returns>A dictionary of environment variables starting with variablePrefix.</returns>
</member>
<member name="T:Cake.Common.Build.ContinuaCI.ContinuaCIMessageType">
<summary>
Provides the known values for Continua CI Message Types.
</summary>
</member>
<member name="F:Cake.Common.Build.ContinuaCI.ContinuaCIMessageType.Debug">
<summary>
Debug Message
</summary>
</member>
<member name="F:Cake.Common.Build.ContinuaCI.ContinuaCIMessageType.Success">
<summary>
Success Message
</summary>
</member>
<member name="F:Cake.Common.Build.ContinuaCI.ContinuaCIMessageType.Information">
<summary>
Information Message
</summary>
</member>
<member name="F:Cake.Common.Build.ContinuaCI.ContinuaCIMessageType.Warning">
<summary>
Warning Message
</summary>
</member>
<member name="F:Cake.Common.Build.ContinuaCI.ContinuaCIMessageType.Error">
<summary>
Error Message
</summary>
</member>
<member name="F:Cake.Common.Build.ContinuaCI.ContinuaCIMessageType.Fatal">
<summary>
Fatal Message
</summary>
</member>
<member name="T:Cake.Common.Build.ContinuaCI.ContinuaCIProvider">
<summary>
Responsible for communicating with Continua CI.
</summary>
</member>
<member name="M:Cake.Common.Build.ContinuaCI.ContinuaCIProvider.#ctor(Cake.Core.ICakeEnvironment,Cake.Common.Build.IBuildSystemServiceMessageWriter)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.ContinuaCI.ContinuaCIProvider"/> class.
</summary>
<param name="environment">The cake environment.</param>
<param name="writer">The build system service message writer.</param>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.ContinuaCIProvider.IsRunningOnContinuaCI">
<inheritdoc/>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.ContinuaCIProvider.Environment">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.ContinuaCI.ContinuaCIProvider.WriteMessage(System.String,Cake.Common.Build.ContinuaCI.ContinuaCIMessageType)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.ContinuaCI.ContinuaCIProvider.WriteStartGroup(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.ContinuaCI.ContinuaCIProvider.WriteEndBlock(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.ContinuaCI.ContinuaCIProvider.SetVariable(System.String,System.String,System.Boolean)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.ContinuaCI.ContinuaCIProvider.SetBuildVersion(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.ContinuaCI.ContinuaCIProvider.SetBuildStatus(System.String)">
<inheritdoc/>
</member>
<member name="T:Cake.Common.Build.ContinuaCI.Data.ContinuaCIBuildInfo">
<summary>
Provides Continua CI build information for a current build.
</summary>
</member>
<member name="M:Cake.Common.Build.ContinuaCI.Data.ContinuaCIBuildInfo.#ctor(Cake.Core.ICakeEnvironment,System.String)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.ContinuaCI.Data.ContinuaCIBuildInfo"/> class.
</summary>
<param name="environment">The environment.</param>
<param name="prefix">The prefix for environment variables in this class.</param>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIBuildInfo.Id">
<summary>
Gets the build id.
</summary>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIBuildInfo.Version">
<summary>
Gets the build version.
</summary>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIBuildInfo.StartedBy">
<summary>
Gets the name of the user or trigger starting the build.
</summary>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIBuildInfo.IsFeatureBranchBuild">
<summary>
Gets a value indicating whether the build uses the feature branch.
</summary>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIBuildInfo.BuildNumber">
<summary>
Gets the build number.
</summary>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIBuildInfo.Started">
<summary>
Gets the build start date and time.
</summary>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIBuildInfo.UsesDefaultBranch">
<summary>
Gets a value indicating whether the build uses the default branch.
</summary>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIBuildInfo.HasNewChanges">
<summary>
Gets a value indicating whether the build has new changes.
</summary>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIBuildInfo.ChangesetCount">
<summary>
Gets build the number of changesets associated with this build.
</summary>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIBuildInfo.IssueCount">
<summary>
Gets build the number of issues associated with this build.
</summary>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIBuildInfo.Elapsed">
<summary>
Gets build elapsed time on queue as a time span.
</summary>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIBuildInfo.TimeOnQueue">
<summary>
Gets build time on queue in ticks.
</summary>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIBuildInfo.Repositories">
<summary>
Gets list of repository names.
</summary>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIBuildInfo.RepositoryBranches">
<summary>
Gets list of repository branch names.
</summary>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIBuildInfo.TriggeringBranch">
<summary>
Gets triggering branch name.
</summary>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIBuildInfo.ChangesetRevisions">
<summary>
Gets list of changeset revisions.
</summary>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIBuildInfo.ChangesetUserNames">
<summary>
Gets list of changeset user names.
</summary>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIBuildInfo.ChangesetTagNames">
<summary>
Gets list of changeset tag names.
</summary>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIBuildInfo.LatestChangeset">
<summary>
Gets the latest build changeset.
</summary>
</member>
<member name="T:Cake.Common.Build.ContinuaCI.Data.ContinuaCIChangesetInfo">
<summary>
Provides Continua CI changeset information for a current build.
</summary>
</member>
<member name="M:Cake.Common.Build.ContinuaCI.Data.ContinuaCIChangesetInfo.#ctor(Cake.Core.ICakeEnvironment,System.String)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.ContinuaCI.Data.ContinuaCIChangesetInfo"/> class.
</summary>
<param name="environment">The environment.</param>
<param name="prefix">The environment variable key prefix.</param>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIChangesetInfo.Revision">
<summary>
Gets the revision used to build this release. Format depends on the VCS used.
</summary>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIChangesetInfo.Branch">
<summary>
Gets the changeset branch name.
</summary>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIChangesetInfo.Created">
<summary>
Gets the changeset created date and time.
</summary>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIChangesetInfo.FileCount">
<summary>
Gets the count of the number of files in the changeset.
</summary>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIChangesetInfo.UserName">
<summary>
Gets the changeset author user/committer name.
</summary>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIChangesetInfo.TagCount">
<summary>
Gets the count of the number of tags associated with the changeset.
</summary>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIChangesetInfo.IssueCount">
<summary>
Gets the count of the number of tags associated with the changeset.
</summary>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIChangesetInfo.TagNames">
<summary>
Gets list of changeset tag names.
</summary>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIChangesetInfo.IssueNames">
<summary>
Gets list of changeset issue names.
</summary>
</member>
<member name="T:Cake.Common.Build.ContinuaCI.Data.ContinuaCIConfigurationInfo">
<summary>
Provides Continua CI configuration information for a current build.
</summary>
</member>
<member name="M:Cake.Common.Build.ContinuaCI.Data.ContinuaCIConfigurationInfo.#ctor(Cake.Core.ICakeEnvironment,System.String)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.ContinuaCI.Data.ContinuaCIConfigurationInfo"/> class.
</summary>
<param name="environment">The environment.</param>
<param name="prefix">The environment variable key prefix.</param>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIConfigurationInfo.Name">
<summary>
Gets the Continua CI Configuration Name.
</summary>
<value>
The Continua CI Configuration Name.
</value>
</member>
<member name="T:Cake.Common.Build.ContinuaCI.Data.ContinuaCIEnvironmentInfo">
<summary>
Provides Continua CI environment information for a current build.
</summary>
</member>
<member name="M:Cake.Common.Build.ContinuaCI.Data.ContinuaCIEnvironmentInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.ContinuaCI.Data.ContinuaCIEnvironmentInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIEnvironmentInfo.Configuration">
<summary>
Gets Continua CI configuration information.
</summary>
<value>
The Continua CI configuration information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.ContinuaCI.IsRunningOnContinuaCI)
{
Information(
@"Configuration:
Name: {0}",
BuildSystem.ContinuaCI.Environment.Configuration.Name
);
}
else
{
Information("Not running on ContinuaCI");
}
</code>
</example>
<para>Via ContinuaCI.</para>
<example>
<code>
if (ContinuaCI.IsRunningOnContinuaCI)
{
Information(
@"Configuration:
Name: {0}",
ContinuaCI.Environment.Configuration.Name
);
}
else
{
Information("Not running on ContinuaCI");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIEnvironmentInfo.Project">
<summary>
Gets Continua CI project information.
</summary>
<value>
The Continua CI project information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.ContinuaCI.IsRunningOnContinuaCI)
{
Information(
@"Project:
Name: {0}",
BuildSystem.ContinuaCI.Environment.Project.Name
);
}
else
{
Information("Not running on ContinuaCI");
}
</code>
</example>
<para>Via ContinuaCI.</para>
<example>
<code>
if (ContinuaCI.IsRunningOnContinuaCI)
{
Information(
@"Project:
Name: {0}",
ContinuaCI.Environment.Project.Name
);
}
else
{
Information("Not running on ContinuaCI");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIEnvironmentInfo.Build">
<summary>
Gets Continua CI build information.
</summary>
<value>
The Continua CI build information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.ContinuaCI.IsRunningOnContinuaCI)
{
Information(
@"Build:
Id: {0}
Version: {1}
Started By: {2}
Is Feature Branch Build: {3}
Build Number: {4}
Started: {5}",
BuildSystem.ContinuaCI.Environment.Build.Id,
BuildSystem.ContinuaCI.Environment.Build.Version,
BuildSystem.ContinuaCI.Environment.Build.StartedBy,
BuildSystem.ContinuaCI.Environment.Build.IsFeatureBranchBuild,
BuildSystem.ContinuaCI.Environment.Build.BuildNumber,
BuildSystem.ContinuaCI.Environment.Build.Started
);
}
else
{
Information("Not running on ContinuaCI");
}
</code>
</example>
<para>Via ContinuaCI.</para>
<example>
<code>
if (ContinuaCI.IsRunningOnContinuaCI)
{
Information(
@"Build:
Id: {0}
Version: {1}
Started By: {2}
Is Feature Branch Build: {3}
Build Number: {4}
Started: {5}",
ContinuaCI.Environment.Build.Id,
ContinuaCI.Environment.Build.Version,
ContinuaCI.Environment.Build.StartedBy,
ContinuaCI.Environment.Build.IsFeatureBranchBuild,
ContinuaCI.Environment.Build.BuildNumber,
ContinuaCI.Environment.Build.Started
);
}
else
{
Information("Not running on ContinuaCI");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIEnvironmentInfo.Variable">
<summary>
Gets Continua CI build variables.
</summary>
<value>
The Continua CI build variables.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.ContinuaCI.IsRunningOnContinuaCI)
{
Information(
@"Variables:
{0}",
BuildSystem.ContinuaCI.Environment.Variable.Aggregate(
new StringBuilder(),(builder, pair) => builder.AppendLine(
string.Format(":", pair.Key, pair.Value)),
builder => builder.ToString())
);
}
else
{
Information("Not running on ContinuaCI");
}
</code>
</example>
<para>Via ContinuaCI.</para>
<example>
<code>
if (ContinuaCI.IsRunningOnContinuaCI)
{
Information(
@"Variables:
{0}",
ContinuaCI.Environment.Variable.Aggregate(
new StringBuilder(),(builder, pair) => builder.AppendLine(
string.Format(":", pair.Key, pair.Value)),
builder => builder.ToString())
);
}
else
{
Information("Not running on ContinuaCI");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIEnvironmentInfo.AgentProperty">
<summary>
Gets Continua CI build agent properties.
</summary>
<value>
The Continua CI build agent properties.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.ContinuaCI.IsRunningOnContinuaCI)
{
Information(
@"Agent Property:
{0}",
BuildSystem.ContinuaCI.Environment.AgentProperty.Aggregate(
new StringBuilder(),(builder, pair) => builder.AppendLine(
string.Format(":", pair.Key, pair.Value)),
builder => builder.ToString())
);
}
else
{
Information("Not running on ContinuaCI");
}
</code>
</example>
<para>Via ContinuaCI.</para>
<example>
<code>
if (ContinuaCI.IsRunningOnContinuaCI)
{
Information(
@"Variables:
{0}",
ContinuaCI.Environment.AgentProperty.Aggregate(
new StringBuilder(),(builder, pair) => builder.AppendLine(
string.Format(":", pair.Key, pair.Value)),
builder => builder.ToString())
);
}
else
{
Information("Not running on ContinuaCI");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIEnvironmentInfo.Version">
<summary>
Gets Continua CI product version.
</summary>
<value>
The Continua CI product version.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.ContinuaCI.IsRunningOnContinuaCI)
{
Information(
@"Version: {0}",
BuildSystem.ContinuaCI.Environment.Version
);
}
else
{
Information("Not running on ContinuaCI");
}
</code>
</example>
<para>Via ContinuaCI.</para>
<example>
<code>
if (ContinuaCI.IsRunningOnContinuaCI)
{
Information(
@"Version: {0}",
ContinuaCI.Environment.Version
);
}
else
{
Information("Not running on ContinuaCI");
}
</code>
</example>
</member>
<member name="T:Cake.Common.Build.ContinuaCI.Data.ContinuaCIProjectInfo">
<summary>
Provides Continua CI project information for a current build.
</summary>
</member>
<member name="M:Cake.Common.Build.ContinuaCI.Data.ContinuaCIProjectInfo.#ctor(Cake.Core.ICakeEnvironment,System.String)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.ContinuaCI.Data.ContinuaCIProjectInfo"/> class.
</summary>
<param name="environment">The environment.</param>
<param name="prefix">The environment variable key prefix.</param>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.Data.ContinuaCIProjectInfo.Name">
<summary>
Gets the Continua CI Project Name.
</summary>
<value>
The Continua CI Project Name.
</value>
</member>
<member name="T:Cake.Common.Build.ContinuaCI.IContinuaCIProvider">
<summary>
Represents a Continua CI provider.
</summary>
</member>
<member name="M:Cake.Common.Build.ContinuaCI.IContinuaCIProvider.WriteMessage(System.String,Cake.Common.Build.ContinuaCI.ContinuaCIMessageType)">
<summary>
Write a status message to the Continua CI build log.
</summary>
<param name="message">Message contents.</param>
<param name="status">Build status.</param>
</member>
<member name="M:Cake.Common.Build.ContinuaCI.IContinuaCIProvider.WriteStartGroup(System.String)">
<summary>
Write the start of a message group to the Continua CI build log.
</summary>
<param name="groupName">Group name.</param>
</member>
<member name="M:Cake.Common.Build.ContinuaCI.IContinuaCIProvider.WriteEndBlock(System.String)">
<summary>
Write the end of a message block to the Continua CI build log.
</summary>
<param name="groupName">Group name.</param>
</member>
<member name="M:Cake.Common.Build.ContinuaCI.IContinuaCIProvider.SetVariable(System.String,System.String,System.Boolean)">
<summary>
Set a Continua CI build variable.
</summary>
<param name="name">Name of the variable to set.</param>
<param name="value">Value to assign to the variable.</param>
<param name="skipIfNotDefined">Set to 'true' to prevent the build failing if the variable has not been defined for the configuration.</param>
</member>
<member name="M:Cake.Common.Build.ContinuaCI.IContinuaCIProvider.SetBuildVersion(System.String)">
<summary>
Set a Continua CI build version.
</summary>
<param name="version">The new build version.</param>
</member>
<member name="M:Cake.Common.Build.ContinuaCI.IContinuaCIProvider.SetBuildStatus(System.String)">
<summary>
Set a Continua CI build status message, which is shown on the build details page when a build is running.
</summary>
<param name="text">The new build status text.</param>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.IContinuaCIProvider.IsRunningOnContinuaCI">
<summary>
Gets a value indicating whether the current build is running on Continua CI.
</summary>
<value>
<c>true</c> if the current build is running on Continua CI; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.ContinuaCI.IContinuaCIProvider.Environment">
<summary>
Gets the Continua CI environment.
</summary>
<value>
The Continua CI environment.
</value>
</member>
<member name="T:Cake.Common.Build.GitHubActions.Commands.GitHubActionsCommands">
<summary>
Provides GitHub Actions commands for a current build.
</summary>
</member>
<member name="M:Cake.Common.Build.GitHubActions.Commands.GitHubActionsCommands.#ctor(Cake.Core.ICakeEnvironment,Cake.Core.IO.IFileSystem,Cake.Common.Build.IBuildSystemServiceMessageWriter,Cake.Common.Build.GitHubActions.Data.GitHubActionsEnvironmentInfo,System.Func{System.String,System.Net.Http.HttpClient})">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.GitHubActions.Commands.GitHubActionsCommands"/> class.
</summary>
<param name="environment">The environment.</param>
<param name="fileSystem">The file system.</param>
<param name="writer">The build system service message writer.</param>
<param name="actionsEnvironment">The actions environment.</param>
<param name="createHttpClient">The http client factory.</param>
</member>
<member name="M:Cake.Common.Build.GitHubActions.Commands.GitHubActionsCommands.Debug(System.String)">
<summary>
Write debug message to the build log.
</summary>
<param name="message">The message.</param>
</member>
<member name="M:Cake.Common.Build.GitHubActions.Commands.GitHubActionsCommands.Notice(System.String,Cake.Common.Build.GitHubActions.Data.GitHubActionsAnnotation)">
<summary>
Write notice message to the build log.
</summary>
<param name="message">The message.</param>
<param name="annotation">The annotation.</param>
</member>
<member name="M:Cake.Common.Build.GitHubActions.Commands.GitHubActionsCommands.Warning(System.String,Cake.Common.Build.GitHubActions.Data.GitHubActionsAnnotation)">
<summary>
Write warning message to the build log.
</summary>
<param name="message">The message.</param>
<param name="annotation">The annotation.</param>
</member>
<member name="M:Cake.Common.Build.GitHubActions.Commands.GitHubActionsCommands.Error(System.String,Cake.Common.Build.GitHubActions.Data.GitHubActionsAnnotation)">
<summary>
Write error message to the build log.
</summary>
<param name="message">The message.</param>
<param name="annotation">The annotation.</param>
</member>
<member name="M:Cake.Common.Build.GitHubActions.Commands.GitHubActionsCommands.StartGroup(System.String)">
<summary>
Start a group in the build log.
</summary>
<param name="title">The title.</param>
</member>
<member name="M:Cake.Common.Build.GitHubActions.Commands.GitHubActionsCommands.EndGroup">
<summary>
End a group in the build log.
</summary>
</member>
<member name="M:Cake.Common.Build.GitHubActions.Commands.GitHubActionsCommands.SetSecret(System.String)">
<summary>
Registers a secret which will get masked in the build log.
</summary>
<param name="secret">The secret.</param>
</member>
<member name="M:Cake.Common.Build.GitHubActions.Commands.GitHubActionsCommands.AddPath(Cake.Core.IO.DirectoryPath)">
<summary>
Prepends a directory to the system PATH variable and automatically makes it available to all subsequent actions in the current job.
</summary>
<param name="path">The directory path.</param>
</member>
<member name="M:Cake.Common.Build.GitHubActions.Commands.GitHubActionsCommands.SetEnvironmentVariable(System.String,System.String)">
<summary>
Creates or updates an environment variable for any steps running next in a job.
</summary>
<param name="key">The key.</param>
<param name="value">The Value.</param>
</member>
<member name="M:Cake.Common.Build.GitHubActions.Commands.GitHubActionsCommands.SetOutputParameter(System.String,System.String)">
<summary>
Creates or updates an output parameter for any steps running next in a job.
</summary>
<param name="key">The key.</param>
<param name="value">The Value.</param>
</member>
<member name="M:Cake.Common.Build.GitHubActions.Commands.GitHubActionsCommands.SetStepSummary(System.String)">
<summary>
Creates or updates the step summary for a GitHub workflow.
</summary>
<param name="summary">The step summary.</param>
</member>
<member name="M:Cake.Common.Build.GitHubActions.Commands.GitHubActionsCommands.UploadArtifact(Cake.Core.IO.FilePath,System.String)">
<summary>
Upload local file into a file container folder, and create an artifact.
</summary>
<param name="path">Path to the local file.</param>
<param name="artifactName">The artifact name.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> representing the asynchronous operation.</returns>
</member>
<member name="M:Cake.Common.Build.GitHubActions.Commands.GitHubActionsCommands.UploadArtifact(Cake.Core.IO.DirectoryPath,System.String)">
<summary>
Upload local directory files into a file container folder, and create an artifact.
</summary>
<param name="path">Path to the local directory.</param>
<param name="artifactName">The artifact name.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> representing the asynchronous operation.</returns>
</member>
<member name="M:Cake.Common.Build.GitHubActions.Commands.GitHubActionsCommands.DownloadArtifact(System.String,Cake.Core.IO.DirectoryPath)">
<summary>
Download remote artifact container into local directory.
</summary>
<param name="artifactName">The artifact name.</param>
<param name="path">Path to the local directory.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> representing the asynchronous operation.</returns>
</member>
<member name="T:Cake.Common.Build.GitHubActions.Data.GitHubActionsAnnotation">
<summary>
Provides optional annotation data associated with a GitHub Actions command.
</summary>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsAnnotation.Title">
<summary>
Gets or sets the custom title.
</summary>
<value>
The custom title.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsAnnotation.File">
<summary>
Gets or sets the file path.
</summary>
<value>
The path of the file.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsAnnotation.StartLine">
<summary>
Gets or sets the start line number.
</summary>
<value>
The start line number.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsAnnotation.EndLine">
<summary>
Gets or sets the end line number.
</summary>
<value>
The end line number.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsAnnotation.StartColumn">
<summary>
Gets or sets the start column number.
</summary>
<value>
The start column number.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsAnnotation.EndColumn">
<summary>
Gets or sets the end column number.
</summary>
<value>
The end column number.
</value>
</member>
<member name="T:Cake.Common.Build.GitHubActions.Data.GitHubActionsArchitecture">
<summary>
The GitHub Actions Architecture.
</summary>
</member>
<member name="F:Cake.Common.Build.GitHubActions.Data.GitHubActionsArchitecture.Unknown">
<summary>
Unknown.
</summary>
</member>
<member name="F:Cake.Common.Build.GitHubActions.Data.GitHubActionsArchitecture.X86">
<summary>
X86.
</summary>
</member>
<member name="F:Cake.Common.Build.GitHubActions.Data.GitHubActionsArchitecture.X64">
<summary>
X64.
</summary>
</member>
<member name="F:Cake.Common.Build.GitHubActions.Data.GitHubActionsArchitecture.ARM">
<summary>
ARM.
</summary>
</member>
<member name="F:Cake.Common.Build.GitHubActions.Data.GitHubActionsArchitecture.ARM64">
<summary>
ARM64.
</summary>
</member>
<member name="T:Cake.Common.Build.GitHubActions.Data.GitHubActionsEnvironmentInfo">
<summary>
Provides GitHub Actions environment information for a current build.
</summary>
</member>
<member name="M:Cake.Common.Build.GitHubActions.Data.GitHubActionsEnvironmentInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.GitHubActions.Data.GitHubActionsEnvironmentInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsEnvironmentInfo.Home">
<summary>
Gets the GitHub Actions home directory.
</summary>
<value>
The home.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.GitHubActions.IsRunningOnGitHubActions)
{
Information(
@"Home: {0}",
BuildSystem.GitHubActions.Environment.Home
);
}
else
{
Information("Not running on GitHubActions");
}
</code>
</example>
<para>Via GitHubActions.</para>
<example>
<code>
if (GitHubActions.IsRunningOnGitHubActions)
{
Information(
@"Home: {0}",
GitHubActions.Environment.Home
);
}
else
{
Information("Not running on GitHubActions");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsEnvironmentInfo.Runner">
<summary>
Gets GitHub Actions runner information.
</summary>
<value>
The GitHub Actions runner information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.GitHubActions.IsRunningOnGitHubActions)
{
Information(
@"Runner:
OS: {0}
Temp: {1}
ToolCache: {2}
Workspace: {3}",
BuildSystem.GitHubActions.Environment.Runner.OS,
BuildSystem.GitHubActions.Environment.Runner.Temp,
BuildSystem.GitHubActions.Environment.Runner.ToolCache,
BuildSystem.GitHubActions.Environment.Runner.Workspace
);
}
else
{
Information("Not running on GitHubActions");
}
</code>
</example>
<para>Via GitHubActions.</para>
<example>
<code>
if (GitHubActions.IsRunningOnGitHubActions)
{
Information(
@"Runner:
OS: {0}
Temp: {1}
ToolCache: {2}
Workspace: {3}",
GitHubActions.Environment.Runner.OS,
GitHubActions.Environment.Runner.Temp,
GitHubActions.Environment.Runner.ToolCache,
GitHubActions.Environment.Runner.Workspace
);
}
else
{
Information("Not running on GitHubActions");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsEnvironmentInfo.Workflow">
<summary>
Gets the GitHub Actions workflow information.
</summary>
<value>
The GitHub Actions workflow information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.GitHubActions.IsRunningOnGitHubActions)
{
Information(
@"Workflow:
Workflow: {0}
Action: {1}
Actor: {2}",
BuildSystem.GitHubActions.Environment.Workflow.Workflow,
BuildSystem.GitHubActions.Environment.Workflow.Action,
BuildSystem.GitHubActions.Environment.Workflow.Actor
);
}
else
{
Information("Not running on GitHubActions");
}
</code>
</example>
<para>Via GitHubActions.</para>
<example>
<code>
Information(
@"Workflow:
Workflow: {0}
Action: {1}
Actor: {2}",
GitHubActions.Environment.Workflow.Workflow,
GitHubActions.Environment.Workflow.Action,
GitHubActions.Environment.Workflow.Actor
);
</code>
</example>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsEnvironmentInfo.PullRequest">
<summary>
Gets GitHub Actions pull request information.
</summary>
<value>
The GitHub Actions pull request information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.GitHubActions.IsRunningOnGitHubActions)
{
Information(
@"PullRequest:
IsPullRequest: {0}",
BuildSystem.GitHubActions.Environment.PullRequest.IsPullRequest
);
}
else
{
Information("Not running on GitHubActions");
}
</code>
</example>
<para>Via GitHubActions.</para>
<example>
<code>
if (GitHubActions.IsRunningOnGitHubActions)
{
Information(
@"PullRequest:
IsPullRequest: {0}",
GitHubActions.Environment.PullRequest.IsPullRequest
);
}
else
{
Information("Not running on GitHubActions");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsEnvironmentInfo.Runtime">
<summary>
Gets GitHub Actions runtime information.
</summary>
<value>
The GitHub Actions runtime information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
// TODO
</code>
</example>
<para>Via GitHubActions.</para>
<example>
<code>
// TODO
</code>
</example>
</member>
<member name="T:Cake.Common.Build.GitHubActions.Data.GitHubActionsPullRequestInfo">
<summary>
Provides GitHub Actions pull request information for the current build.
</summary>
</member>
<member name="M:Cake.Common.Build.GitHubActions.Data.GitHubActionsPullRequestInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.GitHubActions.Data.GitHubActionsPullRequestInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsPullRequestInfo.IsPullRequest">
<summary>
Gets a value indicating whether the current build was started by a pull request.
</summary>
<value>
<c>true</c> if the current build was started by a pull request; otherwise, <c>false</c>.
</value>
</member>
<member name="T:Cake.Common.Build.GitHubActions.Data.GitHubActionsRefType">
<summary>
The GitHub Actions Ref Type.
</summary>
</member>
<member name="F:Cake.Common.Build.GitHubActions.Data.GitHubActionsRefType.Unknown">
<summary>
Unknown.
</summary>
</member>
<member name="F:Cake.Common.Build.GitHubActions.Data.GitHubActionsRefType.Branch">
<summary>
Branch.
</summary>
</member>
<member name="F:Cake.Common.Build.GitHubActions.Data.GitHubActionsRefType.Tag">
<summary>
Tag.
</summary>
</member>
<member name="T:Cake.Common.Build.GitHubActions.Data.GitHubActionsRunnerInfo">
<summary>
Provides GitHub Actions runner information for the current build.
</summary>
</member>
<member name="M:Cake.Common.Build.GitHubActions.Data.GitHubActionsRunnerInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.GitHubActions.Data.GitHubActionsRunnerInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsRunnerInfo.Name">
<summary>
Gets the name of the runner executing the job.
</summary>
<value>
The name of the runner executing the job.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsRunnerInfo.OS">
<summary>
Gets the operating system of the runner executing the job.
</summary>
<value>
The operating system of the runner executing the job.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsRunnerInfo.Temp">
<summary>
Gets the path of the temporary directory for the runner.
</summary>
<value>
The path of the temporary directory for the runner.
This directory is guaranteed to be empty at the start of each job, even on self-hosted runners.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsRunnerInfo.ToolCache">
<summary>
Gets the path of the directory containing some of the pre-installed tools for GitHub-hosted runners.
</summary>
<value>
The path of the directory containing some of the pre-installed tools for GitHub-hosted runners.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsRunnerInfo.Workspace">
<summary>
Gets the runner workspace directory path.
</summary>
<value>
The runner workspace directory path.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsRunnerInfo.ImageOS">
<summary>
Gets the runner image OS on hosted agents.
</summary>
<value>
The runner image OS on hosted agents.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsRunnerInfo.ImageVersion">
<summary>
Gets the runner image version on hosted agents.
</summary>
<value>
The runner image version on hosted agents.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsRunnerInfo.User">
<summary>
Gets the runner user name.
</summary>
<value>
The runner user name.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsRunnerInfo.Architecture">
<summary>
Gets the runner architecture of the runner executing the job.
</summary>
<value>
The runner architecture of the runner executing the job. Possible values are X86, X64, ARM, and ARM64.
</value>
</member>
<member name="T:Cake.Common.Build.GitHubActions.Data.GitHubActionsRuntimeInfo">
<summary>
Provides GitHub Actions runtime information for the current build.
</summary>
</member>
<member name="M:Cake.Common.Build.GitHubActions.Data.GitHubActionsRuntimeInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.GitHubActions.Data.GitHubActionsRuntimeInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsRuntimeInfo.IsRuntimeAvailable">
<summary>
Gets a value indicating whether the GitHub Actions Runtime is available for the current build.
</summary>
<value>
<c>true</c> if the GitHub Actions Runtime is available for the current build.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsRuntimeInfo.Token">
<summary>
Gets the current runtime API authorization token.
</summary>
<value>
The current runtime API authorization token.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsRuntimeInfo.Url">
<summary>
Gets the current runtime API endpoint url.
</summary>
<value>
The current runtime API endpoint url.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsRuntimeInfo.EnvPath">
<summary>
Gets the path to environment file to set an environment variable that the following steps in a job can use.
</summary>
<value>
The path to environment file to set an environment variable that the following steps in a job can use.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsRuntimeInfo.OutputPath">
<summary>
Gets the path to output file to set an output parameter that the following steps in a job can use.
</summary>
<value>
The path to output file to set an output parameter that the following steps in a job can use.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsRuntimeInfo.StepSummary">
<summary>
Gets the path to output file to set the step summary.
</summary>
<value>
The path to output file to set the step summary.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsRuntimeInfo.SystemPath">
<summary>
Gets the path to path file to add a path to system path that the following steps in a job can use.
</summary>
<value>
The path to path file to add a path to system path that the following steps in a job can use.
</value>
</member>
<member name="T:Cake.Common.Build.GitHubActions.Data.GitHubActionsWorkflowInfo">
<summary>
Provide GitHub Actions workflow information for a current build.
</summary>
</member>
<member name="M:Cake.Common.Build.GitHubActions.Data.GitHubActionsWorkflowInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.GitHubActions.Data.GitHubActionsWorkflowInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsWorkflowInfo.Action">
<summary>
Gets the unique identifier of the action.
</summary>
<value>
The unique identifier of the action.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsWorkflowInfo.ActionPath">
<summary>
Gets the path where your action is located. You can use this path to access files located in the same repository as your action. This variable is only supported in composite run steps actions.
</summary>
<value>
The path where your action is located. You can use this path to access files located in the same repository as your action. This variable is only supported in composite run steps actions.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsWorkflowInfo.Actor">
<summary>
Gets the name of the person or app that initiated the workflow.
</summary>
<value>
The name of the person or app that initiated the workflow.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsWorkflowInfo.ApiUrl">
<summary>
Gets the API URL.
</summary>
<value>
The API URL. For example: https://api.github.com.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsWorkflowInfo.BaseRef">
<summary>
Gets the branch of the base repository.
</summary>
<value>
The branch of the base repository. Only set for forked repositories.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsWorkflowInfo.EventName">
<summary>
Gets the name of the webhook event that triggered the workflow.
</summary>
<value>
The name of the webhook event that triggered the workflow.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsWorkflowInfo.EventPath">
<summary>
Gets the path of the file with the complete webhook event payload.
</summary>
<value>
The path of the file with the complete webhook event payload.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsWorkflowInfo.GraphQLUrl">
<summary>
Gets the GraphQL API URL.
</summary>
<value>
The GraphQL API URL. For example: https://api.github.com/graphql.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsWorkflowInfo.HeadRef">
<summary>
Gets the branch of the head repository.
</summary>
<value>
The branch of the head repository. Only set for forked repositories.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsWorkflowInfo.Job">
<summary>
Gets the job name.
</summary>
<value>
The job name.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsWorkflowInfo.Ref">
<summary>
Gets the branch or tag ref that triggered the workflow.
</summary>
<value>
The branch or tag ref that triggered the workflow.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsWorkflowInfo.Repository">
<summary>
Gets the owner and repository name.
</summary>
<value>
The owner and repository name.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsWorkflowInfo.RepositoryOwner">
<summary>
Gets the repository owner.
</summary>
<value>
The repository owner.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsWorkflowInfo.RunId">
<summary>
Gets the unique number for each run within the repository.
</summary>
<value>
The unique number for each run within the repository.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsWorkflowInfo.RunNumber">
<summary>
Gets the unique number for each run of a particular workflow in the repository.
</summary>
<value>
The unique number for each run of a particular workflow in the repository.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsWorkflowInfo.ServerUrl">
<summary>
Gets the URL of the GitHub server.
</summary>
<value>
The URL of the GitHub server. For example: https://github.com.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsWorkflowInfo.Sha">
<summary>
Gets the commit SHA that triggered the workflow.
</summary>
<value>
The commit SHA that triggered the workflow.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsWorkflowInfo.Workflow">
<summary>
Gets the name of the workflow.
</summary>
<value>
The name of the workflow.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsWorkflowInfo.Workspace">
<summary>
Gets the GitHub workspace directory path.
</summary>
<value>
The GitHub workspace directory path.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsWorkflowInfo.Attempt">
<summary>
Gets the number of attempts for current run.
</summary>
<value>
The attempt number for current run.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsWorkflowInfo.RefProtected">
<summary>
Gets a value indicating whether if branch protections are configured for the ref that triggered the workflow run.
</summary>
<value>
Value whether if branch protections are configured for the ref that triggered the workflow run.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsWorkflowInfo.RefName">
<summary>
Gets the branch or tag name that triggered the workflow run.
</summary>
<value>
The branch or tag name that triggered the workflow run.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.Data.GitHubActionsWorkflowInfo.RefType">
<summary>
Gets the type of ref that triggered the workflow run.
</summary>
<value>
The type of ref that triggered the workflow run. Valid values are branch or tag.
</value>
</member>
<member name="T:Cake.Common.Build.GitHubActions.GitHubActionsInfo">
<summary>
Base class used to provide information about the GitHub Actions environment.
</summary>
</member>
<member name="M:Cake.Common.Build.GitHubActions.GitHubActionsInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.GitHubActions.GitHubActionsInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="M:Cake.Common.Build.GitHubActions.GitHubActionsInfo.GetEnvironmentString(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.String"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.GitHubActions.GitHubActionsInfo.GetEnvironmentDirectoryPath(System.String)">
<summary>
Gets an environment variable as a <see cref="T:Cake.Core.IO.DirectoryPath"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.GitHubActions.GitHubActionsInfo.GetEnvironmentFilePath(System.String)">
<summary>
Gets an environment variable as a <see cref="T:Cake.Core.IO.FilePath"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.GitHubActions.GitHubActionsInfo.GetEnvironmentInteger(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Int32"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.GitHubActions.GitHubActionsInfo.GetEnvironmentBoolean(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Boolean"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="T:Cake.Common.Build.GitHubActions.GitHubActionsProvider">
<summary>
Responsible for communicating with GitHub Actions.
</summary>
</member>
<member name="M:Cake.Common.Build.GitHubActions.GitHubActionsProvider.#ctor(Cake.Core.ICakeEnvironment,Cake.Core.IO.IFileSystem,Cake.Common.Build.IBuildSystemServiceMessageWriter)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.GitHubActions.GitHubActionsProvider"/> class.
</summary>
<param name="environment">The environment.</param>
<param name="fileSystem">The file system.</param>
<param name="writer">The build system service message writer.</param>
</member>
<member name="P:Cake.Common.Build.GitHubActions.GitHubActionsProvider.IsRunningOnGitHubActions">
<inheritdoc/>
</member>
<member name="P:Cake.Common.Build.GitHubActions.GitHubActionsProvider.Environment">
<inheritdoc/>
</member>
<member name="P:Cake.Common.Build.GitHubActions.GitHubActionsProvider.Commands">
<inheritdoc/>
</member>
<member name="T:Cake.Common.Build.GitHubActions.IGitHubActionsProvider">
<summary>
Represents a GitHub Actions provider.
</summary>
</member>
<member name="P:Cake.Common.Build.GitHubActions.IGitHubActionsProvider.IsRunningOnGitHubActions">
<summary>
Gets a value indicating whether the current build is running on GitHub Actions.
</summary>
<value>
<c>true</c> if the current build is running on GitHub Actions; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.IGitHubActionsProvider.Environment">
<summary>
Gets the GitHub Actions environment.
</summary>
<value>
The GitHub Actions environment.
</value>
</member>
<member name="P:Cake.Common.Build.GitHubActions.IGitHubActionsProvider.Commands">
<summary>
Gets the GitHub Actions commands.
</summary>
<value>
The GitHub Actions commands.
</value>
</member>
<member name="T:Cake.Common.Build.GitLabCI.Data.GitLabCIBuildInfo">
<summary>
Provide GitLab CI build information for a current build.
</summary>
</member>
<member name="M:Cake.Common.Build.GitLabCI.Data.GitLabCIBuildInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.GitLabCI.Data.GitLabCIBuildInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIBuildInfo.Id">
<summary>
Gets the unique id of the current build that GitLab CI uses internally.
</summary>
<value>
The build ID.
</value>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIBuildInfo.Reference">
<summary>
Gets the commit revision for which project is built.
</summary>
<value>
The commit revision hash.
</value>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIBuildInfo.Tag">
<summary>
Gets the commit tag name. Present only when building tags.
</summary>
<value>
The build tag name.
</value>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIBuildInfo.Name">
<summary>
Gets the name of the build as defined in .gitlab-ci.yml.
</summary>
<value>
The name of the build.
</value>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIBuildInfo.Stage">
<summary>
Gets the name of the stage as defined in .gitlab-ci.yml.
</summary>
<value>
The name of the current stage.
</value>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIBuildInfo.RefName">
<summary>
Gets the branch or tag name for which project is built.
</summary>
<value>
The branch or tag for this build.
</value>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIBuildInfo.RepoUrl">
<summary>
Gets the URL to clone the Git repository.
</summary>
<value>
The repository URL.
</value>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIBuildInfo.Triggered">
<summary>
Gets a value indicating whether the build was triggered.
</summary>
<value>
<c>True</c> if the build was triggered, otherwise <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIBuildInfo.Manual">
<summary>
Gets a value indicating whether the build was manually started.
</summary>
<value>
<c>True</c> if the build was started manually, otherwise <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIBuildInfo.Token">
<summary>
Gets the token used for authenticating with the GitLab Container Registry.
</summary>
<value>
The build authorisation token.
</value>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIBuildInfo.PipelineId">
<summary>
Gets the unique id of the current pipeline that GitLab CI uses internally.
</summary>
<value>
The unique build ID.
</value>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIBuildInfo.PipelineIId">
<summary>
Gets the unique id of the current pipeline scoped to the project.
</summary>
<value>
The unique build ID.
</value>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIBuildInfo.UserId">
<summary>
Gets the id of the user who started the build.
</summary>
<value>
The user ID.
</value>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIBuildInfo.UserEmail">
<summary>
Gets the email of the user who started the build.
</summary>
<value>
The email address of the user.
</value>
</member>
<member name="T:Cake.Common.Build.GitLabCI.Data.GitLabCIEnvironmentInfo">
<summary>
Provides GitLab CI environment information for a current build.
</summary>
</member>
<member name="M:Cake.Common.Build.GitLabCI.Data.GitLabCIEnvironmentInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.GitLabCI.Data.GitLabCIEnvironmentInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIEnvironmentInfo.Runner">
<summary>
Gets the GitLab CI runner information.
</summary>
<value>
The GitLab CI runner information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.GitLabCI.IsRunningOnGitLabCI)
{
Information(
@"Runner:
Id: {0}
Description: {1}
Tags: {2}",
BuildSystem.GitLabCI.Environment.Runner.Id,
BuildSystem.GitLabCI.Environment.Runner.Description,
BuildSystem.GitLabCI.Environment.Runner.Tags
);
}
else
{
Information("Not running on GitLabCI");
}
</code>
</example>
<para>Via GitLabCI.</para>
<example>
<code>
if (GitLabCI.IsRunningOnGitLabCI)
{
Information(
@"Runner:
Id: {0}
Description: {1}
Tags: {2}",
GitLabCI.Environment.Runner.Id,
GitLabCI.Environment.Runner.Description,
GitLabCI.Environment.Runner.Tags
);
}
else
{
Information("Not running on GitLabCI");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIEnvironmentInfo.Server">
<summary>
Gets the GitLab CI server information.
</summary>
<value>
The GitLab CI server information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.GitLabCI.IsRunningOnGitLabCI)
{
Information(
@"Server:
Name: {0}
Version: {1}
Revision: {2}",
BuildSystem.GitLabCI.Environment.Server.Name,
BuildSystem.GitLabCI.Environment.Server.Version,
BuildSystem.GitLabCI.Environment.Server.Revision
);
}
else
{
Information("Not running on GitLabCI");
}
</code>
</example>
<para>Via GitLabCI.</para>
<example>
<code>
if (GitLabCI.IsRunningOnGitLabCI)
{
Information(
@"Server:
Name: {0}
Version: {1}
Revision: {2}",
GitLabCI.Environment.Server.Name,
GitLabCI.Environment.Server.Version,
GitLabCI.Environment.Server.Revision
);
}
else
{
Information("Not running on GitLabCI");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIEnvironmentInfo.Build">
<summary>
Gets the GitLab CI build information.
</summary>
<value>
The GitLab CI build information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.GitLabCI.IsRunningOnGitLabCI)
{
Information(
@"Build:
Id: {0}
Reference: {1}
Tag: {2}
Name: {3}
Stage: {4}",
BuildSystem.GitLabCI.Environment.Build.Id,
BuildSystem.GitLabCI.Environment.Build.Reference,
BuildSystem.GitLabCI.Environment.Build.Tag,
BuildSystem.GitLabCI.Environment.Build.Tag,
BuildSystem.GitLabCI.Environment.Build.Stage
);
}
else
{
Information("Not running on GitLabCI");
}
</code>
</example>
<para>Via GitLabCI.</para>
<example>
<code>
Information(
@"Build:
Id: {0}
Reference: {1}
Tag: {2}
Name: {3}
Stage: {4}",
GitLabCI.Environment.Build.Id,
GitLabCI.Environment.Build.Reference,
GitLabCI.Environment.Build.Tag,
GitLabCI.Environment.Build.Tag,
GitLabCI.Environment.Build.Stage
);
</code>
</example>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIEnvironmentInfo.PullRequest">
<summary>
Gets GitLab CI pull request information.
</summary>
<value>
The GitLab CI pull request information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.GitLabCI.IsRunningOnGitLabCI)
{
Information(
@"PullRequest:
IsPullRequest: {0}
Id: {1}
IId: {2}",
BuildSystem.GitLabCI.Environment.PullRequest.IsPullRequest,
BuildSystem.GitLabCI.Environment.PullRequest.Id,
BuildSystem.GitLabCI.Environment.PullRequest.IId
);
}
else
{
Information("Not running on GitLabCI");
}
</code>
</example>
<para>Via GitLabCI.</para>
<example>
<code>
if (GitLabCI.IsRunningOnGitLabCI)
{
Information(
@"PullRequest:
IsPullRequest: {0}
Id: {1}
IId: {2}",
GitLabCI.Environment.PullRequest.IsPullRequest,
GitLabCI.Environment.PullRequest.Id,
GitLabCI.Environment.PullRequest.IId
);
}
else
{
Information("Not running on GitLabCI");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIEnvironmentInfo.Project">
<summary>
Gets the GitLab CI project information.
</summary>
<value>
The GitLab CI project information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.GitLabCI.IsRunningOnGitLabCI)
{
Information(
@"Project:
Id: {0}
Name: {1}
Namespace: {2}
Path: {3}
Url: {4}
Directory: {5}",
BuildSystem.GitLabCI.Environment.Project.Id,
BuildSystem.GitLabCI.Environment.Project.Name,
BuildSystem.GitLabCI.Environment.Project.Namespace,
BuildSystem.GitLabCI.Environment.Project.Path,
BuildSystem.GitLabCI.Environment.Project.Url,
BuildSystem.GitLabCI.Environment.Project.Directory
);
}
else
{
Information("Not running on GitLabCI");
}
</code>
</example>
<para>Via GitLabCI.</para>
<example>
<code>
Information(
@"Project:
Id: {0}
Name: {1}
Namespace: {2}
Path: {3}
Url: {4}
Directory: {5}",
GitLabCI.Environment.Project.Id,
GitLabCI.Environment.Project.Name,
GitLabCI.Environment.Project.Namespace,
GitLabCI.Environment.Project.Path,
GitLabCI.Environment.Project.Url,
GitLabCI.Environment.Project.Directory
);
</code>
</example>
</member>
<member name="T:Cake.Common.Build.GitLabCI.Data.GitLabCIProjectInfo">
<summary>
Provides GitLab CI project information for a current build.
</summary>
</member>
<member name="M:Cake.Common.Build.GitLabCI.Data.GitLabCIProjectInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.GitLabCI.Data.GitLabCIProjectInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIProjectInfo.Id">
<summary>
Gets the unique id of the current project that GitLab CI uses internally.
</summary>
<value>
The project ID.
</value>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIProjectInfo.Name">
<summary>
Gets the project name that is currently being built.
</summary>
<value>
The project name.
</value>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIProjectInfo.Namespace">
<summary>
Gets the project namespace (username or groupname) that is currently being built.
</summary>
<value>
The project namespace.
</value>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIProjectInfo.Path">
<summary>
Gets the namespace with project name.
</summary>
<value>
The project namespace and project name.
</value>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIProjectInfo.Url">
<summary>
Gets the HTTP address to access the project.
</summary>
<value>
The HTTP address to access the project.
</value>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIProjectInfo.Directory">
<summary>
Gets the full path where the repository is cloned and where the build is run.
</summary>
<value>
The full path where the repository is cloned and where the build is run.
</value>
</member>
<member name="T:Cake.Common.Build.GitLabCI.Data.GitLabCIPullRequestInfo">
<summary>
Provides GitLab CI pull request information for the current build.
</summary>
</member>
<member name="M:Cake.Common.Build.GitLabCI.Data.GitLabCIPullRequestInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.GitLabCI.Data.GitLabCIPullRequestInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIPullRequestInfo.IsPullRequest">
<summary>
Gets a value indicating whether the current build was started by a pull request.
</summary>
<value>
<c>true</c> if the current build was started by a pull request; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIPullRequestInfo.Id">
<summary>
Gets the pull request id that GitLab CI uses internally.
</summary>
<value>
The pull request id.
</value>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIPullRequestInfo.IId">
<summary>
Gets the pull request id scoped to the project.
</summary>
<value>
The pull request id.
</value>
</member>
<member name="T:Cake.Common.Build.GitLabCI.Data.GitLabCIRunnerInfo">
<summary>
Provides GitLab CI runner information for a current build.
</summary>
</member>
<member name="M:Cake.Common.Build.GitLabCI.Data.GitLabCIRunnerInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.GitLabCI.Data.GitLabCIRunnerInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIRunnerInfo.Id">
<summary>
Gets the unique id of runner being used.
</summary>
<value>
The unique id of runner being used.
</value>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIRunnerInfo.Description">
<summary>
Gets the description of the runner as saved in GitLab.
</summary>
<value>
The description of the runner as saved in GitLab.
</value>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIRunnerInfo.Tags">
<summary>
Gets an array of the defined runner tags.
</summary>
<value>
The defined runner tags.
</value>
</member>
<member name="T:Cake.Common.Build.GitLabCI.Data.GitLabCIServerInfo">
<summary>
Provides GitLab CI server information for a current build.
</summary>
</member>
<member name="M:Cake.Common.Build.GitLabCI.Data.GitLabCIServerInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.GitLabCI.Data.GitLabCIServerInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIServerInfo.Name">
<summary>
Gets the name of CI server that is used to coordinate builds.
</summary>
<value>
The name of CI server that is used to coordinate builds.
</value>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIServerInfo.Version">
<summary>
Gets the GitLab version that is used to schedule builds.
</summary>
<value>
The GitLab version that is used to schedule builds.
</value>
</member>
<member name="P:Cake.Common.Build.GitLabCI.Data.GitLabCIServerInfo.Revision">
<summary>
Gets the GitLab revision that is used to schedule builds.
</summary>
<value>
The GitLab revision that is used to schedule builds.
</value>
</member>
<member name="T:Cake.Common.Build.GitLabCI.GitLabCICommands">
<summary>
Provides GitLab CI commands for a current build.
</summary>
</member>
<member name="M:Cake.Common.Build.GitLabCI.GitLabCICommands.#ctor(Cake.Core.IO.IFileSystem)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.GitLabCI.GitLabCICommands"/> class.
</summary>
<param name="fileSystem">The file system.</param>
</member>
<member name="M:Cake.Common.Build.GitLabCI.GitLabCICommands.SetEnvironmentVariable(Cake.Core.IO.FilePath,System.String,System.String)">
<summary>
Creates or updates an environment variable for any steps running next in a job.
</summary>
<param name="envPath">Path to env file.</param>
<param name="key">The key.</param>
<param name="value">The Value.</param>
</member>
<member name="T:Cake.Common.Build.GitLabCI.GitLabCIInfo">
<summary>
Base class used to provide information about the GitLab CI environment.
</summary>
</member>
<member name="M:Cake.Common.Build.GitLabCI.GitLabCIInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.GitLabCI.GitLabCIInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="M:Cake.Common.Build.GitLabCI.GitLabCIInfo.GetEnvironmentString(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.String"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.GitLabCI.GitLabCIInfo.GetEnvironmentString(System.String,System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.String"/>.
</summary>
<param name="primaryVariable">The primary environment variable name.</param>
<param name="secondaryVariable">The secondary environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.GitLabCI.GitLabCIInfo.GetEnvironmentInteger(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Int32"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.GitLabCI.GitLabCIInfo.GetEnvironmentInteger(System.String,System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Int32"/>.
</summary>
<param name="primaryVariable">The primary environment variable name.</param>
<param name="secondaryVariable">The secondary environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.GitLabCI.GitLabCIInfo.GetEnvironmentBoolean(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Boolean"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.GitLabCI.GitLabCIInfo.GetEnvironmentBoolean(System.String,System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Boolean"/>.
</summary>
<param name="primaryVariable">The primary environment variable name.</param>
<param name="secondaryVariable">The secondary environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="T:Cake.Common.Build.GitLabCI.GitLabCIProvider">
<summary>
Responsible for communicating with GitLab CI.
</summary>
</member>
<member name="M:Cake.Common.Build.GitLabCI.GitLabCIProvider.#ctor(Cake.Core.ICakeEnvironment,Cake.Core.IO.IFileSystem)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.GitLabCI.GitLabCIProvider"/> class.
</summary>
<param name="environment">The environment.</param>
<param name="fileSystem">The file system.</param>
</member>
<member name="P:Cake.Common.Build.GitLabCI.GitLabCIProvider.IsRunningOnGitLabCI">
<inheritdoc/>
</member>
<member name="P:Cake.Common.Build.GitLabCI.GitLabCIProvider.Environment">
<inheritdoc/>
</member>
<member name="P:Cake.Common.Build.GitLabCI.GitLabCIProvider.Commands">
<inheritdoc/>
</member>
<member name="T:Cake.Common.Build.GitLabCI.IGitLabCIProvider">
<summary>
Represents a GitLab CI provider.
</summary>
</member>
<member name="P:Cake.Common.Build.GitLabCI.IGitLabCIProvider.IsRunningOnGitLabCI">
<summary>
Gets a value indicating whether the current build is running on GitLab CI.
</summary>
<value>
<c>true</c> if the current build is running on GitLab CI; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.GitLabCI.IGitLabCIProvider.Environment">
<summary>
Gets the GitLab CI environment.
</summary>
<value>
The GitLab CI environment.
</value>
</member>
<member name="P:Cake.Common.Build.GitLabCI.IGitLabCIProvider.Commands">
<summary>
Gets the GitLab CI commands.
</summary>
<value>
The GitLab CI commands.
</value>
</member>
<member name="T:Cake.Common.Build.GoCD.Data.GoCDBuildCauseInfo">
<summary>
The Go.CD build cause.
</summary>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDBuildCauseInfo.Approver">
<summary>
Gets or sets the approver.
</summary>
<value>
The approver.
</value>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDBuildCauseInfo.MaterialRevisions">
<summary>
Gets or sets the material revisions.
</summary>
<value>
The material revisions.
</value>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDBuildCauseInfo.TriggerForced">
<summary>
Gets or sets a value indicating whether the trigger was forced.
</summary>
<value>
<c>true</c> if the trigger was forced; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDBuildCauseInfo.TriggerMessage">
<summary>
Gets or sets the trigger message.
</summary>
<value>
The trigger message.
</value>
</member>
<member name="T:Cake.Common.Build.GoCD.Data.GoCDEnvironmentInfo">
<summary>
Provides Go.CD environment information for a current build.
</summary>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDEnvironmentInfo.Pipeline">
<summary>
Gets GoCD pipeline information.
</summary>
<value>
The GoCD pipeline information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.GoCD.IsRunningOnGoCD)
{
Information(
@"Pipeline:
Name: {0}
Counter: {1}
Label: {2}",
BuildSystem.GoCD.Environment.Pipeline.Name,
BuildSystem.GoCD.Environment.Pipeline.Counter,
BuildSystem.GoCD.Environment.Pipeline.Label
);
}
else
{
Information("Not running on GoCD");
}
</code>
</example>
<para>Via GoCD.</para>
<example>
<code>
if (GoCD.IsRunningOnGoCD)
{
Information(
@"Pipeline:
Name: {0}
Counter: {1}
Label: {2}",
GoCD.Environment.Pipeline.Name,
GoCD.Environment.Pipeline.Counter,
GoCD.Environment.Pipeline.Label
);
}
else
{
Information("Not running on GoCD");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDEnvironmentInfo.Stage">
<summary>
Gets GoCD stage information.
</summary>
<value>
The GoCD stage information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.GoCD.IsRunningOnGoCD)
{
Information(
@"Stage:
Name: {0}
Counter: {1}",
BuildSystem.GoCD.Environment.Stage.Name,
BuildSystem.GoCD.Environment.Stage.Counter
);
}
else
{
Information("Not running on GoCD");
}
</code>
</example>
<para>Via GoCD.</para>
<example>
<code>
if (GoCD.IsRunningOnGoCD)
{
Information(
@"Stage:
Name: {0}
Counter: {1}",
GoCD.Environment.Stage.Name,
GoCD.Environment.Stage.Counter
);
}
else
{
Information("Not running on GoCD");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDEnvironmentInfo.Repository">
<summary>
Gets GoCD repository information.
</summary>
<value>
The GoCD repository information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.GoCD.IsRunningOnGoCD)
{
Information(
@"Repository:
Revision: {0}
ToRevision: {1}
FromRevision: {2}",
BuildSystem.GoCD.Environment.Repository.Revision,
BuildSystem.GoCD.Environment.Repository.ToRevision,
BuildSystem.GoCD.Environment.Repository.FromRevision
);
}
else
{
Information("Not running on GoCD");
}
</code>
</example>
<para>Via GoCD.</para>
<example>
<code>
if (GoCD.IsRunningOnGoCD)
{
Information(
@"Repository:
Revision: {0}
ToRevision: {1}
FromRevision: {2}",
GoCD.Environment.Repository.Revision,
GoCD.Environment.Repository.ToRevision,
GoCD.Environment.Repository.FromRevision
);
}
else
{
Information("Not running on GoCD");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDEnvironmentInfo.GoCDUrl">
<summary>
Gets the Go.CD URL.
</summary>
<value>
The Go.CD URL.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.GoCD.IsRunningOnGoCD)
{
Information(
@"GoCDUrl: {0}",
BuildSystem.GoCD.Environment.GoCDUrl
);
}
else
{
Information("Not running on GoCD");
}
</code>
</example>
<para>Via GoCD.</para>
<example>
<code>
if (GoCD.IsRunningOnGoCD)
{
Information(
@"GoCDUrl: {0}",
GoCD.Environment.GoCDUrl
);
}
else
{
Information("Not running on GoCD");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDEnvironmentInfo.EnvironmentName">
<summary>
Gets the environment name. This is only set if the environment is specified. Otherwise the variable is not set.
</summary>
<value>
The environment name.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.GoCD.IsRunningOnGoCD)
{
Information(
@"EnvironmentName: {0}",
BuildSystem.GoCD.Environment.EnvironmentName
);
}
else
{
Information("Not running on GoCD");
}
</code>
</example>
<para>Via GoCD.</para>
<example>
<code>
if (GoCD.IsRunningOnGoCD)
{
Information(
@"EnvironmentName: {0}",
GoCD.Environment.EnvironmentName
);
}
else
{
Information("Not running on GoCD");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDEnvironmentInfo.JobName">
<summary>
Gets the name of the current job being run.
</summary>
<value>
The job name.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.GoCD.IsRunningOnGoCD)
{
Information(
@"JobName: {0}",
BuildSystem.GoCD.Environment.JobName
);
}
else
{
Information("Not running on GoCD");
}
</code>
</example>
<para>Via GoCD.</para>
<example>
<code>
if (GoCD.IsRunningOnGoCD)
{
Information(
@"JobName: {0}",
GoCD.Environment.JobName
);
}
else
{
Information("Not running on GoCD");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDEnvironmentInfo.User">
<summary>
Gets the username of the user that triggered the build. This will have one of three possible values:
anonymous - if there is no security.
username of the user, who triggered the build.
changes, if SCM changes auto-triggered the build.
timer, if the pipeline is triggered at a scheduled time.
</summary>
<value>
The username of the user that triggered the build.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.GoCD.IsRunningOnGoCD)
{
Information(
@"User: {0}",
BuildSystem.GoCD.Environment.User
);
}
else
{
Information("Not running on GoCD");
}
</code>
</example>
<para>Via GoCD.</para>
<example>
<code>
if (GoCD.IsRunningOnGoCD)
{
Information(
@"User: {0}",
GoCD.Environment.User
);
}
else
{
Information("Not running on GoCD");
}
</code>
</example>
</member>
<member name="M:Cake.Common.Build.GoCD.Data.GoCDEnvironmentInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.GoCD.Data.GoCDEnvironmentInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.GoCD.Data.GoCDHistoryInfo">
<summary>
The Go.CD history.
</summary>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDHistoryInfo.Pipelines">
<summary>
Gets or sets the pipelines.
</summary>
<value>
The pipelines.
</value>
</member>
<member name="T:Cake.Common.Build.GoCD.Data.GoCDMaterialRevisionsInfo">
<summary>
The Go.CD material revision information.
</summary>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDMaterialRevisionsInfo.Changed">
<summary>
Gets or sets a value indicating whether a change was made.
</summary>
<value>
<c>true</c> if changed; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDMaterialRevisionsInfo.Modifications">
<summary>
Gets or sets the modifications.
</summary>
<value>
The modifications.
</value>
</member>
<member name="T:Cake.Common.Build.GoCD.Data.GoCDModificationInfo">
<summary>
A change made in the repository since the last time the Go.CD pipeline was run.
</summary>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDModificationInfo.EmailAddress">
<summary>
Gets or sets the email address.
</summary>
<value>
The email address.
</value>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDModificationInfo.Id">
<summary>
Gets or sets the identifier.
</summary>
<value>
The identifier.
</value>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDModificationInfo.ModifiedTimeUnixMilliseconds">
<summary>
Gets or sets the modified time in milliseconds from the Unix epoch.
</summary>
<value>
The modified time in milliseconds from the Unix epoch.
</value>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDModificationInfo.ModifiedTime">
<summary>
Gets or sets the modified time.
</summary>
<value>
The modified time.
</value>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDModificationInfo.Username">
<summary>
Gets or sets the username.
</summary>
<value>
The username.
</value>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDModificationInfo.Comment">
<summary>
Gets or sets the comment.
</summary>
<value>
The comment.
</value>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDModificationInfo.Revision">
<summary>
Gets or sets the revision.
</summary>
<value>
The revision.
</value>
</member>
<member name="T:Cake.Common.Build.GoCD.Data.GoCDPipelineHistoryInfo">
<summary>
The Go.CD pipeline history.
</summary>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDPipelineHistoryInfo.BuildCause">
<summary>
Gets or sets the build cause.
</summary>
<value>
The build cause.
</value>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDPipelineHistoryInfo.Comment">
<summary>
Gets or sets the comment.
</summary>
<value>
The comment.
</value>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDPipelineHistoryInfo.Name">
<summary>
Gets or sets the name.
</summary>
<value>
The name.
</value>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDPipelineHistoryInfo.NaturalOrder">
<summary>
Gets or sets the natural order.
</summary>
<value>
The natural order.
</value>
</member>
<member name="T:Cake.Common.Build.GoCD.Data.GoCDPipelineInfo">
<summary>
Provides GoCD pipeline information for a current build.
</summary>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDPipelineInfo.Name">
<summary>
Gets the name of the pipeline.
</summary>
<value>
The name of the pipeline.
</value>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDPipelineInfo.Counter">
<summary>
Gets the pipeline counter, showing how many times the current pipeline has been run.
</summary>
<value>
The pipeline counter.
</value>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDPipelineInfo.Label">
<summary>
Gets the pipeline label. By default, this is set to the pipeline count.
</summary>
<value>
The pipeline label.
</value>
</member>
<member name="M:Cake.Common.Build.GoCD.Data.GoCDPipelineInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.GoCD.Data.GoCDPipelineInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.GoCD.Data.GoCDRepositoryInfo">
<summary>
Provides Go.CD repository information for a current build.
</summary>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDRepositoryInfo.Revision">
<summary>
Gets the source control revision.
</summary>
<value>
The the source control revision.
</value>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDRepositoryInfo.ToRevision">
<summary>
Gets the last revision the build was triggered by if there were multiple revisions.
</summary>
<value>
The last revision the build was triggered by if there were multiple revisions.
</value>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDRepositoryInfo.FromRevision">
<summary>
Gets the first revision the build was triggered by if there were multiple revisions.
</summary>
<value>
The first revision the build was triggered by if there were multiple revisions.
</value>
</member>
<member name="M:Cake.Common.Build.GoCD.Data.GoCDRepositoryInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.GoCD.Data.GoCDRepositoryInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.GoCD.Data.GoCDStageInfo">
<summary>
Provides Go.CD commit information for a current build.
</summary>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDStageInfo.Name">
<summary>
Gets the name of the current stage being run.
</summary>
<value>
The stage name.
</value>
</member>
<member name="P:Cake.Common.Build.GoCD.Data.GoCDStageInfo.Counter">
<summary>
Gets the count of the number of times the current stage has been run.
</summary>
<value>
The stage counter.
</value>
</member>
<member name="M:Cake.Common.Build.GoCD.Data.GoCDStageInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.GoCD.Data.GoCDStageInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.GoCD.GoCDInfo">
<summary>
Base class used to provide information about the Go.CD environment.
</summary>
</member>
<member name="M:Cake.Common.Build.GoCD.GoCDInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.GoCD.GoCDInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="M:Cake.Common.Build.GoCD.GoCDInfo.GetEnvironmentString(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.String"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.GoCD.GoCDInfo.GetEnvironmentInteger(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Int32"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.GoCD.GoCDInfo.GetEnvironmentBoolean(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Boolean"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="T:Cake.Common.Build.GoCD.GoCDProvider">
<summary>
Responsible for communicating with GoCD.
</summary>
</member>
<member name="M:Cake.Common.Build.GoCD.GoCDProvider.#ctor(Cake.Core.ICakeEnvironment,Cake.Core.Diagnostics.ICakeLog)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.GoCD.GoCDProvider" /> class.
</summary>
<param name="environment">The environment.</param>
<param name="log">The cake log.</param>
</member>
<member name="P:Cake.Common.Build.GoCD.GoCDProvider.IsRunningOnGoCD">
<inheritdoc/>
</member>
<member name="P:Cake.Common.Build.GoCD.GoCDProvider.Environment">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.GoCD.GoCDProvider.GetHistory(System.String,System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.GoCD.GoCDProvider.GetHistory(System.String,System.String,System.String)">
<inheritdoc/>
</member>
<member name="T:Cake.Common.Build.GoCD.IGoCDProvider">
<summary>
Represents a Go.CD provider.
</summary>
</member>
<member name="P:Cake.Common.Build.GoCD.IGoCDProvider.IsRunningOnGoCD">
<summary>
Gets a value indicating whether the current build is running on Go.CD.
</summary>
<value>
<c>true</c> if the current build is running on Go.CD; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.GoCD.IGoCDProvider.Environment">
<summary>
Gets the Go.CD environment.
</summary>
<value>
The Go.CD environment.
</value>
</member>
<member name="M:Cake.Common.Build.GoCD.IGoCDProvider.GetHistory(System.String,System.String)">
<summary>
Gets the Go.CD build history, including the repository modifications that caused the pipeline to start.
</summary>
<param name="username">The Go.CD username.</param>
<param name="password">The Go.CD password.</param>
<returns>The Go.CD build history.</returns>
</member>
<member name="M:Cake.Common.Build.GoCD.IGoCDProvider.GetHistory(System.String,System.String,System.String)">
<summary>
Gets the Go.CD build history, including the repository modifications that caused the pipeline to start.
</summary>
<param name="username">The Go.CD username.</param>
<param name="password">The Go.CD password.</param>
<param name="serverUrl">The Go.CD server URL.</param>
<returns>The Go.CD build history.</returns>
</member>
<member name="T:Cake.Common.Build.IBuildSystemServiceMessageWriter">
<summary>
Represents build system output.
</summary>
</member>
<member name="M:Cake.Common.Build.IBuildSystemServiceMessageWriter.Write(System.String,System.Object[])">
<summary>
Writes a message to the build system output.
</summary>
<param name="format">A composite format string.</param>
<param name="args">An array of objects to write using format.</param>
</member>
<member name="T:Cake.Common.Build.Jenkins.Data.JenkinsBuildInfo">
<summary>
Provides Jenkins build information for the current build.
</summary>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsBuildInfo.BuildNumber">
<summary>
Gets the build number.
</summary>
<value>
The build number.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsBuildInfo.BuildId">
<summary>
Gets the build identifier which is identical to <see cref="P:Cake.Common.Build.Jenkins.Data.JenkinsBuildInfo.BuildNumber"/> starting from Jenkins 1.597 and a YYYY-MM-DD_hh-mm-ss timestamp for older builds.
</summary>
<value>
The build identifier.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsBuildInfo.BuildDisplayName">
<summary>
Gets the display name of the build.
</summary>
<value>
The display name of the build.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsBuildInfo.BuildTag">
<summary>
Gets the build tag which is a string of "jenkins-${JOB_NAME}-${BUILD_NUMBER}". All forward slashes (/) in the JOB_NAME are replaced with dashes (-).
</summary>
<value>
The build tag.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsBuildInfo.BuildUrl">
<summary>
Gets the build URL.
</summary>
<value>
The build URL.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsBuildInfo.ExecutorNumber">
<summary>
Gets the executor number.
</summary>
<value>
The executor number.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsBuildInfo.Workspace">
<summary>
Gets the absolute path of the workspace directory assigned to the build.
</summary>
<value>
The workspace directory path.
</value>
</member>
<member name="M:Cake.Common.Build.Jenkins.Data.JenkinsBuildInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.Jenkins.Data.JenkinsBuildInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.Jenkins.Data.JenkinsChangeInfo">
<summary>
Provides Jenkins change information for the current build in multibranch projects.
</summary>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsChangeInfo.Id">
<summary>
Gets the change id.
</summary>
<value>
The changed id such as a pull request number.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsChangeInfo.IsPullRequest">
<summary>
Gets a value indicating whether the current build was started by a pull request.
</summary>
<value>
<c>true</c> if the current build was started by a pull request; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsChangeInfo.Url">
<summary>
Gets the change URL.
</summary>
<value>
The change URL.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsChangeInfo.Title">
<summary>
Gets the change title.
</summary>
<value>
The change title.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsChangeInfo.Author">
<summary>
Gets change author.
</summary>
<value>
The change author.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsChangeInfo.AuthorDisplayName">
<summary>
Gets the human name of the change author.
</summary>
<value>
The human name of the change author.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsChangeInfo.AuthorEmail">
<summary>
Gets the email address of the change author.
</summary>
<value>
The email address of the change author.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsChangeInfo.Target">
<summary>
Gets the target/base branch of the change.
</summary>
<value>
The target of the change.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsChangeInfo.Branch">
<summary>
Gets the origin branch of the change.
</summary>
<value>
The origin branch of the change.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsChangeInfo.Fork">
<summary>
Gets the fork name of the change.
</summary>
<value>
The fork name of the change.
</value>
</member>
<member name="M:Cake.Common.Build.Jenkins.Data.JenkinsChangeInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.Jenkins.Data.JenkinsChangeInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.Jenkins.Data.JenkinsEnvironmentInfo">
<summary>
Provides Jenkins environment information for the current build.
</summary>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsEnvironmentInfo.Build">
<summary>
Gets Jenkins build information.
</summary>
<value>
The build.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.Jenkins.IsRunningOnJenkins)
{
Information(
@"Build:
BuildNumber: {0}
BuildId: {1}
BuildDisplayName: {2}",
BuildSystem.Jenkins.Environment.Build.BuildNumber,
BuildSystem.Jenkins.Environment.Build.BuildId,
BuildSystem.Jenkins.Environment.Build.BuildDisplayName
);
}
else
{
Information("Not running on Jenkins");
}
</code>
</example>
<para>Via Jenkins.</para>
<example>
<code>
if (Jenkins.IsRunningOnJenkins)
{
Information(
@"Build:
BuildNumber: {0}
BuildId: {1}
BuildDisplayName: {2}",
Jenkins.Environment.Build.BuildNumber,
Jenkins.Environment.Build.BuildId,
Jenkins.Environment.Build.BuildDisplayName
);
}
else
{
Information("Not running on Jenkins");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsEnvironmentInfo.Repository">
<summary>
Gets Jenkins repository information.
</summary>
<value>
The repository.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.Jenkins.IsRunningOnJenkins)
{
Information(
@"Repository:
BranchName: {0}
GitCommitSha: {1}
GitBranch: {2}",
BuildSystem.Jenkins.Environment.Repository.BranchName,
BuildSystem.Jenkins.Environment.Repository.GitCommitSha,
BuildSystem.Jenkins.Environment.Repository.GitBranch
);
}
else
{
Information("Not running on Jenkins");
}
</code>
</example>
<para>Via Jenkins.</para>
<example>
<code>
if (Jenkins.IsRunningOnJenkins)
{
Information(
@"Repository:
BranchName: {0}
GitCommitSha: {1}
GitBranch: {2}",
Jenkins.Environment.Repository.BranchName,
Jenkins.Environment.Repository.GitCommitSha,
Jenkins.Environment.Repository.GitBranch
);
}
else
{
Information("Not running on Jenkins");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsEnvironmentInfo.Job">
<summary>
Gets Jenkins job information.
</summary>
<value>
The job.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.Jenkins.IsRunningOnJenkins)
{
Information(
@"Job:
JobName: {0}
JobBaseName: {1}
JobUrl: {2}",
BuildSystem.Jenkins.Environment.Job.JobName,
BuildSystem.Jenkins.Environment.Job.JobBaseName,
BuildSystem.Jenkins.Environment.Job.JobUrl
);
}
else
{
Information("Not running on Jenkins");
}
</code>
</example>
<para>Via Jenkins.</para>
<example>
<code>
if (Jenkins.IsRunningOnJenkins)
{
Information(
@"Job:
JobName: {0}
JobBaseName: {1}
JobUrl: {2}",
Jenkins.Environment.Job.JobName,
Jenkins.Environment.Job.JobBaseName,
Jenkins.Environment.Job.JobUrl
);
}
else
{
Information("Not running on Jenkins");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsEnvironmentInfo.Node">
<summary>
Gets the node.
</summary>
<value>
The node.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.Jenkins.IsRunningOnJenkins)
{
Information(
@"Node:
NodeName: {0}
NodeLabels: {1}",
BuildSystem.Jenkins.Environment.Node.NodeName,
BuildSystem.Jenkins.Environment.Node.NodeLabels
);
}
else
{
Information("Not running on Jenkins");
}
</code>
</example>
<para>Via Jenkins.</para>
<example>
<code>
if (Jenkins.IsRunningOnJenkins)
{
Information(
@"Node:
NodeName: {0}
NodeLabels: {1}",
Jenkins.Environment.Node.NodeName,
Jenkins.Environment.Node.NodeLabels
);
}
else
{
Information("Not running on Jenkins");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsEnvironmentInfo.Change">
<summary>
Gets the change.
</summary>
<value>
The change.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.Jenkins.IsRunningOnJenkins)
{
Information(
@"Change:
Id: {0}
Url: {1}
Title: {2}",
BuildSystem.Jenkins.Environment.Change.Id,
BuildSystem.Jenkins.Environment.Change.Url,
BuildSystem.Jenkins.Environment.Change.Title
);
}
else
{
Information("Not running on Jenkins");
}
</code>
</example>
<para>Via Jenkins.</para>
<example>
<code>
if (Jenkins.IsRunningOnJenkins)
{
Information(
@"Change:
Id: {0}
Url: {1}
Title: {2}",
Jenkins.Environment.Change.Id,
Jenkins.Environment.Change.Url,
Jenkins.Environment.Change.Title
);
}
else
{
Information("Not running on Jenkins");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsEnvironmentInfo.JenkinsHome">
<summary>
Gets the absolute path of the directory assigned on the master node for Jenkins to store data.
</summary>
<value>
The absolute path of the directory assigned on the master node for Jenkins to store data.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.Jenkins.IsRunningOnJenkins)
{
Information(
@"JenkinsHome: {0}",
BuildSystem.Jenkins.Environment.JenkinsHome
);
}
else
{
Information("Not running on Jenkins");
}
</code>
</example>
<para>Via Jenkins.</para>
<example>
<code>
if (Jenkins.IsRunningOnJenkins)
{
Information(
@"JenkinsHome: {0}",
Jenkins.Environment.JenkinsHome
);
}
else
{
Information("Not running on Jenkins");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsEnvironmentInfo.JenkinsUrl">
<summary>
Gets the full URL of Jenkins (note: only available if Jenkins URL is set in system configuration).
</summary>
<value>
The full URL of Jenkins.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.Jenkins.IsRunningOnJenkins)
{
Information(
@"JenkinsUrl: {0}",
BuildSystem.Jenkins.Environment.JenkinsUrl
);
}
else
{
Information("Not running on Jenkins");
}
</code>
</example>
<para>Via Jenkins.</para>
<example>
<code>
if (Jenkins.IsRunningOnJenkins)
{
Information(
@"JenkinsUrl: {0}",
Jenkins.Environment.JenkinsUrl
);
}
else
{
Information("Not running on Jenkins");
}
</code>
</example>
</member>
<member name="M:Cake.Common.Build.Jenkins.Data.JenkinsEnvironmentInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.Jenkins.Data.JenkinsEnvironmentInfo" /> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.Jenkins.Data.JenkinsJobInfo">
<summary>
Provides Jenkins job information for a current build.
</summary>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsJobInfo.JobName">
<summary>
Gets the name of the job.
</summary>
<value>
The name of the job.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsJobInfo.JobBaseName">
<summary>
Gets the short name of the project of this build stripping off folder paths, such as "foo" for "bar/foo".
</summary>
<value>
The base name of the job.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsJobInfo.JobUrl">
<summary>
Gets the URL of the job.
</summary>
<value>
The URL of the job.
</value>
</member>
<member name="M:Cake.Common.Build.Jenkins.Data.JenkinsJobInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.Jenkins.Data.JenkinsJobInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.Jenkins.Data.JenkinsNodeInfo">
<summary>
Provides Jenkins node information for a current build.
</summary>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsNodeInfo.NodeName">
<summary>
Gets the name of the node.
</summary>
<value>
The name of the node.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsNodeInfo.NodeLabels">
<summary>
Gets the node labels.
</summary>
<value>
The node labels.
</value>
</member>
<member name="M:Cake.Common.Build.Jenkins.Data.JenkinsNodeInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.Jenkins.Data.JenkinsNodeInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.Jenkins.Data.JenkinsRepositoryInfo">
<summary>
Provides Jenkins repository information for the current build.
</summary>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsRepositoryInfo.BranchName">
<summary>
Gets the branch name which will be build in a multibranch project.
</summary>
<value>
The branch name.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsRepositoryInfo.GitCommitSha">
<summary>
Gets the Git commit sha.
</summary>
<value>
The Git commit sha.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsRepositoryInfo.GitPreviousCommitSha">
<summary>
Gets the previous Git commit sha.
</summary>
<value>
The previous Git commit sha.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsRepositoryInfo.GitPreviousSuccessfullCommitSha">
<summary>
Gets the previous successfull Git commit sha.
</summary>
<value>
The previous successfull Git commit sha.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsRepositoryInfo.GitBranch">
<summary>
Gets the Git branch.
</summary>
<value>
The Git branch.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsRepositoryInfo.GitLocalBranch">
<summary>
Gets the Git local branch.
</summary>
<value>
The Git local branch.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsRepositoryInfo.GitCheckoutDirectory">
<summary>
Gets the Git checkout directory.
</summary>
<value>
The Git checkout directory.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsRepositoryInfo.GitUrl">
<summary>
Gets the Git remote URL.
</summary>
<value>
The Git remote URL.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsRepositoryInfo.SvnRevision">
<summary>
Gets the SVN revision.
</summary>
<value>
The SVN revision.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsRepositoryInfo.CvsBranch">
<summary>
Gets the CVS branch.
</summary>
<value>
The CVS branch.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsRepositoryInfo.SvnUrl">
<summary>
Gets the SVN URL.
</summary>
<value>
The SVN URL.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsRepositoryInfo.MercurialRevision">
<summary>
Gets the full id of the Mercurial revision.
</summary>
<value>
The full id of the Mercurial revision.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsRepositoryInfo.MercurialRevisionShort">
<summary>
Gets the abbreviated id of the Mercurial revision.
</summary>
<value>
The abbreviated id of the Mercurial revision.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsRepositoryInfo.MercurialRevisionNumber">
<summary>
Gets the Mercurial revision number.
</summary>
<value>
The Mercurial revision number.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsRepositoryInfo.MercurialRevisionBranch">
<summary>
Gets the Mercurial revision branch.
</summary>
<value>
The Mercurial revision branch.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.Data.JenkinsRepositoryInfo.MercurialRepositoryUrl">
<summary>
Gets the Mercurial repository URL.
</summary>
<value>
The Mercurial repository URL.
</value>
</member>
<member name="M:Cake.Common.Build.Jenkins.Data.JenkinsRepositoryInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.Jenkins.Data.JenkinsRepositoryInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.Jenkins.IJenkinsProvider">
<summary>
Represents a Jenkins Provider.
</summary>
</member>
<member name="P:Cake.Common.Build.Jenkins.IJenkinsProvider.IsRunningOnJenkins">
<summary>
Gets a value indicating whether this instance is running on jenkins.
</summary>
<value>
<c>true</c> if this instance is running on jenkins; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.Jenkins.IJenkinsProvider.Environment">
<summary>
Gets the Jenkins environment.
</summary>
<value>
The Jenkins environment.
</value>
</member>
<member name="T:Cake.Common.Build.Jenkins.JenkinsInfo">
<summary>
Base class used to provide information about the Jenkins environment.
</summary>
</member>
<member name="M:Cake.Common.Build.Jenkins.JenkinsInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.Jenkins.JenkinsInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="M:Cake.Common.Build.Jenkins.JenkinsInfo.GetEnvironmentString(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.String"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.Jenkins.JenkinsInfo.GetEnvironmentInteger(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Int32"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.Jenkins.JenkinsInfo.GetEnvironmentBoolean(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Boolean"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="T:Cake.Common.Build.Jenkins.JenkinsProvider">
<summary>
Responsible for communicating with Jenkins.
</summary>
</member>
<member name="M:Cake.Common.Build.Jenkins.JenkinsProvider.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.Jenkins.JenkinsProvider"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.Jenkins.JenkinsProvider.IsRunningOnJenkins">
<inheritdoc/>
</member>
<member name="P:Cake.Common.Build.Jenkins.JenkinsProvider.Environment">
<inheritdoc/>
</member>
<member name="T:Cake.Common.Build.MyGet.IMyGetProvider">
<summary>
Represents a MyGet provider.
</summary>
</member>
<member name="P:Cake.Common.Build.MyGet.IMyGetProvider.IsRunningOnMyGet">
<summary>
Gets a value indicating whether the current build is running on MyGet.
</summary>
<value>
<c>true</c> if the current build is running on MyGet; otherwise, <c>false</c>.
</value>
</member>
<member name="M:Cake.Common.Build.MyGet.IMyGetProvider.BuildProblem(System.String)">
<summary>
Report a build problem to MyGet.
</summary>
<param name="description">Description of build problem.</param>
</member>
<member name="M:Cake.Common.Build.MyGet.IMyGetProvider.SetParameter(System.String,System.String)">
<summary>
Allows setting an environment variable that can be used by a future process.
</summary>
<param name="name">Name of the parameter to set.</param>
<param name="value">Value to assign to the parameter.</param>
</member>
<member name="M:Cake.Common.Build.MyGet.IMyGetProvider.WriteStatus(System.String,Cake.Common.Build.MyGet.MyGetBuildStatus,System.String)">
<summary>
Write a status message to the MyGet build log.
</summary>
<param name="message">Message contents.</param>
<param name="status">Build status.</param>
<param name="errorDetails">Error details if status is error.</param>
</member>
<member name="M:Cake.Common.Build.MyGet.IMyGetProvider.SetBuildNumber(System.String)">
<summary>
Tells MyGet to change the current build number.
</summary>
<param name="buildNumber">The required build number.</param>
</member>
<member name="T:Cake.Common.Build.MyGet.MyGetBuildStatus">
<summary>
Provides the known values for MyGet Build Status.
</summary>
</member>
<member name="F:Cake.Common.Build.MyGet.MyGetBuildStatus.Failure">
<summary>
Failure Status
</summary>
</member>
<member name="F:Cake.Common.Build.MyGet.MyGetBuildStatus.Error">
<summary>
Error Status
</summary>
</member>
<member name="F:Cake.Common.Build.MyGet.MyGetBuildStatus.Warning">
<summary>
Warning Status
</summary>
</member>
<member name="F:Cake.Common.Build.MyGet.MyGetBuildStatus.Normal">
<summary>
Normal Status
</summary>
</member>
<member name="T:Cake.Common.Build.MyGet.MyGetProvider">
<summary>
Responsible for communicating with MyGet.
</summary>
</member>
<member name="M:Cake.Common.Build.MyGet.MyGetProvider.#ctor(Cake.Core.ICakeEnvironment,Cake.Common.Build.IBuildSystemServiceMessageWriter)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.MyGet.MyGetProvider"/> class.
</summary>
<param name="environment">The cake environment.</param>
<param name="writer">The build system service message writer.</param>
</member>
<member name="P:Cake.Common.Build.MyGet.MyGetProvider.IsRunningOnMyGet">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.MyGet.MyGetProvider.BuildProblem(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.MyGet.MyGetProvider.SetParameter(System.String,System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.MyGet.MyGetProvider.WriteStatus(System.String,Cake.Common.Build.MyGet.MyGetBuildStatus,System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.MyGet.MyGetProvider.SetBuildNumber(System.String)">
<inheritdoc/>
</member>
<member name="T:Cake.Common.Build.TeamCity.Data.TeamCityBuildInfo">
<summary>
Provides TeamCity build information for a current build.
</summary>
</member>
<member name="P:Cake.Common.Build.TeamCity.Data.TeamCityBuildInfo.BuildConfName">
<summary>
Gets the build configuration name.
</summary>
<value>
The build configuration name.
</value>
</member>
<member name="P:Cake.Common.Build.TeamCity.Data.TeamCityBuildInfo.Number">
<summary>
Gets the build number.
</summary>
<value>
The build number.
</value>
</member>
<member name="P:Cake.Common.Build.TeamCity.Data.TeamCityBuildInfo.StartDateTime">
<summary>
Gets the build start date and time.
</summary>
<value>
The build start date and time if available, or <see langword="null"/>.
</value>
<remarks>
The build start date and time are obtained from reading two environment variables
BUILD_START_DATE (yyyyMMdd) and BUILD_START_TIME (HHmmss) are automatically set by JetBrain's
<see href="https://confluence.jetbrains.com/display/TW/Groovy+plug">Groovy plug</see> plugin.
</remarks>
</member>
<member name="P:Cake.Common.Build.TeamCity.Data.TeamCityBuildInfo.BranchName">
<summary>
Gets the branch display name.
</summary>
<value>
The branch display name.
</value>
</member>
<member name="P:Cake.Common.Build.TeamCity.Data.TeamCityBuildInfo.VcsBranchName">
<summary>
Gets the vcs branch name.
</summary>
<value>
The vcs branch name.
</value>
</member>
<member name="P:Cake.Common.Build.TeamCity.Data.TeamCityBuildInfo.BuildProperties">
<summary>
Gets the TeamCity build properties.
</summary>
<value>
The TeamCity build properties as a key/value dictionary.
</value>
</member>
<member name="P:Cake.Common.Build.TeamCity.Data.TeamCityBuildInfo.ConfigProperties">
<summary>
Gets the TeamCity config properties.
</summary>
<value>
The TeamCity config properties as a key/value dictionary.
</value>
</member>
<member name="P:Cake.Common.Build.TeamCity.Data.TeamCityBuildInfo.RunnerProperties">
<summary>
Gets the TeamCity runner properties.
</summary>
<value>
The TeamCity runner properties as a key/value dictionary.
</value>
</member>
<member name="M:Cake.Common.Build.TeamCity.Data.TeamCityBuildInfo.#ctor(Cake.Core.ICakeEnvironment,Cake.Core.IO.IFileSystem)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.TeamCity.Data.TeamCityBuildInfo"/> class.
</summary>
<param name="environment">The environment.</param>
<param name="fileSystem">The file system.</param>
</member>
<member name="T:Cake.Common.Build.TeamCity.Data.TeamCityEnvironmentInfo">
<summary>
Provides TeamCity environment information for current build.
</summary>
</member>
<member name="P:Cake.Common.Build.TeamCity.Data.TeamCityEnvironmentInfo.Project">
<summary>
Gets TeamCity project information.
</summary>
<value>
The TeamCity project information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.TeamCity.IsRunningOnTeamCity)
{
Information(
@"Project:
Name: {0}",
BuildSystem.TeamCity.Environment.Project.Name
);
}
else
{
Information("Not running on TeamCity");
}
</code>
</example>
<para>Via TeamCity.</para>
<example>
<code>
if (TeamCity.IsRunningOnTeamCity)
{
Information(
@"Project:
Name: {0}",
TeamCity.Environment.Project.Name
);
}
else
{
Information("Not running on TeamCity");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.TeamCity.Data.TeamCityEnvironmentInfo.Build">
<summary>
Gets TeamCity build information.
</summary>
<value>
The TeamCity build information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.TeamCity.IsRunningOnTeamCity)
{
Information(
@"Build:
BuildConfName: {0}
Number: {1}",
BuildSystem.TeamCity.Environment.Build.BuildConfName,
BuildSystem.TeamCity.Environment.Build.Number
);
}
else
{
Information("Not running on TeamCity");
}
</code>
</example>
<para>Via TeamCity.</para>
<example>
<code>
if (TeamCity.IsRunningOnTeamCity)
{
Information(
@"Build:
BuildConfName: {0}
Number: {1}",
TeamCity.Environment.Build.BuildConfName,
TeamCity.Environment.Build.Number
);
}
else
{
Information("Not running on TeamCity");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.TeamCity.Data.TeamCityEnvironmentInfo.PullRequest">
<summary>
Gets TeamCity pull-request information.
</summary>
<value>
The TeamCity pull-request information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.TeamCity.IsRunningOnTeamCity)
{
Information(
@"PullRequest:
IsPullRequest: {0}
Number: {1}",
BuildSystem.TeamCity.Environment.PullRequest.IsPullRequest,
BuildSystem.TeamCity.Environment.PullRequest.Number
);
}
else
{
Information("Not running on TeamCity");
}
</code>
</example>
<para>Via TeamCity.</para>
<example>
<code>
if (TeamCity.IsRunningOnTeamCity)
{
Information(
@"PullRequest:
IsPullRequest: {0}
Number: {1}",
TeamCity.Environment.PullRequest.IsPullRequest,
TeamCity.Environment.PullRequest.Number
);
}
else
{
Information("Not running on TeamCity");
}
</code>
</example>
</member>
<member name="M:Cake.Common.Build.TeamCity.Data.TeamCityEnvironmentInfo.#ctor(Cake.Core.ICakeEnvironment,Cake.Core.IO.IFileSystem)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.TeamCity.Data.TeamCityEnvironmentInfo"/> class.
</summary>
<param name="environment">The environment.</param>
<param name="fileSystem">The file system.</param>
</member>
<member name="T:Cake.Common.Build.TeamCity.Data.TeamCityProjectInfo">
<summary>
Provides TeamCity project information for current build.
</summary>
</member>
<member name="P:Cake.Common.Build.TeamCity.Data.TeamCityProjectInfo.Name">
<summary>
Gets the TeamCity project name.
</summary>
<value>
The TeamCity project name.
</value>
</member>
<member name="M:Cake.Common.Build.TeamCity.Data.TeamCityProjectInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.TeamCity.Data.TeamCityProjectInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.TeamCity.Data.TeamCityPullRequestInfo">
<summary>
Provides TeamCity pull request information for current build.
</summary>
</member>
<member name="P:Cake.Common.Build.TeamCity.Data.TeamCityPullRequestInfo.IsPullRequest">
<summary>
Gets a value indicating whether the current build was started by a pull request.
</summary>
<value>
<c>true</c> if the current build was started by a pull request; otherwise, <c>false</c>.
</value>
<remarks>
<c>env.Git_Branch</c> is a required parameter in TeamCity for this to work.
</remarks>
</member>
<member name="P:Cake.Common.Build.TeamCity.Data.TeamCityPullRequestInfo.Number">
<summary>
Gets the pull request number.
</summary>
<value>
The pull request number.
</value>
<remarks>
<c>env.Git_Branch</c> is a required parameter in TeamCity for this to work.
</remarks>
</member>
<member name="M:Cake.Common.Build.TeamCity.Data.TeamCityPullRequestInfo.#ctor(Cake.Core.ICakeEnvironment,Cake.Common.Build.TeamCity.Data.TeamCityBuildInfo)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.TeamCity.Data.TeamCityPullRequestInfo"/> class.
</summary>
<param name="environment">The environment.</param>
<param name="buildInfo">The TeamCity build info.</param>
</member>
<member name="T:Cake.Common.Build.TeamCity.ITeamCityProvider">
<summary>
Represents a TeamCity provider.
</summary>
</member>
<member name="P:Cake.Common.Build.TeamCity.ITeamCityProvider.IsRunningOnTeamCity">
<summary>
Gets a value indicating whether the current build is running on TeamCity.
</summary>
<value>
<c>true</c> if the current build is running on TeamCity; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.TeamCity.ITeamCityProvider.Environment">
<summary>
Gets the TeamCity environment.
</summary>
<value>
The TeamCity environment.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.TeamCity.IsRunningOnTeamCity)
{
Information(
@"Environment:
PullRequest: {0}
Build Configuration Name: {1}
TeamCity Project Name: {2}",
BuildSystem.TeamCity.Environment.PullRequest.IsPullRequest,
BuildSystem.TeamCity.Environment.Build.BuildConfName,
BuildSystem.TeamCity.Environment.Project.Name
);
}
else
{
Information("Not running on TeamCity");
}
</code>
</example>
<para>Via TeamCity.</para>
<example>
<code>
if (TeamCity.IsRunningOnTeamCity)
{
Information(
@"Environment:
PullRequest: {0}
Build Configuration Name: {1}
TeamCity Project Name: {2}",
BuildSystem.TeamCity.Environment.PullRequest.IsPullRequest,
BuildSystem.TeamCity.Environment.Build.BuildConfName,
BuildSystem.TeamCity.Environment.Project.Name
);
}
else
{
Information("Not running on TeamCity");
}
</code>
</example>
</member>
<member name="M:Cake.Common.Build.TeamCity.ITeamCityProvider.BuildProblem(System.String,System.String)">
<summary>
Report a build problem to TeamCity.
</summary>
<param name="description">A human-readable plain text describing the build problem. By default, the description appears in the build status text and in the list of build's problems. The text is limited to 4000 symbols, and will be truncated if the limit is exceeded.</param>
<param name="identity">A unique problem ID (optional). Different problems must have different identity, same problems - same identity, which should not change throughout builds if the same problem, for example, the same compilation error occurs. It must be a valid Java ID up to 60 characters. If omitted, the identity is calculated based on the description text.</param>
</member>
<member name="M:Cake.Common.Build.TeamCity.ITeamCityProvider.ImportData(System.String,Cake.Core.IO.FilePath)">
<summary>
Tell TeamCity to import data of a given type.
</summary>
<param name="type">Date type.</param>
<param name="path">Data file path.</param>
</member>
<member name="M:Cake.Common.Build.TeamCity.ITeamCityProvider.ImportDotCoverCoverage(Cake.Core.IO.FilePath,Cake.Core.IO.DirectoryPath)">
<summary>
Tell TeamCity to import coverage from dotCover snapshot file.
</summary>
<param name="snapshotFile">Snapshot file path.</param>
<param name="dotCoverHome">The full path to the dotCover home folder to override the bundled dotCover.</param>
</member>
<member name="M:Cake.Common.Build.TeamCity.ITeamCityProvider.PublishArtifacts(System.String)">
<summary>
Tells TeamCity to publish artifacts in the given directory.
</summary>
<param name="path">Path to artifacts.</param>
</member>
<member name="M:Cake.Common.Build.TeamCity.ITeamCityProvider.SetBuildNumber(System.String)">
<summary>
Tells TeamCity to change the current build number.
</summary>
<param name="buildNumber">The required build number.</param>
</member>
<member name="M:Cake.Common.Build.TeamCity.ITeamCityProvider.SetParameter(System.String,System.String)">
<summary>
Tells TeamCity to set a named parameter with a given value.
</summary>
<param name="parameterName">The name of the parameter to set.</param>
<param name="parameterValue">The value to set for the named parameter.</param>
</member>
<member name="M:Cake.Common.Build.TeamCity.ITeamCityProvider.WriteEndBlock(System.String)">
<summary>
Write the end of a message block to the TeamCity build log.
</summary>
<param name="blockName">Block name.</param>
</member>
<member name="M:Cake.Common.Build.TeamCity.ITeamCityProvider.WriteEndBuildBlock(System.String)">
<summary>
Write the end of a build block to the TeamCity build log.
</summary>
<param name="compilerName">Build compiler name.</param>
</member>
<member name="M:Cake.Common.Build.TeamCity.ITeamCityProvider.WriteEndProgress(System.String)">
<summary>
Write a progressFinish message to the TeamCity build log.
</summary>
<param name="message">Build log message.</param>
</member>
<member name="M:Cake.Common.Build.TeamCity.ITeamCityProvider.WriteProgressMessage(System.String)">
<summary>
Write a progress message to the TeamCity build log.
</summary>
<param name="message">Build log message.</param>
</member>
<member name="M:Cake.Common.Build.TeamCity.ITeamCityProvider.WriteStartBlock(System.String)">
<summary>
Write the start of a message block to the TeamCity build log.
</summary>
<param name="blockName">Block name.</param>
</member>
<member name="M:Cake.Common.Build.TeamCity.ITeamCityProvider.WriteStartBuildBlock(System.String)">
<summary>
Write the start of a build block to the TeamCity build log.
</summary>
<param name="compilerName">Build compiler name.</param>
</member>
<member name="M:Cake.Common.Build.TeamCity.ITeamCityProvider.WriteStartProgress(System.String)">
<summary>
Write a progressStart message to the TeamCity build log.
</summary>
<param name="message">Build log message.</param>
</member>
<member name="M:Cake.Common.Build.TeamCity.ITeamCityProvider.WriteStatus(System.String,System.String,System.String)">
<summary>
Write a message to the TeamCity build log. - Messages not added to the build status.
</summary>
<param name="message">Message contents.</param>
<param name="status">Build status.</param>
<param name="errorDetails">Error details if status is error.</param>
</member>
<member name="M:Cake.Common.Build.TeamCity.ITeamCityProvider.WritePrependBuildStatus(System.String,System.String)">
<summary>
Write a status message to the TeamCity build log. - Prepend message to build status.
</summary>
<param name="message">Message contents.</param>
<param name="status">Build status.</param>
</member>
<member name="M:Cake.Common.Build.TeamCity.ITeamCityProvider.WriteAppendBuildStatus(System.String,System.String)">
<summary>
Write a status message to the TeamCity build log. - append message to build status.
</summary>
<param name="message">Message contents.</param>
<param name="status">Build status.</param>
</member>
<member name="M:Cake.Common.Build.TeamCity.ITeamCityProvider.WriteReplacementBuildStatus(System.String,System.String)">
<summary>
Write a status message to the TeamCity build log. - replace existing build status.
</summary>
<param name="message">Message contents.</param>
<param name="status">Build status.</param>
</member>
<member name="M:Cake.Common.Build.TeamCity.ITeamCityProvider.WriteStatistic(System.String,System.String)">
<summary>
Write a statistic message to the TeamCity build log.
</summary>
<param name="key">The statistic key.</param>
<param name="value">The statistic value.</param>
</member>
<member name="T:Cake.Common.Build.TeamCity.TeamCityDisposableExtensions">
<summary>
A set of extensions for allowing "using" with TeamCity "blocks".
</summary>
</member>
<member name="M:Cake.Common.Build.TeamCity.TeamCityDisposableExtensions.Block(Cake.Common.Build.TeamCity.ITeamCityProvider,System.String)">
<summary>
Writes the start of a TeamCity message block, then returns a disposable that writes the report block end on dispose.
</summary>
<param name="teamCityProvider">TeamCity provider.</param>
<param name="blockName">The name of the report block.</param>
<returns>A disposable that writes the report block end.</returns>
</member>
<member name="M:Cake.Common.Build.TeamCity.TeamCityDisposableExtensions.BuildBlock(Cake.Common.Build.TeamCity.ITeamCityProvider,System.String)">
<summary>
Writes the start of a TeamCity build block, then returns a disposable that writes the build block end on dispose.
</summary>
<param name="teamCityProvider">TeamCity provider.</param>
<param name="compilerName">The name of the build block.</param>
<returns>A disposable that writes the build block end.</returns>
</member>
<member name="T:Cake.Common.Build.TeamCity.TeamCityInfo">
<summary>
Base class used to provide information about the TeamCity environment.
</summary>
</member>
<member name="M:Cake.Common.Build.TeamCity.TeamCityInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.TeamCity.TeamCityInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="M:Cake.Common.Build.TeamCity.TeamCityInfo.GetEnvironmentString(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.String"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.TeamCity.TeamCityInfo.GetEnvironmentInteger(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Int32"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.TeamCity.TeamCityInfo.GetEnvironmentBoolean(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Boolean"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="T:Cake.Common.Build.TeamCity.TeamCityProvider">
<summary>
Responsible for communicating with TeamCity.
</summary>
</member>
<member name="P:Cake.Common.Build.TeamCity.TeamCityProvider.IsRunningOnTeamCity">
<inheritdoc/>
</member>
<member name="P:Cake.Common.Build.TeamCity.TeamCityProvider.Environment">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TeamCity.TeamCityProvider.#ctor(Cake.Core.ICakeEnvironment,Cake.Core.IO.IFileSystem,Cake.Common.Build.IBuildSystemServiceMessageWriter)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.TeamCity.TeamCityProvider"/> class.
</summary>
<param name="environment">The cake environment.</param>
<param name="fileSystem">The cake file system.</param>
<param name="writer">The build system service message writer.</param>
</member>
<member name="M:Cake.Common.Build.TeamCity.TeamCityProvider.WriteProgressMessage(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TeamCity.TeamCityProvider.WriteStartProgress(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TeamCity.TeamCityProvider.WriteEndProgress(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TeamCity.TeamCityProvider.WriteStartBlock(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TeamCity.TeamCityProvider.WriteEndBlock(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TeamCity.TeamCityProvider.WriteStartBuildBlock(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TeamCity.TeamCityProvider.WriteEndBuildBlock(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TeamCity.TeamCityProvider.WriteStatus(System.String,System.String,System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TeamCity.TeamCityProvider.WriteAppendBuildStatus(System.String,System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TeamCity.TeamCityProvider.WritePrependBuildStatus(System.String,System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TeamCity.TeamCityProvider.WriteReplacementBuildStatus(System.String,System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TeamCity.TeamCityProvider.ImportData(System.String,Cake.Core.IO.FilePath)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TeamCity.TeamCityProvider.ImportDotCoverCoverage(Cake.Core.IO.FilePath,Cake.Core.IO.DirectoryPath)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TeamCity.TeamCityProvider.BuildProblem(System.String,System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TeamCity.TeamCityProvider.PublishArtifacts(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TeamCity.TeamCityProvider.SetBuildNumber(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TeamCity.TeamCityProvider.SetParameter(System.String,System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TeamCity.TeamCityProvider.WriteStatistic(System.String,System.String)">
<inheritdoc/>
</member>
<member name="T:Cake.Common.Build.TeamCity.NamespaceDoc">
<summary>
This namespace contain types used
to interact with TeamCity.
</summary>
</member>
<member name="T:Cake.Common.Build.TravisCI.Data.TravisCIBuildInfo">
<summary>
Provides Travis CI build information for the current build.
</summary>
</member>
<member name="P:Cake.Common.Build.TravisCI.Data.TravisCIBuildInfo.Branch">
<summary>
Gets the branch for the current build.
</summary>
<value>
The branch.
</value>
</member>
<member name="P:Cake.Common.Build.TravisCI.Data.TravisCIBuildInfo.BuildDirectory">
<summary>
Gets the build directory for the current build.
</summary>
<value>
The build directory.
</value>
</member>
<member name="P:Cake.Common.Build.TravisCI.Data.TravisCIBuildInfo.BuildId">
<summary>
Gets the build identifier for the current build.
</summary>
<value>
The build identifier.
</value>
</member>
<member name="P:Cake.Common.Build.TravisCI.Data.TravisCIBuildInfo.BuildNumber">
<summary>
Gets the build number for the current build.
</summary>
<value>
The build number.
</value>
</member>
<member name="P:Cake.Common.Build.TravisCI.Data.TravisCIBuildInfo.TestResult">
<summary>
Gets the test result indicating if the current build is successful or broken.
</summary>
<value>
The test result.
</value>
</member>
<member name="P:Cake.Common.Build.TravisCI.Data.TravisCIBuildInfo.Tag">
<summary>
Gets the tag name for the current build.
</summary>
<value>
The tag.
</value>
</member>
<member name="M:Cake.Common.Build.TravisCI.Data.TravisCIBuildInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.TravisCI.Data.TravisCIBuildInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.TravisCI.Data.TravisCIEnvironmentInfo">
<summary>
Provides Travis CI environment information for the current build.
</summary>
</member>
<member name="P:Cake.Common.Build.TravisCI.Data.TravisCIEnvironmentInfo.Build">
<summary>
Gets Travis CI build information for the current build.
</summary>
<value>
The build.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.TravisCI.IsRunningOnTravisCI)
{
Information(
@"Build:
Branch: {0}
BuildDirectory: {1}
BuildId: {2}",
BuildSystem.TravisCI.Environment.Build.Branch,
BuildSystem.TravisCI.Environment.Build.BuildDirectory,
BuildSystem.TravisCI.Environment.Build.BuildId
);
}
else
{
Information("Not running on TravisCI");
}
</code>
</example>
<para>Via TravisCI.</para>
<example>
<code>
if (TravisCI.IsRunningOnTravisCI)
{
Information(
@"Build:
Branch: {0}
BuildDirectory: {1}
BuildId: {2}",
TravisCI.Environment.Build.Branch,
TravisCI.Environment.Build.BuildDirectory,
TravisCI.Environment.Build.BuildId
);
}
else
{
Information("Not running on TravisCI");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.TravisCI.Data.TravisCIEnvironmentInfo.PullRequest">
<summary>
Gets Travis CI pull request information.
</summary>
<value>
The Travis CI pull request information.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.TravisCI.IsRunningOnTravisCI)
{
Information(
@"PullRequest:
IsPullRequest: {0}
Id: {1}",
BuildSystem.TravisCI.Environment.PullRequest.IsPullRequest,
BuildSystem.TravisCI.Environment.PullRequest.Id
);
}
else
{
Information("Not running on TravisCI");
}
</code>
</example>
<para>Via TravisCI.</para>
<example>
<code>
if (TravisCI.IsRunningOnTravisCI)
{
Information(
@"PullRequest:
IsPullRequest: {0}
Id: {1}",
TravisCI.Environment.PullRequest.IsPullRequest,
TravisCI.Environment.PullRequest.Id
);
}
else
{
Information("Not running on TravisCI");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.TravisCI.Data.TravisCIEnvironmentInfo.Job">
<summary>
Gets Travis CI job information for the current build.
</summary>
<value>
The job.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.TravisCI.IsRunningOnTravisCI)
{
Information(
@"Job:
JobId: {0}
JobNumber: {1}
OSName: {2}",
BuildSystem.TravisCI.Environment.Job.JobId,
BuildSystem.TravisCI.Environment.Job.JobNumber,
BuildSystem.TravisCI.Environment.Job.OSName
);
}
else
{
Information("Not running on TravisCI");
}
</code>
</example>
<para>Via TravisCI.</para>
<example>
<code>
if (TravisCI.IsRunningOnTravisCI)
{
Information(
@"Job:
JobId: {0}
JobNumber: {1}
OSName: {2}",
TravisCI.Environment.Job.JobId,
TravisCI.Environment.Job.JobNumber,
TravisCI.Environment.Job.OSName
);
}
else
{
Information("Not running on TravisCI");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.TravisCI.Data.TravisCIEnvironmentInfo.Repository">
<summary>
Gets Travis CI repository information for the current build.
</summary>
<value>
The repository.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.TravisCI.IsRunningOnTravisCI)
{
Information(
@"Repository:
Commit: {0}
CommitRange: {1}
PullRequest: {2}",
BuildSystem.TravisCI.Environment.Repository.Commit,
BuildSystem.TravisCI.Environment.Repository.CommitRange,
BuildSystem.TravisCI.Environment.Repository.PullRequest
);
}
else
{
Information("Not running on TravisCI");
}
</code>
</example>
<para>Via TravisCI.</para>
<example>
<code>
if (TravisCI.IsRunningOnTravisCI)
{
Information(
@"Repository:
Commit: {0}
CommitRange: {1}
PullRequest: {2}",
TravisCI.Environment.Repository.Commit,
TravisCI.Environment.Repository.CommitRange,
TravisCI.Environment.Repository.PullRequest
);
}
else
{
Information("Not running on TravisCI");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.TravisCI.Data.TravisCIEnvironmentInfo.CI">
<summary>
Gets a value indicating whether the current build is continuous integration.
</summary>
<value>
<c>true</c> if ci; otherwise, <c>false</c>.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.TravisCI.IsRunningOnTravisCI)
{
Information(
@"CI: {0}",
BuildSystem.TravisCI.Environment.CI
);
}
else
{
Information("Not running on TravisCI");
}
</code>
</example>
<para>Via TravisCI.</para>
<example>
<code>
if (TravisCI.IsRunningOnTravisCI)
{
Information(
@"CI: {0}",
TravisCI.Environment.CI
);
}
else
{
Information("Not running on TravisCI");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.TravisCI.Data.TravisCIEnvironmentInfo.Home">
<summary>
Gets the Travis CI home directory.
</summary>
<value>
The home.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.TravisCI.IsRunningOnTravisCI)
{
Information(
@"Home: {0}",
BuildSystem.TravisCI.Environment.Home
);
}
else
{
Information("Not running on TravisCI");
}
</code>
</example>
<para>Via TravisCI.</para>
<example>
<code>
if (TravisCI.IsRunningOnTravisCI)
{
Information(
@"Home: {0}",
TravisCI.Environment.Home
);
}
else
{
Information("Not running on TravisCI");
}
</code>
</example>
</member>
<member name="P:Cake.Common.Build.TravisCI.Data.TravisCIEnvironmentInfo.Travis">
<summary>
Gets a value indicating whether the environment is Travis.
</summary>
<value>
<c>true</c> if Travis; otherwise, <c>false</c>.
</value>
<para>Via BuildSystem.</para>
<example>
<code>
if (BuildSystem.TravisCI.IsRunningOnTravisCI)
{
Information(
@"Travis: {0}",
BuildSystem.TravisCI.Environment.Travis
);
}
else
{
Information("Not running on TravisCI");
}
</code>
</example>
<para>Via TravisCI.</para>
<example>
<code>
if (TravisCI.IsRunningOnTravisCI)
{
Information(
@"Travis: {0}",
TravisCI.Environment.Travis
);
}
else
{
Information("Not running on TravisCI");
}
</code>
</example>
</member>
<member name="M:Cake.Common.Build.TravisCI.Data.TravisCIEnvironmentInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.TravisCI.Data.TravisCIEnvironmentInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.TravisCI.Data.TravisCIJobInfo">
<summary>
Provides Travis CI job information for the current build.
</summary>
</member>
<member name="P:Cake.Common.Build.TravisCI.Data.TravisCIJobInfo.JobId">
<summary>
Gets the job identifier for the current job.
</summary>
<value>
The job identifier.
</value>
</member>
<member name="P:Cake.Common.Build.TravisCI.Data.TravisCIJobInfo.JobNumber">
<summary>
Gets the job number for the current job.
</summary>
<value>
The job number.
</value>
</member>
<member name="P:Cake.Common.Build.TravisCI.Data.TravisCIJobInfo.OSName">
<summary>
Gets the name of the operating system for the current job.
</summary>
<value>
The name of the os.
</value>
</member>
<member name="P:Cake.Common.Build.TravisCI.Data.TravisCIJobInfo.SecureEnvironmentVariables">
<summary>
Gets a value indicating whether encrypted environment variables are being used for the current job.
</summary>
<value>
<c>true</c> if [secure environment variables are in use]; otherwise, <c>false</c>.
</value>
</member>
<member name="M:Cake.Common.Build.TravisCI.Data.TravisCIJobInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.TravisCI.Data.TravisCIJobInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.TravisCI.Data.TravisCIPullRequestInfo">
<summary>
Provides TravisCI pull request information for a current build.
</summary>
</member>
<member name="M:Cake.Common.Build.TravisCI.Data.TravisCIPullRequestInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.TravisCI.Data.TravisCIPullRequestInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="P:Cake.Common.Build.TravisCI.Data.TravisCIPullRequestInfo.IsPullRequest">
<summary>
Gets a value indicating whether the current build was started by a pull request.
</summary>
<value>
<c>true</c> if the current build was started by a pull request; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.TravisCI.Data.TravisCIPullRequestInfo.Id">
<summary>
Gets the pull request id.
</summary>
<value>
The pull request id.
</value>
</member>
<member name="T:Cake.Common.Build.TravisCI.Data.TravisCIRepositoryInfo">
<summary>
Provides Travis CI repository information for the current build.
</summary>
</member>
<member name="P:Cake.Common.Build.TravisCI.Data.TravisCIRepositoryInfo.Commit">
<summary>
Gets the commit that the current build is testing.
</summary>
<value>
The commit.
</value>
</member>
<member name="P:Cake.Common.Build.TravisCI.Data.TravisCIRepositoryInfo.CommitRange">
<summary>
Gets the commit range for the current pull request.
</summary>
<value>
The commit range.
</value>
</member>
<member name="P:Cake.Common.Build.TravisCI.Data.TravisCIRepositoryInfo.PullRequest">
<summary>
Gets the pull request.
</summary>
<value>
The pull request.
</value>
</member>
<member name="P:Cake.Common.Build.TravisCI.Data.TravisCIRepositoryInfo.Slug">
<summary>
Gets the slug of the repository currently being built.
</summary>
<value>
The slug.
</value>
</member>
<member name="M:Cake.Common.Build.TravisCI.Data.TravisCIRepositoryInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.TravisCI.Data.TravisCIRepositoryInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="T:Cake.Common.Build.TravisCI.ITravisCIProvider">
<summary>
Represents a Travis CI Provider.
</summary>
</member>
<member name="P:Cake.Common.Build.TravisCI.ITravisCIProvider.IsRunningOnTravisCI">
<summary>
Gets a value indicating whether this instance is running on Travis CI.
</summary>
<value>
<c>true</c> if this instance is running on Travis CI; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Build.TravisCI.ITravisCIProvider.Environment">
<summary>
Gets the environment.
</summary>
<value>
The environment.
</value>
</member>
<member name="M:Cake.Common.Build.TravisCI.ITravisCIProvider.WriteStartFold(System.String)">
<summary>
Write the start of a message fold to the Travis CI build log.
</summary>
<param name="name">Name of the group.</param>
</member>
<member name="M:Cake.Common.Build.TravisCI.ITravisCIProvider.WriteEndFold(System.String)">
<summary>
Write the start of a message fold to the Travis CI build log.
</summary>
<param name="name">Name of the group.</param>
</member>
<member name="T:Cake.Common.Build.TravisCI.TravisCIDisposableExtensions">
<summary>
A set of extensions for allowing "using" with Travis CI "blocks".
</summary>
</member>
<member name="M:Cake.Common.Build.TravisCI.TravisCIDisposableExtensions.Fold(Cake.Common.Build.TravisCI.ITravisCIProvider,System.String)">
<summary>
Folds travis log output.
</summary>
<param name="travisCIProvider">The Travis CI provider.</param>
<param name="name">The name.</param>
<returns>An <see cref="T:System.IDisposable"/>.</returns>
</member>
<member name="T:Cake.Common.Build.TravisCI.TravisCIDisposableExtensions.TravisCIActionDisposable">
<summary>
Disposable helper for writing Travis CI message blocks.
</summary>
</member>
<member name="M:Cake.Common.Build.TravisCI.TravisCIDisposableExtensions.TravisCIActionDisposable.#ctor(Cake.Common.Build.TravisCI.ITravisCIProvider,System.Action{Cake.Common.Build.TravisCI.ITravisCIProvider})">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.TravisCI.TravisCIDisposableExtensions.TravisCIActionDisposable"/> class.
</summary>
<param name="travisCiProvider">The Travis CI provider.</param>
<param name="disposeAction">The dispose action.</param>
</member>
<member name="M:Cake.Common.Build.TravisCI.TravisCIDisposableExtensions.TravisCIActionDisposable.Dispose">
<summary>
Writes the end block for this message block.
</summary>
</member>
<member name="T:Cake.Common.Build.TravisCI.TravisCIInfo">
<summary>
Base class used to provide information about the Travis CI environment.
</summary>
</member>
<member name="M:Cake.Common.Build.TravisCI.TravisCIInfo.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.TravisCI.TravisCIInfo"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="M:Cake.Common.Build.TravisCI.TravisCIInfo.GetEnvironmentString(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.String"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.TravisCI.TravisCIInfo.GetEnvironmentInteger(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Int32"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="M:Cake.Common.Build.TravisCI.TravisCIInfo.GetEnvironmentBoolean(System.String)">
<summary>
Gets an environment variable as a <see cref="T:System.Boolean"/>.
</summary>
<param name="variable">The environment variable name.</param>
<returns>The environment variable.</returns>
</member>
<member name="T:Cake.Common.Build.TravisCI.TravisCIProvider">
<summary>
Responsible for communicating with Travis CI.
</summary>
</member>
<member name="M:Cake.Common.Build.TravisCI.TravisCIProvider.#ctor(Cake.Core.ICakeEnvironment,Cake.Common.Build.IBuildSystemServiceMessageWriter)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Build.TravisCI.TravisCIProvider"/> class.
</summary>
<param name="environment">The environment.</param>
<param name="writer">The log.</param>
</member>
<member name="P:Cake.Common.Build.TravisCI.TravisCIProvider.IsRunningOnTravisCI">
<inheritdoc/>
</member>
<member name="P:Cake.Common.Build.TravisCI.TravisCIProvider.Environment">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TravisCI.TravisCIProvider.WriteStartFold(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Build.TravisCI.TravisCIProvider.WriteEndFold(System.String)">
<inheritdoc/>
</member>
<member name="T:Cake.Common.Build.NamespaceDoc">
<summary>
This namespace contain types that
support different build system related tasks.
</summary>
</member>
<member name="T:Cake.Common.Diagnostics.LoggingAliases">
<summary>
Contains functionality related to logging.
</summary>
</member>
<member name="M:Cake.Common.Diagnostics.LoggingAliases.Error(Cake.Core.ICakeContext,System.String,System.Object[])">
<summary>
Writes an error message to the log using the specified format information.
</summary>
<param name="context">The context.</param>
<param name="format">The format.</param>
<param name="args">The arguments.</param>
<example>
<code>
Error("Hello {0}! Today is an {1:dddd}", "World", DateTime.Now);
</code>
</example>
</member>
<member name="M:Cake.Common.Diagnostics.LoggingAliases.Error(Cake.Core.ICakeContext,Cake.Core.Diagnostics.LogAction)">
<summary>
Writes an error message to the log using the specified log message action.
Evaluation message only if verbosity same or more verbose.
</summary>
<param name="context">the context.</param>
<param name="logAction">The function called for message when logging.</param>
<example>
<code>
Error(logAction=>logAction("Hello {0}! Today is an {1:dddd}", "World", DateTime.Now));
</code>
</example>
</member>
<member name="M:Cake.Common.Diagnostics.LoggingAliases.Error(Cake.Core.ICakeContext,System.Object)">
<summary>
Writes an error message to the log using the specified value.
</summary>
<param name="context">the context.</param>
<param name="value">The value.</param>
<example>
<code>
Error(new {FirstName = "John", LastName="Doe"});
</code>
</example>
</member>
<member name="M:Cake.Common.Diagnostics.LoggingAliases.Error(Cake.Core.ICakeContext,System.String)">
<summary>
Writes an error message to the log using the specified string value.
</summary>
<param name="context">the context.</param>
<param name="value">The value.</param>
<example>
<code>
Error("{string}");
</code>
</example>
</member>
<member name="M:Cake.Common.Diagnostics.LoggingAliases.Warning(Cake.Core.ICakeContext,System.String,System.Object[])">
<summary>
Writes a warning message to the log using the specified format information.
</summary>
<param name="context">The context.</param>
<param name="format">The format.</param>
<param name="args">The arguments.</param>
<example>
<code>
Warning("Hello {0}! Today is an {1:dddd}", "World", DateTime.Now);
</code>
</example>
</member>
<member name="M:Cake.Common.Diagnostics.LoggingAliases.Warning(Cake.Core.ICakeContext,Cake.Core.Diagnostics.LogAction)">
<summary>
Writes a warning message to the log using the specified log message action.
Evaluation message only if verbosity same or more verbose.
</summary>
<param name="context">the context.</param>
<param name="logAction">The function called for message when logging.</param>
<example>
<code>
Warning(logAction=>logAction("Hello {0}! Today is an {1:dddd}", "World", DateTime.Now));
</code>
</example>
</member>
<member name="M:Cake.Common.Diagnostics.LoggingAliases.Warning(Cake.Core.ICakeContext,System.Object)">
<summary>
Writes an warning message to the log using the specified value.
</summary>
<param name="context">the context.</param>
<param name="value">The value.</param>
<example>
<code>
Warning(new {FirstName = "John", LastName="Doe"});
</code>
</example>
</member>
<member name="M:Cake.Common.Diagnostics.LoggingAliases.Warning(Cake.Core.ICakeContext,System.String)">
<summary>
Writes an warning message to the log using the specified string value.
</summary>
<param name="context">the context.</param>
<param name="value">The value.</param>
<example>
<code>
Warning("{string}");
</code>
</example>
</member>
<member name="M:Cake.Common.Diagnostics.LoggingAliases.Information(Cake.Core.ICakeContext,System.String,System.Object[])">
<summary>
Writes an informational message to the log using the specified format information.
</summary>
<param name="context">The context.</param>
<param name="format">The format.</param>
<param name="args">The arguments.</param>
<example>
<code>
Information("Hello {0}! Today is an {1:dddd}", "World", DateTime.Now);
</code>
</example>
</member>
<member name="M:Cake.Common.Diagnostics.LoggingAliases.Information(Cake.Core.ICakeContext,Cake.Core.Diagnostics.LogAction)">
<summary>
Writes an informational message to the log using the specified log message action.
Evaluation message only if verbosity same or more verbose.
</summary>
<param name="context">the context.</param>
<param name="logAction">The function called for message when logging.</param>
<example>
<code>
Information(logAction=>logAction("Hello {0}! Today is an {1:dddd}", "World", DateTime.Now));
</code>
</example>
</member>
<member name="M:Cake.Common.Diagnostics.LoggingAliases.Information(Cake.Core.ICakeContext,System.Object)">
<summary>
Writes an informational message to the log using the specified value.
</summary>
<param name="context">The context.</param>
<param name="value">The value.</param>
<example>
<code>
Information(new {FirstName = "John", LastName="Doe"});
</code>
</example>
</member>
<member name="M:Cake.Common.Diagnostics.LoggingAliases.Information(Cake.Core.ICakeContext,System.String)">
<summary>
Writes an informational message to the log using the specified string value.
</summary>
<param name="context">The context.</param>
<param name="value">The value.</param>
<example>
<code>
Information("{string}");
</code>
</example>
</member>
<member name="M:Cake.Common.Diagnostics.LoggingAliases.Verbose(Cake.Core.ICakeContext,System.String,System.Object[])">
<summary>
Writes a verbose message to the log using the specified format information.
</summary>
<param name="context">The context.</param>
<param name="format">The format.</param>
<param name="args">The arguments.</param>
<example>
<code>
Verbose("Hello {0}! Today is an {1:dddd}", "World", DateTime.Now);
</code>
</example>
</member>
<member name="M:Cake.Common.Diagnostics.LoggingAliases.Verbose(Cake.Core.ICakeContext,Cake.Core.Diagnostics.LogAction)">
<summary>
Writes a verbose message to the log using the specified log message action.
Evaluation message only if verbosity same or more verbose.
</summary>
<param name="context">the context.</param>
<param name="logAction">The function called for message when logging.</param>
<example>
<code>
Verbose(logAction=>logAction("Hello {0}! Today is an {1:dddd}", "World", DateTime.Now));
</code>
</example>
</member>
<member name="M:Cake.Common.Diagnostics.LoggingAliases.Verbose(Cake.Core.ICakeContext,System.Object)">
<summary>
Writes a verbose message to the log using the specified value.
</summary>
<param name="context">The context.</param>
<param name="value">The value.</param>
<example>
<code>
Verbose(new {FirstName = "John", LastName="Doe"});
</code>
</example>
</member>
<member name="M:Cake.Common.Diagnostics.LoggingAliases.Verbose(Cake.Core.ICakeContext,System.String)">
<summary>
Writes a verbose message to the log using the specified string value.
</summary>
<param name="context">The context.</param>
<param name="value">The value.</param>
<example>
<code>
Verbose("{string}");
</code>
</example>
</member>
<member name="M:Cake.Common.Diagnostics.LoggingAliases.Debug(Cake.Core.ICakeContext,System.String,System.Object[])">
<summary>
Writes a debug message to the log using the specified format information.
</summary>
<param name="context">The context.</param>
<param name="format">The format.</param>
<param name="args">The arguments.</param>
<example>
<code>
Debug("Hello {0}! Today is an {1:dddd}", "World", DateTime.Now);
</code>
</example>
</member>
<member name="M:Cake.Common.Diagnostics.LoggingAliases.Debug(Cake.Core.ICakeContext,Cake.Core.Diagnostics.LogAction)">
<summary>
Writes a debug message to the log using the specified log message action.
Evaluation message only if verbosity same or more verbose.
</summary>
<param name="context">the context.</param>
<param name="logAction">The function called for message when logging.</param>
<example>
<code>
Debug(logAction=>logAction("Hello {0}! Today is an {1:dddd}", "World", DateTime.Now));
</code>
</example>
</member>
<member name="M:Cake.Common.Diagnostics.LoggingAliases.Debug(Cake.Core.ICakeContext,System.Object)">
<summary>
Writes a debug message to the log using the specified value.
</summary>
<param name="context">the context.</param>
<param name="value">The value.</param>
<example>
<code>
Debug(new {FirstName = "John", LastName="Doe"});
</code>
</example>
</member>
<member name="M:Cake.Common.Diagnostics.LoggingAliases.Debug(Cake.Core.ICakeContext,System.String)">
<summary>
Writes a debug message to the log using the specified string value.
</summary>
<param name="context">the context.</param>
<param name="value">The value.</param>
<example>
<code>
Debug("{string}");
</code>
</example>
</member>
<member name="M:Cake.Common.Diagnostics.LoggingAliases.QuietVerbosity(Cake.Core.ICakeContext)">
<summary>
Sets the log verbosity to quiet and returns a disposable that restores the log verbosity on dispose.
</summary>
<param name="context">the context.</param>
<returns>A disposable that restores the log verbosity.</returns>
<example>
<code>
using (QuietVerbosity())
{
Error("Show me.");
Warning("Hide me.");
Information("Hide me.");
Verbose("Hide me.");
Debug("Hide me.");
}
</code>
</example>
</member>
<member name="M:Cake.Common.Diagnostics.LoggingAliases.MinimalVerbosity(Cake.Core.ICakeContext)">
<summary>
Sets the log verbosity to minimal and returns a disposable that restores the log verbosity on dispose.
</summary>
<param name="context">the context.</param>
<returns>A disposable that restores the log verbosity.</returns>
<example>
<code>
using (MinimalVerbosity())
{
Error("Show me.");
Warning("Show me.");
Information("Hide me.");
Verbose("Hide me.");
Debug("Hide me.");
}
</code>
</example>
</member>
<member name="M:Cake.Common.Diagnostics.LoggingAliases.NormalVerbosity(Cake.Core.ICakeContext)">
<summary>
Sets the log verbosity to normal and returns a disposable that restores the log verbosity on dispose.
</summary>
<param name="context">the context.</param>
<returns>A disposable that restores the log verbosity.</returns>
<example>
<code>
using (NormalVerbosity())
{
Error("Show me.");
Warning("Show me.");
Information("Show me.");
Verbose("Hide me.");
Debug("Hide me.");
}
</code>
</example>
</member>
<member name="M:Cake.Common.Diagnostics.LoggingAliases.VerboseVerbosity(Cake.Core.ICakeContext)">
<summary>
Sets the log verbosity to verbose and returns a disposable that restores the log verbosity on dispose.
</summary>
<param name="context">the context.</param>
<returns>A disposable that restores the log verbosity.</returns>
<example>
<code>
using (VerboseVerbosity())
{
Error("Show me.");
Warning("Show me.");
Information("Show me.");
Verbose("Show me.");
Debug("Hide me.");
}
</code>
</example>
</member>
<member name="M:Cake.Common.Diagnostics.LoggingAliases.DiagnosticVerbosity(Cake.Core.ICakeContext)">
<summary>
Sets the log verbosity to diagnostic and returns a disposable that restores the log verbosity on dispose.
</summary>
<param name="context">the context.</param>
<returns>A disposable that restores the log verbosity.</returns>
<example>
<code>
using (DiagnosticVerbosity())
{
Error("Show me.");
Warning("Show me.");
Information("Show me.");
Verbose("Show me.");
Debug("Show me.");
}
</code>
</example>
</member>
<member name="T:Cake.Common.Diagnostics.ScriptCallerAliases">
<summary>
Contains functionality related to diagnostics.
</summary>
</member>
<member name="M:Cake.Common.Diagnostics.ScriptCallerAliases.GetCallerInfo(Cake.Core.ICakeContext,System.String,System.String,System.Int32)">
<summary>
Performs script caller information.
</summary>
<param name="context">The context.</param>
<param name="memberName">The member name.</param>
<param name="sourceFilePath">The source file path.</param>
<param name="sourceLineNumber">The source line number.</param>
<returns>A <see cref="M:Cake.Common.Diagnostics.ScriptCallerAliases.GetCallerInfo(Cake.Core.ICakeContext,System.String,System.String,System.Int32)"/> instance representing the caller information.</returns>
</member>
<member name="T:Cake.Common.Diagnostics.ScriptCallerInfo">
<summary>
Represents a caller information.
</summary>
</member>
<member name="M:Cake.Common.Diagnostics.ScriptCallerInfo.#ctor(System.String,Cake.Core.IO.FilePath,System.Int32)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Diagnostics.ScriptCallerInfo"/> class.
</summary>
<param name="memberName">The member name.</param>
<param name="sourceFilePath">The source file path.</param>
<param name="sourceLineNumber">The source line number.</param>
</member>
<member name="P:Cake.Common.Diagnostics.ScriptCallerInfo.MemberName">
<summary>
Gets the method or property name of the caller to the method.
</summary>
</member>
<member name="P:Cake.Common.Diagnostics.ScriptCallerInfo.SourceFilePath">
<summary>
Gets the full path of the source file that contains the caller.
</summary>
</member>
<member name="P:Cake.Common.Diagnostics.ScriptCallerInfo.SourceLineNumber">
<summary>
Gets the line number in the source file at which the method is called.
</summary>
</member>
<member name="M:Cake.Common.Diagnostics.ScriptCallerInfo.ToString">
<summary>
Returns a <see cref="T:System.String" /> containing the full path of the source file and the line number in the source file at which the method is called.
</summary>
<returns>
A <see cref="T:System.String" /> containing the full path of the source file and the line number in the source file at which the method is called.
</returns>
</member>
<member name="T:Cake.Common.Diagnostics.NamespaceDoc">
<summary>
This namespace contain types that
enable you to interact with build logs.
</summary>
</member>
<member name="T:Cake.Common.DryRunAliases">
<summary>
Contains functionality related to arguments.
</summary>
</member>
<member name="M:Cake.Common.DryRunAliases.IsDryRun(Cake.Core.ICakeContext)">
<summary>
Determines whether or not the current script execution is a dry run.
</summary>
<param name="context">The context.</param>
<returns>Whether or not the current script execution is a dry run.</returns>
<example>
<code>
Setup(context =>
{
if (!context.IsDryRun())
{
// Do things that you don't want to
// do during a dry run.
}
});
</code>
</example>
</member>
<member name="T:Cake.Common.EnvironmentAliases">
<summary>
Contains functionality related to the environment.
</summary>
</member>
<member name="M:Cake.Common.EnvironmentAliases.EnvironmentVariable(Cake.Core.ICakeContext,System.String)">
<summary>
Retrieves the value of the environment variable or <c>null</c> if the environment variable does not exist.
</summary>
<example>
<code>
Information(EnvironmentVariable("HOME") ?? "Unknown location");
</code>
</example>
<param name="context">The context.</param>
<param name="variable">The environment variable.</param>
<returns>The environment variable or <c>null</c> if the environment variable does not exist.</returns>
</member>
<member name="M:Cake.Common.EnvironmentAliases.EnvironmentVariable``1(Cake.Core.ICakeContext,System.String,``0)">
<summary>
Retrieves the value of the environment variable or <paramref name="defaultValue"/> if the environment variable does not exist.
</summary>
<example>
<code>
Information(EnvironmentVariable<int>("BUILD_NUMBER", 42));
</code>
</example>
<typeparam name="T">The environment variable type.</typeparam>
<param name="context">The context.</param>
<param name="variable">The environment variable.</param>
<param name="defaultValue">The value to return if the environment variable does not exist.</param>
<returns>The environment variable or <paramref name="defaultValue"/> if the environment variable does not exist.</returns>
</member>
<member name="M:Cake.Common.EnvironmentAliases.EnvironmentVariables(Cake.Core.ICakeContext)">
<summary>
Retrieves all environment variables.
</summary>
<example>
<code>
var envVars = EnvironmentVariables();
string path;
if (envVars.TryGetValue("PATH", out path))
{
Information("Path: {0}", path);
}
foreach(var envVar in envVars)
{
Information(
"Key: {0}\tValue: \"{1}\"",
envVar.Key,
envVar.Value
);
}
</code>
</example>
<param name="context">The context.</param>
<returns>The environment variables.</returns>
</member>
<member name="M:Cake.Common.EnvironmentAliases.HasEnvironmentVariable(Cake.Core.ICakeContext,System.String)">
<summary>
Checks for the existence of a value for a given environment variable.
</summary>
<example>
<code>
if (HasEnvironmentVariable("SOME_ENVIRONMENT_VARIABLE"))
{
Information("The environment variable was present.");
}
</code>
</example>
<param name="context">The context.</param>
<param name="variable">The environment variable.</param>
<returns>
<c>true</c> if the environment variable exist; otherwise <c>false</c>.
</returns>
</member>
<member name="M:Cake.Common.EnvironmentAliases.IsRunningOnWindows(Cake.Core.ICakeContext)">
<summary>
Determines whether the build script is running on Windows.
</summary>
<example>
<code>
if (IsRunningOnWindows())
{
Information("Windows!");
}
</code>
</example>
<param name="context">The context.</param>
<returns>
<c>true</c> if the build script is running on Windows; otherwise <c>false</c>.
</returns>
</member>
<member name="M:Cake.Common.EnvironmentAliases.IsRunningOnUnix(Cake.Core.ICakeContext)">
<summary>
Determines whether the build script running on a Unix or Linux based system.
</summary>
<example>
<code>
if (IsRunningOnUnix())
{
Information("Not Windows!");
}
</code>
</example>
<param name="context">The context.</param>
<returns>
<c>true</c> if the build script running on a Unix or Linux based system; otherwise <c>false</c>.
</returns>
</member>
<member name="M:Cake.Common.EnvironmentAliases.IsRunningOnMacOs(Cake.Core.ICakeContext)">
<summary>
Determines whether the build script running on a macOS based system.
</summary>
<example>
<code>
if (IsRunningOnMacOs())
{
Information("macOS!");
}
</code>
</example>
<param name="context">The context.</param>
<returns>
<c>true</c> if the build script running on a macOS based system; otherwise <c>false</c>.
</returns>
</member>
<member name="M:Cake.Common.EnvironmentAliases.IsRunningOnLinux(Cake.Core.ICakeContext)">
<summary>
Determines whether the build script running on a Linux based system.
</summary>
<example>
<code>
if (IsRunningOnLinux())
{
Information("Linux!");
}
</code>
</example>
<param name="context">The context.</param>
<returns>
<c>true</c> if the build script running on a Linux based system; otherwise <c>false</c>.
</returns>
</member>
<member name="T:Cake.Common.IO.DeleteDirectorySettings">
<summary>
Contains settings used by <c>DeleteDirectory</c>.
</summary>
</member>
<member name="P:Cake.Common.IO.DeleteDirectorySettings.Recursive">
<summary>
Gets or sets a value indicating whether to perform a recursive delete if set to <c>true</c>.
<remarks>
It is set to <c>false</c> by default.
</remarks>
</summary>
</member>
<member name="P:Cake.Common.IO.DeleteDirectorySettings.Force">
<summary>
Gets or sets a value indicating whether to delete read-only files if set to <c>true</c>.
<remarks>
It is set to <c>false</c> by default.
</remarks>
</summary>
</member>
<member name="T:Cake.Common.IO.DirectoryAliases">
<summary>
Contains extension methods for working with directories.
</summary>
</member>
<member name="M:Cake.Common.IO.DirectoryAliases.Directory(Cake.Core.ICakeContext,System.String)">
<summary>
Gets a directory path from string.
</summary>
<example>
<code>
// Get the temp directory.
var root = Directory("./");
var temp = root + Directory("temp");
// Clean the directory.
CleanDirectory(temp);
</code>
</example>
<param name="context">The context.</param>
<param name="path">The path.</param>
<returns>A directory path.</returns>
</member>
<member name="M:Cake.Common.IO.DirectoryAliases.DeleteDirectories(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.DirectoryPath},Cake.Common.IO.DeleteDirectorySettings)">
<summary>
Deletes the specified directories.
</summary>
<example>
<code>
var directoriesToDelete = new DirectoryPath[]{
Directory("be"),
Directory("gone")
};
DeleteDirectories(directoriesToDelete, new DeleteDirectorySettings {
Recursive = true,
Force = true
});
</code>
</example>
<param name="context">The context.</param>
<param name="directories">The directory paths.</param>
<param name="settings">The delete settings.</param>
</member>
<member name="M:Cake.Common.IO.DirectoryAliases.DeleteDirectories(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{System.String},Cake.Common.IO.DeleteDirectorySettings)">
<summary>
Deletes the specified directories.
</summary>
<example>
<code>
var directoriesToDelete = new []{
"be",
"gone"
};
DeleteDirectories(directoriesToDelete, new DeleteDirectorySettings {
Recursive = true,
Force = true
});
</code>
</example>
<param name="context">The context.</param>
<param name="directories">The directory paths.</param>
<param name="settings">The delete settings.</param>
</member>
<member name="M:Cake.Common.IO.DirectoryAliases.DeleteDirectory(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath,Cake.Common.IO.DeleteDirectorySettings)">
<summary>
Deletes the specified directory.
</summary>
<example>
<code>
DeleteDirectory("./be/gone", new DeleteDirectorySettings {
Recursive = true,
Force = true
});
</code>
</example>
<param name="context">The context.</param>
<param name="path">The directory path.</param>
<param name="settings">The delete settings.</param>
</member>
<member name="M:Cake.Common.IO.DirectoryAliases.CleanDirectories(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern)">
<summary>
Cleans the directories matching the specified pattern.
Cleaning the directory will remove all its content but not the directory itself.
</summary>
<example>
<code>
CleanDirectories("./src/**/bin/debug");
</code>
</example>
<param name="context">The context.</param>
<param name="pattern">The pattern to match.</param>
</member>
<member name="M:Cake.Common.IO.DirectoryAliases.CleanDirectories(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern,System.Func{Cake.Core.IO.IFileSystemInfo,System.Boolean})">
<summary>
Cleans the directories matching the specified pattern.
Cleaning the directory will remove all its content but not the directory itself.
</summary>
<example>
<code>
Func<IFileSystemInfo, bool> exclude_node_modules =
fileSystemInfo=>!fileSystemInfo.Path.FullPath.EndsWith(
"node_modules",
StringComparison.OrdinalIgnoreCase);
CleanDirectories("./src/**/bin/debug", exclude_node_modules);
</code>
</example>
<param name="context">The context.</param>
<param name="pattern">The pattern to match.</param>
<param name="predicate">The predicate used to filter directories based on file system information.</param>
</member>
<member name="M:Cake.Common.IO.DirectoryAliases.CleanDirectories(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.DirectoryPath})">
<summary>
Cleans the specified directories.
Cleaning a directory will remove all its content but not the directory itself.
</summary>
<example>
<code>
var directoriesToClean = GetDirectories("./src/**/bin/");
CleanDirectories(directoriesToClean);
</code>
</example>
<param name="context">The context.</param>
<param name="directories">The directory paths.</param>
</member>
<member name="M:Cake.Common.IO.DirectoryAliases.CleanDirectories(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{System.String})">
<summary>
Cleans the specified directories.
Cleaning a directory will remove all its content but not the directory itself.
</summary>
<example>
<code>
var directoriesToClean = new []{
"./src/Cake/obj",
"./src/Cake.Common/obj"
};
CleanDirectories(directoriesToClean);
</code>
</example>
<param name="context">The context.</param>
<param name="directories">The directory paths.</param>
</member>
<member name="M:Cake.Common.IO.DirectoryAliases.CleanDirectory(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath)">
<summary>
Cleans the specified directory.
</summary>
<example>
<code>
CleanDirectory("./src/Cake.Common/obj");
</code>
</example>
<param name="context">The context.</param>
<param name="path">The directory path.</param>
</member>
<member name="M:Cake.Common.IO.DirectoryAliases.CleanDirectory(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath,System.Func{Cake.Core.IO.IFileSystemInfo,System.Boolean})">
<summary>
Cleans the specified directory.
</summary>
<example>
<code>
CleanDirectory("./src/Cake.Common/obj", fileSystemInfo=>!fileSystemInfo.Hidden);
</code>
</example>
<param name="context">The context.</param>
<param name="path">The directory path.</param>
<param name="predicate">Predicate used to determine which files/directories should get deleted.</param>
</member>
<member name="M:Cake.Common.IO.DirectoryAliases.CreateDirectory(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath)">
<summary>
Creates the specified directory.
</summary>
<example>
<code>
CreateDirectory("publish");
</code>
</example>
<param name="context">The context.</param>
<param name="path">The directory path.</param>
</member>
<member name="M:Cake.Common.IO.DirectoryAliases.EnsureDirectoryExists(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath)">
<summary>
Creates the specified directory if it does not exist.
</summary>
<example>
<code>
EnsureDirectoryExists("publish");
</code>
</example>
<param name="context">The context.</param>
<param name="path">The directory path.</param>
</member>
<member name="M:Cake.Common.IO.DirectoryAliases.EnsureDirectoryDoesNotExist(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath)">
<summary>
Deletes the specified directory and its contents if it exists.
</summary>
<example>
<code>
EnsureDirectoryDoesNotExist("./be/gone");
</code>
</example>
<param name="context">The context.</param>
<param name="path">The directory path.</param>
</member>
<member name="M:Cake.Common.IO.DirectoryAliases.EnsureDirectoryDoesNotExist(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath,Cake.Common.IO.DeleteDirectorySettings)">
<summary>
Deletes the specified directory if it exists.
</summary>
<example>
<code>
EnsureDirectoryDoesNotExist("./be/gone", new DeleteDirectorySettings {
Recursive = true,
Force = true
});
</code>
</example>
<param name="context">The context.</param>
<param name="path">The directory path.</param>
<param name="settings">The delete settings.</param>
</member>
<member name="M:Cake.Common.IO.DirectoryAliases.EnsureDirectoryDoesNotExist(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath,Cake.Common.IO.EnsureDirectoryDoesNotExistSettings)">
<summary>
Deletes the specified directory if it exists.
</summary>
<example>
<code>
EnsureDirectoryDoesNotExist("./be/gone", new EnsureDirectoryDoesNotExistSettings {
Recursive = true,
Force = true
});
</code>
</example>
<param name="context">The context.</param>
<param name="path">The directory path.</param>
<param name="settings">The delete settings.</param>
</member>
<member name="M:Cake.Common.IO.DirectoryAliases.CopyDirectory(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath,Cake.Core.IO.DirectoryPath)">
<summary>
Copies the contents of a directory, including subdirectories to the specified location.
</summary>
<example>
<code>
CopyDirectory("source_path", "destination_path");
</code>
</example>
<param name="context">The context.</param>
<param name="source">The source directory path.</param>
<param name="destination">The destination directory path.</param>
</member>
<member name="M:Cake.Common.IO.DirectoryAliases.DirectoryExists(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath)">
<summary>
Determines whether the given path refers to an existing directory.
</summary>
<example>
<code>
var dir = "publish";
if (!DirectoryExists(dir))
{
CreateDirectory(dir);
}
</code>
</example>
<param name="context">The context.</param>
<param name="path">The <see cref="T:Cake.Core.IO.DirectoryPath"/> to check.</param>
<returns><c>true</c> if <paramref name="path"/> refers to an existing directory;
<c>false</c> if the directory does not exist or an error occurs when trying to
determine if the specified path exists.</returns>
</member>
<member name="M:Cake.Common.IO.DirectoryAliases.MakeAbsolute(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath)">
<summary>
Makes the path absolute (if relative) using the current working directory.
</summary>
<example>
<code>
var path = MakeAbsolute(Directory("./resources"));
</code>
</example>
<param name="context">The context.</param>
<param name="path">The path.</param>
<returns>An absolute directory path.</returns>
</member>
<member name="M:Cake.Common.IO.DirectoryAliases.MakeRelative(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath,Cake.Core.IO.DirectoryPath)">
<summary>
Makes the directory path relative (if absolute) to a specified root directory. If no root directory is defined
the current working directory is used as default root.
</summary>
<example>
<code>
var path = MakeRelative(Directory("C:\Cake\Tests\Integration"));
</code>
</example>
<param name="context">The context.</param>
<param name="path">The path.</param>
<param name="rootPath">The root path.</param>
<returns>A relative directory path.</returns>
</member>
<member name="M:Cake.Common.IO.DirectoryAliases.MakeRelative(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Core.IO.DirectoryPath)">
<summary>
Makes the file path relative (if absolute) to a specified root directory. If no root directory is defined
the current working directory is used as default root.
</summary>
<example>
<code>
var path = MakeRelative(Directory("C:\Cake\Tests\Integration\file.cake"));
</code>
</example>
<param name="context">The context.</param>
<param name="path">The path.</param>
<param name="rootPath">The root path.</param>
<returns>A relative file path.</returns>
</member>
<member name="M:Cake.Common.IO.DirectoryAliases.MoveDirectory(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath,Cake.Core.IO.DirectoryPath)">
<summary>
Moves an existing directory to a new location, providing the option to specify a new directory name.
</summary>
<param name="context">The context.</param>
<param name="directoryPath">The directory path.</param>
<param name="targetDirectoryPath">The target directory path.</param>
<example>
<code>
MoveDirectory("mydir", "newparent/newdir");
</code>
</example>
</member>
<member name="M:Cake.Common.IO.DirectoryAliases.GetSubDirectories(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath)">
<summary>
Gets a list of all the directories inside a directory.
</summary>
<example>
<code>
var directories = GetSubDirectories("some/dir");
</code>
</example>
<param name="context">The context.</param>
<param name="directoryPath">The directory path.</param>
<returns>An absolute directory path.</returns>
</member>
<member name="M:Cake.Common.IO.DirectoryAliases.ExpandEnvironmentVariables(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath)">
<summary>
Expands all environment variables in the provided <see cref="T:Cake.Core.IO.DirectoryPath"/>.
</summary>
<example>
<code>
var path = new DirectoryPath("%APPDATA%/foo");
var expanded = path.ExpandEnvironmentVariables(environment);
</code>
</example>
<param name="context">The context.</param>
<param name="directoryPath">The path.</param>
<returns>A new <see cref="T:Cake.Core.IO.DirectoryPath"/> with each environment variable replaced by its value.</returns>
</member>
<member name="T:Cake.Common.IO.EnsureDirectoryDoesNotExistSettings">
<summary>
Contains settings used by <c>EnsureDirectoryDoesNotExistSettings</c>.
</summary>
</member>
<member name="T:Cake.Common.IO.FileAliases">
<summary>
Contains functionality related to file operations.
</summary>
</member>
<member name="M:Cake.Common.IO.FileAliases.File(Cake.Core.ICakeContext,System.String)">
<summary>
Gets a file path from string.
</summary>
<example>
<code>
// Get the temp file.
var root = Directory("./");
var temp = root + File("temp");
// Delete the file.
CleanDirectory(temp);
</code>
</example>
<param name="context">The context.</param>
<param name="path">The path.</param>
<returns>A file path.</returns>
</member>
<member name="M:Cake.Common.IO.FileAliases.CopyFileToDirectory(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Core.IO.DirectoryPath)">
<summary>
Copies an existing file to a new location.
</summary>
<param name="context">The context.</param>
<param name="filePath">The file path.</param>
<param name="targetDirectoryPath">The target directory path.</param>
<example>
<code>
CopyFileToDirectory("test.txt", "./targetdir");
</code>
</example>
</member>
<member name="M:Cake.Common.IO.FileAliases.CopyFile(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Core.IO.FilePath)">
<summary>
Copies an existing file to a new file, providing the option to specify a new file name.
</summary>
<param name="context">The context.</param>
<param name="filePath">The file path.</param>
<param name="targetFilePath">The target file path.</param>
<example>
<code>
CopyFile("test.tmp", "test.txt");
</code>
</example>
</member>
<member name="M:Cake.Common.IO.FileAliases.CopyFiles(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern,Cake.Core.IO.DirectoryPath)">
<summary>
Copies all files matching the provided pattern to a new location.
</summary>
<param name="context">The context.</param>
<param name="pattern">The pattern.</param>
<param name="targetDirectoryPath">The target directory path.</param>
<example>
<code>
CopyFiles("Cake.*", "./publish");
</code>
</example>
</member>
<member name="M:Cake.Common.IO.FileAliases.CopyFiles(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Core.IO.DirectoryPath)">
<summary>
Copies existing files to a new location.
</summary>
<param name="context">The context.</param>
<param name="filePaths">The file paths.</param>
<param name="targetDirectoryPath">The target directory path.</param>
<example>
<code>
var files = GetFiles("./**/Cake.*");
CopyFiles(files, "destination");
</code>
</example>
</member>
<member name="M:Cake.Common.IO.FileAliases.CopyFiles(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{System.String},Cake.Core.IO.DirectoryPath)">
<summary>
Copies existing files to a new location.
</summary>
<param name="context">The context.</param>
<param name="filePaths">The file paths.</param>
<param name="targetDirectoryPath">The target directory path.</param>
<example>
<code>
CreateDirectory("destination");
var files = new [] {
"Cake.exe",
"Cake.pdb"
};
CopyFiles(files, "destination");
</code>
</example>
</member>
<member name="M:Cake.Common.IO.FileAliases.CopyFiles(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern,Cake.Core.IO.DirectoryPath,System.Boolean)">
<summary>
Copies all files matching the provided pattern to a new location.
</summary>
<param name="context">The context.</param>
<param name="pattern">The pattern.</param>
<param name="targetDirectoryPath">The target directory path.</param>
<param name="preserveFolderStructure">Keep the folder structure.</param>
<example>
<code>
CopyFiles("Cake.*", "./publish");
</code>
</example>
</member>
<member name="M:Cake.Common.IO.FileAliases.CopyFiles(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Core.IO.DirectoryPath,System.Boolean)">
<summary>
Copies existing files to a new location.
</summary>
<param name="context">The context.</param>
<param name="filePaths">The file paths.</param>
<param name="targetDirectoryPath">The target directory path.</param>
<param name="preserveFolderStructure">Keep the folder structure.</param>
<example>
<code>
var files = GetFiles("./**/Cake.*");
CopyFiles(files, "destination");
</code>
</example>
</member>
<member name="M:Cake.Common.IO.FileAliases.CopyFiles(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{System.String},Cake.Core.IO.DirectoryPath,System.Boolean)">
<summary>
Copies existing files to a new location.
</summary>
<param name="context">The context.</param>
<param name="filePaths">The file paths.</param>
<param name="targetDirectoryPath">The target directory path.</param>
<param name="preserveFolderStructure">Keep the folder structure.</param>
<example>
<code>
CreateDirectory("destination");
var files = new [] {
"Cake.exe",
"Cake.pdb"
};
CopyFiles(files, "destination");
</code>
</example>
</member>
<member name="M:Cake.Common.IO.FileAliases.MoveFileToDirectory(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Core.IO.DirectoryPath)">
<summary>
Moves an existing file to a new location.
</summary>
<param name="context">The context.</param>
<param name="filePath">The file path.</param>
<param name="targetDirectoryPath">The target directory path.</param>
<example>
<code>
MoveFileToDirectory("test.txt", "./targetdir");
</code>
</example>
</member>
<member name="M:Cake.Common.IO.FileAliases.MoveFiles(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern,Cake.Core.IO.DirectoryPath)">
<summary>
Moves existing files matching the specified pattern to a new location.
</summary>
<param name="context">The context.</param>
<param name="pattern">The pattern.</param>
<param name="targetDirectoryPath">The target directory path.</param>
<example>
<code>
MoveFiles("./publish/Cake.*", "./destination");
</code>
</example>
</member>
<member name="M:Cake.Common.IO.FileAliases.MoveFiles(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Core.IO.DirectoryPath)">
<summary>
Moves existing files to a new location.
</summary>
<param name="context">The context.</param>
<param name="filePaths">The file paths.</param>
<param name="targetDirectoryPath">The target directory path.</param>
<example>
<code>
var files = GetFiles("./publish/Cake.*");
MoveFiles(files, "destination");
</code>
</example>
</member>
<member name="M:Cake.Common.IO.FileAliases.MoveFile(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Core.IO.FilePath)">
<summary>
Moves an existing file to a new location, providing the option to specify a new file name.
</summary>
<param name="context">The context.</param>
<param name="filePath">The file path.</param>
<param name="targetFilePath">The target file path.</param>
<example>
<code>
MoveFile("test.tmp", "test.txt");
</code>
</example>
</member>
<member name="M:Cake.Common.IO.FileAliases.DeleteFiles(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern)">
<summary>
Deletes the specified files.
</summary>
<param name="context">The context.</param>
<param name="pattern">The pattern.</param>
<example>
<code>
DeleteFiles("./publish/Cake.*");
</code>
</example>
</member>
<member name="M:Cake.Common.IO.FileAliases.DeleteFiles(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath})">
<summary>
Deletes the specified files.
</summary>
<param name="context">The context.</param>
<param name="filePaths">The file paths.</param>
<example>
<code>
var files = GetFiles("./destination/Cake.*");
DeleteFiles(files);
</code>
</example>
</member>
<member name="M:Cake.Common.IO.FileAliases.DeleteFile(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Deletes the specified file.
</summary>
<param name="context">The context.</param>
<param name="filePath">The file path.</param>
<example>
<code>
DeleteFile("deleteme.txt");
</code>
</example>
</member>
<member name="M:Cake.Common.IO.FileAliases.FileExists(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Determines whether the given path refers to an existing file.
</summary>
<param name="context">The context.</param>
<param name="filePath">The <see cref="T:Cake.Core.IO.FilePath"/> to check.</param>
<returns><c>true</c> if <paramref name="filePath"/> refers to an existing file;
<c>false</c> if the file does not exist or an error occurs when trying to
determine if the specified file exists.</returns>
<example>
<code>
if (FileExists("findme.txt"))
{
Information("File exists!");
}
</code>
</example>
</member>
<member name="M:Cake.Common.IO.FileAliases.MakeAbsolute(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Makes the path absolute (if relative) using the current working directory.
</summary>
<param name="context">The context.</param>
<param name="filePath">The path.</param>
<returns>An absolute file path.</returns>
<example>
<code>
var path = MakeAbsolute(File("./resources"));
</code>
</example>
</member>
<member name="M:Cake.Common.IO.FileAliases.FileSize(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Gets the size of a file in bytes.
</summary>
<param name="context">The context.</param>
<param name="filePath">The path.</param>
<returns>Size of file in bytes or -1 if file doesn't exist.</returns>
<example>
<code>
Information("File size: {0}", FileSize("./build.cake"));
</code>
</example>
</member>
<member name="M:Cake.Common.IO.FileAliases.ExpandEnvironmentVariables(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Expands all environment variables in the provided <see cref="T:Cake.Core.IO.FilePath"/>.
</summary>
<example>
<code>
var path = new FilePath("%APPDATA%/foo.bar");
var expanded = path.ExpandEnvironmentVariables(environment);
</code>
</example>
<param name="context">The context.</param>
<param name="filePath">The path.</param>
<returns>A new <see cref="T:Cake.Core.IO.FilePath"/> with each environment variable replaced by its value.</returns>
</member>
<member name="T:Cake.Common.IO.GlobbingAliases">
<summary>
Contains functionality related to file system globbing.
</summary>
</member>
<member name="M:Cake.Common.IO.GlobbingAliases.GetFiles(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern)">
<summary>
Gets all files matching the specified pattern.
</summary>
<example>
<code>
var files = GetFiles("./**/Cake.*.dll");
foreach(var file in files)
{
Information("File: {0}", file);
}
</code>
</example>
<param name="context">The context.</param>
<param name="pattern">The glob pattern to match.</param>
<returns>A <see cref="T:Cake.Core.IO.FilePathCollection" />.</returns>
</member>
<member name="M:Cake.Common.IO.GlobbingAliases.GetFiles(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern,Cake.Core.IO.GlobberSettings)">
<summary>
Gets all files matching the specified pattern.
</summary>
<example>
<code>
Func<IFileSystemInfo, bool> exclude_node_modules =
fileSystemInfo => !fileSystemInfo.Path.FullPath.EndsWith(
"node_modules", StringComparison.OrdinalIgnoreCase);
var files = GetFiles("./**/Cake.*.dll", new GlobberSettings { Predicate = exclude_node_modules });
foreach(var file in files)
{
Information("File: {0}", file);
}
</code>
</example>
<param name="context">The context.</param>
<param name="pattern">The glob pattern to match.</param>
<param name="settings">The globber settings.</param>
<returns>A <see cref="T:Cake.Core.IO.FilePathCollection" />.</returns>
</member>
<member name="M:Cake.Common.IO.GlobbingAliases.GetDirectories(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern)">
<summary>
Gets all directories matching the specified pattern.
</summary>
<example>
<code>
var directories = GetDirectories("./src/**/obj/*");
foreach(var directory in directories)
{
Information("Directory: {0}", directory);
}
</code>
</example>
<param name="context">The context.</param>
<param name="pattern">The glob pattern to match.</param>
<returns>A <see cref="T:Cake.Core.IO.DirectoryPathCollection" />.</returns>
</member>
<member name="M:Cake.Common.IO.GlobbingAliases.GetDirectories(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern,Cake.Core.IO.GlobberSettings)">
<summary>
Gets all directories matching the specified pattern.
</summary>
<example>
<code>
Func<IFileSystemInfo, bool> exclude_node_modules =
fileSystemInfo => !fileSystemInfo.Path.FullPath.EndsWith(
"node_modules", StringComparison.OrdinalIgnoreCase);
var directories = GetDirectories("./src/**/obj/*", new GlobberSettings { Predicate = exclude_node_modules });
foreach(var directory in directories)
{
Information("Directory: {0}", directory);
}
</code>
</example>
<param name="context">The context.</param>
<param name="pattern">The glob pattern to match.</param>
<param name="settings">The globber settings.</param>
<returns>A <see cref="T:Cake.Core.IO.DirectoryPathCollection" />.</returns>
</member>
<member name="M:Cake.Common.IO.GlobbingAliases.GetPaths(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern)">
<summary>
Gets all paths matching the specified pattern.
</summary>
<example>
<code>
var paths = GetPaths("./src/**/obj/*");
foreach(var path in paths)
{
Information("Path: {0}", path);
}
</code>
</example>
<param name="context">The context.</param>
<param name="pattern">The glob pattern to match.</param>
<returns>A <see cref="T:Cake.Core.IO.PathCollection" />.</returns>
</member>
<member name="M:Cake.Common.IO.GlobbingAliases.GetPaths(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern,Cake.Core.IO.GlobberSettings)">
<summary>
Gets all paths matching the specified pattern.
</summary>
<example>
<code>
Func<IFileSystemInfo, bool> exclude_node_modules =
fileSystemInfo => !fileSystemInfo.Path.FullPath.EndsWith(
"node_modules", StringComparison.OrdinalIgnoreCase);
var paths = GetPaths("./src/**/obj/*", new GlobberSettings { Predicate = exclude_node_modules });
foreach(var path in paths)
{
Information("Path: {0}", path);
}
</code>
</example>
<param name="context">The context.</param>
<param name="pattern">The glob pattern to match.</param>
<param name="settings">The globber settings.</param>
<returns>A <see cref="T:Cake.Core.IO.PathCollection" />.</returns>
</member>
<member name="T:Cake.Common.IO.Paths.ConvertableDirectoryPath">
<summary>
Represents a <see cref="T:Cake.Core.IO.DirectoryPath" /> that can be easily converted.
<example>
To get the underlying <see cref="T:Cake.Core.IO.DirectoryPath"/>:
<code>
ConvertableDirectoryPath convertable = Directory("./root");
DirectoryPath path = (DirectoryPath)convertable;
</code>
To combine two directories:
<code>
ConvertableDirectoryPath path = Directory("./root") + Directory("other");
</code>
To combine a directory with a file:
<code>
ConvertableFilePath path = Directory("./root") + File("other.txt");
</code>
</example>
</summary>
</member>
<member name="P:Cake.Common.IO.Paths.ConvertableDirectoryPath.Path">
<summary>
Gets the path.
</summary>
<value>The path.</value>
</member>
<member name="M:Cake.Common.IO.Paths.ConvertableDirectoryPath.#ctor(Cake.Core.IO.DirectoryPath)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.IO.Paths.ConvertableDirectoryPath"/> class.
</summary>
<param name="path">The path.</param>
</member>
<member name="M:Cake.Common.IO.Paths.ConvertableDirectoryPath.op_Addition(Cake.Common.IO.Paths.ConvertableDirectoryPath,Cake.Common.IO.Paths.ConvertableDirectoryPath)">
<summary>
Operator that combines A <see cref="T:Cake.Common.IO.Paths.ConvertableDirectoryPath"/> instance
with another <see cref="T:Cake.Common.IO.Paths.ConvertableDirectoryPath"/> instance.
</summary>
<param name="left">The left directory path operand.</param>
<param name="right">The right directory path operand.</param>
<returns>A new directory path representing a combination of the two provided paths.</returns>
</member>
<member name="M:Cake.Common.IO.Paths.ConvertableDirectoryPath.op_Addition(Cake.Core.IO.DirectoryPath,Cake.Common.IO.Paths.ConvertableDirectoryPath)">
<summary>
Operator that combines A <see cref="T:Cake.Core.IO.DirectoryPath"/> instance
with a <see cref="T:Cake.Common.IO.Paths.ConvertableDirectoryPath"/> instance.
</summary>
<param name="left">The left directory path operand.</param>
<param name="right">The right directory path operand.</param>
<returns>A new directory path representing a combination of the two provided paths.</returns>
</member>
<member name="M:Cake.Common.IO.Paths.ConvertableDirectoryPath.op_Addition(Cake.Common.IO.Paths.ConvertableDirectoryPath,Cake.Core.IO.DirectoryPath)">
<summary>
Operator that combines A <see cref="T:Cake.Common.IO.Paths.ConvertableDirectoryPath"/> instance
with a <see cref="T:Cake.Core.IO.DirectoryPath"/> instance.
</summary>
<param name="left">The left directory path operand.</param>
<param name="right">The right directory path operand.</param>
<returns>A new directory path representing a combination of the two provided paths.</returns>
</member>
<member name="M:Cake.Common.IO.Paths.ConvertableDirectoryPath.op_Addition(Cake.Common.IO.Paths.ConvertableDirectoryPath,Cake.Common.IO.Paths.ConvertableFilePath)">
<summary>
Operator that combines A <see cref="T:Cake.Common.IO.Paths.ConvertableDirectoryPath"/> instance
with a <see cref="T:Cake.Common.IO.Paths.ConvertableFilePath"/> instance.
</summary>
<param name="directory">The left directory path operand.</param>
<param name="file">The right file path operand.</param>
<returns>A new file path representing a combination of the two provided paths.</returns>
</member>
<member name="M:Cake.Common.IO.Paths.ConvertableDirectoryPath.op_Addition(Cake.Common.IO.Paths.ConvertableDirectoryPath,Cake.Core.IO.FilePath)">
<summary>
Operator that combines A <see cref="T:Cake.Common.IO.Paths.ConvertableDirectoryPath"/> instance
with a <see cref="T:Cake.Core.IO.FilePath"/> instance.
</summary>
<param name="directory">The left directory path operand.</param>
<param name="file">The right file path operand.</param>
<returns>A new file path representing a combination of the two provided paths.</returns>
</member>
<member name="M:Cake.Common.IO.Paths.ConvertableDirectoryPath.op_Implicit(Cake.Common.IO.Paths.ConvertableDirectoryPath)~Cake.Core.IO.DirectoryPath">
<summary>
Performs an implicit conversion from <see cref="T:Cake.Common.IO.Paths.ConvertableDirectoryPath"/> to <see cref="T:Cake.Core.IO.DirectoryPath"/>.
</summary>
<param name="path">The path.</param>
<returns>The result of the conversion.</returns>
</member>
<member name="M:Cake.Common.IO.Paths.ConvertableDirectoryPath.op_Implicit(Cake.Common.IO.Paths.ConvertableDirectoryPath)~System.String">
<summary>
Performs an implicit conversion from <see cref="T:Cake.Common.IO.Paths.ConvertableDirectoryPath"/> to <see cref="T:System.String"/>.
</summary>
<param name="path">The path.</param>
<returns>The result of the conversion.</returns>
</member>
<member name="M:Cake.Common.IO.Paths.ConvertableDirectoryPath.ToString">
<summary>
Returns a <see cref="T:System.String" /> that represents this instance.
</summary>
<returns>
A <see cref="T:System.String" /> that represents this instance.
</returns>
</member>
<member name="T:Cake.Common.IO.Paths.ConvertableFilePath">
<summary>
Represents a <see cref="T:Cake.Core.IO.FilePath" /> that can be easily converted.
</summary>
</member>
<member name="M:Cake.Common.IO.Paths.ConvertableFilePath.#ctor(Cake.Core.IO.FilePath)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.IO.Paths.ConvertableFilePath"/> class.
</summary>
<param name="path">The path.</param>
</member>
<member name="P:Cake.Common.IO.Paths.ConvertableFilePath.Path">
<summary>
Gets the path.
</summary>
<value>The actual path.</value>
</member>
<member name="M:Cake.Common.IO.Paths.ConvertableFilePath.op_Implicit(Cake.Common.IO.Paths.ConvertableFilePath)~Cake.Core.IO.FilePath">
<summary>
Performs an implicit conversion from <see cref="T:Cake.Common.IO.Paths.ConvertableFilePath"/> to <see cref="T:Cake.Core.IO.FilePath"/>.
</summary>
<param name="path">The path.</param>
<returns>The result of the conversion. </returns>
</member>
<member name="M:Cake.Common.IO.Paths.ConvertableFilePath.op_Implicit(Cake.Common.IO.Paths.ConvertableFilePath)~System.String">
<summary>
Performs an implicit conversion from <see cref="T:Cake.Common.IO.Paths.ConvertableFilePath"/> to <see cref="T:System.String"/>.
</summary>
<param name="path">The path.</param>
<returns>The result of the conversion.</returns>
</member>
<member name="M:Cake.Common.IO.Paths.ConvertableFilePath.ToString">
<summary>
Returns a <see cref="T:System.String" /> that represents this instance.
</summary>
<returns>
A <see cref="T:System.String" /> that represents this instance.
</returns>
</member>
<member name="T:Cake.Common.IO.Paths.NamespaceDoc">
<summary>
This namespace contain types related
to file system paths.
</summary>
</member>
<member name="T:Cake.Common.IO.ZipAliases">
<summary>
Contains functionality related to compress files to Zip.
</summary>
</member>
<member name="M:Cake.Common.IO.ZipAliases.Zip(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath,Cake.Core.IO.FilePath)">
<summary>
Zips the specified directory.
</summary>
<param name="context">The context.</param>
<param name="rootPath">The root path.</param>
<param name="outputPath">The output path.</param>
<example>
<code>
Zip("./publish", "publish.zip");
</code>
</example>
</member>
<member name="M:Cake.Common.IO.ZipAliases.Zip(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath,Cake.Core.IO.FilePath,System.String)">
<summary>
Zips the files matching the specified pattern.
</summary>
<param name="context">The context.</param>
<param name="rootPath">The root path.</param>
<param name="outputPath">The output path.</param>
<param name="pattern">The pattern.</param>
<example>
<code>
Zip("./", "XmlFiles.zip", "./*.xml");
</code>
</example>
</member>
<member name="M:Cake.Common.IO.ZipAliases.Zip(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath,Cake.Core.IO.FilePath,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath})">
<summary>
Zips the specified files.
</summary>
<param name="context">The context.</param>
<param name="rootPath">The root path.</param>
<param name="outputPath">The output path.</param>
<param name="filePaths">The file paths.</param>
<example>
<code>
var files = GetFiles("./**/Cake.*.dll");
Zip("./", "CakeAssemblies.zip", files);
</code>
</example>
</member>
<member name="M:Cake.Common.IO.ZipAliases.Zip(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath,Cake.Core.IO.FilePath,System.Collections.Generic.IEnumerable{System.String})">
<summary>
Zips the specified files.
</summary>
<param name="context">The context.</param>
<param name="rootPath">The root path.</param>
<param name="outputPath">The output path.</param>
<param name="filePaths">The file paths.</param>
<example>
<code>
var files = new [] {
"./src/Cake/bin/Debug/Autofac.dll",
"./src/Cake/bin/Debug/Cake.Common.dll",
"./src/Cake/bin/Debug/Cake.Core.dll",
"./src/Cake/bin/Debug/Cake.exe"
};
Zip("./", "CakeBinaries.zip", files);
</code>
</example>
</member>
<member name="M:Cake.Common.IO.ZipAliases.Unzip(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Core.IO.DirectoryPath)">
<summary>
Unzips the specified file.
</summary>
<param name="context">The context.</param>
<param name="zipFile">Zip file to unzip.</param>
<param name="outputPath">Output path to unzip into.</param>
<example>
<code>
Unzip("Cake.zip", "./cake");
</code>
</example>
</member>
<member name="T:Cake.Common.IO.Zipper">
<summary>
Performs Zip compression.
</summary>
</member>
<member name="M:Cake.Common.IO.Zipper.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.Diagnostics.ICakeLog)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.IO.Zipper"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="log">The log.</param>
</member>
<member name="M:Cake.Common.IO.Zipper.Zip(Cake.Core.IO.DirectoryPath,Cake.Core.IO.FilePath,System.Collections.Generic.IEnumerable{Cake.Core.IO.Path})">
<summary>
Zips the specified directory.
</summary>
<param name="rootPath">The root path.</param>
<param name="outputPath">The output path.</param>
<param name="paths">The paths to zip.</param>
</member>
<member name="M:Cake.Common.IO.Zipper.Zip(Cake.Core.IO.DirectoryPath,Cake.Core.IO.FilePath,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath})">
<summary>
Zips the specified directory.
</summary>
<param name="rootPath">The root path.</param>
<param name="outputPath">The output path.</param>
<param name="filePaths">The files to zip.</param>
</member>
<member name="M:Cake.Common.IO.Zipper.Unzip(Cake.Core.IO.FilePath,Cake.Core.IO.DirectoryPath)">
<summary>
Unzips the specified file to the specified output path.
</summary>
<param name="zipPath">Zip file path.</param>
<param name="outputPath">Output directory path.</param>
</member>
<member name="T:Cake.Common.IO.NamespaceDoc">
<summary>
This namespace contain types that support input and output,
including the ability to read and write data to streams and to
interact with the file system.
</summary>
</member>
<member name="T:Cake.Common.IO.Net.NamespaceDoc">
<summary>
This namespace contain types related
to network operations.
</summary>
</member>
<member name="T:Cake.Common.Modules.CommonModule">
<summary>
The module responsible for registering
default types in the Cake.Common assembly.
</summary>
</member>
<member name="M:Cake.Common.Modules.CommonModule.Register(Cake.Core.Composition.ICakeContainerRegistrar)">
<inheritdoc/>
</member>
<member name="T:Cake.Common.Net.DownloadFileSettings">
<summary>
Contains settings for <see cref="T:Cake.Common.Net.HttpAliases"/>.
</summary>
</member>
<member name="P:Cake.Common.Net.DownloadFileSettings.Username">
<summary>
Gets or sets the username to use when downloading the file.
</summary>
</member>
<member name="P:Cake.Common.Net.DownloadFileSettings.Password">
<summary>
Gets or sets the password to use when downloading the file.
</summary>
</member>
<member name="P:Cake.Common.Net.DownloadFileSettings.UseDefaultCredentials">
<summary>
Gets or sets a value indicating whether default credentials are sent when downloading the file.
</summary>
<remarks>
If set to true, any username and password that has been specified will be ignored.
</remarks>
</member>
<member name="T:Cake.Common.Net.HttpAliases">
<summary>
Contains functionality related to HTTP operations.
</summary>
</member>
<member name="M:Cake.Common.Net.HttpAliases.DownloadFile(Cake.Core.ICakeContext,System.String)">
<summary>
Downloads the specified resource over HTTP to a temporary file.
</summary>
<example>
<code>
var resource = DownloadFile("http://www.example.org/index.html");
</code>
</example>
<param name="context">The context.</param>
<param name="address">The URL of the resource to download.</param>
<returns>The path to the downloaded file.</returns>
</member>
<member name="M:Cake.Common.Net.HttpAliases.DownloadFile(Cake.Core.ICakeContext,System.String,Cake.Common.Net.DownloadFileSettings)">
<summary>
Downloads the specified resource over HTTP to a temporary file with specified settings.
</summary>
<example>
<code>
var resource = DownloadFile("http://www.example.org/index.html", new DownloadFileSettings()
{
Username = "bob",
Password = "builder"
});
</code>
</example>
<param name="context">The context.</param>
<param name="address">The URL of the resource to download.</param>
<param name="settings">The settings.</param>
<returns>The path to the downloaded file.</returns>
</member>
<member name="M:Cake.Common.Net.HttpAliases.DownloadFile(Cake.Core.ICakeContext,System.Uri)">
<summary>
Downloads the specified resource over HTTP to a temporary file.
</summary>
<example>
<code>
var address = new Uri("http://www.example.org/index.html");
var resource = DownloadFile(address);
</code>
</example>
<param name="context">The context.</param>
<param name="address">The URL of file to download.</param>
<returns>The path to the downloaded file.</returns>
</member>
<member name="M:Cake.Common.Net.HttpAliases.DownloadFile(Cake.Core.ICakeContext,System.Uri,Cake.Common.Net.DownloadFileSettings)">
<summary>
Downloads the specified resource over HTTP to a temporary file with specified settings.
</summary>
<example>
<code>
var address = new Uri("http://www.example.org/index.html");
var resource = DownloadFile(address, new DownloadFileSettings()
{
Username = "bob",
Password = "builder"
});
</code>
</example>
<param name="context">The context.</param>
<param name="address">The URL of file to download.</param>
<param name="settings">The settings.</param>
<returns>The path to the downloaded file.</returns>
</member>
<member name="M:Cake.Common.Net.HttpAliases.DownloadFile(Cake.Core.ICakeContext,System.String,Cake.Core.IO.FilePath)">
<summary>
Downloads the specified resource over HTTP to the specified output path.
</summary>
<example>
<code>
var outputPath = File("./index.html");
DownloadFile("http://www.example.org/index.html", outputPath);
</code>
</example>
<param name="context">The context.</param>
<param name="address">The URL of the resource to download.</param>
<param name="outputPath">The output path.</param>
</member>
<member name="M:Cake.Common.Net.HttpAliases.DownloadFile(Cake.Core.ICakeContext,System.String,Cake.Core.IO.FilePath,Cake.Common.Net.DownloadFileSettings)">
<summary>
Downloads the specified resource over HTTP to the specified output path and settings.
</summary>
<example>
<code>
var outputPath = File("./index.html");
DownloadFile("http://www.example.org/index.html", outputPath, new DownloadFileSettings()
{
Username = "bob",
Password = "builder"
});
</code>
</example>
<param name="context">The context.</param>
<param name="address">The URL of the resource to download.</param>
<param name="outputPath">The output path.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Net.HttpAliases.DownloadFile(Cake.Core.ICakeContext,System.Uri,Cake.Core.IO.FilePath,Cake.Common.Net.DownloadFileSettings)">
<summary>
Downloads the specified resource over HTTP to the specified output path.
</summary>
<example>
<code>
var address = new Uri("http://www.example.org/index.html");
var outputPath = File("./index.html");
DownloadFile(address, outputPath, new DownloadFileSettings()
{
Username = "bob",
Password = "builder"
});
</code>
</example>
<param name="context">The context.</param>
<param name="address">The URL of the resource to download.</param>
<param name="outputPath">The output path.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Net.HttpAliases.UploadFile(Cake.Core.ICakeContext,System.Uri,Cake.Core.IO.FilePath,Cake.Common.Net.UploadFileSettings)">
<summary>
Uploads the specified file via a HTTP POST to the specified uri using multipart/form-data.
</summary>
<example>
<code>
var address = new Uri("http://www.example.org/upload");
UploadFile(address, @"path/to/file.txt", new UploadFileSettings()
{
Username = "bob",
Password = "builder"
}
</code>
</example>
<param name="context">The context.</param>
<param name="address">The URL of the upload resource.</param>
<param name="filePath">The file to upload.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Net.HttpAliases.UploadFile(Cake.Core.ICakeContext,System.String,Cake.Core.IO.FilePath)">
<summary>
Uploads the specified file via a HTTP POST to the specified uri using multipart/form-data.
</summary>
<example>
<code>
var address = "http://www.example.org/upload";
UploadFile(address, @"path/to/file.txt");
</code>
</example>
<param name="context">The context.</param>
<param name="address">The URL of the upload resource.</param>
<param name="filePath">The file to upload.</param>
</member>
<member name="M:Cake.Common.Net.HttpAliases.UploadFile(Cake.Core.ICakeContext,System.Uri,System.Byte[],System.String,Cake.Common.Net.UploadFileSettings)">
<summary>
Uploads the specified byte array via a HTTP POST to the specified uri using multipart/form-data.
</summary>
<example>
<code>
var address = new Uri("http://www.example.org/upload");
UploadFile(address, @"path/to/file.txt", new UploadFileSettings() {
Username = "bob",
Password = "builder"
});
</code>
</example>
<param name="context">The context.</param>
<param name="address">The URL of the upload resource.</param>
<param name="data">The data to upload.</param>
<param name="fileName">The filename to give the uploaded data.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Net.HttpAliases.UploadFile(Cake.Core.ICakeContext,System.String,System.Byte[],System.String)">
<summary>
Uploads the specified byte array via a HTTP POST to the specified uri using multipart/form-data.
</summary>
<example>
<code>
var address = "http://www.example.org/upload";
UploadFile(address, @"path/to/file.txt");
</code>
</example>
<param name="context">The context.</param>
<param name="address">The URL of the upload resource.</param>
<param name="data">The data to upload.</param>
<param name="fileName">The filename to give the uploaded data.</param>
</member>
<member name="M:Cake.Common.Net.HttpAliases.GetHttpClient(Cake.Core.ICakeContext,System.Boolean)">
<summary>
Gets an <see cref="T:System.Net.Http.HttpClient"/> pre-populated with the correct default headers such as User-Agent.
The returned client should be disposed of by the caller.
</summary>
<param name="context">The current Cake context.</param>
<param name="useDefaultCredentials">Indicates whether or not to use default credentials.</param>
<returns>A <see cref="T:System.Net.Http.HttpClient"/> instance.</returns>
</member>
<member name="T:Cake.Common.Net.UploadFileSettings">
<summary>
Contains settings for <see cref="T:Cake.Common.Net.HttpAliases"/>.
</summary>
</member>
<member name="P:Cake.Common.Net.UploadFileSettings.Username">
<summary>
Gets or sets the username to use when uploadingthe file.
</summary>
</member>
<member name="P:Cake.Common.Net.UploadFileSettings.Password">
<summary>
Gets or sets the password to use when uploading the file.
</summary>
</member>
<member name="P:Cake.Common.Net.UploadFileSettings.UseDefaultCredentials">
<summary>
Gets or sets a value indicating whether default credentials are sent when uploading the file.
</summary>
<remarks>
If set to true, any username and password that has been specified will be ignored.
</remarks>
</member>
<member name="T:Cake.Common.Net.NamespaceDoc">
<summary>
This namespace contain types related
to security aspects such as hashing.
</summary>
</member>
<member name="T:Cake.Common.ProcessAliases">
<summary>
Contains functionality related to processes.
</summary>
</member>
<member name="M:Cake.Common.ProcessAliases.StartProcess(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Starts the process resource that is specified by the filename.
</summary>
<param name="context">The context.</param>
<param name="fileName">The file name.</param>
<returns>The exit code that the started process specified when it terminated.</returns>
<example>
<code>
var exitCodeWithoutArguments = StartProcess("ping");
// This should output 1 as argument is missing
Information("Exit code: {0}", exitCodeWithoutArguments);
</code>
</example>
</member>
<member name="M:Cake.Common.ProcessAliases.StartProcess(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,System.String)">
<summary>
Starts the process resource that is specified by the filename and arguments.
</summary>
<param name="context">The context.</param>
<param name="fileName">Name of the file.</param>
<param name="processArguments">The arguments used in the process settings.</param>
<returns>The exit code that the started process specified when it terminated.</returns>
<example>
<code>
var exitCodeWithArgument = StartProcess("ping", "localhost");
// This should output 0 as valid arguments supplied
Information("Exit code: {0}", exitCodeWithArgument);
</code>
</example>
</member>
<member name="M:Cake.Common.ProcessAliases.StartProcess(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Core.IO.ProcessSettings)">
<summary>
Starts the process resource that is specified by the filename and settings.
</summary>
<param name="context">The context.</param>
<param name="fileName">Name of the file.</param>
<param name="settings">The settings.</param>
<returns>The exit code that the started process specified when it terminated.</returns>
<example>
<code>
var exitCodeWithArgument = StartProcess("ping", new ProcessSettings{ Arguments = "localhost" });
// This should output 0 as valid arguments supplied
Information("Exit code: {0}", exitCodeWithArgument);
</code>
</example>
</member>
<member name="M:Cake.Common.ProcessAliases.StartProcess(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Core.IO.ProcessSettings,System.Collections.Generic.IEnumerable{System.String}@)">
<summary>
Starts the process resource that is specified by the filename and settings.
</summary>
<param name="context">The context.</param>
<param name="fileName">Name of the file.</param>
<param name="settings">The settings.</param>
<param name="redirectedStandardOutput">Returns process output if <see cref="P:Cake.Core.IO.ProcessSettings.RedirectStandardOutput"/> is true.
Otherwise <c>null</c> is returned.</param>
<returns>The exit code that the started process specified when it terminated.</returns>
<example>
<code>
IEnumerable<string> redirectedStandardOutput;
var exitCodeWithArgument =
StartProcess(
"ping",
new ProcessSettings {
Arguments = "localhost",
RedirectStandardOutput = true
},
out redirectedStandardOutput
);
// Output last line of process output.
Information("Last line of output: {0}", redirectedStandardOutput.LastOrDefault());
// This should output 0 as valid arguments supplied
Information("Exit code: {0}", exitCodeWithArgument);
</code>
</example>
</member>
<member name="M:Cake.Common.ProcessAliases.StartProcess(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Core.IO.ProcessSettings,System.Collections.Generic.IEnumerable{System.String}@,System.Collections.Generic.IEnumerable{System.String}@)">
<summary>
Starts the process resource that is specified by the filename and settings.
</summary>
<param name="context">The context.</param>
<param name="fileName">Name of the file.</param>
<param name="settings">The settings.</param>
<param name="redirectedStandardOutput">Returns process output if <see cref="P:Cake.Core.IO.ProcessSettings.RedirectStandardOutput"/> is true.
Otherwise <c>null</c> is returned.</param>
<param name="redirectedErrorOutput">Returns process error output if <see cref="P:Cake.Core.IO.ProcessSettings.RedirectStandardError"/> is true.
Otherwise <c>null</c> is returned.</param>
<returns>The exit code that the started process specified when it terminated.</returns>
<example>
<code>
IEnumerable<string> redirectedStandardOutput;
IEnumerable<string> redirectedErrorOutput;
var exitCodeWithArgument =
StartProcess(
"ping",
new ProcessSettings {
Arguments = "localhost",
RedirectStandardOutput = true,
RedirectStandardError = true
},
out redirectedStandardOutput,
out redirectedErrorOutput
);
// Output last line of process output.
Information("Last line of output: {0}", redirectedStandardOutput.LastOrDefault());
// Throw exception if anything was written to the standard error.
if (redirectedErrorOutput.Any())
{
throw new Exception(
string.Format(
"Errors occurred: {0}",
string.Join(", ", redirectedErrorOutput)));
}
// This should output 0 as valid arguments supplied
Information("Exit code: {0}", exitCodeWithArgument);
</code>
</example>
</member>
<member name="M:Cake.Common.ProcessAliases.StartAndReturnProcess(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Core.IO.ProcessSettings)">
<summary>
Starts the process resource that is specified by the filename and settings.
</summary>
<param name="context">The context.</param>
<param name="fileName">Name of the file.</param>
<param name="settings">The settings.</param>
<returns>The newly started process.</returns>
<example>
<code>
using(var process = StartAndReturnProcess("ping", new ProcessSettings{ Arguments = "localhost" }))
{
process.WaitForExit();
// This should output 0 as valid arguments supplied
Information("Exit code: {0}", process.GetExitCode());
}
</code>
</example>
<exception cref="T:System.ArgumentNullException"><paramref name="context"/>, <paramref name="fileName"/>, or <paramref name="settings"/> is null.</exception>
</member>
<member name="M:Cake.Common.ProcessAliases.StartAndReturnProcess(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Starts the process resource that is specified by the filename.
</summary>
<param name="context">The context.</param>
<param name="fileName">Name of the file.</param>
<returns>The newly started process.</returns>
<example>
<code>
using(var process = StartAndReturnProcess("ping"))
{
process.WaitForExit();
// This should output 0 as valid arguments supplied
Information("Exit code: {0}", process.GetExitCode());
}
</code>
</example>
<exception cref="T:System.ArgumentNullException"><paramref name="context"/>, <paramref name="fileName"/> is null.</exception>
</member>
<member name="T:Cake.Common.NamespaceDoc">
<summary>
This namespace contain types used for common operations
such as parsing release notes, retrieving arguments and
to read and write environment variables.
</summary>
</member>
<member name="T:Cake.Common.Solution.NamespaceDoc">
<summary>
This namespace contain types that
support interaction with MSBuild solution files.
</summary>
</member>
<member name="T:Cake.Common.Solution.Project.NamespaceDoc">
<summary>
This namespace contain types that
support interaction with MSBuild project files.
</summary>
</member>
<member name="T:Cake.Common.Solution.Project.Properties.NamespaceDoc">
<summary>
This namespace contain types that
enable you to read or create assembly information files.
</summary>
</member>
<member name="T:Cake.Common.Solution.Project.Properties.AssemblyInfoAliases">
<summary>
Contains functionality related to assembly info.
</summary>
</member>
<member name="M:Cake.Common.Solution.Project.Properties.AssemblyInfoAliases.CreateAssemblyInfo(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Common.Solution.Project.Properties.AssemblyInfoSettings)">
<summary>
Creates an assembly information file.
</summary>
<param name="context">The context.</param>
<param name="outputPath">The output path.</param>
<param name="settings">The settings.</param>
<example>
<code>
var file = "./SolutionInfo.cs";
var version = "0.0.1";
var buildNo = "123";
var semVersion = string.Concat(version + "-" + buildNo);
CreateAssemblyInfo(file, new AssemblyInfoSettings {
Product = "SampleProject",
Version = version,
FileVersion = version,
InformationalVersion = semVersion,
Copyright = string.Format("Copyright (c) Contoso 2014 - {0}", DateTime.Now.Year)
});
</code>
</example>
</member>
<member name="M:Cake.Common.Solution.Project.Properties.AssemblyInfoAliases.ParseAssemblyInfo(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Parses an existing assembly information file.
</summary>
<param name="context">The context.</param>
<param name="assemblyInfoPath">The assembly info path.</param>
<returns>The content of the assembly info file.</returns>
<example>
<code>
var assemblyInfo = ParseAssemblyInfo("./SolutionInfo.cs");
Information("Version: {0}", assemblyInfo.AssemblyVersion);
Information("File version: {0}", assemblyInfo.AssemblyFileVersion);
Information("Informational version: {0}", assemblyInfo.AssemblyInformationalVersion);
</code>
</example>
</member>
<member name="T:Cake.Common.Solution.Project.Properties.AssemblyInfoCreator">
<summary>
The assembly info creator.
</summary>
</member>
<member name="M:Cake.Common.Solution.Project.Properties.AssemblyInfoCreator.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.Diagnostics.ICakeLog)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Solution.Project.Properties.AssemblyInfoCreator"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="log">The log.</param>
</member>
<member name="M:Cake.Common.Solution.Project.Properties.AssemblyInfoCreator.Create(Cake.Core.IO.FilePath,Cake.Common.Solution.Project.Properties.AssemblyInfoSettings,System.String,System.String,System.String,System.String,System.String,System.String)">
<summary>
Creates an assembly info file.
</summary>
<param name="outputPath">The output path.</param>
<param name="settings">The settings.</param>
<param name="attributeFormat">The attribute format.</param>
<param name="attributeWithValueFormat">The attribute with value format.</param>
<param name="attributeWithKeyValueFormat">The attribute with key value format.</param>
<param name="vbAttributeFormat">The VB attribute format.</param>
<param name="vbAttributeWithValueFormat">The VB attribute with value format.</param>
<param name="vbAttributeWithKeyValueFormat">The VB attribute with key value format.</param>
</member>
<member name="T:Cake.Common.Solution.Project.Properties.AssemblyInfoCustomAttribute">
<summary>
Custom Attribute class used by <see cref="T:Cake.Common.Solution.Project.Properties.AssemblyInfoSettings"/>.
</summary>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoCustomAttribute.Name">
<summary>
Gets or sets the name.
</summary>
<value>The attribute name.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoCustomAttribute.NameSpace">
<summary>
Gets or sets the namespace.
</summary>
<value>The namespace for the attribute.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoCustomAttribute.Value">
<summary>
Gets or sets the value.
</summary>
<value>The value for the attribute.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoCustomAttribute.UseRawValue">
<summary>
Gets or sets a value indicating whether the value is raw or should be quoted in the created attribute.
</summary>
<value>
<c>true</c> if should be treated as raw; otherwise, <c>false</c>.
</value>
</member>
<member name="T:Cake.Common.Solution.Project.Properties.AssemblyInfoMetadataAttribute">
<summary>
Metadata Attribute class used by <see cref="T:Cake.Common.Solution.Project.Properties.AssemblyInfoSettings"/>.
</summary>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoMetadataAttribute.Name">
<summary>
Gets the name.
</summary>
<value>The attribute name.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoMetadataAttribute.Key">
<summary>
Gets or sets the key for meta data.
</summary>
<value>The key for meta data.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoMetadataAttribute.NameSpace">
<summary>
Gets the namespace.
</summary>
<value>The namespace for the meta data attribute.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoMetadataAttribute.Value">
<summary>
Gets or sets the value.
</summary>
<value>The value for the meta data.</value>
</member>
<member name="T:Cake.Common.Solution.Project.Properties.AssemblyInfoParser">
<summary>
The assembly info parser.
</summary>
</member>
<member name="M:Cake.Common.Solution.Project.Properties.AssemblyInfoParser.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Solution.Project.Properties.AssemblyInfoParser"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
</member>
<member name="M:Cake.Common.Solution.Project.Properties.AssemblyInfoParser.Parse(Cake.Core.IO.FilePath)">
<summary>
Parses information from an assembly info file.
</summary>
<param name="assemblyInfoPath">The file path.</param>
<returns>Information about the assembly info content.</returns>
</member>
<member name="T:Cake.Common.Solution.Project.Properties.AssemblyInfoParseResult">
<summary>
Represents the content in an assembly info file.
</summary>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoParseResult.ClsCompliant">
<summary>
Gets a value indicating whether the assembly is CLS compliant.
</summary>
<value>
<c>true</c> if the assembly is CLS compliant; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoParseResult.Company">
<summary>
Gets the assembly company attribute.
</summary>
<value>The assembly company attribute.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoParseResult.ComVisible">
<summary>
Gets a value indicating whether the assembly is accessible from COM.
</summary>
<value>
<c>true</c> if the assembly is accessible from COM; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoParseResult.Configuration">
<summary>
Gets the assembly configuration attribute.
</summary>
<value>The assembly Configuration attribute.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoParseResult.Copyright">
<summary>
Gets the assembly copyright attribute.
</summary>
<value>The assembly copyright attribute.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoParseResult.Description">
<summary>
Gets the assembly's description attribute.
</summary>
<value>The assembly's Description attribute.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoParseResult.AssemblyFileVersion">
<summary>
Gets the assembly file version.
</summary>
<value>The assembly file version.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoParseResult.Guid">
<summary>
Gets the assembly GUID attribute.
</summary>
<value>The assembly GUID attribute.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoParseResult.AssemblyInformationalVersion">
<summary>
Gets the assembly informational version.
</summary>
<value>The assembly informational version.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoParseResult.Product">
<summary>
Gets the assembly product Attribute.
</summary>
<value>The assembly product attribute.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoParseResult.Title">
<summary>
Gets the assembly title Attribute.
</summary>
<value>The assembly Title attribute.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoParseResult.Trademark">
<summary>
Gets the assembly trademark Attribute.
</summary>
<value>The assembly Trademark attribute.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoParseResult.AssemblyVersion">
<summary>
Gets the assembly version.
</summary>
<value>The assembly version.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoParseResult.InternalsVisibleTo">
<summary>
Gets the assemblies that internals are visible to.
</summary>
<value>The assemblies that internals are visible to.</value>
</member>
<member name="M:Cake.Common.Solution.Project.Properties.AssemblyInfoParseResult.#ctor(System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.Collections.Generic.IEnumerable{System.String})">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Solution.Project.Properties.AssemblyInfoParseResult"/> class.
</summary>
<param name="clsCompliant">Whether the assembly is CLS compliant.</param>
<param name="company">The assembly company attribute.</param>
<param name="comVisible">Whether the assembly is accessible from COM.</param>
<param name="configuration">The assembly configuration attribute.</param>
<param name="copyright">The assembly copyright attribute.</param>
<param name="description">The assembly description attribute.</param>
<param name="assemblyFileVersion">The assembly file version.</param>
<param name="guid">The assembly GUID attribute.</param>
<param name="assemblyInformationalVersion">The assembly informational version.</param>
<param name="product">The assembly product attribute.</param>
<param name="title">The assembly title attribute.</param>
<param name="trademark">The assembly trademark attribute.</param>
<param name="assemblyVersion">The assembly version.</param>
<param name="internalsVisibleTo">The assemblies that internals are visible to.</param>
</member>
<member name="T:Cake.Common.Solution.Project.Properties.AssemblyInfoSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Solution.Project.Properties.AssemblyInfoCreator"/>.
</summary>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoSettings.Title">
<summary>
Gets or sets the title.
</summary>
<value>The assembly title.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoSettings.Description">
<summary>
Gets or sets the description.
</summary>
<value>The assembly description.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoSettings.Guid">
<summary>
Gets or sets the unique identifier.
</summary>
<value>The unique identifier.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoSettings.Product">
<summary>
Gets or sets the product.
</summary>
<value>The assembly product.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoSettings.Copyright">
<summary>
Gets or sets the copyright.
</summary>
<value>The copyright.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoSettings.Trademark">
<summary>
Gets or sets the trademark.
</summary>
<value>The trademark.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoSettings.Version">
<summary>
Gets or sets the version.
</summary>
<value>The version.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoSettings.FileVersion">
<summary>
Gets or sets the file version.
</summary>
<value>The file version.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoSettings.InformationalVersion">
<summary>
Gets or sets the informational version.
</summary>
<value>The informational version.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoSettings.ComVisible">
<summary>
Gets or sets whether or not the assembly is COM visible.
</summary>
<value>Whether or not the assembly is COM visible.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoSettings.CLSCompliant">
<summary>
Gets or sets whether or not the assembly is CLS compliant.
</summary>
<value>Whether or not the assembly is CLS compliant.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoSettings.Company">
<summary>
Gets or sets the company.
</summary>
<value>The company.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoSettings.InternalsVisibleTo">
<summary>
Gets or sets the name(s) of the assembly(s) that internals should be visible to.
</summary>
<value>The name(s) of the assembly(s).</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoSettings.Configuration">
<summary>
Gets or sets the configuration of the assembly.
</summary>
<value>The configuration.</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoSettings.CustomAttributes">
<summary>
Gets or sets the custom attribute(s) that should be added to the assembly info file.
</summary>
<value>The namespace(s).</value>
</member>
<member name="P:Cake.Common.Solution.Project.Properties.AssemblyInfoSettings.MetaDataAttributes">
<summary>
Gets or sets the meta data attribute(s) that should be added to the assembly info file.
</summary>
<value>The meta data.</value>
</member>
<member name="T:Cake.Common.Solution.Project.Properties.AssemblyInfoSettingsExtensions">
<summary>
Contains functionality related to AssemblyInfo settings.
</summary>
</member>
<member name="M:Cake.Common.Solution.Project.Properties.AssemblyInfoSettingsExtensions.AddCustomAttribute(Cake.Common.Solution.Project.Properties.AssemblyInfoSettings,System.String,System.String,System.String)">
<summary>
Adds a custom attribute to the AssemblyInfo settings.
</summary>
<param name="settings">The settings.</param>
<param name="name">The name of the custom attribute.</param>
<param name="namespace">The namespace for the custom attribute.</param>
<param name="value">The value for the attribute.</param>
<returns>The same <see cref="T:Cake.Common.Solution.Project.Properties.AssemblyInfoSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Solution.Project.Properties.AssemblyInfoSettingsExtensions.AddMetadataAttribute(Cake.Common.Solution.Project.Properties.AssemblyInfoSettings,System.String,System.String)">
<summary>
Adds a meta data attribute to the AssemblyInfo settings.
</summary>
<param name="settings">The settings.</param>
<param name="key">The key of the meta data attribute.</param>
<param name="value">The value for the attribute.</param>
<returns>The same <see cref="T:Cake.Common.Solution.Project.Properties.AssemblyInfoSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="T:Cake.Common.Solution.Project.XmlDoc.NamespaceDoc">
<summary>
This namespace contain types that
enable you to read XML documentation comments.
</summary>
</member>
<member name="T:Cake.Common.Solution.Project.XmlDoc.XmlDocAliases">
<summary>
Contains functionality related to MSBuild XML document files.
</summary>
</member>
<member name="M:Cake.Common.Solution.Project.XmlDoc.XmlDocAliases.ParseXmlDocExampleCode(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Parses Xml documentation example code from given path.
</summary>
<param name="context">The context.</param>
<param name="xmlFilePath">The Path to the file to parse.</param>
<returns>Parsed example code.</returns>
<example>
<code>
var exampleCodes = ParseXmlDocExampleCode("./Cake.Common.xml");
foreach(var exampleCode in exampleCodes)
{
Information(
"{0}\r\n{1}",
exampleCode.Name,
exampleCode.Code
);
}
</code>
</example>
</member>
<member name="M:Cake.Common.Solution.Project.XmlDoc.XmlDocAliases.ParseXmlDocFilesExampleCode(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern)">
<summary>
Parses Xml documentation example code from file(s) using given pattern.
</summary>
<param name="context">The context.</param>
<param name="pattern">The globber file pattern.</param>
<returns>Parsed example code.</returns>
<example>
<code>
var filesExampleCodes = ParseXmlDocFilesExampleCode("./Cake.*.xml");
foreach(var exampleCode in filesExampleCodes)
{
Information(
"{0}\r\n{1}",
exampleCode.Name,
exampleCode.Code
);
}
</code>
</example>
</member>
<member name="T:Cake.Common.Solution.Project.XmlDoc.XmlDocExampleCode">
<summary>
Parsed Xml documentation example code.
</summary>
</member>
<member name="P:Cake.Common.Solution.Project.XmlDoc.XmlDocExampleCode.Name">
<summary>
Gets Example code parent name.
</summary>
</member>
<member name="P:Cake.Common.Solution.Project.XmlDoc.XmlDocExampleCode.Code">
<summary>
Gets Example code.
</summary>
</member>
<member name="M:Cake.Common.Solution.Project.XmlDoc.XmlDocExampleCode.#ctor(System.String,System.String)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Solution.Project.XmlDoc.XmlDocExampleCode"/> class.
</summary>
<param name="name">The name of code parent.</param>
<param name="code">The example code.</param>
</member>
<member name="T:Cake.Common.Solution.Project.XmlDoc.XmlDocExampleCodeParser">
<summary>
The MSBuild Xml documentation example code parser.
</summary>
</member>
<member name="M:Cake.Common.Solution.Project.XmlDoc.XmlDocExampleCodeParser.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.IO.IGlobber,Cake.Core.Diagnostics.ICakeLog)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Solution.Project.XmlDoc.XmlDocExampleCodeParser"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="globber">The globber.</param>
<param name="log">The log.</param>
</member>
<member name="M:Cake.Common.Solution.Project.XmlDoc.XmlDocExampleCodeParser.Parse(Cake.Core.IO.FilePath)">
<summary>
Parses Xml documentation example code from given path.
</summary>
<param name="xmlFilePath">Path to the file to parse.</param>
<returns>Parsed Example Code.</returns>
</member>
<member name="M:Cake.Common.Solution.Project.XmlDoc.XmlDocExampleCodeParser.ParseFiles(Cake.Core.IO.GlobPattern)">
<summary>
Parses Xml documentation example code from file(s) using given pattern.
</summary>
<param name="pattern">The globber file pattern.</param>
<returns>Parsed Example Code.</returns>
</member>
<member name="T:Cake.Common.Solution.Project.ProjectAliases">
<summary>
Contains functionality related to MSBuild project files.
</summary>
</member>
<member name="M:Cake.Common.Solution.Project.ProjectAliases.ParseProject(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Parses project information from project file.
</summary>
<param name="context">The context.</param>
<param name="projectPath">The project file path.</param>
<returns>A parsed project.</returns>
<example>
<code>
var parsedProject = ParseProject("./src/Cake/Cake.csproj");
Information(
@" Parsed project file:
Configuration : {0}
Platform : {1}
OutputType : {2}
OutputPath : {3}
RootNameSpace : {4}
AssemblyName : {5}
TargetFrameworkVersion: {6}
Files : {7}",
parsedProject.Configuration,
parsedProject.Platform,
parsedProject.OutputType,
parsedProject.OutputPath,
parsedProject.RootNameSpace,
parsedProject.AssemblyName,
parsedProject.TargetFrameworkVersion,
string.Concat(
parsedProject
.Files
.Select(
file=> string.Format(
"\r\n {0}",
file.FilePath
)
)
)
);
</code>
</example>
</member>
<member name="T:Cake.Common.Solution.Project.ProjectAssemblyReference">
<summary>
Represents a project assembly reference.
</summary>
<remarks>
Schema from https://msdn.microsoft.com/en-us/library/ms164283.aspx
and https://msdn.microsoft.com/en-us/library/bb629388.aspx.
</remarks>
</member>
<member name="P:Cake.Common.Solution.Project.ProjectAssemblyReference.Include">
<summary>
Gets or sets the reference to include.
</summary>
<value>
The reference to include.
</value>
</member>
<member name="P:Cake.Common.Solution.Project.ProjectAssemblyReference.HintPath">
<summary>
Gets or sets the relative or absolute path of the assembly.
</summary>
<value>
The relative or absolute path of the assembly.
</value>
</member>
<member name="P:Cake.Common.Solution.Project.ProjectAssemblyReference.Name">
<summary>
Gets or sets the display name of the assembly.
</summary>
<value>
The display name of the assembly.
</value>
</member>
<member name="P:Cake.Common.Solution.Project.ProjectAssemblyReference.FusionName">
<summary>
Gets or sets the simple or strong fusion name for the item.
</summary>
<value>
The simple or strong fusion name for the item.
</value>
</member>
<member name="P:Cake.Common.Solution.Project.ProjectAssemblyReference.SpecificVersion">
<summary>
Gets or sets whether only the version in the fusion name should be referenced.
</summary>
<value>
Whether only the version in the fusion name should be referenced.
</value>
</member>
<member name="P:Cake.Common.Solution.Project.ProjectAssemblyReference.Aliases">
<summary>
Gets or sets any aliases for the reference.
</summary>
<value>
Any aliases for the reference.
</value>
</member>
<member name="P:Cake.Common.Solution.Project.ProjectAssemblyReference.Private">
<summary>
Gets or sets whether the reference should be copied to the output folder.
</summary>
<value>
Whether the reference should be copied to the output folder.
</value>
</member>
<member name="T:Cake.Common.Solution.Project.ProjectFile">
<summary>
Represents a MSBuild project file.
</summary>
</member>
<member name="P:Cake.Common.Solution.Project.ProjectFile.FilePath">
<summary>
Gets or sets the project file path.
</summary>
<value>The project file path.</value>
</member>
<member name="P:Cake.Common.Solution.Project.ProjectFile.RelativePath">
<summary>
Gets or sets the relative path to the project file.
</summary>
<value>
The relative path to the project file.
</value>
</member>
<member name="P:Cake.Common.Solution.Project.ProjectFile.Compile">
<summary>
Gets or sets a value indicating whether this <see cref="T:Cake.Common.Solution.Project.ProjectFile"/> is compiled.
</summary>
<value>
<c>true</c> if compiled; otherwise, <c>false</c>.
</value>
</member>
<member name="T:Cake.Common.Solution.Project.ProjectParser">
<summary>
The MSBuild project file parser.
</summary>
</member>
<member name="M:Cake.Common.Solution.Project.ProjectParser.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Solution.Project.ProjectParser"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
</member>
<member name="M:Cake.Common.Solution.Project.ProjectParser.Parse(Cake.Core.IO.FilePath)">
<summary>
Parses a project file.
</summary>
<param name="projectPath">The project path.</param>
<returns>The parsed project.</returns>
</member>
<member name="T:Cake.Common.Solution.Project.ProjectParserResult">
<summary>
Represents the content in an MSBuild project file.
</summary>
</member>
<member name="P:Cake.Common.Solution.Project.ProjectParserResult.Configuration">
<summary>
Gets the build configuration.
</summary>
<value>The build configuration.</value>
</member>
<member name="P:Cake.Common.Solution.Project.ProjectParserResult.Platform">
<summary>
Gets the target platform.
</summary>
<value>The platform.</value>
</member>
<member name="P:Cake.Common.Solution.Project.ProjectParserResult.ProjectGuid">
<summary>
Gets the unique project identifier.
</summary>
<value>The unique project identifier.</value>
</member>
<member name="P:Cake.Common.Solution.Project.ProjectParserResult.OutputType">
<summary>
Gets the compiler output type, i.e. <c>Exe/Library</c>.
</summary>
<value>The output type.</value>
</member>
<member name="P:Cake.Common.Solution.Project.ProjectParserResult.OutputPath">
<summary>
Gets the compiler output path.
</summary>
<value>The output path.</value>
</member>
<member name="P:Cake.Common.Solution.Project.ProjectParserResult.RootNameSpace">
<summary>
Gets the default root namespace.
</summary>
<value>The root namespace.</value>
</member>
<member name="P:Cake.Common.Solution.Project.ProjectParserResult.AssemblyName">
<summary>
Gets the build target assembly name.
</summary>
<value>The assembly name.</value>
</member>
<member name="P:Cake.Common.Solution.Project.ProjectParserResult.TargetFrameworkVersion">
<summary>
Gets the compiler target framework version.
</summary>
<value>The target framework version.</value>
</member>
<member name="P:Cake.Common.Solution.Project.ProjectParserResult.TargetFrameworkProfile">
<summary>
Gets the compiler target framework profile.
</summary>
<value>The target framework profile.</value>
</member>
<member name="P:Cake.Common.Solution.Project.ProjectParserResult.Files">
<summary>
Gets the project content files.
</summary>
<value>The files.</value>
</member>
<member name="P:Cake.Common.Solution.Project.ProjectParserResult.References">
<summary>
Gets the references.
</summary>
<value>
The references.
</value>
</member>
<member name="P:Cake.Common.Solution.Project.ProjectParserResult.ProjectReferences">
<summary>
Gets the references to other projects.
</summary>
<value>
The references.
</value>
</member>
<member name="M:Cake.Common.Solution.Project.ProjectParserResult.#ctor(System.String,System.String,System.String,System.String,Cake.Core.IO.DirectoryPath,System.String,System.String,System.String,System.String,System.Collections.Generic.IEnumerable{Cake.Common.Solution.Project.ProjectFile},System.Collections.Generic.IEnumerable{Cake.Common.Solution.Project.ProjectAssemblyReference},System.Collections.Generic.IEnumerable{Cake.Common.Solution.Project.ProjectReference})">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Solution.Project.ProjectParserResult" /> class.
</summary>
<param name="configuration">The build configuration.</param>
<param name="platform">The target platform.</param>
<param name="projectGuid">The unique project identifier.</param>
<param name="outputType">The compiler output type.</param>
<param name="outputPath">The compiler output path.</param>
<param name="rootNameSpace">The default root namespace.</param>
<param name="assemblyName">Gets the build target assembly name.</param>
<param name="targetFrameworkVersion">The compiler framework version.</param>
<param name="targetFrameworkProfile">The compiler framework profile.</param>
<param name="files">The project content files.</param>
<param name="references">The references.</param>
<param name="projectReferences">The references to other projects.</param>
</member>
<member name="T:Cake.Common.Solution.Project.ProjectReference">
<summary>
Represents a project reference to another project.
</summary>
<remarks>
Schema from https://msdn.microsoft.com/en-us/library/ms164283.aspx
and https://msdn.microsoft.com/en-us/library/bb629388.aspx.
</remarks>
</member>
<member name="P:Cake.Common.Solution.Project.ProjectReference.FilePath">
<summary>
Gets or sets the path to the referenced project file.
</summary>
<value>
The path to the referenced project file.
</value>
</member>
<member name="P:Cake.Common.Solution.Project.ProjectReference.RelativePath">
<summary>
Gets or sets the relative path to the referenced project file.
</summary>
<value>
The relative path to the referenced project file.
</value>
</member>
<member name="P:Cake.Common.Solution.Project.ProjectReference.Name">
<summary>
Gets or sets the display name of the reference.
</summary>
<value>
The display name of the reference.
</value>
</member>
<member name="P:Cake.Common.Solution.Project.ProjectReference.Project">
<summary>
Gets or sets a GUID for the reference.
</summary>
<value>
A GUID for the reference.
</value>
</member>
<member name="P:Cake.Common.Solution.Project.ProjectReference.Package">
<summary>
Gets or sets the path of the project file that is being referenced.
</summary>
<value>
The path of the project file that is being referenced.
</value>
</member>
<member name="P:Cake.Common.Solution.Project.ProjectReference.Private">
<summary>
Gets or sets whether the reference should be copied to the output folder.
</summary>
<value>
Whether the reference should be copied to the output folder.
</value>
</member>
<member name="T:Cake.Common.Solution.Project.ProjectXElement">
<summary>
MSBuild Project Xml Element XNames.
</summary>
</member>
<member name="F:Cake.Common.Solution.Project.ProjectXElement.Project">
<summary>
Project root element.
</summary>
</member>
<member name="F:Cake.Common.Solution.Project.ProjectXElement.ItemGroup">
<summary>
Item group element.
</summary>
</member>
<member name="F:Cake.Common.Solution.Project.ProjectXElement.Reference">
<summary>
Assembly reference element.
</summary>
</member>
<member name="F:Cake.Common.Solution.Project.ProjectXElement.Import">
<summary>
Namespace import element.
</summary>
</member>
<member name="F:Cake.Common.Solution.Project.ProjectXElement.Compile">
<summary>
Namespace compile element.
</summary>
</member>
<member name="F:Cake.Common.Solution.Project.ProjectXElement.PropertyGroup">
<summary>
Namespace property group element.
</summary>
</member>
<member name="F:Cake.Common.Solution.Project.ProjectXElement.RootNamespace">
<summary>
Namespace root namespace element.
</summary>
</member>
<member name="F:Cake.Common.Solution.Project.ProjectXElement.OutputType">
<summary>
Namespace output type element.
</summary>
</member>
<member name="F:Cake.Common.Solution.Project.ProjectXElement.OutputPath">
<summary>
Namespace output path element.
</summary>
</member>
<member name="F:Cake.Common.Solution.Project.ProjectXElement.AssemblyName">
<summary>
Namespace assembly name element.
</summary>
</member>
<member name="F:Cake.Common.Solution.Project.ProjectXElement.TargetFrameworkVersion">
<summary>
Gets the namespace for the target framework version element.
</summary>
</member>
<member name="F:Cake.Common.Solution.Project.ProjectXElement.TargetFrameworkProfile">
<summary>
Gets the namespace for the target framework version element.
</summary>
</member>
<member name="F:Cake.Common.Solution.Project.ProjectXElement.Configuration">
<summary>
Gets the namespace for the configuration element.
</summary>
</member>
<member name="F:Cake.Common.Solution.Project.ProjectXElement.Platform">
<summary>
Gets the namespace for the platform element.
</summary>
</member>
<member name="F:Cake.Common.Solution.Project.ProjectXElement.ProjectGuid">
<summary>
Gets the namespace for the project GUID.
</summary>
</member>
<member name="F:Cake.Common.Solution.Project.ProjectXElement.BootstrapperPackage">
<summary>
Gets the namespace for the bootstrapper package element.
</summary>
</member>
<member name="F:Cake.Common.Solution.Project.ProjectXElement.ProjectReference">
<summary>
Gets the namespace for the project reference element.
</summary>
</member>
<member name="F:Cake.Common.Solution.Project.ProjectXElement.Service">
<summary>
Gets the namespace for the service element.
</summary>
</member>
<member name="F:Cake.Common.Solution.Project.ProjectXElement.HintPath">
<summary>
Gets the namespace for the hint path element.
</summary>
</member>
<member name="F:Cake.Common.Solution.Project.ProjectXElement.Name">
<summary>
Gets the namespace for the name element.
</summary>
</member>
<member name="F:Cake.Common.Solution.Project.ProjectXElement.FusionName">
<summary>
Gets the namespace for the fusion name element.
</summary>
</member>
<member name="F:Cake.Common.Solution.Project.ProjectXElement.SpecificVersion">
<summary>
Gets the namespace for the specific version element.
</summary>
</member>
<member name="F:Cake.Common.Solution.Project.ProjectXElement.Aliases">
<summary>
Gets the namespace for the aliases element.
</summary>
</member>
<member name="F:Cake.Common.Solution.Project.ProjectXElement.Private">
<summary>
Gets the namespace for the private element.
</summary>
</member>
<member name="F:Cake.Common.Solution.Project.ProjectXElement.Package">
<summary>
Gets the namespace for the package element.
</summary>
</member>
<member name="T:Cake.Common.Solution.SolutionAliases">
<summary>
Contains functionality related to MSBuild solution files.
</summary>
</member>
<member name="M:Cake.Common.Solution.SolutionAliases.ParseSolution(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Parses project information from a solution file.
</summary>
<param name="context">The context.</param>
<param name="solutionPath">The solution path.</param>
<returns>A parsed solution.</returns>
<example>
<code>
var solutionPath = "./src/Cake.sln";
Information("Parsing {0}", solutionPath);
var parsedSolution = ParseSolution(solutionPath);
foreach(var project in parsedSolution.Projects)
{
Information(
@"Solution project file:
Name: {0}
Path: {1}
Id : {2}
Type: {3}",
project.Name,
project.Path,
project.Id,
project.Type
);
}
</code>
</example>
</member>
<member name="T:Cake.Common.Solution.SolutionFolder">
<summary>
Represents a folder in a MSBuild solution.
</summary>
</member>
<member name="F:Cake.Common.Solution.SolutionFolder.TypeIdentifier">
<summary>
Visual Studio project type guid for solution folder.
</summary>
<remarks>
More information can be found http://www.codeproject.com/Reference/720512/List-of-Visual-Studio-Project-Type-GUIDs.
</remarks>
</member>
<member name="P:Cake.Common.Solution.SolutionFolder.Items">
<summary>
Gets Child items of this folder.
</summary>
</member>
<member name="M:Cake.Common.Solution.SolutionFolder.#ctor(System.String,System.String,Cake.Core.IO.FilePath)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Solution.SolutionFolder"/> class.
</summary>
<param name="id">The folder project identity.</param>
<param name="name">The folder name.</param>
<param name="path">The folder path.</param>
</member>
<member name="T:Cake.Common.Solution.SolutionParser">
<summary>
The MSBuild solution file parser.
</summary>
</member>
<member name="M:Cake.Common.Solution.SolutionParser.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Solution.SolutionParser"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
</member>
<member name="M:Cake.Common.Solution.SolutionParser.Parse(Cake.Core.IO.FilePath)">
<summary>
Parses a MSBuild solution.
</summary>
<param name="solutionPath">The solution path.</param>
<returns>A parsed solution.</returns>
</member>
<member name="T:Cake.Common.Solution.SolutionParserResult">
<summary>
Represents the content in an MSBuild solution file.
</summary>
</member>
<member name="P:Cake.Common.Solution.SolutionParserResult.Version">
<summary>
Gets the file format version.
</summary>
</member>
<member name="P:Cake.Common.Solution.SolutionParserResult.VisualStudioVersion">
<summary>
Gets the version of Visual Studio that created the file.
</summary>
</member>
<member name="P:Cake.Common.Solution.SolutionParserResult.MinimumVisualStudioVersion">
<summary>
Gets the minimum supported version of Visual Studio.
</summary>
</member>
<member name="P:Cake.Common.Solution.SolutionParserResult.Projects">
<summary>
Gets all solution projects.
</summary>
</member>
<member name="M:Cake.Common.Solution.SolutionParserResult.#ctor(System.String,System.String,System.String,System.Collections.Generic.IReadOnlyCollection{Cake.Common.Solution.SolutionProject})">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Solution.SolutionParserResult"/> class.
</summary>
<param name="version">The file format version.</param>
<param name="visualStudioVersion">The version of Visual Studio that created the file.</param>
<param name="minimumVisualStudioVersion">The minimum supported version of Visual Studio.</param>
<param name="projects">The solution projects.</param>
</member>
<member name="T:Cake.Common.Solution.SolutionProject">
<summary>
Represents a project in a MSBuild solution.
</summary>
</member>
<member name="P:Cake.Common.Solution.SolutionProject.Id">
<summary>
Gets the project identity.
</summary>
</member>
<member name="P:Cake.Common.Solution.SolutionProject.Name">
<summary>
Gets the project name.
</summary>
</member>
<member name="P:Cake.Common.Solution.SolutionProject.Path">
<summary>
Gets the project path.
</summary>
</member>
<member name="P:Cake.Common.Solution.SolutionProject.Type">
<summary>
Gets the project type identity.
</summary>
</member>
<member name="P:Cake.Common.Solution.SolutionProject.Parent">
<summary>
Gets the parent project if any, otherwise null.
</summary>
</member>
<member name="M:Cake.Common.Solution.SolutionProject.#ctor(System.String,System.String,Cake.Core.IO.FilePath,System.String)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Solution.SolutionProject"/> class.
</summary>
<param name="id">The project identity.</param>
<param name="name">The project name.</param>
<param name="path">The project path.</param>
<param name="type">The project type identity.</param>
</member>
<member name="T:Cake.Common.Text.NamespaceDoc">
<summary>
This namespace contain types for
text templating and transformations.
</summary>
</member>
<member name="T:Cake.Common.Text.TextTransformation`1">
<summary>
Provides functionality to perform simple text transformations
from a Cake build script and save them to disc.
</summary>
<typeparam name="TTemplate">The text transformation template.</typeparam>
</member>
<member name="P:Cake.Common.Text.TextTransformation`1.Template">
<summary>
Gets the text transformation template.
</summary>
<value>The text transformation template.</value>
</member>
<member name="M:Cake.Common.Text.TextTransformation`1.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,`0)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Text.TextTransformation`1"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="template">The text template.</param>
</member>
<member name="M:Cake.Common.Text.TextTransformation`1.Save(Cake.Core.IO.FilePath)">
<summary>
Saves the text transformation to a file.
</summary>
<param name="path">The <see cref="T:Cake.Core.IO.FilePath"/> to save the text transformation to.</param>
</member>
<member name="M:Cake.Common.Text.TextTransformation`1.Save(Cake.Core.IO.FilePath,System.Text.Encoding)">
<summary>
Saves the text transformation to a file.
</summary>
<param name="path">The <see cref="T:Cake.Core.IO.FilePath"/> to save the text transformation to.</param>
<param name="encoding">The text encoding.</param>
</member>
<member name="M:Cake.Common.Text.TextTransformation`1.ToString">
<summary>
Returns a string containing the rendered template.
</summary>
<returns>A string containing the rendered template.</returns>
</member>
<member name="T:Cake.Common.Text.TextTransformationAliases">
<summary>
Contains functionality related to text transformation.
</summary>
</member>
<member name="M:Cake.Common.Text.TextTransformationAliases.TransformText(Cake.Core.ICakeContext,System.String)">
<summary>
Creates a text transformation from the provided template.
</summary>
<param name="context">The context.</param>
<param name="template">The template.</param>
<returns>A <see cref="T:Cake.Common.Text.TextTransformation`1"/> representing the provided template.</returns>
<example>
This sample shows how to create a <see cref="T:Cake.Common.Text.TextTransformation`1"/> using
the specified template.
<code>
string text = TransformText("Hello <%subject%>!")
.WithToken("subject", "world")
.ToString();
</code>
</example>
</member>
<member name="M:Cake.Common.Text.TextTransformationAliases.TransformText(Cake.Core.ICakeContext,System.String,System.String,System.String)">
<summary>
Creates a text transformation from the provided template, using the specified placeholder.
</summary>
<param name="context">The context.</param>
<param name="template">The template.</param>
<param name="leftPlaceholder">The left placeholder.</param>
<param name="rightPlaceholder">The right placeholder.</param>
<returns>A <see cref="T:Cake.Common.Text.TextTransformation`1"/> representing the provided template.</returns>
<example>
This sample shows how to create a <see cref="T:Cake.Common.Text.TextTransformation`1"/> using
the specified template and placeholder.
<code>
string text = TransformText("Hello {subject}!", "{", "}")
.WithToken("subject", "world")
.ToString();
</code>
</example>
</member>
<member name="M:Cake.Common.Text.TextTransformationAliases.TransformTextFile(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Creates a text transformation from the provided template on disc.
</summary>
<param name="context">The context.</param>
<param name="path">The template file path.</param>
<returns>A <see cref="T:Cake.Common.Text.TextTransformation`1"/> representing the provided template.</returns>
<example>
This sample shows how to create a <see cref="T:Cake.Common.Text.TextTransformation`1"/> using
the specified template file with the placeholder format <c><%key%></c>.
<code>
string text = TransformTextFile("./template.txt")
.WithToken("subject", "world")
.ToString();
</code>
</example>
</member>
<member name="M:Cake.Common.Text.TextTransformationAliases.TransformTextFile(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,System.String,System.String)">
<summary>
Creates a text transformation from the provided template on disc, using the specified placeholder.
</summary>
<param name="context">The context.</param>
<param name="path">The template file path.</param>
<param name="leftPlaceholder">The left placeholder.</param>
<param name="rightPlaceholder">The right placeholder.</param>
<returns>A <see cref="T:Cake.Common.Text.TextTransformation`1"/> representing the provided template.</returns>
<example>
This sample shows how to create a <see cref="T:Cake.Common.Text.TextTransformation`1"/> using
the specified template file and placeholder.
<code>
string text = TransformTextFile("./template.txt", "{", "}")
.WithToken("subject", "world")
.ToString();
</code>
</example>
</member>
<member name="T:Cake.Common.Text.TextTransformationExtensions">
<summary>
Contains extension methods for <see cref="T:Cake.Common.Text.TextTransformation`1"/>.
</summary>
</member>
<member name="M:Cake.Common.Text.TextTransformationExtensions.WithToken``1(Cake.Common.Text.TextTransformation{``0},System.String,System.Object)">
<summary>
Registers a key and a value to be used with the text transformation.
</summary>
<typeparam name="TTemplate">The text transformation template.</typeparam>
<param name="transformation">The text transformation.</param>
<param name="key">The key.</param>
<param name="value">The value.</param>
<returns>
The same <see cref="T:Cake.Common.Text.TextTransformation`1" /> instance so that multiple calls can be chained.
</returns>
</member>
<member name="M:Cake.Common.Text.TextTransformationExtensions.WithTokens``1(Cake.Common.Text.TextTransformation{``0},System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.Object}})">
<summary>
Registers all keys and values in the enumerable for text transformation.
</summary>
<typeparam name="TTemplate">The text transformation template.</typeparam>
<param name="transformation">The text transformation.</param>
<param name="tokens">The tokens.</param>
<returns>
The same <see cref="T:Cake.Common.Text.TextTransformation`1" /> instance so that multiple calls can be chained.
</returns>
</member>
<member name="T:Cake.Common.Tools.NamespaceDoc">
<summary>
This namespace contain types used to interact
with different third party tools.
</summary>
</member>
<member name="T:Cake.Common.Tools.Cake.NamespaceDoc">
<summary>
This namespace contain types used to interact with Cake.
</summary>
</member>
<member name="T:Cake.Common.Tools.Cake.CakeAliases">
<summary>
Contains functionality related to running Cake scripts out of process.
</summary>
</member>
<member name="M:Cake.Common.Tools.Cake.CakeAliases.CakeExecuteScript(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Executes cake script out of process.
</summary>
<param name="context">The context.</param>
<param name="cakeScriptPath">The script file.</param>
<example>
<code>
CakeExecuteScript("./helloworld.cake");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Cake.CakeAliases.CakeExecuteScript(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Common.Tools.Cake.CakeSettings)">
<summary>
Executes cake script out of process.
</summary>
<param name="context">The context.</param>
<param name="cakeScriptPath">The script file.</param>
<param name="settings">The settings <see cref="T:Cake.Common.Tools.Cake.CakeSettings"/>.</param>
<example>
<code>
CakeExecuteScript("./helloworld.cake", new CakeSettings{ ToolPath="./Cake.exe" });
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Cake.CakeAliases.CakeExecuteExpression(Cake.Core.ICakeContext,System.String)">
<summary>
Executes Cake expression out of process.
</summary>
<param name="context">The context.</param>
<param name="cakeExpression">The cake expression.</param>
<example>
<code>
CakeExecuteExpression("Information(\"Hello {0}\", \"World\");");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Cake.CakeAliases.CakeExecuteExpression(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.Cake.CakeSettings)">
<summary>
Executes Cake expression out of process.
</summary>
<param name="context">The context.</param>
<param name="cakeExpression">The cake expression.</param>
<param name="settings">The settings <see cref="T:Cake.Common.Tools.Cake.CakeSettings"/>.</param>
<example>
<code>
CakeExecuteExpression(
"Information(\"Hello {0}!\", Argument<string>(\"name\"));",
new CakeSettings {
ToolPath="./Cake.exe" ,
Arguments = new Dictionary<string, string>{{"name", "World"}}
});
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.Cake.CakeRunner">
<summary>
Cake out process runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.Cake.CakeRunner.#cctor">
<summary>
Initializes static members of the <see cref="T:Cake.Common.Tools.Cake.CakeRunner"/> class.
</summary>
</member>
<member name="M:Cake.Common.Tools.Cake.CakeRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IGlobber,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.Cake.CakeRunner"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="globber">The globber.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.Cake.CakeRunner.ExecuteScript(Cake.Core.IO.FilePath,Cake.Common.Tools.Cake.CakeSettings)">
<summary>
Executes supplied cake script in own process and supplied settings.
</summary>
<param name="scriptPath">Path to script to execute.</param>
<param name="settings">optional cake settings.</param>
</member>
<member name="M:Cake.Common.Tools.Cake.CakeRunner.ExecuteExpression(System.String,Cake.Common.Tools.Cake.CakeSettings)">
<summary>
Executes supplied cake code expression in own process and supplied settings.
</summary>
<param name="cakeExpression">Code expression to execute.</param>
<param name="settings">optional cake settings.</param>
</member>
<member name="M:Cake.Common.Tools.Cake.CakeRunner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.Cake.CakeRunner.GetToolExecutableNames">
<summary>
Gets the name of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="M:Cake.Common.Tools.Cake.CakeRunner.GetAlternativeToolPaths(Cake.Common.Tools.Cake.CakeSettings)">
<summary>
Gets alternative file paths which the tool may exist in.
</summary>
<param name="settings">The settings.</param>
<returns>The default tool path.</returns>
</member>
<member name="T:Cake.Common.Tools.Cake.CakeSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.Cake.CakeRunner"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.Cake.CakeSettings.Verbosity">
<summary>
Gets or sets the output verbosity.
</summary>
<value>The output verbosity.</value>
</member>
<member name="P:Cake.Common.Tools.Cake.CakeSettings.Arguments">
<summary>
Gets or sets cake additional arguments.
</summary>
<value>The properties.</value>
</member>
<member name="T:Cake.Common.Tools.ILMerge.NamespaceDoc">
<summary>
This namespace contain types used to interact with ILMerge.
</summary>
</member>
<member name="T:Cake.Common.Tools.ILMerge.ILMergeAliases">
<summary>
<para>Contains functionality related to <see href="http://research.microsoft.com/en-us/people/mbarnett/ILMerge.aspx">ILMerge</see>.</para>
<para>
In order to use the commands for this alias, include the following in your build.cake file to download and
install from nuget.org, or specify the ToolPath within the <see cref="T:Cake.Common.Tools.ILMerge.ILMergeSettings" /> class:
<code>
#tool "nuget:?package=ilmerge"
</code>
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.ILMerge.ILMergeAliases.ILMerge(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Core.IO.FilePath,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath})">
<summary>
Merges the specified assemblies.
</summary>
<param name="context">The context.</param>
<param name="outputFile">The output file.</param>
<param name="primaryAssembly">The primary assembly.</param>
<param name="assemblyPaths">The assembly paths.</param>
<example>
<code>
var assemblyPaths = GetFiles("./**/Cake.*.dll");
ILMerge("./MergedCake.exe", "./Cake.exe", assemblyPaths);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.ILMerge.ILMergeAliases.ILMerge(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Core.IO.FilePath,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.ILMerge.ILMergeSettings)">
<summary>
Merges the specified assemblies.
</summary>
<param name="context">The context.</param>
<param name="outputFile">The output file.</param>
<param name="primaryAssembly">The primary assembly.</param>
<param name="assemblyPaths">The assembly paths.</param>
<param name="settings">The settings.</param>
<example>
<code>
var assemblyPaths = GetFiles("./**/Cake.*.dll");
ILMerge(
"./MergedCake.exe",
"./Cake.exe",
assemblyPaths,
new ILMergeSettings { Internalize = true });
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.ILMerge.ILMergeRunner">
<summary>
The ILMerge runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.ILMerge.ILMergeRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.ILMerge.ILMergeRunner" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.ILMerge.ILMergeRunner.Merge(Cake.Core.IO.FilePath,Cake.Core.IO.FilePath,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.ILMerge.ILMergeSettings)">
<summary>
Merges the specified assemblies.
</summary>
<param name="outputAssemblyPath">The output assembly path.</param>
<param name="primaryAssemblyPath">The primary assembly path.</param>
<param name="assemblyPaths">The assembly paths.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.ILMerge.ILMergeRunner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.ILMerge.ILMergeRunner.GetToolExecutableNames">
<summary>
Gets the name of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="T:Cake.Common.Tools.ILMerge.ILMergeSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.ILMerge.ILMergeRunner"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.ILMerge.ILMergeSettings.Internalize">
<summary>
Gets or sets a value indicating whether whether types in assemblies other
than the primary assembly should have their visibility modified to internal.
</summary>
<value>
<c>true</c> if types in assemblies other than the primary assembly should
have their visibility modified to internal; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.ILMerge.ILMergeSettings.TargetKind">
<summary>
Gets or sets the target kind.
</summary>
<value>The target kind.</value>
</member>
<member name="P:Cake.Common.Tools.ILMerge.ILMergeSettings.TargetPlatform">
<summary>
Gets or sets the target platform.
</summary>
<value>The target platform.</value>
</member>
<member name="P:Cake.Common.Tools.ILMerge.ILMergeSettings.DelaySign">
<summary>
Gets or sets a value indicating whether the target assembly will be
delay signed.
</summary>
<value>
<c>true</c> if target assembly will be delay signed; otherwise, <c>false</c>.
</value>
<remark>This can be set only in conjunction with the <see cref="P:Cake.Common.Tools.ILMerge.ILMergeSettings.KeyFile"/> option.</remark>
</member>
<member name="P:Cake.Common.Tools.ILMerge.ILMergeSettings.Closed">
<summary>
Gets or sets a value indicating whether the "transitive closure" of the
input assemblies is computed and added to the list of input assemblies.
</summary>
<value>
<c>true</c> if the "transitive closure" of the input assemblies is computed
and added to the list of input assemblies; otherwise, <c>false</c>.
</value>
<remark>
An assembly is considered part of the transitive closure if it is
referenced, either directly or indirectly, from one of the originally
specified input assemblies and it has an external reference to one of
the input assemblies, or one of the assemblies that has such a reference.
</remark>
</member>
<member name="P:Cake.Common.Tools.ILMerge.ILMergeSettings.NDebug">
<summary>
Gets or sets a value indicating whether a .pdb file for the output assembly
is generated and merges into it any .pdb files found for input assemblies.
</summary>
<value>
<c>true</c> if pdb file is generated for output assembly; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.ILMerge.ILMergeSettings.CopyAttributes">
<summary>
Gets or sets a value indicating whether the assembly level attributes of
each input assembly are copied over into the target assembly.
</summary>
<value>
<c>true</c> if the assembly level attributes are copied to target
assembly; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.ILMerge.ILMergeSettings.AllowMultiple">
<summary>
Gets or sets a value indicating whether you want to allow duplicates (for
those attributes whose type specifies "AllowMultiple" in their definition).
</summary>
<value>
<c>true</c> if duplicates are allowed; otherwise, <c>false</c>.
</value>
<remark>This can be set only in conjunction with the <see cref="P:Cake.Common.Tools.ILMerge.ILMergeSettings.CopyAttributes"/> option.</remark>
</member>
<member name="P:Cake.Common.Tools.ILMerge.ILMergeSettings.KeepFirst">
<summary>
Gets or sets a value indicating whether the first attribute that is found is kept.
</summary>
<value>
<c>true</c> if the first attribute that is found is kept; otherwise, <c>false</c>.
</value>
<remark>This can be set only in conjunction with the <see cref="P:Cake.Common.Tools.ILMerge.ILMergeSettings.CopyAttributes"/> option.</remark>
</member>
<member name="P:Cake.Common.Tools.ILMerge.ILMergeSettings.XmlDocumentation">
<summary>
Gets or sets a value indicating whether XML documentation files are merged
to produce an XML documentation file for the target assembly.
</summary>
<value>
<c>true</c> if XML documentation files are merged; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.ILMerge.ILMergeSettings.UseFullPublicKeyForReferences">
<summary>
Gets or sets a value indicating whether external assembly references
in the manifest of the target assembly will use full public keys or
public key tokens.
</summary>
<value>
<c>true</c> when full public keys should be used; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.ILMerge.ILMergeSettings.Wildcards">
<summary>
Gets or sets a value indicating whether any wild cards in file names
are expanded and all matching files will be used as input.
</summary>
<value>
<c>true</c> if wildcards in file names are expanded; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.ILMerge.ILMergeSettings.ZeroPeKind">
<summary>
Gets or sets a value indicating whether an assembly's PeKind flag (this
is the value of the field listed as .corflags in the Manifest) is zero
it will be treated as if it was ILonly.
</summary>
<value>
<c>true</c> when assembly's PeKind flag is zero; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.ILMerge.ILMergeSettings.Union">
<summary>
Gets or sets a value indicating whether types with the same name are all
merged into a single type in the target assembly.
</summary>
<value>
<c>true</c> if types with the same name are merged into a single type in
the target assembly; otherwise, <c>false</c>.
</value>
<remark>Cannot be specified at the same time as <see cref="P:Cake.Common.Tools.ILMerge.ILMergeSettings.AllowDuplicateTypes"/>.</remark>
</member>
<member name="P:Cake.Common.Tools.ILMerge.ILMergeSettings.Align">
<summary>
Gets or sets a value that controls the file alignment used for the target assembly.
</summary>
</member>
<member name="P:Cake.Common.Tools.ILMerge.ILMergeSettings.AttributeFile">
<summary>
Gets or sets the path and filename to an attribute assembly, an assembly that
will be used to get all of the assembly-level attributes such as Culture,
Version, etc.
</summary>
</member>
<member name="P:Cake.Common.Tools.ILMerge.ILMergeSettings.Version">
<summary>
Gets or sets the version. When this has a non-null value, then the target assembly will be given its
value as the version number of the assembly.
</summary>
<remark>
The version must be a valid assembly version as defined by the attribute
AssemblyVersion in the System.Reflection namespace.
</remark>
</member>
<member name="P:Cake.Common.Tools.ILMerge.ILMergeSettings.Log">
<summary>
Gets or sets a value indicating whether log messages are written.
</summary>
<remark>
If Log is true, but <see cref="P:Cake.Common.Tools.ILMerge.ILMergeSettings.LogFile"/> is null, then log messages are written to
Console.Out.
</remark>
</member>
<member name="P:Cake.Common.Tools.ILMerge.ILMergeSettings.LogFile">
<summary>
Gets or sets the path to the file where log messages should be written to.
</summary>
</member>
<member name="P:Cake.Common.Tools.ILMerge.ILMergeSettings.KeyFile">
<summary>
Gets or sets the path to a .snk file. The target assembly will be signed with
its contents and will then have a strong name.
</summary>
</member>
<member name="P:Cake.Common.Tools.ILMerge.ILMergeSettings.KeyContainer">
<summary>
Gets or sets the name of the container to use when signing the target assembly.
</summary>
</member>
<member name="P:Cake.Common.Tools.ILMerge.ILMergeSettings.SearchDirectories">
<summary>
Gets or sets the directories to be used to search for input assemblies.
</summary>
</member>
<member name="P:Cake.Common.Tools.ILMerge.ILMergeSettings.AllowDuplicateTypes">
<summary>
Gets or sets a value indicating whether to allow the user to allow all
public types to be renamed when they are duplicates.
</summary>
<value>
<c>true</c> if all public types should be allowed to be renamed; otherwise <c>false</c>.
</value>
<remark>
Use <see cref="P:Cake.Common.Tools.ILMerge.ILMergeSettings.DuplicateTypes"/> to allow fine grain control over exactly
which types are allowed to be renamed.
</remark>
</member>
<member name="P:Cake.Common.Tools.ILMerge.ILMergeSettings.DuplicateTypes">
<summary>
Gets or sets a list of public types which are allowed to be renamed when duplicates
exist.
</summary>
</member>
<member name="M:Cake.Common.Tools.ILMerge.ILMergeSettings.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.ILMerge.ILMergeSettings"/> class.
</summary>
</member>
<member name="T:Cake.Common.Tools.ILMerge.TargetKind">
<summary>
Represents an ILMerge target.
</summary>
</member>
<member name="F:Cake.Common.Tools.ILMerge.TargetKind.Default">
<summary>
TargetKind: <c>Default</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.ILMerge.TargetKind.Dll">
<summary>
TargetKind: <c>Dynamic Link Library</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.ILMerge.TargetKind.Exe">
<summary>
TargetKind: <c>Executable</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.ILMerge.TargetKind.WinExe">
<summary>
TargetKind: <c>Windows executable</c>
</summary>
</member>
<member name="T:Cake.Common.Tools.ILMerge.TargetPlatform">
<summary>
Represents a target platform.
</summary>
</member>
<member name="M:Cake.Common.Tools.ILMerge.TargetPlatform.#ctor(Cake.Common.Tools.ILMerge.TargetPlatformVersion)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.ILMerge.TargetPlatform"/> class.
</summary>
<param name="platform">The .NET framework target version.</param>
</member>
<member name="M:Cake.Common.Tools.ILMerge.TargetPlatform.#ctor(Cake.Common.Tools.ILMerge.TargetPlatformVersion,Cake.Core.IO.DirectoryPath)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.ILMerge.TargetPlatform"/> class.
</summary>
<param name="platform">The .NET framework target version.</param>
<param name="path">The directory where <c>mscorlib.dll</c> can be found.</param>
</member>
<member name="P:Cake.Common.Tools.ILMerge.TargetPlatform.Platform">
<summary>
Gets the .NET framework target version.
</summary>
</member>
<member name="P:Cake.Common.Tools.ILMerge.TargetPlatform.Path">
<summary>
Gets the directory where <c>mscorlib.dll</c> can be found.
</summary>
</member>
<member name="T:Cake.Common.Tools.ILMerge.TargetPlatformVersion">
<summary>
Represents the .NET Framework for the target assembly.
</summary>
</member>
<member name="F:Cake.Common.Tools.ILMerge.TargetPlatformVersion.v1">
<summary>
NET Framework v1
</summary>
</member>
<member name="F:Cake.Common.Tools.ILMerge.TargetPlatformVersion.v11">
<summary>
NET Framework v1.1
</summary>
</member>
<member name="F:Cake.Common.Tools.ILMerge.TargetPlatformVersion.v2">
<summary>
NET Framework v2
</summary>
</member>
<member name="F:Cake.Common.Tools.ILMerge.TargetPlatformVersion.v4">
<summary>
NET Framework v4
</summary>
</member>
<member name="T:Cake.Common.Tools.MSBuild.NamespaceDoc">
<summary>
This namespace contain types used to interact with MSBuild.
</summary>
</member>
<member name="T:Cake.Common.Tools.MSBuild.MSBuildAliases">
<summary>
<para>Contains functionality related to <see href="https://msdn.microsoft.com/en-us/library/dd393574.aspx">MSBuild</see>.</para>
<para>
In order to use the commands for this alias, MSBuild will already have to be installed on the machine the Cake Script
is being executed.
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildAliases.MSBuild(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Builds the specified solution or MsBuild project file using MSBuild.
</summary>
<param name="context">The context.</param>
<param name="solution">The solution or MsBuild project file to build.</param>
<example>
<code>
MSBuild("./src/Cake.sln");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildAliases.MSBuild(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,System.Action{Cake.Common.Tools.MSBuild.MSBuildSettings})">
<summary>
Builds the specified solution or MsBuild project file using MSBuild.
</summary>
<param name="context">The context.</param>
<param name="solution">The solution or MsBuild project file to build.</param>
<param name="configurator">The settings configurator.</param>
<example>
<code>
MSBuild("./src/Cake.sln", configurator =>
configurator.SetConfiguration("Debug")
.SetVerbosity(Verbosity.Minimal)
.UseToolVersion(MSBuildToolVersion.VS2015)
.SetMSBuildPlatform(MSBuildPlatform.x86)
.SetPlatformTarget(PlatformTarget.MSIL));
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildAliases.MSBuild(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Common.Tools.MSBuild.MSBuildSettings)">
<summary>
Builds the specified solution or MsBuild project file using MSBuild.
</summary>
<param name="context">The context.</param>
<param name="solution">The solution or MsBuild project file to build.</param>
<param name="settings">The settings.</param>
<example>
<code>
MSBuild("./src/Cake.sln", new MSBuildSettings {
Verbosity = Verbosity.Minimal,
ToolVersion = MSBuildToolVersion.VS2015,
Configuration = "Release",
PlatformTarget = PlatformTarget.MSIL
});
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.MSBuild.MSBuildBinaryLogImports">
<summary>
What files to include in the binary log.
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildBinaryLogImports.Unspecified">
<summary>Don't specify imports</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildBinaryLogImports.None">
<summary>Do not collect project and imports files</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildBinaryLogImports.Embed">
<summary>Embed in the binlog file</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildBinaryLogImports.ZipFile">
<summary>Produce a separate .ProjectImports.zip</summary>
</member>
<member name="T:Cake.Common.Tools.MSBuild.MSBuildBinaryLogSettings">
<summary>
MSBuild binary logging settings used by <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildBinaryLogSettings.Enabled">
<summary>
Gets or sets a value indicating whether binary logging should be enabled.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildBinaryLogSettings.FileName">
<summary>
Gets or sets the output filename.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildBinaryLogSettings.Imports">
<summary>
Gets or sets what source files should be included in the log.
</summary>
</member>
<member name="T:Cake.Common.Tools.MSBuild.MSBuildFileLogger">
<summary>
Contains settings for specifying a MSBuild file logger.
</summary>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildFileLogger.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.MSBuild.MSBuildFileLogger"/> class.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildFileLogger.PerformanceSummaryEnabled">
<summary>
Gets or sets a value indicating whether PerformanceSummary will Show the time that’s spent in tasks, targets, and projects.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildFileLogger.SummaryDisabled">
<summary>
Gets or sets a value indicating whether Summary will Show the error and warning summary at the end.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildFileLogger.MSBuildFileLoggerOutput">
<summary>
Gets or sets show ErrorsOnly, WarningsOnly, or All.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildFileLogger.HideVerboseItemAndPropertyList">
<summary>
Gets or sets a value indicating whether NoItemAndPropertyList will be set to Don't show the list of items and properties that would appear at the start of each project build if the verbosity level is set to diagnostic.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildFileLogger.ShowCommandLine">
<summary>
Gets or sets a value indicating whether ShowCommandLine. Show TaskCommandLineEvent messages.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildFileLogger.ShowTimestamp">
<summary>
Gets or sets a value indicating whether ShowTimestamp. Show the timestamp as a prefix to any message.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildFileLogger.ShowEventId">
<summary>
Gets or sets a value indicating whether ShowEventId. Show the event ID for each started event, finished event, and message.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildFileLogger.Verbosity">
<summary>
Gets or sets Verbosity. Override the /verbosity setting for this logger.
Specify the following verbosity levels: q[uiet], m[inimal], n[ormal], v[erbose] (detailed), and diag[nostic].
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildFileLogger.LogFile">
<summary>
Gets or sets LogFile. The path to the log file into which the build log is written.
An empty string will use msbuild.log.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildFileLogger.AppendToLogFile">
<summary>
Gets or sets a value indicating whether the build log is appended to the log file or overwrites it. When true, the build log is appended to the log file.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildFileLogger.Encoding">
<summary>
Gets or sets Specifies the encoding for the file (for example, UTF-8, Unicode, or ASCII).
</summary>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildFileLogger.GetParameters(Cake.Core.ICakeEnvironment)">
<summary>
Process the file logger config and return parameters as a string.
</summary>
<param name="environment">The environment.</param>
<returns>The parameters separated by semi-colons.</returns>
</member>
<member name="T:Cake.Common.Tools.MSBuild.MSBuildFileLoggerOutput">
<summary>
The type of file logger output to generate.
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildFileLoggerOutput.All">
<summary>
Show errors and warnings.
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildFileLoggerOutput.ErrorsOnly">
<summary>
Show errors only.
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildFileLoggerOutput.WarningsOnly">
<summary>
Show warnings only.
</summary>
</member>
<member name="T:Cake.Common.Tools.MSBuild.MSBuildLogger">
<summary>
Contains settings for specifying a MSBuild logger.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildLogger.Assembly">
<summary>
Gets or sets the assembly containing the logger. Should match the format {AssemblyName[,StrongName] | AssemblyFile}.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildLogger.Class">
<summary>
Gets or sets the class implementing the logger. Should match the format [PartialOrFullNamespace.]LoggerClassName
If the assembly contains only one logger, class does not need to be specified.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildLogger.Parameters">
<summary>
Gets or sets the parameters to be passed to the logger.
</summary>
</member>
<member name="T:Cake.Common.Tools.MSBuild.MSBuildPlatform">
<summary>
Represents an MSBuild exe platform.
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildPlatform.Automatic">
<summary>
Will build using MSBuild version based on PlatformTarget/Host OS.
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildPlatform.x86">
<summary>
MSBuildPlatform: <c>x86</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildPlatform.x64">
<summary>
MSBuildPlatform: <c>x64</c>
</summary>
</member>
<member name="T:Cake.Common.Tools.MSBuild.MSBuildRunner">
<summary>
The MSBuild runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.MSBuild.MSBuildRunner"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="runner">The runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildRunner.Run(Cake.Core.IO.FilePath,Cake.Common.Tools.MSBuild.MSBuildSettings)">
<summary>
Runs MSBuild with the specified settings.
</summary>
<param name="solution">The solution or MsBuild project file to build.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildRunner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildRunner.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildRunner.GetAlternativeToolPaths(Cake.Common.Tools.MSBuild.MSBuildSettings)">
<summary>
Gets alternative file paths which the tool may exist in.
</summary>
<param name="settings">The settings.</param>
<returns>The default tool path.</returns>
</member>
<member name="T:Cake.Common.Tools.MSBuild.MSBuildSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.MSBuild.MSBuildRunner"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.Targets">
<summary>
Gets the targets.
</summary>
<value>The targets.</value>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.Properties">
<summary>
Gets the properties.
</summary>
<value>The properties.</value>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.PlatformTarget">
<summary>
Gets or sets the platform target.
</summary>
<value>The platform target.</value>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.MSBuildPlatform">
<summary>
Gets or sets the MSBuild platform.
</summary>
<value>The MSBuild platform.</value>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.Target">
<summary>
Gets or sets the MSBuild target.
</summary>
<value>The MSBuild target.</value>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.ToolVersion">
<summary>
Gets or sets the tool version.
</summary>
<value>The tool version.</value>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.Configuration">
<summary>
Gets or sets the configuration.
</summary>
<value>The configuration.</value>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.MaxCpuCount">
<summary>
Gets or sets the maximum CPU count.
If this value is zero, MSBuild will use as many processes as
there are available CPUs to build the project. If not set
MSBuild compile projects in this solution one at a time.
</summary>
<value>The maximum CPU count.</value>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.NodeReuse">
<summary>
Gets or sets whether or not node reuse is used.
When you’re doing multiple builds in a row, this helps reduce your total build time,
by avoiding the start up costs of each MSBuild child node.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.DetailedSummary">
<summary>
Gets or sets whether or not detailed summary is created.
Shows detailed information at the end of the build
about the configurations built and how they were
scheduled to nodes.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.NoConsoleLogger">
<summary>
Gets or sets whether or not information is logged to the console.
Disable the default console logger and do not log events
to the console.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.NoLogo">
<summary>
Gets or sets a value indicating whether to show copyright information at the start of the program.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.Version">
<summary>
Gets or sets the default value of all the version numbers embedded in the build output.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.VersionPrefix">
<summary>
Gets or sets the base version number embedded in the build output.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.VersionSuffix">
<summary>
Gets or sets the pre-release label of the version number embedded in the build output.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.FileVersion">
<summary>
Gets or sets the file version number embedded in the build output.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.AssemblyVersion">
<summary>
Gets or sets the assembly version number embedded in the build output.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.InformationalVersion">
<summary>
Gets or sets the assembly informational version number embedded in the build output.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.PackageVersion">
<summary>
Gets or sets the version number of the NuGet package generated.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.PackageReleaseNotes">
<summary>
Gets or sets the release notes of the NuGet package generated.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.ContinuousIntegrationBuild">
<summary>
Gets or sets a value indicating whether to normalize stored file paths used when producing deterministic builds.
</summary>
<remarks>
For more information see https://devblogs.microsoft.com/dotnet/producing-packages-with-source-link/#deterministic-builds.
</remarks>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.NoImplicitTarget">
<summary>
Gets or sets a value indicating whether implicit target should be passed to MSBuild.
If set to true, no targets will be specified.
If set to false, and no targets specified, Build target will be passed by default.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.Verbosity">
<summary>
Gets or sets the amount of information to display in the build log.
Each logger displays events based on the verbosity level that you set for that logger.
</summary>
<value>The build log verbosity.</value>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.IncludeSymbols">
<summary>
Gets or sets a value indicating whether a symbol package should be created.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.SymbolPackageFormat">
<summary>
Gets or sets the symbol package format.
</summary>
<value>The symbol package format.</value>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.Loggers">
<summary>
Gets the loggers.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.FileLoggers">
<summary>
Gets the file loggers.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.BinaryLogger">
<summary>
Gets or sets the binary logging options.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.WarningsAsError">
<summary>
Gets or sets a value indicating whether warnings should be treated as errors.
Treats all warnings as errors unless <see cref="P:Cake.Common.Tools.MSBuild.MSBuildSettings.WarningsAsErrorCodes"/> has specific codes specified.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.WarningsAsErrorCodes">
<summary>
Gets the warning codes to treat as errors.
If any specified <seealso cref="P:Cake.Common.Tools.MSBuild.MSBuildSettings.WarningsAsError"/> will implicitly be treated as true.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.WarningsAsMessageCodes">
<summary>
Gets the warning codes to NOT treat as errors.
</summary>
<remarks>Only available MSBuild version 15 (VS2017) and newer.</remarks>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.Restore">
<summary>
Gets or sets a value indicating whether the Restore target should be run before any other targets.
This setting will pass the /restore option down to MSBuild.
Use this setting when working with the new csproj format.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.RestoreLockedMode">
<summary>
Gets or sets a value indicating whether or not to lock the package dependency graph while
restoring, using the packages.lock.json file.
This setting is available with at least Visual Studio 2017 version 15.9 and above or NET SDK version 2.1.500 and above.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.ConsoleLoggerParameters">
<summary>
Gets the console logger parameters.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSBuild.MSBuildSettings.AllowPreviewVersion">
<summary>
Gets or sets a value indicating whether tools from a preview edition of Visual Studio should be used.
<para>
If set to <c>true</c>, MSBuildTools from a Preview edition
(e.g. Visual Studio 2022 Preview) will be considered to be used.
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettings.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> class.
</summary>
</member>
<member name="T:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions">
<summary>
Contains functionality related to MSBuild settings.
</summary>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.WithTarget(Cake.Common.Tools.MSBuild.MSBuildSettings,System.String)">
<summary>
Adds a MSBuild target to the configuration.
</summary>
<param name="settings">The settings.</param>
<param name="target">The MSBuild target.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.UseToolVersion(Cake.Common.Tools.MSBuild.MSBuildSettings,Cake.Common.Tools.MSBuild.MSBuildToolVersion)">
<summary>
Sets the tool version.
</summary>
<param name="settings">The settings.</param>
<param name="version">The version.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.UseToolVersion(Cake.Common.Tools.MSBuild.MSBuildSettings,System.String)">
<summary>
Sets the tool version.
</summary>
<param name="settings">The settings.</param>
<param name="version">The string version.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.GetMSBuildToolVersionFromString(System.String)">
<summary>
Helper that gets the MSBuildToolVersion from the version string.
</summary>
<param name="version">The string version.</param>
<returns>The matched MSBuildToolVersion enum <see cref="T:Cake.Common.Tools.MSBuild.MSBuildToolVersion"/>.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.SetPlatformTarget(Cake.Common.Tools.MSBuild.MSBuildSettings,Cake.Common.Tools.MSBuild.PlatformTarget)">
<summary>
Sets the platform target.
</summary>
<param name="settings">The settings.</param>
<param name="target">The target.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.SetPlatformTarget(Cake.Common.Tools.MSBuild.MSBuildSettings,System.String)">
<summary>
Sets the platform target.
</summary>
<param name="settings">The settings.</param>
<param name="target">The target.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.SetMSBuildPlatform(Cake.Common.Tools.MSBuild.MSBuildSettings,Cake.Common.Tools.MSBuild.MSBuildPlatform)">
<summary>
Sets the MSBuild platform.
</summary>
<param name="settings">The settings.</param>
<param name="platform">The platform.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.WithProperty(Cake.Common.Tools.MSBuild.MSBuildSettings,System.String,System.String[])">
<summary>
Adds a property to the configuration.
</summary>
<param name="settings">The settings.</param>
<param name="name">The property name.</param>
<param name="values">The property values.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.SetConfiguration(Cake.Common.Tools.MSBuild.MSBuildSettings,System.String)">
<summary>
Sets the configuration.
</summary>
<param name="settings">The settings.</param>
<param name="configuration">The configuration.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.SetMaxCpuCount(Cake.Common.Tools.MSBuild.MSBuildSettings,System.Nullable{System.Int32})">
<summary>
Sets the maximum CPU count. Without this set MSBuild will compile projects in this solution one at a time.
</summary>
<param name="settings">The settings.</param>
<param name="maxCpuCount">The maximum CPU count. Set this value to zero to use as many MSBuild processes as available CPUs.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.SetNodeReuse(Cake.Common.Tools.MSBuild.MSBuildSettings,System.Boolean)">
<summary>
Sets whether or not node reuse should be enabled.
</summary>
<param name="settings">The settings.</param>
<param name="reuse"><c>true</c> if node reuse should be enabled; otherwise <c>false</c>.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.SetDetailedSummary(Cake.Common.Tools.MSBuild.MSBuildSettings,System.Boolean)">
<summary>
Sets whether or not detailed summary should be enabled.
</summary>
<param name="settings">The settings.</param>
<param name="detailedSummary"><c>true</c> if detailed summary should be enabled; otherwise <c>false</c>.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.SetNoConsoleLogger(Cake.Common.Tools.MSBuild.MSBuildSettings,System.Boolean)">
<summary>
Sets whether or not no console logging should be enabled.
</summary>
<param name="settings">The settings.</param>
<param name="noConsoleLog"><c>true</c> if no console log should be enabled; otherwise <c>false</c>.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.SetNoLogo(Cake.Common.Tools.MSBuild.MSBuildSettings,System.Boolean)">
<summary>
Sets whether or not copyright information at the start of the program should be shown.
</summary>
<param name="settings">The settings.</param>
<param name="noLogo"><c>true</c> if no copyright information at the start of the program should be shown; otherwise <c>false</c>.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.SetVersion(Cake.Common.Tools.MSBuild.MSBuildSettings,System.String)">
<summary>
Sets the version.
</summary>
<param name="settings">The settings.</param>
<param name="version">The version.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
<remarks>
Version will override VersionPrefix and VersionSuffix if set.
This may also override version settings during packaging.
</remarks>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.SetVersionPrefix(Cake.Common.Tools.MSBuild.MSBuildSettings,System.String)">
<summary>
Sets the version prefix.
</summary>
<param name="settings">The settings.</param>
<param name="versionPrefix">The version prefix.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.SetVersionSuffix(Cake.Common.Tools.MSBuild.MSBuildSettings,System.String)">
<summary>
Sets the version suffix.
</summary>
<param name="settings">The settings.</param>
<param name="versionSuffix">The version suffix.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.SetFileVersion(Cake.Common.Tools.MSBuild.MSBuildSettings,System.String)">
<summary>
Sets the file version.
</summary>
<param name="settings">The settings.</param>
<param name="fileVersion">The file version.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.SetAssemblyVersion(Cake.Common.Tools.MSBuild.MSBuildSettings,System.String)">
<summary>
Sets the assembly version.
</summary>
<param name="settings">The settings.</param>
<param name="assemblyVersion">The assembly version.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.SetInformationalVersion(Cake.Common.Tools.MSBuild.MSBuildSettings,System.String)">
<summary>
Sets the informational version.
</summary>
<param name="settings">The settings.</param>
<param name="informationalVersion">The informational version.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.SetPackageVersion(Cake.Common.Tools.MSBuild.MSBuildSettings,System.String)">
<summary>
Sets the package version.
</summary>
<param name="settings">The settings.</param>
<param name="packageVersion">The package version.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.SetPackageReleaseNotes(Cake.Common.Tools.MSBuild.MSBuildSettings,System.String)">
<summary>
Sets the package release notes.
</summary>
<param name="settings">The settings.</param>
<param name="packageReleaseNotes">The package release notes.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.SetContinuousIntegrationBuild(Cake.Common.Tools.MSBuild.MSBuildSettings,System.Nullable{System.Boolean})">
<summary>
Sets a value indicating whether to normalize stored file paths used when producing deterministic builds.
</summary>
<remarks>
For more information see https://devblogs.microsoft.com/dotnet/producing-packages-with-source-link/#deterministic-builds.
</remarks>
<param name="settings">The settings.</param>
<param name="continuousIntegrationBuild">A value indicating whether to normalize stored file paths used when producing deterministic builds.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.SetNoImplicitTarget(Cake.Common.Tools.MSBuild.MSBuildSettings,System.Boolean)">
<summary>
Sets whether or not any targets should be passed to MSBuild.
</summary>
<param name="settings">The settings.</param>
<param name="noImplicitTarget"><c>true</c> if no implicit target should be passed to MSBuild; otherwise <c>false</c>.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.SetIncludeSymbols(Cake.Common.Tools.MSBuild.MSBuildSettings,System.Boolean)">
<summary>
Sets whether or not a symbol package should be created.
</summary>
<param name="settings">The settings.</param>
<param name="includeSymbols"><c>true</c> if a symbol package should be created; otherwise <c>false</c>.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.SetSymbolPackageFormat(Cake.Common.Tools.MSBuild.MSBuildSettings,System.String)">
<summary>
Sets the symbol package format.
</summary>
<param name="settings">The settings.</param>
<param name="symbolPackageFormat">The symbol package format.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.SetVerbosity(Cake.Common.Tools.MSBuild.MSBuildSettings,Cake.Core.Diagnostics.Verbosity)">
<summary>
Sets the build log verbosity.
</summary>
<param name="settings">The settings.</param>
<param name="verbosity">The build log verbosity.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.WithLogger(Cake.Common.Tools.MSBuild.MSBuildSettings,System.String,System.String,System.String)">
<summary>
Adds a custom logger.
</summary>
<param name="settings">The settings.</param>
<param name="loggerAssembly">The assembly containing the logger. Should match the format {AssemblyName[,StrongName] | AssemblyFile}.</param>
<param name="loggerClass">The class implementing the logger. Should match the format [PartialOrFullNamespace.]LoggerClassName. If the assembly contains only one logger, class does not need to be specified.</param>
<param name="loggerParameters">Parameters to be passed to the logger.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.AddFileLogger(Cake.Common.Tools.MSBuild.MSBuildSettings)">
<summary>
Adds a file logger with all the default settings.
Each file logger will be declared in the order added.
The first file logger will match up to the /fl parameter.
The next nine (max) file loggers will match up to the /fl1 through /fl9 respectively.
</summary>
<param name="settings">The settings.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.AddFileLogger(Cake.Common.Tools.MSBuild.MSBuildSettings,Cake.Common.Tools.MSBuild.MSBuildFileLogger)">
<summary>
Adds a file logger.
Each file logger will be declared in the order added.
The first file logger will match up to the /fl parameter.
The next nine (max) file loggers will match up to the /fl1 through /fl9 respectively.
</summary>
<param name="settings">The settings.</param>
<param name="fileLoggerParameters">Parameters to be passed to the logger.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.EnableBinaryLogger(Cake.Common.Tools.MSBuild.MSBuildSettings)">
<summary>
Enables the binary logger with all the default settings.
</summary>
<param name="settings">The settings.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.EnableBinaryLogger(Cake.Common.Tools.MSBuild.MSBuildSettings,Cake.Common.Tools.MSBuild.MSBuildBinaryLogImports)">
<summary>
Enables the binary logger with the specified imports and default file name.
</summary>
<param name="settings">The settings.</param>
<param name="imports">The imports.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.EnableBinaryLogger(Cake.Common.Tools.MSBuild.MSBuildSettings,System.String)">
<summary>
Enables the binary logger with the specified log file name and no imports.
</summary>
<param name="settings">The settings.</param>
<param name="fileName">The log file name.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.EnableBinaryLogger(Cake.Common.Tools.MSBuild.MSBuildSettings,System.String,Cake.Common.Tools.MSBuild.MSBuildBinaryLogImports)">
<summary>
Enables the binary logger with the specified log file name and imports.
</summary>
<param name="settings">The settings.</param>
<param name="fileName">The log file name.</param>
<param name="imports">The imports.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.WithWarningsAsError(Cake.Common.Tools.MSBuild.MSBuildSettings,System.String[])">
<summary>
Treat warnings as errors, if no codes specified all errors will be treated as errors.
</summary>
<param name="settings">The settings.</param>
<param name="codes">Only treat specified warning codes as errors.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.WithWarningsAsMessage(Cake.Common.Tools.MSBuild.MSBuildSettings,System.String[])">
<summary>
Warnings to not treat as errors.
</summary>
<param name="settings">The settings.</param>
<param name="codes">Warning codes to not treat as errors.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.WithRestore(Cake.Common.Tools.MSBuild.MSBuildSettings)">
<summary>
Invoke the Restore target before any other target.
</summary>
<param name="settings">The setting.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.SetRestoreLockedMode(Cake.Common.Tools.MSBuild.MSBuildSettings,System.Boolean)">
<summary>
Sets whether or not to lock the package dependency graph while restoring, using the packages.lock.json file.
This setting is available with atleast Visual Studio 2017 version 15.9 and above or NET SDK version 2.1.500 and above.
</summary>
<param name="settings">The settings.</param>
<param name="restoreLockedMode"><c>true</c> if locked mode restore should be enabled; otherwise <c>false</c>.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildSettingsExtensions.WithConsoleLoggerParameter(Cake.Common.Tools.MSBuild.MSBuildSettings,System.String)">
<summary>
Adds a console logger parameter.
</summary>
<param name="settings">The settings.</param>
<param name="parameter">The console logger parameter.</param>
<returns>The same <see cref="T:Cake.Common.Tools.MSBuild.MSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="T:Cake.Common.Tools.MSBuild.MSBuildToolVersion">
<summary>
Represents a MSBuild tool version.
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildToolVersion.Default">
<summary>
The highest available MSBuild tool version.
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildToolVersion.NET20">
<summary>
MSBuild tool version: <c>.NET 2.0</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildToolVersion.NET30">
<summary>
MSBuild tool version: <c>.NET 3.0</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildToolVersion.VS2005">
<summary>
MSBuild tool version: <c>Visual Studio 2005</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildToolVersion.NET35">
<summary>
MSBuild tool version: <c>.NET 3.5</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildToolVersion.VS2008">
<summary>
MSBuild tool version: <c>Visual Studio 2008</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildToolVersion.NET40">
<summary>
MSBuild tool version: <c>.NET 4.0</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildToolVersion.NET45">
<summary>
MSBuild tool version: <c>.NET 4.5</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildToolVersion.VS2010">
<summary>
MSBuild tool version: <c>Visual Studio 2010</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildToolVersion.VS2011">
<summary>
MSBuild tool version: <c>Visual Studio 2011</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildToolVersion.VS2012">
<summary>
MSBuild tool version: <c>Visual Studio 2012</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildToolVersion.NET451">
<summary>
MSBuild tool version: <c>.NET 4.5.1</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildToolVersion.NET452">
<summary>
MSBuild tool version: <c>.NET 4.5.2</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildToolVersion.VS2013">
<summary>
MSBuild tool version: <c>Visual Studio 2013</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildToolVersion.VS2015">
<summary>
MSBuild tool version: <c>Visual Studio 2015</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildToolVersion.NET46">
<summary>
MSBuild tool version: <c>.NET 4.6</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildToolVersion.VS2017">
<summary>
MSBuild tool version: <c>Visual Studio 2017</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildToolVersion.VS2019">
<summary>
MSBuild tool version: <c>Visual Studio 2019</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildToolVersion.VSCustom">
<summary>
Custom Visual Studio build
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildToolVersion.NETCustom">
<summary>
Custom Visual Studio build
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildToolVersion.VS2022">
<summary>
MSBuild tool version: <c>Visual Studio 2022</c>
</summary>
</member>
<member name="T:Cake.Common.Tools.MSBuild.MSBuildVerbosityExtensions">
<summary>
Contains functionality related to MSBuild verbosity.
</summary>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildVerbosityExtensions.GetMSBuildVerbosityName(Cake.Core.Diagnostics.Verbosity)">
<summary>
Gets the MSBuild verbosity from <see cref="T:Cake.Core.Diagnostics.Verbosity"/>.
</summary>
<param name="verbosity">The verbosity.</param>
<returns>MSBuild verbosity string.</returns>
</member>
<member name="M:Cake.Common.Tools.MSBuild.MSBuildVerbosityExtensions.GetMSBuildVerbosity(System.String)">
<summary>
Gets the MSBuild <see cref="T:Cake.Core.Diagnostics.Verbosity"/> from string value.
</summary>
<param name="verbosity">The verbosity string value.</param>
<returns>MSBuild <see cref="T:Cake.Core.Diagnostics.Verbosity"/> enumeration.</returns>
<remarks>Valid values are 'quiet', 'minimal', 'normal', 'detailed' and 'diagnostic'.</remarks>
</member>
<member name="T:Cake.Common.Tools.MSBuild.MSBuildVersion">
<summary>
Represents a MSBuild version.
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildVersion.MSBuild20">
<summary>Version 2.0</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildVersion.MSBuild35">
<summary>Version 3.5</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildVersion.MSBuild4">
<summary>Version 4.0</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildVersion.MSBuild12">
<summary>Version 12.0</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildVersion.MSBuild14">
<summary>Version 14.0</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildVersion.MSBuild15">
<summary>Version 15.0</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildVersion.MSBuild16">
<summary>Version 16.0</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildVersion.MSBuildCustomVS">
<summary>
Custom VS Version
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildVersion.MSBuildNETCustom">
<summary>
Custom .NET Version
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.MSBuildVersion.MSBuild17">
<summary>Version 17.0</summary>
</member>
<member name="T:Cake.Common.Tools.MSBuild.PlatformTarget">
<summary>
Represents a MSBuild platform target.
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.PlatformTarget.MSIL">
<summary>
Platform target: <c>MSIL</c> (Any CPU)
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.PlatformTarget.x86">
<summary>
Platform target: <c>x86</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.PlatformTarget.x64">
<summary>
Platform target: <c>x64</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.PlatformTarget.ARM">
<summary>
Platform target: <c>ARM</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.PlatformTarget.Win32">
<summary>
Platform target: <c>Win32</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.PlatformTarget.ARM64">
<summary>
Platform target: <c>ARM64</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.PlatformTarget.ARMv6">
<summary>
Platform target: <c>ARMv6</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.PlatformTarget.ARMv7">
<summary>
Platform target: <c>ARMv7</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.MSBuild.PlatformTarget.ARMv7s">
<summary>
Platform target: <c>ARMv7s</c>
</summary>
</member>
<member name="T:Cake.Common.Tools.MSTest.NamespaceDoc">
<summary>
This namespace contain types used to interact with MSTest.
</summary>
</member>
<member name="T:Cake.Common.Tools.MSTest.MSTestAliases">
<summary>
<para>Contains functionality related to running <see href="https://msdn.microsoft.com/en-us/library/ms182486.aspx">MSTest</see> unit tests.</para>
<para>
In order to use the commands for this alias, MSTest will need to be installed on the machine where
the Cake script is being executed. This is typically achieved by having either Visual Studio installed, or by
using the Microsoft Build Tools, for example, for <see href="https://www.microsoft.com/en-us/download/details.aspx?id=48159">2015</see>.
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.MSTest.MSTestAliases.MSTest(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern)">
<summary>
Runs all MSTest unit tests in the assemblies matching the specified pattern.
</summary>
<example>
<code>
MSTest("./Tests/*.UnitTests.dll");
</code>
</example>
<param name="context">The context.</param>
<param name="pattern">The pattern.</param>
</member>
<member name="M:Cake.Common.Tools.MSTest.MSTestAliases.MSTest(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern,Cake.Common.Tools.MSTest.MSTestSettings)">
<summary>
Runs all MSTest unit tests in the assemblies matching the specified pattern.
</summary>
<example>
<code>
MSTest("./Tests/*.UnitTests.dll", new MSTestSettings() { NoIsolation = false });
</code>
</example>
<param name="context">The context.</param>
<param name="pattern">The pattern.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.MSTest.MSTestAliases.MSTest(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath})">
<summary>
Runs all MSTest unit tests in the specified assemblies.
</summary>
<example>
<code>
var paths = new List<FilePath>() { "./assemblydir1", "./assemblydir2" };
MSTest(paths);
</code>
</example>
<param name="context">The context.</param>
<param name="assemblyPaths">The assembly paths.</param>
</member>
<member name="M:Cake.Common.Tools.MSTest.MSTestAliases.MSTest(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.MSTest.MSTestSettings)">
<summary>
Runs all MSTest unit tests in the specified assemblies.
</summary>
<example>
<code>
var paths = new List<FilePath>() { "./assemblydir1", "./assemblydir2" };
MSTest(paths, new MSTestSettings() { NoIsolation = false });
</code>
</example>
<param name="context">The context.</param>
<param name="assemblyPaths">The assembly paths.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.MSTest.MSTestRunner">
<summary>
The MSTest unit test runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.MSTest.MSTestRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.MSTest.MSTestRunner"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.MSTest.MSTestRunner.Run(System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.MSTest.MSTestSettings)">
<summary>
Runs the tests in the specified assembly.
</summary>
<param name="assemblyPaths">The assembly path.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.MSTest.MSTestRunner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The tool name.</returns>
</member>
<member name="M:Cake.Common.Tools.MSTest.MSTestRunner.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="M:Cake.Common.Tools.MSTest.MSTestRunner.GetAlternativeToolPaths(Cake.Common.Tools.MSTest.MSTestSettings)">
<summary>
Gets alternative file paths which the tool may exist in.
</summary>
<param name="settings">The settings.</param>
<returns>The default tool path.</returns>
</member>
<member name="T:Cake.Common.Tools.MSTest.MSTestSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.MSTest.MSTestRunner"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSTest.MSTestSettings.NoIsolation">
<summary>
Gets or sets a value indicating whether to run tests within the MSTest process.
This choice improves test run speed but increases risk to the MSTest.exe process.
Defaults to <c>true</c>.
</summary>
<value>
<c>true</c> if running without isolation; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.MSTest.MSTestSettings.Category">
<summary>
Gets or sets a value indicating the test category filter string to pass to
MSTest.exe flag <see href="https://msdn.microsoft.com/en-us/library/ms182489.aspx#category">/testcategory</see>.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSTest.MSTestSettings.ResultsFile">
<summary>
Gets or sets the filepath for a named resulting test file.
MSTest.exe flag <see href="https://msdn.microsoft.com/en-us/library/ms182489.aspx#resultsfile">/resultsfile</see>.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSTest.MSTestSettings.TestSettings">
<summary>
Gets or sets the test settings file to pass to MSTest.exe flag <see href="https://msdn.microsoft.com/en-us/library/ms182489.aspx#testsettings">/testsettings</see>.
</summary>
</member>
<member name="M:Cake.Common.Tools.MSTest.MSTestSettings.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.MSTest.MSTestSettings"/> class.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSTest.MSTestSettings.AllowPreviewVersion">
<summary>
Gets or sets a value indicating whether tools from a preview edition of Visual Studio should be used.
<para>
If set to <c>true</c>, MSTest from a Preview edition
(e.g. Visual Studio 2022 Preview) will be considered to be used.
</para>
</summary>
</member>
<member name="T:Cake.Common.Tools.NuGet.NamespaceDoc">
<summary>
This namespace contain types used to interact with NuGet.
</summary>
</member>
<member name="T:Cake.Common.Tools.NuGet.Install.NamespaceDoc">
<summary>
This namespace contain types used to interact
with the NuGet package installer.
</summary>
</member>
<member name="T:Cake.Common.Tools.NuGet.Install.NuGetInstaller">
<summary>
The NuGet package installer used to install NuGet packages.
</summary>
</member>
<member name="M:Cake.Common.Tools.NuGet.Install.NuGetInstaller.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Core.IO.NuGet.INuGetToolResolver)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.NuGet.Install.NuGetInstaller"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="resolver">The NuGet tool resolver.</param>
</member>
<member name="M:Cake.Common.Tools.NuGet.Install.NuGetInstaller.InstallFromConfig(Cake.Core.IO.FilePath,Cake.Common.Tools.NuGet.Install.NuGetInstallSettings)">
<summary>
Installs NuGet packages using the specified package configuration file and settings.
</summary>
<param name="packageConfigPath">Path to package configuration to use for install.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.NuGet.Install.NuGetInstaller.Install(System.String,Cake.Common.Tools.NuGet.Install.NuGetInstallSettings)">
<summary>
Installs NuGet packages using the specified package id and settings.
</summary>
<param name="packageId">The source package id.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.NuGet.Install.NuGetInstallSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.NuGet.Install.NuGetInstaller"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Install.NuGetInstallSettings.OutputDirectory">
<summary>
Gets or sets the directory in which packages will be installed.
If none is specified, the current directory will be used.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Install.NuGetInstallSettings.Version">
<summary>
Gets or sets the version of the package to install.
If none specified, the latest will be used.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Install.NuGetInstallSettings.ExcludeVersion">
<summary>
Gets or sets a value indicating whether to exclude the version number from the package folder.
</summary>
<value>
<c>true</c> if to exclude the version number from the package folder; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Install.NuGetInstallSettings.Prerelease">
<summary>
Gets or sets a value indicating whether to allow installation of prerelease packages.
This flag is not required when restoring packages by installing from packages.config.
</summary>
<value>
<c>true</c> to allow installation of prerelease packages; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Install.NuGetInstallSettings.RequireConsent">
<summary>
Gets or sets a value indicating whether to check if package
install consent is granted before installing a package.
</summary>
<value>
<c>true</c> if to check if package install consent is granted before installing a package; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Install.NuGetInstallSettings.SolutionDirectory">
<summary>
Gets or sets the solution directory path for package restore.
</summary>
<value>
The solution directory path.
</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Install.NuGetInstallSettings.Source">
<summary>
Gets or sets a list of packages sources to use for this command.
</summary>
<value>The list of packages sources to use for this command.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Install.NuGetInstallSettings.NoCache">
<summary>
Gets or sets a value indicating whether or not to use the machine cache as the first package source.
</summary>
<value>
<c>true</c> to not use the machine cache as the first package source; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Install.NuGetInstallSettings.DisableParallelProcessing">
<summary>
Gets or sets a value indicating whether to disable parallel processing of packages for this command.
Disable parallel processing of packages for this command.
</summary>
<value>
<c>true</c> to disable parallel processing of packages for this command; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Install.NuGetInstallSettings.Verbosity">
<summary>
Gets or sets the output verbosity.
</summary>
<value>The output verbosity.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Install.NuGetInstallSettings.ConfigFile">
<summary>
Gets or sets the NuGet configuration file.
If not specified, the file <c>%AppData%\NuGet\NuGet.config</c> is used as the configuration file.
</summary>
<value>The NuGet configuration file.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Install.NuGetInstallSettings.FallbackSource">
<summary>
Gets or sets a list of packages sources to use as fallbacks for this command.
This setting requires NuGet V3 or later.
</summary>
<value>The list of packages sources to use as fallbacks for this command.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Install.NuGetInstallSettings.NonInteractive">
<summary>
Gets or sets a value indicating whether or not NuGet suppresses prompts for user input or confirmations.
</summary>
<remarks>
This setting is passed by NuGet.exe to any extensions such as authorization providers.
</remarks>
<value>
<c>false</c> to allow NuGet to show prompts for user input or confirmations; otherwise, <c>true</c>.
</value>
</member>
<member name="T:Cake.Common.Tools.NuGet.Pack.NamespaceDoc">
<summary>
This namespace contain types used to
pack NuGet packages.
</summary>
</member>
<member name="T:Cake.Common.Tools.NuGet.Pack.NuGetPacker">
<summary>
The NuGet packer.
</summary>
</member>
<member name="M:Cake.Common.Tools.NuGet.Pack.NuGetPacker.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Diagnostics.ICakeLog,Cake.Core.Tooling.IToolLocator,Cake.Core.IO.NuGet.INuGetToolResolver)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.NuGet.Pack.NuGetPacker"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="log">The log.</param>
<param name="tools">The tool locator.</param>
<param name="resolver">The NuGet tool resolver.</param>
</member>
<member name="M:Cake.Common.Tools.NuGet.Pack.NuGetPacker.Pack(Cake.Common.Tools.NuGet.Pack.NuGetPackSettings)">
<summary>
Creates a NuGet package from the specified settings.
</summary>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.NuGet.Pack.NuGetPacker.Pack(Cake.Core.IO.FilePath,Cake.Common.Tools.NuGet.Pack.NuGetPackSettings)">
<summary>
Creates a NuGet package from the specified nuspec or project file.
</summary>
<param name="filePath">The nuspec or project file path.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.NuGet.Pack.NuGetPacker"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.BasePath">
<summary>
Gets or sets the base path.
</summary>
<value>The base path.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.OutputDirectory">
<summary>
Gets or sets the output directory.
</summary>
<value>The output directory.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.NoPackageAnalysis">
<summary>
Gets or sets a value indicating whether package analysis should be performed.
Defaults to <c>true</c>.
</summary>
<value>
<c>true</c> if package analysis should be performed; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.IncludeReferencedProjects">
<summary>
Gets or sets a value indicating whether referenced projects should be included.
Defaults to <c>false</c>.
</summary>
<value>
<c>true</c> if referenced projects should be included; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.Symbols">
<summary>
Gets or sets a value indicating whether a symbol package should be created.
Defaults to <c>false</c>.
</summary>
<value>
<c>true</c> if a symbol package should be created; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.SymbolPackageFormat">
<summary>
Gets or sets the symbol package format.
</summary>
<value>The symbol package format.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.Id">
<summary>
Gets or sets the package ID.
</summary>
<value>The package ID.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.Version">
<summary>
Gets or sets the nuspec version.
</summary>
<value>The nuspec version.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.Suffix">
<summary>
Gets or sets the nuspec version suffix.
</summary>
<value>The nuspec version suffix.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.Title">
<summary>
Gets or sets the package title.
</summary>
<value>The package title.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.Authors">
<summary>
Gets or sets the package authors.
</summary>
<value>The package authors.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.Owners">
<summary>
Gets or sets the package owners.
</summary>
<value>The package owners.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.Description">
<summary>
Gets or sets the package description.
</summary>
<value>The package description.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.Summary">
<summary>
Gets or sets the package summary.
</summary>
<value>The package summary.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.ProjectUrl">
<summary>
Gets or sets the package project URL.
</summary>
<value>The package project URL.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.Icon">
<summary>
Gets or sets the Icon path.
</summary>
<value>The path to the icon file contained within the NuGet package.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.IconUrl">
<summary>
Gets or sets the package icon URL.
</summary>
<value>The package icon URL.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.LicenseUrl">
<summary>
Gets or sets the package license URL.
</summary>
<value>The package license URL.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.Copyright">
<summary>
Gets or sets the package copyright.
</summary>
<value>The package copyright.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.ReleaseNotes">
<summary>
Gets or sets the package release notes.
</summary>
<value>The package release notes.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.Tags">
<summary>
Gets or sets the package tags.
</summary>
<value>The package tags.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.Serviceable">
<summary>
Gets or sets a value indicating whether this package should be marked as a serviceable.
</summary>
<value>
<c>true</c> if serviceable; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.Repository">
<summary>
Gets or sets the package repository data.
</summary>
<value>The package repository data.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.License">
<summary>
Gets or sets the package license.
</summary>
<value>The package license.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.PackageTypes">
<summary>
Gets or sets the package types.
</summary>
<value>The package types.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.FrameworkAssemblies">
<summary>
Gets or sets the package framework assemblies.
</summary>
<value>The package framework assemblies.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.DevelopmentDependency">
<summary>
Gets or sets a value indicating whether this package should be marked as a development dependency.
</summary>
<value>
<c>true</c> if a development dependency; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.RequireLicenseAcceptance">
<summary>
Gets or sets a value indicating whether users has to accept the package license.
</summary>
<value>
<c>true</c> if users has to accept the package license; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.References">
<summary>
Gets or sets the package references.
</summary>
<value>The package references.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.ContentFiles">
<summary>
Gets or sets the package content files.
</summary>
<value>The package content files.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.MinClientVersion">
<summary>
Gets or sets the package minimum client version.
</summary>
<value>The package minimum client version.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.Files">
<summary>
Gets or sets the package files.
</summary>
<value>The package files.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.Dependencies">
<summary>
Gets or sets the package dependencies.
</summary>
<value>The package files.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.Verbosity">
<summary>
Gets or sets the verbosity.
</summary>
<value>The verbosity.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.Properties">
<summary>
Gets or sets the properties.
</summary>
<value>
The properties.
</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.MSBuildVersion">
<summary>
Gets or sets the version of MSBuild to be used with this command.
By default the MSBuild in your path is picked, otherwise it defaults to the highest installed version of MSBuild.
This setting requires NuGet V3 or later.
</summary>
<value>The version of MSBuild to be used with this command.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.KeepTemporaryNuSpecFile">
<summary>
Gets or sets a value indicating whether the temporarily autogenerated NuSpec file should be kept or not.
Defaults to <c>false</c>.
</summary>
<value>
<c>true</c> if the temporarily autogenerated NuSpec file should be kept; otherwise <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.Language">
<summary>
Gets or sets the package language.
</summary>
<value>The package language.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetPackSettings.OutputToToolFolder">
<summary>
Gets or sets a value indicating whether the files should be packed into the tool folder.
Defaults to <c>false</c>.
</summary>
<value>
<c>true</c> if the output should be placed in the tool folder inside the NuGet package; otherwise <c>false</c>.
</value>
</member>
<member name="T:Cake.Common.Tools.NuGet.Pack.NuGetRepository">
<summary>
Specifies the package's source code location, allowing IDEs to download and debug the code.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetRepository.Type">
<summary>
Gets or sets the type of repository e.g. Git.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetRepository.Url">
<summary>
Gets or sets the repository's URL.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetRepository.Branch">
<summary>
Gets or sets the name of the branch within the repository.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuGetRepository.Commit">
<summary>
Gets or sets the corresponding commit ID for the specified version of the package.
</summary>
</member>
<member name="T:Cake.Common.Tools.NuGet.Pack.NuSpecContent">
<summary>
Represents a NuGet nuspec file.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuSpecContent.Source">
<summary>
Gets or sets the location of the file or files to include.
The path is relative to the NuSpec file unless an absolute path is specified.
The wildcard character - <c>*</c> - is allowed.
Using a double wildcard - <c>**</c> implies a recursive directory search.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuSpecContent.Target">
<summary>
Gets or sets the relative path to the directory within the package where the source files will be placed.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuSpecContent.Exclude">
<summary>
Gets or sets the file or files to exclude.
This is usually combined with a wildcard value in the <c>src</c> attribute.
The <c>exclude</c> attribute can contain a semi-colon delimited list of files or a file pattern.
Using a double wildcard - <c>**</c> - implies a recursive exclude pattern.
</summary>
</member>
<member name="T:Cake.Common.Tools.NuGet.Pack.NuSpecContentFile">
<summary>
Specifies the package's content to identify the exact files that are included in the package.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuSpecContentFile.Include">
<summary>
Gets or sets the location of the file or files to include.
The wildcard character - <c>*</c> - is allowed.
Using a double wildcard - <c>**</c> implies a recursive directory search.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuSpecContentFile.Exclude">
<summary>
Gets or sets files or file patterns to exclude from <c>src</c> location.
The wildcard character - <c>*</c> - is allowed.
Using a double wildcard - <c>**</c> implies a recursive directory search.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuSpecContentFile.BuildAction">
<summary>
Gets or sets the build action to assign to the content item for MSBuild, e.g. Compile.
Defaults to <c>Compile</c>.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuSpecContentFile.CopyToOutput">
<summary>
Gets or sets a value indicating whether to copy content items to the build (or publish) output folder.
Defaults to <c>false</c>.
</summary>
<value>
<c>true</c> if content items should be copied to the output folder; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuSpecContentFile.Flatten">
<summary>
Gets or sets a value indicating whether to copy content items to a single folder in the build output
or to preserve the folder structure in the package. This flag only works when <c>copyToOutput</c>
flag is set to true. Defaults to <c>false</c>.
</summary>
<value>
<c>true</c> if content items should be copied to a single folder; otherwise, <c>false</c>.
</value>
</member>
<member name="T:Cake.Common.Tools.NuGet.Pack.NuSpecDependency">
<summary>
Represents a NuGet nuspec dependency.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuSpecDependency.Id">
<summary>
Gets or sets the dependency's package ID.
</summary>
<value>The dependency's package ID.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuSpecDependency.Version">
<summary>
Gets or sets the dependency's version.
</summary>
<value>The dependency's version.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuSpecDependency.Include">
<summary>
Gets or sets a list of include/exclude tags indicating of the dependency to
include in the final package. The default value is <c>all</c>.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuSpecDependency.Exclude">
<summary>
Gets or sets a list of include/exclude tags indicating of the dependency to
exclude in the final package. The default value is <c>build,analyzers</c> which can
be over-written.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuSpecDependency.TargetFramework">
<summary>
Gets or sets the target framework for the dependency.
</summary>
<value>The target framework for the dependency.</value>
</member>
<member name="T:Cake.Common.Tools.NuGet.Pack.NuSpecFrameworkAssembly">
<summary>
Specifies framework assemblies to ensure that required references are added to a project.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuSpecFrameworkAssembly.AssemblyName">
<summary>
Gets or sets the fully qualified assembly name.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuSpecFrameworkAssembly.TargetFramework">
<summary>
Gets or sets the target framework to which this reference applies. If omitted,
indicates that the reference applies to all frameworks.
</summary>
</member>
<member name="T:Cake.Common.Tools.NuGet.Pack.NuSpecLicense">
<summary>
Specifies the package's SPDX license expression or path to a license file.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuSpecLicense.Type">
<summary>
Gets or sets the license type.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuSpecLicense.Version">
<summary>
Gets or sets the license version.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuSpecLicense.Value">
<summary>
Gets or sets SPDX license identifier.
</summary>
</member>
<member name="T:Cake.Common.Tools.NuGet.Pack.NuSpecPackageType">
<summary>
Specifies the package's package type that indicates its intended use.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuSpecPackageType.Name">
<summary>
Gets or sets the package type, e.g <c>DotnetCliTool</c>
Defaults to <c>Dependency</c>.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuSpecPackageType.Version">
<summary>
Gets or sets the version of the package type.
</summary>
</member>
<member name="T:Cake.Common.Tools.NuGet.Pack.NuSpecReference">
<summary>
Specifies the package's assemblies that the target project should reference when being used.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuSpecReference.File">
<summary>
Gets or sets file for the reference.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Pack.NuSpecReference.TargetFramework">
<summary>
Gets or sets the target framework for the reference.
</summary>
</member>
<member name="T:Cake.Common.Tools.NuGet.Push.NamespaceDoc">
<summary>
This namespace contain types used to
push NuGet packages.
</summary>
</member>
<member name="T:Cake.Common.Tools.NuGet.Push.NuGetPusher">
<summary>
The NuGet package pusher.
</summary>
</member>
<member name="M:Cake.Common.Tools.NuGet.Push.NuGetPusher.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Core.IO.NuGet.INuGetToolResolver,Cake.Core.Diagnostics.ICakeLog)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.NuGet.Push.NuGetPusher"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="resolver">The NuGet tool resolver.</param>
<param name="log">The logger.</param>
</member>
<member name="M:Cake.Common.Tools.NuGet.Push.NuGetPusher.Push(Cake.Core.IO.FilePath,Cake.Common.Tools.NuGet.Push.NuGetPushSettings)">
<summary>
Pushes a NuGet package to a NuGet server and publishes it.
</summary>
<param name="packageFilePath">The package file path.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.NuGet.Push.NuGetPushSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.NuGet.Push.NuGetPusher"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Push.NuGetPushSettings.Source">
<summary>
Gets or sets the server URL.
When using NuGet pre 3.4.2, this value is optional
and nuget.org is used if omitted (unless DefaultPushSource
config value is set in the NuGet config file.
When using NuGet 3.4.2 (or more recent), this value is mandatory.
Starting with NuGet 2.5, if NuGet.exe identifies a UNC/folder source,
it will perform the file copy to the source.
</summary>
<value>The server URL.</value>
<remarks>
For your convenience, here is the URL for some of the most popular
public NuGet servers:
- NuGet Gallery: https://nuget.org/api/v2/package
- MyGet: https://www.myget.org/F/<your_username>/api/v2/package.
</remarks>
</member>
<member name="P:Cake.Common.Tools.NuGet.Push.NuGetPushSettings.ApiKey">
<summary>
Gets or sets the API key for the server.
</summary>
<value>The API key for the server.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Push.NuGetPushSettings.Timeout">
<summary>
Gets or sets the timeout for pushing to a server.
Defaults to 300 seconds (5 minutes).
</summary>
<value>The timeout for pushing to a server.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Push.NuGetPushSettings.Verbosity">
<summary>
Gets or sets the verbosity.
</summary>
<value>The verbosity.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Push.NuGetPushSettings.ConfigFile">
<summary>
Gets or sets the NuGet configuration file.
</summary>
<value>The NuGet configuration file.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Push.NuGetPushSettings.SkipDuplicate">
<summary>
Gets or sets a value indicating whether to skip a package and continue with
the next package in the push, if any when a package with the same version
already exists.
</summary>
<value>
<c>true</c> if skipping duplicates; otherwise, <c>false</c>.
</value>
</member>
<member name="T:Cake.Common.Tools.NuGet.Restore.NamespaceDoc">
<summary>
This namespace contain types used to
restore NuGet packages.
</summary>
</member>
<member name="T:Cake.Common.Tools.NuGet.Restore.NuGetRestorer">
<summary>
The NuGet package restorer used to restore solution packages.
</summary>
</member>
<member name="M:Cake.Common.Tools.NuGet.Restore.NuGetRestorer.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Core.IO.NuGet.INuGetToolResolver)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.NuGet.Restore.NuGetRestorer"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="resolver">The NuGet tool resolver.</param>
</member>
<member name="M:Cake.Common.Tools.NuGet.Restore.NuGetRestorer.Restore(Cake.Core.IO.FilePath,Cake.Common.Tools.NuGet.Restore.NuGetRestoreSettings)">
<summary>
Restores NuGet packages using the specified settings.
</summary>
<param name="targetFilePath">The target file path.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.NuGet.Restore.NuGetRestoreSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.NuGet.Restore.NuGetRestorer"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Restore.NuGetRestoreSettings.RequireConsent">
<summary>
Gets or sets a value indicating whether package restore consent is granted before installing a package.
</summary>
<value>
<c>true</c> if package restore consent is granted; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Restore.NuGetRestoreSettings.PackagesDirectory">
<summary>
Gets or sets the packages folder.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Restore.NuGetRestoreSettings.Source">
<summary>
Gets or sets a list of packages sources to use for this command.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Restore.NuGetRestoreSettings.NoCache">
<summary>
Gets or sets a value indicating whether or not to use the machine cache as the first package source.
</summary>
<value>
<c>true</c> to not use the machine cache as the first package source; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Restore.NuGetRestoreSettings.DisableParallelProcessing">
<summary>
Gets or sets a value indicating whether or not to disable parallel processing of packages for this command.
</summary>
<value>
<c>true</c> to disable parallel processing; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Restore.NuGetRestoreSettings.Verbosity">
<summary>
Gets or sets the amount of output details.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Restore.NuGetRestoreSettings.ConfigFile">
<summary>
Gets or sets the NuGet configuration file.
If not specified, the file <c>%AppData%\NuGet\NuGet.config</c> is used as the configuration file.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Restore.NuGetRestoreSettings.FallbackSource">
<summary>
Gets or sets a list of packages sources to use as fallbacks for this command.
This setting requires NuGet V3 or later.
</summary>
<value>The list of packages sources to use as fallbacks for this command.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Restore.NuGetRestoreSettings.MSBuildVersion">
<summary>
Gets or sets the version of MSBuild to be used with this command.
By default the MSBuild in your path is picked, otherwise it defaults to the highest installed version of MSBuild.
This setting requires NuGet V3 or later.
</summary>
<value>The version of MSBuild to be used with this command.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Restore.NuGetRestoreSettings.MSBuildPath">
<summary>
Gets or sets the path of MSBuild to use.
This setting takes precedence over <c>-MSBuildVersion</c> and requires NuGet V4 or later.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Restore.NuGetRestoreSettings.NonInteractive">
<summary>
Gets or sets a value indicating whether or not NuGet suppresses prompts for user input or confirmations.
</summary>
<remarks>
This setting is passed by NuGet.exe to any extensions such as authorization providers.
</remarks>
<value>
<c>false</c> to allow NuGet to show prompts for user input or confirmations; otherwise, <c>true</c>.
</value>
</member>
<member name="T:Cake.Common.Tools.NuGet.SetApiKey.NamespaceDoc">
<summary>
This namespace contain types used to
set NuGet API keys.
</summary>
</member>
<member name="T:Cake.Common.Tools.NuGet.SetApiKey.NuGetSetApiKey">
<summary>
The NuGet set API key used to set API key used for API/feed authentication.
</summary>
</member>
<member name="M:Cake.Common.Tools.NuGet.SetApiKey.NuGetSetApiKey.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Core.IO.NuGet.INuGetToolResolver)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.NuGet.SetApiKey.NuGetSetApiKey"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="resolver">The NuGet tool resolver.</param>
</member>
<member name="M:Cake.Common.Tools.NuGet.SetApiKey.NuGetSetApiKey.SetApiKey(System.String,System.String,Cake.Common.Tools.NuGet.SetApiKey.NuGetSetApiKeySettings)">
<summary>
Installs NuGet packages using the specified package id and settings.
</summary>
<param name="apiKey">The API key.</param>
<param name="source">The Server URL where the API key is valid.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.NuGet.SetApiKey.NuGetSetApiKeySettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.NuGet.SetApiKey.NuGetSetApiKey"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.SetApiKey.NuGetSetApiKeySettings.Verbosity">
<summary>
Gets or sets the output verbosity.
</summary>
<value>The output verbosity.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.SetApiKey.NuGetSetApiKeySettings.ConfigFile">
<summary>
Gets or sets the NuGet configuration file.
If not specified, the file <c>%AppData%\NuGet\NuGet.config</c> is used as the configuration file.
</summary>
<value>The NuGet configuration file.</value>
</member>
<member name="T:Cake.Common.Tools.NuGet.SetProxy.NamespaceDoc">
<summary>
This namespace contain types used to
set proxy settings.
</summary>
</member>
<member name="T:Cake.Common.Tools.NuGet.SetProxy.NuGetSetProxy">
<summary>
The NuGet set command used to set the proxy settings to be used while connecting to your NuGet feed.
</summary>
</member>
<member name="M:Cake.Common.Tools.NuGet.SetProxy.NuGetSetProxy.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Core.IO.NuGet.INuGetToolResolver)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.NuGet.SetProxy.NuGetSetProxy"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="resolver">The NuGet tool resolver.</param>
</member>
<member name="M:Cake.Common.Tools.NuGet.SetProxy.NuGetSetProxy.SetProxy(System.String,System.String,System.String,Cake.Common.Tools.NuGet.SetProxy.NuGetSetProxySettings)">
<summary>
Set the proxy settings to be used while connecting to your NuGet feed.
</summary>
<param name="url">The url of the proxy.</param>
<param name="username">The username used to access the proxy.</param>
<param name="password">The password used to access the proxy.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.NuGet.SetProxy.NuGetSetProxySettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.NuGet.SetProxy.NuGetSetProxy"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.SetProxy.NuGetSetProxySettings.Verbosity">
<summary>
Gets or sets the output verbosity.
</summary>
<value>The output verbosity.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.SetProxy.NuGetSetProxySettings.ConfigFile">
<summary>
Gets or sets the NuGet configuration file.
If not specified, the file <c>%AppData%\NuGet\NuGet.config</c> is used as the configuration file.
</summary>
<value>The NuGet configuration file.</value>
</member>
<member name="T:Cake.Common.Tools.NuGet.Sources.NamespaceDoc">
<summary>
This namespace contain types used to
interact with NuGet sources.
</summary>
</member>
<member name="T:Cake.Common.Tools.NuGet.Sources.NuGetSources">
<summary>
The NuGet sources is used to work with user config feeds & credentials.
</summary>
</member>
<member name="M:Cake.Common.Tools.NuGet.Sources.NuGetSources.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Core.IO.NuGet.INuGetToolResolver)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.NuGet.Sources.NuGetSources"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="resolver">The NuGet tool resolver.</param>
</member>
<member name="M:Cake.Common.Tools.NuGet.Sources.NuGetSources.AddSource(System.String,System.String,Cake.Common.Tools.NuGet.Sources.NuGetSourcesSettings)">
<summary>
Adds NuGet package source using the specified settings to global user config.
</summary>
<param name="name">Name of the source.</param>
<param name="source">Path to the package(s) source.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.NuGet.Sources.NuGetSources.RemoveSource(System.String,System.String,Cake.Common.Tools.NuGet.Sources.NuGetSourcesSettings)">
<summary>
Remove specified NuGet package source.
</summary>
<param name="name">Name of the source.</param>
<param name="source">Path to the package(s) source.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.NuGet.Sources.NuGetSources.HasSource(System.String,Cake.Common.Tools.NuGet.Sources.NuGetSourcesSettings)">
<summary>
Determines whether the specified NuGet package source exist.
</summary>
<param name="source">Path to the package(s) source.</param>
<param name="settings">The settings.</param>
<returns>Whether the specified NuGet package source exist.</returns>
</member>
<member name="T:Cake.Common.Tools.NuGet.Sources.NuGetSourcesSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.NuGet.Sources.NuGetSources"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Sources.NuGetSourcesSettings.UserName">
<summary>
Gets or sets the (optional) user name.
</summary>
<value>Optional user name to be used when connecting to an authenticated source.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Sources.NuGetSourcesSettings.Password">
<summary>
Gets or sets the (optional) password.
</summary>
<value>Optional password to be used when connecting to an authenticated source.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Sources.NuGetSourcesSettings.Verbosity">
<summary>
Gets or sets the output verbosity.
</summary>
<value>The output verbosity.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Sources.NuGetSourcesSettings.IsSensitiveSource">
<summary>
Gets or sets a value indicating whether this source contains sensitive data, i.e. authentication token in url.
</summary>
<value>
<c>true</c> if this source contains sensitive data; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Sources.NuGetSourcesSettings.StorePasswordInClearText">
<summary>
Gets or sets a value indicating whether to not encrypt the password and store it in clear text. (Default: <c>false</c>).
</summary>
<value>
<c>true</c> if password is stored as unencrypted; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Sources.NuGetSourcesSettings.ConfigFile">
<summary>
Gets or sets the location of the NuGet configuration file. If not specified, file %AppData%\NuGet\NuGet.config is used as configuration file.
</summary>
</member>
<member name="T:Cake.Common.Tools.NuGet.Update.NamespaceDoc">
<summary>
This namespace contain types used to
update NuGet packages.
</summary>
</member>
<member name="T:Cake.Common.Tools.NuGet.Update.NuGetUpdater">
<summary>
The NuGet package updater.
</summary>
</member>
<member name="M:Cake.Common.Tools.NuGet.Update.NuGetUpdater.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Core.IO.NuGet.INuGetToolResolver)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.NuGet.Update.NuGetUpdater"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="resolver">The NuGet tool resolver.</param>
</member>
<member name="M:Cake.Common.Tools.NuGet.Update.NuGetUpdater.Update(Cake.Core.IO.FilePath,Cake.Common.Tools.NuGet.Update.NuGetUpdateSettings)">
<summary>
Updates NuGet packages using the specified settings.
</summary>
<param name="targetFile">The target file path.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.NuGet.Update.NuGetUpdateSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.NuGet.Update.NuGetUpdater"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Update.NuGetUpdateSettings.Id">
<summary>
Gets or sets the package ids to update.
</summary>
<value>The package ids to update.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Update.NuGetUpdateSettings.Source">
<summary>
Gets or sets a list of package sources to use for this command.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Update.NuGetUpdateSettings.Safe">
<summary>
Gets or sets a value indicating whether to look for updates with the highest
version available within the same major and minor version as the installed package.
</summary>
<value>
<c>true</c> if safe; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Update.NuGetUpdateSettings.Prerelease">
<summary>
Gets or sets a value indicating whether to allow updating to prerelease versions.
This flag is not required when updating prerelease packages that are already installed.
</summary>
<value>
<c>true</c> to allow updating to prerelease versions; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Update.NuGetUpdateSettings.Verbosity">
<summary>
Gets or sets the amount of output details.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Update.NuGetUpdateSettings.MSBuildVersion">
<summary>
Gets or sets the version of MSBuild to be used with this command.
By default the MSBuild in your path is picked, otherwise it defaults to the highest installed version of MSBuild.
This setting requires NuGet V3 or later.
</summary>
<value>The version of MSBuild to be used with this command.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Update.NuGetUpdateSettings.Version">
<summary>
Gets or sets package version to be used with this command.
</summary>
<value>The package version to be used with this command.</value>
</member>
<member name="T:Cake.Common.Tools.NuGet.Add.NuGetAdder">
<summary>
The NuGet package add tool used to add NuGet packages to folder or UNC shares.
</summary>
</member>
<member name="M:Cake.Common.Tools.NuGet.Add.NuGetAdder.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Core.IO.NuGet.INuGetToolResolver)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.NuGet.Add.NuGetAdder"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="resolver">The NuGet tool resolver.</param>
</member>
<member name="M:Cake.Common.Tools.NuGet.Add.NuGetAdder.Add(System.String,Cake.Common.Tools.NuGet.Add.NuGetAddSettings)">
<summary>
Adds NuGet packages to the package source, which is a folder or a UNC share. Http sources are not supported.
</summary>
<param name="packageId">The source package id.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.NuGet.Add.NuGetAddSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.NuGet.Add.NuGetAddSettings"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Add.NuGetAddSettings.Source">
<summary>
Gets or sets a a package sources to use for this command.
</summary>
<value>The package sources to use for this command.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Add.NuGetAddSettings.Expand">
<summary>
Gets or sets a value indicating whether a package added to an offline feed is also expanded.
</summary>
<value><c>true</c> if package should also be expanded; otherwise, <c>false</c>.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Add.NuGetAddSettings.Verbosity">
<summary>
Gets or sets the output verbosity.
</summary>
<value>The output verbosity.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Add.NuGetAddSettings.ConfigFile">
<summary>
Gets or sets the NuGet configuration file.
If not specified, the file <c>%AppData%\NuGet\NuGet.config</c> is used as the configuration file.
</summary>
<value>The NuGet configuration file.</value>
</member>
<member name="T:Cake.Common.Tools.NuGet.Delete.NuGetDeleter">
<summary>
The NuGet package pusher.
</summary>
</member>
<member name="M:Cake.Common.Tools.NuGet.Delete.NuGetDeleter.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Core.IO.NuGet.INuGetToolResolver,Cake.Core.Diagnostics.ICakeLog)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.NuGet.Delete.NuGetDeleter"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="resolver">The NuGet tool resolver.</param>
<param name="log">The logger.</param>
</member>
<member name="M:Cake.Common.Tools.NuGet.Delete.NuGetDeleter.Delete(System.String,System.String,Cake.Common.Tools.NuGet.Delete.NuGetDeleteSettings)">
<summary>
Deletes or unlists a package from a package source.
</summary>
<param name="packageID">The package ID (name).</param>
<param name="packageVersion">The package version.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.NuGet.Delete.NuGetDeleteSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.NuGet.Delete.NuGetDeleter"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Delete.NuGetDeleteSettings.Source">
<summary>
Gets or sets the server URL.
When using NuGet pre 3.4.2, this value is optional
and nuget.org is used if omitted (unless DefaultPushSource
config value is set in the NuGet config file.
When using NuGet 3.4.2 (or more recent), this value is mandatory.
Starting with NuGet 2.5, if NuGet.exe identifies a UNC/folder source,
it will perform the file copy to the source.
</summary>
<value>The server URL.</value>
<remarks>
For your convenience, here is the URL for some of the most popular
public NuGet servers:
- NuGet Gallery: https://nuget.org/api/v2/package
- MyGet: https://www.myget.org/F/<your_username>/api/v2/package.
</remarks>
</member>
<member name="P:Cake.Common.Tools.NuGet.Delete.NuGetDeleteSettings.ApiKey">
<summary>
Gets or sets the API key for the server.
</summary>
<value>The API key for the server.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Delete.NuGetDeleteSettings.Verbosity">
<summary>
Gets or sets the verbosity.
</summary>
<value>The verbosity.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Delete.NuGetDeleteSettings.ConfigFile">
<summary>
Gets or sets the NuGet configuration file.
</summary>
<value>The NuGet configuration file.</value>
</member>
<member name="T:Cake.Common.Tools.NuGet.Init.NuGetIniter">
<summary>
The NuGet package init tool copies all the packages from the source to the hierarchical destination.
</summary>
</member>
<member name="M:Cake.Common.Tools.NuGet.Init.NuGetIniter.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Core.IO.NuGet.INuGetToolResolver)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.NuGet.Init.NuGetIniter"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="resolver">The NuGet tool resolver.</param>
</member>
<member name="M:Cake.Common.Tools.NuGet.Init.NuGetIniter.Init(System.String,System.String,Cake.Common.Tools.NuGet.Init.NuGetInitSettings)">
<summary>
Init adds all the packages from the source to the hierarchical destination.
</summary>
<param name="sourcePackageSourcePath">Package source to be copied from.</param>
<param name="destinationPackageSourcePath">Package destination to be copied to.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.NuGet.Init.NuGetInitSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.NuGet.Init.NuGetInitSettings"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.Init.NuGetInitSettings.Expand">
<summary>
Gets or sets a value indicating whether a package added to an offline feed is also expanded.
</summary>
<value><c>true</c> if package should also be expanded; otherwise, <c>false</c>.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Init.NuGetInitSettings.Verbosity">
<summary>
Gets or sets the output verbosity.
</summary>
<value>The output verbosity.</value>
</member>
<member name="P:Cake.Common.Tools.NuGet.Init.NuGetInitSettings.ConfigFile">
<summary>
Gets or sets the NuGet configuration file.
If not specified, the file <c>%AppData%\NuGet\NuGet.config</c> is used as the configuration file.
</summary>
<value>The NuGet configuration file.</value>
</member>
<member name="T:Cake.Common.Tools.NuGet.List.NuGetList">
<summary>
The NuGet package lister used to list NuGet packages from a source.
</summary>
</member>
<member name="M:Cake.Common.Tools.NuGet.List.NuGetList.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Core.IO.NuGet.INuGetToolResolver)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.NuGet.List.NuGetList"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="resolver">The NuGet tool resolver.</param>
</member>
<member name="M:Cake.Common.Tools.NuGet.List.NuGetList.List(Cake.Common.Tools.NuGet.List.NuGetListSettings)">
<summary>
Lists available packages with their versions.
</summary>
<param name="settings">The settings.</param>
<returns>A list of available packages.</returns>
</member>
<member name="M:Cake.Common.Tools.NuGet.List.NuGetList.List(System.String,Cake.Common.Tools.NuGet.List.NuGetListSettings)">
<summary>
Lists available packages with their versions.
</summary>
<param name="packageId">The source package id. If it equals an empty string, it will match all packageIds.</param>
<param name="settings">The settings.</param>
<returns>A list of available packages.</returns>
</member>
<member name="T:Cake.Common.Tools.NuGet.List.NuGetListItem">
<summary>
An item as returned by <see cref="T:Cake.Common.Tools.NuGet.List.NuGetList"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.List.NuGetListItem.Name">
<summary>
Gets or sets the name of the NuGetListItem.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.List.NuGetListItem.Version">
<summary>
Gets or sets the version of the NuGetListItem as string.
</summary>
</member>
<member name="T:Cake.Common.Tools.NuGet.List.NuGetListSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.NuGet.List.NuGetList"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.List.NuGetListSettings.AllVersions">
<summary>
Gets or sets a value indicating whether list all versions of a package.By default, only the latest package version is displayed.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.List.NuGetListSettings.Prerelease">
<summary>
Gets or sets a value indicating whether to allow prerelease packages to be shown.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.List.NuGetListSettings.IncludeDelisted">
<summary>
Gets or sets a value indicating whether to allow unlisted packages to be shown.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.List.NuGetListSettings.ConfigFile">
<summary>
Gets or sets the NuGet configuration file. If not specified, file %AppData%\NuGet\NuGet.config is used as configuration file.
</summary>
</member>
<member name="P:Cake.Common.Tools.NuGet.List.NuGetListSettings.Source">
<summary>
Gets or sets a list of packages sources to search.
</summary>
</member>
<member name="T:Cake.Common.Tools.NuGet.NuGetAliases">
<summary>
Contains functionality for working with <see href="https://www.nuget.org/">NuGet</see>.
</summary>
<para>
Since Cake requires NuGet to be available very early in the build pipeline, we recommend that NuGet is made
available via the <see href="https://github.com/cake-build/resources">Cake Bootstrapper</see>.
</para>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetPack(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Common.Tools.NuGet.Pack.NuGetPackSettings)">
<summary>
Creates a NuGet package using the specified nuspec or project file.
</summary>
<param name="context">The context.</param>
<param name="filePath">The nuspec or project file path.</param>
<param name="settings">The settings.</param>
<example>
<code>
var nuGetPackSettings = new NuGetPackSettings {
Id = "TestNuGet",
Version = "0.0.0.1",
Title = "The tile of the package",
Authors = new[] {"John Doe"},
Owners = new[] {"Contoso"},
Description = "The description of the package",
Summary = "Excellent summary of what the package does",
ProjectUrl = new Uri("https://github.com/SomeUser/TestNuGet/"),
IconUrl = new Uri("http://cdn.rawgit.com/SomeUser/TestNuGet/master/icons/testNuGet.png"),
LicenseUrl = new Uri("https://github.com/SomeUser/TestNuGet/blob/master/LICENSE.md"),
Copyright = "Some company 2015",
ReleaseNotes = new [] {"Bug fixes", "Issue fixes", "Typos"},
Tags = new [] {"Cake", "Script", "Build"},
RequireLicenseAcceptance= false,
Symbols = false,
NoPackageAnalysis = true,
Files = new [] {
new NuSpecContent {Source = "bin/TestNuGet.dll", Target = "bin"},
},
BasePath = "./src/TestNuGet/bin/release",
OutputDirectory = "./NuGet"
};
NuGetPack("./nuspec/TestNuGet.nuspec", nuGetPackSettings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetPack(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.NuGet.Pack.NuGetPackSettings)">
<summary>
Creates NuGet packages using the specified nuspec or project files.
</summary>
<param name="context">The context.</param>
<param name="filePaths">The nuspec or project file paths.</param>
<param name="settings">The settings.</param>
<example>
<code>
var nuGetPackSettings = new NuGetPackSettings {
Id = "TestNuGet",
Version = "0.0.0.1",
Title = "The tile of the package",
Authors = new[] {"John Doe"},
Owners = new[] {"Contoso"},
Description = "The description of the package",
Summary = "Excellent summary of what the package does",
ProjectUrl = new Uri("https://github.com/SomeUser/TestNuGet/"),
IconUrl = new Uri("http://cdn.rawgit.com/SomeUser/TestNuGet/master/icons/testNuGet.png"),
LicenseUrl = new Uri("https://github.com/SomeUser/TestNuGet/blob/master/LICENSE.md"),
Copyright = "Some company 2015",
ReleaseNotes = new [] {"Bug fixes", "Issue fixes", "Typos"},
Tags = new [] {"Cake", "Script", "Build"},
RequireLicenseAcceptance= false,
Symbols = false,
NoPackageAnalysis = true,
Files = new [] {
new NuSpecContent {Source = "bin/TestNuGet.dll", Target = "bin"},
},
BasePath = "./src/TestNuGet/bin/release",
OutputDirectory = "./NuGet"
};
var nuspecFiles = GetFiles("./**/*.nuspec");
NuGetPack(nuspecFiles, nuGetPackSettings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetPack(Cake.Core.ICakeContext,Cake.Common.Tools.NuGet.Pack.NuGetPackSettings)">
<summary>
Creates a NuGet package using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="settings">The settings.</param>
<example>
<code>
var nuGetPackSettings = new NuGetPackSettings {
Id = "TestNuGet",
Version = "0.0.0.1",
Title = "The tile of the package",
Authors = new[] {"John Doe"},
Owners = new[] {"Contoso"},
Description = "The description of the package",
Summary = "Excellent summary of what the package does",
ProjectUrl = new Uri("https://github.com/SomeUser/TestNuGet/"),
IconUrl = new Uri("http://cdn.rawgit.com/SomeUser/TestNuGet/master/icons/testNuGet.png"),
LicenseUrl = new Uri("https://github.com/SomeUser/TestNuGet/blob/master/LICENSE.md"),
Copyright = "Some company 2015",
ReleaseNotes = new [] {"Bug fixes", "Issue fixes", "Typos"},
Tags = new [] {"Cake", "Script", "Build"},
RequireLicenseAcceptance= false,
Symbols = false,
NoPackageAnalysis = true,
Files = new [] {
new NuSpecContent {Source = "bin/TestNuGet.dll", Target = "bin"},
},
BasePath = "./src/TestNuGet/bin/release",
OutputDirectory = "./NuGet"
};
NuGetPack(nuGetPackSettings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetRestore(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Restores NuGet packages for the specified target.
</summary>
<param name="context">The context.</param>
<param name="targetFilePath">The target to restore.</param>
<example>
<code>
var solutions = GetFiles("./**/*.sln");
// Restore all NuGet packages.
foreach(var solution in solutions)
{
Information("Restoring {0}", solution);
NuGetRestore(solution);
}
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetRestore(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath})">
<summary>
Restores NuGet packages for the specified targets.
</summary>
<param name="context">The context.</param>
<param name="targetFilePaths">The targets to restore.</param>
<example>
<code>
var solutions = GetFiles("./**/*.sln");
NuGetRestore(solutions);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetRestore(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Common.Tools.NuGet.Restore.NuGetRestoreSettings)">
<summary>
Restores NuGet packages using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="targetFilePath">The target to restore.</param>
<param name="settings">The settings.</param>
<example>
<code>
var solutions = GetFiles("./**/*.sln");
// Restore all NuGet packages.
foreach(var solution in solutions)
{
Information("Restoring {0}", solution);
NuGetRestore(solution, new NuGetRestoreSettings { NoCache = true });
}
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetRestore(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.NuGet.Restore.NuGetRestoreSettings)">
<summary>
Restores NuGet packages using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="targetFilePaths">The targets to restore.</param>
<param name="settings">The settings.</param>
<example>
<code>
var solutions = GetFiles("./**/*.sln");
NuGetRestore(solutions, new NuGetRestoreSettings { NoCache = true });
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetPush(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Common.Tools.NuGet.Push.NuGetPushSettings)">
<summary>
Pushes a NuGet package to a NuGet server and publishes it.
</summary>
<param name="context">The context.</param>
<param name="packageFilePath">The <c>.nupkg</c> file path.</param>
<param name="settings">The settings.</param>
<example>
<para>NOTE: Starting with NuGet 3.4.2, the Source parameter is a mandatory parameter.</para>
<para>It is strongly recommended that you ALWAYS set the Source property within the <see cref="T:Cake.Common.Tools.NuGet.Push.NuGetPushSettings" /> instance.</para>
<code>
// Get the path to the package.
var package = "./nuget/SlackPRTGCommander.0.0.1.nupkg";
// Push the package.
NuGetPush(package, new NuGetPushSettings {
Source = "http://example.com/nugetfeed",
ApiKey = "4003d786-cc37-4004-bfdf-c4f3e8ef9b3a"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetPush(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.NuGet.Push.NuGetPushSettings)">
<summary>
Pushes NuGet packages to a NuGet server and publishes them.
</summary>
<param name="context">The context.</param>
<param name="packageFilePaths">The <c>.nupkg</c> file paths.</param>
<param name="settings">The settings.</param>
<example>
<para>NOTE: Starting with NuGet 3.4.2, the Source parameter is a mandatory parameter.</para>
<para>It is strongly recommended that you ALWAYS set the Source property within the <see cref="T:Cake.Common.Tools.NuGet.Push.NuGetPushSettings" /> instance.</para>
<code>
// Get the paths to the packages.
var packages = GetFiles("./**/*.nupkg");
// Push the package.
NuGetPush(packages, new NuGetPushSettings {
Source = "http://example.com/nugetfeed",
ApiKey = "4003d786-cc37-4004-bfdf-c4f3e8ef9b3a"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetAddSource(Cake.Core.ICakeContext,System.String,System.String)">
<summary>
Adds NuGet package source using the specified name &source to global user config.
</summary>
<param name="context">The context.</param>
<param name="name">Name of the source.</param>
<param name="source">Path to the package(s) source.</param>
<example>
<code>
var feed = new
{
Name = EnvironmentVariable("PUBLIC_FEED_NAME"),
Source = EnvironmentVariable("PUBLIC_FEED_SOURCE")
};
NuGetAddSource(
name:feed.Name,
source:feed.Source
);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetAddSource(Cake.Core.ICakeContext,System.String,System.String,Cake.Common.Tools.NuGet.Sources.NuGetSourcesSettings)">
<summary>
Adds NuGet package source using the specified name, source & settings to global user config.
</summary>
<param name="context">The context.</param>
<param name="name">Name of the source.</param>
<param name="source">Path to the package(s) source.</param>
<param name="settings">The settings.</param>
<example>
<code>
var nugetSourceSettings = new NuGetSourcesSettings
{
UserName = EnvironmentVariable("PRIVATE_FEED_USERNAME"),
Password = EnvironmentVariable("PRIVATE_FEED_PASSWORD"),
IsSensitiveSource = true,
Verbosity = NuGetVerbosity.Detailed
};
var feed = new
{
Name = EnvironmentVariable("PRIVATE_FEED_NAME"),
Source = EnvironmentVariable("PRIVATE_FEED_SOURCE")
};
NuGetAddSource(
name:feed.Name,
source:feed.Source,
settings:nugetSourceSettings
);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetRemoveSource(Cake.Core.ICakeContext,System.String,System.String)">
<summary>
Removes NuGet package source using the specified name & source from global user config.
</summary>
<param name="context">The context.</param>
<param name="name">Name of the source.</param>
<param name="source">Path to the package(s) source.</param>
<example>
<code>
var feed = new
{
Name = EnvironmentVariable("PRIVATE_FEED_NAME"),
Source = EnvironmentVariable("PRIVATE_FEED_SOURCE")
};
NuGetRemoveSource(
name:feed.Name,
source:feed.Source
);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetRemoveSource(Cake.Core.ICakeContext,System.String,System.String,Cake.Common.Tools.NuGet.Sources.NuGetSourcesSettings)">
<summary>
Removes NuGet package source using the specified name, source & settings from global user config.
</summary>
<param name="context">The context.</param>
<param name="name">Name of the source.</param>
<param name="source">Path to the package(s) source.</param>
<param name="settings">The settings.</param>
<example>
<code>
var nugetSourceSettings = new NuGetSourcesSettings
{
UserName = EnvironmentVariable("PRIVATE_FEED_USERNAME"),
Password = EnvironmentVariable("PRIVATE_FEED_PASSWORD"),
IsSensitiveSource = true,
Verbosity = NuGetVerbosity.Detailed
};
var feed = new
{
Name = EnvironmentVariable("PRIVATE_FEED_NAME"),
Source = EnvironmentVariable("PRIVATE_FEED_SOURCE")
};
NuGetRemoveSource(
name:feed.Name,
source:feed.Source,
settings:nugetSourceSettings
);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetHasSource(Cake.Core.ICakeContext,System.String)">
<summary>
Checks whether or not a NuGet package source exists in the global user configuration, using the specified source.
</summary>
<param name="context">The context.</param>
<param name="source">Path to the package(s) source.</param>
<returns>Whether or not the NuGet package source exists in the global user configuration.</returns>
<example>
<code>
var feed = new
{
Name = EnvironmentVariable("PRIVATE_FEED_NAME"),
Source = EnvironmentVariable("PRIVATE_FEED_SOURCE")
};
if (!NuGetHasSource(source:feed.Source))
{
Information("Source missing");
}
else
{
Information("Source already exists");
}
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetHasSource(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.NuGet.Sources.NuGetSourcesSettings)">
<summary>
Checks whether or not a NuGet package source exists in the global user configuration, using the specified source and settings.
</summary>
<param name="context">The context.</param>
<param name="source">Path to the package(s) source.</param>
<param name="settings">The settings.</param>
<returns>Whether the specified NuGet package source exist.</returns>
<example>
<code>
var nugetSourceSettings = new NuGetSourcesSettings
{
UserName = EnvironmentVariable("PRIVATE_FEED_USERNAME"),
Password = EnvironmentVariable("PRIVATE_FEED_PASSWORD"),
IsSensitiveSource = true,
Verbosity = NuGetVerbosity.Detailed
};
var feed = new
{
Name = EnvironmentVariable("PRIVATE_FEED_NAME"),
Source = EnvironmentVariable("PRIVATE_FEED_SOURCE")
};
if (!NuGetHasSource(
source:feed.Source,
settings:nugetSourceSettings))
{
Information("Source missing");
}
else
{
Information("Source already exists");
}
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetInstall(Cake.Core.ICakeContext,System.String)">
<summary>
Installs a NuGet package.
</summary>
<param name="context">The context.</param>
<param name="packageId">The id of the package to install.</param>
<example>
<code>
NuGetInstall("MyNuGetPackage");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetInstall(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{System.String})">
<summary>
Installs NuGet packages.
</summary>
<param name="context">The context.</param>
<param name="packageIds">The id's of the package to install.</param>
<example>
<code>
NuGetInstall(new[] { "MyNuGetPackage", "OtherNuGetPackage" });
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetInstall(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.NuGet.Install.NuGetInstallSettings)">
<summary>
Installs a NuGet package using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="packageId">The id of the package to install.</param>
<param name="settings">The settings.</param>
<example>
<code>
NuGetInstall("MyNuGetPackage", new NuGetInstallSettings {
ExcludeVersion = true,
OutputDirectory = "./tools"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetInstall(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{System.String},Cake.Common.Tools.NuGet.Install.NuGetInstallSettings)">
<summary>
Installs NuGet packages using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="packageIds">The id's of the package to install.</param>
<param name="settings">The settings.</param>
<example>
<code>
NuGetInstall(new[] { "MyNuGetPackage", "OtherNuGetPackage" }, new NuGetInstallSettings {
ExcludeVersion = true,
OutputDirectory = "./tools"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetInstallFromConfig(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Installs NuGet packages using the specified package configuration.
</summary>
<param name="context">The context.</param>
<param name="packageConfigPath">The package configuration to install.</param>
<example>
<code>
NuGetInstallFromConfig("./tools/packages.config");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetInstallFromConfig(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath})">
<summary>
Installs NuGet packages using the specified package configurations.
</summary>
<param name="context">The context.</param>
<param name="packageConfigPaths">The package configurations to install.</param>
<example>
<code>
var packageConfigs = GetFiles("./**/packages.config");
NuGetInstallFromConfig(packageConfigs);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetInstallFromConfig(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Common.Tools.NuGet.Install.NuGetInstallSettings)">
<summary>
Installs NuGet packages using the specified package configuration and settings.
</summary>
<param name="context">The context.</param>
<param name="packageConfigPath">The package configuration to install.</param>
<param name="settings">The settings.</param>
<example>
<code>
NuGetInstallFromConfig("./tools/packages.config", new NuGetInstallSettings {
ExcludeVersion = true,
OutputDirectory = "./tools"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetInstallFromConfig(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.NuGet.Install.NuGetInstallSettings)">
<summary>
Installs NuGet packages using the specified package configurations and settings.
</summary>
<param name="context">The context.</param>
<param name="packageConfigPaths">The package configurations to install.</param>
<param name="settings">The settings.</param>
<example>
<code>
var packageConfigs = GetFiles("./**/packages.config");
NuGetInstallFromConfig(packageConfigs, new NuGetInstallSettings {
ExcludeVersion = true,
OutputDirectory = "./tools"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetSetApiKey(Cake.Core.ICakeContext,System.String,System.String,Cake.Common.Tools.NuGet.SetApiKey.NuGetSetApiKeySettings)">
<summary>
Installs NuGet packages using the specified API key, source and settings.
</summary>
<example>
<code>
var setting = new NuGetSetApiKeySettings {
Verbosity = NuGetVerbosity.Detailed
};
NuGetSetApiKey("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "https://nuget.org/api/v2/", setting);
</code>
</example>
<param name="context">The context.</param>
<param name="apiKey">The API key.</param>
<param name="source">Server URL where the API key is valid.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetSetApiKey(Cake.Core.ICakeContext,System.String,System.String)">
<summary>
Installs NuGet packages using the specified API key and source.
</summary>
<example>
<code>
NuGetSetApiKey("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "https://nuget.org/api/v2/");
</code>
</example>
<param name="context">The context.</param>
<param name="apiKey">The API key.</param>
<param name="source">Server URL where the API key is valid.</param>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetSetProxy(Cake.Core.ICakeContext,System.String,System.String,System.String,Cake.Common.Tools.NuGet.SetProxy.NuGetSetProxySettings)">
<summary>
Set the proxy settings to be used while connecting to your NuGet feed, including settings.
</summary>
<example>
<code>
var setting = new NuGetSetProxySettings {
Verbosity = NuGetVerbosity.Detailed
};
NuGetSetProxy("127.0.0.1:8080", "proxyuser","Pa$$w0rd1", setting);
</code>
</example>
<param name="context">The context.</param>
<param name="proxy">The url of the proxy.</param>
<param name="username">The username used to access the proxy.</param>
<param name="password">The password used to access the proxy.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetSetProxy(Cake.Core.ICakeContext,System.String,System.String,System.String)">
<summary>
Set the proxy settings to be used while connecting to your NuGet feed.
</summary>
<example>
<code>
NuGetSetProxy("127.0.0.1:8080", "proxyuser","Pa$$w0rd1");
</code>
</example>
<param name="context">The context.</param>
<param name="proxy">The url of the proxy.</param>
<param name="username">The username used to access the proxy.</param>
<param name="password">The password used to access the proxy.</param>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetUpdate(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Updates NuGet packages.
</summary>
<param name="context">The context.</param>
<param name="targetFile">The target to update.</param>
<example>
<code>
NuGetUpdate("./tools/packages.config");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetUpdate(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath})">
<summary>
Updates NuGet packages.
</summary>
<param name="context">The context.</param>
<param name="targetFiles">The targets to update.</param>
<example>
<code>
var targets = GetFiles("./**/packages.config");
NuGetUpdate(targets);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetUpdate(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Common.Tools.NuGet.Update.NuGetUpdateSettings)">
<summary>
Updates NuGet packages using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="targetFile">The target to update.</param>
<param name="settings">The settings.</param>
<example>
<code>
NuGetUpdate("./tools/packages.config", new NuGetUpdateSettings {
Prerelease = true,
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetUpdate(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.NuGet.Update.NuGetUpdateSettings)">
<summary>
Updates NuGet packages using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="targetFiles">The targets to update.</param>
<param name="settings">The settings.</param>
<example>
<code>
var targets = GetFiles("./**/packages.config");
NuGetUpdate(targets, new NuGetUpdateSettings {
Prerelease = true,
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetAdd(Cake.Core.ICakeContext,System.String,System.String)">
<summary>
Adds a NuGet package using package id and source.
</summary>
<param name="context">The context.</param>
<param name="packageId">The id of the package to add.</param>
<param name="source">Path to the local feed source.</param>
<example>
<code>
NuGetAdd("MyNuGetPackage", "//bar/packages/");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetAdd(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.NuGet.Add.NuGetAddSettings)">
<summary>
Adds a NuGet package using package id and source.
</summary>
<param name="context">The context.</param>
<param name="packageId">The id of the package to add.</param>
<param name="settings">The settings.</param>
<example>
<code>
NuGetAdd("MyNuGetPackage", new NuGetAddSettings {
Source = "//bar/packages/"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetInit(Cake.Core.ICakeContext,System.String,System.String)">
<summary>
Adds all packages from source to destination.
</summary>
<param name="context">The context.</param>
<param name="source">The local feed package source.</param>
<param name="destination">The local feed destination source.</param>
<example>
<code>
NuGetInit("//foo/packages", "//bar/packages/");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetInit(Cake.Core.ICakeContext,System.String,System.String,Cake.Common.Tools.NuGet.Init.NuGetInitSettings)">
<summary>
Adds all packages from source to destination using specified settings.
</summary>
<param name="context">The context.</param>
<param name="source">The local feed package source.</param>
<param name="destination">The local feed destination source.</param>
<param name="settings">The settings.</param>
<example>
<code>
NuGetInit("//foo/packages", "//bar/packages/", new NuGetInitSettings {
Expand = true
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetList(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.NuGet.List.NuGetListSettings)">
<summary>
List packages on available from source using specified settings.
</summary>
<param name="context">The context.</param>
<param name="packageId">The package Id.</param>
<param name="settings">The settings.</param>
<returns>List of packages with their version.</returns>
<example>
<code>
var packageList = NuGetList("Cake", new NuGetListSettings {
AllVersions = false,
Prerelease = false
});
foreach(var package in packageList)
{
Information("Found package {0}, version {1}", package.Name, package.Version);
}
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetList(Cake.Core.ICakeContext,System.String)">
<summary>
List packages on available from source using specified settings.
</summary>
<param name="context">The context.</param>
<param name="packageId">The package Id.</param>
<returns>List of packages with their version.</returns>
<example>
<code>
var packageList = NuGetList("Cake");
foreach(var package in packageList)
{
Information("Found package {0}, version {1}", package.Name, package.Version);
}
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetList(Cake.Core.ICakeContext,Cake.Common.Tools.NuGet.List.NuGetListSettings)">
<summary>
List packages on available from source using specified settings.
</summary>
<param name="context">The context.</param>
<param name="settings">The settings.</param>
<returns>List of packages with their version.</returns>
<example>
<code>
var packageList = NuGetList(new NuGetListSettings {
AllVersions = false,
Prerelease = false
});
foreach(var package in packageList)
{
Information("Found package {0}, version {1}", package.Name, package.Version);
}
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetAliases.NuGetDelete(Cake.Core.ICakeContext,System.String,System.String,Cake.Common.Tools.NuGet.Delete.NuGetDeleteSettings)">
<summary>
Deletes or unlists a package from a package source.
</summary>
<param name="context">The context.</param>
<param name="packageID">The package ID (name).</param>
<param name="packageVersion">The package version.</param>
<param name="settings">The settings.</param>
<example>
<para>NOTE: Starting with NuGet 3.4.2, the Source parameter is a mandatory parameter.</para>
<para>It is strongly recommended that you ALWAYS set the Source property within the <see cref="T:Cake.Common.Tools.NuGet.Delete.NuGetDeleteSettings" /> instance.</para>
<code>
// Delete the package.
NuGetDelete("PackageName", "PackageVersion", new NuGetPushSettings {
Source = "http://example.com/nugetfeed",
ApiKey = "4003d786-cc37-4004-bfdf-c4f3e8ef9b3a"
});
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.NuGet.NuGetMSBuildVersion">
<summary>
NuGet MSBuild version.
</summary>
</member>
<member name="F:Cake.Common.Tools.NuGet.NuGetMSBuildVersion.MSBuild4">
<summary>
MSBuildVersion : <c>4</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.NuGet.NuGetMSBuildVersion.MSBuild12">
<summary>
MSBuildVersion : <c>12</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.NuGet.NuGetMSBuildVersion.MSBuild14">
<summary>
MSBuildVersion : <c>14</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.NuGet.NuGetMSBuildVersion.MSBuild15_1">
<summary>
MSBuildVersion : <c>15.1</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.NuGet.NuGetMSBuildVersion.MSBuild15_3">
<summary>
MSBuildVersion : <c>15.3</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.NuGet.NuGetMSBuildVersion.MSBuild15_4">
<summary>
MSBuildVersion : <c>15.4</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.NuGet.NuGetMSBuildVersion.MSBuild15_5">
<summary>
MSBuildVersion : <c>15.5</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.NuGet.NuGetMSBuildVersion.MSBuild15_6">
<summary>
MSBuildVersion : <c>15.6</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.NuGet.NuGetMSBuildVersion.MSBuild15_7">
<summary>
MSBuildVersion : <c>15.7</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.NuGet.NuGetMSBuildVersion.MSBuild15_8">
<summary>
MSBuildVersion : <c>15.8</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.NuGet.NuGetMSBuildVersion.MSBuild15_9">
<summary>
MSBuildVersion : <c>15.9</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.NuGet.NuGetMSBuildVersion.MSBuild16_0">
<summary>
MSBuildVersion : <c>16.0</c>
</summary>
</member>
<member name="T:Cake.Common.Tools.NuGet.NuGetMSBuildVersionExtensions">
<summary>
Contains extension methods for <see cref="T:Cake.Common.Tools.NuGet.NuGetMSBuildVersion"/>.
</summary>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetMSBuildVersionExtensions.GetNuGetMSBuildVersionString(Cake.Common.Tools.NuGet.NuGetMSBuildVersion)">
<summary>
Gets the string with MSBuild version.
</summary>
<param name="nuGetMSBuildVersion">The NuGet MSBuild version.</param>
<returns>The string with MSBuild version.</returns>
</member>
<member name="T:Cake.Common.Tools.NuGet.NuGetTool`1">
<summary>
Base class for all NuGet related tools.
</summary>
<typeparam name="TSettings">The settings type.</typeparam>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetTool`1.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Core.IO.NuGet.INuGetToolResolver)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.NuGet.NuGetTool`1"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="resolver">The NuGet tool resolver.</param>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetTool`1.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetTool`1.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="M:Cake.Common.Tools.NuGet.NuGetTool`1.GetAlternativeToolPaths(`0)">
<summary>
Gets alternative file paths which the tool may exist in.
</summary>
<param name="settings">The settings.</param>
<returns>The default tool path.</returns>
</member>
<member name="T:Cake.Common.Tools.NuGet.NuGetVerbosity">
<summary>
Represents NuGet verbosity.
</summary>
</member>
<member name="F:Cake.Common.Tools.NuGet.NuGetVerbosity.Normal">
<summary>
Verbosity: <c>Normal</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.NuGet.NuGetVerbosity.Quiet">
<summary>
Verbosity: <c>Quiet</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.NuGet.NuGetVerbosity.Detailed">
<summary>
Verbosity: <c>Detailed</c>
</summary>
</member>
<member name="T:Cake.Common.Tools.NUnit.NamespaceDoc">
<summary>
This namespace contain types used to interact with NUnit.
</summary>
</member>
<member name="T:Cake.Common.Tools.NUnit.NUnit3Aliases">
<summary>
<para>Contains functionality related to running <see href="https://github.com/nunit/nunit">NUnit</see> v2 and v3 unit tests.</para>
<para>
In order to use the commands for this alias, include the following in your build.cake file to download and
install from nuget.org, or specify the ToolPath within the <see cref="T:Cake.Common.Tools.NUnit.NUnit3Settings" /> class:
<code>
#tool "nuget:?package=NUnit.ConsoleRunner"
</code>
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.NUnit.NUnit3Aliases.NUnit3(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern)">
<summary>
Runs all NUnit unit tests in the assemblies matching the specified pattern.
</summary>
<param name="context">The context.</param>
<param name="pattern">The pattern.</param>
<example>
<code>
NUnit3("./src/**/bin/Release/*.Tests.dll");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NUnit.NUnit3Aliases.NUnit3(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern,Cake.Common.Tools.NUnit.NUnit3Settings)">
<summary>
Runs all NUnit unit tests in the assemblies matching the specified pattern,
using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="pattern">The pattern.</param>
<param name="settings">The settings.</param>
<example>
<code>
NUnit3("./src/**/bin/Release/*.Tests.dll", new NUnit3Settings {
NoResults = true
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NUnit.NUnit3Aliases.NUnit3(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{System.String})">
<summary>
Runs all NUnit unit tests in the specified assemblies.
</summary>
<param name="context">The context.</param>
<param name="assemblies">The assemblies.</param>
<example>
<code>
NUnit3(new [] { "./src/Example.Tests/bin/Release/Example.Tests.dll" });
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NUnit.NUnit3Aliases.NUnit3(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath})">
<summary>
Runs all NUnit unit tests in the specified assemblies.
</summary>
<param name="context">The context.</param>
<param name="assemblies">The assemblies.</param>
<example>
<code>
var testAssemblies = GetFiles("./src/**/bin/Release/*.Tests.dll");
NUnit3(testAssemblies);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NUnit.NUnit3Aliases.NUnit3(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{System.String},Cake.Common.Tools.NUnit.NUnit3Settings)">
<summary>
Runs all NUnit unit tests in the specified assemblies,
using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="assemblies">The assemblies.</param>
<param name="settings">The settings.</param>
<example>
<code>
NUnit3(new [] { "./src/Example.Tests/bin/Release/Example.Tests.dll" }, new NUnit3Settings {
NoResults = true
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NUnit.NUnit3Aliases.NUnit3(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.NUnit.NUnit3Settings)">
<summary>
Runs all NUnit unit tests in the specified assemblies,
using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="assemblies">The assemblies.</param>
<param name="settings">The settings.</param>
<example>
<code>
var testAssemblies = GetFiles("./src/**/bin/Release/*.Tests.dll");
NUnit3(testAssemblies, new NUnit3Settings {
NoResults = true
});
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.NUnit.NUnit3AppDomainUsage">
<summary>
The /domain option controls of the creation of AppDomains for running tests.
</summary>
</member>
<member name="F:Cake.Common.Tools.NUnit.NUnit3AppDomainUsage.Default">
<summary>
Create a separate AppDomain for each assembly if more than one is listed on the command
line, otherwise creates a single AppDomain.
</summary>
</member>
<member name="F:Cake.Common.Tools.NUnit.NUnit3AppDomainUsage.None">
<summary>
No AppDomain is created - the tests are run in the primary domain.
This normally requires copying the NUnit assemblies into the same directory as your tests.
</summary>
</member>
<member name="F:Cake.Common.Tools.NUnit.NUnit3AppDomainUsage.Single">
<summary>
A single test AppDomain is created for all test assemblies
This is how NUnit worked prior to version 2.4.
</summary>
</member>
<member name="F:Cake.Common.Tools.NUnit.NUnit3AppDomainUsage.Multiple">
<summary>
An AppDomain is created for each assembly specified on the command line.
</summary>
</member>
<member name="T:Cake.Common.Tools.NUnit.NUnit3Labels">
<summary>
Represents the possible values for the Labels option.
</summary>
</member>
<member name="F:Cake.Common.Tools.NUnit.NUnit3Labels.Off">
<summary>
Does not output labels. This is the default.
</summary>
</member>
<member name="F:Cake.Common.Tools.NUnit.NUnit3Labels.On">
<summary>
Outputs labels for tests that are run.
</summary>
</member>
<member name="F:Cake.Common.Tools.NUnit.NUnit3Labels.All">
<summary>
Outputs labels for all tests.
</summary>
</member>
<member name="F:Cake.Common.Tools.NUnit.NUnit3Labels.Before">
<summary>
Outputs labels at the start of every test.
</summary>
</member>
<member name="F:Cake.Common.Tools.NUnit.NUnit3Labels.After">
<summary>
Outputs labels at the end of every test.
</summary>
</member>
<member name="T:Cake.Common.Tools.NUnit.NUnit3ProcessOption">
<summary>
Represents the various ways NUnit loads tests in processes.
</summary>
</member>
<member name="F:Cake.Common.Tools.NUnit.NUnit3ProcessOption.Multiple">
<summary>
A separate process is created for each test assembly. This is the default.
</summary>
</member>
<member name="F:Cake.Common.Tools.NUnit.NUnit3ProcessOption.Separate">
<summary>
One separate process is created to run all of the test assemblies.
</summary>
</member>
<member name="F:Cake.Common.Tools.NUnit.NUnit3ProcessOption.InProcess">
<summary>
All the tests are run in the nunit-console process.
</summary>
</member>
<member name="T:Cake.Common.Tools.NUnit.NUnit3Result">
<summary>
Contains information for the results that should be exported.
</summary>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Result.FileName">
<summary>
Gets or sets the name of the XML result file.
</summary>
<value>
The name of the XML result file. Defaults to <c>TestResult.xml</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Result.Format">
<summary>
Gets or sets the format that the results should be in. <see cref="P:Cake.Common.Tools.NUnit.NUnit3Result.FileName"/> must be set to
have any effect. Specify nunit2 to output the results in NUnit 2 xml format.
nunit3 may be specified for NUnit 3 format, however this is the default. Additional
formats may be supported in the future, check the NUnit documentation.
</summary>
<value>
The format of the result file. Defaults to <c>nunit3</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Result.Transform">
<summary>
Gets or sets the file name of an XSL transform that will be applied to the results.
</summary>
<value>
The name of an XSLT file that will be applied to the results.
</value>
</member>
<member name="T:Cake.Common.Tools.NUnit.NUnit3Runner">
<summary>
The NUnit3 unit test runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.NUnit.NUnit3Runner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.NUnit.NUnit3Runner"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.NUnit.NUnit3Runner.Run(System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.NUnit.NUnit3Settings)">
<summary>
Runs the tests in the specified assemblies, using the specified settings.
</summary>
<param name="assemblyPaths">The assembly paths.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.NUnit.NUnit3Runner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.NUnit.NUnit3Runner.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="M:Cake.Common.Tools.NUnit.NUnit3Runner.ProcessExitCode(System.Int32)">
<summary>
Customized NUnit 3 exit code handling.
Throws <see cref="T:Cake.Core.CakeException"/> on non-zero exit code.
</summary>
<param name="exitCode">The process exit code.</param>
</member>
<member name="T:Cake.Common.Tools.NUnit.NUnit3Settings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.NUnit.NUnit3Runner" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.Test">
<summary>
Gets or sets the list of tests to run or explore.
</summary>
<value>
A comma-separated list of test names.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.TestList">
<summary>
Gets or sets a file containing the tests to run.
</summary>
<value>
File path containing a list of tests to run, one per line.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.Where">
<summary>
Gets or sets the test selection expression indicating what tests will be run.
</summary>
<value>
The --where option is intended to extend or replace the earlier
--test, --include and --exclude options by use of a selection expression
describing exactly which tests to use. Examples of usage are:
--where:cat==Data
--where "method =~ /DataTest*/ && cat = Slow"
See <a href="https://github.com/nunit/docs/wiki/Test-Selection-Language">https://github.com/nunit/docs/wiki/Test-Selection-Language</a>.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.Timeout">
<summary>
Gets or sets the default timeout to be used for test cases in this run.
If any test exceeds the timeout value, it is cancelled and reported as an error.
</summary>
<value>
The timeout in milliseconds.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.Seed">
<summary>
Gets or sets the random seed used to generate test cases.
</summary>
<value>
The random seed.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.Workers">
<summary>
Gets or sets the number of worker threads to be used
in running tests.If not specified, defaults to
2 or the number of processors, whichever is greater.
</summary>
<value>
The number of worker threads.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.StopOnError">
<summary>
Gets or sets a value indicating whether execution of the test run should terminate
immediately on the first test failure or error.
</summary>
<value>
<c>true</c> if execution of the test run should terminate immediately on the first test failure or error;
otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.SkipNonTestAssemblies">
<summary>
Gets or sets a value indicating whether execution of the test run should
skip any non-test assemblies specified, without error.
</summary>
<value>
<c>true</c> if execution of the test run should skip any non-test assemblies specified, without error;
otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.Work">
<summary>
Gets or sets the directory to use for output files. If
not specified, defaults to the current directory.
</summary>
<value>
PATH of the directory.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.OutputFile">
<summary>
Gets or sets the location that NUnit should write test output.
</summary>
<value>The location that NUnit should write test output.</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.Results">
<summary>
Gets or sets the results that should be saved.
</summary>
<value>The package owners.</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.NoResults">
<summary>
Gets or sets a value indicating whether to generate the XML result file.
</summary>
<value>
<c>true</c> if the XML result file should be generated; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.Labels">
<summary>
Gets or sets a value specifying whether to write test case names to the output.
</summary>
<value>
<c>On</c> to write labels for tests that are run,<c>All</c> to write labels
for all tests,<c>Before</c> to write labels at the start of every test
,or <c>After</c> to write labels at the end of every test.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.TeamCity">
<summary>
Gets or sets a value indicating whether to turn on TeamCity service messages.
</summary>
<value>
<c>true</c> to turn on TeamCity service messages; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.NoHeader">
<summary>
Gets or sets a value indicating whether to show copyright information at the start of the program.
</summary>
<value>
<c>true</c> if to show copyright information at the start of the program; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.NoColor">
<summary>
Gets or sets a value indicating whether to show the output in color.
</summary>
<value>
<c>true</c> disable color output; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.Configuration">
<summary>
Gets or sets the name of a project configuration to load (e.g.:Debug).
This selects the configuration within the NUnit project file.
</summary>
<value>
The name of the configuration to load.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.X86">
<summary>
Gets or sets a value indicating whether to run tests in an x86 process on 64 bit systems.
</summary>
<value>
<c>true</c> to run tests in an x86 process on 64 bit systems; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.DisposeRunners">
<summary>
Gets or sets a value indicating whether to Dispose each test runner after it has finished
running its tests.
</summary>
<value>
<c>true</c> to Dispose each test runner after it has finished
running its tests; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.ShadowCopy">
<summary>
Gets or sets a value indicating whether to shadow copy tests.
Default value is <c>false</c>.
</summary>
<value>
<c>true</c> if tests should be run as a shadow copy; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.Framework">
<summary>
Gets or sets the version of the runtime to be used when executing tests.
</summary>
<value>
The version of the runtime to be used when executing tests.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.Process">
<summary>
Gets or sets a value indicating how NUnit should load tests in processes.
The Default value is <see cref="F:Cake.Common.Tools.NUnit.NUnit3ProcessOption.Multiple"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.AppDomainUsage">
<summary>
Gets or sets a value to control creation of AppDomains for running tests.
Corresponds to the /domain command line switch.
The default is to use multiple domains if multiple assemblies are listed on the command line,
otherwise a single domain is used.
</summary>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.Agents">
<summary>
Gets or sets the maximum number of test assembly agents to run at one
time. If not specified, there is no limit.
</summary>
<value>
The maximum number of test assembly agents to run at one time.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.ConfigFile">
<summary>
Gets or sets a value indicating the path to an alternative app.config file to load.
</summary>
<value>The location that NUnit should load an alternative app.config file from.</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.Params">
<summary>
Gets or sets the parameters that should be passed to the runner.
</summary>
<value>
List of parameters (key/value) which are passed to the runner.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.TestParams">
<summary>
Gets or sets the test parameters that should be passed to the runner.
</summary>
<value>
List of test parameters (key/value) which are passed to the runner.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnit3Settings.TraceLevel">
<summary>
Gets or sets the level of detail at which the runner should write to its internal trace log.
Corresponds to the -trace=LEVEL command line argument.
If <c>null</c>, no argument will be specified.
</summary>
<value>
The trace level.
</value>
</member>
<member name="T:Cake.Common.Tools.NUnit.NUnitAliases">
<summary>
<para>Contains functionality related to running <see href="https://github.com/nunit/nunit">NUnit</see> tests.</para>
<para>
In order to use the commands for this alias, include the following in your build.cake file to download and
install from nuget.org, or specify the ToolPath within the <see cref="T:Cake.Common.Tools.NUnit.NUnitSettings" /> class:
<code>
#tool "nuget:?package=NUnit.Runners&version=2.6.4"
</code>
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.NUnit.NUnitAliases.NUnit(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern)">
<summary>
Runs all NUnit unit tests in the assemblies matching the specified pattern.
</summary>
<example>
<code>
NUnit("./src/UnitTests/*.dll");
</code>
</example>
<param name="context">The context.</param>
<param name="pattern">The pattern.</param>
</member>
<member name="M:Cake.Common.Tools.NUnit.NUnitAliases.NUnit(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern,Cake.Common.Tools.NUnit.NUnitSettings)">
<summary>
Runs all NUnit unit tests in the assemblies matching the specified pattern,
using the specified settings.
</summary>
<example>
<code>
NUnit("./src/UnitTests/*.dll", new NUnitSettings {
Timeout = 4000,
StopOnError = true
});
</code>
</example>
<param name="context">The context.</param>
<param name="pattern">The pattern.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.NUnit.NUnitAliases.NUnit(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{System.String})">
<summary>
Runs all NUnit unit tests in the specified assemblies.
</summary>
<example>
<code>
var assemblies = new [] {
"UnitTests1.dll",
"UnitTests2.dll"
};
NUnit(assemblies);
</code>
</example>
<param name="context">The context.</param>
<param name="assemblies">The assemblies.</param>
</member>
<member name="M:Cake.Common.Tools.NUnit.NUnitAliases.NUnit(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath})">
<summary>
Runs all NUnit unit tests in the specified assemblies.
</summary>
<example>
<code>
var assemblies = GetFiles("./src/UnitTests/*.dll");
NUnit(assemblies);
</code>
</example>
<param name="context">The context.</param>
<param name="assemblies">The assemblies.</param>
</member>
<member name="M:Cake.Common.Tools.NUnit.NUnitAliases.NUnit(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{System.String},Cake.Common.Tools.NUnit.NUnitSettings)">
<summary>
Runs all NUnit unit tests in the specified assemblies,
using the specified settings.
</summary>
<example>
<code>
var assemblies = new [] {
"UnitTests1.dll",
"UnitTests2.dll"
};
NUnit(assemblies, new NUnitSettings {
Timeout = 4000,
StopOnError = true
});
</code>
</example>
<param name="context">The context.</param>
<param name="assemblies">The assemblies.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.NUnit.NUnitAliases.NUnit(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.NUnit.NUnitSettings)">
<summary>
Runs all NUnit unit tests in the specified assemblies,
using the specified settings.
</summary>
<example>
<code>
var assemblies = GetFiles(""./src/UnitTests/*.dll"");
NUnit(assemblies, new NUnitSettings {
Timeout = 4000,
StopOnError = true
});
</code>
</example>
<param name="context">The context.</param>
<param name="assemblies">The assemblies.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.NUnit.NUnitAppDomainUsage">
<summary>
The /domain option controls of the creation of AppDomains for running tests.
</summary>
</member>
<member name="F:Cake.Common.Tools.NUnit.NUnitAppDomainUsage.Default">
<summary>
Create a separate AppDomain for each assembly listed on the command line.
</summary>
</member>
<member name="F:Cake.Common.Tools.NUnit.NUnitAppDomainUsage.None">
<summary>
No domain is created - the tests are run in the primary domain.
This normally requires copying the NUnit assemblies into the same directory as your tests.
</summary>
</member>
<member name="F:Cake.Common.Tools.NUnit.NUnitAppDomainUsage.Single">
<summary>
A test domain is created - this is how NUnit worked prior to version 2.4
</summary>
</member>
<member name="T:Cake.Common.Tools.NUnit.NUnitInternalTraceLevel">
<summary>
Represents the level of detail at which NUnit should set internal tracing.
</summary>
</member>
<member name="F:Cake.Common.Tools.NUnit.NUnitInternalTraceLevel.Off">
<summary>
Do not display any trace messages
</summary>
</member>
<member name="F:Cake.Common.Tools.NUnit.NUnitInternalTraceLevel.Error">
<summary>
Display Error messages only
</summary>
</member>
<member name="F:Cake.Common.Tools.NUnit.NUnitInternalTraceLevel.Warning">
<summary>
Display Warning level and higher messages
</summary>
</member>
<member name="F:Cake.Common.Tools.NUnit.NUnitInternalTraceLevel.Info">
<summary>
Display informational and higher messages
</summary>
</member>
<member name="F:Cake.Common.Tools.NUnit.NUnitInternalTraceLevel.Debug">
<summary>
Display debug messages and higher - i.e. all messages
</summary>
</member>
<member name="F:Cake.Common.Tools.NUnit.NUnitInternalTraceLevel.Verbose">
<summary>
Display debug messages and higher - i.e. all messages
</summary>
</member>
<member name="T:Cake.Common.Tools.NUnit.NUnitInternalTraceLevelExtensions">
<summary>
Contains extension methods for <see cref="T:Cake.Common.Tools.NUnit.NUnitInternalTraceLevel"/>.
</summary>
</member>
<member name="M:Cake.Common.Tools.NUnit.NUnitInternalTraceLevelExtensions.GetArgumentValue(Cake.Common.Tools.NUnit.NUnitInternalTraceLevel)">
<summary>
Gets the LEVEL value for the --trace command line argument for the given <see cref="T:Cake.Common.Tools.NUnit.NUnitInternalTraceLevel"/>.
</summary>
<param name="level">The <see cref="T:Cake.Common.Tools.NUnit.NUnitInternalTraceLevel"/> value for which to get the <see cref="T:System.String"/> representation.</param>
<returns>Returns the appropriate <see cref="T:System.String"/> representation for the given <see cref="T:Cake.Common.Tools.NUnit.NUnitInternalTraceLevel"/> value.</returns>
</member>
<member name="T:Cake.Common.Tools.NUnit.NUnitProcessOption">
<summary>
Represents the various ways NUnit loads tests in processes.
</summary>
</member>
<member name="F:Cake.Common.Tools.NUnit.NUnitProcessOption.Single">
<summary>
All the tests are run in the nunit-console process. This is the default.
</summary>
</member>
<member name="F:Cake.Common.Tools.NUnit.NUnitProcessOption.Separate">
<summary>
A separate process is created to run the tests.
</summary>
</member>
<member name="F:Cake.Common.Tools.NUnit.NUnitProcessOption.Multiple">
<summary>
A separate process is created for each test assembly.
</summary>
</member>
<member name="T:Cake.Common.Tools.NUnit.NUnitRunner">
<summary>
The NUnit unit test runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.NUnit.NUnitRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.NUnit.NUnitRunner"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.NUnit.NUnitRunner.Run(System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.NUnit.NUnitSettings)">
<summary>
Runs the tests in the specified assemblies, using the specified settings.
</summary>
<param name="assemblyPaths">The assembly paths.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.NUnit.NUnitRunner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.NUnit.NUnitRunner.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="M:Cake.Common.Tools.NUnit.NUnitRunner.ProcessExitCode(System.Int32)">
<summary>
Customized NUnit exit code handling.
Throws <see cref="T:Cake.Core.CakeException"/> on non-zero exit code.
</summary>
<param name="exitCode">The process exit code.</param>
</member>
<member name="T:Cake.Common.Tools.NUnit.NUnitSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.NUnit.NUnitRunner" />.
</summary>
</member>
<member name="M:Cake.Common.Tools.NUnit.NUnitSettings.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.NUnit.NUnitSettings" /> class.
</summary>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnitSettings.ResultsFile">
<summary>
Gets or sets the name of the XML result file.
</summary>
<value>
The name of the XML result file. Defaults to <c>TestResult.xml</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnitSettings.NoResults">
<summary>
Gets or sets a value indicating whether to generate the XML result file.
</summary>
<value>
<c>true</c> if the XML result file should be generated; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnitSettings.Framework">
<summary>
Gets or sets the version of the runtime to be used when executing tests.
</summary>
<value>
The version of the runtime to be used when executing tests.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnitSettings.Include">
<summary>
Gets or sets the categories to include in a run.
</summary>
<value>The categories to include in a run.</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnitSettings.Exclude">
<summary>
Gets or sets the categories to exclude from a run.
</summary>
<value>
The categories to exclude from a run.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnitSettings.Timeout">
<summary>
Gets or sets the default timeout to be used for test cases in this run.
If any test exceeds the timeout value, it is cancelled and reported as an error.
</summary>
<value>The default timeout to be used for test cases in this run.</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnitSettings.ShadowCopy">
<summary>
Gets or sets a value indicating whether tests should be run as a shadow copy.
Default value is <c>true</c>.
</summary>
<value>
<c>true</c> if tests should be run as a shadow copy; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnitSettings.NoThread">
<summary>
Gets or sets a value indicating whether the main thread should be used for running tests.
</summary>
<value>
<c>true</c> if the main thread should be used for running tests; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnitSettings.NoLogo">
<summary>
Gets or sets a value indicating whether to show copyright information at the start of the program.
</summary>
<value>
<c>true</c> if to show copyright information at the start of the program; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnitSettings.StopOnError">
<summary>
Gets or sets a value indicating whether execution of the test run should terminate
immediately on the first test failure or error.
</summary>
<value>
<c>true</c> if execution of the test run should terminate immediately on the first test failure or error;
otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnitSettings.Trace">
<summary>
Gets or sets the amount of information that NUnit should write to its internal trace log.
</summary>
<value>The amount of information that NUnit should write to its internal trace log.</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnitSettings.OutputFile">
<summary>
Gets or sets the location that NUnit should write test output.
</summary>
<value>The location that NUnit should write test output.</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnitSettings.ErrorOutputFile">
<summary>
Gets or sets the location that NUnit should write test error output.
</summary>
<value>The location that NUnit should write test error output.</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnitSettings.Process">
<summary>
Gets or sets a value indicating how NUnit should load tests in processes.
The Default value is <see cref="F:Cake.Common.Tools.NUnit.NUnitProcessOption.Single"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnitSettings.UseSingleThreadedApartment">
<summary>
Gets or sets a value indicating whether Single Threaded Apartment state (STA) will be used.
Corresponds to the /apartment command line option.
</summary>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnitSettings.AppDomainUsage">
<summary>
Gets or sets a value to control creation of AppDomains for running tests.
Corresponds to the /domain command line switch.
The default is to use multiple domains if multiple assemblies are listed on the command line.
Otherwise a single domain is used.
</summary>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnitSettings.X86">
<summary>
Gets or sets a value indicating whether to run tests in an x86 process on 64 bit systems.
</summary>
<value>
<c>true</c> to run tests in an x86 process on 64 bit systems; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.NUnit.NUnitSettings.Labels">
<summary>
Gets or sets a value indicating whether to cause an identifying label to be displayed at the start of each test case.
</summary>
<value>
<c>true</c> to cause an identifying label to be displayed at the start of each test case; otherwise, <c>false</c>.
</value>
</member>
<member name="T:Cake.Common.Tools.OctopusDeploy.NamespaceDoc">
<summary>
This namespace contain types used
to interact with Octopus Deploy.
</summary>
</member>
<member name="T:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings">
<summary>
Contains settings used by <see cref="M:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseCreator.CreateRelease(System.String,Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings)"/>.
See Octopus Deploy documentation <see href="http://docs.octopusdeploy.com/display/OD/Creating+releases">here</see>.
</summary>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings"/> class.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.ReleaseNumber">
<summary>
Gets or sets the release number to use for the new release.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.DefaultPackageVersion">
<summary>
Gets or sets the default version number of all packages to use the new release.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.Packages">
<summary>
Gets or sets the version number to use for a package in the release.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.PackagesFolder">
<summary>
Gets or sets the folder containing NuGet packages.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.ReleaseNotes">
<summary>
Gets or sets the release notes for the new release.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.ReleaseNotesFile">
<summary>
Gets or sets the path to a file that contains Release Notes for the new release.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.IgnoreExisting">
<summary>
Gets or sets a value indicating whether to Ignore Existing release flag.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.DeployTo">
<summary>
Gets or sets environment to automatically deploy to, e.g., Production.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.DeployToMultiple">
<summary>
Gets or sets multiple environments to automatically deploy to, e.g., Production, Staging, etc.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.ShowProgress">
<summary>
Gets or sets a value indicating whether progress of the deployment should be followed. (Sets --waitfordeployment and --norawlog to true.)
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.ForcePackageDownload">
<summary>
Gets or sets a value indicating whether to force downloading of already installed packages. Default false.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.WaitForDeployment">
<summary>
Gets or sets a value indicating whether to wait synchronously for deployment to finish.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.DeploymentTimeout">
<summary>
Gets or sets maximum time (timespan format) that the console session will wait for the deployment to finish (default 00:10:00).
This will not stop the deployment. Requires WaitForDeployment parameter set.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.CancelOnTimeout">
<summary>
Gets or sets a value indicating whether to cancel the deployment if the deployment timeout is reached(default false).
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.DeploymentChecksLeepCycle">
<summary>
Gets or sets how much time should elapse between deployment status checks(default 00:00:10).
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.GuidedFailure">
<summary>
Gets or sets a value indicating whether to use Guided Failure mode. If not specified, will use default setting from environment.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.SpecificMachines">
<summary>
Gets or sets list of machines names to target in the deployed environment.If not specified all machines in the environment will be considered.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.Force">
<summary>
Gets or sets a value indicating whether a project is configured to skip packages with already-installed versions, override this setting to force re-deployment (flag, default false).
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.SkipSteps">
<summary>
Gets or sets a list of steps to be skipped. Takes step names.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.NoRawLog">
<summary>
Gets or sets a value indicating whether print the raw log of failed tasks or not.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.RawLogFile">
<summary>
Gets or sets a file where to redirect the raw log of failed tasks.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.Variables">
<summary>
Gets or sets values for any prompted variables.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.DeployAt">
<summary>
Gets or sets time at which deployment should start (scheduled deployment), specified as any valid DateTimeOffset format, and assuming the time zone is the current local time zone.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.Tenant">
<summary>
Gets or sets a tenant the deployment will be performed for; specify this argument multiple times to add multiple tenants or use `*` wildcard to deploy to tenants able to deploy.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.TenantTags">
<summary>
Gets or sets a tenant tags used to match tenants that the deployment will be performed for; specify this argument multiple times to add multiple tenant tags.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.Channel">
<summary>
Gets or sets the octopus channel for the new release.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.IgnoreChannelRules">
<summary>
Gets or sets a value indicating whether octopus channel rules should be ignored.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.DeploymentProgress">
<summary>
Gets or sets a value indicating whether progress of the deployment will be shown.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings.ExcludeMachines">
<summary>
Gets or sets the comma-separated list of machine names to exclude in the deployed environment.If not specified all machines in the environment will be considered.
</summary>
</member>
<member name="T:Cake.Common.Tools.OctopusDeploy.DeploymentQueryResultParser">
<summary>
Parses the Console Output of the Octo.exe call when called with list-deployments.
</summary>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.DeploymentQueryResultParser.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.OctopusDeploy.DeploymentQueryResultParser"/> class.
</summary>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.DeploymentQueryResultParser.ParseResults(System.Collections.Generic.IEnumerable{System.String})">
<summary>
Parse the results from The Deployment Query.
</summary>
<param name="output">Console Output from the Run Process.</param>
<returns>A collection of Octopus deployments.</returns>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.DeploymentQueryResultParser.ParseSet(System.Collections.Generic.List{System.String})">
<summary>
Parses a set of lines from the output.
</summary>
<param name="lineSet">A set of lines to parse.</param>
<returns>an OctopusDeployment or null.</returns>
</member>
<member name="T:Cake.Common.Tools.OctopusDeploy.OctopusDeployAliases">
<summary>
<para>Contains functionality related to <see href="https://octopus.com/">Octopus Deploy</see>.</para>
<para>
In order to use the commands for this alias, include the following in your build.cake file to download and
install from nuget.org, or specify the ToolPath within the appropriate settings class:
<code>
#tool "nuget:?package=OctopusTools"
</code>
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.OctopusDeployAliases.OctoCreateRelease(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings)">
<summary>
Creates a release for the specified Octopus Deploy Project.
</summary>
<param name="context">The cake context.</param>
<param name="projectName">The name of the project.</param>
<param name="settings">The settings.</param>
<example>
<code>
// Minimum required
OctoCreateRelease(projectNameOnServer, new CreateReleaseSettings {
Server = "http://octopus-deploy.example",
ApiKey = "API-XXXXXXXXXXXXXXXXXXXX"
});
OctoCreateRelease(projectNameOnServer, new CreateReleaseSettings {
Server = "http://octopus-deploy.example",
Username = "DeployUser",
Password = "a-very-secure-password"
});
OctoCreateRelease(projectNameOnServer, new CreateReleaseSettings {
ConfigurationFile = @"C:\OctopusDeploy.config"
});
// Additional Options
OctoCreateRelease(projectNameOnServer, new CreateReleaseSettings {
ToolPath = "./tools/OctopusTools/Octo.exe"
EnableDebugLogging = true,
IgnoreSslErrors = true,
EnableServiceMessages = true, // Enables teamcity services messages when logging
ReleaseNumber = "1.8.2",
DefaultPackageVersion = "1.0.0.0", // All packages in the release should be 1.0.0.0
Packages = new Dictionary<string, string>
{
{ "PackageOne", "1.0.2.3" },
{ "PackageTwo", "5.2.3" }
},
PackagesFolder = @"C:\MyOtherNuGetFeed",
// One or the other
ReleaseNotes = "Version 2.0 \n What a milestone we have ...",
ReleaseNotesFile = "./ReleaseNotes.md",
IgnoreExisting = true // if this release number already exists, ignore it
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.OctopusDeployAliases.OctoPush(Cake.Core.ICakeContext,System.String,System.String,Cake.Core.IO.FilePath,Cake.Common.Tools.OctopusDeploy.OctopusPushSettings)">
<summary>
Pushes the specified package to the Octopus Deploy repository.
</summary>
<param name="context">The cake context.</param>
<param name="server">The Octopus server URL.</param>
<param name="apiKey">The user's API key.</param>
<param name="packagePath">Path to the package.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.OctopusDeployAliases.OctoPush(Cake.Core.ICakeContext,System.String,System.String,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.OctopusDeploy.OctopusPushSettings)">
<summary>
Pushes the specified packages to the Octopus Deploy repository.
</summary>
<param name="context">The cake context.</param>
<param name="server">The Octopus server URL.</param>
<param name="apiKey">The user's API key.</param>
<param name="packagePaths">Paths to the packages.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.OctopusDeployAliases.OctoPack(Cake.Core.ICakeContext,System.String)">
<summary>
Packs the specified folder into an Octopus Deploy package.
</summary>
<param name="context">The cake context.</param>
<param name="id">The package ID.</param>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.OctopusDeployAliases.OctoPack(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.OctopusDeploy.OctopusPackSettings)">
<summary>
Packs the specified folder into an Octopus Deploy package.
</summary>
<param name="context">The cake context.</param>
<param name="id">The package ID.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.OctopusDeployAliases.OctoDeployRelease(Cake.Core.ICakeContext,System.String,System.String,System.String,System.String,System.String,Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseDeploymentSettings)">
<summary>
Deploys the specified already existing release into a specified environment
See <see href="http://docs.octopusdeploy.com/display/OD/Deploying+releases">Octopus Documentation</see> for more details.
</summary>
<param name="context">The cake context.</param>
<param name="server">The Octopus server URL.</param>
<param name="apiKey">The user's API key.</param>
<param name="projectName">Name of the target project.</param>
<param name="deployTo">Target environment name.</param>
<param name="releaseNumber">Version number of the release to deploy. Specify "latest" for the latest release.</param>
<param name="settings">Deployment settings.</param>
<example>
<code>
// bare minimum
OctoDeployRelease("http://octopus-deploy.example", "API-XXXXXXXXXXXXXXXXXXXX", "MyGreatProject", "Testing", "2.1.15-RC" new OctopusDeployReleaseDeploymentSettings());
// All of deployment arguments
OctoDeployRelease("http://octopus-deploy.example", "API-XXXXXXXXXXXXXXXXXXXX", "MyGreatProject", "Testing", "2.1.15-RC" new OctopusDeployReleaseDeploymentSettings {
ShowProgress = true,
ForcePackageDownload = true,
WaitForDeployment = true,
DeploymentTimeout = TimeSpan.FromMinutes(1),
CancelOnTimeout = true,
DeploymentChecksLeapCycle = TimeSpan.FromMinutes(77),
GuidedFailure = true,
SpecificMachines = new string[] { "Machine1", "Machine2" },
Force = true,
SkipSteps = new[] { "Step1", "Step2" },
NoRawLog = true,
RawLogFile = "someFile.txt",
DeployAt = new DateTime(2010, 6, 15).AddMinutes(1),
Tenant = new[] { "Tenant1", "Tenant2" },
TenantTags = new[] { "Tag1", "Tag2" },
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.OctopusDeployAliases.OctoDeployRelease(Cake.Core.ICakeContext,System.String,System.String,System.String,System.String[],System.String,Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseDeploymentSettings)">
<summary>
Deploys the specified already existing release into a specified environment
See <see href="http://docs.octopusdeploy.com/display/OD/Deploying+releases">Octopus Documentation</see> for more details.
</summary>
<param name="context">The cake context.</param>
<param name="server">The Octopus server URL.</param>
<param name="apiKey">The user's API key.</param>
<param name="projectName">Name of the target project.</param>
<param name="deployToMultiple">Multiple target environment names.</param>
<param name="releaseNumber">Version number of the release to deploy. Specify "latest" for the latest release.</param>
<param name="settings">Deployment settings.</param>
<example>
<code>
// bare minimum
OctoDeployRelease("http://octopus-deploy.example", "API-XXXXXXXXXXXXXXXXXXXX", "MyGreatProject", "Testing", "2.1.15-RC" new OctopusDeployReleaseDeploymentSettings());
// All of deployment arguments
OctoDeployRelease("http://octopus-deploy.example", "API-XXXXXXXXXXXXXXXXXXXX", "MyGreatProject", new string[] {"Testing", "Testing2"}, "2.1.15-RC" new OctopusDeployReleaseDeploymentSettings {
ShowProgress = true,
ForcePackageDownload = true,
WaitForDeployment = true,
DeploymentTimeout = TimeSpan.FromMinutes(1),
CancelOnTimeout = true,
DeploymentChecksLeapCycle = TimeSpan.FromMinutes(77),
GuidedFailure = true,
SpecificMachines = new string[] { "Machine1", "Machine2" },
Force = true,
SkipSteps = new[] { "Step1", "Step2" },
NoRawLog = true,
RawLogFile = "someFile.txt",
DeployAt = new DateTime(2010, 6, 15).AddMinutes(1),
Tenant = new[] { "Tenant1", "Tenant2" },
TenantTags = new[] { "Tag1", "Tag2" },
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.OctopusDeployAliases.OctoPromoteRelease(Cake.Core.ICakeContext,System.String,System.String,System.String,System.String,System.String,Cake.Common.Tools.OctopusDeploy.OctopusDeployPromoteReleaseSettings)">
<summary>
Promotes the specified already existing release into a specified environment
See <see href="https://octopus.com/docs/api-and-integration/octo.exe-command-line/promoting-releases">Octopus Documentation</see> for more details.
</summary>
<param name="context">The cake context.</param>
<param name="server">The Octopus server URL.</param>
<param name="apiKey">The user's API key.</param>
<param name="projectName">Name of the target project.</param>
<param name="deployFrom">Source environment name.</param>
<param name="deployTo">Target environment name.</param>
<param name="settings">Deployment settings.</param>
<example>
<code>
// bare minimum
OctoPromoteRelease("http://octopus-deploy.example", "API-XXXXXXXXXXXXXXXXXXXX", "MyGreatProject", "Testing", "Staging", new OctopusDeployPromoteReleaseSettings());
// All of deployment arguments
OctoPromoteRelease("http://octopus-deploy.example", "API-XXXXXXXXXXXXXXXXXXXX", "MyGreatProject", "Testing", "Staging", new OctopusDeployPromoteReleaseSettings {
ShowProgress = true,
ForcePackageDownload = true,
WaitForDeployment = true,
DeploymentTimeout = TimeSpan.FromMinutes(1),
CancelOnTimeout = true,
DeploymentChecksLeapCycle = TimeSpan.FromMinutes(77),
GuidedFailure = true,
SpecificMachines = new string[] { "Machine1", "Machine2" },
Force = true,
SkipSteps = new[] { "Step1", "Step2" },
NoRawLog = true,
RawLogFile = "someFile.txt",
DeployAt = new DateTime(2010, 6, 15).AddMinutes(1),
Tenant = new[] { "Tenant1", "Tenant2" },
TenantTags = new[] { "Tag1", "Tag2" },
});
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.OctopusDeploy.OctopusDeployDeploymentQuerier">
<summary>
Allows you to query your Octopus Deploy server deployment history.
</summary>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.OctopusDeployDeploymentQuerier.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.OctopusDeploy.OctopusDeployDeploymentQuerier"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.OctopusDeployDeploymentQuerier.QueryOctopusDeployments(System.String,System.String,Cake.Common.Tools.OctopusDeploy.OctopusDeploymentQuerySettings)">
<summary>
Pushes the specified packages to Octopus Deploy internal repository.
</summary>
<param name="server">The Octopus server URL.</param>
<param name="apiKey">The user's API key.</param>
<param name="querySettings">The query.</param>
<returns>A list of Octopus Deployments.</returns>
</member>
<member name="T:Cake.Common.Tools.OctopusDeploy.OctopusDeployment">
<summary>
An object representing a deployment in Octopus Deploy.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployment.ProjectName">
<summary>
gets or sets the Name of the Deployment's Project.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployment.Environment">
<summary>
gets or sets the Environment the project was deployed to.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployment.Channel">
<summary>
gets or sets the Deployment's channel.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployment.Created">
<summary>
gets or sets When the deployment was created.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployment.Assembled">
<summary>
gets or sets when the deployment was assembled.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployment.Version">
<summary>
gets or sets the deployed project version.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployment.PackageVersions">
<summary>
gets or sets the list of packages in the deployment.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployment.ReleaseNotesHtml">
<summary>
gets or sets the release notes for the deployment (HTML Markup).
</summary>
</member>
<member name="T:Cake.Common.Tools.OctopusDeploy.OctopusDeploymentQuerySettings">
<summary>
Contains settings used by <see cref="M:Cake.Common.Tools.OctopusDeploy.OctopusDeployDeploymentQuerier.QueryOctopusDeployments(System.String,System.String,Cake.Common.Tools.OctopusDeploy.OctopusDeploymentQuerySettings)"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeploymentQuerySettings.EnvironmentName">
<summary>
Gets or Sets a value that is an Octopus Environment Name to filter for.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeploymentQuerySettings.ProjectName">
<summary>
Gets or Sets a value that is an Octopus Project Name to filter for.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeploymentQuerySettings.TenantName">
<summary>
Gets or Sets a value that is an Octopus Tenant Name to filter for.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeploymentQuerySettings.Count">
<summary>
Gets or Sets a value that indicates how many deployments to retrieve
in Date Descending order (most recent first)
Default: 1.
</summary>
</member>
<member name="T:Cake.Common.Tools.OctopusDeploy.OctopusDeployPacker">
<summary>
The Octopus deploy package packer.
</summary>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.OctopusDeployPacker.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.OctopusDeploy.OctopusDeployPacker"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.OctopusDeployPacker.Pack(System.String,Cake.Common.Tools.OctopusDeploy.OctopusPackSettings)">
<summary>
Creates an Octopus deploy package with the specified ID.
</summary>
<param name="id">The package ID.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.OctopusDeploy.OctopusDeployPromoteReleaseSettings">
<summary>
Possible arguments to pass to Octo.exe for promoting a release. See <see href="https://octopus.com/docs/api-and-integration/octo.exe-command-line/promoting-releases">Octopus Deploy documentation</see>.
</summary>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.OctopusDeployPromoteReleaseSettings.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.OctopusDeploy.OctopusDeployPromoteReleaseSettings"/> class.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployPromoteReleaseSettings.UpdateVariables">
<summary>
Gets or sets a value indicating whether overwrite the variable snapshot for the release by re-importing the variables from the project.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployPromoteReleaseSettings.ShowProgress">
<summary>
Gets or sets a value indicating whether progress of the deployment should be followed. (Sets --waitfordeployment and --norawlog to true.)
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployPromoteReleaseSettings.ForcePackageDownload">
<summary>
Gets or sets a value indicating whether to force downloading of already installed packages. Default false.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployPromoteReleaseSettings.WaitForDeployment">
<summary>
Gets or sets a value indicating whether to wait synchronously for deployment to finish.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployPromoteReleaseSettings.DeploymentTimeout">
<summary>
Gets or sets maximum time (timespan format) that the console session will wait for the deployment to finish (default 00:10:00).
This will not stop the deployment. Requires WaitForDeployment parameter set.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployPromoteReleaseSettings.CancelOnTimeout">
<summary>
Gets or sets a value indicating whether to cancel the deployment if the deployment timeout is reached(default false).
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployPromoteReleaseSettings.DeploymentChecksLeepCycle">
<summary>
Gets or sets how much time should elapse between deployment status checks(default 00:00:10).
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployPromoteReleaseSettings.GuidedFailure">
<summary>
Gets or sets a value indicating whether to use Guided Failure mode. If not specified, will use default setting from environment.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployPromoteReleaseSettings.SpecificMachines">
<summary>
Gets or sets list of machines names to target in the deployed environment.If not specified all machines in the environment will be considered.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployPromoteReleaseSettings.Force">
<summary>
Gets or sets a value indicating whether a project is configured to skip packages with already-installed versions, override this setting to force re-deployment (flag, default false).
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployPromoteReleaseSettings.SkipSteps">
<summary>
Gets or sets a list of steps to be skipped. Takes step names.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployPromoteReleaseSettings.NoRawLog">
<summary>
Gets or sets a value indicating whether print the raw log of failed tasks or not.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployPromoteReleaseSettings.RawLogFile">
<summary>
Gets or sets a file where to redirect the raw log of failed tasks.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployPromoteReleaseSettings.Variables">
<summary>
Gets or sets values for any prompted variables.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployPromoteReleaseSettings.DeployAt">
<summary>
Gets or sets time at which deployment should start (scheduled deployment), specified as any valid DateTimeOffset format, and assuming the time zone is the current local time zone.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployPromoteReleaseSettings.Tenant">
<summary>
Gets or sets a tenant the deployment will be performed for; specify this argument multiple times to add multiple tenants or use `*` wildcard to deploy to tenants able to deploy.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployPromoteReleaseSettings.TenantTags">
<summary>
Gets or sets a tenant tags used to match tenants that the deployment will be performed for; specify this argument multiple times to add multiple tenant tags.
</summary>
</member>
<member name="T:Cake.Common.Tools.OctopusDeploy.OctopusDeployPusher">
<summary>
The Octopus Deploy package push runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.OctopusDeployPusher.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.OctopusDeploy.OctopusDeployPusher"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.OctopusDeployPusher.PushPackage(System.String,System.String,Cake.Core.IO.FilePath[],Cake.Common.Tools.OctopusDeploy.OctopusPushSettings)">
<summary>
Pushes the specified packages to Octopus Deploy internal repository.
</summary>
<param name="server">The Octopus server URL.</param>
<param name="apiKey">The user's API key.</param>
<param name="packagePaths">Paths to the packages to be pushed.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseCreator">
<summary>
The Octopus Deploy release creator runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseCreator.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseCreator"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseCreator.CreateRelease(System.String,Cake.Common.Tools.OctopusDeploy.CreateReleaseSettings)">
<summary>
Creates a release for the specified project in OctopusDeploy.
</summary>
<param name="projectName">The target project name.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseDeployer">
<summary>
The Octopus Deploy Release Deploy runner. This class facilitates deploying existing releases in Octopus Deploy.
</summary>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseDeployer.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseDeployer"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseDeployer.DeployRelease(System.String,System.String,System.String,System.String[],System.String,Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseDeploymentSettings)">
<summary>
Requests a deployment of a specified release to an environment.
</summary>
<param name="server">Octopus Server URL.</param>
<param name="apiKey">The user's API key.</param>
<param name="projectName">Name of the target project.</param>
<param name="deployTo">Environment to deploy to, e.g., Production.</param>
<param name="releaseNumber">Release number to be deployed to.</param>
<param name="settings">Settings for the deployment.</param>
</member>
<member name="T:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseDeploymentSettings">
<summary>
Possible arguments to pass to Octo.exe for deploying a release. See <see href="http://docs.octopusdeploy.com/display/OD/Deploying+releases">Octopus Deploy documentation</see>.
</summary>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseDeploymentSettings.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseDeploymentSettings"/> class.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseDeploymentSettings.ShowProgress">
<summary>
Gets or sets a value indicating whether progress of the deployment should be followed. (Sets --waitfordeployment and --norawlog to true.)
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseDeploymentSettings.ForcePackageDownload">
<summary>
Gets or sets a value indicating whether to force downloading of already installed packages. Default false.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseDeploymentSettings.WaitForDeployment">
<summary>
Gets or sets a value indicating whether to wait synchronously for deployment to finish.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseDeploymentSettings.DeploymentTimeout">
<summary>
Gets or sets maximum time (timespan format) that the console session will wait for the deployment to finish (default 00:10:00).
This will not stop the deployment. Requires WaitForDeployment parameter set.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseDeploymentSettings.CancelOnTimeout">
<summary>
Gets or sets a value indicating whether to cancel the deployment if the deployment timeout is reached(default false).
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseDeploymentSettings.DeploymentChecksLeepCycle">
<summary>
Gets or sets how much time should elapse between deployment status checks(default 00:00:10).
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseDeploymentSettings.GuidedFailure">
<summary>
Gets or sets a value indicating whether to use Guided Failure mode. If not specified, will use default setting from environment.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseDeploymentSettings.SpecificMachines">
<summary>
Gets or sets list of machines names to target in the deployed environment.If not specified all machines in the environment will be considered.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseDeploymentSettings.Force">
<summary>
Gets or sets a value indicating whether a project is configured to skip packages with already-installed versions, override this setting to force re-deployment (flag, default false).
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseDeploymentSettings.SkipSteps">
<summary>
Gets or sets a list of steps to be skipped. Takes step names.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseDeploymentSettings.NoRawLog">
<summary>
Gets or sets a value indicating whether print the raw log of failed tasks or not.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseDeploymentSettings.RawLogFile">
<summary>
Gets or sets a file where to redirect the raw log of failed tasks.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseDeploymentSettings.Variables">
<summary>
Gets or sets values for any prompted variables.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseDeploymentSettings.DeployAt">
<summary>
Gets or sets time at which deployment should start (scheduled deployment), specified as any valid DateTimeOffset format, and assuming the time zone is the current local time zone.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseDeploymentSettings.Tenant">
<summary>
Gets or sets a tenant the deployment will be performed for; specify this argument multiple times to add multiple tenants or use `*` wildcard to deploy to tenants able to deploy.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseDeploymentSettings.TenantTags">
<summary>
Gets or sets a tenant tags used to match tenants that the deployment will be performed for; specify this argument multiple times to add multiple tenant tags.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseDeploymentSettings.Channel">
<summary>
Gets or sets the channel to use when getting the release to deploy.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleaseDeploymentSettings.ExcludeMachines">
<summary>
Gets or sets the comma-separated list of machine names to exclude in the deployed environment.If not specified all machines in the environment will be considered.
</summary>
</member>
<member name="T:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleasePromoter">
<summary>
The Octopus Deploy Promote Release runner. This class facilitates promoting existing releases in Octopus Deploy.
</summary>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleasePromoter.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleasePromoter"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.OctopusDeployReleasePromoter.PromoteRelease(System.String,System.String,System.String,System.String,System.String,Cake.Common.Tools.OctopusDeploy.OctopusDeployPromoteReleaseSettings)">
<summary>
Requests a promotion of a specified release to an environment.
</summary>
<param name="server">Octopus Server URL.</param>
<param name="apiKey">The user's API key.</param>
<param name="projectName">Name of the target project.</param>
<param name="deployFrom">Environment to promote from, e.g., Staging.</param>
<param name="deployTo">Environment to promote to, e.g., Production.</param>
<param name="settings">Settings for the deployment.</param>
</member>
<member name="T:Cake.Common.Tools.OctopusDeploy.OctopusDeployToolSettings">
<summary>
Base class for tool settings used by all commands in <see cref="T:Cake.Common.Tools.OctopusDeploy.OctopusDeployTool`1"/>.
</summary>
</member>
<member name="T:Cake.Common.Tools.OctopusDeploy.OctopusDeployCommonToolSettings">
<summary>
Contains the common settings used by all commands in <see cref="T:Cake.Common.Tools.OctopusDeploy.OctopusDeployTool`1"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployCommonToolSettings.Username">
<summary>
Gets or sets the username to use when authenticating with the server.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployCommonToolSettings.Password">
<summary>
Gets or sets the password to use when authenticating with the server.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployCommonToolSettings.Server">
<summary>
Gets or sets the octopus server url.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployCommonToolSettings.ApiKey">
<summary>
Gets or sets the user's API key.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployCommonToolSettings.ConfigurationFile">
<summary>
Gets or sets the text file of default values.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployCommonToolSettings.EnableDebugLogging">
<summary>
Gets or sets a value indicating whether the enable debug logging flag is set.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployCommonToolSettings.IgnoreSslErrors">
<summary>
Gets or sets a value indicating whether the ignore SSL errors flag is set.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployCommonToolSettings.EnableServiceMessages">
<summary>
Gets or sets a value indicating whether the enable service messages flag is set.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployCommonToolSettings.Space">
<summary>
Gets or sets the name of a space within which this command will be executed. The default space will be used if it is omitted.
</summary>
</member>
<member name="T:Cake.Common.Tools.OctopusDeploy.OctopusDeployTool`1">
<summary>
Base class for all octopus deploy related tools.
</summary>
<typeparam name="TSettings">The settings type.</typeparam>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.OctopusDeployTool`1.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.OctopusDeploy.OctopusDeployTool`1"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusDeployTool`1.Environment">
<summary>
Gets the environment.
</summary>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.OctopusDeployTool`1.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.OctopusDeploy.OctopusDeployTool`1.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="T:Cake.Common.Tools.OctopusDeploy.OctopusPackFormat">
<summary>
Represents the format of an Octopus package.
</summary>
</member>
<member name="F:Cake.Common.Tools.OctopusDeploy.OctopusPackFormat.NuPkg">
<summary>
NuGet package
</summary>
</member>
<member name="F:Cake.Common.Tools.OctopusDeploy.OctopusPackFormat.Zip">
<summary>
Zip package
</summary>
</member>
<member name="T:Cake.Common.Tools.OctopusDeploy.OctopusPackSettings">
<summary>
Contains the settings used by OctoPack.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusPackSettings.Version">
<summary>
Gets or sets the version.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusPackSettings.Format">
<summary>
Gets or sets the package format.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusPackSettings.OutFolder">
<summary>
Gets or sets the folder into which the package will be written. Defaults to the current folder.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusPackSettings.BasePath">
<summary>
Gets or sets the root folder containing files and folders to pack. Defaults to the current folder.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusPackSettings.Author">
<summary>
Gets or sets the author. Only applies to NuGet packages.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusPackSettings.Title">
<summary>
Gets or sets the title. Only applies to NuGet packages.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusPackSettings.Description">
<summary>
Gets or sets the description. Only applies to NuGet packages.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusPackSettings.ReleaseNotes">
<summary>
Gets or sets the release notes. Only applies to NuGet packages.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusPackSettings.ReleaseNotesFile">
<summary>
Gets or sets the release notes file. Only applies to NuGet packages.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusPackSettings.Include">
<summary>
Gets or sets the file patterns to include. If none are specified, defaults to **.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusPackSettings.Overwrite">
<summary>
Gets or sets a value indicating whether to allow an existing package with the same ID/version to be overwritten.
</summary>
</member>
<member name="T:Cake.Common.Tools.OctopusDeploy.OctopusPushSettings">
<summary>
Contains settings used by <see cref="M:Cake.Common.Tools.OctopusDeploy.OctopusDeployPusher.PushPackage(System.String,System.String,Cake.Core.IO.FilePath[],Cake.Common.Tools.OctopusDeploy.OctopusPushSettings)"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.OctopusDeploy.OctopusPushSettings.ReplaceExisting">
<summary>
Gets or sets a value indicating whether to overwrite an existing package.
</summary>
</member>
<member name="T:Cake.Common.Tools.Roundhouse.NamespaceDoc">
<summary>
This namespace contain types used
to interact with Roundhouse.
</summary>
</member>
<member name="T:Cake.Common.Tools.Roundhouse.RecoveryMode">
<summary>
Defines the recovery model for SQL Server.
</summary>
</member>
<member name="F:Cake.Common.Tools.Roundhouse.RecoveryMode.NoChange">
<summary>
Doesn't change the mode
</summary>
</member>
<member name="F:Cake.Common.Tools.Roundhouse.RecoveryMode.Simple">
<summary>
Does not create backup before migration
</summary>
</member>
<member name="F:Cake.Common.Tools.Roundhouse.RecoveryMode.Full">
<summary>
Creates log backup before migration
</summary>
</member>
<member name="T:Cake.Common.Tools.Roundhouse.RoundhouseAliases">
<summary>
<para>Contains functionality related to <see href="https://github.com/chucknorris/roundhouse">RoundhousE</see>.</para>
<para>
In order to use the commands for this alias, include the following in your build.cake file to download and
install from nuget.org, or specify the ToolPath within the <see cref="T:Cake.Common.Tools.Roundhouse.RoundhouseSettings" /> class:
<code>
#tool "nuget:?package=roundhouse"
</code>
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.Roundhouse.RoundhouseAliases.RoundhouseMigrate(Cake.Core.ICakeContext,Cake.Common.Tools.Roundhouse.RoundhouseSettings)">
<summary>
Executes Roundhouse with the given configured settings.
</summary>
<param name="context">The context.</param>
<param name="settings">The settings.</param>
<example>
<code>
RoundhouseMigrate(new RoundhouseSettings{
ServerName = "Sql2008R2",
DatabaseName = "AdventureWorks2008R2",
SqlFilesDirectory = "./src/sql"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Roundhouse.RoundhouseAliases.RoundhouseDrop(Cake.Core.ICakeContext,Cake.Common.Tools.Roundhouse.RoundhouseSettings)">
<summary>
Executes Roundhouse migration to drop the database using the provided settings.
</summary>
<param name="context">The context.</param>
<param name="settings">The settings.</param>
<example>
<code>
RoundhouseDrop(new RoundhouseSettings{
ServerName = "Sql2008R2",
DatabaseName = "AdventureWorks2008R2"
});
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.Roundhouse.RoundhouseRunner">
<summary>
The Roundhouse console application runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.Roundhouse.RoundhouseRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.Roundhouse.RoundhouseRunner"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.Roundhouse.RoundhouseRunner.Run(Cake.Common.Tools.Roundhouse.RoundhouseSettings,System.Boolean)">
<summary>
Runs Roundhouse with the given settings.
</summary>
<param name="settings">The settings.</param>
<param name="drop">Will drop/delete the database if set to <c>true</c>.</param>
</member>
<member name="M:Cake.Common.Tools.Roundhouse.RoundhouseRunner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.Roundhouse.RoundhouseRunner.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="T:Cake.Common.Tools.Roundhouse.RoundhouseSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.Roundhouse.RoundhouseRunner" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.ServerName">
<summary>
Gets or sets the server name.
</summary>
<value>
The server on which create/migrate should happen.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.DatabaseName">
<summary>
Gets or sets the database name.
</summary>
<value>
The database you want to create/migrate.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.ConnectionString">
<summary>
Gets or sets the connection string.
</summary>
<value>
As an alternative to ServerName and Database - You can provide an entire connection string instead.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.ConnectionStringAdmin">
<summary>
Gets or sets the connection string for admin connections.
</summary>
<value>
This is used for connecting to master when you may have a different uid and password than normal.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.CommandTimeout">
<summary>
Gets or sets the timeout (in seconds) for normal connections.
</summary>
<value>
This is the timeout when commands are run. This is not for admin commands or restore.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.CommandTimeoutAdmin">
<summary>
Gets or sets the timeout (in seconds) for admin connections.
</summary>
<value>
This is the timeout when administration commands are run (except for restore, which has its own).
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.SqlFilesDirectory">
<summary>
Gets or sets the sql files directory.
</summary>
<value>
The directory where your SQL scripts are.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.RepositoryPath">
<summary>
Gets or sets the location of the source code repository.
</summary>
<value>
Path to code repository to be able to correlate versions.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.VersionFile">
<summary>
Gets or sets the version file.
</summary>
<value>
Path to the file to use for applying version number. Either a .XML file, a .DLL or a .TXT file that a version can be resolved from.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.VersionXPath">
<summary>
Gets or sets the XPath to locate version in the <see cref="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.VersionFile" />.
</summary>
<value>
Works in conjunction with an XML version file.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.AlterDatabaseFolderName">
<summary>
Gets or sets the folder name for 'alterDatabase' scripts.
</summary>
<value>
The name of the folder where you keep your alter database scripts. Read up on token replacement. You will want to use {{DatabaseName}} here instead of specifying a database name.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.RunAfterCreateDatabaseFolderName">
<summary>
Gets or sets the folder name for 'runAfterCreateDatabase' scripts.
</summary>
<value>
The name of the folder where you will keep scripts that ONLY run after a database is created.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.RunBeforeUpFolderName">
<summary>
Gets or sets the folder name for 'runBeforeUp' scripts.
</summary>
<value>
The name of the folder where you keep scripts that you want to run before your update scripts.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.UpFolderName">
<summary>
Gets or sets the folder name for 'up' scripts.
</summary>
<value>
The name of the folder where you keep your update scripts.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.RunFirstAfterUpFolderName">
<summary>
Gets or sets the folder name for 'runFirstAfterUp' scripts.
</summary>
<value>
The name of the folder where you keep any functions, views, or sprocs that are order dependent. If you have a function that depends on a view, you definitely need the view in this folder.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.FunctionsFolderName">
<summary>
Gets or sets the folder name for 'functions' scripts.
</summary>
<value>
The name of the folder where you keep your functions.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.ViewsFolderName">
<summary>
Gets or sets the folder name for 'views' scripts.
</summary>
<value>
The name of the folder where you keep your views.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.SprocsFolderName">
<summary>
Gets or sets the folder name for 'sprocs' scripts.
</summary>
<value>
The name of the folder where you keep your stored procedures.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.IndexesFolderName">
<summary>
Gets or sets the folder name for 'indexes' scripts.
</summary>
<value>
The name of the folder where you keep your indexes.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.RunAfterOtherAnyTimeScriptsFolderName">
<summary>
Gets or sets the folder name for 'runAfterOtherAnyTimeScripts' scripts.
</summary>
<value>
The name of the folder where you keep scripts that will be run after all of the other any time scripts complete.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.PermissionsFolderName">
<summary>
Gets or sets the folder name for 'permissions' scripts.
</summary>
<value>
The name of the folder where you keep your permissions scripts.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.BeforeMigrationFolderName">
<summary>
Gets or sets the folder name for 'beforeMig' scripts.
</summary>
<value>
The name of the folder for scripts to run before migration and outside of a transaction.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.AfterMigrationFolderName">
<summary>
Gets or sets the folder name for 'afterMig' scripts.
</summary>
<value>
The name of the folder for scripts to run before migration and outside of a transaction.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.SchemaName">
<summary>
Gets or sets the schema name to use instead of [RoundhousE].
</summary>
<value>
The schema where RH stores its tables.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.Environment">
<summary>
Gets or sets the environment for RH to be scoped.
</summary>
<value>
This allows RH to be environment aware and only run scripts that are in a particular environment based on the naming of the script. LOCAL.something**.ENV.**sql would only be run in the LOCAL environment.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.Restore">
<summary>
Gets or sets a value indicating whether perform a restore.
</summary>
<value>
This instructs RH to do a restore (with the <see cref="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.RestoreFilePath"/> parameter) of a database before running migration scripts.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.RestoreFilePath">
<summary>
Gets or sets the restore file path.
</summary>
<value>
File path of back when Restore is set to true.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.CreateDatabaseCustomScript">
<summary>
Gets or sets the custom database creation script.
</summary>
<value>
This instructs RH to use this script for creating a database instead of the default based on the SQLType.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.OutputPath">
<summary>
Gets or sets the output path.
</summary>
<value>
Path to where migration artifacts are stored.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.WarnOnOneTimeScriptChanges">
<summary>
Gets or sets a value indicating whether to warn when previously run scripts have changed.
</summary>
<value>
Instructs RH to execute changed one time scripts (DDL/DML in 'Up'/<see cref="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.UpFolderName"/>) that have previously been run against the database instead of failing. A warning is logged for each one time scripts that is rerun.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.Silent">
<summary>
Gets or sets a value indicating whether to keep RH silent.
</summary>
<value>
Tells RH not to ask for any input when it runs.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.DatabaseType">
<summary>
Gets or sets database type.
</summary>
<value>
Database Type (fully qualified class name implementing [roundhouse.sql.Database, roundhouse]).
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.Drop">
<summary>
Gets or sets a value indicating whether to drop the DB.
</summary>
<value>
This instructs RH to remove a database and not run migration scripts.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.WithTransaction">
<summary>
Gets or sets a value indicating whether to use transactions.
</summary>
<value>
This instructs RH to run inside of a transaction.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.RecoveryMode">
<summary>
Gets or sets SQL Server recovery mode.
</summary>
<value>
This sets the recovery model for SQL Server during migration. (NoChange, Simple, Full).
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.DryRun">
<summary>
Gets or sets a value indicating whether to perform a dry run.
</summary>
<value>
This instructs RH to log what would have run, but not to actually run anything against the database. Use this option if you are trying to figure out what RH is going to do.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.DoNotCreateDatabase">
<summary>
Gets or sets a value indicating whether to create a database if it does not exist.
</summary>
<value>
This instructs RH to not create a database if it does not exists. Defaults to <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.DisableOutput">
<summary>
Gets or sets a value indicating whether to disable output of backup, items ran, permissions dumps, etc.
</summary>
<value>
Disable output of backups, items ran, permissions dumps, etc. Log files are kept. Useful for example in CI environment. Defaults to <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.Baseline">
<summary>
Gets or sets a value indicating whether to create an insert for its recording tables, but not run anything.
</summary>
<value>
This instructs RH to create an insert for its recording tables, but not to actually run anything against the database. Use this option if you already have scripts that have been run through other means. Defaults to <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.Debug">
<summary>
Gets or sets a value indicating whether to write debug messages.
</summary>
<value>
This instructs RH to write out all messages. Defaults to <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.RunAllAnyTimeScripts">
<summary>
Gets or sets a value indicating whether to execute any time scripts.
</summary>
<value>
This instructs RH to run any time scripts every time it is run. Defaults to <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.DisableTokenReplacement">
<summary>
Gets or sets a value indicating whether to perform token replacement.
</summary>
<value>
This instructs RH to not perform token replacement {{somename}}. Defaults to <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.Roundhouse.RoundhouseSettings.SearchAllSubdirectoriesInsteadOfTraverse">
<summary>
Gets or sets a value indicating whether to search all subdirectories.
</summary>
<value>
Each Migration folder's subdirectories are traversed by default. This option pulls back scripts from the main directory and all subdirectories at once. Defaults to <c>false</c>.
</value>
</member>
<member name="T:Cake.Common.Tools.SignTool.NamespaceDoc">
<summary>
This namespace contain types used for
signing assemblies with SignTool.
</summary>
</member>
<member name="T:Cake.Common.Tools.SignTool.ISignToolResolver">
<summary>
Represents a sign tool resolver.
</summary>
<remarks>
This exists only to be able to test the sign tool.
Do not use this interface since it will be removed.
</remarks>
</member>
<member name="M:Cake.Common.Tools.SignTool.ISignToolResolver.GetPath">
<summary>
Resolves the path to the sign tool.
</summary>
<returns>The path to the sign tool.</returns>
</member>
<member name="T:Cake.Common.Tools.SignTool.SignToolDigestAlgorithm">
<summary>
Digest algorithm for SignTool.
</summary>
</member>
<member name="F:Cake.Common.Tools.SignTool.SignToolDigestAlgorithm.Sha1">
<summary>
SHA-1 digest algorithm
</summary>
</member>
<member name="F:Cake.Common.Tools.SignTool.SignToolDigestAlgorithm.Sha256">
<summary>
SHA-256 digest algorithm.
</summary>
</member>
<member name="M:Cake.Common.Tools.SignTool.SignToolResolver.GetPath">
<inheritdoc/>
</member>
<member name="T:Cake.Common.Tools.SignTool.SignToolSignAliases">
<summary>
<para>Contains functionality related to signing assemblies with PFX certificates using <see href="https://msdn.microsoft.com/en-gb/library/windows/desktop/aa387764(v=vs.85).aspx">SignTool</see>.</para>
<para>
In order to use the commands for this alias, SignTool will need to be installed on the machine where
the Cake script is being executed. This is typically achieved by installing the correct Windows SDK.
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.SignTool.SignToolSignAliases.Sign(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.SignTool.SignToolSignSettings)">
<summary>
Signs the specified assembly.
</summary>
<param name="context">The context.</param>
<param name="assembly">The target assembly.</param>
<param name="settings">The settings.</param>
<example>
<code>
Task("Sign")
.IsDependentOn("Clean")
.IsDependentOn("Restore")
.IsDependentOn("Build")
.Does(() =>
{
var file = "Core.dll";
Sign(file, new SignToolSignSettings {
TimeStampUri = new Uri("http://timestamp.digicert.com"),
CertPath = "digitalcertificate.pfx",
Password = "TopSecret"
});
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.SignTool.SignToolSignAliases.Sign(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Common.Tools.SignTool.SignToolSignSettings)">
<summary>
Signs the specified assembly.
</summary>
<param name="context">The context.</param>
<param name="assembly">The target assembly.</param>
<param name="settings">The settings.</param>
<example>
<code>
Task("Sign")
.IsDependentOn("Clean")
.IsDependentOn("Restore")
.IsDependentOn("Build")
.Does(() =>
{
var file = new FilePath("Core.dll");
Sign(file, new SignToolSignSettings {
TimeStampUri = new Uri("http://timestamp.digicert.com"),
CertPath = "digitalcertificate.pfx",
Password = "TopSecret"
});
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.SignTool.SignToolSignAliases.Sign(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{System.String},Cake.Common.Tools.SignTool.SignToolSignSettings)">
<summary>
Signs the specified assemblies.
</summary>
<param name="context">The context.</param>
<param name="assemblies">The target assembly.</param>
<param name="settings">The settings.</param>
<example>
<code>
Task("Sign")
.IsDependentOn("Clean")
.IsDependentOn("Restore")
.IsDependentOn("Build")
.Does(() =>
{
var files = new string[] { "Core.dll", "Common.dll" };
Sign(files, new SignToolSignSettings {
TimeStampUri = new Uri("http://timestamp.digicert.com"),
CertPath = "digitalcertificate.pfx",
Password = "TopSecret"
});
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.SignTool.SignToolSignAliases.Sign(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.SignTool.SignToolSignSettings)">
<summary>
Signs the specified assemblies.
</summary>
<param name="context">The context.</param>
<param name="assemblies">The target assembly.</param>
<param name="settings">The settings.</param>
<example>
<code>
Task("Sign")
.IsDependentOn("Clean")
.IsDependentOn("Restore")
.IsDependentOn("Build")
.Does(() =>
{
var files = GetFiles(solutionDir + "/**/bin/" + configuration + "/**/*.exe");
Sign(files, new SignToolSignSettings {
TimeStampUri = new Uri("http://timestamp.digicert.com"),
CertPath = "digitalcertificate.pfx",
Password = "TopSecret"
});
});
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.SignTool.SignToolSignRunner">
<summary>
The SignTool SIGN assembly runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.SignTool.SignToolSignRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Core.IO.IRegistry)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.SignTool.SignToolSignRunner"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="registry">The registry.</param>
</member>
<member name="M:Cake.Common.Tools.SignTool.SignToolSignRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Core.IO.IRegistry,Cake.Common.Tools.SignTool.ISignToolResolver)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.SignTool.SignToolSignRunner"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="registry">The registry.</param>
<param name="resolver">The resolver.</param>
</member>
<member name="M:Cake.Common.Tools.SignTool.SignToolSignRunner.Run(System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.SignTool.SignToolSignSettings)">
<summary>
Signs the specified assemblies.
</summary>
<param name="assemblyPaths">The assembly paths.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.SignTool.SignToolSignRunner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>
The name of the tool (<c>SignTool SIGN</c>).
</returns>
</member>
<member name="M:Cake.Common.Tools.SignTool.SignToolSignRunner.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="M:Cake.Common.Tools.SignTool.SignToolSignRunner.GetAlternativeToolPaths(Cake.Common.Tools.SignTool.SignToolSignSettings)">
<summary>
Gets alternative file paths which the tool may exist in.
</summary>
<param name="settings">The settings.</param>
<returns>The default tool path.</returns>
</member>
<member name="T:Cake.Common.Tools.SignTool.SignToolSignSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.SignTool.SignToolSignRunner"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.SignTool.SignToolSignSettings.TimeStampUri">
<summary>
Gets or sets the timestamp server's URL. Timestamp will only be added if <c>TimeStampUri</c> is set.
</summary>
</member>
<member name="P:Cake.Common.Tools.SignTool.SignToolSignSettings.CertThumbprint">
<summary>
Gets or sets the thumbprint for locating a certificate in the store.
</summary>
</member>
<member name="P:Cake.Common.Tools.SignTool.SignToolSignSettings.CertSubjectName">
<summary>
Gets or sets the name of the subject of the signing certificate. This value can be a substring of the entire subject name.
</summary>
</member>
<member name="P:Cake.Common.Tools.SignTool.SignToolSignSettings.CertPath">
<summary>
Gets or sets the <c>PFX</c> certificate path.
</summary>
</member>
<member name="P:Cake.Common.Tools.SignTool.SignToolSignSettings.Password">
<summary>
Gets or sets the <c>PFX</c> certificate password.
</summary>
</member>
<member name="P:Cake.Common.Tools.SignTool.SignToolSignSettings.Description">
<summary>
Gets or sets the signed content's description.
</summary>
</member>
<member name="P:Cake.Common.Tools.SignTool.SignToolSignSettings.DescriptionUri">
<summary>
Gets or sets the signed content's expanded description URL.
</summary>
</member>
<member name="P:Cake.Common.Tools.SignTool.SignToolSignSettings.DigestAlgorithm">
<summary>
Gets or sets the file digest algorithm.
</summary>
</member>
<member name="P:Cake.Common.Tools.SignTool.SignToolSignSettings.TimeStampDigestAlgorithm">
<summary>
Gets or sets the timestamp digest algorithm.
</summary>
</member>
<member name="P:Cake.Common.Tools.SignTool.SignToolSignSettings.AppendSignature">
<summary>
Gets or sets a value indicating whether the signature should be appended.
</summary>
</member>
<member name="P:Cake.Common.Tools.SignTool.SignToolSignSettings.UseMachineStore">
<summary>
Gets or sets a value indicating whether a machine store, instead of a user store, is used.
</summary>
</member>
<member name="P:Cake.Common.Tools.SignTool.SignToolSignSettings.AdditionalCertPath">
<summary>
Gets or sets the path to an additional certificate that is to be added to the signature block.
</summary>
</member>
<member name="P:Cake.Common.Tools.SignTool.SignToolSignSettings.StoreName">
<summary>
Gets or sets the store to open when searching for the certificate.
</summary>
</member>
<member name="T:Cake.Common.Tools.WiX.NamespaceDoc">
<summary>
This namespace contain types used to interact with WiX.
</summary>
</member>
<member name="T:Cake.Common.Tools.WiX.Architecture">
<summary>
The architecture for the package.
</summary>
</member>
<member name="F:Cake.Common.Tools.WiX.Architecture.X64">
<summary>
Architecture: <c>x86_64</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.WiX.Architecture.X86">
<summary>
Architecture: <c>x86</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.WiX.Architecture.IA64">
<summary>
Architecture: <c>Itanium</c>
</summary>
</member>
<member name="T:Cake.Common.Tools.WiX.CandleRunner">
<summary>
The WiX Candle runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.WiX.CandleRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.WiX.CandleRunner"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.WiX.CandleRunner.Run(System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.WiX.CandleSettings)">
<summary>
Runs Candle with the specified source files and settings.
</summary>
<param name="sourceFiles">The source files (<c>.wxs</c>) to compile.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.WiX.CandleRunner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.WiX.CandleRunner.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="T:Cake.Common.Tools.WiX.CandleSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.WiX.CandleRunner"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.WiX.CandleSettings.Architecture">
<summary>
Gets or sets a value indicating which architecture to build the MSI package for.
</summary>
</member>
<member name="P:Cake.Common.Tools.WiX.CandleSettings.Defines">
<summary>
Gets or sets the pre processor defines.
</summary>
</member>
<member name="P:Cake.Common.Tools.WiX.CandleSettings.Extensions">
<summary>
Gets or sets the WiX extensions to use.
</summary>
</member>
<member name="P:Cake.Common.Tools.WiX.CandleSettings.FIPS">
<summary>
Gets or sets a value indicating whether FIPS compliant algorithms should be used.
</summary>
<value>
<c>true</c> if FIPS compliant algorithms should be used, otherwise <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.CandleSettings.NoLogo">
<summary>
Gets or sets a value indicating whether to show the logo information.
</summary>
</member>
<member name="P:Cake.Common.Tools.WiX.CandleSettings.OutputDirectory">
<summary>
Gets or sets the output directory for the object files.
</summary>
</member>
<member name="P:Cake.Common.Tools.WiX.CandleSettings.Pedantic">
<summary>
Gets or sets a value indicating whether to show pedantic messages.
</summary>
</member>
<member name="P:Cake.Common.Tools.WiX.CandleSettings.ShowSourceTrace">
<summary>
Gets or sets a value indicating whether to show source trace for errors, warnings and verbose messages.
</summary>
</member>
<member name="P:Cake.Common.Tools.WiX.CandleSettings.Verbose">
<summary>
Gets or sets a value indicating whether to show verbose output.
</summary>
</member>
<member name="T:Cake.Common.Tools.WiX.Heat.HeatRunner">
<summary>
The WiX Heat runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.WiX.Heat.HeatRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.WiX.Heat.HeatRunner" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="toolService">The tool service.</param>
</member>
<member name="M:Cake.Common.Tools.WiX.Heat.HeatRunner.Run(Cake.Core.IO.DirectoryPath,Cake.Core.IO.FilePath,Cake.Common.Tools.WiX.Heat.WiXHarvestType,Cake.Common.Tools.WiX.Heat.HeatSettings)">
<summary>
Runs the Wix Heat runner for the specified directory path.
</summary>
<param name="directoryPath">The directory path.</param>
<param name="outputFile">The output file.</param>
<param name="harvestType">The WiX harvest type.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.WiX.Heat.HeatRunner.Run(Cake.Core.IO.FilePath,Cake.Core.IO.FilePath,Cake.Common.Tools.WiX.Heat.WiXHarvestType,Cake.Common.Tools.WiX.Heat.HeatSettings)">
<summary>
Runs the Wix Heat runner for the specified directory path.
</summary>
<param name="objectFile">The object file.</param>
<param name="outputFile">The output file.</param>
<param name="harvestType">The WiX harvest type.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.WiX.Heat.HeatRunner.Run(System.String,Cake.Core.IO.FilePath,Cake.Common.Tools.WiX.Heat.WiXHarvestType,Cake.Common.Tools.WiX.Heat.HeatSettings)">
<summary>
Runs the Wix Heat runner for the specified directory path.
</summary>
<param name="harvestTarget">The harvest target.</param>
<param name="outputFile">The output file.</param>
<param name="harvestType">The WiX harvest type.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.WiX.Heat.HeatRunner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns> The name of the tool. </returns>
</member>
<member name="M:Cake.Common.Tools.WiX.Heat.HeatRunner.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns> The tool executable name. </returns>
</member>
<member name="T:Cake.Common.Tools.WiX.Heat.HeatSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.WiX.Heat.HeatRunner"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.Extensions">
<summary>
Gets or sets the WiX extensions to use.
</summary>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.NoLogo">
<summary>
Gets or sets a value indicating whether [no logo].
</summary>
<value>
<c>true</c> if [no logo]; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.SuppressSpecificWarnings">
<summary>
Gets or sets the suppress specific warnings.
</summary>
<value>
The suppress specific warnings.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.TreatSpecificWarningsAsErrors">
<summary>
Gets or sets the treat specific warnings as errors.
</summary>
<value>
The treat specific warnings as errors.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.Verbose">
<summary>
Gets or sets a value indicating whether output is verbose.
</summary>
<value>
<c>true</c> if verbose; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.AutogeneratedGuid">
<summary>
Gets or sets a value indicating whether to auto generate <see cref="T:System.Guid"/> at compile time.
</summary>
<value>
<c>true</c> if [autogenerated unique identifier]; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.GenerateGuid">
<summary>
Gets or sets a value indicating whether all components are given a guid.
</summary>
<value>
<c>true</c> if [generate unique identifier]; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.OutputFile">
<summary>
Gets or sets the output file.
</summary>
<value>
The output file.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.SuppressFragments">
<summary>
Gets or sets a value indicating whether to suppress the
generation of fragments for directories and components.
</summary>
<value>
<c>true</c> if [suppress fragments]; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.SuppressUniqueIds">
<summary>
Gets or sets a value indicating whether to suppress unique identifiers
for files, components, and directories.
</summary>
<value>
<c>true</c> if [suppress unique ids]; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.Transform">
<summary>
Gets or sets the transform to apply to harvested files.
</summary>
<value>
The transform.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.File">
<summary>
Gets or sets the file.
</summary>
<value>
The file.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.ComponentGroupName">
<summary>
Gets or sets the name of the component group.
</summary>
<value>
The name of the component group.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.DirectoryReferenceId">
<summary>
Gets or sets the directory reference identifier for generated directory elements.
</summary>
<value>
The directory reference identifier.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.PreprocessorVariable">
<summary>
Gets or sets the preprocessor variable.
</summary>
<value>
The preprocessor variable.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.GenerateBinderVariables">
<summary>
Gets or sets a value indicating whether generate binder variables instead
of preprocessor variables.
</summary>
<value>
<c>true</c> if [generate binder variables]; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.SuppressCom">
<summary>
Gets or sets a value indicating whether the COM elements.
</summary>
<value>
<c>true</c> if [suppress COM]; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.SuppressRegistry">
<summary>
Gets or sets a value indicating whether [suppress registry].
</summary>
<value>
<c>true</c> if [suppress registry]; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.SuppressRootDirectory">
<summary>
Gets or sets a value indicating whether [suppress root directory].
</summary>
<value>
<c>true</c> if [suppress root directory]; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.Configuration">
<summary>
Gets or sets the configuration to set when harvesting the project.
</summary>
<value>
The configuration.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.DirectoryId">
<summary>
Gets or sets the overridden directory identifier for generated directory elements.
</summary>
<value>
The directory identifier.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.Generate">
<summary>
Gets or sets the type of elements to generate.
</summary>
<value>
The generate.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.GenerateGuidWithoutBraces">
<summary>
Gets or sets a value indicating whether to generate guids without curly braces.
</summary>
<value>
<c>true</c> if generate guids without curly braces; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.KeepEmptyDirectories">
<summary>
Gets or sets a value indicating whether to keep empty directories.
</summary>
<value>
<c>true</c> if keep empty directories; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.Platform">
<summary>
Gets or sets the platform to set when harvesting the project.
</summary>
<value>
The platform.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.OutputGroup">
<summary>
Gets or sets the output group of Visual Studio project.
</summary>
<value>
The output group.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.ProjectName">
<summary>
Gets or sets the overridden project name to use in variables.
</summary>
<value>
The name of the project.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.Template">
<summary>
Gets or sets the template to use when harvesting.
</summary>
<value>
The template.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.Indent">
<summary>
Gets or sets the indentation multiplier, overrides default of 4.
</summary>
<value>
The indent.
</value>
</member>
<member name="P:Cake.Common.Tools.WiX.Heat.HeatSettings.SuppressVb6Com">
<summary>
Gets or sets a value indicating whether to suppress VB6 COM registration entries.
</summary>
<value>
<c>true</c> if suppress VB6 COM registration entries; otherwise, <c>false</c>.
</value>
</member>
<member name="T:Cake.Common.Tools.WiX.Heat.WiXGenerateType">
<summary>
Type of elements to generate.
</summary>
</member>
<member name="F:Cake.Common.Tools.WiX.Heat.WiXGenerateType.Components">
<summary>
Generates components
</summary>
</member>
<member name="F:Cake.Common.Tools.WiX.Heat.WiXGenerateType.Container">
<summary>
Generates a container
</summary>
</member>
<member name="F:Cake.Common.Tools.WiX.Heat.WiXGenerateType.PayloadGroup">
<summary>
Generates a payload group
</summary>
</member>
<member name="F:Cake.Common.Tools.WiX.Heat.WiXGenerateType.Layout">
<summary>
Generates a layout
</summary>
</member>
<member name="T:Cake.Common.Tools.WiX.Heat.WiXHarvestType">
<summary>
The type of object file to harvest from.
</summary>
</member>
<member name="F:Cake.Common.Tools.WiX.Heat.WiXHarvestType.Dir">
<summary>
Harvest a directory.
</summary>
</member>
<member name="F:Cake.Common.Tools.WiX.Heat.WiXHarvestType.File">
<summary>
Harvest a file
</summary>
</member>
<member name="F:Cake.Common.Tools.WiX.Heat.WiXHarvestType.Project">
<summary>
Harvest outputs of a Visual Studio project.
</summary>
</member>
<member name="F:Cake.Common.Tools.WiX.Heat.WiXHarvestType.Website">
<summary>
Harvest an IIS web site.
</summary>
</member>
<member name="F:Cake.Common.Tools.WiX.Heat.WiXHarvestType.Perf">
<summary>
Harvest performance counters from a category.
</summary>
</member>
<member name="F:Cake.Common.Tools.WiX.Heat.WiXHarvestType.Reg">
<summary>
Harvest registry information from a reg file.
</summary>
</member>
<member name="T:Cake.Common.Tools.WiX.Heat.WiXOutputGroupType">
<summary>
The Output Group of Visual Studio project.
</summary>
</member>
<member name="F:Cake.Common.Tools.WiX.Heat.WiXOutputGroupType.Binaries">
<summary>
OutputGroup: <c>Binaries</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.WiX.Heat.WiXOutputGroupType.Symbols">
<summary>
OutputGroup: <c>Symbols</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.WiX.Heat.WiXOutputGroupType.Documents">
<summary>
OutputGroup: <c>Documents</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.WiX.Heat.WiXOutputGroupType.Satellites">
<summary>
OutputGroup: <c>Satellites</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.WiX.Heat.WiXOutputGroupType.Sources">
<summary>
OutputGroup: <c>Sources</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.WiX.Heat.WiXOutputGroupType.Content">
<summary>
OutputGroup: <c>Content</c>
</summary>
</member>
<member name="T:Cake.Common.Tools.WiX.Heat.WiXTemplateType">
<summary>
Template type to use for harvesting.
</summary>
</member>
<member name="F:Cake.Common.Tools.WiX.Heat.WiXTemplateType.Fragment">
<summary>
TemplateType: <c>Fragment</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.WiX.Heat.WiXTemplateType.Module">
<summary>
TemplateType: <c>Module</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.WiX.Heat.WiXTemplateType.Product">
<summary>
TemplateType: <c>Product</c>
</summary>
</member>
<member name="T:Cake.Common.Tools.WiX.LightRunner">
<summary>
The WiX Light runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.WiX.LightRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.WiX.LightRunner"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The Cake environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.WiX.LightRunner.Run(System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.WiX.LightSettings)">
<summary>
Runs Light with the specified input object files and settings.
</summary>
<param name="objectFiles">The object files (<c>.wixobj</c>).</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.WiX.LightRunner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.WiX.LightRunner.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="T:Cake.Common.Tools.WiX.LightSettings">
<summary>
Contains settings used by the <see cref="T:Cake.Common.Tools.WiX.LightRunner"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.WiX.LightSettings.Defines">
<summary>
Gets or sets the defined WiX variables.
</summary>
</member>
<member name="P:Cake.Common.Tools.WiX.LightSettings.Extensions">
<summary>
Gets or sets the WiX extensions to use.
</summary>
</member>
<member name="P:Cake.Common.Tools.WiX.LightSettings.RawArguments">
<summary>
Gets or sets raw command line arguments to pass through to the linker.
</summary>
</member>
<member name="P:Cake.Common.Tools.WiX.LightSettings.NoLogo">
<summary>
Gets or sets a value indicating whether to show the logo information.
</summary>
</member>
<member name="P:Cake.Common.Tools.WiX.LightSettings.OutputFile">
<summary>
Gets or sets the path to the output file (i.e. the resulting MSI package).
</summary>
</member>
<member name="T:Cake.Common.Tools.WiX.WiXAliases">
<summary>
<para>Contains functionality related to <see href="http://wixtoolset.org/">WiX</see>.</para>
<para>
In order to use the commands for this alias, include the following in your build.cake file to download and
install from nuget.org, or specify the ToolPath within the appropriate settings class:
<code>
#tool "nuget:?package=WiX"
</code>
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.WiX.WiXAliases.WiXCandle(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern,Cake.Common.Tools.WiX.CandleSettings)">
<summary>
Compiles all <c>.wxs</c> sources matching the specified pattern.
</summary>
<example>
<code>
CandleSettings settings = new CandleSettings {
Architecture = Architecture.X64,
Verbose = true
};
WiXCandle("./src/*.wxs", settings);
</code>
</example>
<param name="context">The context.</param>
<param name="pattern">The globbing pattern.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.WiX.WiXAliases.WiXCandle(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.WiX.CandleSettings)">
<summary>
Compiles all <c>.wxs</c> sources in the provided source files.
</summary>
<example>
<code>
var files = GetFiles("./src/*.wxs");
CandleSettings settings = new CandleSettings {
Architecture = Architecture.X64,
Verbose = true
};
WiXCandle(files, settings);
</code>
</example>
<param name="context">The context.</param>
<param name="sourceFiles">The source files.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.WiX.WiXAliases.WiXLight(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern,Cake.Common.Tools.WiX.LightSettings)">
<summary>
Links all <c>.wixobj</c> files matching the specified pattern.
</summary>
<example>
<code>
LightSettings settings = new LightSettings {
RawArguments = "-O1 -pedantic -v"
};
WiXLight("./src/*.wixobj", settings);
</code>
</example>
<param name="context">The context.</param>
<param name="pattern">The globbing pattern.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.WiX.WiXAliases.WiXLight(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.WiX.LightSettings)">
<summary>
Links all <c>.wixobj</c> files in the provided object files.
</summary>
<example>
<code>
var files = GetFiles("./src/*.wxs");
LightSettings settings = new LightSettings {
RawArguments = "-O1 -pedantic -v"
};
WiXLight(files, settings);
</code>
</example>
<param name="context">The context.</param>
<param name="objectFiles">The object files.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.WiX.WiXAliases.WiXHeat(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath,Cake.Core.IO.FilePath,Cake.Common.Tools.WiX.Heat.WiXHarvestType)">
<summary>
Harvests files in the provided object files.
</summary>
<example>
<code>
DirectoryPath harvestDirectory = Directory("./src");
var filePath = new FilePath("Wix.Directory.wxs");
WiXHeat(harvestDirectory, filePath, WiXHarvestType.Dir);
</code>
</example>
<param name="context">The context.</param>
<param name="directoryPath">The object files.</param>
<param name="outputFile">The output file.</param>
<param name="harvestType">The WiX harvest type.</param>
</member>
<member name="M:Cake.Common.Tools.WiX.WiXAliases.WiXHeat(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath,Cake.Core.IO.FilePath,Cake.Common.Tools.WiX.Heat.WiXHarvestType,Cake.Common.Tools.WiX.Heat.HeatSettings)">
<summary>
Harvests files in the provided directory path.
</summary>
<example>
<code>
DirectoryPath harvestDirectory = Directory("./src");
var filePath = File("Wix.Directory.wxs");
Information(MakeAbsolute(harvestDirectory).FullPath);
WiXHeat(harvestDirectory, filePath, WiXHarvestType.Dir, new HeatSettings { NoLogo = true });
</code>
</example>
<param name="context">The context.</param>
<param name="directoryPath">The directory path.</param>
<param name="outputFile">The output file.</param>
<param name="harvestType">The WiX harvest type.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.WiX.WiXAliases.WiXHeat(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Core.IO.FilePath,Cake.Common.Tools.WiX.Heat.WiXHarvestType)">
<summary>
Harvests from the desired files.
</summary>
<example>
<code>
var harvestFile = File("./tools/Cake/Cake.Core.dll");
var filePath = File("Wix.File.wxs");
WiXHeat(harvestFile, filePath, WiXHarvestType.File);
</code>
</example>
<param name="context">The context.</param>
<param name="objectFile">The object file.</param>
<param name="outputFile">The output file.</param>
<param name="harvestType">The WiX harvest type.</param>
</member>
<member name="M:Cake.Common.Tools.WiX.WiXAliases.WiXHeat(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Core.IO.FilePath,Cake.Common.Tools.WiX.Heat.WiXHarvestType,Cake.Common.Tools.WiX.Heat.HeatSettings)">
<summary>
Harvests from the desired files.
</summary>
<example>
<code>
var harvestFiles = File("./tools/Cake/*.dll");
var filePath = File("Wix.File.wxs");
WiXHeat(harvestFiles, filePath, WiXHarvestType.File, new HeatSettings { NoLogo = true });
</code>
</example>
<param name="context">The context.</param>
<param name="objectFile">The object file.</param>
<param name="outputFile">The output file.</param>
<param name="harvestType">The WiX harvest type.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.WiX.WiXAliases.WiXHeat(Cake.Core.ICakeContext,System.String,Cake.Core.IO.FilePath,Cake.Common.Tools.WiX.Heat.WiXHarvestType)">
<summary>
Harvests files for a website or performance.
</summary>
<example>
<code>
var filePath = File("Wix.Website.wxs");
WiXHeat("Default Web Site", filePath, WiXHarvestType.Website);
</code>
</example>
<param name="context">The context.</param>
<param name="harvestTarget">The harvest target.</param>
<param name="outputFile">The output file.</param>
<param name="harvestType">The WiX harvest type.</param>
</member>
<member name="M:Cake.Common.Tools.WiX.WiXAliases.WiXHeat(Cake.Core.ICakeContext,System.String,Cake.Core.IO.FilePath,Cake.Common.Tools.WiX.Heat.WiXHarvestType,Cake.Common.Tools.WiX.Heat.HeatSettings)">
<summary>
Harvests files for a website or performance.
</summary>
<example>
<code>
var filePath = File("Wix.Website.wxs");
WiXHeat("Default Web Site", filePath, WiXHarvestType.Website, new HeatSettings { NoLogo = true });
</code>
</example>
<param name="context">The context.</param>
<param name="harvestTarget">The harvest target.</param>
<param name="outputFile">The output file.</param>
<param name="harvestType">The WiX harvest type.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.XBuild.NamespaceDoc">
<summary>
This namespace contain types used
to interact with XBuild.
</summary>
</member>
<member name="T:Cake.Common.Tools.XBuild.XBuildAliases">
<summary>
<para>Contains functionality related to <see href="http://www.mono-project.com/docs/tools+libraries/tools/xbuild/">XBuild</see>.</para>
<para>
In order to use the commands for this alias, XBuild (which is part of Mono) will already have to be installed on the machine the
Cake Script is being executed.
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.XBuild.XBuildAliases.XBuild(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Builds the specified solution using XBuild.
</summary>
<param name="context">The context.</param>
<param name="solution">The solution to build.</param>
<example>
<code>
XBuild("./src/Cake.sln");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.XBuild.XBuildAliases.XBuild(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,System.Action{Cake.Common.Tools.XBuild.XBuildSettings})">
<summary>
Builds the specified solution using XBuild.
</summary>
<param name="context">The context.</param>
<param name="solution">The solution to build.</param>
<param name="configurator">The settings configurator.</param>
<example>
<code>
XBuild("./src/Cake.sln", configurator =>
configurator.SetConfiguration("Debug")
.SetVerbosity(Verbosity.Minimal)
.UseToolVersion(XBuildToolVersion.NET40));
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.XBuild.XBuildAliases.XBuild(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Common.Tools.XBuild.XBuildSettings)">
<summary>
Builds the specified solution using XBuild.
</summary>
<param name="context">The context.</param>
<param name="solution">The solution to build.</param>
<param name="settings">The settings.</param>
<example>
<code>
XBuild("./src/Cake.sln", new XBuildSettings {
Verbosity = Verbosity.Minimal,
ToolVersion = XBuildToolVersion.NET40,
Configuration = "Release"
});
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.XBuild.XBuildRunner">
<summary>
The XBuild runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.XBuild.XBuildRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.XBuild.XBuildRunner"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="runner">The runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.XBuild.XBuildRunner.Run(Cake.Core.IO.FilePath,Cake.Common.Tools.XBuild.XBuildSettings)">
<summary>
Runs XBuild with the specified settings.
</summary>
<param name="solution">The solution to build.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.XBuild.XBuildRunner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.XBuild.XBuildRunner.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="M:Cake.Common.Tools.XBuild.XBuildRunner.GetAlternativeToolPaths(Cake.Common.Tools.XBuild.XBuildSettings)">
<summary>
Gets alternative file paths which the tool may exist in.
</summary>
<param name="settings">The settings.</param>
<returns>The default tool path.</returns>
</member>
<member name="T:Cake.Common.Tools.XBuild.XBuildSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.XBuild.XBuildRunner"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.XBuild.XBuildSettings.Targets">
<summary>
Gets the targets.
</summary>
<value>The targets.</value>
</member>
<member name="P:Cake.Common.Tools.XBuild.XBuildSettings.Properties">
<summary>
Gets the properties.
</summary>
<value>The properties.</value>
</member>
<member name="P:Cake.Common.Tools.XBuild.XBuildSettings.ToolVersion">
<summary>
Gets or sets the tool version.
</summary>
<value>The tool version.</value>
</member>
<member name="P:Cake.Common.Tools.XBuild.XBuildSettings.Configuration">
<summary>
Gets or sets the configuration.
</summary>
<value>The configuration.</value>
</member>
<member name="P:Cake.Common.Tools.XBuild.XBuildSettings.Verbosity">
<summary>
Gets or sets the amount of information to display in the build log.
Each logger displays events based on the verbosity level that you set for that logger.
</summary>
<value>The build log verbosity.</value>
</member>
<member name="M:Cake.Common.Tools.XBuild.XBuildSettings.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.XBuild.XBuildSettings"/> class.
</summary>
</member>
<member name="T:Cake.Common.Tools.XBuild.XBuildSettingsExtensions">
<summary>
Contains functionality related to XBuild settings.
</summary>
</member>
<member name="M:Cake.Common.Tools.XBuild.XBuildSettingsExtensions.WithTarget(Cake.Common.Tools.XBuild.XBuildSettings,System.String)">
<summary>
Adds a XBuild target to the configuration.
</summary>
<param name="settings">The settings.</param>
<param name="target">The XBuild target.</param>
<returns>The same <see cref="T:Cake.Common.Tools.XBuild.XBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.XBuild.XBuildSettingsExtensions.UseToolVersion(Cake.Common.Tools.XBuild.XBuildSettings,Cake.Common.Tools.XBuild.XBuildToolVersion)">
<summary>
Sets the tool version.
</summary>
<param name="settings">The settings.</param>
<param name="version">The version.</param>
<returns>The same <see cref="T:Cake.Common.Tools.XBuild.XBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.XBuild.XBuildSettingsExtensions.WithProperty(Cake.Common.Tools.XBuild.XBuildSettings,System.String,System.String[])">
<summary>
Adds a property to the configuration.
</summary>
<param name="settings">The settings.</param>
<param name="name">The property name.</param>
<param name="values">The property values.</param>
<returns>The same <see cref="T:Cake.Common.Tools.XBuild.XBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.XBuild.XBuildSettingsExtensions.SetConfiguration(Cake.Common.Tools.XBuild.XBuildSettings,System.String)">
<summary>
Sets the configuration.
</summary>
<param name="settings">The settings.</param>
<param name="configuration">The configuration.</param>
<returns>The same <see cref="T:Cake.Common.Tools.XBuild.XBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.XBuild.XBuildSettingsExtensions.SetVerbosity(Cake.Common.Tools.XBuild.XBuildSettings,Cake.Core.Diagnostics.Verbosity)">
<summary>
Sets the build log verbosity.
</summary>
<param name="settings">The settings.</param>
<param name="verbosity">The build log verbosity.</param>
<returns>The same <see cref="T:Cake.Common.Tools.XBuild.XBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="T:Cake.Common.Tools.XBuild.XBuildToolVersion">
<summary>
Represents a XBuild tool version.
</summary>
</member>
<member name="F:Cake.Common.Tools.XBuild.XBuildToolVersion.Default">
<summary>
The highest available XBuild tool version.
</summary>
</member>
<member name="F:Cake.Common.Tools.XBuild.XBuildToolVersion.NET20">
<summary>
XBuild tool version: <c>.NET 2.0</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.XBuild.XBuildToolVersion.NET30">
<summary>
XBuild tool version: <c>.NET 3.0</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.XBuild.XBuildToolVersion.NET35">
<summary>
XBuild tool version: <c>.NET 3.5</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.XBuild.XBuildToolVersion.NET40">
<summary>
XBuild tool version: <c>.NET 4.0</c>
</summary>
</member>
<member name="T:Cake.Common.Tools.XUnit.NamespaceDoc">
<summary>
This namespace contain types used to interact with XUnit.
</summary>
</member>
<member name="T:Cake.Common.Tools.XUnit.ParallelismOption">
<summary>
Represents XUnit2's options for parallel test execution.
</summary>
</member>
<member name="F:Cake.Common.Tools.XUnit.ParallelismOption.None">
<summary>
Turn off all parallelization
</summary>
</member>
<member name="F:Cake.Common.Tools.XUnit.ParallelismOption.Collections">
<summary>
Only parallelize collections
</summary>
</member>
<member name="F:Cake.Common.Tools.XUnit.ParallelismOption.Assemblies">
<summary>
Only parallelize assemblies
</summary>
</member>
<member name="F:Cake.Common.Tools.XUnit.ParallelismOption.All">
<summary>
Parallelize assemblies and collections.
</summary>
</member>
<member name="T:Cake.Common.Tools.XUnit.XUnit2Aliases">
<summary>
<para>Contains functionality related to running <see href="https://github.com/xunit/xunit">xunit</see> tests.</para>
<para>
In order to use the commands for this alias, include the following in your build.cake file to download and
install from nuget.org, or specify the ToolPath within the <see cref="T:Cake.Common.Tools.XUnit.XUnit2Settings" /> class:
<code>
#tool "nuget:?package=xunit.runner.console"
</code>
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.XUnit.XUnit2Aliases.XUnit2(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern)">
<summary>
Runs all xUnit.net v2 tests in the assemblies matching the specified pattern.
</summary>
<param name="context">The context.</param>
<param name="pattern">The pattern.</param>
<example>
<code>
XUnit2("./src/**/bin/Release/*.Tests.dll");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.XUnit.XUnit2Aliases.XUnit2(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern,Cake.Common.Tools.XUnit.XUnit2Settings)">
<summary>
Runs all xUnit.net v2 tests in the assemblies matching the specified pattern.
</summary>
<param name="context">The context.</param>
<param name="pattern">The pattern.</param>
<param name="settings">The settings.</param>
<example>
<code>
XUnit2("./src/**/bin/Release/*.Tests.dll",
new XUnit2Settings {
Parallelism = ParallelismOption.All,
HtmlReport = true,
NoAppDomain = true,
OutputDirectory = "./build"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.XUnit.XUnit2Aliases.XUnit2(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{System.String})">
<summary>
Runs all xUnit.net v2 tests in the specified assemblies.
</summary>
<param name="context">The context.</param>
<param name="assemblies">The assemblies.</param>
<example>
<code>
XUnit2(new []{
"./src/Cake.Common.Tests/bin/Release/Cake.Common.Tests.dll",
"./src/Cake.Core.Tests/bin/Release/Cake.Core.Tests.dll",
"./src/Cake.NuGet.Tests/bin/Release/Cake.NuGet.Tests.dll",
"./src/Cake.Tests/bin/Release/Cake.Tests.dll"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.XUnit.XUnit2Aliases.XUnit2(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath})">
<summary>
Runs all xUnit.net tests in the specified assemblies.
</summary>
<param name="context">The context.</param>
<param name="assemblies">The assemblies.</param>
<example>
<code>
var testAssemblies = GetFiles("./src/**/bin/Release/*.Tests.dll");
XUnit2(testAssemblies);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.XUnit.XUnit2Aliases.XUnit2(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{System.String},Cake.Common.Tools.XUnit.XUnit2Settings)">
<summary>
Runs all xUnit.net v2 tests in the specified assemblies.
</summary>
<param name="context">The context.</param>
<param name="assemblies">The assemblies.</param>
<param name="settings">The settings.</param>
<example>
<code>
XUnit2(new []{
"./src/Cake.Common.Tests/bin/Release/Cake.Common.Tests.dll",
"./src/Cake.Core.Tests/bin/Release/Cake.Core.Tests.dll",
"./src/Cake.NuGet.Tests/bin/Release/Cake.NuGet.Tests.dll",
"./src/Cake.Tests/bin/Release/Cake.Tests.dll"
},
new XUnit2Settings {
Parallelism = ParallelismOption.All,
HtmlReport = true,
NoAppDomain = true,
OutputDirectory = "./build"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.XUnit.XUnit2Aliases.XUnit2(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.XUnit.XUnit2Settings)">
<summary>
Runs all xUnit.net v2 tests in the specified assemblies.
</summary>
<param name="context">The context.</param>
<param name="assemblies">The assemblies.</param>
<param name="settings">The settings.</param>
<example>
<code>
var testAssemblies = GetFiles("./src/**/bin/Release/*.Tests.dll");
XUnit2(testAssemblies,
new XUnit2Settings {
Parallelism = ParallelismOption.All,
HtmlReport = true,
NoAppDomain = true,
OutputDirectory = "./build"
});
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.XUnit.XUnit2Runner">
<summary>
The xUnit.net v2 test runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.XUnit.XUnit2Runner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.XUnit.XUnit2Runner" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="runner">The runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.XUnit.XUnit2Runner.Run(System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.XUnit.XUnit2Settings)">
<summary>
Runs the tests in the specified assembly.
</summary>
<param name="assemblyPaths">The assembly paths.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.XUnit.XUnit2Runner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.XUnit.XUnit2Runner.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="T:Cake.Common.Tools.XUnit.XUnit2Settings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.XUnit.XUnit2Runner"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.XUnit.XUnit2Settings.ShadowCopy">
<summary>
Gets or sets a value indicating whether tests should be run as a shadow copy.
Default value is <c>true</c>.
</summary>
<value>
<c>true</c> if tests should be run as a shadow copy; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.XUnit.XUnit2Settings.OutputDirectory">
<summary>
Gets or sets the output directory.
</summary>
<value>The output directory.</value>
</member>
<member name="P:Cake.Common.Tools.XUnit.XUnit2Settings.NUnitReport">
<summary>
Gets or sets a value indicating whether an NUnit style XML report should be generated.
</summary>
<value>
<c>true</c> if an NUnit Style XML report should be generated; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.XUnit.XUnit2Settings.JUnitReport">
<summary>
Gets or sets a value indicating whether an JUnit style XML report should be generated.
</summary>
<value>
<c>true</c> if an JUnit Style XML report should be generated; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.XUnit.XUnit2Settings.XmlReport">
<summary>
Gets or sets a value indicating whether an XML report should be generated.
</summary>
<value>
<c>true</c> if an XML report should be generated; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.XUnit.XUnit2Settings.XmlReportV1">
<summary>
Gets or sets a value indicating whether an xUnit.net v1 style XML report should be generated.
</summary>
</member>
<member name="P:Cake.Common.Tools.XUnit.XUnit2Settings.HtmlReport">
<summary>
Gets or sets a value indicating whether an HTML report should be generated.
</summary>
<value>
<c>true</c> if an HTML report should be generated; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.XUnit.XUnit2Settings.ReportName">
<summary>
Gets or sets the name that should be used for the HTML and XML reports.
</summary>
<value>The custom report name.</value>
</member>
<member name="P:Cake.Common.Tools.XUnit.XUnit2Settings.NoAppDomain">
<summary>
Gets or sets a value indicating whether to not use app domains to run test code.
</summary>
<value>
<c>true</c> to not use app domains to run test code; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.XUnit.XUnit2Settings.Parallelism">
<summary>
Gets or sets the parallelism option.
Corresponds to the -parallel command line switch.
</summary>
<value>
The parallelism option.
</value>
</member>
<member name="P:Cake.Common.Tools.XUnit.XUnit2Settings.UseX86">
<summary>
Gets or sets a value indicating whether to run tests in using x86 test runner.
</summary>
<value>
<c>true</c> to run tests with the x86 test runner; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.XUnit.XUnit2Settings.MaxThreads">
<summary>
Gets or sets the maximum thread count for collection parallelization.
</summary>
<value>
<c>null</c> (default);
<c>0</c>: run with unbounded thread count;
<c>>0</c>: limit task thread pool size to value;.
</value>
<exception cref="T:System.ArgumentOutOfRangeException" accessor="set">value < 0.</exception>
</member>
<member name="P:Cake.Common.Tools.XUnit.XUnit2Settings.TraitsToInclude">
<summary>
Gets the traits to include.
</summary>
<remarks>
Only run tests with matching name/value traits.
If more than one is specified, it acts as an OR operation.
</remarks>
<value>
The traits to include.
</value>
</member>
<member name="P:Cake.Common.Tools.XUnit.XUnit2Settings.TraitsToExclude">
<summary>
Gets the traits to exclude.
</summary>
<remarks>
Do not run tests with matching name/value traits.
If more than one is specified, it acts as an AND operation.
</remarks>
<value>
The traits to exclude.
</value>
</member>
<member name="P:Cake.Common.Tools.XUnit.XUnit2Settings.NamespacesToInclude">
<summary>
Gets the namespaces to include.
</summary>
<remarks>
Runs all methods in a given namespace (i.e., 'MyNamespace.MySubNamespace')
If more than one is specified, it acts as an OR operation.
</remarks>
<value>
The namespaces to include.
</value>
</member>
<member name="P:Cake.Common.Tools.XUnit.XUnit2Settings.ClassesToInclude">
<summary>
Gets the class names to include.
</summary>
<remarks>
Runs all methods in a given test class (should be fully specified; i.e., 'MyNamespace.MyClass')
If more than one is specified, it acts as an OR operation.
</remarks>
<value>
The class names to include.
</value>
</member>
<member name="P:Cake.Common.Tools.XUnit.XUnit2Settings.MethodsToInclude">
<summary>
Gets the test methods to include.
</summary>
<remarks>
Runs the given test methods (should be fully specified; i.e., 'MyNamespace.MyClass.MyTestMethod')
If more than one is specified, it acts as an OR operation.
</remarks>
<value>
The namespaces to include.
</value>
</member>
<member name="M:Cake.Common.Tools.XUnit.XUnit2Settings.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.XUnit.XUnit2Settings"/> class.
</summary>
</member>
<member name="T:Cake.Common.Tools.XUnit.XUnit2SettingsExtensions">
<summary>
Contains functionality related to XUnit2 settings.
</summary>
</member>
<member name="M:Cake.Common.Tools.XUnit.XUnit2SettingsExtensions.IncludeTrait(Cake.Common.Tools.XUnit.XUnit2Settings,System.String,System.String[])">
<summary>
Adds a trait to the settings, to include in test execution.
</summary>
<param name="settings">The settings.</param>
<param name="name">The trait name.</param>
<param name="values">The trait values.</param>
<returns>The same <see cref="T:Cake.Common.Tools.XUnit.XUnit2Settings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.XUnit.XUnit2SettingsExtensions.ExcludeTrait(Cake.Common.Tools.XUnit.XUnit2Settings,System.String,System.String[])">
<summary>
Adds a trait to the settings, to exclude in test execution.
</summary>
<param name="settings">The settings.</param>
<param name="name">The trait name.</param>
<param name="values">The trait values.</param>
<returns>The same <see cref="T:Cake.Common.Tools.XUnit.XUnit2Settings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.XUnit.XUnit2SettingsExtensions.IncludeNamespace(Cake.Common.Tools.XUnit.XUnit2Settings,System.String)">
<summary>
Adds a namespace to the settings, to include in test execution. Namespace should be fully qualified; i.e., MyNameSpace.MySubNamespace.
</summary>
<param name="settings">The settings.</param>
<param name="namespaceToInclude">The namespace to include.</param>
<returns>The same <see cref="T:Cake.Common.Tools.XUnit.XUnit2Settings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.XUnit.XUnit2SettingsExtensions.IncludeClass(Cake.Common.Tools.XUnit.XUnit2Settings,System.String)">
<summary>
Adds a class name to the settings, to include in test execution. Class name should be fully qualified; i.e., MyNameSpace.MyClassName.
</summary>
<param name="settings">The settings.</param>
<param name="classNameToInclude">The class name to include.</param>
<returns>The same <see cref="T:Cake.Common.Tools.XUnit.XUnit2Settings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.XUnit.XUnit2SettingsExtensions.IncludeMethod(Cake.Common.Tools.XUnit.XUnit2Settings,System.String)">
<summary>
Adds a method name to the settings, to include in test execution. Method name should be fully qualified; i.e., MyNameSpace.MyClassName.MyMethod.
</summary>
<param name="settings">The settings.</param>
<param name="methodNameToInclude">The method name to include.</param>
<returns>The same <see cref="T:Cake.Common.Tools.XUnit.XUnit2Settings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="T:Cake.Common.Tools.XUnit.XUnitAliases">
<summary>
<para>Contains functionality related to running <see href="https://github.com/xunit/xunit">xunit</see> tests.</para>
<para>
In order to use the commands for this alias, include the following in your build.cake file to download and
install from nuget.org, or specify the ToolPath within the <see cref="T:Cake.Common.Tools.XUnit.XUnitSettings" /> class:
<code>
#tool "nuget:?package=xunit.runner.console&version=2.2.0"
</code>
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.XUnit.XUnitAliases.XUnit(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern)">
<summary>
Runs all xUnit.net tests in the assemblies matching the specified pattern.
</summary>
<param name="context">The context.</param>
<param name="pattern">The pattern.</param>
<example>
<code>
XUnit("./src/**/bin/Release/*.Tests.dll");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.XUnit.XUnitAliases.XUnit(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern,Cake.Common.Tools.XUnit.XUnitSettings)">
<summary>
Runs all xUnit.net tests in the assemblies matching the specified pattern.
</summary>
<param name="context">The context.</param>
<param name="pattern">The pattern.</param>
<param name="settings">The settings.</param>
<example>
<code>
XUnit("./src/**/bin/Release/*.Tests.dll",
new XUnitSettings {
HtmlReport = true,
OutputDirectory = "./build"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.XUnit.XUnitAliases.XUnit(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{System.String})">
<summary>
Runs all xUnit.net tests in the specified assemblies.
</summary>
<param name="context">The context.</param>
<param name="assemblies">The assemblies.</param>
<example>
<code>
XUnit(new []{
"./src/Cake.Common.Tests/bin/Release/Cake.Common.Tests.dll",
"./src/Cake.Core.Tests/bin/Release/Cake.Core.Tests.dll",
"./src/Cake.NuGet.Tests/bin/Release/Cake.NuGet.Tests.dll",
"./src/Cake.Tests/bin/Release/Cake.Tests.dll"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.XUnit.XUnitAliases.XUnit(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath})">
<summary>
Runs all xUnit.net tests in the specified assemblies.
</summary>
<param name="context">The context.</param>
<param name="assemblies">The assemblies.</param>
<example>
<code>
var testAssemblies = GetFiles("./src/**/bin/Release/*.Tests.dll");
XUnit(testAssemblies);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.XUnit.XUnitAliases.XUnit(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{System.String},Cake.Common.Tools.XUnit.XUnitSettings)">
<summary>
Runs all xUnit.net tests in the specified assemblies.
</summary>
<param name="context">The context.</param>
<param name="assemblies">The assemblies.</param>
<param name="settings">The settings.</param>
<example>
<code>
XUnit(new []{
"./src/Cake.Common.Tests/bin/Release/Cake.Common.Tests.dll",
"./src/Cake.Core.Tests/bin/Release/Cake.Core.Tests.dll",
"./src/Cake.NuGet.Tests/bin/Release/Cake.NuGet.Tests.dll",
"./src/Cake.Tests/bin/Release/Cake.Tests.dll"
},
new XUnitSettings {
HtmlReport = true,
OutputDirectory = "./build"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.XUnit.XUnitAliases.XUnit(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.XUnit.XUnitSettings)">
<summary>
Runs all xUnit.net tests in the specified assemblies.
</summary>
<param name="context">The context.</param>
<param name="assemblies">The assemblies.</param>
<param name="settings">The settings.</param>
<example>
<code>
var testAssemblies = GetFiles("./src/**/bin/Release/*.Tests.dll");
XUnit(testAssemblies,
new XUnitSettings {
HtmlReport = true,
OutputDirectory = "./build"
});
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.XUnit.XUnitRunner">
<summary>
The xUnit.net (v1) test runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.XUnit.XUnitRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.XUnit.XUnitRunner" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="runner">The runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.XUnit.XUnitRunner.Run(Cake.Core.IO.FilePath,Cake.Common.Tools.XUnit.XUnitSettings)">
<summary>
Runs the tests in the specified assembly.
</summary>
<param name="assemblyPath">The assembly path.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.XUnit.XUnitRunner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.XUnit.XUnitRunner.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="T:Cake.Common.Tools.XUnit.XUnitSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.XUnit.XUnitRunner" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.XUnit.XUnitSettings.ShadowCopy">
<summary>
Gets or sets a value indicating whether tests should be run as a shadow copy.
Default value is <c>true</c>.
</summary>
<value>
<c>true</c> if tests should be run as a shadow copy; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.XUnit.XUnitSettings.OutputDirectory">
<summary>
Gets or sets the output directory.
</summary>
<value>The output directory.</value>
</member>
<member name="P:Cake.Common.Tools.XUnit.XUnitSettings.XmlReport">
<summary>
Gets or sets a value indicating whether an XML report should be generated.
</summary>
<value>
<c>true</c> if an XML report should be generated; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.XUnit.XUnitSettings.HtmlReport">
<summary>
Gets or sets a value indicating whether an HTML report should be generated.
</summary>
<value>
<c>true</c> if an HTML report should be generated; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.XUnit.XUnitSettings.Silent">
<summary>
Gets or sets a value indicating whether or not output running test count.
</summary>
<value>
<c>true</c> if running test count should be outputted; otherwise, <c>false</c>.
</value>
</member>
<member name="M:Cake.Common.Tools.XUnit.XUnitSettings.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.XUnit.XUnitSettings"/> class.
</summary>
</member>
<member name="T:Cake.Common.Tools.Xml.NamespaceDoc">
<summary>
This namespace contain types used to
interact with XML documents.
</summary>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.ApiKey.ChocolateyApiKeySetter">
<summary>
The Chocolatey package pinner used to pin Chocolatey packages.
</summary>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ApiKey.ChocolateyApiKeySetter.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Common.Tools.Chocolatey.IChocolateyToolResolver)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.Chocolatey.ApiKey.ChocolateyApiKeySetter"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="resolver">The Chocolatey tool resolver.</param>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ApiKey.ChocolateyApiKeySetter.Set(System.String,Cake.Common.Tools.Chocolatey.ApiKey.ChocolateyApiKeySettings)">
<summary>
Pins Chocolatey packages using the specified package id and settings.
</summary>
<param name="source">The Server URL where the API key is valid.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.ApiKey.ChocolateyApiKeySettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.Chocolatey.ApiKey.ChocolateyApiKeySetter"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ApiKey.ChocolateyApiKeySettings.ApiKey">
<summary>
Gets or sets the API key for the server.
</summary>
<value>The API key for the server.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ApiKey.ChocolateyApiKeySettings.Remove">
<summary>
Gets or sets a value indicating whether to remove the selected source.
</summary>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.ChocolateyAliases">
<summary>
<para>Contains functionality for working with <see href="https://github.com/chocolatey/choco">Chocolatey</see>.</para>
<para>
In order to use the commands for this alias, Chocolatey will require to be installed on the machine where the build script
is being run. See this <see href="https://github.com/chocolatey/choco/wiki/Installation">page</see> for details on how
Chocolatey can be installed.
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyPack(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings)">
<summary>
Creates a Chocolatey package using the specified Nuspec file.
</summary>
<param name="context">The context.</param>
<param name="nuspecFilePath">The nuspec file path.</param>
<param name="settings">The settings.</param>
<example>
<code>
var chocolateyPackSettings = new ChocolateyPackSettings {
Id = "TestChocolatey",
Title = "The tile of the package",
Version = "0.0.0.1",
Authors = new[] {"John Doe"},
Owners = new[] {"Contoso"},
Summary = "Excellent summary of what the package does",
Description = "The description of the package",
ProjectUrl = new Uri("https://github.com/SomeUser/TestChocolatey/"),
PackageSourceUrl = new Uri("https://github.com/SomeUser/TestChocolatey/"),
ProjectSourceUrl = new Uri("https://github.com/SomeUser/TestChocolatey/"),
DocsUrl = new Uri("https://github.com/SomeUser/TestChocolatey/"),
MailingListUrl = new Uri("https://github.com/SomeUser/TestChocolatey/"),
BugTrackerUrl = new Uri("https://github.com/SomeUser/TestChocolatey/"),
Tags = new [] {"Cake", "Script", "Build"},
Copyright = "Some company 2015",
LicenseUrl = new Uri("https://github.com/SomeUser/TestChocolatey/blob/master/LICENSE.md"),
RequireLicenseAcceptance= false,
IconUrl = new Uri("http://cdn.rawgit.com/SomeUser/TestChocolatey/master/icons/testchocolatey.png"),
ReleaseNotes = new [] {"Bug fixes", "Issue fixes", "Typos"},
Files = new [] {
new ChocolateyNuSpecContent {Source = "bin/TestChocolatey.dll", Target = "bin"},
},
Debug = false,
Verbose = false,
Force = false,
Noop = false,
LimitOutput = false,
ExecutionTimeout = 13,
CacheLocation = @"C:\temp",
AllowUnofficial = false
};
ChocolateyPack("./nuspec/TestChocolatey.nuspec", chocolateyPackSettings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyPack(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings)">
<summary>
Creates Chocolatey packages using the specified Nuspec files.
</summary>
<param name="context">The context.</param>
<param name="filePaths">The nuspec file paths.</param>
<param name="settings">The settings.</param>
<example>
<code>
var chocolateyPackSettings = new ChocolateyPackSettings {
Id = "TestChocolatey",
Title = "The tile of the package",
Version = "0.0.0.1",
Authors = new[] {"John Doe"},
Owners = new[] {"Contoso"},
Summary = "Excellent summary of what the package does",
Description = "The description of the package",
ProjectUrl = new Uri("https://github.com/SomeUser/TestChocolatey/"),
PackageSourceUrl = new Uri("https://github.com/SomeUser/TestChocolatey/"),
ProjectSourceUrl = new Uri("https://github.com/SomeUser/TestChocolatey/"),
DocsUrl = new Uri("https://github.com/SomeUser/TestChocolatey/"),
MailingListUrl = new Uri("https://github.com/SomeUser/TestChocolatey/"),
BugTrackerUrl = new Uri("https://github.com/SomeUser/TestChocolatey/"),
Tags = new [] {"Cake", "Script", "Build"},
Copyright = "Some company 2015",
LicenseUrl = new Uri("https://github.com/SomeUser/TestChocolatey/blob/master/LICENSE.md"),
RequireLicenseAcceptance= false,
IconUrl = new Uri("http://cdn.rawgit.com/SomeUser/TestChocolatey/master/icons/testchocolatey.png"),
ReleaseNotes = new [] {"Bug fixes", "Issue fixes", "Typos"},
Files = new [] {
new ChocolateyNuSpecContent {Source = "bin/TestChocolatey.dll", Target = "bin"},
},
Debug = false,
Verbose = false,
Force = false,
Noop = false,
LimitOutput = false,
ExecutionTimeout = 13,
CacheLocation = @"C:\temp",
AllowUnofficial = false
};
var nuspecFiles = GetFiles("./**/*.nuspec");
ChocolateyPack(nuspecFiles, chocolateyPackSettings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyPack(Cake.Core.ICakeContext,Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings)">
<summary>
Creates a Chocolatey package using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="settings">The settings.</param>
<example>
<code>
var chocolateyPackSettings = new ChocolateyPackSettings {
Id = "TestChocolatey",
Title = "The tile of the package",
Version = "0.0.0.1",
Authors = new[] {"John Doe"},
Owners = new[] {"Contoso"},
Summary = "Excellent summary of what the package does",
Description = "The description of the package",
ProjectUrl = new Uri("https://github.com/SomeUser/TestChocolatey/"),
PackageSourceUrl = new Uri("https://github.com/SomeUser/TestChocolatey/"),
ProjectSourceUrl = new Uri("https://github.com/SomeUser/TestChocolatey/"),
DocsUrl = new Uri("https://github.com/SomeUser/TestChocolatey/"),
MailingListUrl = new Uri("https://github.com/SomeUser/TestChocolatey/"),
BugTrackerUrl = new Uri("https://github.com/SomeUser/TestChocolatey/"),
Tags = new [] {"Cake", "Script", "Build"},
Copyright = "Some company 2015",
LicenseUrl = new Uri("https://github.com/SomeUser/TestChocolatey/blob/master/LICENSE.md"),
RequireLicenseAcceptance= false,
IconUrl = new Uri("http://cdn.rawgit.com/SomeUser/TestChocolatey/master/icons/testchocolatey.png"),
ReleaseNotes = new [] {"Bug fixes", "Issue fixes", "Typos"},
Files = new [] {
new ChocolateyNuSpecContent {Source = "bin/TestChocolatey.dll", Target = "bin"},
},
Debug = false,
Verbose = false,
Force = false,
Noop = false,
LimitOutput = false,
ExecutionTimeout = 13,
CacheLocation = @"C:\temp",
AllowUnofficial = false
};
ChocolateyPack(chocolateyPackSettings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyInstall(Cake.Core.ICakeContext,System.String)">
<summary>
Installs a Chocolatey package.
</summary>
<param name="context">The context.</param>
<param name="packageId">The id of the package to install.</param>
<example>
<code>
ChocolateyInstall("MyChocolateyPackage");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyInstall(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.Chocolatey.Install.ChocolateyInstallSettings)">
<summary>
Installs a Chocolatey package using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="packageId">The id of the package to install.</param>
<param name="settings">The settings.</param>
<example>
<code>
ChocolateyInstall("MyChocolateyPackage", new ChocolateyInstallSettings {
Source = true,
Version = "1.2.3",
Prerelease = false,
Forcex86 = false,
InstallArguments = "arg1",
OverrideArguments = false,
NotSilent = false,
PackageParameters = "param1",
AllowDowngrade = false,
SideBySide = false,
IgnoreDependencies = false,
ForceDependencies = false,
SkipPowerShell = false,
User = "user",
Password = "password",
IgnoreChecksums = false,
Debug = false,
Verbose = false,
Force = false,
Noop = false,
LimitOutput = false,
ExecutionTimeout = 13,
CacheLocation = @"C:\temp",
AllowUnofficial = false
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyInstallFromConfig(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Installs Chocolatey packages using the specified package configuration.
</summary>
<param name="context">The context.</param>
<param name="packageConfigPath">The package configuration to install.</param>
<example>
<code>
ChocolateyInstallFromConfig("./tools/packages.config");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyInstallFromConfig(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Common.Tools.Chocolatey.Install.ChocolateyInstallSettings)">
<summary>
Installs Chocolatey packages using the specified package configuration and settings.
</summary>
<param name="context">The context.</param>
<param name="packageConfigPath">The package configuration to install.</param>
<param name="settings">The settings.</param>
<example>
<code>
ChocolateyInstallFromConfig("./tools/packages.config", new ChocolateyInstallSettings {
Source = true,
Version = "1.2.3",
Prerelease = false,
Forcex86 = false,
InstallArguments = "arg1",
OverrideArguments = false,
NotSilent = false,
PackageParameters = "param1",
AllowDowngrade = false,
SideBySide = false,
IgnoreDependencies = false,
ForceDependencies = false,
SkipPowerShell = false,
User = "user",
Password = "password",
IgnoreChecksums = false,
Debug = false,
Verbose = false,
Force = false,
Noop = false,
LimitOutput = false,
ExecutionTimeout = 13,
CacheLocation = @"C:\temp",
AllowUnofficial = false
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyUninstall(Cake.Core.ICakeContext,System.String)">
<summary>
Uninstalls a Chocolatey package.
</summary>
<param name="context">The context.</param>
<param name="packageId">The id of the package to uninstall.</param>
<example>
<code>
ChocolateyUninstall("MyChocolateyPackage");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyUninstall(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.Chocolatey.Uninstall.ChocolateyUninstallSettings)">
<summary>
Uninstalls a Chocolatey package using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="packageId">The id of the package to uninstall.</param>
<param name="settings">The settings.</param>
<example>
<code>
ChocolateyUninstall("MyChocolateyPackage", new ChocolateyUninstallSettings {
Source = true,
Version = "1.2.3",
UninstallArguments = "arg1",
OverrideArguments = false,
NotSilent = false,
PackageParameters = "param1",
SideBySide = false,
IgnoreDependencies = false,
ForceDependencies = false,
SkipPowerShell = false,
Debug = false,
Verbose = false,
FailOnStandardError = false,
UseSystemPowershell = false,
AllVersions = false,
Force = false,
Noop = false,
LimitOutput = false,
ExecutionTimeout = 13,
CacheLocation = @"C:\temp",
AllowUnofficial = false,
GlobalArguments = false,
GlobalPackageParameters = false,
IgnorePackageExitCodes = false,
UsePackageExitCodes = false,
UseAutoUninstaller = false,
SkipAutoUninstaller = false,
FailOnAutoUninstaller = false,
IgnoreAutoUninstaller = false
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyUninstall(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{System.String})">
<summary>
Uninstalls a Chocolatey package.
</summary>
<param name="context">The context.</param>
<param name="packageIds">The ids of the packages to uninstall.</param>
<example>
<code>
ChocolateyUninstall("MyChocolateyPackage");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyUninstall(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{System.String},Cake.Common.Tools.Chocolatey.Uninstall.ChocolateyUninstallSettings)">
<summary>
Uninstalls Chocolatey packages using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="packageIds">The ids of the packages to uninstall.</param>
<param name="settings">The settings.</param>
<example>
<code>
ChocolateyUninstall("MyChocolateyPackage", new ChocolateyUninstallSettings {
Source = true,
Version = "1.2.3",
UninstallArguments = "arg1",
OverrideArguments = false,
NotSilent = false,
PackageParameters = "param1",
SideBySide = false,
IgnoreDependencies = false,
ForceDependencies = false,
SkipPowerShell = false,
Debug = false,
Verbose = false,
FailOnStandardError = false,
UseSystemPowershell = false,
AllVersions = false,
Force = false,
Noop = false,
LimitOutput = false,
ExecutionTimeout = 13,
CacheLocation = @"C:\temp",
AllowUnofficial = false,
GlobalArguments = false,
GlobalPackageParameters = false,
IgnorePackageExitCodes = false,
UsePackageExitCodes = false,
UseAutoUninstaller = false,
SkipAutoUninstaller = false,
FailOnAutoUninstaller = false,
IgnoreAutoUninstaller = false
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyPin(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.Chocolatey.Pin.ChocolateyPinSettings)">
<summary>
Pins a Chocolatey package using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="name">The name.</param>
<param name="settings">The settings.</param>
<example>
<code>
ChocolateyPin("MyChocolateyPackage", new ChocolateyPinSettings {
Version = "1.2.3",
Debug = false,
Verbose = false,
Force = false,
Noop = false,
LimitOutput = false,
ExecutionTimeout = 13,
CacheLocation = @"C:\temp",
AllowUnofficial = false
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyApiKey(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.Chocolatey.ApiKey.ChocolateyApiKeySettings)">
<summary>
Sets the Api Key for a Chocolatey Source using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="source">The source.</param>
<param name="settings">The settings.</param>
<example>
<code>
ChocolateyApiKey("http://www.mysource.com", new ChocolateyApiKeySettings {
ApiKey = "myApiKey",
Debug = false,
Verbose = false,
Force = false,
Noop = false,
LimitOutput = false,
ExecutionTimeout = 13,
CacheLocation = @"C:\temp",
AllowUnofficial = false
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyConfig(Cake.Core.ICakeContext,System.String,System.String,Cake.Common.Tools.Chocolatey.Config.ChocolateyConfigSettings)">
<summary>
Sets the config parameter using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="name">The name.</param>
<param name="value">The value.</param>
<param name="settings">The settings.</param>
<example>
<code>
ChocolateyConfig("cacheLocation", @"c:\temp", new ChocolateyConfigSettings {
Debug = false,
Verbose = false,
Force = false,
Noop = false,
LimitOutput = false,
ExecutionTimeout = 13,
CacheLocation = @"C:\temp",
AllowUnofficial = false
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyEnableFeature(Cake.Core.ICakeContext,System.String)">
<summary>
Enables a Chocolatey Feature using the specified name.
</summary>
<param name="context">The context.</param>
<param name="name">Name of the feature.</param>
<example>
<code>
ChocolateyEnableFeature("checkSumFiles");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyEnableFeature(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.Chocolatey.Features.ChocolateyFeatureSettings)">
<summary>
Enables a Chocolatey Feature using the specified name and settings.
</summary>
<param name="context">The context.</param>
<param name="name">Name of the feature.</param>
<param name="settings">The settings.</param>
<example>
<code>
ChocolateyEnableFeature("checkSumFiles", new ChocolateyFeatureSettings {
Debug = false,
Verbose = false,
Force = false,
Noop = false,
LimitOutput = false,
ExecutionTimeout = 13,
CacheLocation = @"C:\temp",
AllowUnofficial = false
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyDisableFeature(Cake.Core.ICakeContext,System.String)">
<summary>
Disables a Chocolatey Feature using the specified name.
</summary>
<param name="context">The context.</param>
<param name="name">Name of the feature.</param>
<example>
<code>
ChocolateyDisableFeature("checkSumFiles");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyDisableFeature(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.Chocolatey.Features.ChocolateyFeatureSettings)">
<summary>
Disables a Chocolatey Feature using the specified name and settings.
</summary>
<param name="context">The context.</param>
<param name="name">Name of the feature.</param>
<param name="settings">The settings.</param>
<example>
<code>
ChocolateyDisableFeature("checkSumFiles", new ChocolateyFeatureSettings {
Debug = false,
Verbose = false,
Force = false,
Noop = false,
LimitOutput = false,
ExecutionTimeout = 13,
CacheLocation = @"C:\temp",
AllowUnofficial = false
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyAddSource(Cake.Core.ICakeContext,System.String,System.String)">
<summary>
Adds Chocolatey package source using the specified name &source to global user config.
</summary>
<param name="context">The context.</param>
<param name="name">Name of the source.</param>
<param name="source">Path to the package(s) source.</param>
<example>
<code>
ChocolateyAddSource("MySource", "http://www.mysource.com");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyAddSource(Cake.Core.ICakeContext,System.String,System.String,Cake.Common.Tools.Chocolatey.Sources.ChocolateySourcesSettings)">
<summary>
Adds Chocolatey package source using the specified name, source & settings to global user config.
</summary>
<param name="context">The context.</param>
<param name="name">Name of the source.</param>
<param name="source">Path to the package(s) source.</param>
<param name="settings">The settings.</param>
<example>
<code>
ChocolateyAddSource("MySource", "http://www.mysource.com", new ChocolateySourcesSettings {
UserName = "user",
Password = "password",
Priority = 13,
Debug = false,
Verbose = false,
Force = false,
Noop = false,
LimitOutput = false,
ExecutionTimeout = 13,
CacheLocation = @"C:\temp",
AllowUnofficial = false
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyRemoveSource(Cake.Core.ICakeContext,System.String)">
<summary>
Removes Chocolatey package source using the specified name & source from global user config.
</summary>
<param name="context">The context.</param>
<param name="name">Name of the source.</param>
<example>
<code>
ChocolateyRemoveSource("MySource");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyRemoveSource(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.Chocolatey.Sources.ChocolateySourcesSettings)">
<summary>
Removes Chocolatey package source using the specified name, source & settings from global user config.
</summary>
<param name="context">The context.</param>
<param name="name">Name of the source.</param>
<param name="settings">The settings.</param>
<example>
<code>
ChocolateyRemoveSource("MySource", new ChocolateySourcesSettings {
Debug = false,
Verbose = false,
Force = false,
Noop = false,
LimitOutput = false,
ExecutionTimeout = 13,
CacheLocation = @"C:\temp",
AllowUnofficial = false
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyEnableSource(Cake.Core.ICakeContext,System.String)">
<summary>
Enables a Chocolatey Source using the specified name.
</summary>
<param name="context">The context.</param>
<param name="name">Name of the source.</param>
<example>
<code>
ChocolateyEnableSource("MySource");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyEnableSource(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.Chocolatey.Sources.ChocolateySourcesSettings)">
<summary>
Enables a Chocolatey Source using the specified name and settings.
</summary>
<param name="context">The context.</param>
<param name="name">Name of the source.</param>
<param name="settings">The settings.</param>
<example>
<code>
ChocolateyEnableSource("MySource", new ChocolateySourcesSettings {
Debug = false,
Verbose = false,
Force = false,
Noop = false,
LimitOutput = false,
ExecutionTimeout = 13,
CacheLocation = @"C:\temp",
AllowUnofficial = false
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyDisableSource(Cake.Core.ICakeContext,System.String)">
<summary>
Disables a Chocolatey Source using the specified name.
</summary>
<param name="context">The context.</param>
<param name="name">Name of the source.</param>
<example>
<code>
ChocolateyDisableSource("MySource");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyDisableSource(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.Chocolatey.Sources.ChocolateySourcesSettings)">
<summary>
Disables a Chocolatey Source using the specified name and settings.
</summary>
<param name="context">The context.</param>
<param name="name">Name of the source.</param>
<param name="settings">The settings.</param>
<example>
<code>
ChocolateyDisableSource("MySource", new ChocolateySourcesSettings {
Debug = false,
Verbose = false,
Force = false,
Noop = false,
LimitOutput = false,
ExecutionTimeout = 13,
CacheLocation = @"C:\temp",
AllowUnofficial = false
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyPush(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Common.Tools.Chocolatey.Push.ChocolateyPushSettings)">
<summary>
Pushes a Chocolatey package to a Chocolatey server and publishes it.
</summary>
<param name="context">The context.</param>
<param name="packageFilePath">The <c>.nupkg</c> file path.</param>
<param name="settings">The settings.</param>
<example>
<code>
// Get the path to the package.
var package = "./chocolatey/MyChocolateyPackage.0.0.1.nupkg";
// Push the package.
ChocolateyPush(package, new ChocolateyPushSettings {
Source = "http://example.com/chocolateyfeed",
ApiKey = "4003d786-cc37-4004-bfdf-c4f3e8ef9b3a"
Timeout = 300
Debug = false,
Verbose = false,
Force = false,
Noop = false,
LimitOutput = false,
ExecutionTimeout = 13,
CacheLocation = @"C:\temp",
AllowUnofficial = false
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyPush(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.Chocolatey.Push.ChocolateyPushSettings)">
<summary>
Pushes Chocolatey packages to a Chocolatey server and publishes them.
</summary>
<param name="context">The context.</param>
<param name="packageFilePaths">The <c>.nupkg</c> file paths.</param>
<param name="settings">The settings.</param>
<example>
<code>
// Get the paths to the packages.
var packages = GetFiles("./**/*.nupkg");
// Push the package.
ChocolateyPush(packages, new ChocolateyPushSettings {
Source = "http://example.com/chocolateyfeed",
ApiKey = "4003d786-cc37-4004-bfdf-c4f3e8ef9b3a"
Timeout = 300
Debug = false,
Verbose = false,
Force = false,
Noop = false,
LimitOutput = false,
ExecutionTimeout = 13,
CacheLocation = @"C:\temp",
AllowUnofficial = false
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyUpgrade(Cake.Core.ICakeContext,System.String)">
<summary>
Upgrades Chocolatey package.
</summary>
<param name="context">The context.</param>
<param name="packageId">The id of the package to upgrade.</param>
<example>
<code>
ChocolateyUpgrade("MyChocolateyPackage");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyUpgrade(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings)">
<summary>
Upgrades Chocolatey package using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="packageId">The id of the package to upgrade.</param>
<param name="settings">The settings.</param>
<example>
<code>
ChocolateyUpgrade("MyChocolateyPackage", new ChocolateyUpgradeSettings {
Source = true,
Version = "1.2.3",
Prerelease = false,
Forcex86 = false,
InstallArguments = "arg1",
OverrideArguments = false,
NotSilent = false,
PackageParameters = "param1",
AllowDowngrade = false,
SideBySide = false,
IgnoreDependencies = false,
SkipPowerShell = false,
FailOnUnfound = false,
FailOnNotInstalled = false,
User = "user",
Password = "password",
IgnoreChecksums = false,
Debug = false,
Verbose = false,
Force = false,
Noop = false,
LimitOutput = false,
ExecutionTimeout = 13,
CacheLocation = @"C:\temp",
AllowUnofficial = false
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyNew(Cake.Core.ICakeContext,System.String)">
<summary>
Generate package specification files for a new package using the default settings.
</summary>
<param name="context">The context.</param>
<param name="packageId">The id of the package to create.</param>
<example>
<code>
ChocolateyNew("MyChocolateyPackage");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyNew(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.Chocolatey.New.ChocolateyNewSettings)">
<summary>
Generate package specification files for a new package using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="packageId">The id of the package to create.</param>
<param name="settings">The settings.</param>
<example>
<code>
ChocolateyNew("MyChocolateyPackage", new ChocolateyNewSettings {
PackageVersion = "1.2.3",
MaintainerName = "John Doe",
MaintainerRepo = "johndoe"
});
</code>
</example>
<example>
<code>
var settings = new ChocolateyNewSettings {
MaintainerName = "John Doe"
}
settings.AdditionalPropertyValues("Tags", "CustomPackage");
ChocolateyNew("MyChocolateyPackage", settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyDownload(Cake.Core.ICakeContext,System.String)">
<summary>
Downloads a Chocolatey package to the current working directory.
Requires Chocolatey licensed edition.
</summary>
<param name="context">The context.</param>
<param name="packageId">The id of the package to download.</param>
<example>
<code>
ChocolateyDownload("MyChocolateyPackage");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyDownload(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloadSettings)">
<summary>
Downloads a Chocolatey package using the specified settings.
Requires Chocolatey licensed edition.
Features requiring Chocolatey for Business or a minimum version are documented
in <see cref="T:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloadSettings"/>.
</summary>
<param name="context">The context.</param>
<param name="packageId">The id of the package to install.</param>
<param name="settings">The settings.</param>
<example>
<para>Download a package to a specific folder:</para>
<code>
ChocolateyDownload(
"MyChocolateyPackage",
new ChocolateyDownloadSettings {
OutputDirectory = @"C:\download\"
});
</code>
<para>Download and internalize a package:</para>
<code>
ChocolateyDownload(
"MyChocolateyPackage",
new ChocolateyDownloadSettings {
Internalize = true
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyExport(Cake.Core.ICakeContext)">
<summary>
Exports the currently installed Chocolatey packages to a packages.config file in the current working directory.
</summary>
<param name="context">The context.</param>
<example>
<code>
ChocolateyExport();
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyAliases.ChocolateyExport(Cake.Core.ICakeContext,Cake.Common.Tools.Chocolatey.Export.ChocolateyExportSettings)">
<summary>
Exports the currently installed Chocolatey packages using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="settings">The settings.</param>
<example>
<para>Exported information should contain the package version numbers:</para>
<code>
ChocolateyExport(
new ChocolateyExportSettings {
IncludeVersionNumbers = true
});
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.ChocolateySettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.Chocolatey.ChocolateySettings"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ChocolateySettings.Debug">
<summary>
Gets or sets a value indicating whether to run in debug mode.
</summary>
<value>The debug flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ChocolateySettings.Verbose">
<summary>
Gets or sets a value indicating whether to run in verbose mode.
</summary>
<value>The verbose flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ChocolateySettings.Trace">
<summary>
Gets or sets a value indicating whether to run in trace mode.
</summary>
<value>The trace flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ChocolateySettings.NoColor">
<summary>
Gets or sets a value indicating whether to run in no color mode.
</summary>
<value>The no-color flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ChocolateySettings.AcceptLicense">
<summary>
Gets or sets a value indicating whether to accept license for package.
</summary>
<value>The accept-license flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ChocolateySettings.Force">
<summary>
Gets or sets a value indicating whether to run in forced mode.
</summary>
<value>The force flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ChocolateySettings.Noop">
<summary>
Gets or sets a value indicating whether to run in noop mode.
</summary>
<value>The noop flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ChocolateySettings.LimitOutput">
<summary>
Gets or sets a value indicating whether to run in limited output mode.
</summary>
<value>The limit-output flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ChocolateySettings.ExecutionTimeout">
<summary>
Gets or sets the execution timeout value.
</summary>
<value>The execution timeout.</value>
<remarks>Default is 2700 seconds.</remarks>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ChocolateySettings.CacheLocation">
<summary>
Gets or sets the location of the download cache.
</summary>
<value>The download cache location.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ChocolateySettings.AllowUnofficial">
<summary>
Gets or sets a value indicating whether to run in allow unofficial mode.
</summary>
<value>The allow-unofficial flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ChocolateySettings.FailOnErrorOutput">
<summary>
Gets or sets a value indicating whether to faile when error output is detected.
</summary>
<value>The fail-on-error-output flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ChocolateySettings.UseSystemPowerShell">
<summary>
Gets or sets a value indicating whether to run using system installed version of PowerShell.
</summary>
<value>The use-system-powershell flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ChocolateySettings.NoProgress">
<summary>
Gets or sets a value indicating whether to run while not showing download progress.
</summary>
<value>The no-progress flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ChocolateySettings.Proxy">
<summary>
Gets or sets the explicit proxy location.
</summary>
<value>The proxy location.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ChocolateySettings.ProxyUser">
<summary>
Gets or sets the explicit proxy user.
</summary>
<value>The proxy user.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ChocolateySettings.ProxyPassword">
<summary>
Gets or sets the explicit proxy password.
</summary>
<value>The proxy password.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ChocolateySettings.ProxyByPassList">
<summary>
Gets or sets the comma separated list of regex location to bypass on proxy.
</summary>
<value>The bypass proxy list.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ChocolateySettings.ProxyBypassOnLocal">
<summary>
Gets or sets a value indicating whether to bypass proxy for local connections.
</summary>
<value>The proxy-bypass-on-local flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ChocolateySettings.LogFile">
<summary>
Gets or sets the path to the file where all log entries will be sent.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ChocolateySettings.SkipCompatibilityChecks">
<summary>
Gets or sets a value indicating whether to skip all compatibility checks.
</summary>
<value>The skip-compatibility-checks flag.</value>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.ChocolateySharedSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.Chocolatey.ChocolateySharedSettings"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ChocolateySharedSettings.Source">
<summary>
Gets or sets the source to find the package(s).
</summary>
<value>The URL or source name.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ChocolateySharedSettings.Version">
<summary>
Gets or sets the specific version of the package.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ChocolateySharedSettings.OverrideArguments">
<summary>
Gets or sets a value indicating whether install arguments be used exclusively without appending to current package passed arguments.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ChocolateySharedSettings.NotSilent">
<summary>
Gets or sets a value indicating whether to process package silently.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ChocolateySharedSettings.PackageParameters">
<summary>
Gets or sets parameters to pass to the package.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ChocolateySharedSettings.ApplyInstallArgumentsToDependencies">
<summary>
Gets or sets a value indicating whether install arguments be applied to dependent packages.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ChocolateySharedSettings.ApplyPackageParametersToDependencies">
<summary>
Gets or sets a value indicating whether package parameters be applied to dependent packages.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ChocolateySharedSettings.SideBySide">
<summary>
Gets or sets a value indicating whether multiple versions of a package be installed.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ChocolateySharedSettings.SkipPowerShell">
<summary>
Gets or sets a value indicating whether to run chocolateyInstall.ps1.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ChocolateySharedSettings.IgnorePackageExitCodes">
<summary>
Gets or sets a value indicating whether to Exit with a 0 for success and 1 for non-success
no matter what package scripts provide for exit codes.
</summary>
<value>The ignore package exit codes flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ChocolateySharedSettings.UsePackageExitCodes">
<summary>
Gets or sets a value indicating whether to use package exit codes.
</summary>
<value>The use package exit codes flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ChocolateySharedSettings.StopOnFirstFailure">
<summary>
Gets or sets a value indicating whether to stop of the first failure of a package.
</summary>
<value>The stop of first failure flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ChocolateySharedSettings.ExitWhenRebootDetected">
<summary>
Gets or sets a value indicating whether to exit when a reboot is detected.
</summary>
<value>The exit when reboot detected flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ChocolateySharedSettings.IgnoreDetectedReboot">
<summary>
Gets or sets a value indicating whether to ignore detected reboots.
</summary>
<value>The ignore detected reboots flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.ChocolateySharedSettings.SkipHooks">
<summary>
Gets or sets a value indicating whether to skip the running of package hook scripts.
</summary>
<value>The skip hooks flag.</value>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.ChocolateyTool`1">
<summary>
Base class for all Chocolatey related tools.
</summary>
<typeparam name="TSettings">The settings type.</typeparam>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyTool`1.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Common.Tools.Chocolatey.IChocolateyToolResolver)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.Chocolatey.ChocolateyTool`1"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="resolver">The Chocolatey tool resolver.</param>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyTool`1.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyTool`1.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyTool`1.GetAlternativeToolPaths(`0)">
<summary>
Gets alternative file paths which the tool may exist in.
</summary>
<param name="settings">The settings.</param>
<returns>The default tool path.</returns>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyTool`1.AddGlobalArguments(Cake.Common.Tools.Chocolatey.ChocolateySettings,Cake.Core.IO.ProcessArgumentBuilder)">
<summary>
Adds common arguments to the process builder.
</summary>
<param name="settings">The settings.</param>
<param name="builder">The process argument builder.</param>
<returns>The process argument builder.</returns>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyTool`1.AddSharedArguments(Cake.Common.Tools.Chocolatey.ChocolateySharedSettings,Cake.Core.IO.ProcessArgumentBuilder)">
<summary>
Adds shared arguents to the process builder.
</summary>
<param name="settings">The settings.</param>
<param name="builder">The process arguments builder.</param>
<returns>The process arguments builder.</returns>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.ChocolateyToolResolver">
<summary>
Contains Chocolatey path resolver functionality.
</summary>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyToolResolver.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.Chocolatey.ChocolateyToolResolver" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.ChocolateyToolResolver.ResolvePath">
<inheritdoc/>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.Config.ChocolateyConfigSetter">
<summary>
The Chocolatey configuration setter.
</summary>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.Config.ChocolateyConfigSetter.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Common.Tools.Chocolatey.IChocolateyToolResolver)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.Chocolatey.Config.ChocolateyConfigSetter"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="resolver">The Chocolatey tool resolver.</param>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.Config.ChocolateyConfigSetter.Set(System.String,System.String,Cake.Common.Tools.Chocolatey.Config.ChocolateyConfigSettings)">
<summary>
Sets Chocolatey configuration parameters using the settings.
</summary>
<param name="name">The name of the config parameter.</param>
<param name="value">The value to assign to the parameter.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.Config.ChocolateyConfigSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.Chocolatey.Config.ChocolateyConfigSetter"/>.
</summary>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloader">
<summary>
The Chocolatey package downloader used to download Chocolatey packages.
</summary>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloader.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Common.Tools.Chocolatey.IChocolateyToolResolver)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloader"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="resolver">The Chocolatey tool resolver.</param>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloader.Download(System.String,Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloadSettings)">
<summary>
Downloads Chocolatey packages using the specified package id and settings.
Requires Chocolatey licensed edition.
Features requiring Chocolatey for Business or a minimum version are documented
in <see cref="T:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloadSettings"/>.
</summary>
<param name="packageId">The source package id.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloadSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloader"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloadSettings.Source">
<summary>
Gets or sets the source to find the package(s) to download. Defaults to default feeds.
</summary>
<value>The server URL.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloadSettings.Version">
<summary>
Gets or sets the version of the package to download.
If none specified, the latest will be used.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloadSettings.Prerelease">
<summary>
Gets or sets a value indicating whether to allow downloading of prerelease packages.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloadSettings.User">
<summary>
Gets or sets the user for authenticated feeds.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloadSettings.Password">
<summary>
Gets or sets the password for authenticated feeds.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloadSettings.Certificate">
<summary>
Gets or sets the path to a PFX certificate for use with x509 authenticated feeds.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloadSettings.CertificatePassword">
<summary>
Gets or sets the password for the <see cref="P:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloadSettings.Certificate"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloadSettings.OutputDirectory">
<summary>
Gets or sets the directory for the downloaded Chocolatey packages.
By default the current working directory is used.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloadSettings.IgnoreDependencies">
<summary>
Gets or sets a value indicating whether to ignore dependencies.
Requires Chocolatey licensed edition.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloadSettings.Installed">
<summary>
Gets or sets a value indicating whether to download all currently installed Chocolatey packages.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloadSettings.IgnoreUnfound">
<summary>
Gets or sets a value indicating whether to ignore unfound packages if downloading more than one at a time.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloadSettings.DisableRepositoryOptimizations">
<summary>
Gets or sets a value indicating whether to use optimizations for reducing bandwidth when communicating with repositories.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloadSettings.Internalize">
<summary>
Gets or sets a value indicating whether all external resources should be downloaded
and the package be recompiled to use the local resources instead.
Requires Chocolatey business edition.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloadSettings.ResourcesLocation">
<summary>
Gets or sets the location for downloaded resource when <see cref="P:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloadSettings.Internalize"/> is set.
<c>null</c> or <see cref="F:System.String.Empty"/> if downloaded resources should be embedded in the package.
Can be a file share or an internal URL location.
When it is a file share, it will attempt to download to that location.
When it is an internal url, it will download locally and give further instructions
where it should be uploaded to match package edits.
By default resources are embedded in the package.
Requires Chocolatey business edition.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloadSettings.DownloadLocation">
<summary>
Gets or sets the location where resources should be downloaded to when <see cref="P:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloadSettings.ResourcesLocation"/> is set.
<c>null</c> or <see cref="F:System.String.Empty"/> if <see cref="P:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloadSettings.ResourcesLocation"/> should be used.
By default <see cref="P:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloadSettings.ResourcesLocation"/> is used.
Requires Chocolatey business edition.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloadSettings.InternalizeAllUrls">
<summary>
Gets or sets a value indicating whether all URLs, not only from known helpers, should be internalized.
Requires Chocolatey business edition (Licensed version 1.11.1+).
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloadSettings.AppendUseOriginalLocation">
<summary>
Gets or sets a value indicating whether the <c>-useOriginalLocation</c> parameter will be passed to any
<c>Install-ChocolateyPackage</c> call in the package and avoiding downloading of resources when
<see cref="P:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloadSettings.Internalize"/> is set.
Overrides the global <c>internalizeAppendUseOriginalLocation</c> feature.
By default set to <c>false</c>.
Requires Chocolatey business edition and Chocolatey v0.10.1 or newer.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloadSettings.SkipDownloadCache">
<summary>
Gets or sets a value indicating whether to skip the package download cache.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloadSettings.UseDownloadCache">
<summary>
Gets or sets a value indicating whether to use the package download cache.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloadSettings.SkipVirusCheck">
<summary>
Gets or sets a value indicating whether skip the virus checking for a package.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloadSettings.VirusCheck">
<summary>
Gets or sets a value indicating whether to force virus checking for a package.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Download.ChocolateyDownloadSettings.VirusPositivesMinimum">
<summary>
Gets or sets the minimum allowed number of virus positives.
</summary>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.Export.ChocolateyExporter">
<summary>
The Chocolatey package exporter used to export Chocolatey packages.
</summary>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.Export.ChocolateyExporter.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Common.Tools.Chocolatey.IChocolateyToolResolver)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.Chocolatey.Export.ChocolateyExporter"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="resolver">The Chocolatey tool resolver.</param>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.Export.ChocolateyExporter.Export(Cake.Common.Tools.Chocolatey.Export.ChocolateyExportSettings)">
<summary>
Exports the currently installed Chocolatey packages using the specified settings.
</summary>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.Export.ChocolateyExportSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.Chocolatey.Export.ChocolateyExporter"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Export.ChocolateyExportSettings.OutputFilePath">
<summary>
Gets or sets the path to the file that will be generated.
</summary>
<value>The path to the file that is generated.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Export.ChocolateyExportSettings.IncludeVersionNumbers">
<summary>
Gets or sets a value indicating whether to include version numbers for installed packages.
</summary>
<value>The include version numbers flag.</value>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.Features.ChocolateyFeatureSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.Chocolatey.Features.ChocolateyFeatureToggler"/>.
</summary>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.Features.ChocolateyFeatureToggler">
<summary>
The Chocolatey feature toggler used to enable/disable Chocolatey Features.
</summary>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.Features.ChocolateyFeatureToggler.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Common.Tools.Chocolatey.IChocolateyToolResolver)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.Chocolatey.Features.ChocolateyFeatureToggler"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="resolver">The Chocolatey tool resolver.</param>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.Features.ChocolateyFeatureToggler.EnableFeature(System.String,Cake.Common.Tools.Chocolatey.Features.ChocolateyFeatureSettings)">
<summary>
Pins Chocolatey packages using the specified package id and settings.
</summary>
<param name="name">The name of the feature.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.Features.ChocolateyFeatureToggler.DisableFeature(System.String,Cake.Common.Tools.Chocolatey.Features.ChocolateyFeatureSettings)">
<summary>
Pins Chocolatey packages using the specified package id and settings.
</summary>
<param name="name">The name of the feature.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.IChocolateyToolResolver">
<summary>
Represents a Chocolatey path resolver.
</summary>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.IChocolateyToolResolver.ResolvePath">
<summary>
Resolves the path to choco.exe.
</summary>
<returns>The path to choco.exe.</returns>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstaller">
<summary>
The Chocolatey package installer used to install Chocolatey packages.
</summary>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstaller.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Common.Tools.Chocolatey.IChocolateyToolResolver)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstaller"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="resolver">The Chocolatey tool resolver.</param>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstaller.InstallFromConfig(Cake.Core.IO.FilePath,Cake.Common.Tools.Chocolatey.Install.ChocolateyInstallSettings)">
<summary>
Installs Chocolatey packages using the specified package configuration file and settings.
</summary>
<param name="packageConfigPath">Path to package configuration to use for install.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstaller.Install(System.String,Cake.Common.Tools.Chocolatey.Install.ChocolateyInstallSettings)">
<summary>
Installs Chocolatey packages using the specified package id and settings.
</summary>
<param name="packageId">The source package id.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstallSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstaller"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstallSettings.Prerelease">
<summary>
Gets or sets a value indicating whether to allow installation of prerelease packages.
This flag is not required when restoring packages by installing from packages.config.
</summary>
<value>
<c>true</c> to allow installation of prerelease packages; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstallSettings.Forcex86">
<summary>
Gets or sets a value indicating whether to force installation of the x86 version of package.
</summary>
<value>The force x86 flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstallSettings.InstallArguments">
<summary>
Gets or sets the install arguments to pass to native installer.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstallSettings.AllowDowngrade">
<summary>
Gets or sets a value indicating whether to allow downgrade of package.
</summary>
<value>The downgrade package flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstallSettings.IgnoreDependencies">
<summary>
Gets or sets a value indicating whether to ignore dependencies.
</summary>
<value>The ignore dependencies flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstallSettings.ForceDependencies">
<summary>
Gets or sets a value indicating whether to force dependencies.
</summary>
<value>The force dependencies flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstallSettings.User">
<summary>
Gets or sets the user for authenticated feeds.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstallSettings.Password">
<summary>
Gets or sets the password for authenticated feeds.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstallSettings.Certificate">
<summary>
Gets or sets the path to a PFX certificate for use with x509 authenticated feeds.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstallSettings.CertificatePassword">
<summary>
Gets or sets the password for the <see cref="P:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstallSettings.Certificate"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstallSettings.IgnoreChecksums">
<summary>
Gets or sets a value indicating whether to ignore checksums.
</summary>
<value>The ignore checksums flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstallSettings.AllowEmptyChecksums">
<summary>
Gets or sets a value indicating whether to allow empty checksums for bare HTTP URLs during package installation.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstallSettings.AllowEmptyChecksumsSecure">
<summary>
Gets or sets a value indicating whether to allow empty checksums for HTTPS URLs during package installation.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstallSettings.RequireChecksums">
<summary>
Gets or sets a value indicating whether checksums are required during package installation.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstallSettings.Checksum">
<summary>
Gets or sets the checksum for 32 bit installation.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstallSettings.Checksum64">
<summary>
Gets or sets the checksum for 64 bit installation.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstallSettings.ChecksumType">
<summary>
Gets or sets the checksum type to use for 32 bit installation.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstallSettings.ChecksumType64">
<summary>
Gets or sets the checksum type to use for 64 bit installation.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstallSettings.DisableRepositoryOptimizations">
<summary>
Gets or sets a value indicating whether to use optimizations for reducing bandwidth when communicating with repositories.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstallSettings.Pin">
<summary>
Gets or sets a value indicating whether to pin the package once installed.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstallSettings.SkipDownloadCache">
<summary>
Gets or sets a value indicating whether to skip the package download cache.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstallSettings.UseDownloadCache">
<summary>
Gets or sets a value indicating whether to use the package download cache.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstallSettings.SkipVirusCheck">
<summary>
Gets or sets a value indicating whether skip the virus checking for a package.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstallSettings.VirusCheck">
<summary>
Gets or sets a value indicating whether to force virus checking for a package.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstallSettings.VirusPositivesMinimum">
<summary>
Gets or sets the minimum allowed number of virus positives.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstallSettings.InstallArgumentsSensitive">
<summary>
Gets or sets the install arguments sensitive to pass to native installer.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstallSettings.PackageParametersSensitive">
<summary>
Gets or sets sensitive parameters to pass to the package.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstallSettings.InstallDirectory">
<summary>
Gets or sets the default application installation directory.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstallSettings.MaximumDownloadBitsPerSecond">
<summary>
Gets or sets the maximum download bits per second when downloading a package.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstallSettings.ReducePackageSize">
<summary>
Gets or sets a value indicating whether package size should be reduced on installation.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstallSettings.NoReducePackageSize">
<summary>
Gets or sets a value indicating whether there should be no reduction in package size on installation.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstallSettings.ReduceNupkgOnly">
<summary>
Gets or sets a value indicating whether only the nupkg file size should be reduced.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Install.ChocolateyInstallSettings.PinReason">
<summary>
Gets or sets a reason for pinning a package during installation.
</summary>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.New.ChocolateyNewSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.Chocolatey.New.ChocolateyScaffolder"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.New.ChocolateyNewSettings.AutomaticPackage">
<summary>
Gets or sets a value indicating whether to generate automatic package instead or normal.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.New.ChocolateyNewSettings.TemplateName">
<summary>
Gets or sets the name of the template to generate new package with.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.New.ChocolateyNewSettings.OutputDirectory">
<summary>
Gets or sets the path where the package will be created.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.New.ChocolateyNewSettings.BuiltInTemplate">
<summary>
Gets or sets a value indicating whether to use original built-in template, rather than an overridden one.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.New.ChocolateyNewSettings.PackageVersion">
<summary>
Gets or sets the version of the package to be created.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.New.ChocolateyNewSettings.MaintainerName">
<summary>
Gets or sets the owner of the package to be created.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.New.ChocolateyNewSettings.MaintainerRepo">
<summary>
Gets or sets the repository of the package source.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.New.ChocolateyNewSettings.InstallerType">
<summary>
Gets or sets the type of the installer.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.New.ChocolateyNewSettings.Url">
<summary>
Gets or sets the URL where the software to be installed can be downloaded from.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.New.ChocolateyNewSettings.Url64">
<summary>
Gets or sets the URL where the 64-Bit version of the software to be installed can be downloaded from.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.New.ChocolateyNewSettings.SilentArgs">
<summary>
Gets or sets the arguments for running the installer silently.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.New.ChocolateyNewSettings.AdditionalPropertyValues">
<summary>
Gets the list of additional property values which should be passed to the template.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.New.ChocolateyNewSettings.File">
<summary>
Gets or sets the file or URL to binary used for auto-detection and generation of package.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.New.ChocolateyNewSettings.File64">
<summary>
Gets or sets the file or URL to 64-bit binary used for auto-detection and generation of package.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.New.ChocolateyNewSettings.UseOriginalFilesLocation">
<summary>
Gets or sets a value indicating whether to use original location of binary in packaging.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.New.ChocolateyNewSettings.Checksum">
<summary>
Gets or sets the checksum for 32 bit installation.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.New.ChocolateyNewSettings.Checksum64">
<summary>
Gets or sets the checksum for 64 bit installation.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.New.ChocolateyNewSettings.ChecksumType">
<summary>
Gets or sets the checksum type to use for 32 bit installation.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.New.ChocolateyNewSettings.PauseOnError">
<summary>
Gets or sets a value indicating whether to pause when there is an error creating a package.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.New.ChocolateyNewSettings.BuildPackage">
<summary>
Gets or sets a value indicating whether to attempt to compile the package after creating it.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.New.ChocolateyNewSettings.GeneratePackagesFromInstalledSoftware">
<summary>
Gets or sets a value indicating whether to generate packages from the currenty installed software on a system.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.New.ChocolateyNewSettings.RemoveArchitectureFromName">
<summary>
Gets or sets a value indicating whether to remove x86, x64, etc. from generated package id.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.New.ChocolateyNewSettings.IncludeArchitectureInPackageName">
<summary>
Gets or sets a value indicating whether to leave x86, x64, etc. as part of the generated package id.
</summary>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.New.ChocolateyScaffolder">
<summary>
The Chocolatey project scaffolder used to generate package specification files for a new package.
</summary>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.New.ChocolateyScaffolder.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Common.Tools.Chocolatey.IChocolateyToolResolver)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.Chocolatey.New.ChocolateyScaffolder"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="resolver">The Chocolatey tool resolver.</param>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.New.ChocolateyScaffolder.CreatePackage(System.String,Cake.Common.Tools.Chocolatey.New.ChocolateyNewSettings)">
<summary>
Generate package specification files for a new package.
</summary>
<param name="packageId">Id of the new package.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.Pack.ChocolateyNuSpecContent">
<summary>
Represents a Chocolatey nuspec file.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyNuSpecContent.Source">
<summary>
Gets or sets the location of the file or files to include.
The path is relative to the NuSpec file unless an absolute path is specified.
The wildcard character - <c>*</c> - is allowed.
Using a double wildcard - <c>**</c> implies a recursive directory search.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyNuSpecContent.Target">
<summary>
Gets or sets the relative path to the directory within the package where the source files will be placed.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyNuSpecContent.Exclude">
<summary>
Gets or sets the file or files to exclude.
This is usually combined with a wildcard value in the <c>src</c> attribute.
The <c>exclude</c> attribute can contain a semi-colon delimited list of files or a file pattern.
Using a double wildcard - <c>**</c> - implies a recursive exclude pattern.
</summary>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.Pack.ChocolateyNuSpecDependency">
<summary>
Represents a Chocolatey NuGet nuspec dependency.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyNuSpecDependency.Id">
<summary>
Gets or sets the dependency's package ID.
</summary>
<value>The dependency's package ID.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyNuSpecDependency.Version">
<summary>
Gets or sets the dependency's version.
</summary>
<value>The dependency's version.</value>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPacker">
<summary>
The Chocolatey packer.
</summary>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPacker.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Diagnostics.ICakeLog,Cake.Core.Tooling.IToolLocator,Cake.Common.Tools.Chocolatey.IChocolateyToolResolver)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPacker"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="log">The log.</param>
<param name="tools">The tool locator.</param>
<param name="resolver">The Chocolatey tool resolver.</param>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPacker.Pack(Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings)">
<summary>
Creates a Chocolatey package from the specified settings.
</summary>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPacker.Pack(Cake.Core.IO.FilePath,Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings)">
<summary>
Creates a Chocolatey package from the specified Nuspec file.
</summary>
<param name="nuspecFilePath">The nuspec file path.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPacker"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings.Id">
<summary>
Gets or sets the package ID.
</summary>
<value>The package ID.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings.Title">
<summary>
Gets or sets the package title.
</summary>
<value>The package title.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings.Authors">
<summary>
Gets or sets the package authors.
</summary>
<value>The package authors.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings.Owners">
<summary>
Gets or sets the package owners.
</summary>
<value>The package owners.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings.Summary">
<summary>
Gets or sets the package summary.
</summary>
<value>The package summary.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings.Description">
<summary>
Gets or sets the package description.
</summary>
<value>The package description.</value>
<remarks>Markdown format is allowed for this property.</remarks>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings.ProjectUrl">
<summary>
Gets or sets the package project URL.
</summary>
<value>The package project URL.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings.PackageSourceUrl">
<summary>
Gets or sets the package Source URL.
</summary>
<value>The package Source URL.</value>
<remarks>Requires at least Chocolatey 0.9.9.7.</remarks>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings.ProjectSourceUrl">
<summary>
Gets or sets the package project Source URL.
</summary>
<value>The package project Source URL.</value>
<remarks>Requires at least Chocolatey 0.9.9.7.</remarks>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings.DocsUrl">
<summary>
Gets or sets the package documentation URL.
</summary>
<value>The package documentation URL.</value>
<remarks>Requires at least Chocolatey 0.9.9.7.</remarks>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings.MailingListUrl">
<summary>
Gets or sets the package mailing list URL.
</summary>
<value>The package mailing list URL.</value>
<remarks>Requires at least Chocolatey 0.9.9.7.</remarks>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings.BugTrackerUrl">
<summary>
Gets or sets the package bug tracker URL.
</summary>
<value>The package bug tracker URL.</value>
<remarks>Requires at least Chocolatey 0.9.9.7.</remarks>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings.Tags">
<summary>
Gets or sets the package tags.
</summary>
<value>The package tags.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings.Copyright">
<summary>
Gets or sets the package copyright.
</summary>
<value>The package copyright.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings.LicenseUrl">
<summary>
Gets or sets the package license URL.
</summary>
<value>The package license URL.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings.RequireLicenseAcceptance">
<summary>
Gets or sets a value indicating whether users has to accept the package license.
</summary>
<value>
<c>true</c> if users has to accept the package license; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings.IconUrl">
<summary>
Gets or sets the package icon URL.
</summary>
<value>The package icon URL.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings.ReleaseNotes">
<summary>
Gets or sets the package release notes.
</summary>
<value>The package release notes.</value>
<remarks>Markdown format is allowed for this property.</remarks>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings.Files">
<summary>
Gets or sets the package files.
</summary>
<value>The package files.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings.Dependencies">
<summary>
Gets or sets the package dependencies.
</summary>
<value>The package files.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings.Version">
<summary>
Gets or sets the Nuspec version.
</summary>
<value>The Nuspec version.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pack.ChocolateyPackSettings.OutputDirectory">
<summary>
Gets or sets a value indicating the Working Directory that should be used while running choco.exe.
</summary>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.Pin.ChocolateyPinner">
<summary>
The Chocolatey package pinner used to pin Chocolatey packages.
</summary>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.Pin.ChocolateyPinner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Common.Tools.Chocolatey.IChocolateyToolResolver)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.Chocolatey.Pin.ChocolateyPinner"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="resolver">The Chocolatey tool resolver.</param>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.Pin.ChocolateyPinner.Pin(System.String,Cake.Common.Tools.Chocolatey.Pin.ChocolateyPinSettings)">
<summary>
Pins Chocolatey packages using the specified package id and settings.
</summary>
<param name="name">The name of the package.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.Pin.ChocolateyPinSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.Chocolatey.Pin.ChocolateyPinner"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pin.ChocolateyPinSettings.Version">
<summary>
Gets or sets the version of the package to pin.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Pin.ChocolateyPinSettings.PinReason">
<summary>
Gets or sets a reason for pinning a package during installation.
</summary>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.Push.ChocolateyPusher">
<summary>
The Chocolatey package pusher.
</summary>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.Push.ChocolateyPusher.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Common.Tools.Chocolatey.IChocolateyToolResolver)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.Chocolatey.Push.ChocolateyPusher"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="resolver">The Chocolatey tool resolver.</param>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.Push.ChocolateyPusher.Push(Cake.Core.IO.FilePath,Cake.Common.Tools.Chocolatey.Push.ChocolateyPushSettings)">
<summary>
Pushes a Chocolatey package to a Chocolatey server and publishes it.
</summary>
<param name="packageFilePath">The package file path.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.Push.ChocolateyPushSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.Chocolatey.Push.ChocolateyPusher"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Push.ChocolateyPushSettings.Source">
<summary>
Gets or sets the source.
</summary>
<value>The source.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Push.ChocolateyPushSettings.ApiKey">
<summary>
Gets or sets the API key for the server.
</summary>
<value>The API key for the server.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Push.ChocolateyPushSettings.ClientCode">
<summary>
Gets or sets the client code generated for delegating access vy a user to the Intune endpoints.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Push.ChocolateyPushSettings.RedirectUrl">
<summary>
Gets or sets the URL used when requesting the client code.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Push.ChocolateyPushSettings.EndPoint">
<summary>
Gets or sets the Intune API endpoint to use.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Push.ChocolateyPushSettings.SkipCleanup">
<summary>
Gets or sets a value indicating whether to skip cleanup local files when pushing to Intune.
</summary>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.Sources.ChocolateySources">
<summary>
The Chocolatey sources is used to work with user config feeds & credentials.
</summary>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.Sources.ChocolateySources.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Common.Tools.Chocolatey.IChocolateyToolResolver)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.Chocolatey.Sources.ChocolateySources"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="resolver">The Chocolatey tool resolver.</param>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.Sources.ChocolateySources.AddSource(System.String,System.String,Cake.Common.Tools.Chocolatey.Sources.ChocolateySourcesSettings)">
<summary>
Adds Chocolatey package source using the specified settings to global user config.
</summary>
<param name="name">Name of the source.</param>
<param name="source">Path to the package(s) source.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.Sources.ChocolateySources.RemoveSource(System.String,Cake.Common.Tools.Chocolatey.Sources.ChocolateySourcesSettings)">
<summary>
Remove specified Chocolatey package source.
</summary>
<param name="name">Name of the source.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.Sources.ChocolateySources.EnableSource(System.String,Cake.Common.Tools.Chocolatey.Sources.ChocolateySourcesSettings)">
<summary>
Enable specified Chocolatey package source.
</summary>
<param name="name">Name of the source.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.Sources.ChocolateySources.DisableSource(System.String,Cake.Common.Tools.Chocolatey.Sources.ChocolateySourcesSettings)">
<summary>
Disable specified Chocolatey package source.
</summary>
<param name="name">Name of the source.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.Sources.ChocolateySourcesSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.Chocolatey.Sources.ChocolateySources"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Sources.ChocolateySourcesSettings.UserName">
<summary>
Gets or sets the (optional) user name.
</summary>
<value>Optional user name to be used when connecting to an authenticated source.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Sources.ChocolateySourcesSettings.Password">
<summary>
Gets or sets the (optional) password.
</summary>
<value>Optional password to be used when connecting to an authenticated source.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Sources.ChocolateySourcesSettings.Certificate">
<summary>
Gets or sets the path to a PFX certificate for use with x509 authenticated feeds.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Sources.ChocolateySourcesSettings.CertificatePassword">
<summary>
Gets or sets the password for the <see cref="P:Cake.Common.Tools.Chocolatey.Sources.ChocolateySourcesSettings.Certificate"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Sources.ChocolateySourcesSettings.Priority">
<summary>
Gets or sets the (optional) priority.
</summary>
<value>Optional priority to be used when creating source.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Sources.ChocolateySourcesSettings.ByPassProxy">
<summary>
Gets or sets a value indicating whether source should explicitly bypass any explicitly set proxy.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Sources.ChocolateySourcesSettings.AllowSelfService">
<summary>
Gets or sets a value indicating whether source should be allowed to be used in self service mode.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Sources.ChocolateySourcesSettings.AdminOnly">
<summary>
Gets or sets a value indicating whether source should be visible to non-admin users.
</summary>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.Uninstall.ChocolateyUninstaller">
<summary>
The Chocolatey package uninstall used to uninstall Chocolatey packages.
</summary>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.Uninstall.ChocolateyUninstaller.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Common.Tools.Chocolatey.IChocolateyToolResolver)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.Chocolatey.Uninstall.ChocolateyUninstaller"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="resolver">The Chocolatey tool resolver.</param>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.Uninstall.ChocolateyUninstaller.Uninstall(System.Collections.Generic.IEnumerable{System.String},Cake.Common.Tools.Chocolatey.Uninstall.ChocolateyUninstallSettings)">
<summary>
Uninstalls Chocolatey packages using the specified package id and settings.
</summary>
<param name="packageIds">List of package ids to uninstall.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.Uninstall.ChocolateyUninstallSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.Chocolatey.Uninstall.ChocolateyUninstaller"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Uninstall.ChocolateyUninstallSettings.AllVersions">
<summary>
Gets or sets a value indicating whether to uninstall all versions.
</summary>
<value>The all versions flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Uninstall.ChocolateyUninstallSettings.UninstallArguments">
<summary>
Gets or sets the uninstall arguments to pass to native installer.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Uninstall.ChocolateyUninstallSettings.ForceDependencies">
<summary>
Gets or sets a value indicating whether to force dependencies.
</summary>
<value>The force dependencies flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Uninstall.ChocolateyUninstallSettings.UseAutoUninstaller">
<summary>
Gets or sets a value indicating whether to use auto uninstaller service when uninstalling.
</summary>
<value>The use auto uninstaller flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Uninstall.ChocolateyUninstallSettings.SkipAutoUninstaller">
<summary>
Gets or sets a value indicating whether to skip auto uninstaller service when uninstalling.
</summary>
<value>The skip auto uninstaller flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Uninstall.ChocolateyUninstallSettings.FailOnAutoUninstaller">
<summary>
Gets or sets a value indicating whether to fail the package uninstall if the auto
uninstaller reports and error.
</summary>
<value>The fail auto uninstaller flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Uninstall.ChocolateyUninstallSettings.IgnoreAutoUninstallerFailure">
<summary>
Gets or sets a value indicating whether to not fail the package if auto
uninstaller reports an error.
</summary>
<value>The ignore auto uninstaller flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Uninstall.ChocolateyUninstallSettings.FromProgramsAndFeatures">
<summary>
Gets or sets a value indicating whether to uninstall a program from programs and features.
</summary>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgrader">
<summary>
The Chocolatey package upgrader.
</summary>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgrader.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Common.Tools.Chocolatey.IChocolateyToolResolver)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgrader"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="resolver">The Chocolatey tool resolver.</param>
</member>
<member name="M:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgrader.Upgrade(System.String,Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings)">
<summary>
Upgrades Chocolatey packages using the specified settings.
</summary>
<param name="packageId">The source package id.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgrader"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings.Prerelease">
<summary>
Gets or sets a value indicating whether to allow upgrading to prerelease versions.
This flag is not required when updating prerelease packages that are already installed.
</summary>
<value>
<c>true</c> to allow updating to prerelease versions; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings.Forcex86">
<summary>
Gets or sets a value indicating whether to force installation of the x86 version of package.
</summary>
<value>The force x86 flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings.InstallArguments">
<summary>
Gets or sets the install arguments to pass to native installer.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings.AllowDowngrade">
<summary>
Gets or sets a value indicating whether to allow downgrade of package.
</summary>
<value>The downgrade package flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings.IgnoreDependencies">
<summary>
Gets or sets a value indicating whether to ignore dependencies.
</summary>
<value>The ignore dependencies flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings.FailOnUnfound">
<summary>
Gets or sets a value indicating whether to fail on unfound packages.
</summary>
<value>The skip powershell flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings.IgnoreUnfound">
<summary>
Gets or sets a value indicating whether to ignore unfound packages if downloading more than one at a time.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings.FailOnNotInstalled">
<summary>
Gets or sets a value indicating whether to fail on not installed packages.
</summary>
<value>The skip powershell flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings.User">
<summary>
Gets or sets the user for authenticated feeds.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings.Password">
<summary>
Gets or sets the password for authenticated feeds.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings.Certificate">
<summary>
Gets or sets the path to a PFX certificate for use with x509 authenticated feeds.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings.CertificatePassword">
<summary>
Gets or sets the password for the <see cref="P:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings.Certificate"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings.IgnoreChecksums">
<summary>
Gets or sets a value indicating whether to ignore checksums.
</summary>
<value>The ignore checksums flag.</value>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings.AllowEmptyChecksums">
<summary>
Gets or sets a value indicating whether to allow empty checksums for bare HTTP URLs during package installation.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings.AllowEmptyChecksumsSecure">
<summary>
Gets or sets a value indicating whether to allow empty checksums for HTTPS URLs during package installation.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings.RequireChecksums">
<summary>
Gets or sets a value indicating whether checksums are required during package installation.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings.Checksum">
<summary>
Gets or sets the checksum for 32 bit installation.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings.Checksum64">
<summary>
Gets or sets the checksum for 64 bit installation.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings.ChecksumType">
<summary>
Gets or sets the checksum type to use for 32 bit installation.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings.ChecksumType64">
<summary>
Gets or sets the checksum type to use for 64 bit installation.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings.Except">
<summary>
Gets or sets a comma separated list of package names that should not be upgraded when running upgrade all.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings.SkipIfNotInstalled">
<summary>
Gets or sets a value indicating whether a package will be skipped if it is not installed during upgrade operation.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings.InstallIfNotInstalled">
<summary>
Gets or sets a value indicating whether to install a package that is not installed during the upgrade operation.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings.ExcludePrerelease">
<summary>
Gets or sets a value indicating whether prerelease packages should be ignored for upgrades.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings.UseRememberedArguments">
<summary>
Gets or sets a value indicating whether to use the remembered arguments for a package.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings.IgnoreRememeredArguments">
<summary>
Gets or sets a value indicating whether to ignore the remembered arguments for package.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings.DisableRepositoryOptimizations">
<summary>
Gets or sets a value indicating whether to use optimizations for reducing bandwidth when communicating with repositories.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings.Pin">
<summary>
Gets or sets a value indicating whether to pin the package once installed.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings.SkipDownloadCache">
<summary>
Gets or sets a value indicating whether to skip the package download cache.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings.UseDownloadCache">
<summary>
Gets or sets a value indicating whether to use the package download cache.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings.SkipVirusCheck">
<summary>
Gets or sets a value indicating whether skip the virus checking for a package.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings.VirusCheck">
<summary>
Gets or sets a value indicating whether to force virus checking for a package.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings.VirusPositivesMinimum">
<summary>
Gets or sets the minimum allowed number of virus positives.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings.InstallArgumentsSensitive">
<summary>
Gets or sets the install arguments sensitive to pass to native installer.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings.PackageParametersSensitive">
<summary>
Gets or sets sensitive parameters to pass to the package.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings.InstallDirectory">
<summary>
Gets or sets the default application installation directory.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings.MaximumDownloadBitsPerSecond">
<summary>
Gets or sets the maximum download bits per second when downloading a package.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings.ReducePackageSize">
<summary>
Gets or sets a value indicating whether package size should be reduced on installation.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings.NoReducePackageSize">
<summary>
Gets or sets a value indicating whether there should be no reduction in package size on installation.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings.ReduceNupkgOnly">
<summary>
Gets or sets a value indicating whether only the nupkg file size should be reduced.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings.ExcludeChocolateyPackagesDuringUpgradeAll">
<summary>
Gets or sets a value indicating whether to exclude all Chocolatey owned packages during upgrade all operation.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings.IncludeChocolateyPackagesDuringUpgradeAll">
<summary>
Gets or sets a value indicating whether to include all Chocolatey owned packages during upgrade all operation.
</summary>
</member>
<member name="P:Cake.Common.Tools.Chocolatey.Upgrade.ChocolateyUpgradeSettings.PinReason">
<summary>
Gets or sets a reason for pinning a package during installation.
</summary>
</member>
<member name="T:Cake.Common.Tools.Command.CommandAliases">
<summary>
<para>Contains generic functionality for simplifying the execution tools with no dedicated alias available yet.</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.Command.CommandAliases.Command(Cake.Core.ICakeContext,System.Collections.Generic.ICollection{System.String},Cake.Core.IO.ProcessArgumentBuilder,System.Int32,System.Func{Cake.Common.Tools.Command.CommandSettings,Cake.Common.Tools.Command.CommandSettings})">
<summary>
Executes a generic tool/process based on arguments and settings.
</summary>
<param name="context">The context.</param>
<param name="toolExecutableNames">The tool executable names.</param>
<param name="arguments">The optional arguments.</param>
<param name="expectedExitCode">The expected exit code (default 0).</param>
<param name="settingsCustomization">The optional settings customization (default null).</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="context"/> or <paramref name="toolExecutableNames"/> is null or empty.</exception>
<example>
<code>
// Example with ProcessArgumentBuilder
#tool dotnet:?package=DPI&version=2022.8.21.54
Command(
new []{ "dpi", "dpi.exe"},
new ProcessArgumentBuilder()
.Append("nuget")
.AppendQuoted(Context.Environment.WorkingDirectory.FullPath)
.AppendSwitch("--output", " ", "TABLE")
.Append("analyze")
);
// Example with implicit ProcessArgumentBuilder
Command(
new []{ "dotnet", "dotnet.exe"},
"--version"
);
// Example specify expected exit code
Command(
new []{ "dotnet", "dotnet.exe"},
expectedExitCode: -2147450751
);
// Example settings customization
Command(
new []{ "dotnet", "dotnet.exe"},
settingsCustomization: settings => settings
.WithToolName(".NET tool")
.WithExpectedExitCode(1)
.WithArgumentCustomization(args => args.Append("tool"))
);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Command.CommandAliases.Command(Cake.Core.ICakeContext,Cake.Common.Tools.Command.CommandSettings,Cake.Core.IO.ProcessArgumentBuilder)">
<summary>
Executes a generic command based on arguments and settings.
</summary>
<param name="context">The context.</param>
<param name="settings">The settings.</param>
<param name="arguments">The optional arguments.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="context"/> or <paramref name="settings"/> is null.</exception>
<example>
<code>
#tool dotnet:?package=DPI&version=2022.8.21.54
// Reusable tools settings i.e. created in setup.
var settings = new CommandSettings {
ToolName = "DPI",
ToolExecutableNames = new []{ "dpi", "dpi.exe"},
};
// Example with ProcessArgumentBuilder
Command(
settings,
new ProcessArgumentBuilder()
.Append("nuget")
.AppendQuoted(Context.Environment.WorkingDirectory.FullPath)
.AppendSwitch("--output", " ", "TABLE")
.Append("analyze")
);
// Example with implicit ProcessArgumentBuilder
Command(
settings,
$"nuget --output TABLE analyze"
);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Command.CommandAliases.Command(Cake.Core.ICakeContext,System.Collections.Generic.ICollection{System.String},System.String@,Cake.Core.IO.ProcessArgumentBuilder,System.Int32,System.Func{Cake.Common.Tools.Command.CommandSettings,Cake.Common.Tools.Command.CommandSettings})">
<summary>
Executes a generic tool/process based on arguments, tool executable names and redirects standard output.
</summary>
<param name="context">The context.</param>
<param name="toolExecutableNames">The tool executable names.</param>
<param name="standardOutput">The standard output.</param>
<param name="arguments">The optional arguments.</param>
<param name="expectedExitCode">The expected exit code (default 0).</param>
<param name="settingsCustomization">The optional settings customization.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="arguments"/>, <paramref name="context"/> or <paramref name="toolExecutableNames"/> is null.</exception>
<returns>The exit code.</returns>
<example>
<code>
using System.Text.Json.Serialization;
using System.Text.Json;
#tool dotnet:?package=DPI&version=2022.8.21.54
// Example with ProcessArgumentBuilder
var exitCode = Command(
new []{ "dpi", "dpi.exe"},
out var standardOutput,
new ProcessArgumentBuilder()
.Append("nuget")
.AppendQuoted(Context.Environment.WorkingDirectory.FullPath)
.AppendSwitch("--output", " ", "JSON")
.Append("analyze")
);
var packageReferences = JsonSerializer.Deserialize<DPIPackageReference[]>(
standardOutput
);
// Example with implicit ProcessArgumentBuilder
var implicitExitCode = Command(
new []{ "dpi", "dpi.exe"},
out var implicitStandardOutput,
$"nuget --output JSON analyze"
);
var implicitPackageReferences = JsonSerializer.Deserialize<DPIPackageReference[]>(
implicitStandardOutput
);
// Example settings customization
var settingsCustomizationExitCode = Command(
new []{ "dpi", "dpi.exe"},
out var settingsCustomizationStandardOutput,
$"nuget --output JSON analyze",
settingsCustomization: settings => settings
.WithToolName("DPI")
.WithArgumentCustomization(args => args.AppendSwitchQuoted("--buildversion", " ", "1.0.0"))
);
var settingsCustomizationPackageReferences = JsonSerializer.Deserialize<DPIPackageReference[]>(
settingsCustomizationStandardOutput
);
// Record used in example above
public record DPIPackageReference(
[property: JsonPropertyName("source")]
string Source,
[property: JsonPropertyName("sourceType")]
string SourceType,
[property: JsonPropertyName("packageId")]
string PackageId,
[property: JsonPropertyName("version")]
string Version
);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Command.CommandAliases.Command(Cake.Core.ICakeContext,Cake.Common.Tools.Command.CommandSettings,System.String@,Cake.Core.IO.ProcessArgumentBuilder)">
<summary>
Executes a generic tool/process based on arguments, settings and redirects standard output.
</summary>
<param name="context">The context.</param>
<param name="settings">The settings.</param>
<param name="standardOutput">The standard output.</param>
<param name="arguments">The optional arguments.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="context"/> or <paramref name="settings"/> is null.</exception>
<returns>The exit code.</returns>
<example>
<code>
using System.Text.Json.Serialization;
using System.Text.Json;
#tool dotnet:?package=DPI&version=2022.8.21.54
// Reusable tools settings i.e. created in setup.
var settings = new CommandSettings {
ToolName = "DPI",
ToolExecutableNames = new []{ "dpi", "dpi.exe" },
};
// Example with ProcessArgumentBuilder
var exitCode = Command(
settings,
out var standardOutput,
new ProcessArgumentBuilder()
.Append("nuget")
.AppendQuoted(Context.Environment.WorkingDirectory.FullPath)
.AppendSwitch("--output", " ", "JSON")
.Append("analyze")
);
var packageReferences = JsonSerializer.Deserialize<DPIPackageReference[]>(
standardOutput
);
// Example with implicit ProcessArgumentBuilder
var implicitExitCode = Command(
settings,
out var implicitStandardOutput,
$"nuget --output JSON analyze"
);
var implicitPackageReferences = JsonSerializer.Deserialize<DPIPackageReference[]>(
implicitStandardOutput
);
// Record used in example above
public record DPIPackageReference(
[property: JsonPropertyName("source")]
string Source,
[property: JsonPropertyName("sourceType")]
string SourceType,
[property: JsonPropertyName("packageId")]
string PackageId,
[property: JsonPropertyName("version")]
string Version
);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Command.CommandAliases.Command(Cake.Core.ICakeContext,System.Collections.Generic.ICollection{System.String},System.String@,System.String@,Cake.Core.IO.ProcessArgumentBuilder,System.Int32,System.Func{Cake.Common.Tools.Command.CommandSettings,Cake.Common.Tools.Command.CommandSettings})">
<summary>
Executes a generic tool/process based on arguments, settings, redirects standard output and standard error.
</summary>
<param name="context">The context.</param>
<param name="toolExecutableNames">The tool executable names.</param>
<param name="standardOutput">The standard output.</param>
<param name="standardError">The standard error.</param>
<param name="arguments">The optional arguments.</param>
<param name="expectedExitCode">The expected exit code (default 0).</param>
<param name="settingsCustomization">The optional settings customization (default null).</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="context"/> or <paramref name="toolExecutableNames"/> is null.</exception>
<returns>The exit code.</returns>
<example>
<code>
// Example with ProcessArgumentBuilder
var exitCode = Command(
new []{ "dotnet", "dotnet.exe" },
out var standardOutput,
out var standardError,
new ProcessArgumentBuilder()
.Append("tool"),
expectedExitCode:1
);
Verbose("Exit code: {0}", exitCode);
Information("Output: {0}", standardOutput);
Error("Error: {0}", standardError);
// Example with implicit ProcessArgumentBuilder
var implicitExitCode = Command(
new []{ "dotnet", "dotnet.exe" },
out var implicitStandardOutput,
out var implicitStandardError,
"tool",
expectedExitCode:1
);
Verbose("Exit code: {0}", implicitExitCode);
Information("Output: {0}", implicitStandardOutput);
Error("Error: {0}", implicitStandardError);
// Example settings customization
var settingsCustomizationExitCode = Command(
new []{ "dotnet", "dotnet.exe" },
out var settingsCustomizationStandardOutput,
out var settingsCustomizationStandardError,
settingsCustomization: settings => settings
.WithToolName(".NET Tool")
.WithArgumentCustomization(args => args.Append("tool"))
.WithExpectedExitCode(1)
);
Verbose("Exit code: {0}", settingsCustomizationExitCode);
Information("Output: {0}", settingsCustomizationStandardOutput);
Error("Error: {0}", settingsCustomizationStandardError);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.Command.CommandAliases.Command(Cake.Core.ICakeContext,Cake.Common.Tools.Command.CommandSettings,System.String@,System.String@,Cake.Core.IO.ProcessArgumentBuilder)">
<summary>
Executes a generic tool/process based on arguments and settings.
</summary>
<param name="context">The context.</param>
<param name="settings">The settings.</param>
<param name="standardOutput">The standard output.</param>
<param name="standardError">The standard error.</param>
<param name="arguments">The optional arguments.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="context"/> or <paramref name="settings"/> is null.</exception>
<returns>The exit code.</returns>
<example>
<code>
// Reusable tools settings i.e. created in setup.
var settings = new CommandSettings {
ToolName = ".NET CLI",
ToolExecutableNames = new []{ "dotnet", "dotnet.exe" },
}.WithExpectedExitCode(1);
// Example with ProcessArgumentBuilder
var exitCode = Command(
settings,
out var standardOutput,
out var standardError,
new ProcessArgumentBuilder()
.Append("tool")
);
Verbose("Exit code: {0}", exitCode);
Information("Output: {0}", standardOutput);
Error("Error: {0}", standardError);
// Example with implicit ProcessArgumentBuilder
var implicitExitCode = Command(
settings,
out var implicitStandardOutput,
out var implicitStandardError,
"tool"
);
Verbose("Exit code: {0}", implicitExitCode);
Information("Output: {0}", implicitStandardOutput);
Error("Error: {0}", implicitStandardError);
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.Command.CommandRunner">
<summary>
The generic command runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.Command.CommandRunner.#ctor(Cake.Common.Tools.Command.CommandSettings,Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.Command.CommandRunner"/> class.
</summary>
<param name="settings">The settings.</param>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The globber.</param>
</member>
<member name="M:Cake.Common.Tools.Command.CommandRunner.GetToolExecutableNames">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Tools.Command.CommandRunner.GetToolName">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Tools.Command.CommandRunner.RunCommand(Cake.Core.IO.ProcessArgumentBuilder)">
<summary>
Runs the command using the specified settings.
</summary>
<param name="arguments">The arguments.</param>
</member>
<member name="M:Cake.Common.Tools.Command.CommandRunner.RunCommand(Cake.Core.IO.ProcessArgumentBuilder,System.String@)">
<summary>
Runs the command using the specified settings.
</summary>
<param name="arguments">The arguments.</param>
<param name="standardOutput">The standard output.</param>
<returns>The exit code.</returns>
</member>
<member name="M:Cake.Common.Tools.Command.CommandRunner.RunCommand(Cake.Core.IO.ProcessArgumentBuilder,System.String@,System.String@)">
<summary>
Runs the command using the specified settings.
</summary>
<param name="arguments">The arguments.</param>
<param name="standardOutput">The standard output.</param>
<param name="standardError">The standard error output.</param>
<returns>The exit code.</returns>
</member>
<member name="M:Cake.Common.Tools.Command.CommandRunner.RunCommand(Cake.Core.IO.ProcessArgumentBuilder,Cake.Core.IO.ProcessSettings,System.Action{Cake.Core.IO.IProcess})">
<summary>
Runs the command using the specified settings.
</summary>
<param name="arguments">The arguments.</param>
<param name="processSettings">The process settings.</param>
<param name="postAction">If specified called after process exit.</param>
</member>
<member name="T:Cake.Common.Tools.Command.CommandSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.Command.CommandRunner" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.Command.CommandSettings.ToolName">
<summary>
Gets or sets the name of the tool.
</summary>
</member>
<member name="P:Cake.Common.Tools.Command.CommandSettings.ToolExecutableNames">
<summary>
Gets or sets the tool executable names.
</summary>
</member>
<member name="T:Cake.Common.Tools.Command.CommandSettingsExtensions">
<summary>
Contains functionality related to <see cref="T:Cake.Common.Tools.Command.CommandRunner" />.
</summary>
</member>
<member name="M:Cake.Common.Tools.Command.CommandSettingsExtensions.WithExecutableNames``1(``0,System.String[])">
<summary>
Sets the tool executable names.
</summary>
<param name="toolSettings">The tools settings.</param>
<param name="toolExecutableNames">The tool executable names.</param>
<typeparam name="T">The ToolSettings type.</typeparam>
<returns>The tools settings.</returns>
</member>
<member name="M:Cake.Common.Tools.Command.CommandSettingsExtensions.WithToolName``1(``0,System.String)">
<summary>
Sets the tool name.
</summary>
<param name="toolSettings">The tools settings.</param>
<param name="toolName">The tool name.</param>
<typeparam name="T">The ToolSettings type.</typeparam>
<returns>The tools settings.</returns>
</member>
<member name="T:Cake.Common.Tools.DotCover.Analyse.DotCoverAnalyser">
<summary>
DotCover Analyser builder.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotCover.Analyse.DotCoverAnalyser.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotCover.Analyse.DotCoverAnalyser" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.DotCover.Analyse.DotCoverAnalyser.Analyse(Cake.Core.ICakeContext,System.Action{Cake.Core.ICakeContext},Cake.Core.IO.FilePath,Cake.Common.Tools.DotCover.Analyse.DotCoverAnalyseSettings)">
<summary>
Runs DotCover Analyse with the specified settings.
</summary>
<param name="context">The context.</param>
<param name="action">The action.</param>
<param name="outputPath">The output file path.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.DotCover.Analyse.DotCoverAnalyseSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotCover.Analyse.DotCoverAnalyser" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotCover.Analyse.DotCoverAnalyseSettings.ReportType">
<summary>
Gets or sets the type of the report.
This represents the <c>/ReportType</c> option.
The Default value is <see cref="F:Cake.Common.Tools.DotCover.DotCoverReportType.XML"/>.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotCover.Cover.DotCoverCoverer">
<summary>
DotCover Coverer builder.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotCover.Cover.DotCoverCoverer.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotCover.Cover.DotCoverCoverer" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.DotCover.Cover.DotCoverCoverer.Cover(Cake.Core.ICakeContext,System.Action{Cake.Core.ICakeContext},Cake.Core.IO.FilePath,Cake.Common.Tools.DotCover.Cover.DotCoverCoverSettings)">
<summary>
Runs DotCover Cover with the specified settings.
</summary>
<param name="context">The context.</param>
<param name="action">The action.</param>
<param name="outputPath">The output file path.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.DotCover.Cover.DotCoverCoverSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotCover.Cover.DotCoverCoverer" />.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotCover.DotCoverAliases">
<summary>
<para>Contains functionality related to <see href="https://www.jetbrains.com/dotcover/">DotCover</see>.</para>
<para>
In order to use the commands for this alias, include the following in your build.cake file to download and
install from nuget.org, or specify the ToolPath within the appropriate settings class:
<code>
#tool "nuget:?package=JetBrains.dotCover.CommandLineTools"
</code>
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.DotCover.DotCoverAliases.DotCoverAnalyse(Cake.Core.ICakeContext,System.Action{Cake.Core.ICakeContext},Cake.Core.IO.FilePath,Cake.Common.Tools.DotCover.Analyse.DotCoverAnalyseSettings)">
<summary>
Runs <see href="https://www.jetbrains.com/dotcover/help/dotCover__Console_Runner_Commands.html#analyse">DotCover Analyse</see>
for the specified action and settings.
</summary>
<param name="context">The context.</param>
<param name="action">The action to run DotCover for.</param>
<param name="outputFile">The DotCover output file.</param>
<param name="settings">The settings.</param>
<example>
<code>
DotCoverAnalyse(tool => {
tool.XUnit2("./**/App.Tests.dll",
new XUnit2Settings {
ShadowCopy = false
});
},
new FilePath("./result.xml"),
new DotCoverAnalyseSettings()
.WithFilter("+:App")
.WithFilter("-:App.Tests"));
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotCover.DotCoverAliases.DotCoverCover(Cake.Core.ICakeContext,System.Action{Cake.Core.ICakeContext},Cake.Core.IO.FilePath,Cake.Common.Tools.DotCover.Cover.DotCoverCoverSettings)">
<summary>
Runs <see href="https://www.jetbrains.com/dotcover/help/dotCover__Console_Runner_Commands.html#cover">DotCover Cover</see>
for the specified action and settings.
</summary>
<param name="context">The context.</param>
<param name="action">The action to run DotCover for.</param>
<param name="outputFile">The DotCover output file.</param>
<param name="settings">The settings.</param>
<example>
<code>
DotCoverCover(tool => {
tool.XUnit2("./**/App.Tests.dll",
new XUnit2Settings {
ShadowCopy = false
});
},
new FilePath("./result.dcvr"),
new DotCoverCoverSettings()
.WithFilter("+:App")
.WithFilter("-:App.Tests"));
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotCover.DotCoverAliases.DotCoverReport(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Core.IO.FilePath,Cake.Common.Tools.DotCover.Report.DotCoverReportSettings)">
<summary>
Runs <see href="https://www.jetbrains.com/dotcover/help/dotCover__Console_Runner_Commands.html#report">DotCover Report</see>
for the specified action and settings.
</summary>
<param name="context">The context.</param>
<param name="sourceFile">The DotCover coverage snapshot file name.</param>
<param name="outputFile">The DotCover output file.</param>
<param name="settings">The settings.</param>
<example>
<code>
DotCoverReport(new FilePath("./result.dcvr"),
new FilePath("./result.html"),
new DotCoverReportSettings {
ReportType = DotCoverReportType.HTML
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotCover.DotCoverAliases.DotCoverMerge(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Core.IO.FilePath)">
<summary>
Runs <see href="https://www.jetbrains.com/dotcover/help/dotCover__Console_Runner_Commands.html#merge">DotCover Merge</see>
for the specified action and settings.
</summary>
<param name="context">The context.</param>
<param name="sourceFiles">The list of DotCover coverage snapshot files.</param>
<param name="outputFile">The merged output file.</param>
<example>
<code>
DotCoverMerge(new[] {
new FilePath("./result1.dcvr"),
new FilePath("./result2.dcvr")
},
new FilePath("./merged.dcvr"));
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotCover.DotCoverAliases.DotCoverMerge(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Core.IO.FilePath,Cake.Common.Tools.DotCover.Merge.DotCoverMergeSettings)">
<summary>
Runs <see href="https://www.jetbrains.com/dotcover/help/dotCover__Console_Runner_Commands.html#merge">DotCover Merge</see>
for the specified action and settings.
</summary>
<param name="context">The context.</param>
<param name="sourceFiles">The list of DotCover coverage snapshot files.</param>
<param name="outputFile">The merged output file.</param>
<param name="settings">The settings.</param>
<example>
<code>
DotCoverMerge(new[] {
new FilePath("./result1.dcvr"),
new FilePath("./result2.dcvr")
},
new FilePath("./merged.dcvr"),
new DotCoverMergeSettings {
LogFile = new FilePath("./log.txt")
});
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.DotCover.DotCoverCoverageSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotCover.DotCoverTool`1" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotCover.DotCoverCoverageSettings.TargetWorkingDir">
<summary>
Gets or sets program working directory
This represents the <c>/TargetWorkingDir</c> option.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotCover.DotCoverCoverageSettings.Scope">
<summary>
Gets the assemblies loaded in the specified scope into coverage results.
Ant-style patterns are supported here (e.g.ProjectFolder/**/*.dll)
This represents the <c>/Scope</c> option.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotCover.DotCoverCoverageSettings.Filters">
<summary>
Gets the coverage filters using the following syntax: +:module=*;class=*;function=*;
Use -:myassembly to exclude an assembly from code coverage.
Asterisk wildcard (*) is supported here.
This represents the <c>/Filters</c> option.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotCover.DotCoverCoverageSettings.AttributeFilters">
<summary>
Gets the attribute filters using the following syntax: filter1;filter2;...
Asterisk wildcard(*) is supported here
This represents the <c>/AttributeFilters</c> option.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotCover.DotCoverCoverageSettings.ProcessFilters">
<summary>
Gets the coverage process filters using the following syntax: +:test.exe;program.exe*;
Use -:anexe to exclude an assembly from code coverage.
This represents the <c>/ProcessFilters</c> option.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotCover.DotCoverCoverageSettings.DisableDefaultFilters">
<summary>
Gets or sets a value indicating whether the default (automatically added) filters should be disabled
This represents the <c>/DisableDefaultFilters</c> option.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotCover.DotCoverCoverageSettings.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotCover.DotCoverCoverageSettings"/> class.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotCover.DotCoverCoverageSettingsExtensions">
<summary>
Contains extensions for <see cref="T:Cake.Common.Tools.DotCover.DotCoverCoverageSettings"/>.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotCover.DotCoverCoverageSettingsExtensions.WithScope``1(``0,System.String)">
<summary>
Adds the scope.
</summary>
<param name="settings">The settings.</param>
<param name="scope">The scope.</param>
<typeparam name="T">The settings type, derived from <see cref="T:Cake.Common.Tools.DotCover.DotCoverCoverageSettings"/>.</typeparam>
<returns>The same <see cref="T:Cake.Common.Tools.DotCover.DotCoverCoverageSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotCover.DotCoverCoverageSettingsExtensions.WithFilter``1(``0,System.String)">
<summary>
Adds the filter.
</summary>
<param name="settings">The settings.</param>
<param name="filter">The filter.</param>
<typeparam name="T">The settings type, derived from <see cref="T:Cake.Common.Tools.DotCover.DotCoverCoverageSettings"/>.</typeparam>
<returns>The same <see cref="T:Cake.Common.Tools.DotCover.DotCoverCoverageSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotCover.DotCoverCoverageSettingsExtensions.WithAttributeFilter``1(``0,System.String)">
<summary>
Adds the attribute filter.
</summary>
<param name="settings">The settings.</param>
<param name="attributeFilter">The filter.</param>
<typeparam name="T">The settings type, derived from <see cref="T:Cake.Common.Tools.DotCover.DotCoverCoverageSettings"/>.</typeparam>
<returns>The same <see cref="T:Cake.Common.Tools.DotCover.DotCoverCoverageSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotCover.DotCoverCoverageSettingsExtensions.WithProcessFilter``1(``0,System.String)">
<summary>
Adds the filter.
</summary>
<param name="settings">The settings.</param>
<param name="filter">The process filter.</param>
<typeparam name="T">The settings type, derived from <see cref="T:Cake.Common.Tools.DotCover.DotCoverCoverageSettings"/>.</typeparam>
<returns>The same <see cref="T:Cake.Common.Tools.DotCover.DotCoverCoverageSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="T:Cake.Common.Tools.DotCover.DotCoverCoverageTool`1">
<summary>
DotCover Coverage tool.
</summary>
<typeparam name="TSettings">The settings type.</typeparam>
</member>
<member name="M:Cake.Common.Tools.DotCover.DotCoverCoverageTool`1.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotCover.DotCoverCoverageTool`1" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.DotCover.DotCoverCoverageTool`1.GetTargetArguments(Cake.Core.ICakeContext,System.Action{Cake.Core.ICakeContext})">
<summary>
Get arguments from the target executable.
</summary>
<param name="context">The context.</param>
<param name="action">The action to run DotCover for.</param>
<returns>The process arguments.</returns>
</member>
<member name="M:Cake.Common.Tools.DotCover.DotCoverCoverageTool`1.GetCoverageArguments(Cake.Common.Tools.DotCover.DotCoverCoverageSettings)">
<summary>
Get arguments from coverage settings.
</summary>
<param name="settings">The settings.</param>
<returns>The process arguments.</returns>
</member>
<member name="T:Cake.Common.Tools.DotCover.DotCoverReportType">
<summary>
Represents DotCover ReportType.
</summary>
</member>
<member name="F:Cake.Common.Tools.DotCover.DotCoverReportType.XML">
<summary>
ReportType: <c>XML</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.DotCover.DotCoverReportType.HTML">
<summary>
ReportType: <c>HTML</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.DotCover.DotCoverReportType.JSON">
<summary>
ReportType: <c>JSON</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.DotCover.DotCoverReportType.DetailedXML">
<summary>
ReportType: <c>DetailedXML</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.DotCover.DotCoverReportType.NDependXML">
<summary>
ReportType: <c>NDependXML</c>
</summary>
</member>
<member name="T:Cake.Common.Tools.DotCover.DotCoverSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotCover.DotCoverTool`1" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotCover.DotCoverSettings.LogFile">
<summary>
Gets or sets a value that enables logging and specifies log file name
This represents the <c>/LogFile</c> option.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotCover.DotCoverSettings.ConfigFile">
<summary>
Gets or sets a value that enables DotCover configuration file.
A configuration file is a reasonable alternative
to specifying all parameters in-line or having them in a batch file.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotCover.DotCoverSettingsExtensions">
<summary>
Contains extensions for <see cref="T:Cake.Common.Tools.DotCover.DotCoverSettings"/>.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotCover.DotCoverSettingsExtensions.WithConfigFile``1(``0,Cake.Core.IO.FilePath)">
<summary>
Adds the scope.
</summary>
<param name="settings">The settings.</param>
<param name="configFile">The DotCover configuration file.</param>
<typeparam name="T">The settings type, derived from <see cref="T:Cake.Common.Tools.DotCover.DotCoverSettings"/>.</typeparam>
<returns>The same <see cref="T:Cake.Common.Tools.DotCover.DotCoverSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="T:Cake.Common.Tools.DotCover.DotCoverTool`1">
<summary>
Base class for all DotCover related tools.
</summary>
<typeparam name="TSettings">The settings type.</typeparam>
</member>
<member name="M:Cake.Common.Tools.DotCover.DotCoverTool`1.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotCover.DotCoverTool`1" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.DotCover.DotCoverTool`1.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.DotCover.DotCoverTool`1.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="M:Cake.Common.Tools.DotCover.DotCoverTool`1.GetArguments(Cake.Common.Tools.DotCover.DotCoverSettings)">
<summary>
Get arguments from global settings.
</summary>
<param name="settings">The settings.</param>
<returns>The process arguments.</returns>
</member>
<member name="M:Cake.Common.Tools.DotCover.DotCoverTool`1.GetConfigurationFileArgument(Cake.Common.Tools.DotCover.DotCoverSettings)">
<summary>
Get configuration full path from coverage settings.
</summary>
<param name="settings">The settings.</param>
<returns>The process arguments.</returns>
</member>
<member name="T:Cake.Common.Tools.DotCover.Merge.DotCoverMerger">
<summary>
DotCover Merge merger.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotCover.Merge.DotCoverMerger.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotCover.Merge.DotCoverMerger" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.DotCover.Merge.DotCoverMerger.Merge(System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Core.IO.FilePath,Cake.Common.Tools.DotCover.Merge.DotCoverMergeSettings)">
<summary>
Runs DotCover Merge with the specified settings.
</summary>
<param name="sourceFiles">The list of DotCover coverage snapshot files.</param>
<param name="outputFile">The merged output file.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.DotCover.Merge.DotCoverMergeSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotCover.Merge.DotCoverMerger" />.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotCover.Report.DotCoverReporter">
<summary>
DotCover Report reporter.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotCover.Report.DotCoverReporter.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotCover.Report.DotCoverReporter" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.DotCover.Report.DotCoverReporter.Report(Cake.Core.IO.FilePath,Cake.Core.IO.FilePath,Cake.Common.Tools.DotCover.Report.DotCoverReportSettings)">
<summary>
Runs DotCover Cover with the specified settings.
</summary>
<param name="sourceFile">The DotCover coverage snapshot file name.</param>
<param name="outputFile">The DotCover output file.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.DotCover.Report.DotCoverReportSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotCover.Report.DotCoverReporter" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotCover.Report.DotCoverReportSettings.ReportType">
<summary>
Gets or sets the type of the report.
This represents the <c>/ReportType</c> option.
The Default value is <see cref="F:Cake.Common.Tools.DotCover.DotCoverReportType.XML"/>.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNet.BuildServer.DotNetBuildServer">
<summary>
.NET Core project builder.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotNet.BuildServer.DotNetBuildServer.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotNet.BuildServer.DotNetBuildServer" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.DotNet.BuildServer.DotNetBuildServer.Shutdown(Cake.Common.Tools.DotNet.BuildServer.DotNetBuildServerShutdownSettings)">
<summary>
Build the project using the specified path and settings.
</summary>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.DotNet.BuildServer.DotNetBuildServerSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotNet.BuildServer.DotNetBuildServer" />.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNet.BuildServer.DotNetBuildServerShutdownSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotNet.BuildServer.DotNetBuildServer" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.BuildServer.DotNetBuildServerShutdownSettings.MSBuild">
<summary>
Gets or sets if to shuts down the MSBuild build server.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.BuildServer.DotNetBuildServerShutdownSettings.Razor">
<summary>
Gets or sets if to shuts down the the Razor build server.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.BuildServer.DotNetBuildServerShutdownSettings.VBCSCompiler">
<summary>
Gets or sets if to shuts down the VB/C# compiler build server.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNet.Build.DotNetBuilder">
<summary>
.NET project builder.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotNet.Build.DotNetBuilder.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotNet.Build.DotNetBuilder" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.DotNet.Build.DotNetBuilder.Build(System.String,Cake.Common.Tools.DotNet.Build.DotNetBuildSettings)">
<summary>
Build the project using the specified path and settings.
</summary>
<param name="project">The target project path.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.DotNet.Build.DotNetBuildSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotNet.Build.DotNetBuilder" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Build.DotNetBuildSettings.OutputDirectory">
<summary>
Gets or sets the output directory.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Build.DotNetBuildSettings.Runtime">
<summary>
Gets or sets the target runtime.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Build.DotNetBuildSettings.Configuration">
<summary>
Gets or sets the configuration under which to build.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Build.DotNetBuildSettings.Framework">
<summary>
Gets or sets the specific framework to compile.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Build.DotNetBuildSettings.VersionSuffix">
<summary>
Gets or sets the value that defines what `*` should be replaced with in version field in project.json.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Build.DotNetBuildSettings.NoIncremental">
<summary>
Gets or sets a value indicating whether to mark the build as unsafe for incrementality.
This turns off incremental compilation and forces a clean rebuild of the project dependency graph.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Build.DotNetBuildSettings.NoDependencies">
<summary>
Gets or sets a value indicating whether to ignore project to project references and only build the root project.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Build.DotNetBuildSettings.NoRestore">
<summary>
Gets or sets a value indicating whether to not do implicit NuGet package restore.
This makes build faster, but requires restore to be done before build is executed.
</summary>
<remarks>
Requires .NET Core 2.x or newer.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.Build.DotNetBuildSettings.NoLogo">
<summary>
Gets or sets a value indicating whether to display the startup banner or the copyright message.
</summary>
<remarks>
Available since .NET Core 3.0 SDK.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.Build.DotNetBuildSettings.Sources">
<summary>
Gets or sets the specified NuGet package sources to use during the build.
</summary>
<remarks>
Requires .NET Core 2.x or newer.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.Build.DotNetBuildSettings.MSBuildSettings">
<summary>
Gets or sets additional arguments to be passed to MSBuild.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNet.Clean.DotNetCleaner">
<summary>
.NET Core project cleaner.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotNet.Clean.DotNetCleaner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotNet.Clean.DotNetCleaner" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.DotNet.Clean.DotNetCleaner.Clean(System.String,Cake.Common.Tools.DotNet.Clean.DotNetCleanSettings)">
<summary>
Cleans the project's output using the specified path and settings.
</summary>
<param name="project">The target project path.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.DotNet.Clean.DotNetCleanSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotNet.Clean.DotNetCleaner" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Clean.DotNetCleanSettings.OutputDirectory">
<summary>
Gets or sets the output directory.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Clean.DotNetCleanSettings.Configuration">
<summary>
Gets or sets the configuration under which to build.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Clean.DotNetCleanSettings.Framework">
<summary>
Gets or sets the specific framework to compile.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Clean.DotNetCleanSettings.Runtime">
<summary>
Gets or sets the target runtime.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Clean.DotNetCleanSettings.NoLogo">
<summary>
Gets or sets a value indicating whether to display the startup banner or the copyright message.
</summary>
<remarks>
Available since .NET Core 3.0 SDK.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.Clean.DotNetCleanSettings.MSBuildSettings">
<summary>
Gets or sets additional arguments to be passed to MSBuild.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNet.DotNetAliases">
<summary>
<para>Contains functionality related to <see href="https://github.com/dotnet/cli">.NET CLI</see>.</para>
<para>
In order to use the commands for this alias, the .NET CLI tools will need to be installed on the machine where
the Cake script is being executed. See this <see href="https://www.microsoft.com/net/core">page</see> for information
on how to install.
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetExecute(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Execute an assembly.
</summary>
<param name="context">The context.</param>
<param name="assemblyPath">The assembly path.</param>
<example>
<code>
DotNetExecute("./bin/Debug/app.dll");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetExecute(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Core.IO.ProcessArgumentBuilder)">
<summary>
Execute an assembly with arguments in the specific path.
</summary>
<param name="context">The context.</param>
<param name="assemblyPath">The assembly path.</param>
<param name="arguments">The arguments.</param>
<example>
<code>
DotNetExecute("./bin/Debug/app.dll", "--arg");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetExecute(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Core.IO.ProcessArgumentBuilder,Cake.Common.Tools.DotNet.Execute.DotNetExecuteSettings)">
<summary>
Execute an assembly with arguments in the specific path with settings.
</summary>
<param name="context">The context.</param>
<param name="assemblyPath">The assembly path.</param>
<param name="arguments">The arguments.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetExecuteSettings
{
FrameworkVersion = "1.0.3"
};
DotNetExecute("./bin/Debug/app.dll", "--arg", settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetRestore(Cake.Core.ICakeContext)">
<summary>
Restore all NuGet Packages.
</summary>
<param name="context">The context.</param>
<example>
<code>
DotNetRestore();
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetRestore(Cake.Core.ICakeContext,System.String)">
<summary>
Restore all NuGet Packages in the specified path.
</summary>
<param name="context">The context.</param>
<param name="root">Path to the project file to restore.</param>
<example>
<code>
DotNetRestore("./src/MyProject/MyProject.csproj");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetRestore(Cake.Core.ICakeContext,Cake.Common.Tools.DotNet.Restore.DotNetRestoreSettings)">
<summary>
Restore all NuGet Packages with the settings.
</summary>
<param name="context">The context.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetRestoreSettings
{
Sources = new[] {"https://www.example.com/nugetfeed", "https://www.example.com/nugetfeed2"},
FallbackSources = new[] {"https://www.example.com/fallbacknugetfeed"},
PackagesDirectory = "./packages",
DotNetVerbosity.Information,
DisableParallel = true,
InferRuntimes = new[] {"runtime1", "runtime2"}
};
DotNetRestore(settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetRestore(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.DotNet.Restore.DotNetRestoreSettings)">
<summary>
Restore all NuGet Packages in the specified path with settings.
</summary>
<param name="context">The context.</param>
<param name="root">Path to the project file to restore.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetRestoreSettings
{
Sources = new[] {"https://www.example.com/nugetfeed", "https://www.example.com/nugetfeed2"},
FallbackSources = new[] {"https://www.example.com/fallbacknugetfeed"},
PackagesDirectory = "./packages",
DotNetVerbosity.Information,
DisableParallel = true,
InferRuntimes = new[] {"runtime1", "runtime2"}
};
DotNetRestore("./src/MyProject/MyProject.csproj", settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetBuild(Cake.Core.ICakeContext,System.String)">
<summary>
Build all projects.
</summary>
<param name="context">The context.</param>
<param name="project">The projects path.</param>
<example>
<code>
DotNetBuild("./src/*");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetBuild(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.DotNet.Build.DotNetBuildSettings)">
<summary>
Build all projects.
</summary>
<param name="context">The context.</param>
<param name="project">The projects path.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetBuildSettings
{
Framework = "netcoreapp2.0",
Configuration = "Debug",
OutputDirectory = "./artifacts/"
};
DotNetBuild("./src/*", settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetPublish(Cake.Core.ICakeContext,System.String)">
<summary>
Publish all projects.
</summary>
<param name="context">The context.</param>
<param name="project">The projects path.</param>
<example>
<code>
DotNetPublish("./src/*");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetPublish(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.DotNet.Publish.DotNetPublishSettings)">
<summary>
Publish all projects.
</summary>
<param name="context">The context.</param>
<param name="project">The projects path.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetPublishSettings
{
Framework = "netcoreapp2.0",
Configuration = "Release",
OutputDirectory = "./artifacts/"
};
DotNetPublish("./src/*", settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetTest(Cake.Core.ICakeContext)">
<summary>
Test project.
</summary>
<param name="context">The context.</param>
<example>
<code>
DotNetTest();
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetTest(Cake.Core.ICakeContext,System.String)">
<summary>
Test project with path.
</summary>
<param name="context">The context.</param>
<param name="project">The project path.</param>
<example>
<para>Specify the path to the .csproj file in the test project.</para>
<code>
DotNetTest("./test/Project.Tests/Project.Tests.csproj");
</code>
<para>You could also specify a task that runs multiple test projects.</para>
<para>Cake task:</para>
<code>
Task("Test")
.Does(() =>
{
var projectFiles = GetFiles("./test/**/*.csproj");
foreach(var file in projectFiles)
{
DotNetTest(file.FullPath);
}
});
</code>
<para>If your test project is using project.json, the project parameter should just be the directory path.</para>
<code>
DotNetTest("./test/Project.Tests/");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetTest(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.DotNet.Test.DotNetTestSettings)">
<summary>
Test project with settings.
</summary>
<param name="context">The context.</param>
<param name="project">The project path.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetTestSettings
{
Configuration = "Release"
};
DotNetTest("./test/Project.Tests/Project.Tests.csproj", settings);
</code>
<para>You could also specify a task that runs multiple test projects.</para>
<para>Cake task:</para>
<code>
Task("Test")
.Does(() =>
{
var settings = new DotNetTestSettings
{
Configuration = "Release"
};
var projectFiles = GetFiles("./test/**/*.csproj");
foreach(var file in projectFiles)
{
DotNetTest(file.FullPath, settings);
}
});
</code>
<para>If your test project is using project.json, the project parameter should just be the directory path.</para>
<code>
var settings = new DotNetTestSettings
{
Configuration = "Release"
};
DotNetTest("./test/Project.Tests/", settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetTest(Cake.Core.ICakeContext,System.String,Cake.Core.IO.ProcessArgumentBuilder,Cake.Common.Tools.DotNet.Test.DotNetTestSettings)">
<summary>
Test project with settings.
</summary>
<param name="context">The context.</param>
<param name="project">The project path.</param>
<param name="arguments">The arguments.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetTestSettings
{
Configuration = "Release"
};
DotNetTest("./test/Project.Tests/Project.Tests.csproj", settings);
</code>
<para>You could also specify a task that runs multiple test projects.</para>
<para>Cake task:</para>
<code>
Task("Test")
.Does(() =>
{
var settings = new DotNetTestSettings
{
Configuration = "Release"
};
var projectFiles = GetFiles("./test/**/*.csproj");
foreach(var file in projectFiles)
{
DotNetTest(file.FullPath, "MSTest.MapInconclusiveToFailed=true", settings);
}
});
</code>
<para>If your test project is using project.json, the project parameter should just be the directory path.</para>
<code>
var settings = new DotNetTestSettings
{
Configuration = "Release"
};
DotNetTest("./test/Project.Tests/", "MSTest.MapInconclusiveToFailed=true", settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetClean(Cake.Core.ICakeContext,System.String)">
<summary>
Cleans a project's output.
</summary>
<param name="context">The context.</param>
<param name="project">The project's path.</param>
<example>
<code>
DotNetClean("./src/project");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetClean(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.DotNet.Clean.DotNetCleanSettings)">
<summary>
Cleans a project's output.
</summary>
<param name="context">The context.</param>
<param name="project">The projects path.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetCleanSettings
{
Framework = "netcoreapp2.0",
Configuration = "Debug",
OutputDirectory = "./artifacts/"
};
DotNetClean("./src/project", settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetNuGetDelete(Cake.Core.ICakeContext)">
<summary>
Delete a NuGet Package from a server.
</summary>
<param name="context">The context.</param>
<example>
<code>
DotNetNuGetDelete();
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetNuGetDelete(Cake.Core.ICakeContext,System.String)">
<summary>
Deletes a package from nuget.org.
</summary>
<param name="context">The context.</param>
<param name="packageName">Name of package to delete.</param>
<example>
<code>
DotNetNuGetDelete("Microsoft.AspNetCore.Mvc");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetNuGetDelete(Cake.Core.ICakeContext,System.String,System.String)">
<summary>
Deletes a specific version of a package from nuget.org.
</summary>
<param name="context">The context.</param>
<param name="packageName">Name of package to delete.</param>
<param name="packageVersion">Version of package to delete.</param>
<example>
<code>
DotNetRestore("Microsoft.AspNetCore.Mvc", "1.0");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetNuGetDelete(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.DotNet.NuGet.Delete.DotNetNuGetDeleteSettings)">
<summary>
Deletes a package from a server.
</summary>
<param name="context">The context.</param>
<param name="packageName">Name of package to delete.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetNuGetDeleteSettings
{
Source = "https://www.example.com/nugetfeed",
NonInteractive = true
};
DotNetNuGetDelete("Microsoft.AspNetCore.Mvc", settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetNuGetDelete(Cake.Core.ICakeContext,Cake.Common.Tools.DotNet.NuGet.Delete.DotNetNuGetDeleteSettings)">
<summary>
Deletes a package from a server using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetNuGetDeleteSettings
{
Source = "https://www.example.com/nugetfeed",
NonInteractive = true
};
DotNetNuGetDelete(settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetNuGetDelete(Cake.Core.ICakeContext,System.String,System.String,Cake.Common.Tools.DotNet.NuGet.Delete.DotNetNuGetDeleteSettings)">
<summary>
Deletes a package from a server using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="packageName">Name of package to delete.</param>
<param name="packageVersion">Version of package to delete.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetNuGetDeleteSettings
{
Source = "https://www.example.com/nugetfeed",
NonInteractive = true
};
DotNetNuGetDelete("Microsoft.AspNetCore.Mvc", "1.0", settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetNuGetPush(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Pushes one or more packages to a server.
</summary>
<param name="context">The context.</param>
<param name="packageFilePath"><see cref="T:Cake.Core.IO.FilePath"/> of the package to push.</param>
<example>
<code>
// With FilePath instance
var packageFilePath = GetFiles("*.nupkg").Single();
DotNetNuGetPush(packageFilePath);
// With string parameter
DotNetNuGetPush("foo*.nupkg");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetNuGetPush(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Common.Tools.DotNet.NuGet.Push.DotNetNuGetPushSettings)">
<summary>
Pushes one or more packages to a server using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="packageFilePath"><see cref="T:Cake.Core.IO.FilePath"/> of the package to push.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetNuGetPushSettings
{
Source = "https://www.example.com/nugetfeed",
ApiKey = "4003d786-cc37-4004-bfdf-c4f3e8ef9b3a"
};
// With FilePath instance
var packageFilePath = GetFiles("foo*.nupkg").Single();
DotNetNuGetPush(packageFilePath);
// With string parameter
DotNetNuGetPush("foo*.nupkg", settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetNuGetAddSource(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.DotNet.NuGet.Source.DotNetNuGetSourceSettings)">
<summary>
Add the specified NuGet source.
</summary>
<param name="context">The context.</param>
<param name="name">The name of the source.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetNuGetSourceSettings
{
Source = "https://www.example.com/nugetfeed",
UserName = "username",
Password = "password",
StorePasswordInClearText = true,
ValidAuthenticationTypes = "basic,negotiate"
};
DotNetNuGetAddSource("example", settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetNuGetDisableSource(Cake.Core.ICakeContext,System.String)">
<summary>
Disable the specified NuGet source.
</summary>
<param name="context">The context.</param>
<param name="name">The name of the source.</param>
<example>
<code>
DotNetNuGetDisableSource("example");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetNuGetDisableSource(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.DotNet.NuGet.Source.DotNetNuGetSourceSettings)">
<summary>
Disable the specified NuGet source.
</summary>
<param name="context">The context.</param>
<param name="name">The name of the source.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetNuGetSourceSettings
{
ConfigFile = "NuGet.config"
};
DotNetNuGetDisableSource("example", settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetNuGetEnableSource(Cake.Core.ICakeContext,System.String)">
<summary>
Enable the specified NuGet source.
</summary>
<param name="context">The context.</param>
<param name="name">The name of the source.</param>
<example>
<code>
DotNetNuGetEnableSource("example");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetNuGetEnableSource(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.DotNet.NuGet.Source.DotNetNuGetSourceSettings)">
<summary>
Enable the specified NuGet source.
</summary>
<param name="context">The context.</param>
<param name="name">The name of the source.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetNuGetSourceSettings
{
ConfigFile = "NuGet.config"
};
DotNetNuGetEnableSource("example", settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetNuGetHasSource(Cake.Core.ICakeContext,System.String)">
<summary>
Determines whether the specified NuGet source exists.
</summary>
<param name="context">The context.</param>
<param name="name">The name of the source.</param>
<returns>Whether the specified NuGet source exists.</returns>
<example>
<code>
var exists = DotNetNuGetHasSource("example");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetNuGetHasSource(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.DotNet.NuGet.Source.DotNetNuGetSourceSettings)">
<summary>
Determines whether the specified NuGet source exists.
</summary>
<param name="context">The context.</param>
<param name="name">The name of the source.</param>
<param name="settings">The settings.</param>
<returns>Whether the specified NuGet source exists.</returns>
<example>
<code>
var settings = new DotNetNuGetSourceSettings
{
ConfigFile = "NuGet.config"
};
var exists = DotNetNuGetHasSource("example", settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetNuGetRemoveSource(Cake.Core.ICakeContext,System.String)">
<summary>
Remove the specified NuGet source.
</summary>
<param name="context">The context.</param>
<param name="name">The name of the source.</param>
<example>
<code>
DotNetNuGetRemoveSource("example");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetNuGetRemoveSource(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.DotNet.NuGet.Source.DotNetNuGetSourceSettings)">
<summary>
Remove the specified NuGet source.
</summary>
<param name="context">The context.</param>
<param name="name">The name of the source.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetNuGetSourceSettings
{
ConfigFile = "NuGet.config"
};
DotNetNuGetRemoveSource("example", settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetNuGetUpdateSource(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.DotNet.NuGet.Source.DotNetNuGetSourceSettings)">
<summary>
Update the specified NuGet source.
</summary>
<param name="context">The context.</param>
<param name="name">The name of the source.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetNuGetSourceSettings
{
Source = "https://www.example.com/nugetfeed",
UserName = "username",
Password = "password",
StorePasswordInClearText = true,
ValidAuthenticationTypes = "basic,negotiate"
};
DotNetNuGetUpdateSource("example", settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetPack(Cake.Core.ICakeContext,System.String)">
<summary>
Package all projects.
</summary>
<param name="context">The context.</param>
<param name="project">The projects path.</param>
<example>
<code>
DotNetPack("./src/*");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetPack(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.DotNet.Pack.DotNetPackSettings)">
<summary>
Package all projects.
</summary>
<param name="context">The context.</param>
<param name="project">The projects path.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetPackSettings
{
Configuration = "Release",
OutputDirectory = "./artifacts/"
};
DotNetPack("./src/*", settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetRun(Cake.Core.ICakeContext)">
<summary>
Run all projects.
</summary>
<param name="context">The context.</param>
<example>
<code>
DotNetRun();
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetRun(Cake.Core.ICakeContext,System.String)">
<summary>
Run project.
</summary>
<param name="context">The context.</param>
<param name="project">The project path.</param>
<example>
<code>
DotNetRun("./src/Project");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetRun(Cake.Core.ICakeContext,System.String,Cake.Core.IO.ProcessArgumentBuilder)">
<summary>
Run project with path and arguments.
</summary>
<param name="context">The context.</param>
<param name="project">The project path.</param>
<param name="arguments">The arguments.</param>
<example>
<code>
DotNetRun("./src/Project", "--args");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetRun(Cake.Core.ICakeContext,System.String,Cake.Core.IO.ProcessArgumentBuilder,Cake.Common.Tools.DotNet.Run.DotNetRunSettings)">
<summary>
Run project with settings.
</summary>
<param name="context">The context.</param>
<param name="project">The project path.</param>
<param name="arguments">The arguments.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetRunSettings
{
Framework = "netcoreapp2.0",
Configuration = "Release"
};
DotNetRun("./src/Project", "--args", settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetRun(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.DotNet.Run.DotNetRunSettings)">
<summary>
Run project with settings.
</summary>
<param name="context">The context.</param>
<param name="project">The project path.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetRunSettings
{
Framework = "netcoreapp2.0",
Configuration = "Release"
};
DotNetRun("./src/Project", settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetMSBuild(Cake.Core.ICakeContext)">
<summary>
Builds the specified targets in a project file found in the current working directory.
</summary>
<param name="context">The context.</param>
<example>
<code>
DotNetMSBuild();
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetMSBuild(Cake.Core.ICakeContext,System.String)">
<summary>
Builds the specified targets in the project file.
</summary>
<param name="context">The context.</param>
<param name="projectOrDirectory">Project file or directory to search for project file.</param>
<example>
<code>
DotNetMSBuild("foobar.proj");
</code>
</example>
<remarks>
If a directory is specified, MSBuild searches that directory for a project file.
</remarks>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetMSBuild(Cake.Core.ICakeContext,Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings)">
<summary>
Builds the specified targets in a project file found in the current working directory.
</summary>
<param name="context">The context.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetMSBuildSettings
{
NoLogo = true,
MaxCpuCount = -1
};
DotNetMSBuild(settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetMSBuild(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings)">
<summary>
Builds the specified targets in the project file.
</summary>
<param name="context">The context.</param>
<param name="projectOrDirectory">Project file or directory to search for project file.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetMSBuildSettings
{
NoLogo = true,
MaxCpuCount = -1
};
DotNetMSBuild("foobar.proj", settings);
</code>
</example>
<remarks>
If a project file is not specified, MSBuild searches the current working directory for a file that has a file
extension that ends in "proj" and uses that file. If a directory is specified, MSBuild searches that directory for a project file.
</remarks>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetVSTest(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern)">
<summary>
Test one or more projects specified by a path or glob pattern using the VS Test host runner.
</summary>
<param name="context">The context.</param>
<param name="testFile">A path to the test file or glob for one or more test files.</param>
<example>
<para>Specify the path to the .csproj file in the test project.</para>
<code>
DotNetVSTest("./test/Project.Tests/bin/Release/netcoreapp2.1/Project.Tests.dll");
</code>
<para>You could also specify a glob pattern to run multiple test projects.</para>
<code>
DotNetVSTest("./**/bin/Release/netcoreapp2.1/*.Tests.dll");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetVSTest(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern,Cake.Common.Tools.DotNet.VSTest.DotNetVSTestSettings)">
<summary>
Test one or more projects specified by a path or glob pattern with settings using the VS Test host runner.
</summary>
<param name="context">The context.</param>
<param name="testFile">A path to the test file or glob for one or more test files.</param>
<param name="settings">The settings.</param>
<example>
<para>Specify the path to the .csproj file in the test project.</para>
<code>
var settings = new DotNetVSTestSettings
{
Framework = "FrameworkCore10",
Platform = "x64"
};
DotNetTest("./test/Project.Tests/bin/Release/netcoreapp2.1/Project.Tests.dll", settings);
</code>
<para>You could also specify a glob pattern to run multiple test projects.</para>
<code>
var settings = new DotNetVSTestSettings
{
Framework = "FrameworkCore10",
Platform = "x64",
Parallel = true
};
DotNetVSTest("./**/bin/Release/netcoreapp2.1/*.Tests.dll", settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetVSTest(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.DotNet.VSTest.DotNetVSTestSettings)">
<summary>
Test one or more specified projects with settings using the VS Test host runner.
</summary>
<param name="context">The context.</param>
<param name="testFiles">The project paths to test.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetVSTestSettings
{
Framework = "FrameworkCore10",
Platform = "x64"
};
DotNetVSTest(new[] { (FilePath)"./test/Project.Tests/bin/Release/netcoreapp2.1/Project.Tests.dll" }, settings);
</code>
<para>You could also specify a task that runs multiple test projects.</para>
<para>Cake task:</para>
<code>
Task("Test")
.Does(() =>
{
var settings = new DotNetVSTestSettings
{
Framework = "FrameworkCore10",
Platform = "x64",
Parallel = true
};
var testFiles = GetFiles("./test/**/bin/Release/netcoreapp2.1/*.Test.dll");
DotNetVSTest(testFiles, settings);
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetTool(Cake.Core.ICakeContext,System.String)">
<summary>
Execute an .NET Core Extensibility Tool.
</summary>
<param name="context">The context.</param>
<param name="command">The command to execute.</param>
<example>
<code>
DotNetTool("cake");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetTool(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.DotNet.Tool.DotNetToolSettings)">
<summary>
Execute an .NET Core Extensibility Tool.
</summary>
<param name="context">The context.</param>
<param name="command">The command to execute.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetToolSettings
{
DiagnosticOutput = true
};
DotNetTool("cake", settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetTool(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,System.String)">
<summary>
Execute an .NET Core Extensibility Tool.
</summary>
<param name="context">The context.</param>
<param name="projectPath">The project path.</param>
<param name="command">The command to execute.</param>
<example>
<code>
DotNetTool("./src/project", "xunit", "-xml report.xml");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetTool(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,System.String,Cake.Core.IO.ProcessArgumentBuilder)">
<summary>
Execute an .NET Core Extensibility Tool.
</summary>
<param name="context">The context.</param>
<param name="projectPath">The project path.</param>
<param name="command">The command to execute.</param>
<param name="arguments">The arguments.</param>
<example>
<code>
DotNetTool("./src/project", "xunit", "-xml report.xml");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetTool(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,System.String,Cake.Core.IO.ProcessArgumentBuilder,Cake.Common.Tools.DotNet.Tool.DotNetToolSettings)">
<summary>
Execute an .NET Core Extensibility Tool.
</summary>
<param name="context">The context.</param>
<param name="projectPath">The project path.</param>
<param name="command">The command to execute.</param>
<param name="arguments">The arguments.</param>
<param name="settings">The settings.</param>
<example>
<code>
DotNetTool("./src/project", "xunit", "-xml report.xml");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetBuildServerShutdown(Cake.Core.ICakeContext)">
<summary>
Shuts down build servers that are started from dotnet.
</summary>
<param name="context">The context.</param>
<example>
<code>
DotNetBuildServerShutdown();
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetBuildServerShutdown(Cake.Core.ICakeContext,Cake.Common.Tools.DotNet.BuildServer.DotNetBuildServerShutdownSettings)">
<summary>
Shuts down build servers that are started from dotnet.
</summary>
<param name="context">The context.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetBuildServerShutdownSettings
{
MSBuild = true
};
DotNetBuildServerShutdown(settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetFormat(Cake.Core.ICakeContext,System.String)">
<summary>
Formats code to match editorconfig settings.
</summary>
<param name="context">The context.</param>
<param name="root">The project or solution path.</param>
<example>
<code>
DotNetFormat("./src/project");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetFormat(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.DotNet.Format.DotNetFormatSettings)">
<summary>
Formats code to match editorconfig settings.
</summary>
<param name="context">The context.</param>
<param name="root">The project or solution path.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetFormatSettings
{
NoRestore = true,
Include = "Program.cs Utility\Logging.cs",
Severity = DotNetFormatSeverity.Error
};
DotNetFormat("./src/project", settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetFormatWhitespace(Cake.Core.ICakeContext,System.String)">
<summary>
Format code to match editorconfig settings for whitespace.
</summary>
<param name="context">The context.</param>
<param name="root">The project or solution path.</param>
<example>
<code>
DotNetFormatWhitespace("./src/*");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetFormatWhitespace(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.DotNet.Format.DotNetFormatSettings)">
<summary>
Format code to match editorconfig settings for whitespace.
</summary>
<param name="context">The context.</param>
<param name="root">The project or solution path.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetFormatSettings
{
NoRestore = true,
Include = "Program.cs Utility\Logging.cs"
};
DotNetFormatWhitespace("./src/*", settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetFormatStyle(Cake.Core.ICakeContext,System.String)">
<summary>
Format code to match editorconfig settings for code style.
</summary>
<param name="context">The context.</param>
<param name="root">The project or solution path.</param>
<example>
<code>
DotNetFormatStyle("./src/*");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetFormatStyle(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.DotNet.Format.DotNetFormatSettings)">
<summary>
Format code to match editorconfig settings for code style.
</summary>
<param name="context">The context.</param>
<param name="root">The project or solution path.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetFormatSettings
{
NoRestore = true,
Include = "Program.cs Utility\Logging.cs"
};
DotNetFormatStyle("./src/*", settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetFormatAnalyzers(Cake.Core.ICakeContext,System.String)">
<summary>
Format code to match editorconfig settings for analyzers.
</summary>
<param name="context">The context.</param>
<param name="project">The project or solution path.</param>
<example>
<code>
DotNetFormatAnalyzers("./src/*");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetFormatAnalyzers(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.DotNet.Format.DotNetFormatSettings)">
<summary>
Format code to match editorconfig settings for analyzers.
</summary>
<param name="context">The context.</param>
<param name="root">The project or solution path.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetFormatSettings
{
NoRestore = true,
Include = "Program.cs Utility\Logging.cs"
};
DotNetFormatAnalyzers("./src/*", settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetSDKCheck(Cake.Core.ICakeContext)">
<summary>
Lists the latest available version of the .NET SDK and .NET Runtime.
</summary>
<param name="context">The context.</param>
<example>
<code>
DotNetSDKCheck();
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetWorkloadSearch(Cake.Core.ICakeContext)">
<summary>
Lists available workloads.
</summary>
<param name="context">The context.</param>
<returns>The list of available workloads.</returns>
<example>
<code>
var workloads = DotNetWorkloadSearch();
foreach (var workload in workloads)
{
Information($"Id: {workload.Id}, Description: {workload.Description}");
}
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetWorkloadSearch(Cake.Core.ICakeContext,System.String)">
<summary>
Lists available workloads by specifying all or part of the workload ID.
</summary>
<param name="context">The context.</param>
<param name="searchString">The workload ID to search for, or part of it.</param>
<returns>The list of available workloads.</returns>
<example>
<code>
var workloads = DotNetWorkloadSearch("maui");
foreach (var workload in workloads)
{
Information($"Id: {workload.Id}, Description: {workload.Description}");
}
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetWorkloadSearch(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.DotNet.Workload.Search.DotNetWorkloadSearchSettings)">
<summary>
Lists available workloads by specifying all or part of the workload ID.
</summary>
<param name="context">The context.</param>
<param name="searchString">The workload ID to search for, or part of it.</param>
<param name="settings">The settings.</param>
<returns>The list of available workloads.</returns>
<example>
<code>
var settings = new DotNetWorkloadSearchSettings
{
DotNetVerbosity.Detailed
};
var workloads = DotNetWorkloadSearch("maui", settings);
foreach (var workload in workloads)
{
Information($"Id: {workload.Id}, Description: {workload.Description}");
}
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetWorkloadUninstall(Cake.Core.ICakeContext,System.String)">
<summary>
Uninstalls a specified workload.
</summary>
<param name="context">The context.</param>
<param name="workloadId">The workload ID to uninstall.</param>
<example>
<code>
DotNetWorkloadUninstall("maui");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetWorkloadUninstall(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{System.String})">
<summary>
Uninstalls one or more workloads.
</summary>
<param name="context">The context.</param>
<param name="workloadIds">The workload ID or multiple IDs to uninstall.</param>
<example>
<code>
DotNetWorkloadUninstall(new string[] { "maui", "maui-desktop", "maui-mobile" });
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetWorkloadInstall(Cake.Core.ICakeContext,System.String)">
<summary>
Installs a specified optional workload.
</summary>
<param name="context">The context.</param>
<param name="workloadId">The workload ID to install.</param>
<example>
<code>
DotNetWorkloadInstall("maui");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetWorkloadInstall(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.DotNet.Workload.Install.DotNetWorkloadInstallSettings)">
<summary>
Installs a specified optional workload.
</summary>
<param name="context">The context.</param>
<param name="workloadId">The workload ID to install.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetWorkloadInstallSettings
{
IncludePreviews = true,
NoCache = true
};
DotNetWorkloadInstall("maui", settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetWorkloadInstall(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{System.String})">
<summary>
Installs one or more optional workloads.
</summary>
<param name="context">The context.</param>
<param name="workloadIds">The workload ID or multiple IDs to install.</param>
<example>
<code>
DotNetWorkloadInstall(new string[] { "maui", "maui-desktop", "maui-mobile" });
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetWorkloadInstall(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{System.String},Cake.Common.Tools.DotNet.Workload.Install.DotNetWorkloadInstallSettings)">
<summary>
Installs one or more optional workloads.
</summary>
<param name="context">The context.</param>
<param name="workloadIds">The workload ID or multiple IDs to install.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetWorkloadInstallSettings
{
IncludePreviews = true,
NoCache = true
};
DotNetWorkloadInstall(new string[] { "maui", "maui-desktop", "maui-mobile" }, settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetWorkloadList(Cake.Core.ICakeContext)">
<summary>
Lists all installed workloads.
</summary>
<param name="context">The context.</param>
<returns>The list of installed workloads.</returns>
<example>
<code>
var workloadIds = DotNetWorkloadList();
foreach (var workloadId in workloadIds)
{
Information($"Installed Workload Id: {workloadId}");
}
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetWorkloadList(Cake.Core.ICakeContext,Cake.Common.Tools.DotNet.Workload.List.DotNetWorkloadListSettings)">
<summary>
Lists all installed workloads.
</summary>
<param name="context">The context.</param>
<param name="settings">The settings.</param>
<returns>The list of installed workloads.</returns>
<example>
<code>
var settings = new DotNetWorkloadListSettings
{
Verbosity = DotNetVerbosity.Detailed
};
var workloads = DotNetWorkloadList(settings);
foreach (var workload in workloads)
{
Information($"Installed Workload Id: {workload.Id}\t Manifest Version: {workload.ManifestVersion}\t Installation Source: {workload.InstallationSource}");
}
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetWorkloadRepair(Cake.Core.ICakeContext)">
<summary>
Repairs all workloads installations.
</summary>
<param name="context">The context.</param>
<example>
<code>
DotNetWorkloadRepair();
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetWorkloadRepair(Cake.Core.ICakeContext,Cake.Common.Tools.DotNet.Workload.Repair.DotNetWorkloadRepairSettings)">
<summary>
Repairs all workloads installations.
</summary>
<param name="context">The context.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetWorkloadRepairSettings
{
IncludePreviews = true,
NoCache = true
};
DotNetWorkloadRepair(settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetWorkloadUpdate(Cake.Core.ICakeContext)">
<summary>
Updates all installed workloads to the newest available version.
</summary>
<param name="context">The context.</param>
<example>
<code>
DotNetWorkloadUpdate();
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetWorkloadUpdate(Cake.Core.ICakeContext,Cake.Common.Tools.DotNet.Workload.Update.DotNetWorkloadUpdateSettings)">
<summary>
Updates all installed workloads to the newest available version.
</summary>
<param name="context">The context.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetWorkloadUpdateSettings
{
IncludePreviews = true,
NoCache = true
};
DotNetWorkloadUpdate(settings);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetWorkloadRestore(Cake.Core.ICakeContext,System.String)">
<summary>
Installs workloads needed for a project or a solution.
</summary>
<param name="context">The context.</param>
<param name="project">The project or solution file to install workloads for.</param>
<example>
<code>
DotNetWorkloadRestore("./src/project");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetAliases.DotNetWorkloadRestore(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.DotNet.Workload.Restore.DotNetWorkloadRestoreSettings)">
<summary>
Installs workloads needed for a project or a solution.
</summary>
<param name="context">The context.</param>
<param name="project">The project or solution file to install workloads for.</param>
<param name="settings">The settings.</param>
<example>
<code>
var settings = new DotNetWorkloadRestoreSettings
{
IncludePreviews = true,
NoCache = true
};
DotNetWorkloadRestore("./src/project", settings);
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.DotNet.DotNetRollForward">
<summary>
Contains the roll forward policy to be used.
</summary>
</member>
<member name="F:Cake.Common.Tools.DotNet.DotNetRollForward.Minor">
<summary>
Roll forward to the lowest higher minor version, if requested minor version is missing.
</summary>
</member>
<member name="F:Cake.Common.Tools.DotNet.DotNetRollForward.LatestPatch">
<summary>
Roll forward to the highest patch version. This disables minor version roll forward.
</summary>
</member>
<member name="F:Cake.Common.Tools.DotNet.DotNetRollForward.Major">
<summary>
Roll forward to lowest higher major version, and lowest minor version, if requested major version is missing.
</summary>
</member>
<member name="F:Cake.Common.Tools.DotNet.DotNetRollForward.LatestMinor">
<summary>
Roll forward to highest minor version, even if requested minor version is present.
</summary>
</member>
<member name="F:Cake.Common.Tools.DotNet.DotNetRollForward.LatestMajor">
<summary>
Roll forward to highest major and highest minor version, even if requested major is present.
</summary>
</member>
<member name="F:Cake.Common.Tools.DotNet.DotNetRollForward.Disable">
<summary>
Don't roll forward. Only bind to specified version.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNet.DotNetSettings">
<summary>
Contains common settings used by <see cref="T:Cake.Common.Tools.DotNet.DotNetTool`1" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.DotNetSettings.Verbosity">
<summary>
Gets or sets the verbosity of logging to use.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.DotNetSettings.DiagnosticOutput">
<summary>
Gets or sets a value indicating whether to not enable diagnostic output.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.DotNetSettings.RollForward">
<summary>
Gets or sets the dotnet roll forward policy.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNet.DotNetTool`1">
<summary>
Base class for all .NET Core related tools.
</summary>
<typeparam name="TSettings">The settings type.</typeparam>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetTool`1.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotNet.DotNetTool`1" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetTool`1.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetTool`1.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetTool`1.RunCommand(`0,Cake.Core.IO.ProcessArgumentBuilder)">
<summary>
Runs the dotnet cli command using the specified settings and arguments.
</summary>
<param name="settings">The settings.</param>
<param name="arguments">The arguments.</param>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetTool`1.RunCommand(`0,Cake.Core.IO.ProcessArgumentBuilder,Cake.Core.IO.ProcessSettings)">
<summary>
Runs the dotnet cli command using the specified settings and arguments.
</summary>
<param name="settings">The settings.</param>
<param name="arguments">The arguments.</param>
<param name="processSettings">The processSettings.</param>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetTool`1.RunCommand(`0,Cake.Core.IO.ProcessArgumentBuilder,Cake.Core.IO.ProcessSettings,System.Action{Cake.Core.IO.IProcess})">
<summary>
Runs the dotnet cli command using the specified settings and arguments.
</summary>
<param name="settings">The settings.</param>
<param name="arguments">The arguments.</param>
<param name="processSettings">The processSettings.</param>
<param name="postAction">If specified called after process exit.</param>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetTool`1.CreateArgumentBuilder(`0)">
<summary>
Creates a <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> and adds common commandline arguments.
</summary>
<param name="settings">The settings.</param>
<returns>Instance of <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/>.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNet.DotNetTool`1.AppendCommonArguments(Cake.Core.IO.ProcessArgumentBuilder,`0)">
<summary>
Adds common commandline arguments.
</summary>
<param name="builder">Process argument builder to update.</param>
<param name="settings">The settings.</param>
<returns>Returns <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> updated with common commandline arguments.</returns>
</member>
<member name="T:Cake.Common.Tools.DotNet.DotNetVerbosity">
<summary>
Contains the verbosity of logging to use.
</summary>
</member>
<member name="F:Cake.Common.Tools.DotNet.DotNetVerbosity.Quiet">
<summary>
Quiet level.
</summary>
</member>
<member name="F:Cake.Common.Tools.DotNet.DotNetVerbosity.Minimal">
<summary>
Minimal level.
</summary>
</member>
<member name="F:Cake.Common.Tools.DotNet.DotNetVerbosity.Normal">
<summary>
Normal level.
</summary>
</member>
<member name="F:Cake.Common.Tools.DotNet.DotNetVerbosity.Detailed">
<summary>
Detailed level.
</summary>
</member>
<member name="F:Cake.Common.Tools.DotNet.DotNetVerbosity.Diagnostic">
<summary>
Diagnostic level.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNet.Execute.DotNetExecuteSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotNet.Execute.DotNetExecutor" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Execute.DotNetExecuteSettings.FrameworkVersion">
<summary>
Gets or sets the version of the installed Shared Framework to use to run the application.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNet.Execute.DotNetExecutor">
<summary>
.NET assembly executor.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotNet.Execute.DotNetExecutor.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotNet.Execute.DotNetExecutor" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.DotNet.Execute.DotNetExecutor.Execute(Cake.Core.IO.FilePath,Cake.Core.IO.ProcessArgumentBuilder,Cake.Common.Tools.DotNet.Execute.DotNetExecuteSettings)">
<summary>
Execute an assembly using arguments and settings.
</summary>
<param name="assemblyPath">The assembly path.</param>
<param name="arguments">The arguments.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.DotNet.Format.DotNetFormatSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotNet.Format.DotNetFormatter" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Format.DotNetFormatSettings.Diagnostics">
<summary>
Gets or sets a space-separated list of diagnostic IDs to use as a filter when fixing code style or third-party issues.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Format.DotNetFormatSettings.Severity">
<summary>
Gets or sets the minimum severity of diagnostics to fix.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Format.DotNetFormatSettings.NoRestore">
<summary>
Gets or sets a value indicating whether to not do implicit NuGet package restore.
This makes build faster, but requires restore to be done before build is executed.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Format.DotNetFormatSettings.VerifyNoChanges">
<summary>
Gets or sets a value indicating whether to verify that no formatting changes would be performed.
Terminates with a non zero exit code if any files would have been formatted.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Format.DotNetFormatSettings.Include">
<summary>
Gets or sets a space-separated list of relative file or folder paths to include in formatting.
All files in the solution or project are formatted if empty.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Format.DotNetFormatSettings.Exclude">
<summary>
Gets or sets a space-separated list of relative file or folder paths to exclude from formatting. The default is none.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Format.DotNetFormatSettings.IncludeGenerated">
<summary>
Gets or sets a value indicating whether to format files generated by the SDK.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Format.DotNetFormatSettings.BinaryLog">
<summary>
Gets or sets a value indicating whether to log all project or solution load information to a binary log file.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Format.DotNetFormatSettings.Report">
<summary>
Gets or sets a path to a JSON report.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNet.Format.DotNetFormatSeverity">
<summary>
Severity of dotnet format.
</summary>
</member>
<member name="F:Cake.Common.Tools.DotNet.Format.DotNetFormatSeverity.Info">
<summary>
Information
</summary>
</member>
<member name="F:Cake.Common.Tools.DotNet.Format.DotNetFormatSeverity.Warning">
<summary>
Warning
</summary>
</member>
<member name="F:Cake.Common.Tools.DotNet.Format.DotNetFormatSeverity.Error">
<summary>
Error
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNet.Format.DotNetFormatter">
<summary>
.NET project formatter.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotNet.Format.DotNetFormatter.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotNet.Format.DotNetFormatter" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.DotNet.Format.DotNetFormatter.Format(System.String,System.String,Cake.Common.Tools.DotNet.Format.DotNetFormatSettings)">
<summary>
Format the project or solution using the specified path and settings.
</summary>
<param name="root">The target project or solution path.</param>
<param name="subcommand">The sub command.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildBuilder">
<summary>
.NET Core project builder.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildBuilder.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildBuilder" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildBuilder.Build(System.String,Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings)">
<summary>
Build the project using the specified path and settings.
</summary>
<param name="projectOrDirectory">The target project path.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildBuilder" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings.DetailedSummary">
<summary>
Gets or sets a value indicating whether to show detailed information at the end of the build log about the configurations that were built and how they were scheduled to nodes.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings.IgnoreProjectExtensions">
<summary>
Gets or sets extensions to ignore when determining which project file to build.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings.MaxCpuCount">
<summary>
Gets or sets the maximum number of concurrent processes to use when building.
</summary>
<remarks>
If you don't include this switch, the default value is 1. If you specifying a value that is zero or less, MSBuild will use up to the number of processors in the computer.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings.ExcludeAutoResponseFiles">
<summary>
Gets or sets a value indicating whether to exclude any MSBuild.rsp files automatically.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings.NoLogo">
<summary>
Gets or sets a value indicating whether to display the startup banner and the copyright message.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings.Version">
<summary>
Gets or sets the default value of all the version numbers embedded in the build output.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings.VersionPrefix">
<summary>
Gets or sets the base version number embedded in the build output.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings.VersionSuffix">
<summary>
Gets or sets the pre-release label of the version number embedded in the build output.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings.FileVersion">
<summary>
Gets or sets the file version number embedded in the build output.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings.AssemblyVersion">
<summary>
Gets or sets the assembly version number embedded in the build output.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings.InformationalVersion">
<summary>
Gets or sets the assembly informational version number embedded in the build output.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings.PackageVersion">
<summary>
Gets or sets the version number of the NuGet package generated.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings.PackageReleaseNotes">
<summary>
Gets or sets the release notes of the NuGet package generated.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings.ContinuousIntegrationBuild">
<summary>
Gets or sets a value indicating whether to normalize stored file paths used when producing deterministic builds.
</summary>
<remarks>
For more information see https://devblogs.microsoft.com/dotnet/producing-packages-with-source-link/#deterministic-builds.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings.Properties">
<summary>
Gets the project-level properties to set or override.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings.Targets">
<summary>
Gets the targets to build in the project.
</summary>
<remarks>
If you specify any targets, they are run instead of any targets in the DefaultTargets attribute in the project file.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings.ToolVersion">
<summary>
Gets or sets the version of the Toolset to use to build the project.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings.ValidateProjectFile">
<summary>
Gets or sets a value indicating whether to validate the project file and, if validation succeeds, build the project.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings.ResponseFiles">
<summary>
Gets the response files to use.
</summary>
<remarks>
A response file is a text file that is used to insert command-line switches. For more information see https://docs.microsoft.com/en-gb/visualstudio/msbuild/msbuild-response-files.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings.DistributedFileLogger">
<summary>
Gets or sets a value indicating whether to log the build output of each MSBuild node to its own file.
</summary>
<remarks>
The initial location for these files is the current directory. By default, the files are named "MSBuildNodeId.log". You can use the /fileLoggerParameters switch to specify the location of the files and other parameters for the fileLogger.
If you name a log file by using the /fileLoggerParameters switch, the distributed logger will use that name as a template and append the node ID to that name when creating a log file for each node.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings.DistributedLoggers">
<summary>
Gets the distributed loggers to use.
</summary>
<remarks>
A distributed logger consists of a central and forwarding logger. MSBuild will attach an instance of the forwarding logger to each secondary node.
For more information see https://msdn.microsoft.com/en-us/library/bb383987.aspx.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings.ConsoleLoggerSettings">
<summary>
Gets or sets the parameters for the console logger.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings.FileLoggers">
<summary>
Gets the file loggers to use.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings.BinaryLogger">
<summary>
Gets or sets the binary logging options.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings.Loggers">
<summary>
Gets the loggers to use to log events from MSBuild.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings.DisableConsoleLogger">
<summary>
Gets or sets a value indicating whether to disable the default console logger, and not log events to the console.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings.WarningCodesAsError">
<summary>
Gets the warning codes to treats as errors.
</summary>
<remarks>
When a warning is treated as an error the target will continue to execute as if it was a warning but the overall build will fail.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings.TreatAllWarningsAs">
<summary>
Gets or sets a value indicating how all warnings should be treated.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings.WarningCodesAsMessage">
<summary>
Gets the warning codes to treats as low importance messages.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings"/> class.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettingsExtensions">
<summary>
Contains functionality related to .NET MSBuild settings.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettingsExtensions.WithTarget(Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings,System.String)">
<summary>
Adds a MSBuild target to the configuration.
</summary>
<param name="settings">The settings.</param>
<param name="target">The MSBuild target.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
<remarks>Ignores a target if already added.</remarks>
</member>
<member name="M:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettingsExtensions.WithProperty(Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings,System.String,System.String[])">
<summary>
Adds a property to the configuration.
</summary>
<param name="settings">The settings.</param>
<param name="name">The property name.</param>
<param name="values">The property values.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettingsExtensions.ShowDetailedSummary(Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings)">
<summary>
Shows detailed information at the end of the build log about the configurations that were built and how they were scheduled to nodes.
</summary>
<param name="settings">The settings.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettingsExtensions.WithIgnoredProjectExtension(Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings,System.String)">
<summary>
Adds a extension to ignore when determining which project file to build.
</summary>
<param name="settings">The settings.</param>
<param name="extension">The extension to ignore.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettingsExtensions.SetMaxCpuCount(Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings,System.Nullable{System.Int32})">
<summary>
Sets the maximum CPU count. Without this set MSBuild will compile projects in this solution one at a time.
</summary>
<param name="settings">The settings.</param>
<param name="maxCpuCount">The maximum CPU count. Set this value to zero to use as many MSBuild processes as available CPUs.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettingsExtensions.ExcludeAutoResponseFiles(Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings)">
<summary>
Exclude any MSBuild.rsp files automatically.
</summary>
<param name="settings">The settings.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettingsExtensions.HideLogo(Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings)">
<summary>
Hide the startup banner and the copyright message.
</summary>
<param name="settings">The settings.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettingsExtensions.SetContinuousIntegrationBuild(Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings,System.Nullable{System.Boolean})">
<summary>
Sets a value indicating whether to normalize stored file paths used when producing deterministic builds.
</summary>
<remarks>
For more information see https://devblogs.microsoft.com/dotnet/producing-packages-with-source-link/#deterministic-builds.
</remarks>
<param name="settings">The settings.</param>
<param name="continuousIntegrationBuild">A value indicating whether to normalize stored file paths used when producing deterministic builds.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettingsExtensions.UseToolVersion(Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings,Cake.Common.Tools.MSBuild.MSBuildVersion)">
<summary>
Sets the version of the Toolset to use to build the project.
</summary>
<param name="settings">The settings.</param>
<param name="version">The version.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettingsExtensions.ValidateProjectFile(Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings)">
<summary>
Validate the project file and, if validation succeeds, build the project.
</summary>
<param name="settings">The settings.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettingsExtensions.WithResponseFile(Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings,Cake.Core.IO.FilePath)">
<summary>
Adds a response file to use.
</summary>
<param name="settings">The settings.</param>
<param name="responseFile">The response file to add.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
<remarks>
A response file is a text file that is used to insert command-line switches. For more information see https://docs.microsoft.com/en-gb/visualstudio/msbuild/msbuild-response-files.
</remarks>
</member>
<member name="M:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettingsExtensions.UseDistributedFileLogger(Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings)">
<summary>
Log the build output of each MSBuild node to its own file.
</summary>
<param name="settings">The settings.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettingsExtensions.WithDistributedLogger(Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings,Cake.Common.Tools.DotNet.MSBuild.MSBuildDistributedLogger)">
<summary>
Adds a distributed loggers to use.
</summary>
<param name="settings">The settings.</param>
<param name="logger">The response file to add.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
<remarks>
A distributed logger consists of a central and forwarding logger. MSBuild will attach an instance of the forwarding logger to each secondary node.
For more information see https://msdn.microsoft.com/en-us/library/bb383987.aspx.
</remarks>
</member>
<member name="M:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettingsExtensions.SetConsoleLoggerSettings(Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings,Cake.Common.Tools.DotNet.MSBuild.MSBuildLoggerSettings)">
<summary>
Sets the parameters for the console logger.
</summary>
<param name="settings">The settings.</param>
<param name="consoleLoggerParameters">The console logger parameters to set.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettingsExtensions.AddFileLogger(Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings)">
<summary>
Adds a file logger with all the default settings.
</summary>
<param name="settings">The settings.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
<remarks>
Each file logger will be declared in the order added.
The first file logger will match up to the /fl parameter.
The next nine (max) file loggers will match up to the /fl1 through /fl9 respectively.
</remarks>
</member>
<member name="M:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettingsExtensions.AddFileLogger(Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings,Cake.Common.Tools.DotNet.MSBuild.MSBuildFileLoggerSettings)">
<summary>
Adds a file logger.
</summary>
<param name="settings">The settings.</param>
<param name="fileLoggerParameters">Parameters to be passed to the logger.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
<remarks>
Each file logger will be declared in the order added.
The first file logger will match up to the /fl parameter.
The next nine (max) file loggers will match up to the /fl1 through /fl9 respectively.
</remarks>
</member>
<member name="M:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettingsExtensions.EnableBinaryLogger(Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings)">
<summary>
Enables the binary logger with all the default settings.
</summary>
<param name="settings">The settings.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettingsExtensions.EnableBinaryLogger(Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings,Cake.Common.Tools.DotNet.MSBuild.MSBuildBinaryLoggerImports)">
<summary>
Enables the binary logger with the specified imports and default file name.
</summary>
<param name="settings">The settings.</param>
<param name="imports">The imports.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettingsExtensions.EnableBinaryLogger(Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings,System.String)">
<summary>
Enables the binary logger with the specified log file name and no imports.
</summary>
<param name="settings">The settings.</param>
<param name="fileName">The log file name.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettingsExtensions.EnableBinaryLogger(Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings,System.String,Cake.Common.Tools.DotNet.MSBuild.MSBuildBinaryLoggerImports)">
<summary>
Enables the binary logger with the specified log file name and imports.
</summary>
<param name="settings">The settings.</param>
<param name="fileName">The log file name.</param>
<param name="imports">The imports.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettingsExtensions.WithLogger(Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings,System.String,System.String,System.String)">
<summary>
Adds a custom logger.
</summary>
<param name="settings">The settings.</param>
<param name="loggerAssembly">The assembly containing the logger. Should match the format {AssemblyName[,StrongName] | AssemblyFile}.</param>
<param name="loggerClass">The class implementing the logger. Should match the format [PartialOrFullNamespace.]LoggerClassName. If the assembly contains only one logger, class does not need to be specified.</param>
<param name="loggerParameters">Parameters to be passed to the logger.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettingsExtensions.DisableConsoleLogger(Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings)">
<summary>
Disables the default console logger, and not log events to the console.
</summary>
<param name="settings">The settings.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettingsExtensions.SetWarningCodeAsError(Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings,System.String)">
<summary>
Sets the warning code to treats as an error.
</summary>
<param name="settings">The settings.</param>
<param name="warningCode">The warning code to treat as an error.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
<remarks>
When a warning is treated as an error the target will continue to execute as if it was a warning but the overall build will fail.
</remarks>
</member>
<member name="M:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettingsExtensions.SetWarningCodeAsMessage(Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings,System.String)">
<summary>
Sets the warning code to treats as a message.
</summary>
<param name="settings">The settings.</param>
<param name="warningCode">The warning code to treat as a message.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettingsExtensions.TreatAllWarningsAs(Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings,Cake.Common.Tools.DotNet.MSBuild.MSBuildTreatAllWarningsAs)">
<summary>
Sets how all warnings should be treated.
</summary>
<param name="settings">The settings.</param>
<param name="behaviour">How all warning should be treated.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettingsExtensions.SetConfiguration(Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings,System.String)">
<summary>
Sets the configuration.
</summary>
<param name="settings">The settings.</param>
<param name="configuration">The configuration.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettingsExtensions.SetVersion(Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings,System.String)">
<summary>
Sets the version.
</summary>
<param name="settings">The settings.</param>
<param name="version">The version.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
<remarks>
Version will override VersionPrefix and VersionSuffix if set.
This may also override version settings during packaging.
</remarks>
</member>
<member name="M:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettingsExtensions.SetFileVersion(Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings,System.String)">
<summary>
Sets the file version.
</summary>
<param name="settings">The settings.</param>
<param name="fileVersion">The file version.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettingsExtensions.SetAssemblyVersion(Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings,System.String)">
<summary>
Sets the assembly version.
</summary>
<param name="settings">The settings.</param>
<param name="assemblyVersion">The assembly version.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettingsExtensions.SetInformationalVersion(Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings,System.String)">
<summary>
Sets the informational version.
</summary>
<param name="settings">The settings.</param>
<param name="informationalVersion">The informational version.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettingsExtensions.SetPackageVersion(Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings,System.String)">
<summary>
Sets the package version.
</summary>
<param name="settings">The settings.</param>
<param name="packageVersion">The package version.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettingsExtensions.SetPackageReleaseNotes(Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings,System.String)">
<summary>
Sets the package release notes.
</summary>
<param name="settings">The settings.</param>
<param name="packageReleaseNotes">The package release notes.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettingsExtensions.SuppressVersionRecommendedFormatWarning(Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings)">
<summary>
Suppress warning CS7035.
This is useful when using semantic versioning and either the file or informational version
doesn't match the recommended format.
The recommended format is: major.minor.build.revision where
each is an integer between 0 and 65534 (inclusive).
</summary>
<param name="settings">The settings.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettingsExtensions.SetVersionPrefix(Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings,System.String)">
<summary>
Sets the version prefix.
</summary>
<param name="settings">The settings.</param>
<param name="versionPrefix">The version prefix.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettingsExtensions.SetVersionSuffix(Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings,System.String)">
<summary>
Sets the version Suffix.
</summary>
<param name="settings">The settings.</param>
<param name="versionSuffix">The version prefix.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettingsExtensions.SetTargetFramework(Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings,System.String)">
<summary>
Adds a framework to target.
</summary>
<param name="settings">The settings.</param>
<param name="targetFramework">The framework to target.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
<remarks>
For list of target frameworks see https://docs.microsoft.com/en-us/dotnet/standard/frameworks.
</remarks>
</member>
<member name="M:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettingsExtensions.SetRuntime(Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings,System.String)">
<summary>
Sets a target operating systems where the application or assembly will run.
</summary>
<param name="settings">The settings.</param>
<param name="runtimeId">The runtime id of the operating system.</param>
<returns>The same <see cref="T:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings"/> instance so that multiple calls can be chained.</returns>
<remarks>
For list of runtime ids see https://docs.microsoft.com/en-us/dotnet/core/rid-catalog.
</remarks>
</member>
<member name="T:Cake.Common.Tools.DotNet.MSBuild.MSBuildArgumentBuilderExtensions">
<summary>
Contains functionality related to MSBuild arguments.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotNet.MSBuild.MSBuildArgumentBuilderExtensions.AppendMSBuildSettings(Cake.Core.IO.ProcessArgumentBuilder,Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings,Cake.Core.ICakeEnvironment)">
<summary>
Adds MSBuild arguments.
</summary>
<param name="builder">Argument builder.</param>
<param name="settings">MSBuild settings to add.</param>
<param name="environment">The environment.</param>
<exception cref="T:System.InvalidOperationException">Throws if 10 or more file loggers specified.</exception>
</member>
<member name="M:Cake.Common.Tools.DotNet.MSBuild.MSBuildArgumentBuilderExtensions.AppendMSBuildSettings(Cake.Core.IO.ProcessArgumentBuilder,Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings,Cake.Core.ICakeEnvironment,System.Boolean)">
<summary>
Adds MSBuild arguments.
</summary>
<param name="builder">Argument builder.</param>
<param name="settings">MSBuild settings to add.</param>
<param name="environment">The environment.</param>
<param name="invokeArgumentCustomization">The flag for if argument customization should be invoked.</param>
<exception cref="T:System.InvalidOperationException">Throws if 10 or more file loggers specified.</exception>
</member>
<member name="T:Cake.Common.Tools.DotNet.MSBuild.MSBuildBinaryLoggerImports">
<summary>
What files to include in the binary log.
</summary>
</member>
<member name="F:Cake.Common.Tools.DotNet.MSBuild.MSBuildBinaryLoggerImports.Unspecified">
<summary>Don't specify imports</summary>
</member>
<member name="F:Cake.Common.Tools.DotNet.MSBuild.MSBuildBinaryLoggerImports.None">
<summary>Do not collect project and imports files</summary>
</member>
<member name="F:Cake.Common.Tools.DotNet.MSBuild.MSBuildBinaryLoggerImports.Embed">
<summary>Embed in the binlog file</summary>
</member>
<member name="F:Cake.Common.Tools.DotNet.MSBuild.MSBuildBinaryLoggerImports.ZipFile">
<summary>Produce a separate .ProjectImports.zip</summary>
</member>
<member name="T:Cake.Common.Tools.DotNet.MSBuild.MSBuildBinaryLoggerSettings">
<summary>
MSBuild binary logger settings used by <see cref="T:Cake.Common.Tools.DotNet.MSBuild.DotNetMSBuildSettings"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.MSBuild.MSBuildBinaryLoggerSettings.Enabled">
<summary>
Gets or sets a value indicating whether binary logging should be enabled.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.MSBuild.MSBuildBinaryLoggerSettings.FileName">
<summary>
Gets or sets the output filename.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.MSBuild.MSBuildBinaryLoggerSettings.Imports">
<summary>
Gets or sets what source files should be included in the log.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNet.MSBuild.MSBuildConsoleColorType">
<summary>
Represents how the console color should behave in a console.
</summary>
</member>
<member name="F:Cake.Common.Tools.DotNet.MSBuild.MSBuildConsoleColorType.Normal">
<summary>
Use the normal console color behaviour.
</summary>
</member>
<member name="F:Cake.Common.Tools.DotNet.MSBuild.MSBuildConsoleColorType.Disabled">
<summary>
Use the default console color for all logging messages.
</summary>
</member>
<member name="F:Cake.Common.Tools.DotNet.MSBuild.MSBuildConsoleColorType.ForceAnsi">
<summary>
Use ANSI console colors even if console does not support it
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNet.MSBuild.MSBuildDistributedLogger">
<summary>
Represents the Distributed Logging Model with a central logger and forwarding logger.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.MSBuild.MSBuildDistributedLogger.CentralLogger">
<summary>
Gets or sets the logger to use as the central logger.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.MSBuild.MSBuildDistributedLogger.ForwardingLogger">
<summary>
Gets or sets the logger to use as the forwarding logger.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNet.MSBuild.MSBuildFileLoggerSettings">
<summary>
Represents the settings for a file logger.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.MSBuild.MSBuildFileLoggerSettings.LogFile">
<summary>
Gets or sets the path to the log file into which the build log is written.
</summary>
<remarks>
An empty string will use msbuild.log, in the current directory.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.MSBuild.MSBuildFileLoggerSettings.AppendToLogFile">
<summary>
Gets or sets a value indicating whether the build log is appended to the log file or overwrites it.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.MSBuild.MSBuildFileLoggerSettings.FileEncoding">
<summary>
Gets or sets the encoding for the file (for example, UTF-8, Unicode, or ASCII).
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNet.MSBuild.MSBuildLoggerOutputLevel">
<summary>
Represents the logging output level for a MSBuild logger.
</summary>
</member>
<member name="F:Cake.Common.Tools.DotNet.MSBuild.MSBuildLoggerOutputLevel.Default">
<summary>
Show the error and warning summary at the end.
</summary>
</member>
<member name="F:Cake.Common.Tools.DotNet.MSBuild.MSBuildLoggerOutputLevel.WarningsOnly">
<summary>
Show only warnings summary at the end.
</summary>
</member>
<member name="F:Cake.Common.Tools.DotNet.MSBuild.MSBuildLoggerOutputLevel.ErrorsOnly">
<summary>
Show only errors summary at the end.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNet.MSBuild.MSBuildLoggerSettings">
<summary>
Represents the common settings for a logger.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.MSBuild.MSBuildLoggerSettings.PerformanceSummary">
<summary>
Gets or sets a value indicating whether to show the time that’s spent in tasks, targets, and projects.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.MSBuild.MSBuildLoggerSettings.NoSummary">
<summary>
Gets or sets a value indicating whether to hide the error and warning summary at the end.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.MSBuild.MSBuildLoggerSettings.SummaryOutputLevel">
<summary>
Gets or sets value that indicates the level of summary output at the end for the logger.
</summary>
<remarks>Default is to show errors and summary.</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.MSBuild.MSBuildLoggerSettings.HideItemAndPropertyList">
<summary>
Gets or sets a value indicating whether to hide the list of items and properties that would appear at the start of each project build if the verbosity level is set to diagnostic.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.MSBuild.MSBuildLoggerSettings.ShowCommandLine">
<summary>
Gets or sets a value indicating whether to show TaskCommandLineEvent messages.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.MSBuild.MSBuildLoggerSettings.ShowTimestamp">
<summary>
Gets or sets a value indicating whether to show the timestamp as a prefix to any message.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.MSBuild.MSBuildLoggerSettings.ShowEventId">
<summary>
Gets or sets a value indicating whether to show the event Id for each started event, finished event, and message.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.MSBuild.MSBuildLoggerSettings.ForceNoAlign">
<summary>
Gets or sets a value indicating whether to not align the text to the size of the console buffer.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.MSBuild.MSBuildLoggerSettings.ConsoleColorType">
<summary>
Gets or sets value that indicates the type of console color to use for all logging messages.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.MSBuild.MSBuildLoggerSettings.DisableMultiprocessorLogging">
<summary>
Gets or sets a value indicating whether to disable the multiprocessor logging style of output when running in non-multiprocessor mode.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.MSBuild.MSBuildLoggerSettings.Verbosity">
<summary>
Gets or sets a value that overrides the /verbosity setting for this logger.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNet.MSBuild.MSBuildTreatAllWarningsAs">
<summary>
Represents how all warnings should be treated as by MSBuild.
</summary>
</member>
<member name="F:Cake.Common.Tools.DotNet.MSBuild.MSBuildTreatAllWarningsAs.Default">
<summary>
Use the default MSBuild behaviour.
</summary>
</member>
<member name="F:Cake.Common.Tools.DotNet.MSBuild.MSBuildTreatAllWarningsAs.Message">
<summary>
Treat all warnings as low importance messages.
</summary>
</member>
<member name="F:Cake.Common.Tools.DotNet.MSBuild.MSBuildTreatAllWarningsAs.Error">
<summary>
Treat all warnings as errors.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNet.NuGet.Delete.DotNetNuGetDeleter">
<summary>
.NET NuGet deleter. Deletes or unlists a package from the server.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotNet.NuGet.Delete.DotNetNuGetDeleter.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotNet.NuGet.Delete.DotNetNuGetDeleter" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.DotNet.NuGet.Delete.DotNetNuGetDeleter.Delete(System.String,System.String,Cake.Common.Tools.DotNet.NuGet.Delete.DotNetNuGetDeleteSettings)">
<summary>
Delete the NuGet package using the specified name, version and settings.
</summary>
<param name="packageName">The name of the target package.</param>
<param name="version">Version of the package.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.DotNet.NuGet.Delete.DotNetNuGetDeleteSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotNet.NuGet.Delete.DotNetNuGetDeleter" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.NuGet.Delete.DotNetNuGetDeleteSettings.Source">
<summary>
Gets or sets a value indicating the server URL.
</summary>
<remarks>
Supported URLs for nuget.org include http://www.nuget.org, http://www.nuget.org/api/v3,
and http://www.nuget.org/api/v2/package. For private feeds, substitute the host name
(for example, %hostname%/api/v3).
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.NuGet.Delete.DotNetNuGetDeleteSettings.NoServiceEndpoint">
<summary>
Gets or sets a value indicating whether to append "api/v2/package" to the source URL.
</summary>
<remarks>
Available since .NET Core 2.1 SDK.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.NuGet.Delete.DotNetNuGetDeleteSettings.Interactive">
<summary>
Gets or sets a value indicating whether to block and require manual action for operations like authentication.
</summary>
<remarks>
Available since .NET Core 2.2 SDK.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.NuGet.Delete.DotNetNuGetDeleteSettings.NonInteractive">
<summary>
Gets or sets a value indicating whether to prompt for user input or confirmations.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.NuGet.Delete.DotNetNuGetDeleteSettings.ApiKey">
<summary>
Gets or sets a value indicating the API key for the server.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.NuGet.Delete.DotNetNuGetDeleteSettings.ForceEnglishOutput">
<summary>
Gets or sets a value indicating whether to force command-line output in English.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNet.NuGet.Push.DotNetNuGetPusher">
<summary>
.NET NuGet pusher. Pushes a package and its symbols to the server.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotNet.NuGet.Push.DotNetNuGetPusher.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotNet.NuGet.Push.DotNetNuGetPusher" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.DotNet.NuGet.Push.DotNetNuGetPusher.Push(System.String,Cake.Common.Tools.DotNet.NuGet.Push.DotNetNuGetPushSettings)">
<summary>
Push one or more NuGet package using the specified name, version and settings.
</summary>
<param name="packageName">The name of the target package.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.DotNet.NuGet.Push.DotNetNuGetPushSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotNet.NuGet.Push.DotNetNuGetPusher" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.NuGet.Push.DotNetNuGetPushSettings.Source">
<summary>
Gets or sets a value indicating the server URL.
</summary>
<remarks>
This option is required unless DefaultPushSource config value is set in the NuGet config file.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.NuGet.Push.DotNetNuGetPushSettings.SymbolSource">
<summary>
Gets or sets a value indicating the symbol server URL.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.NuGet.Push.DotNetNuGetPushSettings.NoServiceEndpoint">
<summary>
Gets or sets a value indicating whether to append "api/v2/package" to the source URL.
</summary>
<remarks>
Available since .NET Core 2.1 SDK.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.NuGet.Push.DotNetNuGetPushSettings.Interactive">
<summary>
Gets or sets a value indicating whether to block and require manual action for operations like authentication.
</summary>
<remarks>
Available since .NET Core 2.2 SDK.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.NuGet.Push.DotNetNuGetPushSettings.Timeout">
<summary>
Gets or sets a value indicating timeout for pushing to a server in seconds.
<remarks>
Defaults to 300 seconds (5 minutes). Specifying 0 (zero seconds) applies the default value.
</remarks>
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.NuGet.Push.DotNetNuGetPushSettings.ApiKey">
<summary>
Gets or sets a value indicating the API key for the server.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.NuGet.Push.DotNetNuGetPushSettings.SymbolApiKey">
<summary>
Gets or sets a value indicating the API key for the symbol server.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.NuGet.Push.DotNetNuGetPushSettings.DisableBuffering">
<summary>
Gets or sets a value indicating whether buffering is disabled when pushing to an HTTP(S) server.
</summary>
<remarks>
This decreases memory usage.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.NuGet.Push.DotNetNuGetPushSettings.IgnoreSymbols">
<summary>
Gets or sets a value indicating whether symbols should be not be pushed if present.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.NuGet.Push.DotNetNuGetPushSettings.SkipDuplicate">
<summary>
Gets or sets a value indicating whether, when pushing multiple packages to an HTTP(S) server,
to treat any 409 Conflict response as a warning so that the push can continue.
</summary>
<remarks>
Available since .NET Core 3.1 SDK.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.NuGet.Push.DotNetNuGetPushSettings.ForceEnglishOutput">
<summary>
Gets or sets a value indicating whether to force command-line output in English.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNet.NuGet.Source.DotNetNuGetAddSourceSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotNet.NuGet.Source.DotNetNuGetSourcer" /> for adding new sources.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNet.NuGet.Source.DotNetNuGetDisableSourceSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotNet.NuGet.Source.DotNetNuGetSourcer" /> for disabling NuGet sources.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNet.NuGet.Source.DotNetNuGetEnableSourceSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotNet.NuGet.Source.DotNetNuGetSourcer" /> for enabling a NuGet source.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNet.NuGet.Source.DotNetNuGetHasSourceSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotNet.NuGet.Source.DotNetNuGetSourcer" /> for checking if a NuGet source exists.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNet.NuGet.Source.DotNetNuGetListSourceSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotNet.NuGet.Source.DotNetNuGetSourcer" /> for listing NuGet sources.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNet.NuGet.Source.DotNetNuGetRemoveSourceSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotNet.NuGet.Source.DotNetNuGetSourcer" /> for removing a NuGet source.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNet.NuGet.Source.DotNetNuGetSourcer">
<summary>
.NET NuGet sourcer.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotNet.NuGet.Source.DotNetNuGetSourcer.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotNet.NuGet.Source.DotNetNuGetSourcer" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.DotNet.NuGet.Source.DotNetNuGetSourcer.AddSource(System.String,Cake.Common.Tools.DotNet.NuGet.Source.DotNetNuGetSourceSettings)">
<summary>
Add the specified NuGet source.
</summary>
<param name="name">The name of the source.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.DotNet.NuGet.Source.DotNetNuGetSourcer.DisableSource(System.String,Cake.Common.Tools.DotNet.NuGet.Source.DotNetNuGetSourceSettings)">
<summary>
Disable the specified NuGet source.
</summary>
<param name="name">The name of the source.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.DotNet.NuGet.Source.DotNetNuGetSourcer.EnableSource(System.String,Cake.Common.Tools.DotNet.NuGet.Source.DotNetNuGetSourceSettings)">
<summary>
Enable the specified NuGet source.
</summary>
<param name="name">The name of the source.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.DotNet.NuGet.Source.DotNetNuGetSourcer.HasSource(System.String,Cake.Common.Tools.DotNet.NuGet.Source.DotNetNuGetSourceSettings)">
<summary>
Determines whether the specified NuGet source exists.
</summary>
<param name="name">The name of the source.</param>
<param name="settings">The settings.</param>
<returns>Whether the specified NuGet source exists.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNet.NuGet.Source.DotNetNuGetSourcer.ListSource(System.String,Cake.Common.Tools.DotNet.NuGet.Source.DotNetNuGetSourceSettings)">
<summary>
Lists the NuGet sources.
</summary>
<param name="format">The output format. Accepts two values: detailed (the default) and short.</param>
<param name="settings">The settings.</param>
<returns>The NuGet sources.</returns>
</member>
<member name="M:Cake.Common.Tools.DotNet.NuGet.Source.DotNetNuGetSourcer.RemoveSource(System.String,Cake.Common.Tools.DotNet.NuGet.Source.DotNetNuGetSourceSettings)">
<summary>
Remove the specified NuGet source.
</summary>
<param name="name">The name of the source.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.DotNet.NuGet.Source.DotNetNuGetSourcer.UpdateSource(System.String,Cake.Common.Tools.DotNet.NuGet.Source.DotNetNuGetSourceSettings)">
<summary>
Update the specified NuGet source.
</summary>
<param name="name">The name of the source.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.DotNet.NuGet.Source.DotNetNuGetSourceSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotNet.NuGet.Source.DotNetNuGetSourcer" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.NuGet.Source.DotNetNuGetSourceSettings.Source">
<summary>
Gets or sets the path to the package(s) source.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.NuGet.Source.DotNetNuGetSourceSettings.IsSensitiveSource">
<summary>
Gets or sets a value indicating whether this source contains sensitive data, i.e. authentication token in url.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.NuGet.Source.DotNetNuGetSourceSettings.UserName">
<summary>
Gets or sets the user name to be used when connecting to an authenticated source.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.NuGet.Source.DotNetNuGetSourceSettings.Password">
<summary>
Gets or sets the password to be used when connecting to an authenticated source.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.NuGet.Source.DotNetNuGetSourceSettings.StorePasswordInClearText">
<summary>
Gets or sets a value indicating whether to enable storing portable package source credentials by disabling password encryption.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.NuGet.Source.DotNetNuGetSourceSettings.ValidAuthenticationTypes">
<summary>
Gets or sets the comma-separated list of valid authentication types for this source.
</summary>
<remarks>
By default, all authentication types are valid. Example: basic,negotiate.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.NuGet.Source.DotNetNuGetSourceSettings.ConfigFile">
<summary>
Gets or sets the NuGet configuration file.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNet.NuGet.Source.DotNetNuGetUpdateSourceSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotNet.NuGet.Source.DotNetNuGetSourcer" /> for updating a NuGet source.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNet.Pack.DotNetPacker">
<summary>
.NET project packer.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotNet.Pack.DotNetPacker.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotNet.Pack.DotNetPacker" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.DotNet.Pack.DotNetPacker.Pack(System.String,Cake.Common.Tools.DotNet.Pack.DotNetPackSettings)">
<summary>
Pack the project using the specified path and settings.
</summary>
<param name="project">The target file path.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.DotNet.Pack.DotNetPackSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotNet.Pack.DotNetPacker" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Pack.DotNetPackSettings.OutputDirectory">
<summary>
Gets or sets the output directory.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Pack.DotNetPackSettings.Configuration">
<summary>
Gets or sets the configuration under which to build.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Pack.DotNetPackSettings.VersionSuffix">
<summary>
Gets or sets the value that defines what `*` should be replaced with in version field in project.json.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Pack.DotNetPackSettings.NoBuild">
<summary>
Gets or sets a value indicating whether to not build project before packing.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Pack.DotNetPackSettings.NoDependencies">
<summary>
Gets or sets a value indicating whether to ignore project to project references and only build the root project.
</summary>
<remarks>
Requires .NET Core 2.x or newer.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.Pack.DotNetPackSettings.NoRestore">
<summary>
Gets or sets a value indicating whether to not do implicit NuGet package restore.
This makes build faster, but requires restore to be done before build is executed.
</summary>
<remarks>
Requires .NET Core 2.x or newer.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.Pack.DotNetPackSettings.NoLogo">
<summary>
Gets or sets a value indicating whether to display the startup banner or the copyright message.
</summary>
<remarks>
Available since .NET Core 3.0 SDK.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.Pack.DotNetPackSettings.IncludeSymbols">
<summary>
Gets or sets a value indicating whether to generate the symbols package.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Pack.DotNetPackSettings.SymbolPackageFormat">
<summary>
Gets or sets the symbol package format.
</summary>
<value>The symbol package format.</value>
</member>
<member name="P:Cake.Common.Tools.DotNet.Pack.DotNetPackSettings.IncludeSource">
<summary>
Gets or sets a value indicating whether to includes the source files in the NuGet package.
The sources files are included in the src folder within the nupkg.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Pack.DotNetPackSettings.Serviceable">
<summary>
Gets or sets a value indicating whether to set the serviceable flag in the package.
</summary>
<remarks>
For more information, see https://aka.ms/nupkgservicing.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.Pack.DotNetPackSettings.Runtime">
<summary>
Gets or sets the target runtime.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Pack.DotNetPackSettings.Sources">
<summary>
Gets or sets the specified NuGet package sources to use during the packing.
</summary>
<remarks>
Requires .NET Core 2.x or newer.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.Pack.DotNetPackSettings.MSBuildSettings">
<summary>
Gets or sets additional arguments to be passed to MSBuild.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNet.Publish.DotNetPublisher">
<summary>
.NET project publisher.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotNet.Publish.DotNetPublisher.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotNet.Publish.DotNetPublisher" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.DotNet.Publish.DotNetPublisher.Publish(System.String,Cake.Common.Tools.DotNet.Publish.DotNetPublishSettings)">
<summary>
Publish the project using the specified path and settings.
</summary>
<param name="path">The target file path.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.DotNet.Publish.DotNetPublishSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotNet.Publish.DotNetPublisher" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Publish.DotNetPublishSettings.OutputDirectory">
<summary>
Gets or sets the output directory.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Publish.DotNetPublishSettings.Runtime">
<summary>
Gets or sets the target runtime.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Publish.DotNetPublishSettings.Framework">
<summary>
Gets or sets a specific framework to compile.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Publish.DotNetPublishSettings.Configuration">
<summary>
Gets or sets the configuration under which to build.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Publish.DotNetPublishSettings.VersionSuffix">
<summary>
Gets or sets the value that defines what `*` should be replaced with in version field in project.json.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Publish.DotNetPublishSettings.NoBuild">
<summary>
Gets or sets a value indicating whether to not to build the project before publishing.
This makes build faster, but requires build to be done before publish is executed.
</summary>
<remarks>
Requires .NET Core 2.1 or newer.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.Publish.DotNetPublishSettings.NoDependencies">
<summary>
Gets or sets a value indicating whether to ignore project to project references and only build the root project.
</summary>
<remarks>
Requires .NET Core 2.x or newer.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.Publish.DotNetPublishSettings.NoRestore">
<summary>
Gets or sets a value indicating whether to not do implicit NuGet package restore.
This makes build faster, but requires restore to be done before build is executed.
</summary>
<remarks>
Requires .NET Core 2.x or newer.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.Publish.DotNetPublishSettings.NoLogo">
<summary>
Gets or sets a value indicating whether to display the startup banner or the copyright message.
</summary>
<remarks>
Available since .NET Core 3.0 SDK.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.Publish.DotNetPublishSettings.Force">
<summary>
Gets or sets a value indicating whether to force all dependencies to be resolved even if the last restore was successful. This is equivalent to deleting project.assets.json.
</summary>
<remarks>
Requires .NET Core 2.x or newer.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.Publish.DotNetPublishSettings.SelfContained">
<summary>
Gets or sets a value indicating whether Publish the .NET Core runtime with your application so the runtime doesn't need to be installed on the target machine. Defaults to 'true' if a runtime identifier is specified.
</summary>
<remarks>
Requires .NET Core 2.x or newer.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.Publish.DotNetPublishSettings.PublishSingleFile">
<summary>
Gets or sets a value indicating whether to package your app into a platform-specific single-file executable.
</summary>
<remarks>
Requires .NET Core 3.x or newer.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.Publish.DotNetPublishSettings.PublishTrimmed">
<summary>
Gets or sets a value indicating whether to reduce the size of apps by analyzing IL and trimming unused assemblies.
</summary>
<remarks>
Requires .NET Core 3.x or newer.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.Publish.DotNetPublishSettings.TieredCompilationQuickJit">
<summary>
Gets or sets a value as to whether tiered compilation quick JIT is enabled.
</summary>
<remarks>
Requires .NET Core 3.x or newer. Tiered compilation is enabled by default in .NET Core 3.
<para>Code generated by Quick JIT may run slower, allocate more memory, or use more stack space.</para>
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.Publish.DotNetPublishSettings.TieredCompilation">
<summary>
Gets or sets a value indicating whether tiered compilation is enabled.
</summary>
<remarks>
Requires .NET Core 3.x or newer. Tiered compilation is enabled by default in .NET Core 3.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.Publish.DotNetPublishSettings.PublishReadyToRun">
<summary>
Gets or sets a value indicating whether to compile your application assemblies as ReadyToRun (R2R) format.
</summary>
<remarks>
Requires .NET Core 3.x or newer. Tiered compilation is enabled by default in .NET Core 3.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.Publish.DotNetPublishSettings.PublishReadyToRunShowWarnings">
<summary>
Gets or sets a value indicating whether to show warnings emitted by ReadyToRun (R2R) compilation.
</summary>
<remarks>
Requires .NET Core 3.x or newer. Tiered compilation is enabled by default in .NET Core 3.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.Publish.DotNetPublishSettings.IncludeNativeLibrariesForSelfExtract">
<summary>
Gets or sets a value indicating whether to bundle native libraries when publishing a platform-specific single-file executable.
</summary>
<remarks>
Requires .NET 5 or newer.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.Publish.DotNetPublishSettings.IncludeAllContentForSelfExtract">
<summary>
Gets or sets a value indicating whether to bundle all content when publishing a platform-specific single-file executable.
This will extract all files before running the executable and preserves the original .NET Core single-file deployment behavior.
</summary>
<remarks>
Requires .NET 5 or newer.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.Publish.DotNetPublishSettings.EnableCompressionInSingleFile">
<summary>
Gets or sets a value indicating whether to enable compression on the embedded assemblies when publishing a single-file executable.
</summary>
<remarks>
Requires .NET 6 or newer.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.Publish.DotNetPublishSettings.Sources">
<summary>
Gets or sets the specified NuGet package sources to use during the restore.
</summary>
<remarks>
Requires .NET Core 2.x or newer.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.Publish.DotNetPublishSettings.MSBuildSettings">
<summary>
Gets or sets additional arguments to be passed to MSBuild.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNet.Restore.DotNetRestorer">
<summary>
.NET project restorer.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotNet.Restore.DotNetRestorer.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Core.Diagnostics.ICakeLog)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotNet.Restore.DotNetRestorer" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="log">The cake log.</param>
</member>
<member name="M:Cake.Common.Tools.DotNet.Restore.DotNetRestorer.Restore(System.String,Cake.Common.Tools.DotNet.Restore.DotNetRestoreSettings)">
<summary>
Restore the project using the specified path and settings.
</summary>
<param name="root">List of projects and project folders to restore. Each value can be: a path to a project.json or global.json file, or a folder to recursively search for project.json files.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.DotNet.Restore.DotNetRestoreSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotNet.Restore.DotNetRestorer" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Restore.DotNetRestoreSettings.Sources">
<summary>
Gets or sets the specified NuGet package sources to use during the restore.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Restore.DotNetRestoreSettings.ConfigFile">
<summary>
Gets or sets the NuGet configuration file to use.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Restore.DotNetRestoreSettings.PackagesDirectory">
<summary>
Gets or sets the directory to install packages in.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Restore.DotNetRestoreSettings.NoCache">
<summary>
Gets or sets a value indicating whether to do not cache packages and http requests.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Restore.DotNetRestoreSettings.DisableParallel">
<summary>
Gets or sets a value indicating whether to disable restoring multiple projects in parallel.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Restore.DotNetRestoreSettings.IgnoreFailedSources">
<summary>
Gets or sets a value indicating whether to only warning failed sources if there are packages meeting version requirement.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Restore.DotNetRestoreSettings.Runtime">
<summary>
Gets or sets the target runtime to restore packages for.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Restore.DotNetRestoreSettings.NoDependencies">
<summary>
Gets or sets a value indicating whether to ignore project to project references and restore only the root project.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Restore.DotNetRestoreSettings.Force">
<summary>
Gets or sets a value indicating whether to force all dependencies to be resolved even if the last restore was successful.
This is equivalent to deleting the project.assets.json file.
Note: This flag was introduced with the .NET Core 2.x release.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Restore.DotNetRestoreSettings.Interactive">
<summary>
Gets or sets a value indicating whether to stop and wait for user input or action (for example to complete authentication).
</summary>
<remarks>
Supported by .NET SDK version 2.1.400 and above.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.Restore.DotNetRestoreSettings.UseLockFile">
<summary>
Gets or sets a value indicating whether to enable project lock file to be generated and used with restore.
</summary>
<remarks>
Supported by .NET SDK version 2.1.500 and above.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.Restore.DotNetRestoreSettings.LockedMode">
<summary>
Gets or sets a value indicating whether to not allow updating project lock file.
</summary>
<remarks>
When set to true, restore will fail if the lock file is out of sync.
Useful for CI builds when you do not want the build to continue if the package closure has changed than what is present in the lock file.
<para>
Supported by .NET SDK version 2.1.500 and above.
</para>
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.Restore.DotNetRestoreSettings.LockFilePath">
<summary>
Gets or sets a value indicating output location where project lock file is written.
</summary>
<remarks>
If not set, 'dotnet restore' defaults to 'PROJECT_ROOT\packages.lock.json'.
<para>
Supported by .NET SDK version 2.1.500 and above.
</para>
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.Restore.DotNetRestoreSettings.ForceEvaluate">
<summary>
Gets or sets a value indicating whether to force restore to reevaluate all dependencies even if a lock file already exists.
</summary>
<remarks>
Supported by .NET SDK version 2.1.500 and above.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.Restore.DotNetRestoreSettings.MSBuildSettings">
<summary>
Gets or sets additional arguments to be passed to MSBuild.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNet.Run.DotNetRunner">
<summary>
.NET project runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotNet.Run.DotNetRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotNet.Run.DotNetRunner" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.DotNet.Run.DotNetRunner.Run(System.String,Cake.Core.IO.ProcessArgumentBuilder,Cake.Common.Tools.DotNet.Run.DotNetRunSettings)">
<summary>
Runs the project using the specified path with arguments and settings.
</summary>
<param name="project">The target project path.</param>
<param name="arguments">The arguments.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.DotNet.Run.DotNetRunSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotNet.Run.DotNetRunner" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Run.DotNetRunSettings.Framework">
<summary>
Gets or sets a specific framework to compile.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Run.DotNetRunSettings.Configuration">
<summary>
Gets or sets the configuration under which to build.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Run.DotNetRunSettings.NoRestore">
<summary>
Gets or sets a value indicating whether to not do implicit NuGet package restore.
This makes run faster, but requires restore to be done before run is executed.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Run.DotNetRunSettings.NoBuild">
<summary>
Gets or sets a value indicating whether to not do implicit build.
This makes run faster, but requires build to be done before run is executed.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Run.DotNetRunSettings.Sources">
<summary>
Gets or sets the specified NuGet package sources to use during the run is executed.
</summary>
<remarks>
Requires .NET Core 2.x or newer.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.Run.DotNetRunSettings.Runtime">
<summary>
Gets or sets the target runtime.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Run.DotNetRunSettings.MSBuildSettings">
<summary>
Gets or sets additional arguments to be passed to MSBuild.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNet.SDKCheck.DotNetSDKChecker">
<summary>
.NET SDK checker.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotNet.SDKCheck.DotNetSDKChecker.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotNet.SDKCheck.DotNetSDKChecker" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.DotNet.SDKCheck.DotNetSDKChecker.Check">
<summary>
Lists the latest available version of the .NET SDK and .NET Runtime, for each feature band.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNet.SDKCheck.DotNetSDKCheckSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotNet.SDKCheck.DotNetSDKChecker" />.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNet.Test.DotNetTester">
<summary>
.NET project tester.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotNet.Test.DotNetTester.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotNet.Test.DotNetTester" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.DotNet.Test.DotNetTester.Test(System.String,Cake.Core.IO.ProcessArgumentBuilder,Cake.Common.Tools.DotNet.Test.DotNetTestSettings)">
<summary>
Tests the project using the specified path with arguments and settings.
</summary>
<param name="project">The target project path.</param>
<param name="arguments">The arguments.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.DotNet.Test.DotNetTestSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotNet.Test.DotNetTester" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Test.DotNetTestSettings.Settings">
<summary>
Gets or sets the settings file to use when running tests.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Test.DotNetTestSettings.Filter">
<summary>
Gets or sets the filter expression to filter out tests in the current project.
</summary>
<remarks>
For more information on filtering support, see https://aka.ms/vstest-filtering.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.Test.DotNetTestSettings.TestAdapterPath">
<summary>
Gets or sets the path to use for the custom test adapter in the test run.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Test.DotNetTestSettings.Loggers">
<summary>
Gets or sets the loggers for test results.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Test.DotNetTestSettings.OutputDirectory">
<summary>
Gets or sets the output directory.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Test.DotNetTestSettings.Configuration">
<summary>
Gets or sets the configuration under which to build.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Test.DotNetTestSettings.Collectors">
<summary>
Gets or sets the data collectors for the test run.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Test.DotNetTestSettings.Framework">
<summary>
Gets or sets specific framework to compile.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Test.DotNetTestSettings.NoBuild">
<summary>
Gets or sets a value indicating whether to not build the project before testing.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Test.DotNetTestSettings.NoRestore">
<summary>
Gets or sets a value indicating whether to not do implicit NuGet package restore.
This makes build faster, but requires restore to be done before build is executed.
</summary>
<remarks>
Requires .NET Core 2.x or newer.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.Test.DotNetTestSettings.NoLogo">
<summary>
Gets or sets a value indicating whether to run tests without displaying the Microsoft TestPlatform banner.
</summary>
<remarks>
Available since .NET Core 3.0 SDK.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.Test.DotNetTestSettings.DiagnosticFile">
<summary>
Gets or sets a file to write diagnostic messages to.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Test.DotNetTestSettings.ResultsDirectory">
<summary>
Gets or sets the results directory. This setting is only available from 2.0.0 upward.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Test.DotNetTestSettings.VSTestReportPath">
<summary>
Gets or sets the file path to write VSTest reports to.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Test.DotNetTestSettings.Runtime">
<summary>
Gets or sets the target runtime to test for. This setting is only available from .NET Core 3.x upward.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Test.DotNetTestSettings.Blame">
<summary>
Gets or sets a value indicating whether to run the tests in blame mode. This option is helpful in isolating a problematic test causing the test host to crash.
Outputs a 'Sequence.xml' file in the current directory that captures the order of execution of test before the crash.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Test.DotNetTestSettings.Sources">
<summary>
Gets or sets the specified NuGet package sources to use during testing.
</summary>
<remarks>
Requires .NET Core 2.x or newer.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.Test.DotNetTestSettings.MSBuildSettings">
<summary>
Gets or sets additional arguments to be passed to MSBuild.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNet.Tool.DotNetToolRunner">
<summary>
.NET Extensibility Commands Runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotNet.Tool.DotNetToolRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotNet.Tool.DotNetToolRunner" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.DotNet.Tool.DotNetToolRunner.Execute(Cake.Core.IO.FilePath,System.String,Cake.Core.IO.ProcessArgumentBuilder,Cake.Common.Tools.DotNet.Tool.DotNetToolSettings)">
<summary>
Execute an assembly using arguments and settings.
</summary>
<param name="projectPath">The target project path.</param>
<param name="command">The command to execute.</param>
<param name="arguments">The arguments.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.DotNet.Tool.DotNetToolSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotNet.Tool.DotNetToolRunner" />.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNet.VSTest.DotNetVSTester">
<summary>
.NET Core VSTest tester.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotNet.VSTest.DotNetVSTester.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotNet.VSTest.DotNetVSTester" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.DotNet.VSTest.DotNetVSTester.Test(System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.DotNet.VSTest.DotNetVSTestSettings)">
<summary>
Tests the project using the specified path with arguments and settings.
</summary>
<param name="testFiles">A list of test files to run.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.DotNet.VSTest.DotNetVSTestSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotNet.VSTest.DotNetVSTester" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.VSTest.DotNetVSTestSettings.Settings">
<summary>
Gets or sets the settings file to use when running tests.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.VSTest.DotNetVSTestSettings.TestsToRun">
<summary>
Gets or sets the a list tests to run.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.VSTest.DotNetVSTestSettings.TestAdapterPath">
<summary>
Gets or sets the path to use for the custom test adapter in the test run.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.VSTest.DotNetVSTestSettings.Platform">
<summary>
Gets or sets the target platform architecture to be used for test execution.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.VSTest.DotNetVSTestSettings.Framework">
<summary>
Gets or sets specific .Net Framework version to be used for test execution.
</summary>
<remarks>
Valid values are ".NETFramework,Version=v4.6", ".NETCoreApp,Version=v1.0" etc.
Other supported values are Framework35, Framework40, Framework45 and FrameworkCore10.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.VSTest.DotNetVSTestSettings.Parallel">
<summary>
Gets or sets a value indicating whether the tests should be executed in parallel.
</summary>
<remarks>
By default up to all available cores on the machine may be used. The number of cores to use may be configured using a settings file.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.VSTest.DotNetVSTestSettings.TestCaseFilter">
<summary>
Gets or sets the filter expression to run test that match.
</summary>
<remarks>
For more information on filtering support, see https://aka.ms/vstest-filtering.
</remarks>
</member>
<member name="P:Cake.Common.Tools.DotNet.VSTest.DotNetVSTestSettings.Logger">
<summary>
Gets or sets a logger for test results.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.VSTest.DotNetVSTestSettings.ParentProcessId">
<summary>
Gets or sets the Process Id of the Parent Process responsible for launching current process.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.VSTest.DotNetVSTestSettings.Port">
<summary>
Gets or sets the Port for socket connection and receiving the event messages.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.VSTest.DotNetVSTestSettings.DiagnosticFile">
<summary>
Gets or sets a file to write diagnostic messages to.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.VSTest.DotNetVSTestSettings.ResultsDirectory">
<summary>
Gets or sets the path to put the test results in.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.VSTest.DotNetVSTestSettings.Arguments">
<summary>
Gets or sets a list of extra arguments that should be passed to adapter.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotNet.VSTest.DotNetVSTestSettings.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotNet.VSTest.DotNetVSTestSettings"/> class.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNet.Workload.Install.DotNetWorkloadInstaller">
<summary>
.NET workloads installer.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotNet.Workload.Install.DotNetWorkloadInstaller.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotNet.Workload.Install.DotNetWorkloadInstaller" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.DotNet.Workload.Install.DotNetWorkloadInstaller.Install(System.Collections.Generic.IEnumerable{System.String},Cake.Common.Tools.DotNet.Workload.Install.DotNetWorkloadInstallSettings)">
<summary>
Lists the latest available version of the .NET SDK and .NET Runtime, for each feature band.
</summary>
<param name="workloadIds">The workload ID or multiple IDs to uninstall.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.DotNet.Workload.Install.DotNetWorkloadInstallSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotNet.Workload.Install.DotNetWorkloadInstaller" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Workload.Install.DotNetWorkloadInstallSettings.ConfigFile">
<summary>
Gets or sets the NuGet configuration file (nuget.config) to use.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Workload.Install.DotNetWorkloadInstallSettings.DisableParallel">
<summary>
Gets or sets a value indicating whether to prevent restoring multiple projects in parallel.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Workload.Install.DotNetWorkloadInstallSettings.IgnoreFailedSources">
<summary>
Gets or sets a value indicating whether to treat package source failures as warnings.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Workload.Install.DotNetWorkloadInstallSettings.IncludePreviews">
<summary>
Gets or sets a value indicating whether to allow prerelease workload manifests.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Workload.Install.DotNetWorkloadInstallSettings.Interactive">
<summary>
Gets or sets a value indicating whether to allow the command to stop and wait for user input or action.
For example, to complete authentication.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Workload.Install.DotNetWorkloadInstallSettings.NoCache">
<summary>
Gets or sets a value indicating whether to do not cache packages and http requests.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Workload.Install.DotNetWorkloadInstallSettings.SkipManifestUpdate">
<summary>
Gets or sets a value indicating whether to skip updating the workload manifests.
The workload manifests define what assets and versions need to be installed for each workload.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Workload.Install.DotNetWorkloadInstallSettings.Source">
<summary>
Gets or sets the URI of the NuGet package source to use.
This setting overrides all of the sources specified in the nuget.config files.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Workload.Install.DotNetWorkloadInstallSettings.TempDir">
<summary>
Gets or sets the temporary directory used to download and extract NuGet packages (must be secure).
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNet.Workload.List.DotNetWorkloadLister">
<summary>
.NET workloads lister.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotNet.Workload.List.DotNetWorkloadLister.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotNet.Workload.List.DotNetWorkloadLister" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.DotNet.Workload.List.DotNetWorkloadLister.List(Cake.Common.Tools.DotNet.Workload.List.DotNetWorkloadListSettings)">
<summary>
Lists all installed workloads.
</summary>
<param name="settings">The settings.</param>
<returns>The list of installed workloads.</returns>
</member>
<member name="T:Cake.Common.Tools.DotNet.Workload.List.DotNetWorkloadListItem">
<summary>
An item as returned by <see cref="T:Cake.Common.Tools.DotNet.Workload.List.DotNetWorkloadLister"/>.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotNet.Workload.List.DotNetWorkloadListItem.#ctor(System.String,System.String,System.String)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotNet.Workload.List.DotNetWorkloadListItem" /> class.
</summary>
<param name="id">The workload Id.</param>
<param name="manifestVersion">The workload manifest version.</param>
<param name="installationSource">The workload installation source.</param>
</member>
<member name="P:Cake.Common.Tools.DotNet.Workload.List.DotNetWorkloadListItem.Id">
<summary>
Gets the workload ID.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Workload.List.DotNetWorkloadListItem.ManifestVersion">
<summary>
Gets the manifest version of the workload as string.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Workload.List.DotNetWorkloadListItem.InstallationSource">
<summary>
Gets the installation source of the workload as string.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNet.Workload.List.DotNetWorkloadListSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotNet.Workload.List.DotNetWorkloadLister" />.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNet.Workload.Repair.DotNetWorkloadRepairer">
<summary>
.NET workloads installations repairer.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotNet.Workload.Repair.DotNetWorkloadRepairer.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotNet.Workload.Repair.DotNetWorkloadRepairer" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.DotNet.Workload.Repair.DotNetWorkloadRepairer.Repair(Cake.Common.Tools.DotNet.Workload.Repair.DotNetWorkloadRepairSettings)">
<summary>
Repairs all workloads installations.
</summary>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.DotNet.Workload.Repair.DotNetWorkloadRepairSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotNet.Workload.Repair.DotNetWorkloadRepairer" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Workload.Repair.DotNetWorkloadRepairSettings.ConfigFile">
<summary>
Gets or sets the NuGet configuration file (nuget.config) to use.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Workload.Repair.DotNetWorkloadRepairSettings.DisableParallel">
<summary>
Gets or sets a value indicating whether to prevent restoring multiple projects in parallel.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Workload.Repair.DotNetWorkloadRepairSettings.IgnoreFailedSources">
<summary>
Gets or sets a value indicating whether to treat package source failures as warnings.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Workload.Repair.DotNetWorkloadRepairSettings.IncludePreviews">
<summary>
Gets or sets a value indicating whether to allow prerelease workload manifests.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Workload.Repair.DotNetWorkloadRepairSettings.Interactive">
<summary>
Gets or sets a value indicating whether to allow the command to stop and wait for user input or action.
For example, to complete authentication.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Workload.Repair.DotNetWorkloadRepairSettings.NoCache">
<summary>
Gets or sets a value indicating whether to do not cache packages and http requests.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Workload.Repair.DotNetWorkloadRepairSettings.Source">
<summary>
Gets or sets the URI of the NuGet package source to use.
This setting overrides all of the sources specified in the nuget.config files.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Workload.Repair.DotNetWorkloadRepairSettings.TempDir">
<summary>
Gets or sets the temporary directory used to download and extract NuGet packages (must be secure).
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNet.Workload.Restore.DotNetWorkloadRestorer">
<summary>
.NET workloads restorer.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotNet.Workload.Restore.DotNetWorkloadRestorer.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotNet.Workload.Restore.DotNetWorkloadRestorer" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.DotNet.Workload.Restore.DotNetWorkloadRestorer.Restore(System.String,Cake.Common.Tools.DotNet.Workload.Restore.DotNetWorkloadRestoreSettings)">
<summary>
Installs workloads needed for a project or a solution.
</summary>
<param name="project">The target project or solution file path.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.DotNet.Workload.Restore.DotNetWorkloadRestoreSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotNet.Workload.Restore.DotNetWorkloadRestorer" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Workload.Restore.DotNetWorkloadRestoreSettings.ConfigFile">
<summary>
Gets or sets the NuGet configuration file (nuget.config) to use.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Workload.Restore.DotNetWorkloadRestoreSettings.DisableParallel">
<summary>
Gets or sets a value indicating whether to prevent restoring multiple projects in parallel.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Workload.Restore.DotNetWorkloadRestoreSettings.IgnoreFailedSources">
<summary>
Gets or sets a value indicating whether to treat package source failures as warnings.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Workload.Restore.DotNetWorkloadRestoreSettings.IncludePreviews">
<summary>
Gets or sets a value indicating whether to allow prerelease workload manifests.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Workload.Restore.DotNetWorkloadRestoreSettings.Interactive">
<summary>
Gets or sets a value indicating whether to allow the command to stop and wait for user input or action.
For example, to complete authentication.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Workload.Restore.DotNetWorkloadRestoreSettings.NoCache">
<summary>
Gets or sets a value indicating whether to do not cache packages and http requests.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Workload.Restore.DotNetWorkloadRestoreSettings.SkipManifestUpdate">
<summary>
Gets or sets a value indicating whether to skip updating the workload manifests.
The workload manifests define what assets and versions need to be installed for each workload.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Workload.Restore.DotNetWorkloadRestoreSettings.Source">
<summary>
Gets or sets the URI of the NuGet package source to use.
This setting overrides all of the sources specified in the nuget.config files.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Workload.Restore.DotNetWorkloadRestoreSettings.TempDir">
<summary>
Gets or sets the temporary directory used to download and extract NuGet packages (must be secure).
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNet.Workload.Search.DotNetWorkload">
<summary>
Workload information.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotNet.Workload.Search.DotNetWorkload.#ctor(System.String,System.String)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotNet.Workload.Search.DotNetWorkload" /> class.
</summary>
<param name="id">The workload Id.</param>
<param name="description">The workload description.</param>
</member>
<member name="P:Cake.Common.Tools.DotNet.Workload.Search.DotNetWorkload.Id">
<summary>
Gets the workload Id.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Workload.Search.DotNetWorkload.Description">
<summary>
Gets the workload description.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNet.Workload.Search.DotNetWorkloadSearcher">
<summary>
.NET workloads searcher.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotNet.Workload.Search.DotNetWorkloadSearcher.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotNet.Workload.Search.DotNetWorkloadSearcher" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.DotNet.Workload.Search.DotNetWorkloadSearcher.Search(System.String,Cake.Common.Tools.DotNet.Workload.Search.DotNetWorkloadSearchSettings)">
<summary>
Lists the latest available version of the .NET SDK and .NET Runtime, for each feature band.
</summary>
<param name="searchString">The workload ID to search for, or part of it.</param>
<param name="settings">The settings.</param>
<returns>The list of available workloads.</returns>
</member>
<member name="T:Cake.Common.Tools.DotNet.Workload.Search.DotNetWorkloadSearchSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotNet.Workload.Search.DotNetWorkloadSearcher" />.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNet.Workload.Uninstall.DotNetWorkloadUninstaller">
<summary>
.NET workloads uninstaller.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotNet.Workload.Uninstall.DotNetWorkloadUninstaller.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotNet.Workload.Uninstall.DotNetWorkloadUninstaller" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.DotNet.Workload.Uninstall.DotNetWorkloadUninstaller.Uninstall(System.Collections.Generic.IEnumerable{System.String})">
<summary>
Uninstalls one or more workloads.
</summary>
<param name="workloadIds">The workload ID or multiple IDs to uninstall.</param>
</member>
<member name="T:Cake.Common.Tools.DotNet.Workload.Uninstall.DotNetWorkloadUninstallSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotNet.Workload.Uninstall.DotNetWorkloadUninstaller" />.
</summary>
</member>
<member name="T:Cake.Common.Tools.DotNet.Workload.Update.DotNetWorkloadUpdater">
<summary>
.NET workloads updater.
</summary>
</member>
<member name="M:Cake.Common.Tools.DotNet.Workload.Update.DotNetWorkloadUpdater.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DotNet.Workload.Update.DotNetWorkloadUpdater" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.DotNet.Workload.Update.DotNetWorkloadUpdater.Update(Cake.Common.Tools.DotNet.Workload.Update.DotNetWorkloadUpdateSettings)">
<summary>
Updates all installed workloads to the newest available version.
</summary>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.DotNet.Workload.Update.DotNetWorkloadUpdateSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DotNet.Workload.Update.DotNetWorkloadUpdater" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Workload.Update.DotNetWorkloadUpdateSettings.AdvertisingManifestsOnly">
<summary>
Gets or sets a value indicating whether to downloads advertising manifests but doesn't update any workloads.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Workload.Update.DotNetWorkloadUpdateSettings.ConfigFile">
<summary>
Gets or sets the NuGet configuration file (nuget.config) to use.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Workload.Update.DotNetWorkloadUpdateSettings.DisableParallel">
<summary>
Gets or sets a value indicating whether to prevent restoring multiple projects in parallel.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Workload.Update.DotNetWorkloadUpdateSettings.FromPreviousSdk">
<summary>
Gets or sets a value indicating whether to include workloads installed with previous SDK versions in the update.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Workload.Update.DotNetWorkloadUpdateSettings.IgnoreFailedSources">
<summary>
Gets or sets a value indicating whether to treat package source failures as warnings.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Workload.Update.DotNetWorkloadUpdateSettings.IncludePreviews">
<summary>
Gets or sets a value indicating whether to allow prerelease workload manifests.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Workload.Update.DotNetWorkloadUpdateSettings.Interactive">
<summary>
Gets or sets a value indicating whether to allow the command to stop and wait for user input or action.
For example, to complete authentication.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Workload.Update.DotNetWorkloadUpdateSettings.NoCache">
<summary>
Gets or sets a value indicating whether to do not cache packages and http requests.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Workload.Update.DotNetWorkloadUpdateSettings.Source">
<summary>
Gets or sets the URI of the NuGet package source to use.
This setting overrides all of the sources specified in the nuget.config files.
</summary>
</member>
<member name="P:Cake.Common.Tools.DotNet.Workload.Update.DotNetWorkloadUpdateSettings.TempDir">
<summary>
Gets or sets the temporary directory used to download and extract NuGet packages (must be secure).
</summary>
</member>
<member name="T:Cake.Common.Tools.DupFinder.DupFinderAliases">
<summary>
<para>Contains functionality related to ReSharper's <see href="https://www.jetbrains.com/help/resharper/2016.1/dupFinder.html">dupFinder</see> tool.</para>
<para>
In order to use the commands for this alias, include the following in your build.cake file to download and
install from nuget.org, or specify the ToolPath within the <see cref="T:Cake.Common.Tools.DupFinder.DupFinderSettings" /> class:
<code>
#tool "nuget:?package=JetBrains.ReSharper.CommandLineTools"
</code>
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.DupFinder.DupFinderAliases.DupFinder(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Analyses the specified file with ReSharper's DupFinder.
The file can either be a solution/project or a source file.
</summary>
<param name="context">The context.</param>
<param name="file">The file to analyze.</param>
<example>
<code>
DupFinder("./src/MySolution.sln");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DupFinder.DupFinderAliases.DupFinder(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Common.Tools.DupFinder.DupFinderSettings)">
<summary>
Analyses the specified file with ReSharper's DupFinder using the specified settings.
The file can either be a solution/project or a source file.
</summary>
<param name="context">The context.</param>
<param name="file">The file to analyze.</param>
<param name="settings">The settings.</param>
<example>
<code>
var buildOutputDirectory = Directory("./.build");
var resharperReportsDirectory = buildOutputDirectory + Directory("_ReSharperReports");
var rootDirectoryPath = MakeAbsolute(Context.Environment.WorkingDirectory);
DupFinder("./src/MySolution.sln", new DupFinderSettings {
ShowStats = true,
ShowText = true,
ExcludePattern = new String[]
{
rootDirectoryPath + "/**/*Designer.cs",
},
OutputFile = resharperReportsDirectory + File("dupfinder-output.xml"),
ThrowExceptionOnFindingDuplicates = true
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DupFinder.DupFinderAliases.DupFinder(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath})">
<summary>
Analyses the specified projects with ReSharper's DupFinder.
The files can either be solutions and projects or a source files.
</summary>
<param name="context">The context.</param>
<param name="files">The files to analyze.</param>
<example>
<code>
var projects = GetFiles("./src/**/*.csproj");
DupFinder(projects);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DupFinder.DupFinderAliases.DupFinder(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.DupFinder.DupFinderSettings)">
<summary>
Analyses the specified projects with ReSharper's DupFinder using the specified settings.
The files can either be solutions and projects or a source files.
</summary>
<param name="context">The context.</param>
<param name="files">The files to analyze.</param>
<param name="settings">The settings.</param>
<example>
<code>
var buildOutputDirectory = Directory("./.build");
var resharperReportsDirectory = buildOutputDirectory + Directory("_ReSharperReports");
var rootDirectoryPath = MakeAbsolute(Context.Environment.WorkingDirectory);
var projects = GetFiles("./src/**/*.csproj");
DupFinder(projects, new DupFinderSettings {
ShowStats = true,
ShowText = true,
ExcludePattern = new String[]
{
rootDirectoryPath + "/**/*Designer.cs",
},
OutputFile = resharperReportsDirectory + File("dupfinder-output.xml"),
ThrowExceptionOnFindingDuplicates = true
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DupFinder.DupFinderAliases.DupFinder(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern)">
<summary>
Analyses all files matching the specified pattern with ReSharper's DupFinder.
</summary>
<param name="context">The context.</param>
<param name="pattern">The pattern.</param>
<example>
<code>
DupFinder("*.cs");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DupFinder.DupFinderAliases.DupFinder(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern,Cake.Common.Tools.DupFinder.DupFinderSettings)">
<summary>
Analyses all files matching the specified pattern with ReSharper's DupFinder,
using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="pattern">The pattern.</param>
<param name="settings">The settings.</param>
<example>
<code>
var buildOutputDirectory = Directory("./.build");
var resharperReportsDirectory = buildOutputDirectory + Directory("_ReSharperReports");
DupFinder("*.cs", new DupFinderSettings {
OutputFile = resharperReportsDirectory + File("dupfinder-output.xml"),
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.DupFinder.DupFinderAliases.DupFinderFromConfig(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Runs ReSharper's DupFinder using the provided config file.
</summary>
<param name="context">The context.</param>
<param name="configFile">The config file.</param>
<example>
<code>
DupFinderFromConfig("./src/dupfinder.config");
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.DupFinder.DupFinderRunner">
<summary>
DupFinder runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.DupFinder.DupFinderRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Core.Diagnostics.ICakeLog)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.DupFinder.DupFinderRunner"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="log">The logger.</param>
</member>
<member name="M:Cake.Common.Tools.DupFinder.DupFinderRunner.Run(System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.DupFinder.DupFinderSettings)">
<summary>
Analyses the specified files using the specified settings.
</summary>
<param name="filePaths">The file paths.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.DupFinder.DupFinderRunner.RunFromConfig(Cake.Core.IO.FilePath)">
<summary>
Runs ReSharper's DupFinder using the provided config file.
</summary>
<param name="configFile">The config file.</param>
</member>
<member name="M:Cake.Common.Tools.DupFinder.DupFinderRunner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.DupFinder.DupFinderRunner.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="T:Cake.Common.Tools.DupFinder.DupFinderSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.DupFinder.DupFinderRunner"/> .
</summary>
</member>
<member name="P:Cake.Common.Tools.DupFinder.DupFinderSettings.Debug">
<summary>
Gets or sets a value indicating whether the debug output should be enabled.
</summary>
</member>
<member name="P:Cake.Common.Tools.DupFinder.DupFinderSettings.DiscardCost">
<summary>
Gets or sets the complexity threshold for duplicate fragments.
Code fragment with lower complexity are discarded.
</summary>
</member>
<member name="P:Cake.Common.Tools.DupFinder.DupFinderSettings.DiscardFieldsName">
<summary>
Gets or sets a value indicating whether to discard similar fields with different names.
</summary>
</member>
<member name="P:Cake.Common.Tools.DupFinder.DupFinderSettings.DiscardLiterals">
<summary>
Gets or sets a value indicating whether to discard similar lines of code with different literals.
</summary>
</member>
<member name="P:Cake.Common.Tools.DupFinder.DupFinderSettings.DiscardLocalVariablesName">
<summary>
Gets or sets a value indicating whether to discard similar local variables with different names.
</summary>
</member>
<member name="P:Cake.Common.Tools.DupFinder.DupFinderSettings.DiscardTypes">
<summary>
Gets or sets a value indicating whether to discard similar types with different names.
</summary>
</member>
<member name="P:Cake.Common.Tools.DupFinder.DupFinderSettings.IdlePriority">
<summary>
Gets or sets a value indicating whether the process priority should be set to idle.
</summary>
</member>
<member name="P:Cake.Common.Tools.DupFinder.DupFinderSettings.ExcludeFilesByStartingCommentSubstring">
<summary>
Gets or sets a list of keywords to exclude files that contain one of the keywords in their opening comments.
</summary>
</member>
<member name="P:Cake.Common.Tools.DupFinder.DupFinderSettings.ExcludeCodeRegionsByNameSubstring">
<summary>
Gets or sets a list of keywords to exclude regions that contain one of the keywords in their message.
</summary>
</member>
<member name="P:Cake.Common.Tools.DupFinder.DupFinderSettings.ExcludePattern">
<summary>
Gets or sets a lift of patterns which will be excluded from the analysis.
</summary>
</member>
<member name="P:Cake.Common.Tools.DupFinder.DupFinderSettings.MsBuildProperties">
<summary>
Gets or sets MsBuild properties.
</summary>
</member>
<member name="P:Cake.Common.Tools.DupFinder.DupFinderSettings.NormalizeTypes">
<summary>
Gets or sets a value indicating whether to normalize type names to the last subtype.
</summary>
</member>
<member name="P:Cake.Common.Tools.DupFinder.DupFinderSettings.CachesHome">
<summary>
Gets or sets the directory where caches will be stored.
The default is %TEMP%.
</summary>
</member>
<member name="P:Cake.Common.Tools.DupFinder.DupFinderSettings.OutputFile">
<summary>
Gets or sets the location DupFinder should write its output.
</summary>
<value>The location DupFinder should write its output.</value>
</member>
<member name="P:Cake.Common.Tools.DupFinder.DupFinderSettings.ShowStats">
<summary>
Gets or sets a value indicating whether to show CPU and memory usage statistics.
</summary>
</member>
<member name="P:Cake.Common.Tools.DupFinder.DupFinderSettings.ShowText">
<summary>
Gets or sets a value indicating whether to show duplicates text in the report.
</summary>
</member>
<member name="P:Cake.Common.Tools.DupFinder.DupFinderSettings.ThrowExceptionOnFindingDuplicates">
<summary>
Gets or sets a value indicating whether to throw an exception on finding duplicates.
</summary>
</member>
<member name="P:Cake.Common.Tools.DupFinder.DupFinderSettings.SkipOutputAnalysis">
<summary>
Gets or sets a value indicating whether to skip analysis of the file
that was output by the command line tool or not.
</summary>
</member>
<member name="T:Cake.Common.Tools.Fixie.FixieAliases">
<summary>
<para>Contains functionality related to running <see href="https://github.com/fixie/fixie">Fixie</see> tests.</para>
<para>
In order to use the commands for this alias, include the following in your build.cake file to download and
install from nuget.org, or specify the ToolPath within the <see cref="T:Cake.Common.Tools.Fixie.FixieSettings" /> class:
<code>
#tool "nuget:?package=Fixie"
</code>
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.Fixie.FixieAliases.Fixie(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern)">
<summary>
Runs all Fixie tests in the assemblies matching the specified pattern.
</summary>
<example>
<code>
Fixie("./src/UnitTests/*.dll");
</code>
</example>
<param name="context">The context.</param>
<param name="pattern">The pattern.</param>
</member>
<member name="M:Cake.Common.Tools.Fixie.FixieAliases.Fixie(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern,Cake.Common.Tools.Fixie.FixieSettings)">
<summary>
Runs all Fixie tests in the assemblies matching the specified pattern,
using the specified settings.
</summary>
<example>
<code>
Fixie("./src/UnitTests/*.dll", new FixieSettings {
NUnitXml = TestResult.xml
});
</code>
</example>
<param name="context">The context.</param>
<param name="pattern">The pattern.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.Fixie.FixieAliases.Fixie(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{System.String})">
<summary>
Runs all Fixie tests in the specified assemblies.
</summary>
<example>
<code>
var assemblies = new [] {
"UnitTests1.dll",
"UnitTests2.dll"
};
Fixie(assemblies);
</code>
</example>
<param name="context">The context.</param>
<param name="assemblies">The assemblies.</param>
</member>
<member name="M:Cake.Common.Tools.Fixie.FixieAliases.Fixie(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath})">
<summary>
Runs all Fixie tests in the specified assemblies.
</summary>
<example>
<code>
var assemblies = GetFiles("./src/UnitTests/*.dll");
Fixie(assemblies);
</code>
</example>
<param name="context">The context.</param>
<param name="assemblies">The assemblies.</param>
</member>
<member name="M:Cake.Common.Tools.Fixie.FixieAliases.Fixie(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{System.String},Cake.Common.Tools.Fixie.FixieSettings)">
<summary>
Runs all Fixie tests in the specified assemblies,
using the specified settings.
</summary>
<example>
<code>
var assemblies = new [] {
"UnitTests1.dll",
"UnitTests2.dll"
};
Fixie(assemblies, new FixieSettings {
NUnitXml = TestResult.xml
});
</code>
</example>
<param name="context">The context.</param>
<param name="assemblies">The assemblies.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.Fixie.FixieAliases.Fixie(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.Fixie.FixieSettings)">
<summary>
Runs all Fixie tests in the specified assemblies,
using the specified settings.
</summary>
<example>
<code>
var assemblies = GetFiles("./src/UnitTests/*.dll");
Fixie(assemblies, new FixieSettings {
NUnitXml = TestResult.xml
});
</code>
</example>
<param name="context">The context.</param>
<param name="assemblies">The assemblies.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.Fixie.FixieRunner">
<summary>
The Fixie test runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.Fixie.FixieRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.Fixie.FixieRunner"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The globber.</param>
</member>
<member name="M:Cake.Common.Tools.Fixie.FixieRunner.Run(System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.Fixie.FixieSettings)">
<summary>
Runs the tests in the specified assemblies, using the specified settings.
</summary>
<param name="assemblyPaths">The assembly paths.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.Fixie.FixieRunner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.Fixie.FixieRunner.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="T:Cake.Common.Tools.Fixie.FixieSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.Fixie.FixieRunner" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.Fixie.FixieSettings.NUnitXml">
<summary>
Gets or sets the file to be used to output NUnit style of XML results.
</summary>
<value>
The name of the file to write NUnit style of results.
</value>
</member>
<member name="P:Cake.Common.Tools.Fixie.FixieSettings.XUnitXml">
<summary>
Gets or sets the file to be used to output xUnit style of XML results.
</summary>
<value>
The name of the file to write xUnit style of results.
</value>
</member>
<member name="P:Cake.Common.Tools.Fixie.FixieSettings.TeamCity">
<summary>
Gets or sets the the option to force TeamCity-formatted output on or off.
</summary>
<value>
The value of TeamCity-formatted output. Either "on" or "off".
</value>
</member>
<member name="P:Cake.Common.Tools.Fixie.FixieSettings.Options">
<summary>
Gets the collection of Options as KeyValuePairs.
</summary>
<value>
The collection of keys and values.
</value>
</member>
<member name="T:Cake.Common.Tools.Fixie.FixieSettingsExtensions">
<summary>
Contains functionality related to Fixie settings.
</summary>
</member>
<member name="M:Cake.Common.Tools.Fixie.FixieSettingsExtensions.WithOption(Cake.Common.Tools.Fixie.FixieSettings,System.String,System.String[])">
<summary>
Adds an option to the settings.
</summary>
<param name="settings">The settings.</param>
<param name="name">The option name.</param>
<param name="values">The option values.</param>
<returns>The same <see cref="T:Cake.Common.Tools.Fixie.FixieSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="T:Cake.Common.Tools.GitLink.GitLink3Aliases">
<summary>
<para>Contains functionality related to <see href="https://github.com/gittools/gitlink">GitLink</see> version 3.</para>
<para>
In order to use the commands for this alias, include the following in your build.cake file to download and
install from nuget.org, or specify the ToolPath within the <see cref="T:Cake.Common.Tools.GitLink.GitLink3Settings" /> class:
<code>
#tool "nuget:?package=gitlink"
</code>
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.GitLink.GitLink3Aliases.GitLink3(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Update the pdb file to link all sources.
This will allow anyone to step through the source code while debugging without a symbol source server.
</summary>
<param name="context">The context.</param>
<param name="pdbFilePath">The PDB File to analyze.</param>
<example>
<code>
GitLink3("C:/temp/solution/bin/my.pdb");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.GitLink.GitLink3Aliases.GitLink3(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Common.Tools.GitLink.GitLink3Settings)">
<summary>
Update the pdb file to link all sources.
This will allow anyone to step through the source code while debugging without a symbol source server.
</summary>
<param name="context">The context.</param>
<param name="pdbFilePath">The PDB File to analyze.</param>
<param name="settings">The settings.</param>
<example>
<code>
GitLink3("C:/temp/solution/bin/my.pdb", new GitLink3Settings {
RepositoryUrl = "http://mydomain.com",
ShaHash = "abcdef"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.GitLink.GitLink3Aliases.GitLink3(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath})">
<summary>
Update the pdb files to link all sources.
This will allow anyone to step through the source code while debugging without a symbol source server.
</summary>
<param name="context">The context.</param>
<param name="pdbFiles">The PDB File collection to analyze.</param>
<example>
<code>
GitLink3("C:/temp/solution/bin/**/*.pdb");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.GitLink.GitLink3Aliases.GitLink3(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.GitLink.GitLink3Settings)">
<summary>
Update the pdb files to link all sources.
This will allow anyone to step through the source code while debugging without a symbol source server.
</summary>
<param name="context">The context.</param>
<param name="pdbFiles">The PDB File collection to analyze.</param>
<param name="settings">The settings.</param>
<example>
<code>
GitLink3("C:/temp/solution/bin/**/*.pdb", new GitLink3Settings {
RepositoryUrl = "http://mydomain.com",
ShaHash = "abcdef"
});
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.GitLink.GitLink3Runner">
<summary>
GitLink runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.GitLink.GitLink3Runner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.GitLink.GitLink3Runner"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.GitLink.GitLink3Runner.Run(Cake.Core.IO.FilePath,Cake.Common.Tools.GitLink.GitLink3Settings)">
<summary>
Update pdb file to link all sources.
</summary>
<param name="pdbFile">The path to the pdb file to link.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.GitLink.GitLink3Runner.Run(System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.GitLink.GitLink3Settings)">
<summary>
Update pdb files to link all sources.
</summary>
<param name="pdbFiles">The file path collection for the pdb files to link.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.GitLink.GitLink3Runner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.GitLink.GitLink3Runner.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="T:Cake.Common.Tools.GitLink.GitLink3Settings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.GitLink.GitLink3Runner"/> .
</summary>
</member>
<member name="P:Cake.Common.Tools.GitLink.GitLink3Settings.RepositoryUrl">
<summary>
Gets or sets the Url to remote Git repository.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitLink.GitLink3Settings.ShaHash">
<summary>
Gets or sets the SHA-1 hash of the Git commit to be used.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitLink.GitLink3Settings.BaseDir">
<summary>
Gets or sets the path to the root of the Git repository.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitLink.GitLink3Settings.UsePowerShell">
<summary>
Gets or sets a value indicating whether the Use PowerShell Command option should be enabled.
This option will use PowerShell instead of HTTP in SRCSRV to retrieve the source code.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitLink.GitLink3Settings.SkipVerify">
<summary>
Gets or sets a value indicating whether the Skip Verify option should be enabled.
This option indicates whether verification of all source files are available in source control.
</summary>
</member>
<member name="T:Cake.Common.Tools.GitLink.GitLinkAliases">
<summary>
<para>Contains functionality related to <see href="https://github.com/gittools/gitlink">GitLink</see>.</para>
<para>
In order to use the commands for this alias, include the following in your build.cake file to download and
install from nuget.org, or specify the ToolPath within the <see cref="T:Cake.Common.Tools.GitLink.GitLinkSettings" /> class:
<code>
#tool "nuget:?package=gitlink&version=2.4.0"
</code>
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.GitLink.GitLinkAliases.GitLink(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath)">
<summary>
Update pdb files to link all sources.
This will allow anyone to step through the source code while debugging without a symbol source server.
</summary>
<param name="context">The context.</param>
<param name="repositoryRootPath">The Solution File to analyze.</param>
<example>
<code>
GitLink("C:/temp/solution");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.GitLink.GitLinkAliases.GitLink(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath,Cake.Common.Tools.GitLink.GitLinkSettings)">
<summary>
Update pdb files to link all sources, using specified settings.
This will allow anyone to step through the source code while debugging without a symbol source server.
</summary>
<param name="context">The context.</param>
<param name="repositoryRootPath">The path to the Root of the Repository to analyze.</param>
<param name="settings">The settings.</param>
<example>
<code>
GitLink("C:/temp/solution", new GitLinkSettings {
RepositoryUrl = "http://mydomain.com",
Branch = "master",
ShaHash = "abcdef",
});
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.GitLink.GitLinkRunner">
<summary>
GitLink runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.GitLink.GitLinkRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.GitLink.GitLinkRunner"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.GitLink.GitLinkRunner.Run(Cake.Core.IO.DirectoryPath,Cake.Common.Tools.GitLink.GitLinkSettings)">
<summary>
Update pdb files to link all sources.
</summary>
<param name="repositoryRootPath">The path to the Root of the Repository to analyze.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.GitLink.GitLinkRunner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.GitLink.GitLinkRunner.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="T:Cake.Common.Tools.GitLink.GitLinkSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.GitLink.GitLinkRunner"/> .
</summary>
</member>
<member name="P:Cake.Common.Tools.GitLink.GitLinkSettings.RepositoryUrl">
<summary>
Gets or sets the Url to remote Git repository.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitLink.GitLinkSettings.SolutionFileName">
<summary>
Gets or sets the Solution file name.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitLink.GitLinkSettings.Configuration">
<summary>
Gets or sets the name of the configuration.
</summary>
<remarks>Default is Release.</remarks>
</member>
<member name="P:Cake.Common.Tools.GitLink.GitLinkSettings.Platform">
<summary>
Gets or sets the name of the platform.
</summary>
<remarks>Default is AnyCPU.</remarks>
</member>
<member name="P:Cake.Common.Tools.GitLink.GitLinkSettings.Branch">
<summary>
Gets or sets the name of the branch to use on the remote repository.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitLink.GitLinkSettings.LogFilePath">
<summary>
Gets or sets the path to the GitLink log file.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitLink.GitLinkSettings.ShaHash">
<summary>
Gets or sets the SHA-1 hash of the Git commit to be used.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitLink.GitLinkSettings.PdbDirectoryPath">
<summary>
Gets or sets the directory where the PDB files are located.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitLink.GitLinkSettings.UsePowerShell">
<summary>
Gets or sets a value indicating whether the Use PowerShell Command option should be enabled.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitLink.GitLinkSettings.ErrorsAsWarnings">
<summary>
Gets or sets a value indicating whether the ErrorsAsWarnings option should be enabled.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitLink.GitLinkSettings.SkipVerify">
<summary>
Gets or sets a value indicating whether the Skip Verify option should be enabled.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitLink.GitLinkSettings.IsDebug">
<summary>
Gets or sets a value indicating whether the debug output should be enabled.
</summary>
</member>
<member name="T:Cake.Common.Tools.GitReleaseManager.AddAssets.GitReleaseManagerAddAssetsSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.GitReleaseManager.AddAssets.GitReleaseManagerAssetsAdder"/>.
</summary>
</member>
<member name="T:Cake.Common.Tools.GitReleaseManager.AddAssets.GitReleaseManagerAssetsAdder">
<summary>
The GitReleaseManager Asset Adder used to add assets to a release.
</summary>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.AddAssets.GitReleaseManagerAssetsAdder.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.GitReleaseManager.AddAssets.GitReleaseManagerAssetsAdder"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.AddAssets.GitReleaseManagerAssetsAdder.AddAssets(System.String,System.String,System.String,System.String,System.String,System.String,Cake.Common.Tools.GitReleaseManager.AddAssets.GitReleaseManagerAddAssetsSettings)">
<summary>
Creates a Release using the specified and settings.
</summary>
<param name="userName">The user name.</param>
<param name="password">The password.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="tagName">The tag name.</param>
<param name="assets">The assets to upload.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.AddAssets.GitReleaseManagerAssetsAdder.AddAssets(System.String,System.String,System.String,System.String,System.String,Cake.Common.Tools.GitReleaseManager.AddAssets.GitReleaseManagerAddAssetsSettings)">
<summary>
Creates a Release using the specified and settings.
</summary>
<param name="token">The token.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="tagName">The tag name.</param>
<param name="assets">The assets to upload.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.GitReleaseManager.Close.GitReleaseManagerCloseMilestoneSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.GitReleaseManager.Close.GitReleaseManagerMilestoneCloser"/>.
</summary>
</member>
<member name="T:Cake.Common.Tools.GitReleaseManager.Close.GitReleaseManagerMilestoneCloser">
<summary>
The GitReleaseManager Milestone Closer used to close milestones.
</summary>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.Close.GitReleaseManagerMilestoneCloser.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.GitReleaseManager.Close.GitReleaseManagerMilestoneCloser"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.Close.GitReleaseManagerMilestoneCloser.Close(System.String,System.String,System.String,System.String,System.String,Cake.Common.Tools.GitReleaseManager.Close.GitReleaseManagerCloseMilestoneSettings)">
<summary>
Closes a milestone using the specified settings.
</summary>
<param name="userName">The user name.</param>
<param name="password">The password.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="milestone">The milestone.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.Close.GitReleaseManagerMilestoneCloser.Close(System.String,System.String,System.String,System.String,Cake.Common.Tools.GitReleaseManager.Close.GitReleaseManagerCloseMilestoneSettings)">
<summary>
Closes a milestone using the specified settings.
</summary>
<param name="token">The token.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="milestone">The milestone.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.GitReleaseManager.Create.GitReleaseManagerCreateSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.GitReleaseManager.Create.GitReleaseManagerCreator"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitReleaseManager.Create.GitReleaseManagerCreateSettings.Milestone">
<summary>
Gets or sets the milestone to be used when creating the release.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitReleaseManager.Create.GitReleaseManagerCreateSettings.Name">
<summary>
Gets or sets the name to be used when creating the release.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitReleaseManager.Create.GitReleaseManagerCreateSettings.InputFilePath">
<summary>
Gets or sets the location of a set of Release Notes to be used when creating the release.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitReleaseManager.Create.GitReleaseManagerCreateSettings.Prerelease">
<summary>
Gets or sets a value indicating whether or not to create the release as a pre-release.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitReleaseManager.Create.GitReleaseManagerCreateSettings.Assets">
<summary>
Gets or sets the Path(s) to the file(s) to include in the release.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitReleaseManager.Create.GitReleaseManagerCreateSettings.TargetCommitish">
<summary>
Gets or sets the commit to tag. Can be a branch or SHA. Defaults to repository's default branch.
</summary>
</member>
<member name="T:Cake.Common.Tools.GitReleaseManager.Create.GitReleaseManagerCreator">
<summary>
The GitReleaseManager Release Creator used to create releases.
</summary>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.Create.GitReleaseManagerCreator.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.GitReleaseManager.Create.GitReleaseManagerCreator"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.Create.GitReleaseManagerCreator.Create(System.String,System.String,System.String,System.String,Cake.Common.Tools.GitReleaseManager.Create.GitReleaseManagerCreateSettings)">
<summary>
Creates a Release using the specified settings.
</summary>
<param name="userName">The user name.</param>
<param name="password">The password.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.Create.GitReleaseManagerCreator.Create(System.String,System.String,System.String,Cake.Common.Tools.GitReleaseManager.Create.GitReleaseManagerCreateSettings)">
<summary>
Creates a Release using the specified settings.
</summary>
<param name="token">The token.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.GitReleaseManager.Discard.GitReleaseManagerDiscarder">
<summary>
The GitReleaseManager Release Discarder used to discard releases.
</summary>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.Discard.GitReleaseManagerDiscarder.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.GitReleaseManager.Discard.GitReleaseManagerDiscarder"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.Discard.GitReleaseManagerDiscarder.Discard(System.String,System.String,System.String,System.String,Cake.Common.Tools.GitReleaseManager.Discard.GitReleaseManagerDiscardSettings)">
<summary>
Discards a Release using the specified settings.
</summary>
<param name="token">The token.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="milestone">The milestone.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.GitReleaseManager.Discard.GitReleaseManagerDiscardSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.GitReleaseManager.Discard.GitReleaseManagerDiscarder"/>.
</summary>
</member>
<member name="T:Cake.Common.Tools.GitReleaseManager.Export.GitReleaseManagerExporter">
<summary>
The GitReleaseManager Release Publisher used to publish releases.
</summary>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.Export.GitReleaseManagerExporter.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.GitReleaseManager.Export.GitReleaseManagerExporter"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.Export.GitReleaseManagerExporter.Export(System.String,System.String,System.String,System.String,Cake.Core.IO.FilePath,Cake.Common.Tools.GitReleaseManager.Export.GitReleaseManagerExportSettings)">
<summary>
Creates a Release using the specified and settings.
</summary>
<param name="userName">The user name.</param>
<param name="password">The password.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="fileOutputPath">The output path.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.Export.GitReleaseManagerExporter.Export(System.String,System.String,System.String,Cake.Core.IO.FilePath,Cake.Common.Tools.GitReleaseManager.Export.GitReleaseManagerExportSettings)">
<summary>
Creates a Release using the specified and settings.
</summary>
<param name="token">The token.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="fileOutputPath">The output path.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.GitReleaseManager.Export.GitReleaseManagerExportSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.GitReleaseManager.Export.GitReleaseManagerExporter"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitReleaseManager.Export.GitReleaseManagerExportSettings.TagName">
<summary>
Gets or sets the tag name to be used when exporting the release notes.
</summary>
</member>
<member name="T:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerAliases">
<summary>
<para>Contains functionality related to <see href="https://github.com/gittools/gitreleasemanager">GitReleaseManager</see>.</para>
<para>
In order to use the commands for this alias, include the following in your build.cake file to download and
install from nuget.org, or specify the ToolPath within the appropriate settings class:
<code>
#tool "nuget:?package=gitreleasemanager"
</code>
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerAliases.GitReleaseManagerCreate(Cake.Core.ICakeContext,System.String,System.String,System.String)">
<summary>
Creates a Package Release.
</summary>
<param name="context">The context.</param>
<param name="token">The token.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<example>
<code>
GitReleaseManagerCreate("token", "owner", "repo");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerAliases.GitReleaseManagerCreate(Cake.Core.ICakeContext,System.String,System.String,System.String,Cake.Common.Tools.GitReleaseManager.Create.GitReleaseManagerCreateSettings)">
<summary>
Creates a Package Release using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="token">The token.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="settings">The settings.</param>
<example>
<code>
GitReleaseManagerCreate("token", "owner", "repo", new GitReleaseManagerCreateSettings {
Milestone = "0.1.0",
Prerelease = false,
Assets = "c:/temp/asset1.txt,c:/temp/asset2.txt",
TargetCommitish = "master",
TargetDirectory = "c:/repo",
LogFilePath = "c:/temp/grm.log"
});
</code>
</example>
<example>
<code>
GitReleaseManagerCreate("token", "owner", "repo", new GitReleaseManagerCreateSettings {
Name = "0.1.0",
InputFilePath = "c:/repo/releasenotes.md",
Prerelease = false,
Assets = "c:/temp/asset1.txt,c:/temp/asset2.txt",
TargetCommitish = "master",
TargetDirectory = "c:/repo",
LogFilePath = "c:/temp/grm.log"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerAliases.GitReleaseManagerAddAssets(Cake.Core.ICakeContext,System.String,System.String,System.String,System.String,System.String)">
<summary>
Add Assets to an existing release.
</summary>
<param name="context">The context.</param>
<param name="token">The token.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="tagName">The tag name.</param>
<param name="assets">The assets.</param>
<example>
<code>
GitReleaseManagerAddAssets("token", "owner", "repo", "0.1.0", "c:/temp/asset1.txt,c:/temp/asset2.txt");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerAliases.GitReleaseManagerAddAssets(Cake.Core.ICakeContext,System.String,System.String,System.String,System.String,System.String,Cake.Common.Tools.GitReleaseManager.AddAssets.GitReleaseManagerAddAssetsSettings)">
<summary>
Add Assets to an existing release using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="token">The token.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="tagName">The tag name.</param>
<param name="assets">The assets.</param>
<param name="settings">The settings.</param>
<example>
<code>
GitReleaseManagerAddAssets("token", "owner", "repo", "0.1.0", "c:/temp/asset1.txt,c:/temp/asset2.txt", new GitReleaseManagerAddAssetsSettings {
TargetDirectory = "c:/repo",
LogFilePath = "c:/temp/grm.log"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerAliases.GitReleaseManagerClose(Cake.Core.ICakeContext,System.String,System.String,System.String,System.String)">
<summary>
Closes the milestone associated with a release.
</summary>
<param name="context">The context.</param>
<param name="token">The token.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="milestone">The milestone.</param>
<example>
<code>
GitReleaseManagerClose("token", "owner", "repo", "0.1.0");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerAliases.GitReleaseManagerClose(Cake.Core.ICakeContext,System.String,System.String,System.String,System.String,Cake.Common.Tools.GitReleaseManager.Close.GitReleaseManagerCloseMilestoneSettings)">
<summary>
Closes the milestone associated with a release using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="token">The token.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="milestone">The milestone.</param>
<param name="settings">The settings.</param>
<example>
<code>
GitReleaseManagerClose("token", "owner", "repo", "0.1.0", new GitReleaseManagerCloseMilestoneSettings {
TargetDirectory = "c:/repo",
LogFilePath = "c:/temp/grm.log"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerAliases.GitReleaseManagerPublish(Cake.Core.ICakeContext,System.String,System.String,System.String,System.String)">
<summary>
Publishes the release.
</summary>
<param name="context">The context.</param>
<param name="token">The token.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="tagName">The tag name.</param>
<example>
<code>
GitReleaseManagerPublish("token", "owner", "repo", "0.1.0");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerAliases.GitReleaseManagerPublish(Cake.Core.ICakeContext,System.String,System.String,System.String,System.String,Cake.Common.Tools.GitReleaseManager.Publish.GitReleaseManagerPublishSettings)">
<summary>
Publishes the release using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="token">The token.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="tagName">The tag name.</param>
<param name="settings">The settings.</param>
<example>
<code>
GitReleaseManagerPublish("token", "owner", "repo", "0.1.0", new GitReleaseManagerPublishSettings {
TargetDirectory = "c:/repo",
LogFilePath = "c:/temp/grm.log"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerAliases.GitReleaseManagerExport(Cake.Core.ICakeContext,System.String,System.String,System.String,Cake.Core.IO.FilePath)">
<summary>
Exports the release notes.
</summary>
<param name="context">The context.</param>
<param name="token">The token.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="fileOutputPath">The output file path.</param>
<example>
<code>
GitReleaseManagerExport("token", "owner", "repo", "c:/temp/releasenotes.md")
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerAliases.GitReleaseManagerExport(Cake.Core.ICakeContext,System.String,System.String,System.String,Cake.Core.IO.FilePath,Cake.Common.Tools.GitReleaseManager.Export.GitReleaseManagerExportSettings)">
<summary>
Exports the release notes using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="token">The token.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="fileOutputPath">The output file path.</param>
<param name="settings">The settings.</param>
<example>
<code>
GitReleaseManagerExport("token", "owner", "repo", "c:/temp/releasenotes.md", new GitReleaseManagerExportSettings {
TagName = "0.1.0",
TargetDirectory = "c:/repo",
LogFilePath = "c:/temp/grm.log"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerAliases.GitReleaseManagerLabel(Cake.Core.ICakeContext,System.String,System.String,System.String)">
<summary>
Deletes and creates labels.
</summary>
<param name="context">The context.</param>
<param name="token">The token.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<example>
<code>
GitReleaseManagerLabel("token", "owner", "repo");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerAliases.GitReleaseManagerLabel(Cake.Core.ICakeContext,System.String,System.String,System.String,Cake.Common.Tools.GitReleaseManager.Label.GitReleaseManagerLabelSettings)">
<summary>
Deletes and creates labels using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="token">The token.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="settings">The settings.</param>
<example>
<code>
GitReleaseManagerLabel("token", "owner", "repo", new GitReleaseManagerLabelSettings {
LogFilePath = "c:/temp/grm.log"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerAliases.GitReleaseManagerOpen(Cake.Core.ICakeContext,System.String,System.String,System.String,System.String)">
<summary>
Opens the milestone associated with a release.
</summary>
<param name="context">The context.</param>
<param name="token">The token.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="milestone">The milestone.</param>
<example>
<code>
GitReleaseManagerOpen("token", "owner", "repo", "0.1.0");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerAliases.GitReleaseManagerOpen(Cake.Core.ICakeContext,System.String,System.String,System.String,System.String,Cake.Common.Tools.GitReleaseManager.Open.GitReleaseManagerOpenMilestoneSettings)">
<summary>
Opens the milestone associated with a release using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="token">The token.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="milestone">The milestone.</param>
<param name="settings">The settings.</param>
<example>
<code>
GitReleaseManagerOpen("token", "owner", "repo", "0.1.0", new GitReleaseManagerOpenMilestoneSettings {
TargetDirectory = "c:/repo",
LogFilePath = "c:/temp/grm.log"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerAliases.GitReleaseManagerDiscard(Cake.Core.ICakeContext,System.String,System.String,System.String,System.String)">
<summary>
Discards a Release.
</summary>
<param name="context">The context.</param>
<param name="token">The token.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="milestone">The milestone.</param>
<example>
<code>
GitReleaseManagerDiscard("token", "owner", "repo", "0.1.0");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerAliases.GitReleaseManagerDiscard(Cake.Core.ICakeContext,System.String,System.String,System.String,System.String,Cake.Common.Tools.GitReleaseManager.Discard.GitReleaseManagerDiscardSettings)">
<summary>
Discards a Release using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="token">The token.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="milestone">The milestone.</param>
<param name="settings">The settings.</param>
<example>
<code>
GitReleaseManagerDiscard("token", "owner", "repo", "0.1.0", new GitReleaseManagerDiscardSettings {
TargetDirectory = "c:/repo",
LogFilePath = "c:/temp/grm.log"
});
</code>
</example>
<example>
<code>
GitReleaseManagerDiscard("token", "owner", "repo", "0.1.0", new GitReleaseManagerDiscardSettings {
TargetDirectory = "c:/repo",
LogFilePath = "c:/temp/grm.log"
});
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerSettings"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerSettings.TargetDirectory">
<summary>
Gets or sets the path on which GitReleaseManager should be executed.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerSettings.LogFilePath">
<summary>
Gets or sets the path to the GitReleaseManager log file.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerSettings.Debug">
<summary>
Gets or sets a value indicating whether or not to use debug level logging.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerSettings.Verbose">
<summary>
Gets or sets a value indicating whether or not to use verbose level logging.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerSettings.NoLogo">
<summary>
Gets or sets a value indicating whether or not to show the GitReleaseManager logo during execution.
</summary>
</member>
<member name="T:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerTool`1">
<summary>
Base class for all GitReleaseManager related tools.
</summary>
<typeparam name="TSettings">The settings type.</typeparam>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerTool`1.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerTool`1"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerTool`1.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerTool`1.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.GitReleaseManagerTool`1.AddBaseArguments(Cake.Common.Tools.GitReleaseManager.GitReleaseManagerSettings,Cake.Core.IO.ProcessArgumentBuilder)">
<summary>
Adds common arguments to the process builder.
</summary>
<param name="settings">The settings.</param>
<param name="builder">The process argument builder.</param>
<returns>The process argument builder.</returns>
</member>
<member name="T:Cake.Common.Tools.GitReleaseManager.Label.GitReleaseManagerLabeller">
<summary>
The GitReleaseManager Label Creator used to delete and create labels.
</summary>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.Label.GitReleaseManagerLabeller.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.GitReleaseManager.Label.GitReleaseManagerLabeller"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.Label.GitReleaseManagerLabeller.Label(System.String,System.String,System.String,System.String,Cake.Common.Tools.GitReleaseManager.Label.GitReleaseManagerLabelSettings)">
<summary>
Deletes and creates labels using the specified and settings.
</summary>
<param name="userName">The user name.</param>
<param name="password">The password.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.Label.GitReleaseManagerLabeller.Label(System.String,System.String,System.String,Cake.Common.Tools.GitReleaseManager.Label.GitReleaseManagerLabelSettings)">
<summary>
Deletes and creates labels using the specified and settings.
</summary>
<param name="token">The token.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.GitReleaseManager.Label.GitReleaseManagerLabelSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.GitReleaseManager.Label.GitReleaseManagerLabeller"/>.
</summary>
</member>
<member name="T:Cake.Common.Tools.GitReleaseManager.Open.GitReleaseManagerMilestoneOpener">
<summary>
The GitReleaseManager Milestone Opener used to open milestones.
</summary>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.Open.GitReleaseManagerMilestoneOpener.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.GitReleaseManager.Open.GitReleaseManagerMilestoneOpener"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.Open.GitReleaseManagerMilestoneOpener.Open(System.String,System.String,System.String,System.String,Cake.Common.Tools.GitReleaseManager.Open.GitReleaseManagerOpenMilestoneSettings)">
<summary>
Creates a Release using the specified settings.
</summary>
<param name="token">The token.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="milestone">The milestone.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.GitReleaseManager.Open.GitReleaseManagerOpenMilestoneSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.GitReleaseManager.Open.GitReleaseManagerMilestoneOpener"/>.
</summary>
</member>
<member name="T:Cake.Common.Tools.GitReleaseManager.Publish.GitReleaseManagerPublisher">
<summary>
The GitReleaseManager Release Publisher used to publish releases.
</summary>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.Publish.GitReleaseManagerPublisher.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.GitReleaseManager.Publish.GitReleaseManagerPublisher"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.Publish.GitReleaseManagerPublisher.Publish(System.String,System.String,System.String,System.String,System.String,Cake.Common.Tools.GitReleaseManager.Publish.GitReleaseManagerPublishSettings)">
<summary>
Creates a Release using the specified and settings.
</summary>
<param name="userName">The user name.</param>
<param name="password">The password.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="tagName">The tag name.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.GitReleaseManager.Publish.GitReleaseManagerPublisher.Publish(System.String,System.String,System.String,System.String,Cake.Common.Tools.GitReleaseManager.Publish.GitReleaseManagerPublishSettings)">
<summary>
Creates a Release using the specified and settings.
</summary>
<param name="token">The token.</param>
<param name="owner">The owner.</param>
<param name="repository">The repository.</param>
<param name="tagName">The tag name.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.GitReleaseManager.Publish.GitReleaseManagerPublishSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.GitReleaseManager.Publish.GitReleaseManagerPublisher"/>.
</summary>
</member>
<member name="T:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesAliases">
<summary>
<para>Contains functionality related to <see href="https://github.com/gittools/gitreleasenotes">GitReleaseNotes</see>.</para>
<para>
In order to use the commands for this alias, include the following in your build.cake file to download and
install from nuget.org, or specify the ToolPath within the <see cref="T:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesSettings" /> class:
<code>
#tool "nuget:?package=GitReleaseNotes"
</code>
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesAliases.GitReleaseNotes(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesSettings)">
<summary>
Generates a set of release notes based on the commit history of the repository and specified settings.
</summary>
<param name="context">The context.</param>
<param name="outputFile">The output file.</param>
<param name="settings">The settings.</param>
<example>
<code>
GitReleaseNotes("c:/temp/releasenotes.md", new GitReleaseNotesSettings {
WorkingDirectory = "c:/temp",
Verbose = true,
IssueTracker = IssueTracker.GitHub,
AllTags = true,
RepoUserName = "bob",
RepoPassword = "password",
RepoUrl = "http://myrepo.co.uk",
RepoBranch = "master",
IssueTrackerUrl = "http://myissuetracker.co.uk",
IssueTrackerUserName = "bob",
IssueTrackerPassword = "password",
IssueTrackerProjectId = "1234",
Categories = "Category1",
Version = "1.2.3.4",
AllLabels = true
});
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesIssueTracker">
<summary>
The IssueTracker to be used.
</summary>
</member>
<member name="F:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesIssueTracker.BitBucket">
<summary>
Uses BitBucket as Issue Tracker.
</summary>
</member>
<member name="F:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesIssueTracker.GitHub">
<summary>
Uses GitHub as Issue Tracker.
</summary>
</member>
<member name="F:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesIssueTracker.Jira">
<summary>
Uses Jira as Issue Tracker.
</summary>
</member>
<member name="F:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesIssueTracker.YouTrack">
<summary>
Uses YouTrack as Issue Tracker.
</summary>
</member>
<member name="T:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesRunner">
<summary>
The GitReleaseNotes runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesRunner"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesRunner.Run(Cake.Core.IO.FilePath,Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesSettings)">
<summary>
Runs GitVersion and processes the results.
</summary>
<param name="outputFile">The output file.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesRunner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesRunner.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="T:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesRunner" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesSettings.Verbose">
<summary>
Gets or sets a value indicating whether verbose logging is used.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesSettings.IssueTracker">
<summary>
Gets or sets the IssueTracker to use.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesSettings.AllTags">
<summary>
Gets or sets a value indicating whether all tags should be included in the releasenotes.
</summary>
<remarks>If not specified then only the issues since that last tag are included.</remarks>
</member>
<member name="P:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesSettings.RepoUserName">
<summary>
Gets or sets the username to use when accessing repository.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesSettings.RepoPassword">
<summary>
Gets or sets the password to use when accessing repository.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesSettings.RepoToken">
<summary>
Gets or sets the token to use when accessing repository.
</summary>
<remarks>To be used instead of username/password.</remarks>
</member>
<member name="P:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesSettings.RepoUrl">
<summary>
Gets or sets the Url to use when accessing repository.
</summary>
<remarks>To be used instead of username/password.</remarks>
</member>
<member name="P:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesSettings.RepoBranch">
<summary>
Gets or sets the branch name to checkout any existing release notes file.
</summary>
<remarks>To be used instead of username/password.</remarks>
</member>
<member name="P:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesSettings.IssueTrackerUrl">
<summary>
Gets or sets the Url to the Issue Tracker.
</summary>
<remarks>To be used instead of username/password.</remarks>
</member>
<member name="P:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesSettings.IssueTrackerUserName">
<summary>
Gets or sets the username to use when accessing issue tracker.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesSettings.IssueTrackerPassword">
<summary>
Gets or sets the password to use when accessing issue tracker.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesSettings.IssueTrackerToken">
<summary>
Gets or sets the token to use when accessing issue tracker.
</summary>
<remarks>To be used instead of username/password.</remarks>
</member>
<member name="P:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesSettings.IssueTrackerProjectId">
<summary>
Gets or sets the Project Id to use when accessing issue tracker.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesSettings.IssueTrackerFilter">
<summary>
Gets or sets the Jql query for closed issues you would like included if mentioned.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesSettings.Categories">
<summary>
Gets or sets a value which allows additional labels to be treated as categories.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesSettings.Version">
<summary>
Gets or sets a value which specifies the version to publish.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitReleaseNotes.GitReleaseNotesSettings.AllLabels">
<summary>
Gets or sets a value indicating whether all labels should be included in the releasenotes.
</summary>
<remarks>If not specified then only the defaults (bug, enhancement, feature) are included.</remarks>
</member>
<member name="T:Cake.Common.Tools.GitVersion.GitVersion">
<summary>
GitVersion information.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.Major">
<summary>
Gets or sets the major version.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.Minor">
<summary>
Gets or sets the minor version.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.Patch">
<summary>
Gets or sets the patch version.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.PreReleaseTag">
<summary>
Gets or sets the pre-release tag.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.PreReleaseTagWithDash">
<summary>
Gets or sets the pre-release tag with dash.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.PreReleaseLabel">
<summary>
Gets or sets the pre-release label.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.PreReleaseLabelWithDash">
<summary>
Gets or sets the pre-release label with dash.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.PreReleaseNumber">
<summary>
Gets or sets the pre-release number.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.WeightedPreReleaseNumber">
<summary>
Gets or sets the weighted pre-release number.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.BuildMetaData">
<summary>
Gets or sets the build metadata.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.BuildMetaDataPadded">
<summary>
Gets or sets the build metadata padded.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.FullBuildMetaData">
<summary>
Gets or sets the major version.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.MajorMinorPatch">
<summary>
Gets or sets the major, minor, and path.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.SemVer">
<summary>
Gets or sets the Semantic Version.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.LegacySemVer">
<summary>
Gets or sets the legacy Semantic Version.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.LegacySemVerPadded">
<summary>
Gets or sets the padded legacy Semantic Version.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.AssemblySemVer">
<summary>
Gets or sets the assembly Semantic Version.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.AssemblySemFileVer">
<summary>
Gets or sets the assembly semantic file version.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.FullSemVer">
<summary>
Gets or sets the full Semantic Version.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.InformationalVersion">
<summary>
Gets or sets the informational version.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.BranchName">
<summary>
Gets or sets the branch name.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.EscapedBranchName">
<summary>
Gets or sets the escaped branch name.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.Sha">
<summary>
Gets or sets the Git SHA.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.ShortSha">
<summary>
Gets or sets the shortened Git SHA.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.NuGetVersionV2">
<summary>
Gets or sets the NuGet version for v2.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.NuGetVersion">
<summary>
Gets or sets the NuGet version.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.NuGetPreReleaseTagV2">
<summary>
Gets or sets the NuGet pre-release tag for v2.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.NuGetPreReleaseTag">
<summary>
Gets or sets the NuGet pre-release tag.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.VersionSourceSha">
<summary>
Gets or sets the version source sha.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.CommitsSinceVersionSource">
<summary>
Gets or sets the commits since version source.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.CommitsSinceVersionSourcePadded">
<summary>
Gets or sets the commits since version source padded.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.UncommittedChanges">
<summary>
Gets or sets the number of uncommited changes.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersion.CommitDate">
<summary>
Gets or sets the commit date.
</summary>
</member>
<member name="T:Cake.Common.Tools.GitVersion.GitVersionAliases">
<summary>
<para>Contains functionality related to <see href="https://github.com/gittools/gitversion">GitVersion</see>.</para>
<para>
In order to use the commands for this alias, include the following in your build.cake file to download and
install from nuget.org, or specify the ToolPath within the <see cref="T:Cake.Common.Tools.GitVersion.GitVersionSettings" /> class:
<code>
#tool "dotnet:?package=GitVersion.Tool"
</code>
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.GitVersion.GitVersionAliases.GitVersion(Cake.Core.ICakeContext)">
<summary>
Retrieves the GitVersion output.
</summary>
<param name="context">The context.</param>
<returns>The Git version info.</returns>
<example>
<para>Update the assembly info files for the project.</para>
<para>Cake task:</para>
<code>
<![CDATA[
Task("UpdateAssemblyInfo")
.Does(() =>
{
GitVersion(new GitVersionSettings {
UpdateAssemblyInfo = true
});
});
]]>
</code>
<para>Get the Git version info for the project using a dynamic repository.</para>
<para>Cake task:</para>
<code>
<![CDATA[
Task("GetVersionInfo")
.Does(() =>
{
var result = GitVersion(new GitVersionSettings {
UserName = "MyUser",
Password = "MyPassword,
Url = "http://git.myhost.com/myproject.git"
Branch = "develop"
Commit = EnvironmentVariable("MY_COMMIT")
});
// Use result for building NuGet packages, setting build server version, etc...
});
]]>
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.GitVersion.GitVersionAliases.GitVersion(Cake.Core.ICakeContext,Cake.Common.Tools.GitVersion.GitVersionSettings)">
<summary>
Retrieves the GitVersion output.
</summary>
<param name="context">The context.</param>
<param name="settings">The GitVersion settings.</param>
<returns>The Git version info.</returns>
<example>
<para>Update the assembly info files for the project.</para>
<para>Cake task:</para>
<code>
<![CDATA[
Task("UpdateAssemblyInfo")
.Does(() =>
{
GitVersion(new GitVersionSettings {
UpdateAssemblyInfo = true
});
});
]]>
</code>
<para>Get the Git version info for the project using a dynamic repository.</para>
<para>Cake task:</para>
<code>
<![CDATA[
Task("GetVersionInfo")
.Does(() =>
{
var result = GitVersion(new GitVersionSettings {
UserName = "MyUser",
Password = "MyPassword,
Url = "http://git.myhost.com/myproject.git"
Branch = "develop"
Commit = EnvironmentVariable("MY_COMMIT")
});
// Use result for building NuGet packages, setting build server version, etc...
});
]]>
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.GitVersion.GitVersionOutput">
<summary>
The Git version output type.
</summary>
</member>
<member name="F:Cake.Common.Tools.GitVersion.GitVersionOutput.Json">
<summary>
Outputs to the stdout using json.
</summary>
</member>
<member name="F:Cake.Common.Tools.GitVersion.GitVersionOutput.BuildServer">
<summary>
Outputs to the stdout in a way usable by a detected build server.
</summary>
</member>
<member name="F:Cake.Common.Tools.GitVersion.GitVersionOutput.File">
<summary>
Outputs to a file, as specified in the OutputFile parameter.
</summary>
</member>
<member name="T:Cake.Common.Tools.GitVersion.GitVersionRunner">
<summary>
The GitVersion runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.GitVersion.GitVersionRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Core.Diagnostics.ICakeLog)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.GitVersion.GitVersionRunner"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="log">The log.</param>
</member>
<member name="M:Cake.Common.Tools.GitVersion.GitVersionRunner.Run(Cake.Common.Tools.GitVersion.GitVersionSettings)">
<summary>
Runs GitVersion and processes the results.
</summary>
<param name="settings">The settings.</param>
<returns>A task with the GitVersion results.</returns>
</member>
<member name="M:Cake.Common.Tools.GitVersion.GitVersionRunner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.GitVersion.GitVersionRunner.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="T:Cake.Common.Tools.GitVersion.GitVersionSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.GitVersion.GitVersionRunner" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersionSettings.RepositoryPath">
<summary>
Gets or sets the path for the Git repository to use.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersionSettings.OutputType">
<summary>
Gets or sets the output type.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersionSettings.OutputFile">
<summary>
Gets or sets the path to a file to store the asserted GitVersion numbers in JSON format.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersionSettings.ConfigFile">
<summary>
Gets or sets the path to config file.
</summary>
<remarks>Defaults to GitVersion.yml.</remarks>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersionSettings.UpdateAssemblyInfo">
<summary>
Gets or sets a value indicating whether to update all the AssemblyInfo files.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersionSettings.UpdateAssemblyInfoFilePath">
<summary>
Gets or sets whether to update all the AssemblyInfo files.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersionSettings.UpdateProjectFiles">
<summary>
Gets or sets a value indicating whether to recursively search for all project files (.csproj/.vbproj/.fsproj) files in the git repo and update them.
</summary>
<remarks>This is only compatible with the newer Sdk projects.</remarks>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersionSettings.EnsureAssemblyInfo">
<summary>
Gets or sets a value indicating whether if the assembly info file specified with /updateassemblyinfo or /updateassemblyinfofilename is not found, it be created with these attributes: AssemblyFileVersion, AssemblyVersion and AssemblyInformationalVersion.
</summary>
<remarks>Supports writing version info for: C#, F#, VB.</remarks>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersionSettings.UpdateWixVersionFile">
<summary>
Gets or sets a value indicating whether all the GitVersion variables are written to 'GitVersion_WixVersion.wxi'. The variables can then be referenced in other WiX project files for versioning.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersionSettings.ShowVariable">
<summary>
Gets or sets whether to only show a specific variable.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersionSettings.UserName">
<summary>
Gets or sets the username for the target repository.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersionSettings.Password">
<summary>
Gets or sets the password for the target repository.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersionSettings.Url">
<summary>
Gets or sets the Git URL to use if using dynamic repositories.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersionSettings.Branch">
<summary>
Gets or sets the branch to use if using dynamic repositories.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersionSettings.Commit">
<summary>
Gets or sets the branch to use if using dynamic repositories.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersionSettings.NoFetch">
<summary>
Gets or sets a value indicating whether to fetch repository information from remote when calculating version.
</summary>
<remarks>If your CI server clones the entire repository you can set this to 'true' to prevent GitVersion attempting any remote repository fetching.</remarks>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersionSettings.NoCache">
<summary>
Gets or sets a value indicating whether to bypass the cached GitVersion result. Result will not be written to the cache.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersionSettings.NoNormalize">
<summary>
Gets or sets a value indicating whether to disable normalize step on a build server.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersionSettings.Diag">
<summary>
Gets or sets a value indicating whether to run GitVersion with additional diagnostic information.
</summary>
<remarks>Requires git.exe to be installed.</remarks>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersionSettings.DynamicRepositoryPath">
<summary>
Gets or sets the dynamic repository path. Defaults to %TEMP%.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersionSettings.LogFilePath">
<summary>
Gets or sets the path to the log file.
</summary>
</member>
<member name="P:Cake.Common.Tools.GitVersion.GitVersionSettings.Verbosity">
<summary>
Gets or sets the logging verbosity.
</summary>
</member>
<member name="T:Cake.Common.Tools.GitVersion.GitVersionVerbosity">
<summary>
The GitVersion verbosity. Default is <see cref="F:Cake.Common.Tools.GitVersion.GitVersionVerbosity.Normal"/>.
</summary>
</member>
<member name="F:Cake.Common.Tools.GitVersion.GitVersionVerbosity.Quiet">
<summary>
Quiet verbosity.
</summary>
</member>
<member name="F:Cake.Common.Tools.GitVersion.GitVersionVerbosity.Minimal">
<summary>
Minimal verbosity.
</summary>
</member>
<member name="F:Cake.Common.Tools.GitVersion.GitVersionVerbosity.Normal">
<summary>
Normal verbosity (Default).
</summary>
</member>
<member name="F:Cake.Common.Tools.GitVersion.GitVersionVerbosity.Verbose">
<summary>
Verbose verbosity.
</summary>
</member>
<member name="F:Cake.Common.Tools.GitVersion.GitVersionVerbosity.Diagnostic">
<summary>
Diagnostic verbosity.
</summary>
</member>
<member name="T:Cake.Common.Tools.ILRepack.ILRepackAliases">
<summary>
<para>Contains functionality related to <see href="https://github.com/gluck/il-repack">ILRepack</see>.</para>
<para>
In order to use the commands for this alias, include the following in your build.cake file to download and
install from nuget.org, or specify the ToolPath within the <see cref="T:Cake.Common.Tools.ILRepack.ILRepackSettings" /> class:
<code>
#tool "nuget:?package=ILRepack"
</code>
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.ILRepack.ILRepackAliases.ILRepack(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Core.IO.FilePath,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath})">
<summary>
Merges the specified assemblies.
</summary>
<param name="context">The context.</param>
<param name="outputFile">The output file.</param>
<param name="primaryAssembly">The primary assembly.</param>
<param name="assemblyPaths">The assembly paths.</param>
<example>
<code>
var assemblyPaths = GetFiles("./**/Cake.*.dll");
ILRepack("./MergedCake.exe", "./Cake.exe", assemblyPaths);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.ILRepack.ILRepackAliases.ILRepack(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Core.IO.FilePath,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.ILRepack.ILRepackSettings)">
<summary>
Merges the specified assemblies.
</summary>
<param name="context">The context.</param>
<param name="outputFile">The output file.</param>
<param name="primaryAssembly">The primary assembly.</param>
<param name="assemblyPaths">The assembly paths.</param>
<param name="settings">The settings.</param>
<example>
<code>
var assemblyPaths = GetFiles("./**/Cake.*.dll");
ILRepack(
"./MergedCake.exe",
"./Cake.exe",
assemblyPaths,
new ILRepackSettings { Internalize = true });
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.ILRepack.ILRepackRunner">
<summary>
The ILMerge runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.ILRepack.ILRepackRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.ILRepack.ILRepackRunner" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.ILRepack.ILRepackRunner.Merge(Cake.Core.IO.FilePath,Cake.Core.IO.FilePath,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.ILRepack.ILRepackSettings)">
<summary>
Merges the specified assemblies.
</summary>
<param name="outputAssemblyPath">The output assembly path.</param>
<param name="primaryAssemblyPath">The primary assembly path.</param>
<param name="assemblyPaths">The assembly paths.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.ILRepack.ILRepackRunner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.ILRepack.ILRepackRunner.GetToolExecutableNames">
<summary>
Gets the name of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="T:Cake.Common.Tools.ILRepack.ILRepackSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.ILRepack.ILRepackRunner"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.ILRepack.ILRepackSettings.Keyfile">
<summary>
Gets or sets a keyfile to sign the output assembly.
</summary>
<value>The keyfile.</value>
</member>
<member name="P:Cake.Common.Tools.ILRepack.ILRepackSettings.Log">
<summary>
Gets or sets a file to enable logging to (no logging if null or empty).
</summary>
<value>The log file.</value>
</member>
<member name="P:Cake.Common.Tools.ILRepack.ILRepackSettings.Version">
<summary>
Gets or sets the target assembly version.
</summary>
<value>The version.</value>
</member>
<member name="P:Cake.Common.Tools.ILRepack.ILRepackSettings.Union">
<summary>
Gets or sets a value indicating whether to merge types with identical names into one.
</summary>
<value><c>true</c> if types with identical names should be merged into one; otherwise, <c>false</c>.</value>
</member>
<member name="P:Cake.Common.Tools.ILRepack.ILRepackSettings.NDebug">
<summary>
Gets or sets a value indicating whether to disable symbol file generation.
</summary>
<value><c>true</c> if debug symbols should be disabled; otherwise, <c>false</c>.</value>
</member>
<member name="P:Cake.Common.Tools.ILRepack.ILRepackSettings.CopyAttrs">
<summary>
Gets or sets a value indicating whether to copy assembly attributes (by default only the primary assembly attributes are copied).
</summary>
<value><c>true</c> if assembly attributes should be copied; otherwise, <c>false</c>.</value>
</member>
<member name="P:Cake.Common.Tools.ILRepack.ILRepackSettings.Attr">
<summary>
Gets or sets the assembly file to take attributes from.
</summary>
<value>The assembly file to take attributes from.</value>
</member>
<member name="P:Cake.Common.Tools.ILRepack.ILRepackSettings.AllowMultiple">
<summary>
Gets or sets a value indicating whether to allow multiple attributes (if type allows).
</summary>
<value><c>true</c> if multiple attributes should be allowed; otherwise, <c>false</c>.</value>
</member>
<member name="P:Cake.Common.Tools.ILRepack.ILRepackSettings.TargetKind">
<summary>
Gets or sets the specify target assembly kind (library, exe, winexe supported, default is same as first assembly).
</summary>
<value>The kind of the target assembly to create.</value>
</member>
<member name="P:Cake.Common.Tools.ILRepack.ILRepackSettings.TargetPlatform">
<summary>
Gets or sets the target platform (v1, v1.1, v2, v4 supported).
</summary>
<value>The target platform.</value>
</member>
<member name="P:Cake.Common.Tools.ILRepack.ILRepackSettings.XmlDocs">
<summary>
Gets or sets a value indicating whether to merge XML documentation as well.
</summary>
<value><c>true</c> if xml documents should be merged; otherwise, <c>false</c>.</value>
</member>
<member name="P:Cake.Common.Tools.ILRepack.ILRepackSettings.Libs">
<summary>
Gets or sets the paths to search directories for referenced assemblies (can be specified multiple times).
</summary>
<value>The libs.</value>
</member>
<member name="P:Cake.Common.Tools.ILRepack.ILRepackSettings.Internalize">
<summary>
Gets or sets a value indicating whether to set all types but the ones from the first assembly 'internal'.
</summary>
<value>
<c>true</c> if types in assemblies other than the primary assembly should
have their visibility modified to internal; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.ILRepack.ILRepackSettings.DelaySign">
<summary>
Gets or sets a value indicating whether to set the key, but don't sign the assembly.
</summary>
<value><c>true</c> if assembly should be delay signed; otherwise, <c>false</c>.</value>
</member>
<member name="P:Cake.Common.Tools.ILRepack.ILRepackSettings.AllowDup">
<summary>
Gets or sets the specified type for being duplicated in input assemblies.
</summary>
<value>The type to allow duplication of.</value>
</member>
<member name="P:Cake.Common.Tools.ILRepack.ILRepackSettings.AllowDuplicateResources">
<summary>
Gets or sets a value indicating whether to duplicate resources in output assembly (by default they're ignored).
</summary>
<value><c>true</c> if duplicate resources should be allowed in the output assembly; otherwise, <c>false</c>.</value>
</member>
<member name="P:Cake.Common.Tools.ILRepack.ILRepackSettings.ZeroPeKind">
<summary>
Gets or sets a value indicating whether to allow assemblies with Zero PeKind (but obviously only IL will get merged).
</summary>
<value><c>true</c> if assemblies with Zero PeKind should be allowed; otherwise, <c>false</c>.</value>
</member>
<member name="P:Cake.Common.Tools.ILRepack.ILRepackSettings.Wildcards">
<summary>
Gets or sets a value indicating whether to allow (and resolve) file wildcards (e.g. `*`.dll) in input assemblies.
</summary>
<value><c>true</c> if file wildcards should be allowed in input assembly paths; otherwise, <c>false</c>.</value>
</member>
<member name="P:Cake.Common.Tools.ILRepack.ILRepackSettings.Parallel">
<summary>
Gets or sets a value indicating whether to use as many CPUs as possible to merge the assemblies.
</summary>
<value><c>true</c> if merging should use as many CPUs as possible in parallel; otherwise, <c>false</c>.</value>
</member>
<member name="P:Cake.Common.Tools.ILRepack.ILRepackSettings.Pause">
<summary>
Gets or sets a value indicating whether to pause execution once completed (good for debugging).
</summary>
<value><c>true</c> if execution should pause once completed; otherwise, <c>false</c>.</value>
</member>
<member name="P:Cake.Common.Tools.ILRepack.ILRepackSettings.Verbose">
<summary>
Gets or sets a value indicating whether to show more logs.
</summary>
<value><c>true</c> if more logs should be output during execution; otherwise, <c>false</c>.</value>
</member>
<member name="T:Cake.Common.Tools.InnoSetup.InnoSetupAliases">
<summary>
<para>Contains functionality related to <see href="http://www.jrsoftware.org/isinfo.php">Inno Setup</see>.</para>
<para>
In order to use the commands for this alias, Inno Setup will need to be installed on the machine where
the Cake script is being executed. See this <see href="http://www.jrsoftware.org/isdl.php">page</see> for information
on how to download/install.
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.InnoSetup.InnoSetupAliases.InnoSetup(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Compiles the given Inno Setup script using the default settings.
</summary>
<param name="context">The context.</param>
<param name="scriptFile">The path to the <c>.iss</c> script file to compile.</param>
<example>
<code>
InnoSetup("./src/Cake.iss");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.InnoSetup.InnoSetupAliases.InnoSetup(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Common.Tools.InnoSetup.InnoSetupSettings)">
<summary>
Compiles the given Inno Setup script using the given <paramref name="settings"/>.
</summary>
<param name="context">The context.</param>
<param name="scriptFile">The path to the <c>.iss</c> script file to compile.</param>
<param name="settings">The <see cref="T:Cake.Common.Tools.InnoSetup.InnoSetupSettings"/> to use.</param>
<example>
<code>
InnoSetup("./src/Cake.iss", new InnoSetupSettings {
OutputDirectory = outputDirectory
});
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.InnoSetup.InnoSetupQuietMode">
<summary>
Represents the possible quiet modes when compiling an Inno Setup script.
</summary>
</member>
<member name="F:Cake.Common.Tools.InnoSetup.InnoSetupQuietMode.Off">
<summary>
Quiet mode disabled. This is the default value.
</summary>
</member>
<member name="F:Cake.Common.Tools.InnoSetup.InnoSetupQuietMode.Quiet">
<summary>
Quiet mode. Only error messages are printed.
</summary>
</member>
<member name="F:Cake.Common.Tools.InnoSetup.InnoSetupQuietMode.QuietWithProgress">
<summary>
Quiet mode with progress. Same as quiet mode, but also displays progress.
</summary>
</member>
<member name="T:Cake.Common.Tools.InnoSetup.InnoSetupRunner">
<summary>
The runner which executes Inno Setup.
</summary>
</member>
<member name="M:Cake.Common.Tools.InnoSetup.InnoSetupRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.IO.IRegistry,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.InnoSetup.InnoSetupRunner"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="registry">The registry.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.InnoSetup.InnoSetupRunner.Run(Cake.Core.IO.FilePath,Cake.Common.Tools.InnoSetup.InnoSetupSettings)">
<summary>
Runs <c>iscc.exe</c> with the specified script files and settings.
</summary>
<param name="scriptFile">The script file (<c>.iss</c>) to compile.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.InnoSetup.InnoSetupRunner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.InnoSetup.InnoSetupRunner.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="M:Cake.Common.Tools.InnoSetup.InnoSetupRunner.GetAlternativeToolPaths(Cake.Common.Tools.InnoSetup.InnoSetupSettings)">
<summary>
Gets alternative file paths which the tool may exist in.
</summary>
<param name="settings">The settings.</param>
<returns>The default tool path.</returns>
</member>
<member name="T:Cake.Common.Tools.InnoSetup.InnoSetupSettings">
<summary>
Contains settings used by the <see cref="T:Cake.Common.Tools.InnoSetup.InnoSetupRunner"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.InnoSetup.InnoSetupSettings.Defines">
<summary>
Gets or sets the script compiler defines. Emulates <c>#define public</c> preprocessor directive.
</summary>
</member>
<member name="P:Cake.Common.Tools.InnoSetup.InnoSetupSettings.EnableOutput">
<summary>
Gets or sets whether or not the compiler should generate output (<c>/O+</c> and <c>/O-</c> command line options,
overrides the script's <c>Output</c> attribute).
</summary>
</member>
<member name="P:Cake.Common.Tools.InnoSetup.InnoSetupSettings.OutputDirectory">
<summary>
Gets or sets the output directory (<c>/O<path></c> command line option, overrides the script's <c>OutputDir</c>
attribute).
</summary>
</member>
<member name="P:Cake.Common.Tools.InnoSetup.InnoSetupSettings.OutputBaseFilename">
<summary>
Gets or sets the output base file name (<c>/F<filename></c> command line option, overrides the script's
<c>OutputBaseFilename</c> attribute).
</summary>
</member>
<member name="P:Cake.Common.Tools.InnoSetup.InnoSetupSettings.QuietMode">
<summary>
Gets or sets the script compiler's quiet mode (<c>/Q</c> and <c>/Qp</c> command line options).
</summary>
</member>
<member name="P:Cake.Common.Tools.InnoSetup.InnoSetupSettings.Version">
<summary>
Gets or sets the version of Inno Setup to be used with this command. By default the highest installed version of Inno Setup is used.
</summary>
</member>
<member name="M:Cake.Common.Tools.InnoSetup.InnoSetupSettings.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.InnoSetup.InnoSetupSettings"/> class with the default settings.
</summary>
</member>
<member name="T:Cake.Common.Tools.InnoSetup.InnoSetupVersion">
<summary>
Represents the supported major versions of Inno Setup.
</summary>
</member>
<member name="F:Cake.Common.Tools.InnoSetup.InnoSetupVersion.InnoSetup5">
<summary>Version 5.x</summary>
</member>
<member name="F:Cake.Common.Tools.InnoSetup.InnoSetupVersion.InnoSetup6">
<summary>Version 6.x</summary>
</member>
<member name="T:Cake.Common.Tools.InspectCode.InspectCodeAliases">
<summary>
<para>Contains functionality related to ReSharper's <see href="https://www.jetbrains.com/help/resharper/2016.1/InspectCode.html">InspectCode</see> tool.</para>
<para>
In order to use the commands for this alias, include the following in your build.cake file to download and
install from nuget.org, or specify the ToolPath within the <see cref="T:Cake.Common.Tools.InspectCode.InspectCodeSettings" /> class:
<code>
#tool "nuget:?package=JetBrains.ReSharper.CommandLineTools"
</code>
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.InspectCode.InspectCodeAliases.InspectCode(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Analyses the specified solution with ReSharper's InspectCode.
</summary>
<param name="context">The context.</param>
<param name="solution">The solution.</param>
<example>
<code>
InspectCode("./src/MySolution.sln");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.InspectCode.InspectCodeAliases.InspectCode(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Common.Tools.InspectCode.InspectCodeSettings)">
<summary>
Analyses the specified solution with ReSharper's InspectCode,
using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="solution">The solution.</param>
<param name="settings">The settings.</param>
<example>
<code>
var buildOutputDirectory = Directory("./.build");
var resharperReportsDirectory = buildOutputDirectory + Directory("_ReSharperReports");
var msBuildProperties = new Dictionary<string, string>();
msBuildProperties.Add("configuration", configuration);
msBuildProperties.Add("platform", "AnyCPU");
InspectCode("./MySolution.sln", new InspectCodeSettings {
SolutionWideAnalysis = true,
Profile = "./MySolution.sln.DotSettings",
MsBuildProperties = msBuildProperties,
OutputFile = resharperReportsDirectory + File("inspectcode-output.xml"),
ThrowExceptionOnFindingViolations = true
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.InspectCode.InspectCodeAliases.InspectCodeFromConfig(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Runs ReSharper's InspectCode using the specified config file.
</summary>
<param name="context">The context.</param>
<param name="configFile">The config file.</param>
<example>
<code>
InspectCodeFromConfig("./src/inspectcode.config");
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.InspectCode.InspectCodeRunner">
<summary>
InspectCode runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.InspectCode.InspectCodeRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator,Cake.Core.Diagnostics.ICakeLog)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.InspectCode.InspectCodeRunner"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
<param name="log">The logger.</param>
</member>
<member name="M:Cake.Common.Tools.InspectCode.InspectCodeRunner.Run(Cake.Core.IO.FilePath,Cake.Common.Tools.InspectCode.InspectCodeSettings)">
<summary>
Analyses the specified solution, using the specified settings.
</summary>
<param name="solution">The solution.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.InspectCode.InspectCodeRunner.RunFromConfig(Cake.Core.IO.FilePath)">
<summary>
Runs ReSharper's InspectCode using the provided config file.
</summary>
<param name="configFile">The config file.</param>
</member>
<member name="M:Cake.Common.Tools.InspectCode.InspectCodeRunner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.InspectCode.InspectCodeRunner.GetToolExecutableNames(Cake.Common.Tools.InspectCode.InspectCodeSettings)">
<summary>
Gets the possible names of the tool executable.
</summary>
<param name="settings">The settings.</param>
<returns>The tool executable name.</returns>
</member>
<member name="M:Cake.Common.Tools.InspectCode.InspectCodeRunner.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="T:Cake.Common.Tools.InspectCode.InspectCodeSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.InspectCode.InspectCodeRunner" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.InspectCode.InspectCodeSettings.OutputFile">
<summary>
Gets or sets the location InspectCode should write its output.
</summary>
<value>The location that InspectCode should write its output.</value>
</member>
<member name="P:Cake.Common.Tools.InspectCode.InspectCodeSettings.SolutionWideAnalysis">
<summary>
Gets or sets a value indicating whether enable solution-wide analysis should be forced.
Default value is <c>false</c>.
</summary>
<value>
<c>true</c> if solution-wide analysis should be enabled by force; otherwise, <c>fault</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.InspectCode.InspectCodeSettings.NoSolutionWideAnalysis">
<summary>
Gets or sets a value indicating whether disable solution-wide analysis should be forced.
Default value is <c>false</c>.
</summary>
<value>
<c>true</c> if solution-wide analysis should be disabled by force; otherwise, <c>fault</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.InspectCode.InspectCodeSettings.ProjectFilter">
<summary>
Gets or sets a filter to analyze only particular project(s) instead of the whole solution.
Supports wildcards.
</summary>
<value>The filter to analyze only particular projects(s).</value>
</member>
<member name="P:Cake.Common.Tools.InspectCode.InspectCodeSettings.MsBuildProperties">
<summary>
Gets or sets MSBuild properties.
</summary>
<value>The MSBuild properties to override.</value>
</member>
<member name="P:Cake.Common.Tools.InspectCode.InspectCodeSettings.Extensions">
<summary>
Gets or sets a list of ReSharper extensions which will be used.
</summary>
</member>
<member name="P:Cake.Common.Tools.InspectCode.InspectCodeSettings.CachesHome">
<summary>
Gets or sets the directory where caches will be stored.
The default is %TEMP%.
</summary>
<value>The directory where caches will be stored.</value>
</member>
<member name="P:Cake.Common.Tools.InspectCode.InspectCodeSettings.Debug">
<summary>
Gets or sets a value indicating whether the debug output should be enabled.
</summary>
<value>
<c>true</c> if the debug output should be enabled; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.InspectCode.InspectCodeSettings.NoBuildinSettings">
<summary>
Gets or sets a value indicating whether all global, solution and project settings should be ignored.
Alias for disabling the settings layers GlobalAll, GlobalPerProduct, SolutionShared, SolutionPersonal, ProjectShared and ProjectPersonal.
</summary>
</member>
<member name="P:Cake.Common.Tools.InspectCode.InspectCodeSettings.DisabledSettingsLayers">
<summary>
Gets or sets a list of <c>InspectCodeSettings</c> which will be disabled.
</summary>
</member>
<member name="P:Cake.Common.Tools.InspectCode.InspectCodeSettings.Profile">
<summary>
Gets or sets the path to the file to use custom settings from.
</summary>
</member>
<member name="P:Cake.Common.Tools.InspectCode.InspectCodeSettings.ThrowExceptionOnFindingViolations">
<summary>
Gets or sets a value indicating whether to throw an exception on finding violations.
</summary>
</member>
<member name="P:Cake.Common.Tools.InspectCode.InspectCodeSettings.UseX86Tool">
<summary>
Gets or sets a value indicating whether to use x86 tool.
</summary>
</member>
<member name="P:Cake.Common.Tools.InspectCode.InspectCodeSettings.Verbosity">
<summary>
Gets or sets the verbosity level of the log messages.
</summary>
</member>
<member name="P:Cake.Common.Tools.InspectCode.InspectCodeSettings.Severity">
<summary>
Gets or sets the minimal severity of issues to report.
</summary>
</member>
<member name="P:Cake.Common.Tools.InspectCode.InspectCodeSettings.SkipOutputAnalysis">
<summary>
Gets or sets a value indicating whether to skip analysis of the file
that was output by the command line tool or not.
</summary>
</member>
<member name="P:Cake.Common.Tools.InspectCode.InspectCodeSettings.Build">
<summary>
Gets or sets a value indicating whether to build or not-build the
sources before running the tool. Setting this value is only valid
for InspectCode version 2021.2.0 and later.
<para>
<list type="bullet">
<item><description>
Setting this property to <c>true</c> will result in passing the '--build' option.
</description></item>
<item><description>
Setting this property to <c>false</c> will result in passing the '--no-build' option.
</description></item>
<item><description>
Setting this property to <c>null</c> will result in no changes to the options. This is the default
and the only valid setting for versions before 2021.2.
</description></item>
</list>
</para>
</summary>
<remarks>
Starting from version 2021.2, InspectCode builds the target solution before starting the analysis
to make sure it only finds relevant code issues.
To explicitly accept the new behavior and suppress this warning, use the '--build' option.
To match the behavior in previous versions and skip the build, use '--no-build'.
</remarks>
</member>
<member name="T:Cake.Common.Tools.InspectCode.InspectCodeSeverity">
<summary>
Represents InspectCode's minimal severity report.
</summary>
</member>
<member name="F:Cake.Common.Tools.InspectCode.InspectCodeSeverity.Info">
<summary>
Severity: INFO.
</summary>
</member>
<member name="F:Cake.Common.Tools.InspectCode.InspectCodeSeverity.Hint">
<summary>
Severity: HINT.
</summary>
</member>
<member name="F:Cake.Common.Tools.InspectCode.InspectCodeSeverity.Suggestion">
<summary>
Severity: SUGGESTION.
</summary>
</member>
<member name="F:Cake.Common.Tools.InspectCode.InspectCodeSeverity.Warning">
<summary>
Severity: WARNING.
</summary>
</member>
<member name="F:Cake.Common.Tools.InspectCode.InspectCodeSeverity.Error">
<summary>
Severity: ERROR.
</summary>
</member>
<member name="T:Cake.Common.Tools.InspectCode.InspectCodeVerbosity">
<summary>
Represents InspectCode's logging verbosity.
</summary>
</member>
<member name="F:Cake.Common.Tools.InspectCode.InspectCodeVerbosity.Off">
<summary>
Verbosity: OFF.
</summary>
</member>
<member name="F:Cake.Common.Tools.InspectCode.InspectCodeVerbosity.Fatal">
<summary>
Verbosity: FATAL.
</summary>
</member>
<member name="F:Cake.Common.Tools.InspectCode.InspectCodeVerbosity.Error">
<summary>
Verbosity: ERROR.
</summary>
</member>
<member name="F:Cake.Common.Tools.InspectCode.InspectCodeVerbosity.Warn">
<summary>
Verbosity: WARN.
</summary>
</member>
<member name="F:Cake.Common.Tools.InspectCode.InspectCodeVerbosity.Info">
<summary>
Verbosity: INFO.
</summary>
</member>
<member name="F:Cake.Common.Tools.InspectCode.InspectCodeVerbosity.Verbose">
<summary>
Verbosity: VERBOSE.
</summary>
</member>
<member name="F:Cake.Common.Tools.InspectCode.InspectCodeVerbosity.Trace">
<summary>
Verbosity: TRACE.
</summary>
</member>
<member name="T:Cake.Common.Tools.InspectCode.SettingsLayer">
<summary>
Represents ReSharper's settings layers.
</summary>
</member>
<member name="F:Cake.Common.Tools.InspectCode.SettingsLayer.GlobalAll">
<summary>
SettingsLayer: <c>GlobalAll</c>.
</summary>
</member>
<member name="F:Cake.Common.Tools.InspectCode.SettingsLayer.GlobalPerProduct">
<summary>
SettingsLayer: <c>GlobalPerProduct</c>.
</summary>
</member>
<member name="F:Cake.Common.Tools.InspectCode.SettingsLayer.SolutionShared">
<summary>
SettingsLayer: <c>SolutionShared</c>. This layer is saved in <c>%SolutionName%.sln.DotSettings</c>
</summary>
</member>
<member name="F:Cake.Common.Tools.InspectCode.SettingsLayer.SolutionPersonal">
<summary>
SettingsLayer: <c>SolutionPersonal</c>. This layer is saved in <c>%SolutionName%.sln.DotSettings.user</c>.
</summary>
</member>
<member name="F:Cake.Common.Tools.InspectCode.SettingsLayer.ProjectShared">
<summary>
SettingsLayer: <c>ProjectShared</c>. This layer is saved in <c>%ProjectName%.csproj.DotSettings</c>.
</summary>
</member>
<member name="F:Cake.Common.Tools.InspectCode.SettingsLayer.ProjectPersonal">
<summary>
SettingsLayer: <c>ProjectPersonal</c>. This layer is saved in <c>%ProjectName%.csproj.DotSettings.user</c>.
</summary>
</member>
<member name="T:Cake.Common.Tools.MSpec.MSpecAliases">
<summary>
<para>Contains functionality related to running <see href="https://github.com/machine/machine.specifications">Machine.Specifications</see> tests.</para>
<para>
In order to use the commands for this alias, include the following in your build.cake file to download and
install from nuget.org, or specify the ToolPath within the <see cref="T:Cake.Common.Tools.MSpec.MSpecSettings" /> class:
<code>
#tool "nuget:?package=Machine.Specifications.Runner.Console"
</code>
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.MSpec.MSpecAliases.MSpec(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern)">
<summary>
Runs all MSpec tests in the assemblies matching the specified pattern.
</summary>
<param name="context">The context.</param>
<param name="pattern">The pattern.</param>
<example>
<code>
MSpec("./src/**/bin/Release/*.Tests.dll");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.MSpec.MSpecAliases.MSpec(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern,Cake.Common.Tools.MSpec.MSpecSettings)">
<summary>
Runs all MSpec tests in the assemblies matching the specified pattern.
</summary>
<param name="context">The context.</param>
<param name="pattern">The pattern.</param>
<param name="settings">The settings.</param>
<example>
<code>
MSpec("./src/**/bin/Release/*.Tests.dll",
new MSpecSettings {
Parallelism = ParallelismOption.All,
HtmlReport = true,
NoAppDomain = true,
OutputDirectory = "./build"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.MSpec.MSpecAliases.MSpec(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{System.String})">
<summary>
Runs all MSpec tests in the specified assemblies.
</summary>
<param name="context">The context.</param>
<param name="assemblies">The assemblies.</param>
<example>
<code>
MSpec(new []{
"./src/Cake.Common.Tests/bin/Release/Cake.Common.Tests.dll",
"./src/Cake.Core.Tests/bin/Release/Cake.Core.Tests.dll",
"./src/Cake.NuGet.Tests/bin/Release/Cake.NuGet.Tests.dll",
"./src/Cake.Tests/bin/Release/Cake.Tests.dll"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.MSpec.MSpecAliases.MSpec(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath})">
<summary>
Runs all MSpec tests in the specified assemblies.
</summary>
<param name="context">The context.</param>
<param name="assemblies">The assemblies.</param>
<example>
<code>
var testAssemblies = GetFiles("./src/**/bin/Release/*.Tests.dll");
MSpec(testAssemblies);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.MSpec.MSpecAliases.MSpec(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{System.String},Cake.Common.Tools.MSpec.MSpecSettings)">
<summary>
Runs all MSpec tests in the specified assemblies.
</summary>
<param name="context">The context.</param>
<param name="assemblies">The assemblies.</param>
<param name="settings">The settings.</param>
<example>
<code>
MSpec(new []{
"./src/Cake.Common.Tests/bin/Release/Cake.Common.Tests.dll",
"./src/Cake.Core.Tests/bin/Release/Cake.Core.Tests.dll",
"./src/Cake.NuGet.Tests/bin/Release/Cake.NuGet.Tests.dll",
"./src/Cake.Tests/bin/Release/Cake.Tests.dll"
},
new MSpecSettings {
Parallelism = ParallelismOption.All,
HtmlReport = true,
NoAppDomain = true,
OutputDirectory = "./build"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.MSpec.MSpecAliases.MSpec(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.MSpec.MSpecSettings)">
<summary>
Runs all MSpec tests in the specified assemblies.
</summary>
<param name="context">The context.</param>
<param name="assemblies">The assemblies.</param>
<param name="settings">The settings.</param>
<example>
<code>
var testAssemblies = GetFiles("./src/**/bin/Release/*.Tests.dll");
MSpec(testAssemblies,
new MSpecSettings {
Parallelism = ParallelismOption.All,
HtmlReport = true,
NoAppDomain = true,
OutputDirectory = "./build"
});
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.MSpec.MSpecRunner">
<summary>
The MSpec unit test runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.MSpec.MSpecRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.MSpec.MSpecRunner"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.MSpec.MSpecRunner.Run(System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.MSpec.MSpecSettings)">
<summary>
Runs the tests in the specified assemblies, using the specified settings.
</summary>
<param name="assemblyPaths">The assembly paths.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.MSpec.MSpecRunner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.MSpec.MSpecRunner.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="T:Cake.Common.Tools.MSpec.MSpecSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.MSpec.MSpecRunner" />.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSpec.MSpecSettings.Filters">
<summary>
Gets or sets the path to the filter file specifying contexts to execute(full type name, one per line). Takes precedence over
tags.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSpec.MSpecSettings.TeamCity">
<summary>
Gets or sets a value indicating whether reporting for TeamCity CI integration(also auto - detected).
</summary>
<value>
<c>true</c> to turn on TeamCity service messages; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.MSpec.MSpecSettings.NoColor">
<summary>
Gets or sets a value indicating whether to suppress colored console output.
</summary>
<value>
<c>true</c> disable color output; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.MSpec.MSpecSettings.XmlReport">
<summary>
Gets or sets a value indicating whether an XML report should be generated.
</summary>
<value>
<c>true</c> if an XML report should be generated; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.MSpec.MSpecSettings.HtmlReport">
<summary>
Gets or sets a value indicating whether an HTML report should be generated.
</summary>
<value>
<c>true</c> if an HTML report should be generated; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.MSpec.MSpecSettings.ReportName">
<summary>
Gets or sets the name that should be used for the HTML and XML reports.
</summary>
<value>The custom report name.</value>
</member>
<member name="P:Cake.Common.Tools.MSpec.MSpecSettings.Include">
<summary>
Gets or sets Executes all specifications in contexts with these comma delimited tags. Ex. - i "foo,bar,foo_bar".
</summary>
</member>
<member name="P:Cake.Common.Tools.MSpec.MSpecSettings.Exclude">
<summary>
Gets or sets Exclude specifications in contexts with these comma delimited tags. Ex. - x "foo,bar,foo_bar".
</summary>
</member>
<member name="P:Cake.Common.Tools.MSpec.MSpecSettings.TimeInfo">
<summary>
Gets or sets a value indicating whether to show time-related information in HTML output.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSpec.MSpecSettings.Silent">
<summary>
Gets or sets a value indicating whether to suppress progress output(print fatal errors, failures and summary).
</summary>
</member>
<member name="P:Cake.Common.Tools.MSpec.MSpecSettings.Progress">
<summary>
Gets or sets a value indicating whether to print dotted progress output.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSpec.MSpecSettings.Wait">
<summary>
Gets or sets a value indicating whether to wait 15 seconds for debugger to be attached.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSpec.MSpecSettings.NoTeamCity">
<summary>
Gets or sets a value indicating whether to disable TeamCity autodetection.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSpec.MSpecSettings.AppVeyor">
<summary>
Gets or sets a value indicating whether to enable reporting for AppVeyor CI integration (also auto-detected).
</summary>
</member>
<member name="P:Cake.Common.Tools.MSpec.MSpecSettings.NoAppVeyor">
<summary>
Gets or sets a value indicating whether to disable AppVeyor autodetection.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSpec.MSpecSettings.OutputDirectory">
<summary>
Gets or sets output directory for reports.
</summary>
</member>
<member name="P:Cake.Common.Tools.MSpec.MSpecSettings.UseX86">
<summary>
Gets or sets a value indicating whether to use X86.
</summary>
</member>
<member name="T:Cake.Common.Tools.NSIS.MakeNSISRunner">
<summary>
The runner which executes NSIS.
</summary>
</member>
<member name="M:Cake.Common.Tools.NSIS.MakeNSISRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.NSIS.MakeNSISRunner"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.NSIS.MakeNSISRunner.Run(Cake.Core.IO.FilePath,Cake.Common.Tools.NSIS.MakeNSISSettings)">
<summary>
Runs <c>makensis.exe</c> with the specified script files and settings.
</summary>
<param name="scriptFile">The script file (<c>.nsi</c>) to compile.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.NSIS.MakeNSISRunner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.NSIS.MakeNSISRunner.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="T:Cake.Common.Tools.NSIS.MakeNSISSettings">
<summary>
Contains settings used by the <see cref="T:Cake.Common.Tools.NSIS.MakeNSISRunner"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.NSIS.MakeNSISSettings.Defines">
<summary>
Gets or sets the script compiler defines.
</summary>
</member>
<member name="P:Cake.Common.Tools.NSIS.MakeNSISSettings.NoChangeDirectory">
<summary>
Gets or sets a value indicating whether to disable current directory change to that of the script file.
</summary>
</member>
<member name="P:Cake.Common.Tools.NSIS.MakeNSISSettings.NoConfig">
<summary>
Gets or sets a value indicating whether to disable inclusion of the <c>nsisconf.nsh</c> file.
</summary>
</member>
<member name="T:Cake.Common.Tools.NSIS.NSISAliases">
<summary>
<para>Contains functionality related to <see href="http://nsis.sourceforge.net/Main_Page">NSIS</see>.</para>
<para>
In order to use the commands for this alias, NSIS will need to be installed on the machine where
the Cake script is being executed. See this <see href="http://nsis.sourceforge.net/Download">page</see> for information
on how to download/install.
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.NSIS.NSISAliases.MakeNSIS(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Compiles the given NSIS script using the default settings.
</summary>
<param name="context">The context.</param>
<param name="scriptFile">The path to the <c>.nsi</c> script file to compile.</param>
<example>
<code>
MakeNSIS("./src/Cake.nsi");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.NSIS.NSISAliases.MakeNSIS(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Common.Tools.NSIS.MakeNSISSettings)">
<summary>
Compiles the given NSIS script using the given <paramref name="settings"/>.
</summary>
<param name="context">The context.</param>
<param name="scriptFile">The path to the <c>.nsi</c> script file to compile.</param>
<param name="settings">The <see cref="T:Cake.Common.Tools.NSIS.MakeNSISSettings"/> to use.</param>
<example>
<code>
MakeNSIS("./src/Cake.nsi", new MakeNSISSettings {
NoConfig = true
});
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.OpenCover.OpenCoverAliases">
<summary>
<para>Contains functionality related to <see href="https://github.com/opencover/opencover">OpenCover</see>.</para>
<para>
In order to use the commands for this alias, include the following in your build.cake file to download and
install from nuget.org, or specify the ToolPath within the <see cref="T:Cake.Common.Tools.OpenCover.OpenCoverSettings" /> class:
<code>
#tool "nuget:?package=OpenCover"
</code>
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.OpenCover.OpenCoverAliases.OpenCover(Cake.Core.ICakeContext,System.Action{Cake.Core.ICakeContext},Cake.Core.IO.FilePath,Cake.Common.Tools.OpenCover.OpenCoverSettings)">
<summary>
Runs <see href="https://github.com/OpenCover/opencover">OpenCover</see>
for the specified action and settings.
</summary>
<param name="context">The context.</param>
<param name="action">The action to run OpenCover for.</param>
<param name="outputFile">The OpenCover output file.</param>
<param name="settings">The settings.</param>
<example>
<code>
OpenCover(tool => {
tool.XUnit2("./**/App.Tests.dll",
new XUnit2Settings {
ShadowCopy = false
});
},
new FilePath("./result.xml"),
new OpenCoverSettings()
.WithFilter("+[App]*")
.WithFilter("-[App.Tests]*"));
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.OpenCover.OpenCoverHideSkippedOption">
<summary>
Represents the hide skipped option for OpenCover.
</summary>
</member>
<member name="F:Cake.Common.Tools.OpenCover.OpenCoverHideSkippedOption.None">
<summary>
Removes no information from output file.
</summary>
</member>
<member name="F:Cake.Common.Tools.OpenCover.OpenCoverHideSkippedOption.File">
<summary>
Removes information from output files that relates to classes/modules that have been skipped (filtered) due to use of the -excludebyfile -switch.
</summary>
</member>
<member name="F:Cake.Common.Tools.OpenCover.OpenCoverHideSkippedOption.Filter">
<summary>
Removes information from output files that relates to classes/modules that have been skipped (filtered) due to use of the -filter -switch.
</summary>
</member>
<member name="F:Cake.Common.Tools.OpenCover.OpenCoverHideSkippedOption.Attribute">
<summary>
Removes information from output files that relates to classes/modules that have been skipped (filtered) due to use of the -excludebyattribute -switch.
</summary>
</member>
<member name="F:Cake.Common.Tools.OpenCover.OpenCoverHideSkippedOption.MissingPdb">
<summary>
Removes missing Pdb information from output file.
</summary>
</member>
<member name="F:Cake.Common.Tools.OpenCover.OpenCoverHideSkippedOption.All">
<summary>
Removes all information from output file.
</summary>
</member>
<member name="T:Cake.Common.Tools.OpenCover.OpenCoverHideSkippedOptionExtensions">
<summary>
Extensions class for <see cref="T:Cake.Common.Tools.OpenCover.OpenCoverHideSkippedOption"/>.
</summary>
</member>
<member name="M:Cake.Common.Tools.OpenCover.OpenCoverHideSkippedOptionExtensions.GetFlags(Cake.Common.Tools.OpenCover.OpenCoverHideSkippedOption)">
<summary>
Get flags.
</summary>
<param name="openCoverHideSkippedOption">
The input.
</param>
<returns>
The <see cref="T:System.Collections.IEnumerable"/>.
</returns>
</member>
<member name="T:Cake.Common.Tools.OpenCover.OpenCoverLogLevel">
<summary>
Represents the logging output level for OpenCover.
</summary>
</member>
<member name="F:Cake.Common.Tools.OpenCover.OpenCoverLogLevel.Info">
<summary>
Logs info messages and above (default)
</summary>
</member>
<member name="F:Cake.Common.Tools.OpenCover.OpenCoverLogLevel.Off">
<summary>
This log level disables logging
</summary>
</member>
<member name="F:Cake.Common.Tools.OpenCover.OpenCoverLogLevel.Fatal">
<summary>
Logs fatal messages
</summary>
</member>
<member name="F:Cake.Common.Tools.OpenCover.OpenCoverLogLevel.Error">
<summary>
Logs error messages and above
</summary>
</member>
<member name="F:Cake.Common.Tools.OpenCover.OpenCoverLogLevel.Warn">
<summary>
Logs warn messages and above
</summary>
</member>
<member name="F:Cake.Common.Tools.OpenCover.OpenCoverLogLevel.Debug">
<summary>
Logs debug messages and above
</summary>
</member>
<member name="F:Cake.Common.Tools.OpenCover.OpenCoverLogLevel.Verbose">
<summary>
Logs verbose messages and above
</summary>
</member>
<member name="F:Cake.Common.Tools.OpenCover.OpenCoverLogLevel.All">
<summary>
Logs all messages
</summary>
</member>
<member name="T:Cake.Common.Tools.OpenCover.OpenCoverRegisterOption">
<summary>
Represents the register-options:
<list type="bullet">
<item>
<term>empty</term>
<description>Registers and de-register the code coverage profiler. (Administrative permissions to the registry are required.)</description>
</item>
<item>
<term>"user"</term>
<description>Does per-user registration where the user account does not have administrative permissions.</description>
</item>
<item>
<term>path</term>
<description>If you do not want to use the registry entries, use -register:path to select the profiler.</description>
</item>
</list>
</summary>
</member>
<member name="M:Cake.Common.Tools.OpenCover.OpenCoverRegisterOption.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.OpenCover.OpenCoverRegisterOption"/> class.
</summary>
<param name="commandLineValue">The value, as required for the commandline.</param>
<remarks>
Note that no value (<c>null</c> or <c>string.Empty</c>) is valid.
However, if a value exists it NEEDS to start with a colon (":").
</remarks>
</member>
<member name="M:Cake.Common.Tools.OpenCover.OpenCoverRegisterOption.ToString">
<summary>
Converts to string.
</summary>
<returns>
A <see cref="T:System.String" /> that represents this instance.
</returns>
</member>
<member name="M:Cake.Common.Tools.OpenCover.OpenCoverRegisterOption.op_Implicit(System.String)~Cake.Common.Tools.OpenCover.OpenCoverRegisterOption">
<summary>
Performs an implicit conversion from <see cref="T:System.String"/> to <see cref="T:Cake.Common.Tools.OpenCover.OpenCoverRegisterOption"/>.
(Since the switch from pure string to <see cref="T:Cake.Common.Tools.OpenCover.OpenCoverRegisterOption"/> is a breaking change.)
</summary>
<param name="option">The option.</param>
<returns>
The result of the conversion.
</returns>
</member>
<member name="T:Cake.Common.Tools.OpenCover.OpenCoverRegisterOptionUser">
<summary>
Gets the register-option representing the "user"-mode.
(This will translate to "-register:user".)
</summary>
<seealso cref="T:Cake.Common.Tools.OpenCover.OpenCoverRegisterOption" />
</member>
<member name="M:Cake.Common.Tools.OpenCover.OpenCoverRegisterOptionUser.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.OpenCover.OpenCoverRegisterOptionUser"/> class.
</summary>
</member>
<member name="T:Cake.Common.Tools.OpenCover.OpenCoverRegisterOptionAdmin">
<summary>
Gets the register-option representing the "admin"-mode.
(This will translate to "-register".)
</summary>
<seealso cref="T:Cake.Common.Tools.OpenCover.OpenCoverRegisterOption" />
</member>
<member name="M:Cake.Common.Tools.OpenCover.OpenCoverRegisterOptionAdmin.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.OpenCover.OpenCoverRegisterOptionAdmin"/> class.
</summary>
</member>
<member name="T:Cake.Common.Tools.OpenCover.OpenCoverRegisterOptionDll">
<summary>
Gets a register-option pointing to a dll.
(This will translate to "-register:[path-to-dll]".)
</summary>
<seealso cref="T:Cake.Common.Tools.OpenCover.OpenCoverRegisterOption" />
</member>
<member name="M:Cake.Common.Tools.OpenCover.OpenCoverRegisterOptionDll.#ctor(Cake.Core.IO.FilePath)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.OpenCover.OpenCoverRegisterOptionDll"/> class.
</summary>
<param name="pathToDll">Path to the dll.</param>
</member>
<member name="T:Cake.Common.Tools.OpenCover.OpenCoverRunner">
<summary>
The OpenCover runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.OpenCover.OpenCoverRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.OpenCover.OpenCoverRunner"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.OpenCover.OpenCoverRunner.Run(Cake.Core.ICakeContext,System.Action{Cake.Core.ICakeContext},Cake.Core.IO.FilePath,Cake.Common.Tools.OpenCover.OpenCoverSettings)">
<summary>
Runs OpenCover with the specified settings.
</summary>
<param name="context">The context.</param>
<param name="action">The action.</param>
<param name="outputPath">The output file path.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.OpenCover.OpenCoverRunner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.OpenCover.OpenCoverRunner.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="T:Cake.Common.Tools.OpenCover.OpenCoverSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.OpenCover.OpenCoverRunner"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.OpenCover.OpenCoverSettings.Filters">
<summary>
Gets the filters.
This represents the <c>-filter</c> option.
</summary>
<value>The filters.</value>
</member>
<member name="P:Cake.Common.Tools.OpenCover.OpenCoverSettings.ExcludedAttributeFilters">
<summary>
Gets attribute filters used to exclude classes or methods.
This represents the <c>-excludebyattribute</c> option.
</summary>
<value>The excluded attributes.</value>
</member>
<member name="P:Cake.Common.Tools.OpenCover.OpenCoverSettings.ExcludedFileFilters">
<summary>
Gets file filters used to excluded classes or methods.
This represents the <c>-excludebyfile</c> option.
</summary>
<value>The excluded file filters.</value>
</member>
<member name="P:Cake.Common.Tools.OpenCover.OpenCoverSettings.SkipAutoProps">
<summary>
Gets or sets a value indicating whether or not auto-implemented properties should be skipped.
</summary>
</member>
<member name="P:Cake.Common.Tools.OpenCover.OpenCoverSettings.Register">
<summary>
Gets or sets the register option.
</summary>
</member>
<member name="P:Cake.Common.Tools.OpenCover.OpenCoverSettings.ReturnTargetCodeOffset">
<summary>
Gets or sets the Return target code offset to be used.
</summary>
</member>
<member name="P:Cake.Common.Tools.OpenCover.OpenCoverSettings.OldStyle">
<summary>
Gets or sets a value indicating whether the OldStyle option for OpenCover should be used.
</summary>
</member>
<member name="P:Cake.Common.Tools.OpenCover.OpenCoverSettings.MergeOutput">
<summary>
Gets or sets a value indicating whether to merge the results with an existing file.
</summary>
</member>
<member name="P:Cake.Common.Tools.OpenCover.OpenCoverSettings.ExcludeDirectories">
<summary>
Gets a list of directories where assemblies being loaded from will be ignored.
</summary>
</member>
<member name="P:Cake.Common.Tools.OpenCover.OpenCoverSettings.LogLevel">
<summary>
Gets or sets the log level of OpenCover.
</summary>
</member>
<member name="P:Cake.Common.Tools.OpenCover.OpenCoverSettings.HideSkippedOption">
<summary>
Gets or sets the hide skipped option of OpenCover.
</summary>
</member>
<member name="P:Cake.Common.Tools.OpenCover.OpenCoverSettings.MergeByHash">
<summary>
Gets or sets a value indicating whether to merge the coverage results for an assembly
regardless of where it was loaded assuming it has the same file-hash in each location.
</summary>
</member>
<member name="P:Cake.Common.Tools.OpenCover.OpenCoverSettings.NoDefaultFilters">
<summary>
Gets or sets a value indicating whether the default filters should be applied or not.
</summary>
</member>
<member name="P:Cake.Common.Tools.OpenCover.OpenCoverSettings.SearchDirectories">
<summary>
Gets a list of directories with alternative locations to look for PDBs.
</summary>
</member>
<member name="P:Cake.Common.Tools.OpenCover.OpenCoverSettings.IsService">
<summary>
Gets or sets a value indicating whether if the value provided in the target parameter
is the name of a service rather than a name of a process.
</summary>
</member>
<member name="P:Cake.Common.Tools.OpenCover.OpenCoverSettings.TargetDirectory">
<summary>
Gets or sets a value indicating the path to the target directory.
If the target already contains a path, this parameter can be used
as additional path where PDBs may be found.
</summary>
</member>
<member name="M:Cake.Common.Tools.OpenCover.OpenCoverSettings.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.OpenCover.OpenCoverSettings"/> class.
</summary>
</member>
<member name="T:Cake.Common.Tools.OpenCover.OpenCoverSettingsExtensions">
<summary>
Contains extensions for <see cref="T:Cake.Common.Tools.OpenCover.OpenCoverSettings"/>.
</summary>
</member>
<member name="M:Cake.Common.Tools.OpenCover.OpenCoverSettingsExtensions.WithFilter(Cake.Common.Tools.OpenCover.OpenCoverSettings,System.String)">
<summary>
Adds the filter.
</summary>
<param name="settings">The settings.</param>
<param name="filter">The filter.</param>
<returns>The same <see cref="T:Cake.Common.Tools.OpenCover.OpenCoverSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.OpenCover.OpenCoverSettingsExtensions.ExcludeByAttribute(Cake.Common.Tools.OpenCover.OpenCoverSettings,System.String)">
<summary>
Exclude a class or method by filter
that match attributes that have been applied.
</summary>
<param name="settings">The settings.</param>
<param name="filter">The filter.</param>
<returns>The same <see cref="T:Cake.Common.Tools.OpenCover.OpenCoverSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.OpenCover.OpenCoverSettingsExtensions.ExcludeByFile(Cake.Common.Tools.OpenCover.OpenCoverSettings,System.String)">
<summary>
Exclude a class (or methods) by filter that match the filenames.
</summary>
<param name="settings">The settings.</param>
<param name="filter">The filter.</param>
<returns>The same <see cref="T:Cake.Common.Tools.OpenCover.OpenCoverSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.OpenCover.OpenCoverSettingsExtensions.WithoutRegister(Cake.Common.Tools.OpenCover.OpenCoverSettings)">
<summary>
Sets the register-option to "none".
</summary>
<param name="settings">The settings.</param>
<returns>The same <see cref="T:Cake.Common.Tools.OpenCover.OpenCoverSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.OpenCover.OpenCoverSettingsExtensions.WithRegisterAdmin(Cake.Common.Tools.OpenCover.OpenCoverSettings)">
<summary>
Sets the register-option to admin-registry-access.
</summary>
<param name="settings">The settings.</param>
<returns>The same <see cref="T:Cake.Common.Tools.OpenCover.OpenCoverSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.OpenCover.OpenCoverSettingsExtensions.WithRegisterUser(Cake.Common.Tools.OpenCover.OpenCoverSettings)">
<summary>
Sets the register-option to user-registry-access.
</summary>
<param name="settings">The settings.</param>
<returns>The same <see cref="T:Cake.Common.Tools.OpenCover.OpenCoverSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.OpenCover.OpenCoverSettingsExtensions.WithRegisterDll(Cake.Common.Tools.OpenCover.OpenCoverSettings,Cake.Core.IO.FilePath)">
<summary>
Sets the register-option to dll-registration (i.e no registry-access).
</summary>
<param name="settings">The settings.</param>
<param name="path">The path.</param>
<returns>The same <see cref="T:Cake.Common.Tools.OpenCover.OpenCoverSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="T:Cake.Common.Tools.ReportGenerator.ReportGeneratorAliases">
<summary>
<para>Contains functionality related to <see href="https://github.com/danielpalme/ReportGenerator">ReportGenerator</see>.</para>
<para>
In order to use the commands for this alias, include the following in your build.cake file to download and
install from nuget.org, or specify the ToolPath within the <see cref="T:Cake.Common.Tools.ReportGenerator.ReportGeneratorSettings" /> class:
<code>
#tool "nuget:?package=ReportGenerator"
</code>
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.ReportGenerator.ReportGeneratorAliases.ReportGenerator(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern,Cake.Core.IO.DirectoryPath)">
<summary>
Converts the coverage report specified by the glob pattern into human readable form.
</summary>
<param name="context">The context.</param>
<param name="pattern">The glob pattern.</param>
<param name="targetDir">The output directory.</param>
<example>
<code>
ReportGenerator("c:/temp/coverage/*.xml", "c:/temp/output");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.ReportGenerator.ReportGeneratorAliases.ReportGenerator(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern,Cake.Core.IO.DirectoryPath,Cake.Common.Tools.ReportGenerator.ReportGeneratorSettings)">
<summary>
Converts the coverage report specified by the glob pattern into human readable form using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="pattern">The glob pattern.</param>
<param name="targetDir">The output directory.</param>
<param name="settings">The settings.</param>
<example>
<code>
ReportGenerator("c:/temp/coverage/*.xml", "c:/temp/output", new ReportGeneratorSettings(){
ToolPath = "c:/tools/reportgenerator.exe"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.ReportGenerator.ReportGeneratorAliases.ReportGenerator(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Core.IO.DirectoryPath)">
<summary>
Converts the specified coverage report into human readable form.
</summary>
<param name="context">The context.</param>
<param name="report">The coverage report.</param>
<param name="targetDir">The output directory.</param>
<example>
<code>
ReportGenerator("c:/temp/coverage/report.xml", "c:/temp/output");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.ReportGenerator.ReportGeneratorAliases.ReportGenerator(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Core.IO.DirectoryPath,Cake.Common.Tools.ReportGenerator.ReportGeneratorSettings)">
<summary>
Converts the specified coverage report into human readable form using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="report">The coverage report.</param>
<param name="targetDir">The output directory.</param>
<param name="settings">The settings.</param>
<example>
<code>
ReportGenerator("c:/temp/coverage.xml", "c:/temp/output", new ReportGeneratorSettings(){
ToolPath = "c:/tools/reportgenerator.exe"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.ReportGenerator.ReportGeneratorAliases.ReportGenerator(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Core.IO.DirectoryPath)">
<summary>
Converts the specified coverage reports into human readable form.
</summary>
<param name="context">The context.</param>
<param name="reports">The coverage reports.</param>
<param name="targetDir">The output directory.</param>
<example>
<code>
ReportGenerator(new[] { "c:/temp/coverage1.xml", "c:/temp/coverage2.xml" }, "c:/temp/output");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.ReportGenerator.ReportGeneratorAliases.ReportGenerator(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Core.IO.DirectoryPath,Cake.Common.Tools.ReportGenerator.ReportGeneratorSettings)">
<summary>
Converts the specified coverage reports into human readable form using the specified settings.
</summary>
<param name="context">The context.</param>
<param name="reports">The coverage reports.</param>
<param name="targetDir">The output directory.</param>
<param name="settings">The settings.</param>>
<example>
<code>
ReportGenerator(new[] { "c:/temp/coverage1.xml", "c:/temp/coverage2.xml" }, "c:/temp/output", new ReportGeneratorSettings(){
ToolPath = "c:/tools/reportgenerator.exe"
});
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.ReportGenerator.ReportGeneratorReportType">
<summary>
Represents ReportGenerator's output formats.
</summary>
</member>
<member name="F:Cake.Common.Tools.ReportGenerator.ReportGeneratorReportType.Badges">
<summary>
Badge report.
</summary>
</member>
<member name="F:Cake.Common.Tools.ReportGenerator.ReportGeneratorReportType.Html">
<summary>
Html report.
</summary>
</member>
<member name="F:Cake.Common.Tools.ReportGenerator.ReportGeneratorReportType.HtmlSummary">
<summary>
Html summary report.
</summary>
</member>
<member name="F:Cake.Common.Tools.ReportGenerator.ReportGeneratorReportType.Latex">
<summary>
Latex report.
</summary>
</member>
<member name="F:Cake.Common.Tools.ReportGenerator.ReportGeneratorReportType.LatexSummary">
<summary>
Latex summary report.
</summary>
</member>
<member name="F:Cake.Common.Tools.ReportGenerator.ReportGeneratorReportType.TextSummary">
<summary>
Text summary report.
</summary>
</member>
<member name="F:Cake.Common.Tools.ReportGenerator.ReportGeneratorReportType.Xml">
<summary>
Xml report.
</summary>
</member>
<member name="F:Cake.Common.Tools.ReportGenerator.ReportGeneratorReportType.XmlSummary">
<summary>
Xml summary report.
</summary>
</member>
<member name="F:Cake.Common.Tools.ReportGenerator.ReportGeneratorReportType.Cobertura">
<summary>
Cobertura report
</summary>
</member>
<member name="F:Cake.Common.Tools.ReportGenerator.ReportGeneratorReportType.CsvSummary">
<summary>
CSV summary report
</summary>
</member>
<member name="F:Cake.Common.Tools.ReportGenerator.ReportGeneratorReportType.HtmlChart">
<summary>
HTML Chart report
</summary>
</member>
<member name="F:Cake.Common.Tools.ReportGenerator.ReportGeneratorReportType.HtmlInline">
<summary>
Html report with inline CSS and JavaScript
</summary>
</member>
<member name="F:Cake.Common.Tools.ReportGenerator.ReportGeneratorReportType.HtmlInline_AzurePipelines">
<summary>
Same as HTMLInline but with modified CSS that matches the look and feel of Azure Pipelines.
</summary>
</member>
<member name="F:Cake.Common.Tools.ReportGenerator.ReportGeneratorReportType.PngChart">
<summary>
A single PNG file containing a chart with historic coverage information.
</summary>
</member>
<member name="F:Cake.Common.Tools.ReportGenerator.ReportGeneratorReportType.MHtml">
<summary>
Same as HTML but packaged into a single MHTML file.
</summary>
</member>
<member name="F:Cake.Common.Tools.ReportGenerator.ReportGeneratorReportType.SonarQube">
<summary>
Creates xml report in SonarQube 'Generic Test Data' format.
</summary>
<remarks>
Requires ReportGenerator 4.0.6+
</remarks>
</member>
<member name="F:Cake.Common.Tools.ReportGenerator.ReportGeneratorReportType.HtmlInline_AzurePipelines_Dark">
<summary>
Same as HTMLInline but with modified CSS that matches the dark look and feel of Azure Pipelines.
</summary>
<remarks>
Requires ReportGenerator 4.0.10+
</remarks>
</member>
<member name="F:Cake.Common.Tools.ReportGenerator.ReportGeneratorReportType.Clover">
<summary>
Creates xml report in Clover format.
</summary>
<remarks>
Requires ReportGenerator 4.0.6+
</remarks>
</member>
<member name="F:Cake.Common.Tools.ReportGenerator.ReportGeneratorReportType.JsonSummary">
<summary>
Creates summary report in JSON format.
</summary>
<remarks>
Requires ReportGenerator 4.5.2+
</remarks>
</member>
<member name="F:Cake.Common.Tools.ReportGenerator.ReportGeneratorReportType.lcov">
<summary>
Creates summary report in lcov format.
</summary>
<remarks>
Requires ReportGenerator 4.3.0+
</remarks>
</member>
<member name="F:Cake.Common.Tools.ReportGenerator.ReportGeneratorReportType.TeamCitySummary">
<summary>
Outputs summary report as TeamCity statistics messages.
</summary>
<remarks>
Requires ReportGenerator 4.1.3+
</remarks>
</member>
<member name="T:Cake.Common.Tools.ReportGenerator.ReportGeneratorRunner">
<summary>
ReportGenerator runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.ReportGenerator.ReportGeneratorRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.ReportGenerator.ReportGeneratorRunner"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.ReportGenerator.ReportGeneratorRunner.Run(System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Core.IO.DirectoryPath,Cake.Common.Tools.ReportGenerator.ReportGeneratorSettings)">
<summary>
Converts the specified coverage reports into human readable form according to the specified settings.
</summary>
<param name="reports">The coverage reports.</param>
<param name="targetDir">The output directory.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.ReportGenerator.ReportGeneratorRunner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.ReportGenerator.ReportGeneratorRunner.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="T:Cake.Common.Tools.ReportGenerator.ReportGeneratorSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.ReportGenerator.ReportGeneratorRunner"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.ReportGenerator.ReportGeneratorSettings.ReportTypes">
<summary>
Gets or sets the list of coverage reports that should be parsed.
</summary>
</member>
<member name="P:Cake.Common.Tools.ReportGenerator.ReportGeneratorSettings.SourceDirectories">
<summary>
Gets or sets the directories which contain the corresponding source code.
The source files are used if coverage report contains classes without path information.
</summary>
</member>
<member name="P:Cake.Common.Tools.ReportGenerator.ReportGeneratorSettings.HistoryDirectory">
<summary>
Gets or sets the directory for storing persistent coverage information.
Can be used in future reports to show coverage evolution.
</summary>
</member>
<member name="P:Cake.Common.Tools.ReportGenerator.ReportGeneratorSettings.AssemblyFilters">
<summary>
Gets or sets the list of assemblies that should be included or excluded in the report.
Exclusion filters take precedence over inclusion filters.
Wildcards are allowed.
</summary>
</member>
<member name="P:Cake.Common.Tools.ReportGenerator.ReportGeneratorSettings.ClassFilters">
<summary>
Gets or sets the list of classes that should be included or excluded in the report.
Exclusion filters take precedence over inclusion filters.
Wildcards are allowed.
</summary>
</member>
<member name="P:Cake.Common.Tools.ReportGenerator.ReportGeneratorSettings.Verbosity">
<summary>
Gets or sets the verbosity level of the log messages.
</summary>
</member>
<member name="T:Cake.Common.Tools.ReportGenerator.ReportGeneratorVerbosity">
<summary>
Represents ReportGenerator's logging verbosity.
</summary>
</member>
<member name="F:Cake.Common.Tools.ReportGenerator.ReportGeneratorVerbosity.Verbose">
<summary>
Verbosity: Verbose.
</summary>
</member>
<member name="F:Cake.Common.Tools.ReportGenerator.ReportGeneratorVerbosity.Info">
<summary>
Verbosity: Info.
</summary>
</member>
<member name="F:Cake.Common.Tools.ReportGenerator.ReportGeneratorVerbosity.Error">
<summary>
Verbosity: Error.
</summary>
</member>
<member name="T:Cake.Common.Tools.ReportUnit.ReportUnitAliases">
<summary>
<para>Contains functionality related to <see href="http://reportunit.relevantcodes.com/">ReportUnit</see>.</para>
<para>
In order to use the commands for this alias, include the following in your build.cake file to download and
install from nuget.org, or specify the ToolPath within the <see cref="T:Cake.Common.Tools.ReportUnit.ReportUnitSettings" /> class:
<code>
#tool "nuget:?package=ReportUnit"
</code>
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.ReportUnit.ReportUnitAliases.ReportUnit(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath)">
<summary>
Converts the reports in the specified directory into human readable form.
</summary>
<param name="context">The context.</param>
<param name="inputFolder">The input folder.</param>
<example>
<para>Provide only an input folder, which will causes ReportUnit to search entire directory for report files.</para>
<para>Cake task:</para>
<code>
ReportUnit("c:/temp");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.ReportUnit.ReportUnitAliases.ReportUnit(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath,Cake.Common.Tools.ReportUnit.ReportUnitSettings)">
<summary>
Converts the reports in the specified directory into human readable form.
</summary>
<param name="context">The context.</param>
<param name="inputFolder">The input folder.</param>
<param name="settings">The ReportUnit settings.</param>
<example>
<para>Provide an input folder and custom ToolPath, which will causes ReportUnit to search entire directory for report files.</para>
<para>Cake task:</para>
<code>
ReportUnit("c:/temp", new ReportUnitSettings(){
ToolPath = "c:/tools/reportunit.exe"
});
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.ReportUnit.ReportUnitAliases.ReportUnit(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath,Cake.Core.IO.DirectoryPath,Cake.Common.Tools.ReportUnit.ReportUnitSettings)">
<summary>
Converts the reports in the specified directory into human readable form and outputs to specified folder.
</summary>
<param name="context">The context.</param>
<param name="inputFolder">The input folder.</param>
<param name="outputFolder">The output folder.</param>
<param name="settings">The ReportUnit settings.</param>
<example>
<para>Provide both input and output folder, which will causes ReportUnit to search entire directory for report files, and output the results to specified location.</para>
<para>Cake task:</para>
<code>
ReportUnit("c:/temp/input", "c:/temp/output");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.ReportUnit.ReportUnitAliases.ReportUnit(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Core.IO.FilePath)">
<summary>
Converts the single specified report into human readable form and outputs to specified file.
</summary>
<param name="context">The context.</param>
<param name="inputFile">The input file.</param>
<param name="outputFile">The output file.</param>
<example>
<para>Provide both input and output file, which will causes ReportUnit to transform only the specific file, and output to the specified location.</para>
<para>Cake task:</para>
<code>
ReportUnit("c:/temp/input", "c:/temp/output");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.ReportUnit.ReportUnitAliases.ReportUnit(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Core.IO.FilePath,Cake.Common.Tools.ReportUnit.ReportUnitSettings)">
<summary>
Converts the single specified report into human readable form and outputs to specified file.
</summary>
<param name="context">The context.</param>
<param name="inputFile">The input file.</param>
<param name="outputFile">The output file.</param>
<param name="settings">The ReportUnit settings.</param>
<example>
<para>Provide both input and output file, which will causes ReportUnit to transform only the specific file, and output to the specified location. Also use a custom path for the reportunit.exe.</para>
<para>Cake task:</para>
<code>
ReportUnit("c:/temp/input", "c:/temp/output", new ReportUnitSettings(){
ToolPath = "c:/tools/reportunit.exe"
});
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.ReportUnit.ReportUnitRunner">
<summary>
ReportUnit runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.ReportUnit.ReportUnitRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.ReportUnit.ReportUnitRunner"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.ReportUnit.ReportUnitRunner.Run(Cake.Core.IO.DirectoryPath,Cake.Core.IO.DirectoryPath,Cake.Common.Tools.ReportUnit.ReportUnitSettings)">
<summary>
Converts the reports from specified folder into human readable form according to the specified settings.
</summary>
<param name="inputFolder">The input folder.</param>
<param name="outputFolder">The output folder.</param>
<param name="settings">The ReportUnit settings.</param>
</member>
<member name="M:Cake.Common.Tools.ReportUnit.ReportUnitRunner.Run(Cake.Core.IO.FilePath,Cake.Core.IO.FilePath,Cake.Common.Tools.ReportUnit.ReportUnitSettings)">
<summary>
Converts the specified report into human readable form according to the specified settings.
</summary>
<param name="inputFile">The input file.</param>
<param name="outputFile">The output file.</param>
<param name="settings">The ReportUnit settings.</param>
</member>
<member name="M:Cake.Common.Tools.ReportUnit.ReportUnitRunner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.ReportUnit.ReportUnitRunner.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="T:Cake.Common.Tools.ReportUnit.ReportUnitSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.ReportUnit.ReportUnitRunner"/>.
</summary>
</member>
<member name="T:Cake.Common.Tools.SpecFlow.SpecFlowAliases">
<summary>
<para>Contains functionality related to <see href="http://www.specflow.org/">SpecFlow</see>.</para>
<para>
In order to use the commands for this alias, include the following in your build.cake file to download and
install from nuget.org, or specify the ToolPath within the appropriate settings class:
<code>
#tool "nuget:?package=SpecFlow"
</code>
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.SpecFlow.SpecFlowAliases.SpecFlowStepDefinitionReport(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Creates a report that shows the usage and binding status of the steps for the entire project.
You can use this report to find both unused code in the automation layer and scenario steps that have no definition yet.
See <see href="https://github.com/techtalk/SpecFlow/wiki/Reporting#step-definition-report">SpecFlow Documentation</see> for more information.
</summary>
<param name="context">The context.</param>
<param name="projectFile">The path of the project file containing the feature files.</param>
</member>
<member name="M:Cake.Common.Tools.SpecFlow.SpecFlowAliases.SpecFlowStepDefinitionReport(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Common.Tools.SpecFlow.StepDefinitionReport.SpecFlowStepDefinitionReportSettings)">
<summary>
Creates a report that shows the usage and binding status of the steps for the entire project.
You can use this report to find both unused code in the automation layer and scenario steps that have no definition yet.
See <see href="https://github.com/techtalk/SpecFlow/wiki/Reporting#step-definition-report">SpecFlow Documentation</see> for more information.
</summary>
<param name="context">The context.</param>
<param name="projectFile">The path of the project file containing the feature files.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.SpecFlow.SpecFlowAliases.SpecFlowTestExecutionReport(Cake.Core.ICakeContext,System.Action{Cake.Core.ICakeContext},Cake.Core.IO.FilePath)">
<summary>
Creates a formatted HTML report of a test execution.
The report contains a summary about the executed tests and the result and also a detailed report for the individual scenario executions.
See <see href="https://github.com/techtalk/SpecFlow/wiki/Reporting#test-execution-report">SpecFlow Documentation</see> for more information.
</summary>
<param name="context">The context.</param>
<param name="action">The action to run SpecFlow for. Supported actions are: MSTest, NUnit3 and XUnit2.</param>
<param name="projectFile">The path of the project file containing the feature files.</param>
</member>
<member name="M:Cake.Common.Tools.SpecFlow.SpecFlowAliases.SpecFlowTestExecutionReport(Cake.Core.ICakeContext,System.Action{Cake.Core.ICakeContext},Cake.Core.IO.FilePath,Cake.Common.Tools.SpecFlow.TestExecutionReport.SpecFlowTestExecutionReportSettings)">
<summary>
Creates a formatted HTML report of a test execution.
The report contains a summary about the executed tests and the result and also a detailed report for the individual scenario executions.
See <see href="https://github.com/techtalk/SpecFlow/wiki/Reporting#test-execution-report">SpecFlow Documentation</see> for more information.
</summary>
<param name="context">The context.</param>
<param name="action">The action to run SpecFlow for. Supported actions are: MSTest, NUnit, NUnit3, XUnit and XUnit2.</param>
<param name="projectFile">The path of the project file containing the feature files.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.SpecFlow.SpecFlowSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.SpecFlow.SpecFlowTool`1"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.SpecFlow.SpecFlowSettings.Out">
<summary>
Gets or sets the generated Output File. Optional.
Default: TestResult.html.
</summary>
</member>
<member name="P:Cake.Common.Tools.SpecFlow.SpecFlowSettings.XsltFile">
<summary>
Gets or sets the custom XSLT file to use, defaults to built-in stylesheet if not provided. Optional.
Default: not specified.
</summary>
</member>
<member name="T:Cake.Common.Tools.SpecFlow.SpecFlowTool`1">
<summary>
Base class for all SpecFlow related tools.
</summary>
<typeparam name="TSettings">The settings type.</typeparam>
</member>
<member name="M:Cake.Common.Tools.SpecFlow.SpecFlowTool`1.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.SpecFlow.SpecFlowTool`1" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.SpecFlow.SpecFlowTool`1.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.SpecFlow.SpecFlowTool`1.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="M:Cake.Common.Tools.SpecFlow.SpecFlowTool`1.AppendArguments(Cake.Common.Tools.SpecFlow.SpecFlowSettings,Cake.Core.IO.ProcessArgumentBuilder)">
<summary>
Appends the SpecFlowSettings arguments to builder.
</summary>
<param name="settings">The settings.</param>
<param name="builder">The argument builder.</param>
</member>
<member name="T:Cake.Common.Tools.SpecFlow.StepDefinitionReport.SpecFlowStepDefinitionReporter">
<summary>
SpecFlow StepDefinition execution report runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.SpecFlow.StepDefinitionReport.SpecFlowStepDefinitionReporter.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.SpecFlow.StepDefinitionReport.SpecFlowStepDefinitionReporter" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.SpecFlow.StepDefinitionReport.SpecFlowStepDefinitionReporter.Run(Cake.Core.IO.FilePath,Cake.Common.Tools.SpecFlow.StepDefinitionReport.SpecFlowStepDefinitionReportSettings)">
<summary>
Runs SpecFlow StepDefinitionReport with the specified settings.
</summary>
<param name="projectFile">The project file path.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.SpecFlow.StepDefinitionReport.SpecFlowStepDefinitionReportSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.SpecFlow.StepDefinitionReport.SpecFlowStepDefinitionReporter"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.SpecFlow.StepDefinitionReport.SpecFlowStepDefinitionReportSettings.BinFolder">
<summary>
Gets or sets the path for the compiled SpecFlow project. Optional.
Default: bin\Debug.
</summary>
</member>
<member name="T:Cake.Common.Tools.SpecFlow.TestExecutionReport.SpecFlowTestExecutionReporter">
<summary>
SpecFlow MSTest execution report runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.SpecFlow.TestExecutionReport.SpecFlowTestExecutionReporter.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.SpecFlow.TestExecutionReport.SpecFlowTestExecutionReporter" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.SpecFlow.TestExecutionReport.SpecFlowTestExecutionReporter.Run(Cake.Core.ICakeContext,System.Action{Cake.Core.ICakeContext},Cake.Core.IO.FilePath,Cake.Common.Tools.SpecFlow.TestExecutionReport.SpecFlowTestExecutionReportSettings)">
<summary>
Runs SpecFlow Test Execution Report with the specified settings.
</summary>
<param name="context">The context.</param>
<param name="action">The action.</param>
<param name="projectFile">The project file path.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.SpecFlow.TestExecutionReport.SpecFlowTestExecutionReportSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.SpecFlow.TestExecutionReport.SpecFlowTestExecutionReporter"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.SpecFlow.TestExecutionReport.SpecFlowTestExecutionReportSettings.ThrowOnTestFailure">
<summary>
Gets or sets a value indicating whether exceptions from the
intercepted action should be rethrown after report generation.
</summary>
</member>
<member name="T:Cake.Common.Tools.TextTransform.TextTransformAliases">
<summary>
<para>Contains functionality related to <see href="https://github.com/mono/monodevelop/tree/master/main/src/addins/TextTemplating/TextTransform">TextTransform</see>.</para>
<para>
In order to use the commands for this alias, include the following in your build.cake file to download and
install from nuget.org, or specify the ToolPath within the <see cref="T:Cake.Common.Tools.TextTransform.TextTransformSettings" /> class:
<code>
#tool "nuget:?package=Mono.TextTransform"
</code>
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.TextTransform.TextTransformAliases.TransformTemplate(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Transform a text template.
</summary>
<example>
<code>
// Transform a .tt template.
var transform = File("./src/Cake/Transform.tt");
TransformTemplate(transform);
</code>
</example>
<param name="context">The context.</param>
<param name="sourceFile">The source file.</param>
</member>
<member name="M:Cake.Common.Tools.TextTransform.TextTransformAliases.TransformTemplate(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Common.Tools.TextTransform.TextTransformSettings)">
<summary>
Transform a text template.
</summary>
<example>
<code>
// Transform a .tt template.
var transform = File("./src/Cake/Transform.tt");
TransformTemplate(transform, new TextTransformSettings { OutputFile="./src/Cake/Transform.cs" });
</code>
</example>
<param name="context">The context.</param>
<param name="sourceFile">The source file.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.TextTransform.TextTransformRunner">
<summary>
The Text Transform runner.
</summary>
</member>
<member name="M:Cake.Common.Tools.TextTransform.TextTransformRunner.Run(Cake.Core.IO.FilePath,Cake.Common.Tools.TextTransform.TextTransformSettings)">
<summary>
Runs Text Transform with the specified files and settings.
</summary>
<param name="sourceFile">The source file.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.TextTransform.TextTransformRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.TextTransform.TextTransformRunner" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.TextTransform.TextTransformRunner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Common.Tools.TextTransform.TextTransformRunner.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="T:Cake.Common.Tools.TextTransform.TextTransformSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.TextTransform.TextTransformRunner"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.TextTransform.TextTransformSettings.Assembly">
<summary>
Gets or sets the assembly used for compiling and running the text template.
</summary>
<value>
The assembly.
</value>
</member>
<member name="P:Cake.Common.Tools.TextTransform.TextTransformSettings.OutputFile">
<summary>
Gets or sets the output file for the transform.
</summary>
<value>
The output file.
</value>
</member>
<member name="P:Cake.Common.Tools.TextTransform.TextTransformSettings.Namespace">
<summary>
Gets or sets the namespace that is used for compiling the text template.
</summary>
<value>
The namespace.
</value>
</member>
<member name="P:Cake.Common.Tools.TextTransform.TextTransformSettings.IncludeDirectory">
<summary>
Gets or sets a directory that contains the text templates sourced in the specified text template.
</summary>
</member>
<member name="P:Cake.Common.Tools.TextTransform.TextTransformSettings.ReferencePath">
<summary>
Gets or sets a directory to search for assemblies specified within the text template.
</summary>
<value>
The reference path.
</value>
</member>
<member name="P:Cake.Common.Tools.TextTransform.TextTransformSettings.Class">
<summary>
Gets or sets the class name used for converting T4 template into a C# class that can be compiled into your app and executed at runtime.
</summary>
<value>
The class name.
</value>
<remarks>
Requires T4 text template processor version 2 or newer.
</remarks>
</member>
<member name="P:Cake.Common.Tools.TextTransform.TextTransformSettings.Properties">
<summary>
Gets or sets properties passes to the template's Session dictionary.
</summary>
<value>
The properties dictionary.
</value>
<remarks>
Requires T4 text template processor version 2 or newer.
These can also be accessed using strongly typed properties
(declared with <#@ parameter name="<name>" type="<type>" #> directives.)
</remarks>
</member>
<member name="T:Cake.Common.Tools.VSTest.VSTestAliases">
<summary>
Contains functionality related to running VSTest unit tests.
</summary>
</member>
<member name="M:Cake.Common.Tools.VSTest.VSTestAliases.VSTest(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern)">
<summary>
Runs all VSTest unit tests in the assemblies matching the specified pattern.
</summary>
<example>
<code>
VSTest("./Tests/*.UnitTests.dll");
</code>
</example>
<param name="context">The context.</param>
<param name="pattern">The pattern.</param>
</member>
<member name="M:Cake.Common.Tools.VSTest.VSTestAliases.VSTest(Cake.Core.ICakeContext,Cake.Core.IO.GlobPattern,Cake.Common.Tools.VSTest.VSTestSettings)">
<summary>
Runs all VSTest unit tests in the assemblies matching the specified pattern.
</summary>
<example>
<code>
VSTest("./Tests/*.UnitTests.dll", new VSTestSettings() { Logger = "trx" });
</code>
</example>
<param name="context">The context.</param>
<param name="pattern">The pattern.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.VSTest.VSTestAliases.VSTest(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath})">
<summary>
Runs all VSTest unit tests in the specified assemblies.
</summary>
<example>
<code>
var paths = new List<FilePath>() { "./assemblydir1", "./assemblydir2" };
VSTest(paths);
</code>
</example>
<param name="context">The context.</param>
<param name="assemblyPaths">The assembly paths.</param>
</member>
<member name="M:Cake.Common.Tools.VSTest.VSTestAliases.VSTest(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.VSTest.VSTestSettings)">
<summary>
Runs all VSTest unit tests in the specified assemblies.
</summary>
<example>
<code>
var paths = new List<FilePath>() { "./assemblydir1", "./assemblydir2" };
VSTest(paths, new VSTestSettings() { InIsolation = true });
</code>
</example>
<param name="context">The context.</param>
<param name="assemblyPaths">The assembly paths.</param>
<param name="settings">The settings.</param>
</member>
<member name="T:Cake.Common.Tools.VSTest.VSTestFrameworkVersion">
<summary>
Target .NET Framework version to be used for test execution.
</summary>
</member>
<member name="F:Cake.Common.Tools.VSTest.VSTestFrameworkVersion.Default">
<summary>
Use default .NET Framework version.
</summary>
</member>
<member name="F:Cake.Common.Tools.VSTest.VSTestFrameworkVersion.NET35">
<summary>
.NET Framework version: <c>3.5</c>.
</summary>
</member>
<member name="F:Cake.Common.Tools.VSTest.VSTestFrameworkVersion.NET40">
<summary>
.NET Framework version: <c>4.0</c>.
</summary>
</member>
<member name="F:Cake.Common.Tools.VSTest.VSTestFrameworkVersion.NET45">
<summary>
.NET Framework version: <c>4.5</c>.
</summary>
</member>
<member name="T:Cake.Common.Tools.VSTest.VSTestPlatform">
<summary>
Target platform architecture to be used for test execution.
</summary>
</member>
<member name="F:Cake.Common.Tools.VSTest.VSTestPlatform.Default">
<summary>
Use default platform architecture.
</summary>
</member>
<member name="F:Cake.Common.Tools.VSTest.VSTestPlatform.x86">
<summary>
Platform architecture: <c>x86</c>.
</summary>
</member>
<member name="F:Cake.Common.Tools.VSTest.VSTestPlatform.x64">
<summary>
Platform architecture: <c>x64</c>.
</summary>
</member>
<member name="F:Cake.Common.Tools.VSTest.VSTestPlatform.ARM">
<summary>
Platform architecture: <c>ARM</c>.
</summary>
</member>
<member name="T:Cake.Common.Tools.VSTest.VSTestRunner">
<summary>
The VSTest unit test runner.
Used by Visual Studio 2012 and newer.
</summary>
</member>
<member name="M:Cake.Common.Tools.VSTest.VSTestRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.VSTest.VSTestRunner"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="toolLocator">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.VSTest.VSTestRunner.Run(System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Common.Tools.VSTest.VSTestSettings)">
<summary>
Runs the tests in the specified assembly.
</summary>
<param name="assemblyPaths">The assembly path.</param>
<param name="settings">The settings.</param>
</member>
<member name="M:Cake.Common.Tools.VSTest.VSTestRunner.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The tool name.</returns>
</member>
<member name="M:Cake.Common.Tools.VSTest.VSTestRunner.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="M:Cake.Common.Tools.VSTest.VSTestRunner.GetAlternativeToolPaths(Cake.Common.Tools.VSTest.VSTestSettings)">
<summary>
Gets alternative file paths which the tool may exist in.
</summary>
<param name="settings">The settings.</param>
<returns>The default tool path.</returns>
</member>
<member name="T:Cake.Common.Tools.VSTest.VSTestSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.VSTest.VSTestRunner"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.VSTest.VSTestSettings.SettingsFile">
<summary>
Gets or sets the settings filename to be used to control additional settings such as data collectors.
</summary>
</member>
<member name="P:Cake.Common.Tools.VSTest.VSTestSettings.Parallel">
<summary>
Gets or sets a value indicating whether the tests are executed in parallel. By default up to all available cores on the machine may be used. The number of cores to use may be configured using a settings file.
</summary>
</member>
<member name="P:Cake.Common.Tools.VSTest.VSTestSettings.EnableCodeCoverage">
<summary>
Gets or sets a value indicating whether to enable data diagnostic adapter 'CodeCoverage' in the test run. Default settings are used if not specified using settings file.
</summary>
</member>
<member name="P:Cake.Common.Tools.VSTest.VSTestSettings.InIsolation">
<summary>
Gets or sets a value indicating whether to run tests within the vstest.console.exe process.
This makes vstest.console.exe process less likely to be stopped on an error in the tests, but tests might run slower.
Defaults to <c>false</c>.
</summary>
<value>
<c>true</c> if running in isolation; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Common.Tools.VSTest.VSTestSettings.UseVsixExtensions">
<summary>
Gets or sets a value overriding whether VSTest will use or skip the VSIX extensions installed (if any) in the test run.
</summary>
</member>
<member name="P:Cake.Common.Tools.VSTest.VSTestSettings.TestAdapterPath">
<summary>
Gets or sets a value that makes VSTest use custom test adapters from a given path (if any) in the test run.
</summary>
</member>
<member name="P:Cake.Common.Tools.VSTest.VSTestSettings.PlatformArchitecture">
<summary>
Gets or sets the target platform architecture to be used for test execution.
</summary>
</member>
<member name="P:Cake.Common.Tools.VSTest.VSTestSettings.FrameworkVersion">
<summary>
Gets or sets the target .NET Framework version to be used for test execution.
</summary>
</member>
<member name="P:Cake.Common.Tools.VSTest.VSTestSettings.TestCaseFilter">
<summary>
Gets or sets an expression to run only tests that match, of the format <property>Operator<value>[|&<Expression>]
where Operator is one of =, != or ~ (Operator ~ has 'contains'
semantics and is applicable for string properties like DisplayName).
Parenthesis () can be used to group sub-expressions.
Examples: Priority=1
(FullyQualifiedName~Nightly|Name=MyTestMethod).
</summary>
</member>
<member name="P:Cake.Common.Tools.VSTest.VSTestSettings.Diag">
<summary>
Gets or sets a path which makes VSTest write diagnosis trace logs to specified file.
</summary>
</member>
<member name="P:Cake.Common.Tools.VSTest.VSTestSettings.ResultsDirectory">
<summary>
Gets or sets the result directory.
Test results directory will be created in specified path if not exists.
VSTest.Console.exe flag <see href="https://docs.microsoft.com/en-us/visualstudio/test/vstest-console-options#ResultDirectory">/ResultsDirectory</see>.
</summary>
</member>
<member name="P:Cake.Common.Tools.VSTest.VSTestSettings.Logger">
<summary>
Gets or sets the name of your logger. Possible values:
- A blank string (or null): no logger
- "trx": Visual Studio's built-in logger
- "AppVeyor": AppVeyor's custom logger which is available only when building your solution on the AppVeyor platform
- any custom value: the name of your custom logger.
</summary>
</member>
<member name="P:Cake.Common.Tools.VSTest.VSTestSettings.AllowPreviewVersion">
<summary>
Gets or sets a value indicating whether tools from a preview edition of Visual Studio should be used.
<para>
If set to <c>true</c>, VSTest from a Preview edition
(e.g. Visual Studio 2022 Preview) will be considered to be used.
</para>
</summary>
</member>
<member name="T:Cake.Common.Tools.VSTest.VSTestSettingsExtensions">
<summary>
Contains functionality related to VSTest settings.
</summary>
</member>
<member name="M:Cake.Common.Tools.VSTest.VSTestSettingsExtensions.WithoutAnyLogger(Cake.Common.Tools.VSTest.VSTestSettings)">
<summary>
Do not Log.
</summary>
<param name="settings">The settings.</param>
<returns>The same <see cref="T:Cake.Common.Tools.VSTest.VSTestSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.VSTest.VSTestSettingsExtensions.WithVisualStudioLogger(Cake.Common.Tools.VSTest.VSTestSettings)">
<summary>
Log to a trx file.
</summary>
<param name="settings">The settings.</param>
<returns>The same <see cref="T:Cake.Common.Tools.VSTest.VSTestSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.VSTest.VSTestSettingsExtensions.WithAppVeyorLogger(Cake.Common.Tools.VSTest.VSTestSettings)">
<summary>
Log to the AppVeyor logger (which is only available when building your solution on the AppVeyor platform).
</summary>
<param name="settings">The settings.</param>
<returns>The same <see cref="T:Cake.Common.Tools.VSTest.VSTestSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Common.Tools.VSTest.VSTestSettingsExtensions.WithLogger(Cake.Common.Tools.VSTest.VSTestSettings,System.String)">
<summary>
Log to a custom logger.
</summary>
<param name="settings">The settings.</param>
<param name="loggerName">The name of the logger.</param>
<returns>The same <see cref="T:Cake.Common.Tools.VSTest.VSTestSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="T:Cake.Common.Tools.VSWhere.All.VSWhereAll">
<summary>
The VSWhere tool that finds all instances regardless if they are complete.
</summary>
</member>
<member name="M:Cake.Common.Tools.VSWhere.All.VSWhereAll.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.VSWhere.All.VSWhereAll"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="toolLocator">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.VSWhere.All.VSWhereAll.All(Cake.Common.Tools.VSWhere.All.VSWhereAllSettings)">
<summary>
Finds all instances regardless if they are complete.
</summary>
<param name="settings">The settings.</param>
<returns>Installation paths for all instances.</returns>
</member>
<member name="T:Cake.Common.Tools.VSWhere.All.VSWhereAllSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.VSWhere.All.VSWhereAll"/>.
</summary>
</member>
<member name="T:Cake.Common.Tools.VSWhere.Latest.VSWhereLatest">
<summary>
The VSWhere tool that returns only the newest version and last installed.
</summary>
</member>
<member name="M:Cake.Common.Tools.VSWhere.Latest.VSWhereLatest.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.VSWhere.Latest.VSWhereLatest"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="toolLocator">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.VSWhere.Latest.VSWhereLatest.Latest(Cake.Common.Tools.VSWhere.Latest.VSWhereLatestSettings)">
<summary>
Returns only the newest version and last installed.
</summary>
<param name="settings">The settings.</param>
<returns>Installation path of the newest or last install.</returns>
</member>
<member name="T:Cake.Common.Tools.VSWhere.Latest.VSWhereLatestSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.VSWhere.Latest.VSWhereLatest"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.VSWhere.Latest.VSWhereLatestSettings.Products">
<summary>
Gets or sets the products to find. Defaults to Community, Professional, and Enterprise. Specify "*" by itself to search all product instances installed.
</summary>
</member>
<member name="T:Cake.Common.Tools.VSWhere.Legacy.VSWhereLegacy">
<summary>
The VSWhere tool that finds Visual Studio products.
</summary>
</member>
<member name="M:Cake.Common.Tools.VSWhere.Legacy.VSWhereLegacy.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.VSWhere.Legacy.VSWhereLegacy"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="toolLocator">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.VSWhere.Legacy.VSWhereLegacy.Legacy(Cake.Common.Tools.VSWhere.Legacy.VSWhereLegacySettings)">
<summary>
Also searches Visual Studio 2015 and older products. Information is limited.
</summary>
<param name="settings">The settings.</param>
<returns>Installation paths for all instances.</returns>
</member>
<member name="T:Cake.Common.Tools.VSWhere.Legacy.VSWhereLegacySettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.VSWhere.Legacy.VSWhereLegacy"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.VSWhere.Legacy.VSWhereLegacySettings.Latest">
<summary>
Gets or sets a value indicating whether to return only the newest version and last installed.
</summary>
<value><c>true</c> to find the newest version or last installed; otherwise, <c>false</c>.</value>
</member>
<member name="P:Cake.Common.Tools.VSWhere.Legacy.VSWhereLegacySettings.Requires">
<summary>
Gets the workload(s) or component(s) required when finding instances, immutable to always be empty per documentation.
</summary>
</member>
<member name="T:Cake.Common.Tools.VSWhere.Product.VSWhereProduct">
<summary>
The VSWhere tool that finds Visual Studio products.
</summary>
</member>
<member name="M:Cake.Common.Tools.VSWhere.Product.VSWhereProduct.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.VSWhere.Product.VSWhereProduct"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="toolLocator">The tool locator.</param>
</member>
<member name="M:Cake.Common.Tools.VSWhere.Product.VSWhereProduct.Products(Cake.Common.Tools.VSWhere.Product.VSWhereProductSettings)">
<summary>
Finds one ore more products.
</summary>
<param name="settings">The settings.</param>
<returns>Installation paths for all instances.</returns>
</member>
<member name="T:Cake.Common.Tools.VSWhere.Product.VSWhereProductSettings">
<summary>
Contains settings used by <see cref="T:Cake.Common.Tools.VSWhere.Product.VSWhereProduct"/>.
</summary>
</member>
<member name="P:Cake.Common.Tools.VSWhere.Product.VSWhereProductSettings.Products">
<summary>
Gets or sets the products to find. Defaults to Community, Professional, and Enterprise. Specify "*" by itself to search all product instances installed.
</summary>
</member>
<member name="T:Cake.Common.Tools.VSWhere.VSWhereAliases">
<summary>
<para>Contains functionality related to running <see href="https://github.com/Microsoft/vswhere">VSWhere</see> tool.</para>
<para>
In order to use the commands for this alias, include the following in your build.cake file to download and
install from nuget.org, or specify the ToolPath within the settings class:
<code>
#tool "nuget:?package=vswhere"
</code>
</para>
</summary>
</member>
<member name="M:Cake.Common.Tools.VSWhere.VSWhereAliases.VSWhereLegacy(Cake.Core.ICakeContext,System.Boolean)">
<summary>
Gets the legacy Visual Studio product installation paths.
</summary>
<param name="context">The context.</param>
<param name="latest">Get the latest version.</param>
<returns>The Visual Studio installation path.</returns>
<example>
<code>
var legacyInstallationPath = VSWhereLegacy(true);
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.VSWhere.VSWhereAliases.VSWhereLegacy(Cake.Core.ICakeContext,Cake.Common.Tools.VSWhere.Legacy.VSWhereLegacySettings)">
<summary>
Gets the legacy Visual Studio product installation paths.
</summary>
<param name="context">The context.</param>
<param name="settings">The settings.</param>
<returns>The Visual Studio installation paths.</returns>
<example>
<code>
var legacyInstallationPaths = VSWhereLegacy(new VSWhereLegacySettings());
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.VSWhere.VSWhereAliases.VSWhereLatest(Cake.Core.ICakeContext)">
<summary>
Gets the latest Visual Studio product installation path.
</summary>
<param name="context">The context.</param>
<returns>The Visual Studio installation path.</returns>
<example>
<code>
var latestInstallationPath = VSWhereLatest();
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.VSWhere.VSWhereAliases.VSWhereLatest(Cake.Core.ICakeContext,Cake.Common.Tools.VSWhere.Latest.VSWhereLatestSettings)">
<summary>
Gets the latest Visual Studio product installation path.
</summary>
<param name="context">The context.</param>
<param name="settings">The settings.</param>
<returns>The Visual Studio installation path.</returns>
<example>
<code>
var latestInstallationPath = VSWhereLatest(new VSWhereLatestSettings { Requires = "'Microsoft.Component.MSBuild" });
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.VSWhere.VSWhereAliases.VSWhereAll(Cake.Core.ICakeContext)">
<summary>
Gets all Visual Studio product installation paths.
</summary>
<param name="context">The context.</param>
<returns>The Visual Studio installation paths.</returns>
<example>
<code>
var latestInstallationPaths = VSWhereAll();
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.VSWhere.VSWhereAliases.VSWhereAll(Cake.Core.ICakeContext,Cake.Common.Tools.VSWhere.All.VSWhereAllSettings)">
<summary>
Gets all Visual Studio product installation paths.
</summary>
<param name="context">The context.</param>
<param name="settings">The settings.</param>
<returns>The Visual Studio installation paths.</returns>
<example>
<code>
var latestInstallationPaths = VSWhereAll(new VSWhereAllSettings { Requires = "'Microsoft.Component.MSBuild" });
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.VSWhere.VSWhereAliases.VSWhereProducts(Cake.Core.ICakeContext,System.String)">
<summary>
Gets Visual Studio product installation paths.
</summary>
<param name="context">The context.</param>
<param name="products">The products to find.</param>
<returns>The Visual Studio installation paths.</returns>
<example>
<code>
var latestInstallationPaths = VSWhereProducts("Microsoft.VisualStudio.Product.BuildTools");
</code>
</example>
</member>
<member name="M:Cake.Common.Tools.VSWhere.VSWhereAliases.VSWhereProducts(Cake.Core.ICakeContext,System.String,Cake.Common.Tools.VSWhere.Product.VSWhereProductSettings)">
<summary>
Gets Visual Studio product installation paths.
</summary>
<param name="context">The context.</param>
<param name="products">The products to find.</param>
<param name="settings">The settings.</param>
<returns>The Visual Studio installation paths.</returns>
<example>
<code>
var latestInstallationPaths = VSWhereProducts("Microsoft.VisualStudio.Product.BuildTools", new VSWhereProductSettings { Requires = "'Microsoft.Component.MSBuild" });
</code>
</example>
</member>
<member name="T:Cake.Common.Tools.VSWhere.VSWhereSettings">
<summary>
Base class for all settings for VSWhere tools.
</summary>
</member>
<member name="P:Cake.Common.Tools.VSWhere.VSWhereSettings.Requires">
<summary>
Gets or sets the workload(s) or component(s) required when finding instances.
</summary>
</member>
<member name="P:Cake.Common.Tools.VSWhere.VSWhereSettings.Version">
<summary>
Gets or sets version range for instances to find. Example: ["15.0","16.0"] will find versions 15.*.
</summary>
</member>
<member name="P:Cake.Common.Tools.VSWhere.VSWhereSettings.ReturnProperty">
<summary>
Gets or sets the name of the property to return. Defaults to "value" format.
</summary>
</member>
<member name="P:Cake.Common.Tools.VSWhere.VSWhereSettings.IncludePrerelease">
<summary>
Gets or sets a value indicating whether VSWhere should include prerelease installations.
</summary>
</member>
<member name="M:Cake.Common.Tools.VSWhere.VSWhereSettings.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.VSWhere.VSWhereSettings"/> class.
</summary>
</member>
<member name="T:Cake.Common.Tools.VSWhere.VSWhereTool`1">
<summary>
Base class for all VSWhere related tools.
Used to locate Visual Studio.
</summary>
<typeparam name="TSettings">The settings type.</typeparam>
</member>
<member name="M:Cake.Common.Tools.VSWhere.VSWhereTool`1.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Tools.VSWhere.VSWhereTool`1"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="toolLocator">The tool locator service.</param>
</member>
<member name="M:Cake.Common.Tools.VSWhere.VSWhereTool`1.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The tool name.</returns>
</member>
<member name="M:Cake.Common.Tools.VSWhere.VSWhereTool`1.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="M:Cake.Common.Tools.VSWhere.VSWhereTool`1.GetAlternativeToolPaths(`0)">
<summary>
Gets alternative file paths which the tool may exist in.
</summary>
<param name="settings">The settings.</param>
<returns>The default tool path.</returns>
</member>
<member name="M:Cake.Common.Tools.VSWhere.VSWhereTool`1.RunVSWhere(`0,Cake.Core.IO.ProcessArgumentBuilder)">
<summary>
Runs VSWhere with supplied arguments and parses installation paths.
</summary>
<param name="settings">The settings.</param>
<param name="builder">The process argument builder.</param>
<returns>The parsed file paths.</returns>
</member>
<member name="M:Cake.Common.Tools.VSWhere.VSWhereTool`1.AddCommonArguments(Cake.Common.Tools.VSWhere.VSWhereSettings,Cake.Core.IO.ProcessArgumentBuilder)">
<summary>
Adds common arguments to the process builder.
</summary>
<param name="settings">The settings.</param>
<param name="builder">The process argument builder.</param>
<returns>The process argument builder.</returns>
</member>
<member name="T:Cake.Common.ReleaseNotes">
<summary>
Represent release notes.
</summary>
</member>
<member name="P:Cake.Common.ReleaseNotes.SemVersion">
<summary>
Gets the version.
</summary>
<value>The version.</value>
</member>
<member name="P:Cake.Common.ReleaseNotes.Version">
<summary>
Gets the version.
</summary>
<value>The version.</value>
</member>
<member name="P:Cake.Common.ReleaseNotes.Notes">
<summary>
Gets the release notes.
</summary>
<value>The release notes.</value>
</member>
<member name="P:Cake.Common.ReleaseNotes.RawVersionLine">
<summary>
Gets the raw text of the line that <see cref="P:Cake.Common.ReleaseNotes.Version"/> was extracted from.
</summary>
<value>The raw text of the Version line.</value>
</member>
<member name="M:Cake.Common.ReleaseNotes.#ctor(Cake.Common.SemVersion,System.Collections.Generic.IEnumerable{System.String},System.String)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.ReleaseNotes"/> class.
</summary>
<param name="semVersion">The semantic version.</param>
<param name="notes">The notes.</param>
<param name="rawVersionLine">The raw text of the version line.</param>
</member>
<member name="M:Cake.Common.ReleaseNotes.#ctor(System.Version,System.Collections.Generic.IEnumerable{System.String},System.String)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.ReleaseNotes"/> class.
</summary>
<param name="version">The version.</param>
<param name="notes">The notes.</param>
<param name="rawVersionLine">The raw text of the version line.</param>
</member>
<member name="T:Cake.Common.ReleaseNotesAliases">
<summary>
Contains functionality related to release notes.
</summary>
</member>
<member name="M:Cake.Common.ReleaseNotesAliases.ParseAllReleaseNotes(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Parses all release notes.
</summary>
<param name="context">The context.</param>
<param name="filePath">The file path.</param>
<returns>All release notes.</returns>
<example>
<code>
var releaseNotes = ParseAllReleaseNotes("./ReleaseNotes.md");
foreach(var releaseNote in releaseNotes)
{
Information("Version: {0}", releaseNote.Version);
foreach(var note in releaseNote.Notes)
{
Information("\t{0}", note);
}
}
</code>
</example>
</member>
<member name="M:Cake.Common.ReleaseNotesAliases.ParseReleaseNotes(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Parses the latest release notes.
</summary>
<param name="context">The context.</param>
<param name="filePath">The file path.</param>
<returns>The latest release notes.</returns>
<example>
<code>
var releaseNote = ParseReleaseNotes("./ReleaseNotes.md");
Information("Version: {0}", releaseNote.Version);
foreach(var note in releaseNote.Notes)
{
Information("\t{0}", note);
}
</code>
</example>
</member>
<member name="T:Cake.Common.ReleaseNotesParser">
<summary>
The release notes parser.
</summary>
</member>
<member name="M:Cake.Common.ReleaseNotesParser.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.ReleaseNotesParser"/> class.
</summary>
</member>
<member name="M:Cake.Common.ReleaseNotesParser.Parse(System.String)">
<summary>
Parses all release notes.
</summary>
<param name="content">The content.</param>
<returns>All release notes.</returns>
</member>
<member name="T:Cake.Common.Security.DirectoryHash">
<summary>
Represents a calculated directory hash.
</summary>
</member>
<member name="M:Cake.Common.Security.DirectoryHash.#ctor(Cake.Core.IO.DirectoryPath,System.Byte[],Cake.Common.Security.HashAlgorithm,System.Collections.Generic.IEnumerable{Cake.Common.Security.FileHash})">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Security.DirectoryHash"/> class.
</summary>
<param name="directoryPath">The directory path.</param>
<param name="hash">The computed hash.</param>
<param name="hashAlgorithm">The algorithm used.</param>
<param name="fileHashList">List of all computed <see cref="T:Cake.Common.Security.FileHash"/>.</param>
</member>
<member name="P:Cake.Common.Security.DirectoryHash.Algorithm">
<summary>
Gets the algorithm used for the hash computation.
</summary>
</member>
<member name="P:Cake.Common.Security.DirectoryHash.Path">
<summary>
Gets the <see cref="T:Cake.Core.IO.DirectoryPath"/> for the directory.
</summary>
</member>
<member name="P:Cake.Common.Security.DirectoryHash.FileHashList">
<summary>
Gets the list of <see cref="T:Cake.Common.Security.FileHash"/> for all files of the directory.
</summary>
</member>
<member name="P:Cake.Common.Security.DirectoryHash.ComputedHash">
<summary>
Gets the raw computed hash.
</summary>
</member>
<member name="M:Cake.Common.Security.DirectoryHash.ToHex">
<summary>
Convert the directory hash to a hexadecimal string.
</summary>
<returns>A hexadecimal string representing the computed hash.</returns>
</member>
<member name="T:Cake.Common.Security.DirectoryHashCalculator">
<summary>
Class for calculating a hash for a directory.
</summary>
</member>
<member name="M:Cake.Common.Security.DirectoryHashCalculator.#ctor(Cake.Core.ICakeContext,Cake.Common.Security.IHashAlgorithmBuilder)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Security.DirectoryHashCalculator"/> class.
</summary>
<param name="context">The cake context.</param>
<param name="hashAlgorithmBuilder">The hash algorithm builder.</param>
</member>
<member name="M:Cake.Common.Security.DirectoryHashCalculator.Calculate(Cake.Core.IO.DirectoryPath,System.Collections.Generic.IEnumerable{Cake.Core.IO.GlobPattern},Cake.Common.Security.HashAlgorithm)">
<summary>
Calculates the hash for a given directory.
</summary>
<param name="directoryPath">The directory path.</param>
<param name="pattern">The glob pattern to match.</param>
<param name="hashAlgorithm">The hash algorithm to use.</param>
<returns>A <see cref="T:Cake.Common.Security.DirectoryHash"/> instance representing the calculated hash.</returns>
<example>
<code>
Information(
"Cake It calculates the hashes from all cs files in all subdirectories using a MD5 hash: {0}",
CalculateDirectoryHash("C:\directoryToHash", "./**/*.cs", HashAlgorithm.MD5).ToHex());
</code>
</example>
</member>
<member name="M:Cake.Common.Security.DirectoryHashCalculator.Calculate(Cake.Core.IO.DirectoryPath,System.Collections.Generic.IEnumerable{System.String},Cake.Common.Security.HashAlgorithm)">
<summary>
Calculates the hash for a given directory.
</summary>
<param name="directoryPath">The directory path.</param>
<param name="pattern">The glob pattern to match.</param>
<param name="hashAlgorithm">The hash algorithm to use.</param>
<returns>A <see cref="T:Cake.Common.Security.DirectoryHash"/> instance representing the calculated hash.</returns>
<example>
<code>
Information(
"Cake It calculates the hashes from all cs files in all subdirectories using a MD5 hash: {0}",
CalculateDirectoryHash("C:\directoryToHash", "./**/*.cs", HashAlgorithm.MD5).ToHex());
</code>
</example>
</member>
<member name="T:Cake.Common.Security.FileHash">
<summary>
Represents a calculated file hash.
</summary>
</member>
<member name="M:Cake.Common.Security.FileHash.#ctor(Cake.Core.IO.FilePath,System.Byte[],Cake.Common.Security.HashAlgorithm)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Security.FileHash"/> class.
</summary>
<param name="filePath">The file path.</param>
<param name="hash">The computed hash.</param>
<param name="hashAlgorithm">The algorithm used.</param>
</member>
<member name="P:Cake.Common.Security.FileHash.Algorithm">
<summary>
Gets the algorithm used for the hash computation.
</summary>
</member>
<member name="P:Cake.Common.Security.FileHash.Path">
<summary>
Gets the <see cref="T:Cake.Core.IO.FilePath"/> for the file.
</summary>
</member>
<member name="P:Cake.Common.Security.FileHash.ComputedHash">
<summary>
Gets the raw computed hash.
</summary>
</member>
<member name="M:Cake.Common.Security.FileHash.ToHex">
<summary>
Convert the file hash to a hexadecimal string.
</summary>
<returns>A hexadecimal string representing the computed hash.</returns>
</member>
<member name="T:Cake.Common.Security.FileHashCalculator">
<summary>
Represents a file hash operation.
</summary>
</member>
<member name="M:Cake.Common.Security.FileHashCalculator.#ctor(Cake.Core.IO.IFileSystem)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Security.FileHashCalculator"/> class.
</summary>
<param name="fileSystem">The file system.</param>
</member>
<member name="M:Cake.Common.Security.FileHashCalculator.#ctor(Cake.Core.IO.IFileSystem,Cake.Common.Security.IHashAlgorithmBuilder)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Security.FileHashCalculator"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="hashAlgorithmBuilder">The hash algorithm builder.</param>
</member>
<member name="M:Cake.Common.Security.FileHashCalculator.Calculate(Cake.Core.IO.FilePath,Cake.Common.Security.HashAlgorithm)">
<summary>
Calculates the hash for a file using the given algorithm.
</summary>
<param name="filePath">The file path.</param>
<param name="hashAlgorithm">The algorithm to use.</param>
<returns>A <see cref="T:Cake.Common.Security.FileHash"/> instance representing the calculated hash.</returns>
</member>
<member name="T:Cake.Common.Security.HashAlgorithm">
<summary>
The hash algorithm to use for a specific operation.
</summary>
</member>
<member name="F:Cake.Common.Security.HashAlgorithm.MD5">
<summary>
The MD5 hash algorithm.
</summary>
</member>
<member name="F:Cake.Common.Security.HashAlgorithm.SHA256">
<summary>
The SHA256 hash algorithm.
</summary>
</member>
<member name="F:Cake.Common.Security.HashAlgorithm.SHA512">
<summary>
The SHA512 hash algorithm.
</summary>
</member>
<member name="T:Cake.Common.Security.HashAlgorithmBuilder">
<inheritdoc/>
</member>
<member name="M:Cake.Common.Security.HashAlgorithmBuilder.CreateHashAlgorithm(Cake.Common.Security.HashAlgorithm)">
<inheritdoc/>
</member>
<member name="T:Cake.Common.Security.IHashAlgorithmBuilder">
<summary>
Creates a <see cref="T:System.Security.Cryptography.HashAlgorithm"/> instance by
<see cref="T:Cake.Common.Security.HashAlgorithm"/>.
</summary>
</member>
<member name="M:Cake.Common.Security.IHashAlgorithmBuilder.CreateHashAlgorithm(Cake.Common.Security.HashAlgorithm)">
<summary>
Return a instance of <see cref="T:System.Security.Cryptography.HashAlgorithm"/> by
<see cref="T:Cake.Common.Security.HashAlgorithm"/> enum value.
</summary>
<param name="hashAlgorithm">Algorithm enum value.</param>
<returns>A <see cref="T:System.Security.Cryptography.HashAlgorithm"/> instance.</returns>
</member>
<member name="T:Cake.Common.Security.SecurityAliases">
<summary>
Contains security related functionality, such as calculating file
hashes.
</summary>
</member>
<member name="M:Cake.Common.Security.SecurityAliases.CalculateFileHash(Cake.Core.ICakeContext,Cake.Core.IO.FilePath)">
<summary>
Calculates the hash for a given file using the default (SHA256) algorithm.
</summary>
<param name="context">The context.</param>
<param name="filePath">The file path.</param>
<returns>A <see cref="T:Cake.Common.Security.FileHash"/> instance representing the calculated hash.</returns>
<example>
<code>
Information(
"Cake executable file SHA256 hash: {0}",
CalculateFileHash("Cake.exe").ToHex());
</code>
</example>
</member>
<member name="M:Cake.Common.Security.SecurityAliases.CalculateFileHash(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Common.Security.HashAlgorithm)">
<summary>
Calculates the hash for a given file.
</summary>
<param name="context">The context.</param>
<param name="filePath">The file path.</param>
<param name="hashAlgorithm">The hash algorithm to use.</param>
<returns>A <see cref="T:Cake.Common.Security.FileHash"/> instance representing the calculated hash.</returns>
<example>
<code>
Information(
"Cake executable file MD5 hash: {0}",
CalculateFileHash("Cake.exe", HashAlgorithm.MD5).ToHex());
</code>
</example>
</member>
<member name="M:Cake.Common.Security.SecurityAliases.CalculateDirectoryHash(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{Cake.Core.IO.GlobPattern},Cake.Core.IO.DirectoryPath)">
<summary>
Calculates the hash for a given directory using the default (SHA256) algorithm.
</summary>
<param name="context">The context.</param>
<param name="directoryPath">The file path.</param>
<param name="globs">The glob pattern to match.</param>
<returns>A <see cref="T:Cake.Common.Security.DirectoryHash"/> instance representing the calculated hash.</returns>
<example>
<code>
Information(
"Cake It calculates the hashes from all cs files in all subdirectories using a SHA256 hash: {0}",
CalculateDirectoryHash("C:\directoryToHash", "./**/*.cs").ToHex());
</code>
</example>
</member>
<member name="M:Cake.Common.Security.SecurityAliases.CalculateDirectoryHash(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath,System.Collections.Generic.IEnumerable{Cake.Core.IO.GlobPattern},Cake.Common.Security.HashAlgorithm)">
<summary>
Calculates the hash for a given directory.
</summary>
<param name="context">The context.</param>
<param name="directoryPath">The file path.</param>
<param name="globs">The glob pattern to match.</param>
<param name="hashAlgorithm">The hash algorithm to use.</param>
<returns>A <see cref="T:Cake.Common.Security.DirectoryHash"/> instance representing the calculated hash.</returns>
<example>
<code>
Information(
"Cake It calculates the hashes from all cs files in all subdirectories using a MD5 hash: {0}",
CalculateDirectoryHash("C:\directoryToHash", "./**/*.cs", HashAlgorithm.MD5).ToHex());
</code>
</example>
</member>
<member name="M:Cake.Common.Security.SecurityAliases.CalculateDirectoryHash(Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{System.String},Cake.Core.IO.DirectoryPath)">
<summary>
Calculates the hash for a given directory using the default (SHA256) algorithm.
</summary>
<param name="context">The context.</param>
<param name="directoryPath">The file path.</param>
<param name="globs">The glob pattern to match.</param>
<returns>A <see cref="T:Cake.Common.Security.DirectoryHash"/> instance representing the calculated hash.</returns>
<example>
<code>
Information(
"Cake It calculates the hashes from all cs files in all subdirectories using a SHA256 hash: {0}",
CalculateDirectoryHash("C:\directoryToHash", "./**/*.cs").ToHex());
</code>
</example>
</member>
<member name="M:Cake.Common.Security.SecurityAliases.CalculateDirectoryHash(Cake.Core.ICakeContext,Cake.Core.IO.DirectoryPath,System.Collections.Generic.IEnumerable{System.String},Cake.Common.Security.HashAlgorithm)">
<summary>
Calculates the hash for a given directory.
</summary>
<param name="context">The context.</param>
<param name="directoryPath">The file path.</param>
<param name="globs">The glob pattern to match.</param>
<param name="hashAlgorithm">The hash algorithm to use.</param>
<returns>A <see cref="T:Cake.Common.Security.DirectoryHash"/> instance representing the calculated hash.</returns>
<example>
<code>
Information(
"Cake It calculates the hashes from all cs files in all subdirectories using a MD5 hash: {0}",
CalculateDirectoryHash("C:\directoryToHash", "./**/*.cs", HashAlgorithm.MD5).ToHex());
</code>
</example>
</member>
<member name="T:Cake.Common.SemVersion">
<summary>
Class for representing semantic versions.
</summary>
</member>
<member name="P:Cake.Common.SemVersion.Zero">
<summary>
Gets the default version of a SemanticVersion.
</summary>
</member>
<member name="F:Cake.Common.SemVersion.SemVerRegex">
<summary>
Regex property for parsing a semantic version number.
</summary>
</member>
<member name="P:Cake.Common.SemVersion.Major">
<summary>
Gets the major number of the version.
</summary>
</member>
<member name="P:Cake.Common.SemVersion.Minor">
<summary>
Gets the minor number of the version.
</summary>
</member>
<member name="P:Cake.Common.SemVersion.Patch">
<summary>
Gets the patch number of the version.
</summary>
</member>
<member name="P:Cake.Common.SemVersion.PreRelease">
<summary>
Gets the prerelease of the version.
</summary>
</member>
<member name="P:Cake.Common.SemVersion.Meta">
<summary>
Gets the meta of the version.
</summary>
</member>
<member name="P:Cake.Common.SemVersion.IsPreRelease">
<summary>
Gets a value indicating whether semantic version is a prerelease or not.
</summary>
</member>
<member name="P:Cake.Common.SemVersion.HasMeta">
<summary>
Gets a value indicating whether semantic version has meta or not.
</summary>
</member>
<member name="P:Cake.Common.SemVersion.VersionString">
<summary>
Gets the VersionString of the semantic version.
</summary>
</member>
<member name="P:Cake.Common.SemVersion.AssemblyVersion">
<summary>
Gets the AssemblyVersion of the semantic version.
</summary>
</member>
<member name="M:Cake.Common.SemVersion.#ctor(System.Int32,System.Int32,System.Int32,System.String,System.String)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.SemVersion"/> class.
</summary>
<param name="major">Major number.</param>
<param name="minor">Minor number.</param>
<param name="patch">Patch number.</param>
<param name="preRelease">Prerelease string.</param>
<param name="meta">Meta string.</param>
</member>
<member name="M:Cake.Common.SemVersion.#ctor(System.Int32,System.Int32,System.Int32,System.String,System.String,System.String)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.SemVersion"/> class.
</summary>
<param name="major">Major number.</param>
<param name="minor">Minor number.</param>
<param name="patch">Patch number.</param>
<param name="preRelease">Prerelease string.</param>
<param name="meta">Meta string.</param>
<param name="versionString">The complete version number.</param>
</member>
<member name="M:Cake.Common.SemVersion.TryParse(System.String,Cake.Common.SemVersion@)">
<summary>
Method which tries to parse a semantic version string.
</summary>
<param name="version">the version that should be parsed.</param>
<param name="semVersion">the out parameter the parsed version should be stored in.</param>
<returns>Returns a boolean indicating if the parse was successful.</returns>
</member>
<member name="M:Cake.Common.SemVersion.Equals(Cake.Common.SemVersion)">
<summary>
Checks if two SemVersion objects are equal.
</summary>
<param name="other">the other SemVersion want to test equality to.</param>
<returns>A boolean indicating whether the objecst we're equal or not.</returns>
</member>
<member name="M:Cake.Common.SemVersion.CompareTo(Cake.Common.SemVersion)">
<summary>
Compares to SemVersion objects to and another.
</summary>
<param name="other">The SemVersion object we compare with.</param>
<returns>Return 0 if the objects are identical, 1 if the version is newer and -1 if the version is older.</returns>
</member>
<member name="M:Cake.Common.SemVersion.CompareTo(System.Object)">
<summary>
Compares to SemVersion objects to and another.
</summary>
<param name="obj">The object we compare with.</param>
<returns>Return 0 if the objects are identical, 1 if the version is newer and -1 if the version is older.</returns>
</member>
<member name="M:Cake.Common.SemVersion.Equals(System.Object)">
<summary>
Equals-method for the SemVersion class.
</summary>
<param name="obj">the other SemVersion want to test equality to.</param>
<returns>A boolean indicating whether the objecst we're equal or not.</returns>
</member>
<member name="M:Cake.Common.SemVersion.GetHashCode">
<summary>
Method for getting the hashcode of the SemVersion object.
</summary>
<returns>The hashcode of the SemVersion object.</returns>
</member>
<member name="M:Cake.Common.SemVersion.ToString">
<summary>
Returns the string representation of an SemVersion object.
</summary>
<returns>The string representation of the object.</returns>
</member>
<member name="M:Cake.Common.SemVersion.op_GreaterThan(Cake.Common.SemVersion,Cake.Common.SemVersion)">
<summary>
The greater than-operator for the SemVersion class.
</summary>
<param name="operand1">first SemVersion.</param>
<param name="operand2">second. SemVersion.</param>
<returns>A value indicating if the operand1 was greater than operand2.</returns>
</member>
<member name="M:Cake.Common.SemVersion.op_LessThan(Cake.Common.SemVersion,Cake.Common.SemVersion)">
<summary>
The less than-operator for the SemVersion class.
</summary>
<param name="operand1">first SemVersion.</param>
<param name="operand2">second. SemVersion.</param>
<returns>A value indicating if the operand1 was less than operand2.</returns>
</member>
<member name="M:Cake.Common.SemVersion.op_GreaterThanOrEqual(Cake.Common.SemVersion,Cake.Common.SemVersion)">
<summary>
The greater than or equal to-operator for the SemVersion class.
</summary>
<param name="operand1">first SemVersion.</param>
<param name="operand2">second. SemVersion.</param>
<returns>A value indicating if the operand1 was greater than or equal to operand2.</returns>
</member>
<member name="M:Cake.Common.SemVersion.op_LessThanOrEqual(Cake.Common.SemVersion,Cake.Common.SemVersion)">
<summary>
The lesser than or equal to-operator for the SemVersion class.
</summary>
<param name="operand1">first SemVersion.</param>
<param name="operand2">second. SemVersion.</param>
<returns>A value indicating if the operand1 was lesser than or equal to operand2.</returns>
</member>
<member name="M:Cake.Common.SemVersion.op_Equality(Cake.Common.SemVersion,Cake.Common.SemVersion)">
<summary>
The equal to-operator for the SemVersion class.
</summary>
<param name="operand1">first SemVersion.</param>
<param name="operand2">second. SemVersion.</param>
<returns>A value indicating if the operand1 was equal to operand2.</returns>
</member>
<member name="M:Cake.Common.SemVersion.op_Inequality(Cake.Common.SemVersion,Cake.Common.SemVersion)">
<summary>
The not equal to-operator for the SemVersion class.
</summary>
<param name="operand1">first SemVersion.</param>
<param name="operand2">second. SemVersion.</param>
<returns>A value indicating if the operand1 was not equal to operand2.</returns>
</member>
<member name="T:Cake.Common.Xml.XmlDtdProcessing">
<summary>
Specifies how will an XmlReader handle DTDs in the XML document.
</summary>
</member>
<member name="F:Cake.Common.Xml.XmlDtdProcessing.Prohibit">
<summary>
The XmlReader will throw an exception when it finds a 'DOCTYPE' markup.
</summary>
</member>
<member name="F:Cake.Common.Xml.XmlDtdProcessing.Ignore">
<summary>
The DTD will be ignored. Any reference to a general entity in the XML document
will cause an exception (except for the predefined entities < > & " and ').
The DocumentType node will not be reported.
</summary>
</member>
<member name="F:Cake.Common.Xml.XmlDtdProcessing.Parse">
<summary>
The DTD will be parsed and fully processed (entities expanded, default attributes added etc.)
</summary>
</member>
<member name="T:Cake.Common.Xml.XmlPeekAliases">
<summary>
Contains functionality related to XML XPath queries.
</summary>
</member>
<member name="M:Cake.Common.Xml.XmlPeekAliases.XmlPeek(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,System.String)">
<summary>
Gets the value of a target node.
</summary>
<returns>The value found at the given XPath query.</returns>
<param name="context">The context.</param>
<param name="filePath">The target file.</param>
<param name="xpath">The xpath of the node to get.</param>
<example>
<code>
string autoFacVersion = XmlPeek("./src/Cake/packages.config", "/packages/package[@id='Autofac']/@version");
</code>
</example>
</member>
<member name="M:Cake.Common.Xml.XmlPeekAliases.XmlPeek(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,System.String,Cake.Common.Xml.XmlPeekSettings)">
<summary>
Get the value of a target node.
</summary>
<returns>The value found at the given XPath query.</returns>
<param name="context">The context.</param>
<param name="filePath">The target file.</param>
<param name="xpath">The xpath of the nodes to set.</param>
<param name="settings">Additional settings to tweak Xml Peek behavior.</param>
<example>
<code>
<para>XML document:</para>
<![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<pastery xmlns = "https://cakebuild.net/pastery" >
<cake price="1.62" />
</pastery>
]]>
</code>
<para>XmlPeek usage:</para>
<code>
string version = XmlPeek("./pastry.xml", "/pastry:pastry/pastry:cake/@price",
new XmlPeekSettings {
Namespaces = new Dictionary<string, string> {{ "pastry", "https://cakebuild.net/pastry" }}
});
string unknown = XmlPeek("./pastry.xml", "/pastry:pastry/pastry:cake/@recipe",
new XmlPeekSettings {
Namespaces = new Dictionary<string, string> {{ "pastry", "https://cakebuild.net/pastry" }},
SuppressWarning = true
});
</code>
</example>
</member>
<member name="M:Cake.Common.Xml.XmlPeekAliases.XmlPeek(System.Xml.XmlReader,System.String,Cake.Common.Xml.XmlPeekSettings)">
<summary>
Gets the value of a target node.
</summary>
<returns>The value found at the given XPath query (or the first, if multiple eligible nodes are found).</returns>
<param name="source">The source xml to transform.</param>
<param name="xpath">The xpath of the nodes to set.</param>
<param name="settings">Additional settings to tweak Xml Peek behavior.</param>
</member>
<member name="M:Cake.Common.Xml.XmlPeekAliases.GetXmlReaderSettings(Cake.Common.Xml.XmlPeekSettings)">
<summary>
Gets a XmlReaderSettings from a XmlPeekSettings.
</summary>
<returns>The xml reader settings.</returns>
<param name="settings">Additional settings to tweak Xml Peek behavior.</param>
</member>
<member name="T:Cake.Common.Xml.XmlPeekSettings">
<summary>
Contains settings for <see cref="T:Cake.Common.Xml.XmlPeekAliases"/>.
</summary>
</member>
<member name="P:Cake.Common.Xml.XmlPeekSettings.Namespaces">
<summary>
Gets or sets namespaces to include for xpath recognition.
</summary>
</member>
<member name="P:Cake.Common.Xml.XmlPeekSettings.PreserveWhitespace">
<summary>
Gets or sets a value indicating whether to preserve white space.
</summary>
</member>
<member name="P:Cake.Common.Xml.XmlPeekSettings.SuppressWarning">
<summary>
Gets or sets a value indicating whether to suppress the xpath not found warning.
</summary>
</member>
<member name="P:Cake.Common.Xml.XmlPeekSettings.DtdProcessing">
<summary>
Gets or sets a value that determines the processing of DTDs.
</summary>
</member>
<member name="M:Cake.Common.Xml.XmlPeekSettings.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Xml.XmlPeekSettings"/> class.
</summary>
</member>
<member name="T:Cake.Common.Xml.XmlPokeAliases">
<summary>
Contains functionality related to XML XSL transformation.
</summary>
</member>
<member name="M:Cake.Common.Xml.XmlPokeAliases.XmlPoke(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,System.String,System.String)">
<summary>
Set the value of, or remove, target nodes.
</summary>
<param name="context">The context.</param>
<param name="filePath">The target file.</param>
<param name="xpath">The xpath of the nodes to set.</param>
<param name="value">The value to set too. Leave blank to remove the selected nodes.</param>
<example>
<para>
Change the <c>server</c> setting in the configuration from <c>testhost.somecompany.com</c>
to <c>productionhost.somecompany.com</c>.
</para>
<para>XML file:</para>
<code>
<![CDATA[
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="server" value="testhost.somecompany.com" />
</appSettings>
</configuration>
]]>
</code>
<para>Cake Task:</para>
<code>
<![CDATA[
Task("Transform")
.Does(() =>
{
var file = File("test.xml");
XmlPoke(file, "/configuration/appSettings/add[@key = 'server']/@value", "productionhost.somecompany.com");
});
]]>
</code>
</example>
<example>
<para>
Modify the <c>noNamespaceSchemaLocation</c> in an XML file.
</para>
<para>XML file:</para>
<code>
<![CDATA[
<?xml version="1.0" encoding="utf-8" ?>
<Commands xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="Path Value">
</Commands>
]]>
</code>
<para>Cake Task:</para>
<code>
<![CDATA[
Task("Transform")
.Does(() =>
{
var file = File("test.xml");
XmlPoke(file, "/Commands/@xsi:noNamespaceSchemaLocation", "d:\\Commands.xsd", new XmlPokeSettings {
Namespaces = new Dictionary<string, string> {
{ /* Prefix */ "xsi", /* URI */ "http://www.w3.org/2001/XMLSchema-instance" }
}
});
});
]]>
</code>
</example>
<example>
<para>
Remove an app setting from a config file.
</para>
<para>XML file:</para>
<code>
<![CDATA[
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="server" value="testhost.somecompany.com" />
<add key="testing" value="true" />
</appSettings>
</configuration>
]]>
</code>
<para>Cake Task:</para>
<code>
<![CDATA[
Task("Transform")
.Does(() =>
{
var file = File("test.xml");
XmlPoke(file, "/configuration/appSettings/add[@testing]", null);
});
]]>
</code>
</example>
<para>
Credit to NAnt for the original example.
http://nant.sourceforge.net/release/latest/help/tasks/xmlpoke.html.
</para>
</member>
<member name="M:Cake.Common.Xml.XmlPokeAliases.XmlPoke(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,System.String,System.String,Cake.Common.Xml.XmlPokeSettings)">
<summary>
Set the value of, or remove, target nodes.
</summary>
<param name="context">The context.</param>
<param name="filePath">The target file.</param>
<param name="xpath">The xpath of the nodes to set.</param>
<param name="value">The value to set too. Leave blank to remove the selected nodes.</param>
<param name="settings">Additional settings to tweak Xml Poke behavior.</param>
<example>
<para>
Change the <c>server</c> setting in the configuration from <c>testhost.somecompany.com</c>
to <c>productionhost.somecompany.com</c>.
</para>
<para>XML file:</para>
<code>
<![CDATA[
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="server" value="testhost.somecompany.com" />
</appSettings>
</configuration>
]]>
</code>
<para>Cake Task:</para>
<code>
<![CDATA[
Task("Transform")
.Does(() =>
{
var file = File("test.xml");
XmlPoke(file, "/configuration/appSettings/add[@key = 'server']/@value", "productionhost.somecompany.com");
});
]]>
</code>
</example>
<example>
<para>
Modify the <c>noNamespaceSchemaLocation</c> in an XML file.
</para>
<para>XML file:</para>
<code>
<![CDATA[
<?xml version="1.0" encoding="utf-8" ?>
<Commands xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="Path Value">
</Commands>
]]>
</code>
<para>Cake Task:</para>
<code>
<![CDATA[
Task("Transform")
.Does(() =>
{
var file = File("test.xml");
XmlPoke(file, "/Commands/@xsi:noNamespaceSchemaLocation", "d:\\Commands.xsd", new XmlPokeSettings {
Namespaces = new Dictionary<string, string> {
{ /* Prefix */ "xsi", /* URI */ "http://www.w3.org/2001/XMLSchema-instance" }
}
});
});
]]>
</code>
</example>
<example>
<para>
Remove an app setting from a config file.
</para>
<para>XML file:</para>
<code>
<![CDATA[
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="server" value="testhost.somecompany.com" />
<add key="testing" value="true" />
</appSettings>
</configuration>
]]>
</code>
<para>Cake Task:</para>
<code>
<![CDATA[
Task("Transform")
.Does(() =>
{
var file = File("test.xml");
XmlPoke(file, "/configuration/appSettings/add[@testing]", null);
});
]]>
</code>
</example>
<para>
Credit to NAnt for the original example.
http://nant.sourceforge.net/release/latest/help/tasks/xmlpoke.html.
</para>
</member>
<member name="M:Cake.Common.Xml.XmlPokeAliases.XmlPokeString(Cake.Core.ICakeContext,System.String,System.String,System.String)">
<summary>
Set the value of, or remove, target nodes.
</summary>
<param name="context">The context.</param>
<param name="sourceXml">The source xml to transform.</param>
<param name="xpath">The xpath of the nodes to set.</param>
<param name="value">The value to set too. Leave blank to remove the selected nodes.</param>
<returns>Resulting XML.</returns>
<example>
<para>
Change the <c>server</c> setting in the configuration from <c>testhost.somecompany.com</c>
to <c>productionhost.somecompany.com</c>.
</para>
<para>XML string:</para>
<code>
<![CDATA[
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="server" value="testhost.somecompany.com" />
</appSettings>
</configuration>
]]>
</code>
<para>Cake Task:</para>
<code>
<![CDATA[
Task("Transform")
.Does(() =>
{
var result = XmlPokeString(xmlString, "/configuration/appSettings/add[@key = 'server']/@value", "productionhost.somecompany.com");
});
]]>
</code>
</example>
<example>
<para>
Modify the <c>noNamespaceSchemaLocation</c> in an XML file.
</para>
<para>XML string:</para>
<code>
<![CDATA[
<?xml version="1.0" encoding="utf-8" ?>
<Commands xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="Path Value">
</Commands>
]]>
</code>
<para>Cake Task:</para>
<code>
<![CDATA[
Task("Transform")
.Does(() =>
{
var result = XmlPokeString(xmlString, "/Commands/@xsi:noNamespaceSchemaLocation", "d:\\Commands.xsd", new XmlPokeSettings {
Namespaces = new Dictionary<string, string> {
{ /* Prefix */ "xsi", /* URI */ "http://www.w3.org/2001/XMLSchema-instance" }
}
});
});
]]>
</code>
</example>
<example>
<para>
Remove an app setting from a config file.
</para>
<para>XML string:</para>
<code>
<![CDATA[
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="server" value="testhost.somecompany.com" />
<add key="testing" value="true" />
</appSettings>
</configuration>
]]>
</code>
<para>Cake Task:</para>
<code>
<![CDATA[
Task("Transform")
.Does(() =>
{
var result = XmlPokeString(xmlString, "/configuration/appSettings/add[@testing]", null);
});
]]>
</code>
</example>
<para>
Credit to NAnt for the original example.
http://nant.sourceforge.net/release/latest/help/tasks/xmlpoke.html.
</para>
</member>
<member name="M:Cake.Common.Xml.XmlPokeAliases.XmlPokeString(Cake.Core.ICakeContext,System.String,System.String,System.String,Cake.Common.Xml.XmlPokeSettings)">
<summary>
Set the value of, or remove, target nodes.
</summary>
<param name="context">The context.</param>
<param name="sourceXml">The source xml to transform.</param>
<param name="xpath">The xpath of the nodes to set.</param>
<param name="value">The value to set too. Leave blank to remove the selected nodes.</param>
<param name="settings">Additional settings to tweak Xml Poke behavior.</param>
<returns>Resulting XML.</returns>
<example>
<para>
Change the <c>server</c> setting in the configuration from <c>testhost.somecompany.com</c>
to <c>productionhost.somecompany.com</c>.
</para>
<para>XML string:</para>
<code>
<![CDATA[
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="server" value="testhost.somecompany.com" />
</appSettings>
</configuration>
]]>
</code>
<para>Cake Task:</para>
<code>
<![CDATA[
Task("Transform")
.Does(() =>
{
var result = XmlPokeString(xmlString, "/configuration/appSettings/add[@key = 'server']/@value", "productionhost.somecompany.com");
});
]]>
</code>
</example>
<example>
<para>
Modify the <c>noNamespaceSchemaLocation</c> in an XML file.
</para>
<para>XML string:</para>
<code>
<![CDATA[
<?xml version="1.0" encoding="utf-8" ?>
<Commands xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="Path Value">
</Commands>
]]>
</code>
<para>Cake Task:</para>
<code>
<![CDATA[
Task("Transform")
.Does(() =>
{
var result = XmlPokeString(xmlString, "/Commands/@xsi:noNamespaceSchemaLocation", "d:\\Commands.xsd", new XmlPokeSettings {
Namespaces = new Dictionary<string, string> {
{ /* Prefix */ "xsi", /* URI */ "http://www.w3.org/2001/XMLSchema-instance" }
}
});
});
]]>
</code>
</example>
<example>
<para>
Remove an app setting from a config file.
</para>
<para>XML string:</para>
<code>
<![CDATA[
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="server" value="testhost.somecompany.com" />
<add key="testing" value="true" />
</appSettings>
</configuration>
]]>
</code>
<para>Cake Task:</para>
<code>
<![CDATA[
Task("Transform")
.Does(() =>
{
var result = XmlPokeString(xmlString, "/configuration/appSettings/add[@testing]", null);
});
]]>
</code>
</example>
<para>
Credit to NAnt for the original example.
http://nant.sourceforge.net/release/latest/help/tasks/xmlpoke.html.
</para>
</member>
<member name="M:Cake.Common.Xml.XmlPokeAliases.XmlPoke(System.IO.Stream,System.IO.Stream,System.String,System.String,Cake.Common.Xml.XmlPokeSettings)">
<summary>
Set the value of, or remove, target nodes.
</summary>
<param name="source">The source xml to transform.</param>
<param name="destination">The destination to write too.</param>
<param name="xpath">The xpath of the nodes to set.</param>
<param name="value">The value to set too. Leave blank to remove the selected nodes.</param>
<param name="settings">Additional settings to tweak Xml Poke behavior.</param>
</member>
<member name="M:Cake.Common.Xml.XmlPokeAliases.GetXmlReaderSettings(Cake.Common.Xml.XmlPokeSettings)">
<summary>
Gets a XmlReaderSettings from a XmlPokeSettings.
</summary>
<returns>The xml reader settings.</returns>
<param name="settings">Additional settings to tweak Xml Poke behavior.</param>
</member>
<member name="M:Cake.Common.Xml.XmlPokeAliases.GetXmlWriterSettings(Cake.Common.Xml.XmlPokeSettings)">
<summary>
Gets a XmlWriterSettings from a XmlPokeSettings.
</summary>
<param name="settings">Additional settings to tweak Xml Poke behavior.</param>
<returns>The xml writer settings.</returns>
</member>
<member name="T:Cake.Common.Xml.XmlPokeSettings">
<summary>
Contains settings for <see cref="T:Cake.Common.Xml.XmlPokeAliases"/>.
</summary>
</member>
<member name="P:Cake.Common.Xml.XmlPokeSettings.PreserveWhitespace">
<summary>
Gets or sets a value indicating whether to preserve white space.
</summary>
</member>
<member name="P:Cake.Common.Xml.XmlPokeSettings.Namespaces">
<summary>
Gets or sets namespaces to include for xpath recognition.
</summary>
</member>
<member name="P:Cake.Common.Xml.XmlPokeSettings.Encoding">
<summary>
Gets or sets the type of text encoding to use.
</summary>
</member>
<member name="P:Cake.Common.Xml.XmlPokeSettings.DtdProcessing">
<summary>
Gets or sets a value that determines the processing of DTDs.
</summary>
</member>
<member name="P:Cake.Common.Xml.XmlPokeSettings.NewLineOnAttributes">
<summary>
Gets or sets a value indicating whether to write attributes on a new line.
This setting is used when <see cref="P:Cake.Common.Xml.XmlPokeSettings.Indent"/> is set to true.
</summary>
</member>
<member name="P:Cake.Common.Xml.XmlPokeSettings.IndentChars">
<summary>
Gets or sets the character string to use when indenting.
This setting is used when <see cref="P:Cake.Common.Xml.XmlPokeSettings.Indent"/> is set to true.
The default is two spaces.
</summary>
</member>
<member name="P:Cake.Common.Xml.XmlPokeSettings.Indent">
<summary>
Gets or sets a value indicating whether to indent elements.
</summary>
</member>
<member name="M:Cake.Common.Xml.XmlPokeSettings.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Xml.XmlPokeSettings"/> class.
</summary>
</member>
<member name="T:Cake.Common.Xml.XmlTransformation">
<summary>
Provides functionality to perform XML transformation.
</summary>
</member>
<member name="M:Cake.Common.Xml.XmlTransformation.Transform(System.String,System.String)">
<summary>
Performs XML XSL transformation.
</summary>
<param name="xsl">XML style sheet.</param>
<param name="xml">XML data.</param>
<returns>Transformed XML string.</returns>
</member>
<member name="M:Cake.Common.Xml.XmlTransformation.Transform(System.String,System.String,Cake.Common.Xml.XmlTransformationSettings)">
<summary>
Performs XML XSL transformation.
</summary>
<param name="xsl">XML style sheet.</param>
<param name="xml">XML data.</param>
<param name="settings">Settings for result file XML transformation.</param>
<returns>Transformed XML string.</returns>
</member>
<member name="M:Cake.Common.Xml.XmlTransformation.Transform(Cake.Core.IO.IFileSystem,Cake.Core.IO.FilePath,Cake.Core.IO.FilePath,Cake.Core.IO.FilePath)">
<summary>
Performs XML XSL transformation.
</summary>
<param name="fileSystem">The file system.</param>
<param name="xslPath">Path to XML style sheet.</param>
<param name="xmlPath">Path XML data.</param>
<param name="resultPath">Transformation result path.</param>
</member>
<member name="M:Cake.Common.Xml.XmlTransformation.Transform(Cake.Core.IO.IFileSystem,Cake.Core.IO.FilePath,Cake.Core.IO.FilePath,Cake.Core.IO.FilePath,Cake.Common.Xml.XmlTransformationSettings)">
<summary>
Performs XML XSL transformation.
</summary>
<param name="fileSystem">The file system.</param>
<param name="xslPath">Path to XML style sheet.</param>
<param name="xmlPath">Path XML data.</param>
<param name="resultPath">Transformation result path.</param>
<param name="settings">Settings for result file XML transformation.</param>
</member>
<member name="M:Cake.Common.Xml.XmlTransformation.Transform(System.IO.TextReader,System.Xml.Xsl.XsltArgumentList,System.IO.TextReader,System.IO.Stream,System.Xml.XmlWriterSettings)">
<summary>
Performs XML XSL transformation.
</summary>
<param name="xsl">XML style sheet.</param>
<param name="arguments">XSLT argument list.</param>
<param name="xml">XML data.</param>
<param name="result">Transformation result.</param>
<param name="settings">Optional settings for result file XML writer.</param>
</member>
<member name="M:Cake.Common.Xml.XmlTransformation.Transform(System.Xml.XmlReader,System.Xml.Xsl.XsltArgumentList,System.Xml.XmlReader,System.Xml.XmlWriter)">
<summary>
Performs XML XSL transformation.
</summary>
<param name="xsl">XML style sheet.</param>
<param name="arguments">XSLT argument list.</param>
<param name="xml">XML data.</param>
<param name="result">Transformation result.</param>
</member>
<member name="T:Cake.Common.Xml.XmlTransformationAlias">
<summary>
Contains functionality related to XML XSL transformation.
</summary>
</member>
<member name="M:Cake.Common.Xml.XmlTransformationAlias.XmlTransform(Cake.Core.ICakeContext,System.String,System.String)">
<summary>
Performs XML XSL transformation.
</summary>
<param name="context">The context.</param>
<param name="xsl">XML style sheet.</param>
<param name="xml">XML data.</param>
<returns>Transformed XML string.</returns>
<example>
<code>
<para>This example code will convert xml to a new xml structure using XmlTransform alias.</para>
<![CDATA[
string xsl = @"<xsl:stylesheet version=""1.0"" xmlns:xsl=""http://www.w3.org/1999/XSL/Transform"">
<xsl:output method=""xml"" omit-xml-declaration=""yes"" />
<xsl:template match=""/"">
<xsl:for-each select=""pastery/cake"" >
<price><xsl:value-of select=""@price""/></price>
</xsl:for-each>
</xsl:template>
</xsl:stylesheet>";
string xml = @"<?xml version=""1.0"" encoding=""UTF-8""?>
<pastery>
<cake price=""1.62"" />
</pastery>";
var priceTag = XmlTransform(xsl, xml);
]]>
</code>
<para>Result:</para>
<code>
<![CDATA[<price>1.62</price>]]>
</code>
</example>
</member>
<member name="M:Cake.Common.Xml.XmlTransformationAlias.XmlTransform(Cake.Core.ICakeContext,System.String,System.String,Cake.Common.Xml.XmlTransformationSettings)">
<summary>
Performs XML XSL transformation.
</summary>
<param name="context">The context.</param>
<param name="xsl">XML style sheet.</param>
<param name="xml">XML data.</param>
<param name="settings">Optional settings for result file xml writer.</param>
<returns>Transformed XML string.</returns>
<example>
<code>
<para>This example code will convert specific part of xml to plaintext using XmlTransform alias.</para>
<![CDATA[string xsl = @"<xsl:stylesheet version=""1.0"" xmlns:xsl=""http://www.w3.org/1999/XSL/Transform"">
<xsl:output method=""text"" omit-xml-declaration=""yes"" indent=""no""/>
<xsl:strip-space elements=""*""/>
<xsl:template match=""pastery/cake""><xsl:value-of select=""@price""/></xsl:template>
</xsl:stylesheet>";
string xml = @"<?xml version=""1.0"" encoding=""UTF-8""?>
<pastery>
<cake price=""1.62"" />
</pastery>";
var text = XmlTransform(xsl, xml, new XmlTransformationSettings {
ConformanceLevel = System.Xml.ConformanceLevel.Fragment, Encoding = Encoding.ASCII });
]]>
</code>
</example>
</member>
<member name="M:Cake.Common.Xml.XmlTransformationAlias.XmlTransform(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Core.IO.FilePath,Cake.Core.IO.FilePath)">
<summary>
Performs XML XSL transformation.
</summary>
<param name="context">The context.</param>
<param name="xslPath">Path to xml style sheet.</param>
<param name="xmlPath">Path xml data.</param>
<param name="resultPath">Transformation result path, will overwrite if exists.</param>
<example>
<code>
<para>This example code will convert the Cake nuspec into html using the XmlTransform alias.</para>
<para>XML stylesheet:</para>
<![CDATA[
<?xml version="1.0" ?>
<xsl:stylesheet
version="1.0"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:p="http://schemas.microsoft.com/packaging/2010/07/nuspec.xsd"
exclude-result-prefixes="p"
>
<xsl:output method="xml" indent="yes" omit-xml-declaration="yes" />
<xsl:template match="/">
<html lang="en" class="static">
<head>
<title>
<xsl:for-each select="package/p:metadata">
<xsl:value-of select="p:id"/>
</xsl:for-each>
</title>
</head>
<body>
<xsl:for-each select="package/p:metadata">
<h1>
<xsl:value-of select="p:id"/>
</h1>
<h2>Description</h2>
<i><xsl:value-of select="p:description"/></i>
</xsl:for-each>
<h3>Files</h3>
<ul>
<xsl:for-each select="package/files/file" >
<li><xsl:value-of select="@src"/></li>
</xsl:for-each>
</ul>
</body>
</html>
</xsl:template>
</xsl:stylesheet>
]]>
</code>
<para>XmlTransform usage:</para>
<code>
XmlTransform("./nuspec.xsl", "./nuspec/Cake.nuspec", "./Cake.htm");
</code>
</example>
</member>
<member name="M:Cake.Common.Xml.XmlTransformationAlias.XmlTransform(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.Core.IO.FilePath,Cake.Core.IO.FilePath,Cake.Common.Xml.XmlTransformationSettings)">
<summary>
Performs XML XSL transformation.
</summary>
<param name="context">The context.</param>
<param name="xslPath">Path to xml style sheet.</param>
<param name="xmlPath">Path xml data.</param>
<param name="resultPath">Transformation result path.</param>
<param name="settings">Optional settings for result file xml writer.</param>
<example>
<code>
<para>This example code will convert the Cake nuspec into html using the XmlTransform alias,
specifying that result should be indented and using Unicode encoding.</para>
<para>XML stylesheet:</para>
<![CDATA[
<?xml version="1.0" ?>
<xsl:stylesheet
version="1.0"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:p="http://schemas.microsoft.com/packaging/2010/07/nuspec.xsd"
exclude-result-prefixes="p"
>
<xsl:output method="xml" indent="yes" omit-xml-declaration="yes" />
<xsl:template match="/">
<html lang="en" class="static">
<head>
<title>
<xsl:for-each select="package/p:metadata">
<xsl:value-of select="p:id"/>
</xsl:for-each>
</title>
</head>
<body>
<xsl:for-each select="package/p:metadata">
<h1>
<xsl:value-of select="p:id"/>
</h1>
<h2>Description</h2>
<i><xsl:value-of select="p:description"/></i>
</xsl:for-each>
<h3>Files</h3>
<ul>
<xsl:for-each select="package/files/file" >
<li><xsl:value-of select="@src"/></li>
</xsl:for-each>
</ul>
</body>
</html>
</xsl:template>
</xsl:stylesheet>
]]>
</code>
<para>XmlTransform usage:</para>
<code>
XmlTransform("./nuspec.xsl", "./nuspec/Cake.nuspec", "./Cake.htm",
new XmlTransformationSettings { Indent = true, Encoding = Encoding.Unicode});
</code>
</example>
</member>
<member name="T:Cake.Common.Xml.XmlTransformationSettings">
<summary>
Contains settings for <see cref="T:Cake.Common.Xml.XmlTransformation"/>.
</summary>
</member>
<member name="P:Cake.Common.Xml.XmlTransformationSettings.Overwrite">
<summary>
Gets or sets a value indicating whether overwriting existing file is permitted.
</summary>
</member>
<member name="P:Cake.Common.Xml.XmlTransformationSettings.CheckCharacters">
<summary>
Gets or sets a value indicating whether the XML writer should check to ensure that all characters in the document conform to the "2.2 Characters" section of the W3C XML 1.0 Recommendation.
</summary>
</member>
<member name="P:Cake.Common.Xml.XmlTransformationSettings.ConformanceLevel">
<summary>
Gets or sets a value indicating level of conformance that the XmlWriter checks the XML output for.
</summary>
</member>
<member name="P:Cake.Common.Xml.XmlTransformationSettings.DoNotEscapeUriAttributes">
<summary>
Gets or sets a value indicating whether the XmlWriter does not escape URI attributes.
</summary>
</member>
<member name="P:Cake.Common.Xml.XmlTransformationSettings.Encoding">
<summary>
Gets or sets the type of text encoding to use.
</summary>
</member>
<member name="P:Cake.Common.Xml.XmlTransformationSettings.Indent">
<summary>
Gets or sets a value indicating whether to indent elements.
</summary>
</member>
<member name="P:Cake.Common.Xml.XmlTransformationSettings.IndentChars">
<summary>
Gets or sets the character string to use when indenting. This setting is used when the Indent property is set to true.
</summary>
</member>
<member name="P:Cake.Common.Xml.XmlTransformationSettings.NamespaceHandling">
<summary>
Gets or sets a value that indicates whether the XmlWriter should remove duplicate namespace declarations when writing XML content. The default behavior is for the writer to output all namespace declarations that are present in the writer's namespace resolver.
</summary>
</member>
<member name="P:Cake.Common.Xml.XmlTransformationSettings.NewLineChars">
<summary>
Gets or sets the character string to use for line breaks.
</summary>
</member>
<member name="P:Cake.Common.Xml.XmlTransformationSettings.NewLineHandling">
<summary>
Gets or sets a value indicating whether to normalize line breaks in the output.
</summary>
</member>
<member name="P:Cake.Common.Xml.XmlTransformationSettings.NewLineOnAttributes">
<summary>
Gets or sets a value indicating whether to write attributes on a new line.
</summary>
</member>
<member name="P:Cake.Common.Xml.XmlTransformationSettings.OmitXmlDeclaration">
<summary>
Gets or sets a value indicating whether to omit an XML declaration.
</summary>
</member>
<member name="P:Cake.Common.Xml.XmlTransformationSettings.WriteEndDocumentOnClose">
<summary>
Gets or sets a value indicating whether the XmlWriter will add closing tags to all unclosed element tags when the Close method is called.
</summary>
</member>
<member name="P:Cake.Common.Xml.XmlTransformationSettings.XsltArgumentList">
<summary>
Gets or sets an argument list for XSL transformation.
</summary>
</member>
<member name="M:Cake.Common.Xml.XmlTransformationSettings.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Common.Xml.XmlTransformationSettings"/> class.
</summary>
</member>
</members>
</doc>
md5: B6171C0E9CB32B2A1F69FDC81FA2CD46 | sha1: EF266DD4E6442C1CB1D44A624B851B2AA7E63B9C | sha256: 03C3772C71F4E7E223AC5EBC2A048DEC951AD1C9EBC7DC8954C77A13F955FECC | sha512: 70D90CDCCACF8D724BFD8B1005B23EADF542C068E8291770329908A4A2012A2D0F3064EA438B6648B963362D043D3392C04C1C2761D2F7618108A94E1B7295E3
<?xml version="1.0"?>
<doc>
<assembly>
<name>Cake.Core</name>
</assembly>
<members>
<member name="T:Cake.Core.AfterSetupEventArgs">
<summary>
Event data for the <see cref="E:Cake.Core.ICakeEngine.AfterSetup"/> event.
</summary>
</member>
<member name="P:Cake.Core.AfterSetupEventArgs.Context">
<summary>
Gets the Cake context.
</summary>
</member>
<member name="M:Cake.Core.AfterSetupEventArgs.#ctor(Cake.Core.ICakeContext)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.AfterSetupEventArgs"/> class.
</summary>
<param name="context">The context.</param>
</member>
<member name="T:Cake.Core.AfterTaskSetupEventArgs">
<summary>
Event data for the <see cref="E:Cake.Core.ICakeEngine.AfterTaskSetup"/> event.
</summary>
</member>
<member name="P:Cake.Core.AfterTaskSetupEventArgs.TaskSetupContext">
<summary>
Gets the task setup context.
</summary>
</member>
<member name="M:Cake.Core.AfterTaskSetupEventArgs.#ctor(Cake.Core.ITaskSetupContext)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.AfterTaskSetupEventArgs"/> class.
</summary>
<param name="taskSetupContext">The task setup context.</param>
</member>
<member name="T:Cake.Core.AfterTaskTeardownEventArgs">
<summary>
Event data for the <see cref="E:Cake.Core.ICakeEngine.AfterTaskTeardown"/> event.
</summary>
</member>
<member name="P:Cake.Core.AfterTaskTeardownEventArgs.TaskTeardownContext">
<summary>
Gets the task teardown context.
</summary>
</member>
<member name="M:Cake.Core.AfterTaskTeardownEventArgs.#ctor(Cake.Core.ITaskTeardownContext)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.AfterTaskTeardownEventArgs"/> class.
</summary>
<param name="taskTeardownContext">The task teardown context.</param>
</member>
<member name="T:Cake.Core.AfterTeardownEventArgs">
<summary>
Event data for the <see cref="E:Cake.Core.ICakeEngine.AfterTeardown"/> event.
</summary>
</member>
<member name="P:Cake.Core.AfterTeardownEventArgs.TeardownContext">
<summary>
Gets the teardown context.
</summary>
</member>
<member name="M:Cake.Core.AfterTeardownEventArgs.#ctor(Cake.Core.ITeardownContext)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.AfterTeardownEventArgs"/> class.
</summary>
<param name="teardownContext">The teardown context.</param>
</member>
<member name="T:Cake.Core.Annotations.CakeAliasAttribute">
<summary>
An attribute used to mark script aliases.
</summary>
</member>
<member name="T:Cake.Core.Annotations.CakeAliasCategoryAttribute">
<summary>
An attribute used for documentation of alias methods/properties.
</summary>
</member>
<member name="P:Cake.Core.Annotations.CakeAliasCategoryAttribute.Name">
<summary>
Gets the category name.
</summary>
<value>The category name.</value>
</member>
<member name="M:Cake.Core.Annotations.CakeAliasCategoryAttribute.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Annotations.CakeAliasCategoryAttribute"/> class.
</summary>
<param name="name">The category name.</param>
</member>
<member name="T:Cake.Core.Annotations.CakeMethodAliasAttribute">
<summary>
An attribute used to mark script method aliases.
</summary>
</member>
<member name="T:Cake.Core.Annotations.CakeModuleAttribute">
<summary>
An attribute used to identify a module implementation in an assembly.
</summary>
</member>
<member name="P:Cake.Core.Annotations.CakeModuleAttribute.ModuleType">
<summary>
Gets the module type.
</summary>
<value>The module type.</value>
</member>
<member name="M:Cake.Core.Annotations.CakeModuleAttribute.#ctor(System.Type)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Annotations.CakeModuleAttribute"/> class.
</summary>
<param name="moduleType">The module type.</param>
</member>
<member name="T:Cake.Core.Annotations.CakeNamespaceImportAttribute">
<summary>
An attribute used to hint Cake about additional namespaces that need
to be imported for an alias to work. This attribute can mark an
extension method, the extension method class, or the assembly to provide a global set of imports.
</summary>
</member>
<member name="P:Cake.Core.Annotations.CakeNamespaceImportAttribute.Namespace">
<summary>
Gets the namespace.
</summary>
<value>The namespace.</value>
</member>
<member name="M:Cake.Core.Annotations.CakeNamespaceImportAttribute.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Annotations.CakeNamespaceImportAttribute"/> class.
</summary>
<param name="namespace">The namespace.</param>
</member>
<member name="T:Cake.Core.Annotations.CakePropertyAliasAttribute">
<summary>
An attribute used to mark script property aliases.
</summary>
</member>
<member name="P:Cake.Core.Annotations.CakePropertyAliasAttribute.Cache">
<summary>
Gets or sets a value indicating whether the result of the property alias method should be cached.
Indicates .
</summary>
<value>
<c>true</c> if cache; otherwise, <c>false</c>.
</value>
</member>
<member name="T:Cake.Core.Annotations.NamespaceDoc">
<summary>
This namespace contain attributes used by
the Cake engine and addins.
</summary>
</member>
<member name="T:Cake.Core.BeforeSetupEventArgs">
<summary>
Event data for the <see cref="E:Cake.Core.ICakeEngine.BeforeSetup"/> event.
</summary>
</member>
<member name="P:Cake.Core.BeforeSetupEventArgs.Context">
<summary>
Gets the Cake context.
</summary>
</member>
<member name="M:Cake.Core.BeforeSetupEventArgs.#ctor(Cake.Core.ICakeContext)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.BeforeSetupEventArgs"/> class.
</summary>
<param name="context">The context.</param>
</member>
<member name="T:Cake.Core.BeforeTaskSetupEventArgs">
<summary>
Event data for the <see cref="E:Cake.Core.ICakeEngine.BeforeTaskSetup"/> event.
</summary>
</member>
<member name="P:Cake.Core.BeforeTaskSetupEventArgs.TaskSetupContext">
<summary>
Gets the task setup context.
</summary>
</member>
<member name="M:Cake.Core.BeforeTaskSetupEventArgs.#ctor(Cake.Core.ITaskSetupContext)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.BeforeTaskSetupEventArgs"/> class.
</summary>
<param name="taskSetupContext">The task setup context.</param>
</member>
<member name="T:Cake.Core.BeforeTaskTeardownEventArgs">
<summary>
Event data for the <see cref="E:Cake.Core.ICakeEngine.BeforeTaskTeardown"/> event.
</summary>
</member>
<member name="P:Cake.Core.BeforeTaskTeardownEventArgs.TaskTeardownContext">
<summary>
Gets the task teardown context.
</summary>
</member>
<member name="M:Cake.Core.BeforeTaskTeardownEventArgs.#ctor(Cake.Core.ITaskTeardownContext)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.BeforeTaskTeardownEventArgs"/> class.
</summary>
<param name="taskTeardownContext">The task teardown context.</param>
</member>
<member name="T:Cake.Core.BeforeTeardownEventArgs">
<summary>
Event data for the <see cref="E:Cake.Core.ICakeEngine.BeforeTeardown"/> event.
</summary>
</member>
<member name="P:Cake.Core.BeforeTeardownEventArgs.TeardownContext">
<summary>
Gets the teardown context.
</summary>
</member>
<member name="M:Cake.Core.BeforeTeardownEventArgs.#ctor(Cake.Core.ITeardownContext)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.BeforeTeardownEventArgs"/> class.
</summary>
<param name="teardownContext">The teardown context.</param>
</member>
<member name="T:Cake.Core.CakeArguments">
<inheritdoc/>
</member>
<member name="M:Cake.Core.CakeArguments.#ctor(System.Linq.ILookup{System.String,System.String})">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.CakeArguments"/> class.
</summary>
<param name="arguments">The arguments.</param>
</member>
<member name="M:Cake.Core.CakeArguments.HasArgument(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.CakeArguments.GetArguments(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.CakeArguments.GetArguments">
<inheritdoc/>
</member>
<member name="T:Cake.Core.CakeConsole">
<summary>
The default console implementation.
</summary>
</member>
<member name="P:Cake.Core.CakeConsole.ForegroundColor">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeConsole.BackgroundColor">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeConsole.SupportAnsiEscapeCodes">
<inheritdoc/>
</member>
<member name="M:Cake.Core.CakeConsole.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.CakeConsole"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="M:Cake.Core.CakeConsole.Write(System.String,System.Object[])">
<inheritdoc/>
</member>
<member name="M:Cake.Core.CakeConsole.WriteLine(System.String,System.Object[])">
<inheritdoc/>
</member>
<member name="M:Cake.Core.CakeConsole.WriteError(System.String,System.Object[])">
<inheritdoc/>
</member>
<member name="M:Cake.Core.CakeConsole.WriteErrorLine(System.String,System.Object[])">
<inheritdoc/>
</member>
<member name="M:Cake.Core.CakeConsole.ResetColor">
<inheritdoc/>
</member>
<member name="T:Cake.Core.CakeContext">
<summary>
Implementation of <see cref="T:Cake.Core.ICakeContext"/>.
</summary>
</member>
<member name="M:Cake.Core.CakeContext.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IGlobber,Cake.Core.Diagnostics.ICakeLog,Cake.Core.ICakeArguments,Cake.Core.IO.IProcessRunner,Cake.Core.IO.IRegistry,Cake.Core.Tooling.IToolLocator,Cake.Core.ICakeDataService,Cake.Core.Configuration.ICakeConfiguration)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.CakeContext"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="globber">The globber.</param>
<param name="log">The log.</param>
<param name="arguments">The arguments.</param>
<param name="processRunner">The process runner.</param>
<param name="registry">The registry.</param>
<param name="tools">The tool locator.</param>
<param name="data">The data service.</param>
<param name="configuration">The cake configuration.</param>
</member>
<member name="P:Cake.Core.CakeContext.FileSystem">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeContext.Environment">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeContext.Globber">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeContext.Log">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeContext.Arguments">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeContext.ProcessRunner">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeContext.Registry">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeContext.Tools">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeContext.Data">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeContext.Configuration">
<inheritdoc/>
</member>
<member name="T:Cake.Core.CakeContextAdapter">
<summary>
Adapter to ensure correct conversion of Cake Context in derived classes.
</summary>
</member>
<member name="M:Cake.Core.CakeContextAdapter.#ctor(Cake.Core.ICakeContext)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.CakeContextAdapter"/> class.
</summary>
<param name="context">The Cake Context.</param>
</member>
<member name="P:Cake.Core.CakeContextAdapter.FileSystem">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeContextAdapter.Environment">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeContextAdapter.Globber">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeContextAdapter.Log">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeContextAdapter.Arguments">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeContextAdapter.ProcessRunner">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeContextAdapter.Registry">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeContextAdapter.Tools">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeContextAdapter.Data">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeContextAdapter.Configuration">
<inheritdoc/>
</member>
<member name="T:Cake.Core.CakeDataService">
<summary>
Implementation of <see cref="T:Cake.Core.ICakeDataService"/>.
</summary>
</member>
<member name="M:Cake.Core.CakeDataService.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.CakeDataService"/> class.
</summary>
</member>
<member name="M:Cake.Core.CakeDataService.Get``1">
<inheritdoc/>
</member>
<member name="M:Cake.Core.CakeDataService.Add``1(``0)">
<inheritdoc/>
</member>
<member name="T:Cake.Core.CakeEngine">
<summary>
The Cake execution engine.
</summary>
</member>
<member name="P:Cake.Core.CakeEngine.Tasks">
<inheritdoc/>
</member>
<member name="E:Cake.Core.CakeEngine.BeforeSetup">
<inheritdoc/>
</member>
<member name="E:Cake.Core.CakeEngine.AfterSetup">
<inheritdoc/>
</member>
<member name="E:Cake.Core.CakeEngine.BeforeTeardown">
<inheritdoc/>
</member>
<member name="E:Cake.Core.CakeEngine.AfterTeardown">
<inheritdoc/>
</member>
<member name="E:Cake.Core.CakeEngine.BeforeTaskSetup">
<inheritdoc/>
</member>
<member name="E:Cake.Core.CakeEngine.AfterTaskSetup">
<inheritdoc/>
</member>
<member name="E:Cake.Core.CakeEngine.BeforeTaskTeardown">
<inheritdoc/>
</member>
<member name="E:Cake.Core.CakeEngine.AfterTaskTeardown">
<inheritdoc/>
</member>
<member name="M:Cake.Core.CakeEngine.#ctor(Cake.Core.ICakeDataService,Cake.Core.Diagnostics.ICakeLog)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.CakeEngine"/> class.
</summary>
<param name="data">The data service.</param>
<param name="log">The log.</param>
</member>
<member name="M:Cake.Core.CakeEngine.RegisterTask(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.CakeEngine.RegisterSetupAction(System.Action{Cake.Core.ISetupContext})">
<inheritdoc/>
</member>
<member name="M:Cake.Core.CakeEngine.RegisterSetupAction``1(System.Func{Cake.Core.ISetupContext,``0})">
<inheritdoc/>
</member>
<member name="M:Cake.Core.CakeEngine.RegisterTeardownAction(System.Action{Cake.Core.ITeardownContext})">
<inheritdoc/>
</member>
<member name="M:Cake.Core.CakeEngine.RegisterTeardownAction``1(System.Action{Cake.Core.ITeardownContext,``0})">
<inheritdoc/>
<param name="action">The action to be executed.</param>
</member>
<member name="M:Cake.Core.CakeEngine.RegisterTaskSetupAction(System.Action{Cake.Core.ITaskSetupContext})">
<inheritdoc/>
</member>
<member name="M:Cake.Core.CakeEngine.RegisterTaskSetupAction``1(System.Action{Cake.Core.ITaskSetupContext,``0})">
<inheritdoc/>
</member>
<member name="M:Cake.Core.CakeEngine.RegisterTaskTeardownAction(System.Action{Cake.Core.ITaskTeardownContext})">
<inheritdoc/>
</member>
<member name="M:Cake.Core.CakeEngine.RegisterTaskTeardownAction``1(System.Action{Cake.Core.ITaskTeardownContext,``0})">
<inheritdoc/>
</member>
<member name="M:Cake.Core.CakeEngine.RunTargetAsync(Cake.Core.ICakeContext,Cake.Core.IExecutionStrategy,Cake.Core.ExecutionSettings)">
<inheritdoc/>
</member>
<member name="T:Cake.Core.CakeEngineActions">
<summary>
Container for actions required by the engine.
</summary>
</member>
<member name="P:Cake.Core.CakeEngineActions.Setups">
<summary>
Gets all registerd setup actions.
</summary>
</member>
<member name="P:Cake.Core.CakeEngineActions.Teardowns">
<summary>
Gets all registered teardown actions.
</summary>
</member>
<member name="P:Cake.Core.CakeEngineActions.TaskSetup">
<summary>
Gets the registered task setup action.
</summary>
</member>
<member name="P:Cake.Core.CakeEngineActions.TaskTeardown">
<summary>
Gets the registered task teardown action.
</summary>
</member>
<member name="M:Cake.Core.CakeEngineActions.#ctor(Cake.Core.ICakeDataService)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.CakeEngineActions"/> class.
</summary>
<param name="data">The data context.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="data"/> is null.</exception>
</member>
<member name="M:Cake.Core.CakeEngineActions.RegisterSetup(System.Action{Cake.Core.ISetupContext})">
<summary>
Register a setup action.
</summary>
<param name="action">The setup action.</param>
</member>
<member name="M:Cake.Core.CakeEngineActions.RegisterSetup``1(System.Func{Cake.Core.ISetupContext,``0})">
<summary>
Registers a setup action.
</summary>
<typeparam name="TData">Type of the data for the setup action.</typeparam>
<param name="action">The setup action.</param>
<exception cref="T:Cake.Core.CakeException"><typeparamref name="TData"/> was already registered.</exception>
</member>
<member name="M:Cake.Core.CakeEngineActions.RegisterTeardown(System.Action{Cake.Core.ITeardownContext})">
<summary>
Registers a teardown action.
</summary>
<param name="action">The teardown action.</param>
</member>
<member name="M:Cake.Core.CakeEngineActions.RegisterTeardown``1(System.Action{Cake.Core.ITeardownContext,``0})">
<summary>
Registers a teardown action.
</summary>
<typeparam name="TData">Type of the data for the teardown action.</typeparam>
<param name="action">The teardown action.</param>
</member>
<member name="M:Cake.Core.CakeEngineActions.RegisterTaskSetup(System.Action{Cake.Core.ITaskSetupContext})">
<summary>
Registers the task setup action.
</summary>
<param name="action">The task setup action.</param>
</member>
<member name="M:Cake.Core.CakeEngineActions.RegisterTaskSetup``1(System.Action{Cake.Core.ITaskSetupContext,``0})">
<summary>
Registers the task setup action.
</summary>
<typeparam name="TData">Type of the data for the task setup action.</typeparam>
<param name="action">The task setup action.</param>
</member>
<member name="M:Cake.Core.CakeEngineActions.RegisterTaskTeardown(System.Action{Cake.Core.ITaskTeardownContext})">
<summary>
Registers the task teardown action.
</summary>
<param name="action">The task teardown action.</param>
</member>
<member name="M:Cake.Core.CakeEngineActions.RegisterTaskTeardown``1(System.Action{Cake.Core.ITaskTeardownContext,``0})">
<summary>
Registers the task teardown action.
</summary>
<typeparam name="TData">Type of the data for the task teardown action.</typeparam>
<param name="action">The task teardown action.</param>
</member>
<member name="M:Cake.Core.CakeEngineActions.Validate">
<summary>
Executed all validations.
</summary>
</member>
<member name="T:Cake.Core.CakeEnvironment">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeEnvironment.WorkingDirectory">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeEnvironment.ApplicationRoot">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeEnvironment.Platform">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeEnvironment.Runtime">
<inheritdoc/>
</member>
<member name="M:Cake.Core.CakeEnvironment.#ctor(Cake.Core.ICakePlatform,Cake.Core.ICakeRuntime)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.CakeEnvironment" /> class.
</summary>
<param name="platform">The platform.</param>
<param name="runtime">The runtime.</param>
</member>
<member name="M:Cake.Core.CakeEnvironment.GetSpecialPath(Cake.Core.IO.SpecialPath)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.CakeEnvironment.GetEnvironmentVariable(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.CakeEnvironment.GetEnvironmentVariables">
<inheritdoc/>
</member>
<member name="T:Cake.Core.CakeEnvironmentExtensions">
<summary>
Contains extensions for <see cref="T:Cake.Core.ICakeEnvironment"/>.
</summary>
</member>
<member name="M:Cake.Core.CakeEnvironmentExtensions.ExpandEnvironmentVariables(Cake.Core.ICakeEnvironment,System.String)">
<summary>
Expands the environment variables in the provided text.
</summary>
<example>
<code>
var expanded = environment.ExpandEnvironmentVariables("%APPDATA%/foo");
</code>
</example>
<param name="environment">The environment.</param>
<param name="text">A string containing the names of zero or more environment variables.</param>
<returns>A string with each environment variable replaced by its value.</returns>
</member>
<member name="T:Cake.Core.CakeException">
<summary>
Represent errors that occur during script execution.
</summary>
</member>
<member name="P:Cake.Core.CakeException.ExitCode">
<summary>
Gets custom exit code.
</summary>
</member>
<member name="M:Cake.Core.CakeException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.CakeException"/> class.
</summary>
</member>
<member name="M:Cake.Core.CakeException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.CakeException"/> class.
</summary>
<param name="message">The message that describes the error.</param>
</member>
<member name="M:Cake.Core.CakeException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.CakeException"/> class.
</summary>
<param name="message">The error message that explains the reason for the exception.</param>
<param name="innerException">The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified.</param>
</member>
<member name="M:Cake.Core.CakeException.#ctor(System.Int32)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.CakeException"/> class.
</summary>
<param name="exitCode">Exit code.</param>
</member>
<member name="M:Cake.Core.CakeException.#ctor(System.Int32,System.String)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.CakeException"/> class.
</summary>
<param name="exitCode">Custom exit code.</param>
<param name="message">The error message that explains the reason for the exception.</param>
</member>
<member name="M:Cake.Core.CakeException.#ctor(System.Int32,System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.CakeException"/> class.
</summary>
<param name="exitCode">Custom exit code.</param>
<param name="message">The error message that explains the reason for the exception.</param>
<param name="innerException">The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified.</param>
</member>
<member name="T:Cake.Core.CakePlatform">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakePlatform.Family">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakePlatform.Is64Bit">
<inheritdoc/>
</member>
<member name="M:Cake.Core.CakePlatform.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.CakePlatform"/> class.
</summary>
</member>
<member name="T:Cake.Core.CakeReport">
<summary>
Contains information about tasks that were executed in a script.
</summary>
</member>
<member name="P:Cake.Core.CakeReport.IsEmpty">
<summary>
Gets a value indicating whether the report is empty.
</summary>
<value>
<c>true</c> if this report is empty; otherwise, <c>false</c>.
</value>
</member>
<member name="M:Cake.Core.CakeReport.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.CakeReport"/> class.
</summary>
</member>
<member name="M:Cake.Core.CakeReport.Add(System.String,System.TimeSpan)">
<summary>
Adds a task result to the report.
</summary>
<param name="task">The task.</param>
<param name="span">The span.</param>
</member>
<member name="M:Cake.Core.CakeReport.Add(System.String,Cake.Core.CakeReportEntryCategory,System.TimeSpan)">
<summary>
Adds a task result to the report with a specific category.
</summary>
<param name="task">The task.</param>
<param name="category">The category.</param>
<param name="span">The span.</param>
</member>
<member name="M:Cake.Core.CakeReport.AddSkipped(System.String,System.String)">
<summary>
Adds a skipped task result to the report.
</summary>
<param name="task">The task.</param>
<param name="skippedMessage">The message explaining why the task was skipped.</param>
</member>
<member name="M:Cake.Core.CakeReport.AddFailed(System.String,System.TimeSpan)">
<summary>
Adds a failed task result to the report.
</summary>
<param name="task">The task.</param>
<param name="span">The span.</param>
</member>
<member name="M:Cake.Core.CakeReport.AddDelegated(System.String,System.TimeSpan)">
<summary>
Adds a delegated task result to the report.
</summary>
<param name="task">The task.</param>
<param name="span">The span.</param>
</member>
<member name="M:Cake.Core.CakeReport.Add(System.String,System.String,Cake.Core.CakeReportEntryCategory,System.TimeSpan,Cake.Core.CakeTaskExecutionStatus)">
<summary>
Adds a task result to the report.
</summary>
<param name="task">The task.</param>
<param name="skippedMessage">The message explaining why the task was skipped.</param>
<param name="category">The category.</param>
<param name="span">The span.</param>
<param name="executionStatus">The execution status.</param>
</member>
<member name="M:Cake.Core.CakeReport.GetEnumerator">
<summary>
Returns an enumerator that iterates through the collection.
</summary>
<returns>
A <see cref="T:System.Collections.Generic.IEnumerator`1" /> that can be used to iterate through the collection.
</returns>
</member>
<member name="M:Cake.Core.CakeReport.System#Collections#IEnumerable#GetEnumerator">
<summary>
Returns an enumerator that iterates through a collection.
</summary>
<returns>
An <see cref="T:System.Collections.IEnumerator" /> object that can be used to iterate through the collection.
</returns>
</member>
<member name="T:Cake.Core.CakeReportEntry">
<summary>
Represents an entry in a <see cref="T:Cake.Core.CakeReport"/>.
</summary>
</member>
<member name="P:Cake.Core.CakeReportEntry.TaskName">
<summary>
Gets the task name.
</summary>
<value>The name.</value>
</member>
<member name="P:Cake.Core.CakeReportEntry.SkippedMessage">
<summary>
Gets the message explaining why task was skipped.
</summary>
</member>
<member name="P:Cake.Core.CakeReportEntry.Category">
<summary>
Gets the task category.
</summary>
<value>The category.</value>
</member>
<member name="P:Cake.Core.CakeReportEntry.Duration">
<summary>
Gets the duration the task ran for.
</summary>
<value>The duration the task ran for.</value>
</member>
<member name="P:Cake.Core.CakeReportEntry.ExecutionStatus">
<summary>
Gets the task execution status.
</summary>
<value>The execution status.</value>
</member>
<member name="M:Cake.Core.CakeReportEntry.#ctor(System.String,System.String,Cake.Core.CakeReportEntryCategory,System.TimeSpan)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.CakeReportEntry"/> class.
</summary>
<param name="taskName">The name of the task.</param>
<param name="skippedMessage">The message explaining why the task was skipped.</param>
<param name="category">The task category.</param>
<param name="duration">The duration.</param>
</member>
<member name="M:Cake.Core.CakeReportEntry.#ctor(System.String,System.String,Cake.Core.CakeReportEntryCategory,System.TimeSpan,Cake.Core.CakeTaskExecutionStatus)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.CakeReportEntry"/> class.
</summary>
<param name="taskName">The name of the task.</param>
<param name="skippedMessage">The message explaining why the task was skipped.</param>
<param name="category">The task category.</param>
<param name="duration">The duration.</param>
<param name="executionStatus">The execution status.</param>
</member>
<member name="T:Cake.Core.CakeReportEntryCategory">
<summary>
Represents a Cake report entry category.
</summary>
</member>
<member name="F:Cake.Core.CakeReportEntryCategory.Task">
<summary>
Represents a normal task.
</summary>
</member>
<member name="F:Cake.Core.CakeReportEntryCategory.Setup">
<summary>
Represent a setup task.
</summary>
</member>
<member name="F:Cake.Core.CakeReportEntryCategory.Teardown">
<summary>
Represent a teardown task.
</summary>
</member>
<member name="T:Cake.Core.CakeReportPrinter">
<summary>
The default report printer.
</summary>
</member>
<member name="M:Cake.Core.CakeReportPrinter.#ctor(Cake.Core.IConsole,Cake.Core.ICakeContext)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.CakeReportPrinter"/> class.
</summary>
<param name="console">The console.</param>
<param name="context">The context.</param>
</member>
<member name="M:Cake.Core.CakeReportPrinter.Write(Cake.Core.CakeReport)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.CakeReportPrinter.WriteStep(System.String,Cake.Core.Diagnostics.Verbosity)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.CakeReportPrinter.WriteLifeCycleStep(System.String,Cake.Core.Diagnostics.Verbosity)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.CakeReportPrinter.WriteSkippedStep(System.String,Cake.Core.Diagnostics.Verbosity)">
<inheritdoc/>
</member>
<member name="T:Cake.Core.CakeRuntime">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeRuntime.BuiltFramework">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeRuntime.Runtime">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeRuntime.CakeVersion">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeRuntime.IsCoreClr">
<inheritdoc/>
</member>
<member name="M:Cake.Core.CakeRuntime.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.CakeRuntime"/> class.
</summary>
</member>
<member name="T:Cake.Core.CakeTask">
<summary>
A <see cref="T:Cake.Core.CakeTask"/> represents a unit of work.
</summary>
</member>
<member name="P:Cake.Core.CakeTask.Name">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeTask.Description">
<inheritdoc/>
</member>
<member name="P:Cake.Core.CakeTask.Dependencies">
<summary>
Gets the task's dependencies.
</summary>
<value>The task's dependencies.</value>
</member>
<member name="P:Cake.Core.CakeTask.Dependees">
<summary>
Gets the tasks that the task want to be a dependency of.
</summary>
<value>The tasks that the task want to be a dependency of.</value>
</member>
<member name="P:Cake.Core.CakeTask.Criterias">
<summary>
Gets the task's criterias.
</summary>
<value>The task's criterias.</value>
</member>
<member name="P:Cake.Core.CakeTask.ErrorHandler">
<summary>
Gets or sets the error handler.
</summary>
<value>The error handler.</value>
</member>
<member name="P:Cake.Core.CakeTask.ErrorReporter">
<summary>
Gets or sets the error reporter.
</summary>
</member>
<member name="P:Cake.Core.CakeTask.FinallyHandler">
<summary>
Gets or sets the finally handler.
</summary>
</member>
<member name="P:Cake.Core.CakeTask.Actions">
<summary>
Gets the task's actions.
</summary>
<value>The task's actions.</value>
</member>
<member name="P:Cake.Core.CakeTask.DelayedActions">
<summary>
Gets the task's actions that are run at execution time to additionally populate <see cref="P:Cake.Core.CakeTask.Actions"/>.
</summary>
<value>The task's delayed actions actions.</value>
</member>
<member name="P:Cake.Core.CakeTask.DeferExceptions">
<summary>
Gets or sets a value indicating whether gets the task's state if it will defer exceptions until the end of the task.
</summary>
<value>The task's defer exceptions state.</value>
</member>
<member name="M:Cake.Core.CakeTask.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.CakeTask"/> class.
</summary>
<param name="name">The name of the task.</param>
</member>
<member name="M:Cake.Core.CakeTask.Execute(Cake.Core.ICakeContext)">
<summary>
Executes the task using the specified context.
</summary>
<param name="context">The context.</param>
<returns>Returned Task.</returns>
</member>
<member name="T:Cake.Core.CakeTaskBuilderExtensions">
<summary>
Contains extension methods for <see cref="T:Cake.Core.CakeTaskBuilder"/>.
</summary>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.WithCriteria(Cake.Core.CakeTaskBuilder,System.Boolean)">
<summary>
Adds a criteria that has to be fulfilled for the task to run.
</summary>
<param name="builder">The task builder.</param>
<param name="criteria">The criteria.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.WithCriteria(Cake.Core.CakeTaskBuilder,System.Boolean,System.String)">
<summary>
Adds a criteria that has to be fulfilled for the task to run.
</summary>
<param name="builder">The task builder.</param>
<param name="criteria">The criteria.</param>
<param name="message">The message to display if the task was skipped due to the provided criteria.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.WithCriteria(Cake.Core.CakeTaskBuilder,System.Func{System.Boolean})">
<summary>
Adds a criteria that has to be fulfilled for the task to run.
The criteria is evaluated when traversal of the graph occurs.
</summary>
<param name="builder">The task builder.</param>
<param name="criteria">The criteria.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.WithCriteria(Cake.Core.CakeTaskBuilder,System.Func{System.Boolean},System.String)">
<summary>
Adds a criteria that has to be fulfilled for the task to run.
The criteria is evaluated when traversal of the graph occurs.
</summary>
<param name="builder">The task builder.</param>
<param name="criteria">The criteria.</param>
<param name="message">The message to display if the task was skipped due to the provided criteria.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.WithCriteria(Cake.Core.CakeTaskBuilder,System.Func{Cake.Core.ICakeContext,System.Boolean})">
<summary>
Adds a criteria that has to be fulfilled for the task to run.
The criteria is evaluated when traversal of the graph occurs.
</summary>
<param name="builder">The task builder.</param>
<param name="criteria">The criteria.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.WithCriteria(Cake.Core.CakeTaskBuilder,System.Func{Cake.Core.ICakeContext,System.Boolean},System.String)">
<summary>
Adds a criteria that has to be fulfilled for the task to run.
The criteria is evaluated when traversal of the graph occurs.
</summary>
<param name="builder">The task builder.</param>
<param name="criteria">The criteria.</param>
<param name="message">The message to display if the task was skipped due to the provided criteria.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.WithCriteria``1(Cake.Core.CakeTaskBuilder,System.Func{``0,System.Boolean})">
<summary>
Adds a criteria that has to be fulfilled for the task to run.
The criteria is evaluated when traversal of the graph occurs.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<param name="builder">The task builder.</param>
<param name="criteria">The criteria.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.WithCriteria``1(Cake.Core.CakeTaskBuilder,System.Func{``0,System.Boolean},System.String)">
<summary>
Adds a criteria that has to be fulfilled for the task to run.
The criteria is evaluated when traversal of the graph occurs.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<param name="builder">The task builder.</param>
<param name="criteria">The criteria.</param>
<param name="message">The message to display if the task was skipped due to the provided criteria.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.WithCriteria``1(Cake.Core.CakeTaskBuilder,System.Func{Cake.Core.ICakeContext,``0,System.Boolean})">
<summary>
Adds a criteria that has to be fulfilled for the task to run.
The criteria is evaluated when traversal of the graph occurs.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<param name="builder">The task builder.</param>
<param name="criteria">The criteria.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.WithCriteria``1(Cake.Core.CakeTaskBuilder,System.Func{Cake.Core.ICakeContext,``0,System.Boolean},System.String)">
<summary>
Adds a criteria that has to be fulfilled for the task to run.
The criteria is evaluated when traversal of the graph occurs.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<param name="builder">The task builder.</param>
<param name="criteria">The criteria.</param>
<param name="message">The message to display if the task was skipped due to the provided criteria.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.IsDependentOn(Cake.Core.CakeTaskBuilder,System.String)">
<summary>
Creates a dependency between two tasks.
</summary>
<param name="builder">The task builder.</param>
<param name="name">The name of the dependent task.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.IsDependentOn(Cake.Core.CakeTaskBuilder,Cake.Core.CakeTaskBuilder)">
<summary>
Creates a dependency between two tasks.
</summary>
<param name="builder">The task builder.</param>
<param name="other">The name of the dependent task.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.IsDependeeOf(Cake.Core.CakeTaskBuilder,System.String)">
<summary>
Makes the task a dependency of another task.
</summary>
<param name="builder">The task builder.</param>
<param name="name">The name of the task the current task will be a dependency of.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.IsDependeeOf(Cake.Core.CakeTaskBuilder,Cake.Core.CakeTaskBuilder)">
<summary>
Makes the task a dependency of another task.
</summary>
<param name="builder">The task builder.</param>
<param name="other">The name of the dependent task.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.DeferOnError(Cake.Core.CakeTaskBuilder)">
<summary>
Defers all exceptions until after all actions for this task have completed.
</summary>
<param name="builder">The task builder.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.ContinueOnError(Cake.Core.CakeTaskBuilder)">
<summary>
Adds an indication to the task that a thrown exception will not halt the script execution.
</summary>
<param name="builder">The task builder.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.OnError(Cake.Core.CakeTaskBuilder,System.Action)">
<summary>
Adds an error handler to be executed if an exception occurs in the task.
</summary>
<param name="builder">The builder.</param>
<param name="errorHandler">The error handler.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.OnError(Cake.Core.CakeTaskBuilder,System.Func{System.Threading.Tasks.Task})">
<summary>
Adds an error handler to be executed if an exception occurs in the task.
</summary>
<param name="builder">The builder.</param>
<param name="errorHandler">The error handler.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.OnError(Cake.Core.CakeTaskBuilder,System.Action{System.Exception})">
<summary>
Adds an error handler to be executed if an exception occurs in the task.
</summary>
<param name="builder">The builder.</param>
<param name="errorHandler">The error handler.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.OnError(Cake.Core.CakeTaskBuilder,System.Func{System.Exception,System.Threading.Tasks.Task})">
<summary>
Adds an error handler to be executed if an exception occurs in the task.
</summary>
<param name="builder">The builder.</param>
<param name="errorHandler">The error handler.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.OnError(Cake.Core.CakeTaskBuilder,System.Action{System.Exception,Cake.Core.ICakeContext})">
<summary>
Adds an error handler to be executed if an exception occurs in the task.
</summary>
<param name="builder">The builder.</param>
<param name="errorHandler">The error handler.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.OnError(Cake.Core.CakeTaskBuilder,System.Func{System.Exception,Cake.Core.ICakeContext,System.Threading.Tasks.Task})">
<summary>
Adds an error handler to be executed if an exception occurs in the task.
</summary>
<param name="builder">The builder.</param>
<param name="errorHandler">The error handler.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.OnError``1(Cake.Core.CakeTaskBuilder,System.Action{``0})">
<summary>
Adds an error handler to be executed if an exception occurs in the task.
</summary>
<param name="builder">The builder.</param>
<param name="errorHandler">The error handler.</param>
<typeparam name="TData">The extra data to operate with inside the error handler.</typeparam>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.OnError``1(Cake.Core.CakeTaskBuilder,System.Func{``0,System.Threading.Tasks.Task})">
<summary>
Adds an error handler to be executed if an exception occurs in the task.
</summary>
<param name="builder">The builder.</param>
<param name="errorHandler">The error handler.</param>
<typeparam name="TData">The extra data to operate with inside the error handler.</typeparam>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.OnError``1(Cake.Core.CakeTaskBuilder,System.Action{System.Exception,``0})">
<summary>
Adds an error handler to be executed if an exception occurs in the task.
</summary>
<param name="builder">The builder.</param>
<param name="errorHandler">The error handler.</param>
<typeparam name="TData">The extra data to operate with inside the error handler.</typeparam>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.OnError``1(Cake.Core.CakeTaskBuilder,System.Func{System.Exception,``0,System.Threading.Tasks.Task})">
<summary>
Adds an error handler to be executed if an exception occurs in the task.
</summary>
<param name="builder">The builder.</param>
<param name="errorHandler">The error handler.</param>
<typeparam name="TData">The extra data to operate with inside the error handler.</typeparam>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.OnError``1(Cake.Core.CakeTaskBuilder,System.Action{System.Exception,Cake.Core.ICakeContext,``0})">
<summary>
Adds an error handler to be executed if an exception occurs in the task.
</summary>
<param name="builder">The builder.</param>
<param name="errorHandler">The error handler.</param>
<typeparam name="TData">The extra data to operate with inside the error handler.</typeparam>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.OnError``1(Cake.Core.CakeTaskBuilder,System.Func{System.Exception,Cake.Core.ICakeContext,``0,System.Threading.Tasks.Task})">
<summary>
Adds an error handler to be executed if an exception occurs in the task.
</summary>
<param name="builder">The builder.</param>
<param name="errorHandler">The error handler.</param>
<typeparam name="TData">The extra data to operate with inside the error handler.</typeparam>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.Finally(Cake.Core.CakeTaskBuilder,System.Action)">
<summary>
Adds a finally handler to be executed after the task have finished executing.
</summary>
<param name="builder">The builder.</param>
<param name="finallyHandler">The finally handler.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.Finally(Cake.Core.CakeTaskBuilder,System.Func{System.Threading.Tasks.Task})">
<summary>
Adds a finally handler to be executed after the task have finished executing.
</summary>
<param name="builder">The builder.</param>
<param name="finallyHandler">The finally handler.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.Finally(Cake.Core.CakeTaskBuilder,System.Action{Cake.Core.ICakeContext})">
<summary>
Adds a finally handler to be executed after the task have finished executing.
</summary>
<param name="builder">The builder.</param>
<param name="finallyHandler">The finally handler.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.Finally(Cake.Core.CakeTaskBuilder,System.Func{Cake.Core.ICakeContext,System.Threading.Tasks.Task})">
<summary>
Adds a finally handler to be executed after the task have finished executing.
</summary>
<param name="builder">The builder.</param>
<param name="finallyHandler">The finally handler.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.Finally``1(Cake.Core.CakeTaskBuilder,System.Action{Cake.Core.ICakeContext,``0})">
<summary>
Adds a finally handler to be executed after the task have finished executing.
</summary>
<param name="builder">The builder.</param>
<param name="finallyHandler">The finally handler.</param>
<typeparam name="TData">The extra data to operate with inside the finally handler.</typeparam>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.Finally``1(Cake.Core.CakeTaskBuilder,System.Func{Cake.Core.ICakeContext,``0,System.Threading.Tasks.Task})">
<summary>
Adds a finally handler to be executed after the task have finished executing.
</summary>
<param name="builder">The builder.</param>
<param name="finallyHandler">The finally handler.</param>
<typeparam name="TData">The extra data to operate with inside the finally handler.</typeparam>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.ReportError(Cake.Core.CakeTaskBuilder,System.Action{System.Exception})">
<summary>
Adds an error reporter for the task to be executed when an exception is thrown from the task.
This action is invoked before the error handler, but gives no opportunity to recover from the error.
</summary>
<param name="builder">The builder.</param>
<param name="errorReporter">The finally handler.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.ReportError(Cake.Core.CakeTaskBuilder,System.Func{System.Exception,System.Threading.Tasks.Task})">
<summary>
Adds an error reporter for the task to be executed when an exception is thrown from the task.
This action is invoked before the error handler, but gives no opportunity to recover from the error.
</summary>
<param name="builder">The builder.</param>
<param name="errorReporter">The finally handler.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.Does(Cake.Core.CakeTaskBuilder,System.Action)">
<summary>
Adds an action to be executed when the task is invoked.
</summary>
<param name="builder">The task builder.</param>
<param name="action">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.Does``1(Cake.Core.CakeTaskBuilder,System.Action{``0})">
<summary>
Adds an action to be executed when the task is invoked.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<param name="builder">The task builder.</param>
<param name="action">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.Does(Cake.Core.CakeTaskBuilder,System.Func{System.Threading.Tasks.Task})">
<summary>
Adds an action to be executed when the task is invoked.
</summary>
<param name="builder">The task builder.</param>
<param name="func">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.Does(Cake.Core.CakeTaskBuilder,System.Action{Cake.Core.ICakeContext})">
<summary>
Adds an action to be executed when the task is invoked.
</summary>
<param name="builder">The task builder.</param>
<param name="action">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.Does(Cake.Core.CakeTaskBuilder,System.Func{Cake.Core.ICakeContext,System.Threading.Tasks.Task})">
<summary>
Adds an action to be executed when the task is invoked.
</summary>
<param name="builder">The task builder.</param>
<param name="func">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.Does``1(Cake.Core.CakeTaskBuilder,System.Func{``0,System.Threading.Tasks.Task})">
<summary>
Adds an action to be executed when the task is invoked.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<param name="builder">The task builder.</param>
<param name="func">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.Does``1(Cake.Core.CakeTaskBuilder,System.Action{Cake.Core.ICakeContext,``0})">
<summary>
Adds an action to be executed when the task is invoked.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<param name="builder">The task builder.</param>
<param name="action">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.Does``1(Cake.Core.CakeTaskBuilder,System.Func{Cake.Core.ICakeContext,``0,System.Threading.Tasks.Task})">
<summary>
Adds an action to be executed when the task is invoked.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<param name="builder">The task builder.</param>
<param name="func">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.DoesForEach``1(Cake.Core.CakeTaskBuilder,System.Collections.Generic.IEnumerable{``0},System.Action{``0})">
<summary>
Adds an action to be executed foreach item in the list.
</summary>
<typeparam name="TItem">The item type.</typeparam>
<param name="builder">The task builder.</param>
<param name="items">The items.</param>
<param name="action">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.DoesForEach``2(Cake.Core.CakeTaskBuilder,System.Collections.Generic.IEnumerable{``1},System.Action{``0,``1})">
<summary>
Adds an action to be executed foreach item in the list.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<typeparam name="TItem">The item type.</typeparam>
<param name="builder">The task builder.</param>
<param name="items">The items.</param>
<param name="action">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.DoesForEach``2(Cake.Core.CakeTaskBuilder,System.Collections.Generic.IEnumerable{``1},System.Action{``0,``1,Cake.Core.ICakeContext})">
<summary>
Adds an action to be executed foreach item in the list.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<typeparam name="TItem">The item type.</typeparam>
<param name="builder">The task builder.</param>
<param name="items">The items.</param>
<param name="action">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.DoesForEach``1(Cake.Core.CakeTaskBuilder,System.Collections.Generic.IEnumerable{``0},System.Action{``0,Cake.Core.ICakeContext})">
<summary>
Adds an action to be executed foreach item in the list.
</summary>
<typeparam name="TItem">The item type.</typeparam>
<param name="builder">The task builder.</param>
<param name="items">The items.</param>
<param name="action">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.DoesForEach``1(Cake.Core.CakeTaskBuilder,System.Func{System.Collections.Generic.IEnumerable{``0}},System.Action{``0})">
<summary>
Adds an action to be executed foreach item returned by the items function.
This method will be executed the first time the task is executed.
</summary>
<typeparam name="TItem">The item type.</typeparam>
<param name="builder">The task builder.</param>
<param name="itemsFunc">The items.</param>
<param name="action">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.DoesForEach``1(Cake.Core.CakeTaskBuilder,System.Func{Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{``0}},System.Action{``0})">
<summary>
Adds an action to be executed foreach item returned by the items function.
This method will be executed the first time the task is executed.
</summary>
<typeparam name="TItem">The item type.</typeparam>
<param name="builder">The task builder.</param>
<param name="itemsFunc">The items.</param>
<param name="action">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.DoesForEach``2(Cake.Core.CakeTaskBuilder,System.Func{System.Collections.Generic.IEnumerable{``1}},System.Action{``0,``1})">
<summary>
Adds an action to be executed foreach item returned by the items function.
This method will be executed the first time the task is executed.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<typeparam name="TItem">The item type.</typeparam>
<param name="builder">The task builder.</param>
<param name="itemsFunc">The items.</param>
<param name="action">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.DoesForEach``2(Cake.Core.CakeTaskBuilder,System.Func{System.Collections.Generic.IEnumerable{``1}},System.Action{``0,``1,Cake.Core.ICakeContext})">
<summary>
Adds an action to be executed foreach item returned by the items function.
This method will be executed the first time the task is executed.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<typeparam name="TItem">The item type.</typeparam>
<param name="builder">The task builder.</param>
<param name="itemsFunc">The items.</param>
<param name="action">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.DoesForEach``1(Cake.Core.CakeTaskBuilder,System.Func{System.Collections.Generic.IEnumerable{``0}},System.Action{``0,Cake.Core.ICakeContext})">
<summary>
Adds an action to be executed foreach item returned by the items function.
This method will be executed the first time the task is executed.
</summary>
<typeparam name="TItem">The item type.</typeparam>
<param name="builder">The task builder.</param>
<param name="itemsFunc">The items.</param>
<param name="action">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.DoesForEach``2(Cake.Core.CakeTaskBuilder,System.Func{Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{``1}},System.Action{``0,``1})">
<summary>
Adds an action to be executed foreach item returned by the items function.
This method will be executed the first time the task is executed.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<typeparam name="TItem">The item type.</typeparam>
<param name="builder">The task builder.</param>
<param name="itemsFunc">The items.</param>
<param name="action">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.DoesForEach``2(Cake.Core.CakeTaskBuilder,System.Func{``0,System.Collections.Generic.IEnumerable{``1}},System.Action{``0,``1,Cake.Core.ICakeContext})">
<summary>
Adds an action to be executed foreach item returned by the items function.
This method will be executed the first time the task is executed.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<typeparam name="TItem">The item type.</typeparam>
<param name="builder">The task builder.</param>
<param name="itemsFunc">The items.</param>
<param name="action">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.DoesForEach``2(Cake.Core.CakeTaskBuilder,System.Func{Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{``1}},System.Action{``0,``1,Cake.Core.ICakeContext})">
<summary>
Adds an action to be executed foreach item returned by the items function.
This method will be executed the first time the task is executed.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<typeparam name="TItem">The item type.</typeparam>
<param name="builder">The task builder.</param>
<param name="itemsFunc">The items.</param>
<param name="action">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.DoesForEach``2(Cake.Core.CakeTaskBuilder,System.Func{``0,System.Collections.Generic.IEnumerable{``1}},System.Action{``0,``1})">
<summary>
Adds an action to be executed foreach item returned by the items function.
This method will be executed the first time the task is executed.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<typeparam name="TItem">The item type.</typeparam>
<param name="builder">The task builder.</param>
<param name="itemsFunc">The items.</param>
<param name="action">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.DoesForEach``2(Cake.Core.CakeTaskBuilder,System.Func{``0,System.Collections.Generic.IEnumerable{``1}},System.Action{``1,Cake.Core.ICakeContext})">
<summary>
Adds an action to be executed foreach item returned by the items function.
This method will be executed the first time the task is executed.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<typeparam name="TItem">The item type.</typeparam>
<param name="builder">The task builder.</param>
<param name="itemsFunc">The items.</param>
<param name="action">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.DoesForEach``2(Cake.Core.CakeTaskBuilder,System.Func{``0,System.Collections.Generic.IEnumerable{``1}},System.Action{``1})">
<summary>
Adds an action to be executed foreach item returned by the items function.
This method will be executed the first time the task is executed.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<typeparam name="TItem">The item type.</typeparam>
<param name="builder">The task builder.</param>
<param name="itemsFunc">The items.</param>
<param name="action">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.DoesForEach``2(Cake.Core.CakeTaskBuilder,System.Func{``0,Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{``1}},System.Action{``0,``1,Cake.Core.ICakeContext})">
<summary>
Adds an action to be executed foreach item returned by the items function.
This method will be executed the first time the task is executed.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<typeparam name="TItem">The item type.</typeparam>
<param name="builder">The task builder.</param>
<param name="itemsFunc">The items.</param>
<param name="action">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.DoesForEach``2(Cake.Core.CakeTaskBuilder,System.Func{``0,Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{``1}},System.Action{``0,``1})">
<summary>
Adds an action to be executed foreach item returned by the items function.
This method will be executed the first time the task is executed.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<typeparam name="TItem">The item type.</typeparam>
<param name="builder">The task builder.</param>
<param name="itemsFunc">The items.</param>
<param name="action">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.DoesForEach``2(Cake.Core.CakeTaskBuilder,System.Func{``0,Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{``1}},System.Action{``1,Cake.Core.ICakeContext})">
<summary>
Adds an action to be executed foreach item returned by the items function.
This method will be executed the first time the task is executed.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<typeparam name="TItem">The item type.</typeparam>
<param name="builder">The task builder.</param>
<param name="itemsFunc">The items.</param>
<param name="action">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.DoesForEach``2(Cake.Core.CakeTaskBuilder,System.Func{``0,Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{``1}},System.Action{``1})">
<summary>
Adds an action to be executed foreach item returned by the items function.
This method will be executed the first time the task is executed.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<typeparam name="TItem">The item type.</typeparam>
<param name="builder">The task builder.</param>
<param name="itemsFunc">The items.</param>
<param name="action">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.DoesForEach``1(Cake.Core.CakeTaskBuilder,System.Func{Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{``0}},System.Action{``0,Cake.Core.ICakeContext})">
<summary>
Adds an action to be executed foreach item returned by the items function.
This method will be executed the first time the task is executed.
</summary>
<typeparam name="TItem">The item type.</typeparam>
<param name="builder">The task builder.</param>
<param name="itemsFunc">The items.</param>
<param name="action">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderExtensions.Description(Cake.Core.CakeTaskBuilder,System.String)">
<summary>
Adds a description to the task.
</summary>
<param name="builder">The task builder.</param>
<param name="description">The description.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="T:Cake.Core.CakeTaskBuilder">
<summary>
Allows configuration to be performed for a registered <see cref="T:Cake.Core.CakeTask"/>.
</summary>
</member>
<member name="P:Cake.Core.CakeTaskBuilder.Task">
<summary>
Gets a read-only representation of the task being configured.
</summary>
</member>
<member name="M:Cake.Core.CakeTaskBuilder.#ctor(Cake.Core.CakeTask)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.CakeTaskBuilder"/> class.
</summary>
<param name="task">The target task.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="task"/> is null.</exception>
</member>
<member name="T:Cake.Core.CakeTaskBuilderOfTExtensions">
<summary>
Contains extension methods for <see cref="T:Cake.Core.CakeTaskBuilder`1"/>.
</summary>
</member>
<member name="M:Cake.Core.CakeTaskBuilderOfTExtensions.WithCriteria``1(Cake.Core.CakeTaskBuilder{``0},System.Func{Cake.Core.ICakeContext,``0,System.Boolean})">
<summary>
Adds a criteria that has to be fulfilled for the task to run.
The criteria is evaluated when traversal of the graph occurs.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<param name="builder">The task builder.</param>
<param name="criteria">The criteria.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder`1"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderOfTExtensions.WithCriteria``1(Cake.Core.CakeTaskBuilder{``0},System.Func{Cake.Core.ICakeContext,``0,System.Boolean},System.String)">
<summary>
Adds a criteria that has to be fulfilled for the task to run.
The criteria is evaluated when traversal of the graph occurs.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<param name="builder">The task builder.</param>
<param name="criteria">The criteria.</param>
<param name="message">The message to display if the task was skipped due to the provided criteria.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder`1"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderOfTExtensions.IsDependeeOf``1(Cake.Core.CakeTaskBuilder{``0},System.String)">
<summary>
Makes the task a dependee of another task.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<param name="builder">The task builder.</param>
<param name="name">The name of the task the current task will be a dependency of.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder`1"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderOfTExtensions.IsDependeeOf``1(Cake.Core.CakeTaskBuilder{``0},Cake.Core.CakeTaskBuilder{``0})">
<summary>
Makes the task a dependee of another task.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<param name="builder">The task builder.</param>
<param name="other">The dependent task.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder`1"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderOfTExtensions.IsDependentOn``1(Cake.Core.CakeTaskBuilder{``0},System.String)">
<summary>
Creates a dependency between two tasks.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<param name="builder">The task builder.</param>
<param name="name">The name of the dependent task.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder`1"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderOfTExtensions.IsDependentOn``1(Cake.Core.CakeTaskBuilder{``0},Cake.Core.CakeTaskBuilder{``0})">
<summary>
Creates a dependency between two tasks.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<param name="builder">The task builder.</param>
<param name="other">The dependent task.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder`1"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderOfTExtensions.IsDependentOn``1(Cake.Core.CakeTaskBuilder{``0},Cake.Core.CakeTaskBuilder)">
<summary>
Creates a dependency between two tasks.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<param name="builder">The task builder.</param>
<param name="other">The dependent task.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder`1"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderOfTExtensions.ContinueOnError``1(Cake.Core.CakeTaskBuilder{``0})">
<summary>
Adds an indication to the task that a thrown exception will not halt the script execution.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<param name="builder">The task builder.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder`1"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderOfTExtensions.DeferOnError``1(Cake.Core.CakeTaskBuilder{``0})">
<summary>
Defers all exceptions until after all actions for this task have completed.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<param name="builder">The task builder.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder`1"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderOfTExtensions.OnError``1(Cake.Core.CakeTaskBuilder{``0},System.Action{System.Exception,Cake.Core.ICakeContext,``0})">
<summary>
Adds an error handler to be executed if an exception occurs in the task.
</summary>
<typeparam name="TData">The extra data to operate with inside the error handler.</typeparam>
<param name="builder">The builder.</param>
<param name="errorHandler">The error handler.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder`1"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderOfTExtensions.ReportError``1(Cake.Core.CakeTaskBuilder{``0},System.Action{System.Exception})">
<summary>
Adds an error reporter for the task to be executed when an exception is thrown from the task.
This action is invoked before the error handler, but gives no opportunity to recover from the error.
</summary>
<typeparam name="TData">The extra data to operate with inside the error handler.</typeparam>
<param name="builder">The builder.</param>
<param name="errorReporter">The error report handler.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder`1"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderOfTExtensions.OnError``1(Cake.Core.CakeTaskBuilder{``0},System.Func{System.Exception,Cake.Core.ICakeContext,``0,System.Threading.Tasks.Task})">
<summary>
Adds an error handler to be executed if an exception occurs in the task.
</summary>
<typeparam name="TData">The extra data to operate with inside the error handler.</typeparam>
<param name="builder">The builder.</param>
<param name="errorHandler">The error handler.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder`1"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderOfTExtensions.Finally``1(Cake.Core.CakeTaskBuilder{``0},System.Func{Cake.Core.ICakeContext,``0,System.Threading.Tasks.Task})">
<summary>
Adds a finally handler to be executed after the task have finished executing.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<param name="builder">The builder.</param>
<param name="finallyHandler">The finally handler.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder`1"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderOfTExtensions.Finally``1(Cake.Core.CakeTaskBuilder{``0},System.Action{Cake.Core.ICakeContext,``0})">
<summary>
Adds a finally handler to be executed after the task have finished executing.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<param name="builder">The builder.</param>
<param name="finallyHandler">The finally handler.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder`1"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderOfTExtensions.Does``1(Cake.Core.CakeTaskBuilder{``0},System.Action{Cake.Core.ICakeContext,``0})">
<summary>
Adds an action to be executed when the task is invoked.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<param name="builder">The task builder.</param>
<param name="action">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder`1"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderOfTExtensions.Does``1(Cake.Core.CakeTaskBuilder{``0},System.Func{Cake.Core.ICakeContext,``0,System.Threading.Tasks.Task})">
<summary>
Adds an action to be executed when the task is invoked.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<param name="builder">The task builder.</param>
<param name="action">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder`1"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderOfTExtensions.DoesForEach``2(Cake.Core.CakeTaskBuilder{``0},System.Func{``0,Cake.Core.ICakeContext,System.Collections.Generic.IEnumerable{``1}},System.Action{``0,``1,Cake.Core.ICakeContext})">
<summary>
Adds an action to be executed foreach item returned by the items function.
This method will be executed the first time the task is executed.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<typeparam name="TItem">The item type.</typeparam>
<param name="builder">The task builder.</param>
<param name="itemsFunc">The items.</param>
<param name="action">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder`1"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderOfTExtensions.DoesForEach``2(Cake.Core.CakeTaskBuilder{``0},System.Collections.Generic.IEnumerable{``1},System.Action{``0,``1,Cake.Core.ICakeContext})">
<summary>
Adds an action to be executed foreach item returned by the items function.
This method will be executed the first time the task is executed.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<typeparam name="TItem">The item type.</typeparam>
<param name="builder">The task builder.</param>
<param name="items">The items.</param>
<param name="action">The action.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder`1"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.CakeTaskBuilderOfTExtensions.Of``1(Cake.Core.CakeTaskBuilder)">
<summary>
Gives a <see cref="T:Cake.Core.CakeTaskBuilder`1"/> bound to specific data context type.
</summary>
<param name="builder">The task builder.</param>
<returns>A <see cref="T:Cake.Core.CakeTaskBuilder`1"/>.</returns>
<typeparam name="TData">The type of the data context.</typeparam>
</member>
<member name="M:Cake.Core.CakeTaskBuilderOfTExtensions.Description``1(Cake.Core.CakeTaskBuilder{``0},System.String)">
<summary>
Adds a description to the task.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
<param name="builder">The task builder.</param>
<param name="description">The description.</param>
<returns>The same <see cref="T:Cake.Core.CakeTaskBuilder`1"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="T:Cake.Core.CakeTaskBuilder`1">
<summary>
Allows configuration to be performed for a registered <see cref="T:Cake.Core.CakeTask"/>.
</summary>
<typeparam name="TData">The type of the data context.</typeparam>
</member>
<member name="P:Cake.Core.CakeTaskBuilder`1.Task">
<summary>
Gets a read-only representation of the task being configured.
</summary>
</member>
<member name="P:Cake.Core.CakeTaskBuilder`1.Builder">
<summary>
Gets the cake task builder.
</summary>
</member>
<member name="M:Cake.Core.CakeTaskBuilder`1.#ctor(Cake.Core.CakeTaskBuilder)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.CakeTaskBuilder`1"/> class.
</summary>
<param name="builder">The task builder.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="builder"/> is null.</exception>
</member>
<member name="M:Cake.Core.CakeTaskBuilder`1.#ctor(Cake.Core.CakeTask)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.CakeTaskBuilder`1"/> class.
</summary>
<param name="task">The task.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="task"/> is null.</exception>
</member>
<member name="T:Cake.Core.CakeTaskCriteria">
<summary>
Represents Cake task criteria.
</summary>
</member>
<member name="P:Cake.Core.CakeTaskCriteria.CausedSkippingOfTask">
<summary>
Gets or sets a value indicating whether this criteria caused the task to be skipped.
</summary>
</member>
<member name="P:Cake.Core.CakeTaskCriteria.Predicate">
<summary>
Gets the criteria predicate.
</summary>
<value>The criteria predicate.</value>
</member>
<member name="P:Cake.Core.CakeTaskCriteria.Message">
<summary>
Gets the criteria message.
</summary>
<value>The criteria message.</value>
</member>
<member name="M:Cake.Core.CakeTaskCriteria.#ctor(System.Func{Cake.Core.ICakeContext,System.Boolean},System.String)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.CakeTaskCriteria"/> class.
</summary>
<param name="predicate">The criteria predicate.</param>
<param name="message">The criteria message if skipped.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="predicate"/> is null.</exception>
</member>
<member name="T:Cake.Core.CakeTaskDependency">
<summary>
Represents a task dependency.
</summary>
</member>
<member name="P:Cake.Core.CakeTaskDependency.Name">
<summary>
Gets the name of the dependency.
</summary>
</member>
<member name="P:Cake.Core.CakeTaskDependency.Required">
<summary>
Gets a value indicating whether or not the dependency is required.
</summary>
</member>
<member name="M:Cake.Core.CakeTaskDependency.#ctor(System.String,System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.CakeTaskDependency"/> class.
</summary>
<param name="name">The name of the task.</param>
<param name="required">Whether or not the dependency is required.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="name"/> is null.</exception>
</member>
<member name="T:Cake.Core.CakeTaskExecutionStatus">
<summary>
The execution status of a <see cref="T:Cake.Core.CakeTask"/>.
</summary>
</member>
<member name="F:Cake.Core.CakeTaskExecutionStatus.Executed">
<summary>
The task was executed.
</summary>
</member>
<member name="F:Cake.Core.CakeTaskExecutionStatus.Delegated">
<summary>
The task delegated execution.
</summary>
</member>
<member name="F:Cake.Core.CakeTaskExecutionStatus.Skipped">
<summary>
The task was skipped.
</summary>
</member>
<member name="F:Cake.Core.CakeTaskExecutionStatus.Failed">
<summary>
The task failed.
</summary>
</member>
<member name="T:Cake.Core.CakeTaskExtensions">
<summary>
Contains extension methods for <see cref="T:Cake.Core.CakeTask"/>.
</summary>
</member>
<member name="M:Cake.Core.CakeTaskExtensions.AddDependency(Cake.Core.CakeTask,System.String,System.Boolean)">
<summary>
Adds the dependency to the task's dependencies.
</summary>
<param name="task">The task.</param>
<param name="name">The name of the dependency .</param>
<param name="required">Whether or not the dependency is required.</param>
<exception cref="T:Cake.Core.CakeException">The task already has the dependency.</exception>
</member>
<member name="M:Cake.Core.CakeTaskExtensions.AddDependee(Cake.Core.CakeTask,System.String,System.Boolean)">
<summary>
Adds the dependee to the task's dependees.
</summary>
<param name="task">The task.</param>
<param name="name">The name of the dependee.</param>
<param name="required">Whether or not the dependee is required.</param>
<exception cref="T:Cake.Core.CakeException">The task already is a dependee.</exception>
</member>
<member name="M:Cake.Core.CakeTaskExtensions.AddCriteria(Cake.Core.CakeTask,System.Func{Cake.Core.ICakeContext,System.Boolean},System.String)">
<summary>
Adds to the task's criteria.
</summary>
<param name="task">The task.</param>
<param name="predicate">The criteria predicate.</param>
<param name="message">The criteria message if skipped.</param>
</member>
<member name="M:Cake.Core.CakeTaskExtensions.SetErrorHandler(Cake.Core.CakeTask,System.Action{System.Exception,Cake.Core.ICakeContext})">
<summary>
Sets the task's error handler.
</summary>
<param name="task">The task.</param>
<param name="errorHandler">The error handler.</param>
<exception cref="T:Cake.Core.CakeException">There can only be one error handler per task.</exception>
<exception cref="T:System.ArgumentNullException"><paramref name="errorHandler"/> is null.</exception>
</member>
<member name="M:Cake.Core.CakeTaskExtensions.SetErrorHandler(Cake.Core.CakeTask,System.Func{System.Exception,Cake.Core.ICakeContext,System.Threading.Tasks.Task})">
<summary>
Sets the task's error handler.
</summary>
<param name="task">The task.</param>
<param name="errorHandler">The error handler.</param>
<exception cref="T:Cake.Core.CakeException">There can only be one error handler per task.</exception>
<exception cref="T:System.ArgumentNullException"><paramref name="errorHandler"/> is null.</exception>
</member>
<member name="M:Cake.Core.CakeTaskExtensions.SetErrorReporter(Cake.Core.CakeTask,System.Action{System.Exception})">
<summary>
Sets the task's error reporter.
</summary>
<param name="task">The task.</param>
<param name="errorReporter">The error reporter.</param>
<exception cref="T:Cake.Core.CakeException">There can only be one error reporter per task.</exception>
<exception cref="T:System.ArgumentNullException"><paramref name="errorReporter"/> is null.</exception>
</member>
<member name="M:Cake.Core.CakeTaskExtensions.SetErrorReporter(Cake.Core.CakeTask,System.Func{System.Exception,System.Threading.Tasks.Task})">
<summary>
Sets the task's error reporter.
</summary>
<param name="task">The task.</param>
<param name="errorReporter">The error reporter.</param>
<exception cref="T:Cake.Core.CakeException">There can only be one error reporter per task.</exception>
<exception cref="T:System.ArgumentNullException"><paramref name="errorReporter"/> is null.</exception>
</member>
<member name="M:Cake.Core.CakeTaskExtensions.SetFinallyHandler(Cake.Core.CakeTask,System.Action)">
<summary>
Sets the task's finally handler.
</summary>
<param name="task">The task.</param>
<param name="finallyHandler">The finally handler.</param>
<exception cref="T:Cake.Core.CakeException">There can only be one finally handler per task.</exception>
<exception cref="T:System.ArgumentNullException"><paramref name="finallyHandler"/> is null.</exception>
</member>
<member name="M:Cake.Core.CakeTaskExtensions.SetFinallyHandler(Cake.Core.CakeTask,System.Func{System.Threading.Tasks.Task})">
<summary>
Sets the task's finally handler.
</summary>
<param name="task">The task.</param>
<param name="finallyHandler">The finally handler.</param>
<exception cref="T:Cake.Core.CakeException">There can only be one finally handler per task.</exception>
<exception cref="T:System.ArgumentNullException"><paramref name="finallyHandler"/> is null.</exception>
</member>
<member name="M:Cake.Core.CakeTaskExtensions.SetFinallyHandler(Cake.Core.CakeTask,System.Action{Cake.Core.ICakeContext})">
<summary>
Sets the task's finally handler.
</summary>
<param name="task">The task.</param>
<param name="finallyHandler">The finally handler.</param>
<exception cref="T:Cake.Core.CakeException">There can only be one finally handler per task.</exception>
<exception cref="T:System.ArgumentNullException"><paramref name="finallyHandler"/> is null.</exception>
</member>
<member name="M:Cake.Core.CakeTaskExtensions.SetFinallyHandler(Cake.Core.CakeTask,System.Func{Cake.Core.ICakeContext,System.Threading.Tasks.Task})">
<summary>
Sets the task's finally handler.
</summary>
<param name="task">The task.</param>
<param name="finallyHandler">The finally handler.</param>
<exception cref="T:Cake.Core.CakeException">There can only be one finally handler per task.</exception>
<exception cref="T:System.ArgumentNullException"><paramref name="finallyHandler"/> is null.</exception>
</member>
<member name="M:Cake.Core.CakeTaskExtensions.AddAction(Cake.Core.CakeTask,System.Func{Cake.Core.ICakeContext,System.Threading.Tasks.Task})">
<summary>
Adds the action to the task's actions.
</summary>
<param name="task">The task.</param>
<param name="action">The action.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="action"/> is null.</exception>
</member>
<member name="M:Cake.Core.CakeTaskExtensions.AddDelayedAction(Cake.Core.CakeTask,System.Action{Cake.Core.ICakeContext})">
<summary>
Adds the action to the task's delayed actions.
</summary>
<param name="task">The task.</param>
<param name="action">The action.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="action"/> is null.</exception>
</member>
<member name="M:Cake.Core.CakeTaskExtensions.SetDeferExceptions(Cake.Core.CakeTask,System.Boolean)">
<summary>
Sets the task's defer exceptions state.
</summary>
<param name="task">The task.</param>
<param name="value">The defer exceptions state.</param>
</member>
<member name="T:Cake.Core.Composition.ICakeContainerRegistrar">
<summary>
Represents a container registry used to register types and instances with Cake.
</summary>
</member>
<member name="M:Cake.Core.Composition.ICakeContainerRegistrar.RegisterType(System.Type)">
<summary>
Registers a type with the container registry.
</summary>
<param name="type">The implementation type to register.</param>
<returns>A registration builder used to configure the registration.</returns>
</member>
<member name="M:Cake.Core.Composition.ICakeContainerRegistrar.RegisterInstance``1(``0)">
<summary>
Registers an instance with the container registry.
</summary>
<typeparam name="TImplementation">The instance's implementation type to register.</typeparam>
<param name="instance">The instance to register.</param>
<returns>A registration builder used to configure the registration.</returns>
</member>
<member name="T:Cake.Core.Composition.ICakeModule">
<summary>
Represents a module responsible for
registering types and instances.
</summary>
</member>
<member name="M:Cake.Core.Composition.ICakeModule.Register(Cake.Core.Composition.ICakeContainerRegistrar)">
<summary>
Performs custom registrations in the provided registrar.
</summary>
<param name="registrar">The container registrar.</param>
</member>
<member name="T:Cake.Core.Composition.ICakeRegistrationBuilder">
<summary>
Represents a registration builder for a container.
</summary>
</member>
<member name="M:Cake.Core.Composition.ICakeRegistrationBuilder.As(System.Type)">
<summary>
Adds a registration type to the configuration.
</summary>
<param name="type">The registration type.</param>
<returns>The same <see cref="T:Cake.Core.Composition.ICakeRegistrationBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.Composition.ICakeRegistrationBuilder.AsSelf">
<summary>
Adds a registration type that matches the implementation type.
</summary>
<returns>The same <see cref="T:Cake.Core.Composition.ICakeRegistrationBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.Composition.ICakeRegistrationBuilder.Singleton">
<summary>
Configure the component so that every dependent component
gets the same, shared instance. This is the default lifetime scope.
</summary>
<returns>The same <see cref="T:Cake.Core.Composition.ICakeRegistrationBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.Composition.ICakeRegistrationBuilder.Transient">
<summary>
Configure the component so that every dependent component
gets a new, unique instance.
</summary>
<returns>The same <see cref="T:Cake.Core.Composition.ICakeRegistrationBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="T:Cake.Core.Composition.ContainerRegistrarExtensions">
<summary>
Contains extension methods for <see cref="T:Cake.Core.Composition.ICakeContainerRegistrar"/>.
</summary>
</member>
<member name="M:Cake.Core.Composition.ContainerRegistrarExtensions.RegisterType``1(Cake.Core.Composition.ICakeContainerRegistrar)">
<summary>
Registers a type with the container registrar.
</summary>
<typeparam name="TImplementation">The implementation type to register.</typeparam>
<param name="registrar">The container registrar.</param>
<returns>A registration builder used to configure the registration.</returns>
</member>
<member name="M:Cake.Core.Composition.ContainerRegistrarExtensions.As``1(Cake.Core.Composition.ICakeRegistrationBuilder)">
<summary>
Adds a registration type to an existing registration builder.
</summary>
<typeparam name="TRegistration">The registration type.</typeparam>
<param name="builder">The registration builder.</param>
<returns>The same <see cref="T:Cake.Core.Composition.ICakeRegistrationBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="T:Cake.Core.Configuration.CakeConfiguration">
<summary>
The default implementation of the Cake configuration.
</summary>
</member>
<member name="M:Cake.Core.Configuration.CakeConfiguration.#ctor(System.Collections.Generic.IDictionary{System.String,System.String})">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Configuration.CakeConfiguration"/> class.
</summary>
<param name="lookup">The initial configuration table.</param>
</member>
<member name="M:Cake.Core.Configuration.CakeConfiguration.GetValue(System.String)">
<inheritdoc/>
</member>
<member name="T:Cake.Core.Configuration.CakeConfigurationProvider">
<summary>
Implementation of the Cake configuration provider.
</summary>
</member>
<member name="M:Cake.Core.Configuration.CakeConfigurationProvider.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Configuration.CakeConfigurationProvider"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
</member>
<member name="M:Cake.Core.Configuration.CakeConfigurationProvider.CreateConfiguration(Cake.Core.IO.DirectoryPath,System.Collections.Generic.IDictionary{System.String,System.String})">
<summary>
Creates a configuration from the provided arguments.
</summary>
<param name="path">The directory to look for the configuration file.</param>
<param name="arguments">The arguments.</param>
<returns>The created configuration.</returns>
</member>
<member name="M:Cake.Core.Configuration.CakeConfigurationProvider.CreateConfiguration(Cake.Core.IO.DirectoryPath,System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.String}},System.Collections.Generic.IDictionary{System.String,System.String})">
<summary>
Creates a configuration from the provided arguments.
</summary>
<param name="path">The directory to look for the configuration file.</param>
<param name="baseConfiguration">The initial base configuration.</param>
<param name="arguments">The arguments.</param>
<returns>The created configuration.</returns>
</member>
<member name="T:Cake.Core.Configuration.ICakeConfiguration">
<summary>
Represents the Cake configuration.
</summary>
</member>
<member name="M:Cake.Core.Configuration.ICakeConfiguration.GetValue(System.String)">
<summary>
Gets the value that corresponds to the specified key.
</summary>
<param name="key">The key.</param>
<returns>The value for the specified key, or <c>null</c> if key doesn't exists.</returns>
</member>
<member name="T:Cake.Core.DefaultExecutionStrategy">
<summary>
The default execution strategy.
</summary>
</member>
<member name="M:Cake.Core.DefaultExecutionStrategy.#ctor(Cake.Core.Diagnostics.ICakeLog,Cake.Core.ICakeReportPrinter)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.DefaultExecutionStrategy"/> class.
</summary>
<param name="log">The log.</param>
<param name="reportPrinter">The report printer.</param>
</member>
<member name="M:Cake.Core.DefaultExecutionStrategy.PerformSetup(System.Action{Cake.Core.ISetupContext},Cake.Core.ISetupContext)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.DefaultExecutionStrategy.PerformTeardown(System.Action{Cake.Core.ITeardownContext},Cake.Core.ITeardownContext)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.DefaultExecutionStrategy.ExecuteAsync(Cake.Core.CakeTask,Cake.Core.ICakeContext)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.DefaultExecutionStrategy.Skip(Cake.Core.CakeTask,Cake.Core.CakeTaskCriteria)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.DefaultExecutionStrategy.ReportErrorsAsync(System.Func{System.Exception,System.Threading.Tasks.Task},System.Exception)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.DefaultExecutionStrategy.HandleErrorsAsync(System.Func{System.Exception,Cake.Core.ICakeContext,System.Threading.Tasks.Task},System.Exception,Cake.Core.ICakeContext)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.DefaultExecutionStrategy.InvokeFinallyAsync(System.Func{Cake.Core.ICakeContext,System.Threading.Tasks.Task},Cake.Core.ICakeContext)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.DefaultExecutionStrategy.PerformTaskSetup(System.Action{Cake.Core.ITaskSetupContext},Cake.Core.ITaskSetupContext)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.DefaultExecutionStrategy.PerformTaskTeardown(System.Action{Cake.Core.ITaskTeardownContext},Cake.Core.ITaskTeardownContext)">
<inheritdoc/>
</member>
<member name="T:Cake.Core.Diagnostics.CakeBuildLog">
<summary>
A log that writes to the console.
</summary>
</member>
<member name="P:Cake.Core.Diagnostics.CakeBuildLog.Verbosity">
<inheritdoc/>
</member>
<member name="M:Cake.Core.Diagnostics.CakeBuildLog.#ctor(Cake.Core.IConsole,Cake.Core.Diagnostics.Verbosity)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Diagnostics.CakeBuildLog" /> class.
</summary>
<param name="console">The console.</param>
<param name="verbosity">The verbosity.</param>
</member>
<member name="M:Cake.Core.Diagnostics.CakeBuildLog.Write(Cake.Core.Diagnostics.Verbosity,Cake.Core.Diagnostics.LogLevel,System.String,System.Object[])">
<inheritdoc/>
</member>
<member name="T:Cake.Core.Diagnostics.CakeDebugger">
<summary>
The Cake debugger.
</summary>
</member>
<member name="M:Cake.Core.Diagnostics.CakeDebugger.#ctor(Cake.Core.Diagnostics.ICakeLog)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Diagnostics.CakeDebugger"/> class.
</summary>
<param name="log">The log.</param>
</member>
<member name="M:Cake.Core.Diagnostics.CakeDebugger.WaitForAttach(System.TimeSpan)">
<summary>
Waits for a debugger to attach.
</summary>
<param name="timeout">The timeout.</param>
</member>
<member name="T:Cake.Core.Diagnostics.ICakeDebugger">
<summary>
Represents a mechanism to interact with the debugger.
</summary>
</member>
<member name="M:Cake.Core.Diagnostics.ICakeDebugger.WaitForAttach(System.TimeSpan)">
<summary>
Waits for a debugger to attach to the process.
</summary>
<param name="timeout">The timeout.</param>
</member>
<member name="T:Cake.Core.Diagnostics.ICakeLog">
<summary>
Represents a log.
</summary>
</member>
<member name="P:Cake.Core.Diagnostics.ICakeLog.Verbosity">
<summary>
Gets or sets the verbosity.
</summary>
<value>The verbosity.</value>
</member>
<member name="M:Cake.Core.Diagnostics.ICakeLog.Write(Cake.Core.Diagnostics.Verbosity,Cake.Core.Diagnostics.LogLevel,System.String,System.Object[])">
<summary>
Writes the text representation of the specified array of objects to the
log using the specified verbosity, log level and format information.
</summary>
<param name="verbosity">The verbosity.</param>
<param name="level">The log level.</param>
<param name="format">A composite format string.</param>
<param name="args">An array of objects to write using format.</param>
</member>
<member name="T:Cake.Core.Diagnostics.LogAction">
<summary>
Delegate representing lazy log action.
</summary>
<param name="actionEntry">Proxy to log.</param>
</member>
<member name="T:Cake.Core.Diagnostics.LogActionEntry">
<summary>
Delegate representing lazy log entry.
</summary>
<param name="format">A composite format string.</param>
<param name="args">An array of objects to write using format.</param>
</member>
<member name="T:Cake.Core.Diagnostics.LogExtensions">
<summary>
Contains extension methods for <see cref="T:Cake.Core.Diagnostics.ICakeLog"/>.
</summary>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Error(Cake.Core.Diagnostics.ICakeLog,System.String,System.Object[])">
<summary>
Writes an error message to the log using the specified format information.
</summary>
<param name="log">The log.</param>
<param name="format">A composite format string.</param>
<param name="args">An array of objects to write using format.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Error(Cake.Core.Diagnostics.ICakeLog,Cake.Core.Diagnostics.Verbosity,System.String,System.Object[])">
<summary>
Writes an error message to the log using the specified verbosity and format information.
</summary>
<param name="log">The log.</param>
<param name="verbosity">The verbosity.</param>
<param name="format">A composite format string.</param>
<param name="args">An array of objects to write using format.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Error(Cake.Core.Diagnostics.ICakeLog,Cake.Core.Diagnostics.Verbosity,Cake.Core.Diagnostics.LogAction)">
<summary>
Writes an error message to the log using the specified verbosity and log message action.
Evaluates log message only if the verbosity is equal to or more verbose than the log's verbosity.
</summary>
<param name="log">The log.</param>
<param name="verbosity">The verbosity.</param>
<param name="logAction">The log action.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Error(Cake.Core.Diagnostics.ICakeLog,Cake.Core.Diagnostics.LogAction)">
<summary>
Writes an error message to the log using the specified log message action.
Evaluates log message only if the verbosity is equal to or more verbose than the log's verbosity.
</summary>
<param name="log">The log.</param>
<param name="logAction">The log action.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Error(Cake.Core.Diagnostics.ICakeLog,System.Object)">
<summary>
Writes an error message to the log using the specified value.
</summary>
<param name="log">The log.</param>
<param name="value">The value.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Error(Cake.Core.Diagnostics.ICakeLog,System.String)">
<summary>
Writes an error message to the log using the specified string value.
</summary>
<param name="log">The log.</param>
<param name="value">The value.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Warning(Cake.Core.Diagnostics.ICakeLog,System.String,System.Object[])">
<summary>
Writes a warning message to the log using the specified format information.
</summary>
<param name="log">The log.</param>
<param name="format">A composite format string.</param>
<param name="args">An array of objects to write using format.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Warning(Cake.Core.Diagnostics.ICakeLog,Cake.Core.Diagnostics.Verbosity,System.String,System.Object[])">
<summary>
Writes a warning message to the log using the specified verbosity and format information.
</summary>
<param name="log">The log.</param>
<param name="verbosity">The verbosity.</param>
<param name="format">A composite format string.</param>
<param name="args">An array of objects to write using format.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Warning(Cake.Core.Diagnostics.ICakeLog,Cake.Core.Diagnostics.LogAction)">
<summary>
Writes a warning message to the log using the specified log message action.
Evaluates log message only if the verbosity is equal to or more verbose than the log's verbosity.
</summary>
<param name="log">The log.</param>
<param name="logAction">The log action.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Warning(Cake.Core.Diagnostics.ICakeLog,Cake.Core.Diagnostics.Verbosity,Cake.Core.Diagnostics.LogAction)">
<summary>
Writes a warning message to the log using the specified verbosity and log message action.
Evaluates log message only if the verbosity is equal to or more verbose than the log's verbosity.
</summary>
<param name="log">The log.</param>
<param name="verbosity">The verbosity.</param>
<param name="logAction">The log action.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Warning(Cake.Core.Diagnostics.ICakeLog,System.Object)">
<summary>
Writes an warning message to the log using the specified value.
</summary>
<param name="log">The log.</param>
<param name="value">The value.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Warning(Cake.Core.Diagnostics.ICakeLog,System.String)">
<summary>
Writes an warning message to the log using the specified string value.
</summary>
<param name="log">The log.</param>
<param name="value">The value.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Information(Cake.Core.Diagnostics.ICakeLog,System.String,System.Object[])">
<summary>
Writes an informational message to the log using the specified format information.
</summary>
<param name="log">The log.</param>
<param name="format">A composite format string.</param>
<param name="args">An array of objects to write using format.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Information(Cake.Core.Diagnostics.ICakeLog,Cake.Core.Diagnostics.Verbosity,System.String,System.Object[])">
<summary>
Writes an informational message to the log using the specified verbosity and format information.
</summary>
<param name="log">The log.</param>
<param name="verbosity">The verbosity.</param>
<param name="format">A composite format string.</param>
<param name="args">An array of objects to write using format.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Information(Cake.Core.Diagnostics.ICakeLog,Cake.Core.Diagnostics.Verbosity,Cake.Core.Diagnostics.LogAction)">
<summary>
Writes an informational message to the log using the specified verbosity and log message action.
Evaluates log message only if the verbosity is equal to or more verbose than the log's verbosity.
</summary>
<param name="log">The log.</param>
<param name="verbosity">The verbosity.</param>
<param name="logAction">The log action.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Information(Cake.Core.Diagnostics.ICakeLog,Cake.Core.Diagnostics.LogAction)">
<summary>
Writes an informational message to the log using the specified log message action.
Evaluates log message only if the verbosity is equal to or more verbose than the log's verbosity.
</summary>
<param name="log">The log.</param>
<param name="logAction">The log action.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Information(Cake.Core.Diagnostics.ICakeLog,System.Object)">
<summary>
Writes an informational message to the log using the specified value.
</summary>
<param name="log">The log.</param>
<param name="value">The value.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Information(Cake.Core.Diagnostics.ICakeLog,System.String)">
<summary>
Writes an informational message to the log using the specified string value.
</summary>
<param name="log">The log.</param>
<param name="value">The value.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Verbose(Cake.Core.Diagnostics.ICakeLog,System.String,System.Object[])">
<summary>
Writes a verbose message to the log using the specified format information.
</summary>
<param name="log">The log.</param>
<param name="format">A composite format string.</param>
<param name="args">An array of objects to write using format.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Verbose(Cake.Core.Diagnostics.ICakeLog,Cake.Core.Diagnostics.Verbosity,System.String,System.Object[])">
<summary>
Writes a verbose message to the log using the specified verbosity and format information.
</summary>
<param name="log">The log.</param>
<param name="verbosity">The verbosity.</param>
<param name="format">A composite format string.</param>
<param name="args">An array of objects to write using format.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Verbose(Cake.Core.Diagnostics.ICakeLog,Cake.Core.Diagnostics.LogAction)">
<summary>
Writes a verbose message to the log using the specified log message action.
Evaluates log message only if the verbosity is equal to or more verbose than the log's verbosity.
</summary>
<param name="log">The log.</param>
<param name="logAction">The log action.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Verbose(Cake.Core.Diagnostics.ICakeLog,Cake.Core.Diagnostics.Verbosity,Cake.Core.Diagnostics.LogAction)">
<summary>
Writes a verbose message to the log using the specified verbosity and log message action.
Evaluates log message only if the verbosity is equal to or more verbose than the log's verbosity.
</summary>
<param name="log">The log.</param>
<param name="verbosity">The verbosity.</param>
<param name="logAction">The log action.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Verbose(Cake.Core.Diagnostics.ICakeLog,System.Object)">
<summary>
Writes a verbose message to the log using the specified value.
</summary>
<param name="log">The log.</param>
<param name="value">The value.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Verbose(Cake.Core.Diagnostics.ICakeLog,System.String)">
<summary>
Writes a verbose message to the log using the specified string value.
</summary>
<param name="log">The log.</param>
<param name="value">The value.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Debug(Cake.Core.Diagnostics.ICakeLog,System.String,System.Object[])">
<summary>
Writes a debug message to the log using the specified format information.
</summary>
<param name="log">The log.</param>
<param name="format">A composite format string.</param>
<param name="args">An array of objects to write using format.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Debug(Cake.Core.Diagnostics.ICakeLog,Cake.Core.Diagnostics.Verbosity,System.String,System.Object[])">
<summary>
Writes a debug message to the log using the specified verbosity and format information.
</summary>
<param name="log">The log.</param>
<param name="verbosity">The verbosity.</param>
<param name="format">A composite format string.</param>
<param name="args">An array of objects to write using format.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Debug(Cake.Core.Diagnostics.ICakeLog,Cake.Core.Diagnostics.LogAction)">
<summary>
Writes a debug message to the log using the specified log message action.
Evaluates log message only if the verbosity is equal to or more verbose than the log's verbosity.
</summary>
<param name="log">The log.</param>
<param name="logAction">The log action.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Debug(Cake.Core.Diagnostics.ICakeLog,Cake.Core.Diagnostics.Verbosity,Cake.Core.Diagnostics.LogAction)">
<summary>
Writes a debug message to the log using the specified verbosity and log message action.
Evaluates log message only if the verbosity is equal to or more verbose than the log's verbosity.
</summary>
<param name="log">The log.</param>
<param name="verbosity">The verbosity.</param>
<param name="logAction">The log action.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Debug(Cake.Core.Diagnostics.ICakeLog,System.Object)">
<summary>
Writes a debug message to the log using the specified value.
</summary>
<param name="log">The log.</param>
<param name="value">The value.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Debug(Cake.Core.Diagnostics.ICakeLog,System.String)">
<summary>
Writes a debug message to the log using the specified string value.
</summary>
<param name="log">The log.</param>
<param name="value">The value.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.Write(Cake.Core.Diagnostics.ICakeLog,Cake.Core.Diagnostics.Verbosity,Cake.Core.Diagnostics.LogLevel,Cake.Core.Diagnostics.LogAction)">
<summary>
Writes a message to the log using the specified verbosity, log level and log action delegate.
Evaluates log message only if the verbosity is equal to or more verbose than the log's verbosity.
</summary>
<param name="log">The log.</param>
<param name="verbosity">The verbosity.</param>
<param name="level">The log level.</param>
<param name="logAction">The log action.</param>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.QuietVerbosity(Cake.Core.Diagnostics.ICakeLog)">
<summary>
Sets the log verbosity to quiet and returns a disposable that restores the log verbosity on dispose.
</summary>
<param name="log">The log.</param>
<returns>A disposable that restores the log verbosity.</returns>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.MinimalVerbosity(Cake.Core.Diagnostics.ICakeLog)">
<summary>
Sets the log verbosity to minimal and returns a disposable that restores the log verbosity on dispose.
</summary>
<param name="log">The log.</param>
<returns>A disposable that restores the log verbosity.</returns>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.NormalVerbosity(Cake.Core.Diagnostics.ICakeLog)">
<summary>
Sets the log verbosity to normal and returns a disposable that restores the log verbosity on dispose.
</summary>
<param name="log">The log.</param>
<returns>A disposable that restores the log verbosity.</returns>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.VerboseVerbosity(Cake.Core.Diagnostics.ICakeLog)">
<summary>
Sets the log verbosity to verbose and returns a disposable that restores the log verbosity on dispose.
</summary>
<param name="log">The log.</param>
<returns>A disposable that restores the log verbosity.</returns>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.DiagnosticVerbosity(Cake.Core.Diagnostics.ICakeLog)">
<summary>
Sets the log verbosity to diagnostic and returns a disposable that restores the log verbosity on dispose.
</summary>
<param name="log">The log.</param>
<returns>A disposable that restores the log verbosity.</returns>
</member>
<member name="M:Cake.Core.Diagnostics.LogExtensions.WithVerbosity(Cake.Core.Diagnostics.ICakeLog,Cake.Core.Diagnostics.Verbosity)">
<summary>
Sets the log verbosity as specified and returns a disposable that restores the log verbosity on dispose.
</summary>
<param name="log">The log.</param>
<param name="verbosity">The verbosity.</param>
<returns>A disposable that restores the log verbosity.</returns>
</member>
<member name="T:Cake.Core.Diagnostics.LogLevel">
<summary>
Represents a log level.
</summary>
</member>
<member name="F:Cake.Core.Diagnostics.LogLevel.Fatal">
<summary>
Severe errors that cause premature termination.
</summary>
</member>
<member name="F:Cake.Core.Diagnostics.LogLevel.Error">
<summary>
Other runtime errors or unexpected conditions.
</summary>
</member>
<member name="F:Cake.Core.Diagnostics.LogLevel.Warning">
<summary>
Use of deprecated APIs, poor use of API, 'almost' errors, other runtime
situations that are undesirable or unexpected, but not necessarily "wrong".
</summary>
</member>
<member name="F:Cake.Core.Diagnostics.LogLevel.Information">
<summary>
Interesting runtime events.
</summary>
</member>
<member name="F:Cake.Core.Diagnostics.LogLevel.Verbose">
<summary>
Detailed information on the flow through the system.
</summary>
</member>
<member name="F:Cake.Core.Diagnostics.LogLevel.Debug">
<summary>
Most detailed information.
</summary>
</member>
<member name="T:Cake.Core.Diagnostics.NullLog">
<summary>
A log that discards messages written to it.
</summary>
</member>
<member name="P:Cake.Core.Diagnostics.NullLog.Verbosity">
<inheritdoc/>
</member>
<member name="M:Cake.Core.Diagnostics.NullLog.Write(Cake.Core.Diagnostics.Verbosity,Cake.Core.Diagnostics.LogLevel,System.String,System.Object[])">
<inheritdoc/>
</member>
<member name="T:Cake.Core.Diagnostics.Verbosity">
<summary>
Represents verbosity.
</summary>
</member>
<member name="F:Cake.Core.Diagnostics.Verbosity.Quiet">
<summary>
Quiet verbosity.
</summary>
</member>
<member name="F:Cake.Core.Diagnostics.Verbosity.Minimal">
<summary>
Minimal verbosity.
</summary>
</member>
<member name="F:Cake.Core.Diagnostics.Verbosity.Normal">
<summary>
Normal verbosity.
</summary>
</member>
<member name="F:Cake.Core.Diagnostics.Verbosity.Verbose">
<summary>
Verbose verbosity.
</summary>
</member>
<member name="F:Cake.Core.Diagnostics.Verbosity.Diagnostic">
<summary>
Diagnostic verbosity.
</summary>
</member>
<member name="T:Cake.Core.Diagnostics.NamespaceDoc">
<summary>
This namespace contain types that
enable you to implement custom logging support
and interact with build logs.
</summary>
</member>
<member name="T:Cake.Core.Disposable">
<summary>
Disposable helper.
</summary>
</member>
<member name="M:Cake.Core.Disposable.Create(System.Action)">
<summary>
Creates an anonymous disposable with the specified disposer action.
</summary>
<param name="disposer">The disposer action.</param>
<returns>The anonymous disposable.</returns>
</member>
<member name="F:Cake.Core.Disposable.Empty">
<summary>
An empty disposable; does nothing.
</summary>
</member>
<member name="T:Cake.Core.ExecutionSettings">
<summary>
Contains settings related to execution of the script.
</summary>
</member>
<member name="P:Cake.Core.ExecutionSettings.Targets">
<summary>
Gets the targets to be executed.
</summary>
</member>
<member name="P:Cake.Core.ExecutionSettings.Exclusive">
<summary>
Gets a value indicating whether or not to use the target exclusively.
</summary>
</member>
<member name="M:Cake.Core.ExecutionSettings.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.ExecutionSettings"/> class.
</summary>
</member>
<member name="M:Cake.Core.ExecutionSettings.SetTarget(System.String)">
<summary>
Sets the target to be executed.
</summary>
<param name="target">The target.</param>
<returns>The same <see cref="T:Cake.Core.ExecutionSettings"/> instance so that multiple calls can be chained.</returns>
<remarks>Targets consisting of whitespace only will be ignored.</remarks>
</member>
<member name="M:Cake.Core.ExecutionSettings.SetTargets(System.Collections.Generic.IEnumerable{System.String})">
<summary>
Sets the targets to be executed.
</summary>
<param name="targets">The targets.</param>
<returns>The same <see cref="T:Cake.Core.ExecutionSettings"/> instance so that multiple calls can be chained.</returns>
<remarks>Targets consisting of whitespace only will be ignored.</remarks>
</member>
<member name="M:Cake.Core.ExecutionSettings.UseExclusiveTarget">
<summary>
Whether or not to use the target exclusively.
</summary>
<returns>The same <see cref="T:Cake.Core.ExecutionSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="T:Cake.Core.ByteArrayExtensions">
<summary>
Contains extension methods for <see cref="T:byte[]"/>.
</summary>
</member>
<member name="M:Cake.Core.ByteArrayExtensions.StartsWith(System.Byte[],System.Byte[])">
<summary>
Determines if a <see cref="T:byte[]"/> starts with a specified prefix.
</summary>
<param name="value">The value.</param>
<param name="prefix">The prefix to compare.</param>
<returns>Whether or not the <see cref="T:byte[]"/> starts with the specified prefix.</returns>
</member>
<member name="T:Cake.Core.CakeArgumentsExtensions">
<summary>
Contains extension methods for <see cref="T:Cake.Core.ICakeArguments"/>.
</summary>
</member>
<member name="M:Cake.Core.CakeArgumentsExtensions.GetArgument(Cake.Core.ICakeArguments,System.String)">
<summary>
Gets the value for an argument.
</summary>
<remarks>
If multiple arguments with the same name are
specified, the last argument value is returned.
</remarks>
<param name="arguments">The arguments.</param>
<param name="name">The argument name.</param>
<returns>The argument value.</returns>
</member>
<member name="T:Cake.Core.CakeConfigurationExtensions">
<summary>
Contains extension methods for <see cref="T:Cake.Core.Configuration.ICakeConfiguration"/>.
</summary>
</member>
<member name="M:Cake.Core.CakeConfigurationExtensions.GetToolPath(Cake.Core.Configuration.ICakeConfiguration,Cake.Core.IO.DirectoryPath,Cake.Core.ICakeEnvironment)">
<summary>
Gets the tool directory path.
</summary>
<param name="configuration">The Cake configuration.</param>
<param name="defaultRoot">The default root path.</param>
<param name="environment">The environment.</param>
<returns>The tool directory path.</returns>
</member>
<member name="M:Cake.Core.CakeConfigurationExtensions.GetModulePath(Cake.Core.Configuration.ICakeConfiguration,Cake.Core.IO.DirectoryPath,Cake.Core.ICakeEnvironment)">
<summary>
Gets the module directory path.
</summary>
<param name="configuration">The Cake configuration.</param>
<param name="defaultRoot">The default root path.</param>
<param name="environment">The environment.</param>
<returns>The module directory path.</returns>
</member>
<member name="T:Cake.Core.CakePlatformExtensions">
<summary>
Contains extension methods for <see cref="T:Cake.Core.ICakePlatform"/>.
</summary>
</member>
<member name="M:Cake.Core.CakePlatformExtensions.IsWindows(Cake.Core.ICakePlatform)">
<summary>
Determines whether the specified platform is a Windows platform.
</summary>
<param name="platform">The platform.</param>
<returns><c>true</c> if the platform is a Windows platform; otherwise <c>false</c>.</returns>
</member>
<member name="M:Cake.Core.CakePlatformExtensions.IsUnix(Cake.Core.ICakePlatform)">
<summary>
Determines whether the specified platform is a Unix platform.
</summary>
<param name="platform">The platform.</param>
<returns><c>true</c> if the platform is a Unix platform; otherwise <c>false</c>.</returns>
</member>
<member name="M:Cake.Core.CakePlatformExtensions.IsOSX(Cake.Core.ICakePlatform)">
<summary>
Determines whether the specified platform is a macOS platform.
</summary>
<param name="platform">The platform.</param>
<returns><c>true</c> if the platform is a macOS platform; otherwise <c>false</c>.</returns>
</member>
<member name="M:Cake.Core.CakePlatformExtensions.IsLinux(Cake.Core.ICakePlatform)">
<summary>
Determines whether the specified platform is a Linux platform.
</summary>
<param name="platform">The platform.</param>
<returns><c>true</c> if the platform is a Linux platform; otherwise <c>false</c>.</returns>
</member>
<member name="T:Cake.Core.ConsoleExtensions">
<summary>
Contains extension methods for <see cref="T:Cake.Core.IConsole"/>.
</summary>
</member>
<member name="M:Cake.Core.ConsoleExtensions.WriteLine(Cake.Core.IConsole)">
<summary>
Writes an empty line to the console output.
</summary>
<param name="console">The console to write to.</param>
</member>
<member name="M:Cake.Core.ConsoleExtensions.WriteErrorLine(Cake.Core.IConsole)">
<summary>
Writes an empty line to the console error output.
</summary>
<param name="console">The console to write to.</param>
</member>
<member name="T:Cake.Core.DirectoryExtensions">
<summary>
Contains extensions for <see cref="T:Cake.Core.IO.IDirectory"/>.
</summary>
</member>
<member name="M:Cake.Core.DirectoryExtensions.GetDirectories(Cake.Core.IO.IDirectory,System.String,Cake.Core.IO.SearchScope,System.Func{Cake.Core.IO.IFileSystemInfo,System.Boolean})">
<summary>
Gets directories matching the specified filter and scope, with option to exclude hidden directories.
</summary>
<param name="directory">The directory.</param>
<param name="filter">The filter.</param>
<param name="scope">The search scope.</param>
<param name="predicate">Predicate used to filter directories based on file system information.</param>
<returns>The directories matching the specified filter, scope and predicate.</returns>
</member>
<member name="M:Cake.Core.DirectoryExtensions.GetDirectories(Cake.Core.IO.IDirectory,System.String,Cake.Core.IO.SearchScope,System.Func{Cake.Core.IO.IFileSystemInfo,System.Boolean},System.Action{Cake.Core.IO.IFileSystemInfo})">
<summary>
Gets directories matching the specified filter and scope, with option to exclude hidden directories.
</summary>
<param name="directory">The directory.</param>
<param name="filter">The filter.</param>
<param name="scope">The search scope.</param>
<param name="predicate">Predicate used to filter directories based on file system information.</param>
<param name="action">Callback if directory gets filtered by <paramref name="predicate"/>.</param>
<returns>The directories matching the specified filter, scope and predicate.</returns>
</member>
<member name="M:Cake.Core.DirectoryExtensions.GetFiles(Cake.Core.IO.IDirectory,System.String,Cake.Core.IO.SearchScope,System.Func{Cake.Core.IO.IFileSystemInfo,System.Boolean})">
<summary>
Gets files matching the specified filter and scope.
</summary>
<param name="directory">The directory.</param>
<param name="filter">The filter.</param>
<param name="scope">The search scope.</param>
<param name="predicate">Predicate used to filter files based on file system information.</param>
<returns>The files matching the specified filter, scope and predicate.</returns>
</member>
<member name="M:Cake.Core.DirectoryExtensions.GetFiles(Cake.Core.IO.IDirectory,System.String,Cake.Core.IO.SearchScope,System.Func{Cake.Core.IO.IFileSystemInfo,System.Boolean},System.Action{Cake.Core.IO.IFileSystemInfo})">
<summary>
Gets files matching the specified filter and scope.
</summary>
<param name="directory">The directory.</param>
<param name="filter">The filter.</param>
<param name="scope">The search scope.</param>
<param name="predicate">Predicate used to filter files based on file system information.</param>
<param name="action">Callback if file gets filtered by <paramref name="predicate"/>.</param>
<returns>The files matching the specified filter, scope and predicate.</returns>
</member>
<member name="T:Cake.Core.EnumerableStringExtensions">
<summary>
Contains extension methods for <see cref="T:IEnumerable{String}"/>.
</summary>
</member>
<member name="M:Cake.Core.EnumerableStringExtensions.ToProcessArguments(System.Collections.Generic.IEnumerable{System.String})">
<summary>
Performs a conversion from <see cref="T:System.Collections.Generic.IEnumerable`1"/> to <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/>.
</summary>
<param name="values">The text values to convert.</param>
<returns>A <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/>.</returns>
</member>
<member name="M:Cake.Core.EnumerableStringExtensions.ToProcessArgumentsQuoted(System.Collections.Generic.IEnumerable{System.String})">
<summary>
Performs a conversion from <see cref="T:System.Collections.Generic.IEnumerable`1"/> to <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/>.
</summary>
<param name="values">The text values to convert.</param>
<returns>A <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/>.</returns>
</member>
<member name="T:Cake.Core.MethodInfoExtensions">
<summary>
Contains extension methods for <see cref="T:System.Reflection.MethodInfo"/>.
</summary>
</member>
<member name="M:Cake.Core.MethodInfoExtensions.GetSignature(System.Reflection.MethodInfo,System.Boolean,System.Boolean)">
<summary>
Gets the signature for a method.
</summary>
<param name="method">The method.</param>
<param name="includeMethodNamespace">if set to <c>true</c>, include method namespace.</param>
<param name="includeParameterNamespace">if set to <c>true</c>, include parameter namespace.</param>
<returns>The method signature.</returns>
</member>
<member name="M:Cake.Core.MethodInfoExtensions.GetFullName(System.Reflection.MethodInfo)">
<summary>
Gets the full name of a method.
</summary>
<param name="method">The method to get the full name for.</param>
<returns>The full name.</returns>
</member>
<member name="M:Cake.Core.MethodInfoExtensions.GetNamespace(System.Reflection.MethodInfo)">
<summary>
Gets the namespace of the method.
</summary>
<param name="method">The method.</param>
<returns>The namespace of the method.</returns>
</member>
<member name="T:Cake.Core.ProcessArgumentListExtensions">
<summary>
Contains extension methods for <see cref="T:Cake.Core.IO.ProcessArgumentBuilder" />.
</summary>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.Append(Cake.Core.IO.ProcessArgumentBuilder,System.String)">
<summary>
Appends the specified text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="text">The text to be appended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.Prepend(Cake.Core.IO.ProcessArgumentBuilder,System.String)">
<summary>
Prepend the specified text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="text">The text to be prepended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.Append(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.Object[])">
<summary>
Formats and appends the specified text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="format">A composite format string.</param>
<param name="args">An object array that contains zero or more objects to format.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
<exception cref="T:System.ArgumentNullException"><paramref name="format" /> or <paramref name="args" /> is null. </exception>
<exception cref="T:System.FormatException"><paramref name="format" /> is invalid.-or- The index of a format item is less than zero, or greater than or equal to the length of the <paramref name="args" /> array. </exception>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.Prepend(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.Object[])">
<summary>
Formats and prepends the specified text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="format">A composite format string.</param>
<param name="args">An object array that contains zero or more objects to format.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
<exception cref="T:System.ArgumentNullException"><paramref name="format" /> or <paramref name="args" /> is null. </exception>
<exception cref="T:System.FormatException"><paramref name="format" /> is invalid.-or- The index of a format item is less than zero, or greater than or equal to the length of the <paramref name="args" /> array. </exception>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.AppendQuoted(Cake.Core.IO.ProcessArgumentBuilder,System.String)">
<summary>
Quotes and appends the specified text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="text">The text to be quoted and appended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.PrependQuoted(Cake.Core.IO.ProcessArgumentBuilder,System.String)">
<summary>
Quotes and prepends the specified text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="text">The text to be quoted and prepended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.AppendQuoted(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.Object[])">
<summary>
Formats, quotes and appends the specified text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="format">A composite format string to be quoted and appended.</param>
<param name="args">An object array that contains zero or more objects to format.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
<exception cref="T:System.ArgumentNullException"><paramref name="format" /> or <paramref name="args" /> is null. </exception>
<exception cref="T:System.FormatException"><paramref name="format" /> is invalid.-or- The index of a format item is less than zero, or greater than or equal to the length of the <paramref name="args" /> array. </exception>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.PrependQuoted(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.Object[])">
<summary>
Formats, quotes and prepends the specified text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="format">A composite format string to be quoted and prepended.</param>
<param name="args">An object array that contains zero or more objects to format.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
<exception cref="T:System.ArgumentNullException"><paramref name="format" /> or <paramref name="args" /> is null. </exception>
<exception cref="T:System.FormatException"><paramref name="format" /> is invalid.-or- The index of a format item is less than zero, or greater than or equal to the length of the <paramref name="args" /> array. </exception>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.AppendQuoted(Cake.Core.IO.ProcessArgumentBuilder,Cake.Core.IO.IProcessArgument)">
<summary>
Quotes and appends the specified argument to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="argument">The argument to be quoted and appended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.PrependQuoted(Cake.Core.IO.ProcessArgumentBuilder,Cake.Core.IO.IProcessArgument)">
<summary>
Quotes and prepends the specified argument to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="argument">The argument to be quoted and prepended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.AppendSecret(Cake.Core.IO.ProcessArgumentBuilder,System.String)">
<summary>
Appends the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="text">The secret text to be appended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.PrependSecret(Cake.Core.IO.ProcessArgumentBuilder,System.String)">
<summary>
Prepends the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="text">The secret text to be prepended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.AppendSecret(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.Object[])">
<summary>
Formats and appends the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="format">A composite format string for the secret text to be appended.</param>
<param name="args">An object array that contains zero or more objects to format.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
<exception cref="T:System.ArgumentNullException"><paramref name="format" /> or <paramref name="args" /> is null. </exception>
<exception cref="T:System.FormatException"><paramref name="format" /> is invalid.-or- The index of a format item is less than zero, or greater than or equal to the length of the <paramref name="args" /> array. </exception>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.PrependSecret(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.Object[])">
<summary>
Formats and prepend the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="format">A composite format string for the secret text to be prepended.</param>
<param name="args">An object array that contains zero or more objects to format.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
<exception cref="T:System.ArgumentNullException"><paramref name="format" /> or <paramref name="args" /> is null. </exception>
<exception cref="T:System.FormatException"><paramref name="format" /> is invalid.-or- The index of a format item is less than zero, or greater than or equal to the length of the <paramref name="args" /> array. </exception>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.AppendSecret(Cake.Core.IO.ProcessArgumentBuilder,Cake.Core.IO.IProcessArgument)">
<summary>
Appends the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="argument">The secret argument to be appended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.PrependSecret(Cake.Core.IO.ProcessArgumentBuilder,Cake.Core.IO.IProcessArgument)">
<summary>
Prepend the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="argument">The secret argument to be prepended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.AppendQuotedSecret(Cake.Core.IO.ProcessArgumentBuilder,System.String)">
<summary>
Quotes and appends the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="text">The secret text to be quoted and appended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.PrependQuotedSecret(Cake.Core.IO.ProcessArgumentBuilder,System.String)">
<summary>
Quotes and prepends the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="text">The secret text to be quoted and prepended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.AppendQuotedSecret(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.Object[])">
<summary>
Formats, quotes and appends the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="format">A composite format string for the secret text to be quoted and appended.</param>
<param name="args">An object array that contains zero or more objects to format.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
<exception cref="T:System.ArgumentNullException"><paramref name="format" /> or <paramref name="args" /> is null. </exception>
<exception cref="T:System.FormatException"><paramref name="format" /> is invalid.-or- The index of a format item is less than zero, or greater than or equal to the length of the <paramref name="args" /> array. </exception>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.PrependQuotedSecret(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.Object[])">
<summary>
Formats, quotes and prepends the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="format">A composite format string for the secret text to be quoted and prepended.</param>
<param name="args">An object array that contains zero or more objects to format.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
<exception cref="T:System.ArgumentNullException"><paramref name="format" /> or <paramref name="args" /> is null. </exception>
<exception cref="T:System.FormatException"><paramref name="format" /> is invalid.-or- The index of a format item is less than zero, or greater than or equal to the length of the <paramref name="args" /> array. </exception>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.AppendQuotedSecret(Cake.Core.IO.ProcessArgumentBuilder,Cake.Core.IO.IProcessArgument)">
<summary>
Quotes and appends the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="argument">The secret argument to be appended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.PrependQuotedSecret(Cake.Core.IO.ProcessArgumentBuilder,Cake.Core.IO.IProcessArgument)">
<summary>
Quotes and prepends the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="argument">The secret argument to be prepended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.AppendSwitch(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.String)">
<summary>
Appends the specified switch to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="text">The text to be appended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.PrependSwitch(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.String)">
<summary>
Prepend the specified switch to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="text">The text to be prepended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.AppendSwitch(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.String,System.String)">
<summary>
Appends the specified switch to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="separator">The separator between the switch and argument.</param>
<param name="text">The text to be appended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.PrependSwitch(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.String,System.String)">
<summary>
Prepend the specified switch to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="separator">The separator between the switch and argument.</param>
<param name="text">The text to be prepended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.AppendSwitchQuoted(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.String)">
<summary>
Quotes and appends the specified text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="text">The text to be quoted and appended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.PrependSwitchQuoted(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.String)">
<summary>
Quotes and prepends the specified text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="text">The text to be quoted and prepended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.AppendSwitchQuoted(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.String,System.String)">
<summary>
Quotes and appends the specified text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="separator">The separator between the switch and argument.</param>
<param name="text">The text to be quoted and appended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.PrependSwitchQuoted(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.String,System.String)">
<summary>
Quotes and prepends the specified text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="separator">The separator between the switch and argument.</param>
<param name="text">The text to be quoted and prepended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.AppendSwitchQuoted(Cake.Core.IO.ProcessArgumentBuilder,System.String,Cake.Core.IO.IProcessArgument)">
<summary>
Quotes and appends the specified argument to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="argument">The argument to be quoted and appended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.PrependSwitchQuoted(Cake.Core.IO.ProcessArgumentBuilder,System.String,Cake.Core.IO.IProcessArgument)">
<summary>
Quotes and prepends the specified argument to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="argument">The argument to be quoted and prepended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.AppendSwitchQuoted(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.String,Cake.Core.IO.IProcessArgument)">
<summary>
Quotes and appends the specified argument to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="separator">The separator between the switch and argument.</param>
<param name="argument">The argument to be quoted and appended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.PrependSwitchQuoted(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.String,Cake.Core.IO.IProcessArgument)">
<summary>
Quotes and prepends the specified argument to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="separator">The separator between the switch and argument.</param>
<param name="argument">The argument to be quoted and prepended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.AppendSwitchSecret(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.String)">
<summary>
Appends the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="text">The secret text to be appended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.PrependSwitchSecret(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.String)">
<summary>
Prepend the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="text">The secret text to be prepended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.AppendSwitchSecret(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.String,System.String)">
<summary>
Appends the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="separator">The separator between the switch and argument.</param>
<param name="text">The secret text to be appended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.PrependSwitchSecret(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.String,System.String)">
<summary>
Prepend the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="separator">The separator between the switch and argument.</param>
<param name="text">The secret text to be prepended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.AppendSwitchSecret(Cake.Core.IO.ProcessArgumentBuilder,System.String,Cake.Core.IO.IProcessArgument)">
<summary>
Appends the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="argument">The secret argument to be appended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.PrependSwitchSecret(Cake.Core.IO.ProcessArgumentBuilder,System.String,Cake.Core.IO.IProcessArgument)">
<summary>
Prepend the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="argument">The secret argument to be prepended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.AppendSwitchSecret(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.String,Cake.Core.IO.IProcessArgument)">
<summary>
Appends the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="separator">The separator between the switch and argument.</param>
<param name="argument">The secret argument to be appended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.PrependSwitchSecret(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.String,Cake.Core.IO.IProcessArgument)">
<summary>
Prepend the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="separator">The separator between the switch and argument.</param>
<param name="argument">The secret argument to be prepended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.AppendSwitchQuotedSecret(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.String)">
<summary>
Quotes and appends the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="text">The secret text to be quoted and appended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.PrependSwitchQuotedSecret(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.String)">
<summary>
Quotes and prepend the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="text">The secret text to be quoted and prepended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.AppendSwitchQuotedSecret(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.String,System.String)">
<summary>
Quotes and appends the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="separator">The separator between the switch and argument.</param>
<param name="text">The secret text to be quoted and appended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.PrependSwitchQuotedSecret(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.String,System.String)">
<summary>
Quotes and prepends the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="separator">The separator between the switch and argument.</param>
<param name="text">The secret text to be quoted and prepended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.AppendQuotedSecret(Cake.Core.IO.ProcessArgumentBuilder,System.String,Cake.Core.IO.IProcessArgument)">
<summary>
Quotes and appends the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="argument">The secret argument to be appended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.PrependQuotedSecret(Cake.Core.IO.ProcessArgumentBuilder,System.String,Cake.Core.IO.IProcessArgument)">
<summary>
Quotes and prepends the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="argument">The secret argument to be prepended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.AppendQuotedSecret(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.String,Cake.Core.IO.IProcessArgument)">
<summary>
Quotes and appends the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="separator">The separator between the switch and argument.</param>
<param name="argument">The secret argument to be appended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.PrependQuotedSecret(Cake.Core.IO.ProcessArgumentBuilder,System.String,System.String,Cake.Core.IO.IProcessArgument)">
<summary>
Quotes and prepend the specified secret text to the argument builder.
</summary>
<param name="builder">The builder.</param>
<param name="switch">The switch preceding the text.</param>
<param name="separator">The separator between the switch and argument.</param>
<param name="argument">The secret argument to be prepended.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.IsNullOrEmpty(Cake.Core.IO.ProcessArgumentBuilder)">
<summary>
Indicates whether a <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> is null or renders empty.
</summary>
<param name="builder">The builder.</param>
<returns><c>true</c> if <paramref name="builder"/> refers to a null or empty <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/>;
<c>false</c> if the <paramref name="builder"/>refers to non null or empty <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/>.</returns>
</member>
<member name="M:Cake.Core.ProcessArgumentListExtensions.CopyTo(Cake.Core.IO.ProcessArgumentBuilder,Cake.Core.IO.ProcessArgumentBuilder)">
<summary>
Copies all the arguments of the source <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> to target <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/>.
</summary>
<param name="source">The argument builder to copy from.</param>
<param name="target">The argument builder to copy to.</param>
</member>
<member name="T:Cake.Core.ProcessRunnerExtensions">
<summary>
Contains extension methods for <see cref="T:Cake.Core.IO.IProcessRunner"/>.
</summary>
</member>
<member name="M:Cake.Core.ProcessRunnerExtensions.Start(Cake.Core.IO.IProcessRunner,Cake.Core.IO.FilePath)">
<summary>
Starts a process using the specified information.
</summary>
<param name="processRunner">The process runner.</param>
<param name="filePath">The file name such as an application or document with which to start the process.</param>
<returns>A process handle.</returns>
</member>
<member name="T:Cake.Core.ProcessSettingsExtensions">
<summary>
Contains extension methods for <see cref="T:Cake.Core.IO.ProcessSettings" />.
</summary>
</member>
<member name="M:Cake.Core.ProcessSettingsExtensions.WithArguments(Cake.Core.IO.ProcessSettings,System.Action{Cake.Core.IO.ProcessArgumentBuilder})">
<summary>
Sets the arguments for the process.
</summary>
<param name="settings">The settings.</param>
<param name="arguments">The action used to set arguments.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessSettingsExtensions.UseWorkingDirectory(Cake.Core.IO.ProcessSettings,Cake.Core.IO.DirectoryPath)">
<summary>
Sets the working directory for the process to be started.
</summary>
<param name="settings">The process settings.</param>
<param name="path">The working directory for the process to be started.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessSettingsExtensions.SetRedirectedStandardOutputHandler(Cake.Core.IO.ProcessSettings,System.Func{System.String,System.String})">
<summary>
Sets a function that intercepts the standard output before being redirected. Use in conjunction with <see cref="P:Cake.Core.IO.ProcessSettings.RedirectStandardOutput"/>.
</summary>
<param name="settings">The process settings.</param>
<param name="handler">The standard output handler.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessSettingsExtensions.SetRedirectedStandardErrorHandler(Cake.Core.IO.ProcessSettings,System.Func{System.String,System.String})">
<summary>
Sets a function that intercepts the standard error before being redirected. Use in conjunction with <see cref="P:Cake.Core.IO.ProcessSettings.RedirectStandardOutput"/>.
</summary>
<param name="settings">The process settings.</param>
<param name="handler">The standard error handler.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessSettingsExtensions.SetRedirectStandardOutput(Cake.Core.IO.ProcessSettings,System.Boolean)">
<summary>
Sets a value indicating whether the output of an application is written to the standard output stream.
</summary>
<param name="settings">The process settings.</param>
<param name="redirect">true if output should be redirected; false if output should be written to the standard output stream. The default is false.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessSettingsExtensions.SetRedirectStandardError(Cake.Core.IO.ProcessSettings,System.Boolean)">
<summary>
Sets a value indicating whether the standard error of an application is written to the standard error stream.
</summary>
<param name="settings">The process settings.</param>
<param name="redirect">true if error output should be redirected; false if error output should be written to the standard error stream. The default is false.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="M:Cake.Core.ProcessSettingsExtensions.SetTimeout(Cake.Core.IO.ProcessSettings,System.Int32)">
<summary>
Sets the optional timeout for process execution.
</summary>
<param name="settings">The process settings.</param>
<param name="timeout">The timeout duration.</param>
<returns>The same <see cref="T:Cake.Core.IO.ProcessSettings"/> instance so that multiple calls can be chained.</returns>
</member>
<member name="T:Cake.Core.StringExtensions">
<summary>
Contains extension methods for <see cref="T:System.String"/>.
</summary>
</member>
<member name="M:Cake.Core.StringExtensions.Quote(System.String)">
<summary>
Quotes the specified <see cref="T:System.String"/>.
</summary>
<param name="value">The string to quote.</param>
<returns>A quoted string.</returns>
</member>
<member name="M:Cake.Core.StringExtensions.UnQuote(System.String)">
<summary>
Unquote the specified <see cref="T:System.String"/>.
</summary>
<param name="value">The string to unquote.</param>
<returns>An unquoted string.</returns>
</member>
<member name="M:Cake.Core.StringExtensions.SplitLines(System.String)">
<summary>
Splits the <see cref="T:System.String"/> into lines.
</summary>
<param name="content">The string to split.</param>
<returns>The lines making up the provided string.</returns>
</member>
<member name="M:Cake.Core.StringExtensions.NormalizeLineEndings(System.String)">
<summary>
Normalizes the line endings in a <see cref="T:System.String"/>.
</summary>
<param name="value">The string to normalize line endings in.</param>
<returns>A <see cref="T:System.String"/> with normalized line endings.</returns>
</member>
<member name="T:Cake.Core.TypeExtensions">
<summary>
Contains extension methods for <see cref="T:System.Type"/>.
</summary>
</member>
<member name="M:Cake.Core.TypeExtensions.IsStatic(System.Type)">
<summary>
Determines whether the specified <see cref="T:System.Type"/> is static.
</summary>
<param name="type">The type.</param>
<returns>Whether or not the specified type is static.</returns>
</member>
<member name="M:Cake.Core.TypeExtensions.GetFullName(System.Type,System.Boolean)">
<summary>
Gets the full name of a <see cref="T:System.Type"/>.
</summary>
<param name="type">The type.</param>
<param name="includeNamespace">if set to <c>true</c> then namespace is included.</param>
<returns>The full name of a type.</returns>
</member>
<member name="M:Cake.Core.TypeExtensions.IsSubclassOfRawGeneric(System.Type,System.Type)">
<summary>
Gets whether or not a given <see cref="T:System.Type"/> is a subclass of an raw/open generic.
</summary>
<param name="toCheck">The type to check.</param>
<param name="generic">The open generic to test.</param>
<code>typeof(Nullable<int>).IsSubclassOfRawGeneric(typeof(Nullable<>));.</code>
<returns>Returns <c>true</c> if the type is a subtype of a raw generic, else <c>false</c>.</returns>
</member>
<member name="T:Cake.Core.UriExtensions">
<summary>
Extensions for <see cref="T:System.Uri"/>.
</summary>
</member>
<member name="M:Cake.Core.UriExtensions.GetQueryString(System.Uri)">
<summary>
Extracts query string of <see cref="T:System.Uri"/>.
</summary>
<param name="uri">The URI.</param>
<returns>Collection of parameters and their values.</returns>
</member>
<member name="T:Cake.Core.Graph.CakeGraph">
<summary>
Represents the Cake task graph.
</summary>
</member>
<member name="M:Cake.Core.Graph.CakeGraph.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Graph.CakeGraph"/> class.
</summary>
</member>
<member name="P:Cake.Core.Graph.CakeGraph.Nodes">
<summary>
Gets the nodes in the graph.
</summary>
</member>
<member name="P:Cake.Core.Graph.CakeGraph.Edges">
<summary>
Gets the edges in the graph.
</summary>
</member>
<member name="M:Cake.Core.Graph.CakeGraph.Add(System.String)">
<summary>
Adds a node to the graph.
</summary>
<param name="node">The node to add.</param>
</member>
<member name="M:Cake.Core.Graph.CakeGraph.Connect(System.String,System.String)">
<summary>
Connects two nodes in the graph together.
If any of the nodes are missing, they will be added.
</summary>
<param name="start">The start node.</param>
<param name="end">The end node.</param>
</member>
<member name="M:Cake.Core.Graph.CakeGraph.Exist(System.String)">
<summary>
Gets whether or not a node exists in the graph.
</summary>
<param name="name">The name of the node.</param>
<returns>Whether or not the node exists in the graph.</returns>
</member>
<member name="M:Cake.Core.Graph.CakeGraph.Traverse(System.String)">
<summary>
Traverses the graph leading to the specified target.
</summary>
<param name="target">The target to traverse to.</param>
<returns>A list of nodes.</returns>
</member>
<member name="T:Cake.Core.Graph.CakeGraphBuilder">
<summary>
Responsible for building the Cake task graph.
</summary>
</member>
<member name="M:Cake.Core.Graph.CakeGraphBuilder.Build(System.Collections.Generic.IReadOnlyCollection{Cake.Core.ICakeTaskInfo})">
<summary>
Builds a <see cref="T:Cake.Core.Graph.CakeGraph"/> from the specified tasks.
</summary>
<param name="tasks">The tasks to build the graph from.</param>
<returns>An assembled graph.</returns>
</member>
<member name="T:Cake.Core.Graph.CakeGraphEdge">
<summary>
Represents an edge in a <see cref="T:Cake.Core.Graph.CakeGraph"/>.
</summary>
</member>
<member name="P:Cake.Core.Graph.CakeGraphEdge.Start">
<summary>
Gets the start node of the edge.
</summary>
</member>
<member name="P:Cake.Core.Graph.CakeGraphEdge.End">
<summary>
Gets the end node of the edge.
</summary>
</member>
<member name="M:Cake.Core.Graph.CakeGraphEdge.#ctor(System.String,System.String)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Graph.CakeGraphEdge"/> class.
</summary>
<param name="start">The start node.</param>
<param name="end">The end node.</param>
</member>
<member name="T:Cake.Core.ICakeArguments">
<summary>
Represents arguments passed to the executing script.
</summary>
</member>
<member name="M:Cake.Core.ICakeArguments.HasArgument(System.String)">
<summary>
Determines whether or not the specified argument exist.
</summary>
<param name="name">The argument name.</param>
<returns>
<c>true</c> if the argument exist; otherwise <c>false</c>.
</returns>
</member>
<member name="M:Cake.Core.ICakeArguments.GetArguments(System.String)">
<summary>
Gets all values for an argument.
</summary>
<param name="name">The argument name.</param>
<returns>The argument values.</returns>
</member>
<member name="M:Cake.Core.ICakeArguments.GetArguments">
<summary>
Gets all command line arguments.
</summary>
<returns>The command line arguments as IDictionary<string, ICollection<string>>.</returns>
</member>
<member name="T:Cake.Core.ICakeContext">
<summary>
Represents a context for scripts and script aliases.
</summary>
</member>
<member name="P:Cake.Core.ICakeContext.FileSystem">
<summary>
Gets the file system.
</summary>
<value>The file system.</value>
</member>
<member name="P:Cake.Core.ICakeContext.Environment">
<summary>
Gets the environment.
</summary>
<value>The environment.</value>
</member>
<member name="P:Cake.Core.ICakeContext.Globber">
<summary>
Gets the globber.
</summary>
<value>The globber.</value>
</member>
<member name="P:Cake.Core.ICakeContext.Log">
<summary>
Gets the log.
</summary>
<value>The log.</value>
</member>
<member name="P:Cake.Core.ICakeContext.Arguments">
<summary>
Gets the arguments.
</summary>
<value>The arguments.</value>
</member>
<member name="P:Cake.Core.ICakeContext.ProcessRunner">
<summary>
Gets the process runner.
</summary>
<value>The process runner.</value>
</member>
<member name="P:Cake.Core.ICakeContext.Registry">
<summary>
Gets the registry.
</summary>
<value>The registry.</value>
</member>
<member name="P:Cake.Core.ICakeContext.Tools">
<summary>
Gets the tool locator.
</summary>
<value>The tool locator.</value>
</member>
<member name="P:Cake.Core.ICakeContext.Data">
<summary>
Gets the data context resolver.
</summary>
</member>
<member name="P:Cake.Core.ICakeContext.Configuration">
<summary>
Gets the cake configuration.
</summary>
</member>
<member name="T:Cake.Core.ICakeDataResolver">
<summary>
Represents a data context resolver.
</summary>
</member>
<member name="M:Cake.Core.ICakeDataResolver.Get``1">
<summary>
Gets the data of the specified type.
</summary>
<typeparam name="TData">The data type.</typeparam>
<returns>The value of the data.</returns>
</member>
<member name="T:Cake.Core.ICakeDataService">
<summary>
Represents a data context service.
</summary>
</member>
<member name="M:Cake.Core.ICakeDataService.Add``1(``0)">
<summary>
Adds the data of the specified type.
</summary>
<typeparam name="TData">The data type.</typeparam>
<param name="value">The value of the data.</param>
</member>
<member name="T:Cake.Core.ICakeEngine">
<summary>
Represents the Cake engine.
</summary>
</member>
<member name="P:Cake.Core.ICakeEngine.Tasks">
<summary>
Gets all registered tasks.
</summary>
<value>The registered tasks.</value>
</member>
<member name="E:Cake.Core.ICakeEngine.BeforeSetup">
<summary>
Raised at the start of setup before any tasks are run.
</summary>
</member>
<member name="E:Cake.Core.ICakeEngine.AfterSetup">
<summary>
Raised at the end of setup before any tasks are run.
</summary>
</member>
<member name="E:Cake.Core.ICakeEngine.BeforeTeardown">
<summary>
Raised at the start of teardown after all other tasks have been run.
</summary>
</member>
<member name="E:Cake.Core.ICakeEngine.AfterTeardown">
<summary>
Raised at the end of teardown after all other tasks have been run.
</summary>
</member>
<member name="E:Cake.Core.ICakeEngine.BeforeTaskSetup">
<summary>
Raised at the start of task setup before each task is run.
</summary>
</member>
<member name="E:Cake.Core.ICakeEngine.AfterTaskSetup">
<summary>
Raised at the end of task setup before each task is run.
</summary>
</member>
<member name="E:Cake.Core.ICakeEngine.BeforeTaskTeardown">
<summary>
Raised at the start of task teardown after each task has been run.
</summary>
</member>
<member name="E:Cake.Core.ICakeEngine.AfterTaskTeardown">
<summary>
Raised at the end of task teardown after each task has been run.
</summary>
</member>
<member name="M:Cake.Core.ICakeEngine.RegisterTask(System.String)">
<summary>
Creates and registers a new Cake task.
</summary>
<param name="name">The name of the task.</param>
<returns>A <see cref="T:Cake.Core.CakeTaskBuilder"/> used to configure the task.</returns>
</member>
<member name="M:Cake.Core.ICakeEngine.RegisterSetupAction(System.Action{Cake.Core.ISetupContext})">
<summary>
Allows registration of an action that's executed before any tasks are run.
If setup fails, no tasks will be executed but teardown will be performed.
</summary>
<param name="action">The action to be executed.</param>
</member>
<member name="M:Cake.Core.ICakeEngine.RegisterSetupAction``1(System.Func{Cake.Core.ISetupContext,``0})">
<summary>
Allows registration of an action that's executed before any tasks are run.
If setup fails, no tasks will be executed but teardown will be performed.
</summary>
<typeparam name="TData">The data type.</typeparam>
<param name="action">The action to be executed.</param>
</member>
<member name="M:Cake.Core.ICakeEngine.RegisterTeardownAction(System.Action{Cake.Core.ITeardownContext})">
<summary>
Allows registration of an action that's executed after all other tasks have been run.
If a setup action or a task fails with or without recovery, the specified teardown action will still be executed.
</summary>
<param name="action">The action to be executed.</param>
</member>
<member name="M:Cake.Core.ICakeEngine.RegisterTeardownAction``1(System.Action{Cake.Core.ITeardownContext,``0})">
<summary>
Allows registration of an action that's executed after all other tasks have been run.
If a setup action or a task fails with or without recovery, the specified teardown action will still be executed.
</summary>
<typeparam name="TData">The data type.</typeparam>
<param name="action">The action to be executed.</param>
</member>
<member name="M:Cake.Core.ICakeEngine.RunTargetAsync(Cake.Core.ICakeContext,Cake.Core.IExecutionStrategy,Cake.Core.ExecutionSettings)">
<summary>
Runs the specified target using the specified <see cref="T:Cake.Core.IExecutionStrategy"/>.
</summary>
<param name="context">The context.</param>
<param name="strategy">The execution strategy.</param>
<param name="settings">The execution settings.</param>
<returns>The resulting report.</returns>
</member>
<member name="M:Cake.Core.ICakeEngine.RegisterTaskSetupAction(System.Action{Cake.Core.ITaskSetupContext})">
<summary>
Allows registration of an action that's executed before each task is run.
If the task setup fails, the task will not be executed but the task's teardown will be performed.
</summary>
<param name="action">The action to be executed.</param>
</member>
<member name="M:Cake.Core.ICakeEngine.RegisterTaskSetupAction``1(System.Action{Cake.Core.ITaskSetupContext,``0})">
<summary>
Allows registration of an action that's executed before each task is run.
If the task setup fails, the task will not be executed but the task's teardown will be performed.
</summary>
<typeparam name="TData">The data type.</typeparam>
<param name="action">The action to be executed.</param>
</member>
<member name="M:Cake.Core.ICakeEngine.RegisterTaskTeardownAction(System.Action{Cake.Core.ITaskTeardownContext})">
<summary>
Allows registration of an action that's executed after each task has been run.
If a task setup action or a task fails with or without recovery, the specified task teardown action will still be executed.
</summary>
<param name="action">The action to be executed.</param>
</member>
<member name="M:Cake.Core.ICakeEngine.RegisterTaskTeardownAction``1(System.Action{Cake.Core.ITaskTeardownContext,``0})">
<summary>
Allows registration of an action that's executed after each task has been run.
If a task setup action or a task fails with or without recovery, the specified task teardown action will still be executed.
</summary>
<typeparam name="TData">The data type.</typeparam>
<param name="action">The action to be executed.</param>
</member>
<member name="T:Cake.Core.ICakeEnvironment">
<summary>
Represents the environment Cake operates in.
</summary>
</member>
<member name="P:Cake.Core.ICakeEnvironment.WorkingDirectory">
<summary>
Gets or sets the working directory.
</summary>
<value>The working directory.</value>
</member>
<member name="P:Cake.Core.ICakeEnvironment.ApplicationRoot">
<summary>
Gets the application root path.
</summary>
<value>The application root path.</value>
</member>
<member name="M:Cake.Core.ICakeEnvironment.GetSpecialPath(Cake.Core.IO.SpecialPath)">
<summary>
Gets a special path.
</summary>
<param name="path">The path.</param>
<returns>A <see cref="T:Cake.Core.IO.DirectoryPath"/> to the special path.</returns>
</member>
<member name="M:Cake.Core.ICakeEnvironment.GetEnvironmentVariable(System.String)">
<summary>
Gets an environment variable.
</summary>
<param name="variable">The variable.</param>
<returns>The value of the environment variable.</returns>
</member>
<member name="M:Cake.Core.ICakeEnvironment.GetEnvironmentVariables">
<summary>
Gets all environment variables.
</summary>
<returns>The environment variables as IDictionary<string, string>.</returns>
</member>
<member name="P:Cake.Core.ICakeEnvironment.Platform">
<summary>
Gets the platform Cake is running on.
</summary>
<value>The platform Cake is running on.</value>
</member>
<member name="P:Cake.Core.ICakeEnvironment.Runtime">
<summary>
Gets the runtime Cake is running in.
</summary>
<value>The runtime Cake is running in.</value>
</member>
<member name="T:Cake.Core.ICakePlatform">
<summary>
Represents the platform that Cake is running on.
</summary>
</member>
<member name="P:Cake.Core.ICakePlatform.Family">
<summary>
Gets the platform family.
</summary>
<value>The platform family.</value>
</member>
<member name="P:Cake.Core.ICakePlatform.Is64Bit">
<summary>
Gets a value indicating whether or not the current operative system is 64 bit.
</summary>
<value>
<c>true</c> if current operative system is 64 bit; otherwise, <c>false</c>.
</value>
</member>
<member name="T:Cake.Core.ICakeReportPrinter">
<summary>
Represents a report printer.
</summary>
</member>
<member name="M:Cake.Core.ICakeReportPrinter.Write(Cake.Core.CakeReport)">
<summary>
Writes the specified report to a target.
</summary>
<param name="report">The report to write.</param>
</member>
<member name="M:Cake.Core.ICakeReportPrinter.WriteLifeCycleStep(System.String,Cake.Core.Diagnostics.Verbosity)">
<summary>
Writes the specified lifecyle steps (i.e. Setup/TearDown) to a target.
</summary>
<param name="name">The name of the lifecycyle step.</param>
<param name="verbosity">The <see cref="T:Cake.Core.Diagnostics.Verbosity"/> at which the step should be written.</param>
</member>
<member name="M:Cake.Core.ICakeReportPrinter.WriteStep(System.String,Cake.Core.Diagnostics.Verbosity)">
<summary>
Writes the specified step to a target.
</summary>
<param name="name">The name of the step.</param>
<param name="verbosity">The <see cref="T:Cake.Core.Diagnostics.Verbosity"/> at which the step should be written.</param>
</member>
<member name="M:Cake.Core.ICakeReportPrinter.WriteSkippedStep(System.String,Cake.Core.Diagnostics.Verbosity)">
<summary>
Writes the skipped step to a target.
</summary>
<param name="name">The name of the step.</param>
<param name="verbosity">The <see cref="T:Cake.Core.Diagnostics.Verbosity"/> at which the step should be written.</param>
</member>
<member name="T:Cake.Core.ICakeRuntime">
<summary>
Represents the runtime that Cake is running in.
</summary>
</member>
<member name="P:Cake.Core.ICakeRuntime.BuiltFramework">
<summary>
Gets the build-time .NET framework version that is being used.
</summary>
</member>
<member name="P:Cake.Core.ICakeRuntime.Runtime">
<summary>
Gets the current executing .NET Runtime.
</summary>
<returns>The target framework.</returns>
</member>
<member name="P:Cake.Core.ICakeRuntime.CakeVersion">
<summary>
Gets the version of Cake executing the script.
</summary>
<returns>The Cake.exe version.</returns>
</member>
<member name="P:Cake.Core.ICakeRuntime.IsCoreClr">
<summary>
Gets a value indicating whether we're running on CoreClr.
</summary>
<value>
<c>true</c> if we're running on CoreClr; otherwise, <c>false</c>.
</value>
</member>
<member name="T:Cake.Core.ICakeTaskInfo">
<summary>
Provides descriptive properties about a cake task.
</summary>
</member>
<member name="P:Cake.Core.ICakeTaskInfo.Name">
<summary>
Gets the name of the task.
</summary>
<value>The name of the task.</value>
</member>
<member name="P:Cake.Core.ICakeTaskInfo.Description">
<summary>
Gets the description of the task.
</summary>
<value>The description of the task.</value>
</member>
<member name="P:Cake.Core.ICakeTaskInfo.Dependencies">
<summary>
Gets the task's dependencies.
</summary>
<value>The task's dependencies.</value>
</member>
<member name="P:Cake.Core.ICakeTaskInfo.Dependees">
<summary>
Gets the tasks that the task want to be a dependency of.
</summary>
<value>The tasks that the task want to be a dependency of.</value>
</member>
<member name="T:Cake.Core.IConsole">
<summary>
Represents console output.
</summary>
</member>
<member name="P:Cake.Core.IConsole.ForegroundColor">
<summary>
Gets or sets the foreground color.
</summary>
<value>The foreground color.</value>
</member>
<member name="P:Cake.Core.IConsole.BackgroundColor">
<summary>
Gets or sets the background color.
</summary>
<value>The background color.</value>
</member>
<member name="P:Cake.Core.IConsole.SupportAnsiEscapeCodes">
<summary>
Gets a value indicating whether or not the console supports ANSI escape codes.
</summary>
</member>
<member name="M:Cake.Core.IConsole.Write(System.String,System.Object[])">
<summary>
Writes the text representation of the specified array of objects to the
console output using the specified format information.
</summary>
<param name="format">A composite format string.</param>
<param name="arg">An array of objects to write using format.</param>
</member>
<member name="M:Cake.Core.IConsole.WriteLine(System.String,System.Object[])">
<summary>
Writes the text representation of the specified array of objects, followed
by the current line terminator, to the console output using the specified
format information.
</summary>
<param name="format">A composite format string.</param>
<param name="arg">An array of objects to write using format.</param>
</member>
<member name="M:Cake.Core.IConsole.WriteError(System.String,System.Object[])">
<summary>
Writes the text representation of the specified array of objects to the
console error output using the specified format information.
</summary>
<param name="format">A composite format string.</param>
<param name="arg">An array of objects to write using format.</param>
</member>
<member name="M:Cake.Core.IConsole.WriteErrorLine(System.String,System.Object[])">
<summary>
Writes the text representation of the specified array of objects, followed
by the current line terminator, to the console error output using the
specified format information.
</summary>
<param name="format">A composite format string.</param>
<param name="arg">An array of objects to write using format.</param>
</member>
<member name="M:Cake.Core.IConsole.ResetColor">
<summary>
Sets the foreground and background console colors to their defaults.
</summary>
</member>
<member name="T:Cake.Core.IExecutionStrategy">
<summary>
Represents a task execution strategy.
</summary>
</member>
<member name="M:Cake.Core.IExecutionStrategy.PerformSetup(System.Action{Cake.Core.ISetupContext},Cake.Core.ISetupContext)">
<summary>
Performs the setup.
</summary>
<param name="action">The action.</param>
<param name="context">The context.</param>
</member>
<member name="M:Cake.Core.IExecutionStrategy.PerformTeardown(System.Action{Cake.Core.ITeardownContext},Cake.Core.ITeardownContext)">
<summary>
Performs the teardown.
</summary>
<param name="action">The action.</param>
<param name="teardownContext">The context.</param>
</member>
<member name="M:Cake.Core.IExecutionStrategy.ExecuteAsync(Cake.Core.CakeTask,Cake.Core.ICakeContext)">
<summary>
Executes the specified task.
</summary>
<param name="task">The task to execute.</param>
<param name="context">The context.</param>
<returns>Returned Task.</returns>
</member>
<member name="M:Cake.Core.IExecutionStrategy.Skip(Cake.Core.CakeTask,Cake.Core.CakeTaskCriteria)">
<summary>
Skips the specified task.
</summary>
<param name="task">The task to skip.</param>
<param name="criteria">The criteria that caused the task to be skipped.</param>
</member>
<member name="M:Cake.Core.IExecutionStrategy.ReportErrorsAsync(System.Func{System.Exception,System.Threading.Tasks.Task},System.Exception)">
<summary>
Executes the error reporter.
</summary>
<param name="action">The action.</param>
<param name="exception">The exception.</param>
<returns>The awaitable task.</returns>
</member>
<member name="M:Cake.Core.IExecutionStrategy.HandleErrorsAsync(System.Func{System.Exception,Cake.Core.ICakeContext,System.Threading.Tasks.Task},System.Exception,Cake.Core.ICakeContext)">
<summary>
Executes the error handler.
</summary>
<param name="action">The action.</param>
<param name="exception">The exception.</param>
<param name="context">The context.</param>
<returns>The awaitable task.</returns>
</member>
<member name="M:Cake.Core.IExecutionStrategy.InvokeFinallyAsync(System.Func{Cake.Core.ICakeContext,System.Threading.Tasks.Task},Cake.Core.ICakeContext)">
<summary>
Invokes the finally handler.
</summary>
<param name="action">The action.</param>
<param name="context">The context.</param>
<returns>The awaitable task.</returns>
</member>
<member name="M:Cake.Core.IExecutionStrategy.PerformTaskSetup(System.Action{Cake.Core.ITaskSetupContext},Cake.Core.ITaskSetupContext)">
<summary>
Performs the specified setup action before each task is invoked.
</summary>
<param name="action">The action.</param>
<param name="taskSetupContext">The context.</param>
</member>
<member name="M:Cake.Core.IExecutionStrategy.PerformTaskTeardown(System.Action{Cake.Core.ITaskTeardownContext},Cake.Core.ITaskTeardownContext)">
<summary>
Performs the specified teardown action after each task is invoked.
</summary>
<param name="action">The action.</param>
<param name="taskTeardownContext">The context.</param>
</member>
<member name="T:Cake.Core.IO.Arguments.QuotedArgument">
<summary>
Represents a quoted argument.
</summary>
</member>
<member name="M:Cake.Core.IO.Arguments.QuotedArgument.#ctor(Cake.Core.IO.IProcessArgument)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.IO.Arguments.QuotedArgument"/> class.
</summary>
<param name="argument">The argument.</param>
</member>
<member name="M:Cake.Core.IO.Arguments.QuotedArgument.Render">
<inheritdoc/>
</member>
<member name="M:Cake.Core.IO.Arguments.QuotedArgument.RenderSafe">
<inheritdoc/>
</member>
<member name="M:Cake.Core.IO.Arguments.QuotedArgument.ToString">
<inheritdoc/>
</member>
<member name="T:Cake.Core.IO.Arguments.SecretArgument">
<summary>
Represents a secret argument.
</summary>
</member>
<member name="M:Cake.Core.IO.Arguments.SecretArgument.#ctor(Cake.Core.IO.IProcessArgument)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.IO.Arguments.SecretArgument"/> class.
</summary>
<param name="argument">The argument.</param>
</member>
<member name="M:Cake.Core.IO.Arguments.SecretArgument.Render">
<inheritdoc/>
</member>
<member name="M:Cake.Core.IO.Arguments.SecretArgument.RenderSafe">
<inheritdoc/>
</member>
<member name="M:Cake.Core.IO.Arguments.SecretArgument.ToString">
<inheritdoc/>
</member>
<member name="T:Cake.Core.IO.Arguments.SwitchArgument">
<summary>
Represents a argument preceded by a switch.
</summary>
</member>
<member name="M:Cake.Core.IO.Arguments.SwitchArgument.#ctor(System.String,Cake.Core.IO.IProcessArgument,System.String)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.IO.Arguments.SwitchArgument"/> class.
</summary>
<param name="switch">The switch.</param>
<param name="argument">The argument.</param>
<param name="separator">The separator between the <paramref name="switch"/> and the <paramref name="argument"/>.</param>
</member>
<member name="M:Cake.Core.IO.Arguments.SwitchArgument.Render">
<inheritdoc/>
</member>
<member name="M:Cake.Core.IO.Arguments.SwitchArgument.RenderSafe">
<inheritdoc/>
</member>
<member name="M:Cake.Core.IO.Arguments.SwitchArgument.ToString">
<inheritdoc/>
</member>
<member name="T:Cake.Core.IO.Arguments.TextArgument">
<summary>
Represents a text argument.
</summary>
</member>
<member name="M:Cake.Core.IO.Arguments.TextArgument.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.IO.Arguments.TextArgument"/> class.
</summary>
<param name="text">The text.</param>
</member>
<member name="M:Cake.Core.IO.Arguments.TextArgument.Render">
<inheritdoc/>
</member>
<member name="M:Cake.Core.IO.Arguments.TextArgument.RenderSafe">
<inheritdoc/>
</member>
<member name="M:Cake.Core.IO.Arguments.TextArgument.ToString">
<inheritdoc/>
</member>
<member name="T:Cake.Core.IO.Arguments.NamespaceDoc">
<summary>
This namespace contain types
used to compose process arguments in a safe way.
</summary>
</member>
<member name="T:Cake.Core.IO.DirectoryPath">
<summary>
Represents a directory path.
</summary>
</member>
<member name="M:Cake.Core.IO.DirectoryPath.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.IO.DirectoryPath"/> class.
</summary>
<param name="path">The path.</param>
</member>
<member name="M:Cake.Core.IO.DirectoryPath.GetDirectoryName">
<summary>
Gets the name of the directory.
</summary>
<returns>The directory name.</returns>
<remarks>
If this is passed a file path, it will return the file name.
This is by-and-large equivalent to how DirectoryInfo handles this scenario.
If we wanted to return the *actual* directory name, we'd need to pull in IFileSystem,
and do various checks to make sure things exists.
</remarks>
</member>
<member name="M:Cake.Core.IO.DirectoryPath.GetFilePath(Cake.Core.IO.FilePath)">
<summary>
Combines the current path with the file name of a <see cref="T:Cake.Core.IO.FilePath"/>.
</summary>
<param name="path">The path.</param>
<returns>A combination of the current path and the file name of the provided <see cref="T:Cake.Core.IO.FilePath"/>.</returns>
</member>
<member name="M:Cake.Core.IO.DirectoryPath.GetParent">
<summary>
Gets the directory path of a <see cref="T:Cake.Core.IO.DirectoryPath"/>.
</summary>
<returns>A <see cref="T:Cake.Core.IO.DirectoryPath"/> to the parent directory of the given <see cref="T:Cake.Core.IO.DirectoryPath"/>.</returns>
</member>
<member name="M:Cake.Core.IO.DirectoryPath.CombineWithFilePath(Cake.Core.IO.FilePath)">
<summary>
Combines the current path with a <see cref="T:Cake.Core.IO.FilePath"/>.
The provided <see cref="T:Cake.Core.IO.FilePath"/> must be relative.
</summary>
<param name="path">The path.</param>
<returns>A combination of the current path and the provided <see cref="T:Cake.Core.IO.FilePath"/>.</returns>
</member>
<member name="M:Cake.Core.IO.DirectoryPath.Combine(Cake.Core.IO.DirectoryPath)">
<summary>
Combines the current path with another <see cref="T:Cake.Core.IO.DirectoryPath"/>.
The provided <see cref="T:Cake.Core.IO.DirectoryPath"/> must be relative.
</summary>
<param name="path">The path.</param>
<returns>A combination of the current path and the provided <see cref="T:Cake.Core.IO.DirectoryPath"/>.</returns>
</member>
<member name="M:Cake.Core.IO.DirectoryPath.MakeAbsolute(Cake.Core.IO.DirectoryPath)">
<summary>
Makes the path absolute to another (absolute) path.
</summary>
<param name="path">The path.</param>
<returns>An absolute path.</returns>
</member>
<member name="M:Cake.Core.IO.DirectoryPath.MakeAbsolute(Cake.Core.ICakeEnvironment)">
<summary>
Makes the path absolute (if relative) using the current working directory.
</summary>
<param name="environment">The environment.</param>
<returns>An absolute path.</returns>
</member>
<member name="M:Cake.Core.IO.DirectoryPath.Collapse">
<summary>
Collapses a <see cref="T:Cake.Core.IO.DirectoryPath"/> containing ellipses.
</summary>
<returns>A collapsed <see cref="T:Cake.Core.IO.DirectoryPath"/>.</returns>
</member>
<member name="M:Cake.Core.IO.DirectoryPath.op_Implicit(System.String)~Cake.Core.IO.DirectoryPath">
<summary>
Performs an implicit conversion from <see cref="T:System.String"/> to <see cref="T:Cake.Core.IO.DirectoryPath"/>.
</summary>
<param name="path">The path.</param>
<returns>A <see cref="T:Cake.Core.IO.DirectoryPath"/>.</returns>
</member>
<member name="M:Cake.Core.IO.DirectoryPath.FromString(System.String)">
<summary>
Performs a conversion from <see cref="T:System.String"/> to <see cref="T:Cake.Core.IO.DirectoryPath"/>.
</summary>
<param name="path">The path.</param>
<returns>A <see cref="T:Cake.Core.IO.DirectoryPath"/>.</returns>
</member>
<member name="M:Cake.Core.IO.DirectoryPath.GetRelativePath(Cake.Core.IO.DirectoryPath)">
<summary>
Get the relative path to another directory.
</summary>
<param name="to">The target directory path.</param>
<returns>A <see cref="T:Cake.Core.IO.DirectoryPath"/>.</returns>
</member>
<member name="M:Cake.Core.IO.DirectoryPath.GetRelativePath(Cake.Core.IO.FilePath)">
<summary>
Get the relative path to another file.
</summary>
<param name="to">The target file path.</param>
<returns>A <see cref="T:Cake.Core.IO.FilePath"/>.</returns>
</member>
<member name="M:Cake.Core.IO.DirectoryPath.Equals(Cake.Core.IO.DirectoryPath)">
<summary>
Determines whether two <see cref="T:Cake.Core.IO.DirectoryPath"/> instances are equal.
</summary>
<param name="other">the <see cref="T:Cake.Core.IO.DirectoryPath"/> to compare.</param>
<returns>True if other is equal to current object, False otherwise.</returns>
</member>
<member name="M:Cake.Core.IO.DirectoryPath.Equals(System.Object)">
<summary>
Determines whether two <see cref="T:Cake.Core.IO.DirectoryPath"/> instances are equal.
</summary>
<param name="other">the <see cref="T:Cake.Core.IO.DirectoryPath"/> to compare.</param>
<returns>True if other is equal to current object, False otherwise.</returns>
</member>
<member name="M:Cake.Core.IO.DirectoryPath.op_Equality(Cake.Core.IO.DirectoryPath,Cake.Core.IO.DirectoryPath)">
<summary>
Determines whether two <see cref="T:Cake.Core.IO.DirectoryPath"/> instances are equal.
</summary>
<param name="directoryPath">left side <see cref="T:Cake.Core.IO.DirectoryPath"/>.</param>
<param name="otherDirectoryPath">right side <see cref="T:Cake.Core.IO.DirectoryPath"/>.</param>
<returns>True if other is equal to current object, False otherwise.</returns>
</member>
<member name="M:Cake.Core.IO.DirectoryPath.op_Inequality(Cake.Core.IO.DirectoryPath,Cake.Core.IO.DirectoryPath)">
<summary>
Determines whether two <see cref="T:Cake.Core.IO.DirectoryPath"/> instances are different.
</summary>
<param name="directoryPath">left side <see cref="T:Cake.Core.IO.DirectoryPath"/>.</param>
<param name="otherDirectoryPath">right side <see cref="T:Cake.Core.IO.DirectoryPath"/>.</param>
<returns>True if other is equal to current object, False otherwise.</returns>
</member>
<member name="M:Cake.Core.IO.DirectoryPath.GetHashCode">
<summary>
Returns the hash code for the <see cref="T:Cake.Core.IO.FilePath"/>.
</summary>
<returns>
A 32-bit signed integer hash code.
</returns>
</member>
<member name="M:Cake.Core.IO.DirectoryPath.Compare(Cake.Core.IO.DirectoryPath,Cake.Core.IO.DirectoryPath)">
<summary>
Compares two DirectoryPath and returns an indication of their relative sort order.
</summary>
<param name="x">The first <see cref="T:Cake.Core.IO.Path"/> to compare.</param>
<param name="y">The second <see cref="T:Cake.Core.IO.Path"/> to compare.</param>
<returns>A signed integer that indicates the relative values of x and y.
<list type="table">
<item>
<term>Less than zero</term>
<description>x precedes y in the sort order, or x is null and y is not null.</description>
</item>
<item>
<term>Zero</term>
<description>x is equal to y, or x and y are both null.</description>
</item>
<item>
<term>Greater than zero</term>
<description>
x follows y in the sort order, or y is null and x is not null.
</description>
</item>
</list>
</returns>
</member>
<member name="T:Cake.Core.IO.DirectoryPathCollection">
<summary>
A collection of <see cref="T:Cake.Core.IO.DirectoryPath"/>.
</summary>
</member>
<member name="P:Cake.Core.IO.DirectoryPathCollection.Count">
<summary>
Gets the number of directories in the collection.
</summary>
<value>The number of directories in the collection.</value>
</member>
<member name="M:Cake.Core.IO.DirectoryPathCollection.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.IO.DirectoryPathCollection"/> class.
</summary>
</member>
<member name="M:Cake.Core.IO.DirectoryPathCollection.#ctor(Cake.Core.IO.PathComparer)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.IO.DirectoryPathCollection"/> class.
</summary>
<param name="comparer">The comparer.</param>
</member>
<member name="M:Cake.Core.IO.DirectoryPathCollection.#ctor(System.Collections.Generic.IEnumerable{Cake.Core.IO.DirectoryPath})">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.IO.DirectoryPathCollection"/> class.
</summary>
<param name="paths">The paths.</param>
</member>
<member name="M:Cake.Core.IO.DirectoryPathCollection.#ctor(System.Collections.Generic.IEnumerable{Cake.Core.IO.DirectoryPath},Cake.Core.IO.PathComparer)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.IO.DirectoryPathCollection"/> class.
</summary>
<param name="paths">The paths.</param>
<param name="comparer">The comparer.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="comparer"/> is <c>null</c>.</exception>
</member>
<member name="M:Cake.Core.IO.DirectoryPathCollection.Add(Cake.Core.IO.DirectoryPath)">
<summary>
Adds the specified path to the collection.
</summary>
<param name="path">The path to add.</param>
<returns>
<c>true</c> if the path was added; <c>false</c> if the path was already present.
</returns>
</member>
<member name="M:Cake.Core.IO.DirectoryPathCollection.Add(System.Collections.Generic.IEnumerable{Cake.Core.IO.DirectoryPath})">
<summary>
Adds the specified paths to the collection.
</summary>
<param name="paths">The paths to add.</param>
</member>
<member name="M:Cake.Core.IO.DirectoryPathCollection.Remove(Cake.Core.IO.DirectoryPath)">
<summary>
Removes the specified path from the collection.
</summary>
<param name="path">The path to remove.</param>
<returns>
<c>true</c> if the path was removed; <c>false</c> if the path was not found in the collection.
</returns>
</member>
<member name="M:Cake.Core.IO.DirectoryPathCollection.Remove(System.Collections.Generic.IEnumerable{Cake.Core.IO.DirectoryPath})">
<summary>
Removes the specified paths from the collection.
</summary>
<param name="paths">The paths to remove.</param>
</member>
<member name="M:Cake.Core.IO.DirectoryPathCollection.op_Addition(Cake.Core.IO.DirectoryPathCollection,Cake.Core.IO.DirectoryPath)">
<summary>Adds a path to the collection.</summary>
<param name="collection">The collection.</param>
<param name="path">The path to add.</param>
<returns>A new <see cref="T:Cake.Core.IO.DirectoryPathCollection"/> that contains the provided path as
well as the paths in the original collection.</returns>
</member>
<member name="M:Cake.Core.IO.DirectoryPathCollection.op_Addition(Cake.Core.IO.DirectoryPathCollection,System.Collections.Generic.IEnumerable{Cake.Core.IO.DirectoryPath})">
<summary>Adds multiple paths to the collection.</summary>
<param name="collection">The collection.</param>
<param name="paths">The paths to add.</param>
<returns>A new <see cref="T:Cake.Core.IO.DirectoryPathCollection"/> with the content of both collections.</returns>
</member>
<member name="M:Cake.Core.IO.DirectoryPathCollection.op_Subtraction(Cake.Core.IO.DirectoryPathCollection,Cake.Core.IO.DirectoryPath)">
<summary>
Removes a path from the collection.
</summary>
<param name="collection">The collection.</param>
<param name="path">The path to remove.</param>
<returns>A new <see cref="T:Cake.Core.IO.DirectoryPathCollection"/> that do not contain the provided path.</returns>
</member>
<member name="M:Cake.Core.IO.DirectoryPathCollection.op_Subtraction(Cake.Core.IO.DirectoryPathCollection,System.Collections.Generic.IEnumerable{Cake.Core.IO.DirectoryPath})">
<summary>
Removes multiple paths from the collection.
</summary>
<param name="collection">The collection.</param>
<param name="paths">The paths to remove.</param>
<returns>A new <see cref="T:Cake.Core.IO.DirectoryPathCollection"/> that do not contain the provided paths.</returns>
</member>
<member name="M:Cake.Core.IO.DirectoryPathCollection.GetEnumerator">
<summary>
Returns an enumerator that iterates through the collection.
</summary>
<returns>
A <see cref="T:System.Collections.Generic.IEnumerator`1" /> that can be used to iterate through the collection.
</returns>
</member>
<member name="M:Cake.Core.IO.DirectoryPathCollection.System#Collections#IEnumerable#GetEnumerator">
<summary>
Returns an enumerator that iterates through a collection.
</summary>
<returns>
An <see cref="T:System.Collections.IEnumerator" /> that can be used to iterate through the collection.
</returns>
</member>
<member name="T:Cake.Core.IO.DirectoryPathConverter">
<summary>
A type converter for <see cref="T:Cake.Core.IO.DirectoryPath"/>.
</summary>
</member>
<member name="M:Cake.Core.IO.DirectoryPathConverter.CanConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Type)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.IO.DirectoryPathConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.IO.DirectoryPathConverter.CanConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Type)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.IO.DirectoryPathConverter.ConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object,System.Type)">
<inheritdoc/>
</member>
<member name="T:Cake.Core.IO.FileExtensions">
<summary>
Contains extension methods for <see cref="T:Cake.Core.IO.IFile"/>.
</summary>
</member>
<member name="M:Cake.Core.IO.FileExtensions.Open(Cake.Core.IO.IFile,System.IO.FileMode)">
<summary>
Opens the file using the specified options.
</summary>
<param name="file">The file.</param>
<param name="mode">The mode.</param>
<returns>A <see cref="T:System.IO.Stream"/> to the file.</returns>
</member>
<member name="M:Cake.Core.IO.FileExtensions.Open(Cake.Core.IO.IFile,System.IO.FileMode,System.IO.FileAccess)">
<summary>
Opens the file using the specified options.
</summary>
<param name="file">The file.</param>
<param name="mode">The mode.</param>
<param name="access">The access.</param>
<returns>A <see cref="T:System.IO.Stream"/> to the file.</returns>
</member>
<member name="M:Cake.Core.IO.FileExtensions.OpenRead(Cake.Core.IO.IFile)">
<summary>
Opens the file for reading.
</summary>
<param name="file">The file.</param>
<returns>A <see cref="T:System.IO.Stream"/> to the file.</returns>
</member>
<member name="M:Cake.Core.IO.FileExtensions.OpenWrite(Cake.Core.IO.IFile)">
<summary>
Opens the file for writing.
If the file already exists, it will be overwritten.
</summary>
<param name="file">The file to be opened.</param>
<returns>A <see cref="T:System.IO.Stream"/> to the file.</returns>
</member>
<member name="M:Cake.Core.IO.FileExtensions.ReadLines(Cake.Core.IO.IFile,System.Text.Encoding)">
<summary>
Enumerates line in file.
</summary>
<param name="file">The file to be read from.</param>
<param name="encoding">The encoding that is applied to the content of the file.</param>
<returns>A <see cref="T:System.Collections.Generic.IEnumerable`1"/> of file line content.</returns>
</member>
<member name="M:Cake.Core.IO.FileExtensions.IsClrAssembly(Cake.Core.IO.IFile)">
<summary>
Checks if file has CLR PE Header.
</summary>
<param name="file">The file to be read from.</param>
<returns><c>true</c> if file is CLR assembly; otherwise, <c>false</c>.</returns>
<remarks>
See <a href="https://docs.microsoft.com/en-us/windows/desktop/Debug/pe-format">https://docs.microsoft.com/en-us/windows/desktop/Debug/pe-format</a> for more information.
</remarks>
</member>
<member name="T:Cake.Core.IO.FilePath">
<summary>
Represents a file path.
</summary>
</member>
<member name="P:Cake.Core.IO.FilePath.HasExtension">
<summary>
Gets a value indicating whether this path has a file extension.
</summary>
<value>
<c>true</c> if this file path has a file extension; otherwise, <c>false</c>.
</value>
</member>
<member name="M:Cake.Core.IO.FilePath.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.IO.FilePath"/> class.
</summary>
<param name="path">The path.</param>
</member>
<member name="M:Cake.Core.IO.FilePath.GetDirectory">
<summary>
Gets the directory part of the path.
</summary>
<returns>The directory part of the path.</returns>
</member>
<member name="M:Cake.Core.IO.FilePath.GetFilename">
<summary>
Gets the filename.
</summary>
<returns>The filename.</returns>
</member>
<member name="M:Cake.Core.IO.FilePath.GetFilenameWithoutExtension">
<summary>
Gets the filename without its extension.
</summary>
<returns>The filename without its extension.</returns>
</member>
<member name="M:Cake.Core.IO.FilePath.GetExtension">
<summary>
Gets the file extension.
</summary>
<returns>The file extension.</returns>
</member>
<member name="M:Cake.Core.IO.FilePath.ChangeExtension(System.String)">
<summary>
Changes the file extension of the path.
</summary>
<param name="extension">The new extension.</param>
<returns>A new <see cref="T:Cake.Core.IO.FilePath"/> with a new extension.</returns>
</member>
<member name="M:Cake.Core.IO.FilePath.AppendExtension(System.String)">
<summary>
Appends a file extension to the path.
</summary>
<param name="extension">The extension.</param>
<returns>A new <see cref="T:Cake.Core.IO.FilePath"/> with an appended extension.</returns>
</member>
<member name="M:Cake.Core.IO.FilePath.MakeAbsolute(Cake.Core.ICakeEnvironment)">
<summary>
Makes the path absolute (if relative) using the current working directory.
</summary>
<param name="environment">The environment.</param>
<returns>An absolute path.</returns>
</member>
<member name="M:Cake.Core.IO.FilePath.MakeAbsolute(Cake.Core.IO.DirectoryPath)">
<summary>
Makes the path absolute (if relative) using the specified directory path.
</summary>
<param name="path">The path.</param>
<returns>An absolute path.</returns>
</member>
<member name="M:Cake.Core.IO.FilePath.Collapse">
<summary>
Collapses a <see cref="T:Cake.Core.IO.FilePath"/> containing ellipses.
</summary>
<returns>A collapsed <see cref="T:Cake.Core.IO.FilePath"/>.</returns>
</member>
<member name="M:Cake.Core.IO.FilePath.op_Implicit(System.String)~Cake.Core.IO.FilePath">
<summary>
Performs an implicit conversion from <see cref="T:System.String"/> to <see cref="T:Cake.Core.IO.FilePath"/>.
</summary>
<param name="path">The path.</param>
<returns>A <see cref="T:Cake.Core.IO.FilePath"/>.</returns>
</member>
<member name="M:Cake.Core.IO.FilePath.FromString(System.String)">
<summary>
Performs a conversion from <see cref="T:System.String"/> to <see cref="T:Cake.Core.IO.FilePath"/>.
</summary>
<param name="path">The path.</param>
<returns>A <see cref="T:Cake.Core.IO.FilePath"/>.</returns>
</member>
<member name="M:Cake.Core.IO.FilePath.GetRelativePath(Cake.Core.IO.DirectoryPath)">
<summary>
Get the relative path to another directory.
</summary>
<param name="to">The target directory path.</param>
<returns>A <see cref="T:Cake.Core.IO.DirectoryPath"/>.</returns>
</member>
<member name="M:Cake.Core.IO.FilePath.GetRelativePath(Cake.Core.IO.FilePath)">
<summary>
Get the relative path to another file.
</summary>
<param name="to">The target file path.</param>
<returns>A <see cref="T:Cake.Core.IO.FilePath"/>.</returns>
</member>
<member name="M:Cake.Core.IO.FilePath.Equals(Cake.Core.IO.FilePath)">
<summary>
Determines wheter two <see cref="T:Cake.Core.IO.FilePath"/> instances are equal.
</summary>
<param name="other">the <see cref="T:Cake.Core.IO.FilePath"/> to compare.</param>
<returns>True if other is equal to current object, False otherwise.</returns>
</member>
<member name="M:Cake.Core.IO.FilePath.Equals(System.Object)">
<summary>
Determines wheter two <see cref="T:Cake.Core.IO.FilePath"/> instances are equal.
</summary>
<param name="other">the <see cref="T:Cake.Core.IO.FilePath"/> to compare.</param>
<returns>True if other is equal to current object, False otherwise.</returns>
</member>
<member name="M:Cake.Core.IO.FilePath.op_Equality(Cake.Core.IO.FilePath,Cake.Core.IO.FilePath)">
<summary>
Determines wheter two <see cref="T:Cake.Core.IO.FilePath"/> instances are equal.
</summary>
<param name="filePath">left side <see cref="T:Cake.Core.IO.FilePath"/>.</param>
<param name="otherFilePath">right side <see cref="T:Cake.Core.IO.FilePath"/>.</param>
<returns>True if other is equal to current object, False otherwise.</returns>
</member>
<member name="M:Cake.Core.IO.FilePath.op_Inequality(Cake.Core.IO.FilePath,Cake.Core.IO.FilePath)">
<summary>
Determines wheter two <see cref="T:Cake.Core.IO.FilePath"/> instances are different.
</summary>
<param name="filePath">left side <see cref="T:Cake.Core.IO.FilePath"/>.</param>
<param name="otherFilePath">right side <see cref="T:Cake.Core.IO.FilePath"/>.</param>
<returns>True if other is equal to current object, False otherwise.</returns>
</member>
<member name="M:Cake.Core.IO.FilePath.GetHashCode">
<summary>
Returns the hash code for the <see cref="T:Cake.Core.IO.FilePath"/>.
</summary>
<returns>
A 32-bit signed integer hash code.
</returns>
</member>
<member name="M:Cake.Core.IO.FilePath.Compare(Cake.Core.IO.FilePath,Cake.Core.IO.FilePath)">
<summary>
Compares two FilePath and returns an indication of their relative sort order.
</summary>
<param name="x">The first <see cref="T:Cake.Core.IO.Path"/> to compare.</param>
<param name="y">The second <see cref="T:Cake.Core.IO.Path"/> to compare.</param>
<returns>A signed integer that indicates the relative values of x and y.
<list type="table">
<item>
<term>Less than zero</term>
<description>x precedes y in the sort order, or x is null and y is not null.</description>
</item>
<item>
<term>Zero</term>
<description>x is equal to y, or x and y are both null.</description>
</item>
<item>
<term>Greater than zero</term>
<description>
x follows y in the sort order, or y is null and x is not null.
</description>
</item>
</list>
</returns>
</member>
<member name="T:Cake.Core.IO.FilePathCollection">
<summary>
A collection of <see cref="T:Cake.Core.IO.FilePath"/>.
</summary>
</member>
<member name="P:Cake.Core.IO.FilePathCollection.Count">
<summary>
Gets the number of files in the collection.
</summary>
<value>The number of files in the collection.</value>
</member>
<member name="M:Cake.Core.IO.FilePathCollection.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.IO.FilePathCollection"/> class.
</summary>
</member>
<member name="M:Cake.Core.IO.FilePathCollection.#ctor(Cake.Core.IO.PathComparer)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.IO.FilePathCollection"/> class.
</summary>
<param name="comparer">The comparer.</param>
</member>
<member name="M:Cake.Core.IO.FilePathCollection.#ctor(System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath})">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.IO.FilePathCollection"/> class.
</summary>
<param name="paths">The paths.</param>
</member>
<member name="M:Cake.Core.IO.FilePathCollection.#ctor(System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath},Cake.Core.IO.PathComparer)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.IO.FilePathCollection"/> class.
</summary>
<param name="paths">The paths.</param>
<param name="comparer">The comparer.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="comparer"/> is <c>null</c>.</exception>
</member>
<member name="M:Cake.Core.IO.FilePathCollection.Add(Cake.Core.IO.FilePath)">
<summary>
Adds the specified path to the collection.
</summary>
<param name="path">The path to add.</param>
<returns>
<c>true</c> if the path was added; <c>false</c> if the path was already present.
</returns>
</member>
<member name="M:Cake.Core.IO.FilePathCollection.Add(System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath})">
<summary>
Adds the specified paths to the collection.
</summary>
<param name="paths">The paths to add.</param>
</member>
<member name="M:Cake.Core.IO.FilePathCollection.Remove(Cake.Core.IO.FilePath)">
<summary>
Removes the specified path from the collection.
</summary>
<param name="path">The path to remove.</param>
<returns>
<c>true</c> if the path was removed; <c>false</c> if the path was not found in the collection.
</returns>
</member>
<member name="M:Cake.Core.IO.FilePathCollection.Remove(System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath})">
<summary>
Removes the specified paths from the collection.
</summary>
<param name="paths">The paths to remove.</param>
</member>
<member name="M:Cake.Core.IO.FilePathCollection.op_Addition(Cake.Core.IO.FilePathCollection,Cake.Core.IO.FilePath)">
<summary>Adds a path to the collection.</summary>
<param name="collection">The collection.</param>
<param name="path">The path to add.</param>
<returns>A new <see cref="T:Cake.Core.IO.FilePathCollection"/> that contains the provided path as
well as the paths in the original collection.</returns>
</member>
<member name="M:Cake.Core.IO.FilePathCollection.op_Addition(Cake.Core.IO.FilePathCollection,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath})">
<summary>Adds multiple paths to the collection.</summary>
<param name="collection">The collection.</param>
<param name="paths">The paths to add.</param>
<returns>A new <see cref="T:Cake.Core.IO.FilePathCollection"/> with the content of both collections.</returns>
</member>
<member name="M:Cake.Core.IO.FilePathCollection.op_Subtraction(Cake.Core.IO.FilePathCollection,Cake.Core.IO.FilePath)">
<summary>
Removes a path from the collection.
</summary>
<param name="collection">The collection.</param>
<param name="path">The path to remove.</param>
<returns>A new <see cref="T:Cake.Core.IO.FilePathCollection"/> that do not contain the provided path.</returns>
</member>
<member name="M:Cake.Core.IO.FilePathCollection.op_Subtraction(Cake.Core.IO.FilePathCollection,System.Collections.Generic.IEnumerable{Cake.Core.IO.FilePath})">
<summary>
Removes multiple paths from the collection.
</summary>
<param name="collection">The collection.</param>
<param name="paths">The paths to remove.</param>
<returns>A new <see cref="T:Cake.Core.IO.FilePathCollection"/> that do not contain the provided paths.</returns>
</member>
<member name="M:Cake.Core.IO.FilePathCollection.GetEnumerator">
<summary>
Returns an enumerator that iterates through the collection.
</summary>
<returns>
A <see cref="T:System.Collections.Generic.IEnumerator`1" /> that can be used to iterate through the collection.
</returns>
</member>
<member name="M:Cake.Core.IO.FilePathCollection.System#Collections#IEnumerable#GetEnumerator">
<summary>
Returns an enumerator that iterates through a collection.
</summary>
<returns>
An <see cref="T:System.Collections.IEnumerator" /> that can be used to iterate through the collection.
</returns>
</member>
<member name="T:Cake.Core.IO.FilePathConverter">
<summary>
A type converter for <see cref="T:Cake.Core.IO.FilePath"/>.
</summary>
</member>
<member name="M:Cake.Core.IO.FilePathConverter.CanConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Type)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.IO.FilePathConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.IO.FilePathConverter.CanConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Type)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.IO.FilePathConverter.ConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object,System.Type)">
<inheritdoc/>
</member>
<member name="T:Cake.Core.IO.FileSystem">
<summary>
A physical file system implementation.
</summary>
</member>
<member name="M:Cake.Core.IO.FileSystem.GetFile(Cake.Core.IO.FilePath)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.IO.FileSystem.GetDirectory(Cake.Core.IO.DirectoryPath)">
<inheritdoc/>
</member>
<member name="T:Cake.Core.IO.FileSystemExtensions">
<summary>
Contains extensions for <see cref="T:Cake.Core.IO.IFileSystem"/>.
</summary>
</member>
<member name="M:Cake.Core.IO.FileSystemExtensions.Exist(Cake.Core.IO.IFileSystem,Cake.Core.IO.FilePath)">
<summary>
Determines if a specified <see cref="T:Cake.Core.IO.FilePath"/> exist.
</summary>
<param name="fileSystem">The file system.</param>
<param name="path">The path.</param>
<returns>Whether or not the specified file exist.</returns>
</member>
<member name="M:Cake.Core.IO.FileSystemExtensions.Exist(Cake.Core.IO.IFileSystem,Cake.Core.IO.DirectoryPath)">
<summary>
Determines if a specified <see cref="T:Cake.Core.IO.DirectoryPath"/> exist.
</summary>
<param name="fileSystem">The file system.</param>
<param name="path">The path.</param>
<returns>Whether or not the specified directory exist.</returns>
</member>
<member name="T:Cake.Core.IO.Globber">
<summary>
The file system globber.
</summary>
</member>
<member name="M:Cake.Core.IO.Globber.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.IO.Globber"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
</member>
<member name="M:Cake.Core.IO.Globber.Match(Cake.Core.IO.GlobPattern,Cake.Core.IO.GlobberSettings)">
<inheritdoc/>
</member>
<member name="T:Cake.Core.IO.GlobberExtensions">
<summary>
Contains extensions for <see cref="T:Cake.Core.IO.IGlobber"/>.
</summary>
</member>
<member name="M:Cake.Core.IO.GlobberExtensions.GetFiles(Cake.Core.IO.IGlobber,Cake.Core.IO.GlobPattern)">
<summary>
Gets all files matching the specified pattern.
</summary>
<param name="globber">The globber.</param>
<param name="pattern">The pattern.</param>
<returns>The files matching the specified pattern.</returns>
</member>
<member name="M:Cake.Core.IO.GlobberExtensions.GetDirectories(Cake.Core.IO.IGlobber,Cake.Core.IO.GlobPattern)">
<summary>
Gets all directories matching the specified pattern.
</summary>
<param name="globber">The globber.</param>
<param name="pattern">The pattern.</param>
<returns>The directories matching the specified pattern.</returns>
</member>
<member name="M:Cake.Core.IO.GlobberExtensions.Match(Cake.Core.IO.IGlobber,Cake.Core.IO.GlobPattern)">
<summary>
Returns <see cref="T:Cake.Core.IO.Path" /> instances matching the specified pattern.
</summary>
<param name="globber">The globber.</param>
<param name="pattern">The pattern to match.</param>
<returns>
<see cref="T:Cake.Core.IO.Path" /> instances matching the specified pattern.
</returns>
</member>
<member name="M:Cake.Core.IO.GlobberExtensions.GetFiles(Cake.Core.IO.IGlobber,System.String)">
<summary>
Gets all files matching the specified pattern.
</summary>
<param name="globber">The globber.</param>
<param name="pattern">The pattern.</param>
<returns>The files matching the specified pattern.</returns>
</member>
<member name="M:Cake.Core.IO.GlobberExtensions.GetDirectories(Cake.Core.IO.IGlobber,System.String)">
<summary>
Gets all directories matching the specified pattern.
</summary>
<param name="globber">The globber.</param>
<param name="pattern">The pattern.</param>
<returns>The directories matching the specified pattern.</returns>
</member>
<member name="M:Cake.Core.IO.GlobberExtensions.Match(Cake.Core.IO.IGlobber,System.String)">
<summary>
Returns <see cref="T:Cake.Core.IO.Path" /> instances matching the specified pattern.
</summary>
<param name="globber">The globber.</param>
<param name="pattern">The pattern to match.</param>
<returns>
<see cref="T:Cake.Core.IO.Path" /> instances matching the specified pattern.
</returns>
</member>
<member name="T:Cake.Core.IO.GlobberSettings">
<summary>
Contains settings used by the globber.
</summary>
</member>
<member name="P:Cake.Core.IO.GlobberSettings.Predicate">
<summary>
Gets or sets the predicate used to filter directories based on file system information.
</summary>
</member>
<member name="P:Cake.Core.IO.GlobberSettings.FilePredicate">
<summary>
Gets or sets the filter used to filter files based on file system information.
</summary>
</member>
<member name="P:Cake.Core.IO.GlobberSettings.IsCaseSensitive">
<summary>
Gets or sets whether or not globbing is case sensitive or not.
If not set, the default value for the operating system will be used.
</summary>
</member>
<member name="T:Cake.Core.IO.GlobPattern">
<summary>
The file system globber pattern.
</summary>
</member>
<member name="P:Cake.Core.IO.GlobPattern.Pattern">
<summary>
Gets the the globber pattern.
</summary>
</member>
<member name="M:Cake.Core.IO.GlobPattern.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.IO.GlobPattern"/> class.
</summary>
<param name="pattern">The globber pattern.</param>
</member>
<member name="M:Cake.Core.IO.GlobPattern.op_Implicit(System.String)~Cake.Core.IO.GlobPattern">
<summary>
Performs an implicit conversion from <see cref="T:System.String"/> to <see cref="T:Cake.Core.IO.GlobPattern"/>.
</summary>
<param name="pattern">The string pattern.</param>
<returns>A <see cref="T:Cake.Core.IO.GlobPattern"/>.</returns>
</member>
<member name="M:Cake.Core.IO.GlobPattern.op_Implicit(Cake.Core.IO.GlobPattern)~System.String">
<summary>
Performs an implicit conversion from <see cref="T:Cake.Core.IO.GlobPattern"/> to <see cref="T:System.String"/>.
</summary>
<param name="pattern">The glob pattern.</param>
<returns>A <see cref="T:Cake.Core.IO.GlobPattern"/>.</returns>
</member>
<member name="M:Cake.Core.IO.GlobPattern.FromString(System.String)">
<summary>
Performs a conversion from <see cref="T:System.String"/> to <see cref="T:Cake.Core.IO.GlobPattern"/>.
</summary>
<param name="pattern">The pattern.</param>
<returns>A <see cref="T:Cake.Core.IO.GlobPattern"/>.</returns>
</member>
<member name="M:Cake.Core.IO.GlobPattern.Equals(System.Object)">
<summary>
Determines whether two <see cref="T:Cake.Core.IO.GlobPattern"/>. instances are equal.
</summary>
<param name="obj">The object to compare with the current object.</param>
<returns>
<c>true</c> if the specified object is equal to the current object; otherwise, <c>false</c>.
</returns>
</member>
<member name="M:Cake.Core.IO.GlobPattern.GetHashCode">
<summary>
Returns the hash code for the <see cref="T:Cake.Core.IO.GlobPattern"/>.
</summary>
<returns>
A 32-bit signed integer hash code.
</returns>
</member>
<member name="M:Cake.Core.IO.GlobPattern.ToString">
<summary>
Returns a <see cref="T:System.String" /> that represents this instance.
</summary>
<returns>
A <see cref="T:System.String" /> that represents this instance.
</returns>
</member>
<member name="T:Cake.Core.IO.IDirectory">
<summary>
Represents a directory.
</summary>
</member>
<member name="P:Cake.Core.IO.IDirectory.Path">
<summary>
Gets the path to the directory.
</summary>
<value>The path.</value>
</member>
<member name="M:Cake.Core.IO.IDirectory.Create">
<summary>
Creates the directory.
</summary>
</member>
<member name="M:Cake.Core.IO.IDirectory.Move(Cake.Core.IO.DirectoryPath)">
<summary>
Moves the directory to the specified destination path.
</summary>
<param name="destination">The destination path.</param>
</member>
<member name="M:Cake.Core.IO.IDirectory.Delete(System.Boolean)">
<summary>
Deletes the directory.
</summary>
<param name="recursive">Will perform a recursive delete if set to <c>true</c>.</param>
</member>
<member name="M:Cake.Core.IO.IDirectory.GetDirectories(System.String,Cake.Core.IO.SearchScope)">
<summary>
Gets directories matching the specified filter and scope.
</summary>
<param name="filter">The filter.</param>
<param name="scope">The search scope.</param>
<returns>Directories matching the filter and scope.</returns>
</member>
<member name="M:Cake.Core.IO.IDirectory.GetFiles(System.String,Cake.Core.IO.SearchScope)">
<summary>
Gets files matching the specified filter and scope.
</summary>
<param name="filter">The filter.</param>
<param name="scope">The search scope.</param>
<returns>Files matching the specified filter and scope.</returns>
</member>
<member name="T:Cake.Core.IO.IFile">
<summary>
Represents a file.
</summary>
</member>
<member name="P:Cake.Core.IO.IFile.Path">
<summary>
Gets the path to the file.
</summary>
<value>The path.</value>
</member>
<member name="P:Cake.Core.IO.IFile.Length">
<summary>
Gets the length of the file.
</summary>
<value>The length of the file.</value>
</member>
<member name="P:Cake.Core.IO.IFile.Attributes">
<summary>
Gets or sets the file attributes.
</summary>
<value>The file attributes.</value>
</member>
<member name="M:Cake.Core.IO.IFile.Copy(Cake.Core.IO.FilePath,System.Boolean)">
<summary>
Copies the file to the specified destination path.
</summary>
<param name="destination">The destination path.</param>
<param name="overwrite">Will overwrite existing destination file if set to <c>true</c>.</param>
</member>
<member name="M:Cake.Core.IO.IFile.Move(Cake.Core.IO.FilePath)">
<summary>
Moves the file to the specified destination path.
</summary>
<param name="destination">The destination path.</param>
</member>
<member name="M:Cake.Core.IO.IFile.Delete">
<summary>
Deletes the file.
</summary>
</member>
<member name="M:Cake.Core.IO.IFile.Open(System.IO.FileMode,System.IO.FileAccess,System.IO.FileShare)">
<summary>
Opens the file using the specified options.
</summary>
<param name="fileMode">The file mode.</param>
<param name="fileAccess">The file access.</param>
<param name="fileShare">The file share.</param>
<returns>A <see cref="T:System.IO.Stream"/> to the file.</returns>
</member>
<member name="T:Cake.Core.IO.IFileSystem">
<summary>
Represents a file system.
</summary>
</member>
<member name="M:Cake.Core.IO.IFileSystem.GetFile(Cake.Core.IO.FilePath)">
<summary>
Gets a <see cref="T:Cake.Core.IO.IFile"/> instance representing the specified path.
</summary>
<param name="path">The path.</param>
<returns>A <see cref="T:Cake.Core.IO.IFile"/> instance representing the specified path.</returns>
</member>
<member name="M:Cake.Core.IO.IFileSystem.GetDirectory(Cake.Core.IO.DirectoryPath)">
<summary>
Gets a <see cref="T:Cake.Core.IO.IDirectory"/> instance representing the specified path.
</summary>
<param name="path">The path.</param>
<returns>A <see cref="T:Cake.Core.IO.IDirectory"/> instance representing the specified path.</returns>
</member>
<member name="T:Cake.Core.IO.IFileSystemInfo">
<summary>
Represents an entry in the file system.
</summary>
</member>
<member name="P:Cake.Core.IO.IFileSystemInfo.Path">
<summary>
Gets the path to the entry.
</summary>
<value>The path.</value>
</member>
<member name="P:Cake.Core.IO.IFileSystemInfo.Exists">
<summary>
Gets a value indicating whether this <see cref="T:Cake.Core.IO.IFileSystemInfo"/> exists.
</summary>
<value>
<c>true</c> if the entry exists; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Core.IO.IFileSystemInfo.Hidden">
<summary>
Gets a value indicating whether this <see cref="T:Cake.Core.IO.IFileSystemInfo"/> is hidden.
</summary>
<value>
<c>true</c> if the entry is hidden; otherwise, <c>false</c>.
</value>
</member>
<member name="T:Cake.Core.IO.IGlobber">
<summary>
Represents a file system globber.
</summary>
</member>
<member name="M:Cake.Core.IO.IGlobber.Match(Cake.Core.IO.GlobPattern,Cake.Core.IO.GlobberSettings)">
<summary>
Returns <see cref="T:Cake.Core.IO.Path" /> instances matching the specified pattern.
</summary>
<param name="pattern">The pattern to match.</param>
<param name="settings">The globber settings.</param>
<returns>
<see cref="T:Cake.Core.IO.Path" /> instances matching the specified pattern.
</returns>
</member>
<member name="T:Cake.Core.IO.IPath`1">
<summary>
Represents a path.
</summary>
<typeparam name="T">The path type.</typeparam>
</member>
<member name="P:Cake.Core.IO.IPath`1.FullPath">
<summary>
Gets the full path.
</summary>
<value>The full path.</value>
</member>
<member name="P:Cake.Core.IO.IPath`1.IsRelative">
<summary>
Gets a value indicating whether or not this path is relative.
</summary>
<value>
<c>true</c> if this path is relative; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Core.IO.IPath`1.IsUNC">
<summary>
Gets a value indicating whether or not this path is an UNC path.
</summary>
<value>
<c>true</c> if this path is an UNC path; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Core.IO.IPath`1.Separator">
<summary>
Gets the separator this path was normalized with.
</summary>
</member>
<member name="P:Cake.Core.IO.IPath`1.Segments">
<summary>
Gets the segments making up the path.
</summary>
<value>The segments making up the path.</value>
</member>
<member name="M:Cake.Core.IO.IPath`1.ToString">
<summary>
Returns a <see cref="T:System.String" /> that represents this path.
</summary>
<returns>
A <see cref="T:System.String" /> that represents this instance.
</returns>
</member>
<member name="M:Cake.Core.IO.IPath`1.MakeAbsolute(Cake.Core.ICakeEnvironment)">
<summary>
Makes the {T} path absolute (if relative) using the current working directory.
</summary>
<param name="environment">The environment.</param>
<returns>An absolute path.</returns>
</member>
<member name="M:Cake.Core.IO.IPath`1.MakeAbsolute(Cake.Core.IO.DirectoryPath)">
<summary>
Makes the path absolute (if relative) using the specified directory path.
</summary>
<param name="path">The path.</param>
<returns>An absolute path.</returns>
</member>
<member name="M:Cake.Core.IO.IPath`1.Collapse">
<summary>
Collapses a path containing ellipses.
</summary>
<returns>A collapsed path.</returns>
</member>
<member name="M:Cake.Core.IO.IPath`1.GetRelativePath(`0)">
<summary>
Get the relative path to another path.
</summary>
<param name="to">The target path.</param>
<returns>A path.</returns>
</member>
<member name="T:Cake.Core.IO.IProcess">
<summary>
Represents a process.
</summary>
</member>
<member name="M:Cake.Core.IO.IProcess.WaitForExit">
<summary>
Waits for the process to exit.
</summary>
</member>
<member name="M:Cake.Core.IO.IProcess.WaitForExit(System.Int32)">
<summary>
Waits for the process to exit with possible timeout for command.
</summary>
<param name="milliseconds">The amount of time, in milliseconds, to wait for the associated process to exit. The maximum is the largest possible value of a 32-bit integer, which represents infinity to the operating system.</param>
<returns>true if the associated process has exited; otherwise, false.</returns>
</member>
<member name="M:Cake.Core.IO.IProcess.GetExitCode">
<summary>
Gets the exit code of the process.
</summary>
<returns>The exit code of the process.</returns>
</member>
<member name="M:Cake.Core.IO.IProcess.GetStandardError">
<summary>
Get the standard error of process.
</summary>
<returns>Returns process error output if <see cref="P:Cake.Core.IO.ProcessSettings.RedirectStandardError">RedirectStandardError</see> is true.</returns>
</member>
<member name="M:Cake.Core.IO.IProcess.GetStandardOutput">
<summary>
Get the standard output of process.
</summary>
<returns>Returns process output if <see cref="P:Cake.Core.IO.ProcessSettings.RedirectStandardOutput">RedirectStandardOutput</see> is true.</returns>
</member>
<member name="M:Cake.Core.IO.IProcess.Kill">
<summary>
Immediately stops the associated process.
</summary>
</member>
<member name="T:Cake.Core.IO.IProcessArgument">
<summary>
Represents a process argument.
</summary>
</member>
<member name="M:Cake.Core.IO.IProcessArgument.Render">
<summary>
Render the arguments as a <see cref="T:System.String"/>.
Sensitive information will be included.
</summary>
<returns>A string representation of the argument.</returns>
</member>
<member name="M:Cake.Core.IO.IProcessArgument.RenderSafe">
<summary>
Renders the argument as a <see cref="T:System.String"/>.
Sensitive information will be redacted.
</summary>
<returns>A safe string representation of the argument.</returns>
</member>
<member name="T:Cake.Core.IO.IProcessRunner">
<summary>
Represents a process runner.
</summary>
</member>
<member name="M:Cake.Core.IO.IProcessRunner.Start(Cake.Core.IO.FilePath,Cake.Core.IO.ProcessSettings)">
<summary>
Starts a process using the specified information.
</summary>
<param name="filePath">The file name such as an application or document with which to start the process.</param>
<param name="settings">The information about the process to start.</param>
<returns>A process handle.</returns>
</member>
<member name="T:Cake.Core.IO.IRegistry">
<summary>
Represents the Windows registry.
</summary>
</member>
<member name="P:Cake.Core.IO.IRegistry.CurrentUser">
<summary>
Gets a registry key representing HKEY_CURRENT_USER.
</summary>
<value>
A registry key representing HKEY_CURRENT_USER.
</value>
</member>
<member name="P:Cake.Core.IO.IRegistry.LocalMachine">
<summary>
Gets a registry key representing HKEY_LOCAL_MACHINE.
</summary>
<value>
A registry key representing HKEY_LOCAL_MACHINE.
</value>
</member>
<member name="P:Cake.Core.IO.IRegistry.ClassesRoot">
<summary>
Gets a registry key representing HKEY_CLASSES_ROOT.
</summary>
<value>
A registry key representing HKEY_CLASSES_ROOT.
</value>
</member>
<member name="P:Cake.Core.IO.IRegistry.Users">
<summary>
Gets a registry key representing HKEY_USERS.
</summary>
<value>
A registry key representing HKEY_USERS.
</value>
</member>
<member name="P:Cake.Core.IO.IRegistry.PerformanceData">
<summary>
Gets a registry key representing HKEY_PERFORMANCE_DATA.
</summary>
<value>
A registry key representing HKEY_PERFORMANCE_DATA.
</value>
</member>
<member name="P:Cake.Core.IO.IRegistry.CurrentConfig">
<summary>
Gets a registry key representing HKEY_CURRENT_CONFIG.
</summary>
<value>
A registry key representing HKEY_CURRENT_CONFIG.
</value>
</member>
<member name="T:Cake.Core.IO.IRegistryKey">
<summary>
Represents a Windows registry key.
</summary>
</member>
<member name="M:Cake.Core.IO.IRegistryKey.GetSubKeyNames">
<summary>
Gets all sub keys.
</summary>
<returns>All sub keys.</returns>
</member>
<member name="M:Cake.Core.IO.IRegistryKey.OpenKey(System.String)">
<summary>
Opens the sub key with the specified name.
</summary>
<param name="name">The name of the key.</param>
<returns>The sub key with the specified name.</returns>
</member>
<member name="M:Cake.Core.IO.IRegistryKey.GetValue(System.String)">
<summary>
Gets the value of the key.
</summary>
<param name="name">The name of the key.</param>
<returns>The value of the key.</returns>
</member>
<member name="T:Cake.Core.IO.NuGet.INuGetToolResolver">
<summary>
Represents a NuGet path resolver.
</summary>
</member>
<member name="M:Cake.Core.IO.NuGet.INuGetToolResolver.ResolvePath">
<summary>
Resolves the path to nuget.exe.
</summary>
<returns>The path to nuget.exe.</returns>
</member>
<member name="T:Cake.Core.IO.NuGet.NuGetToolResolver">
<summary>
Contains NuGet path resolver functionality.
</summary>
</member>
<member name="M:Cake.Core.IO.NuGet.NuGetToolResolver.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.IO.NuGet.NuGetToolResolver" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Core.IO.NuGet.NuGetToolResolver.ResolvePath">
<inheritdoc/>
</member>
<member name="T:Cake.Core.IO.NuGet.NamespaceDoc">
<summary>
This namespace contain types
related to NuGet functionality.
</summary>
</member>
<member name="T:Cake.Core.IO.Path">
<summary>
Provides properties and instance methods for working with paths.
This class must be inherited.
</summary>
</member>
<member name="P:Cake.Core.IO.Path.FullPath">
<summary>
Gets the full path.
</summary>
<value>The full path.</value>
</member>
<member name="P:Cake.Core.IO.Path.IsRelative">
<summary>
Gets a value indicating whether or not this path is relative.
</summary>
<value>
<c>true</c> if this path is relative; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Core.IO.Path.IsUNC">
<summary>
Gets a value indicating whether or not this path is an UNC path.
</summary>
<value>
<c>true</c> if this path is an UNC path; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Core.IO.Path.Separator">
<summary>
Gets the separator this path was normalized with.
</summary>
</member>
<member name="P:Cake.Core.IO.Path.Segments">
<summary>
Gets the segments making up the path.
</summary>
<value>The segments making up the path.</value>
</member>
<member name="M:Cake.Core.IO.Path.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.IO.Path"/> class.
</summary>
<param name="path">The path.</param>
</member>
<member name="M:Cake.Core.IO.Path.ToString">
<summary>
Returns a <see cref="T:System.String" /> that represents this path.
</summary>
<returns>
A <see cref="T:System.String" /> that represents this instance.
</returns>
</member>
<member name="T:Cake.Core.IO.PathCollection">
<summary>
A collection of <see cref="T:Cake.Core.IO.Path"/>.
</summary>
</member>
<member name="P:Cake.Core.IO.PathCollection.Count">
<summary>
Gets the number of paths in the collection.
</summary>
<value>The number of paths in the collection.</value>
</member>
<member name="M:Cake.Core.IO.PathCollection.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.IO.PathCollection"/> class.
</summary>
</member>
<member name="M:Cake.Core.IO.PathCollection.#ctor(Cake.Core.IO.PathComparer)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.IO.PathCollection"/> class.
</summary>
<param name="comparer">The comparer.</param>
</member>
<member name="M:Cake.Core.IO.PathCollection.#ctor(System.Collections.Generic.IEnumerable{Cake.Core.IO.Path})">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.IO.PathCollection"/> class.
</summary>
<param name="paths">The paths.</param>
</member>
<member name="M:Cake.Core.IO.PathCollection.#ctor(System.Collections.Generic.IEnumerable{Cake.Core.IO.Path},Cake.Core.IO.PathComparer)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.IO.PathCollection"/> class.
</summary>
<param name="paths">The paths.</param>
<param name="comparer">The comparer.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="comparer"/> is <c>null</c>.</exception>
</member>
<member name="M:Cake.Core.IO.PathCollection.Add(Cake.Core.IO.Path)">
<summary>
Adds the specified path to the collection.
</summary>
<param name="path">The path to add.</param>
<returns>
<c>true</c> if the path was added; <c>false</c> if the path was already present.
</returns>
</member>
<member name="M:Cake.Core.IO.PathCollection.Add(System.Collections.Generic.IEnumerable{Cake.Core.IO.Path})">
<summary>
Adds the specified paths to the collection.
</summary>
<param name="paths">The paths to add.</param>
</member>
<member name="M:Cake.Core.IO.PathCollection.Remove(Cake.Core.IO.Path)">
<summary>
Removes the specified path from the collection.
</summary>
<param name="path">The path to remove.</param>
<returns>
<c>true</c> if the path was removed; <c>false</c> if the path was not found in the collection.
</returns>
</member>
<member name="M:Cake.Core.IO.PathCollection.Remove(System.Collections.Generic.IEnumerable{Cake.Core.IO.Path})">
<summary>
Removes the specified paths from the collection.
</summary>
<param name="paths">The paths to remove.</param>
</member>
<member name="M:Cake.Core.IO.PathCollection.op_Addition(Cake.Core.IO.PathCollection,Cake.Core.IO.Path)">
<summary>Adds a path to the collection.</summary>
<param name="collection">The collection.</param>
<param name="path">The path to add.</param>
<returns>A new <see cref="T:Cake.Core.IO.PathCollection"/> that contains the provided path as
well as the paths in the original collection.</returns>
</member>
<member name="M:Cake.Core.IO.PathCollection.op_Addition(Cake.Core.IO.PathCollection,System.Collections.Generic.IEnumerable{Cake.Core.IO.Path})">
<summary>Adds multiple paths to the collection.</summary>
<param name="collection">The collection.</param>
<param name="paths">The paths to add.</param>
<returns>A new <see cref="T:Cake.Core.IO.PathCollection"/> with the content of both collections.</returns>
</member>
<member name="M:Cake.Core.IO.PathCollection.op_Subtraction(Cake.Core.IO.PathCollection,Cake.Core.IO.Path)">
<summary>
Removes a path from the collection.
</summary>
<param name="collection">The collection.</param>
<param name="path">The path to remove.</param>
<returns>A new <see cref="T:Cake.Core.IO.PathCollection"/> that do not contain the provided path.</returns>
</member>
<member name="M:Cake.Core.IO.PathCollection.op_Subtraction(Cake.Core.IO.PathCollection,System.Collections.Generic.IEnumerable{Cake.Core.IO.Path})">
<summary>
Removes multiple paths from the collection.
</summary>
<param name="collection">The collection.</param>
<param name="paths">The paths to remove.</param>
<returns>A new <see cref="T:Cake.Core.IO.PathCollection"/> that do not contain the provided paths.</returns>
</member>
<member name="M:Cake.Core.IO.PathCollection.GetEnumerator">
<summary>
Returns an enumerator that iterates through the collection.
</summary>
<returns>
A <see cref="T:System.Collections.Generic.IEnumerator`1" /> that can be used to iterate through the collection.
</returns>
</member>
<member name="M:Cake.Core.IO.PathCollection.System#Collections#IEnumerable#GetEnumerator">
<summary>
Returns an enumerator that iterates through a collection.
</summary>
<returns>
An <see cref="T:System.Collections.IEnumerator" /> that can be used to iterate through the collection.
</returns>
</member>
<member name="T:Cake.Core.IO.PathComparer">
<summary>
Compares <see cref="T:Cake.Core.IO.Path"/> instances.
</summary>
</member>
<member name="F:Cake.Core.IO.PathComparer.Default">
<summary>
The default path comparer.
</summary>
</member>
<member name="P:Cake.Core.IO.PathComparer.IsCaseSensitive">
<summary>
Gets a value indicating whether comparison is case sensitive.
</summary>
<value>
<c>true</c> if comparison is case sensitive; otherwise, <c>false</c>.
</value>
</member>
<member name="M:Cake.Core.IO.PathComparer.#ctor(System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.IO.PathComparer"/> class.
</summary>
<param name="isCaseSensitive">if set to <c>true</c>, comparison is case sensitive.</param>
</member>
<member name="M:Cake.Core.IO.PathComparer.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.IO.PathComparer"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="M:Cake.Core.IO.PathComparer.Equals(Cake.Core.IO.Path,Cake.Core.IO.Path)">
<summary>
Determines whether the specified <see cref="T:Cake.Core.IO.Path"/> instances are equal.
</summary>
<param name="x">The first <see cref="T:Cake.Core.IO.Path"/> to compare.</param>
<param name="y">The second <see cref="T:Cake.Core.IO.Path"/> to compare.</param>
<returns>
True if the specified <see cref="T:Cake.Core.IO.Path"/> instances are equal; otherwise, false.
</returns>
</member>
<member name="M:Cake.Core.IO.PathComparer.GetHashCode(Cake.Core.IO.Path)">
<summary>
Returns a hash code for the specified <see cref="T:Cake.Core.IO.Path"/>.
</summary>
<param name="obj">The path.</param>
<returns>
A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
</returns>
</member>
<member name="M:Cake.Core.IO.PathComparer.Compare(Cake.Core.IO.Path,Cake.Core.IO.Path)">
<summary>
Compares two Paths and returns an indication of their relative sort order.
</summary>
<param name="x">The first <see cref="T:Cake.Core.IO.Path"/> to compare.</param>
<param name="y">The second <see cref="T:Cake.Core.IO.Path"/> to compare.</param>
<returns>A signed integer that indicates the relative values of x and y.
<list type="table">
<item>
<term>Less than zero</term>
<description>x precedes y in the sort order, or x is null and y is not null.</description>
</item>
<item>
<term>Zero</term>
<description>x is equal to y, or x and y are both null.</description>
</item>
<item>
<term>Greater than zero</term>
<description>
x follows y in the sort order, or y is null and x is not null.
</description>
</item>
</list>
</returns>
</member>
<member name="T:Cake.Core.IO.PathExtensions">
<summary>
Contains extensions for <see cref="T:Cake.Core.IO.FilePath"/> and <see cref="T:Cake.Core.IO.DirectoryPath"/>.
</summary>
</member>
<member name="M:Cake.Core.IO.PathExtensions.ExpandEnvironmentVariables(Cake.Core.IO.FilePath,Cake.Core.ICakeEnvironment)">
<summary>
Expands all environment variables in the provided <see cref="T:Cake.Core.IO.FilePath"/>.
</summary>
<example>
<code>
var path = new FilePath("%APPDATA%/foo.bar");
var expanded = path.ExpandEnvironmentVariables(environment);
</code>
</example>
<param name="path">The file path to expand.</param>
<param name="environment">The environment.</param>
<returns>A new <see cref="T:Cake.Core.IO.FilePath"/> with each environment variable replaced by its value.</returns>
</member>
<member name="M:Cake.Core.IO.PathExtensions.ExpandEnvironmentVariables(Cake.Core.IO.DirectoryPath,Cake.Core.ICakeEnvironment)">
<summary>
Expands all environment variables in the provided <see cref="T:Cake.Core.IO.DirectoryPath"/>.
</summary>
<example>
<code>
var path = new DirectoryPath("%APPDATA%");
var expanded = path.ExpandEnvironmentVariables(environment);
</code>
</example>
<param name="path">The directory to expand.</param>
<param name="environment">The environment.</param>
<returns>A new <see cref="T:Cake.Core.IO.DirectoryPath"/> with each environment variable replaced by its value.</returns>
</member>
<member name="T:Cake.Core.IO.ProcessArgumentBuilder">
<summary>
Utility for building process arguments.
</summary>
</member>
<member name="P:Cake.Core.IO.ProcessArgumentBuilder.Count">
<summary>
Gets the number of arguments contained in the <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/>.
</summary>
</member>
<member name="M:Cake.Core.IO.ProcessArgumentBuilder.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/> class.
</summary>
</member>
<member name="M:Cake.Core.IO.ProcessArgumentBuilder.Clear">
<summary>
Clears all arguments from the builder.
</summary>
</member>
<member name="M:Cake.Core.IO.ProcessArgumentBuilder.Append(Cake.Core.IO.IProcessArgument)">
<summary>
Appends an argument.
</summary>
<param name="argument">The argument.</param>
</member>
<member name="M:Cake.Core.IO.ProcessArgumentBuilder.Prepend(Cake.Core.IO.IProcessArgument)">
<summary>
Prepends an argument.
</summary>
<param name="argument">The argument.</param>
</member>
<member name="M:Cake.Core.IO.ProcessArgumentBuilder.AppendRange(System.Collections.Generic.IEnumerable{Cake.Core.IO.IProcessArgument})">
<summary>
Appends arguments.
</summary>
<param name="arguments">The arguments.</param>
</member>
<member name="M:Cake.Core.IO.ProcessArgumentBuilder.PrependRange(System.Collections.Generic.IEnumerable{Cake.Core.IO.IProcessArgument})">
<summary>
Prepends arguments.
</summary>
<param name="arguments">The arguments.</param>
</member>
<member name="M:Cake.Core.IO.ProcessArgumentBuilder.Render">
<summary>
Renders the arguments as a <see cref="T:System.String"/>.
Sensitive information will be included.
</summary>
<returns>A string representation of the arguments.</returns>
</member>
<member name="M:Cake.Core.IO.ProcessArgumentBuilder.RenderSafe">
<summary>
Renders the arguments as a <see cref="T:System.String"/>.
Sensitive information will be redacted.
</summary>
<returns>A safe string representation of the arguments.</returns>
</member>
<member name="M:Cake.Core.IO.ProcessArgumentBuilder.FilterUnsafe(System.String)">
<summary>
Tries to filer any unsafe arguments from string.
</summary>
<param name="source">unsafe source string.</param>
<returns>Filtered string.</returns>
</member>
<member name="M:Cake.Core.IO.ProcessArgumentBuilder.op_Implicit(System.String)~Cake.Core.IO.ProcessArgumentBuilder">
<summary>
Performs an implicit conversion from <see cref="T:System.String"/> to <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/>.
</summary>
<param name="value">The text value to convert.</param>
<returns>A <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/>.</returns>
</member>
<member name="M:Cake.Core.IO.ProcessArgumentBuilder.FromString(System.String)">
<summary>
Performs a conversion from <see cref="T:System.String"/> to <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/>.
</summary>
<param name="value">The text value to convert.</param>
<returns>A <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/>.</returns>
</member>
<member name="M:Cake.Core.IO.ProcessArgumentBuilder.FromStringQuoted(System.String)">
<summary>
Performs a conversion from <see cref="T:System.String"/> to <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/>.
</summary>
<param name="value">The text value to convert.</param>
<returns>A <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/>.</returns>
</member>
<member name="M:Cake.Core.IO.ProcessArgumentBuilder.FromStrings(System.Collections.Generic.IEnumerable{System.String})">
<summary>
Performs a conversion from <see cref="T:System.Collections.Generic.IEnumerable`1"/> to <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/>.
</summary>
<param name="values">The text values to convert.</param>
<returns>A <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/>.</returns>
</member>
<member name="M:Cake.Core.IO.ProcessArgumentBuilder.FromStringsQuoted(System.Collections.Generic.IEnumerable{System.String})">
<summary>
Performs a conversion from <see cref="T:System.Collections.Generic.IEnumerable`1"/> to <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/>.
</summary>
<param name="values">The text values to convert.</param>
<returns>A <see cref="T:Cake.Core.IO.ProcessArgumentBuilder"/>.</returns>
</member>
<member name="M:Cake.Core.IO.ProcessArgumentBuilder.System#Collections#Generic#IEnumerable{Cake#Core#IO#IProcessArgument}#GetEnumerator">
<summary>
Returns an enumerator that iterates through the collection.
</summary>
<returns>
An enumerator that can be used to iterate through the collection.
</returns>
</member>
<member name="M:Cake.Core.IO.ProcessArgumentBuilder.System#Collections#IEnumerable#GetEnumerator">
<summary>
Returns an enumerator that iterates through a collection.
</summary>
<returns>
An <see cref="T:System.Collections.IEnumerator" /> that can be used to iterate through the collection.
</returns>
</member>
<member name="T:Cake.Core.IO.ProcessRunner">
<summary>
Responsible for starting processes.
</summary>
</member>
<member name="M:Cake.Core.IO.ProcessRunner.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.Diagnostics.ICakeLog,Cake.Core.Tooling.IToolLocator,Cake.Core.Configuration.ICakeConfiguration)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.IO.ProcessRunner" /> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="log">The log.</param>
<param name="tools">The tool locator.</param>
<param name="configuration">The tool configuration.</param>
</member>
<member name="M:Cake.Core.IO.ProcessRunner.Start(Cake.Core.IO.FilePath,Cake.Core.IO.ProcessSettings)">
<inheritdoc/>
</member>
<member name="T:Cake.Core.IO.ProcessSettings">
<summary>
Specifies a set of values that are used to start a process.
</summary>
</member>
<member name="P:Cake.Core.IO.ProcessSettings.Arguments">
<summary>
Gets or sets the set of command-line arguments to use when starting the application.
</summary>
<value>The set of command-line arguments to use when starting the application.</value>
</member>
<member name="P:Cake.Core.IO.ProcessSettings.WorkingDirectory">
<summary>
Gets or sets the working directory for the process to be started.
</summary>
<value>The working directory for the process to be started.</value>
</member>
<member name="P:Cake.Core.IO.ProcessSettings.NoWorkingDirectory">
<summary>
Gets or sets a value indicating whether or not to opt out of using
an explicit working directory for the process.
</summary>
</member>
<member name="P:Cake.Core.IO.ProcessSettings.RedirectStandardError">
<summary>
Gets or sets a value indicating whether the error output of an application is written to the standard error stream.
</summary>
<value>true if error output should be redirected; false if error output should be written to the standard error stream. The default is false.</value>
</member>
<member name="P:Cake.Core.IO.ProcessSettings.RedirectStandardOutput">
<summary>
Gets or sets a value indicating whether the output of an application is written to the standard output stream.
</summary>
<value>true if output should be redirected; false if output should be written to the standard output stream. The default is false.</value>
</member>
<member name="P:Cake.Core.IO.ProcessSettings.RedirectedStandardErrorHandler">
<summary>
Gets or sets a function that intercepts the error output before being redirected. Use in conjunction with <see cref="P:Cake.Core.IO.ProcessSettings.RedirectStandardError"/>.
</summary>
</member>
<member name="P:Cake.Core.IO.ProcessSettings.RedirectedStandardOutputHandler">
<summary>
Gets or sets a function that intercepts the standard output before being redirected. Use in conjunction with <see cref="P:Cake.Core.IO.ProcessSettings.RedirectStandardOutput"/>.
</summary>
</member>
<member name="P:Cake.Core.IO.ProcessSettings.Timeout">
<summary>
Gets or sets optional timeout, in milliseconds, to wait for the associated process to exit. The maximum is the largest possible value of a 32-bit integer, which represents infinity to the operating system.
</summary>
</member>
<member name="P:Cake.Core.IO.ProcessSettings.Silent">
<summary>
Gets or sets a value indicating whether process output will be suppressed.
</summary>
<value>
<c>true</c> if process output will be suppressed; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Core.IO.ProcessSettings.EnvironmentVariables">
<summary>
Gets or sets search paths for files, directories for temporary files, application-specific options, and other similar information.
</summary>
<example>
<code>
StartProcess("cmd", new ProcessSettings{
Arguments = "/c set",
EnvironmentVariables = new Dictionary<string, string>{
{ "CI", "True" },
{ "TEMP", MakeAbsolute(Directory("./Temp")).FullPath }
}
});
</code>
</example>
</member>
<member name="T:Cake.Core.IO.SearchScope">
<summary>
Represents a search scope.
</summary>
</member>
<member name="F:Cake.Core.IO.SearchScope.Current">
<summary>
The current directory.
</summary>
</member>
<member name="F:Cake.Core.IO.SearchScope.Recursive">
<summary>
The current directory and child directories.
</summary>
</member>
<member name="T:Cake.Core.IO.SpecialPath">
<summary>
Represents a special path.
</summary>
</member>
<member name="F:Cake.Core.IO.SpecialPath.ApplicationData">
<summary>
The directory that serves as a common repository for application-specific
data for the current roaming user.
</summary>
</member>
<member name="F:Cake.Core.IO.SpecialPath.CommonApplicationData">
<summary>
The directory that serves as a common repository for application-specific
data that is used by all users.
</summary>
</member>
<member name="F:Cake.Core.IO.SpecialPath.LocalApplicationData">
<summary>
The directory that serves as a common repository for application-specific
data that is used by the current, non-roaming user.
</summary>
</member>
<member name="F:Cake.Core.IO.SpecialPath.ProgramFiles">
<summary>
The Program Files folder.
</summary>
</member>
<member name="F:Cake.Core.IO.SpecialPath.ProgramFilesX86">
<summary>
The Program Files (X86) folder.
</summary>
</member>
<member name="F:Cake.Core.IO.SpecialPath.Windows">
<summary>
The Windows folder.
</summary>
</member>
<member name="F:Cake.Core.IO.SpecialPath.LocalTemp">
<summary>
The current user's temporary folder.
</summary>
</member>
<member name="T:Cake.Core.IO.WindowsRegistry">
<summary>
Represents an Windows implementation of <see cref="T:Cake.Core.IO.IRegistry"/>.
</summary>
</member>
<member name="P:Cake.Core.IO.WindowsRegistry.CurrentUser">
<inheritdoc/>
</member>
<member name="P:Cake.Core.IO.WindowsRegistry.LocalMachine">
<inheritdoc/>
</member>
<member name="P:Cake.Core.IO.WindowsRegistry.ClassesRoot">
<inheritdoc/>
</member>
<member name="P:Cake.Core.IO.WindowsRegistry.Users">
<inheritdoc/>
</member>
<member name="P:Cake.Core.IO.WindowsRegistry.PerformanceData">
<inheritdoc/>
</member>
<member name="P:Cake.Core.IO.WindowsRegistry.CurrentConfig">
<inheritdoc/>
</member>
<member name="T:Cake.Core.IO.NamespaceDoc">
<summary>
This namespace contain fundamental types that support
input and output, including the ability to read and write data
to streams and to interact with the file system.
</summary>
</member>
<member name="T:Cake.Core.ISetupContext">
<summary>
Acts as a context providing info about the overall build before its started.
</summary>
</member>
<member name="P:Cake.Core.ISetupContext.TargetTask">
<summary>
Gets target (initiating) task.
</summary>
</member>
<member name="P:Cake.Core.ISetupContext.TasksToExecute">
<summary>
Gets all registered tasks that are going to be executed.
</summary>
</member>
<member name="T:Cake.Core.ITaskSetupContext">
<summary>
Acts as a context providing info about a <see cref="T:Cake.Core.CakeTask"/> before its invocation.
</summary>
</member>
<member name="P:Cake.Core.ITaskSetupContext.Task">
<summary>
Gets the <see cref="T:Cake.Core.ICakeTaskInfo"/> describing the <see cref="T:Cake.Core.CakeTask"/> that has just been invoked.
</summary>
<value>
The task.
</value>
</member>
<member name="T:Cake.Core.ITaskTeardownContext">
<summary>
Acts as a context providing info about a <see cref="T:Cake.Core.CakeTask"/> following its invocation.
</summary>
</member>
<member name="P:Cake.Core.ITaskTeardownContext.Task">
<summary>
Gets the <see cref="T:Cake.Core.ICakeTaskInfo"/> describing the <see cref="T:Cake.Core.CakeTask"/> that has just been invoked.
</summary>
<value>
The task.
</value>
</member>
<member name="P:Cake.Core.ITaskTeardownContext.Duration">
<summary>
Gets the duration of the <see cref="T:Cake.Core.CakeTask"/>'s execution.
</summary>
<value>
The duration of the <see cref="T:Cake.Core.CakeTask"/>'s execution.
</value>
</member>
<member name="P:Cake.Core.ITaskTeardownContext.Skipped">
<summary>
Gets a value indicating whether this <see cref="T:Cake.Core.CakeTask"/> was skipped (not executed).
</summary>
<value>
<c>true</c> if skipped; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Cake.Core.ITaskTeardownContext.Successful">
<summary>
Gets a value indicating whether this <see cref="T:Cake.Core.CakeTask"/> was successful.
</summary>
<value>
<c>true</c> if successful; otherwise <c>false</c>.
</value>
</member>
<member name="P:Cake.Core.ITaskTeardownContext.ThrownException">
<summary>
Gets the exception that was thrown by the tasl.
</summary>
</member>
<member name="T:Cake.Core.ITeardownContext">
<summary>
Acts as a context providing info about the overall build following its completion.
</summary>
</member>
<member name="P:Cake.Core.ITeardownContext.Successful">
<summary>
Gets a value indicating whether this build was successful.
</summary>
<value>
<c>true</c> if successful; otherwise <c>false</c>.
</value>
</member>
<member name="P:Cake.Core.ITeardownContext.ThrownException">
<summary>
Gets the exception that was thrown by the target.
</summary>
</member>
<member name="T:Cake.Core.Modules.CoreModule">
<summary>
The module responsible for registering
default types in the Cake.Core assembly.
</summary>
</member>
<member name="M:Cake.Core.Modules.CoreModule.Register(Cake.Core.Composition.ICakeContainerRegistrar)">
<inheritdoc/>
</member>
<member name="T:Cake.Core.Packaging.IPackageInstaller">
<summary>
Represents an installer for a specific package.
</summary>
</member>
<member name="M:Cake.Core.Packaging.IPackageInstaller.CanInstall(Cake.Core.Packaging.PackageReference,Cake.Core.Packaging.PackageType)">
<summary>
Determines whether this instance can install the specified resource.
</summary>
<param name="package">The package resource.</param>
<param name="type">The package type.</param>
<returns>
<c>true</c> if this installer can install the
specified resource; otherwise <c>false</c>.
</returns>
</member>
<member name="M:Cake.Core.Packaging.IPackageInstaller.Install(Cake.Core.Packaging.PackageReference,Cake.Core.Packaging.PackageType,Cake.Core.IO.DirectoryPath)">
<summary>
Installs the specified resource at the given location.
</summary>
<param name="package">The package resource.</param>
<param name="type">The package type.</param>
<param name="path">The location where to install the resource.</param>
<returns>The installed files.</returns>
</member>
<member name="T:Cake.Core.Packaging.PackageReference">
<summary>
Represents an URI resource.
</summary>
</member>
<member name="P:Cake.Core.Packaging.PackageReference.OriginalString">
<summary>
Gets the original string.
</summary>
<value>The original string.</value>
</member>
<member name="P:Cake.Core.Packaging.PackageReference.Scheme">
<summary>
Gets the scheme.
</summary>
<value>The scheme.</value>
</member>
<member name="P:Cake.Core.Packaging.PackageReference.Address">
<summary>
Gets the address.
</summary>
<value>The address.</value>
</member>
<member name="P:Cake.Core.Packaging.PackageReference.Parameters">
<summary>
Gets the parameters.
</summary>
<value>The parameters.</value>
</member>
<member name="P:Cake.Core.Packaging.PackageReference.Package">
<summary>
Gets the package.
</summary>
<value>The package.</value>
</member>
<member name="M:Cake.Core.Packaging.PackageReference.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Packaging.PackageReference"/> class.
</summary>
<param name="uri">The URI.</param>
</member>
<member name="M:Cake.Core.Packaging.PackageReference.#ctor(System.Uri)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Packaging.PackageReference"/> class.
</summary>
<param name="uri">The URI.</param>
<exception cref="T:System.ArgumentException">Package query string parameter is missing.;uri.</exception>
</member>
<member name="T:Cake.Core.Packaging.PackageType">
<summary>
Represents a package type.
</summary>
</member>
<member name="F:Cake.Core.Packaging.PackageType.Unspecified">
<summary>
Represents an unspecified package type.
</summary>
</member>
<member name="F:Cake.Core.Packaging.PackageType.Addin">
<summary>
Represents an addin.
</summary>
</member>
<member name="F:Cake.Core.Packaging.PackageType.Tool">
<summary>
Represents a tool.
</summary>
</member>
<member name="F:Cake.Core.Packaging.PackageType.Module">
<summary>
Represents a module.
</summary>
</member>
<member name="T:Cake.Core.PlatformFamily">
<summary>
Represents a platform family.
</summary>
</member>
<member name="F:Cake.Core.PlatformFamily.Unknown">
<summary>
The platform family is unknown.
</summary>
</member>
<member name="F:Cake.Core.PlatformFamily.Windows">
<summary>
Represents the Windows platform family.
</summary>
</member>
<member name="F:Cake.Core.PlatformFamily.Linux">
<summary>
Represents the Linux platform family.
</summary>
</member>
<member name="F:Cake.Core.PlatformFamily.OSX">
<summary>
Represents the OSX platform family.
</summary>
</member>
<member name="T:Cake.Core.Polyfill.Runtime">
<summary>
The current Runtime Cake is executing on.
</summary>
</member>
<member name="F:Cake.Core.Polyfill.Runtime.Clr">
<summary>
Full Framework or Mono.
</summary>
</member>
<member name="F:Cake.Core.Polyfill.Runtime.CoreClr">
<summary>
.NET Core or .NET 5+.
</summary>
</member>
<member name="T:Cake.Core.NamespaceDoc">
<summary>
The <see cref="N:Cake.Core"/> namespace contains fundamental classes and
base classes for Cake and the Cake scripting environment.
</summary>
</member>
<member name="T:Cake.Core.Scripting.NamespaceDoc">
<summary>
This namespace contain types
related to script processing and execution.
</summary>
</member>
<member name="T:Cake.Core.Scripting.Processors.NamespaceDoc">
<summary>
This namespace contain types
related to script processing.
</summary>
</member>
<member name="T:Cake.Core.Scripting.Processors.LineProcessor">
<summary>
Abstract line processor.
</summary>
</member>
<member name="M:Cake.Core.Scripting.Processors.LineProcessor.Process(Cake.Core.Scripting.Analysis.IScriptAnalyzerContext,System.String,System.String@)">
<summary>
Processes the specified line.
</summary>
<param name="analyzer">The analyzer.</param>
<param name="line">The line.</param>
<param name="replacement">The replacement for line, null if no replacement.</param>
<returns><c>true</c> if the line was processed
by this processor; otherwise <c>false</c>.</returns>
</member>
<member name="M:Cake.Core.Scripting.Processors.LineProcessor.Split(System.String)">
<summary>
Splits the specified line into tokens.
</summary>
<param name="line">The line to split.</param>
<returns>The parts that make up the line.</returns>
</member>
<member name="T:Cake.Core.Scripting.Processors.Loading.ILoadDirectiveProvider">
<summary>
Represents a load directive provider.
</summary>
</member>
<member name="M:Cake.Core.Scripting.Processors.Loading.ILoadDirectiveProvider.CanLoad(Cake.Core.Scripting.Analysis.IScriptAnalyzerContext,Cake.Core.Scripting.Processors.Loading.LoadReference)">
<summary>
Indicates whether or not this provider can load the specified <see cref="T:Cake.Core.Scripting.Processors.Loading.LoadReference"/>.
</summary>
<param name="context">The context.</param>
<param name="reference">The reference to the code to load.</param>
<returns><c>true</c> if the provider can load the reference; otherwise <c>false</c>.</returns>
</member>
<member name="M:Cake.Core.Scripting.Processors.Loading.ILoadDirectiveProvider.Load(Cake.Core.Scripting.Analysis.IScriptAnalyzerContext,Cake.Core.Scripting.Processors.Loading.LoadReference)">
<summary>
Loads the specified <see cref="T:Cake.Core.Scripting.Processors.Loading.LoadReference"/>.
</summary>
<param name="context">The context.</param>
<param name="reference">The reference to load.</param>
</member>
<member name="T:Cake.Core.Scripting.Processors.Loading.LoadReference">
<summary>
Represents a resource to load via the #load directive.
</summary>
</member>
<member name="P:Cake.Core.Scripting.Processors.Loading.LoadReference.OriginalString">
<summary>
Gets the original string.
</summary>
<value>The original string.</value>
</member>
<member name="P:Cake.Core.Scripting.Processors.Loading.LoadReference.Scheme">
<summary>
Gets the scheme.
</summary>
<value>The scheme.</value>
</member>
<member name="P:Cake.Core.Scripting.Processors.Loading.LoadReference.Address">
<summary>
Gets the address.
</summary>
<value>The address.</value>
</member>
<member name="P:Cake.Core.Scripting.Processors.Loading.LoadReference.Parameters">
<summary>
Gets the parameters.
</summary>
<value>The parameters.</value>
</member>
<member name="M:Cake.Core.Scripting.Processors.Loading.LoadReference.#ctor(System.Uri)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Scripting.Processors.Loading.LoadReference"/> class.
</summary>
<param name="uri">The URI.</param>
</member>
<member name="T:Cake.Core.Scripting.Analysis.IScriptAnalyzer">
<summary>
Represents the script analyzer responsible for
parsing and analyzing scripts.
</summary>
</member>
<member name="M:Cake.Core.Scripting.Analysis.IScriptAnalyzer.Analyze(Cake.Core.IO.FilePath,Cake.Core.Scripting.Analysis.ScriptAnalyzerSettings)">
<summary>
Analyzes the specified script path.
</summary>
<param name="path">The path to the script to analyze.</param>
<param name="settings">The script analyzer settings.</param>
<returns>The script analysis result.</returns>
</member>
<member name="T:Cake.Core.Scripting.Analysis.IScriptAnalyzerContext">
<summary>
Represents the context used by the <see cref="T:Cake.Core.Scripting.Analysis.ScriptAnalyzer"/>.
</summary>
</member>
<member name="P:Cake.Core.Scripting.Analysis.IScriptAnalyzerContext.Root">
<summary>
Gets the path to the initial script being executed.
</summary>
</member>
<member name="P:Cake.Core.Scripting.Analysis.IScriptAnalyzerContext.Current">
<summary>
Gets the current script being processed.
</summary>
<value>The current script being processed.</value>
</member>
<member name="M:Cake.Core.Scripting.Analysis.IScriptAnalyzerContext.Analyze(Cake.Core.IO.FilePath)">
<summary>
Processes the specified script path using the same context.
</summary>
<param name="scriptPath">The script path to process.</param>
</member>
<member name="M:Cake.Core.Scripting.Analysis.IScriptAnalyzerContext.AddScriptLine(System.String)">
<summary>
Adds a script line to the result.
</summary>
<param name="line">The script line to add.</param>
</member>
<member name="M:Cake.Core.Scripting.Analysis.IScriptAnalyzerContext.AddScriptError(System.String)">
<summary>
Adds a script error to the result.
</summary>
<param name="error">The script error to add.</param>
</member>
<member name="T:Cake.Core.Scripting.Analysis.IScriptInformation">
<summary>
Represents information about a script.
</summary>
</member>
<member name="P:Cake.Core.Scripting.Analysis.IScriptInformation.Path">
<summary>
Gets the script path.
</summary>
<value>The script path.</value>
</member>
<member name="P:Cake.Core.Scripting.Analysis.IScriptInformation.Includes">
<summary>
Gets the includes.
</summary>
<value>The includes.</value>
</member>
<member name="P:Cake.Core.Scripting.Analysis.IScriptInformation.References">
<summary>
Gets the referenced script assemblies.
</summary>
<value>The referenced script assemblies.</value>
</member>
<member name="P:Cake.Core.Scripting.Analysis.IScriptInformation.Namespaces">
<summary>
Gets all namespaces referenced by the script.
</summary>
<value>The namespaces referenced by the script.</value>
</member>
<member name="P:Cake.Core.Scripting.Analysis.IScriptInformation.UsingAliases">
<summary>
Gets all using aliases defined by the scripts.
</summary>
<value>The using aliases defined by the script.</value>
</member>
<member name="P:Cake.Core.Scripting.Analysis.IScriptInformation.UsingStaticDirectives">
<summary>
Gets all types referenced with the using static directive.
</summary>
<value>The fully qualified type names referenced by using static in the script.</value>
</member>
<member name="P:Cake.Core.Scripting.Analysis.IScriptInformation.Defines">
<summary>
Gets the defines directives defined by the scripts.
</summary>
<value>The defines.</value>
</member>
<member name="P:Cake.Core.Scripting.Analysis.IScriptInformation.Tools">
<summary>
Gets the tools.
</summary>
<value>The tools.</value>
</member>
<member name="P:Cake.Core.Scripting.Analysis.IScriptInformation.Addins">
<summary>
Gets the addins.
</summary>
<value>The addins.</value>
</member>
<member name="P:Cake.Core.Scripting.Analysis.IScriptInformation.Modules">
<summary>
Gets the modules.
</summary>
<value>The modules.</value>
</member>
<member name="T:Cake.Core.Scripting.Analysis.ScriptAnalyzer">
<summary>
The script analyzer.
</summary>
</member>
<member name="M:Cake.Core.Scripting.Analysis.ScriptAnalyzer.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.Diagnostics.ICakeLog,System.Collections.Generic.IEnumerable{Cake.Core.Scripting.Processors.Loading.ILoadDirectiveProvider})">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Scripting.Analysis.ScriptAnalyzer"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="log">The log.</param>
<param name="providers">The load directive providers.</param>
</member>
<member name="M:Cake.Core.Scripting.Analysis.ScriptAnalyzer.Analyze(Cake.Core.IO.FilePath,Cake.Core.Scripting.Analysis.ScriptAnalyzerSettings)">
<inheritdoc/>
</member>
<member name="T:Cake.Core.Scripting.Analysis.ScriptAnalyzerError">
<summary>
Represents a script analysis error.
</summary>
</member>
<member name="P:Cake.Core.Scripting.Analysis.ScriptAnalyzerError.File">
<summary>
Gets the file containing the error.
</summary>
</member>
<member name="P:Cake.Core.Scripting.Analysis.ScriptAnalyzerError.Line">
<summary>
Gets the line number for the error.
</summary>
</member>
<member name="P:Cake.Core.Scripting.Analysis.ScriptAnalyzerError.Message">
<summary>
Gets the error message.
</summary>
</member>
<member name="M:Cake.Core.Scripting.Analysis.ScriptAnalyzerError.#ctor(Cake.Core.IO.FilePath,System.Int32,System.String)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Scripting.Analysis.ScriptAnalyzerError"/> class.
</summary>
<param name="file">The file containing the error.</param>
<param name="line">The line number for the error.</param>
<param name="message">The error message.</param>
</member>
<member name="T:Cake.Core.Scripting.Analysis.ScriptAnalyzerMode">
<summary>
Represents the script analyzer mode.
</summary>
</member>
<member name="F:Cake.Core.Scripting.Analysis.ScriptAnalyzerMode.Everything">
<summary>
Analyzes everything.
</summary>
</member>
<member name="F:Cake.Core.Scripting.Analysis.ScriptAnalyzerMode.Modules">
<summary>
Analyzes modules.
</summary>
</member>
<member name="T:Cake.Core.Scripting.Analysis.ScriptAnalyzerResult">
<summary>
Represents a script analysis result.
</summary>
</member>
<member name="P:Cake.Core.Scripting.Analysis.ScriptAnalyzerResult.Script">
<summary>
Gets the analyzed script.
</summary>
<value>The script.</value>
</member>
<member name="P:Cake.Core.Scripting.Analysis.ScriptAnalyzerResult.Lines">
<summary>
Gets the merged script lines.
</summary>
<value>The merged script lines.</value>
</member>
<member name="P:Cake.Core.Scripting.Analysis.ScriptAnalyzerResult.References">
<summary>
Gets all references.
</summary>
<value>The references.</value>
</member>
<member name="P:Cake.Core.Scripting.Analysis.ScriptAnalyzerResult.Namespaces">
<summary>
Gets all the namespaces.
</summary>
<value>The namespaces.</value>
</member>
<member name="P:Cake.Core.Scripting.Analysis.ScriptAnalyzerResult.UsingAliases">
<summary>
Gets the using aliases.
</summary>
<value>The using aliases.</value>
</member>
<member name="P:Cake.Core.Scripting.Analysis.ScriptAnalyzerResult.UsingStaticDirectives">
<summary>
Gets all types referenced with the using static directive.
</summary>
</member>
<member name="P:Cake.Core.Scripting.Analysis.ScriptAnalyzerResult.Defines">
<summary>
Gets the defines.
</summary>
<value>The defines.</value>
</member>
<member name="P:Cake.Core.Scripting.Analysis.ScriptAnalyzerResult.Addins">
<summary>
Gets the addins.
</summary>
<value>The addins.</value>
</member>
<member name="P:Cake.Core.Scripting.Analysis.ScriptAnalyzerResult.Tools">
<summary>
Gets the tools.
</summary>
<value>The tools.</value>
</member>
<member name="P:Cake.Core.Scripting.Analysis.ScriptAnalyzerResult.Modules">
<summary>
Gets the modules.
</summary>
<value>The modules.</value>
</member>
<member name="P:Cake.Core.Scripting.Analysis.ScriptAnalyzerResult.Succeeded">
<summary>
Gets a value indicating whether to analysis succeeded without errors.
</summary>
</member>
<member name="P:Cake.Core.Scripting.Analysis.ScriptAnalyzerResult.Errors">
<summary>
Gets the list of analyzer errors.
</summary>
</member>
<member name="M:Cake.Core.Scripting.Analysis.ScriptAnalyzerResult.#ctor(Cake.Core.Scripting.Analysis.IScriptInformation,System.Collections.Generic.IReadOnlyList{System.String},System.Collections.Generic.IReadOnlyList{Cake.Core.Scripting.Analysis.ScriptAnalyzerError})">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Scripting.Analysis.ScriptAnalyzerResult"/> class.
</summary>
<param name="script">The script.</param>
<param name="lines">The merged script lines.</param>
<param name="errors">The analyzer errors.</param>
</member>
<member name="T:Cake.Core.Scripting.Analysis.ScriptAnalyzerSettings">
<summary>
Represents settings for the script analyzer.
</summary>
</member>
<member name="P:Cake.Core.Scripting.Analysis.ScriptAnalyzerSettings.Mode">
<summary>
Gets or sets the analyzer mode.
</summary>
</member>
<member name="T:Cake.Core.Scripting.CodeGen.GenericParameterConstraintEmitter">
<summary>
Responsible for generating generic parameter constraints on generated generic methods.
</summary>
</member>
<member name="T:Cake.Core.Scripting.CodeGen.MethodAliasGenerator">
<summary>
Responsible for generating script method aliases.
</summary>
</member>
<member name="M:Cake.Core.Scripting.CodeGen.MethodAliasGenerator.Generate(System.Reflection.MethodInfo)">
<summary>
Generates a script method alias from the specified method.
The provided method must be an extension method for <see cref="T:Cake.Core.ICakeContext"/>
and it must be decorated with the <see cref="T:Cake.Core.Annotations.CakeMethodAliasAttribute"/>.
</summary>
<param name="method">The method to generate the code for.</param>
<returns>The generated code.</returns>
</member>
<member name="M:Cake.Core.Scripting.CodeGen.MethodAliasGenerator.Generate(System.Reflection.MethodInfo,System.String@)">
<summary>
Generates a script method alias from the specified method.
The provided method must be an extension method for <see cref="T:Cake.Core.ICakeContext"/>
and it must be decorated with the <see cref="T:Cake.Core.Annotations.CakeMethodAliasAttribute"/>.
</summary>
<param name="method">The method to generate the code for.</param>
<param name="hash">The hash of method signature.</param>
<returns>The generated code.</returns>
</member>
<member name="T:Cake.Core.Scripting.CodeGen.ParameterEmitter">
<summary>
Responsible for generating parameter tokens in method alias generation.
</summary>
</member>
<member name="T:Cake.Core.Scripting.CodeGen.ParameterFormatter">
<summary>
Provides support for cleaning parameter names consisting of reserved keywords.
</summary>
</member>
<member name="T:Cake.Core.Scripting.CodeGen.PropertyAliasGenerator">
<summary>
Responsible for generating script property aliases.
</summary>
</member>
<member name="M:Cake.Core.Scripting.CodeGen.PropertyAliasGenerator.Generate(System.Reflection.MethodInfo)">
<summary>
Generates a script property alias from the specified method.
The provided method must be an extension method for <see cref="T:Cake.Core.ICakeContext"/>
and it must be decorated with the <see cref="T:Cake.Core.Annotations.CakePropertyAliasAttribute"/>.
</summary>
<param name="method">The method to generate the code for.</param>
<returns>The generated code.</returns>
</member>
<member name="M:Cake.Core.Scripting.CodeGen.PropertyAliasGenerator.Generate(System.Reflection.MethodInfo,System.String@)">
<summary>
Generates a script property alias from the specified method.
The provided method must be an extension method for <see cref="T:Cake.Core.ICakeContext"/>
and it must be decorated with the <see cref="T:Cake.Core.Annotations.CakePropertyAliasAttribute"/>.
</summary>
<param name="method">The method to generate the code for.</param>
<param name="hash">The hash of property signature.</param>
<returns>The generated code.</returns>
</member>
<member name="T:Cake.Core.Scripting.IReferenceAssemblyResolver">
<summary>
Represents a framework reference assembly resolver.
</summary>
</member>
<member name="M:Cake.Core.Scripting.IReferenceAssemblyResolver.GetReferenceAssemblies">
<summary>
Finds framwork reference assemblies.
</summary>
<returns>The resolved reference assemblies.</returns>
</member>
<member name="T:Cake.Core.Scripting.IScriptAliasFinder">
<summary>
Represents a script alias generator.
</summary>
</member>
<member name="M:Cake.Core.Scripting.IScriptAliasFinder.FindAliases(System.Collections.Generic.IEnumerable{System.Reflection.Assembly})">
<summary>
Finds script aliases in the provided assemblies.
</summary>
<param name="assemblies">The assemblies to find script aliases in.</param>
<returns>The script aliases that were found.</returns>
</member>
<member name="T:Cake.Core.Scripting.IScriptConventions">
<summary>
Represents the script conventions used by Cake.
</summary>
</member>
<member name="M:Cake.Core.Scripting.IScriptConventions.GetDefaultNamespaces">
<summary>
Gets the default namespaces.
</summary>
<returns>A list containing all default namespaces.</returns>
</member>
<member name="M:Cake.Core.Scripting.IScriptConventions.GetDefaultAssemblies(Cake.Core.IO.DirectoryPath)">
<summary>
Gets the default assemblies.
</summary>
<param name="root">The root to where to find Cake related assemblies.</param>
<returns>A list containing all default assemblies.</returns>
</member>
<member name="M:Cake.Core.Scripting.IScriptConventions.GetDefaultDefines">
<summary>
Gets the default defines.
</summary>
<returns>A list containing all default defines.</returns>
</member>
<member name="T:Cake.Core.Scripting.IScriptEngine">
<summary>
Represents a script engine.
</summary>
</member>
<member name="M:Cake.Core.Scripting.IScriptEngine.CreateSession(Cake.Core.Scripting.IScriptHost)">
<summary>
Creates a new script session.
</summary>
<param name="host">The host.</param>
<returns>A new script session.</returns>
</member>
<member name="T:Cake.Core.Scripting.IScriptHost">
<summary>
Represents a script host that works as a context for scripts.
</summary>
</member>
<member name="P:Cake.Core.Scripting.IScriptHost.Context">
<summary>
Gets the context.
</summary>
<value>The context.</value>
</member>
<member name="P:Cake.Core.Scripting.IScriptHost.Tasks">
<summary>
Gets all registered tasks.
</summary>
<value>The registered tasks.</value>
</member>
<member name="P:Cake.Core.Scripting.IScriptHost.Settings">
<summary>
Gets the execution settings.
</summary>
</member>
<member name="M:Cake.Core.Scripting.IScriptHost.Task(System.String)">
<summary>
Registers a new task.
</summary>
<param name="name">The name of the task.</param>
<returns>A <see cref="T:Cake.Core.CakeTaskBuilder"/>.</returns>
</member>
<member name="M:Cake.Core.Scripting.IScriptHost.TaskOf``1(System.String)">
<summary>
Registers a new task.
</summary>
<param name="name">The name of the task.</param>
<returns>A <see cref="T:Cake.Core.CakeTaskBuilder"/>.</returns>
<typeparam name="TData">The type of the data context.</typeparam>
</member>
<member name="M:Cake.Core.Scripting.IScriptHost.Setup(System.Action{Cake.Core.ISetupContext})">
<summary>
Allows registration of an action that's executed before any tasks are run.
If setup fails, no tasks will be executed but teardown will be performed.
</summary>
<param name="action">The action to be executed.</param>
<example>
<code>
Setup(context => {
context.Log.Information("Hello World!");
});
</code>
</example>
</member>
<member name="M:Cake.Core.Scripting.IScriptHost.Setup``1(System.Func{Cake.Core.ISetupContext,``0})">
<summary>
Allows registration of an action that's executed before any tasks are run.
If setup fails, no tasks will be executed but teardown will be performed.
</summary>
<typeparam name="TData">The data type.</typeparam>
<param name="action">The action to be executed.</param>
<example>
<code>
Setup<Foo>(context => {
return new Foo();
});
</code>
</example>
</member>
<member name="M:Cake.Core.Scripting.IScriptHost.Teardown(System.Action{Cake.Core.ITeardownContext})">
<summary>
Allows registration of an action that's executed after all other tasks have been run.
If a setup action or a task fails with or without recovery, the specified teardown action will still be executed.
</summary>
<param name="action">The action to be executed.</param>
<example>
<code>
Teardown(context => {
context.Log.Information("Goodbye World!");
});
</code>
</example>
</member>
<member name="M:Cake.Core.Scripting.IScriptHost.Teardown``1(System.Action{Cake.Core.ITeardownContext,``0})">
<summary>
Allows registration of an action that's executed after all other tasks have been run.
If a setup action or a task fails with or without recovery, the specified teardown action will still be executed.
</summary>
<typeparam name="TData">The data type.</typeparam>
<param name="action">The action to be executed.</param>
<example>
<code>
Teardown((context, data) => {
context.Log.Information("Goodbye {0}!", data.Place);
});
</code>
</example>
</member>
<member name="M:Cake.Core.Scripting.IScriptHost.TaskSetup(System.Action{Cake.Core.ITaskSetupContext})">
<summary>
Allows registration of an action that's executed before each task is run.
If the task setup fails, its task will not be executed but the task teardown will be performed.
</summary>
<param name="action">The action to be executed.</param>
</member>
<member name="M:Cake.Core.Scripting.IScriptHost.TaskSetup``1(System.Action{Cake.Core.ITaskSetupContext,``0})">
<summary>
Allows registration of an action that's executed before each task is run.
If the task setup fails, its task will not be executed but the task teardown will be performed.
</summary>
<typeparam name="TData">The data type.</typeparam>
<param name="action">The action to be executed.</param>
</member>
<member name="M:Cake.Core.Scripting.IScriptHost.TaskTeardown(System.Action{Cake.Core.ITaskTeardownContext})">
<summary>
Allows registration of an action that's executed after each task has been run.
If a task setup action or a task fails with or without recovery, the specified task teardown action will still be executed.
</summary>
<param name="action">The action to be executed.</param>
</member>
<member name="M:Cake.Core.Scripting.IScriptHost.TaskTeardown``1(System.Action{Cake.Core.ITaskTeardownContext,``0})">
<summary>
Allows registration of an action that's executed after each task has been run.
If a task setup action or a task fails with or without recovery, the specified task teardown action will still be executed.
</summary>
<typeparam name="TData">The data type.</typeparam>
<param name="action">The action to be executed.</param>
</member>
<member name="M:Cake.Core.Scripting.IScriptHost.RunTarget(System.String)">
<summary>
Runs the specified target.
</summary>
<param name="target">The target to run.</param>
<returns>The resulting report.</returns>
</member>
<member name="M:Cake.Core.Scripting.IScriptHost.RunTargetAsync(System.String)">
<summary>
Runs the specified target.
</summary>
<param name="target">The target to run.</param>
<returns>The resulting report.</returns>
</member>
<member name="M:Cake.Core.Scripting.IScriptHost.RunTargets(System.Collections.Generic.IEnumerable{System.String})">
<summary>
Runs the specified targets.
</summary>
<param name="targets">The targets to run.</param>
<returns>The resulting report.</returns>
</member>
<member name="M:Cake.Core.Scripting.IScriptHost.RunTargetsAsync(System.Collections.Generic.IEnumerable{System.String})">
<summary>
Runs the specified targets.
</summary>
<param name="targets">The targets to run.</param>
<returns>The resulting report.</returns>
</member>
<member name="T:Cake.Core.Scripting.IScriptProcessor">
<summary>
Represents a script processor.
</summary>
</member>
<member name="M:Cake.Core.Scripting.IScriptProcessor.InstallAddins(System.Collections.Generic.IReadOnlyCollection{Cake.Core.Packaging.PackageReference},Cake.Core.IO.DirectoryPath)">
<summary>
Installs the addins.
</summary>
<param name="addins">The addins to install.</param>
<param name="installPath">The install path.</param>
<returns>A list containing file paths to installed addin assemblies.</returns>
</member>
<member name="M:Cake.Core.Scripting.IScriptProcessor.InstallTools(System.Collections.Generic.IReadOnlyCollection{Cake.Core.Packaging.PackageReference},Cake.Core.IO.DirectoryPath)">
<summary>
Installs the tools.
</summary>
<param name="tools">The tools to install.</param>
<param name="installPath">The install path.</param>
</member>
<member name="M:Cake.Core.Scripting.IScriptProcessor.InstallModules(System.Collections.Generic.IReadOnlyCollection{Cake.Core.Packaging.PackageReference},Cake.Core.IO.DirectoryPath)">
<summary>
Installs the modules.
</summary>
<param name="modules">The modules to install.</param>
<param name="installPath">The install path.</param>
</member>
<member name="T:Cake.Core.Scripting.IScriptRunner">
<summary>
Represents a script runner responsible for running scripts.
</summary>
</member>
<member name="M:Cake.Core.Scripting.IScriptRunner.Run(Cake.Core.Scripting.IScriptHost,Cake.Core.IO.FilePath)">
<summary>
Runs the script using the specified script host.
</summary>
<param name="host">The script host.</param>
<param name="scriptPath">The script path.</param>
</member>
<member name="T:Cake.Core.Scripting.IScriptSession">
<summary>
Represents a script session.
</summary>
</member>
<member name="M:Cake.Core.Scripting.IScriptSession.AddReference(Cake.Core.IO.FilePath)">
<summary>
Adds a reference path to the session.
</summary>
<param name="path">The reference path.</param>
</member>
<member name="M:Cake.Core.Scripting.IScriptSession.AddReference(System.Reflection.Assembly)">
<summary>
Adds an assembly reference to the session.
</summary>
<param name="assembly">The assembly reference.</param>
</member>
<member name="M:Cake.Core.Scripting.IScriptSession.ImportNamespace(System.String)">
<summary>
Imports a namespace to the session.
</summary>
<param name="namespace">The namespace to import.</param>
</member>
<member name="M:Cake.Core.Scripting.IScriptSession.Execute(Cake.Core.Scripting.Script)">
<summary>
Executes the specified script.
</summary>
<param name="script">The script to execute.</param>
</member>
<member name="T:Cake.Core.Scripting.Script">
<summary>
Represents a script.
</summary>
</member>
<member name="P:Cake.Core.Scripting.Script.Namespaces">
<summary>
Gets the namespaces imported via the <c>using</c> statement.
</summary>
<value>The namespaces.</value>
</member>
<member name="P:Cake.Core.Scripting.Script.ExcludedNamespaces">
<summary>
Gets the namespaces flagged to be excluded by code generation and affected aliases.
</summary>
</member>
<member name="P:Cake.Core.Scripting.Script.Lines">
<summary>
Gets the script lines.
</summary>
<value>
The lines.
</value>
</member>
<member name="P:Cake.Core.Scripting.Script.Aliases">
<summary>
Gets the aliases.
</summary>
<value>The aliases.</value>
</member>
<member name="P:Cake.Core.Scripting.Script.UsingAliasDirectives">
<summary>
Gets the using alias directives.
</summary>
<value>The using alias directives.</value>
</member>
<member name="P:Cake.Core.Scripting.Script.UsingStaticDirectives">
<summary>
Gets the using static directives.
</summary>
<value>The using static directives.</value>
</member>
<member name="P:Cake.Core.Scripting.Script.Defines">
<summary>
Gets the defines.
</summary>
<value>The defines.</value>
</member>
<member name="M:Cake.Core.Scripting.Script.#ctor(System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{Cake.Core.Scripting.ScriptAlias},System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String})">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Scripting.Script" /> class.
</summary>
<param name="namespaces">The namespaces.</param>
<param name="lines">The scrip lines.</param>
<param name="aliases">The script aliases.</param>
<param name="usingAliasDirectives">The using alias directives.</param>
<param name="usingStaticDirectives">The using static directives.</param>
<param name="defines">The defines.</param>
</member>
<member name="T:Cake.Core.Scripting.ScriptAlias">
<summary>
Represents a script alias.
</summary>
</member>
<member name="P:Cake.Core.Scripting.ScriptAlias.Name">
<summary>
Gets the name of the alias.
</summary>
<value>The name.</value>
</member>
<member name="P:Cake.Core.Scripting.ScriptAlias.Method">
<summary>
Gets the method associated with the alias.
</summary>
<value>The method associated with the alias.</value>
</member>
<member name="P:Cake.Core.Scripting.ScriptAlias.Type">
<summary>
Gets the alias type.
</summary>
<value>The alias type.</value>
</member>
<member name="P:Cake.Core.Scripting.ScriptAlias.Namespaces">
<summary>
Gets all namespaces that the alias need to be imported.
</summary>
<value>
The namespaces that the alias need to be imported.
</value>
</member>
<member name="M:Cake.Core.Scripting.ScriptAlias.#ctor(System.Reflection.MethodInfo,Cake.Core.Scripting.ScriptAliasType,System.Collections.Generic.ISet{System.String})">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Scripting.ScriptAlias"/> class.
</summary>
<param name="method">The method associated with the alias.</param>
<param name="type">The alias type.</param>
<param name="namespaces">The namespaces that the alias need to be imported.</param>
</member>
<member name="T:Cake.Core.Scripting.ScriptAliasFinder">
<summary>
The script alias finder.
</summary>
</member>
<member name="M:Cake.Core.Scripting.ScriptAliasFinder.#ctor(Cake.Core.Diagnostics.ICakeLog)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Scripting.ScriptAliasFinder"/> class.
</summary>
<param name="log">The log.</param>
</member>
<member name="M:Cake.Core.Scripting.ScriptAliasFinder.FindAliases(System.Collections.Generic.IEnumerable{System.Reflection.Assembly})">
<inheritdoc/>
</member>
<member name="T:Cake.Core.Scripting.ScriptAliasType">
<summary>
Represents a script alias type.
</summary>
</member>
<member name="F:Cake.Core.Scripting.ScriptAliasType.Unknown">
<summary>
Represents an unknown script alias type.
</summary>
</member>
<member name="F:Cake.Core.Scripting.ScriptAliasType.Method">
<summary>
Represents a script alias method.
</summary>
</member>
<member name="F:Cake.Core.Scripting.ScriptAliasType.Property">
<summary>
Represents a script alias property.
</summary>
</member>
<member name="T:Cake.Core.Scripting.ScriptConventions">
<summary>
The script conventions used by Cake.
</summary>
</member>
<member name="M:Cake.Core.Scripting.ScriptConventions.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.Reflection.IAssemblyLoader,Cake.Core.ICakeRuntime,Cake.Core.Scripting.IReferenceAssemblyResolver)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Scripting.ScriptConventions"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="loader">The assembly loader.</param>
<param name="runtime">The Cake runtime.</param>
<param name="referenceAssemblyResolver">The reference assembly resolver.</param>
</member>
<member name="M:Cake.Core.Scripting.ScriptConventions.GetDefaultNamespaces">
<inheritdoc/>
</member>
<member name="M:Cake.Core.Scripting.ScriptConventions.GetDefaultAssemblies(Cake.Core.IO.DirectoryPath)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.Scripting.ScriptConventions.GetDefaultDefines">
<inheritdoc/>
</member>
<member name="T:Cake.Core.Scripting.ScriptHost">
<summary>
The script host works as a context for scripts.
</summary>
</member>
<member name="P:Cake.Core.Scripting.ScriptHost.Engine">
<summary>
Gets the engine.
</summary>
<value>The engine.</value>
</member>
<member name="P:Cake.Core.Scripting.ScriptHost.Context">
<inheritdoc/>
</member>
<member name="P:Cake.Core.Scripting.ScriptHost.Settings">
<summary>
Gets the settings.
</summary>
<value>The settings.</value>
</member>
<member name="M:Cake.Core.Scripting.ScriptHost.#ctor(Cake.Core.ICakeEngine,Cake.Core.ICakeContext)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Scripting.ScriptHost"/> class.
</summary>
<param name="engine">The engine.</param>
<param name="context">The context.</param>
</member>
<member name="P:Cake.Core.Scripting.ScriptHost.Tasks">
<inheritdoc/>
</member>
<member name="M:Cake.Core.Scripting.ScriptHost.Task(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.Scripting.ScriptHost.TaskOf``1(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.Scripting.ScriptHost.Setup(System.Action{Cake.Core.ISetupContext})">
<inheritdoc/>
</member>
<member name="M:Cake.Core.Scripting.ScriptHost.Setup``1(System.Func{Cake.Core.ISetupContext,``0})">
<inheritdoc/>
</member>
<member name="M:Cake.Core.Scripting.ScriptHost.Teardown(System.Action{Cake.Core.ITeardownContext})">
<inheritdoc/>
</member>
<member name="M:Cake.Core.Scripting.ScriptHost.Teardown``1(System.Action{Cake.Core.ITeardownContext,``0})">
<inheritdoc/>
</member>
<member name="M:Cake.Core.Scripting.ScriptHost.TaskSetup(System.Action{Cake.Core.ITaskSetupContext})">
<inheritdoc/>
</member>
<member name="M:Cake.Core.Scripting.ScriptHost.TaskSetup``1(System.Action{Cake.Core.ITaskSetupContext,``0})">
<inheritdoc/>
</member>
<member name="M:Cake.Core.Scripting.ScriptHost.TaskTeardown(System.Action{Cake.Core.ITaskTeardownContext})">
<inheritdoc/>
</member>
<member name="M:Cake.Core.Scripting.ScriptHost.TaskTeardown``1(System.Action{Cake.Core.ITaskTeardownContext,``0})">
<inheritdoc/>
</member>
<member name="M:Cake.Core.Scripting.ScriptHost.RunTarget(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.Scripting.ScriptHost.RunTargetAsync(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.Scripting.ScriptHost.RunTargets(System.Collections.Generic.IEnumerable{System.String})">
<inheritdoc/>
</member>
<member name="M:Cake.Core.Scripting.ScriptHost.RunTargetsAsync(System.Collections.Generic.IEnumerable{System.String})">
<inheritdoc/>
</member>
<member name="T:Cake.Core.Scripting.ScriptProcessor">
<summary>
Implementation of a script processor.
</summary>
</member>
<member name="M:Cake.Core.Scripting.ScriptProcessor.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.Diagnostics.ICakeLog,Cake.Core.Tooling.IToolLocator,System.Collections.Generic.IEnumerable{Cake.Core.Packaging.IPackageInstaller},Cake.Core.Configuration.ICakeConfiguration)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Scripting.ScriptProcessor"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="log">The log.</param>
<param name="tools">The tool locator.</param>
<param name="installers">The available package installers.</param>
<param name="configuration">The configuration.</param>
</member>
<member name="M:Cake.Core.Scripting.ScriptProcessor.InstallAddins(System.Collections.Generic.IReadOnlyCollection{Cake.Core.Packaging.PackageReference},Cake.Core.IO.DirectoryPath)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.Scripting.ScriptProcessor.InstallTools(System.Collections.Generic.IReadOnlyCollection{Cake.Core.Packaging.PackageReference},Cake.Core.IO.DirectoryPath)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.Scripting.ScriptProcessor.InstallModules(System.Collections.Generic.IReadOnlyCollection{Cake.Core.Packaging.PackageReference},Cake.Core.IO.DirectoryPath)">
<inheritdoc/>
</member>
<member name="T:Cake.Core.Scripting.ScriptRunner">
<summary>
Responsible for running scripts.
</summary>
</member>
<member name="M:Cake.Core.Scripting.ScriptRunner.#ctor(Cake.Core.ICakeEnvironment,Cake.Core.Diagnostics.ICakeLog,Cake.Core.Configuration.ICakeConfiguration,Cake.Core.Scripting.IScriptEngine,Cake.Core.Scripting.IScriptAliasFinder,Cake.Core.Scripting.Analysis.IScriptAnalyzer,Cake.Core.Scripting.IScriptProcessor,Cake.Core.Scripting.IScriptConventions,Cake.Core.Reflection.IAssemblyLoader)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Scripting.ScriptRunner"/> class.
</summary>
<param name="environment">The environment.</param>
<param name="log">The log.</param>
<param name="configuration">The configuration.</param>
<param name="engine">The session factory.</param>
<param name="aliasFinder">The alias finder.</param>
<param name="analyzer">The script analyzer.</param>
<param name="processor">The script processor.</param>
<param name="conventions">The script conventions.</param>
<param name="assemblyLoader">The assembly loader.</param>
</member>
<member name="M:Cake.Core.Scripting.ScriptRunner.Run(Cake.Core.Scripting.IScriptHost,Cake.Core.IO.FilePath)">
<inheritdoc/>
</member>
<member name="T:Cake.Core.Text.NamespaceDoc">
<summary>
This namespace contain types
related to text processing and transformations.
</summary>
</member>
<member name="T:Cake.Core.Text.ITextTransformationTemplate">
<summary>
Represents a text template.
</summary>
</member>
<member name="M:Cake.Core.Text.ITextTransformationTemplate.Register(System.String,System.Object)">
<summary>
Registers a key and an associated value.
</summary>
<param name="key">The key.</param>
<param name="value">The value.</param>
</member>
<member name="M:Cake.Core.Text.ITextTransformationTemplate.Render">
<summary>
Renders the text template using the registered tokens.
</summary>
<returns>The rendered template.</returns>
</member>
<member name="T:Cake.Core.Text.QuoteAwareStringSplitter">
<summary>
Utility that that respect quotes when splitting a string.
</summary>
</member>
<member name="M:Cake.Core.Text.QuoteAwareStringSplitter.Split(System.String)">
<summary>
Splits the provided string on spaces while respecting quoted strings.
</summary>
<param name="text">The string to split.</param>
<returns>The split, individual parts.</returns>
</member>
<member name="T:Cake.Core.Text.TextTransformationTemplate">
<summary>
Provides template functionality for simple text transformations.
</summary>
</member>
<member name="M:Cake.Core.Text.TextTransformationTemplate.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Text.TextTransformationTemplate"/> class.
</summary>
<param name="template">The template.</param>
</member>
<member name="M:Cake.Core.Text.TextTransformationTemplate.#ctor(System.String,System.Tuple{System.String,System.String})">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Text.TextTransformationTemplate"/> class.
</summary>
<param name="template">The template.</param>
<param name="placeholder">The key placeholder.</param>
</member>
<member name="M:Cake.Core.Text.TextTransformationTemplate.Register(System.String,System.Object)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.Text.TextTransformationTemplate.Render">
<inheritdoc/>
</member>
<member name="T:Cake.Core.Tooling.NamespaceDoc">
<summary>
This namespace contain base classes
and functionality related to tooling.
</summary>
</member>
<member name="T:Cake.Core.Tooling.IToolLocator">
<summary>
Represents a tool locator.
</summary>
</member>
<member name="M:Cake.Core.Tooling.IToolLocator.RegisterFile(Cake.Core.IO.FilePath)">
<summary>
Registers the specified tool file path.
</summary>
<param name="path">The tool path.</param>
</member>
<member name="M:Cake.Core.Tooling.IToolLocator.Resolve(System.String)">
<summary>
Resolves the path to the specified tool.
</summary>
<param name="tool">The tool.</param>
<returns>A path if the tool was found; otherwise <c>null</c>.</returns>
</member>
<member name="M:Cake.Core.Tooling.IToolLocator.Resolve(System.Collections.Generic.IEnumerable{System.String})">
<summary>
Resolves the path to the specified tool.
</summary>
<param name="toolExeNames">The possible names of the tool executable.</param>
<returns>A path if the tool was found; otherwise <c>null</c>.</returns>
</member>
<member name="T:Cake.Core.Tooling.IToolRepository">
<summary>
Represents a tool repository.
</summary>
</member>
<member name="M:Cake.Core.Tooling.IToolRepository.Register(Cake.Core.IO.FilePath)">
<summary>
Registers the specified path with the repository.
</summary>
<param name="path">The path to register.</param>
</member>
<member name="M:Cake.Core.Tooling.IToolRepository.Resolve(System.String)">
<summary>
Resolves the specified tool.
</summary>
<param name="tool">The tool to resolve.</param>
<returns>The tool's file paths if any; otherwise <c>null</c>.</returns>
</member>
<member name="T:Cake.Core.Tooling.IToolResolutionStrategy">
<summary>
Represents a tool resolution strategy.
</summary>
</member>
<member name="M:Cake.Core.Tooling.IToolResolutionStrategy.Resolve(Cake.Core.Tooling.IToolRepository,System.String)">
<summary>
Resolves the specified tool using the specified tool repository.
</summary>
<param name="repository">The tool repository.</param>
<param name="tool">The tool.</param>
<returns>The path to the tool; otherwise <c>null</c>.</returns>
</member>
<member name="M:Cake.Core.Tooling.IToolResolutionStrategy.Resolve(Cake.Core.Tooling.IToolRepository,System.Collections.Generic.IEnumerable{System.String})">
<summary>
Resolves the specified tool using the specified tool repository.
</summary>
<param name="repository">The tool repository.</param>
<param name="toolExeNames">The possible names of the tool executable.</param>
<returns>The path to the tool; otherwise <c>null</c>.</returns>
</member>
<member name="T:Cake.Core.Tooling.Tool`1">
<summary>
Base class for tools.
</summary>
<typeparam name="TSettings">The settings type.</typeparam>
</member>
<member name="M:Cake.Core.Tooling.Tool`1.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IProcessRunner,Cake.Core.Tooling.IToolLocator)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Tooling.Tool`1"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="processRunner">The process runner.</param>
<param name="tools">The tool locator.</param>
</member>
<member name="M:Cake.Core.Tooling.Tool`1.Run(`0,Cake.Core.IO.ProcessArgumentBuilder)">
<summary>
Runs the tool using the specified settings.
</summary>
<param name="settings">The settings.</param>
<param name="arguments">The arguments.</param>
</member>
<member name="M:Cake.Core.Tooling.Tool`1.Run(`0,Cake.Core.IO.ProcessArgumentBuilder,Cake.Core.IO.ProcessSettings,System.Action{Cake.Core.IO.IProcess})">
<summary>
Runs the tool using a custom tool path and the specified settings.
</summary>
<param name="settings">The settings.</param>
<param name="arguments">The arguments.</param>
<param name="processSettings">The process settings.</param>
<param name="postAction">If specified called after process exit.</param>
</member>
<member name="M:Cake.Core.Tooling.Tool`1.ProcessExitCode(System.Int32)">
<summary>
Customized exit code handling.
Standard behavior is to fail when non zero.
</summary>
<param name="exitCode">The process exit code.</param>
</member>
<member name="M:Cake.Core.Tooling.Tool`1.RunProcess(`0,Cake.Core.IO.ProcessArgumentBuilder)">
<summary>
Runs the tool using a custom tool path and the specified settings.
</summary>
<param name="settings">The settings.</param>
<param name="arguments">The arguments.</param>
<returns>The process that the tool is running under.</returns>
</member>
<member name="M:Cake.Core.Tooling.Tool`1.RunProcess(`0,Cake.Core.IO.ProcessArgumentBuilder,Cake.Core.IO.ProcessSettings)">
<summary>
Runs the tool using a custom tool path and the specified settings.
</summary>
<param name="settings">The settings.</param>
<param name="arguments">The arguments.</param>
<param name="processSettings">The process settings.</param>
<returns>The process that the tool is running under.</returns>
</member>
<member name="M:Cake.Core.Tooling.Tool`1.GetToolName">
<summary>
Gets the name of the tool.
</summary>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Core.Tooling.Tool`1.GetToolExecutableNames(`0)">
<summary>
Gets the possible names of the tool executable.
</summary>
<param name="settings">The settings.</param>
<returns>The name of the tool.</returns>
</member>
<member name="M:Cake.Core.Tooling.Tool`1.GetToolExecutableNames">
<summary>
Gets the possible names of the tool executable.
</summary>
<returns>The tool executable name.</returns>
</member>
<member name="M:Cake.Core.Tooling.Tool`1.GetWorkingDirectory(`0)">
<summary>
Gets the working directory.
Defaults to the currently set working directory.
</summary>
<param name="settings">The settings.</param>
<returns>The working directory for the tool.</returns>
</member>
<member name="M:Cake.Core.Tooling.Tool`1.GetAlternativeToolPaths(`0)">
<summary>
Gets alternative file paths which the tool may exist in.
</summary>
<param name="settings">The settings.</param>
<returns>The default tool path.</returns>
</member>
<member name="M:Cake.Core.Tooling.Tool`1.GetEnvironmentVariables(`0)">
<summary>
Gets the environment variables.
</summary>
<param name="settings">The settings.</param>
<returns>The environment variables for the tool.</returns>
</member>
<member name="M:Cake.Core.Tooling.Tool`1.GetToolPath(`0)">
<summary>
Gets the resolved tool path.
</summary>
<param name="settings">The settings.</param>
<returns>The resolved tool path.</returns>
</member>
<member name="T:Cake.Core.Tooling.ToolLocator">
<summary>
Implementation of the tool locator.
</summary>
</member>
<member name="M:Cake.Core.Tooling.ToolLocator.#ctor(Cake.Core.ICakeEnvironment,Cake.Core.Tooling.IToolRepository,Cake.Core.Tooling.IToolResolutionStrategy)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Tooling.ToolLocator"/> class.
</summary>
<param name="environment">The environment.</param>
<param name="repository">The tool repository.</param>
<param name="strategy">The tool resolution strategy.</param>
</member>
<member name="M:Cake.Core.Tooling.ToolLocator.RegisterFile(Cake.Core.IO.FilePath)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.Tooling.ToolLocator.Resolve(System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.Tooling.ToolLocator.Resolve(System.Collections.Generic.IEnumerable{System.String})">
<inheritdoc/>
</member>
<member name="T:Cake.Core.Tooling.ToolRepository">
<summary>
The tool repository.
</summary>
</member>
<member name="M:Cake.Core.Tooling.ToolRepository.#ctor(Cake.Core.ICakeEnvironment)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Tooling.ToolRepository"/> class.
</summary>
<param name="environment">The environment.</param>
</member>
<member name="M:Cake.Core.Tooling.ToolRepository.Register(Cake.Core.IO.FilePath)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.Tooling.ToolRepository.Resolve(System.String)">
<inheritdoc/>
</member>
<member name="T:Cake.Core.Tooling.ToolResolutionStrategy">
<summary>
Implementation of the default tool resolution strategy.
</summary>
</member>
<member name="M:Cake.Core.Tooling.ToolResolutionStrategy.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.Core.IO.IGlobber,Cake.Core.Configuration.ICakeConfiguration,Cake.Core.Diagnostics.ICakeLog)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Tooling.ToolResolutionStrategy"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="globber">The globber.</param>
<param name="configuration">The configuration.</param>
<param name="log">The log.</param>
</member>
<member name="M:Cake.Core.Tooling.ToolResolutionStrategy.Resolve(Cake.Core.Tooling.IToolRepository,System.String)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.Tooling.ToolResolutionStrategy.Resolve(Cake.Core.Tooling.IToolRepository,System.Collections.Generic.IEnumerable{System.String})">
<inheritdoc/>
</member>
<member name="T:Cake.Core.Tooling.ToolSettings">
<summary>
Base class for tool settings.
</summary>
</member>
<member name="P:Cake.Core.Tooling.ToolSettings.ToolPath">
<summary>
Gets or sets the tool path.
</summary>
<value>The tool path.</value>
</member>
<member name="P:Cake.Core.Tooling.ToolSettings.ToolTimeout">
<summary>
Gets or sets optional timeout for tool execution.
</summary>
</member>
<member name="P:Cake.Core.Tooling.ToolSettings.WorkingDirectory">
<summary>
Gets or sets the working directory for the tool process.
</summary>
<value>The working directory for the tool process.</value>
</member>
<member name="P:Cake.Core.Tooling.ToolSettings.NoWorkingDirectory">
<summary>
Gets or sets a value indicating whether or not to opt out of using
an explicit working directory for the process.
</summary>
</member>
<member name="P:Cake.Core.Tooling.ToolSettings.ArgumentCustomization">
<summary>
Gets or sets the argument customization.
Argument customization is a way that lets you add, replace or reuse arguments passed to a tool.
This allows you to support new tool arguments, customize arguments or address potential argument issues.
</summary>
<example>
<para>Combining tool specific settings and tool arguments:</para>
<code>
NuGetAddSource("Cake", "https://www.myget.org/F/cake/api/v3/index.json",
new NuGetSourcesSettings { UserName = "user", Password = "incorrect",
ArgumentCustomization = args=>args.Append("-StorePasswordInClearText")
});
</code>
</example>
<example>
<para>Setting multiple tool arguments:</para>
<code>
MSTest(pathPattern, new MSTestSettings()
{ ArgumentCustomization = args=>args.Append("/detail:errormessage")
.Append("/resultsfile:TestResults.trx") });
</code>
</example>
<value>The delegate used to customize the <see cref="T:Cake.Core.IO.ProcessArgumentBuilder" />.</value>
</member>
<member name="P:Cake.Core.Tooling.ToolSettings.EnvironmentVariables">
<summary>
Gets or sets search paths for files, directories for temporary files, application-specific options, and other similar information.
</summary>
<example>
<code>
MSBuild("./src/Cake.sln", new MSBuildSettings {
EnvironmentVariables = new Dictionary<string, string>{
{ "TOOLSPATH", MakeAbsolute(Directory("./tools")).FullPath }
}});
</code>
</example>
</member>
<member name="P:Cake.Core.Tooling.ToolSettings.HandleExitCode">
<summary>
Gets or sets whether the exit code from the tool process causes an exception to be thrown.
<para>
If the delegate is null (the default) or returns false, then an exception is thrown upon a non-zero exit code.
</para>
<para>
If the delegate returns true then no exception is thrown.
</para>
<para>
This can be useful when the exit code should be ignored, or if there is a desire to apply logic that is conditional
on the exit code value.
</para>
</summary>
<example>
Don't throw exceptions if DotNetCoreTest returns non-zero:
<code>
DotNetCoreTest("MyProject.csproj", new DotNetCoreTestSettings {
HandleExitCode = _=> true
});
</code>
</example>
<example>
Use custom logic for exit code:
<code>
DotNetCoreTest("MyProject.csproj", new DotNetCoreTestSettings {
HandleExitCode = exitCode => exitCode switch {
0 => throw new CakeException("ZERO"),
1 => true, // treat 1 and 2 as handled "ok".
2 => true,
_ => false // everything else will throw via default implementation
};
});
</code>
</example>
</member>
<member name="P:Cake.Core.Tooling.ToolSettings.PostAction">
<summary>
Gets or sets a delegate which is executed after the process was started.
</summary>
</member>
<member name="P:Cake.Core.Tooling.ToolSettings.SetupProcessSettings">
<summary>
Gets or sets a delegate to configure the process settings.
</summary>
</member>
<member name="T:Cake.Core.Tooling.ToolSettingsExtensions">
<summary>
Contains functionality related to <see cref="T:Cake.Core.Tooling.ToolSettings" />.
</summary>
</member>
<member name="M:Cake.Core.Tooling.ToolSettingsExtensions.WithToolSettings``1(``0,System.Action{``0})">
<summary>
Provides fluent null guarded tool settings action.
</summary>
<typeparam name="T">The ToolSettings type.</typeparam>
<param name="toolSettings">The tools settings.</param>
<param name="toolSettingsAction">The tools settings action.</param>
<returns>The tools settings.</returns>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="toolSettings"/> or <paramref name="toolSettingsAction"/> is null.</exception>
</member>
<member name="M:Cake.Core.Tooling.ToolSettingsExtensions.WithToolPath``1(``0,Cake.Core.IO.FilePath)">
<summary>
Sets the tool path.
</summary>
<typeparam name="T">The ToolSettings type.</typeparam>
<param name="toolSettings">The tools settings.</param>
<param name="toolPath">The tool path.</param>
<returns>The tools settings.</returns>
</member>
<member name="M:Cake.Core.Tooling.ToolSettingsExtensions.WithToolTimeout``1(``0,System.TimeSpan)">
<summary>
Sets the tool timeout.
</summary>
<typeparam name="T">The ToolSettings type.</typeparam>
<param name="toolSettings">The tools settings.</param>
<param name="toolTimeout">The tool timeout.</param>
<returns>The tools settings.</returns>
</member>
<member name="M:Cake.Core.Tooling.ToolSettingsExtensions.WithWorkingDirectory``1(``0,Cake.Core.IO.DirectoryPath)">
<summary>
Sets the tool working directory.
</summary>
<typeparam name="T">The ToolSettings type.</typeparam>
<param name="toolSettings">The tools settings.</param>
<param name="workingDirectory">The tool working directory.</param>
<returns>The tools settings.</returns>
</member>
<member name="M:Cake.Core.Tooling.ToolSettingsExtensions.WithNoWorkingDirectory``1(``0,System.Boolean)">
<summary>
Sets whether the tool should use a working directory or not.
</summary>
<typeparam name="T">The ToolSettings type.</typeparam>
<param name="toolSettings">The tools settings.</param>
<param name="noWorkingDirectory">Flag for no working directory (default true).</param>
<returns>The tools settings.</returns>
</member>
<member name="M:Cake.Core.Tooling.ToolSettingsExtensions.WithArgumentCustomization``1(``0,System.Func{Cake.Core.IO.ProcessArgumentBuilder,Cake.Core.IO.ProcessArgumentBuilder})">
<summary>
Sets the tool argument customization delegate.
</summary>
<typeparam name="T">The ToolSettings type.</typeparam>
<param name="toolSettings">The tools settings.</param>
<param name="argumentCustomization">The tool argument customization delegate.</param>
<returns>The tools settings.</returns>
</member>
<member name="M:Cake.Core.Tooling.ToolSettingsExtensions.WithEnvironmentVariable``1(``0,System.String,System.String)">
<summary>
Sets or adds tool environment variable.
</summary>
<typeparam name="T">The ToolSettings type.</typeparam>
<param name="toolSettings">The tools settings.</param>
<param name="key">The tool environment variable key.</param>
<param name="value">The tool environment variable value.</param>
<returns>The tools settings.</returns>
</member>
<member name="M:Cake.Core.Tooling.ToolSettingsExtensions.WithHandleExitCode``1(``0,System.Func{System.Int32,System.Boolean})">
<summary>
Sets delegate whether the exit code from the tool process causes an exception to be thrown.
</summary>
<typeparam name="T">The ToolSettings type.</typeparam>
<param name="toolSettings">The tools settings.</param>
<param name="handleExitCode">The tool handle exit code delegate.</param>
<returns>The tools settings.</returns>
</member>
<member name="M:Cake.Core.Tooling.ToolSettingsExtensions.WithPostAction``1(``0,System.Action{Cake.Core.IO.IProcess})">
<summary>
Sets a delegate which is executed after the tool process was started.
</summary>
<typeparam name="T">The ToolSettings type.</typeparam>
<param name="toolSettings">The tools settings.</param>
<param name="postAction">The tool argument customization delegate.</param>
<returns>The tools settings.</returns>
</member>
<member name="M:Cake.Core.Tooling.ToolSettingsExtensions.WithSetupProcessSettings``1(``0,System.Action{Cake.Core.IO.ProcessSettings})">
<summary>
Sets a delegate to configure the process settings.
</summary>
<typeparam name="T">The ToolSettings type.</typeparam>
<param name="toolSettings">The tools settings.</param>
<param name="setupProcessSettings">The setup process settings delegate.</param>
<returns>The tools settings.</returns>
</member>
<member name="M:Cake.Core.Tooling.ToolSettingsExtensions.WithExpectedExitCode``1(``0,System.Int32)">
<summary>
Sets expected exit code using <see cref="M:Cake.Core.Tooling.ToolSettingsExtensions.WithHandleExitCode``1(``0,System.Func{System.Int32,System.Boolean})"/>.
</summary>
<typeparam name="T">The ToolSettings type.</typeparam>
<param name="toolSettings">The tools settings.</param>
<param name="expectExitCode">The tool expected exit code.</param>
<returns>The tools settings.</returns>
</member>
<member name="T:Cake.Core.Reflection.AssemblyLoader">
<summary>
Responsible for loading assemblies.
</summary>
</member>
<member name="M:Cake.Core.Reflection.AssemblyLoader.#ctor(Cake.Core.ICakeEnvironment,Cake.Core.IO.IFileSystem,Cake.Core.Reflection.IAssemblyVerifier,Cake.Core.Diagnostics.ICakeLog)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Reflection.AssemblyLoader"/> class.
</summary>
<param name="environment">The environment.</param>
<param name="fileSystem">The file system.</param>
<param name="verifier">The assembly verifier.</param>
<param name="log">The cake log.</param>
</member>
<member name="M:Cake.Core.Reflection.AssemblyLoader.Load(System.Reflection.AssemblyName)">
<inheritdoc/>
</member>
<member name="M:Cake.Core.Reflection.AssemblyLoader.Load(Cake.Core.IO.FilePath,System.Boolean)">
<inheritdoc/>
</member>
<member name="T:Cake.Core.Reflection.AssemblyVerifier">
<summary>
Responsible for verifying assemblies.
</summary>
</member>
<member name="M:Cake.Core.Reflection.AssemblyVerifier.#ctor(Cake.Core.Configuration.ICakeConfiguration,Cake.Core.Diagnostics.ICakeLog)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.Reflection.AssemblyVerifier"/> class.
</summary>
<param name="configuration">The configuration.</param>
<param name="log">The log.</param>
</member>
<member name="M:Cake.Core.Reflection.AssemblyVerifier.Verify(System.Reflection.Assembly)">
<inheritdoc/>
</member>
<member name="T:Cake.Core.Reflection.IAssemblyLoader">
<summary>
Represents an assembly loader.
</summary>
</member>
<member name="M:Cake.Core.Reflection.IAssemblyLoader.Load(System.Reflection.AssemblyName)">
<summary>
Loads an assembly from its assembly name.
</summary>
<param name="assemblyName">The assembly name.</param>
<returns>The loaded assembly.</returns>
</member>
<member name="M:Cake.Core.Reflection.IAssemblyLoader.Load(Cake.Core.IO.FilePath,System.Boolean)">
<summary>
Loads an assembly from the specified path.
</summary>
<param name="path">The assembly path to load.</param>
<param name="verify">If the assembly should be verified whether or not it will work properly with Cake or not.</param>
<returns>The loaded assembly.</returns>
</member>
<member name="T:Cake.Core.Reflection.IAssemblyVerifier">
<summary>
Represents an assembly verifier.
</summary>
</member>
<member name="M:Cake.Core.Reflection.IAssemblyVerifier.Verify(System.Reflection.Assembly)">
<summary>
Verifies an assembly.
</summary>
<param name="assembly">The target assembly.</param>
</member>
<member name="T:Cake.Core.SetupContext">
<summary>
Acts as a context providing info about the overall build following its completion.
</summary>
</member>
<member name="P:Cake.Core.SetupContext.TargetTask">
<inheritdoc/>
</member>
<member name="P:Cake.Core.SetupContext.TasksToExecute">
<inheritdoc/>
</member>
<member name="M:Cake.Core.SetupContext.#ctor(Cake.Core.ICakeContext,Cake.Core.ICakeTaskInfo,System.Collections.Generic.IEnumerable{Cake.Core.ICakeTaskInfo})">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.SetupContext"/> class.
</summary>
<param name="context">The Cake context.</param>
<param name="targetTask">The target (initiating) task.</param>
<param name="tasksToExecute">The tasks to execute.</param>
</member>
<member name="T:Cake.Core.TaskSetupContext">
<inheritdoc/>
</member>
<member name="M:Cake.Core.TaskSetupContext.#ctor(Cake.Core.ICakeContext,Cake.Core.ICakeTaskInfo)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.TaskSetupContext"/> class.
</summary>
<param name="context">The Cake Context.</param>
<param name="task">The task.</param>
</member>
<member name="P:Cake.Core.TaskSetupContext.Task">
<inheritdoc/>
</member>
<member name="T:Cake.Core.TaskTeardownContext">
<inheritdoc/>
</member>
<member name="M:Cake.Core.TaskTeardownContext.#ctor(Cake.Core.ICakeContext,Cake.Core.ICakeTaskInfo,System.TimeSpan,System.Boolean,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.TaskTeardownContext"/> class.
</summary>
<param name="context">The Cake Context.</param>
<param name="task">The task.</param>
<param name="duration">The duration of the task.</param>
<param name="skipped">if set to <c>true</c>, the task was not executed.</param>
<param name="throwException">The exception that was thrown by the task.</param>
</member>
<member name="P:Cake.Core.TaskTeardownContext.Task">
<inheritdoc/>
</member>
<member name="P:Cake.Core.TaskTeardownContext.Duration">
<inheritdoc/>
</member>
<member name="P:Cake.Core.TaskTeardownContext.Skipped">
<inheritdoc/>
</member>
<member name="P:Cake.Core.TaskTeardownContext.Successful">
<inheritdoc/>
</member>
<member name="P:Cake.Core.TaskTeardownContext.ThrownException">
<inheritdoc/>
</member>
<member name="T:Cake.Core.TeardownContext">
<inheritdoc/>
</member>
<member name="P:Cake.Core.TeardownContext.Successful">
<inheritdoc/>
</member>
<member name="P:Cake.Core.TeardownContext.ThrownException">
<inheritdoc/>
</member>
<member name="M:Cake.Core.TeardownContext.#ctor(Cake.Core.ICakeContext,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Cake.Core.TeardownContext"/> class.
</summary>
<param name="context">The Cake context.</param>
<param name="throwException">The exception that was thrown by the target.</param>
</member>
</members>
</doc>
md5: 4D06BB8AD3D399A933E74B5467FFAD50 | sha1: DCA185B6BCAB978195B48AA2B1D720F9DC8CA55F | sha256: 931BAEDAC5C38E3B90AB18354A906BBE4DA808C81CFAD7A31974A04ED73F4D97 | sha512: 21B108800FC375BE778648F503640F99EF689615E9349C4953FA9BD3455F9D427301BAB7CC106896E1AB58E4190D38B4D88DDE04A20B986481C89868606D7F0C
<?xml version="1.0"?>
<doc>
<assembly>
<name>Cake.NuGet</name>
</assembly>
<members>
<member name="F:Cake.NuGet.Constants.NuGet.Source">
<summary>
The config key name for overriding the default NuGet package source.
</summary>
</member>
<member name="F:Cake.NuGet.Constants.NuGet.UseInProcessClient">
<summary>
The config key name for using the in process client for installing packages.
</summary>
</member>
<member name="F:Cake.NuGet.Constants.NuGet.LoadDependencies">
<summary>
The config key name for enabling loading of NuGet package dependencies.
</summary>
</member>
<member name="F:Cake.NuGet.Constants.NuGet.ConfigFile">
<summary>
The config key name for overriding the default NuGet config file.
</summary>
</member>
<member name="M:Cake.NuGet.InProcessInstaller.#ctor(Cake.Core.IO.IFileSystem,Cake.Core.ICakeEnvironment,Cake.NuGet.INuGetContentResolver,Cake.Core.Diagnostics.ICakeLog,Cake.Core.Configuration.ICakeConfiguration)">
<summary>
Initializes a new instance of the <see cref="T:Cake.NuGet.InProcessInstaller"/> class.
</summary>
<param name="fileSystem">The file system.</param>
<param name="environment">The environment.</param>
<param name="contentResolver">The content resolver.</param>
<param name="log">The log.</param>
<param name="config">the configuration.</param>
</member>
<member name="T:Cake.NuGet.INuGetContentResolver">
<summary>
Represents a file locator for NuGet packages that returns relevant
files for the current framework given the resource type.
</summary>
</member>
<member name="M:Cake.NuGet.INuGetContentResolver.GetFiles(Cake.Core.IO.DirectoryPath,Cake.Core.Packaging.PackageReference,Cake.Core.Packaging.PackageType)">
<summary>
Gets the relevant files for a NuGet package
given a path and a resource type.
</summary>
<param name="path">The path to search.</param>
<param name="package">The package.</param>
<param name="type">The resource type.</param>
<returns>A collection of files.</returns>
</member>
<member name="T:Cake.NuGet.INuGetPackageInstaller">
<summary>
Represents a NuGet package installer.
</summary>
</member>
<member name="T:Cake.NuGet.NuGetModule">
<summary>
The module responsible for registering
default types in the Cake.NuGet assembly.
</summary>
</member>
<member name="M:Cake.NuGet.NuGetModule.Register(Cake.Core.Composition.ICakeContainerRegistrar)">
<inheritdoc/>
</member>
</members>
</doc>
md5: 9419F1E783F4DEF98849B8365C3369AE | sha1: FC4AC400EFDAD85163AEC6D9E3C02A27C3F6E943 | sha256: 9A405A45BFF0C04707410B1DE4479DE905C7ECB41BBE3CADF02BCD8CA3C83401 | sha512: F1F2362AF45DFEDFF57FF9E37DA31AF04D00DB1E54E5DE058E563D9A1CF0E030EF537A8B9D0DD38813B8111A11C9A7AE803C60B8AA4EE9166B28C8498757F4DC
md5: CB4C469C0F23A2DC50AE734BC50CCF2C | sha1: 2F200A1F99869D6E8DD4311D191323BFDEB70076 | sha256: 3AFD8D5BE4FC1B637E86BB7919D17B16CF9EF447A332C3DBDEADDD4E515FCDF6 | sha512: 7256EF8B45FF8518FFC78223E00143F72E4365DC84A66890C843198EF8C756D4FBBE12077467234AC23469541AEC446224EEC3A2F6D04F1782C08005DCBE1142
md5: 55BEE4FFCAE8F42FE98F49A114ADB4A5 | sha1: C3727E77530B7B0D948C47700150EEDE2A4E6100 | sha256: BD39ED8F19F3B81F756C3E0DD0D401F5C553AFA83515013E37725DD7B38C155D | sha512: C197C481B44449F1CF6F8385931EF5560FA9A781085E1D85D5711E44A3B0E93ABD01E433394823EBDBF86093CD3C7D3D679380473F49EB78B78BF5779B73A012
md5: A184FE5B2D614400BECA3FD34A4D21F9 | sha1: A45BC7AA35D36425DD170C63E89821AEAB42327F | sha256: 11E97FF5FB88E1AA744F110559A3BA433829F00B5AA99F4947FC02EC8437305D | sha512: 59F232076335935F33E25ED3EA698EA830F3E10ECAE0DB57B52C79B58DDECC7B462C29906FA3E42050331D7202DCD00DA0317A95F3C01C75EC9DCAEEA44658B6
<?xml version="1.0"?>
<doc>
<assembly>
<name>Microsoft.CodeAnalysis</name>
</assembly>
<members>
<member name="T:Microsoft.CodeAnalysis.AdditionalTextFile">
<summary>
Represents a non source code file.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.AdditionalTextFile.Path">
<summary>
Path to the file.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.AdditionalTextFile.GetText(System.Threading.CancellationToken)">
<summary>
Returns a <see cref="T:Microsoft.CodeAnalysis.Text.SourceText"/> with the contents of this file, or <c>null</c> if
there were errors reading the file.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.AdditionalTextFile.Diagnostics">
<summary>
Errors encountered when trying to read the additional file. Always empty if
<see cref="M:Microsoft.CodeAnalysis.AdditionalTextFile.GetText(System.Threading.CancellationToken)"/> has not been called.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.AbstractLookupSymbolsInfo`1.TryGetAritiesAndUniqueSymbol(System.String,Microsoft.CodeAnalysis.AbstractLookupSymbolsInfo{`0}.IArityEnumerable@,`0@)">
<summary>
If <paramref name="uniqueSymbol"/> is set, then <paramref name="arities"/> will be null.
The only arity in that case will be encoded in the symbol.
</summary>
<param name="name"></param>
<param name="arities"></param>
<param name="uniqueSymbol"></param>
<returns></returns>
</member>
<member name="T:Microsoft.CodeAnalysis.CaseInsensitiveComparison">
<summary>
Case-insensitive operations (mostly comparison) on unicode strings.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CaseInsensitiveComparison.ToLower(System.Char)">
<summary>
ToLower implements the Unicode lowercase mapping
as described in ftp://ftp.unicode.org/Public/UNIDATA/UnicodeData.txt.
VB uses these mappings for case-insensitive comparison.
</summary>
<param name="c"></param>
<returns>If <paramref name="c"/> is upper case, then this returns its Unicode lower case equivalent. Otherwise, <paramref name="c"/> is returned unmodified.</returns>
</member>
<member name="T:Microsoft.CodeAnalysis.CaseInsensitiveComparison.OneToOneUnicodeComparer">
<summary>
This class seeks to perform the lowercase Unicode case mapping.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CaseInsensitiveComparison.s_comparer">
<summary>
Returns a StringComparer that compares strings according to Unicode rules for case-insensitive
identifier comparison (lower-case mapping).
</summary>
<remarks>
These are also the rules used for VB identifier comparison.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.CaseInsensitiveComparison.Comparer">
<summary>
Returns a StringComparer that compares strings according to Unicode rules for case-insensitive
identifier comparison (lower-case mapping).
</summary>
<remarks>
These are also the rules used for VB identifier comparison.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.CaseInsensitiveComparison.Equals(System.String,System.String)">
<summary>
Determines if two strings are equal according to Unicode rules for case-insensitive
identifier comparison (lower-case mapping).
</summary>
<param name="left">First identifier to compare</param>
<param name="right">Second identifier to compare</param>
<returns>true if the identifiers should be considered the same.</returns>
<remarks>
These are also the rules used for VB identifier comparison.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.CaseInsensitiveComparison.Equals(System.ReadOnlySpan{System.Char},System.ReadOnlySpan{System.Char})">
<summary>
Determines if two strings are equal according to Unicode rules for case-insensitive
identifier comparison (lower-case mapping).
</summary>
<param name="left">First identifier to compare</param>
<param name="right">Second identifier to compare</param>
<returns>true if the identifiers should be considered the same.</returns>
<remarks>
These are also the rules used for VB identifier comparison.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.CaseInsensitiveComparison.EndsWith(System.String,System.String)">
<summary>
Determines if the string 'value' end with string 'possibleEnd'.
</summary>
<param name="value"></param>
<param name="possibleEnd"></param>
<returns></returns>
</member>
<member name="M:Microsoft.CodeAnalysis.CaseInsensitiveComparison.StartsWith(System.String,System.String)">
<summary>
Determines if the string 'value' starts with string 'possibleStart'.
</summary>
<param name="value"></param>
<param name="possibleStart"></param>
<returns></returns>
</member>
<member name="M:Microsoft.CodeAnalysis.CaseInsensitiveComparison.Compare(System.String,System.String)">
<summary>
Compares two strings according to the Unicode rules for case-insensitive
identifier comparison (lower-case mapping).
</summary>
<param name="left">First identifier to compare</param>
<param name="right">Second identifier to compare</param>
<returns>-1 if <paramref name="left"/> < <paramref name="right"/>, 1 if <paramref name="left"/> > <paramref name="right"/>, 0 if they are equal.</returns>
<remarks>
These are also the rules used for VB identifier comparison.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.CaseInsensitiveComparison.Compare(System.ReadOnlySpan{System.Char},System.ReadOnlySpan{System.Char})">
<summary>
Compares two strings according to the Unicode rules for case-insensitive
identifier comparison (lower-case mapping).
</summary>
<param name="left">First identifier to compare</param>
<param name="right">Second identifier to compare</param>
<returns>-1 if <paramref name="left"/> < <paramref name="right"/>, 1 if <paramref name="left"/> > <paramref name="right"/>, 0 if they are equal.</returns>
<remarks>
These are also the rules used for VB identifier comparison.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.CaseInsensitiveComparison.GetHashCode(System.String)">
<summary>
Gets a case-insensitive hash code for Unicode identifiers.
</summary>
<param name="value">identifier to get the hash code for</param>
<returns>The hash code for the given identifier</returns>
<remarks>
These are also the rules used for VB identifier comparison.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.CaseInsensitiveComparison.ToLower(System.String)">
<summary>
Convert a string to lower case per Unicode
</summary>
<param name="value"></param>
<returns></returns>
</member>
<member name="M:Microsoft.CodeAnalysis.CaseInsensitiveComparison.ToLower(System.Text.StringBuilder)">
<summary>
In-place convert string in StringBuilder to lower case per Unicode rules
</summary>
<param name="builder"></param>
</member>
<member name="T:Microsoft.CodeAnalysis.CodeGen.ArrayMethods">
<summary>
Constructs and caches already created pseudo-methods.
Every compiled module is supposed to have one of this, created lazily
(multidimensional arrays are not common).
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.ArrayMethods.GetArrayConstructor(Microsoft.Cci.IArrayTypeReference)">
<summary>
Acquires an array constructor for a given array type
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.ArrayMethods.GetArrayGet(Microsoft.Cci.IArrayTypeReference)">
<summary>
Acquires an element getter method for a given array type
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.ArrayMethods.GetArraySet(Microsoft.Cci.IArrayTypeReference)">
<summary>
Acquires an element setter method for a given array type
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.ArrayMethods.GetArrayAddress(Microsoft.Cci.IArrayTypeReference)">
<summary>
Acquires an element referencer method for a given array type
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CodeGen.ArrayMethods._dict">
<summary>
Maps {array type, method kind} tuples to implementing pseudo-methods.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.ArrayMethods.GetArrayMethod(Microsoft.Cci.IArrayTypeReference,Microsoft.CodeAnalysis.CodeGen.ArrayMethods.ArrayMethodKind)">
<summary>
lazily fetches or creates a new array method.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CodeGen.ArrayMethods.ArrayConstructor">
<summary>
"newobj ArrayConstructor" is equivalent of "newarr ElementType"
when working with multidimensional arrays
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CodeGen.ArrayMethods.ArrayGet">
<summary>
"call ArrayGet" is equivalent of "ldelem ElementType"
when working with multidimensional arrays
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CodeGen.ArrayMethods.ArrayAddress">
<summary>
"call ArrayAddress" is equivalent of "ldelema ElementType"
when working with multidimensional arrays
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CodeGen.ArrayMethods.ArraySet">
<summary>
"call ArraySet" is equivalent of "stelem ElementType"
when working with multidimensional arrays
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CodeGen.ArrayMethodParameterInfo">
<summary>
Represents a parameter in an array pseudo-method.
NOTE: It appears that only number of indices is used for verification,
types just have to be Int32.
Even though actual arguments can be native ints.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CodeGen.ArraySetValueParameterInfo">
<summary>
Represents the "value" parameter of the Set pseudo-method.
NOTE: unlike index parameters, type of the value parameter must match
the actual element type.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CodeGen.ArrayMethod">
<summary>
Base of all array methods. They have a lot in common.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CodeGen.ILBuilder.Reachability.NotReachable">
<summary>
Block is not reachable or reachability analysis
has not been performed.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CodeGen.ILBuilder.Reachability.Reachable">
<summary>
Block can be reached either falling through
from previous block or from branch.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CodeGen.ILBuilder.Reachability.BlockedByFinally">
<summary>
Block is reachable from try or catch but
finally prevents falling through.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeGen.ILBuilder.BasicBlock.IsBranchToLabel">
<summary>
Returns true if this block has a branch label
and is not a "nop" branch.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeGen.ILBuilder.BasicBlock.RegularInstructions">
<summary>
Instructions that are not branches.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeGen.ILBuilder.BasicBlock.HasNoRegularInstructions">
<summary>
The block contains only the final branch or nothing at all
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.ILBuilder.BasicBlock.AdjustForDelta(System.Int32)">
<summary>
Updates position of the current block to account for shorter sizes of previous blocks.
</summary>
<param name="delta"></param>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.ILBuilder.BasicBlock.ShortenBranches(System.Int32@)">
<summary>
If possible, changes the branch code of the current block to the short version and
updates the delta correspondingly.
</summary>
<param name="delta">Position delta created by previous block size reductions.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.ILBuilder.BasicBlock.OptimizeBranches(System.Int32@)">
<summary>
replaces branches with more compact code if possible.
* same branch as in the next ===> nop
* branch to the next block ===> nop
* branch to ret block ===> ret
* cond branch over uncond branch ===> flip condition, skip next block
* cond branch to equivalent ===> pop args + nop
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.ILBuilder.BasicBlock.AreIdentical(Microsoft.CodeAnalysis.CodeGen.ILBuilder.BasicBlock,Microsoft.CodeAnalysis.CodeGen.ILBuilder.BasicBlock)">
<summary>
Blocks are identical if:
1) have same regular instructions
2) lead to unconditional control transfer (no fall through)
3) branch with the same instruction to the same label
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.ILBuilder.BasicBlock.GetReversedBranchOp">
<summary>
Returns reversed branch operation for the current block.
If no reverse opcode can be obtained Nop is returned.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CodeGen.ILBuilder.EmitState">
<summary>
Abstract Execution state.
If we know something interesting about IL stream we put it here.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeGen.ILBuilder.EmitState.MaxStack">
<summary>
Eval stack's high watermark.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeGen.ILBuilder.EmitState.CurStack">
<summary>
Current evaluation stack depth.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.ILBuilder.EmitState.AdjustStack(System.Int32)">
<summary>
Record effects of that currently emitted instruction on the eval stack.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CodeGen.ILBuilder._allocatedILMarkers">
<summary>
In some cases we have to get a final IL offset during emit phase, for example for
proper emitting sequence points. The problem is that before the builder is realized we
don't know the actual IL offset, but only {block/offset-in-the-block} pair.
Thus, whenever we need to mark some IL position we allocate a new marker id, store it
in allocatedILMarkers and reference this IL marker in the entity requiring the IL offset.
IL markers will be 'materialized' when the builder is realized; the resulting offsets
will be put into allocatedILMarkers array. Note that only markers from reachable blocks
are materialized, the rest will have offset -1.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.ILBuilder.Realize">
<summary>
Realizes method body.
No more data can be added to the builder after this call.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.ILBuilder.GetAllScopes">
<summary>
Gets all scopes that contain variables.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.ILBuilder.GetHoistedLocalScopes">
<summary>
Gets all scopes that contain variables.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeGen.ILBuilder.InstructionsEmitted">
<summary>
IL opcodes emitted by this builder.
This includes branch instructions that end blocks except if they are fall-through NOPs.
This count allows compilers to see if emitting a particular statement/expression
actually produced any instructions.
Example: a label will not result in any code so when emitting debugging information
an extra NOP may be needed if we want to decorate the label with sequence point.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.ILBuilder.MarkReachableBlocks">
<summary>
Marks blocks that are reachable.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.ILBuilder.MarkReachableFrom(Microsoft.CodeAnalysis.PooledObjects.ArrayBuilder{Microsoft.CodeAnalysis.CodeGen.ILBuilder.BasicBlock},Microsoft.CodeAnalysis.CodeGen.ILBuilder.BasicBlock)">
<summary>
Marks blocks that are recursively reachable from the given block.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.ILBuilder.OptimizeLabels">
<summary>
If a label points to a block that does nothing other than passing to block X,
replaces target label's block with block X.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.ILBuilder.DropUnreachableBlocks">
<summary>
Drops blocks that are not reachable
Returns true if any blocks were dropped
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.ILBuilder.MarkAllBlocksUnreachable">
<summary>
Marks all blocks unreachable.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.ILBuilder.RewriteSpecialBlocks">
<summary>
Rewrite any block marked as BlockedByFinally as an "infinite loop".
</summary>
<remarks>
Matches the code generated by the native compiler in
ILGENREC::AdjustBlockedLeaveTargets.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.ILBuilder.IsSpecialEndHandlerBlock(Microsoft.CodeAnalysis.CodeGen.ILBuilder.BasicBlock)">
<summary>
Returns true if the block has the signature of the special
labeled block that follows a complete try/catch or try/finally.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.ILBuilder.ComputeOffsetsAndAdjustBranches">
<summary>
Returns true if any branches were optimized (that does not include shortening)
We need this because optimizing a branch may result in unreachable code that needs to be eliminated.
=== Example:
x = 1;
if (blah)
{
global = 1;
}
else
{
throw null;
}
return x;
=== rewrites into
push 1;
if (blah)
{
global = 1;
ret;
}
else
{
throw null;
}
// this ret unreachable now!
// even worse - empty stack is assumed thus the ret is illegal.
ret;
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.ILBuilder.DefineSequencePoint(Microsoft.CodeAnalysis.SyntaxTree,Microsoft.CodeAnalysis.Text.TextSpan)">
<summary>
Define a sequence point with the given syntax tree and span within it.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.ILBuilder.DefineHiddenSequencePoint">
<summary>
Defines a hidden sequence point.
The effect of this is that debugger will not associate following code
with any source (until it sees a lexically following sequence point).
This is used for synthetic code that is reachable through labels.
If such code is not separated from previous sequence point by the means of a hidden sequence point
It looks as a part of the statement that previous sequence point specifies.
As a result, when user steps through the code and goes through a jump to such label,
it will appear as if the jump landed at the beginning of the previous statement.
NOTE: Also inserted as the first statement of a method that would not otherwise have a leading
sequence point so that step-into will find the method body.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.ILBuilder.DefineInitialHiddenSequencePoint">
<summary>
Define a hidden sequence point at the first statement of
the method so that step-into will find the method body.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.ILBuilder.SetInitialDebugDocument(Microsoft.CodeAnalysis.SyntaxTree)">
<summary>
This is called when starting emitting a method for which there is some source.
It is done in case the first sequence point is a hidden point.
Even though hidden points do not have syntax, they need to associate with some document.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.ILBuilder.MarkFilterConditionEnd">
<summary>
Marks the end of filter condition and start of the actual filter handler.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.ILBuilder.AddLocalToScope(Microsoft.CodeAnalysis.CodeGen.LocalDefinition)">
<summary>
Puts local variable into current scope.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.ILBuilder.AddLocalConstantToScope(Microsoft.CodeAnalysis.CodeGen.LocalConstantDefinition)">
<summary>
Puts local constant into current scope.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.ILBuilder.MarkLabel(System.Object)">
<summary>
Mark current IL position with a label
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.ILBuilder.EmitStringSwitchJumpTable(System.Collections.Generic.KeyValuePair{Microsoft.CodeAnalysis.ConstantValue,System.Object}[],System.Object,Microsoft.CodeAnalysis.CodeGen.LocalOrParameter,Microsoft.CodeAnalysis.CodeGen.LocalDefinition,Microsoft.CodeAnalysis.CodeGen.SwitchStringJumpTableEmitter.EmitStringCompareAndBranch,Microsoft.CodeAnalysis.CodeGen.SwitchStringJumpTableEmitter.GetStringHashCode)">
<summary>
Primary method for emitting string switch jump table
</summary>
<param name="caseLabels">switch case labels</param>
<param name="fallThroughLabel">fall through label for the jump table</param>
<param name="key">Local holding the value to switch on.
This value has already been loaded onto the execution stack.
</param>
<param name="keyHash">Local holding the hash value of the key for emitting
hash table switch. Hash value has already been computed and loaded into keyHash.
This parameter is null if emitting non hash table switch.
</param>
<param name="emitStringCondBranchDelegate">
Delegate to emit string compare call and conditional branch based on the compare result.
</param>
<param name="computeStringHashcodeDelegate">
Delegate to compute string hash consistent with value of keyHash.
</param>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.ILBuilder.EmitIntegerSwitchJumpTable(System.Collections.Generic.KeyValuePair{Microsoft.CodeAnalysis.ConstantValue,System.Object}[],System.Object,Microsoft.CodeAnalysis.CodeGen.LocalOrParameter,Microsoft.Cci.PrimitiveTypeCode)">
<summary>
Primary method for emitting integer switch jump table.
</summary>
<param name="caseLabels">switch case labels</param>
<param name="fallThroughLabel">fall through label for the jump table.</param>
<param name="key">Local or parameter holding the value to switch on.
This value has already been loaded onto the execution stack.
</param>
<param name="keyTypeCode">Primitive type code of switch key.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.ILBuilder.FinishFilterCondition">
<summary>
Finishes filter condition (and starts actual handler portion of the handler).
Returns the last block of the condition.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.ILBuilder.EmitArrayCreation(Microsoft.Cci.IArrayTypeReference,Microsoft.CodeAnalysis.SyntaxNode,Microsoft.CodeAnalysis.DiagnosticBag)">
<summary>
Generates code that creates an instance of multidimensional array
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.ILBuilder.EmitArrayElementLoad(Microsoft.Cci.IArrayTypeReference,Microsoft.CodeAnalysis.SyntaxNode,Microsoft.CodeAnalysis.DiagnosticBag)">
<summary>
Generates code that loads an element of a multidimensional array
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.ILBuilder.EmitArrayElementAddress(Microsoft.Cci.IArrayTypeReference,Microsoft.CodeAnalysis.SyntaxNode,Microsoft.CodeAnalysis.DiagnosticBag)">
<summary>
Generates code that loads an address of an element of a multidimensional array.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.ILBuilder.EmitArrayElementStore(Microsoft.Cci.IArrayTypeReference,Microsoft.CodeAnalysis.SyntaxNode,Microsoft.CodeAnalysis.DiagnosticBag)">
<summary>
Generates code that stores an element of a multidimensional array.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CodeGen.ILBuilder.LabelInfo">
<summary>
Contains information about a label.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CodeGen.ILBuilder.LabelInfo.targetOfConditionalBranches">
<summary>
Sometimes we need to know if a label is targeted by conditional branches.
For example optimizer can do optimizations of branches into outer try scopes only
if they are unconditional (because there are no conditional Leave opcodes)
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.ILBuilder.LabelInfo.#ctor(System.Int32,System.Boolean)">
<summary>
Used when we see a branch, but label is not yet marked.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.ILBuilder.LabelInfo.#ctor(Microsoft.CodeAnalysis.CodeGen.ILBuilder.BasicBlock,System.Int32,System.Boolean)">
<summary>
Used when label is marked to the code.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.ILBuilder.LocalScopeManager.GetAllScopesWithLocals">
<summary>
Gets all scopes that contain variables.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.ILBuilder.LocalScopeManager.GetExceptionHandlerRegions">
<summary>
Returns an ExceptionHandlerRegion for each exception handler clause
beneath the root scope. Each ExceptionHandlerRegion indicates the type
of clause (catch or finally) and the bounds of the try block and clause block.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CodeGen.ILBuilder.ScopeInfo">
<summary>
Base class for IL scopes where a scope contains IL blocks and other nested
scopes. A scope may represent a scope for variable declarations, an exception
handler clause, or an entire exception handler (multiple clauses).
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.ILBuilder.ScopeInfo.GetLocalScopes(Microsoft.CodeAnalysis.PooledObjects.ArrayBuilder{Microsoft.Cci.LocalScope})">
<summary>
Recursively calculates the start and end of the given scope.
Only scopes with locals are actually dumped to the list.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.ILBuilder.ScopeInfo.GetHoistedLocalScopes(Microsoft.CodeAnalysis.PooledObjects.ArrayBuilder{Microsoft.CodeAnalysis.Debugging.StateMachineHoistedLocalScope})">
<summary>
Recursively calculates the start and end of the given scope.
Only scopes with locals are actually dumped to the list.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.ILBuilder.ScopeInfo.FreeBasicBlocks">
<summary>
Free any basic blocks owned by this scope or sub-scopes.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CodeGen.ILBuilder.LocalScopeInfo">
<summary>
Class that collects content of the scope (blocks, nested scopes, variables etc).
There is one for every opened scope.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CodeGen.ILBuilder.ExceptionHandlerScope">
<summary>
A scope for a single try, catch, or finally clause. If the clause
is a catch clause, ExceptionType will be set.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CodeGen.ILBuilder.ExceptionHandlerContainerScope">
<summary>
A scope for an entire exception handler (a try block with either several
catches or a finally block). Unlike other scopes, this scope contains
nested scopes only, no IL blocks (although nested ExceptionHandlerScopes
for the clauses will contain IL blocks).
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CodeGen.ILBuilder.ScopeComparer">
<summary>
Compares scopes by their start (ascending) and then size (descending).
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CodeGen.DebugId">
<summary>
Unique identification of an emitted entity (method, lambda, closure) used for debugging purposes (EnC).
</summary>
<remarks>
When used for a synthesized method the ordinal and generation numbers are included its name.
For user defined methods the ordinal is included in Custom Debug Information record attached to the method.
</remarks>
</member>
<member name="F:Microsoft.CodeAnalysis.CodeGen.DebugId.Ordinal">
<summary>
The index of the method in member list of the containing type, or <see cref="F:Microsoft.CodeAnalysis.CodeGen.DebugId.UndefinedOrdinal"/> if undefined.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CodeGen.DebugId.Generation">
<summary>
The EnC generation the method was defined in (0 is the baseline build).
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.ILOpCodeExtensions.IsControlTransfer(System.Reflection.Metadata.ILOpCode)">
<summary>
These opcodes represent control transfer.
They should not appear inside basic blocks.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.ILOpCodeExtensions.CanFallThrough(System.Reflection.Metadata.ILOpCode)">
<summary>
Opcodes that represents a branch to a label.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CodeGen.ItemTokenMap`1">
<summary>
Handles storage of items referenced via tokens in metadata. When items are stored
they are uniquely "associated" with fake tokens, which are basically sequential numbers.
IL gen will use these fake tokens during codegen and later, when actual values
are known, the method bodies will be patched.
To support these two scenarios we need two maps - Item-->uint, and uint-->Item. (The second is really just a list).
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.ITokenDeferral.GetReferenceFromToken(System.UInt32)">
<summary>
Gets the <see cref="T:Microsoft.Cci.IReference"/> or <see cref="T:Microsoft.Cci.ISignature"/> corresponding to this token.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CodeGen.LambdaDebugInfo">
<summary>
Debug information maintained for each lambda.
</summary>
<remarks>
The information is emitted to PDB in Custom Debug Information record for a method containing the lambda.
</remarks>
</member>
<member name="F:Microsoft.CodeAnalysis.CodeGen.LambdaDebugInfo.SyntaxOffset">
<summary>
The syntax offset of the syntax node declaring the lambda (lambda expression) or its body (lambda in a query).
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CodeGen.LambdaDebugInfo.ClosureOrdinal">
<summary>
The ordinal of the closure frame the lambda belongs to, or
<see cref="F:Microsoft.CodeAnalysis.CodeGen.LambdaDebugInfo.StaticClosureOrdinal"/> if the lambda is static, or
<see cref="F:Microsoft.CodeAnalysis.CodeGen.LambdaDebugInfo.ThisOnlyClosureOrdinal"/> if the lambda is closed over "this" pointer only.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CodeGen.LocalConstantDefinition">
<summary>
We need a CCI representation for local constants because they are emitted as locals in
PDB scopes to improve the debugging experience (see LocalScopeProvider.GetConstantsInScope).
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CodeGen.LocalDebugId">
<summary>
Id that associates an emitted user-defined or long-lived synthesized local variable
with a syntax node that defined it. If a syntax node defines multiple variables it
provides information necessary to identify which one of these variables is it.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CodeGen.LocalDebugId.SyntaxOffset">
<summary>
We calculate a "syntax offset" for each user-defined and long-lived synthesized variable.
Every such variable symbol has to be associated with a syntax node (its declarator).
In usual cases this is the textual distance of the declarator from the start of the method body.
It gets a bit complicated when the containing method body is not contiguous (constructors).
If the variable is in the body of the constructor the definition of syntax offset is the same.
If the variable is defined in a constructor initializer or in a member initializer
(this is only possible when declaration expressions or closures in primary constructors are involved)
then the distance is a negative sum of the widths of all the initializers that succeed the declarator
of the variable in the emitted constructor body plus the relative offset of the declarator from
the start of the containing initializer.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CodeGen.LocalDebugId.Ordinal">
<summary>
If a single node is a declarator for multiple variables of the same synthesized kind (it can only happen for synthesized variables)
we calculate additional number "ordinal" for such variable. We assign the ordinals to the synthesized variables with the same kind
and syntax offset in the order as they appear in the lowered bound tree. It is important that a valid EnC edit can't change
the ordinal of a synthesized variable. If it could it would need to be assigned a different kind or associated with a different declarator node.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CodeGen.LocalDefinition._pdbAttributes">
<see cref="P:Microsoft.Cci.ILocalDefinition.PdbAttributes"/>.
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.LocalDefinition.#ctor(Microsoft.CodeAnalysis.Symbols.ILocalSymbolInternal,System.String,Microsoft.Cci.ITypeReference,System.Int32,Microsoft.CodeAnalysis.SynthesizedLocalKind,Microsoft.CodeAnalysis.CodeGen.LocalDebugId,System.Reflection.Metadata.LocalVariableAttributes,Microsoft.CodeAnalysis.LocalSlotConstraints,System.Collections.Immutable.ImmutableArray{System.Boolean},System.Collections.Immutable.ImmutableArray{System.String})">
<summary>
Creates a new LocalDefinition.
</summary>
<param name="symbolOpt">Local symbol, used by edit and continue only, null otherwise.</param>
<param name="nameOpt">Name associated with the slot.</param>
<param name="type">Type associated with the slot.</param>
<param name="slot">Slot position in the signature.</param>
<param name="synthesizedKind">Local kind.</param>
<param name="id">Local id.</param>
<param name="pdbAttributes">Value to emit in the attributes field in the PDB.</param>
<param name="constraints">Specifies whether slot type should have pinned modifier and whether slot should have byref constraint.</param>
<param name="dynamicTransformFlags">The synthesized dynamic attributes of the local.</param>
<param name="tupleElementNames">Tuple element names of the local.</param>
</member>
<member name="T:Microsoft.CodeAnalysis.CodeGen.LocalSlotManager">
<summary>
At this level there are two kinds of local variables:
<list type="bullet">
<item>
Locals - have identities by which consuming code refers to them.
Typical use is a local variable or a compiler generated temp that can be accessed in multiple operations.
Any object can be used as identity. Reference equality is used.
</item>
<item>
Temps - do not have identity. They are borrowed and returned to the free list.
Typical use is a scratch temporary or spilling storage.
</item>
</list>
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CodeGen.LocalSlotManager.LocalSignature">
<summary>
Structure that represents a local signature (as in <a href="http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-335.pdf">ECMA-335</a>, Partition I, §8.6.1.3 Local signatures).
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.LocalSlotManager.GetLocal(Microsoft.CodeAnalysis.Symbols.ILocalSymbolInternal)">
<summary>
Retrieve a local slot by its symbol.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.LocalSlotManager.FreeLocal(Microsoft.CodeAnalysis.Symbols.ILocalSymbolInternal)">
<summary>
Release a local slot by its symbol.
Slot is not associated with symbol after this.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.LocalSlotManager.AllocateSlot(Microsoft.Cci.ITypeReference,Microsoft.CodeAnalysis.LocalSlotConstraints,System.Collections.Immutable.ImmutableArray{System.Boolean},System.Collections.Immutable.ImmutableArray{System.String})">
<summary>
Gets a local slot.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.LocalSlotManager.FreeSlot(Microsoft.CodeAnalysis.CodeGen.LocalDefinition)">
<summary>
Frees a local slot.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CodeGen.MetadataCreateArray">
<summary>
An expression that creates an array instance in metadata. Only for use in custom attributes.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CodeGen.MetadataNamedArgument">
<summary>
An expression that represents a (name, value) pair and that is typically used in method calls, custom attributes and object initializers.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeGen.MetadataNamedArgument.Microsoft#Cci#IMetadataNamedArgument#ArgumentName">
<summary>
The name of the parameter or property or field that corresponds to the argument.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeGen.MetadataNamedArgument.Microsoft#Cci#IMetadataNamedArgument#ArgumentValue">
<summary>
The value of the argument.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeGen.MetadataNamedArgument.Microsoft#Cci#IMetadataNamedArgument#IsField">
<summary>
True if the named argument provides the value of a field.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CodeGen.MetadataTypeOf">
<summary>
An expression that results in a System.Type instance.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeGen.MetadataTypeOf.TypeToGet">
<summary>
The type that will be represented by the System.Type instance.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CodeGen.MethodBody">
<summary>
Holds on to the method body data.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeGen.MethodBody.Microsoft#Cci#IMethodBody#ImportScope">
<summary>
This is a list of the using directives that were in scope for this method body.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeGen.MethodBody.HasStackalloc">
<summary>
True if there's a stackalloc somewhere in the method.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CodeGen.PermissionSetAttributeWithFileReference">
<summary>
This class represents the PermissionSetAttribute specified in source which needs fixup during codegen.
</summary>
<remarks>
PermissionSetAttribute needs fixup when it contains an assignment to the 'File' property as a single named attribute argument.
Fixup performed is ported from SecurityAttributes::FixUpPermissionSetAttribute at ndp\clr\src\vm\securityattributes.cpp.
It involves following steps:
1) Verifying that the specified file name resolves to a valid path: This is done during binding.
2) Reading the contents of the file into a byte array.
3) Convert each byte in the file content into two bytes containing hexadecimal characters (see method <see cref="M:Microsoft.CodeAnalysis.CodeGen.PermissionSetAttributeWithFileReference.ConvertToHex(System.IO.Stream)"/>).
4) Replacing the 'File = fileName' named argument with 'Hex = hexFileContent' argument, where hexFileContent is the converted output from step 3) above.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.PermissionSetAttributeWithFileReference.GetArguments(Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
Zero or more positional arguments for the attribute constructor.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.PermissionSetAttributeWithFileReference.Constructor(Microsoft.CodeAnalysis.Emit.EmitContext,System.Boolean)">
<summary>
A reference to the constructor that will be used to instantiate this custom attribute during execution (if the attribute is inspected via Reflection).
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.PermissionSetAttributeWithFileReference.GetNamedArguments(Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
Zero or more named arguments that specify values for fields and properties of the attribute.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeGen.PermissionSetAttributeWithFileReference.ArgumentCount">
<summary>
The number of positional arguments.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeGen.PermissionSetAttributeWithFileReference.NamedArgumentCount">
<summary>
The number of named arguments.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.PermissionSetAttributeWithFileReference.GetType(Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
The type of the attribute. For example System.AttributeUsageAttribute.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CodeGen.PermissionSetFileReadException">
<summary>
Exception class to enable generating ERR_PermissionSetAttributeFileReadError while reading the file for PermissionSetAttribute fixup.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CodeGen.PrivateImplementationDetails">
<summary>
TypeDefinition that represents <PrivateImplementationDetails> class.
The main purpose of this class so far is to contain mapped fields and their types.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CodeGen.ExplicitSizeStruct">
<summary>
Simple struct type with explicit size and no members.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CodeGen.MappedField">
<summary>
Definition of a simple field mapped to a metadata block
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CodeGen.DefaultTypeDef">
<summary>
Just a default implementation of a type definition.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CodeGen.RawSequencePoint">
<summary>
Represents a sequence point before translation by #line/ExternalSource directives.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CodeGen.ReferenceDependencyWalker">
<summary>
Some features of the compiler (such as anonymous types, pay-as-you-go, NoPIA, ...)
rely on all referenced symbols to go through translate mechanism. Because by default
symbol translator does not translate some of indirectly referenced symbols, such as
type argument, we have to force translation here
This class provides unified implementation for this functionality.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CodeGen.ScopeType.StateMachineVariable">
<summary>
Scope of user-defined variable hoisted to state machine.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CodeGen.SequencePointList">
<summary>
Maintains a list of sequence points in a space efficient way. Most of the time sequence points
occur in the same syntax tree, so optimize for that case. Store a sequence point as an offset, and
position in a syntax tree, then translate to CCI format only on demand.
Use a ArrayBuilder{RawSequencePoint} to create.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.SequencePointList.Create(Microsoft.CodeAnalysis.PooledObjects.ArrayBuilder{Microsoft.CodeAnalysis.CodeGen.RawSequencePoint},Microsoft.CodeAnalysis.CodeGen.ILBuilder)">
<summary>
Create a SequencePointList with the raw sequence points from an ArrayBuilder.
A linked list of instances for each syntax tree is created (almost always of length one).
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.SequencePointList.GetSequencePoints(Microsoft.CodeAnalysis.CodeGen.DebugDocumentProvider,Microsoft.CodeAnalysis.PooledObjects.ArrayBuilder{Microsoft.Cci.SequencePoint})">
<summary>
Get all the sequence points, possibly mapping them using #line/ExternalSource directives, and mapping
file names to debug documents with the given mapping function.
</summary>
<param name="documentProvider">Function that maps file paths to CCI debug documents</param>
<param name="builder">where sequence points should be deposited</param>
</member>
<member name="T:Microsoft.CodeAnalysis.CodeGen.SequencePointList.OffsetAndSpan">
<summary>
Represents the combination of an IL offset and a source text span.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CodeGen.SignatureOnlyLocalDefinition">
<summary>
A local whose type is represented by a metadata signature instead of a type symbol.
</summary>
<remarks>
Used when emitting a new version of a method during EnC for variables that are no longer used.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeGen.SignatureOnlyLocalDefinition.PdbAttributes">
<remarks>
This temp is not interesting to the expression compiler. However, it
may be replaced by an interesting local in a later stage.
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.CodeGen.SwitchIntegralJumpTableEmitter">
<summary>
Class for emitting the switch jump table for switch statements with integral governing type
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CodeGen.SwitchIntegralJumpTableEmitter._key">
<summary>
Switch key for the jump table
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CodeGen.SwitchIntegralJumpTableEmitter._keyTypeCode">
<summary>
Primitive type of the switch key
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CodeGen.SwitchIntegralJumpTableEmitter._fallThroughLabel">
<summary>
Fall through label for the jump table
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CodeGen.SwitchIntegralJumpTableEmitter._sortedCaseLabels">
<summary>
Integral case labels sorted and indexed by their ConstantValue
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeGen.SwitchIntegralJumpTableEmitter.SwitchBucket.IsDegenerate">
<summary>
Degenerate buckets here are buckets with contiguous range of constants
leading to the same label. Like:
case 0:
case 1:
case 2:
case 3:
DoOneThing();
break;
case 4:
case 5:
case 6:
case 7:
DoAnotherThing();
break;
NOTE: A trivial bucket with only one case constant is by definition degenerate.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.SwitchIntegralJumpTableEmitter.SwitchBucket.TryMergeWith(Microsoft.CodeAnalysis.CodeGen.SwitchIntegralJumpTableEmitter.SwitchBucket)">
<summary>
Try to merge with the nextBucket.
If merge results in a better bucket than two original ones, merge and return true.
Else don't merge and return false.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CodeGen.SwitchStringJumpTableEmitter._key">
<summary>
Switch key for the jump table
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CodeGen.SwitchStringJumpTableEmitter._caseLabels">
<summary>
Switch case labels
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CodeGen.SwitchStringJumpTableEmitter._fallThroughLabel">
<summary>
Fall through label for the jump table
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CodeGen.SwitchStringJumpTableEmitter.EmitStringCompareAndBranch">
<summary>
Delegate to emit string compare call and conditional branch based on the compare result.
</summary>
<param name="key">Key to compare</param>
<param name="stringConstant">Case constant to compare the key against</param>
<param name="targetLabel">Target label to branch to if key = stringConstant</param>
</member>
<member name="T:Microsoft.CodeAnalysis.CodeGen.SwitchStringJumpTableEmitter.GetStringHashCode">
<summary>
Delegate to compute string hash code.
This piece is language-specific because VB treats "" and null as equal while C# does not.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CodeGen.SwitchStringJumpTableEmitter._emitStringCondBranchDelegate">
<summary>
Delegate to emit string compare call
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CodeGen.SwitchStringJumpTableEmitter._computeStringHashcodeDelegate">
<summary>
Delegate to emit string hash
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CodeGen.SwitchStringJumpTableEmitter._keyHash">
<summary>
Local storing the key hash value, used for emitting hash table based string switch.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CodeGen.SynthesizedLocalOrdinalsDispenser">
<summary>
Dispenser of unique ordinals for synthesized variable names that have the same kind and syntax offset.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CodeGen.TokenMap">
<summary>
Handles storage of items referenced via tokens in metadata (strings or Symbols).
When items are stored they are uniquely "associated" with fake token, which is basically
a sequential number.
IL gen will use these fake tokens during codegen and later, when actual token values are known
the method bodies will be patched.
To support these two scenarios we need two maps - Item-->uint, and uint-->Item. (the second is really just a list).
This map supports tokens of type <see cref="T:Microsoft.Cci.ISignature"/> and <see cref="T:Microsoft.Cci.IReference"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.VariableSlotAllocator.TryGetPreviousHoistedLocalSlotIndex(Microsoft.CodeAnalysis.SyntaxNode,Microsoft.Cci.ITypeReference,Microsoft.CodeAnalysis.SynthesizedLocalKind,Microsoft.CodeAnalysis.CodeGen.LocalDebugId,Microsoft.CodeAnalysis.DiagnosticBag,System.Int32@)">
<summary>
Returns an index of a slot that stores specified hoisted local variable in the previous generation.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeGen.VariableSlotAllocator.PreviousHoistedLocalSlotCount">
<summary>
Number of slots reserved for hoisted local variables.
</summary>
<remarks>
Some of the slots might not be used anymore (a variable might have been deleted or its type changed).
Still, new hoisted variables are assigned slots starting with <see cref="P:Microsoft.CodeAnalysis.CodeGen.VariableSlotAllocator.PreviousHoistedLocalSlotCount"/>.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.VariableSlotAllocator.TryGetPreviousAwaiterSlotIndex(Microsoft.Cci.ITypeReference,Microsoft.CodeAnalysis.DiagnosticBag,System.Int32@)">
<summary>
Returns true and an index of a slot that stores an awaiter of a specified type in the previous generation, if any.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeGen.VariableSlotAllocator.PreviousAwaiterSlotCount">
<summary>
Number of slots reserved for awaiters.
</summary>
<remarks>
Some of the slots might not be used anymore (the type of an awaiter might have changed).
Still, new awaiters are assigned slots starting with <see cref="P:Microsoft.CodeAnalysis.CodeGen.VariableSlotAllocator.PreviousAwaiterSlotCount"/>.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeGen.VariableSlotAllocator.MethodId">
<summary>
The id of the method, or null if the method wasn't assigned one.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.VariableSlotAllocator.TryGetPreviousClosure(Microsoft.CodeAnalysis.SyntaxNode,Microsoft.CodeAnalysis.CodeGen.DebugId@)">
<summary>
Finds a closure in the previous generation that corresponds to the specified syntax.
</summary>
<remarks>
See LambdaFrame.AssertIsLambdaScopeSyntax for kinds of syntax nodes that represent closures.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.CodeGen.VariableSlotAllocator.TryGetPreviousLambda(Microsoft.CodeAnalysis.SyntaxNode,System.Boolean,Microsoft.CodeAnalysis.CodeGen.DebugId@)">
<summary>
Finds a lambda in the previous generation that corresponds to the specified syntax.
The <paramref name="lambdaOrLambdaBodySyntax"/> is either a lambda syntax (<paramref name="isLambdaBody"/> is false),
or lambda body syntax (<paramref name="isLambdaBody"/> is true).
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.ArrayBuilderExtensions.SelectAsArray``2(Microsoft.CodeAnalysis.PooledObjects.ArrayBuilder{``0},System.Func{``0,``1})">
<summary>
Maps an array builder to immutable array.
</summary>
<typeparam name="TItem"></typeparam>
<typeparam name="TResult"></typeparam>
<param name="items">The array to map</param>
<param name="map">The mapping delegate</param>
<returns>If the items's length is 0, this will return an empty immutable array</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.ArrayBuilderExtensions.SelectAsArray``3(Microsoft.CodeAnalysis.PooledObjects.ArrayBuilder{``0},System.Func{``0,``1,``2},``1)">
<summary>
Maps an array builder to immutable array.
</summary>
<typeparam name="TItem"></typeparam>
<typeparam name="TArg"></typeparam>
<typeparam name="TResult"></typeparam>
<param name="items">The sequence to map</param>
<param name="map">The mapping delegate</param>
<param name="arg">The extra input used by mapping delegate</param>
<returns>If the items's length is 0, this will return an empty immutable array.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.BitVector.Create(System.Int32)">
<summary>
Create BitArray with at least the specified number of bits.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.BitVector.AllSet(System.Int32)">
<summary>
return a bit array with all bits set from index 0 through bitCount-1
</summary>
<param name="capacity"></param>
<returns></returns>
</member>
<member name="M:Microsoft.CodeAnalysis.BitVector.Clone">
<summary>
Make a copy of a bit array.
</summary>
<returns></returns>
</member>
<member name="M:Microsoft.CodeAnalysis.BitVector.Invert">
<summary>
Invert all the bits in the vector.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.BitVector.IsNull">
<summary>
Is the given bit array null?
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.BitVector.IntersectWith(Microsoft.CodeAnalysis.BitVector@)">
<summary>
Modify this bit vector by bitwise AND-ing each element with the other bit vector.
For the purposes of the intersection, any bits beyond the current length will be treated as zeroes.
Return true if any changes were made to the bits of this bit vector.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.BitVector.UnionWith(Microsoft.CodeAnalysis.BitVector@)">
<summary>
Modify this bit vector by '|'ing each element with the other bit vector.
</summary>
<returns>
True if any bits were set as a result of the union.
</returns>
</member>
<member name="T:Microsoft.CodeAnalysis.Collections.CachingDictionary`2">
<summary>
The CachingLookup class provides a convenient representation of an ILookup that is based
upon a potentially slow lookup, and caches lookup results so that subsequent lookups are
fast. Internally a ConcurrentDictionary is used to cache lookup results. The client provides
two delegates to perform lookups: One that maps a key to a IEnumerable of values, and one
that provides all keys.
The client must provide an IEqualityComparer used for comparing keys. Failed lookups are
cached, but that has the disadvantage that every different failed lookup will consume a
small amount of extra memory. However, that memory can be reclaimed by forcing a full
population of the cache.
Thread safe.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Collections.CachingDictionary`2.#ctor(System.Func{`0,System.Collections.Immutable.ImmutableArray{`1}},System.Func{System.Collections.Generic.IEqualityComparer{`0},System.Collections.Generic.HashSet{`0}},System.Collections.Generic.IEqualityComparer{`0})">
<summary>
Create a CachingLookup.
</summary>
<param name="getElementsOfKey">A function that takes a key, and returns an IEnumerable of values that
correspond to that key. If no values correspond, the function may either return null or an empty
IEnumerable.</param>
<param name="getKeys">A function that returns an IEnumerable of all keys that have associated values.</param>
<param name="comparer">A IEqualityComparer used to compare keys.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Collections.CachingDictionary`2.Contains(`0)">
<summary>
Does this key have one or more associated values?
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Collections.CachingDictionary`2.Item(`0)">
<summary>
Get the values associated with a key.
</summary>
<param name="key">Key to look up.</param>
<returns>All values associated with key. Returns an empty IEnumerable if
no values are associated. Never returns null.</returns>
</member>
<member name="P:Microsoft.CodeAnalysis.Collections.CachingDictionary`2.Count">
<summary>
Get the number of distinct keys.
Forces a full population of the cache.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Collections.CachingDictionary`2.Keys">
<summary>
Enumerate all the keys.
Forces a full population of the cache.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Collections.CachingDictionary`2.AddValues(Microsoft.CodeAnalysis.PooledObjects.ArrayBuilder{`1})">
<summary>
Add the values from all keys to a flat array.
Forces a full population of the cache.
</summary>
<param name="array"></param>
</member>
<member name="M:Microsoft.CodeAnalysis.Collections.CachingDictionary`2.CreateConcurrentDictionary">
<summary>
Create an instance of the concurrent dictionary.
</summary>
<returns>The concurrent dictionary</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Collections.CachingDictionary`2.CreateDictionaryForFullyPopulatedMap(System.Int32)">
<summary>
Create a dictionary instance suitable for use as the fully populated map.
</summary>
<returns>A new, empty dictionary, suitable for use as the fully populated map.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Collections.CachingDictionary`2.GetOrCreateValue(`0)">
<summary>
Use the underlying (possibly slow) functions to get the values associated with a key.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Collections.CachingDictionary`2.AddToConcurrentMap(System.Collections.Concurrent.ConcurrentDictionary{`0,System.Collections.Immutable.ImmutableArray{`1}},`0)">
<summary>
Add a new value with the given key to the given concurrent map.
</summary>
<param name="map">The concurrent map to augment.</param>
<param name="key">The key of the new entry.</param>
<returns>The added entry. If there was a race, and another thread beat this one, then this returns the previously added entry.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Collections.CachingDictionary`2.IsNotFullyPopulatedMap(System.Collections.Generic.IDictionary{`0,System.Collections.Immutable.ImmutableArray{`1}})">
<summary>
Determines if the given map is fully populated.
</summary>
<param name="existingMap">The map to test.</param>
<returns>true if the map is fully populated.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Collections.CachingDictionary`2.CreateFullyPopulatedMap(System.Collections.Generic.IDictionary{`0,System.Collections.Immutable.ImmutableArray{`1}})">
<summary>
Create the fully populated map from an existing map and the key generator.
</summary>
<param name="existingMap">The existing map which may be null or a ConcurrentDictionary.</param>
<returns></returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Collections.CachingDictionary`2.EnsureFullyPopulated">
<summary>
Fully populate the underlying dictionary. Once this returns, the dictionary is guaranteed
to have every key in it.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Collections.OrderPreservingMultiDictionary`2">
<summary>
A MultiDictionary that allows only adding, and preserves the order of values added to the
dictionary. Thread-safe for reading, but not for adding.
</summary>
<remarks>
Always uses the default comparer.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.Collections.OrderPreservingMultiDictionary`2.Add(`0,`1)">
<summary>
Add a value to the dictionary.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Collections.OrderPreservingMultiDictionary`2.Item(`0)">
<summary>
Get all values associated with K, in the order they were added.
Returns empty read-only array if no values were present.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Collections.OrderPreservingMultiDictionary`2.Keys">
<summary>
Get a collection of all the keys.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Collections.OrderPreservingMultiDictionary`2.ValueSet._value">
<summary>
Each value is either a single V or an <see cref="T:Microsoft.CodeAnalysis.PooledObjects.ArrayBuilder`1"/>.
Never null.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Collections.SmallConcurrentSetOfInts">
<summary>
A set of ints that is small, thread-safe and lock free.
Several assumptions have been made that allow it to be small and fast:
1. Deletes never happen.
2. The size is small. In dogfooding experiments, 89% had 4 or fewer elements and
98% had 8 or fewer elements. The largest size was 17.
3. As a result of assumption 2, linear look-up is good enough.
4. One value, in this case int.MinValue, is used as a sentinel and may never appear in the set.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Collections.SmallConcurrentSetOfInts.Contains(System.Int32)">
<summary>
Determine if the given integer appears in the set.
</summary>
<param name="i">The value to look up.</param>
<returns>true if <paramref name="i"/> appears in the set. false otherwise.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Collections.SmallConcurrentSetOfInts.Add(System.Int32)">
<summary>
Insert the given value into the set.
</summary>
<param name="i">The value to insert</param>
<returns>true if <paramref name="i"/> was added. false if it was already present.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Collections.SmallConcurrentSetOfInts.AddHelper(System.Int32@,System.Int32,System.Boolean@)">
<summary>
If the given slot is unoccupied, then try to replace it with a new value.
</summary>
<param name="slot">The slot to examine.</param>
<param name="i">The new value to insert if the slot is unoccupied.</param>
<param name="added">An out param indicating whether the slot was successfully updated.</param>
<returns>true if the value in the slot either now contains, or already contained <paramref name="i"/>. false otherwise.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Collections.Internal.HashHelpers.GetFastModMultiplier(System.UInt32)">
<summary>Returns approximate reciprocal of the divisor: ceil(2**64 / divisor).</summary>
<remarks>This should only be used on 64-bit.</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.Collections.Internal.HashHelpers.FastMod(System.UInt32,System.UInt32,System.UInt64)">
<summary>Performs a mod operation using the multiplier pre-computed with <see cref="M:Microsoft.CodeAnalysis.Collections.Internal.HashHelpers.GetFastModMultiplier(System.UInt32)"/>.</summary>
<remarks>
PERF: This improves performance in 64-bit scenarios at the expense of performance in 32-bit scenarios. Since
we only build a single AnyCPU binary, we opt for improved performance in the 64-bit scenario.
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.Collections.Internal.InsertionBehavior">
<summary>
Used internally to control behavior of insertion into a <see cref="T:System.Collections.Generic.Dictionary`2"/> or <see cref="T:System.Collections.Generic.HashSet`1"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Collections.Internal.InsertionBehavior.None">
<summary>
The default insertion behavior.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Collections.Internal.InsertionBehavior.OverwriteExisting">
<summary>
Specifies that an existing entry with the same key should be overwritten if encountered.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Collections.Internal.InsertionBehavior.ThrowOnExisting">
<summary>
Specifies that if an existing entry with the same key is encountered, an exception should be thrown.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Collections.Internal.RoslynUnsafe.NullRef``1">
<summary>
Returns a by-ref to type <typeparamref name="T"/> that is a null reference.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Collections.Internal.RoslynUnsafe.IsNullRef``1(``0@)">
<summary>
Returns if a given by-ref to type <typeparamref name="T"/> is a null reference.
</summary>
<remarks>
This check is conceptually similar to <c>(void*)(&source) == nullptr</c>.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.Collections.Internal.SegmentedArrayHelper.CalculateSegmentSize(System.Int32)">
<summary>
Calculates the maximum number of elements of size <paramref name="elementSize"/> which can fit into an array
which has the following characteristics:
<list type="bullet">
<item><description>The array can be allocated in the small object heap.</description></item>
<item><description>The array length is a power of 2.</description></item>
</list>
</summary>
<param name="elementSize">The size of the elements in the array.</param>
<returns>The segment size to use for small object heap segmented arrays.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Collections.Internal.SegmentedArrayHelper.CalculateSegmentShift(System.Int32)">
<summary>
Calculates a shift which can be applied to an absolute index to get the page index within a segmented array.
</summary>
<param name="segmentSize">The number of elements in each page of the segmented array. Must be a power of 2.</param>
<returns>The shift to apply to the absolute index to get the page index within a segmented array.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Collections.Internal.SegmentedArrayHelper.CalculateOffsetMask(System.Int32)">
<summary>
Calculates a mask, which can be applied to an absolute index to get the index within a page of a segmented
array.
</summary>
<param name="segmentSize">The number of elements in each page of the segmented array. Must be a power of 2.</param>
<returns>The bit mask to obtain the index within a page from an absolute index within a segmented array.</returns>
</member>
<member name="P:Microsoft.CodeAnalysis.Collections.Internal.SR.Arg_ArrayPlusOffTooSmall">
<summary>Destination array is not long enough to copy all the items in the collection. Check array index and length.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Collections.Internal.SR.Arg_HTCapacityOverflow">
<summary>Hashtable's capacity overflowed and went negative. Check load factor, capacity and the current size of the table.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Collections.Internal.SR.Arg_KeyNotFoundWithKey">
<summary>The given key '{0}' was not present in the dictionary.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Collections.Internal.SR.Arg_LongerThanDestArray">
<summary>Destination array was not long enough. Check the destination index, length, and the array's lower bounds.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Collections.Internal.SR.Arg_LongerThanSrcArray">
<summary>Source array was not long enough. Check the source index, length, and the array's lower bounds.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Collections.Internal.SR.Arg_NonZeroLowerBound">
<summary>The lower bound of target array must be zero.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Collections.Internal.SR.Arg_RankMultiDimNotSupported">
<summary>Only single dimensional arrays are supported for the requested action.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Collections.Internal.SR.Arg_WrongType">
<summary>The value "{0}" is not of type "{1}" and cannot be used in this generic collection.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Collections.Internal.SR.Argument_AddingDuplicateWithKey">
<summary>An item with the same key has already been added. Key: {0}</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Collections.Internal.SR.Argument_InvalidArrayType">
<summary>Target array type is not compatible with the type of items in the collection.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Collections.Internal.SR.Argument_InvalidOffLen">
<summary>Offset and length were out of bounds for the array or count is greater than the number of elements from index to the end of the source collection.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Collections.Internal.SR.ArgumentOutOfRange_ArrayLB">
<summary>Number was less than the array's lower bound in the first dimension.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Collections.Internal.SR.ArgumentOutOfRange_BiggerThanCollection">
<summary>Larger than collection size.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Collections.Internal.SR.ArgumentOutOfRange_Count">
<summary>Count must be positive and count must refer to a location within the string/array/collection.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Collections.Internal.SR.ArgumentOutOfRange_Index">
<summary>Index was out of range. Must be non-negative and less than the size of the collection.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Collections.Internal.SR.ArgumentOutOfRange_ListInsert">
<summary>Index must be within the bounds of the List.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Collections.Internal.SR.ArgumentOutOfRange_NeedNonNegNum">
<summary>Non-negative number required.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Collections.Internal.SR.ArgumentOutOfRange_SmallCapacity">
<summary>capacity was less than the current size.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Collections.Internal.SR.InvalidOperation_ConcurrentOperationsNotSupported">
<summary>Operations that change non-concurrent collections must have exclusive access. A concurrent update was performed on this collection and corrupted its state. The collection's state is no longer correct.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Collections.Internal.SR.InvalidOperation_EnumFailedVersion">
<summary>Collection was modified; enumeration operation may not execute.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Collections.Internal.SR.InvalidOperation_EnumOpCantHappen">
<summary>Enumeration has either not started or has already finished.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Collections.Internal.SR.InvalidOperation_IComparerFailed">
<summary>Failed to compare two elements in the array.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Collections.Internal.SR.NotSupported_KeyCollectionSet">
<summary>Mutating a key collection derived from a dictionary is not allowed.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Collections.Internal.SR.NotSupported_ValueCollectionSet">
<summary>Mutating a value collection derived from a dictionary is not allowed.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Collections.Internal.SR.Rank_MustMatch">
<summary>The specified arrays must have the same number of dimensions.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Collections.Internal.SR.NotSupported_FixedSizeCollection">
<summary>Collection was of a fixed size.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Collections.Internal.SR.ArgumentException_OtherNotArrayOfCorrectLength">
<summary>Object is not a array with the same number of elements as the array to compare it to.</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Collections.SegmentedArray.Clear``1(Microsoft.CodeAnalysis.Collections.SegmentedArray{``0},System.Int32,System.Int32)">
<seealso cref="M:System.Array.Clear(System.Array,System.Int32,System.Int32)"/>
</member>
<member name="M:Microsoft.CodeAnalysis.Collections.SegmentedArray.Copy``1(Microsoft.CodeAnalysis.Collections.SegmentedArray{``0},Microsoft.CodeAnalysis.Collections.SegmentedArray{``0},System.Int32)">
<seealso cref="M:System.Array.Copy(System.Array,System.Array,System.Int32)"/>
</member>
<member name="T:Microsoft.CodeAnalysis.Collections.SegmentedArray`1">
<summary>
Defines a fixed-size collection with the same API surface and behavior as an "SZArray", which is a
single-dimensional zero-based array commonly represented in C# as <c>T[]</c>. The implementation of this
collection uses segmented arrays to avoid placing objects on the Large Object Heap.
</summary>
<typeparam name="T">The type of elements stored in the array.</typeparam>
</member>
<member name="F:Microsoft.CodeAnalysis.Collections.SegmentedArray`1.s_segmentSize">
<summary>
The number of elements in each page of the segmented array of type <typeparamref name="T"/>.
</summary>
<remarks>
<para>The segment size is calculated according to <see cref="M:System.Runtime.CompilerServices.Unsafe.SizeOf``1"/>, performs the IL operation
defined by <see cref="F:System.Reflection.Emit.OpCodes.Sizeof"/>. ECMA-335 defines this operation with the following note:</para>
<para><c>sizeof</c> returns the total size that would be occupied by each element in an array of this type –
including any padding the implementation chooses to add. Specifically, array elements lie <c>sizeof</c>
bytes apart.</para>
</remarks>
</member>
<member name="F:Microsoft.CodeAnalysis.Collections.SegmentedArray`1.s_segmentShift">
<summary>
The bit shift to apply to an array index to get the page index within <see cref="F:Microsoft.CodeAnalysis.Collections.SegmentedArray`1._items"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Collections.SegmentedArray`1.s_offsetMask">
<summary>
The bit mask to apply to an array index to get the index within a page of <see cref="F:Microsoft.CodeAnalysis.Collections.SegmentedArray`1._items"/>.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Collections.SegmentedDictionary`2">
<summary>
Represents a collection of keys and values.
</summary>
<remarks>
<para>This collection has the same performance characteristics as <see cref="T:System.Collections.Generic.Dictionary`2"/>, but
uses segmented arrays to avoid allocations in the Large Object Heap.</para>
</remarks>
<typeparam name="TKey">The type of the keys in the dictionary.</typeparam>
<typeparam name="TValue">The type of the values in the dictionary.</typeparam>
</member>
<member name="M:Microsoft.CodeAnalysis.Collections.SegmentedDictionary`2.EnsureCapacity(System.Int32)">
<summary>
Ensures that the dictionary can hold up to 'capacity' entries without any further expansion of its backing storage
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Collections.SegmentedDictionary`2.TrimExcess">
<summary>
Sets the capacity of this dictionary to what it would be if it had been originally initialized with all its entries
</summary>
<remarks>
This method can be used to minimize the memory overhead
once it is known that no new elements will be added.
To allocate minimum size storage array, execute the following statements:
dictionary.Clear();
dictionary.TrimExcess();
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.Collections.SegmentedDictionary`2.TrimExcess(System.Int32)">
<summary>
Sets the capacity of this dictionary to hold up 'capacity' entries without any further expansion of its backing storage
</summary>
<remarks>
This method can be used to minimize the memory overhead
once it is known that no new elements will be added.
</remarks>
</member>
<member name="F:Microsoft.CodeAnalysis.Collections.SegmentedDictionary`2.Entry._next">
<summary>
0-based index of next entry in chain: -1 means end of chain
also encodes whether this entry _itself_ is part of the free list by changing sign and subtracting 3,
so -2 means end of free list, -3 means index 0 but on free list, -4 means index 1 but on free list, etc.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.ConsListExtensions">
<summary>
Extension methods associated with ConsList.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.DictionaryExtensions">
<summary>
The collection of extension methods for the <see cref="T:System.Collections.Generic.Dictionary`2"/> type
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.DictionaryExtensions.GetOrAdd``2(System.Collections.Generic.Dictionary{``0,``1},``0,``1)">
<summary>
If the given key is not found in the dictionary, add it with the given value and return the value.
Otherwise return the existing value associated with that key.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Grouping`2">
<summary>
A simple class to implement IGrouping.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.IdentifierCollection">
<summary>
A dictionary that maps strings to all known spellings of that string. Can be used to
efficiently store the set of known type names for a module for both VB and C# while also
answering questions like "do you have a type called Goo" in either a case sensitive or
insensitive manner.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.ImmutableArrayExtensions">
<summary>
The collection of extension methods for the <see cref="T:System.Collections.Immutable.ImmutableArray`1"/> type
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.ImmutableArrayExtensions.AsImmutable``1(System.Collections.Generic.IEnumerable{``0})">
<summary>
Converts a sequence to an immutable array.
</summary>
<typeparam name="T">Elemental type of the sequence.</typeparam>
<param name="items">The sequence to convert.</param>
<returns>An immutable copy of the contents of the sequence.</returns>
<exception cref="T:System.ArgumentNullException">If items is null (default)</exception>
<remarks>If the sequence is null, this will throw <see cref="T:System.ArgumentNullException"/></remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.ImmutableArrayExtensions.AsImmutableOrEmpty``1(System.Collections.Generic.IEnumerable{``0})">
<summary>
Converts a sequence to an immutable array.
</summary>
<typeparam name="T">Elemental type of the sequence.</typeparam>
<param name="items">The sequence to convert.</param>
<returns>An immutable copy of the contents of the sequence.</returns>
<remarks>If the sequence is null, this will return an empty array.</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.ImmutableArrayExtensions.AsImmutableOrNull``1(System.Collections.Generic.IEnumerable{``0})">
<summary>
Converts a sequence to an immutable array.
</summary>
<typeparam name="T">Elemental type of the sequence.</typeparam>
<param name="items">The sequence to convert.</param>
<returns>An immutable copy of the contents of the sequence.</returns>
<remarks>If the sequence is null, this will return the default (null) array.</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.ImmutableArrayExtensions.AsImmutable``1(``0[])">
<summary>
Converts an array to an immutable array. The array must not be null.
</summary>
<typeparam name="T"></typeparam>
<param name="items">The sequence to convert</param>
<returns></returns>
</member>
<member name="M:Microsoft.CodeAnalysis.ImmutableArrayExtensions.AsImmutableOrNull``1(``0[])">
<summary>
Converts a array to an immutable array.
</summary>
<typeparam name="T"></typeparam>
<param name="items">The sequence to convert</param>
<returns></returns>
<remarks>If the sequence is null, this will return the default (null) array.</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.ImmutableArrayExtensions.AsImmutableOrEmpty``1(``0[])">
<summary>
Converts an array to an immutable array.
</summary>
<typeparam name="T"></typeparam>
<param name="items">The sequence to convert</param>
<returns>If the array is null, this will return an empty immutable array.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.ImmutableArrayExtensions.ToImmutable(System.IO.MemoryStream)">
<summary>
Reads bytes from specified <see cref="T:System.IO.MemoryStream"/>.
</summary>
<param name="stream">The stream.</param>
<returns>Read-only content of the stream.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.ImmutableArrayExtensions.SelectAsArray``2(System.Collections.Immutable.ImmutableArray{``0},System.Func{``0,``1})">
<summary>
Maps an immutable array to another immutable array.
</summary>
<typeparam name="TItem"></typeparam>
<typeparam name="TResult"></typeparam>
<param name="items">The array to map</param>
<param name="map">The mapping delegate</param>
<returns>If the items's length is 0, this will return an empty immutable array</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.ImmutableArrayExtensions.SelectAsArray``3(System.Collections.Immutable.ImmutableArray{``0},System.Func{``0,``1,``2},``1)">
<summary>
Maps an immutable array to another immutable array.
</summary>
<typeparam name="TItem"></typeparam>
<typeparam name="TArg"></typeparam>
<typeparam name="TResult"></typeparam>
<param name="items">The sequence to map</param>
<param name="map">The mapping delegate</param>
<param name="arg">The extra input used by mapping delegate</param>
<returns>If the items's length is 0, this will return an empty immutable array.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.ImmutableArrayExtensions.SelectAsArray``3(System.Collections.Immutable.ImmutableArray{``0},System.Func{``0,System.Int32,``1,``2},``1)">
<summary>
Maps an immutable array to another immutable array.
</summary>
<typeparam name="TItem"></typeparam>
<typeparam name="TArg"></typeparam>
<typeparam name="TResult"></typeparam>
<param name="items">The sequence to map</param>
<param name="map">The mapping delegate</param>
<param name="arg">The extra input used by mapping delegate</param>
<returns>If the items's length is 0, this will return an empty immutable array.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.ImmutableArrayExtensions.SelectAsArray``2(System.Collections.Immutable.ImmutableArray{``0},System.Func{``0,System.Boolean},System.Func{``0,``1})">
<summary>
Maps a subset of immutable array to another immutable array.
</summary>
<typeparam name="TItem">Type of the source array items</typeparam>
<typeparam name="TResult">Type of the transformed array items</typeparam>
<param name="array">The array to transform</param>
<param name="predicate">The condition to use for filtering the array content.</param>
<param name="selector">A transform function to apply to each element that is not filtered out by <paramref name="predicate"/>.</param>
<returns>If the items's length is 0, this will return an empty immutable array.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.ImmutableArrayExtensions.SelectAsArrayAsync``2(System.Collections.Immutable.ImmutableArray{``0},System.Func{``0,System.Threading.Tasks.ValueTask{``1}})">
<summary>
Maps an immutable array through a function that returns ValueTasks, returning the new ImmutableArray.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.ImmutableArrayExtensions.ZipAsArray``3(System.Collections.Immutable.ImmutableArray{``0},System.Collections.Immutable.ImmutableArray{``1},System.Func{``0,``1,``2})">
<summary>
Zips two immutable arrays together through a mapping function, producing another immutable array.
</summary>
<returns>If the items's length is 0, this will return an empty immutable array.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.ImmutableArrayExtensions.WhereAsArray``1(System.Collections.Immutable.ImmutableArray{``0},System.Func{``0,System.Boolean})">
<summary>
Creates a new immutable array based on filtered elements by the predicate. The array must not be null.
</summary>
<param name="array">The array to process</param>
<param name="predicate">The delegate that defines the conditions of the element to search for.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.ImmutableArrayExtensions.WhereAsArray``2(System.Collections.Immutable.ImmutableArray{``0},System.Func{``0,``1,System.Boolean},``1)">
<summary>
Creates a new immutable array based on filtered elements by the predicate. The array must not be null.
</summary>
<param name="array">The array to process</param>
<param name="predicate">The delegate that defines the conditions of the element to search for.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.ImmutableArrayExtensions.Cast``2(System.Collections.Immutable.ImmutableArray{``0})">
<summary>
Casts the immutable array of a Type to an immutable array of its base type.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.ImmutableArrayExtensions.SetEquals``1(System.Collections.Immutable.ImmutableArray{``0},System.Collections.Immutable.ImmutableArray{``0},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Determines whether this instance and another immutable array are equal.
</summary>
<typeparam name="T"></typeparam>
<param name="array1"></param>
<param name="array2"></param>
<param name="comparer">The comparer to determine if the two arrays are equal.</param>
<returns>True if the two arrays are equal</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.ImmutableArrayExtensions.NullToEmpty``1(System.Collections.Immutable.ImmutableArray{``0})">
<summary>
Returns an empty array if the input array is null (default)
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.ImmutableArrayExtensions.Distinct``1(System.Collections.Immutable.ImmutableArray{``0},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Returns an array of distinct elements, preserving the order in the original array.
If the array has no duplicates, the original array is returned. The original array must not be null.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Rope">
<summary>
A representation of a string of characters that requires O(1) extra space to concatenate two ropes.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Rope.ForString(System.String)">
<summary>
A rope can wrap a simple string.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Rope.Concat(Microsoft.CodeAnalysis.Rope,Microsoft.CodeAnalysis.Rope)">
<summary>
A rope can be formed from the concatenation of two ropes.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Rope.Equals(System.Object)">
<summary>
Two ropes are "the same" if they represent the same sequence of characters.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Rope.StringRope">
<summary>
A rope that wraps a simple string.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Rope.ConcatRope">
<summary>
A rope that represents the concatenation of two ropes.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.SmallDictionary`2">
<summary>
Dictionary designed to hold small number of items.
Compared to the regular Dictionary, average overhead per-item is roughly the same, but
unlike regular dictionary, this one is based on an AVL tree and as such does not require
rehashing when items are added.
It does require rebalancing, but that is allocation-free.
Major caveats:
1) There is no Remove method. (can be added, but we do not seem to use Remove that much)
2) foreach [keys|values|pairs] may allocate a small array.
3) Performance is no longer O(1). At a certain count it becomes slower than regular Dictionary.
In comparison to regular Dictionary on my machine:
On trivial number of elements (5 or so) it is more than 2x faster.
The break even count is about 120 elements for read and 55 for write operations (with unknown initial size).
At UShort.MaxValue elements, this dictionary is 6x slower to read and 4x slower to write
Generally, this dictionary is a win if number of elements is small, not known beforehand or both.
If the size of the dictionary is known at creation and it is likely to contain more than 10 elements,
then regular Dictionary is a better choice.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.TopologicalSort">
<summary>
A helper class that contains a topological sort algorithm.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.TopologicalSort.TryIterativeSort``1(System.Collections.Generic.IEnumerable{``0},System.Func{``0,System.Collections.Immutable.ImmutableArray{``0}},System.Collections.Immutable.ImmutableArray{``0}@)">
<summary>
Produce a topological sort of a given directed acyclic graph, given a set of nodes which include all nodes
that have no predecessors. Any nodes not in the given set, but reachable through successors, will be added
to the result. This is an iterative rather than recursive implementation, so it is unlikely to cause a stack
overflow.
</summary>
<typeparam name="TNode">The type of the node</typeparam>
<param name="nodes">Any subset of the nodes that includes all nodes with no predecessors</param>
<param name="successors">A function mapping a node to its set of successors</param>
<param name="result">A list of all reachable nodes, in which each node always precedes its successors</param>
<returns>true if successful; false if not successful due to cycles in the graph</returns>
</member>
<member name="T:Microsoft.CodeAnalysis.UnionCollection`1">
<summary>
Implements a readonly collection over a set of existing collections. This can be used to
prevent having to copy items from one collection over to another (thus bloating space).
Note: this is a *collection*, not a *set*. There is no removal of duplicated elements. This
allows us to be able to efficiently do operations like CopyTo, Count, etc. in O(c) time
instead of O(n) (where 'c' is the number of collections and 'n' is the number of elements).
If you have a few collections with many elements in them, then this is an appropriate
collection for you.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.AnalyzerConfig">
<summary>
Represents a single EditorConfig file, see https://editorconfig.org for details about the format.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.AnalyzerConfig.GlobalKey">
<summary>
Key that indicates if this config is a global config
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.AnalyzerConfig.GlobalLevelKey">
<summary>
Key that indicates the precedence of this config when <see cref="P:Microsoft.CodeAnalysis.AnalyzerConfig.IsGlobal"/> is true
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.AnalyzerConfig.UserGlobalConfigName">
<summary>
Filename that indicates this file is a user provided global config
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.AnalyzerConfig.ReservedKeys">
<summary>
A set of keys that are reserved for special interpretation for the editorconfig specification.
All values corresponding to reserved keys in a (key,value) property pair are always lowercased
during parsing.
</summary>
<remarks>
This list was retrieved from https://github.com/editorconfig/editorconfig/wiki/EditorConfig-Properties
at 2018-04-21 19:37:05Z. New keys may be added to this list in newer versions, but old ones will
not be removed.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.AnalyzerConfig.ReservedValues">
<summary>
A set of values that are reserved for special use for the editorconfig specification
and will always be lower-cased by the parser.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.AnalyzerConfig.NormalizedDirectory">
<summary>
The directory the editorconfig was contained in, with all directory separators
replaced with '/'.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.AnalyzerConfig.PathToFile">
<summary>
The path passed to <see cref="M:Microsoft.CodeAnalysis.AnalyzerConfig.Parse(System.String,System.String)"/> during construction.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.AnalyzerConfig.DirectoryLengthComparer">
<summary>
Comparer for sorting <see cref="T:Microsoft.CodeAnalysis.AnalyzerConfig"/> files by <see cref="P:Microsoft.CodeAnalysis.AnalyzerConfig.NormalizedDirectory"/> path length.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.AnalyzerConfig.IsRoot">
<summary>
Gets whether this editorconfig is a topmost editorconfig.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.AnalyzerConfig.IsGlobal">
<summary>
Gets whether this editorconfig is a global editorconfig.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.AnalyzerConfig.GlobalLevel">
<summary>
Get the global level of this config, used to resolve conflicting keys
</summary>
<remarks>
A user can explicitly set the global level via the <see cref="F:Microsoft.CodeAnalysis.AnalyzerConfig.GlobalLevelKey"/>.
When no global level is explicitly set, we use a heuristic:
<list type="bullet">
<item><description>
Any file matching the <see cref="F:Microsoft.CodeAnalysis.AnalyzerConfig.UserGlobalConfigName"/> is determined to be a user supplied global config and gets a level of 100
</description></item>
<item><description>
Any other file gets a default level of 0
</description></item>
</list>
This value is unused when <see cref="P:Microsoft.CodeAnalysis.AnalyzerConfig.IsGlobal"/> is <c>false</c>.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.AnalyzerConfig.Parse(System.String,System.String)">
<summary>
Parses an editor config file text located at the given path. No parsing
errors are reported. If any line contains a parse error, it is dropped.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.AnalyzerConfig.Parse(Microsoft.CodeAnalysis.Text.SourceText,System.String)">
<summary>
Parses an editor config file text located at the given path. No parsing
errors are reported. If any line contains a parse error, it is dropped.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.AnalyzerConfig.Section">
<summary>
Represents a named section of the editorconfig file, which consists of a name followed by a set
of key-value pairs.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.AnalyzerConfig.Section.NameComparer">
<summary>
Used to compare <see cref="P:Microsoft.CodeAnalysis.AnalyzerConfig.Section.Name"/>s of sections. Specified by editorconfig to
be a case-sensitive comparison.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.AnalyzerConfig.Section.NameEqualityComparer">
<summary>
Used to compare <see cref="P:Microsoft.CodeAnalysis.AnalyzerConfig.Section.Name"/>s of sections. Specified by editorconfig to
be a case-sensitive comparison.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.AnalyzerConfig.Section.PropertiesKeyComparer">
<summary>
Used to compare keys in <see cref="P:Microsoft.CodeAnalysis.AnalyzerConfig.Section.Properties"/>. The editorconfig spec defines property
keys as being compared case-insensitively according to Unicode lower-case rules.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.AnalyzerConfig.Section.Name">
<summary>
The name as present directly in the section specification of the editorconfig file.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.AnalyzerConfig.Section.Properties">
<summary>
Keys and values for this section. All keys are lower-cased according to the
EditorConfig specification and keys are compared case-insensitively. Values are
lower-cased if the value appears in <see cref="P:Microsoft.CodeAnalysis.AnalyzerConfig.ReservedValues" />
or if the corresponding key is in <see cref="P:Microsoft.CodeAnalysis.AnalyzerConfig.ReservedKeys" />. Otherwise,
the values are the literal values present in the source.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.AnalyzerConfig.TryCreateSectionNameMatcher(System.String)">
<summary>
Takes a <see cref="P:Microsoft.CodeAnalysis.AnalyzerConfig.Section.Name"/> and creates a matcher that
matches the given language. Returns null if the section name is
invalid.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.AnalyzerConfig.IsAbsoluteEditorConfigPath(System.String)">
<summary>
Test if a section name is an absolute path with no special chars
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.AnalyzerConfig.TryCompilePathList(Microsoft.CodeAnalysis.AnalyzerConfig.SectionNameLexer@,System.Text.StringBuilder,System.Boolean,Microsoft.CodeAnalysis.PooledObjects.ArrayBuilder{System.ValueTuple{System.Int32,System.Int32}})">
<summary>
<![CDATA[
<path-list> ::= <path-item> | <path-item> <path-list>
<path-item> ::= "*" | "**" | "?" | <char> | <choice> | <range>
<char> ::= any unicode character
<choice> ::= "{" <choice-list> "}"
<choice-list> ::= <path-list> | <path-list> "," <choice-list>
]]>
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.AnalyzerConfig.TryCompileCharacterClass(Microsoft.CodeAnalysis.AnalyzerConfig.SectionNameLexer@,System.Text.StringBuilder)">
<summary>
Compile a globbing character class of the form [...]. Returns true if
the character class was successfully compiled. False if there was a syntax
error. The starting character is expected to be directly after the '['.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.AnalyzerConfig.TryCompileChoice(Microsoft.CodeAnalysis.AnalyzerConfig.SectionNameLexer@,System.Text.StringBuilder,Microsoft.CodeAnalysis.PooledObjects.ArrayBuilder{System.ValueTuple{System.Int32,System.Int32}})">
<summary>
Parses choice defined by the following grammar:
<![CDATA[
<choice> ::= "{" <choice-list> "}"
<choice-list> ::= <path-list> | <path-list> "," <choice-list>
]]>
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.AnalyzerConfig.TryParseNumberRange(Microsoft.CodeAnalysis.AnalyzerConfig.SectionNameLexer@)">
<summary>
Parses range defined by the following grammar.
<![CDATA[
<range> ::= "{" <integer> ".." <integer> "}"
<integer> ::= "-" <digit-list> | <digit-list>
<digit-list> ::= <digit> | <digit> <digit-list>
<digit> ::= 0-9
]]>
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.AnalyzerConfig.SectionNameLexer.EatCurrentCharacter">
<summary>
Call after getting <see cref="F:Microsoft.CodeAnalysis.AnalyzerConfig.TokenKind.SimpleCharacter" /> from <see cref="M:Microsoft.CodeAnalysis.AnalyzerConfig.SectionNameLexer.Lex" />
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.AnalyzerConfig.SectionNameLexer.TryEatCurrentCharacter(System.Char@)">
<summary>
Returns false if there are no more characters in the lex stream.
Otherwise, produces the next character in the stream and returns true.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.AnalyzerConfig.SectionNameLexer.TryLexNumber">
<summary>
Returns the string representation of a decimal integer, or null if
the current lexeme is not an integer.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.AnalyzerConfigOptionsResult">
<summary>
Holds results from <see cref="M:Microsoft.CodeAnalysis.AnalyzerConfigSet.GetOptionsForSourcePath(System.String)"/>.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.AnalyzerConfigOptionsResult.TreeOptions">
<summary>
Options that customize diagnostic severity as reported by the compiler.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.AnalyzerConfigOptionsResult.AnalyzerOptions">
<summary>
Options that do not have any special compiler behavior and are passed to analyzers as-is.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.AnalyzerConfigOptionsResult.Diagnostics">
<summary>
Any produced diagnostics while applying analyzer configuration.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.AnalyzerConfigSet">
<summary>
Represents a set of <see cref="T:Microsoft.CodeAnalysis.AnalyzerConfig"/>, and can compute the effective analyzer options for a given source file. This is used to
collect all the <see cref="T:Microsoft.CodeAnalysis.AnalyzerConfig"/> files for that would apply to a compilation.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.AnalyzerConfigSet._analyzerConfigs">
<summary>
The list of <see cref="T:Microsoft.CodeAnalysis.AnalyzerConfig" />s in this set. This list has been sorted per <see cref="P:Microsoft.CodeAnalysis.AnalyzerConfig.DirectoryLengthComparer"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.AnalyzerConfigSet._analyzerMatchers">
<summary>
<see cref="T:Microsoft.CodeAnalysis.AnalyzerConfig.SectionNameMatcher"/>s for each section. The entries in the outer array correspond to entries in <see cref="F:Microsoft.CodeAnalysis.AnalyzerConfigSet._analyzerConfigs"/>, and each inner array
corresponds to each <see cref="P:Microsoft.CodeAnalysis.AnalyzerConfig.NamedSections"/>.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.AnalyzerConfigSet.GlobalConfigOptions">
<summary>
Gets an <see cref="T:Microsoft.CodeAnalysis.AnalyzerConfigOptionsResult"/> that contain the options that apply globally
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.AnalyzerConfigSet.GetOptionsForSourcePath(System.String)">
<summary>
Returns a <see cref="T:Microsoft.CodeAnalysis.AnalyzerConfigOptionsResult"/> for a source file. This computes which <see cref="T:Microsoft.CodeAnalysis.AnalyzerConfig"/> rules applies to this file, and correctly applies
precedence rules if there are multiple rules for the same file.
</summary>
<param name="sourcePath">The path to a file such as a source file or additional file. Must be non-null.</param>
<remarks>This method is safe to call from multiple threads.</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.AnalyzerConfigSet.MergeGlobalConfigs(Microsoft.CodeAnalysis.PooledObjects.ArrayBuilder{Microsoft.CodeAnalysis.AnalyzerConfig},System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.Diagnostic}@)">
<summary>
Merge any partial global configs into a single global config, and remove the partial configs
</summary>
<param name="analyzerConfigs">An <see cref="T:Microsoft.CodeAnalysis.PooledObjects.ArrayBuilder`1"/> of <see cref="T:Microsoft.CodeAnalysis.AnalyzerConfig"/> containing a mix of regular and unmerged partial global configs</param>
<param name="diagnostics">Diagnostics produced during merge will be added to this bag</param>
<returns>A <see cref="T:Microsoft.CodeAnalysis.AnalyzerConfigSet.GlobalAnalyzerConfig" /> that contains the merged partial configs, or <c>null</c> if there were no partial configs</returns>
</member>
<member name="T:Microsoft.CodeAnalysis.AnalyzerConfigSet.GlobalAnalyzerConfigBuilder">
<summary>
Builds a global analyzer config from a series of partial configs
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.AnalyzerConfigSet.GlobalAnalyzerConfig">
<summary>
Represents a combined global analyzer config.
</summary>
<remarks>
We parse all <see cref="T:Microsoft.CodeAnalysis.AnalyzerConfig"/>s as individual files, according to the editorconfig spec.
However, when viewing the configs as an <see cref="T:Microsoft.CodeAnalysis.AnalyzerConfigSet"/> if multiple files have the
<c>is_global</c> property set to <c>true</c> we combine those files and treat them as a single
'logical' global config file. This type represents that combined file.
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.CommandLineAnalyzerReference">
<summary>
Describes a command line analyzer assembly specification.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommandLineAnalyzerReference.FilePath">
<summary>
Assembly file path.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CommandLineArguments">
<summary>
The base class for representing command line arguments to a
<see cref="T:Microsoft.CodeAnalysis.CommonCompiler"/>.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommandLineArguments.InteractiveMode">
<summary>
Drop to an interactive loop. If a script is specified in <see cref="P:Microsoft.CodeAnalysis.CommandLineArguments.SourceFiles"/> executes the script first.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommandLineArguments.BaseDirectory">
<summary>
Directory used to resolve relative paths stored in the arguments.
</summary>
<remarks>
Except for paths stored in <see cref="P:Microsoft.CodeAnalysis.CommandLineArguments.MetadataReferences"/>, all
paths stored in the properties of this class are resolved and
absolute. This is the directory that relative paths specified on
command line were resolved against.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.CommandLineArguments.PathMap">
<summary>
A list of pairs of paths. This stores the value of the command-line compiler
option /pathMap:X1=Y1;X2=Y2... which causes a prefix of X1 followed by a path
separator to be replaced by Y1 followed by a path separator, and so on for each following pair.
</summary>
<remarks>
This option is used to help get build-to-build determinism even when the build
directory is different from one build to the next. The prefix matching is case sensitive.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.CommandLineArguments.ReferencePaths">
<summary>
Sequence of absolute paths used to search for references.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommandLineArguments.SourcePaths">
<summary>
Sequence of absolute paths used to search for sources specified as #load directives.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommandLineArguments.KeyFileSearchPaths">
<summary>
Sequence of absolute paths used to search for key files.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommandLineArguments.Utf8Output">
<summary>
If true, use UTF8 for output.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommandLineArguments.CompilationName">
<summary>
Compilation name or null if not specified.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommandLineArguments.EmitOptions">
<summary>
Gets the emit options.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommandLineArguments.OutputFileName">
<summary>
Name of the output file or null if not specified.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommandLineArguments.OutputRefFilePath">
<summary>
Path of the output ref assembly or null if not specified.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommandLineArguments.PdbPath">
<summary>
Path of the PDB file or null if same as output binary path with .pdb extension.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommandLineArguments.SourceLink">
<summary>
Path of the file containing information linking the compilation to source server that stores
a snapshot of the source code included in the compilation.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommandLineArguments.RuleSetPath">
<summary>
Absolute path of the .ruleset file or null if not specified.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommandLineArguments.EmitPdb">
<summary>
True to emit PDB information (to a standalone PDB file or embedded into the PE file).
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommandLineArguments.OutputDirectory">
<summary>
Absolute path of the output directory (could only be null if there is an error reported).
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommandLineArguments.DocumentationPath">
<summary>
Absolute path of the documentation comment XML file or null if not specified.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommandLineArguments.GeneratedFilesOutputDirectory">
<summary>
Absolute path of the directory to place generated files in, or <c>null</c> to not emit any generated files.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommandLineArguments.ErrorLogOptions">
<summary>
Options controlling the generation of a SARIF log file containing compilation or
analysis diagnostics, or null if no log file is desired.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommandLineArguments.ErrorLogPath">
<summary>
Options controlling the generation of a SARIF log file containing compilation or
analysis diagnostics, or null if no log file is desired.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommandLineArguments.AppConfigPath">
<summary>
An absolute path of the app.config file or null if not specified.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommandLineArguments.Errors">
<summary>
Errors while parsing the command line arguments.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommandLineArguments.MetadataReferences">
<summary>
References to metadata supplied on the command line.
Includes assemblies specified via /r and netmodules specified via /addmodule.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommandLineArguments.AnalyzerReferences">
<summary>
References to analyzers supplied on the command line.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommandLineArguments.AnalyzerConfigPaths">
<summary>
A set of paths to EditorConfig-compatible analyzer config files.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommandLineArguments.AdditionalFiles">
<summary>
A set of additional non-code text files that can be used by analyzers.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommandLineArguments.EmbeddedFiles">
<summary>
A set of files to embed in the PDB.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommandLineArguments.ReportAnalyzer">
<value>
Report additional information related to analyzers, such as analyzer execution time.
</value>
</member>
<member name="P:Microsoft.CodeAnalysis.CommandLineArguments.SkipAnalyzers">
<value>
Skip execution of <see cref="T:Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer"/>s.
</value>
</member>
<member name="P:Microsoft.CodeAnalysis.CommandLineArguments.DisplayLogo">
<summary>
If true, prepend the command line header logo during
<see cref="M:Microsoft.CodeAnalysis.CommonCompiler.Run(System.IO.TextWriter,System.Threading.CancellationToken)"/>.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommandLineArguments.DisplayHelp">
<summary>
If true, append the command line help during
<see cref="M:Microsoft.CodeAnalysis.CommonCompiler.Run(System.IO.TextWriter,System.Threading.CancellationToken)"/>
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommandLineArguments.DisplayVersion">
<summary>
If true, append the compiler version during
<see cref="M:Microsoft.CodeAnalysis.CommonCompiler.Run(System.IO.TextWriter,System.Threading.CancellationToken)"/>
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommandLineArguments.DisplayLangVersions">
<summary>
If true, prepend the compiler-supported language versions during
<see cref="M:Microsoft.CodeAnalysis.CommonCompiler.Run(System.IO.TextWriter,System.Threading.CancellationToken)"/>
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommandLineArguments.Win32ResourceFile">
<summary>
The path to a Win32 resource.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommandLineArguments.Win32Icon">
<summary>
The path to a .ico icon file.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommandLineArguments.Win32Manifest">
<summary>
The path to a Win32 manifest file to embed
into the output portable executable (PE) file.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommandLineArguments.NoWin32Manifest">
<summary>
If true, do not embed any Win32 manifest, including
one specified by <see cref="P:Microsoft.CodeAnalysis.CommandLineArguments.Win32Manifest"/> or any
default manifest.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommandLineArguments.ManifestResources">
<summary>
Resources specified as arguments to the compilation.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommandLineArguments.Encoding">
<summary>
Encoding to be used for source files or 'null' for autodetect/default.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommandLineArguments.ChecksumAlgorithm">
<summary>
Hash algorithm to use to calculate source file debug checksums and PDB checksum.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommandLineArguments.ScriptArguments">
<summary>
Arguments following a script file or separator "--". Null if the command line parser is not interactive.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommandLineArguments.SourceFiles">
<summary>
Source file paths.
</summary>
<remarks>
Includes files specified directly on command line as well as files matching patterns specified
on command line using '*' and '?' wildcards or /recurse option.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.CommandLineArguments.TouchedFilesPath">
<summary>
Full path of a log of file paths accessed by the compiler, or null if file logging should be suppressed.
</summary>
<remarks>
Two log files will be created:
One with path <see cref="P:Microsoft.CodeAnalysis.CommandLineArguments.TouchedFilesPath"/> and extension ".read" logging the files read,
and second with path <see cref="P:Microsoft.CodeAnalysis.CommandLineArguments.TouchedFilesPath"/> and extension ".write" logging the files written to during compilation.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.CommandLineArguments.PrintFullPaths">
<summary>
If true, prints the full path of the file containing errors or
warnings in diagnostics.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommandLineArguments.ParseOptions">
<summary>
Options to the <see cref="T:Microsoft.CodeAnalysis.CommandLineParser"/>.
</summary>
<returns></returns>
</member>
<member name="P:Microsoft.CodeAnalysis.CommandLineArguments.CompilationOptions">
<summary>
Options to the <see cref="T:Microsoft.CodeAnalysis.Compilation"/>.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommandLineArguments.PreferredUILang">
<summary>
Specify the preferred output language name.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommandLineArguments.GetOutputFilePath(System.String)">
<summary>
Returns a full path of the file that the compiler will generate the assembly to if compilation succeeds.
</summary>
<remarks>
The method takes <paramref name="outputFileName"/> rather than using the value of <see cref="P:Microsoft.CodeAnalysis.CommandLineArguments.OutputFileName"/>
since the latter might be unspecified, in which case actual output path can't be determined for C# command line
without creating a compilation and finding an entry point. VB does not allow <see cref="P:Microsoft.CodeAnalysis.CommandLineArguments.OutputFileName"/> to
be unspecified.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.CommandLineArguments.GetPdbFilePath(System.String)">
<summary>
Returns a full path of the PDB file that the compiler will generate the debug symbols to
if <see cref="P:Microsoft.CodeAnalysis.CommandLineArguments.EmitPdbFile"/> is true and the compilation succeeds.
</summary>
<remarks>
The method takes <paramref name="outputFileName"/> rather than using the value of <see cref="P:Microsoft.CodeAnalysis.CommandLineArguments.OutputFileName"/>
since the latter might be unspecified, in which case actual output path can't be determined for C# command line
without creating a compilation and finding an entry point. VB does not allow <see cref="P:Microsoft.CodeAnalysis.CommandLineArguments.OutputFileName"/> to
be unspecified.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.CommandLineArguments.EmitPdbFile">
<summary>
Returns true if the PDB is generated to a PDB file, as opposed to embedded to the output binary and not generated at all.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommandLineArguments.ResolveMetadataReferences(Microsoft.CodeAnalysis.MetadataReferenceResolver)">
<summary>
Resolves metadata references stored in <see cref="P:Microsoft.CodeAnalysis.CommandLineArguments.MetadataReferences"/> using given file resolver and metadata provider.
</summary>
<param name="metadataResolver"><see cref="T:Microsoft.CodeAnalysis.MetadataReferenceResolver"/> to use for assembly name and relative path resolution.</param>
<returns>Yields resolved metadata references or <see cref="T:Microsoft.CodeAnalysis.UnresolvedMetadataReference"/>.</returns>
<exception cref="T:System.ArgumentNullException"><paramref name="metadataResolver"/> is null.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.CommandLineArguments.ResolveMetadataReferences(Microsoft.CodeAnalysis.MetadataReferenceResolver,System.Collections.Generic.List{Microsoft.CodeAnalysis.DiagnosticInfo},Microsoft.CodeAnalysis.CommonMessageProvider)">
<summary>
Resolves metadata references stored in <see cref="P:Microsoft.CodeAnalysis.CommandLineArguments.MetadataReferences"/> using given file resolver and metadata provider.
If a non-null diagnostic bag <paramref name="diagnosticsOpt"/> is provided, it catches exceptions that may be generated while reading the metadata file and
reports appropriate diagnostics.
Otherwise, if <paramref name="diagnosticsOpt"/> is null, the exceptions are unhandled.
</summary>
<remarks>
called by CommonCompiler with diagnostics and message provider
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.CommandLineArguments.ResolveAnalyzerReferences(Microsoft.CodeAnalysis.IAnalyzerAssemblyLoader)">
<summary>
Resolves analyzer references stored in <see cref="P:Microsoft.CodeAnalysis.CommandLineArguments.AnalyzerReferences"/> using given file resolver.
</summary>
<param name="analyzerLoader">Load an assembly from a file path</param>
<returns>Yields resolved <see cref="T:Microsoft.CodeAnalysis.Diagnostics.AnalyzerFileReference"/> or <see cref="T:Microsoft.CodeAnalysis.Diagnostics.UnresolvedAnalyzerReference"/>.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.CommandLineParser.EnumerateFiles(System.String,System.String,System.IO.SearchOption)">
<summary>
Enumerates files in the specified directory and subdirectories whose name matches the given pattern.
</summary>
<param name="directory">Full path of the directory to enumerate.</param>
<param name="fileNamePattern">File name pattern. May contain wildcards '*' (matches zero or more characters) and '?' (matches any character).</param>
<param name="searchOption">Specifies whether to search the specified <paramref name="directory"/> only, or all its subdirectories as well.</param>
<returns>Sequence of file paths.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.CommandLineParser.Parse(System.Collections.Generic.IEnumerable{System.String},System.String,System.String,System.String)">
<summary>
Parses a command line.
</summary>
<param name="args">A collection of strings representing the command line arguments.</param>
<param name="baseDirectory">The base directory used for qualifying file locations.</param>
<param name="sdkDirectory">The directory to search for mscorlib, or null if not available.</param>
<param name="additionalReferenceDirectories">A string representing additional reference paths.</param>
<returns>a <see cref="T:Microsoft.CodeAnalysis.CommandLineArguments"/> object representing the parsed command line.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.CommandLineParser.RemoveTrailingSpacesAndDots(System.String)">
<summary>
Trims all '.' and whitespace from the end of the path
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommandLineParser.SplitWithDoubledSeparatorEscaping(System.String,System.Char)">
<summary>
Splits specified <paramref name="str"/> on <paramref name="separator"/>
treating two consecutive separators as if they were a single non-separating character.
E.g. "a,,b,c" split on ',' yields ["a,b", "c"].
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommandLineParser.TryParseClientArgs(System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.List{System.String}@,System.Boolean@,System.String@,System.String@,System.String@)">
<summary>
Returns false if any of the client arguments are invalid and true otherwise.
</summary>
<param name="args">
The original args to the client.
</param>
<param name="parsedArgs">
The original args minus the client args, if no errors were encountered.
</param>
<param name="containsShared">
Only defined if no errors were encountered.
True if '/shared' was an argument, false otherwise.
</param>
<param name="keepAliveValue">
Only defined if no errors were encountered.
The value to the '/keepalive' argument if one was specified, null otherwise.
</param>
<param name="errorMessage">
Only defined if errors were encountered.
The error message for the encountered error.
</param>
<param name="pipeName">
Only specified if <paramref name="containsShared"/> is true and the session key
was provided. Can be null
</param>
</member>
<member name="M:Microsoft.CodeAnalysis.CommandLineParser.ParseResponseFile(System.String,System.Collections.Generic.IList{Microsoft.CodeAnalysis.Diagnostic})">
<summary>
Parse a response file into a set of arguments. Errors opening the response file are output into "errors".
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommandLineParser.ParseResponseLines(System.Collections.Generic.IEnumerable{System.String})">
<summary>
Take a string of lines from a response file, remove comments,
and split into a set of command line arguments.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommandLineParser.SplitCommandLineIntoArguments(System.String,System.Boolean)">
<summary>
See <see cref="M:Roslyn.Utilities.CommandLineUtilities.SplitCommandLineIntoArguments(System.String,System.Boolean)"/>
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommandLineParser.RemoveQuotesAndSlashes(System.String)">
<summary>
Remove the extraneous quotes and slashes from the argument. This function is designed to have
compat behavior with the native compiler.
</summary>
<remarks>
Mimics the function RemoveQuotes from the native C# compiler. The native VB equivalent of this
function is called RemoveQuotesAndSlashes. It has virtually the same behavior except for a few
quirks in error cases.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.CommandLineParser.ProcessSlashes(System.Text.StringBuilder,System.String,System.Int32@)">
<summary>
Mimic behavior of the native function by the same name.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommandLineParser.Split(System.String,System.Func{System.Char,System.Boolean})">
<summary>
Split a string, based on whether "splitHere" returned true on each character.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommandLineParser.ParseSeparatedStrings(System.String,System.Char[],System.StringSplitOptions)">
<summary>
Split a string by a set of separators, taking quotes into account.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommandLineParser.TryParseUInt64(System.String,System.UInt64@)">
<summary>
Tries to parse a UInt64 from string in either decimal, octal or hex format.
</summary>
<param name="value">The string value.</param>
<param name="result">The result if parsing was successful.</param>
<returns>true if parsing was successful, otherwise false.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.CommandLineParser.TryParseUInt16(System.String,System.UInt16@)">
<summary>
Tries to parse a UInt16 from string in either decimal, octal or hex format.
</summary>
<param name="value">The string value.</param>
<param name="result">The result if parsing was successful.</param>
<returns>true if parsing was successful, otherwise false.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.CommandLineParser.SortPathMap(System.Collections.Immutable.ImmutableArray{System.Collections.Generic.KeyValuePair{System.String,System.String}})">
<summary>
Sort so that more specific keys precede less specific.
When mapping a path we find the first key in the array that is a prefix of the path.
If multiple keys are prefixes of the path we want to use the longest (more specific) one for the mapping.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CommandLineReference">
<summary>
Describes a command line metadata reference (assembly or netmodule) specification.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommandLineReference.Reference">
<summary>
Metadata file path or an assembly display name.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommandLineReference.Properties">
<summary>
Metadata reference properties.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CommandLineSourceFile">
<summary>
Describes a source file specification stored on command line arguments.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommandLineSourceFile.Path">
<summary>
Resolved absolute path of the source file (does not contain wildcards).
</summary>
<remarks>
Although this path is absolute it may not be normalized. That is, it may contain ".." and "." in the middle.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.CommandLineSourceFile.IsInputRedirected">
<summary>
True if the input has been redirected from the standard input stream.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommandLineSourceFile.IsScript">
<summary>
True if the file should be treated as a script file.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CommonCompiler">
<summary>
Base class for csc.exe, csi.exe, vbc.exe and vbi.exe implementations.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CommonCompiler.CompilerEmitStreamProvider">
<summary>
This implementation of <see cref="T:Microsoft.CodeAnalysis.Compilation.EmitStreamProvider"/> will delay the creation
of the PE / PDB file until the compiler determines the compilation has succeeded. This prevents
the compiler from deleting output from the previous compilation when a new compilation
fails. The <see cref="M:Microsoft.CodeAnalysis.CommonCompiler.CompilerEmitStreamProvider.Close(Microsoft.CodeAnalysis.DiagnosticBag)"/> method must be called to retrieve all diagnostics.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CommonCompiler._fallbackEncoding">
<summary>
Fallback encoding that is lazily retrieved if needed. If <see cref="M:Microsoft.CodeAnalysis.Text.EncodedStringText.CreateFallbackEncoding"/> is
evaluated and stored, the value is used if a PDB is created for this compilation.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommonCompiler.EmbeddedSourcePaths">
<summary>
The set of source file paths that are in the set of embedded paths.
This is used to prevent reading source files that are embedded twice.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonCompiler.PrintVersion(System.IO.TextWriter)">
<summary>
Print compiler version
</summary>
<param name="consoleOutput"></param>
</member>
<member name="P:Microsoft.CodeAnalysis.CommonCompiler.Type">
<summary>
The type of the compiler class for version information in /help and /version.
We don't simply use this.GetType() because that would break mock subclasses.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonCompiler.GetCompilerVersion">
<summary>
The version of this compiler with commit hash, used in logo and /version output.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonCompiler.GetToolName">
<summary>
Tool name used, along with assembly version, for error logging.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonCompiler.GetAssemblyVersion">
<summary>
Tool version identifier used for error logging.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonCompiler.ResolveMetadataReferences(System.Collections.Generic.List{Microsoft.CodeAnalysis.DiagnosticInfo},Microsoft.CodeAnalysis.TouchedFileLogger,Microsoft.CodeAnalysis.MetadataReferenceResolver@)">
<summary>
Resolves metadata references stored in command line arguments and reports errors for those that can't be resolved.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonCompiler.TryReadFileContent(Microsoft.CodeAnalysis.CommandLineSourceFile,System.Collections.Generic.IList{Microsoft.CodeAnalysis.DiagnosticInfo})">
<summary>
Reads content of a source file.
</summary>
<param name="file">Source file information.</param>
<param name="diagnostics">Storage for diagnostics.</param>
<returns>File content or null on failure.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonCompiler.TryReadFileContent(Microsoft.CodeAnalysis.CommandLineSourceFile,System.Collections.Generic.IList{Microsoft.CodeAnalysis.DiagnosticInfo},System.String@)">
<summary>
Reads content of a source file.
</summary>
<param name="file">Source file information.</param>
<param name="diagnostics">Storage for diagnostics.</param>
<param name="normalizedFilePath">If given <paramref name="file"/> opens successfully, set to normalized absolute path of the file, null otherwise.</param>
<returns>File content or null on failure.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonCompiler.TryGetAnalyzerConfigSet(System.Collections.Immutable.ImmutableArray{System.String},Microsoft.CodeAnalysis.DiagnosticBag,Microsoft.CodeAnalysis.AnalyzerConfigSet@)">
<summary>
Read all analyzer config files from the given paths.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonCompiler.GetFallbackEncoding">
<summary>
Returns the fallback encoding for parsing source files, if used, or null
if not used
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonCompiler.TryReadFileContent(System.String,Microsoft.CodeAnalysis.DiagnosticBag,System.String@)">
<summary>
Read a UTF-8 encoded file and return the text as a string.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonCompiler.ReportDiagnostics(System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.Diagnostic},System.IO.TextWriter,Microsoft.CodeAnalysis.ErrorLogger,Microsoft.CodeAnalysis.Compilation)">
<summary>Returns true if there were any errors, false otherwise.</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonCompiler.ReportDiagnostics(Microsoft.CodeAnalysis.DiagnosticBag,System.IO.TextWriter,Microsoft.CodeAnalysis.ErrorLogger,Microsoft.CodeAnalysis.Compilation)">
<summary>Returns true if there were any errors, false otherwise.</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonCompiler.ReportDiagnostics(System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.DiagnosticInfo},System.IO.TextWriter,Microsoft.CodeAnalysis.ErrorLogger,Microsoft.CodeAnalysis.Compilation)">
<summary>Returns true if there were any errors, false otherwise.</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonCompiler.HasUnsuppressableErrors(Microsoft.CodeAnalysis.DiagnosticBag)">
<summary>
Returns true if there are any error diagnostics in the bag which cannot be suppressed and
are guaranteed to break the build.
Only diagnostics which have default severity error and are tagged as NotConfigurable fall in this bucket.
This includes all compiler error diagnostics and specific analyzer error diagnostics that are marked as not configurable by the analyzer author.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonCompiler.HasUnsuppressedErrors(Microsoft.CodeAnalysis.DiagnosticBag)">
<summary>
Returns true if the bag has any diagnostics with effective Severity=Error. Also returns true for warnings or informationals
or warnings promoted to error via /warnaserror which are not suppressed.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonCompiler.Run(System.IO.TextWriter,System.Threading.CancellationToken)">
<summary>
csc.exe and vbc.exe entry point.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonCompiler.RunGenerators(Microsoft.CodeAnalysis.Compilation,Microsoft.CodeAnalysis.ParseOptions,System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.ISourceGenerator},Microsoft.CodeAnalysis.Diagnostics.AnalyzerConfigOptionsProvider,System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.AdditionalText},Microsoft.CodeAnalysis.DiagnosticBag)">
<summary>
Perform source generation, if the compiler supports it.
</summary>
<param name="input">The compilation before any source generation has occurred.</param>
<param name="parseOptions">The <see cref="T:Microsoft.CodeAnalysis.ParseOptions"/> to use when parsing any generated sources.</param>
<param name="generators">The generators to run</param>
<param name="analyzerConfigOptionsProvider">A provider that returns analyzer config options</param>
<param name="additionalTexts">Any additional texts that should be passed to the generators when run.</param>
<param name="generatorDiagnostics">Any diagnostics that were produced during generation</param>
<returns>A compilation that represents the original compilation with any additional, generated texts added to it.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonCompiler.CompileAndEmit(Microsoft.CodeAnalysis.TouchedFileLogger,Microsoft.CodeAnalysis.Compilation@,System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer},System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.ISourceGenerator},System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.AdditionalText},Microsoft.CodeAnalysis.AnalyzerConfigSet,System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.AnalyzerConfigOptionsResult},System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.EmbeddedText},Microsoft.CodeAnalysis.DiagnosticBag,System.Threading.CancellationToken,System.Threading.CancellationTokenSource@,System.Boolean@,Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver@)">
<summary>
Perform all the work associated with actual compilation
(parsing, binding, compile, emit), resulting in diagnostics
and analyzer output.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonCompiler.GetOutputFileName(Microsoft.CodeAnalysis.Compilation,System.Threading.CancellationToken)">
<summary>
Returns the name with which the assembly should be output
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommonCompiler.FileOpen">
<summary>
Test hook for intercepting File.Open.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommonCompiler.Culture">
<summary>
When overridden by a derived class, this property can override the current thread's
CurrentUICulture property for diagnostic message resource lookups.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonCompiler.CreateDeterminismKey(Microsoft.CodeAnalysis.CommandLineArguments,System.String[],System.String,Microsoft.CodeAnalysis.CommandLineParser)">
<summary>
The string returned from this function represents the inputs to the compiler which impact determinism. It is
meant to be inline with the specification here:
- https://github.com/dotnet/roslyn/blob/master/docs/compilers/Deterministic%20Inputs.md
Issue #8193 tracks filling this out to the full specification.
https://github.com/dotnet/roslyn/issues/8193
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CommonCompiler.ExistingReferencesResolver">
<summary>
Looks for metadata references among the assembly file references given to the compilation when constructed.
When scripts are included into a project we don't want #r's to reference other assemblies than those
specified explicitly in the project references.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CommonCompiler.SuppressionDiagnostic">
<summary>
Special informational diagnostic for each programmatic <see cref="T:Microsoft.CodeAnalysis.Diagnostics.Suppression"/> reported by a <see cref="T:Microsoft.CodeAnalysis.Diagnostics.DiagnosticSuppressor"/>.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.BuildPaths.ClientDirectory">
<summary>
The path which contains the compiler binaries and response files.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.BuildPaths.WorkingDirectory">
<summary>
The path in which the compilation takes place.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.BuildPaths.SdkDirectory">
<summary>
The path which contains mscorlib. This can be null when specified by the user or running in a
CoreClr environment.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.BuildPaths.TempDirectory">
<summary>
The temporary directory a compilation should use instead of <see cref="M:System.IO.Path.GetTempPath"/>. The latter
relies on global state individual compilations should ignore.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.ErrorLogger">
<summary>
Base class for logging compiler diagnostics.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.ErrorLogOptions">
<summary>
Options controlling the generation of a SARIF log file containing compilation or analyzer diagnostics.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ErrorLogOptions.Path">
<summary>
Absolute path of the error log file.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ErrorLogOptions.SarifVersion">
<summary>
Version of the SARIF format used in the error log.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.ErrorLogOptions.#ctor(System.String,Microsoft.CodeAnalysis.SarifVersion)">
<summary>
Initializes a new instance of the <see cref="T:Microsoft.CodeAnalysis.ErrorLogOptions"/> class.
</summary>
<param name="path">Absolute path of the error log file.</param>
<param name="sarifVersion">Version of the SARIF format used in the error log.</param>
</member>
<member name="T:Microsoft.CodeAnalysis.SarifDiagnosticComparer">
<summary>
Compares descriptors by the values that we write to a SARIF log and nothing else.
We cannot just use <see cref="T:Microsoft.CodeAnalysis.DiagnosticDescriptor"/>'s built-in implementation
of <see cref="T:System.IEquatable`1"/> for two reasons:
1. <see cref="P:Microsoft.CodeAnalysis.DiagnosticDescriptor.MessageFormat"/> is part of that built-in
equatability, but we do not write it out, and so descriptors differing only
by MessageFormat (common) would lead to duplicate rule metadata entries in
the log.
2. <see cref="P:Microsoft.CodeAnalysis.DiagnosticDescriptor.CustomTags"/> is *not* part of that built-in
equatability, but we do write them out, and so descriptors differing only
by CustomTags (rare) would cause only one set of tags to be reported in the
log.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.SarifErrorLogger">
<summary>
Base class for the <see cref="T:Microsoft.CodeAnalysis.SarifV1ErrorLogger"/> and <see cref="T:Microsoft.CodeAnalysis.SarifV2ErrorLogger"/> classes.
The SarifV2ErrorLogger produces the standardized SARIF v2.1.0. The SarifV1ErrorLogger produces
the non-standardized SARIF v1.0.0. It is retained (and in fact, is retained as the default)
for compatibility with previous versions of the compiler. Customers who want to integrate
with standardized SARIF tooling should specify /errorlog:logFilePath;version=2 on the command
line to produce SARIF v2.1.0.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.SarifV1ErrorLogger">
<summary>
Used for logging compiler diagnostics to a stream in the unstandardized SARIF
(Static Analysis Results Interchange Format) v1.0.0 format.
https://github.com/sarif-standard/sarif-spec
https://rawgit.com/sarif-standard/sarif-spec/master/Static%20Analysis%20Results%20Interchange%20Format%20(SARIF).html
</summary>
<remarks>
To log diagnostics in the standardized SARIF v2.1.0 format, use the SarifV2ErrorLogger.
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.SarifV1ErrorLogger.DiagnosticDescriptorSet">
<summary>
Represents a distinct set of <see cref="T:Microsoft.CodeAnalysis.DiagnosticDescriptor"/>s and provides unique string keys
to distinguish them.
The first <see cref="T:Microsoft.CodeAnalysis.DiagnosticDescriptor"/> added with a given <see cref="P:Microsoft.CodeAnalysis.DiagnosticDescriptor.Id"/>
value is given that value as its unique key. Subsequent adds with the same ID will have .NNN
appended to their with an auto-incremented numeric value.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SarifV1ErrorLogger.DiagnosticDescriptorSet.Count">
<summary>
The total number of descriptors in the set.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SarifV1ErrorLogger.DiagnosticDescriptorSet.Add(Microsoft.CodeAnalysis.DiagnosticDescriptor)">
<summary>
Adds a descriptor to the set if not already present.
</summary>
<returns>
The unique key assigned to the given descriptor.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SarifV1ErrorLogger.DiagnosticDescriptorSet.ToSortedList">
<summary>
Converts the set to a list of (key, descriptor) pairs sorted by key.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.SarifV2ErrorLogger">
<summary>
Used for logging compiler diagnostics to a stream in the standardized SARIF
(Static Analysis Results Interchange Format) v2.1.0 format.
http://docs.oasis-open.org/sarif/sarif/v2.1.0/sarif-v2.1.0.html
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.SarifV2ErrorLogger.DiagnosticDescriptorSet">
<summary>
Represents a distinct set of <see cref="T:Microsoft.CodeAnalysis.DiagnosticDescriptor"/>s and provides unique integer indices
to distinguish them.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SarifV2ErrorLogger.DiagnosticDescriptorSet.Count">
<summary>
The total number of descriptors in the set.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SarifV2ErrorLogger.DiagnosticDescriptorSet.Add(Microsoft.CodeAnalysis.DiagnosticDescriptor)">
<summary>
Adds a descriptor to the set if not already present.
</summary>
<returns>
The unique key assigned to the given descriptor.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SarifV2ErrorLogger.DiagnosticDescriptorSet.ToSortedList">
<summary>
Converts the set to a list, sorted by index.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.SarifVersion">
<summary>
Specifies the version of the SARIF log file to produce.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SarifVersion.Sarif1">
<summary>
The original, non-standardized version of the SARIF format.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SarifVersion.Sarif2">
<summary>
The first standardized version of the SARIF format.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SarifVersion.Default">
<summary>
The default SARIF version, which is v1.0.0 for compatibility with
previous versions of the compiler.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SarifVersion.Latest">
<summary>
The latest supported SARIF version.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SarifVersionFacts.TryParse(System.String,Microsoft.CodeAnalysis.SarifVersion@)">
<summary>
Try to parse the SARIF log file version from a string.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.TouchedFileLogger">
<summary>
Used for logging all the paths which are "touched" (used) in any way
in the process of compilation.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.TouchedFileLogger.AddRead(System.String)">
<summary>
Adds a fully-qualified path to the Logger for a read file.
Semantics are undefined after a call to <see cref="M:Microsoft.CodeAnalysis.TouchedFileLogger.WriteReadPaths(System.IO.TextWriter)" />.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.TouchedFileLogger.AddWritten(System.String)">
<summary>
Adds a fully-qualified path to the Logger for a written file.
Semantics are undefined after a call to <see cref="M:Microsoft.CodeAnalysis.TouchedFileLogger.WriteWrittenPaths(System.IO.TextWriter)" />.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.TouchedFileLogger.AddReadWritten(System.String)">
<summary>
Adds a fully-qualified path to the Logger for a read and written
file. Semantics are undefined after a call to
<see cref="M:Microsoft.CodeAnalysis.TouchedFileLogger.WriteWrittenPaths(System.IO.TextWriter)" />.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.TouchedFileLogger.WriteReadPaths(System.IO.TextWriter)">
<summary>
Writes all of the paths the TouchedFileLogger to the given
TextWriter in upper case. After calling this method the
logger is in an undefined state.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.TouchedFileLogger.WriteWrittenPaths(System.IO.TextWriter)">
<summary>
Writes all of the paths the TouchedFileLogger to the given
TextWriter in upper case. After calling this method the
logger is in an undefined state.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Compilation">
<summary>
The compilation object is an immutable representation of a single invocation of the
compiler. Although immutable, a compilation is also on-demand, and will realize and cache
data as necessary. A compilation can produce a new compilation from existing compilation
with the application of small deltas. In many cases, it is more efficient than creating a
new compilation from scratch, as the new compilation can reuse information from the old
compilation.
</summary>
<summary>
The compilation object is an immutable representation of a single invocation of the
compiler. Although immutable, a compilation is also on-demand, and will realize and cache
data as necessary. A compilation can produce a new compilation from existing compilation
with the application of small deltas. In many cases, it is more efficient than creating a
new compilation from scratch, as the new compilation can reuse information from the old
compilation.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Compilation.EmitStreamSignKind">
<summary>
Describes the kind of real signing that is being done during Emit. In the case of public signing
this value will be <see cref="F:Microsoft.CodeAnalysis.Compilation.EmitStreamSignKind.None"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Compilation.EmitStreamSignKind.SignedWithBuilder">
<summary>
This form of signing occurs in memory using the <see cref="T:System.Reflection.PortableExecutable.PEBuilder"/> APIs. This is the default
form of signing and will be used when a strong name key is provided in a file on disk.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Compilation.EmitStreamSignKind.SignedWithFile">
<summary>
This form of signing occurs using the <see cref="T:Microsoft.CodeAnalysis.Interop.IClrStrongName"/> COM APIs. This form of signing
requires the unsigned PE to be written to disk before it can be signed (typically by writing it
out to the %TEMP% folder). This signing is used when the key in a key container, the signing
requires a counter signature or customers opted in via the UseLegacyStrongNameProvider feature
flag.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Compilation.EmitStream">
<summary>
This type abstracts away the legacy COM based signing implementation for PE streams. Under the hood
a temporary file must be created on disk (at the last possible moment), emitted to, signed on disk
and then copied back to the original <see cref="T:System.IO.Stream"/>. Only when legacy signing is enabled though.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Compilation.EmitStream._stream">
<summary>
The <see cref="T:System.IO.Stream"/> that is being emitted into. This value should _never_ be
disposed. It is either returned from the <see cref="T:Microsoft.CodeAnalysis.Compilation.EmitStreamProvider"/> instance in
which case it is owned by that. Or it is just an alias for the value that is stored
in <see cref="F:Microsoft.CodeAnalysis.Compilation.EmitStream._tempInfo"/> in which case it will be disposed from there.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.EmitStream.CreateStream(Microsoft.CodeAnalysis.DiagnosticBag)">
<summary>
Create the stream which should be used for Emit. This should only be called one time.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Compilation.EmitStreamProvider">
<summary>
Abstraction that allows the caller to delay the creation of the <see cref="P:Microsoft.CodeAnalysis.Compilation.EmitStreamProvider.Stream"/> values
until they are actually needed.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Compilation.EmitStreamProvider.Stream">
<summary>
Returns an existing open stream or null if no stream has been open.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.EmitStreamProvider.CreateStream(Microsoft.CodeAnalysis.DiagnosticBag)">
<summary>
This method will be called once during Emit at the time the Compilation needs
to create a stream for writing. It will not be called in the case of
user errors in code. Shall not be called when <see cref="P:Microsoft.CodeAnalysis.Compilation.EmitStreamProvider.Stream"/> returns non-null.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.EmitStreamProvider.GetOrCreateStream(Microsoft.CodeAnalysis.DiagnosticBag)">
<summary>
Returns a <see cref="P:Microsoft.CodeAnalysis.Compilation.EmitStreamProvider.Stream"/>. If one cannot be gotten or created then a diagnostic will
be added to <paramref name="diagnostics"/>
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Compilation.IsCaseSensitive">
<summary>
Returns true if this is a case sensitive compilation, false otherwise. Case sensitivity
affects compilation features such as name lookup as well as choosing what names to emit
when there are multiple different choices (for example between a virtual method and an
override).
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Compilation._lazyMakeWellKnownTypeMissingMap">
<summary>
Used for test purposes only to emulate missing members.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Compilation._lazyMakeMemberMissingMap">
<summary>
Used for test purposes only to emulate missing members.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Compilation.Language">
<summary>
Gets the source language ("C#" or "Visual Basic").
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.CheckSubmissionOptions(Microsoft.CodeAnalysis.CompilationOptions)">
<summary>
Checks options passed to submission compilation constructor.
Throws an exception if the options are not applicable to submissions.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.Clone">
<summary>
Creates a new compilation equivalent to this one with different symbol instances.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.WithEventQueue(Microsoft.CodeAnalysis.Diagnostics.AsyncQueue{Microsoft.CodeAnalysis.Diagnostics.CompilationEvent})">
<summary>
Returns a new compilation with a given event queue.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.WithSemanticModelProvider(Microsoft.CodeAnalysis.SemanticModelProvider)">
<summary>
Returns a new compilation with a given semantic model provider.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.GetSemanticModel(Microsoft.CodeAnalysis.SyntaxTree,System.Boolean)">
<summary>
Gets a new <see cref="T:Microsoft.CodeAnalysis.SemanticModel"/> for the specified syntax tree.
</summary>
<param name="syntaxTree">The specified syntax tree.</param>
<param name="ignoreAccessibility">
True if the SemanticModel should ignore accessibility rules when answering semantic questions.
</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.CommonGetSemanticModel(Microsoft.CodeAnalysis.SyntaxTree,System.Boolean)">
<summary>
Gets a <see cref="T:Microsoft.CodeAnalysis.SemanticModel"/> for the given <paramref name="syntaxTree"/>.
If <see cref="P:Microsoft.CodeAnalysis.Compilation.SemanticModelProvider"/> is non-null, it attempts to use <see cref="M:Microsoft.CodeAnalysis.SemanticModelProvider.GetSemanticModel(Microsoft.CodeAnalysis.SyntaxTree,Microsoft.CodeAnalysis.Compilation,System.Boolean)"/>
to get a semantic model. Otherwise, it creates a new semantic model using <see cref="M:Microsoft.CodeAnalysis.Compilation.CreateSemanticModel(Microsoft.CodeAnalysis.SyntaxTree,System.Boolean)"/>.
</summary>
<param name="syntaxTree"></param>
<param name="ignoreAccessibility"></param>
<returns></returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.CreateSemanticModel(Microsoft.CodeAnalysis.SyntaxTree,System.Boolean)">
<summary>
Creates a new <see cref="T:Microsoft.CodeAnalysis.SemanticModel"/> for the given <paramref name="syntaxTree"/>.
Unlike the <see cref="M:Microsoft.CodeAnalysis.Compilation.GetSemanticModel(Microsoft.CodeAnalysis.SyntaxTree,System.Boolean)"/> and <see cref="M:Microsoft.CodeAnalysis.Compilation.CommonGetSemanticModel(Microsoft.CodeAnalysis.SyntaxTree,System.Boolean)"/>,
it does not attempt to use the <see cref="P:Microsoft.CodeAnalysis.Compilation.SemanticModelProvider"/> to get a semantic model, but instead always creates a new semantic model.
</summary>
<param name="syntaxTree"></param>
<param name="ignoreAccessibility"></param>
<returns></returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.CreateErrorTypeSymbol(Microsoft.CodeAnalysis.INamespaceOrTypeSymbol,System.String,System.Int32)">
<summary>
Returns a new INamedTypeSymbol representing an error type with the given name and arity
in the given optional container.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.CreateErrorNamespaceSymbol(Microsoft.CodeAnalysis.INamespaceSymbol,System.String)">
<summary>
Returns a new INamespaceSymbol representing an error (missing) namespace with the given name.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Compilation.AssemblyName">
<summary>
Simple assembly name, or null if not specified.
</summary>
<remarks>
The name is used for determining internals-visible-to relationship with referenced assemblies.
If the compilation represents an assembly the value of <see cref="P:Microsoft.CodeAnalysis.Compilation.AssemblyName"/> is its simple name.
Unless <see cref="P:Microsoft.CodeAnalysis.CompilationOptions.ModuleName"/> specifies otherwise the module name
written to metadata is <see cref="P:Microsoft.CodeAnalysis.Compilation.AssemblyName"/> with an extension based upon <see cref="P:Microsoft.CodeAnalysis.CompilationOptions.OutputKind"/>.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.WithAssemblyName(System.String)">
<summary>
Creates a compilation with the specified assembly name.
</summary>
<param name="assemblyName">The new assembly name.</param>
<returns>A new compilation.</returns>
</member>
<member name="P:Microsoft.CodeAnalysis.Compilation.Options">
<summary>
Gets the options the compilation was created with.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.WithOptions(Microsoft.CodeAnalysis.CompilationOptions)">
<summary>
Creates a new compilation with the specified compilation options.
</summary>
<param name="options">The new options.</param>
<returns>A new compilation.</returns>
</member>
<member name="P:Microsoft.CodeAnalysis.Compilation.IsSubmission">
<summary>
True if the compilation represents an interactive submission.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Compilation.PreviousSubmission">
<summary>
The previous submission, if any, or null.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.GetSubmissionSlotIndex">
<summary>
Gets or allocates a runtime submission slot index for this compilation.
</summary>
<returns>Non-negative integer if this is a submission and it or a previous submission contains code, negative integer otherwise.</returns>
</member>
<member name="P:Microsoft.CodeAnalysis.Compilation.SubmissionReturnType">
<summary>
The type object that represents the type of submission result the host requested.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Compilation.HostObjectType">
<summary>
The type of the globals object or null if not specified for this compilation.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Compilation.SyntaxTrees">
<summary>
Gets the syntax trees (parsed from source code) that this compilation was created with.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.AddSyntaxTrees(Microsoft.CodeAnalysis.SyntaxTree[])">
<summary>
Creates a new compilation with additional syntax trees.
</summary>
<param name="trees">The new syntax trees.</param>
<returns>A new compilation.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.AddSyntaxTrees(System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.SyntaxTree})">
<summary>
Creates a new compilation with additional syntax trees.
</summary>
<param name="trees">The new syntax trees.</param>
<returns>A new compilation.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.RemoveSyntaxTrees(Microsoft.CodeAnalysis.SyntaxTree[])">
<summary>
Creates a new compilation without the specified syntax trees. Preserves metadata info for use with trees
added later.
</summary>
<param name="trees">The new syntax trees.</param>
<returns>A new compilation.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.RemoveSyntaxTrees(System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.SyntaxTree})">
<summary>
Creates a new compilation without the specified syntax trees. Preserves metadata info for use with trees
added later.
</summary>
<param name="trees">The new syntax trees.</param>
<returns>A new compilation.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.RemoveAllSyntaxTrees">
<summary>
Creates a new compilation without any syntax trees. Preserves metadata info for use with
trees added later.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.ReplaceSyntaxTree(Microsoft.CodeAnalysis.SyntaxTree,Microsoft.CodeAnalysis.SyntaxTree)">
<summary>
Creates a new compilation with an old syntax tree replaced with a new syntax tree.
Reuses metadata from old compilation object.
</summary>
<param name="newTree">The new tree.</param>
<param name="oldTree">The old tree.</param>
<returns>A new compilation.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.ContainsSyntaxTree(Microsoft.CodeAnalysis.SyntaxTree)">
<summary>
Returns true if this compilation contains the specified tree. False otherwise.
</summary>
<param name="syntaxTree">A syntax tree.</param>
</member>
<member name="P:Microsoft.CodeAnalysis.Compilation.SemanticModelProvider">
<summary>
Optional semantic model provider for this compilation.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Compilation.EventQueue">
<summary>
The event queue that this compilation was created with.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Compilation.ExternalReferences">
<summary>
Metadata references passed to the compilation constructor.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Compilation.DirectiveReferences">
<summary>
Unique metadata references specified via #r directive in the source code of this compilation.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Compilation.ReferenceDirectives">
<summary>
All reference directives used in this compilation.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Compilation.ReferenceDirectiveMap">
<summary>
Maps values of #r references to resolved metadata references.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Compilation.References">
<summary>
All metadata references -- references passed to the compilation
constructor as well as references specified via #r directives.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.ToMetadataReference(System.Collections.Immutable.ImmutableArray{System.String},System.Boolean)">
<summary>
Creates a metadata reference for this compilation.
</summary>
<param name="aliases">
Optional aliases that can be used to refer to the compilation root namespace via extern alias directive.
</param>
<param name="embedInteropTypes">
Embed the COM types from the reference so that the compiled
application no longer requires a primary interop assembly (PIA).
</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.WithReferences(System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.MetadataReference})">
<summary>
Creates a new compilation with the specified references.
</summary>
<param name="newReferences">
The new references.
</param>
<returns>A new compilation.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.WithReferences(Microsoft.CodeAnalysis.MetadataReference[])">
<summary>
Creates a new compilation with the specified references.
</summary>
<param name="newReferences">The new references.</param>
<returns>A new compilation.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.CommonWithReferences(System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.MetadataReference})">
<summary>
Creates a new compilation with the specified references.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.AddReferences(Microsoft.CodeAnalysis.MetadataReference[])">
<summary>
Creates a new compilation with additional metadata references.
</summary>
<param name="references">The new references.</param>
<returns>A new compilation.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.AddReferences(System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.MetadataReference})">
<summary>
Creates a new compilation with additional metadata references.
</summary>
<param name="references">The new references.</param>
<returns>A new compilation.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.RemoveReferences(Microsoft.CodeAnalysis.MetadataReference[])">
<summary>
Creates a new compilation without the specified metadata references.
</summary>
<param name="references">The new references.</param>
<returns>A new compilation.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.RemoveReferences(System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.MetadataReference})">
<summary>
Creates a new compilation without the specified metadata references.
</summary>
<param name="references">The new references.</param>
<returns>A new compilation.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.RemoveAllReferences">
<summary>
Creates a new compilation without any metadata references.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.ReplaceReference(Microsoft.CodeAnalysis.MetadataReference,Microsoft.CodeAnalysis.MetadataReference)">
<summary>
Creates a new compilation with an old metadata reference replaced with a new metadata
reference.
</summary>
<param name="newReference">The new reference.</param>
<param name="oldReference">The old reference.</param>
<returns>A new compilation.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.GetAssemblyOrModuleSymbol(Microsoft.CodeAnalysis.MetadataReference)">
<summary>
Gets the <see cref="T:Microsoft.CodeAnalysis.IAssemblySymbol"/> or <see cref="T:Microsoft.CodeAnalysis.IModuleSymbol"/> for a metadata reference used to create this
compilation.
</summary>
<param name="reference">The target reference.</param>
<returns>
Assembly or module symbol corresponding to the given reference or null if there is none.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.GetMetadataReference(Microsoft.CodeAnalysis.IAssemblySymbol)">
<summary>
Gets the <see cref="T:Microsoft.CodeAnalysis.MetadataReference"/> that corresponds to the assembly symbol.
</summary>
<param name="assemblySymbol">The target symbol.</param>
</member>
<member name="P:Microsoft.CodeAnalysis.Compilation.ReferencedAssemblyNames">
<summary>
Assembly identities of all assemblies directly referenced by this compilation.
</summary>
<remarks>
Includes identities of references passed in the compilation constructor
as well as those specified via directives in source code.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Compilation.Assembly">
<summary>
The <see cref="T:Microsoft.CodeAnalysis.IAssemblySymbol"/> that represents the assembly being created.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Compilation.SourceModule">
<summary>
Gets the <see cref="T:Microsoft.CodeAnalysis.IModuleSymbol"/> for the module being created by compiling all of
the source code.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Compilation.GlobalNamespace">
<summary>
The root namespace that contains all namespaces and types defined in source code or in
referenced metadata, merged into a single namespace hierarchy.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.GetCompilationNamespace(Microsoft.CodeAnalysis.INamespaceSymbol)">
<summary>
Gets the corresponding compilation namespace for the specified module or assembly namespace.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.GetEntryPoint(System.Threading.CancellationToken)">
<summary>
Returns the Main method that will serves as the entry point of the assembly, if it is
executable (and not a script).
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.GetSpecialType(Microsoft.CodeAnalysis.SpecialType)">
<summary>
Get the symbol for the predefined type from the Cor Library referenced by this
compilation.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.CommonGetSpecialTypeMember(Microsoft.CodeAnalysis.SpecialMember)">
<summary>
Get the symbol for the predefined type member from the COR Library referenced by this compilation.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.IsSystemTypeReference(Microsoft.CodeAnalysis.Symbols.ITypeSymbolInternal)">
<summary>
Returns true if the type is System.Type.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.CommonGetWellKnownTypeMember(Microsoft.CodeAnalysis.WellKnownMember)">
<summary>
Lookup member declaration in well known type used by this Compilation.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.CommonGetWellKnownType(Microsoft.CodeAnalysis.WellKnownType)">
<summary>
Lookup well-known type used by this Compilation.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.IsAttributeType(Microsoft.CodeAnalysis.ITypeSymbol)">
<summary>
Returns true if the specified type is equal to or derives from System.Attribute well-known type.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Compilation.ObjectType">
<summary>
The INamedTypeSymbol for the .NET System.Object type, which could have a TypeKind of
Error if there was no COR Library in this Compilation.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Compilation.DynamicType">
<summary>
The TypeSymbol for the type 'dynamic' in this Compilation.
</summary>
<exception cref="T:System.NotSupportedException">If the compilation is a VisualBasic compilation.</exception>
</member>
<member name="P:Microsoft.CodeAnalysis.Compilation.ScriptGlobalsType">
<summary>
A symbol representing the script globals type.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Compilation.ScriptClass">
<summary>
A symbol representing the implicit Script class. This is null if the class is not
defined in the compilation.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.CommonBindScriptClass">
<summary>
Resolves a symbol that represents script container (Script class). Uses the
full name of the container class stored in <see cref="P:Microsoft.CodeAnalysis.CompilationOptions.ScriptClassName"/> to find the symbol.
</summary>
<returns>The Script class symbol or null if it is not defined.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.CreateArrayTypeSymbol(Microsoft.CodeAnalysis.ITypeSymbol,System.Int32,Microsoft.CodeAnalysis.NullableAnnotation)">
<summary>
Returns a new ArrayTypeSymbol representing an array type tied to the base types of the
COR Library in this Compilation.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.CreateArrayTypeSymbol(Microsoft.CodeAnalysis.ITypeSymbol,System.Int32)">
<summary>
Returns a new ArrayTypeSymbol representing an array type tied to the base types of the
COR Library in this Compilation.
</summary>
<remarks>This overload is for backwards compatibility. Do not remove.</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.CreatePointerTypeSymbol(Microsoft.CodeAnalysis.ITypeSymbol)">
<summary>
Returns a new IPointerTypeSymbol representing a pointer type tied to a type in this
Compilation.
</summary>
<exception cref="T:System.NotSupportedException">If the compilation is a VisualBasic compilation.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.CreateFunctionPointerTypeSymbol(Microsoft.CodeAnalysis.ITypeSymbol,Microsoft.CodeAnalysis.RefKind,System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.ITypeSymbol},System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.RefKind},System.Reflection.Metadata.SignatureCallingConvention,System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.INamedTypeSymbol})">
<summary>
Returns a new IFunctionPointerTypeSymbol representing a function pointer type tied to types in this
Compilation.
</summary>
<exception cref="T:System.NotSupportedException">If the compilation is a VisualBasic compilation.</exception>
<exception cref="T:System.ArgumentException">
If:
* <see cref="F:Microsoft.CodeAnalysis.RefKind.Out"/> is passed as the returnRefKind.
* parameterTypes and parameterRefKinds do not have the same length.
</exception>
<exception cref="T:System.ArgumentNullException">
If returnType is <see langword="null"/>, or if parameterTypes or parameterRefKinds are default,
or if any of the types in parameterTypes are null.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.CreateNativeIntegerTypeSymbol(System.Boolean)">
<summary>
Returns a new INamedTypeSymbol representing a native integer.
</summary>
<exception cref="T:System.NotSupportedException">If the compilation is a VisualBasic compilation.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.GetTypeByMetadataName(System.String)">
<summary>
Gets the type within the compilation's assembly and all referenced assemblies (other than
those that can only be referenced via an extern alias) using its canonical CLR metadata name.
</summary>
<returns>Null if the type can't be found.</returns>
<remarks>
Since VB does not have the concept of extern aliases, it considers all referenced assemblies.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.CreateTupleTypeSymbol(System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.ITypeSymbol},System.Collections.Immutable.ImmutableArray{System.String},System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.Location},System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.NullableAnnotation})">
<summary>
Returns a new INamedTypeSymbol with the given element types and
(optional) element names, locations, and nullable annotations.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.CreateTupleTypeSymbol(System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.ITypeSymbol},System.Collections.Immutable.ImmutableArray{System.String},System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.Location})">
<summary>
Returns a new INamedTypeSymbol with the given element types, names, and locations.
</summary>
<remarks>This overload is for backwards compatibility. Do not remove.</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.CheckTupleElementNames(System.Int32,System.Collections.Immutable.ImmutableArray{System.String})">
<summary>
Check that if any names are provided, and their number matches the expected cardinality.
Returns a normalized version of the element names (empty array if all the names are null).
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.CreateTupleTypeSymbol(Microsoft.CodeAnalysis.INamedTypeSymbol,System.Collections.Immutable.ImmutableArray{System.String},System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.Location},System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.NullableAnnotation})">
<summary>
Returns a new INamedTypeSymbol with the given underlying type and
(optional) element names, locations, and nullable annotations.
The underlying type needs to be tuple-compatible.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.CreateTupleTypeSymbol(Microsoft.CodeAnalysis.INamedTypeSymbol,System.Collections.Immutable.ImmutableArray{System.String},System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.Location})">
<summary>
Returns a new INamedTypeSymbol with the given underlying type and element names and locations.
The underlying type needs to be tuple-compatible.
</summary>
<remarks>This overload is for backwards compatibility. Do not remove.</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.CreateAnonymousTypeSymbol(System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.ITypeSymbol},System.Collections.Immutable.ImmutableArray{System.String},System.Collections.Immutable.ImmutableArray{System.Boolean},System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.Location},System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.NullableAnnotation})">
<summary>
Returns a new anonymous type symbol with the given member types, names, source locations, and nullable annotations.
Anonymous type members will be readonly by default. Writable properties are
supported in VB and can be created by passing in <see langword="false"/> in the
appropriate locations in <paramref name="memberIsReadOnly"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.CreateAnonymousTypeSymbol(System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.ITypeSymbol},System.Collections.Immutable.ImmutableArray{System.String},System.Collections.Immutable.ImmutableArray{System.Boolean},System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.Location})">
<summary>
Returns a new anonymous type symbol with the given member types, names, and source locations.
Anonymous type members will be readonly by default. Writable properties are
supported in VB and can be created by passing in <see langword="false"/> in the
appropriate locations in <paramref name="memberIsReadOnly"/>.
</summary>
<remarks>This overload is for backwards compatibility. Do not remove.</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.ClassifyCommonConversion(Microsoft.CodeAnalysis.ITypeSymbol,Microsoft.CodeAnalysis.ITypeSymbol)">
<summary>
Classifies a conversion from <paramref name="source"/> to <paramref name="destination"/> according
to this compilation's programming language.
</summary>
<param name="source">Source type of value to be converted</param>
<param name="destination">Destination type of value to be converted</param>
<returns>A <see cref="T:Microsoft.CodeAnalysis.Operations.CommonConversion"/> that classifies the conversion from the
<paramref name="source"/> type to the <paramref name="destination"/> type.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.HasImplicitConversion(Microsoft.CodeAnalysis.ITypeSymbol,Microsoft.CodeAnalysis.ITypeSymbol)">
<summary>
Returns true if there is an implicit (C#) or widening (VB) conversion from
<paramref name="fromType"/> to <paramref name="toType"/>. Returns false if
either <paramref name="fromType"/> or <paramref name="toType"/> is null, or
if no such conversion exists.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.IsSymbolAccessibleWithin(Microsoft.CodeAnalysis.ISymbol,Microsoft.CodeAnalysis.ISymbol,Microsoft.CodeAnalysis.ITypeSymbol)">
<summary>
Checks if <paramref name="symbol"/> is accessible from within <paramref name="within"/>. An optional qualifier of type
<paramref name="throughType"/> is used to resolve protected access for instance members. All symbols are
required to be from this compilation or some assembly referenced (<see cref="P:Microsoft.CodeAnalysis.Compilation.References"/>) by this
compilation. <paramref name="within"/> is required to be an <see cref="T:Microsoft.CodeAnalysis.INamedTypeSymbol"/> or <see cref="T:Microsoft.CodeAnalysis.IAssemblySymbol"/>.
</summary>
<remarks>
<para>Submissions can reference symbols from previous submissions and their referenced assemblies, even
though those references are missing from <see cref="P:Microsoft.CodeAnalysis.Compilation.References"/>.
See https://github.com/dotnet/roslyn/issues/27356.
This implementation works around that by permitting symbols from previous submissions as well.</para>
<para>It is advised to avoid the use of this API within the compilers, as the compilers have additional
requirements for access checking that are not satisfied by this implementation, including the
avoidance of infinite recursion that could result from the use of the ISymbol APIs here, the detection
of use-site diagnostics, and additional returned details (from the compiler's internal APIs) that are
helpful for more precisely diagnosing reasons for accessibility failure.</para>
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.GetParseDiagnostics(System.Threading.CancellationToken)">
<summary>
Gets the diagnostics produced during the parsing stage.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.GetDeclarationDiagnostics(System.Threading.CancellationToken)">
<summary>
Gets the diagnostics produced during symbol declaration.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.GetMethodBodyDiagnostics(System.Threading.CancellationToken)">
<summary>
Gets the diagnostics produced during the analysis of method bodies and field initializers.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.GetDiagnostics(System.Threading.CancellationToken)">
<summary>
Gets all the diagnostics for the compilation, including syntax, declaration, and
binding. Does not include any diagnostics that might be produced during emit, see
<see cref="T:Microsoft.CodeAnalysis.Emit.EmitResult"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.FilterAndAppendAndFreeDiagnostics(Microsoft.CodeAnalysis.DiagnosticBag,Microsoft.CodeAnalysis.DiagnosticBag@,System.Threading.CancellationToken)">
<summary>
Filter out warnings based on the compiler options (/nowarn, /warn and /warnaserror) and the pragma warning directives.
'incoming' is freed.
</summary>
<param name="accumulator">Bag to which filtered diagnostics will be added.</param>
<param name="incoming">Diagnostics to be filtered.</param>
<returns>True if there are no unsuppressed errors (i.e., no errors which fail compilation).</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.FilterAndAppendDiagnostics(Microsoft.CodeAnalysis.DiagnosticBag,System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.Diagnostic},System.Collections.Generic.HashSet{System.Int32},System.Threading.CancellationToken)">
<summary>
Filter out warnings based on the compiler options (/nowarn, /warn and /warnaserror) and the pragma warning directives.
</summary>
<returns>True if there are no unsuppressed errors (i.e., no errors which fail compilation).</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.CreateDefaultWin32Resources(System.Boolean,System.Boolean,System.IO.Stream,System.IO.Stream)">
<summary>
Create a stream filled with default win32 resources.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Compilation.SignUsingBuilder">
<summary>
There are two ways to sign PE files
1. By directly signing the <see cref="T:System.Reflection.PortableExecutable.PEBuilder"/>
2. Write the unsigned PE to disk and use CLR COM APIs to sign.
The preferred method is #1 as it's more efficient and more resilient (no reliance on %TEMP%). But
we must continue to support #2 as it's the only way to do the following:
- Access private keys stored in a key container
- Do proper counter signature verification for AssemblySignatureKey attributes
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.ConstructModuleSerializationProperties(Microsoft.CodeAnalysis.Emit.EmitOptions,System.String,System.Guid)">
<summary>
Constructs the module serialization properties out of the compilation options of this compilation.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Compilation.LinkerMajorVersion">
<summary>
The value is not used by Windows loader, but the OS appcompat infrastructure uses it to identify apps.
It is useful for us to have a mechanism to identify the compiler that produced the binary.
This is the appropriate value to use for that. That is what it was invented for.
We don't want to have the high bit set for this in case some users perform a signed comparison to
determine if the value is less than some version. The C++ linker is at 0x0B.
We'll start our numbering at 0x30 for C#, 0x50 for VB.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.HasCodeToEmit">
<summary>
Return true if the compilation contains any code or types.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.CompileMethods(Microsoft.CodeAnalysis.Emit.CommonPEModuleBuilder,System.Boolean,System.Boolean,System.Boolean,Microsoft.CodeAnalysis.DiagnosticBag,System.Predicate{Microsoft.CodeAnalysis.Symbols.ISymbolInternal},System.Threading.CancellationToken)">
<summary>
Report declaration diagnostics and compile and synthesize method bodies.
</summary>
<returns>True if successful.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.GenerateResourcesAndDocumentationComments(Microsoft.CodeAnalysis.Emit.CommonPEModuleBuilder,System.IO.Stream,System.IO.Stream,System.String,Microsoft.CodeAnalysis.DiagnosticBag,System.Threading.CancellationToken)">
<summary>
Update resources and generate XML documentation comments.
</summary>
<returns>True if successful.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.ReportUnusedImports(Microsoft.CodeAnalysis.SyntaxTree,Microsoft.CodeAnalysis.DiagnosticBag,System.Threading.CancellationToken)">
<summary>
Reports all unused imports/usings so far (and thus it must be called as a last step of Emit)
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.CompleteTrees(Microsoft.CodeAnalysis.SyntaxTree)">
<summary>
Signals the event queue, if any, that we are done compiling.
There should not be more compiling actions after this step.
NOTE: once we signal about completion to analyzers they will cancel and thus in some cases we
may be effectively cutting off some diagnostics.
It is not clear if behavior is desirable.
See: https://github.com/dotnet/roslyn/issues/11470
</summary>
<param name="filterTree">What tree to complete. null means complete all trees. </param>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.Emit(System.IO.Stream,System.IO.Stream,System.IO.Stream,System.IO.Stream,System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.ResourceDescription},Microsoft.CodeAnalysis.Emit.EmitOptions,Microsoft.CodeAnalysis.IMethodSymbol,System.IO.Stream,System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.EmbeddedText},System.IO.Stream,System.Threading.CancellationToken)">
<summary>
Emit the IL for the compiled source code into the specified stream.
</summary>
<param name="peStream">Stream to which the compilation will be written.</param>
<param name="metadataPEStream">Stream to which the metadata-only output will be written.</param>
<param name="pdbStream">Stream to which the compilation's debug info will be written. Null to forego PDB generation.</param>
<param name="xmlDocumentationStream">Stream to which the compilation's XML documentation will be written. Null to forego XML generation.</param>
<param name="win32Resources">Stream from which the compilation's Win32 resources will be read (in RES format).
Null to indicate that there are none. The RES format begins with a null resource entry.</param>
<param name="manifestResources">List of the compilation's managed resources. Null to indicate that there are none.</param>
<param name="options">Emit options.</param>
<param name="debugEntryPoint">
Debug entry-point of the assembly. The method token is stored in the generated PDB stream.
When a program launches with a debugger attached the debugger places the first breakpoint to the start of the debug entry-point method.
The CLR starts executing the static Main method of <see cref="P:Microsoft.CodeAnalysis.CompilationOptions.MainTypeName"/> type. When the first breakpoint is hit
the debugger steps thru the code statement by statement until user code is reached, skipping methods marked by <see cref="T:System.Diagnostics.DebuggerHiddenAttribute"/>,
and taking other debugging attributes into consideration.
By default both entry points in an executable program (<see cref="F:Microsoft.CodeAnalysis.OutputKind.ConsoleApplication"/>, <see cref="F:Microsoft.CodeAnalysis.OutputKind.WindowsApplication"/>, <see cref="F:Microsoft.CodeAnalysis.OutputKind.WindowsRuntimeApplication"/>)
are the same method (Main). A non-executable program has no entry point. Runtimes that implement a custom loader may specify debug entry-point
to force the debugger to skip over complex custom loader logic executing at the beginning of the .exe and thus improve debugging experience.
Unlike ordinary entry-point which is limited to a non-generic static method of specific signature, there are no restrictions on the <paramref name="debugEntryPoint"/>
method other than having a method body (extern, interface, or abstract methods are not allowed).
</param>
<param name="sourceLinkStream">
Stream containing information linking the compilation to a source control.
</param>
<param name="embeddedTexts">
Texts to embed in the PDB.
Only supported when emitting Portable PDBs.
</param>
<param name="cancellationToken">To cancel the emit process.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.Emit(System.IO.Stream,System.IO.Stream,System.IO.Stream,System.IO.Stream,System.IO.Stream,System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.ResourceDescription},Microsoft.CodeAnalysis.Emit.EmitOptions,Microsoft.CodeAnalysis.IMethodSymbol,System.IO.Stream,System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.EmbeddedText},Microsoft.CodeAnalysis.CodeGen.CompilationTestData,System.Threading.CancellationToken)">
<summary>
This overload is only intended to be directly called by tests that want to pass <paramref name="testData"/>.
The map is used for storing a list of methods and their associated IL.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.EmitDifference(Microsoft.CodeAnalysis.Emit.EmitBaseline,System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.Emit.SemanticEdit},System.IO.Stream,System.IO.Stream,System.IO.Stream,System.Collections.Generic.ICollection{System.Reflection.Metadata.MethodDefinitionHandle},System.Threading.CancellationToken)">
<summary>
Emit the differences between the compilation and the previous generation
for Edit and Continue. The differences are expressed as added and changed
symbols, and are emitted as metadata, IL, and PDB deltas. A representation
of the current compilation is returned as an EmitBaseline for use in a
subsequent Edit and Continue.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.EmitDifference(Microsoft.CodeAnalysis.Emit.EmitBaseline,System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.Emit.SemanticEdit},System.Func{Microsoft.CodeAnalysis.ISymbol,System.Boolean},System.IO.Stream,System.IO.Stream,System.IO.Stream,System.Collections.Generic.ICollection{System.Reflection.Metadata.MethodDefinitionHandle},System.Threading.CancellationToken)">
<summary>
Emit the differences between the compilation and the previous generation
for Edit and Continue. The differences are expressed as added and changed
symbols, and are emitted as metadata, IL, and PDB deltas. A representation
of the current compilation is returned as an EmitBaseline for use in a
subsequent Edit and Continue.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.CheckOptionsAndCreateModuleBuilder(Microsoft.CodeAnalysis.DiagnosticBag,System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.ResourceDescription},Microsoft.CodeAnalysis.Emit.EmitOptions,Microsoft.CodeAnalysis.IMethodSymbol,System.IO.Stream,System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.EmbeddedText},Microsoft.CodeAnalysis.CodeGen.CompilationTestData,System.Threading.CancellationToken)">
<summary>
Check compilation options and create <see cref="T:Microsoft.CodeAnalysis.Emit.CommonPEModuleBuilder"/>.
</summary>
<returns><see cref="T:Microsoft.CodeAnalysis.Emit.CommonPEModuleBuilder"/> if successful.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.CompareSyntaxTreeOrdering(Microsoft.CodeAnalysis.SyntaxTree,Microsoft.CodeAnalysis.SyntaxTree)">
<summary>
The compiler needs to define an ordering among different partial class in different syntax trees
in some cases, because emit order for fields in structures, for example, is semantically important.
This function defines an ordering among syntax trees in this compilation.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.CompareSourceLocations(Microsoft.CodeAnalysis.Location,Microsoft.CodeAnalysis.Location)">
<summary>
Compare two source locations, using their containing trees, and then by Span.First within a tree.
Can be used to get a total ordering on declarations, for example.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.CompareSourceLocations(Microsoft.CodeAnalysis.SyntaxReference,Microsoft.CodeAnalysis.SyntaxReference)">
<summary>
Compare two source locations, using their containing trees, and then by Span.First within a tree.
Can be used to get a total ordering on declarations, for example.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.FirstSourceLocation``1(``0,``0)">
<summary>
Return the lexically first of two locations.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.FirstSourceLocation``1(System.Collections.Immutable.ImmutableArray{``0})">
<summary>
Return the lexically first of multiple locations.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.ContainsSymbolsWithName(System.Func{System.String,System.Boolean},Microsoft.CodeAnalysis.SymbolFilter,System.Threading.CancellationToken)">
<summary>
Return true if there is a source declaration symbol name that meets given predicate.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.GetSymbolsWithName(System.Func{System.String,System.Boolean},Microsoft.CodeAnalysis.SymbolFilter,System.Threading.CancellationToken)">
<summary>
Return source declaration symbols whose name meets given predicate.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.ContainsSymbolsWithName(System.String,Microsoft.CodeAnalysis.SymbolFilter,System.Threading.CancellationToken)">
<summary>
Return true if there is a source declaration symbol name that matches the provided name.
This may be faster than <see cref="M:Microsoft.CodeAnalysis.Compilation.ContainsSymbolsWithName(System.Func{System.String,System.Boolean},Microsoft.CodeAnalysis.SymbolFilter,System.Threading.CancellationToken)"/> when predicate is just a simple string check.
<paramref name="name"/> is case sensitive or not depending on the target language.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.GetSymbolsWithName(System.String,Microsoft.CodeAnalysis.SymbolFilter,System.Threading.CancellationToken)">
<summary>
Return source declaration symbols whose name matches the provided name. This may be
faster than <see cref="M:Microsoft.CodeAnalysis.Compilation.GetSymbolsWithName(System.Func{System.String,System.Boolean},Microsoft.CodeAnalysis.SymbolFilter,System.Threading.CancellationToken)"/> when predicate is just a simple string check. <paramref
name="name"/> is case sensitive or not depending on the target language.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.GetUnreferencedAssemblyIdentities(Microsoft.CodeAnalysis.Diagnostic)">
<summary>
Given a <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/> reporting unreferenced <see cref="T:Microsoft.CodeAnalysis.AssemblyIdentity"/>s, returns
the actual <see cref="T:Microsoft.CodeAnalysis.AssemblyIdentity"/> instances that were not referenced.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.GetRequiredLanguageVersion(Microsoft.CodeAnalysis.Diagnostic)">
<summary>
Returns the required language version found in a <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>, if any is found.
Returns null if none is found.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Compilation._retargetingAssemblySymbols">
<summary>
The list of RetargetingAssemblySymbol objects created for this Compilation.
RetargetingAssemblySymbols are created when some other compilation references this one,
but the other references provided are incompatible with it. For example, compilation C1
references v1 of Lib.dll and compilation C2 references C1 and v2 of Lib.dll. In this
case, in context of C2, all types from v1 of Lib.dll leaking through C1 (through method
signatures, etc.) must be retargeted to the types from v2 of Lib.dll. This is what
RetargetingAssemblySymbol is responsible for. In the example above, modules in C2 do not
reference C1.AssemblySymbol, but reference a special RetargetingAssemblySymbol created
for C1 by ReferenceManager.
WeakReference is used to allow RetargetingAssemblySymbol to be collected when they become unused.
Guarded by <see cref="F:Microsoft.CodeAnalysis.CommonReferenceManager.SymbolCacheAndReferenceManagerStateGuard"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.CacheRetargetingAssemblySymbolNoLock(Microsoft.CodeAnalysis.Symbols.IAssemblySymbolInternal)">
<summary>
Adds given retargeting assembly for this compilation into the cache.
<see cref="F:Microsoft.CodeAnalysis.CommonReferenceManager.SymbolCacheAndReferenceManagerStateGuard"/> must be locked while calling this method.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Compilation.AddRetargetingAssemblySymbolsNoLock``1(System.Collections.Generic.List{``0})">
<summary>
Adds cached retargeting symbols into the given list.
<see cref="F:Microsoft.CodeAnalysis.CommonReferenceManager.SymbolCacheAndReferenceManagerStateGuard"/> must be locked while calling this method.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CandidateReason">
<summary>
Indicates the reasons why a candidate (or set of candidate) symbols were not considered
correct in SemanticInfo. Higher values take precedence over lower values, so if, for
example, there a symbol with a given name that was inaccessible, and other with the wrong
arity, only the inaccessible one would be reported in the SemanticInfo.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CandidateReason.None">
<summary>
No CandidateSymbols.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CandidateReason.NotATypeOrNamespace">
<summary>
Only a type or namespace was valid in the given location, but the candidate symbols was
of the wrong kind.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CandidateReason.NotAnEvent">
<summary>
Only an event was valid in the given location, but the candidate symbols was
of the wrong kind.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CandidateReason.NotAWithEventsMember">
<summary>
The candidate symbol must be a WithEvents member, but it was not.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CandidateReason.NotAnAttributeType">
<summary>
Only an attribute type was valid in the given location, but the candidate symbol was
of the wrong kind.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CandidateReason.WrongArity">
<summary>
The candidate symbol takes a different number of type parameters that was required.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CandidateReason.NotCreatable">
<summary>
The candidate symbol existed, but was not allowed to be created in a new expression.
For example, interfaces, static classes, and unconstrained type parameters.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CandidateReason.NotReferencable">
<summary>
The candidate symbol existed, but was not allowed to be referenced. For example, the
"get_XXX" method used to implement a property named "XXX" may not be directly
referenced. Similarly, the type "System.Void" can not be directly referenced.
Also occurs if "this" is used in a context (static method or field initializer)
where "this" is not available.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CandidateReason.Inaccessible">
<summary>
The candidate symbol had an accessibility modifier (private, protected, ...) that made
it inaccessible.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CandidateReason.NotAValue">
<summary>
The candidate symbol was in a place where a value was required, but was not a value
(e.g., was a type or namespace).
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CandidateReason.NotAVariable">
<summary>
The candidate symbol was in a place where a variable (or sometimes, a property) was
required, but was not allowed there because it isn't a symbol that can be assigned to.
For example, the left hand side of an assignment, or a ref or out parameter.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CandidateReason.NotInvocable">
<summary>
The candidate symbol was used in a way that an invocable member (method, or variable of
delegate type) was required, but the candidate symbol was not invocable.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CandidateReason.StaticInstanceMismatch">
<summary>
The candidate symbol must be an instance variable, but was used as static, or the
reverse.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CandidateReason.OverloadResolutionFailure">
<summary>
Overload resolution did not choose a method. The candidate symbols are the methods there
were considered during overload resolution (which may or may not be applicable methods).
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CandidateReason.LateBound">
<summary>
Method could not be selected statically.
The candidate symbols are the methods there were considered during overload resolution
(which may or may not be applicable methods).
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CandidateReason.Ambiguous">
<summary>
Multiple ambiguous symbols were available with the same name. This can occur if "using"
statements bring multiple namespaces into scope, and the same type is available in
multiple. This can also occur if multiple properties of the same name are available in a
multiple interface inheritance situation.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CandidateReason.MemberGroup">
<summary>
CandidateSymbols are members of a group of results. This is used when there isn't a problem,
but there is more than one result, for example nameof(int.ToString).
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.ModuleCompilationState`2._lazyStateMachineTypes">
<summary>
Maps an async/iterator method to the synthesized state machine type that implements the method.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CompilationOptions">
<summary>
Represents compilation options common to C# and VB.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CompilationOptions.OutputKind">
<summary>
The kind of assembly generated when emitted.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CompilationOptions.ModuleName">
<summary>
Name of the primary module, or null if a default name should be used.
</summary>
<remarks>
The name usually (but not necessarily) includes an extension, e.g. "MyModule.dll".
If <see cref="P:Microsoft.CodeAnalysis.CompilationOptions.ModuleName"/> is null the actual name written to metadata
is derived from the name of the compilation (<see cref="P:Microsoft.CodeAnalysis.Compilation.AssemblyName"/>)
by appending a default extension for <see cref="P:Microsoft.CodeAnalysis.CompilationOptions.OutputKind"/>.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.CompilationOptions.ScriptClassName">
<summary>
The full name of a global implicit class (script class). This class implicitly encapsulates top-level statements,
type declarations, and member declarations. Could be a namespace qualified name.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CompilationOptions.MainTypeName">
<summary>
The full name of a type that declares static Main method. Must be a valid non-generic namespace-qualified name.
Null if any static Main method is a candidate for an entry point.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CompilationOptions.CryptoPublicKey">
<summary>
Specifies public key used to generate strong name for the compilation assembly, or empty if not specified.
</summary>
<remarks>
If specified the values of <see cref="P:Microsoft.CodeAnalysis.CompilationOptions.CryptoKeyFile"/> and <see cref="P:Microsoft.CodeAnalysis.CompilationOptions.CryptoKeyContainer"/>
must be null. If <see cref="P:Microsoft.CodeAnalysis.CompilationOptions.PublicSign"/> is true the assembly is marked as fully signed
but only signed with the public key (aka "OSS signing").
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.CompilationOptions.CryptoKeyFile">
<summary>
The name of the file containing the public and private keys to use to generate strong name of the
compilation assembly and to sign it.
</summary>
<remarks>
<para>
To sign the output supply either one of <see cref="P:Microsoft.CodeAnalysis.CompilationOptions.CryptoKeyFile"/> or <see cref="P:Microsoft.CodeAnalysis.CompilationOptions.CryptoKeyContainer"/>.
but not both. If both are specified <see cref="P:Microsoft.CodeAnalysis.CompilationOptions.CryptoKeyContainer"/> is ignored.
</para>
<para>
If <see cref="P:Microsoft.CodeAnalysis.CompilationOptions.PublicSign" /> is also set, <see cref="P:Microsoft.CodeAnalysis.CompilationOptions.CryptoKeyFile"/> must be the absolute
path to key file.
</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.CompilationOptions.CryptoKeyContainer">
<summary>
The CSP container containing the key with which to sign the output.
</summary>
<remarks>
<para>
To sign the output supply either one of <see cref="P:Microsoft.CodeAnalysis.CompilationOptions.CryptoKeyFile"/> or <see cref="P:Microsoft.CodeAnalysis.CompilationOptions.CryptoKeyContainer"/>.
but not both. If both are specified <see cref="P:Microsoft.CodeAnalysis.CompilationOptions.CryptoKeyContainer"/> is ignored.
</para>
<para>
This setting is obsolete and only supported on Microsoft Windows platform.
Use <see cref="P:Microsoft.CodeAnalysis.CompilationOptions.CryptoPublicKey"/> to generate assemblies with strong name and
a signing tool (Microsoft .NET Framework Strong Name Utility (sn.exe) or equivalent) to sign them.
</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.CompilationOptions.DelaySign">
<summary>
Mark the compilation assembly as delay-signed.
</summary>
<remarks>
If true the resulting assembly is marked as delay signed.
If false and <see cref="P:Microsoft.CodeAnalysis.CompilationOptions.CryptoPublicKey"/>, <see cref="P:Microsoft.CodeAnalysis.CompilationOptions.CryptoKeyFile"/>, or <see cref="P:Microsoft.CodeAnalysis.CompilationOptions.CryptoKeyContainer"/> is specified
or attribute System.Reflection.AssemblyKeyFileAttribute or System.Reflection.AssemblyKeyNameAttribute is applied to the
compilation assembly in source the resulting assembly is signed accordingly to the specified values/attributes.
If null the semantics is specified by the value of attribute System.Reflection.AssemblyDelaySignAttribute
applied to the compilation assembly in source. If the attribute is not present the value defaults to "false".
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.CompilationOptions.PublicSign">
<summary>
Mark the compilation assembly as fully signed, but only sign with the public key.
</summary>
<remarks>
<para>
If true, the assembly is marked as signed, but is only signed with the public key.
</para>
<para>
The key must be provided through either an absolute path in <see cref="P:Microsoft.CodeAnalysis.CompilationOptions.CryptoKeyFile"/>
or directly via <see cref="P:Microsoft.CodeAnalysis.CompilationOptions.CryptoPublicKey" />.
</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.CompilationOptions.CheckOverflow">
<summary>
Whether bounds checking on integer arithmetic is enforced by default or not.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CompilationOptions.Platform">
<summary>
Specifies which version of the common language runtime (CLR) can run the assembly.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CompilationOptions.OptimizationLevel">
<summary>
Specifies whether or not optimizations should be performed on the output IL.
This is independent of whether or not PDB information is generated.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CompilationOptions.GeneralDiagnosticOption">
<summary>
Global warning report option
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CompilationOptions.WarningLevel">
<summary>
Global warning level (a non-negative integer).
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CompilationOptions.ConcurrentBuild">
<summary>
Specifies whether building compilation may use multiple threads.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CompilationOptions.Deterministic">
<summary>
Specifies whether the compilation should be deterministic.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CompilationOptions.CurrentLocalTime">
<summary>
Used for time-based version generation when <see cref="T:System.Reflection.AssemblyVersionAttribute"/> contains a wildcard.
If equal to default(<see cref="T:System.DateTime"/>) the actual current local time will be used.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CompilationOptions.DebugPlusMode">
<summary>
Emit mode that favors debuggability.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CompilationOptions.MetadataImportOptions">
<summary>
Specifies whether to import members with accessibility other than public or protected by default.
Default value is <see cref="F:Microsoft.CodeAnalysis.MetadataImportOptions.Public"/>. The value specified is not going to
affect correctness of analysis performed by compilers because all members needed for correctness
are going to be imported regardless. This setting can force compilation to import members that it
normally doesn't.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CompilationOptions.ReferencesSupersedeLowerVersions">
<summary>
Apply additional disambiguation rules during resolution of referenced assemblies.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CompilationOptions.FilterDiagnostic(Microsoft.CodeAnalysis.Diagnostic,System.Threading.CancellationToken)">
<summary>
Modifies the incoming diagnostic, for example escalating its severity, or discarding it (returning null) based on the compilation options.
</summary>
<param name="diagnostic"></param>
<returns>The modified diagnostic, or null</returns>
</member>
<member name="P:Microsoft.CodeAnalysis.CompilationOptions.SpecificDiagnosticOptions">
<summary>
Warning report option for each warning.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CompilationOptions.SyntaxTreeOptionsProvider">
<summary>
Provider to retrieve options for particular syntax trees.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CompilationOptions.ReportSuppressedDiagnostics">
<summary>
Whether diagnostics suppressed in source, i.e. <see cref="P:Microsoft.CodeAnalysis.Diagnostic.IsSuppressed"/> is true, should be reported.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CompilationOptions.MetadataReferenceResolver">
<summary>
Resolves paths to metadata references specified in source via #r directives.
Null if the compilation can't contain references to metadata other than those explicitly passed to its factory (such as #r directives in sources).
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CompilationOptions.XmlReferenceResolver">
<summary>
Gets the resolver for resolving XML document references for the compilation.
Null if the compilation is not allowed to contain XML file references, such as XML doc comment include tags and permission sets stored in an XML file.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CompilationOptions.SourceReferenceResolver">
<summary>
Gets the resolver for resolving source document references for the compilation.
Null if the compilation is not allowed to contain source file references, such as #line pragmas and #load directives.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CompilationOptions.StrongNameProvider">
<summary>
Provides strong name and signature the source assembly.
Null if assembly signing is not supported.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CompilationOptions.AssemblyIdentityComparer">
<summary>
Used to compare assembly identities. May implement unification and portability policies specific to the target platform.
<see cref="P:Microsoft.CodeAnalysis.AssemblyIdentityComparer.Default"/> if not specified.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CompilationOptions.NullableContextOptions">
<summary>
Gets the default nullable context state in this compilation.
</summary>
<remarks>
This context does not apply to files that are marked as generated. Nullable is off
by default in those locations.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.CompilationOptions.Features">
<summary>
A set of strings designating experimental compiler features that are to be enabled.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CompilationOptions.Language">
<summary>
Gets the source language ("C#" or "Visual Basic").
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CompilationOptions.WithGeneralDiagnosticOption(Microsoft.CodeAnalysis.ReportDiagnostic)">
<summary>
Creates a new options instance with the specified general diagnostic option.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CompilationOptions.WithSpecificDiagnosticOptions(System.Collections.Immutable.ImmutableDictionary{System.String,Microsoft.CodeAnalysis.ReportDiagnostic})">
<summary>
Creates a new options instance with the specified diagnostic-specific options.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CompilationOptions.WithSpecificDiagnosticOptions(System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,Microsoft.CodeAnalysis.ReportDiagnostic}})">
<summary>
Creates a new options instance with the specified diagnostic-specific options.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CompilationOptions.WithReportSuppressedDiagnostics(System.Boolean)">
<summary>
Creates a new options instance with the specified suppressed diagnostics reporting option.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CompilationOptions.WithConcurrentBuild(System.Boolean)">
<summary>
Creates a new options instance with the concurrent build property set accordingly.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CompilationOptions.WithDeterministic(System.Boolean)">
<summary>
Creates a new options instance with the deterministic property set accordingly.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CompilationOptions.WithOutputKind(Microsoft.CodeAnalysis.OutputKind)">
<summary>
Creates a new options instance with the specified output kind.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CompilationOptions.WithPlatform(Microsoft.CodeAnalysis.Platform)">
<summary>
Creates a new options instance with the specified platform.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CompilationOptions.WithPublicSign(System.Boolean)">
<summary>
Creates a new options instance with the specified public sign setting.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CompilationOptions.WithOptimizationLevel(Microsoft.CodeAnalysis.OptimizationLevel)">
<summary>
Creates a new options instance with optimizations enabled or disabled.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CompilationOptions.ValidateOptions(Microsoft.CodeAnalysis.PooledObjects.ArrayBuilder{Microsoft.CodeAnalysis.Diagnostic})">
<summary>
Performs validation of options compatibilities and generates diagnostics if needed
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CompilationOptions.Errors">
<summary>
Errors collection related to an incompatible set of compilation options
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CompilationStage">
<summary>
Represents the possible compilation stages for which it is possible to get diagnostics
(errors).
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.ControlFlowAnalysis">
<summary>
Provides information about statements which transfer control in and out of a region. This
information is returned from a call to <see cref="M:Microsoft.CodeAnalysis.SemanticModel.AnalyzeControlFlow(Microsoft.CodeAnalysis.SyntaxNode)" />.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ControlFlowAnalysis.EntryPoints">
<summary>
The set of statements inside the region what are the
destination of branches outside the region.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ControlFlowAnalysis.ExitPoints">
<summary>
The set of statements inside a region that jump to locations outside
the region.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ControlFlowAnalysis.EndPointIsReachable">
<summary>
Indicates whether a region completes normally. Return true if and only if the end of the
last statement in a region is reachable or the region contains no statements.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ControlFlowAnalysis.ReturnStatements">
<summary>
The set of return statements found within a region.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ControlFlowAnalysis.Succeeded">
<summary>
Returns true iff analysis was successful. Analysis can fail if the region does not properly span a single expression,
a single statement, or a contiguous series of statements within the enclosing block.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.DataFlowAnalysis">
<summary>
Provides information about how data flows into and out of a region. This information is
returned from a call to
<see cref="M:Microsoft.CodeAnalysis.SemanticModel.AnalyzeDataFlow(Microsoft.CodeAnalysis.SyntaxNode,Microsoft.CodeAnalysis.SyntaxNode)" />, or one of its language-specific overloads,
where you pass the first and last statements of the region as parameters.
"Inside" means those statements or ones between them. "Outside" are any other statements of the same method.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.DataFlowAnalysis.VariablesDeclared">
<summary>
The set of local variables that are declared within a region. Note
that the region must be bounded by a method's body or a field's initializer, so
parameter symbols are never included in the result.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.DataFlowAnalysis.DataFlowsIn">
<summary>
The set of local variables which are assigned a value outside a region
that may be used inside the region.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.DataFlowAnalysis.DataFlowsOut">
<summary>
The set of local variables which are assigned a value inside a region
that may be used outside the region.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.DataFlowAnalysis.DefinitelyAssignedOnEntry">
<summary>
<para>
The set of local variables which are definitely assigned a value when a region is
entered.
</para>
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.DataFlowAnalysis.DefinitelyAssignedOnExit">
<summary>
<para>
The set of local variables which are definitely assigned a value when a region is
exited.
</para>
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.DataFlowAnalysis.AlwaysAssigned">
<summary>
The set of local variables for which a value is always assigned inside
a region.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.DataFlowAnalysis.ReadInside">
<summary>
The set of local variables that are read inside a region.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.DataFlowAnalysis.WrittenInside">
<summary>
The set of local variables that are written inside a region.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.DataFlowAnalysis.ReadOutside">
<summary>
The set of the local variables that are read outside a region.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.DataFlowAnalysis.WrittenOutside">
<summary>
The set of local variables that are written outside a region.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.DataFlowAnalysis.Captured">
<summary>
The set of the local variables that have been referenced in anonymous
functions within a region and therefore must be moved to a field of a frame class.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.DataFlowAnalysis.CapturedInside">
<summary>
The set of variables that are captured inside a region.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.DataFlowAnalysis.CapturedOutside">
<summary>
The set of variables that are captured outside a region.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.DataFlowAnalysis.UnsafeAddressTaken">
<summary>
The set of non-constant local variables and parameters that have had their
address (or the address of one of their fields) taken.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.DataFlowAnalysis.UsedLocalFunctions">
<summary>
The set of local functions that are used.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.DataFlowAnalysis.Succeeded">
<summary>
Returns true iff analysis was successful. Analysis can fail if the region does not
properly span a single expression, a single statement, or a contiguous series of
statements within the enclosing block.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Emit.EmitResult">
<summary>
The result of the Compilation.Emit method.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Emit.EmitResult.Success">
<summary>
True if the compilation successfully produced an executable.
If false then the diagnostics should include at least one error diagnostic
indicating the cause of the failure.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Emit.EmitResult.Diagnostics">
<summary>
A list of all the diagnostics associated with compilations. This include parse errors, declaration errors,
compilation errors, and emitting errors.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Emit.AnonymousTypeKeyField.Name">
<summary>
Name of the anonymous type field.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Emit.AnonymousTypeKeyField.IsKey">
<summary>
True if the anonymous type field was marked as 'Key' in VB.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Emit.AnonymousTypeKeyField.IgnoreCase">
<summary>
<see cref="F:Microsoft.CodeAnalysis.Emit.AnonymousTypeKeyField.Name"/> is case insensitive.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Emit.AsyncMoveNextBodyDebugInfo">
<summary>
Represents additional info needed by async method implementation methods
(MoveNext methods) to properly emit necessary PDB data for async debugging.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Emit.AsyncMoveNextBodyDebugInfo.CatchHandlerOffset">
<summary>
IL offset of catch handler or -1
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Emit.AsyncMoveNextBodyDebugInfo.YieldOffsets">
<summary>
Set of IL offsets where await operators yield control
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Emit.AsyncMoveNextBodyDebugInfo.ResumeOffsets">
<summary>
Set of IL offsets where await operators are to be resumed
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Emit.CommonPEModuleBuilder.CurrentGenerationOrdinal">
<summary>
EnC generation.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Emit.CommonPEModuleBuilder.Name">
<summary>
If this module represents an assembly, name of the assembly used in AssemblyDef table. Otherwise name of the module same as <see cref="P:Microsoft.CodeAnalysis.Emit.CommonPEModuleBuilder.ModuleName"/>.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Emit.CommonPEModuleBuilder.ModuleName">
<summary>
Name of the module. Used in ModuleDef table.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Emit.CommonPEModuleBuilder.GetExportedTypes(Microsoft.CodeAnalysis.DiagnosticBag)">
<summary>
Public types defined in other modules making up this assembly and to which other assemblies may refer to via this assembly
followed by types forwarded to another assembly.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Emit.CommonPEModuleBuilder.GenerateVisualBasicStylePdb">
<summary>
Used to distinguish which style to pick while writing native PDB information.
</summary>
<remarks>
The PDB content for custom debug information is different between Visual Basic and CSharp.
E.g. C# always includes a CustomMetadata Header (MD2) that contains the namespace scope counts, where
as VB only outputs namespace imports into the namespace scopes.
C# defines forwards in that header, VB includes them into the scopes list.
Currently the compiler doesn't allow mixing C# and VB method bodies. Thus this flag can be per module.
It is possible to move this flag to per-method basis but native PDB CDI forwarding would need to be adjusted accordingly.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Emit.CommonPEModuleBuilder.LinkedAssembliesDebugInfo">
<summary>
Linked assembly names to be stored to native PDB (VB only).
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Emit.CommonPEModuleBuilder.GetImports">
<summary>
Project level imports (VB only, TODO: C# scripts).
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Emit.CommonPEModuleBuilder.DefaultNamespace">
<summary>
Default namespace (VB only).
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Emit.CommonPEModuleBuilder.GetAdditionalTopLevelTypeDefinitions(Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
Additional top-level types injected by the Expression Evaluators.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Emit.CommonPEModuleBuilder.GetAnonymousTypeDefinitions(Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
Anonymous types defined in the compilation.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Emit.CommonPEModuleBuilder.GetEmbeddedTypeDefinitions(Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
Top-level embedded types (e.g. attribute types that are not present in referenced assemblies).
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Emit.CommonPEModuleBuilder.GetTopLevelSourceTypeDefinitions(Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
Top-level named types defined in source.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Emit.CommonPEModuleBuilder.GetFiles(Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
A list of the files that constitute the assembly. Empty for netmodule. These are not the source language files that may have been
used to compile the assembly, but the files that contain constituent modules of a multi-module assembly as well
as any external resources. It corresponds to the File table of the .NET assembly file format.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Emit.CommonPEModuleBuilder.GetSymbolToLocationMap">
<summary>
Builds symbol definition to location map used for emitting token -> location info
into PDB to be consumed by WinMdExp.exe tool (only applicable for /t:winmdobj)
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Emit.CommonPEModuleBuilder.DebugDocumentCount">
<summary>
Number of debug documents in the module.
Used to determine capacities of lists and indices when emitting debug info.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Emit.CommonPEModuleBuilder.HintNumberOfMethodDefinitions">
<summary>
An approximate number of method definitions that can
provide a basis for approximating the capacities of
various databases used during Emit.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Emit.CommonPEModuleBuilder.GetCorLibrary(Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
CorLibrary assembly referenced by this module.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Emit.CommonPEModuleBuilder.GetStrings">
<summary>
Returns User Strings referenced from the IL in the module.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Emit.CommonPEModuleBuilder.GetAssemblyReferenceAliases(Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
Assembly reference aliases (C# only).
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Emit.PEModuleBuilder`9">
<summary>
Common base class for C# and VB PE module builder.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Emit.PEModuleBuilder`9.GetTopLevelTypeDefinitions(Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
Returns all top-level (not nested) types defined in the module.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Emit.PEModuleBuilder`9.SynthesizedDefinitions">
<summary>
Captures the set of synthesized definitions that should be added to a type
during emit process.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Emit.PEModuleBuilder`9.GetSynthesizedTypes(`4)">
<summary>
Returns null if there are no compiler generated types.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Emit.PEModuleBuilder`9.GetSynthesizedFields(`4)">
<summary>
Returns null if there are no synthesized fields.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Emit.PEModuleBuilder`9.GetSynthesizedProperties(`4)">
<summary>
Returns null if there are no synthesized properties.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Emit.PEModuleBuilder`9.GetSynthesizedMethods(`4)">
<summary>
Returns null if there are no synthesized methods.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Emit.EditAndContinueMethodDebugInformation">
<summary>
Debugging information associated with the specified method that is emitted by the compiler to support Edit and Continue.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Emit.EditAndContinueMethodDebugInformation.Create(System.Collections.Immutable.ImmutableArray{System.Byte},System.Collections.Immutable.ImmutableArray{System.Byte})">
<summary>
Deserializes Edit and Continue method debug information from specified blobs.
</summary>
<param name="compressedSlotMap">Local variable slot map.</param>
<param name="compressedLambdaMap">Lambda and closure map.</param>
<exception cref="T:System.IO.InvalidDataException">Invalid data.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.Emit.EditAndContinueMethodDebugInformation.UncompressSlotMap(System.Collections.Immutable.ImmutableArray{System.Byte})">
<exception cref="T:System.IO.InvalidDataException">Invalid data.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.Emit.DeltaMetadataWriter.GetMethodTokens(System.Collections.Generic.ICollection{System.Reflection.Metadata.MethodDefinitionHandle})">
<summary>
Return tokens for all modified debuggable methods.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Emit.DeltaMetadataWriter.DefinitionIndex`1.AddUpdated(`0)">
<summary>
Add an item from a previous generation
that has been updated in this generation.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Emit.EmitBaseline">
<summary>
Represents a module from a previous compilation. Used in Edit and Continue
to emit the differences in a subsequent compilation.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Emit.EmitBaseline.MetadataSymbols.AssemblyReferenceIdentityMap">
<summary>
A map of the assembly identities of the baseline compilation to the identities of the original metadata AssemblyRefs.
Only includes identities that differ between these two.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Emit.EmitBaseline.CreateInitialBaseline(Microsoft.CodeAnalysis.ModuleMetadata,System.Func{System.Reflection.Metadata.MethodDefinitionHandle,Microsoft.CodeAnalysis.Emit.EditAndContinueMethodDebugInformation})">
<summary>
Creates an <see cref="T:Microsoft.CodeAnalysis.Emit.EmitBaseline"/> from the metadata of the module before editing
and from a function that maps from a method to an array of local names.
</summary>
<param name="module">The metadata of the module before editing.</param>
<param name="debugInformationProvider">
A function that for a method handle returns Edit and Continue debug information emitted by the compiler into the PDB.
The function shall throw <see cref="T:System.IO.InvalidDataException"/> if the debug information can't be read for the specified method.
This exception and <see cref="T:System.IO.IOException"/> are caught and converted to an emit diagnostic. Other exceptions are passed through.
</param>
<returns>An <see cref="T:Microsoft.CodeAnalysis.Emit.EmitBaseline"/> for the module.</returns>
<exception cref="T:System.ArgumentException"><paramref name="module"/> is not a PE image.</exception>
<exception cref="T:System.ArgumentNullException"><paramref name="module"/> is null.</exception>
<exception cref="T:System.ArgumentNullException"><paramref name="debugInformationProvider"/> is null.</exception>
<exception cref="T:System.IO.IOException">Error reading module metadata.</exception>
<exception cref="T:System.BadImageFormatException">Module metadata is invalid.</exception>
<exception cref="T:System.ObjectDisposedException">Module has been disposed.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.Emit.EmitBaseline.CreateInitialBaseline(Microsoft.CodeAnalysis.ModuleMetadata,System.Func{System.Reflection.Metadata.MethodDefinitionHandle,Microsoft.CodeAnalysis.Emit.EditAndContinueMethodDebugInformation},System.Func{System.Reflection.Metadata.MethodDefinitionHandle,System.Reflection.Metadata.StandaloneSignatureHandle},System.Boolean)">
<summary>
Creates an <see cref="T:Microsoft.CodeAnalysis.Emit.EmitBaseline"/> from the metadata of the module before editing
and from a function that maps from a method to an array of local names.
</summary>
<param name="module">The metadata of the module before editing.</param>
<param name="debugInformationProvider">
A function that for a method handle returns Edit and Continue debug information emitted by the compiler into the PDB.
The function shall throw <see cref="T:System.IO.InvalidDataException"/> if the debug information can't be read for the specified method.
This exception and <see cref="T:System.IO.IOException"/> are caught and converted to an emit diagnostic. Other exceptions are passed through.
</param>
<param name="localSignatureProvider">
A function that for a method handle returns the signature of its local variables.
The function shall throw <see cref="T:System.IO.InvalidDataException"/> if the information can't be read for the specified method.
This exception and <see cref="T:System.IO.IOException"/> are caught and converted to an emit diagnostic. Other exceptions are passed through.
</param>
<param name="hasPortableDebugInformation">
True if the baseline PDB is portable.
</param>
<returns>An <see cref="T:Microsoft.CodeAnalysis.Emit.EmitBaseline"/> for the module.</returns>
<remarks>
Only the initial baseline is created using this method; subsequent baselines are created
automatically when emitting the differences in subsequent compilations.
When an active method (one for which a frame is allocated on a stack) is updated the values of its local variables need to be preserved.
The mapping of local variable names to their slots in the frame is not included in the metadata and thus needs to be provided by
<paramref name="debugInformationProvider"/>.
The <paramref name="debugInformationProvider"/> is only needed for the initial generation. The mapping for the subsequent generations
is carried over through <see cref="T:Microsoft.CodeAnalysis.Emit.EmitBaseline"/>. The compiler assigns slots to named local variables (including named temporary variables)
it the order in which they appear in the source code. This property allows the compiler to reconstruct the local variable mapping
for the initial generation. A subsequent generation may add a new variable in between two variables of the previous generation.
Since the slots of the previous generation variables need to be preserved the only option is to add these new variables to the end.
The slot ordering thus no longer matches the syntax ordering. It is therefore necessary to pass <see cref="P:Microsoft.CodeAnalysis.Emit.EmitDifferenceResult.Baseline"/>
to the next generation (rather than e.g. create new <see cref="T:Microsoft.CodeAnalysis.Emit.EmitBaseline"/>s from scratch based on metadata produced by subsequent compilations).
</remarks>
<exception cref="T:System.ArgumentNullException"><paramref name="module"/> is null.</exception>
<exception cref="T:System.ArgumentNullException"><paramref name="debugInformationProvider"/> is null.</exception>
<exception cref="T:System.ArgumentNullException"><paramref name="localSignatureProvider"/> is null.</exception>
<exception cref="T:System.IO.IOException">Error reading module metadata.</exception>
<exception cref="T:System.BadImageFormatException">Module metadata is invalid.</exception>
<exception cref="T:System.ObjectDisposedException">Module has been disposed.</exception>
</member>
<member name="P:Microsoft.CodeAnalysis.Emit.EmitBaseline.OriginalMetadata">
<summary>
The original metadata of the module.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Emit.EmitBaseline.Ordinal">
<summary>
Metadata generation ordinal. Zero for
full metadata and non-zero for delta.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Emit.EmitBaseline.EncId">
<summary>
Unique Guid for this delta, or default(Guid)
if full metadata.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Emit.EmitBaseline.AddedOrChangedMethods">
<summary>
EnC metadata for methods added or updated since the initial generation, indexed by method row id.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Emit.EmitBaseline.DebugInformationProvider">
<summary>
Reads EnC debug information of a method from the initial baseline PDB.
The function shall throw <see cref="T:System.IO.InvalidDataException"/> if the debug information can't be read for the specified method.
This exception and <see cref="T:System.IO.IOException"/> are caught and converted to an emit diagnostic. Other exceptions are passed through.
The function shall return an empty <see cref="T:Microsoft.CodeAnalysis.Emit.EditAndContinueMethodDebugInformation"/> if the method that corresponds to the specified handle
has no debug information.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Emit.EmitBaseline.LocalSignatureProvider">
<summary>
A function that for a method handle returns the signature of its local variables.
The function shall throw <see cref="T:System.IO.InvalidDataException"/> if the information can't be read for the specified method.
This exception and <see cref="T:System.IO.IOException"/> are caught and converted to an emit diagnostic. Other exceptions are passed through.
The function shall return a nil <see cref="T:System.Reflection.Metadata.StandaloneSignatureHandle"/> if the method that corresponds to the specified handle
has no local variables.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Emit.LambdaSyntaxFacts.TryGetCorrespondingLambdaBody(Microsoft.CodeAnalysis.SyntaxNode,Microsoft.CodeAnalysis.SyntaxNode)">
<summary>
When invoked on a node that represents an anonymous function or a query clause [1]
with a <paramref name="lambdaOrLambdaBodySyntax"/> of another anonymous function or a query clause of the same kind [2],
returns the body of the [1] that positionally corresponds to the specified <paramref name="lambdaOrLambdaBodySyntax"/>.
E.g. join clause declares left expression and right expression -- each of these expressions is a lambda body.
JoinClause1.GetCorrespondingLambdaBody(JoinClause2.RightExpression) returns JoinClause1.RightExpression.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Emit.LambdaSyntaxFacts.GetDeclaratorPosition(Microsoft.CodeAnalysis.SyntaxNode)">
<summary>
Given a node that represents a variable declaration, lambda or a closure scope return the position to be used to calculate
the node's syntax offset with respect to its containing member.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Emit.SymbolChange.None">
<summary>
No change to symbol or members.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Emit.SymbolChange.ContainsChanges">
<summary>
No change to symbol but may contain changed symbols.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Emit.SymbolChange.Updated">
<summary>
Symbol updated.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Emit.SymbolChange.Added">
<summary>
Symbol added.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Emit.SymbolChanges._definitionMap">
<summary>
Maps definitions being emitted to the corresponding definitions defined in the previous generation (metadata or source).
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Emit.SymbolChanges._changes">
<summary>
Contains all symbols explicitly updated/added to the source and
their containing types and namespaces.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Emit.SymbolChanges.IsAdded(Microsoft.CodeAnalysis.ISymbol)">
<summary>
True if the symbol is a source symbol added during EnC session.
The symbol may be declared in any source compilation in the current solution.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Emit.SymbolChanges.RequiresCompilation(Microsoft.CodeAnalysis.ISymbol)">
<summary>
Returns true if the symbol or some child symbol has changed and needs to be compiled.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Emit.SymbolChanges.CalculateChanges(System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.Emit.SemanticEdit})">
<summary>
Calculate the set of changes up to top-level types. The result
will be used as a filter when traversing the module.
Note that these changes only include user-defined source symbols, not synthesized symbols since those will be
generated during lowering of the changed user-defined symbols.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Emit.SymbolChanges.GetContainingSymbol(Microsoft.CodeAnalysis.ISymbol)">
<summary>
Return the symbol that contains this symbol as far
as changes are concerned. For instance, an auto property
is considered the containing symbol for the backing
field and the accessor methods. By default, the containing
symbol is simply Symbol.ContainingSymbol.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Emit.SymbolMatcher.MapSynthesizedMembers(System.Collections.Immutable.ImmutableDictionary{Microsoft.CodeAnalysis.Symbols.ISymbolInternal,System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.Symbols.ISymbolInternal}},System.Collections.Immutable.ImmutableDictionary{Microsoft.CodeAnalysis.Symbols.ISymbolInternal,System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.Symbols.ISymbolInternal}})">
<summary>
Merges synthesized members generated during lowering of the current compilation with aggregate synthesized members
from all previous source generations (gen >= 1).
</summary>
<remarks>
Suppose {S -> {A, B, D}, T -> {E, F}} are all synthesized members in previous generations,
and {S' -> {A', B', C}, U -> {G, H}} members are generated in the current compilation.
Where X matches X' via this matcher, i.e. X' is from the new compilation and
represents the same metadata entity as X in the previous compilation.
Then the resulting collection shall have the following entries:
{S' -> {A', B', C, D}, U -> {G, H}, T -> {E, F}}
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.Emit.EmitOptions">
<summary>
Represents compilation emit options.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Emit.EmitOptions.EmitMetadataOnly">
<summary>
True to emit an assembly excluding executable code such as method bodies.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Emit.EmitOptions.TolerateErrors">
<summary>
Tolerate errors, producing a PE stream and a success result even in the presence of (some) errors.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Emit.EmitOptions.IncludePrivateMembers">
<summary>
Unless set (private) members that don't affect the language semantics of the resulting assembly will be excluded
when emitting metadata-only assemblies as primary output (with <see cref="P:Microsoft.CodeAnalysis.Emit.EmitOptions.EmitMetadataOnly"/> on).
If emitting a secondary output, this flag is required to be false.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Emit.EmitOptions.InstrumentationKinds">
<summary>
Type of instrumentation that should be added to the output binary.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Emit.EmitOptions.SubsystemVersion">
<summary>
Subsystem version
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Emit.EmitOptions.FileAlignment">
<summary>
Specifies the size of sections in the output file.
</summary>
<remarks>
Valid values are 0, 512, 1024, 2048, 4096 and 8192.
If the value is 0 the file alignment is determined based upon the value of <see cref="T:Microsoft.CodeAnalysis.Platform"/>.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Emit.EmitOptions.HighEntropyVirtualAddressSpace">
<summary>
True to enable high entropy virtual address space for the output binary.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Emit.EmitOptions.BaseAddress">
<summary>
Specifies the preferred base address at which to load the output DLL.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Emit.EmitOptions.DebugInformationFormat">
<summary>
Debug information format.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Emit.EmitOptions.OutputNameOverride">
<summary>
Assembly name override - file name and extension. If not specified the compilation name is used.
</summary>
<remarks>
By default the name of the output assembly is <see cref="P:Microsoft.CodeAnalysis.Compilation.AssemblyName"/>. Only in rare cases it is necessary
to override the name.
CAUTION: If this is set to a (non-null) value other than the existing compilation output name, then internals-visible-to
and assembly references may not work as expected. In particular, things that were visible at bind time, based on the
name of the compilation, may not be visible at runtime and vice-versa.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Emit.EmitOptions.PdbFilePath">
<summary>
The name of the PDB file to be embedded in the PE image, or null to use the default.
</summary>
<remarks>
If not specified the file name of the source module with an extension changed to "pdb" is used.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Emit.EmitOptions.PdbChecksumAlgorithm">
<summary>
A crypto hash algorithm used to calculate PDB Checksum stored in the PE/COFF File.
If not specified (the value is <c>default(HashAlgorithmName)</c>) the checksum is not calculated.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Emit.EmitOptions.RuntimeMetadataVersion">
<summary>
Runtime metadata version.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Emit.EmitOptions.DefaultSourceFileEncoding">
<summary>
The encoding used to parse source files that do not have a Byte Order Mark. If specified,
is stored in the emitted PDB in order to allow recreating the original compilation.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Emit.EmitOptions.FallbackSourceFileEncoding">
<summary>
If <see cref="P:Microsoft.CodeAnalysis.Emit.EmitOptions.DefaultSourceFileEncoding"/> is not specified, the encoding used to parse source files
that do not declare their encoding via Byte Order Mark and are not UTF8-encoded.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Emit.EmitOptions.WithFileAlignment(System.Int32)">
<summary>
Sets the byte alignment for portable executable file sections.
</summary>
<param name="value">Can be one of the following values: 0, 512, 1024, 2048, 4096, 8192</param>
</member>
<member name="T:Microsoft.CodeAnalysis.Emit.ErrorType">
<summary>
Error type symbols should be replaced with an object of this class
in the translation layer for emit.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Emit.ErrorType.s_name">
<summary>
For the name we will use a word "Error" followed by a guid, generated on the spot.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Emit.ErrorType.ErrorAssembly">
<summary>
A fake containing assembly for an ErrorType object.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Emit.ErrorType.ErrorAssembly.s_identity">
<summary>
For the name we will use a word "Error" followed by a guid, generated on the spot.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Emit.InstrumentationKind">
<summary>
Specifies a kind of instrumentation to be applied in generated code.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Emit.InstrumentationKind.None">
<summary>
No instrumentation.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Emit.InstrumentationKind.TestCoverage">
<summary>
Instruments the binary to add test coverage.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Emit.IteratorMoveNextBodyDebugInfo">
<summary>
Represents additional info needed by iterator method implementation methods
(MoveNext methods) to properly emit necessary PDB data for iterator debugging.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Emit.NoPia.EmbeddedTypesManager`21.CommonEmbeddedMethod.ToString">
<remarks>
This is only used for testing.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.Emit.NoPia.EmbeddedTypesManager`21.CommonEmbeddedParameter.ToString">
<remarks>
This is only used for testing.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.Emit.NoPia.EmbeddedTypesManager`21.CommonEmbeddedType.ToString">
<remarks>
This is only used for testing.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.Emit.NoPia.EmbeddedTypesManager`21.GetEmbeddedTypeForMember(`5,`3,Microsoft.CodeAnalysis.DiagnosticBag)">
<summary>
Returns null if member doesn't belong to an embedded NoPia type.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Emit.SemanticEdit">
<summary>
Describes a symbol edit between two compilations.
For example, an addition of a method, an update of a method, removal of a type, etc.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Emit.SemanticEdit.Kind">
<summary>
The type of edit.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Emit.SemanticEdit.OldSymbol">
<summary>
The symbol from the earlier compilation,
or null if the edit represents an addition.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Emit.SemanticEdit.NewSymbol">
<summary>
The symbol from the later compilation,
or null if the edit represents a deletion.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Emit.SemanticEdit.SyntaxMap">
<summary>
A map from syntax node in the later compilation to syntax node in the previous compilation,
or null if <see cref="P:Microsoft.CodeAnalysis.Emit.SemanticEdit.PreserveLocalVariables"/> is false and the map is not needed or
the source of the current method is the same as the source of the previous method.
</summary>
<remarks>
The map does not need to map all syntax nodes in the active method, only those syntax nodes
that declare a local or generate a long lived local.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Emit.SemanticEdit.PreserveLocalVariables">
<summary>
True if the edit is an update of the active method and local values
should be preserved; false otherwise.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Emit.SemanticEdit.#ctor(Microsoft.CodeAnalysis.Emit.SemanticEditKind,Microsoft.CodeAnalysis.ISymbol,Microsoft.CodeAnalysis.ISymbol,System.Func{Microsoft.CodeAnalysis.SyntaxNode,Microsoft.CodeAnalysis.SyntaxNode},System.Boolean)">
<summary>
Initializes an instance of <see cref="T:Microsoft.CodeAnalysis.Emit.SemanticEdit"/>.
</summary>
<param name="kind">The type of edit.</param>
<param name="oldSymbol">
The symbol from the earlier compilation, or null if the edit represents an addition.
</param>
<param name="newSymbol">
The symbol from the later compilation, or null if the edit represents a deletion.
</param>
<param name="syntaxMap">
A map from syntax node in the later compilation to syntax node in the previous compilation,
or null if <paramref name="preserveLocalVariables"/> is false and the map is not needed or
the source of the current method is the same as the source of the previous method.
</param>
<param name="preserveLocalVariables">
True if the edit is an update of an active method and local values should be preserved; false otherwise.
</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="oldSymbol"/> or <paramref name="newSymbol"/> is null and the edit isn't a <see cref="F:Microsoft.CodeAnalysis.Emit.SemanticEditKind.Insert"/> or <see cref="F:Microsoft.CodeAnalysis.Emit.SemanticEditKind.Delete"/>, respectively.
</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="kind"/> is not a valid kind.
</exception>
</member>
<member name="F:Microsoft.CodeAnalysis.Emit.SemanticEditKind.None">
<summary>
No change.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Emit.SemanticEditKind.Update">
<summary>
Node value was updated.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Emit.SemanticEditKind.Insert">
<summary>
Node was inserted.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Emit.SemanticEditKind.Delete">
<summary>
Node was deleted.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Emit.StateMachineMoveNextBodyDebugInfo">
<summary>
Information associated with method body of a state machine MoveNext method.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Emit.StateMachineMoveNextBodyDebugInfo.KickoffMethod">
<summary>
Original async/iterator method transformed into MoveNext()
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IInvalidOperation">
<summary>
Represents an invalid operation with one or more child operations.
<para>
Current usage:
(1) C# invalid expression or invalid statement.
(2) VB invalid expression or invalid statement.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.Invalid"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IBlockOperation">
<summary>
Represents a block containing a sequence of operations and local declarations.
<para>
Current usage:
(1) C# "{ ... }" block statement.
(2) VB implicit block statement for method bodies and other block scoped statements.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.Block"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IBlockOperation.Operations">
<summary>
Operations contained within the block.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IBlockOperation.Locals">
<summary>
Local declarations contained within the block.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IVariableDeclarationGroupOperation">
<summary>
Represents a variable declaration statement.
</summary>
<para>
Current Usage:
(1) C# local declaration statement
(2) C# fixed statement
(3) C# using statement
(4) C# using declaration
(5) VB Dim statement
(6) VB Using statement
</para>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.VariableDeclarationGroup"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IVariableDeclarationGroupOperation.Declarations">
<summary>
Variable declaration in the statement.
</summary>
<remarks>
In C#, this will always be a single declaration, with all variables in <see cref="P:Microsoft.CodeAnalysis.Operations.IVariableDeclarationOperation.Declarators" />.
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.ISwitchOperation">
<summary>
Represents a switch operation with a value to be switched upon and switch cases.
<para>
Current usage:
(1) C# switch statement.
(2) VB Select Case statement.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.Switch"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ISwitchOperation.Locals">
<summary>
Locals declared within the switch operation with scope spanning across all <see cref="P:Microsoft.CodeAnalysis.Operations.ISwitchOperation.Cases" />.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ISwitchOperation.Value">
<summary>
Value to be switched upon.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ISwitchOperation.Cases">
<summary>
Cases of the switch.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ISwitchOperation.ExitLabel">
<summary>
Exit label for the switch statement.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.ILoopOperation">
<summary>
Represents a loop operation.
<para>
Current usage:
(1) C# 'while', 'for', 'foreach' and 'do' loop statements
(2) VB 'While', 'ForTo', 'ForEach', 'Do While' and 'Do Until' loop statements
</para>
</summary>
<remarks>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ILoopOperation.LoopKind">
<summary>
Kind of the loop.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ILoopOperation.Body">
<summary>
Body of the loop.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ILoopOperation.Locals">
<summary>
Declared locals.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ILoopOperation.ContinueLabel">
<summary>
Loop continue label.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ILoopOperation.ExitLabel">
<summary>
Loop exit/break label.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IForEachLoopOperation">
<summary>
Represents a for each loop.
<para>
Current usage:
(1) C# 'foreach' loop statement
(2) VB 'For Each' loop statement
</para>
</summary>
<remarks>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IForEachLoopOperation.LoopControlVariable">
<summary>
Refers to the operation for declaring a new local variable or reference an existing variable or an expression.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IForEachLoopOperation.Collection">
<summary>
Collection value over which the loop iterates.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IForEachLoopOperation.NextVariables">
<summary>
Optional list of comma separated next variables at loop bottom in VB.
This list is always empty for C#.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IForEachLoopOperation.IsAsynchronous">
<summary>
Whether this for each loop is asynchronous.
Always false for VB.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IForLoopOperation">
<summary>
Represents a for loop.
<para>
Current usage:
(1) C# 'for' loop statement
</para>
</summary>
<remarks>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IForLoopOperation.Before">
<summary>
List of operations to execute before entry to the loop. For C#, this comes from the first clause of the for statement.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IForLoopOperation.ConditionLocals">
<summary>
Locals declared within the loop Condition and are in scope throughout the <see cref="P:Microsoft.CodeAnalysis.Operations.IForLoopOperation.Condition" />,
<see cref="P:Microsoft.CodeAnalysis.Operations.ILoopOperation.Body" /> and <see cref="P:Microsoft.CodeAnalysis.Operations.IForLoopOperation.AtLoopBottom" />.
They are considered to be declared per iteration.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IForLoopOperation.Condition">
<summary>
Condition of the loop. For C#, this comes from the second clause of the for statement.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IForLoopOperation.AtLoopBottom">
<summary>
List of operations to execute at the bottom of the loop. For C#, this comes from the third clause of the for statement.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IForToLoopOperation">
<summary>
Represents a for to loop with loop control variable and initial, limit and step values for the control variable.
<para>
Current usage:
(1) VB 'For ... To ... Step' loop statement
</para>
</summary>
<remarks>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IForToLoopOperation.LoopControlVariable">
<summary>
Refers to the operation for declaring a new local variable or reference an existing variable or an expression.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IForToLoopOperation.InitialValue">
<summary>
Operation for setting the initial value of the loop control variable. This comes from the expression between the 'For' and 'To' keywords.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IForToLoopOperation.LimitValue">
<summary>
Operation for the limit value of the loop control variable. This comes from the expression after the 'To' keyword.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IForToLoopOperation.StepValue">
<summary>
Operation for the step value of the loop control variable. This comes from the expression after the 'Step' keyword,
or inferred by the compiler if 'Step' clause is omitted.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IForToLoopOperation.IsChecked">
<summary>
<code>true</code> if arithmetic operations behind this loop are 'checked'.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IForToLoopOperation.NextVariables">
<summary>
Optional list of comma separated next variables at loop bottom.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IWhileLoopOperation">
<summary>
Represents a while or do while loop.
<para>
Current usage:
(1) C# 'while' and 'do while' loop statements.
(2) VB 'While', 'Do While' and 'Do Until' loop statements.
</para>
</summary>
<remarks>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IWhileLoopOperation.Condition">
<summary>
Condition of the loop. This can only be null in error scenarios.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IWhileLoopOperation.ConditionIsTop">
<summary>
True if the <see cref="P:Microsoft.CodeAnalysis.Operations.IWhileLoopOperation.Condition" /> is evaluated at start of each loop iteration.
False if it is evaluated at the end of each loop iteration.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IWhileLoopOperation.ConditionIsUntil">
<summary>
True if the loop has 'Until' loop semantics and the loop is executed while <see cref="P:Microsoft.CodeAnalysis.Operations.IWhileLoopOperation.Condition" /> is false.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IWhileLoopOperation.IgnoredCondition">
<summary>
Additional conditional supplied for loop in error cases, which is ignored by the compiler.
For example, for VB 'Do While' or 'Do Until' loop with syntax errors where both the top and bottom conditions are provided.
The top condition is preferred and exposed as <see cref="P:Microsoft.CodeAnalysis.Operations.IWhileLoopOperation.Condition" /> and the bottom condition is ignored and exposed by this property.
This property should be null for all non-error cases.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.ILabeledOperation">
<summary>
Represents an operation with a label.
<para>
Current usage:
(1) C# labeled statement.
(2) VB label statement.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.Labeled"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ILabeledOperation.Label">
<summary>
Label that can be the target of branches.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ILabeledOperation.Operation">
<summary>
Operation that has been labeled. In VB, this is always null.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IBranchOperation">
<summary>
Represents a branch operation.
<para>
Current usage:
(1) C# goto, break, or continue statement.
(2) VB GoTo, Exit ***, or Continue *** statement.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.Branch"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IBranchOperation.Target">
<summary>
Label that is the target of the branch.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IBranchOperation.BranchKind">
<summary>
Kind of the branch.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IEmptyOperation">
<summary>
Represents an empty or no-op operation.
<para>
Current usage:
(1) C# empty statement.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.Empty"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IReturnOperation">
<summary>
Represents a return from the method with an optional return value.
<para>
Current usage:
(1) C# return statement and yield statement.
(2) VB Return statement.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.Return"/></description></item>
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.YieldBreak"/></description></item>
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.YieldReturn"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IReturnOperation.ReturnedValue">
<summary>
Value to be returned.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.ILockOperation">
<summary>
Represents a <see cref="P:Microsoft.CodeAnalysis.Operations.ILockOperation.Body" /> of operations that are executed while holding a lock onto the <see cref="P:Microsoft.CodeAnalysis.Operations.ILockOperation.LockedValue" />.
<para>
Current usage:
(1) C# lock statement.
(2) VB SyncLock statement.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.Lock"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ILockOperation.LockedValue">
<summary>
Operation producing a value to be locked.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ILockOperation.Body">
<summary>
Body of the lock, to be executed while holding the lock.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.ITryOperation">
<summary>
Represents a try operation for exception handling code with a body, catch clauses and a finally handler.
<para>
Current usage:
(1) C# try statement.
(2) VB Try statement.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.Try"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ITryOperation.Body">
<summary>
Body of the try, over which the handlers are active.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ITryOperation.Catches">
<summary>
Catch clauses of the try.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ITryOperation.Finally">
<summary>
Finally handler of the try.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ITryOperation.ExitLabel">
<summary>
Exit label for the try. This will always be null for C#.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IUsingOperation">
<summary>
Represents a <see cref="P:Microsoft.CodeAnalysis.Operations.IUsingOperation.Body" /> of operations that are executed while using disposable <see cref="P:Microsoft.CodeAnalysis.Operations.IUsingOperation.Resources" />.
<para>
Current usage:
(1) C# using statement.
(2) VB Using statement.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.Using"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IUsingOperation.Resources">
<summary>
Declaration introduced or resource held by the using.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IUsingOperation.Body">
<summary>
Body of the using, over which the resources of the using are maintained.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IUsingOperation.Locals">
<summary>
Locals declared within the <see cref="P:Microsoft.CodeAnalysis.Operations.IUsingOperation.Resources" /> with scope spanning across this entire <see cref="T:Microsoft.CodeAnalysis.Operations.IUsingOperation" />.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IUsingOperation.IsAsynchronous">
<summary>
Whether this using is asynchronous.
Always false for VB.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IExpressionStatementOperation">
<summary>
Represents an operation that drops the resulting value and the type of the underlying wrapped <see cref="P:Microsoft.CodeAnalysis.Operations.IExpressionStatementOperation.Operation" />.
<para>
Current usage:
(1) C# expression statement.
(2) VB expression statement.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.ExpressionStatement"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IExpressionStatementOperation.Operation">
<summary>
Underlying operation with a value and type.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.ILocalFunctionOperation">
<summary>
Represents a local function defined within a method.
<para>
Current usage:
(1) C# local function statement.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.LocalFunction"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ILocalFunctionOperation.Symbol">
<summary>
Local function symbol.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ILocalFunctionOperation.Body">
<summary>
Body of the local function.
</summary>
<remarks>
This can be null in error scenarios, or when the method is an extern method.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ILocalFunctionOperation.IgnoredBody">
<summary>
An extra body for the local function, if both a block body and expression body are specified in source.
</summary>
<remarks>
This is only ever non-null in error situations.
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IStopOperation">
<summary>
Represents an operation to stop or suspend execution of code.
<para>
Current usage:
(1) VB Stop statement.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.Stop"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IEndOperation">
<summary>
Represents an operation that stops the execution of code abruptly.
<para>
Current usage:
(1) VB End Statement.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.End"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IRaiseEventOperation">
<summary>
Represents an operation for raising an event.
<para>
Current usage:
(1) VB raise event statement.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.RaiseEvent"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IRaiseEventOperation.EventReference">
<summary>
Reference to the event to be raised.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IRaiseEventOperation.Arguments">
<summary>
Arguments of the invocation, excluding the instance argument. Arguments are in evaluation order.
</summary>
<remarks>
If the invocation is in its expanded form, then params/ParamArray arguments would be collected into arrays.
Default values are supplied for optional arguments missing in source.
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.ILiteralOperation">
<summary>
Represents a textual literal numeric, string, etc.
<para>
Current usage:
(1) C# literal expression.
(2) VB literal expression.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.Literal"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IConversionOperation">
<summary>
Represents a type conversion.
<para>
Current usage:
(1) C# conversion expression.
(2) VB conversion expression.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.Conversion"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IConversionOperation.Operand">
<summary>
Value to be converted.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IConversionOperation.OperatorMethod">
<summary>
Operator method used by the operation, null if the operation does not use an operator method.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IConversionOperation.Conversion">
<summary>
Gets the underlying common conversion information.
</summary>
<remarks>
If you need conversion information that is language specific, use either
<see cref="T:Microsoft.CodeAnalysis.CSharp.CSharpExtensions.GetConversion(IConversionOperation)" /> or
<see cref="T:Microsoft.CodeAnalysis.VisualBasic.VisualBasicExtensions.GetConversion(IConversionOperation)" />.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IConversionOperation.IsTryCast">
<summary>
False if the conversion will fail with a <see cref="T:System.InvalidCastException" /> at runtime if the cast fails. This is true for C#'s
<c>as</c> operator and for VB's <c>TryCast</c> operator.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IConversionOperation.IsChecked">
<summary>
True if the conversion can fail at runtime with an overflow exception. This corresponds to C# checked and unchecked blocks.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IInvocationOperation">
<summary>
Represents an invocation of a method.
<para>
Current usage:
(1) C# method invocation expression.
(2) C# collection element initializer.
For example, in the following collection initializer: <code>new C() { 1, 2, 3 }</code>, we will have
3 <see cref="T:Microsoft.CodeAnalysis.Operations.IInvocationOperation" /> nodes, each of which will be a call to the corresponding Add method
with either 1, 2, 3 as the argument.
(3) VB method invocation expression.
(4) VB collection element initializer.
Similar to the C# example, <code>New C() From {1, 2, 3}</code> will have 3 <see cref="T:Microsoft.CodeAnalysis.Operations.IInvocationOperation" />
nodes with 1, 2, and 3 as their arguments, respectively.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.Invocation"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IInvocationOperation.TargetMethod">
<summary>
Method to be invoked.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IInvocationOperation.Instance">
<summary>
'This' or 'Me' instance to be supplied to the method, or null if the method is static.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IInvocationOperation.IsVirtual">
<summary>
True if the invocation uses a virtual mechanism, and false otherwise.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IInvocationOperation.Arguments">
<summary>
Arguments of the invocation, excluding the instance argument. Arguments are in evaluation order.
</summary>
<remarks>
If the invocation is in its expanded form, then params/ParamArray arguments would be collected into arrays.
Default values are supplied for optional arguments missing in source.
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IArrayElementReferenceOperation">
<summary>
Represents a reference to an array element.
<para>
Current usage:
(1) C# array element reference expression.
(2) VB array element reference expression.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.ArrayElementReference"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IArrayElementReferenceOperation.ArrayReference">
<summary>
Array to be indexed.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IArrayElementReferenceOperation.Indices">
<summary>
Indices that specify an individual element.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.ILocalReferenceOperation">
<summary>
Represents a reference to a declared local variable.
<para>
Current usage:
(1) C# local reference expression.
(2) VB local reference expression.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.LocalReference"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ILocalReferenceOperation.Local">
<summary>
Referenced local variable.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ILocalReferenceOperation.IsDeclaration">
<summary>
True if this reference is also the declaration site of this variable. This is true in out variable declarations
and in deconstruction operations where a new variable is being declared.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IParameterReferenceOperation">
<summary>
Represents a reference to a parameter.
<para>
Current usage:
(1) C# parameter reference expression.
(2) VB parameter reference expression.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.ParameterReference"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IParameterReferenceOperation.Parameter">
<summary>
Referenced parameter.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IMemberReferenceOperation">
<summary>
Represents a reference to a member of a class, struct, or interface.
<para>
Current usage:
(1) C# member reference expression.
(2) VB member reference expression.
</para>
</summary>
<remarks>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IMemberReferenceOperation.Instance">
<summary>
Instance of the type. Null if the reference is to a static/shared member.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IMemberReferenceOperation.Member">
<summary>
Referenced member.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IFieldReferenceOperation">
<summary>
Represents a reference to a field.
<para>
Current usage:
(1) C# field reference expression.
(2) VB field reference expression.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.FieldReference"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IFieldReferenceOperation.Field">
<summary>
Referenced field.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IFieldReferenceOperation.IsDeclaration">
<summary>
If the field reference is also where the field was declared.
</summary>
<remarks>
This is only ever true in CSharp scripts, where a top-level statement creates a new variable
in a reference, such as an out variable declaration or a deconstruction declaration.
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IMethodReferenceOperation">
<summary>
Represents a reference to a method other than as the target of an invocation.
<para>
Current usage:
(1) C# method reference expression.
(2) VB method reference expression.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.MethodReference"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IMethodReferenceOperation.Method">
<summary>
Referenced method.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IMethodReferenceOperation.IsVirtual">
<summary>
Indicates whether the reference uses virtual semantics.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IPropertyReferenceOperation">
<summary>
Represents a reference to a property.
<para>
Current usage:
(1) C# property reference expression.
(2) VB property reference expression.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.PropertyReference"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IPropertyReferenceOperation.Property">
<summary>
Referenced property.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IPropertyReferenceOperation.Arguments">
<summary>
Arguments of the indexer property reference, excluding the instance argument. Arguments are in evaluation order.
</summary>
<remarks>
If the invocation is in its expanded form, then params/ParamArray arguments would be collected into arrays.
Default values are supplied for optional arguments missing in source.
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IEventReferenceOperation">
<summary>
Represents a reference to an event.
<para>
Current usage:
(1) C# event reference expression.
(2) VB event reference expression.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.EventReference"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IEventReferenceOperation.Event">
<summary>
Referenced event.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IUnaryOperation">
<summary>
Represents an operation with one operand and a unary operator.
<para>
Current usage:
(1) C# unary operation expression.
(2) VB unary operation expression.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.Unary"/></description></item>
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.UnaryOperator"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IUnaryOperation.OperatorKind">
<summary>
Kind of unary operation.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IUnaryOperation.Operand">
<summary>
Operand.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IUnaryOperation.IsLifted">
<summary>
<see langword="true" /> if this is a 'lifted' unary operator. When there is an
operator that is defined to work on a value type, 'lifted' operators are
created to work on the <see cref="T:System.Nullable`1" /> versions of those
value types.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IUnaryOperation.IsChecked">
<summary>
<see langword="true" /> if overflow checking is performed for the arithmetic operation.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IUnaryOperation.OperatorMethod">
<summary>
Operator method used by the operation, null if the operation does not use an operator method.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IBinaryOperation">
<summary>
Represents an operation with two operands and a binary operator that produces a result with a non-null type.
<para>
Current usage:
(1) C# binary operator expression.
(2) VB binary operator expression.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.Binary"/></description></item>
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.BinaryOperator"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IBinaryOperation.OperatorKind">
<summary>
Kind of binary operation.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IBinaryOperation.LeftOperand">
<summary>
Left operand.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IBinaryOperation.RightOperand">
<summary>
Right operand.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IBinaryOperation.IsLifted">
<summary>
<see langword="true" /> if this is a 'lifted' binary operator. When there is an
operator that is defined to work on a value type, 'lifted' operators are
created to work on the <see cref="T:System.Nullable`1" /> versions of those
value types.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IBinaryOperation.IsChecked">
<summary>
<see langword="true" /> if this is a 'checked' binary operator.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IBinaryOperation.IsCompareText">
<summary>
<see langword="true" /> if the comparison is text based for string or object comparison in VB.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IBinaryOperation.OperatorMethod">
<summary>
Operator method used by the operation, null if the operation does not use an operator method.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IConditionalOperation">
<summary>
Represents a conditional operation with:
(1) <see cref="P:Microsoft.CodeAnalysis.Operations.IConditionalOperation.Condition" /> to be tested,
(2) <see cref="P:Microsoft.CodeAnalysis.Operations.IConditionalOperation.WhenTrue" /> operation to be executed when <see cref="P:Microsoft.CodeAnalysis.Operations.IConditionalOperation.Condition" /> is true and
(3) <see cref="P:Microsoft.CodeAnalysis.Operations.IConditionalOperation.WhenFalse" /> operation to be executed when the <see cref="P:Microsoft.CodeAnalysis.Operations.IConditionalOperation.Condition" /> is false.
<para>
Current usage:
(1) C# ternary expression "a ? b : c" and if statement.
(2) VB ternary expression "If(a, b, c)" and If Else statement.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.Conditional"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IConditionalOperation.Condition">
<summary>
Condition to be tested.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IConditionalOperation.WhenTrue">
<summary>
Operation to be executed if the <see cref="P:Microsoft.CodeAnalysis.Operations.IConditionalOperation.Condition" /> is true.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IConditionalOperation.WhenFalse">
<summary>
Operation to be executed if the <see cref="P:Microsoft.CodeAnalysis.Operations.IConditionalOperation.Condition" /> is false.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IConditionalOperation.IsRef">
<summary>
Is result a managed reference
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.ICoalesceOperation">
<summary>
Represents a coalesce operation with two operands:
(1) <see cref="P:Microsoft.CodeAnalysis.Operations.ICoalesceOperation.Value" />, which is the first operand that is unconditionally evaluated and is the result of the operation if non null.
(2) <see cref="P:Microsoft.CodeAnalysis.Operations.ICoalesceOperation.WhenNull" />, which is the second operand that is conditionally evaluated and is the result of the operation if <see cref="P:Microsoft.CodeAnalysis.Operations.ICoalesceOperation.Value" /> is null.
<para>
Current usage:
(1) C# null-coalescing expression "Value ?? WhenNull".
(2) VB binary conditional expression "If(Value, WhenNull)".
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.Coalesce"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ICoalesceOperation.Value">
<summary>
Operation to be unconditionally evaluated.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ICoalesceOperation.WhenNull">
<summary>
Operation to be conditionally evaluated if <see cref="P:Microsoft.CodeAnalysis.Operations.ICoalesceOperation.Value" /> evaluates to null/Nothing.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ICoalesceOperation.ValueConversion">
<summary>
Conversion associated with <see cref="P:Microsoft.CodeAnalysis.Operations.ICoalesceOperation.Value" /> when it is not null/Nothing.
Identity if result type of the operation is the same as type of <see cref="P:Microsoft.CodeAnalysis.Operations.ICoalesceOperation.Value" />.
Otherwise, if type of <see cref="P:Microsoft.CodeAnalysis.Operations.ICoalesceOperation.Value" /> is nullable, then conversion is applied to an
unwrapped <see cref="P:Microsoft.CodeAnalysis.Operations.ICoalesceOperation.Value" />, otherwise to the <see cref="P:Microsoft.CodeAnalysis.Operations.ICoalesceOperation.Value" /> itself.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IAnonymousFunctionOperation">
<summary>
Represents an anonymous function operation.
<para>
Current usage:
(1) C# lambda expression.
(2) VB anonymous delegate expression.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.AnonymousFunction"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IAnonymousFunctionOperation.Symbol">
<summary>
Symbol of the anonymous function.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IAnonymousFunctionOperation.Body">
<summary>
Body of the anonymous function.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IObjectCreationOperation">
<summary>
Represents creation of an object instance.
<para>
Current usage:
(1) C# new expression.
(2) VB New expression.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.ObjectCreation"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IObjectCreationOperation.Constructor">
<summary>
Constructor to be invoked on the created instance.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IObjectCreationOperation.Initializer">
<summary>
Object or collection initializer, if any.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IObjectCreationOperation.Arguments">
<summary>
Arguments of the object creation, excluding the instance argument. Arguments are in evaluation order.
</summary>
<remarks>
If the invocation is in its expanded form, then params/ParamArray arguments would be collected into arrays.
Default values are supplied for optional arguments missing in source.
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.ITypeParameterObjectCreationOperation">
<summary>
Represents a creation of a type parameter object, i.e. new T(), where T is a type parameter with new constraint.
<para>
Current usage:
(1) C# type parameter object creation expression.
(2) VB type parameter object creation expression.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.TypeParameterObjectCreation"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ITypeParameterObjectCreationOperation.Initializer">
<summary>
Object or collection initializer, if any.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IArrayCreationOperation">
<summary>
Represents the creation of an array instance.
<para>
Current usage:
(1) C# array creation expression.
(2) VB array creation expression.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.ArrayCreation"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IArrayCreationOperation.DimensionSizes">
<summary>
Sizes of the dimensions of the created array instance.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IArrayCreationOperation.Initializer">
<summary>
Values of elements of the created array instance.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IInstanceReferenceOperation">
<summary>
Represents an implicit/explicit reference to an instance.
<para>
Current usage:
(1) C# this or base expression.
(2) VB Me, MyClass, or MyBase expression.
(3) C# object or collection or 'with' expression initializers.
(4) VB With statements, object or collection initializers.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.InstanceReference"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IInstanceReferenceOperation.ReferenceKind">
<summary>
The kind of reference that is being made.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IIsTypeOperation">
<summary>
Represents an operation that tests if a value is of a specific type.
<para>
Current usage:
(1) C# "is" operator expression.
(2) VB "TypeOf" and "TypeOf IsNot" expression.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.IsType"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IIsTypeOperation.ValueOperand">
<summary>
Value to test.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IIsTypeOperation.TypeOperand">
<summary>
Type for which to test.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IIsTypeOperation.IsNegated">
<summary>
Flag indicating if this is an "is not" type expression.
True for VB "TypeOf ... IsNot ..." expression.
False, otherwise.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IAwaitOperation">
<summary>
Represents an await operation.
<para>
Current usage:
(1) C# await expression.
(2) VB await expression.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.Await"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IAwaitOperation.Operation">
<summary>
Awaited operation.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IAssignmentOperation">
<summary>
Represents a base interface for assignments.
<para>
Current usage:
(1) C# simple, compound and deconstruction assignment expressions.
(2) VB simple and compound assignment expressions.
</para>
</summary>
<remarks>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IAssignmentOperation.Target">
<summary>
Target of the assignment.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IAssignmentOperation.Value">
<summary>
Value to be assigned to the target of the assignment.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.ISimpleAssignmentOperation">
<summary>
Represents a simple assignment operation.
<para>
Current usage:
(1) C# simple assignment expression.
(2) VB simple assignment expression.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.SimpleAssignment"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ISimpleAssignmentOperation.IsRef">
<summary>
Is this a ref assignment
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.ICompoundAssignmentOperation">
<summary>
Represents a compound assignment that mutates the target with the result of a binary operation.
<para>
Current usage:
(1) C# compound assignment expression.
(2) VB compound assignment expression.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.CompoundAssignment"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ICompoundAssignmentOperation.InConversion">
<summary>
Conversion applied to <see cref="P:Microsoft.CodeAnalysis.Operations.IAssignmentOperation.Target" /> before the operation occurs.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ICompoundAssignmentOperation.OutConversion">
<summary>
Conversion applied to the result of the binary operation, before it is assigned back to
<see cref="P:Microsoft.CodeAnalysis.Operations.IAssignmentOperation.Target" />.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ICompoundAssignmentOperation.OperatorKind">
<summary>
Kind of binary operation.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ICompoundAssignmentOperation.IsLifted">
<summary>
<see langword="true" /> if this assignment contains a 'lifted' binary operation.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ICompoundAssignmentOperation.IsChecked">
<summary>
<see langword="true" /> if overflow checking is performed for the arithmetic operation.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ICompoundAssignmentOperation.OperatorMethod">
<summary>
Operator method used by the operation, null if the operation does not use an operator method.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IParenthesizedOperation">
<summary>
Represents a parenthesized operation.
<para>
Current usage:
(1) VB parenthesized expression.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.Parenthesized"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IParenthesizedOperation.Operand">
<summary>
Operand enclosed in parentheses.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IEventAssignmentOperation">
<summary>
Represents a binding of an event.
<para>
Current usage:
(1) C# event assignment expression.
(2) VB Add/Remove handler statement.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.EventAssignment"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IEventAssignmentOperation.EventReference">
<summary>
Reference to the event being bound.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IEventAssignmentOperation.HandlerValue">
<summary>
Handler supplied for the event.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IEventAssignmentOperation.Adds">
<summary>
True for adding a binding, false for removing one.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IConditionalAccessOperation">
<summary>
Represents a conditionally accessed operation. Note that <see cref="T:Microsoft.CodeAnalysis.Operations.IConditionalAccessInstanceOperation" /> is used to refer to the value
of <see cref="P:Microsoft.CodeAnalysis.Operations.IConditionalAccessOperation.Operation" /> within <see cref="P:Microsoft.CodeAnalysis.Operations.IConditionalAccessOperation.WhenNotNull" />.
<para>
Current usage:
(1) C# conditional access expression (? or ?. operator).
(2) VB conditional access expression (? or ?. operator).
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.ConditionalAccess"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IConditionalAccessOperation.Operation">
<summary>
Operation that will be evaluated and accessed if non null.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IConditionalAccessOperation.WhenNotNull">
<summary>
Operation to be evaluated if <see cref="P:Microsoft.CodeAnalysis.Operations.IConditionalAccessOperation.Operation" /> is non null.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IConditionalAccessInstanceOperation">
<summary>
Represents the value of a conditionally-accessed operation within <see cref="P:Microsoft.CodeAnalysis.Operations.IConditionalAccessOperation.WhenNotNull" />.
For a conditional access operation of the form <c>someExpr?.Member</c>, this operation is used as the InstanceReceiver for the right operation <c>Member</c>.
See https://github.com/dotnet/roslyn/issues/21279#issuecomment-323153041 for more details.
<para>
Current usage:
(1) C# conditional access instance expression.
(2) VB conditional access instance expression.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.ConditionalAccessInstance"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IInterpolatedStringOperation">
<summary>
Represents an interpolated string.
<para>
Current usage:
(1) C# interpolated string expression.
(2) VB interpolated string expression.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.InterpolatedString"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IInterpolatedStringOperation.Parts">
<summary>
Constituent parts of interpolated string, each of which is an <see cref="T:Microsoft.CodeAnalysis.Operations.IInterpolatedStringContentOperation" />.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IAnonymousObjectCreationOperation">
<summary>
Represents a creation of anonymous object.
<para>
Current usage:
(1) C# "new { ... }" expression
(2) VB "New With { ... }" expression
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.AnonymousObjectCreation"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IAnonymousObjectCreationOperation.Initializers">
<summary>
Property initializers.
Each initializer is an <see cref="T:Microsoft.CodeAnalysis.Operations.ISimpleAssignmentOperation" />, with an <see cref="T:Microsoft.CodeAnalysis.Operations.IPropertyReferenceOperation" />
as the target whose Instance is an <see cref="T:Microsoft.CodeAnalysis.Operations.IInstanceReferenceOperation" /> with <see cref="F:Microsoft.CodeAnalysis.Operations.InstanceReferenceKind.ImplicitReceiver" /> kind.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IObjectOrCollectionInitializerOperation">
<summary>
Represents an initialization for an object or collection creation.
<para>
Current usage:
(1) C# object or collection initializer expression.
(2) VB object or collection initializer expression.
For example, object initializer "{ X = x }" within object creation "new Class() { X = x }" and
collection initializer "{ x, y, 3 }" within collection creation "new MyList() { x, y, 3 }".
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.ObjectOrCollectionInitializer"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IObjectOrCollectionInitializerOperation.Initializers">
<summary>
Object member or collection initializers.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IMemberInitializerOperation">
<summary>
Represents an initialization of member within an object initializer with a nested object or collection initializer.
<para>
Current usage:
(1) C# nested member initializer expression.
For example, given an object creation with initializer "new Class() { X = x, Y = { x, y, 3 }, Z = { X = z } }",
member initializers for Y and Z, i.e. "Y = { x, y, 3 }", and "Z = { X = z }" are nested member initializers represented by this operation.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.MemberInitializer"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IMemberInitializerOperation.InitializedMember">
<summary>
Initialized member reference <see cref="T:Microsoft.CodeAnalysis.Operations.IMemberReferenceOperation" /> or an invalid operation for error cases.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IMemberInitializerOperation.Initializer">
<summary>
Member initializer.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.ICollectionElementInitializerOperation">
<summary>
Obsolete interface that used to represent a collection element initializer. It has been replaced by
<see cref="T:Microsoft.CodeAnalysis.Operations.IInvocationOperation" /> and <see cref="T:Microsoft.CodeAnalysis.Operations.IDynamicInvocationOperation" />, as appropriate.
<para>
Current usage:
None. This API has been obsoleted in favor of <see cref="T:Microsoft.CodeAnalysis.Operations.IInvocationOperation" /> and <see cref="T:Microsoft.CodeAnalysis.Operations.IDynamicInvocationOperation" />.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.CollectionElementInitializer"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.INameOfOperation">
<summary>
Represents an operation that gets a string value for the <see cref="P:Microsoft.CodeAnalysis.Operations.INameOfOperation.Argument" /> name.
<para>
Current usage:
(1) C# nameof expression.
(2) VB NameOf expression.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.NameOf"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.INameOfOperation.Argument">
<summary>
Argument to the name of operation.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.ITupleOperation">
<summary>
Represents a tuple with one or more elements.
<para>
Current usage:
(1) C# tuple expression.
(2) VB tuple expression.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.Tuple"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ITupleOperation.Elements">
<summary>
Tuple elements.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ITupleOperation.NaturalType">
<summary>
Natural type of the tuple, or null if tuple doesn't have a natural type.
Natural type can be different from <see cref="P:Microsoft.CodeAnalysis.IOperation.Type" /> depending on the
conversion context, in which the tuple is used.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IDynamicObjectCreationOperation">
<summary>
Represents an object creation with a dynamically bound constructor.
<para>
Current usage:
(1) C# "new" expression with dynamic argument(s).
(2) VB late bound "New" expression.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.DynamicObjectCreation"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IDynamicObjectCreationOperation.Initializer">
<summary>
Object or collection initializer, if any.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IDynamicObjectCreationOperation.Arguments">
<summary>
Dynamically bound arguments, excluding the instance argument.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IDynamicMemberReferenceOperation">
<summary>
Represents a reference to a member of a class, struct, or module that is dynamically bound.
<para>
Current usage:
(1) C# dynamic member reference expression.
(2) VB late bound member reference expression.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.DynamicMemberReference"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IDynamicMemberReferenceOperation.Instance">
<summary>
Instance receiver, if it exists.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IDynamicMemberReferenceOperation.MemberName">
<summary>
Referenced member.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IDynamicMemberReferenceOperation.TypeArguments">
<summary>
Type arguments.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IDynamicMemberReferenceOperation.ContainingType">
<summary>
The containing type of the referenced member, if different from type of the <see cref="P:Microsoft.CodeAnalysis.Operations.IDynamicMemberReferenceOperation.Instance" />.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IDynamicInvocationOperation">
<summary>
Represents a invocation that is dynamically bound.
<para>
Current usage:
(1) C# dynamic invocation expression.
(2) C# dynamic collection element initializer.
For example, in the following collection initializer: <code>new C() { do1, do2, do3 }</code> where
the doX objects are of type dynamic, we'll have 3 <see cref="T:Microsoft.CodeAnalysis.Operations.IDynamicInvocationOperation" /> with do1, do2, and
do3 as their arguments.
(3) VB late bound invocation expression.
(4) VB dynamic collection element initializer.
Similar to the C# example, <code>New C() From {do1, do2, do3}</code> will generate 3 <see cref="T:Microsoft.CodeAnalysis.Operations.IDynamicInvocationOperation" />
nodes with do1, do2, and do3 as their arguments, respectively.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.DynamicInvocation"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IDynamicInvocationOperation.Operation">
<summary>
Dynamically or late bound operation.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IDynamicInvocationOperation.Arguments">
<summary>
Dynamically bound arguments, excluding the instance argument.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IDynamicIndexerAccessOperation">
<summary>
Represents an indexer access that is dynamically bound.
<para>
Current usage:
(1) C# dynamic indexer access expression.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.DynamicIndexerAccess"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IDynamicIndexerAccessOperation.Operation">
<summary>
Dynamically indexed operation.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IDynamicIndexerAccessOperation.Arguments">
<summary>
Dynamically bound arguments, excluding the instance argument.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.ITranslatedQueryOperation">
<summary>
Represents an unrolled/lowered query operation.
For example, for a C# query expression "from x in set where x.Name != null select x.Name", the Operation tree has the following shape:
ITranslatedQueryExpression
IInvocationExpression ('Select' invocation for "select x.Name")
IInvocationExpression ('Where' invocation for "where x.Name != null")
IInvocationExpression ('From' invocation for "from x in set")
<para>
Current usage:
(1) C# query expression.
(2) VB query expression.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.TranslatedQuery"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ITranslatedQueryOperation.Operation">
<summary>
Underlying unrolled operation.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IDelegateCreationOperation">
<summary>
Represents a delegate creation. This is created whenever a new delegate is created.
<para>
Current usage:
(1) C# delegate creation expression.
(2) VB delegate creation expression.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.DelegateCreation"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IDelegateCreationOperation.Target">
<summary>
The lambda or method binding that this delegate is created from.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IDefaultValueOperation">
<summary>
Represents a default value operation.
<para>
Current usage:
(1) C# default value expression.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.DefaultValue"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.ITypeOfOperation">
<summary>
Represents an operation that gets <see cref="T:System.Type" /> for the given <see cref="P:Microsoft.CodeAnalysis.Operations.ITypeOfOperation.TypeOperand" />.
<para>
Current usage:
(1) C# typeof expression.
(2) VB GetType expression.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.TypeOf"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ITypeOfOperation.TypeOperand">
<summary>
Type operand.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.ISizeOfOperation">
<summary>
Represents an operation to compute the size of a given type.
<para>
Current usage:
(1) C# sizeof expression.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.SizeOf"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ISizeOfOperation.TypeOperand">
<summary>
Type operand.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IAddressOfOperation">
<summary>
Represents an operation that creates a pointer value by taking the address of a reference.
<para>
Current usage:
(1) C# address of expression
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.AddressOf"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IAddressOfOperation.Reference">
<summary>
Addressed reference.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IIsPatternOperation">
<summary>
Represents an operation that tests if a value matches a specific pattern.
<para>
Current usage:
(1) C# is pattern expression. For example, "x is int i".
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.IsPattern"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IIsPatternOperation.Value">
<summary>
Underlying operation to test.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IIsPatternOperation.Pattern">
<summary>
Pattern.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IIncrementOrDecrementOperation">
<summary>
Represents an <see cref="F:Microsoft.CodeAnalysis.OperationKind.Increment" /> or <see cref="F:Microsoft.CodeAnalysis.OperationKind.Decrement" /> operation.
Note that this operation is different from an <see cref="T:Microsoft.CodeAnalysis.Operations.IUnaryOperation" /> as it mutates the <see cref="P:Microsoft.CodeAnalysis.Operations.IIncrementOrDecrementOperation.Target" />,
while unary operator expression does not mutate it's operand.
<para>
Current usage:
(1) C# increment expression or decrement expression.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.Increment"/></description></item>
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.Decrement"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IIncrementOrDecrementOperation.IsPostfix">
<summary>
<see langword="true" /> if this is a postfix expression. <see langword="false" /> if this is a prefix expression.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IIncrementOrDecrementOperation.IsLifted">
<summary>
<see langword="true" /> if this is a 'lifted' increment operator. When there
is an operator that is defined to work on a value type, 'lifted' operators are
created to work on the <see cref="T:System.Nullable`1" /> versions of those
value types.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IIncrementOrDecrementOperation.IsChecked">
<summary>
<see langword="true" /> if overflow checking is performed for the arithmetic operation.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IIncrementOrDecrementOperation.Target">
<summary>
Target of the assignment.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IIncrementOrDecrementOperation.OperatorMethod">
<summary>
Operator method used by the operation, null if the operation does not use an operator method.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IThrowOperation">
<summary>
Represents an operation to throw an exception.
<para>
Current usage:
(1) C# throw expression.
(2) C# throw statement.
(2) VB Throw statement.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.Throw"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IThrowOperation.Exception">
<summary>
Instance of an exception being thrown.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IDeconstructionAssignmentOperation">
<summary>
Represents a assignment with a deconstruction.
<para>
Current usage:
(1) C# deconstruction assignment expression.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.DeconstructionAssignment"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IDeclarationExpressionOperation">
<summary>
Represents a declaration expression operation. Unlike a regular variable declaration <see cref="T:Microsoft.CodeAnalysis.Operations.IVariableDeclaratorOperation" /> and <see cref="T:Microsoft.CodeAnalysis.Operations.IVariableDeclarationOperation" />, this operation represents an "expression" declaring a variable.
<para>
Current usage:
(1) C# declaration expression. For example,
(a) "var (x, y)" is a deconstruction declaration expression with variables x and y.
(b) "(var x, var y)" is a tuple expression with two declaration expressions.
(c) "M(out var x);" is an invocation expression with an out "var x" declaration expression.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.DeclarationExpression"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IDeclarationExpressionOperation.Expression">
<summary>
Underlying expression.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IOmittedArgumentOperation">
<summary>
Represents an argument value that has been omitted in an invocation.
<para>
Current usage:
(1) VB omitted argument in an invocation expression.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.OmittedArgument"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.ISymbolInitializerOperation">
<summary>
Represents an initializer for a field, property, parameter or a local variable declaration.
<para>
Current usage:
(1) C# field, property, parameter or local variable initializer.
(2) VB field(s), property, parameter or local variable initializer.
</para>
</summary>
<remarks>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ISymbolInitializerOperation.Locals">
<summary>
Local declared in and scoped to the <see cref="P:Microsoft.CodeAnalysis.Operations.ISymbolInitializerOperation.Value" />.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ISymbolInitializerOperation.Value">
<summary>
Underlying initializer value.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IFieldInitializerOperation">
<summary>
Represents an initialization of a field.
<para>
Current usage:
(1) C# field initializer with equals value clause.
(2) VB field(s) initializer with equals value clause or AsNew clause. Multiple fields can be initialized with AsNew clause in VB.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.FieldInitializer"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IFieldInitializerOperation.InitializedFields">
<summary>
Initialized fields. There can be multiple fields for Visual Basic fields declared with AsNew clause.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IVariableInitializerOperation">
<summary>
Represents an initialization of a local variable.
<para>
Current usage:
(1) C# local variable initializer with equals value clause.
(2) VB local variable initializer with equals value clause or AsNew clause.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.VariableInitializer"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IPropertyInitializerOperation">
<summary>
Represents an initialization of a property.
<para>
Current usage:
(1) C# property initializer with equals value clause.
(2) VB property initializer with equals value clause or AsNew clause. Multiple properties can be initialized with 'WithEvents' declaration with AsNew clause in VB.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.PropertyInitializer"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IPropertyInitializerOperation.InitializedProperties">
<summary>
Initialized properties. There can be multiple properties for Visual Basic 'WithEvents' declaration with AsNew clause.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IParameterInitializerOperation">
<summary>
Represents an initialization of a parameter at the point of declaration.
<para>
Current usage:
(1) C# parameter initializer with equals value clause.
(2) VB parameter initializer with equals value clause.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.ParameterInitializer"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IParameterInitializerOperation.Parameter">
<summary>
Initialized parameter.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IArrayInitializerOperation">
<summary>
Represents the initialization of an array instance.
<para>
Current usage:
(1) C# array initializer.
(2) VB array initializer.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.ArrayInitializer"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IArrayInitializerOperation.ElementValues">
<summary>
Values to initialize array elements.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IVariableDeclaratorOperation">
<summary>
Represents a single variable declarator and initializer.
</summary>
<para>
Current Usage:
(1) C# variable declarator
(2) C# catch variable declaration
(3) VB single variable declaration
(4) VB catch variable declaration
</para>
<remarks>
In VB, the initializer for this node is only ever used for explicit array bounds initializers. This node corresponds to
the VariableDeclaratorSyntax in C# and the ModifiedIdentifierSyntax in VB.
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.VariableDeclarator"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IVariableDeclaratorOperation.Symbol">
<summary>
Symbol declared by this variable declaration
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IVariableDeclaratorOperation.Initializer">
<summary>
Optional initializer of the variable.
</summary>
<remarks>
If this variable is in an <see cref="T:Microsoft.CodeAnalysis.Operations.IVariableDeclarationOperation" />, the initializer may be located
in the parent operation. Call <see cref="M:Microsoft.CodeAnalysis.Operations.OperationExtensions.GetVariableInitializer(Microsoft.CodeAnalysis.Operations.IVariableDeclaratorOperation)" />
to check in all locations. It is only possible to have initializers in both locations in VB invalid code scenarios.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IVariableDeclaratorOperation.IgnoredArguments">
<summary>
Additional arguments supplied to the declarator in error cases, ignored by the compiler. This only used for the C# case of
DeclaredArgumentSyntax nodes on a VariableDeclaratorSyntax.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IVariableDeclarationOperation">
<summary>
Represents a declarator that declares multiple individual variables.
</summary>
<para>
Current Usage:
(1) C# VariableDeclaration
(2) C# fixed declarations
(3) VB Dim statement declaration groups
(4) VB Using statement variable declarations
</para>
<remarks>
The initializer of this node is applied to all individual declarations in <see cref="P:Microsoft.CodeAnalysis.Operations.IVariableDeclarationOperation.Declarators" />. There cannot
be initializers in both locations except in invalid code scenarios.
In C#, this node will never have an initializer.
This corresponds to the VariableDeclarationSyntax in C#, and the VariableDeclaratorSyntax in Visual Basic.
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.VariableDeclaration"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IVariableDeclarationOperation.Declarators">
<summary>
Individual variable declarations declared by this multiple declaration.
</summary>
<remarks>
All <see cref="T:Microsoft.CodeAnalysis.Operations.IVariableDeclarationGroupOperation" /> will have at least 1 <see cref="T:Microsoft.CodeAnalysis.Operations.IVariableDeclarationOperation" />,
even if the declaration group only declares 1 variable.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IVariableDeclarationOperation.Initializer">
<summary>
Optional initializer of the variable.
</summary>
<remarks>
In C#, this will always be null.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IVariableDeclarationOperation.IgnoredDimensions">
<summary>
Array dimensions supplied to an array declaration in error cases, ignored by the compiler. This is only used for the C# case of
RankSpecifierSyntax nodes on an ArrayTypeSyntax.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IArgumentOperation">
<summary>
Represents an argument to a method invocation.
<para>
Current usage:
(1) C# argument to an invocation expression, object creation expression, etc.
(2) VB argument to an invocation expression, object creation expression, etc.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.Argument"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IArgumentOperation.ArgumentKind">
<summary>
Kind of argument.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IArgumentOperation.Parameter">
<summary>
Parameter the argument matches. This can be null for __arglist parameters.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IArgumentOperation.Value">
<summary>
Value supplied for the argument.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IArgumentOperation.InConversion">
<summary>
Information of the conversion applied to the argument value passing it into the target method. Applicable only to VB Reference arguments.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IArgumentOperation.OutConversion">
<summary>
Information of the conversion applied to the argument value after the invocation. Applicable only to VB Reference arguments.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.ICatchClauseOperation">
<summary>
Represents a catch clause.
<para>
Current usage:
(1) C# catch clause.
(2) VB Catch clause.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.CatchClause"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ICatchClauseOperation.ExceptionDeclarationOrExpression">
<summary>
Optional source for exception. This could be any of the following operation:
1. Declaration for the local catch variable bound to the caught exception (C# and VB) OR
2. Null, indicating no declaration or expression (C# and VB)
3. Reference to an existing local or parameter (VB) OR
4. Other expression for error scenarios (VB)
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ICatchClauseOperation.ExceptionType">
<summary>
Type of the exception handled by the catch clause.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ICatchClauseOperation.Locals">
<summary>
Locals declared by the <see cref="P:Microsoft.CodeAnalysis.Operations.ICatchClauseOperation.ExceptionDeclarationOrExpression" /> and/or <see cref="P:Microsoft.CodeAnalysis.Operations.ICatchClauseOperation.Filter" /> clause.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ICatchClauseOperation.Filter">
<summary>
Filter operation to be executed to determine whether to handle the exception.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ICatchClauseOperation.Handler">
<summary>
Body of the exception handler.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.ISwitchCaseOperation">
<summary>
Represents a switch case section with one or more case clauses to match and one or more operations to execute within the section.
<para>
Current usage:
(1) C# switch section for one or more case clause and set of statements to execute.
(2) VB case block with a case statement for one or more case clause and set of statements to execute.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.SwitchCase"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ISwitchCaseOperation.Clauses">
<summary>
Clauses of the case.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ISwitchCaseOperation.Body">
<summary>
One or more operations to execute within the switch section.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ISwitchCaseOperation.Locals">
<summary>
Locals declared within the switch case section scoped to the section.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.ICaseClauseOperation">
<summary>
Represents a case clause.
<para>
Current usage:
(1) C# case clause.
(2) VB Case clause.
</para>
</summary>
<remarks>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ICaseClauseOperation.CaseKind">
<summary>
Kind of the clause.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ICaseClauseOperation.Label">
<summary>
Label associated with the case clause, if any.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IDefaultCaseClauseOperation">
<summary>
Represents a default case clause.
<para>
Current usage:
(1) C# default clause.
(2) VB Case Else clause.
</para>
</summary>
<remarks>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IPatternCaseClauseOperation">
<summary>
Represents a case clause with a pattern and an optional guard operation.
<para>
Current usage:
(1) C# pattern case clause.
</para>
</summary>
<remarks>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IPatternCaseClauseOperation.Label">
<summary>
Label associated with the case clause.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IPatternCaseClauseOperation.Pattern">
<summary>
Pattern associated with case clause.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IPatternCaseClauseOperation.Guard">
<summary>
Guard associated with the pattern case clause.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IRangeCaseClauseOperation">
<summary>
Represents a case clause with range of values for comparison.
<para>
Current usage:
(1) VB range case clause of the form "Case x To y".
</para>
</summary>
<remarks>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IRangeCaseClauseOperation.MinimumValue">
<summary>
Minimum value of the case range.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IRangeCaseClauseOperation.MaximumValue">
<summary>
Maximum value of the case range.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IRelationalCaseClauseOperation">
<summary>
Represents a case clause with custom relational operator for comparison.
<para>
Current usage:
(1) VB relational case clause of the form "Case Is op x".
</para>
</summary>
<remarks>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IRelationalCaseClauseOperation.Value">
<summary>
Case value.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IRelationalCaseClauseOperation.Relation">
<summary>
Relational operator used to compare the switch value with the case value.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.ISingleValueCaseClauseOperation">
<summary>
Represents a case clause with a single value for comparison.
<para>
Current usage:
(1) C# case clause of the form "case x"
(2) VB case clause of the form "Case x".
</para>
</summary>
<remarks>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ISingleValueCaseClauseOperation.Value">
<summary>
Case value.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IInterpolatedStringContentOperation">
<summary>
Represents a constituent part of an interpolated string.
<para>
Current usage:
(1) C# interpolated string content.
(2) VB interpolated string content.
</para>
</summary>
<remarks>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IInterpolatedStringTextOperation">
<summary>
Represents a constituent string literal part of an interpolated string operation.
<para>
Current usage:
(1) C# interpolated string text.
(2) VB interpolated string text.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.InterpolatedStringText"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IInterpolatedStringTextOperation.Text">
<summary>
Text content.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IInterpolationOperation">
<summary>
Represents a constituent interpolation part of an interpolated string operation.
<para>
Current usage:
(1) C# interpolation part.
(2) VB interpolation part.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.Interpolation"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IInterpolationOperation.Expression">
<summary>
Expression of the interpolation.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IInterpolationOperation.Alignment">
<summary>
Optional alignment of the interpolation.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IInterpolationOperation.FormatString">
<summary>
Optional format string of the interpolation.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IPatternOperation">
<summary>
Represents a pattern matching operation.
<para>
Current usage:
(1) C# pattern.
</para>
</summary>
<remarks>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IPatternOperation.InputType">
<summary>
The input type to the pattern-matching operation.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IPatternOperation.NarrowedType">
<summary>
The narrowed type of the pattern-matching operation.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IConstantPatternOperation">
<summary>
Represents a pattern with a constant value.
<para>
Current usage:
(1) C# constant pattern.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.ConstantPattern"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IConstantPatternOperation.Value">
<summary>
Constant value of the pattern operation.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IDeclarationPatternOperation">
<summary>
Represents a pattern that declares a symbol.
<para>
Current usage:
(1) C# declaration pattern.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.DeclarationPattern"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IDeclarationPatternOperation.MatchedType">
<summary>
The type explicitly specified, or null if it was inferred (e.g. using <code>var</code> in C#).
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IDeclarationPatternOperation.MatchesNull">
<summary>
True if the pattern is of a form that accepts null.
For example, in C# the pattern `var x` will match a null input,
while the pattern `string x` will not.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IDeclarationPatternOperation.DeclaredSymbol">
<summary>
Symbol declared by the pattern, if any.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.ITupleBinaryOperation">
<summary>
Represents a comparison of two operands that returns a bool type.
<para>
Current usage:
(1) C# tuple binary operator expression.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.TupleBinary"/></description></item>
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.TupleBinaryOperator"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ITupleBinaryOperation.OperatorKind">
<summary>
Kind of binary operation.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ITupleBinaryOperation.LeftOperand">
<summary>
Left operand.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ITupleBinaryOperation.RightOperand">
<summary>
Right operand.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IMethodBodyBaseOperation">
<summary>
Represents a method body operation.
<para>
Current usage:
(1) C# method body
</para>
</summary>
<remarks>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IMethodBodyBaseOperation.BlockBody">
<summary>
Method body corresponding to BaseMethodDeclarationSyntax.Body or AccessorDeclarationSyntax.Body
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IMethodBodyBaseOperation.ExpressionBody">
<summary>
Method body corresponding to BaseMethodDeclarationSyntax.ExpressionBody or AccessorDeclarationSyntax.ExpressionBody
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IMethodBodyOperation">
<summary>
Represents a method body operation.
<para>
Current usage:
(1) C# method body for non-constructor
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.MethodBody"/></description></item>
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.MethodBodyOperation"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IConstructorBodyOperation">
<summary>
Represents a constructor method body operation.
<para>
Current usage:
(1) C# method body for constructor declaration
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.ConstructorBody"/></description></item>
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.ConstructorBodyOperation"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IConstructorBodyOperation.Locals">
<summary>
Local declarations contained within the <see cref="P:Microsoft.CodeAnalysis.Operations.IConstructorBodyOperation.Initializer" />.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IConstructorBodyOperation.Initializer">
<summary>
Constructor initializer, if any.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IDiscardOperation">
<summary>
Represents a discard operation.
<para>
Current usage: C# discard expressions
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.Discard"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IDiscardOperation.DiscardSymbol">
<summary>
The symbol of the discard operation.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.ICoalesceAssignmentOperation">
<summary>
Represents a coalesce assignment operation with a target and a conditionally-evaluated value:
(1) <see cref="P:Microsoft.CodeAnalysis.Operations.IAssignmentOperation.Target" /> is evaluated for null. If it is null, <see cref="P:Microsoft.CodeAnalysis.Operations.IAssignmentOperation.Value" /> is evaluated and assigned to target.
(2) <see cref="P:Microsoft.CodeAnalysis.Operations.IAssignmentOperation.Value" /> is conditionally evaluated if <see cref="P:Microsoft.CodeAnalysis.Operations.IAssignmentOperation.Target" /> is null, and the result is assigned into <see cref="P:Microsoft.CodeAnalysis.Operations.IAssignmentOperation.Target" />.
The result of the entire expression is<see cref="P:Microsoft.CodeAnalysis.Operations.IAssignmentOperation.Target" />, which is only evaluated once.
<para>
Current usage:
(1) C# null-coalescing assignment operation <code>Target ??= Value</code>.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.CoalesceAssignment"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IRangeOperation">
<summary>
Represents a range operation.
<para>
Current usage:
(1) C# range expressions
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.Range"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IRangeOperation.LeftOperand">
<summary>
Left operand.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IRangeOperation.RightOperand">
<summary>
Right operand.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IRangeOperation.IsLifted">
<summary>
<code>true</code> if this is a 'lifted' range operation. When there is an
operator that is defined to work on a value type, 'lifted' operators are
created to work on the <see cref="T:System.Nullable`1" /> versions of those
value types.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IRangeOperation.Method">
<summary>
Factory method used to create this Range value. Can be null if appropriate
symbol was not found.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IReDimOperation">
<summary>
Represents the ReDim operation to re-allocate storage space for array variables.
<para>
Current usage:
(1) VB ReDim statement.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.ReDim"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IReDimOperation.Clauses">
<summary>
Individual clauses of the ReDim operation.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IReDimOperation.Preserve">
<summary>
Modifier used to preserve the data in the existing array when you change the size of only the last dimension.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IReDimClauseOperation">
<summary>
Represents an individual clause of an <see cref="T:Microsoft.CodeAnalysis.Operations.IReDimOperation" /> to re-allocate storage space for a single array variable.
<para>
Current usage:
(1) VB ReDim clause.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.ReDimClause"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IReDimClauseOperation.Operand">
<summary>
Operand whose storage space needs to be re-allocated.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IReDimClauseOperation.DimensionSizes">
<summary>
Sizes of the dimensions of the created array instance.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IRecursivePatternOperation">
<summary>
Represents a C# recursive pattern.
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.RecursivePattern"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IRecursivePatternOperation.MatchedType">
<summary>
The type accepted for the recursive pattern.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IRecursivePatternOperation.DeconstructSymbol">
<summary>
The symbol, if any, used for the fetching values for subpatterns. This is either a <code>Deconstruct</code>
method, the type <code>System.Runtime.CompilerServices.ITuple</code>, or null (for example, in
error cases or when matching a tuple type).
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IRecursivePatternOperation.DeconstructionSubpatterns">
<summary>
This contains the patterns contained within a deconstruction or positional subpattern.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IRecursivePatternOperation.PropertySubpatterns">
<summary>
This contains the (symbol, property) pairs within a property subpattern.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IRecursivePatternOperation.DeclaredSymbol">
<summary>
Symbol declared by the pattern.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IDiscardPatternOperation">
<summary>
Represents a discard pattern.
<para>
Current usage: C# discard pattern
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.DiscardPattern"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.ISwitchExpressionOperation">
<summary>
Represents a switch expression.
<para>
Current usage:
(1) C# switch expression.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.SwitchExpression"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ISwitchExpressionOperation.Value">
<summary>
Value to be switched upon.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ISwitchExpressionOperation.Arms">
<summary>
Arms of the switch expression.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.ISwitchExpressionArmOperation">
<summary>
Represents one arm of a switch expression.
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.SwitchExpressionArm"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ISwitchExpressionArmOperation.Pattern">
<summary>
The pattern to match.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ISwitchExpressionArmOperation.Guard">
<summary>
Guard (when clause expression) associated with the switch arm, if any.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ISwitchExpressionArmOperation.Value">
<summary>
Result value of the enclosing switch expression when this arm matches.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ISwitchExpressionArmOperation.Locals">
<summary>
Locals declared within the switch arm (e.g. pattern locals and locals declared in the guard) scoped to the arm.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IPropertySubpatternOperation">
<summary>
Represents an element of a property subpattern, which identifies a member to be matched and the
pattern to match it against.
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.PropertySubpattern"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IPropertySubpatternOperation.Member">
<summary>
The member being matched in a property subpattern. This can be a <see cref="T:Microsoft.CodeAnalysis.Operations.IMemberReferenceOperation" />
in non-error cases, or an <see cref="T:Microsoft.CodeAnalysis.Operations.IInvalidOperation" /> in error cases.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IPropertySubpatternOperation.Pattern">
<summary>
The pattern to which the member is matched in a property subpattern.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IAggregateQueryOperation">
<summary>
Represents a standalone VB query Aggregate operation with more than one item in Into clause.
</summary>
<remarks>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IFixedOperation">
<summary>
Represents a C# fixed statement.
</summary>
<remarks>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IFixedOperation.Locals">
<summary>
Locals declared.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IFixedOperation.Variables">
<summary>
Variables to be fixed.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IFixedOperation.Body">
<summary>
Body of the fixed, over which the variables are fixed.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.INoPiaObjectCreationOperation">
<summary>
Represents a creation of an instance of a NoPia interface, i.e. new I(), where I is an embedded NoPia interface.
<para>
Current usage:
(1) C# NoPia interface instance creation expression.
(2) VB NoPia interface instance creation expression.
</para>
</summary>
<remarks>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.INoPiaObjectCreationOperation.Initializer">
<summary>
Object or collection initializer, if any.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IPlaceholderOperation">
<summary>
Represents a general placeholder when no more specific kind of placeholder is available.
A placeholder is an expression whose meaning is inferred from context.
</summary>
<remarks>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IPointerIndirectionReferenceOperation">
<summary>
Represents a reference through a pointer.
<para>
Current usage:
(1) C# pointer indirection reference expression.
</para>
</summary>
<remarks>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IPointerIndirectionReferenceOperation.Pointer">
<summary>
Pointer to be dereferenced.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IWithStatementOperation">
<summary>
Represents a <see cref="P:Microsoft.CodeAnalysis.Operations.IWithStatementOperation.Body" /> of operations that are executed with implicit reference to the <see cref="P:Microsoft.CodeAnalysis.Operations.IWithStatementOperation.Value" /> for member references.
<para>
Current usage:
(1) VB With statement.
</para>
</summary>
<remarks>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IWithStatementOperation.Body">
<summary>
Body of the with.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IWithStatementOperation.Value">
<summary>
Value to whose members leading-dot-qualified references within the with body bind.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IUsingDeclarationOperation">
<summary>
Represents using variable declaration, with scope spanning across the parent <see cref="T:Microsoft.CodeAnalysis.Operations.IBlockOperation" />.
<para>
Current Usage:
(1) C# using declaration
(1) C# asynchronous using declaration
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.UsingDeclaration"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IUsingDeclarationOperation.DeclarationGroup">
<summary>
The variables declared by this using declaration.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IUsingDeclarationOperation.IsAsynchronous">
<summary>
True if this is an asynchronous using declaration.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.INegatedPatternOperation">
<summary>
Represents a negated pattern.
<para>
Current usage:
(1) C# negated pattern.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.NegatedPattern"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.INegatedPatternOperation.Pattern">
<summary>
The negated pattern.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IBinaryPatternOperation">
<summary>
Represents a binary ("and" or "or") pattern.
<para>
Current usage:
(1) C# "and" and "or" patterns.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.BinaryPattern"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IBinaryPatternOperation.OperatorKind">
<summary>
Kind of binary pattern; either <see cref="F:Microsoft.CodeAnalysis.Operations.BinaryOperatorKind.And" /> or <see cref="F:Microsoft.CodeAnalysis.Operations.BinaryOperatorKind.Or" />.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IBinaryPatternOperation.LeftPattern">
<summary>
The pattern on the left.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IBinaryPatternOperation.RightPattern">
<summary>
The pattern on the right.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.ITypePatternOperation">
<summary>
Represents a pattern comparing the input with a given type.
<para>
Current usage:
(1) C# type pattern.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.TypePattern"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.ITypePatternOperation.MatchedType">
<summary>
The type explicitly specified, or null if it was inferred (e.g. using <code>var</code> in C#).
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IRelationalPatternOperation">
<summary>
Represents a pattern comparing the input with a constant value using a relational operator.
<para>
Current usage:
(1) C# relational pattern.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.RelationalPattern"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IRelationalPatternOperation.OperatorKind">
<summary>
The kind of the relational operator.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IRelationalPatternOperation.Value">
<summary>
Constant value of the pattern operation.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.IWithOperation">
<summary>
Represents cloning of an object instance.
<para>
Current usage:
(1) C# with expression.
</para>
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.With"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IWithOperation.Operand">
<summary>
Operand to be cloned.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IWithOperation.CloneMethod">
<summary>
Clone method to be invoked on the value. This can be null in error scenarios.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.IWithOperation.Initializer">
<summary>
With collection initializer.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Operations.BlockOperation.CreateTemporaryBlock(System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.IOperation},Microsoft.CodeAnalysis.SemanticModel,Microsoft.CodeAnalysis.SyntaxNode)">
<summary>
This creates a block that can be used for temporary, internal applications that require a block composed of
statements from another block. Blocks created by this API violate IOperation tree constraints and should
never be exposed from a public API.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Operations.OperationCloner.CloneOperation``1(``0)">
<summary>Deep clone given IOperation</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.OperationVisitor">
<summary>
Represents a <see cref="T:Microsoft.CodeAnalysis.IOperation"/> visitor that visits only the single IOperation
passed into its Visit method.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.OperationVisitor`2">
<summary>
Represents a <see cref="T:Microsoft.CodeAnalysis.IOperation"/> visitor that visits only the single IOperation
passed into its Visit method with an additional argument of the type specified by the
<typeparamref name="TArgument"/> parameter and produces a value of the type specified by
the <typeparamref name="TResult"/> parameter.
</summary>
<typeparam name="TArgument">
The type of the additional argument passed to this visitor's Visit method.
</typeparam>
<typeparam name="TResult">
The type of the return value of this visitor's Visit method.
</typeparam>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.ArgumentKind">
<summary>
Kinds of arguments.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.ArgumentKind.None">
<summary>
Represents unknown argument kind.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.ArgumentKind.Explicit">
<summary>
Argument value is explicitly supplied.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.ArgumentKind.ParamArray">
<summary>
Argument is a param array created by compilers for the matching C# params or VB ParamArray parameter.
Note, the value is a an array creation expression that encapsulates all the elements, if any.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.ArgumentKind.DefaultValue">
<summary>
Argument is a default value supplied automatically by the compilers.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.BinaryOperatorKind">
<summary>
Kind of binary operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.BinaryOperatorKind.None">
<summary>
Represents unknown or error operator kind.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.BinaryOperatorKind.Add">
<summary>
Represents the '+' operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.BinaryOperatorKind.Subtract">
<summary>
Represents the '-' operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.BinaryOperatorKind.Multiply">
<summary>
Represents the '*' operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.BinaryOperatorKind.Divide">
<summary>
Represents the '/' operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.BinaryOperatorKind.IntegerDivide">
<summary>
Represents the VB '\' integer divide operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.BinaryOperatorKind.Remainder">
<summary>
Represents the C# '%' operator and VB 'Mod' operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.BinaryOperatorKind.Power">
<summary>
Represents the VB '^' exponentiation operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.BinaryOperatorKind.LeftShift">
<summary>
Represents the <![CDATA['<<']]> operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.BinaryOperatorKind.RightShift">
<summary>
Represents the <![CDATA['>>']]> operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.BinaryOperatorKind.And">
<summary>
Represents the C# <![CDATA['&']]> operator and VB 'And' operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.BinaryOperatorKind.Or">
<summary>
Represents the C# <![CDATA['|']]> operator and VB 'Or' operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.BinaryOperatorKind.ExclusiveOr">
<summary>
Represents the C# '^' operator and VB 'Xor' operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.BinaryOperatorKind.ConditionalAnd">
<summary>
Represents the C# <![CDATA['&&']]> operator and VB 'AndAlso' operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.BinaryOperatorKind.ConditionalOr">
<summary>
Represents the C# <![CDATA['||']]> operator and VB 'OrElse' operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.BinaryOperatorKind.Concatenate">
<summary>
Represents the VB <![CDATA['&']]> operator for string concatenation.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.BinaryOperatorKind.Equals">
<summary>
Represents the C# '==' operator and VB 'Is' operator and '=' operator for non-object typed operands.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.BinaryOperatorKind.ObjectValueEquals">
<summary>
Represents the VB '=' operator for object typed operands.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.BinaryOperatorKind.NotEquals">
<summary>
Represents the C# '!=' operator and VB 'IsNot' operator and <![CDATA['<>']]> operator for non-object typed operands.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.BinaryOperatorKind.ObjectValueNotEquals">
<summary>
Represents the VB <![CDATA['<>']]> operator for object typed operands.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.BinaryOperatorKind.LessThan">
<summary>
Represents the <![CDATA['<']]> operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.BinaryOperatorKind.LessThanOrEqual">
<summary>
Represents the <![CDATA['<=']]> operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.BinaryOperatorKind.GreaterThanOrEqual">
<summary>
Represents the <![CDATA['>=']]> operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.BinaryOperatorKind.GreaterThan">
<summary>
Represents the <![CDATA['>']]> operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.BinaryOperatorKind.Like">
<summary>
Represents the VB 'Like' operator.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.BranchKind">
<summary>
Kind of the branch for an <see cref="T:Microsoft.CodeAnalysis.Operations.IBranchOperation"/>
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.BranchKind.None">
<summary>
Represents unknown branch kind.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.BranchKind.Continue">
<summary>
Represents a continue branch kind.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.BranchKind.Break">
<summary>
Represents a break branch kind.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.BranchKind.GoTo">
<summary>
Represents a goto branch kind.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.CaseKind">
<summary>
Kinds of cases.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.CaseKind.None">
<summary>
Represents unknown case kind.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.CaseKind.SingleValue">
<summary>
Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.ISingleValueCaseClauseOperation"/> in C# or VB.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.CaseKind.Relational">
<summary>
Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IRelationalCaseClauseOperation"/> in VB.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.CaseKind.Range">
<summary>
Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IRangeCaseClauseOperation"/> in VB.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.CaseKind.Default">
<summary>
Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IDefaultCaseClauseOperation"/> in C# or VB.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.CaseKind.Pattern">
<summary>
Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IPatternCaseClauseOperation" /> in C#.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.CommonConversion">
<summary>
Represents the common, language-agnostic elements of a conversion.
</summary>
<remarks>
We reserve the right to change this struct in the future.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.CommonConversion.Exists">
<summary>
Returns true if the conversion exists, as defined by the target language.
</summary>
<remarks>
The existence of a conversion does not necessarily imply that the conversion is valid.
For example, an ambiguous user-defined conversion may exist but may not be valid.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.CommonConversion.IsIdentity">
<summary>
Returns true if the conversion is an identity conversion.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.CommonConversion.IsNullable">
<summary>
Returns true if the conversion is an nullable conversion.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.CommonConversion.IsNumeric">
<summary>
Returns true if the conversion is a numeric conversion.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.CommonConversion.IsReference">
<summary>
Returns true if the conversion is a reference conversion.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.CommonConversion.IsImplicit">
<summary>
Returns true if the conversion is an implicit (C#) or widening (VB) conversion.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.CommonConversion.IsUserDefined">
<summary>
Returns true if the conversion is a user-defined conversion.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operations.CommonConversion.MethodSymbol">
<summary>
Returns the method used to perform the conversion for a user-defined conversion if <see cref="P:Microsoft.CodeAnalysis.Operations.CommonConversion.IsUserDefined"/> is true.
Otherwise, returns null.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.InstanceReferenceKind">
<summary>
Kind of reference for an <see cref="T:Microsoft.CodeAnalysis.Operations.IInstanceReferenceOperation"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.InstanceReferenceKind.ContainingTypeInstance">
<summary>
Reference to an instance of the containing type. Used for <code>this</code> and <code>base</code> in C# code, and <code>Me</code>,
<code>MyClass</code>, <code>MyBase</code> in VB code.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.InstanceReferenceKind.ImplicitReceiver">
<summary>
Reference to the object being initialized in C# or VB object or collection initializer,
anonymous type creation initializer, or to the object being referred to in a VB With statement,
or the C# 'with' expression initializer.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.InstanceReferenceKind.PatternInput">
<summary>
Reference to the value being matching in a property subpattern.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.ForEachLoopOperationInfo.ElementType">
<summary>
Element type of the collection
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.ForEachLoopOperationInfo.CurrentConversion">
<summary>
The conversion from the type of the <see cref="F:Microsoft.CodeAnalysis.Operations.ForEachLoopOperationInfo.CurrentProperty"/> to the <see cref="F:Microsoft.CodeAnalysis.Operations.ForEachLoopOperationInfo.ElementType"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.ForEachLoopOperationInfo.ElementConversion">
<summary>
The conversion from the <see cref="F:Microsoft.CodeAnalysis.Operations.ForEachLoopOperationInfo.ElementType"/> to the iteration variable type.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.LoopKind">
<summary>
Kinds of loop operations.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.LoopKind.None">
<summary>
Represents unknown loop kind.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.LoopKind.While">
<summary>
Represents an <see cref="T:Microsoft.CodeAnalysis.Operations.IWhileLoopOperation"/> in C# or VB.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.LoopKind.For">
<summary>
Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IForLoopOperation"/> in C#.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.LoopKind.ForTo">
<summary>
Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IForToLoopOperation"/> in VB.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.LoopKind.ForEach">
<summary>
Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IForEachLoopOperation"/> in C# or VB.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Operations.OperationExtensions.HasErrors(Microsoft.CodeAnalysis.IOperation,Microsoft.CodeAnalysis.Compilation,System.Threading.CancellationToken)">
<summary>
This will check whether context around the operation has any error such as syntax or semantic error
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Operations.OperationExtensions.Descendants(Microsoft.CodeAnalysis.IOperation)">
<summary>
Returns all the descendant operations of the given <paramref name="operation"/> in evaluation order.
</summary>
<param name="operation">Operation whose descendants are to be fetched.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Operations.OperationExtensions.DescendantsAndSelf(Microsoft.CodeAnalysis.IOperation)">
<summary>
Returns all the descendant operations of the given <paramref name="operation"/> including the given <paramref name="operation"/> in evaluation order.
</summary>
<param name="operation">Operation whose descendants are to be fetched.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Operations.OperationExtensions.GetDeclaredVariables(Microsoft.CodeAnalysis.Operations.IVariableDeclarationGroupOperation)">
<summary>
Gets all the declared local variables in the given <paramref name="declarationGroup"/>.
</summary>
<param name="declarationGroup">Variable declaration group</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Operations.OperationExtensions.GetDeclaredVariables(Microsoft.CodeAnalysis.Operations.IVariableDeclarationOperation)">
<summary>
Gets all the declared local variables in the given <paramref name="declaration"/>.
</summary>
<param name="declaration">Variable declaration</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Operations.OperationExtensions.GetVariableInitializer(Microsoft.CodeAnalysis.Operations.IVariableDeclaratorOperation)">
<summary>
Gets the variable initializer for the given <paramref name="declarationOperation"/>, checking to see if there is a parent initializer
if the single variable initializer is null.
</summary>
<param name="declarationOperation">Single variable declaration to retrieve initializer for.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Operations.OperationExtensions.GetArgumentName(Microsoft.CodeAnalysis.Operations.IDynamicInvocationOperation,System.Int32)">
<summary>
Get an optional argument name for a named argument to the given <paramref name="dynamicOperation"/> at the given <paramref name="index"/>.
</summary>
<param name="dynamicOperation">Dynamic or late bound operation.</param>
<param name="index">Argument index.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Operations.OperationExtensions.GetArgumentName(Microsoft.CodeAnalysis.Operations.IDynamicIndexerAccessOperation,System.Int32)">
<summary>
Get an optional argument name for a named argument to the given <paramref name="dynamicOperation"/> at the given <paramref name="index"/>.
</summary>
<param name="dynamicOperation">Dynamic or late bound operation.</param>
<param name="index">Argument index.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Operations.OperationExtensions.GetArgumentName(Microsoft.CodeAnalysis.Operations.IDynamicObjectCreationOperation,System.Int32)">
<summary>
Get an optional argument name for a named argument to the given <paramref name="dynamicOperation"/> at the given <paramref name="index"/>.
</summary>
<param name="dynamicOperation">Dynamic or late bound operation.</param>
<param name="index">Argument index.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Operations.OperationExtensions.GetArgumentName(Microsoft.CodeAnalysis.Operations.HasDynamicArgumentsExpression,System.Int32)">
<summary>
Get an optional argument name for a named argument to the given <paramref name="dynamicOperation"/> at the given <paramref name="index"/>.
</summary>
<param name="dynamicOperation">Dynamic or late bound operation.</param>
<param name="index">Argument index.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Operations.OperationExtensions.GetArgumentRefKind(Microsoft.CodeAnalysis.Operations.IDynamicInvocationOperation,System.Int32)">
<summary>
Get an optional argument <see cref="T:Microsoft.CodeAnalysis.RefKind"/> for an argument at the given <paramref name="index"/> to the given <paramref name="dynamicOperation"/>.
Returns a non-null argument <see cref="T:Microsoft.CodeAnalysis.RefKind"/> for C#.
Always returns null for VB as <see cref="T:Microsoft.CodeAnalysis.RefKind"/> cannot be specified for an argument in VB.
</summary>
<param name="dynamicOperation">Dynamic or late bound operation.</param>
<param name="index">Argument index.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Operations.OperationExtensions.GetArgumentRefKind(Microsoft.CodeAnalysis.Operations.IDynamicIndexerAccessOperation,System.Int32)">
<summary>
Get an optional argument <see cref="T:Microsoft.CodeAnalysis.RefKind"/> for an argument at the given <paramref name="index"/> to the given <paramref name="dynamicOperation"/>.
Returns a non-null argument <see cref="T:Microsoft.CodeAnalysis.RefKind"/> for C#.
Always returns null for VB as <see cref="T:Microsoft.CodeAnalysis.RefKind"/> cannot be specified for an argument in VB.
</summary>
<param name="dynamicOperation">Dynamic or late bound operation.</param>
<param name="index">Argument index.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Operations.OperationExtensions.GetArgumentRefKind(Microsoft.CodeAnalysis.Operations.IDynamicObjectCreationOperation,System.Int32)">
<summary>
Get an optional argument <see cref="T:Microsoft.CodeAnalysis.RefKind"/> for an argument at the given <paramref name="index"/> to the given <paramref name="dynamicOperation"/>.
Returns a non-null argument <see cref="T:Microsoft.CodeAnalysis.RefKind"/> for C#.
Always returns null for VB as <see cref="T:Microsoft.CodeAnalysis.RefKind"/> cannot be specified for an argument in VB.
</summary>
<param name="dynamicOperation">Dynamic or late bound operation.</param>
<param name="index">Argument index.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Operations.OperationExtensions.GetRootOperation(Microsoft.CodeAnalysis.IOperation)">
<summary>
Gets the root operation for the <see cref="T:Microsoft.CodeAnalysis.IOperation"/> tree containing the given <paramref name="operation"/>.
</summary>
<param name="operation">Operation whose root is requested.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Operations.OperationExtensions.GetCorrespondingOperation(Microsoft.CodeAnalysis.Operations.IBranchOperation)">
<summary>
Gets either a loop or a switch operation that corresponds to the given branch operation.
</summary>
<param name="operation">The branch operation for which a corresponding operation is looked up</param>
<returns>The corresponding operation or <c>null</c> in case not found (e.g. no loop or switch syntax, or the branch is not a break or continue)</returns>
<exception cref="T:System.ArgumentNullException"><paramref name="operation"/> is null</exception>
<exception cref="T:System.InvalidOperationException">The operation is a part of Control Flow Graph</exception>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.NoneOperation">
<summary>
Use this to create IOperation when we don't have proper specific IOperation yet for given language construct
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.OperationWalker">
<summary>
Represents a <see cref="T:Microsoft.CodeAnalysis.Operations.OperationVisitor"/> that descends an entire <see cref="T:Microsoft.CodeAnalysis.IOperation"/> tree
visiting each IOperation and its child IOperation nodes in depth-first order.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.OperationWalker`1">
<summary>
Represents a <see cref="T:Microsoft.CodeAnalysis.Operations.OperationVisitor`2"/> that descends an entire <see cref="T:Microsoft.CodeAnalysis.IOperation"/> tree
visiting each IOperation and its child IOperation nodes in depth-first order. Returns null.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operations.UnaryOperatorKind">
<summary>
Kind of unary operator
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.UnaryOperatorKind.None">
<summary>
Represents unknown or error operator kind.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.UnaryOperatorKind.BitwiseNegation">
<summary>
Represents the C# '~' operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.UnaryOperatorKind.Not">
<summary>
Represents the C# '!' operator and VB 'Not' operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.UnaryOperatorKind.Plus">
<summary>
Represents the unary '+' operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.UnaryOperatorKind.Minus">
<summary>
Represents the unary '-' operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.UnaryOperatorKind.True">
<summary>
Represents the C# 'true' operator and VB 'IsTrue' operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.UnaryOperatorKind.False">
<summary>
Represents the C# 'false' operator and VB 'IsFalse' operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Operations.UnaryOperatorKind.Hat">
<summary>
Represents the C# '^' operator.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.ModelExtensions.GetSymbolInfo(Microsoft.CodeAnalysis.SemanticModel,Microsoft.CodeAnalysis.SyntaxNode,System.Threading.CancellationToken)">
<summary>
Gets symbol information about a syntax node.
</summary>
<param name="semanticModel"></param>
<param name="node">The syntax node to get semantic information for.</param>
<param name="cancellationToken">A cancellation token that can be used to cancel the
process of obtaining the semantic info.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.ModelExtensions.GetSpeculativeSymbolInfo(Microsoft.CodeAnalysis.SemanticModel,System.Int32,Microsoft.CodeAnalysis.SyntaxNode,Microsoft.CodeAnalysis.SpeculativeBindingOption)">
<summary>
Binds the node in the context of the specified location and get semantic information
such as type, symbols and diagnostics. This method is used to get semantic information
about an expression that did not actually appear in the source code.
</summary>
<param name="semanticModel"></param>
<param name="position">A character position used to identify a declaration scope and
accessibility. This character position must be within the FullSpan of the Root syntax
node in this SemanticModel.
</param>
<param name="expression">A syntax node that represents a parsed expression. This syntax
node need not and typically does not appear in the source code referred to SemanticModel
instance.</param>
<param name="bindingOption">Indicates whether to binding the expression as a full expressions,
or as a type or namespace. If SpeculativeBindingOption.BindAsTypeOrNamespace is supplied, then
expression should derive from TypeSyntax.</param>
<returns>The semantic information for the topmost node of the expression.</returns>
<remarks>The passed in expression is interpreted as a stand-alone expression, as if it
appeared by itself somewhere within the scope that encloses "position".</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.ModelExtensions.GetTypeInfo(Microsoft.CodeAnalysis.SemanticModel,Microsoft.CodeAnalysis.SyntaxNode,System.Threading.CancellationToken)">
<summary>
Gets type information about a syntax node.
</summary>
<param name="semanticModel"></param>
<param name="node">The syntax node to get semantic information for.</param>
<param name="cancellationToken">A cancellation token that can be used to cancel the
process of obtaining the semantic info.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.ModelExtensions.GetAliasInfo(Microsoft.CodeAnalysis.SemanticModel,Microsoft.CodeAnalysis.SyntaxNode,System.Threading.CancellationToken)">
<summary>
If "nameSyntax" resolves to an alias name, return the IAliasSymbol corresponding
to A. Otherwise return null.
</summary>
<param name="semanticModel"></param>
<param name="nameSyntax">Name to get alias info for.</param>
<param name="cancellationToken">A cancellation token that can be used to cancel the
process of obtaining the alias information.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.ModelExtensions.GetSpeculativeAliasInfo(Microsoft.CodeAnalysis.SemanticModel,System.Int32,Microsoft.CodeAnalysis.SyntaxNode,Microsoft.CodeAnalysis.SpeculativeBindingOption)">
<summary>
Binds the name in the context of the specified location and sees if it resolves to an
alias name. If it does, return the AliasSymbol corresponding to it. Otherwise, return null.
</summary>
<param name="semanticModel"></param>
<param name="position">A character position used to identify a declaration scope and
accessibility. This character position must be within the FullSpan of the Root syntax
node in this SemanticModel.
</param>
<param name="nameSyntax">A syntax node that represents a name. This syntax
node need not and typically does not appear in the source code referred to by the
SemanticModel instance.</param>
<param name="bindingOption">Indicates whether to binding the name as a full expression,
or as a type or namespace. If SpeculativeBindingOption.BindAsTypeOrNamespace is supplied, then
expression should derive from TypeSyntax.</param>
<remarks>The passed in name is interpreted as a stand-alone name, as if it
appeared by itself somewhere within the scope that encloses "position".</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.ModelExtensions.GetSpeculativeTypeInfo(Microsoft.CodeAnalysis.SemanticModel,System.Int32,Microsoft.CodeAnalysis.SyntaxNode,Microsoft.CodeAnalysis.SpeculativeBindingOption)">
<summary>
Binds the node in the context of the specified location and get semantic information
such as type, symbols and diagnostics. This method is used to get semantic information
about an expression that did not actually appear in the source code.
</summary>
<param name="semanticModel"></param>
<param name="position">A character position used to identify a declaration scope and
accessibility. This character position must be within the FullSpan of the Root syntax
node in this SemanticModel.
</param>
<param name="expression">A syntax node that represents a parsed expression. This syntax
node need not and typically does not appear in the source code referred to SemanticModel
instance.</param>
<param name="bindingOption">Indicates whether to binding the expression as a full expressions,
or as a type or namespace. If SpeculativeBindingOption.BindAsTypeOrNamespace is supplied, then
expression should derive from TypeSyntax.</param>
<returns>The semantic information for the topmost node of the expression.</returns>
<remarks>The passed in expression is interpreted as a stand-alone expression, as if it
appeared by itself somewhere within the scope that encloses "position".</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.ModelExtensions.GetDeclaredSymbol(Microsoft.CodeAnalysis.SemanticModel,Microsoft.CodeAnalysis.SyntaxNode,System.Threading.CancellationToken)">
<summary>
Gets the symbol associated with a declaration syntax node.
</summary>
<param name="semanticModel"></param>
<param name="declaration">A syntax node that is a declaration. This can be any type
derived from MemberDeclarationSyntax, TypeDeclarationSyntax, EnumDeclarationSyntax,
NamespaceDeclarationSyntax, ParameterSyntax, TypeParameterSyntax, or the alias part of a
UsingDirectiveSyntax</param>
<param name="cancellationToken">The cancellation token.</param>
<returns>The symbol declared by the node or null if the node is not a declaration.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.ModelExtensions.GetMemberGroup(Microsoft.CodeAnalysis.SemanticModel,Microsoft.CodeAnalysis.SyntaxNode,System.Threading.CancellationToken)">
<summary>
Gets a list of method or indexed property symbols for a syntax node.
</summary>
<param name="semanticModel"></param>
<param name="node">The syntax node to get semantic information for.</param>
<param name="cancellationToken">The cancellation token.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.ModelExtensions.AnalyzeControlFlow(Microsoft.CodeAnalysis.SemanticModel,Microsoft.CodeAnalysis.SyntaxNode,Microsoft.CodeAnalysis.SyntaxNode)">
<summary>
Analyze control-flow within a part of a method body.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.ModelExtensions.AnalyzeControlFlow(Microsoft.CodeAnalysis.SemanticModel,Microsoft.CodeAnalysis.SyntaxNode)">
<summary>
Analyze control-flow within a part of a method body.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.ModelExtensions.AnalyzeDataFlow(Microsoft.CodeAnalysis.SemanticModel,Microsoft.CodeAnalysis.SyntaxNode,Microsoft.CodeAnalysis.SyntaxNode)">
<summary>
Analyze data-flow within a part of a method body.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.ModelExtensions.AnalyzeDataFlow(Microsoft.CodeAnalysis.SemanticModel,Microsoft.CodeAnalysis.SyntaxNode)">
<summary>
Analyze data-flow within a part of a method body.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.GeneratedKind.Unknown">
<summary>
It is unknown if the <see cref="T:Microsoft.CodeAnalysis.SyntaxTree"/> is automatically generated.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.GeneratedKind.NotGenerated">
<summary>
The <see cref="T:Microsoft.CodeAnalysis.SyntaxTree"/> is not automatically generated.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.GeneratedKind.MarkedGenerated">
<summary>
The <see cref="T:Microsoft.CodeAnalysis.SyntaxTree"/> is marked as automatically generated.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.NullableContext">
<summary>
Represents the state of the nullable analysis at a specific point in a file. Bits one and
two correspond to whether the nullable feature is enabled. Bits three and four correspond
to whether the context was inherited from the global context.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.NullableContext.Disabled">
<summary>
Nullable warnings and annotations are explicitly turned off at this location.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.NullableContext.WarningsEnabled">
<summary>
Nullable warnings are enabled and will be reported at this file location.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.NullableContext.AnnotationsEnabled">
<summary>
Nullable annotations are enabled and will be shown when APIs defined at
this location are used in other contexts.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.NullableContext.Enabled">
<summary>
The nullable feature is fully enabled.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.NullableContext.WarningsContextInherited">
<summary>
The nullable warning state is inherited from the project default.
</summary>
<remarks>
The project default can change depending on the file type. Generated
files have nullable off by default, regardless of the project-level
default setting.
</remarks>
</member>
<member name="F:Microsoft.CodeAnalysis.NullableContext.AnnotationsContextInherited">
<summary>
The nullable annotation state is inherited from the project default.
</summary>
<remarks>
The project default can change depending on the file type. Generated
files have nullable off by default, regardless of the project-level
default setting.
</remarks>
</member>
<member name="F:Microsoft.CodeAnalysis.NullableContext.ContextInherited">
<summary>
The current state of both warnings and annotations are inherited from
the project default.
</summary>
<remarks>
This flag is set by default at the start of all files.
The project default can change depending on the file type. Generated
files have nullable off by default, regardless of the project-level
default setting.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.NullableContextExtensions.WarningsEnabled(Microsoft.CodeAnalysis.NullableContext)">
<summary>
Returns whether nullable warnings are enabled for this context.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.NullableContextExtensions.AnnotationsEnabled(Microsoft.CodeAnalysis.NullableContext)">
<summary>
Returns whether nullable annotations are enabled for this context.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.NullableContextExtensions.WarningsInherited(Microsoft.CodeAnalysis.NullableContext)">
<summary>
Returns whether the nullable warning state was inherited from the project default for this file type.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.NullableContextExtensions.AnnotationsInherited(Microsoft.CodeAnalysis.NullableContext)">
<summary>
Returns whether the nullable annotation state was inherited from the project default for this file type.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.NullableContextOptions">
<summary>
Represents the default state of nullable analysis in this compilation.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.NullableContextOptions.Disable">
<summary>
The nullable analysis feature is disabled.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.NullableContextOptions.Warnings">
<summary>
Nullable warnings are enabled and will be reported by default.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.NullableContextOptions.Annotations">
<summary>
Nullable annotations are enabled and will be shown when APIs
defined in this project are used in other contexts.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.NullableContextOptions.Enable">
<summary>
The nullable analysis feature is fully enabled.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.NullableContextOptionsExtensions.WarningsEnabled(Microsoft.CodeAnalysis.NullableContextOptions)">
<summary>
Returns whether nullable warnings are enabled.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.NullableContextOptionsExtensions.AnnotationsEnabled(Microsoft.CodeAnalysis.NullableContextOptions)">
<summary>
Returns whether nullable annotations are enabled.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.OptimizationLevel">
<summary>
Determines the level of optimization of the generated code.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OptimizationLevel.Debug">
<summary>
Disables all optimizations and instruments the generated code to improve debugging experience.
</summary>
<remarks>
The compiler prefers debuggability over performance. Do not use for code running in a production environment.
<list type="bullet">
<item><description>JIT optimizations are disabled via assembly level attribute (<see cref="T:System.Diagnostics.DebuggableAttribute"/>).</description></item>
<item><description>Edit and Continue is enabled.</description></item>
<item><description>Slots for local variables are not reused, lifetime of local variables is extended to make the values available during debugging.</description></item>
</list>
<para>
Corresponds to command line argument /optimize-.
</para>
</remarks>
</member>
<member name="F:Microsoft.CodeAnalysis.OptimizationLevel.Release">
<summary>
Enables all optimizations, debugging experience might be degraded.
</summary>
<remarks>
The compiler prefers performance over debuggability. Use for code running in a production environment.
<list type="bullet">
<item><description>JIT optimizations are enabled via assembly level attribute (<see cref="T:System.Diagnostics.DebuggableAttribute"/>).</description></item>
<item><description>Edit and Continue is disabled.</description></item>
<item><description>Sequence points may be optimized away. As a result it might not be possible to place or hit a breakpoint.</description></item>
<item><description>User-defined locals might be optimized away. They might not be available while debugging.</description></item>
</list>
<para>
Corresponds to command line argument /optimize+.
</para>
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.ParseOptions">
<summary>
Represents parse options common to C# and VB.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ParseOptions.Kind">
<summary>
Specifies whether to parse as regular code files, script files or interactive code.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ParseOptions.SpecifiedKind">
<summary>
Gets the specified source code kind, which is the value that was specified in
the call to the constructor, or modified using the <see cref="M:Microsoft.CodeAnalysis.ParseOptions.WithKind(Microsoft.CodeAnalysis.SourceCodeKind)"/> method.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ParseOptions.DocumentationMode">
<summary>
Gets a value indicating whether the documentation comments are parsed.
</summary>
<value><c>true</c> if documentation comments are parsed, <c>false</c> otherwise.</value>
</member>
<member name="P:Microsoft.CodeAnalysis.ParseOptions.Language">
<summary>
Gets the source language ("C#" or "Visual Basic").
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ParseOptions.Errors">
<summary>
Errors collection related to an incompatible set of parse options
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.ParseOptions.WithKind(Microsoft.CodeAnalysis.SourceCodeKind)">
<summary>
Creates a new options instance with the specified source code kind.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.ParseOptions.ValidateOptions(Microsoft.CodeAnalysis.PooledObjects.ArrayBuilder{Microsoft.CodeAnalysis.Diagnostic})">
<summary>
Performs validation of options compatibilities and generates diagnostics if needed
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.ParseOptions.WithDocumentationMode(Microsoft.CodeAnalysis.DocumentationMode)">
<summary>
Creates a new options instance with the specified documentation mode.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.ParseOptions.WithFeatures(System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.String}})">
<summary>
Enable some experimental language features for testing.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ParseOptions.Features">
<summary>
Returns the experimental features.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ParseOptions.PreprocessorSymbolNames">
<summary>
Names of defined preprocessor symbols.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Platform.AnyCpu">
<summary>
AnyCPU (default) compiles the assembly to run on any platform.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Platform.X86">
<summary>
x86 compiles the assembly to be run by the 32-bit, x86-compatible common language runtime.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Platform.X64">
<summary>
x64 compiles the assembly to be run by the 64-bit common language runtime on a computer that supports the AMD64 or EM64T instruction set.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Platform.Itanium">
<summary>
Itanium compiles the assembly to be run by the 64-bit common language runtime on a computer with an Itanium processor.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Platform.AnyCpu32BitPreferred">
<summary>
Compiles your assembly to run on any platform. Your application runs in 32-bit mode on systems that support both 64-bit and 32-bit applications.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Platform.Arm">
<summary>
Compiles your assembly to run on a computer that has an Advanced RISC Machine (ARM) processor.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Platform.Arm64">
<summary>
Compiles your assembly to run on a computer that has an Advanced RISC Machine 64 bit (ARM64) processor.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.PreprocessingSymbolInfo.Symbol">
<summary>
The symbol that was referred to by the identifier, if any.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.PreprocessingSymbolInfo.IsDefined">
<summary>
Returns true if this preprocessing symbol is defined at the identifier position.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.SemanticModel">
<summary>
Allows asking semantic questions about a tree of syntax nodes in a Compilation. Typically,
an instance is obtained by a call to GetBinding on a Compilation or Compilation.
</summary>
<remarks>
<para>An instance of SemanticModel caches local symbols and semantic information. Thus, it
is much more efficient to use a single instance of SemanticModel when asking multiple
questions about a syntax tree, because information from the first question may be reused.
This also means that holding onto an instance of SemanticModel for a long time may keep a
significant amount of memory from being garbage collected.
</para>
<para>
When an answer is a named symbol that is reachable by traversing from the root of the symbol
table, (that is, from an AssemblySymbol of the Compilation), that symbol will be returned
(i.e. the returned value will be reference-equal to one reachable from the root of the
symbol table). Symbols representing entities without names (e.g. array-of-int) may or may
not exhibit reference equality. However, some named symbols (such as local variables) are
not reachable from the root. These symbols are visible as answers to semantic questions.
When the same SemanticModel object is used, the answers exhibit reference-equality.
</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.SemanticModel.Language">
<summary>
Gets the source language ("C#" or "Visual Basic").
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SemanticModel.Compilation">
<summary>
The compilation this model was obtained from.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SemanticModel.CompilationCore">
<summary>
The compilation this model was obtained from.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SemanticModel.SyntaxTree">
<summary>
The syntax tree this model was obtained from.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SemanticModel.SyntaxTreeCore">
<summary>
The syntax tree this model was obtained from.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModel.GetOperation(Microsoft.CodeAnalysis.SyntaxNode,System.Threading.CancellationToken)">
<summary>
Gets the operation corresponding to the expression or statement syntax node.
</summary>
<param name="node">The expression or statement syntax node.</param>
<param name="cancellationToken">An optional cancellation token.</param>
<returns></returns>
</member>
<member name="P:Microsoft.CodeAnalysis.SemanticModel.IgnoresAccessibility">
<summary>
Returns true if this is a SemanticModel that ignores accessibility rules when answering semantic questions.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModel.GetSymbolInfo(Microsoft.CodeAnalysis.SyntaxNode,System.Threading.CancellationToken)">
<summary>
Gets symbol information about a syntax node.
</summary>
<param name="node">The syntax node to get semantic information for.</param>
<param name="cancellationToken">A cancellation token that can be used to cancel the
process of obtaining the semantic info.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModel.GetSymbolInfoCore(Microsoft.CodeAnalysis.SyntaxNode,System.Threading.CancellationToken)">
<summary>
Gets symbol information about a syntax node.
</summary>
<param name="node">The syntax node to get semantic information for.</param>
<param name="cancellationToken">A cancellation token that can be used to cancel the
process of obtaining the semantic info.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModel.GetSpeculativeSymbolInfo(System.Int32,Microsoft.CodeAnalysis.SyntaxNode,Microsoft.CodeAnalysis.SpeculativeBindingOption)">
<summary>
Binds the node in the context of the specified location and get semantic information
such as type, symbols and diagnostics. This method is used to get semantic information
about an expression that did not actually appear in the source code.
</summary>
<param name="position">A character position used to identify a declaration scope and
accessibility. This character position must be within the FullSpan of the Root syntax
node in this SemanticModel.
</param>
<param name="expression">A syntax node that represents a parsed expression. This syntax
node need not and typically does not appear in the source code referred to SemanticModel
instance.</param>
<param name="bindingOption">Indicates whether to binding the expression as a full expressions,
or as a type or namespace. If SpeculativeBindingOption.BindAsTypeOrNamespace is supplied, then
expression should derive from TypeSyntax.</param>
<returns>The semantic information for the topmost node of the expression.</returns>
<remarks>The passed in expression is interpreted as a stand-alone expression, as if it
appeared by itself somewhere within the scope that encloses "position".</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModel.GetSpeculativeSymbolInfoCore(System.Int32,Microsoft.CodeAnalysis.SyntaxNode,Microsoft.CodeAnalysis.SpeculativeBindingOption)">
<summary>
Binds the node in the context of the specified location and get semantic information
such as type, symbols and diagnostics. This method is used to get semantic information
about an expression that did not actually appear in the source code.
</summary>
<param name="position">A character position used to identify a declaration scope and
accessibility. This character position must be within the FullSpan of the Root syntax
node in this SemanticModel.
</param>
<param name="expression">A syntax node that represents a parsed expression. This syntax
node need not and typically does not appear in the source code referred to SemanticModel
instance.</param>
<param name="bindingOption">Indicates whether to binding the expression as a full expressions,
or as a type or namespace. If SpeculativeBindingOption.BindAsTypeOrNamespace is supplied, then
expression should derive from TypeSyntax.</param>
<returns>The semantic information for the topmost node of the expression.</returns>
<remarks>The passed in expression is interpreted as a stand-alone expression, as if it
appeared by itself somewhere within the scope that encloses "position".</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModel.GetSpeculativeTypeInfo(System.Int32,Microsoft.CodeAnalysis.SyntaxNode,Microsoft.CodeAnalysis.SpeculativeBindingOption)">
<summary>
Binds the node in the context of the specified location and get semantic information
such as type, symbols and diagnostics. This method is used to get semantic information
about an expression that did not actually appear in the source code.
</summary>
<param name="position">A character position used to identify a declaration scope and
accessibility. This character position must be within the FullSpan of the Root syntax
node in this SemanticModel.
</param>
<param name="expression">A syntax node that represents a parsed expression. This syntax
node need not and typically does not appear in the source code referred to SemanticModel
instance.</param>
<param name="bindingOption">Indicates whether to binding the expression as a full expressions,
or as a type or namespace. If SpeculativeBindingOption.BindAsTypeOrNamespace is supplied, then
expression should derive from TypeSyntax.</param>
<returns>The semantic information for the topmost node of the expression.</returns>
<remarks>The passed in expression is interpreted as a stand-alone expression, as if it
appeared by itself somewhere within the scope that encloses "position".</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModel.GetSpeculativeTypeInfoCore(System.Int32,Microsoft.CodeAnalysis.SyntaxNode,Microsoft.CodeAnalysis.SpeculativeBindingOption)">
<summary>
Binds the node in the context of the specified location and get semantic information
such as type, symbols and diagnostics. This method is used to get semantic information
about an expression that did not actually appear in the source code.
</summary>
<param name="position">A character position used to identify a declaration scope and
accessibility. This character position must be within the FullSpan of the Root syntax
node in this SemanticModel.
</param>
<param name="expression">A syntax node that represents a parsed expression. This syntax
node need not and typically does not appear in the source code referred to SemanticModel
instance.</param>
<param name="bindingOption">Indicates whether to binding the expression as a full expressions,
or as a type or namespace. If SpeculativeBindingOption.BindAsTypeOrNamespace is supplied, then
expression should derive from TypeSyntax.</param>
<returns>The semantic information for the topmost node of the expression.</returns>
<remarks>The passed in expression is interpreted as a stand-alone expression, as if it
appeared by itself somewhere within the scope that encloses "position".</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModel.GetTypeInfo(Microsoft.CodeAnalysis.SyntaxNode,System.Threading.CancellationToken)">
<summary>
Gets type information about a syntax node.
</summary>
<param name="node">The syntax node to get semantic information for.</param>
<param name="cancellationToken">A cancellation token that can be used to cancel the
process of obtaining the semantic info.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModel.GetTypeInfoCore(Microsoft.CodeAnalysis.SyntaxNode,System.Threading.CancellationToken)">
<summary>
Gets type information about a syntax node.
</summary>
<param name="node">The syntax node to get semantic information for.</param>
<param name="cancellationToken">A cancellation token that can be used to cancel the
process of obtaining the semantic info.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModel.GetAliasInfo(Microsoft.CodeAnalysis.SyntaxNode,System.Threading.CancellationToken)">
<summary>
If "nameSyntax" resolves to an alias name, return the IAliasSymbol corresponding
to A. Otherwise return null.
</summary>
<param name="nameSyntax">Name to get alias info for.</param>
<param name="cancellationToken">A cancellation token that can be used to cancel the
process of obtaining the alias information.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModel.GetAliasInfoCore(Microsoft.CodeAnalysis.SyntaxNode,System.Threading.CancellationToken)">
<summary>
If "nameSyntax" resolves to an alias name, return the IAliasSymbol corresponding
to A. Otherwise return null.
</summary>
<param name="nameSyntax">Name to get alias info for.</param>
<param name="cancellationToken">A cancellation token that can be used to cancel the
process of obtaining the alias information.</param>
</member>
<member name="P:Microsoft.CodeAnalysis.SemanticModel.IsSpeculativeSemanticModel">
<summary>
Returns true if this is a speculative semantic model created with any of the TryGetSpeculativeSemanticModel methods.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SemanticModel.OriginalPositionForSpeculation">
<summary>
If this is a speculative semantic model, returns the original position at which the speculative model was created.
Otherwise, returns 0.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SemanticModel.ParentModel">
<summary>
If this is a speculative semantic model, then returns its parent semantic model.
Otherwise, returns null.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SemanticModel.ParentModelCore">
<summary>
If this is a speculative semantic model, then returns its parent semantic model.
Otherwise, returns null.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SemanticModel.ContainingModelOrSelf">
<summary>
If this is a non-speculative member semantic model, then returns the containing semantic model for the entire tree.
Otherwise, returns this instance of the semantic model.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModel.GetSpeculativeAliasInfo(System.Int32,Microsoft.CodeAnalysis.SyntaxNode,Microsoft.CodeAnalysis.SpeculativeBindingOption)">
<summary>
Binds the name in the context of the specified location and sees if it resolves to an
alias name. If it does, return the AliasSymbol corresponding to it. Otherwise, return null.
</summary>
<param name="position">A character position used to identify a declaration scope and
accessibility. This character position must be within the FullSpan of the Root syntax
node in this SemanticModel.
</param>
<param name="nameSyntax">A syntax node that represents a name. This syntax
node need not and typically does not appear in the source code referred to by the
SemanticModel instance.</param>
<param name="bindingOption">Indicates whether to binding the name as a full expression,
or as a type or namespace. If SpeculativeBindingOption.BindAsTypeOrNamespace is supplied, then
expression should derive from TypeSyntax.</param>
<remarks>The passed in name is interpreted as a stand-alone name, as if it
appeared by itself somewhere within the scope that encloses "position".</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModel.GetSpeculativeAliasInfoCore(System.Int32,Microsoft.CodeAnalysis.SyntaxNode,Microsoft.CodeAnalysis.SpeculativeBindingOption)">
<summary>
Binds the name in the context of the specified location and sees if it resolves to an
alias name. If it does, return the AliasSymbol corresponding to it. Otherwise, return null.
</summary>
<param name="position">A character position used to identify a declaration scope and
accessibility. This character position must be within the FullSpan of the Root syntax
node in this SemanticModel.
</param>
<param name="nameSyntax">A syntax node that represents a name. This syntax
node need not and typically does not appear in the source code referred to by the
SemanticModel instance.</param>
<param name="bindingOption">Indicates whether to binding the name as a full expression,
or as a type or namespace. If SpeculativeBindingOption.BindAsTypeOrNamespace is supplied, then
expression should derive from TypeSyntax.</param>
<remarks>The passed in name is interpreted as a stand-alone name, as if it
appeared by itself somewhere within the scope that encloses "position".</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModel.GetSyntaxDiagnostics(System.Nullable{Microsoft.CodeAnalysis.Text.TextSpan},System.Threading.CancellationToken)">
<summary>
Get all of the syntax errors within the syntax tree associated with this
object. Does not get errors involving declarations or compiling method bodies or initializers.
</summary>
<param name="span">Optional span within the syntax tree for which to get diagnostics.
If no argument is specified, then diagnostics for the entire tree are returned.</param>
<param name="cancellationToken">A cancellation token that can be used to cancel the
process of obtaining the diagnostics.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModel.GetDeclarationDiagnostics(System.Nullable{Microsoft.CodeAnalysis.Text.TextSpan},System.Threading.CancellationToken)">
<summary>
Get all of the declaration errors within the syntax tree associated with this
object. Does not get errors involving incorrect syntax, compiling method bodies or initializers.
</summary>
<param name="span">Optional span within the syntax tree for which to get diagnostics.
If no argument is specified, then diagnostics for the entire tree are returned.</param>
<param name="cancellationToken">A cancellation token that can be used to cancel the
process of obtaining the diagnostics.</param>
<remarks>The declaration errors for a syntax tree are cached. The first time this method
is called, all declarations are analyzed for diagnostics. Calling this a second time
will return the cached diagnostics.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModel.GetMethodBodyDiagnostics(System.Nullable{Microsoft.CodeAnalysis.Text.TextSpan},System.Threading.CancellationToken)">
<summary>
Get all of the method body and initializer errors within the syntax tree associated with this
object. Does not get errors involving incorrect syntax or declarations.
</summary>
<param name="span">Optional span within the syntax tree for which to get diagnostics.
If no argument is specified, then diagnostics for the entire tree are returned.</param>
<param name="cancellationToken">A cancellation token that can be used to cancel the
process of obtaining the diagnostics.</param>
<remarks>The method body errors for a syntax tree are not cached. The first time this method
is called, all method bodies are analyzed for diagnostics. Calling this a second time
will repeat this work.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModel.GetDiagnostics(System.Nullable{Microsoft.CodeAnalysis.Text.TextSpan},System.Threading.CancellationToken)">
<summary>
Get all the errors within the syntax tree associated with this object. Includes errors
involving compiling method bodies or initializers, in addition to the errors returned by
GetDeclarationDiagnostics.
</summary>
<param name="span">Optional span within the syntax tree for which to get diagnostics.
If no argument is specified, then diagnostics for the entire tree are returned.</param>
<param name="cancellationToken">A cancellation token that can be used to cancel the
process of obtaining the diagnostics.</param>
<remarks>
Because this method must semantically bind all method bodies and initializers to check
for diagnostics, it may take a significant amount of time. Unlike
GetDeclarationDiagnostics, diagnostics for method bodies and initializers are not
cached, any semantic information used to obtain the diagnostics is discarded.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModel.GetDeclaredSymbolForNode(Microsoft.CodeAnalysis.SyntaxNode,System.Threading.CancellationToken)">
<summary>
Gets the symbol associated with a declaration syntax node.
</summary>
<param name="declaration">A syntax node that is a declaration. This can be any type
derived from MemberDeclarationSyntax, TypeDeclarationSyntax, EnumDeclarationSyntax,
NamespaceDeclarationSyntax, ParameterSyntax, TypeParameterSyntax, or the alias part of a
UsingDirectiveSyntax</param>
<param name="cancellationToken">The cancellation token.</param>
<returns>The symbol declared by the node or null if the node is not a declaration.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModel.GetDeclaredSymbolCore(Microsoft.CodeAnalysis.SyntaxNode,System.Threading.CancellationToken)">
<summary>
Gets the symbol associated with a declaration syntax node.
</summary>
<param name="declaration">A syntax node that is a declaration. This can be any type
derived from MemberDeclarationSyntax, TypeDeclarationSyntax, EnumDeclarationSyntax,
NamespaceDeclarationSyntax, ParameterSyntax, TypeParameterSyntax, or the alias part of a
UsingDirectiveSyntax</param>
<param name="cancellationToken">The cancellation token.</param>
<returns>The symbol declared by the node or null if the node is not a declaration.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModel.GetDeclaredSymbolsForNode(Microsoft.CodeAnalysis.SyntaxNode,System.Threading.CancellationToken)">
<summary>
Gets the symbol associated with a declaration syntax node. Unlike <see cref="M:Microsoft.CodeAnalysis.SemanticModel.GetDeclaredSymbolForNode(Microsoft.CodeAnalysis.SyntaxNode,System.Threading.CancellationToken)"/>,
this method returns all symbols declared by a given declaration syntax node. Specifically, in the case of field declaration syntax nodes,
which can declare multiple symbols, this method returns all declared symbols.
</summary>
<param name="declaration">A syntax node that is a declaration. This can be any type
derived from MemberDeclarationSyntax, TypeDeclarationSyntax, EnumDeclarationSyntax,
NamespaceDeclarationSyntax, ParameterSyntax, TypeParameterSyntax, or the alias part of a
UsingDirectiveSyntax</param>
<param name="cancellationToken">The cancellation token.</param>
<returns>The symbols declared by the node.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModel.GetDeclaredSymbolsCore(Microsoft.CodeAnalysis.SyntaxNode,System.Threading.CancellationToken)">
<summary>
Gets the symbol associated with a declaration syntax node. Unlike <see cref="M:Microsoft.CodeAnalysis.SemanticModel.GetDeclaredSymbolForNode(Microsoft.CodeAnalysis.SyntaxNode,System.Threading.CancellationToken)"/>,
this method returns all symbols declared by a given declaration syntax node. Specifically, in the case of field declaration syntax nodes,
which can declare multiple symbols, this method returns all declared symbols.
</summary>
<param name="declaration">A syntax node that is a declaration. This can be any type
derived from MemberDeclarationSyntax, TypeDeclarationSyntax, EnumDeclarationSyntax,
NamespaceDeclarationSyntax, ParameterSyntax, TypeParameterSyntax, or the alias part of a
UsingDirectiveSyntax</param>
<param name="cancellationToken">The cancellation token.</param>
<returns>The symbols declared by the node.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModel.LookupSymbols(System.Int32,Microsoft.CodeAnalysis.INamespaceOrTypeSymbol,System.String,System.Boolean)">
<summary>
Gets the available named symbols in the context of the specified location and optional container. Only
symbols that are accessible and visible from the given location are returned.
</summary>
<param name="position">The character position for determining the enclosing declaration scope and
accessibility.</param>
<param name="container">The container to search for symbols within. If null then the enclosing declaration
scope around position is used.</param>
<param name="name">The name of the symbol to find. If null is specified then symbols
with any names are returned.</param>
<param name="includeReducedExtensionMethods">Consider (reduced) extension methods.</param>
<returns>A list of symbols that were found. If no symbols were found, an empty list is returned.</returns>
<remarks>
The "position" is used to determine what variables are visible and accessible. Even if "container" is
specified, the "position" location is significant for determining which members of "containing" are
accessible.
Labels are not considered (see <see cref="M:Microsoft.CodeAnalysis.SemanticModel.LookupLabels(System.Int32,System.String)"/>).
Non-reduced extension methods are considered regardless of the value of <paramref name="includeReducedExtensionMethods"/>.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModel.LookupSymbolsCore(System.Int32,Microsoft.CodeAnalysis.INamespaceOrTypeSymbol,System.String,System.Boolean)">
<summary>
Backing implementation of <see cref="M:Microsoft.CodeAnalysis.SemanticModel.LookupSymbols(System.Int32,Microsoft.CodeAnalysis.INamespaceOrTypeSymbol,System.String,System.Boolean)"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModel.LookupBaseMembers(System.Int32,System.String)">
<summary>
Gets the available base type members in the context of the specified location. Akin to
calling <see cref="M:Microsoft.CodeAnalysis.SemanticModel.LookupSymbols(System.Int32,Microsoft.CodeAnalysis.INamespaceOrTypeSymbol,System.String,System.Boolean)"/> with the container set to the immediate base type of
the type in which <paramref name="position"/> occurs. However, the accessibility rules
are different: protected members of the base type will be visible.
Consider the following example:
public class Base
{
protected void M() { }
}
public class Derived : Base
{
void Test(Base b)
{
b.M(); // Error - cannot access protected member.
base.M();
}
}
Protected members of an instance of another type are only accessible if the instance is known
to be "this" instance (as indicated by the "base" keyword).
</summary>
<param name="position">The character position for determining the enclosing declaration scope and
accessibility.</param>
<param name="name">The name of the symbol to find. If null is specified then symbols
with any names are returned.</param>
<returns>A list of symbols that were found. If no symbols were found, an empty list is returned.</returns>
<remarks>
The "position" is used to determine what variables are visible and accessible.
Non-reduced extension methods are considered, but reduced extension methods are not.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModel.LookupBaseMembersCore(System.Int32,System.String)">
<summary>
Backing implementation of <see cref="M:Microsoft.CodeAnalysis.SemanticModel.LookupBaseMembers(System.Int32,System.String)"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModel.LookupStaticMembers(System.Int32,Microsoft.CodeAnalysis.INamespaceOrTypeSymbol,System.String)">
<summary>
Gets the available named static member symbols in the context of the specified location and optional container.
Only members that are accessible and visible from the given location are returned.
Non-reduced extension methods are considered, since they are static methods.
</summary>
<param name="position">The character position for determining the enclosing declaration scope and
accessibility.</param>
<param name="container">The container to search for symbols within. If null then the enclosing declaration
scope around position is used.</param>
<param name="name">The name of the symbol to find. If null is specified then symbols
with any names are returned.</param>
<returns>A list of symbols that were found. If no symbols were found, an empty list is returned.</returns>
<remarks>
The "position" is used to determine what variables are visible and accessible. Even if "container" is
specified, the "position" location is significant for determining which members of "containing" are
accessible.
Essentially the same as filtering instance members out of the results of an analogous <see cref="M:Microsoft.CodeAnalysis.SemanticModel.LookupSymbols(System.Int32,Microsoft.CodeAnalysis.INamespaceOrTypeSymbol,System.String,System.Boolean)"/> call.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModel.LookupStaticMembersCore(System.Int32,Microsoft.CodeAnalysis.INamespaceOrTypeSymbol,System.String)">
<summary>
Backing implementation of <see cref="M:Microsoft.CodeAnalysis.SemanticModel.LookupStaticMembers(System.Int32,Microsoft.CodeAnalysis.INamespaceOrTypeSymbol,System.String)"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModel.LookupNamespacesAndTypes(System.Int32,Microsoft.CodeAnalysis.INamespaceOrTypeSymbol,System.String)">
<summary>
Gets the available named namespace and type symbols in the context of the specified location and optional container.
Only members that are accessible and visible from the given location are returned.
</summary>
<param name="position">The character position for determining the enclosing declaration scope and
accessibility.</param>
<param name="container">The container to search for symbols within. If null then the enclosing declaration
scope around position is used.</param>
<param name="name">The name of the symbol to find. If null is specified then symbols
with any names are returned.</param>
<returns>A list of symbols that were found. If no symbols were found, an empty list is returned.</returns>
<remarks>
The "position" is used to determine what variables are visible and accessible. Even if "container" is
specified, the "position" location is significant for determining which members of "containing" are
accessible.
Does not return INamespaceOrTypeSymbol, because there could be aliases.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModel.LookupNamespacesAndTypesCore(System.Int32,Microsoft.CodeAnalysis.INamespaceOrTypeSymbol,System.String)">
<summary>
Backing implementation of <see cref="M:Microsoft.CodeAnalysis.SemanticModel.LookupNamespacesAndTypes(System.Int32,Microsoft.CodeAnalysis.INamespaceOrTypeSymbol,System.String)"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModel.LookupLabels(System.Int32,System.String)">
<summary>
Gets the available named label symbols in the context of the specified location and optional container.
Only members that are accessible and visible from the given location are returned.
</summary>
<param name="position">The character position for determining the enclosing declaration scope and
accessibility.</param>
<param name="name">The name of the symbol to find. If null is specified then symbols
with any names are returned.</param>
<returns>A list of symbols that were found. If no symbols were found, an empty list is returned.</returns>
<remarks>
The "position" is used to determine what variables are visible and accessible. Even if "container" is
specified, the "position" location is significant for determining which members of "containing" are
accessible.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModel.LookupLabelsCore(System.Int32,System.String)">
<summary>
Backing implementation of <see cref="M:Microsoft.CodeAnalysis.SemanticModel.LookupLabels(System.Int32,System.String)"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModel.AnalyzeControlFlow(Microsoft.CodeAnalysis.SyntaxNode,Microsoft.CodeAnalysis.SyntaxNode)">
<summary>
Analyze control-flow within a part of a method body.
</summary>
<param name="firstStatement">The first node to be included within the analysis.</param>
<param name="lastStatement">The last node to be included within the analysis.</param>
<returns>An object that can be used to obtain the result of the control flow analysis.</returns>
<exception cref="T:System.ArgumentException">The span is not with a method
body.</exception>
<remarks>
The first and last nodes must be fully inside the same method body.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModel.AnalyzeControlFlowCore(Microsoft.CodeAnalysis.SyntaxNode,Microsoft.CodeAnalysis.SyntaxNode)">
<summary>
Analyze control-flow within a part of a method body.
</summary>
<param name="firstStatement">The first node to be included within the analysis.</param>
<param name="lastStatement">The last node to be included within the analysis.</param>
<returns>An object that can be used to obtain the result of the control flow analysis.</returns>
<exception cref="T:System.ArgumentException">The span is not with a method
body.</exception>
<remarks>
The first and last nodes must be fully inside the same method body.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModel.AnalyzeControlFlow(Microsoft.CodeAnalysis.SyntaxNode)">
<summary>
Analyze control-flow within a part of a method body.
</summary>
<param name="statement">The statement to be analyzed.</param>
<returns>An object that can be used to obtain the result of the control flow analysis.</returns>
<exception cref="T:System.ArgumentException">The span is not with a method
body.</exception>
<remarks>
The statement must be fully inside the same method body.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModel.AnalyzeControlFlowCore(Microsoft.CodeAnalysis.SyntaxNode)">
<summary>
Analyze control-flow within a part of a method body.
</summary>
<param name="statement">The statement to be analyzed.</param>
<returns>An object that can be used to obtain the result of the control flow analysis.</returns>
<exception cref="T:System.ArgumentException">The span is not with a method
body.</exception>
<remarks>
The statement must be fully inside the same method body.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModel.AnalyzeDataFlow(Microsoft.CodeAnalysis.SyntaxNode,Microsoft.CodeAnalysis.SyntaxNode)">
<summary>
Analyze data-flow within a part of a method body.
</summary>
<param name="firstStatement">The first node to be included within the analysis.</param>
<param name="lastStatement">The last node to be included within the analysis.</param>
<returns>An object that can be used to obtain the result of the data flow analysis.</returns>
<exception cref="T:System.ArgumentException">The span is not with a method
body.</exception>
<remarks>
The first and last nodes must be fully inside the same method body.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModel.AnalyzeDataFlowCore(Microsoft.CodeAnalysis.SyntaxNode,Microsoft.CodeAnalysis.SyntaxNode)">
<summary>
Analyze data-flow within a part of a method body.
</summary>
<param name="firstStatement">The first node to be included within the analysis.</param>
<param name="lastStatement">The last node to be included within the analysis.</param>
<returns>An object that can be used to obtain the result of the data flow analysis.</returns>
<exception cref="T:System.ArgumentException">The span is not with a method
body.</exception>
<remarks>
The first and last nodes must be fully inside the same method body.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModel.AnalyzeDataFlow(Microsoft.CodeAnalysis.SyntaxNode)">
<summary>
Analyze data-flow within a part of a method body.
</summary>
<param name="statementOrExpression">The statement or expression to be analyzed.</param>
<returns>An object that can be used to obtain the result of the data flow analysis.</returns>
<exception cref="T:System.ArgumentException">The statement or expression is not with a method
body or field or property initializer.</exception>
<remarks>
The statement or expression must be fully inside a method body.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModel.AnalyzeDataFlowCore(Microsoft.CodeAnalysis.SyntaxNode)">
<summary>
Analyze data-flow within a part of a method body.
</summary>
<param name="statementOrExpression">The statement or expression to be analyzed.</param>
<returns>An object that can be used to obtain the result of the data flow analysis.</returns>
<exception cref="T:System.ArgumentException">The statement or expression is not with a method
body or field or property initializer.</exception>
<remarks>
The statement or expression must be fully inside a method body.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModel.GetConstantValue(Microsoft.CodeAnalysis.SyntaxNode,System.Threading.CancellationToken)">
<summary>
If the node provided has a constant value an Optional value will be returned with
HasValue set to true and with Value set to the constant. If the node does not have an
constant value, an Optional will be returned with HasValue set to false.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModel.GetConstantValueCore(Microsoft.CodeAnalysis.SyntaxNode,System.Threading.CancellationToken)">
<summary>
If the node provided has a constant value an Optional value will be returned with
HasValue set to true and with Value set to the constant. If the node does not have an
constant value, an Optional will be returned with HasValue set to false.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModel.GetMemberGroup(Microsoft.CodeAnalysis.SyntaxNode,System.Threading.CancellationToken)">
<summary>
When getting information for a symbol that resolves to a method group or property group,
from which a method is then chosen; the chosen method or property is present in Symbol;
all methods in the group that was consulted are placed in this property.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModel.GetMemberGroupCore(Microsoft.CodeAnalysis.SyntaxNode,System.Threading.CancellationToken)">
<summary>
When getting information for a symbol that resolves to a method group or property group,
from which a method is then chosen; the chosen method or property is present in Symbol;
all methods in the group that was consulted are placed in this property.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModel.GetEnclosingSymbol(System.Int32,System.Threading.CancellationToken)">
<summary>
Given a position in the SyntaxTree for this SemanticModel returns the innermost Symbol
that the position is considered inside of.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModel.GetEnclosingSymbolCore(System.Int32,System.Threading.CancellationToken)">
<summary>
Given a position in the SyntaxTree for this SemanticModel returns the innermost Symbol
that the position is considered inside of.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModel.IsAccessible(System.Int32,Microsoft.CodeAnalysis.ISymbol)">
<summary>
Determines if the symbol is accessible from the specified location.
</summary>
<param name="position">A character position used to identify a declaration scope and
accessibility. This character position must be within the FullSpan of the Root syntax
node in this SemanticModel.
</param>
<param name="symbol">The symbol that we are checking to see if it accessible.</param>
<returns>
True if "symbol is accessible, false otherwise.</returns>
<remarks>
This method only checks accessibility from the point of view of the accessibility
modifiers on symbol and its containing types. Even if true is returned, the given symbol
may not be able to be referenced for other reasons, such as name hiding.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModel.IsAccessibleCore(System.Int32,Microsoft.CodeAnalysis.ISymbol)">
<summary>
Determines if the symbol is accessible from the specified location.
</summary>
<param name="position">A character position used to identify a declaration scope and
accessibility. This character position must be within the FullSpan of the Root syntax
node in this SemanticModel.
</param>
<param name="symbol">The symbol that we are checking to see if it accessible.</param>
<returns>
True if "symbol is accessible, false otherwise.</returns>
<remarks>
This method only checks accessibility from the point of view of the accessibility
modifiers on symbol and its containing types. Even if true is returned, the given symbol
may not be able to be referenced for other reasons, such as name hiding.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModel.IsEventUsableAsField(System.Int32,Microsoft.CodeAnalysis.IEventSymbol)">
<summary>
Field-like events can be used as fields in types that can access private
members of the declaring type of the event.
</summary>
<remarks>
Always false for VB events.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModel.IsEventUsableAsFieldCore(System.Int32,Microsoft.CodeAnalysis.IEventSymbol)">
<summary>
Field-like events can be used as fields in types that can access private
members of the declaring type of the event.
</summary>
<remarks>
Always false for VB events.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModel.GetPreprocessingSymbolInfo(Microsoft.CodeAnalysis.SyntaxNode)">
<summary>
If <paramref name="nameSyntax"/> is an identifier name syntax node, return the <see cref="T:Microsoft.CodeAnalysis.PreprocessingSymbolInfo"/> corresponding
to it.
</summary>
<param name="nameSyntax">The nameSyntax node to get semantic information for.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModel.GetPreprocessingSymbolInfoCore(Microsoft.CodeAnalysis.SyntaxNode)">
<summary>
If <paramref name="nameSyntax"/> is an identifier name syntax node, return the <see cref="T:Microsoft.CodeAnalysis.PreprocessingSymbolInfo"/> corresponding
to it.
</summary>
<param name="nameSyntax">The nameSyntax node to get semantic information for.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModel.ComputeDeclarationsInSpan(Microsoft.CodeAnalysis.Text.TextSpan,System.Boolean,Microsoft.CodeAnalysis.PooledObjects.ArrayBuilder{Microsoft.CodeAnalysis.DeclarationInfo},System.Threading.CancellationToken)">
<summary>
Gets the <see cref="T:Microsoft.CodeAnalysis.DeclarationInfo"/> for all the declarations whose span overlaps with the given <paramref name="span"/>.
</summary>
<param name="span">Span to get declarations.</param>
<param name="getSymbol">Flag indicating whether <see cref="P:Microsoft.CodeAnalysis.DeclarationInfo.DeclaredSymbol"/> should be computed for the returned declaration infos.
If false, then <see cref="P:Microsoft.CodeAnalysis.DeclarationInfo.DeclaredSymbol"/> is always null.</param>
<param name="builder">Builder to add declarations.</param>
<param name="cancellationToken">Cancellation token.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModel.ComputeDeclarationsInNode(Microsoft.CodeAnalysis.SyntaxNode,Microsoft.CodeAnalysis.ISymbol,System.Boolean,Microsoft.CodeAnalysis.PooledObjects.ArrayBuilder{Microsoft.CodeAnalysis.DeclarationInfo},System.Threading.CancellationToken,System.Nullable{System.Int32})">
<summary>
Takes a node and returns a set of declarations that overlap the node's span.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModel.GetTopmostNodeForDiagnosticAnalysis(Microsoft.CodeAnalysis.ISymbol,Microsoft.CodeAnalysis.SyntaxNode)">
<summary>
Takes a Symbol and syntax for one of its declaring syntax reference and returns the topmost syntax node to be used by syntax analyzer.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SemanticModel.Root">
<summary>
Root of this semantic model
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SemanticModel.RootCore">
<summary>
Root of this semantic model
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModel.GetNullableContext(System.Int32)">
<summary>
Gets the <see cref="T:Microsoft.CodeAnalysis.NullableContext"/> at a position in the file.
</summary>
<param name="position">The position to get the context for.</param>
</member>
<member name="T:Microsoft.CodeAnalysis.SemanticModelProvider">
<summary>
Provides semantic models for syntax trees in a compilation.
This provider can be attached to a compilation, see <see cref="P:Microsoft.CodeAnalysis.Compilation.SemanticModelProvider"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SemanticModelProvider.GetSemanticModel(Microsoft.CodeAnalysis.SyntaxTree,Microsoft.CodeAnalysis.Compilation,System.Boolean)">
<summary>
Gets a <see cref="T:Microsoft.CodeAnalysis.SemanticModel"/> for the given <paramref name="tree"/> that belongs to the given <paramref name="compilation"/>.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.SourceReferenceResolver">
<summary>
Resolves references to source documents specified in the source.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SourceReferenceResolver.NormalizePath(System.String,System.String)">
<summary>
Normalizes specified source path with respect to base file path.
</summary>
<param name="path">The source path to normalize. May be absolute or relative.</param>
<param name="baseFilePath">Path of the source file that contains the <paramref name="path"/> (may also be relative), or null if not available.</param>
<returns>Normalized path, or null if <paramref name="path"/> can't be normalized. The resulting path doesn't need to exist.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SourceReferenceResolver.ResolveReference(System.String,System.String)">
<summary>
Resolves specified path with respect to base file path.
</summary>
<param name="path">The path to resolve. May be absolute or relative.</param>
<param name="baseFilePath">Path of the source file that contains the <paramref name="path"/> (may also be relative), or null if not available.</param>
<returns>Normalized path, or null if the file can't be resolved.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SourceReferenceResolver.OpenRead(System.String)">
<summary>
Opens a <see cref="T:System.IO.Stream"/> that allows reading the content of the specified file.
</summary>
<param name="resolvedPath">Path returned by <see cref="M:Microsoft.CodeAnalysis.SourceReferenceResolver.ResolveReference(System.String,System.String)"/>.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="resolvedPath"/> is null.</exception>
<exception cref="T:System.ArgumentException"><paramref name="resolvedPath"/> is not a valid absolute path.</exception>
<exception cref="T:System.IO.IOException">Error reading file <paramref name="resolvedPath"/>. See <see cref="P:System.Exception.InnerException"/> for details.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.SourceReferenceResolver.ReadText(System.String)">
<summary>
Reads the contents of <paramref name="resolvedPath"/> and returns a <see cref="T:Microsoft.CodeAnalysis.Text.SourceText"/>.
</summary>
<param name="resolvedPath">Path returned by <see cref="M:Microsoft.CodeAnalysis.SourceReferenceResolver.ResolveReference(System.String,System.String)"/>.</param>
</member>
<member name="T:Microsoft.CodeAnalysis.SpeculativeBindingOption">
<summary>
Describes the kind of binding to be performed in one of the SemanticModel
speculative binding methods.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SpeculativeBindingOption.BindAsExpression">
<summary>
Binds the given expression using the normal expression binding rules
that would occur during normal binding of expressions.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SpeculativeBindingOption.BindAsTypeOrNamespace">
<summary>
Binds the given expression as a type or namespace only. If this option
is selected, then the given expression must derive from TypeSyntax.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.SubsystemVersion">
<summary>
Represents subsystem version, see /subsystemversion command line
option for details and valid values.
The following table lists common subsystem versions of Windows.
Windows version Subsystem version
- Windows 2000 5.00
- Windows XP 5.01
- Windows Vista 6.00
- Windows 7 6.01
- Windows 8 Release Preview 6.02
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SubsystemVersion.Major">
<summary>
Major subsystem version
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SubsystemVersion.Minor">
<summary>
Minor subsystem version
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SubsystemVersion.None">
<summary>
Subsystem version not specified
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SubsystemVersion.Windows2000">
<summary>
Subsystem version: Windows 2000
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SubsystemVersion.WindowsXP">
<summary>
Subsystem version: Windows XP
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SubsystemVersion.WindowsVista">
<summary>
Subsystem version: Windows Vista
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SubsystemVersion.Windows7">
<summary>
Subsystem version: Windows 7
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SubsystemVersion.Windows8">
<summary>
Subsystem version: Windows 8
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SubsystemVersion.TryParse(System.String,Microsoft.CodeAnalysis.SubsystemVersion@)">
<summary>
Try parse subsystem version in "x.y" format. Note, no spaces are allowed in string representation.
</summary>
<param name="str">String to parse</param>
<param name="version">the value if successfully parsed or None otherwise</param>
<returns>true if parsed successfully, false otherwise</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SubsystemVersion.Create(System.Int32,System.Int32)">
<summary>
Create a new instance of subsystem version with specified major and minor values.
</summary>
<param name="major">major subsystem version</param>
<param name="minor">minor subsystem version</param>
<returns>subsystem version with provided major and minor</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SubsystemVersion.Default(Microsoft.CodeAnalysis.OutputKind,Microsoft.CodeAnalysis.Platform)">
<summary>
Subsystem version default for the specified output kind and platform combination
</summary>
<param name="outputKind">Output kind</param>
<param name="platform">Platform</param>
<returns>Subsystem version</returns>
</member>
<member name="P:Microsoft.CodeAnalysis.SubsystemVersion.IsValid">
<summary>
True if the subsystem version has a valid value
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.SymbolFilter">
<summary>
Indicate what kinds of declaration symbols will be included
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolFilter.None">
<summary>
None
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolFilter.Namespace">
<summary>
include namespace symbols
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolFilter.Type">
<summary>
include type symbols
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolFilter.Member">
<summary>
include member symbols such as method, event, property, field
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolFilter.TypeAndMember">
<summary>
include type and member
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolFilter.All">
<summary>
include all namespace, type and member
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SymbolInfo.Symbol">
<summary>
The symbol that was referred to by the syntax node, if any. Returns null if the given
expression did not bind successfully to a single symbol. If null is returned, it may
still be that case that we have one or more "best guesses" as to what symbol was
intended. These best guesses are available via the CandidateSymbols property.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SymbolInfo.CandidateSymbols">
<summary>
If the expression did not successfully resolve to a symbol, but there were one or more
symbols that may have been considered but discarded, this property returns those
symbols. The reason that the symbols did not successfully resolve to a symbol are
available in the CandidateReason property. For example, if the symbol was inaccessible,
ambiguous, or used in the wrong context.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SymbolInfo.CandidateReason">
<summary>
If the expression did not successfully resolve to a symbol, but there were one or more
symbols that may have been considered but discarded, this property describes why those
symbol or symbols were not considered suitable.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTreeOptionsProvider.IsGenerated(Microsoft.CodeAnalysis.SyntaxTree,System.Threading.CancellationToken)">
<summary>
Get whether the given tree is generated.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTreeOptionsProvider.TryGetDiagnosticValue(Microsoft.CodeAnalysis.SyntaxTree,System.String,System.Threading.CancellationToken,Microsoft.CodeAnalysis.ReportDiagnostic@)">
<summary>
Get diagnostic severity setting for a given diagnostic identifier in a given tree.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTreeOptionsProvider.TryGetGlobalDiagnosticValue(System.String,System.Threading.CancellationToken,Microsoft.CodeAnalysis.ReportDiagnostic@)">
<summary>
Get diagnostic severity set globally for a given diagnostic identifier
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.TypeInfo.Type">
<summary>
The type of the expression represented by the syntax node. For expressions that do not
have a type, null is returned. If the type could not be determined due to an error, then
an IErrorTypeSymbol is returned.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.TypeInfo.Nullability">
<summary>
The top-level nullability information of the expression represented by the syntax node.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.TypeInfo.ConvertedType">
<summary>
The type of the expression after it has undergone an implicit conversion. If the type
did not undergo an implicit conversion, returns the same as Type.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.TypeInfo.ConvertedNullability">
<summary>
The top-level nullability of the expression after it has undergone an implicit conversion.
For most expressions, this will be the same as the type. It can change in situations such
as implicit user-defined conversions that have a nullable return type.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.XmlReferenceResolver">
<summary>
Resolves references to XML documents specified in source code.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.XmlReferenceResolver.ResolveReference(System.String,System.String)">
<summary>
Resolves specified XML reference with respect to base file path.
</summary>
<param name="path">The reference path to resolve. May be absolute or relative path.</param>
<param name="baseFilePath">Path of the source file that contains the <paramref name="path"/> (may also be relative), or null if not available.</param>
<returns>Path to the XML artifact, or null if the file can't be resolved.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.XmlReferenceResolver.OpenRead(System.String)">
<summary>
Opens a <see cref="T:System.IO.Stream"/> that allows reading the content of the specified file.
</summary>
<param name="resolvedPath">Path returned by <see cref="M:Microsoft.CodeAnalysis.XmlReferenceResolver.ResolveReference(System.String,System.String)"/>.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="resolvedPath"/> is null.</exception>
<exception cref="T:System.ArgumentException"><paramref name="resolvedPath"/> is not a valid absolute path.</exception>
<exception cref="T:System.IO.IOException">Error reading file <paramref name="resolvedPath"/>. See <see cref="P:System.Exception.InnerException"/> for details.</exception>
</member>
<member name="F:Microsoft.CodeAnalysis.ConstantValue._s_IEEE_canonical_NaN">
<summary>
The IEEE floating-point spec doesn't specify which bit pattern an implementation
is required to use when producing NaN values. Indeed, the spec does recommend
"diagnostic" information "left to the implementer’s discretion" be placed in the
undefined bits. It is therefore likely that NaNs produced on different platforms
will differ even for the same arithmetic such as 0.0 / 0.0. To ensure that the
compiler behaves in a deterministic way, we force NaN values to use the
IEEE "canonical" form with the diagnostic bits set to zero and the sign bit set
to one. Conversion of this value to float produces the corresponding
canonical NaN of the float type (IEEE Std 754-2008 section 6.2.3).
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.ConstantValue.ConstantValueString._constantValueReference">
<summary>
Some string constant values can have large costs to realize. To compensate, we realize
constant values lazily, and hold onto a weak reference. If the next time we're asked for the constant
value the previous one still exists, we can avoid rerealizing it. But we don't want to root the constant
value if it's not being used.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CvtResFile">
<summary>
Parses .RES a file into its constituent resource elements.
Mostly translated from cvtres.cpp.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Win32ResourceConversions.VersionResourceSerializer.PadKeyLen(System.Int32)">
<summary>
Assume that 3 WORDs preceded this string and that they began 32-bit aligned.
Given the string length compute the number of bytes that should be written to end
the buffer on a 32-bit boundary</summary>
<param name="cb"></param>
<returns></returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Win32ResourceConversions.VersionResourceSerializer.PadToDword(System.Int32)">
<summary>
assuming the length of bytes submitted began on a 32-bit boundary,
round up this length as necessary so that it ends at a 32-bit boundary.
</summary>
<param name="cb"></param>
<returns></returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Win32ResourceConversions.VersionResourceSerializer.KEYSIZE(System.String)">
<summary>
compute number of chars needed to end up on a 32-bit boundary assuming that three
WORDS preceded this string.
</summary>
<param name="sz"></param>
<returns></returns>
</member>
<member name="T:Microsoft.CodeAnalysis.Debugging.SourceHashAlgorithms">
<summary>
Hash algorithms supported by the debugger used for source file checksums stored in the PDB.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Debugging.CustomDebugInfoConstants">
<summary>
Constants for producing and consuming streams of binary custom debug info.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Debugging.CustomDebugInfoEncoder.ToArray">
<exception cref="T:System.InvalidOperationException">More than <see cref="F:System.Byte.MaxValue"/> records added.</exception>
</member>
<member name="T:Microsoft.CodeAnalysis.Debugging.CustomDebugInfoKind">
<summary>
The kinds of custom debug info that we know how to interpret.
The values correspond to possible values of the "kind" byte
in the record header.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Debugging.CustomDebugInfoKind.UsingGroups">
<summary>
C# only. Encodes the sizes of using groups that are applicable to the method.
The actual import strings are stored separately trhu ISymUnmanagedWriter.UsingNamespace.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Debugging.CustomDebugInfoKind.ForwardMethodInfo">
<summary>
C# only. Indicates that per-method debug information (import strings) is stored on another method,
whose token is specified.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Debugging.CustomDebugInfoKind.ForwardModuleInfo">
<summary>
C# only. Indicates that per-module debug information (assembly reference aliases) is stored on another method,
whose token is specified.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Debugging.CustomDebugInfoKind.StateMachineHoistedLocalScopes">
<summary>
C# only. Specifies local scopes for state machine hoisted local variables.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Debugging.CustomDebugInfoKind.StateMachineTypeName">
<summary>
C# and VB. The name of the state machine type. Emitted for async and iterator kick-off methods.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Debugging.CustomDebugInfoKind.DynamicLocals">
<summary>
C# only. Dynamic flags for local variables and constants.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Debugging.CustomDebugInfoKind.EditAndContinueLocalSlotMap">
<summary>
C# and VB. Encodes EnC local variable slot map.
See https://github.com/dotnet/corefx/blob/master/src/System.Reflection.Metadata/specs/PortablePdb-Metadata.md#EditAndContinueLocalSlotMap.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Debugging.CustomDebugInfoKind.EditAndContinueLambdaMap">
<summary>
C# and VB. Encodes EnC lambda map.
See https://github.com/dotnet/corefx/blob/master/src/System.Reflection.Metadata/specs/PortablePdb-Metadata.md#EditAndContinueLambdaAndClosureMap.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Debugging.CustomDebugInfoKind.TupleElementNames">
<summary>
C# and VB. Tuple element names for local variables and constants.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Debugging.CustomDebugInfoReader">
<summary>
A collection of utility method for consuming custom debug info from a PDB.
</summary>
<remarks>
This is not a public API, so we're just going to let bad offsets fail on their own.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.Debugging.CustomDebugInfoReader.ReadGlobalHeader(System.Byte[],System.Int32@,System.Byte@,System.Byte@)">
<summary>
This is the first header in the custom debug info blob.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Debugging.CustomDebugInfoReader.ReadRecordHeader(System.Byte[],System.Int32@,System.Byte@,Microsoft.CodeAnalysis.Debugging.CustomDebugInfoKind@,System.Int32@,System.Int32@)">
<summary>
After the global header (see <see cref="M:Microsoft.CodeAnalysis.Debugging.CustomDebugInfoReader.ReadGlobalHeader(System.Byte[],System.Int32@,System.Byte@,System.Byte@)"/> comes list of custom debug info record.
Each record begins with a standard header.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Debugging.CustomDebugInfoReader.TryGetCustomDebugInfoRecord(System.Byte[],Microsoft.CodeAnalysis.Debugging.CustomDebugInfoKind)">
<exception cref="T:System.InvalidOperationException"></exception>
</member>
<member name="M:Microsoft.CodeAnalysis.Debugging.CustomDebugInfoReader.GetCustomDebugInfoRecords(System.Byte[])">
<remarks>
Exposed for <see cref="T:Roslyn.Test.PdbUtilities.PdbToXmlConverter"/>.
</remarks>
<exception cref="T:System.InvalidOperationException"></exception>
</member>
<member name="M:Microsoft.CodeAnalysis.Debugging.CustomDebugInfoReader.DecodeUsingRecord(System.Collections.Immutable.ImmutableArray{System.Byte})">
<summary>
For each namespace declaration enclosing a method (innermost-to-outermost), there is a count
of the number of imports in that declaration.
</summary>
<remarks>
There's always at least one entry (for the global namespace).
Exposed for <see cref="T:Roslyn.Test.PdbUtilities.PdbToXmlConverter"/>.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.Debugging.CustomDebugInfoReader.DecodeForwardRecord(System.Collections.Immutable.ImmutableArray{System.Byte})">
<summary>
This indicates that further information can be obtained by looking at the custom debug
info of another method (specified by token).
</summary>
<remarks>
Appears when multiple method would otherwise have identical using records (see <see cref="M:Microsoft.CodeAnalysis.Debugging.CustomDebugInfoReader.DecodeUsingRecord(System.Collections.Immutable.ImmutableArray{System.Byte})"/>).
Exposed for <see cref="T:Roslyn.Test.PdbUtilities.PdbToXmlConverter"/>.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.Debugging.CustomDebugInfoReader.DecodeForwardToModuleRecord(System.Collections.Immutable.ImmutableArray{System.Byte})">
<summary>
This indicates that further information can be obtained by looking at the custom debug
info of another method (specified by token).
</summary>
<remarks>
Appears when there are extern aliases and edit-and-continue is disabled.
Exposed for <see cref="T:Roslyn.Test.PdbUtilities.PdbToXmlConverter"/>.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.Debugging.CustomDebugInfoReader.DecodeStateMachineHoistedLocalScopesRecord(System.Collections.Immutable.ImmutableArray{System.Byte})">
<summary>
Scopes of state machine hoisted local variables.
</summary>
<remarks>
Exposed for <see cref="T:Roslyn.Test.PdbUtilities.PdbToXmlConverter"/>.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.Debugging.CustomDebugInfoReader.DecodeForwardIteratorRecord(System.Collections.Immutable.ImmutableArray{System.Byte})">
<summary>
Indicates that this method is the iterator state machine for the method named in the record.
</summary>
<remarks>
Appears when are iterator methods.
Exposed for <see cref="T:Roslyn.Test.PdbUtilities.PdbToXmlConverter"/>.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.Debugging.CustomDebugInfoReader.DecodeDynamicLocalsRecord(System.Collections.Immutable.ImmutableArray{System.Byte})">
<summary>
Does for locals what System.Runtime.CompilerServices.DynamicAttribute does for parameters, return types, and fields.
In particular, indicates which occurrences of <see cref="T:System.Object"/> in the signature are really dynamic.
</summary>
<remarks>
Appears when there are dynamic locals.
Exposed for <see cref="T:Roslyn.Test.PdbUtilities.PdbToXmlConverter"/>.
</remarks>
<exception cref="T:System.InvalidOperationException">Bad data.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.Debugging.CustomDebugInfoReader.DecodeTupleElementNamesRecord(System.Collections.Immutable.ImmutableArray{System.Byte})">
<summary>
Tuple element names for locals.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Debugging.CustomDebugInfoReader.ReadRawRecordBody(System.Byte[],System.Int32@,System.Int32,System.Collections.Immutable.ImmutableArray{System.Byte}@)">
<summary>
Returns the raw bytes of a record.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Debugging.CustomDebugInfoReader.SkipRecord(System.Byte[],System.Int32@,System.Int32)">
<summary>
Skips past a record.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Debugging.CustomDebugInfoReader.GetCSharpGroupedImportStrings``1(System.Int32,``0,System.Func{System.Int32,``0,System.Byte[]},System.Func{System.Int32,``0,System.Collections.Immutable.ImmutableArray{System.String}},System.Collections.Immutable.ImmutableArray{System.String}@)">
<summary>
Get the import strings for a given method, following forward pointers as necessary.
</summary>
<returns>
For each namespace enclosing the method, a list of import strings, innermost to outermost.
There should always be at least one entry, for the global namespace.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Debugging.CustomDebugInfoReader.GetVisualBasicImportStrings``1(System.Int32,``0,System.Func{System.Int32,``0,System.Collections.Immutable.ImmutableArray{System.String}})">
<summary>
Get the import strings for a given method, following forward pointers as necessary.
</summary>
<returns>
A list of import strings. There should always be at least one entry, for the global namespace.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Debugging.CustomDebugInfoReader.TryParseCSharpImportString(System.String,System.String@,System.String@,System.String@,Microsoft.CodeAnalysis.Debugging.ImportTargetKind@)">
<summary>
Parse a string representing a C# using (or extern alias) directive.
</summary>
<remarks>
<![CDATA[
For C#:
"USystem" -> <namespace name="System" />
"AS USystem" -> <alias name="S" target="System" kind="namespace" />
"AC TSystem.Console" -> <alias name="C" target="System.Console" kind="type" />
"AS ESystem alias" -> <alias name="S" qualifier="alias" target="System" kind="type" />
"XOldLib" -> <extern alias="OldLib" />
"ZOldLib assembly" -> <externinfo name="OldLib" assembly="assembly" />
"ESystem alias" -> <namespace qualifier="alias" name="System" />
"TSystem.Math" -> <type name="System.Math" />
]]>
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.Debugging.CustomDebugInfoReader.TryParseVisualBasicImportString(System.String,System.String@,System.String@,Microsoft.CodeAnalysis.Debugging.ImportTargetKind@,Microsoft.CodeAnalysis.Debugging.VBImportScopeKind@)">
<summary>
Parse a string representing a VB import statement.
</summary>
<exception cref="T:System.ArgumentNullException"><paramref name="import"/> is null.</exception>
<exception cref="T:System.ArgumentException">Format of <paramref name="import"/> is not valid.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.Debugging.CustomDebugInfoReader.ReadUtf8String(System.Collections.Immutable.ImmutableArray{System.Byte},System.Int32@)">
<summary>
Read UTF8 string with null terminator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Debugging.ImportTargetKind.Namespace">
<summary>
C# or VB namespace import.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Debugging.ImportTargetKind.Type">
<summary>
C# or VB type import.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Debugging.ImportTargetKind.NamespaceOrType">
<summary>
VB namespace or type alias target (not specified).
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Debugging.ImportTargetKind.Assembly">
<summary>
C# extern alias.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Debugging.ImportTargetKind.XmlNamespace">
<summary>
VB XML import.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Debugging.ImportTargetKind.MethodToken">
<summary>
VB forwarding information (i.e. another method has the imports for this one).
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Debugging.ImportTargetKind.CurrentNamespace">
<summary>
VB containing namespace (not an import).
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Debugging.ImportTargetKind.DefaultNamespace">
<summary>
VB root namespace (not an import).
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Debugging.ImportTargetKind.Defunct">
<summary>
A kind that is no longer used.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Debugging.StateMachineHoistedLocalScope.StartOffset">
<summary>
The offset of the first operation in the scope.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Debugging.StateMachineHoistedLocalScope.EndOffset">
<summary>
The offset of the first operation outside of the scope, or the method body length.
If zero then <see cref="F:Microsoft.CodeAnalysis.Debugging.StateMachineHoistedLocalScope.StartOffset"/> is also zero and the slot represents a synthesized local.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.AssemblyPortabilityPolicy">
<summary>
Policy to be used when matching assembly reference to an assembly definition across platforms.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.AssemblyVersion.op_Explicit(System.Version)~Microsoft.CodeAnalysis.AssemblyVersion">
<summary>
Converts <see cref="T:System.Version"/> to <see cref="T:Microsoft.CodeAnalysis.AssemblyVersion"/>.
</summary>
<exception cref="T:System.InvalidCastException">Major, minor, build or revision number are less than 0 or greater than 0xFFFF.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.DesktopAssemblyIdentityComparer.#ctor(Microsoft.CodeAnalysis.AssemblyPortabilityPolicy)">
<param name="policy">Assembly portability policy, usually provided through an app.config file.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.DesktopAssemblyIdentityComparer.LoadFromXml(System.IO.Stream)">
<summary>
Loads <see cref="T:Microsoft.CodeAnalysis.AssemblyPortabilityPolicy"/> information from XML with app.config schema.
</summary>
<exception cref="T:System.Xml.XmlException">The stream doesn't contain a well formed XML.</exception>
<exception cref="T:System.ArgumentNullException"><paramref name="input"/> is null.</exception>
<remarks>
Tries to find supportPortability elements in the given XML:
<![CDATA[
<configuration>
<runtime>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<supportPortability PKT="7cec85d7bea7798e" enable="false"/>
<supportPortability PKT="31bf3856ad364e35" enable="false"/>
</assemblyBinding>
</runtime>
</configuration>
]]>
Keeps the stream open.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.DesktopAssemblyIdentityComparer.IsFrameworkAssembly(Microsoft.CodeAnalysis.AssemblyIdentity)">
<summary>
Returns true if the identity is a Framework 4.5 or lower assembly.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.AdditionalText">
<summary>
Represents a non source code file.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.AdditionalText.Path">
<summary>
Path to the text.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.AdditionalText.GetText(System.Threading.CancellationToken)">
<summary>
Returns a <see cref="T:Microsoft.CodeAnalysis.Text.SourceText"/> with the contents of this file, or <c>null</c> if
there were errors reading the file.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.AnalysisContextInfo">
<summary>
this hold onto analyzer executor context which will be used later to put context information in analyzer exception if it occurs.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.AnalysisResult">
<summary>
Stores the results of analyzer execution:
1. Local and non-local diagnostics, per-analyzer.
2. Analyzer execution times, if requested.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AnalysisResult.Analyzers">
<summary>
Analyzers corresponding to this analysis result.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AnalysisResult.SyntaxDiagnostics">
<summary>
Syntax diagnostics reported by the <see cref="P:Microsoft.CodeAnalysis.Diagnostics.AnalysisResult.Analyzers"/>.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AnalysisResult.SemanticDiagnostics">
<summary>
Semantic diagnostics reported by the <see cref="P:Microsoft.CodeAnalysis.Diagnostics.AnalysisResult.Analyzers"/>.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AnalysisResult.AdditionalFileDiagnostics">
<summary>
Diagnostics in additional files reported by the <see cref="P:Microsoft.CodeAnalysis.Diagnostics.AnalysisResult.Analyzers"/>.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AnalysisResult.CompilationDiagnostics">
<summary>
Compilation diagnostics reported by the <see cref="P:Microsoft.CodeAnalysis.Diagnostics.AnalysisResult.Analyzers"/>.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AnalysisResult.AnalyzerTelemetryInfo">
<summary>
Analyzer telemetry info (register action counts and execution times).
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalysisResult.GetAllDiagnostics(Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer)">
<summary>
Gets all the diagnostics reported by the given <paramref name="analyzer"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalysisResult.GetAllDiagnostics">
<summary>
Gets all the diagnostics reported by all the <see cref="P:Microsoft.CodeAnalysis.Diagnostics.AnalysisResult.Analyzers"/>.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.AnalysisResultBuilder">
<summary>
Stores the results of analyzer execution:
1. Local and non-local diagnostics, per-analyzer.
2. Analyzer execution times, if requested.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.AnalysisScope">
<summary>
Scope for analyzer execution.
This scope could either be the entire compilation for all analyzers (command line build) or
could be scoped to a specific tree/span and/or a subset of analyzers (CompilationWithAnalyzers).
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AnalysisScope.SyntaxTrees">
<summary>
Syntax trees on which we need to perform syntax analysis.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AnalysisScope.AdditionalFiles">
<summary>
Non-source files on which we need to perform analysis.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AnalysisScope.CategorizeDiagnostics">
<summary>
True if we need to categorize diagnostics into local and non-local diagnostics and track the analyzer reporting each diagnostic.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AnalysisScope.IsSyntacticSingleFileAnalysis">
<summary>
True if we need to perform only syntax analysis for a single source or additional file.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AnalysisScope.IsSingleFileAnalysis">
<summary>
True if we need to perform analysis for a single source or additional file.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AnalysisScope.IsPartialAnalysis">
<summary>
Flag indicating if this is a partial analysis for the corresponding <see cref="T:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers"/>,
i.e. <see cref="P:Microsoft.CodeAnalysis.Diagnostics.AnalysisScope.IsSingleFileAnalysis"/> is true and/or <see cref="P:Microsoft.CodeAnalysis.Diagnostics.AnalysisScope.Analyzers"/> is a subset of <see cref="P:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers.Analyzers"/>.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.AnalysisState">
<summary>
Stores the partial analysis state for analyzers executed on a specific compilation.
</summary>
<summary>
Stores the current partial analysis state for an analyzer.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.AnalysisState.AnalyzerStateData">
<summary>
Stores the partial analysis state for a specific event/symbol/tree for a specific analyzer.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AnalysisState.AnalyzerStateData.StateKind">
<summary>
Current state of analysis.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AnalysisState.AnalyzerStateData.ProcessedActions">
<summary>
Set of completed actions.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalysisState.AnalyzerStateData.ResetToReadyState">
<summary>
Resets the <see cref="P:Microsoft.CodeAnalysis.Diagnostics.AnalysisState.AnalyzerStateData.StateKind"/> from <see cref="F:Microsoft.CodeAnalysis.Diagnostics.AnalysisState.StateKind.InProcess"/> to <see cref="F:Microsoft.CodeAnalysis.Diagnostics.AnalysisState.StateKind.ReadyToProcess"/>.
This method must be invoked after successful analysis completion AND on analysis cancellation.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Diagnostics.AnalysisState._analyzerStateMap">
<summary>
Per-analyzer analysis state map.
The integer value points to the index within the <see cref="F:Microsoft.CodeAnalysis.Diagnostics.AnalysisState._analyzerStates"/> array.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Diagnostics.AnalysisState._analyzerStates">
<summary>
Per-analyzer analysis state.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Diagnostics.AnalysisState._pendingSourceEvents">
<summary>
Compilation events corresponding to source tree, that are not completely processed for all analyzers.
Events are dropped as and when they are fully processed by all analyzers.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Diagnostics.AnalysisState._pendingNonSourceEvents">
<summary>
Compilation events corresponding to the compilation (compilation start and completed events), that are not completely processed for all analyzers.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Diagnostics.AnalysisState._lazyAnalyzerActionCountsMap">
<summary>
Action counts per-analyzer.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalysisState.OnCompilationEventProcessedAsync(Microsoft.CodeAnalysis.Diagnostics.CompilationEvent,System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer},System.Func{Microsoft.CodeAnalysis.ISymbol,Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer,System.Threading.Tasks.Task})">
<summary>
Invoke this method at completion of event processing for the given analyzers.
It updates the analysis state of this event for each analyzer and if the event has been fully processed for all analyzers, then removes it from our event cache.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalysisState.GetPendingEvents(System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer},Microsoft.CodeAnalysis.SyntaxTree,System.Threading.CancellationToken)">
<summary>
Gets pending events for given set of analyzers for the given syntax tree.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalysisState.GetPendingEvents_NoLock(System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer},Microsoft.CodeAnalysis.SyntaxTree)">
<summary>
Gets pending events for given set of analyzers for the given syntax tree.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalysisState.GetPendingEvents(System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer},System.Boolean,System.Boolean,System.Threading.CancellationToken)">
<summary>
Gets all pending events for given set of analyzers.
</summary>
<param name="analyzers"></param>
<param name="includeSourceEvents">Indicates if source events (symbol declared, compilation unit completed event) should be included.</param>
<param name="includeNonSourceEvents">Indicates if compilation wide events (compilation started and completed event) should be included.</param>
<param name="cancellationToken">Cancellation token.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalysisState.HasPendingSyntaxAnalysis(Microsoft.CodeAnalysis.Diagnostics.AnalysisScope)">
<summary>
Returns true if we have any pending syntax analysis for given analysis scope.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalysisState.HasPendingSymbolAnalysis(Microsoft.CodeAnalysis.Diagnostics.AnalysisScope,System.Threading.CancellationToken)">
<summary>
Returns true if we have any pending symbol analysis for given analysis scope.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalysisState.TryStartProcessingEvent(Microsoft.CodeAnalysis.Diagnostics.CompilationEvent,Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer,Microsoft.CodeAnalysis.Diagnostics.AnalysisState.AnalyzerStateData@)">
<summary>
Attempts to start processing a compilation event for the given analyzer.
</summary>
<returns>
Returns false if the event has already been processed for the analyzer OR is currently being processed by another task.
If true, then it returns a non-null <paramref name="state"/> representing partial analysis state for the given event for the given analyzer.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalysisState.MarkEventComplete(Microsoft.CodeAnalysis.Diagnostics.CompilationEvent,Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer)">
<summary>
Marks the given event as fully analyzed for the given analyzer.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalysisState.MarkEventComplete(Microsoft.CodeAnalysis.Diagnostics.CompilationEvent,System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer})">
<summary>
Marks the given event as fully analyzed for the given analyzers.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalysisState.MarkEventCompleteForUnprocessedAnalyzers(Microsoft.CodeAnalysis.Diagnostics.CompilationEvent,Microsoft.CodeAnalysis.Diagnostics.AnalysisScope,System.Collections.Generic.HashSet{Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer})">
<summary>
Marks the given event as fully analyzed for the unprocessed analyzers in the given analysisScope.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalysisState.IsEventComplete(Microsoft.CodeAnalysis.Diagnostics.CompilationEvent,Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer)">
<summary>
Checks if the given event has been fully analyzed for the given analyzer.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalysisState.TryStartAnalyzingSymbol(Microsoft.CodeAnalysis.ISymbol,Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer,Microsoft.CodeAnalysis.Diagnostics.AnalysisState.AnalyzerStateData@)">
<summary>
Attempts to start processing a symbol for the given analyzer's symbol actions.
</summary>
<returns>
Returns false if the symbol has already been processed for the analyzer OR is currently being processed by another task.
If true, then it returns a non-null <paramref name="state"/> representing partial analysis state for the given symbol for the given analyzer.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalysisState.TryStartSymbolEndAnalysis(Microsoft.CodeAnalysis.ISymbol,Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer,Microsoft.CodeAnalysis.Diagnostics.AnalysisState.AnalyzerStateData@)">
<summary>
Attempts to start executing a symbol's end actions for the given analyzer.
</summary>
<returns>
Returns false if the symbol end actions have already been executed for the analyzer OR are currently being executed by another task.
If true, then it returns a non-null <paramref name="state"/> representing partial analysis state for the given symbol end actions for the given analyzer.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalysisState.MarkSymbolComplete(Microsoft.CodeAnalysis.ISymbol,Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer)">
<summary>
Marks the given symbol as fully analyzed for the given analyzer.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalysisState.MarkSymbolCompleteForUnprocessedAnalyzers(Microsoft.CodeAnalysis.ISymbol,Microsoft.CodeAnalysis.Diagnostics.AnalysisScope,System.Collections.Generic.HashSet{Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer})">
<summary>
Marks the given symbol as fully analyzed for the unprocessed analyzers in the given analysisScope.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalysisState.IsSymbolComplete(Microsoft.CodeAnalysis.ISymbol,Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer)">
<summary>
True if the given symbol is fully analyzed for the given analyzer.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalysisState.MarkSymbolEndAnalysisComplete(Microsoft.CodeAnalysis.ISymbol,System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer})">
<summary>
Marks the given symbol end actions as fully executed for the given analyzers.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalysisState.MarkSymbolEndAnalysisComplete(Microsoft.CodeAnalysis.ISymbol,Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer)">
<summary>
Marks the given symbol end actions as fully executed for the given analyzer.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalysisState.IsSymbolEndAnalysisComplete(Microsoft.CodeAnalysis.ISymbol,Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer)">
<summary>
True if the given symbol end analysis is complete for the given analyzer.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalysisState.TryStartAnalyzingDeclaration(Microsoft.CodeAnalysis.ISymbol,System.Int32,Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer,Microsoft.CodeAnalysis.Diagnostics.AnalysisState.DeclarationAnalyzerStateData@)">
<summary>
Attempts to start processing a symbol declaration for the given analyzer's syntax node and code block actions.
</summary>
<returns>
Returns false if the declaration has already been processed for the analyzer OR is currently being processed by another task.
If true, then it returns a non-null <paramref name="state"/> representing partial analysis state for the given declaration for the given analyzer.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalysisState.IsDeclarationComplete(Microsoft.CodeAnalysis.ISymbol,System.Int32)">
<summary>
True if the given symbol declaration is fully analyzed for all the analyzers.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalysisState.IsDeclarationComplete(Microsoft.CodeAnalysis.ISymbol,System.Int32,Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer)">
<summary>
True if the given symbol declaration is fully analyzed for the given analyzer.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalysisState.MarkDeclarationComplete(Microsoft.CodeAnalysis.ISymbol,System.Int32,Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer)">
<summary>
Marks the given symbol declaration as fully analyzed for the given analyzer.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalysisState.MarkDeclarationComplete(Microsoft.CodeAnalysis.ISymbol,System.Int32,System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer})">
<summary>
Marks the given symbol declaration as fully analyzed for the given analyzers.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalysisState.MarkDeclarationsComplete(Microsoft.CodeAnalysis.ISymbol,System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer})">
<summary>
Marks all the symbol declarations for the given symbol as fully analyzed for all the given analyzers.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalysisState.TryStartSyntaxAnalysis(Microsoft.CodeAnalysis.Diagnostics.SourceOrAdditionalFile,Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer,Microsoft.CodeAnalysis.Diagnostics.AnalysisState.AnalyzerStateData@)">
<summary>
Attempts to start processing a syntax tree or additional file for the given analyzer's syntax tree or additional file actions respectively.
</summary>
<returns>
Returns false if the file has already been processed for the analyzer OR is currently being processed by another task.
If true, then it returns a non-null <paramref name="state"/> representing partial syntax analysis state for the given tree for the given analyzer.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalysisState.MarkSyntaxAnalysisComplete(Microsoft.CodeAnalysis.Diagnostics.SourceOrAdditionalFile,Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer)">
<summary>
Marks the given file as fully syntactically analyzed for the given analyzer.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalysisState.MarkSyntaxAnalysisComplete(Microsoft.CodeAnalysis.Diagnostics.SourceOrAdditionalFile,System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer})">
<summary>
Marks the given file as fully syntactically analyzed for the given analyzers.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalysisState.MarkSyntaxAnalysisCompleteForUnprocessedAnalyzers(Microsoft.CodeAnalysis.Diagnostics.SourceOrAdditionalFile,Microsoft.CodeAnalysis.Diagnostics.AnalysisScope,System.Collections.Generic.HashSet{Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer})">
<summary>
Marks the given file as fully syntactically analyzed for the unprocessed analyzers in the given analysisScope.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.AnalysisState.StateKind">
<summary>
State kind of per-analyzer <see cref="T:Microsoft.CodeAnalysis.Diagnostics.AnalysisState.AnalyzerStateData"/> tracking an analyzer's partial analysis state.
An analysis state object can be in one of the following states:
1. Completely unprocessed: <see cref="F:Microsoft.CodeAnalysis.Diagnostics.AnalysisState.StateKind.ReadyToProcess"/>
2. Currently being processed: <see cref="F:Microsoft.CodeAnalysis.Diagnostics.AnalysisState.StateKind.InProcess"/>
3. Partially processed by one or more older requests that was either completed or cancelled: <see cref="F:Microsoft.CodeAnalysis.Diagnostics.AnalysisState.StateKind.ReadyToProcess"/>
4. Fully processed: <see cref="F:Microsoft.CodeAnalysis.Diagnostics.AnalysisState.StateKind.FullyProcessed"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Diagnostics.AnalysisState.StateKind.ReadyToProcess">
<summary>
Ready for processing.
Indicates it is either completely unprocessed or partially processed by one or more older requests that was either completed or cancelled.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Diagnostics.AnalysisState.StateKind.InProcess">
<summary>
Currently being processed.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Diagnostics.AnalysisState.StateKind.FullyProcessed">
<summary>
Fully processed.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.AnalysisState.DeclarationAnalyzerStateData">
<summary>
Stores the partial analysis state for a specific symbol declaration for a specific analyzer.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AnalysisState.DeclarationAnalyzerStateData.CodeBlockAnalysisState">
<summary>
Partial analysis state for code block actions executed on the declaration.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AnalysisState.DeclarationAnalyzerStateData.OperationBlockAnalysisState">
<summary>
Partial analysis state for operation block actions executed on the declaration.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.AnalysisState.SyntaxNodeAnalyzerStateData">
<summary>
Stores the partial analysis state for syntax node actions executed on the declaration.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.AnalysisState.OperationAnalyzerStateData">
<summary>
Stores the partial analysis state for operation actions executed on the declaration.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.AnalysisState.BlockAnalyzerStateData`2">
<summary>
Stores the partial analysis state for code block actions or operation block actions executed on the declaration.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.AnalysisState.CodeBlockAnalyzerStateData">
<summary>
Stores the partial analysis state for code block actions executed on the declaration.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.AnalysisState.OperationBlockAnalyzerStateData">
<summary>
Stores the partial analysis state for operation block actions executed on the declaration.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.Telemetry.AnalyzerActionCounts">
<summary>
Contains the counts of registered actions for an analyzer.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.Telemetry.AnalyzerActionCounts.CompilationStartActionsCount">
<summary>
Count of registered compilation start actions.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.Telemetry.AnalyzerActionCounts.CompilationEndActionsCount">
<summary>
Count of registered compilation end actions.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.Telemetry.AnalyzerActionCounts.CompilationActionsCount">
<summary>
Count of registered compilation actions.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.Telemetry.AnalyzerActionCounts.SyntaxTreeActionsCount">
<summary>
Count of registered syntax tree actions.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.Telemetry.AnalyzerActionCounts.AdditionalFileActionsCount">
<summary>
Count of registered additional file actions.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.Telemetry.AnalyzerActionCounts.SemanticModelActionsCount">
<summary>
Count of registered semantic model actions.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.Telemetry.AnalyzerActionCounts.SymbolActionsCount">
<summary>
Count of registered symbol actions.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.Telemetry.AnalyzerActionCounts.SymbolStartActionsCount">
<summary>
Count of registered symbol start actions.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.Telemetry.AnalyzerActionCounts.SymbolEndActionsCount">
<summary>
Count of registered symbol end actions.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.Telemetry.AnalyzerActionCounts.SyntaxNodeActionsCount">
<summary>
Count of registered syntax node actions.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.Telemetry.AnalyzerActionCounts.CodeBlockStartActionsCount">
<summary>
Count of code block start actions.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.Telemetry.AnalyzerActionCounts.CodeBlockEndActionsCount">
<summary>
Count of code block end actions.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.Telemetry.AnalyzerActionCounts.CodeBlockActionsCount">
<summary>
Count of code block actions.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.Telemetry.AnalyzerActionCounts.OperationActionsCount">
<summary>
Count of Operation actions.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.Telemetry.AnalyzerActionCounts.OperationBlockStartActionsCount">
<summary>
Count of Operation block start actions.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.Telemetry.AnalyzerActionCounts.OperationBlockEndActionsCount">
<summary>
Count of Operation block end actions.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.Telemetry.AnalyzerActionCounts.OperationBlockActionsCount">
<summary>
Count of Operation block actions.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.Telemetry.AnalyzerActionCounts.HasAnyExecutableCodeActions">
<summary>
Returns true if there are any actions that need to run on executable code.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.Telemetry.AnalyzerActionCounts.Concurrent">
<summary>
Gets a value indicating whether the analyzer supports concurrent execution.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.Telemetry.AnalyzerTelemetryInfo">
<summary>
Contains telemetry info for a specific analyzer, such as count of registered actions, the total execution time, etc.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.Telemetry.AnalyzerTelemetryInfo.CompilationStartActionsCount">
<summary>
Count of registered compilation start actions.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.Telemetry.AnalyzerTelemetryInfo.CompilationEndActionsCount">
<summary>
Count of registered compilation end actions.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.Telemetry.AnalyzerTelemetryInfo.CompilationActionsCount">
<summary>
Count of registered compilation actions.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.Telemetry.AnalyzerTelemetryInfo.SyntaxTreeActionsCount">
<summary>
Count of registered syntax tree actions.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.Telemetry.AnalyzerTelemetryInfo.AdditionalFileActionsCount">
<summary>
Count of registered additional file actions.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.Telemetry.AnalyzerTelemetryInfo.SemanticModelActionsCount">
<summary>
Count of registered semantic model actions.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.Telemetry.AnalyzerTelemetryInfo.SymbolActionsCount">
<summary>
Count of registered symbol actions.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.Telemetry.AnalyzerTelemetryInfo.SymbolStartActionsCount">
<summary>
Count of registered symbol start actions.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.Telemetry.AnalyzerTelemetryInfo.SymbolEndActionsCount">
<summary>
Count of registered symbol end actions.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.Telemetry.AnalyzerTelemetryInfo.SyntaxNodeActionsCount">
<summary>
Count of registered syntax node actions.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.Telemetry.AnalyzerTelemetryInfo.CodeBlockStartActionsCount">
<summary>
Count of registered code block start actions.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.Telemetry.AnalyzerTelemetryInfo.CodeBlockEndActionsCount">
<summary>
Count of registered code block end actions.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.Telemetry.AnalyzerTelemetryInfo.CodeBlockActionsCount">
<summary>
Count of registered code block actions.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.Telemetry.AnalyzerTelemetryInfo.OperationActionsCount">
<summary>
Count of registered operation actions.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.Telemetry.AnalyzerTelemetryInfo.OperationBlockStartActionsCount">
<summary>
Count of registered operation block start actions.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.Telemetry.AnalyzerTelemetryInfo.OperationBlockEndActionsCount">
<summary>
Count of registered operation block end actions.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.Telemetry.AnalyzerTelemetryInfo.OperationBlockActionsCount">
<summary>
Count of registered operation block actions.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.Telemetry.AnalyzerTelemetryInfo.SuppressionActionsCount">
<summary>
Count of registered suppression actions.
This is the same as count of <see cref="T:Microsoft.CodeAnalysis.Diagnostics.DiagnosticSuppressor"/>s as each suppressor
has a single suppression action, i.e. <see cref="M:Microsoft.CodeAnalysis.Diagnostics.DiagnosticSuppressor.ReportSuppressions(Microsoft.CodeAnalysis.Diagnostics.SuppressionAnalysisContext)"/>.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.Telemetry.AnalyzerTelemetryInfo.ExecutionTime">
<summary>
Total execution time.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.Telemetry.AnalyzerTelemetryInfo.Concurrent">
<summary>
Gets a value indicating whether the analyzer supports concurrent execution.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.Telemetry.AnalyzerTelemetryInfo.#ctor">
<summary>
Create telemetry info for a specific analyzer, such as count of registered actions, the total execution time, etc.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AnalyzerConfigOptions.KeyComparer">
<summary>
Comparer that should be used for all analyzer config keys. This is a case-insensitive comparison based
on Unicode case sensitivity rules for identifiers.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerConfigOptions.TryGetValue(System.String,System.String@)">
<summary>
Get an analyzer config value for the given key, using the <see cref="P:Microsoft.CodeAnalysis.Diagnostics.AnalyzerConfigOptions.KeyComparer"/>.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.AnalyzerConfigOptionsProvider">
<summary>
Provide options from an analyzer config file keyed on a source file.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AnalyzerConfigOptionsProvider.GlobalOptions">
<summary>
Gets global options that do not apply to any specific file
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerConfigOptionsProvider.GetOptions(Microsoft.CodeAnalysis.SyntaxTree)">
<summary>
Get options for a given <paramref name="tree"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerConfigOptionsProvider.GetOptions(Microsoft.CodeAnalysis.AdditionalText)">
<summary>
Get options for a given <see cref="T:Microsoft.CodeAnalysis.AdditionalText"/>
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver">
<summary>
Driver to execute diagnostic analyzers for a given compilation.
It uses a <see cref="T:Microsoft.CodeAnalysis.Diagnostics.AsyncQueue`1"/> of <see cref="T:Microsoft.CodeAnalysis.Diagnostics.CompilationEvent"/>s to drive its analysis.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver._programmaticSuppressions">
<summary>
Set of diagnostic suppressions that are suppressed via analyzer suppression actions.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver._diagnosticsProcessedForProgrammaticSuppressions">
<summary>
Set of diagnostics that have already been processed for application of programmatic suppressions.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver._hasDiagnosticSuppressors">
<summary>
Flag indicating if the <see cref="P:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.Analyzers"/> include any <see cref="T:Microsoft.CodeAnalysis.Diagnostics.DiagnosticSuppressor"/>
which can suppress reported analyzer/compiler diagnostics.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver._severityFilter">
<summary>
Filtered diagnostic severities in the compilation, i.e. diagnostics with effective severity from this set should not be reported.
PERF: If all supported diagnostics for an analyzer are from this set, we completely skip executing the analyzer.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.UnsuppressedAnalyzers">
<summary>
Unsuppressed analyzers that need to be executed.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.PerSymbolAnalyzerActionsCache">
<summary>
Cache of additional analyzer actions to be executed per symbol per analyzer, which are registered in symbol start actions.
We cache the tuple:
1. myActions: analyzer actions registered in the symbol start actions of containing namespace/type, which are to be executed for this symbol
2. childActions: analyzer actions registered in this symbol's start actions, which are to be executed for member symbols.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.DefaultGeneratedCodeAnalysisFlags">
<summary>
Default analysis mode for generated code.
</summary>
<remarks>
This mode should always guarantee that analyzer action callbacks are enabled for generated code, i.e. <see cref="F:Microsoft.CodeAnalysis.Diagnostics.GeneratedCodeAnalysisFlags.Analyze"/> is set.
However, the default diagnostic reporting mode is liable to change in future.
</remarks>
</member>
<member name="F:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver._lazyAnalyzerGateMap">
<summary>
Map from non-concurrent analyzers to the gate guarding callback into the analyzer.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.GeneratedCodeAnalysisFlagsMap">
<summary>
Map from analyzers to their <see cref="T:Microsoft.CodeAnalysis.Diagnostics.GeneratedCodeAnalysisFlags"/> setting.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver._lazyAnalyzerActions">
<summary>
The set of registered analyzer actions.
</summary>
<seealso cref="P:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.AnalyzerActions"/>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.NonConfigurableAnalyzers">
<summary>
Set of unsuppressed analyzers that report non-configurable diagnostics that cannot be suppressed with end user configuration.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.SymbolStartAnalyzers">
<summary>
Set of analyzers that have registered symbol start analyzer actions.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.TreatAllCodeAsNonGeneratedCode">
<summary>
True if all analyzers need to analyze and report diagnostics in generated code - we can assume all code to be non-generated code.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver._lazyDoNotAnalyzeGeneratedCode">
<summary>
True if no analyzer needs generated code analysis - we can skip all analysis on a generated code symbol/tree.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.GeneratedCodeFilesMap">
<summary>
Lazily populated dictionary indicating whether a source file is a generated code file or not - we populate it lazily to avoid realizing all syntax trees in the compilation upfront.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.GeneratedCodeSymbolsForTreeMap">
<summary>
Lazily populated dictionary from tree to declared symbols with GeneratedCodeAttribute.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.SuppressedAnalyzersForTreeMap">
<summary>
Lazily populated dictionary from tree to analyzers that are suppressed on the entire tree.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.IsGeneratedCodeSymbolMap">
<summary>
Lazily populated dictionary from symbol to a bool indicating if it is a generated code symbol.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver._lazyTreesWithHiddenRegionsMap">
<summary>
Lazily populated dictionary indicating whether a source file has any hidden regions - we populate it lazily to avoid realizing all syntax trees in the compilation upfront.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver._lazyGeneratedCodeAttribute">
<summary>
Symbol for <see cref="T:System.CodeDom.Compiler.GeneratedCodeAttribute"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver._lazyInitializeTask">
<summary>
Driver task which initializes all analyzers.
This task is initialized and executed only once at start of analysis.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver._initializeSucceeded">
<summary>
Flag to indicate if the <see cref="F:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver._lazyInitializeTask"/> was successfully started.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver._lazyPrimaryTask">
<summary>
Primary driver task which processes all <see cref="P:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.CompilationEventQueue"/> events, runs analyzer actions and signals completion of <see cref="P:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.DiagnosticQueue"/> at the end.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver._workerCount">
<summary>
Number of worker tasks processing compilation events and executing analyzer actions.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.CompilationEventQueue">
<summary>
Events queue for analyzer execution.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.DiagnosticQueue">
<summary>
<see cref="P:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.DiagnosticQueue"/> that is fed the diagnostics as they are computed.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.#ctor(System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer},Microsoft.CodeAnalysis.Diagnostics.AnalyzerManager,Microsoft.CodeAnalysis.Diagnostics.SeverityFilter,System.Func{Microsoft.CodeAnalysis.SyntaxTrivia,System.Boolean})">
<summary>
Create an analyzer driver.
</summary>
<param name="analyzers">The set of analyzers to include in the analysis</param>
<param name="analyzerManager">AnalyzerManager to manage analyzers for analyzer host's lifetime.</param>
<param name="severityFilter">Filtered diagnostic severities in the compilation, i.e. diagnostics with effective severity from this set should not be reported.</param>
<param name="isComment">Delegate to identify if the given trivia is a comment.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.Initialize(Microsoft.CodeAnalysis.Diagnostics.AnalyzerExecutor,Microsoft.CodeAnalysis.Diagnostics.DiagnosticQueue,Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.CompilationData,System.Threading.CancellationToken)">
<summary>
Initializes the <see cref="P:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.AnalyzerActions"/> and related actions maps for the analyzer driver.
It kicks off the <see cref="P:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.WhenInitializedTask"/> task for initialization.
Note: This method must be invoked exactly once on the driver.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.ComputeShouldTreatAllCodeAsNonGeneratedCode(System.Collections.Immutable.ImmutableHashSet{Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer},System.Collections.Immutable.ImmutableDictionary{Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer,Microsoft.CodeAnalysis.Diagnostics.GeneratedCodeAnalysisFlags})">
<summary>
Returns true if all analyzers need to analyze and report diagnostics in generated code - we can assume all code to be non-generated code.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.AttachQueueAndProcessAllEventsAsync(Microsoft.CodeAnalysis.Diagnostics.AsyncQueue{Microsoft.CodeAnalysis.Diagnostics.CompilationEvent},Microsoft.CodeAnalysis.Diagnostics.AnalysisScope,Microsoft.CodeAnalysis.Diagnostics.AnalysisState,System.Threading.CancellationToken)">
<summary>
Attaches a pre-populated event queue to the driver and processes all events in the queue.
</summary>
<param name="eventQueue">Compilation events to analyze.</param>
<param name="analysisScope">Scope of analysis.</param>
<param name="analysisState">An optional object to track partial analysis state.</param>
<param name="cancellationToken">Cancellation token to abort analysis.</param>
<remarks>Driver must be initialized before invoking this method, i.e. <see cref="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.Initialize(Microsoft.CodeAnalysis.Diagnostics.AnalyzerExecutor,Microsoft.CodeAnalysis.Diagnostics.DiagnosticQueue,Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.CompilationData,System.Threading.CancellationToken)"/> method must have been invoked and <see cref="P:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.WhenInitializedTask"/> must be non-null.</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.AttachQueueAndStartProcessingEvents(Microsoft.CodeAnalysis.Diagnostics.AsyncQueue{Microsoft.CodeAnalysis.Diagnostics.CompilationEvent},Microsoft.CodeAnalysis.Diagnostics.AnalysisScope,System.Threading.CancellationToken)">
<summary>
Attaches event queue to the driver and start processing all events pertaining to the given analysis scope.
</summary>
<param name="eventQueue">Compilation events to analyze.</param>
<param name="analysisScope">Scope of analysis.</param>
<param name="cancellationToken">Cancellation token to abort analysis.</param>
<remarks>Driver must be initialized before invoking this method, i.e. <see cref="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.Initialize(Microsoft.CodeAnalysis.Diagnostics.AnalyzerExecutor,Microsoft.CodeAnalysis.Diagnostics.DiagnosticQueue,Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.CompilationData,System.Threading.CancellationToken)"/> method must have been invoked and <see cref="P:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.WhenInitializedTask"/> must be non-null.</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.CreateAndAttachToCompilation(Microsoft.CodeAnalysis.Compilation,System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer},Microsoft.CodeAnalysis.Diagnostics.AnalyzerOptions,Microsoft.CodeAnalysis.Diagnostics.AnalyzerManager,System.Action{Microsoft.CodeAnalysis.Diagnostic},System.Boolean,Microsoft.CodeAnalysis.Diagnostics.SeverityFilter,Microsoft.CodeAnalysis.Compilation@,System.Threading.CancellationToken)">
<summary>
Create an <see cref="T:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver"/> and attach it to the given compilation.
</summary>
<param name="compilation">The compilation to which the new driver should be attached.</param>
<param name="analyzers">The set of analyzers to include in the analysis.</param>
<param name="options">Options that are passed to analyzers.</param>
<param name="analyzerManager">AnalyzerManager to manage analyzers for the lifetime of analyzer host.</param>
<param name="addExceptionDiagnostic">Delegate to add diagnostics generated for exceptions from third party analyzers.</param>
<param name="reportAnalyzer">Report additional information related to analyzers, such as analyzer execution time.</param>
<param name="severityFilter">Filtered diagnostic severities in the compilation, i.e. diagnostics with effective severity from this set should not be reported.</param>
<param name="newCompilation">The new compilation with the analyzer driver attached.</param>
<param name="cancellationToken">A cancellation token that can be used to abort analysis.</param>
<returns>A newly created analyzer driver</returns>
<remarks>
Note that since a compilation is immutable, the act of creating a driver and attaching it produces
a new compilation. Any further actions on the compilation should use the new compilation.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.GetDiagnosticsAsync(Microsoft.CodeAnalysis.Compilation)">
<summary>
Returns all diagnostics computed by the analyzers since the last time this was invoked.
If <see cref="P:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.CompilationEventQueue"/> has been completed with all compilation events, then it waits for
<see cref="P:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.WhenCompletedTask"/> task for the driver to finish processing all events and generate remaining analyzer diagnostics.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.WhenInitializedTask">
<summary>
Return a task that completes when the driver is initialized.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.WhenCompletedTask">
<summary>
Return a task that completes when the driver is done producing diagnostics.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.TryProcessSymbolDeclaredAsync(Microsoft.CodeAnalysis.Diagnostics.SymbolDeclaredCompilationEvent,Microsoft.CodeAnalysis.Diagnostics.AnalysisScope,Microsoft.CodeAnalysis.Diagnostics.AnalysisState,System.Threading.CancellationToken)">
<summary>
Tries to execute symbol action, symbol start/end actions and declaration actions for the given symbol.
</summary>
<returns>
<see cref="T:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.EventProcessedState"/> indicating the current state of processing of the given compilation event.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.TryExecuteSymbolActions(Microsoft.CodeAnalysis.Diagnostics.SymbolDeclaredCompilationEvent,Microsoft.CodeAnalysis.Diagnostics.AnalysisScope,Microsoft.CodeAnalysis.Diagnostics.AnalysisState,System.Boolean,System.Threading.CancellationToken)">
<summary>
Tries to execute symbol actions.
</summary>
<returns>
True, if successfully executed the actions for the given analysis scope OR no actions were required to be executed for the given analysis scope.
False, otherwise.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.TryProcessCompilationUnitCompleted(Microsoft.CodeAnalysis.Diagnostics.CompilationUnitCompletedEvent,Microsoft.CodeAnalysis.Diagnostics.AnalysisScope,Microsoft.CodeAnalysis.Diagnostics.AnalysisState,System.Threading.CancellationToken)">
<summary>
Tries to execute compilation unit actions.
</summary>
<returns>
True, if successfully executed the actions for the given analysis scope OR no actions were required to be executed for the given analysis scope.
False, otherwise.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.TryProcessCompilationStarted(Microsoft.CodeAnalysis.Diagnostics.CompilationStartedEvent,Microsoft.CodeAnalysis.Diagnostics.AnalysisScope,Microsoft.CodeAnalysis.Diagnostics.AnalysisState)">
<summary>
Tries to execute compilation started actions.
</summary>
<returns>
True, if successfully executed the actions for the given analysis scope OR no actions were required to be executed for the given analysis scope.
False, otherwise.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.TryProcessCompilationCompleted(Microsoft.CodeAnalysis.Diagnostics.CompilationCompletedEvent,Microsoft.CodeAnalysis.Diagnostics.AnalysisScope,Microsoft.CodeAnalysis.Diagnostics.AnalysisState)">
<summary>
Tries to execute compilation completed actions.
</summary>
<returns>
True, if successfully executed the actions for the given analysis scope OR no actions were required to be executed for the given analysis scope.
False, otherwise.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.TryExecuteCompilationActions(System.Collections.Immutable.ImmutableArray{System.ValueTuple{Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer,System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.Diagnostics.CompilationAnalyzerAction}}},Microsoft.CodeAnalysis.Diagnostics.CompilationEvent,Microsoft.CodeAnalysis.Diagnostics.AnalysisScope,Microsoft.CodeAnalysis.Diagnostics.AnalysisState)">
<summary>
Tries to execute compilation actions.
</summary>
<returns>
True, if successfully executed the actions for the given analysis scope OR no actions were required to be executed for the given analysis scope.
False, otherwise.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.IsDiagnosticAnalyzerSuppressed(Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer,Microsoft.CodeAnalysis.CompilationOptions,Microsoft.CodeAnalysis.Diagnostics.AnalyzerManager,Microsoft.CodeAnalysis.Diagnostics.AnalyzerExecutor,Microsoft.CodeAnalysis.Diagnostics.SeverityFilter)">
<summary>
Returns true if all the diagnostics that can be produced by this analyzer are suppressed through options.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.DeclarationAnalysisData.DeclaringReferenceSyntax">
<summary>
GetSyntax() for the given SyntaxReference.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.DeclarationAnalysisData.TopmostNodeForAnalysis">
<summary>
Topmost declaration node for analysis.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.DeclarationAnalysisData.DeclarationsInNode">
<summary>
All member declarations within the declaration.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.DeclarationAnalysisData.DescendantNodesToAnalyze">
<summary>
All descendant nodes for syntax node actions.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.DeclarationAnalysisData.IsPartialAnalysis">
<summary>
Flag indicating if this is a partial analysis.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.EventProcessedState">
<summary>
Used to represent state of processing of a <see cref="T:Microsoft.CodeAnalysis.Diagnostics.CompilationEvent"/>.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.EventProcessedState.SubsetProcessedAnalyzers">
<summary>
Subset of processed analyzers.
NOTE: This property is only non-null for <see cref="F:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.EventProcessedStateKind.PartiallyProcessed"/>.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver`1">
<summary>
Driver to execute diagnostic analyzers for a given compilation.
It uses a <see cref="T:Microsoft.CodeAnalysis.Diagnostics.AsyncQueue`1"/> of <see cref="T:Microsoft.CodeAnalysis.Diagnostics.CompilationEvent"/>s to drive its analysis.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver`1.#ctor(System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer},System.Func{Microsoft.CodeAnalysis.SyntaxNode,`0},Microsoft.CodeAnalysis.Diagnostics.AnalyzerManager,Microsoft.CodeAnalysis.Diagnostics.SeverityFilter,System.Func{Microsoft.CodeAnalysis.SyntaxTrivia,System.Boolean})">
<summary>
Create an analyzer driver.
</summary>
<param name="analyzers">The set of analyzers to include in the analysis</param>
<param name="getKind">A delegate that returns the language-specific kind for a given syntax node</param>
<param name="analyzerManager">AnalyzerManager to manage analyzers for the lifetime of analyzer host.</param>
<param name="severityFilter">Filtered diagnostic severities in the compilation, i.e. diagnostics with effective severity from this set should not be reported.</param>
<param name="isComment">Delegate to identify if the given trivia is a comment.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver`1.TryExecuteDeclaringReferenceActions(Microsoft.CodeAnalysis.Diagnostics.SymbolDeclaredCompilationEvent,Microsoft.CodeAnalysis.Diagnostics.AnalysisScope,Microsoft.CodeAnalysis.Diagnostics.AnalysisState,System.Boolean,Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.IGroupedAnalyzerActions,System.Threading.CancellationToken)">
<summary>
Tries to execute syntax node, code block and operation actions for all declarations for the given symbol.
</summary>
<returns>
True, if successfully executed the actions for the given analysis scope OR no actions were required to be executed for the given analysis scope.
False, otherwise.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver`1.TryExecuteDeclaringReferenceActions(Microsoft.CodeAnalysis.SyntaxReference,System.Int32,Microsoft.CodeAnalysis.Diagnostics.SymbolDeclaredCompilationEvent,Microsoft.CodeAnalysis.Diagnostics.AnalysisScope,Microsoft.CodeAnalysis.Diagnostics.AnalysisState,Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver{`0}.GroupedAnalyzerActions,Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver{`0}.GroupedAnalyzerActions,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Threading.CancellationToken)">
<summary>
Tries to execute syntax node, code block and operation actions for the given declaration.
</summary>
<returns>
True, if successfully executed the actions for the given analysis scope OR no actions were required to be executed for the given analysis scope.
False, otherwise.
</returns>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver`1.GroupedAnalyzerActions">
<summary>
<see cref="P:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver`1.GroupedAnalyzerActions.AnalyzerActions"/> grouped by <see cref="T:Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer"/>, and possibly other entities, such as <see cref="T:Microsoft.CodeAnalysis.OperationKind"/>, <see cref="T:Microsoft.CodeAnalysis.SymbolKind"/>, etc.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.AnalyzerExecutor">
<summary>
Contains the core execution logic for callbacks into analyzers.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.AnalyzerExecutor.AnalyzerDiagnosticReporter">
<summary>
Pooled object that carries the info needed to process
a reported diagnostic from a syntax node action.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Diagnostics.AnalyzerExecutor._analyzerExecutionTimeMap">
<summary>
The values in this map convert to <see cref="T:System.TimeSpan"/> using <see cref="M:System.TimeSpan.FromTicks(System.Int64)"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerExecutor.Create(Microsoft.CodeAnalysis.Compilation,Microsoft.CodeAnalysis.Diagnostics.AnalyzerOptions,System.Action{Microsoft.CodeAnalysis.Diagnostic},System.Action{System.Exception,Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer,Microsoft.CodeAnalysis.Diagnostic},System.Func{System.Exception,System.Boolean},System.Func{Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer,System.Boolean},Microsoft.CodeAnalysis.Diagnostics.AnalyzerManager,System.Func{Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer,System.Boolean},System.Func{Microsoft.CodeAnalysis.Diagnostic,Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer,Microsoft.CodeAnalysis.Compilation,System.Threading.CancellationToken,System.Boolean},System.Func{Microsoft.CodeAnalysis.SyntaxTree,Microsoft.CodeAnalysis.Text.TextSpan,System.Boolean},System.Func{Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer,Microsoft.CodeAnalysis.SyntaxTree,Microsoft.CodeAnalysis.SyntaxTreeOptionsProvider,System.Boolean},System.Func{Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer,System.Object},System.Func{Microsoft.CodeAnalysis.SyntaxTree,Microsoft.CodeAnalysis.SemanticModel},System.Boolean,System.Action{Microsoft.CodeAnalysis.Diagnostic,Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer,System.Boolean},System.Action{Microsoft.CodeAnalysis.Diagnostic,Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer},System.Action{Microsoft.CodeAnalysis.Diagnostics.Suppression},System.Threading.CancellationToken)">
<summary>
Creates <see cref="T:Microsoft.CodeAnalysis.Diagnostics.AnalyzerExecutor"/> to execute analyzer actions with given arguments
</summary>
<param name="compilation">Compilation to be used in the analysis.</param>
<param name="analyzerOptions">Analyzer options.</param>
<param name="addNonCategorizedDiagnostic">Optional delegate to add non-categorized analyzer diagnostics.</param>
<param name="onAnalyzerException">
Delegate which is invoked when an analyzer throws an exception.
Delegate can do custom tasks such as report the given analyzer exception diagnostic, report a non-fatal watson for the exception, etc.
</param>
<param name="analyzerExceptionFilter">
Optional delegate which is invoked when an analyzer throws an exception as an exception filter.
Delegate can do custom tasks such as crash hosting process to create a dump.
</param>
<param name="isCompilerAnalyzer">Delegate to determine if the given analyzer is compiler analyzer.
We need to special case the compiler analyzer at few places for performance reasons.</param>
<param name="analyzerManager">Analyzer manager to fetch supported diagnostics.</param>
<param name="getAnalyzerGate">
Delegate to fetch the gate object to guard all callbacks into the analyzer.
It should return a unique gate object for the given analyzer instance for non-concurrent analyzers, and null otherwise.
All analyzer callbacks for non-concurrent analyzers will be guarded with a lock on the gate.
</param>
<param name="getSemanticModel">Delegate to get a semantic model for the given syntax tree which can be shared across analyzers.</param>
<param name="shouldSkipAnalysisOnGeneratedCode">Delegate to identify if analysis should be skipped on generated code.</param>
<param name="shouldSuppressGeneratedCodeDiagnostic">Delegate to identify if diagnostic reported while analyzing generated code should be suppressed.</param>
<param name="isGeneratedCodeLocation">Delegate to identify if the given location is in generated code.</param>
<param name="isAnalyzerSuppressedForTree">Delegate to identify if the given analyzer is suppressed for the given tree.</param>
<param name="logExecutionTime">Flag indicating whether we need to log analyzer execution time.</param>
<param name="addCategorizedLocalDiagnostic">Optional delegate to add categorized local analyzer diagnostics.</param>
<param name="addCategorizedNonLocalDiagnostic">Optional delegate to add categorized non-local analyzer diagnostics.</param>
<param name="addSuppression">Optional thread-safe delegate to add diagnostic suppressions from suppressors.</param>
<param name="cancellationToken">Cancellation token.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerExecutor.CreateForSupportedDiagnostics(System.Action{System.Exception,Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer,Microsoft.CodeAnalysis.Diagnostic},Microsoft.CodeAnalysis.Diagnostics.AnalyzerManager,System.Threading.CancellationToken)">
<summary>
Creates <see cref="T:Microsoft.CodeAnalysis.Diagnostics.AnalyzerExecutor"/> to fetch <see cref="P:Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer.SupportedDiagnostics"/>.
</summary>
<param name="onAnalyzerException">
Optional delegate which is invoked when an analyzer throws an exception.
Delegate can do custom tasks such as report the given analyzer exception diagnostic, report a non-fatal watson for the exception, etc.
</param>
<param name="analyzerManager">Analyzer manager to fetch supported diagnostics.</param>
<param name="cancellationToken">Cancellation token.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerExecutor.ExecuteInitializeMethod(Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer,Microsoft.CodeAnalysis.Diagnostics.HostSessionStartAnalysisScope)">
<summary>
Executes the <see cref="M:Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer.Initialize(Microsoft.CodeAnalysis.Diagnostics.AnalysisContext)"/> for the given analyzer.
</summary>
<param name="analyzer">Analyzer to get session wide analyzer actions.</param>
<param name="sessionScope">Session scope to store register session wide analyzer actions.</param>
<remarks>
Note that this API doesn't execute any <see cref="T:Microsoft.CodeAnalysis.Diagnostics.CompilationStartAnalyzerAction"/> registered by the Initialize invocation.
Use <see cref="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerExecutor.ExecuteCompilationStartActions(System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.Diagnostics.CompilationStartAnalyzerAction},Microsoft.CodeAnalysis.Diagnostics.HostCompilationStartAnalysisScope)"/> API
to get execute these actions to get the per-compilation analyzer actions.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerExecutor.ExecuteCompilationStartActions(System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.Diagnostics.CompilationStartAnalyzerAction},Microsoft.CodeAnalysis.Diagnostics.HostCompilationStartAnalysisScope)">
<summary>
Executes the compilation start actions.
</summary>
<param name="actions"><see cref="T:Microsoft.CodeAnalysis.Diagnostics.AnalyzerActions"/> whose compilation start actions are to be executed.</param>
<param name="compilationScope">Compilation scope to store the analyzer actions.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerExecutor.ExecuteSymbolStartActions(Microsoft.CodeAnalysis.ISymbol,Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer,System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.Diagnostics.SymbolStartAnalyzerAction},Microsoft.CodeAnalysis.Diagnostics.HostSymbolStartAnalysisScope)">
<summary>
Executes the symbol start actions.
</summary>
<param name="actions"><see cref="T:Microsoft.CodeAnalysis.Diagnostics.AnalyzerActions"/> whose symbol start actions are to be executed.</param>
<param name="symbolScope">Symbol scope to store the analyzer actions.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerExecutor.ExecuteSuppressionAction(Microsoft.CodeAnalysis.Diagnostics.DiagnosticSuppressor,System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.Diagnostic})">
<summary>
Executes the given diagnostic suppressor.
</summary>
<param name="suppressor">Suppressor to be executed.</param>
<param name="reportedDiagnostics">Reported analyzer/compiler diagnostics that can be suppressed.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerExecutor.TryExecuteCompilationActions(System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.Diagnostics.CompilationAnalyzerAction},Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer,Microsoft.CodeAnalysis.Diagnostics.CompilationEvent,Microsoft.CodeAnalysis.Diagnostics.AnalysisScope,Microsoft.CodeAnalysis.Diagnostics.AnalysisState)">
<summary>
Tries to executes compilation actions or compilation end actions.
</summary>
<param name="compilationActions">Compilation actions to be executed.</param>
<param name="analyzer">Analyzer whose actions are to be executed.</param>
<param name="compilationEvent">Compilation event.</param>
<param name="analysisScope">Scope for analyzer execution.</param>
<param name="analysisState">An optional object to track analysis state.</param>
<returns>
True, if successfully executed the actions for the given analysis scope OR all the actions have already been executed for the given analysis scope.
False, if there are some pending actions that are currently being executed on another thread.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerExecutor.TryExecuteSymbolActions(System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.Diagnostics.SymbolAnalyzerAction},Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer,Microsoft.CodeAnalysis.Diagnostics.SymbolDeclaredCompilationEvent,System.Func{Microsoft.CodeAnalysis.ISymbol,Microsoft.CodeAnalysis.SyntaxReference,Microsoft.CodeAnalysis.Compilation,System.Threading.CancellationToken,Microsoft.CodeAnalysis.SyntaxNode},Microsoft.CodeAnalysis.Diagnostics.AnalysisScope,Microsoft.CodeAnalysis.Diagnostics.AnalysisState,System.Boolean)">
<summary>
Tries to execute the symbol actions on the given symbol.
</summary>
<param name="symbolActions">Symbol actions to be executed.</param>
<param name="analyzer">Analyzer whose actions are to be executed.</param>
<param name="symbolDeclaredEvent">Symbol event to be analyzed.</param>
<param name="getTopMostNodeForAnalysis">Delegate to get topmost declaration node for a symbol declaration reference.</param>
<param name="analysisScope">Scope for analyzer execution.</param>
<param name="analysisState">An optional object to track analysis state.</param>
<param name="isGeneratedCodeSymbol">Flag indicating if this is a generated code symbol.</param>
<returns>
True, if successfully executed the actions for the given analysis scope OR all the actions have already been executed for the given analysis scope.
False, if there are some pending actions that are currently being executed on another thread.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerExecutor.TryExecuteSymbolEndActionsForContainer(Microsoft.CodeAnalysis.INamespaceOrTypeSymbol,Microsoft.CodeAnalysis.ISymbol,Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer,System.Func{Microsoft.CodeAnalysis.ISymbol,Microsoft.CodeAnalysis.SyntaxReference,Microsoft.CodeAnalysis.Compilation,System.Threading.CancellationToken,Microsoft.CodeAnalysis.SyntaxNode},Microsoft.CodeAnalysis.Diagnostics.AnalysisState,Microsoft.CodeAnalysis.Diagnostics.SymbolDeclaredCompilationEvent@)">
<summary>
Tries to execute the symbol end actions on the given namespace or type containing symbol for the process member symbol for the given analyzer.
</summary>
<param name="containingSymbol">Symbol whose actions are to be executed.</param>
<param name="processedMemberSymbol">Completed member symbol.</param>
<param name="analyzer">Analyzer whose actions are to be executed.</param>
<param name="getTopMostNodeForAnalysis">Delegate to get topmost declaration node for a symbol declaration reference.</param>
<param name="analysisState">An optional object to track analysis state.</param>
<returns>
True, if successfully executed the actions for the given analysis scope OR all the actions have already been executed for the given analysis scope.
False, if there are some pending actions.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerExecutor.TryExecuteSymbolEndActions(System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.Diagnostics.SymbolEndAnalyzerAction},Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer,Microsoft.CodeAnalysis.Diagnostics.SymbolDeclaredCompilationEvent,System.Func{Microsoft.CodeAnalysis.ISymbol,Microsoft.CodeAnalysis.SyntaxReference,Microsoft.CodeAnalysis.Compilation,System.Threading.CancellationToken,Microsoft.CodeAnalysis.SyntaxNode},Microsoft.CodeAnalysis.Diagnostics.AnalysisState)">
<summary>
Tries to execute the symbol end actions on the given symbol for the given analyzer.
</summary>
<param name="symbolEndActions">Symbol actions to be executed.</param>
<param name="analyzer">Analyzer whose actions are to be executed.</param>
<param name="symbolDeclaredEvent">Symbol event to be analyzed.</param>
<param name="getTopMostNodeForAnalysis">Delegate to get topmost declaration node for a symbol declaration reference.</param>
<param name="analysisState">An optional object to track analysis state.</param>
<returns>
True, if successfully executed the actions for the given analysis scope OR all the actions have already been executed for the given analysis scope.
False, if there are some pending actions.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerExecutor.TryExecuteSemanticModelActions(System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.Diagnostics.SemanticModelAnalyzerAction},Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer,Microsoft.CodeAnalysis.SemanticModel,Microsoft.CodeAnalysis.Diagnostics.CompilationEvent,Microsoft.CodeAnalysis.Diagnostics.AnalysisScope,Microsoft.CodeAnalysis.Diagnostics.AnalysisState,System.Boolean)">
<summary>
Tries to execute the semantic model actions on the given semantic model.
</summary>
<param name="semanticModelActions">Semantic model actions to be executed.</param>
<param name="analyzer">Analyzer whose actions are to be executed.</param>
<param name="semanticModel">Semantic model to analyze.</param>
<param name="compilationUnitCompletedEvent">Compilation event for semantic model analysis.</param>
<param name="analysisScope">Scope for analyzer execution.</param>
<param name="analysisState">An optional object to track analysis state.</param>
<param name="isGeneratedCode">Flag indicating if the syntax tree being analyzed is generated code.</param>
<returns>
True, if successfully executed the actions for the given analysis scope OR all the actions have already been executed for the given analysis scope.
False, if there are some pending actions that are currently being executed on another thread.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerExecutor.TryExecuteSyntaxTreeActions(System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.Diagnostics.SyntaxTreeAnalyzerAction},Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer,Microsoft.CodeAnalysis.Diagnostics.SourceOrAdditionalFile,Microsoft.CodeAnalysis.Diagnostics.AnalysisScope,Microsoft.CodeAnalysis.Diagnostics.AnalysisState,System.Boolean)">
<summary>
Tries to execute the syntax tree actions on the given syntax tree.
</summary>
<param name="syntaxTreeActions">Syntax tree actions to be executed.</param>
<param name="analyzer">Analyzer whose actions are to be executed.</param>
<param name="file">Syntax tree to analyze.</param>
<param name="analysisScope">Scope for analyzer execution.</param>
<param name="analysisState">An optional object to track analysis state.</param>
<param name="isGeneratedCode">Flag indicating if the syntax tree being analyzed is generated code.</param>
<returns>
True, if successfully executed the actions for the given analysis scope OR all the actions have already been executed for the given analysis scope.
False, if there are some pending actions that are currently being executed on another thread.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerExecutor.TryExecuteAdditionalFileActions(System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.Diagnostics.AdditionalFileAnalyzerAction},Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer,Microsoft.CodeAnalysis.Diagnostics.SourceOrAdditionalFile,Microsoft.CodeAnalysis.Diagnostics.AnalysisScope,Microsoft.CodeAnalysis.Diagnostics.AnalysisState)">
<summary>
Tries to execute the additional file actions.
</summary>
<param name="additionalFileActions">Actions to be executed.</param>
<param name="analyzer">Analyzer whose actions are to be executed.</param>
<param name="file">Additional file to analyze.</param>
<param name="analysisScope">Scope for analyzer execution.</param>
<param name="analysisState">An optional object to track analysis state.</param>
<returns>
True, if successfully executed the actions for the given analysis scope OR all the actions have already been executed for the given analysis scope.
False, if there are some pending actions that are currently being executed on another thread.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerExecutor.TryExecuteCodeBlockActions``1(System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.Diagnostics.CodeBlockStartAnalyzerAction{``0}},System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.Diagnostics.CodeBlockAnalyzerAction},System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.Diagnostics.CodeBlockAnalyzerAction},Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer,Microsoft.CodeAnalysis.SyntaxNode,Microsoft.CodeAnalysis.ISymbol,System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.SyntaxNode},Microsoft.CodeAnalysis.SemanticModel,System.Func{Microsoft.CodeAnalysis.SyntaxNode,``0},System.Int32,Microsoft.CodeAnalysis.Diagnostics.AnalysisScope,Microsoft.CodeAnalysis.Diagnostics.AnalysisState,System.Boolean)">
<summary>
Tries to execute code block actions for the given analyzer for the given declaration.
</summary>
<returns>
True, if successfully executed the actions for the given analysis scope OR all the actions have already been executed for the given analysis scope.
False, if there are some pending actions that are currently being executed on another thread.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerExecutor.TryExecuteOperationBlockActions(System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.Diagnostics.OperationBlockStartAnalyzerAction},System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.Diagnostics.OperationBlockAnalyzerAction},System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.Diagnostics.OperationBlockAnalyzerAction},Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer,Microsoft.CodeAnalysis.SyntaxNode,Microsoft.CodeAnalysis.ISymbol,System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.IOperation},System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.IOperation},Microsoft.CodeAnalysis.SemanticModel,System.Int32,Microsoft.CodeAnalysis.Diagnostics.AnalysisScope,Microsoft.CodeAnalysis.Diagnostics.AnalysisState,System.Boolean)">
<summary>
Tries to execute operation block actions for the given analyzer for the given declaration.
</summary>
<returns>
True, if successfully executed the actions for the given analysis scope OR all the actions have already been executed for the given analysis scope.
False, if there are some pending actions that are currently being executed on another thread.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerExecutor.TryExecuteSyntaxNodeActions``1(System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.SyntaxNode},System.Collections.Generic.IDictionary{``0,System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.Diagnostics.SyntaxNodeAnalyzerAction{``0}}},Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer,Microsoft.CodeAnalysis.SemanticModel,System.Func{Microsoft.CodeAnalysis.SyntaxNode,``0},Microsoft.CodeAnalysis.Text.TextSpan,System.Int32,Microsoft.CodeAnalysis.ISymbol,Microsoft.CodeAnalysis.Diagnostics.AnalysisScope,Microsoft.CodeAnalysis.Diagnostics.AnalysisState,System.Boolean)">
<summary>
Tries to execute syntax node actions for the given analyzer for the given declaration.
</summary>
<returns>
True, if successfully executed the actions for the given analysis scope OR all the actions have already been executed for the given analysis scope.
False, if there are some pending actions that are currently being executed on another thread.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerExecutor.TryExecuteOperationActions(System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.IOperation},System.Collections.Generic.IDictionary{Microsoft.CodeAnalysis.OperationKind,System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.Diagnostics.OperationAnalyzerAction}},Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer,Microsoft.CodeAnalysis.SemanticModel,Microsoft.CodeAnalysis.Text.TextSpan,System.Int32,Microsoft.CodeAnalysis.ISymbol,Microsoft.CodeAnalysis.Diagnostics.AnalysisScope,Microsoft.CodeAnalysis.Diagnostics.AnalysisState,System.Boolean)">
<summary>
Tries to execute operation actions for the given analyzer for the given declaration.
</summary>
<returns>
True, if successfully executed the actions for the given analysis scope OR all the actions have already been executed for the given analysis scope.
False, if there are some pending actions that are currently being executed on another thread.
</returns>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.AnalyzerFileReference">
<summary>
Represents analyzers stored in an analyzer assembly file.
</summary>
<remarks>
Analyzer are read from the file, owned by the reference, and doesn't change
since the reference is accessed until the reference object is garbage collected.
If you need to manage the lifetime of the analyzer reference (and the file stream) explicitly use <see cref="T:Microsoft.CodeAnalysis.Diagnostics.AnalyzerImageReference"/>.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerFileReference.#ctor(System.String,Microsoft.CodeAnalysis.IAnalyzerAssemblyLoader)">
<summary>
Creates an AnalyzerFileReference with the given <paramref name="fullPath"/> and <paramref name="assemblyLoader"/>.
</summary>
<param name="fullPath">Full path of the analyzer assembly.</param>
<param name="assemblyLoader">Loader for obtaining the <see cref="T:System.Reflection.Assembly"/> from the <paramref name="fullPath"/></param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerFileReference.AddAnalyzers(System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer}.Builder,System.String)">
<summary>
Adds the <see cref="T:System.Collections.Immutable.ImmutableArray`1"/> of <see cref="T:Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer"/> defined in this assembly reference of given <paramref name="language"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerFileReference.AddGenerators(System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.ISourceGenerator}.Builder,System.String)">
<summary>
Adds the <see cref="T:System.Collections.Immutable.ImmutableArray`1"/> of <see cref="T:Microsoft.CodeAnalysis.ISourceGenerator"/> defined in this assembly reference of given <paramref name="language"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerFileReference.GetAnalyzerTypeNameMap(System.String,System.Type,Microsoft.CodeAnalysis.Diagnostics.AnalyzerFileReference.AttributeLanguagesFunc)">
<summary>
Opens the analyzer dll with the metadata reader and builds a map of language -> analyzer type names.
</summary>
<exception cref="T:System.BadImageFormatException">The PE image format is invalid.</exception>
<exception cref="T:System.IO.IOException">IO error reading the metadata.</exception>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.AnalyzerImageReference">
<summary>
Represents an in-memory analyzer reference image.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AnalyzerLoadFailureEventArgs.TypeName">
<summary>
If a specific analyzer failed to load the namespace-qualified name of its type, null otherwise.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AnalyzerLoadFailureEventArgs.Message">
<summary>
Error message.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AnalyzerLoadFailureEventArgs.ErrorCode">
<summary>
Error code.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AnalyzerLoadFailureEventArgs.Exception">
<summary>
Exception that was thrown while loading the analyzer. May be null.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.AnalyzerManager">
<summary>
Manages properties of analyzers (such as registered actions, supported diagnostics) for analyzer host's lifetime
and executes the callbacks into the analyzers.
It ensures the following for the lifetime of analyzer host:
1) <see cref="M:Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer.Initialize(Microsoft.CodeAnalysis.Diagnostics.AnalysisContext)"/> is invoked only once per-analyzer.
2) <see cref="P:Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer.SupportedDiagnostics"/> is invoked only once per-analyzer.
3) <see cref="T:Microsoft.CodeAnalysis.Diagnostics.CompilationStartAnalyzerAction"/> registered during Initialize are invoked only once per-compilation per-analyzer and analyzer options.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Diagnostics.AnalyzerManager.AnalyzerExecutionContext._lazyPendingMemberSymbolsMap">
<summary>
Map from (symbol, analyzer) to count of its member symbols whose symbol declared events are not yet processed.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Diagnostics.AnalyzerManager.AnalyzerExecutionContext._lazyPendingSymbolEndActionsMap">
<summary>
Symbol declared events for symbols with pending symbol end analysis for given analyzer.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Diagnostics.AnalyzerManager.AnalyzerExecutionContext._lazySessionScopeTask">
<summary>
Task to compute HostSessionStartAnalysisScope for session wide analyzer actions, i.e. AnalyzerActions registered by analyzer's Initialize method.
These are run only once per every analyzer.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Diagnostics.AnalyzerManager.AnalyzerExecutionContext._lazyCompilationScopeTask">
<summary>
Task to compute HostCompilationStartAnalysisScope for per-compilation analyzer actions, i.e. AnalyzerActions registered by analyzer's CompilationStartActions.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Diagnostics.AnalyzerManager.AnalyzerExecutionContext._lazySymbolScopeTasks">
<summary>
Task to compute HostSymbolStartAnalysisScope for per-symbol analyzer actions, i.e. AnalyzerActions registered by analyzer's SymbolStartActions.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Diagnostics.AnalyzerManager.AnalyzerExecutionContext._lazyDiagnosticDescriptors">
<summary>
Supported diagnostic descriptors for diagnostic analyzer, if any.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Diagnostics.AnalyzerManager.AnalyzerExecutionContext._lazySuppressionDescriptors">
<summary>
Supported suppression descriptors for diagnostic suppressor, if any.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerManager.AnalyzerExecutionContext.ComputeDiagnosticDescriptors(Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer,Microsoft.CodeAnalysis.Diagnostics.AnalyzerExecutor)">
<summary>
Compute <see cref="P:Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer.SupportedDiagnostics"/> and exception handler for the given <paramref name="analyzer"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerManager.GetAnalyzerActionsAsync(Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer,Microsoft.CodeAnalysis.Diagnostics.AnalyzerExecutor)">
<summary>
Get all the analyzer actions to execute for the given analyzer against a given compilation.
The returned actions include the actions registered during <see cref="M:Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer.Initialize(Microsoft.CodeAnalysis.Diagnostics.AnalysisContext)"/> method as well as
the actions registered during <see cref="T:Microsoft.CodeAnalysis.Diagnostics.CompilationStartAnalyzerAction"/> for the given compilation.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerManager.GetPerSymbolAnalyzerActionsAsync(Microsoft.CodeAnalysis.ISymbol,Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer,Microsoft.CodeAnalysis.Diagnostics.AnalyzerExecutor)">
<summary>
Get the per-symbol analyzer actions to be executed by the given analyzer.
These are the actions registered during the various RegisterSymbolStartAction method invocations for the given symbol on different analysis contexts.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerManager.IsConcurrentAnalyzerAsync(Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer,Microsoft.CodeAnalysis.Diagnostics.AnalyzerExecutor)">
<summary>
Returns true if the given analyzer has enabled concurrent execution by invoking <see cref="M:Microsoft.CodeAnalysis.Diagnostics.AnalysisContext.EnableConcurrentExecution"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerManager.GetGeneratedCodeAnalysisFlagsAsync(Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer,Microsoft.CodeAnalysis.Diagnostics.AnalyzerExecutor)">
<summary>
Returns <see cref="T:Microsoft.CodeAnalysis.Diagnostics.GeneratedCodeAnalysisFlags"/> for the given analyzer.
If an analyzer hasn't configured generated code analysis, returns <see cref="F:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver.DefaultGeneratedCodeAnalysisFlags"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerManager.GetSupportedDiagnosticDescriptors(Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer,Microsoft.CodeAnalysis.Diagnostics.AnalyzerExecutor)">
<summary>
Return <see cref="P:Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer.SupportedDiagnostics"/> of given <paramref name="analyzer"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerManager.GetSupportedSuppressionDescriptors(Microsoft.CodeAnalysis.Diagnostics.DiagnosticSuppressor,Microsoft.CodeAnalysis.Diagnostics.AnalyzerExecutor)">
<summary>
Return <see cref="P:Microsoft.CodeAnalysis.Diagnostics.DiagnosticSuppressor.SupportedSuppressions"/> of given <paramref name="suppressor"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerManager.IsDiagnosticAnalyzerSuppressed(Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer,Microsoft.CodeAnalysis.CompilationOptions,System.Func{Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer,System.Boolean},Microsoft.CodeAnalysis.Diagnostics.AnalyzerExecutor,Microsoft.CodeAnalysis.Diagnostics.SeverityFilter)">
<summary>
Returns true if all the diagnostics that can be produced by this analyzer are suppressed through options.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.AnalyzerOptions">
<summary>
Options passed to <see cref="T:Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer"/>.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AnalyzerOptions.AdditionalFiles">
<summary>
A set of additional non-code text files that can be used by analyzers.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AnalyzerOptions.AnalyzerConfigOptionsProvider">
<summary>
A set of options keyed to <see cref="T:Microsoft.CodeAnalysis.SyntaxTree"/> or <see cref="T:Microsoft.CodeAnalysis.AdditionalText"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerOptions.#ctor(System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.AdditionalText},Microsoft.CodeAnalysis.Diagnostics.AnalyzerConfigOptionsProvider)">
<summary>
Creates analyzer options to be passed to <see cref="T:Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer"/>.
</summary>
<param name="additionalFiles">A set of additional non-code text files that can be used by analyzers.</param>
<param name="optionsProvider">A set of per-tree options that can be used by analyzers.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerOptions.#ctor(System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.AdditionalText})">
<summary>
Creates analyzer options to be passed to <see cref="T:Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer"/>.
</summary>
<param name="additionalFiles">A set of additional non-code text files that can be used by analyzers.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerOptions.WithAdditionalFiles(System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.AdditionalText})">
<summary>
Returns analyzer options with the given <paramref name="additionalFiles"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerOptionsExtensions.TryGetSeverityFromBulkConfiguration(Microsoft.CodeAnalysis.Diagnostics.AnalyzerOptions,Microsoft.CodeAnalysis.SyntaxTree,Microsoft.CodeAnalysis.Compilation,Microsoft.CodeAnalysis.DiagnosticDescriptor,System.Threading.CancellationToken,Microsoft.CodeAnalysis.ReportDiagnostic@)">
<summary>
Tries to get configured severity for the given <paramref name="descriptor"/>
for the given <paramref name="tree"/> from bulk configuration analyzer config options, i.e.
'dotnet_analyzer_diagnostic.category-%RuleCategory%.severity = %severity%'
or
'dotnet_analyzer_diagnostic.severity = %severity%'
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.AnalyzerReference">
<summary>
Represents an analyzer assembly reference that contains diagnostic analyzers.
</summary>
<remarks>
Represents a logical location of the analyzer reference, not the content of the reference.
The content might change in time. A snapshot is taken when the compiler queries the reference for its analyzers.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AnalyzerReference.FullPath">
<summary>
Full path describing the location of the analyzer reference, or null if the reference has no location.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AnalyzerReference.Display">
<summary>
Path or name used in error messages to identity the reference.
</summary>
<remarks>
Should not be null.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AnalyzerReference.Id">
<summary>
A unique identifier for this analyzer reference.
</summary>
<remarks>
Should not be null.
Note that this and <see cref="P:Microsoft.CodeAnalysis.Diagnostics.AnalyzerReference.FullPath"/> serve different purposes. An analyzer reference may not
have a path, but it always has an ID. Further, two analyzer references with different paths may
represent two copies of the same analyzer, in which case the IDs should also be the same.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerReference.GetAnalyzersForAllLanguages">
<summary>
Gets all the diagnostic analyzers defined in this assembly reference, irrespective of the language supported by the analyzer.
Use this method only if you need all the analyzers defined in the assembly, without a language context.
In most instances, either the analyzer reference is associated with a project or is being queried for analyzers in a particular language context.
If so, use <see cref="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerReference.GetAnalyzers(System.String)"/> method.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerReference.GetAnalyzers(System.String)">
<summary>
Gets all the diagnostic analyzers defined in this assembly reference for the given <paramref name="language"/>.
</summary>
<param name="language">Language name.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerReference.GetGeneratorsForAllLanguages">
<summary>
Gets all the source generators defined in this assembly reference.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerReference.GetGenerators(System.String)">
<summary>
Gets all the diagnostic generators defined in this assembly reference for the given <paramref name="language"/>.
</summary>
<param name="language">Language name.</param>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.AsyncQueue`1">
<summary>
A queue whose enqueue and dequeue operations can be performed in parallel.
</summary>
<typeparam name="TElement">The type of values kept by the queue.</typeparam>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AsyncQueue`1.Count">
<summary>
The number of unconsumed elements in the queue.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AsyncQueue`1.Enqueue(`0)">
<summary>
Adds an element to the tail of the queue. This method will throw if the queue
is completed.
</summary>
<exception cref="T:System.InvalidOperationException">The queue is already completed.</exception>
<param name="value">The value to add.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AsyncQueue`1.TryEnqueue(`0)">
<summary>
Tries to add an element to the tail of the queue. This method will return false if the queue
is completed.
</summary>
<param name="value">The value to add.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AsyncQueue`1.TryDequeue(`0@)">
<summary>
Attempts to dequeue an existing item and return whether or not it was available.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AsyncQueue`1.IsCompleted">
<summary>
Gets a value indicating whether the queue has completed.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AsyncQueue`1.Complete">
<summary>
Signals that no further elements will be enqueued. All outstanding and future
Dequeue Task will be cancelled.
</summary>
<exception cref="T:System.InvalidOperationException">The queue is already completed.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AsyncQueue`1.TryComplete">
<summary>
Same operation as <see cref="M:Microsoft.CodeAnalysis.Diagnostics.AsyncQueue`1.Complete"/> except it will not
throw if the queue is already completed.
</summary>
<returns>Whether or not the operation succeeded.</returns>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AsyncQueue`1.WhenCompletedTask">
<summary>
Gets a task that transitions to a completed state when <see cref="M:Microsoft.CodeAnalysis.Diagnostics.AsyncQueue`1.Complete"/> or
<see cref="M:Microsoft.CodeAnalysis.Diagnostics.AsyncQueue`1.TryComplete"/> is called. This transition will not happen synchronously.
This Task will not complete until it has completed all existing values returned
from <see cref="M:Microsoft.CodeAnalysis.Diagnostics.AsyncQueue`1.DequeueAsync(System.Threading.CancellationToken)"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AsyncQueue`1.DequeueAsync(System.Threading.CancellationToken)">
<summary>
Gets a task whose result is the element at the head of the queue. If the queue
is empty, the returned task waits for an element to be enqueued. If <see cref="M:Microsoft.CodeAnalysis.Diagnostics.AsyncQueue`1.Complete"/>
is called before an element becomes available, the returned task is cancelled.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AsyncQueue`1.TryDequeueAsync(System.Threading.CancellationToken)">
<summary>
Gets a task whose result is the element at the head of the queue. If the queue
is empty, the returned task waits for an element to be enqueued. If <see cref="M:Microsoft.CodeAnalysis.Diagnostics.AsyncQueue`1.Complete"/>
is called before an element becomes available, the returned task is completed and
<see cref="P:Microsoft.CodeAnalysis.Optional`1.HasValue"/> will be <see langword="false"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AsyncQueue`1.AttachCancellation``1(System.Threading.Tasks.TaskCompletionSource{``0},System.Threading.CancellationToken)">
<summary>
Cancels a <see cref="P:System.Threading.Tasks.TaskCompletionSource`1.Task"/> if a given <see cref="T:System.Threading.CancellationToken"/> is canceled.
</summary>
<typeparam name="T">The type of value returned by a successfully completed <see cref="T:System.Threading.Tasks.Task`1"/>.</typeparam>
<param name="taskCompletionSource">The <see cref="T:System.Threading.Tasks.TaskCompletionSource`1"/> to cancel.</param>
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/>.</param>
<seealso href="https://github.com/microsoft/vs-threading/blob/558f24c576cc620a00b20ed1fa90a5e2d13b0440/src/Microsoft.VisualStudio.Threading/ThreadingTools.cs#L181-L255"/>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.AsyncQueue`1.CancelableTaskCompletionSource`1">
<summary>
A state object for tracking cancellation and a TaskCompletionSource.
</summary>
<typeparam name="T">The type of value returned from a task.</typeparam>
<remarks>
We use this class so that we only allocate one object to support all continuations
required for cancellation handling, rather than a special closure and delegate for each one.
</remarks>
<seealso href="https://github.com/microsoft/vs-threading/blob/558f24c576cc620a00b20ed1fa90a5e2d13b0440/src/Microsoft.VisualStudio.Threading/ThreadingTools.cs#L318-L372"/>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AsyncQueue`1.CancelableTaskCompletionSource`1.#ctor(System.Threading.Tasks.TaskCompletionSource{`1},System.Threading.CancellationToken)">
<summary>
Initializes a new instance of the <see cref="T:Microsoft.CodeAnalysis.Diagnostics.AsyncQueue`1.CancelableTaskCompletionSource`1"/> class.
</summary>
<param name="taskCompletionSource">The task completion source.</param>
<param name="cancellationToken">The cancellation token.</param>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AsyncQueue`1.CancelableTaskCompletionSource`1.CancellationToken">
<summary>
Gets the cancellation token.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AsyncQueue`1.CancelableTaskCompletionSource`1.TaskCompletionSource">
<summary>
Gets the Task completion source.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AsyncQueue`1.CancelableTaskCompletionSource`1.CancellationTokenRegistration">
<summary>
Gets or sets the cancellation token registration.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.CachingSemanticModelProvider">
<summary>
Provider that caches semantic models for requested trees, with a strong reference to the model.
Clients using this provider are responsible for maintaining the lifetime of the entries in this cache,
and should invoke <see cref="M:Microsoft.CodeAnalysis.Diagnostics.CachingSemanticModelProvider.ClearCache(Microsoft.CodeAnalysis.SyntaxTree,Microsoft.CodeAnalysis.Compilation)"/> and <see cref="M:Microsoft.CodeAnalysis.Diagnostics.CachingSemanticModelProvider.ClearCache(Microsoft.CodeAnalysis.Compilation)"/> to clear entries when appropriate.
For example, <see cref="T:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers"/> uses this provider to ensure that semantic model instances
are shared between the compiler and analyzers for improved analyzer execution performance. The underlying
<see cref="T:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver"/> executing analyzers clears per-tree entries in the cache whenever a <see cref="T:Microsoft.CodeAnalysis.Diagnostics.CompilationUnitCompletedEvent"/>
has been processed, indicating all relevant analyzers have executed on the corresponding syntax tree for the event.
Similarly, it clears the entire compilation wide cache whenever a <see cref="T:Microsoft.CodeAnalysis.Diagnostics.CompilationCompletedEvent"/> has been processed,
indicating all relevant analyzers have executed on the entire compilation.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.CompilationAnalysisValueProvider`2">
<summary>
Wrapper over the core <see cref="T:Microsoft.CodeAnalysis.Diagnostics.AnalysisValueProvider`2"/> which holds a strong reference to key-value pairs for the lifetime of a compilation that this provider is associated with.
This ensures that values are never re-computed for equivalent keys while analyzing each compilation, improving overall analyzer performance.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.CompilationCompletedEvent">
<summary>
The last event placed into a compilation's event queue.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.CompilationStartedEvent">
<summary>
The first event placed into a compilation's event queue.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers._driverPool">
<summary>
Pool of <see cref="T:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver"/>s used for analyzer execution.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers._analysisState">
<summary>
Contains the partial analysis state per-analyzer. It tracks:
1. Global set of pending compilation events. This is used to populate the event queue for analyzer execution.
2. Per-analyzer set of pending compilation events, symbols, declarations, etc. Each of these pending entities has a <see cref="T:Microsoft.CodeAnalysis.Diagnostics.AnalysisState.AnalyzerStateData"/> state object to track partial analysis.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers._analysisResultBuilder">
<summary>
Builder for storing current, possibly partial, analysis results:
1. Diagnostics reported by analyzers.
2. AnalyzerTelemetryInfo.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers._exceptionDiagnostics">
<summary>
Set of exception diagnostics reported for exceptions thrown by the analyzers.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers._executingTasksLock">
<summary>
Lock to track the set of active tasks computing tree diagnostics and task computing compilation diagnostics.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers._currentToken">
<summary>
Used to generate a unique token for each tree diagnostics request.
The token is used to determine the priority of each request.
Each new tree diagnostic request gets an incremented token value and has higher priority over other requests for the same tree.
Compilation diagnostics requests always have the lowest priority.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers._concurrentTreeTaskTokensOpt">
<summary>
Map from active tasks computing tree diagnostics to their token number.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers._eventQueuePool">
<summary>
Pool of event queues to serve each diagnostics request.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers.Compilation">
<summary>
Underlying <see cref="P:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers.Compilation"/> with a non-null <see cref="P:Microsoft.CodeAnalysis.Compilation.EventQueue"/>, used to drive analyzer execution.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers.Analyzers">
<summary>
Analyzers to execute on the compilation.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers.AnalysisOptions">
<summary>
Options to configure analyzer execution.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers.CancellationToken">
<summary>
An optional cancellation token which can be used to cancel analysis.
Note: This token is only used if the API invoked to get diagnostics doesn't provide a cancellation token.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers.#ctor(Microsoft.CodeAnalysis.Compilation,System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer},Microsoft.CodeAnalysis.Diagnostics.AnalyzerOptions,System.Threading.CancellationToken)">
<summary>
Creates a new compilation by attaching diagnostic analyzers to an existing compilation.
</summary>
<param name="compilation">The original compilation.</param>
<param name="analyzers">The set of analyzers to include in future analyses.</param>
<param name="options">Options that are passed to analyzers.</param>
<param name="cancellationToken">A cancellation token that can be used to abort analysis.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers.#ctor(Microsoft.CodeAnalysis.Compilation,System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer},Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzersOptions)">
<summary>
Creates a new compilation by attaching diagnostic analyzers to an existing compilation.
</summary>
<param name="compilation">The original compilation.</param>
<param name="analyzers">The set of analyzers to include in future analyses.</param>
<param name="analysisOptions">Options to configure analyzer execution.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers.GetAnalyzerDiagnosticsAsync">
<summary>
Returns diagnostics produced by all <see cref="P:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers.Analyzers"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers.GetAnalyzerDiagnosticsAsync(System.Threading.CancellationToken)">
<summary>
Returns diagnostics produced by all <see cref="P:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers.Analyzers"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers.GetAnalyzerDiagnosticsAsync(System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer},System.Threading.CancellationToken)">
<summary>
Returns diagnostics produced by given <paramref name="analyzers"/>.
</summary>
<param name="analyzers">Analyzers whose diagnostics are required. All the given analyzers must be from the analyzers passed into the constructor of <see cref="T:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers"/>.</param>
<param name="cancellationToken">Cancellation token.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers.GetAnalysisResultAsync(System.Threading.CancellationToken)">
<summary>
Executes all <see cref="P:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers.Analyzers"/> and returns the corresponding <see cref="T:Microsoft.CodeAnalysis.Diagnostics.AnalysisResult"/> with all diagnostics and telemetry info.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers.GetAnalysisResultAsync(System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer},System.Threading.CancellationToken)">
<summary>
Executes the given <paramref name="analyzers"/> and returns the corresponding <see cref="T:Microsoft.CodeAnalysis.Diagnostics.AnalysisResult"/> with all diagnostics and telemetry info.
</summary>
<param name="analyzers">Analyzers whose analysis results are required. All the given analyzers must be from the analyzers passed into the constructor of <see cref="T:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers"/>.</param>
<param name="cancellationToken">Cancellation token.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers.GetAllDiagnosticsAsync">
<summary>
Returns all diagnostics produced by compilation and by all <see cref="P:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers.Analyzers"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers.GetAllDiagnosticsAsync(System.Threading.CancellationToken)">
<summary>
Returns all diagnostics produced by compilation and by all <see cref="P:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers.Analyzers"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers.GetAnalyzerCompilationDiagnosticsAsync(System.Threading.CancellationToken)">
<summary>
Returns diagnostics produced by compilation actions of all <see cref="P:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers.Analyzers"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers.GetAnalyzerCompilationDiagnosticsAsync(System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer},System.Threading.CancellationToken)">
<summary>
Returns diagnostics produced by compilation actions of given <paramref name="analyzers"/>.
</summary>
<param name="analyzers">Analyzers whose diagnostics are required. All the given analyzers must be from the analyzers passed into the constructor of <see cref="T:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers"/>.</param>
<param name="cancellationToken">Cancellation token.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers.GetAnalyzerSyntaxDiagnosticsAsync(Microsoft.CodeAnalysis.SyntaxTree,System.Threading.CancellationToken)">
<summary>
Returns syntax diagnostics produced by all <see cref="P:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers.Analyzers"/> from analyzing the given <paramref name="tree"/>.
Depending on analyzers' behavior, returned diagnostics can have locations outside the tree,
and some diagnostics that would be reported for the tree by an analysis of the complete compilation
can be absent.
</summary>
<param name="tree">Syntax tree to analyze.</param>
<param name="cancellationToken">Cancellation token.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers.GetAnalyzerSyntaxDiagnosticsAsync(Microsoft.CodeAnalysis.SyntaxTree,System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer},System.Threading.CancellationToken)">
<summary>
Returns syntax diagnostics produced by given <paramref name="analyzers"/> from analyzing the given <paramref name="tree"/>.
Depending on analyzers' behavior, returned diagnostics can have locations outside the tree,
and some diagnostics that would be reported for the tree by an analysis of the complete compilation
can be absent.
</summary>
<param name="tree">Syntax tree to analyze.</param>
<param name="analyzers">Analyzers whose diagnostics are required. All the given analyzers must be from the analyzers passed into the constructor of <see cref="T:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers"/>.</param>
<param name="cancellationToken">Cancellation token.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers.GetAnalysisResultAsync(Microsoft.CodeAnalysis.SyntaxTree,System.Threading.CancellationToken)">
<summary>
Returns an <see cref="T:Microsoft.CodeAnalysis.Diagnostics.AnalysisResult"/> populated with <see cref="P:Microsoft.CodeAnalysis.Diagnostics.AnalysisResult.SyntaxDiagnostics"/> produced by all <see cref="P:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers.Analyzers"/> from analyzing the given <paramref name="tree"/>.
Depending on analyzers' behavior, some diagnostics that would be reported for the tree by an analysis of the complete compilation can be absent.
</summary>
<param name="tree">Syntax tree to analyze.</param>
<param name="cancellationToken">Cancellation token.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers.GetAnalysisResultAsync(Microsoft.CodeAnalysis.SyntaxTree,System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer},System.Threading.CancellationToken)">
<summary>
Returns an <see cref="T:Microsoft.CodeAnalysis.Diagnostics.AnalysisResult"/> populated with <see cref="P:Microsoft.CodeAnalysis.Diagnostics.AnalysisResult.SyntaxDiagnostics"/> produced by given <paramref name="analyzers"/> from analyzing the given <paramref name="tree"/>.
Depending on analyzers' behavior, some diagnostics that would be reported for the tree by an analysis of the complete compilation can be absent.
</summary>
<param name="tree">Syntax tree to analyze.</param>
<param name="analyzers">Analyzers whose diagnostics are required. All the given analyzers must be from the analyzers passed into the constructor of <see cref="T:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers"/>.</param>
<param name="cancellationToken">Cancellation token.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers.GetAnalysisResultAsync(Microsoft.CodeAnalysis.AdditionalText,System.Threading.CancellationToken)">
<summary>
Returns an <see cref="T:Microsoft.CodeAnalysis.Diagnostics.AnalysisResult"/> populated with <see cref="P:Microsoft.CodeAnalysis.Diagnostics.AnalysisResult.AdditionalFileDiagnostics"/> produced by all <see cref="P:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers.Analyzers"/> from analyzing the given additional <paramref name="file"/>.
The given <paramref name="file"/> must be part of <see cref="P:Microsoft.CodeAnalysis.Diagnostics.AnalyzerOptions.AdditionalFiles"/> for the <see cref="P:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers.AnalysisOptions"/> for this CompilationWithAnalyzers instance.
Depending on analyzers' behavior, some diagnostics that would be reported for the file by an analysis of the complete compilation can be absent.
</summary>
<param name="file">Additional file to analyze.</param>
<param name="cancellationToken">Cancellation token.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers.GetAnalysisResultAsync(Microsoft.CodeAnalysis.AdditionalText,System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer},System.Threading.CancellationToken)">
<summary>
Returns an <see cref="T:Microsoft.CodeAnalysis.Diagnostics.AnalysisResult"/> populated with <see cref="P:Microsoft.CodeAnalysis.Diagnostics.AnalysisResult.AdditionalFileDiagnostics"/> produced by given <paramref name="analyzers"/> from analyzing the given additional <paramref name="file"/>.
The given <paramref name="file"/> must be part of <see cref="P:Microsoft.CodeAnalysis.Diagnostics.AnalyzerOptions.AdditionalFiles"/> for the <see cref="P:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers.AnalysisOptions"/> for this CompilationWithAnalyzers instance.
Depending on analyzers' behavior, some diagnostics that would be reported for the file by an analysis of the complete compilation can be absent.
</summary>
<param name="file">Additional file to analyze.</param>
<param name="analyzers">Analyzers whose diagnostics are required. All the given analyzers must be from the analyzers passed into the constructor of <see cref="T:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers"/>.</param>
<param name="cancellationToken">Cancellation token.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers.GetAnalyzerSemanticDiagnosticsAsync(Microsoft.CodeAnalysis.SemanticModel,System.Nullable{Microsoft.CodeAnalysis.Text.TextSpan},System.Threading.CancellationToken)">
<summary>
Returns semantic diagnostics produced by all <see cref="P:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers.Analyzers"/> from analyzing the given <paramref name="model"/>, optionally scoped to a <paramref name="filterSpan"/>.
Depending on analyzers' behavior, some diagnostics that would be reported for the tree by an analysis of the complete compilation can be absent.
</summary>
<param name="model">Semantic model representing the syntax tree to analyze.</param>
<param name="filterSpan">An optional span within the tree to scope analysis.</param>
<param name="cancellationToken">Cancellation token.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers.GetAnalyzerSemanticDiagnosticsAsync(Microsoft.CodeAnalysis.SemanticModel,System.Nullable{Microsoft.CodeAnalysis.Text.TextSpan},System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer},System.Threading.CancellationToken)">
<summary>
Returns semantic diagnostics produced by the given <paramref name="analyzers"/> from analyzing the given <paramref name="model"/>, optionally scoped to a <paramref name="filterSpan"/>.
Depending on analyzers' behavior, some diagnostics that would be reported for the tree by an analysis of the complete compilation can be absent.
</summary>
<param name="model">Semantic model representing the syntax tree to analyze.</param>
<param name="filterSpan">An optional span within the tree to scope analysis.</param>
<param name="analyzers">Analyzers whose diagnostics are required. All the given analyzers must be from the analyzers passed into the constructor of <see cref="T:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers"/>.</param>
<param name="cancellationToken">Cancellation token.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers.GetAnalysisResultAsync(Microsoft.CodeAnalysis.SemanticModel,System.Nullable{Microsoft.CodeAnalysis.Text.TextSpan},System.Threading.CancellationToken)">
<summary>
Returns an <see cref="T:Microsoft.CodeAnalysis.Diagnostics.AnalysisResult"/> populated with <see cref="P:Microsoft.CodeAnalysis.Diagnostics.AnalysisResult.SemanticDiagnostics"/> produced by all <see cref="P:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers.Analyzers"/> from analyzing the given <paramref name="model"/>, optionally scoped to a <paramref name="filterSpan"/>.
Depending on analyzers' behavior, some diagnostics that would be reported for the tree by an analysis of the complete compilation can be absent.
</summary>
<param name="model">Semantic model representing the syntax tree to analyze.</param>
<param name="filterSpan">An optional span within the tree to scope analysis.</param>
<param name="cancellationToken">Cancellation token.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers.GetAnalysisResultAsync(Microsoft.CodeAnalysis.SemanticModel,System.Nullable{Microsoft.CodeAnalysis.Text.TextSpan},System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer},System.Threading.CancellationToken)">
<summary>
Returns an <see cref="T:Microsoft.CodeAnalysis.Diagnostics.AnalysisResult"/> populated with <see cref="P:Microsoft.CodeAnalysis.Diagnostics.AnalysisResult.SemanticDiagnostics"/> produced by the given <paramref name="analyzers"/> from analyzing the given <paramref name="model"/>, optionally scoped to a <paramref name="filterSpan"/>.
Depending on analyzers' behavior, some diagnostics that would be reported for the tree by an analysis of the complete compilation can be absent.
</summary>
<param name="model">Semantic model representing the syntax tree to analyze.</param>
<param name="filterSpan">An optional span within the tree to scope analysis.</param>
<param name="analyzers">Analyzers whose diagnostics are required. All the given analyzers must be from the analyzers passed into the constructor of <see cref="T:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers"/>.</param>
<param name="cancellationToken">Cancellation token.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers.ComputeAnalyzerDiagnosticsCoreAsync(Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver,Microsoft.CodeAnalysis.Diagnostics.AsyncQueue{Microsoft.CodeAnalysis.Diagnostics.CompilationEvent},Microsoft.CodeAnalysis.Diagnostics.AnalysisScope,System.Threading.CancellationToken)">
<summary>
Core method for executing analyzers.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers.GetEffectiveDiagnostics(System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.Diagnostic},Microsoft.CodeAnalysis.Compilation)">
<summary>
Given a set of compiler or <see cref="T:Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer"/> generated <paramref name="diagnostics"/>, returns the effective diagnostics after applying the below filters:
1) <see cref="P:Microsoft.CodeAnalysis.CompilationOptions.SpecificDiagnosticOptions"/> specified for the given <paramref name="compilation"/>.
2) <see cref="P:Microsoft.CodeAnalysis.CompilationOptions.GeneralDiagnosticOption"/> specified for the given <paramref name="compilation"/>.
3) Diagnostic suppression through applied <see cref="T:System.Diagnostics.CodeAnalysis.SuppressMessageAttribute"/>.
4) Pragma directives for the given <paramref name="compilation"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers.GetEffectiveDiagnostics(System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.Diagnostic},Microsoft.CodeAnalysis.Compilation)">
<summary>
Given a set of compiler or <see cref="T:Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer"/> generated <paramref name="diagnostics"/>, returns the effective diagnostics after applying the below filters:
1) <see cref="P:Microsoft.CodeAnalysis.CompilationOptions.SpecificDiagnosticOptions"/> specified for the given <paramref name="compilation"/>.
2) <see cref="P:Microsoft.CodeAnalysis.CompilationOptions.GeneralDiagnosticOption"/> specified for the given <paramref name="compilation"/>.
3) Diagnostic suppression through applied <see cref="T:System.Diagnostics.CodeAnalysis.SuppressMessageAttribute"/>.
4) Pragma directives for the given <paramref name="compilation"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers.IsDiagnosticAnalyzerSuppressed(Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer,Microsoft.CodeAnalysis.CompilationOptions,System.Action{System.Exception,Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer,Microsoft.CodeAnalysis.Diagnostic})">
<summary>
Returns true if all the diagnostics that can be produced by this analyzer are suppressed through options.
<param name="analyzer">Analyzer to be checked for suppression.</param>
<param name="options">Compilation options.</param>
<param name="onAnalyzerException">
Optional delegate which is invoked when an analyzer throws an exception.
Delegate can do custom tasks such as report the given analyzer exception diagnostic, report a non-fatal watson for the exception, etc.
</param>
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers.ClearAnalyzerState(System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer})">
<summary>
This method should be invoked when the analyzer host is disposing off the given <paramref name="analyzers"/>.
It clears the cached internal state (supported descriptors, registered actions, exception handlers, etc.) for analyzers.
</summary>
<param name="analyzers">Analyzers whose state needs to be cleared.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers.GetAnalyzerTelemetryInfoAsync(Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer,System.Threading.CancellationToken)">
<summary>
Gets telemetry info for the given analyzer, such as count of registered actions, the total execution time (if <see cref="P:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzersOptions.LogAnalyzerExecutionTime"/> is true), etc.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers.GetAnalyzerActionCountsAsync(Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer,System.Threading.CancellationToken)">
<summary>
Gets the count of registered actions for the analyzer.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers.GetAnalyzerExecutionTime(Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer)">
<summary>
Gets the execution time for the given analyzer.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzersOptions">
<summary>
Options to configure analyzer execution within <see cref="T:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers"/>.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzersOptions.Options">
<summary>
Options passed to <see cref="T:Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer"/>s.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzersOptions.OnAnalyzerException">
<summary>
An optional delegate to be invoked when an analyzer throws an exception.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzersOptions.AnalyzerExceptionFilter">
<summary>
An optional delegate to be invoked when an analyzer throws an exception as an exception filter.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzersOptions.ConcurrentAnalysis">
<summary>
Flag indicating whether analysis can be performed concurrently on multiple threads.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzersOptions.LogAnalyzerExecutionTime">
<summary>
Flag indicating whether analyzer execution time should be logged.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzersOptions.ReportSuppressedDiagnostics">
<summary>
Flag indicating whether analyzer diagnostics with <see cref="P:Microsoft.CodeAnalysis.Diagnostic.IsSuppressed"/> should be reported.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzersOptions.#ctor(Microsoft.CodeAnalysis.Diagnostics.AnalyzerOptions,System.Action{System.Exception,Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer,Microsoft.CodeAnalysis.Diagnostic},System.Boolean,System.Boolean)">
<summary>
Creates a new <see cref="T:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzersOptions"/>.
</summary>
<param name="options">Options that are passed to analyzers.</param>
<param name="onAnalyzerException">Action to invoke if an analyzer throws an exception.</param>
<param name="concurrentAnalysis">Flag indicating whether analysis can be performed concurrently on multiple threads.</param>
<param name="logAnalyzerExecutionTime">Flag indicating whether analyzer execution time should be logged.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzersOptions.#ctor(Microsoft.CodeAnalysis.Diagnostics.AnalyzerOptions,System.Action{System.Exception,Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer,Microsoft.CodeAnalysis.Diagnostic},System.Boolean,System.Boolean,System.Boolean)">
<summary>
Creates a new <see cref="T:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzersOptions"/>.
</summary>
<param name="options">Options that are passed to analyzers.</param>
<param name="onAnalyzerException">Action to invoke if an analyzer throws an exception.</param>
<param name="concurrentAnalysis">Flag indicating whether analysis can be performed concurrently on multiple threads.</param>
<param name="logAnalyzerExecutionTime">Flag indicating whether analyzer execution time should be logged.</param>
<param name="reportSuppressedDiagnostics">Flag indicating whether analyzer diagnostics with <see cref="P:Microsoft.CodeAnalysis.Diagnostic.IsSuppressed"/> should be reported.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzersOptions.#ctor(Microsoft.CodeAnalysis.Diagnostics.AnalyzerOptions,System.Action{System.Exception,Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer,Microsoft.CodeAnalysis.Diagnostic},System.Boolean,System.Boolean,System.Boolean,System.Func{System.Exception,System.Boolean})">
<summary>
Creates a new <see cref="T:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzersOptions"/>.
</summary>
<param name="options">Options that are passed to analyzers.</param>
<param name="onAnalyzerException">Action to invoke if an analyzer throws an exception.</param>
<param name="analyzerExceptionFilter">Action to invoke if an analyzer throws an exception as an exception filter.</param>
<param name="concurrentAnalysis">Flag indicating whether analysis can be performed concurrently on multiple threads.</param>
<param name="logAnalyzerExecutionTime">Flag indicating whether analyzer execution time should be logged.</param>
<param name="reportSuppressedDiagnostics">Flag indicating whether analyzer diagnostics with <see cref="P:Microsoft.CodeAnalysis.Diagnostic.IsSuppressed"/> should be reported.</param>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.CompilerDiagnosticAnalyzer">
<summary>
DiagnosticAnalyzer for compiler's syntax/semantic/compilation diagnostics.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.CompilerDiagnosticAnalyzer.CompilationAnalyzer">
<summary>
Per-compilation DiagnosticAnalyzer for compiler's syntax/semantic/compilation diagnostics.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.AnalysisContext">
<summary>
Context for initializing an analyzer.
Analyzer initialization can use an <see cref="T:Microsoft.CodeAnalysis.Diagnostics.AnalysisContext"/> to register actions to be executed at any of:
<list type="bullet">
<item>
<description>compilation start,</description>
</item>
<item>
<description>compilation end,</description>
</item>
<item>
<description>completion of parsing a code document,</description>
</item>
<item>
<description>completion of semantic analysis of a code document,</description>
</item>
<item>
<description>completion of semantic analysis of a symbol,</description>
</item>
<item>
<description>start of semantic analysis of a method body or an expression appearing outside a method body,</description>
</item>
<item>
<description>completion of semantic analysis of a method body or an expression appearing outside a method body, or</description>
</item>
<item>
<description>completion of semantic analysis of a syntax node.</description>
</item>
</list>
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalysisContext.RegisterCompilationStartAction(System.Action{Microsoft.CodeAnalysis.Diagnostics.CompilationStartAnalysisContext})">
<summary>
Register an action to be executed at compilation start.
A compilation start action can register other actions and/or collect state information to be used in diagnostic analysis,
but cannot itself report any <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s.
</summary>
<param name="action">Action to be executed at compilation start.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalysisContext.RegisterCompilationAction(System.Action{Microsoft.CodeAnalysis.Diagnostics.CompilationAnalysisContext})">
<summary>
Register an action to be executed for a complete compilation.
A compilation action reports <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s about the <see cref="T:Microsoft.CodeAnalysis.Compilation"/>.
</summary>
<param name="action">Action to be executed at compilation end.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalysisContext.RegisterSemanticModelAction(System.Action{Microsoft.CodeAnalysis.Diagnostics.SemanticModelAnalysisContext})">
<summary>
Register an action to be executed at completion of semantic analysis of a document,
which will operate on the <see cref="T:Microsoft.CodeAnalysis.SemanticModel"/> of the document. A semantic model action
reports <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s about the model.
</summary>
<param name="action">Action to be executed for a document's <see cref="T:Microsoft.CodeAnalysis.SemanticModel"/>.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalysisContext.RegisterSymbolAction(System.Action{Microsoft.CodeAnalysis.Diagnostics.SymbolAnalysisContext},Microsoft.CodeAnalysis.SymbolKind[])">
<summary>
Register an action to be executed at completion of semantic analysis of an <see cref="T:Microsoft.CodeAnalysis.ISymbol"/> with an appropriate Kind.
A symbol action reports <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s about <see cref="T:Microsoft.CodeAnalysis.ISymbol"/>s.
</summary>
<param name="action">Action to be executed for an <see cref="T:Microsoft.CodeAnalysis.ISymbol"/>.</param>
<param name="symbolKinds">Action will be executed only if an <see cref="T:Microsoft.CodeAnalysis.ISymbol"/>'s Kind matches one of the <see cref="T:Microsoft.CodeAnalysis.SymbolKind"/> values.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalysisContext.RegisterSymbolAction(System.Action{Microsoft.CodeAnalysis.Diagnostics.SymbolAnalysisContext},System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.SymbolKind})">
<summary>
Register an action to be executed at completion of semantic analysis of an <see cref="T:Microsoft.CodeAnalysis.ISymbol"/> with an appropriate Kind.
A symbol action reports <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s about <see cref="T:Microsoft.CodeAnalysis.ISymbol"/>s.
</summary>
<param name="action">Action to be executed for an <see cref="T:Microsoft.CodeAnalysis.ISymbol"/>.</param>
<param name="symbolKinds">Action will be executed only if an <see cref="T:Microsoft.CodeAnalysis.ISymbol"/>'s Kind matches one of the <see cref="T:Microsoft.CodeAnalysis.SymbolKind"/> values.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalysisContext.RegisterSymbolStartAction(System.Action{Microsoft.CodeAnalysis.Diagnostics.SymbolStartAnalysisContext},Microsoft.CodeAnalysis.SymbolKind)">
<summary>
Register an action to be executed at start of semantic analysis of an <see cref="T:Microsoft.CodeAnalysis.ISymbol"/> and its members with an appropriate Kind.
</summary>
<param name="action">Action to be executed.</param>
<param name="symbolKind">Action will be executed only if an <see cref="T:Microsoft.CodeAnalysis.ISymbol"/>'s Kind matches the given <see cref="T:Microsoft.CodeAnalysis.SymbolKind"/>.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalysisContext.RegisterCodeBlockStartAction``1(System.Action{Microsoft.CodeAnalysis.Diagnostics.CodeBlockStartAnalysisContext{``0}})">
<summary>
Register an action to be executed at the start of semantic analysis of a method body or an expression appearing outside a method body.
A code block start action can register other actions and/or collect state information to be used in diagnostic analysis,
but cannot itself report any <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s.
</summary>
<typeparam name="TLanguageKindEnum">Enum type giving the syntax node kinds of the source language for which the action applies.</typeparam>
<param name="action">Action to be executed at the start of semantic analysis of a code block.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalysisContext.RegisterCodeBlockAction(System.Action{Microsoft.CodeAnalysis.Diagnostics.CodeBlockAnalysisContext})">
<summary>
Register an action to be executed after semantic analysis of a method body or an expression appearing outside a method body.
A code block action reports <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s about code blocks.
</summary>
<param name="action">Action to be executed for a code block.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalysisContext.RegisterSyntaxTreeAction(System.Action{Microsoft.CodeAnalysis.Diagnostics.SyntaxTreeAnalysisContext})">
<summary>
Register an action to be executed at completion of parsing of a code document.
A syntax tree action reports <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s about the <see cref="T:Microsoft.CodeAnalysis.SyntaxTree"/> of a document.
</summary>
<param name="action">Action to be executed at completion of parsing of a document.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalysisContext.RegisterAdditionalFileAction(System.Action{Microsoft.CodeAnalysis.Diagnostics.AdditionalFileAnalysisContext})">
<summary>
Register an action to be executed for each non-code document.
An additional file action reports <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s about the <see cref="T:Microsoft.CodeAnalysis.AdditionalText"/> of a document.
</summary>
<param name="action">Action to be executed for each non-code document.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalysisContext.RegisterSyntaxNodeAction``1(System.Action{Microsoft.CodeAnalysis.Diagnostics.SyntaxNodeAnalysisContext},``0[])">
<summary>
Register an action to be executed at completion of semantic analysis of a <see cref="T:Microsoft.CodeAnalysis.SyntaxNode"/> with an appropriate Kind.
A syntax node action can report <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s about <see cref="T:Microsoft.CodeAnalysis.SyntaxNode"/>s, and can also collect
state information to be used by other syntax node actions or code block end actions.
</summary>
<typeparam name="TLanguageKindEnum">Enum type giving the syntax node kinds of the source language for which the action applies.</typeparam>
<param name="action">Action to be executed at completion of semantic analysis of a <see cref="T:Microsoft.CodeAnalysis.SyntaxNode"/>.</param>
<param name="syntaxKinds">Action will be executed only if a <see cref="T:Microsoft.CodeAnalysis.SyntaxNode"/>'s Kind matches one of the syntax kind values.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalysisContext.RegisterSyntaxNodeAction``1(System.Action{Microsoft.CodeAnalysis.Diagnostics.SyntaxNodeAnalysisContext},System.Collections.Immutable.ImmutableArray{``0})">
<summary>
Register an action to be executed at completion of semantic analysis of a <see cref="T:Microsoft.CodeAnalysis.SyntaxNode"/> with an appropriate Kind.
A syntax node action can report <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s about <see cref="T:Microsoft.CodeAnalysis.SyntaxNode"/>s, and can also collect
state information to be used by other syntax node actions or code block end actions.
</summary>
<typeparam name="TLanguageKindEnum">Enum type giving the syntax node kinds of the source language for which the action applies.</typeparam>
<param name="action">Action to be executed at completion of semantic analysis of a <see cref="T:Microsoft.CodeAnalysis.SyntaxNode"/>.</param>
<param name="syntaxKinds">Action will be executed only if a <see cref="T:Microsoft.CodeAnalysis.SyntaxNode"/>'s Kind matches one of the syntax kind values.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalysisContext.RegisterOperationBlockStartAction(System.Action{Microsoft.CodeAnalysis.Diagnostics.OperationBlockStartAnalysisContext})">
<summary>
Register an action to be executed at the start of semantic analysis of a method body or an expression appearing outside a method body.
An operation block start action can register other actions and/or collect state information to be used in diagnostic analysis,
but cannot itself report any <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s.
</summary>
<param name="action">Action to be executed at the start of semantic analysis of an operation block.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalysisContext.RegisterOperationBlockAction(System.Action{Microsoft.CodeAnalysis.Diagnostics.OperationBlockAnalysisContext})">
<summary>
Register an action to be executed after semantic analysis of a method body or an expression appearing outside a method body.
An operation block action reports <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s about operation blocks.
</summary>
<param name="action">Action to be executed for an operation block.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalysisContext.RegisterOperationAction(System.Action{Microsoft.CodeAnalysis.Diagnostics.OperationAnalysisContext},Microsoft.CodeAnalysis.OperationKind[])">
<summary>
Register an action to be executed at completion of semantic analysis of an <see cref="T:Microsoft.CodeAnalysis.IOperation"/> with an appropriate Kind.
An operation action can report <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s about <see cref="T:Microsoft.CodeAnalysis.IOperation"/>s, and can also collect
state information to be used by other operation actions or code block end actions.
</summary>
<param name="action">Action to be executed at completion of semantic analysis of an <see cref="T:Microsoft.CodeAnalysis.IOperation"/>.</param>
<param name="operationKinds">Action will be executed only if an <see cref="T:Microsoft.CodeAnalysis.IOperation"/>'s Kind matches one of the operation kind values.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalysisContext.RegisterOperationAction(System.Action{Microsoft.CodeAnalysis.Diagnostics.OperationAnalysisContext},System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.OperationKind})">
<summary>
Register an action to be executed at completion of semantic analysis of an <see cref="T:Microsoft.CodeAnalysis.IOperation"/> with an appropriate Kind.
An operation action can report <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s about <see cref="T:Microsoft.CodeAnalysis.IOperation"/>s, and can also collect
state information to be used by other operation actions or code block end actions.
</summary>
<param name="action">Action to be executed at completion of semantic analysis of an <see cref="T:Microsoft.CodeAnalysis.IOperation"/>.</param>
<param name="operationKinds">Action will be executed only if an <see cref="T:Microsoft.CodeAnalysis.IOperation"/>'s Kind matches one of the operation kind values.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalysisContext.EnableConcurrentExecution">
<summary>
Enable concurrent execution of analyzer actions registered by this analyzer.
An analyzer that registers for concurrent execution can have better performance than a non-concurrent analyzer.
However, such an analyzer must ensure that its actions can execute correctly in parallel.
</summary>
<remarks>
Even when an analyzer registers for concurrent execution, certain related actions are *never* executed concurrently.
For example, end actions registered on any analysis unit (compilation, code block, operation block, etc.) are by definition semantically dependent on analysis from non-end actions registered on the same analysis unit.
Hence, end actions are never executed concurrently with non-end actions operating on the same analysis unit.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalysisContext.ConfigureGeneratedCodeAnalysis(Microsoft.CodeAnalysis.Diagnostics.GeneratedCodeAnalysisFlags)">
<summary>
Configure analysis mode of generated code for this analyzer.
Non-configured analyzers will default to an appropriate default mode for generated code.
It is recommended for the analyzer to invoke this API with the required <see cref="T:Microsoft.CodeAnalysis.Diagnostics.GeneratedCodeAnalysisFlags"/> setting.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalysisContext.TryGetValue``1(Microsoft.CodeAnalysis.Text.SourceText,Microsoft.CodeAnalysis.Diagnostics.SourceTextValueProvider{``0},``0@)">
<summary>
Attempts to compute or get the cached value provided by the given <paramref name="valueProvider"/> for the given <paramref name="text"/>.
Note that the pair {<paramref name="valueProvider"/>, <paramref name="text"/>} acts as the key.
Reusing the same <paramref name="valueProvider"/> instance across analyzer actions and/or analyzer instances can improve the overall analyzer performance by avoiding recomputation of the values.
</summary>
<typeparam name="TValue">The type of the value associated with the key.</typeparam>
<param name="text"><see cref="T:Microsoft.CodeAnalysis.Text.SourceText"/> for which the value is queried.</param>
<param name="valueProvider">Provider that computes the underlying value.</param>
<param name="value">Value associated with the key.</param>
<returns>Returns true on success, false otherwise.</returns>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.GeneratedCodeAnalysisFlags">
<summary>
Flags to configure mode of generated code analysis.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Diagnostics.GeneratedCodeAnalysisFlags.None">
<summary>
Disable analyzer action callbacks and diagnostic reporting for generated code.
Analyzer driver will not make callbacks into the analyzer for entities (source files, symbols, etc.) that it classifies as generated code.
Additionally, any diagnostic reported by the analyzer with location in generated code will not be reported.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Diagnostics.GeneratedCodeAnalysisFlags.Analyze">
<summary>
Enable analyzer action callbacks for generated code.
Analyzer driver will make callbacks into the analyzer for all entities (source files, symbols, etc.) in the compilation, including generated code.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Diagnostics.GeneratedCodeAnalysisFlags.ReportDiagnostics">
<summary>
Enable reporting diagnostics on generated code.
Analyzer driver will not suppress any analyzer diagnostic based on whether or not it's location is in generated code.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.CompilationStartAnalysisContext">
<summary>
Context for a compilation start action.
A compilation start action can use a <see cref="T:Microsoft.CodeAnalysis.Diagnostics.CompilationStartAnalysisContext"/> to register actions to be executed at any of:
<list type="bullet">
<item>
<description>compilation end,</description>
</item>
<item>
<description>completion of parsing a code document,</description>
</item>
<item>
<description>completion of semantic analysis of a code document,</description>
</item>
<item>
<description>completion of semantic analysis of a symbol,</description>
</item>
<item>
<description>start of semantic analysis of a method body or an expression appearing outside a method body,</description>
</item>
<item>
<description>completion of semantic analysis of a method body or an expression appearing outside a method body, or</description>
</item>
<item>
<description>completion of semantic analysis of a syntax node.</description>
</item>
</list>
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.CompilationStartAnalysisContext.Compilation">
<summary>
<see cref="T:Microsoft.CodeAnalysis.Compilation"/> that is the subject of the analysis.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.CompilationStartAnalysisContext.Options">
<summary>
Options specified for the analysis.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.CompilationStartAnalysisContext.CancellationToken">
<summary>
Token to check for requested cancellation of the analysis.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CompilationStartAnalysisContext.RegisterCompilationEndAction(System.Action{Microsoft.CodeAnalysis.Diagnostics.CompilationAnalysisContext})">
<summary>
Register an action to be executed at compilation end.
A compilation end action reports <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s about the <see cref="T:Microsoft.CodeAnalysis.Compilation"/>.
</summary>
<param name="action">Action to be executed at compilation end.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CompilationStartAnalysisContext.RegisterSemanticModelAction(System.Action{Microsoft.CodeAnalysis.Diagnostics.SemanticModelAnalysisContext})">
<summary>
Register an action to be executed at completion of semantic analysis of a document,
which will operate on the <see cref="T:Microsoft.CodeAnalysis.SemanticModel"/> of the document. A semantic model action
reports <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s about the model.
</summary>
<param name="action">Action to be executed for a document's <see cref="T:Microsoft.CodeAnalysis.SemanticModel"/>.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CompilationStartAnalysisContext.RegisterSymbolAction(System.Action{Microsoft.CodeAnalysis.Diagnostics.SymbolAnalysisContext},Microsoft.CodeAnalysis.SymbolKind[])">
<summary>
Register an action to be executed at completion of semantic analysis of an <see cref="T:Microsoft.CodeAnalysis.ISymbol"/> with an appropriate Kind.
A symbol action reports <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s about <see cref="T:Microsoft.CodeAnalysis.ISymbol"/>s.
</summary>
<param name="action">Action to be executed for an <see cref="T:Microsoft.CodeAnalysis.ISymbol"/>.</param>
<param name="symbolKinds">Action will be executed only if an <see cref="T:Microsoft.CodeAnalysis.ISymbol"/>'s Kind matches one of the <see cref="T:Microsoft.CodeAnalysis.SymbolKind"/> values.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CompilationStartAnalysisContext.RegisterSymbolAction(System.Action{Microsoft.CodeAnalysis.Diagnostics.SymbolAnalysisContext},System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.SymbolKind})">
<summary>
Register an action to be executed at completion of semantic analysis of an <see cref="T:Microsoft.CodeAnalysis.ISymbol"/> with an appropriate Kind.
A symbol action reports <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s about <see cref="T:Microsoft.CodeAnalysis.ISymbol"/>s.
</summary>
<param name="action">Action to be executed for an <see cref="T:Microsoft.CodeAnalysis.ISymbol"/>.</param>
<param name="symbolKinds">Action will be executed only if an <see cref="T:Microsoft.CodeAnalysis.ISymbol"/>'s Kind matches one of the <see cref="T:Microsoft.CodeAnalysis.SymbolKind"/> values.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CompilationStartAnalysisContext.RegisterSymbolStartAction(System.Action{Microsoft.CodeAnalysis.Diagnostics.SymbolStartAnalysisContext},Microsoft.CodeAnalysis.SymbolKind)">
<summary>
Register an action to be executed at start of semantic analysis of an <see cref="T:Microsoft.CodeAnalysis.ISymbol"/> and its members with an appropriate Kind.
</summary>
<param name="action">Action to be executed.</param>
<param name="symbolKind">Action will be executed only if an <see cref="T:Microsoft.CodeAnalysis.ISymbol"/>'s Kind matches the given <see cref="T:Microsoft.CodeAnalysis.SymbolKind"/>.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CompilationStartAnalysisContext.RegisterCodeBlockStartAction``1(System.Action{Microsoft.CodeAnalysis.Diagnostics.CodeBlockStartAnalysisContext{``0}})">
<summary>
Register an action to be executed at the start of semantic analysis of a method body or an expression appearing outside a method body.
A code block start action can register other actions and/or collect state information to be used in diagnostic analysis,
but cannot itself report any <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s.
</summary>
<typeparam name="TLanguageKindEnum">Enum type giving the syntax node kinds of the source language for which the action applies.</typeparam>
<param name="action">Action to be executed at the start of semantic analysis of a code block.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CompilationStartAnalysisContext.RegisterCodeBlockAction(System.Action{Microsoft.CodeAnalysis.Diagnostics.CodeBlockAnalysisContext})">
<summary>
Register an action to be executed at the end of semantic analysis of a method body or an expression appearing outside a method body.
A code block action reports <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s about code blocks.
</summary>
<param name="action">Action to be executed for a code block.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CompilationStartAnalysisContext.RegisterOperationBlockStartAction(System.Action{Microsoft.CodeAnalysis.Diagnostics.OperationBlockStartAnalysisContext})">
<summary>
Register an action to be executed at the start of semantic analysis of a method body or an expression appearing outside a method body.
An operation block start action can register other actions and/or collect state information to be used in diagnostic analysis,
but cannot itself report any <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s.
</summary>
<param name="action">Action to be executed at the start of semantic analysis of an operation block.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CompilationStartAnalysisContext.RegisterOperationBlockAction(System.Action{Microsoft.CodeAnalysis.Diagnostics.OperationBlockAnalysisContext})">
<summary>
Register an action to be executed after semantic analysis of a method body or an expression appearing outside a method body.
An operation block action reports <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s about operation blocks.
</summary>
<param name="action">Action to be executed for an operation block.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CompilationStartAnalysisContext.RegisterSyntaxTreeAction(System.Action{Microsoft.CodeAnalysis.Diagnostics.SyntaxTreeAnalysisContext})">
<summary>
Register an action to be executed at completion of parsing of a code document.
A syntax tree action reports <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s about the <see cref="T:Microsoft.CodeAnalysis.SyntaxTree"/> of a document.
</summary>
<param name="action">Action to be executed at completion of parsing of a document.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CompilationStartAnalysisContext.RegisterAdditionalFileAction(System.Action{Microsoft.CodeAnalysis.Diagnostics.AdditionalFileAnalysisContext})">
<summary>
Register an action to be executed for each non-code document.
An additional file action reports <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s about the <see cref="T:Microsoft.CodeAnalysis.AdditionalText"/> of a document.
</summary>
<param name="action">Action to be executed for each non-code document.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CompilationStartAnalysisContext.RegisterSyntaxNodeAction``1(System.Action{Microsoft.CodeAnalysis.Diagnostics.SyntaxNodeAnalysisContext},``0[])">
<summary>
Register an action to be executed at completion of semantic analysis of a <see cref="T:Microsoft.CodeAnalysis.SyntaxNode"/> with an appropriate Kind.
A syntax node action can report <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s about <see cref="T:Microsoft.CodeAnalysis.SyntaxNode"/>s, and can also collect
state information to be used by other syntax node actions or code block end actions.
</summary>
<typeparam name="TLanguageKindEnum">Enum type giving the syntax node kinds of the source language for which the action applies.</typeparam>
<param name="action">Action to be executed at completion of semantic analysis of a <see cref="T:Microsoft.CodeAnalysis.SyntaxNode"/>.</param>
<param name="syntaxKinds">Action will be executed only if a <see cref="T:Microsoft.CodeAnalysis.SyntaxNode"/>'s Kind matches one of the syntax kind values.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CompilationStartAnalysisContext.RegisterSyntaxNodeAction``1(System.Action{Microsoft.CodeAnalysis.Diagnostics.SyntaxNodeAnalysisContext},System.Collections.Immutable.ImmutableArray{``0})">
<summary>
Register an action to be executed at completion of semantic analysis of a <see cref="T:Microsoft.CodeAnalysis.SyntaxNode"/> with an appropriate Kind.
A syntax node action can report <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s about <see cref="T:Microsoft.CodeAnalysis.SyntaxNode"/>s, and can also collect
state information to be used by other syntax node actions or code block end actions.
</summary>
<typeparam name="TLanguageKindEnum">Enum type giving the syntax node kinds of the source language for which the action applies.</typeparam>
<param name="action">Action to be executed at completion of semantic analysis of a <see cref="T:Microsoft.CodeAnalysis.SyntaxNode"/>.</param>
<param name="syntaxKinds">Action will be executed only if a <see cref="T:Microsoft.CodeAnalysis.SyntaxNode"/>'s Kind matches one of the syntax kind values.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CompilationStartAnalysisContext.RegisterOperationAction(System.Action{Microsoft.CodeAnalysis.Diagnostics.OperationAnalysisContext},Microsoft.CodeAnalysis.OperationKind[])">
<summary>
Register an action to be executed at completion of semantic analysis of an <see cref="T:Microsoft.CodeAnalysis.IOperation"/> with an appropriate Kind.
An operation action can report <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s about <see cref="T:Microsoft.CodeAnalysis.IOperation"/>s, and can also collect
state information to be used by other operation actions or code block end actions.
</summary>
<param name="action">Action to be executed at completion of semantic analysis of an <see cref="T:Microsoft.CodeAnalysis.IOperation"/>.</param>
<param name="operationKinds">Action will be executed only if an <see cref="T:Microsoft.CodeAnalysis.IOperation"/>'s Kind matches one of the operation kind values.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CompilationStartAnalysisContext.RegisterOperationAction(System.Action{Microsoft.CodeAnalysis.Diagnostics.OperationAnalysisContext},System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.OperationKind})">
<summary>
Register an action to be executed at completion of semantic analysis of an <see cref="T:Microsoft.CodeAnalysis.IOperation"/> with an appropriate Kind.
An operation action can report <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s about <see cref="T:Microsoft.CodeAnalysis.IOperation"/>s, and can also collect
state information to be used by other operation actions or code block end actions.
</summary>
<param name="action">Action to be executed at completion of semantic analysis of an <see cref="T:Microsoft.CodeAnalysis.IOperation"/>.</param>
<param name="operationKinds">Action will be executed only if an <see cref="T:Microsoft.CodeAnalysis.IOperation"/>'s Kind matches one of the operation kind values.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CompilationStartAnalysisContext.TryGetValue``1(Microsoft.CodeAnalysis.Text.SourceText,Microsoft.CodeAnalysis.Diagnostics.SourceTextValueProvider{``0},``0@)">
<summary>
Attempts to compute or get the cached value provided by the given <paramref name="valueProvider"/> for the given <paramref name="text"/>.
Note that the pair {<paramref name="valueProvider"/>, <paramref name="text"/>} acts as the key.
Reusing the same <paramref name="valueProvider"/> instance across analyzer actions and/or analyzer instances can improve the overall analyzer performance by avoiding recomputation of the values.
</summary>
<typeparam name="TValue">The type of the value associated with the key.</typeparam>
<param name="text"><see cref="T:Microsoft.CodeAnalysis.Text.SourceText"/> for which the value is queried.</param>
<param name="valueProvider">Provider that computes the underlying value.</param>
<param name="value">Value associated with the key.</param>
<returns>Returns true on success, false otherwise.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CompilationStartAnalysisContext.TryGetValue``1(Microsoft.CodeAnalysis.SyntaxTree,Microsoft.CodeAnalysis.Diagnostics.SyntaxTreeValueProvider{``0},``0@)">
<summary>
Attempts to compute or get the cached value provided by the given <paramref name="valueProvider"/> for the given <paramref name="tree"/>.
Note that the pair {<paramref name="valueProvider"/>, <paramref name="tree"/>} acts as the key.
Reusing the same <paramref name="valueProvider"/> instance across analyzer actions and/or analyzer instances can improve the overall analyzer performance by avoiding recomputation of the values.
</summary>
<typeparam name="TValue">The type of the value associated with the key.</typeparam>
<param name="tree"><see cref="T:Microsoft.CodeAnalysis.SyntaxTree"/> instance for which the value is queried.</param>
<param name="valueProvider">Provider that computes the underlying value.</param>
<param name="value">Value associated with the key.</param>
<returns>Returns true on success, false otherwise.</returns>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.CompilationAnalysisContext">
<summary>
Context for a compilation action or compilation end action.
A compilation action or compilation end action can use a <see cref="T:Microsoft.CodeAnalysis.Diagnostics.CompilationAnalysisContext"/> to report <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s about a <see cref="T:Microsoft.CodeAnalysis.Compilation"/>.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.CompilationAnalysisContext.Compilation">
<summary>
<see cref="T:Microsoft.CodeAnalysis.Compilation"/> that is the subject of the analysis.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.CompilationAnalysisContext.Options">
<summary>
Options specified for the analysis.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.CompilationAnalysisContext.CancellationToken">
<summary>
Token to check for requested cancellation of the analysis.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CompilationAnalysisContext.ReportDiagnostic(Microsoft.CodeAnalysis.Diagnostic)">
<summary>
Report a <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/> about a <see cref="T:Microsoft.CodeAnalysis.Compilation"/>.
</summary>
<param name="diagnostic"><see cref="T:Microsoft.CodeAnalysis.Diagnostic"/> to be reported.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CompilationAnalysisContext.TryGetValue``1(Microsoft.CodeAnalysis.Text.SourceText,Microsoft.CodeAnalysis.Diagnostics.SourceTextValueProvider{``0},``0@)">
<summary>
Attempts to compute or get the cached value provided by the given <paramref name="valueProvider"/> for the given <paramref name="text"/>.
Note that the pair {<paramref name="valueProvider"/>, <paramref name="text"/>} acts as the key.
Reusing the same <paramref name="valueProvider"/> instance across analyzer actions and/or analyzer instances can improve the overall analyzer performance by avoiding recomputation of the values.
</summary>
<typeparam name="TValue">The type of the value associated with the key.</typeparam>
<param name="text"><see cref="T:Microsoft.CodeAnalysis.Text.SourceText"/> for which the value is queried.</param>
<param name="valueProvider">Provider that computes the underlying value.</param>
<param name="value">Value associated with the key.</param>
<returns>Returns true on success, false otherwise.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CompilationAnalysisContext.TryGetValue``1(Microsoft.CodeAnalysis.SyntaxTree,Microsoft.CodeAnalysis.Diagnostics.SyntaxTreeValueProvider{``0},``0@)">
<summary>
Attempts to compute or get the cached value provided by the given <paramref name="valueProvider"/> for the given <paramref name="tree"/>.
Note that the pair {<paramref name="valueProvider"/>, <paramref name="tree"/>} acts as the key.
Reusing the same <paramref name="valueProvider"/> instance across analyzer actions and/or analyzer instances can improve the overall analyzer performance by avoiding recomputation of the values.
</summary>
<typeparam name="TValue">The type of the value associated with the key.</typeparam>
<param name="tree"><see cref="T:Microsoft.CodeAnalysis.SyntaxTree"/> for which the value is queried.</param>
<param name="valueProvider">Provider that computes the underlying value.</param>
<param name="value">Value associated with the key.</param>
<returns>Returns true on success, false otherwise.</returns>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.SemanticModelAnalysisContext">
<summary>
Context for a semantic model action.
A semantic model action operates on the <see cref="T:Microsoft.CodeAnalysis.SemanticModel"/> of a code document, and can use a <see cref="T:Microsoft.CodeAnalysis.Diagnostics.SemanticModelAnalysisContext"/> to report <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s about the model.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.SemanticModelAnalysisContext.SemanticModel">
<summary>
<see cref="T:Microsoft.CodeAnalysis.SemanticModel"/> that is the subject of the analysis.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.SemanticModelAnalysisContext.Options">
<summary>
Options specified for the analysis.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.SemanticModelAnalysisContext.CancellationToken">
<summary>
Token to check for requested cancellation of the analysis.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.SemanticModelAnalysisContext.ReportDiagnostic(Microsoft.CodeAnalysis.Diagnostic)">
<summary>
Report a <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/> about a <see cref="T:Microsoft.CodeAnalysis.SemanticModel"/>.
</summary>
<param name="diagnostic"><see cref="T:Microsoft.CodeAnalysis.Diagnostic"/> to be reported.</param>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.SymbolAnalysisContext">
<summary>
Context for a symbol action.
A symbol action can use a <see cref="T:Microsoft.CodeAnalysis.Diagnostics.SymbolAnalysisContext"/> to report <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s about an <see cref="T:Microsoft.CodeAnalysis.ISymbol"/>.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.SymbolAnalysisContext.Symbol">
<summary>
<see cref="T:Microsoft.CodeAnalysis.ISymbol"/> that is the subject of the analysis.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.SymbolAnalysisContext.Compilation">
<summary>
<see cref="T:Microsoft.CodeAnalysis.Compilation"/> containing the <see cref="T:Microsoft.CodeAnalysis.ISymbol"/>.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.SymbolAnalysisContext.Options">
<summary>
Options specified for the analysis.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.SymbolAnalysisContext.CancellationToken">
<summary>
Token to check for requested cancellation of the analysis.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.SymbolAnalysisContext.ReportDiagnostic(Microsoft.CodeAnalysis.Diagnostic)">
<summary>
Report a <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/> about an <see cref="T:Microsoft.CodeAnalysis.ISymbol"/>.
</summary>
<param name="diagnostic"><see cref="T:Microsoft.CodeAnalysis.Diagnostic"/> to be reported.</param>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.SymbolStartAnalysisContext">
<summary>
Context for a symbol start action to analyze a symbol and its members.
A symbol start/end action can use a <see cref="T:Microsoft.CodeAnalysis.Diagnostics.SymbolStartAnalysisContext"/> to report <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s about code within a <see cref="T:Microsoft.CodeAnalysis.ISymbol"/> and its members.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.SymbolStartAnalysisContext.Symbol">
<summary>
<see cref="T:Microsoft.CodeAnalysis.ISymbol"/> that is the subject of the analysis.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.SymbolStartAnalysisContext.Compilation">
<summary>
<see cref="T:Microsoft.CodeAnalysis.Compilation"/> containing the <see cref="T:Microsoft.CodeAnalysis.ISymbol"/>.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.SymbolStartAnalysisContext.Options">
<summary>
Options specified for the analysis.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.SymbolStartAnalysisContext.CancellationToken">
<summary>
Token to check for requested cancellation of the analysis.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.SymbolStartAnalysisContext.RegisterSymbolEndAction(System.Action{Microsoft.CodeAnalysis.Diagnostics.SymbolAnalysisContext})">
<summary>
Register an action to be executed at end of semantic analysis of an <see cref="T:Microsoft.CodeAnalysis.ISymbol"/> and its members.
A symbol end action reports <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s about the code within a <see cref="P:Microsoft.CodeAnalysis.Diagnostics.SymbolStartAnalysisContext.Symbol"/> and its members.
</summary>
<param name="action">Action to be executed at compilation end.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.SymbolStartAnalysisContext.RegisterCodeBlockStartAction``1(System.Action{Microsoft.CodeAnalysis.Diagnostics.CodeBlockStartAnalysisContext{``0}})">
<summary>
Register an action to be executed at the start of semantic analysis of a method body or an expression appearing outside a method body.
A code block start action can register other actions and/or collect state information to be used in diagnostic analysis,
but cannot itself report any <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s.
</summary>
<typeparam name="TLanguageKindEnum">Enum type giving the syntax node kinds of the source language for which the action applies.</typeparam>
<param name="action">Action to be executed at the start of semantic analysis of a code block.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.SymbolStartAnalysisContext.RegisterCodeBlockAction(System.Action{Microsoft.CodeAnalysis.Diagnostics.CodeBlockAnalysisContext})">
<summary>
Register an action to be executed after semantic analysis of a method body or an expression appearing outside a method body.
A code block action reports <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s about code blocks.
</summary>
<param name="action">Action to be executed for a code block.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.SymbolStartAnalysisContext.RegisterSyntaxNodeAction``1(System.Action{Microsoft.CodeAnalysis.Diagnostics.SyntaxNodeAnalysisContext},``0[])">
<summary>
Register an action to be executed at completion of semantic analysis of a <see cref="T:Microsoft.CodeAnalysis.SyntaxNode"/> with an appropriate Kind.
A syntax node action can report <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s about <see cref="T:Microsoft.CodeAnalysis.SyntaxNode"/>s, and can also collect
state information to be used by other syntax node actions or code block end actions.
</summary>
<typeparam name="TLanguageKindEnum">Enum type giving the syntax node kinds of the source language for which the action applies.</typeparam>
<param name="action">Action to be executed at completion of semantic analysis of a <see cref="T:Microsoft.CodeAnalysis.SyntaxNode"/>.</param>
<param name="syntaxKinds">Action will be executed only if a <see cref="T:Microsoft.CodeAnalysis.SyntaxNode"/>'s Kind matches one of the syntax kind values.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.SymbolStartAnalysisContext.RegisterSyntaxNodeAction``1(System.Action{Microsoft.CodeAnalysis.Diagnostics.SyntaxNodeAnalysisContext},System.Collections.Immutable.ImmutableArray{``0})">
<summary>
Register an action to be executed at completion of semantic analysis of a <see cref="T:Microsoft.CodeAnalysis.SyntaxNode"/> with an appropriate Kind.
A syntax node action can report <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s about <see cref="T:Microsoft.CodeAnalysis.SyntaxNode"/>s, and can also collect
state information to be used by other syntax node actions or code block end actions.
</summary>
<typeparam name="TLanguageKindEnum">Enum type giving the syntax node kinds of the source language for which the action applies.</typeparam>
<param name="action">Action to be executed at completion of semantic analysis of a <see cref="T:Microsoft.CodeAnalysis.SyntaxNode"/>.</param>
<param name="syntaxKinds">Action will be executed only if a <see cref="T:Microsoft.CodeAnalysis.SyntaxNode"/>'s Kind matches one of the syntax kind values.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.SymbolStartAnalysisContext.RegisterOperationBlockStartAction(System.Action{Microsoft.CodeAnalysis.Diagnostics.OperationBlockStartAnalysisContext})">
<summary>
Register an action to be executed at the start of semantic analysis of a method body or an expression appearing outside a method body.
An operation block start action can register other actions and/or collect state information to be used in diagnostic analysis,
but cannot itself report any <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s.
</summary>
<param name="action">Action to be executed at the start of semantic analysis of an operation block.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.SymbolStartAnalysisContext.RegisterOperationBlockAction(System.Action{Microsoft.CodeAnalysis.Diagnostics.OperationBlockAnalysisContext})">
<summary>
Register an action to be executed after semantic analysis of a method body or an expression appearing outside a method body.
An operation block action reports <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s about operation blocks.
</summary>
<param name="action">Action to be executed for an operation block.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.SymbolStartAnalysisContext.RegisterOperationAction(System.Action{Microsoft.CodeAnalysis.Diagnostics.OperationAnalysisContext},Microsoft.CodeAnalysis.OperationKind[])">
<summary>
Register an action to be executed at completion of semantic analysis of an <see cref="T:Microsoft.CodeAnalysis.IOperation"/> with an appropriate Kind.
An operation action can report <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s about <see cref="T:Microsoft.CodeAnalysis.IOperation"/>s, and can also collect
state information to be used by other operation actions or code block end actions.
</summary>
<param name="action">Action to be executed at completion of semantic analysis of an <see cref="T:Microsoft.CodeAnalysis.IOperation"/>.</param>
<param name="operationKinds">Action will be executed only if an <see cref="T:Microsoft.CodeAnalysis.IOperation"/>'s Kind matches one of the operation kind values.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.SymbolStartAnalysisContext.RegisterOperationAction(System.Action{Microsoft.CodeAnalysis.Diagnostics.OperationAnalysisContext},System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.OperationKind})">
<summary>
Register an action to be executed at completion of semantic analysis of an <see cref="T:Microsoft.CodeAnalysis.IOperation"/> with an appropriate Kind.
An operation action can report <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s about <see cref="T:Microsoft.CodeAnalysis.IOperation"/>s, and can also collect
state information to be used by other operation actions or code block end actions.
</summary>
<param name="action">Action to be executed at completion of semantic analysis of an <see cref="T:Microsoft.CodeAnalysis.IOperation"/>.</param>
<param name="operationKinds">Action will be executed only if an <see cref="T:Microsoft.CodeAnalysis.IOperation"/>'s Kind matches one of the operation kind values.</param>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.CodeBlockStartAnalysisContext`1">
<summary>
Context for a code block start action.
A code block start action can use a <see cref="T:Microsoft.CodeAnalysis.Diagnostics.CodeBlockStartAnalysisContext`1"/> to register actions to be executed
at any of:
<list type="bullet">
<item>
<description>completion of semantic analysis of a method body or an expression appearing outside a method body, or</description>
</item>
<item>
<description>completion of semantic analysis of a syntax node.</description>
</item>
</list>
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.CodeBlockStartAnalysisContext`1.CodeBlock">
<summary>
Method body or expression subject to analysis.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.CodeBlockStartAnalysisContext`1.OwningSymbol">
<summary>
<see cref="T:Microsoft.CodeAnalysis.ISymbol"/> for which the code block provides a definition or value.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.CodeBlockStartAnalysisContext`1.SemanticModel">
<summary>
<see cref="T:Microsoft.CodeAnalysis.SemanticModel"/> that can provide semantic information about the <see cref="T:Microsoft.CodeAnalysis.SyntaxNode"/>s in the code block.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.CodeBlockStartAnalysisContext`1.Options">
<summary>
Options specified for the analysis.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.CodeBlockStartAnalysisContext`1.CancellationToken">
<summary>
Token to check for requested cancellation of the analysis.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CodeBlockStartAnalysisContext`1.RegisterCodeBlockEndAction(System.Action{Microsoft.CodeAnalysis.Diagnostics.CodeBlockAnalysisContext})">
<summary>
Register an action to be executed at the end of semantic analysis of a method body or an expression appearing outside a method body.
A code block end action reports <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s about code blocks.
</summary>
<param name="action">Action to be executed at the end of semantic analysis of a code block.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CodeBlockStartAnalysisContext`1.RegisterSyntaxNodeAction(System.Action{Microsoft.CodeAnalysis.Diagnostics.SyntaxNodeAnalysisContext},`0[])">
<summary>
Register an action to be executed at completion of semantic analysis of a <see cref="T:Microsoft.CodeAnalysis.SyntaxNode"/> with an appropriate Kind.
A syntax node action can report <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s about <see cref="T:Microsoft.CodeAnalysis.SyntaxNode"/>s, and can also collect
state information to be used by other syntax node actions or code block end actions.
</summary>
<param name="action">Action to be executed at completion of semantic analysis of a <see cref="T:Microsoft.CodeAnalysis.SyntaxNode"/>.</param>
<param name="syntaxKinds">Action will be executed only if a <see cref="T:Microsoft.CodeAnalysis.SyntaxNode"/>'s Kind matches one of the syntax kind values.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CodeBlockStartAnalysisContext`1.RegisterSyntaxNodeAction(System.Action{Microsoft.CodeAnalysis.Diagnostics.SyntaxNodeAnalysisContext},System.Collections.Immutable.ImmutableArray{`0})">
<summary>
Register an action to be executed at completion of semantic analysis of a <see cref="T:Microsoft.CodeAnalysis.SyntaxNode"/> with an appropriate Kind.
A syntax node action can report <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s about <see cref="T:Microsoft.CodeAnalysis.SyntaxNode"/>s, and can also collect
state information to be used by other syntax node actions or code block end actions.
</summary>
<param name="action">Action to be executed at completion of semantic analysis of a <see cref="T:Microsoft.CodeAnalysis.SyntaxNode"/>.</param>
<param name="syntaxKinds">Action will be executed only if a <see cref="T:Microsoft.CodeAnalysis.SyntaxNode"/>'s Kind matches one of the syntax kind values.</param>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.CodeBlockAnalysisContext">
<summary>
Context for a code block action or code block end action.
A code block action or code block end action can use a <see cref="T:Microsoft.CodeAnalysis.Diagnostics.CodeBlockAnalysisContext"/> to report <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s about a code block.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.CodeBlockAnalysisContext.CodeBlock">
<summary>
Code block that is the subject of the analysis.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.CodeBlockAnalysisContext.OwningSymbol">
<summary>
<see cref="T:Microsoft.CodeAnalysis.ISymbol"/> for which the code block provides a definition or value.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.CodeBlockAnalysisContext.SemanticModel">
<summary>
<see cref="T:Microsoft.CodeAnalysis.SemanticModel"/> that can provide semantic information about the <see cref="T:Microsoft.CodeAnalysis.SyntaxNode"/>s in the code block.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.CodeBlockAnalysisContext.Options">
<summary>
Options specified for the analysis.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.CodeBlockAnalysisContext.CancellationToken">
<summary>
Token to check for requested cancellation of the analysis.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.CodeBlockAnalysisContext.ReportDiagnostic(Microsoft.CodeAnalysis.Diagnostic)">
<summary>
Report a <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/> about a code block.
</summary>
<param name="diagnostic"><see cref="T:Microsoft.CodeAnalysis.Diagnostic"/> to be reported.</param>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.OperationBlockStartAnalysisContext">
<summary>
Context for an operation block start action.
An operation block start action can use an <see cref="T:Microsoft.CodeAnalysis.Diagnostics.OperationBlockStartAnalysisContext"/> to register actions to be executed
at any of:
<list type="bullet">
<item>
<description>completion of semantic analysis of a method body or an expression appearing outside a method body, or</description>
</item>
<item>
<description>completion of semantic analysis of an operation.</description>
</item>
</list>
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.OperationBlockStartAnalysisContext.OperationBlocks">
<summary>
One or more operation blocks that are the subject of the analysis.
This includes all blocks associated with the <see cref="P:Microsoft.CodeAnalysis.Diagnostics.OperationBlockStartAnalysisContext.OwningSymbol"/>,
such as method body, field/property/constructor/parameter initializer(s), attributes, etc.
</summary>
<remarks>Note that the operation blocks are not in any specific order.</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.OperationBlockStartAnalysisContext.OwningSymbol">
<summary>
<see cref="T:Microsoft.CodeAnalysis.ISymbol"/> for which the <see cref="P:Microsoft.CodeAnalysis.Diagnostics.OperationBlockStartAnalysisContext.OperationBlocks"/> provides a definition or value.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.OperationBlockStartAnalysisContext.Compilation">
<summary>
<see cref="T:Microsoft.CodeAnalysis.Compilation"/> containing the <see cref="P:Microsoft.CodeAnalysis.Diagnostics.OperationBlockStartAnalysisContext.OperationBlocks"/>.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.OperationBlockStartAnalysisContext.Options">
<summary>
Options specified for the analysis.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.OperationBlockStartAnalysisContext.CancellationToken">
<summary>
Token to check for requested cancellation of the analysis.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.OperationBlockStartAnalysisContext.RegisterOperationBlockEndAction(System.Action{Microsoft.CodeAnalysis.Diagnostics.OperationBlockAnalysisContext})">
<summary>
Register an action to be executed at the end of semantic analysis of a method body or an expression appearing outside a method body.
A code block end action reports <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s about code blocks.
</summary>
<param name="action">Action to be executed at the end of semantic analysis of a code block.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.OperationBlockStartAnalysisContext.RegisterOperationAction(System.Action{Microsoft.CodeAnalysis.Diagnostics.OperationAnalysisContext},Microsoft.CodeAnalysis.OperationKind[])">
<summary>
Register an action to be executed at completion of semantic analysis of an operation with an appropriate Kind.
An operation action can report <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s about <see cref="T:Microsoft.CodeAnalysis.IOperation"/>s, and can also collect
state information to be used by other operation actions or operation block end actions.
</summary>
<param name="action">Action to be executed at completion of semantic analysis of an <see cref="T:Microsoft.CodeAnalysis.IOperation"/>.</param>
<param name="operationKinds">Action will be executed only if an <see cref="T:Microsoft.CodeAnalysis.IOperation"/>'s Kind matches one of the operation kind values.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.OperationBlockStartAnalysisContext.RegisterOperationAction(System.Action{Microsoft.CodeAnalysis.Diagnostics.OperationAnalysisContext},System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.OperationKind})">
<summary>
Register an action to be executed at completion of semantic analysis of an <see cref="T:Microsoft.CodeAnalysis.IOperation"/> with an appropriate Kind.
An operation action can report <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s about <see cref="T:Microsoft.CodeAnalysis.IOperation"/>s, and can also collect
state information to be used by other operation actions or operation block end actions.
</summary>
<param name="action">Action to be executed at completion of semantic analysis of an <see cref="T:Microsoft.CodeAnalysis.IOperation"/>.</param>
<param name="operationKinds">Action will be executed only if an <see cref="T:Microsoft.CodeAnalysis.IOperation"/>'s Kind matches one of the operation kind values.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.OperationBlockStartAnalysisContext.GetControlFlowGraph(Microsoft.CodeAnalysis.IOperation)">
<summary>
Gets a <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraph"/> for a given <paramref name="operationBlock"/> from this analysis context's <see cref="P:Microsoft.CodeAnalysis.Diagnostics.OperationBlockStartAnalysisContext.OperationBlocks"/>.
</summary>
<param name="operationBlock">Operation block.</param>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.OperationBlockAnalysisContext">
<summary>
Context for an operation block action or operation block end action.
An operation block action or operation block end action can use an <see cref="T:Microsoft.CodeAnalysis.Diagnostics.OperationAnalysisContext"/> to report <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s about an operation block.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.OperationBlockAnalysisContext.OperationBlocks">
<summary>
One or more operation blocks that are the subject of the analysis.
This includes all blocks associated with the <see cref="P:Microsoft.CodeAnalysis.Diagnostics.OperationBlockAnalysisContext.OwningSymbol"/>,
such as method body, field/property/constructor/parameter initializer(s), attributes, etc.
</summary>
<remarks>Note that the operation blocks are not in any specific order.</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.OperationBlockAnalysisContext.OwningSymbol">
<summary>
<see cref="T:Microsoft.CodeAnalysis.ISymbol"/> for which the <see cref="P:Microsoft.CodeAnalysis.Diagnostics.OperationBlockAnalysisContext.OperationBlocks"/> provides a definition or value.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.OperationBlockAnalysisContext.Compilation">
<summary>
<see cref="T:Microsoft.CodeAnalysis.Compilation"/> containing the <see cref="P:Microsoft.CodeAnalysis.Diagnostics.OperationBlockAnalysisContext.OperationBlocks"/>.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.OperationBlockAnalysisContext.Options">
<summary>
Options specified for the analysis.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.OperationBlockAnalysisContext.CancellationToken">
<summary>
Token to check for requested cancellation of the analysis.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.OperationBlockAnalysisContext.ReportDiagnostic(Microsoft.CodeAnalysis.Diagnostic)">
<summary>
Report a <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/> about a code block.
</summary>
<param name="diagnostic"><see cref="T:Microsoft.CodeAnalysis.Diagnostic"/> to be reported.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.OperationBlockAnalysisContext.GetControlFlowGraph(Microsoft.CodeAnalysis.IOperation)">
<summary>
Gets a <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraph"/> for a given <paramref name="operationBlock"/> from this analysis context's <see cref="P:Microsoft.CodeAnalysis.Diagnostics.OperationBlockAnalysisContext.OperationBlocks"/>.
</summary>
<param name="operationBlock">Operation block.</param>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.SyntaxTreeAnalysisContext">
<summary>
Context for a syntax tree action.
A syntax tree action can use a <see cref="T:Microsoft.CodeAnalysis.Diagnostics.SyntaxTreeAnalysisContext"/> to report <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s about a <see cref="T:Microsoft.CodeAnalysis.SyntaxTree"/> for a code document.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.SyntaxTreeAnalysisContext.Tree">
<summary>
<see cref="T:Microsoft.CodeAnalysis.SyntaxTree"/> that is the subject of the analysis.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.SyntaxTreeAnalysisContext.Options">
<summary>
Options specified for the analysis.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.SyntaxTreeAnalysisContext.CancellationToken">
<summary>
Token to check for requested cancellation of the analysis.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.SyntaxTreeAnalysisContext.ReportDiagnostic(Microsoft.CodeAnalysis.Diagnostic)">
<summary>
Report a <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/> about a <see cref="T:Microsoft.CodeAnalysis.SyntaxTree"/>.
</summary>
<param name="diagnostic"><see cref="T:Microsoft.CodeAnalysis.Diagnostic"/> to be reported.</param>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.AdditionalFileAnalysisContext">
<summary>
Context for an additional file action.
An additional file action can use an <see cref="T:Microsoft.CodeAnalysis.Diagnostics.AdditionalFileAnalysisContext"/> to report <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s about a non-source <see cref="T:Microsoft.CodeAnalysis.AdditionalText"/> document.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AdditionalFileAnalysisContext.AdditionalFile">
<summary>
<see cref="T:Microsoft.CodeAnalysis.AdditionalText"/> that is the subject of the analysis.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AdditionalFileAnalysisContext.Options">
<summary>
Options specified for the analysis.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AdditionalFileAnalysisContext.CancellationToken">
<summary>
Token to check for requested cancellation of the analysis.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.AdditionalFileAnalysisContext.Compilation">
<summary>
Compilation being analyzed.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AdditionalFileAnalysisContext.ReportDiagnostic(Microsoft.CodeAnalysis.Diagnostic)">
<summary>
Report a diagnostic for the given <see cref="P:Microsoft.CodeAnalysis.Diagnostics.AdditionalFileAnalysisContext.AdditionalFile"/>.
A diagnostic in a non-source document should be created with a non-source <see cref="T:Microsoft.CodeAnalysis.Location"/>,
which can be created using <see cref="M:Microsoft.CodeAnalysis.Location.Create(System.String,Microsoft.CodeAnalysis.Text.TextSpan,Microsoft.CodeAnalysis.Text.LinePositionSpan)"/> API.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.SyntaxNodeAnalysisContext">
<summary>
Context for a syntax node action.
A syntax node action can use a <see cref="T:Microsoft.CodeAnalysis.Diagnostics.SyntaxNodeAnalysisContext"/> to report <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s for a <see cref="T:Microsoft.CodeAnalysis.SyntaxNode"/>.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.SyntaxNodeAnalysisContext.Node">
<summary>
<see cref="T:Microsoft.CodeAnalysis.SyntaxNode"/> that is the subject of the analysis.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.SyntaxNodeAnalysisContext.ContainingSymbol">
<summary>
<see cref="T:Microsoft.CodeAnalysis.ISymbol"/> for the declaration containing the syntax node.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.SyntaxNodeAnalysisContext.SemanticModel">
<summary>
<see cref="T:Microsoft.CodeAnalysis.SemanticModel"/> that can provide semantic information about the <see cref="T:Microsoft.CodeAnalysis.SyntaxNode"/>.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.SyntaxNodeAnalysisContext.Compilation">
<summary>
<see cref="T:Microsoft.CodeAnalysis.Compilation"/> containing the <see cref="T:Microsoft.CodeAnalysis.SyntaxNode"/>.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.SyntaxNodeAnalysisContext.Options">
<summary>
Options specified for the analysis.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.SyntaxNodeAnalysisContext.CancellationToken">
<summary>
Token to check for requested cancellation of the analysis.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.SyntaxNodeAnalysisContext.ReportDiagnostic(Microsoft.CodeAnalysis.Diagnostic)">
<summary>
Report a <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/> about a <see cref="T:Microsoft.CodeAnalysis.SyntaxNode"/>.
</summary>
<param name="diagnostic"><see cref="T:Microsoft.CodeAnalysis.Diagnostic"/> to be reported.</param>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.OperationAnalysisContext">
<summary>
Context for an operation action.
An operation action can use an <see cref="T:Microsoft.CodeAnalysis.Diagnostics.OperationAnalysisContext"/> to report <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s for an <see cref="T:Microsoft.CodeAnalysis.IOperation"/>.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.OperationAnalysisContext.Operation">
<summary>
<see cref="T:Microsoft.CodeAnalysis.IOperation"/> that is the subject of the analysis.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.OperationAnalysisContext.ContainingSymbol">
<summary>
<see cref="T:Microsoft.CodeAnalysis.ISymbol"/> for the declaration containing the operation.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.OperationAnalysisContext.Compilation">
<summary>
<see cref="T:Microsoft.CodeAnalysis.Compilation"/> containing the <see cref="T:Microsoft.CodeAnalysis.IOperation"/>.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.OperationAnalysisContext.Options">
<summary>
Options specified for the analysis.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.OperationAnalysisContext.CancellationToken">
<summary>
Token to check for requested cancellation of the analysis.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.OperationAnalysisContext.ReportDiagnostic(Microsoft.CodeAnalysis.Diagnostic)">
<summary>
Report a <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/> about a <see cref="T:Microsoft.CodeAnalysis.SyntaxNode"/>.
</summary>
<param name="diagnostic"><see cref="T:Microsoft.CodeAnalysis.Diagnostic"/> to be reported.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.OperationAnalysisContext.GetControlFlowGraph">
<summary>
Gets a <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraph"/> for the operation block containing the <see cref="P:Microsoft.CodeAnalysis.Diagnostics.OperationAnalysisContext.Operation"/>.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.SuppressionAnalysisContext">
<summary>
Context for suppressing analyzer and/or compiler non-error diagnostics reported for the compilation.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.SuppressionAnalysisContext.ReportedDiagnostics">
<summary>
Analyzer and/or compiler non-error diagnostics reported for the compilation.
Each <see cref="T:Microsoft.CodeAnalysis.Diagnostics.DiagnosticSuppressor"/> only receives diagnostics whose IDs were declared suppressible in its <see cref="P:Microsoft.CodeAnalysis.Diagnostics.DiagnosticSuppressor.SupportedSuppressions"/>.
This may be a subset of the full set of reported diagnostics, as an optimization for
supporting incremental and partial analysis scenarios.
A diagnostic is considered suppressible by a DiagnosticSuppressor if *all* of the following conditions are met:
1. Diagnostic is not already suppressed in source via pragma/suppress message attribute.
2. Diagnostic's <see cref="P:Microsoft.CodeAnalysis.Diagnostic.DefaultSeverity"/> is not <see cref="F:Microsoft.CodeAnalysis.DiagnosticSeverity.Error"/>.
3. Diagnostic is not tagged with <see cref="F:Microsoft.CodeAnalysis.WellKnownDiagnosticTags.NotConfigurable"/> custom tag.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.SuppressionAnalysisContext.Compilation">
<summary>
<see cref="T:Microsoft.CodeAnalysis.Compilation"/> for the context.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.SuppressionAnalysisContext.Options">
<summary>
Options specified for the analysis.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.SuppressionAnalysisContext.CancellationToken">
<summary>
Token to check for requested cancellation of the analysis.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.SuppressionAnalysisContext.ReportSuppression(Microsoft.CodeAnalysis.Diagnostics.Suppression)">
<summary>
Report a <see cref="T:Microsoft.CodeAnalysis.Diagnostics.Suppression"/> for a reported diagnostic.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.SuppressionAnalysisContext.GetSemanticModel(Microsoft.CodeAnalysis.SyntaxTree)">
<summary>
Gets a <see cref="T:Microsoft.CodeAnalysis.SemanticModel"/> for the given <see cref="T:Microsoft.CodeAnalysis.SyntaxTree"/>, which is shared across all analyzers.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer">
<summary>
The base type for diagnostic analyzers.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer.SupportedDiagnostics">
<summary>
Returns a set of descriptors for the diagnostics that this analyzer is capable of producing.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer.Initialize(Microsoft.CodeAnalysis.Diagnostics.AnalysisContext)">
<summary>
Called once at session start to register actions in the analysis context.
</summary>
<param name="context"></param>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzerAttribute">
<summary>
Place this attribute onto a type to cause it to be considered a diagnostic analyzer.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzerAttribute.Languages">
<summary>
The source languages to which this analyzer applies. See <see cref="T:Microsoft.CodeAnalysis.LanguageNames"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzerAttribute.#ctor(System.String,System.String[])">
<summary>
Attribute constructor used to specify automatic application of a diagnostic analyzer.
</summary>
<param name="firstLanguage">One language to which the analyzer applies.</param>
<param name="additionalLanguages">Additional languages to which the analyzer applies. See <see cref="T:Microsoft.CodeAnalysis.LanguageNames"/>.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzerExtensions.WithAnalyzers(Microsoft.CodeAnalysis.Compilation,System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer},Microsoft.CodeAnalysis.Diagnostics.AnalyzerOptions,System.Threading.CancellationToken)">
<summary>
Returns a new compilation with attached diagnostic analyzers.
</summary>
<param name="compilation">Compilation to which analyzers are to be added.</param>
<param name="analyzers">The set of analyzers to include in future analyses.</param>
<param name="options">Options that are passed to analyzers.</param>
<param name="cancellationToken">A cancellation token that can be used to abort analysis.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzerExtensions.WithAnalyzers(Microsoft.CodeAnalysis.Compilation,System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer},Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzersOptions)">
<summary>
Returns a new compilation with attached diagnostic analyzers.
</summary>
<param name="compilation">Compilation to which analyzers are to be added.</param>
<param name="analyzers">The set of analyzers to include in future analyses.</param>
<param name="analysisOptions">Options to configure analyzer execution within <see cref="T:Microsoft.CodeAnalysis.Diagnostics.CompilationWithAnalyzers"/>.</param>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.DiagnosticQueue">
<summary>
Queue to store analyzer diagnostics on the <see cref="T:Microsoft.CodeAnalysis.Diagnostics.AnalyzerDriver"/>.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.DiagnosticQueue.SimpleDiagnosticQueue">
<summary>
Simple diagnostics queue: maintains all diagnostics reported by all analyzers in a single queue.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.DiagnosticQueue.CategorizedDiagnosticQueue">
<summary>
Categorized diagnostics queue: maintains separate set of simple diagnostic queues for local semantic, local syntax and non-local diagnostics for every analyzer.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.AnalyzerAnalysisContext">
<summary>
Scope for setting up analyzers for an entire session, automatically associating actions with analyzers.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.AnalyzerCompilationStartAnalysisContext">
<summary>
Scope for setting up analyzers for a compilation, automatically associating actions with analyzers.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.AnalyzerSymbolStartAnalysisContext">
<summary>
Scope for setting up analyzers for code within a symbol and its members.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.AnalyzerCodeBlockStartAnalysisContext`1">
<summary>
Scope for setting up analyzers for a code block, automatically associating actions with analyzers.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.AnalyzerOperationBlockStartAnalysisContext">
<summary>
Scope for setting up analyzers for an operation block, automatically associating actions with analyzers.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.HostSessionStartAnalysisScope">
<summary>
Scope for setting up analyzers for an entire session, capable of retrieving the actions.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.HostCompilationStartAnalysisScope">
<summary>
Scope for setting up analyzers for a compilation, capable of retrieving the actions.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.HostSymbolStartAnalysisScope">
<summary>
Scope for setting up analyzers for analyzing a symbol and its members.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.HostCodeBlockStartAnalysisScope`1">
<summary>
Scope for setting up analyzers for a code block, capable of retrieving the actions.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.AnalyzerActions">
<summary>
Actions registered by a particular analyzer.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.AnalyzerActions.Append(Microsoft.CodeAnalysis.Diagnostics.AnalyzerActions@,System.Boolean)">
<summary>
Append analyzer actions from <paramref name="otherActions"/> to actions from this instance.
</summary>
<param name="otherActions">Analyzer actions to append</param>.
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.DiagnosticSuppressor">
<summary>
The base type for diagnostic suppressors that can programmatically suppress analyzer and/or compiler non-error diagnostics.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.DiagnosticSuppressor.SupportedSuppressions">
<summary>
Returns a set of descriptors for the suppressions that this suppressor is capable of producing.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.DiagnosticSuppressor.ReportSuppressions(Microsoft.CodeAnalysis.Diagnostics.SuppressionAnalysisContext)">
<summary>
Suppress analyzer and/or compiler non-error diagnostics reported for the compilation.
This may be a subset of the full set of reported diagnostics, as an optimization for
supporting incremental and partial analysis scenarios.
A diagnostic is considered suppressible by a DiagnosticSuppressor if *all* of the following conditions are met:
1. Diagnostic is not already suppressed in source via pragma/suppress message attribute.
2. Diagnostic's <see cref="P:Microsoft.CodeAnalysis.Diagnostic.DefaultSeverity"/> is not <see cref="F:Microsoft.CodeAnalysis.DiagnosticSeverity.Error"/>.
3. Diagnostic is not tagged with <see cref="F:Microsoft.CodeAnalysis.WellKnownDiagnosticTags.NotConfigurable"/> custom tag.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.SourceOrAdditionalFile">
<summary>
Represents a source file or an additional file.
For source files, <see cref="P:Microsoft.CodeAnalysis.Diagnostics.SourceOrAdditionalFile.SourceTree"/> is non-null and <see cref="P:Microsoft.CodeAnalysis.Diagnostics.SourceOrAdditionalFile.AdditionalFile"/> is null.
For additional files, <see cref="P:Microsoft.CodeAnalysis.Diagnostics.SourceOrAdditionalFile.AdditionalFile"/> is non-null and <see cref="P:Microsoft.CodeAnalysis.Diagnostics.SourceOrAdditionalFile.SourceTree"/> is null.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.SourceTextValueProvider`1">
<summary>
Provides custom values associated with <see cref="T:Microsoft.CodeAnalysis.Text.SourceText"/> instances using the given computeValue delegate.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.SourceTextValueProvider`1.#ctor(System.Func{Microsoft.CodeAnalysis.Text.SourceText,`0},System.Collections.Generic.IEqualityComparer{Microsoft.CodeAnalysis.Text.SourceText})">
<summary>
Provides custom values associated with <see cref="T:Microsoft.CodeAnalysis.Text.SourceText"/> instances using the given <paramref name="computeValue"/>.
</summary>
<param name="computeValue">Delegate to compute the value associated with a given <see cref="T:Microsoft.CodeAnalysis.Text.SourceText"/> instance.</param>
<param name="sourceTextComparer">Optional equality comparer to determine equivalent <see cref="T:Microsoft.CodeAnalysis.Text.SourceText"/> instances that have the same value.
If no comparer is provided, then <see cref="T:Microsoft.CodeAnalysis.Text.SourceTextComparer"/> is used by default.</param>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.Suppression">
<summary>
Programmatic suppression of a <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/> by a <see cref="T:Microsoft.CodeAnalysis.Diagnostics.DiagnosticSuppressor"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.Suppression.Create(Microsoft.CodeAnalysis.SuppressionDescriptor,Microsoft.CodeAnalysis.Diagnostic)">
<summary>
Creates a suppression of a <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/> with the given <see cref="T:Microsoft.CodeAnalysis.SuppressionDescriptor"/>.
</summary>
<param name="descriptor">
Descriptor for the suppression, which must be from <see cref="P:Microsoft.CodeAnalysis.Diagnostics.DiagnosticSuppressor.SupportedSuppressions"/>
for the <see cref="T:Microsoft.CodeAnalysis.Diagnostics.DiagnosticSuppressor"/> creating this suppression.
</param>
<param name="suppressedDiagnostic">
<see cref="T:Microsoft.CodeAnalysis.Diagnostic"/> to be suppressed, which must be from <see cref="P:Microsoft.CodeAnalysis.Diagnostics.SuppressionAnalysisContext.ReportedDiagnostics"/>
for the suppression context in which this suppression is being created.</param>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.Suppression.Descriptor">
<summary>
Descriptor for this suppression.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.Suppression.SuppressedDiagnostic">
<summary>
Diagnostic suppressed by this suppression.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.SuppressMessageAttributeState.TargetSymbolResolver.Resolve(System.Boolean@)">
<summary>
Attempts to resolve the "Target" argument of the global SuppressMessageAttribute to symbols in compilation.
</summary>
<param name="resolvedWithDocCommentIdFormat">Indicates if resolved "Target" argument is in Roslyn's <see cref="T:Microsoft.CodeAnalysis.DocumentationCommentId"/> format.</param>
<returns>Resolved symbols for the the "Target" argument of the global SuppressMessageAttribute.</returns>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.SymbolDeclaredCompilationEvent">
<summary>
An event for each declaration in the program (namespace, type, method, field, parameter, etc).
Note that some symbols may have multiple declarations (namespaces, partial types) and may therefore
have multiple events.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.SyntaxTreeValueProvider`1">
<summary>
Provides custom values associated with <see cref="T:Microsoft.CodeAnalysis.SyntaxTree"/> instances using the given computeValue delegate.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostics.SyntaxTreeValueProvider`1.#ctor(System.Func{Microsoft.CodeAnalysis.SyntaxTree,`0},System.Collections.Generic.IEqualityComparer{Microsoft.CodeAnalysis.SyntaxTree})">
<summary>
Provides values associated with <see cref="T:Microsoft.CodeAnalysis.SyntaxTree"/> instances using the given <paramref name="computeValue"/>.
</summary>
<param name="computeValue">Delegate to compute the value associated with a given <see cref="T:Microsoft.CodeAnalysis.SyntaxTree"/> instance.</param>
<param name="syntaxTreeComparer">Optional equality comparer to determine equivalent <see cref="T:Microsoft.CodeAnalysis.SyntaxTree"/> instances that have the same value.
If no comparer is provided, then <see cref="T:Microsoft.CodeAnalysis.SyntaxTreeComparer"/> is used by default.</param>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.UnresolvedAnalyzerReference">
<summary>
Represents an analyzer reference that can't be resolved.
</summary>
<remarks>
For error reporting only, can't be used to reference an analyzer assembly.
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.ProgrammaticSuppressionInfo">
<summary>
Contains information about the source of a programmatic diagnostic suppression produced by an <see cref="T:Microsoft.CodeAnalysis.Diagnostics.DiagnosticSuppressor"/>.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.SeverityFilter">
<summary>
Represents a set of filtered diagnostic severities.
Currently, we only support filtering out Hidden and Info severities during build.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostics.SuppressionInfo">
<summary>
Contains information about the source of diagnostic suppression.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.SuppressionInfo.Id">
<summary>
<see cref="P:Microsoft.CodeAnalysis.Diagnostic.Id"/> of the suppressed diagnostic.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostics.SuppressionInfo.Attribute">
<summary>
If the diagnostic was suppressed by an attribute, then returns that attribute.
Otherwise, returns null.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.IAnalyzerAssemblyLoader">
<summary>
Handles loading analyzer assemblies and their dependencies.
Before an analyzer assembly is loaded with <see cref="M:Microsoft.CodeAnalysis.IAnalyzerAssemblyLoader.LoadFromPath(System.String)"/>,
its location and the location of all of its dependencies must first be specified
by calls to <see cref="M:Microsoft.CodeAnalysis.IAnalyzerAssemblyLoader.AddDependencyLocation(System.String)"/>.
</summary>
<remarks>
To the extent possible, implementations should remain consistent in the face
of exceptions and allow the caller to handle them. This allows the caller to
decide how to surface issues to the user and whether or not they are fatal. For
example, if asked to load an a non-existent or inaccessible file a command line
tool may wish to exit immediately, while an IDE may wish to keep going and give
the user a chance to correct the issue.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.IAnalyzerAssemblyLoader.LoadFromPath(System.String)">
<summary>
Given the full path to an assembly on disk, loads and returns the
corresponding <see cref="T:System.Reflection.Assembly"/> object.
</summary>
<remarks>
Multiple calls with the same path should return the same
<see cref="T:System.Reflection.Assembly"/> instance.
</remarks>
<exception cref="T:System.ArgumentNullException"><paramref name="fullPath" /> is null.</exception>
<exception cref="T:System.ArgumentException"><paramref name="fullPath" /> is not a full path.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.IAnalyzerAssemblyLoader.AddDependencyLocation(System.String)">
<summary>
Adds a file to consider when loading an analyzer or its dependencies.
</summary>
<exception cref="T:System.ArgumentNullException"><paramref name="fullPath" /> is null.</exception>
<exception cref="T:System.ArgumentException"><paramref name="fullPath" /> is not a full path.</exception>
</member>
<member name="F:Microsoft.CodeAnalysis.ShadowCopyAnalyzerAssemblyLoader._baseDirectory">
<summary>
The base directory for shadow copies. Each instance of
<see cref="T:Microsoft.CodeAnalysis.ShadowCopyAnalyzerAssemblyLoader"/> gets its own
subdirectory under this directory. This is also the starting point
for scavenge operations.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.ShadowCopyAnalyzerAssemblyLoader._shadowCopyDirectoryAndMutex">
<summary>
The directory where this instance of <see cref="T:Microsoft.CodeAnalysis.ShadowCopyAnalyzerAssemblyLoader"/>
will shadow-copy assemblies, and the mutex created to mark that the owner of it is still active.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.ShadowCopyAnalyzerAssemblyLoader._assemblyDirectoryId">
<summary>
Used to generate unique names for per-assembly directories. Should be updated with <see cref="M:System.Threading.Interlocked.Increment(System.Int32@)"/>.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CommonMessageProvider">
<summary>
Abstracts the ability to classify and load messages for error codes. Allows the error
infrastructure to be reused between C# and VB.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CommonMessageProvider.s_errorIdCache">
<summary>
Caches the return values for <see cref="M:Microsoft.CodeAnalysis.CommonMessageProvider.GetIdForErrorCode(System.Int32)"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonMessageProvider.GetSeverity(System.Int32)">
<summary>
Given an error code, get the severity (warning or error) of the code.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonMessageProvider.LoadMessage(System.Int32,System.Globalization.CultureInfo)">
<summary>
Load the message for the given error code. If the message contains
"fill-in" placeholders, those should be expressed in standard string.Format notation
and be in the string.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonMessageProvider.GetTitle(System.Int32)">
<summary>
Get an optional localizable title for the given diagnostic code.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonMessageProvider.GetDescription(System.Int32)">
<summary>
Get an optional localizable description for the given diagnostic code.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonMessageProvider.GetMessageFormat(System.Int32)">
<summary>
Get a localizable message format string for the given diagnostic code.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonMessageProvider.GetHelpLink(System.Int32)">
<summary>
Get an optional help link for the given diagnostic code.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonMessageProvider.GetCategory(System.Int32)">
<summary>
Get the diagnostic category for the given diagnostic code.
Default category is <see cref="F:Microsoft.CodeAnalysis.Diagnostic.CompilerDiagnosticCategory"/>.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommonMessageProvider.CodePrefix">
<summary>
Get the text prefix (e.g., "CS" for C#) used on error messages.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonMessageProvider.GetWarningLevel(System.Int32)">
<summary>
Get the warning level for warnings (e.g., 1 or greater for C#). VB does not have warning
levels and always uses 1. Errors should return 0.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommonMessageProvider.ErrorCodeType">
<summary>
Type that defines error codes. For testing purposes only.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonMessageProvider.CreateDiagnostic(System.Int32,Microsoft.CodeAnalysis.Location)">
<summary>
Create a simple language specific diagnostic for given error code.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonMessageProvider.CreateDiagnostic(Microsoft.CodeAnalysis.DiagnosticInfo)">
<summary>
Create a simple language specific diagnostic with no location for given info.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonMessageProvider.CreateDiagnostic(System.Int32,Microsoft.CodeAnalysis.Location,System.Object[])">
<summary>
Create a simple language specific diagnostic for given error code.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonMessageProvider.GetMessagePrefix(System.String,Microsoft.CodeAnalysis.DiagnosticSeverity,System.Boolean,System.Globalization.CultureInfo)">
<summary>
Given a message identifier (e.g., CS0219), severity, warning as error and a culture,
get the entire prefix (e.g., "error CS0219: Warning as Error:" for C# or "error BC42024:" for VB) used on error messages.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonMessageProvider.GetErrorDisplayString(Microsoft.CodeAnalysis.ISymbol)">
<summary>
Convert given symbol to string representation.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonMessageProvider.GetIdForErrorCode(System.Int32)">
<summary>
Given an error code (like 1234) return the identifier (CS1234 or BC1234).
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonMessageProvider.GetDiagnosticReport(Microsoft.CodeAnalysis.DiagnosticInfo,Microsoft.CodeAnalysis.CompilationOptions)">
<summary>
Produces the filtering action for the diagnostic based on the options passed in.
</summary>
<returns>
A new <see cref="T:Microsoft.CodeAnalysis.DiagnosticInfo"/> with new effective severity based on the options or null if the
diagnostic has been suppressed.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonMessageProvider.FilterDiagnosticInfo(Microsoft.CodeAnalysis.DiagnosticInfo,Microsoft.CodeAnalysis.CompilationOptions)">
<summary>
Filter a <see cref="T:Microsoft.CodeAnalysis.DiagnosticInfo"/> based on the compilation options so that /nowarn and /warnaserror etc. take effect.options
</summary>
<returns>A <see cref="T:Microsoft.CodeAnalysis.DiagnosticInfo"/> with effective severity based on option or null if suppressed.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonMessageProvider.ReportStreamWriteException(System.Exception,System.String,Microsoft.CodeAnalysis.DiagnosticBag)">
<summary>
Takes an exception produced while writing to a file stream and produces a diagnostic.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Diagnostic">
<summary>
Represents a diagnostic, such as a compiler error or a warning, along with the location where it occurred.
</summary>
<summary>
A diagnostic (such as a compiler error or a warning), along with the location where it occurred.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Diagnostic.DefaultWarningLevel">
<summary>
The default warning level, which is also used for non-error diagnostics.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Diagnostic.InfoAndHiddenWarningLevel">
<summary>
The warning level used for hidden and info diagnostics. Because these diagnostics interact with other editor features, we want them to always be produced unless /warn:0 is set.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Diagnostic.MaxWarningLevel">
<summary>
The maximum warning level represented by a large value of 9999.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostic.Create(Microsoft.CodeAnalysis.DiagnosticDescriptor,Microsoft.CodeAnalysis.Location,System.Object[])">
<summary>
Creates a <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/> instance.
</summary>
<param name="descriptor">A <see cref="T:Microsoft.CodeAnalysis.DiagnosticDescriptor"/> describing the diagnostic</param>
<param name="location">An optional primary location of the diagnostic. If null, <see cref="P:Microsoft.CodeAnalysis.Diagnostic.Location"/> will return <see cref="P:Microsoft.CodeAnalysis.Location.None"/>.</param>
<param name="messageArgs">Arguments to the message of the diagnostic</param>
<returns>The <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/> instance.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostic.Create(Microsoft.CodeAnalysis.DiagnosticDescriptor,Microsoft.CodeAnalysis.Location,System.Collections.Immutable.ImmutableDictionary{System.String,System.String},System.Object[])">
<summary>
Creates a <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/> instance.
</summary>
<param name="descriptor">A <see cref="T:Microsoft.CodeAnalysis.DiagnosticDescriptor"/> describing the diagnostic.</param>
<param name="location">An optional primary location of the diagnostic. If null, <see cref="P:Microsoft.CodeAnalysis.Diagnostic.Location"/> will return <see cref="P:Microsoft.CodeAnalysis.Location.None"/>.</param>
<param name="properties">
An optional set of name-value pairs by means of which the analyzer that creates the diagnostic
can convey more detailed information to the fixer. If null, <see cref="P:Microsoft.CodeAnalysis.Diagnostic.Properties"/> will return
<see cref="F:System.Collections.Immutable.ImmutableDictionary`2.Empty"/>.
</param>
<param name="messageArgs">Arguments to the message of the diagnostic.</param>
<returns>The <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/> instance.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostic.Create(Microsoft.CodeAnalysis.DiagnosticDescriptor,Microsoft.CodeAnalysis.Location,System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.Location},System.Object[])">
<summary>
Creates a <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/> instance.
</summary>
<param name="descriptor">A <see cref="T:Microsoft.CodeAnalysis.DiagnosticDescriptor"/> describing the diagnostic.</param>
<param name="location">An optional primary location of the diagnostic. If null, <see cref="P:Microsoft.CodeAnalysis.Diagnostic.Location"/> will return <see cref="P:Microsoft.CodeAnalysis.Location.None"/>.</param>
<param name="additionalLocations">
An optional set of additional locations related to the diagnostic.
Typically, these are locations of other items referenced in the message.
If null, <see cref="P:Microsoft.CodeAnalysis.Diagnostic.AdditionalLocations"/> will return an empty list.
</param>
<param name="messageArgs">Arguments to the message of the diagnostic.</param>
<returns>The <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/> instance.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostic.Create(Microsoft.CodeAnalysis.DiagnosticDescriptor,Microsoft.CodeAnalysis.Location,System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.Location},System.Collections.Immutable.ImmutableDictionary{System.String,System.String},System.Object[])">
<summary>
Creates a <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/> instance.
</summary>
<param name="descriptor">A <see cref="T:Microsoft.CodeAnalysis.DiagnosticDescriptor"/> describing the diagnostic.</param>
<param name="location">An optional primary location of the diagnostic. If null, <see cref="P:Microsoft.CodeAnalysis.Diagnostic.Location"/> will return <see cref="P:Microsoft.CodeAnalysis.Location.None"/>.</param>
<param name="additionalLocations">
An optional set of additional locations related to the diagnostic.
Typically, these are locations of other items referenced in the message.
If null, <see cref="P:Microsoft.CodeAnalysis.Diagnostic.AdditionalLocations"/> will return an empty list.
</param>
<param name="properties">
An optional set of name-value pairs by means of which the analyzer that creates the diagnostic
can convey more detailed information to the fixer. If null, <see cref="P:Microsoft.CodeAnalysis.Diagnostic.Properties"/> will return
<see cref="F:System.Collections.Immutable.ImmutableDictionary`2.Empty"/>.
</param>
<param name="messageArgs">Arguments to the message of the diagnostic.</param>
<returns>The <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/> instance.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostic.Create(Microsoft.CodeAnalysis.DiagnosticDescriptor,Microsoft.CodeAnalysis.Location,Microsoft.CodeAnalysis.DiagnosticSeverity,System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.Location},System.Collections.Immutable.ImmutableDictionary{System.String,System.String},System.Object[])">
<summary>
Creates a <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/> instance.
</summary>
<param name="descriptor">A <see cref="T:Microsoft.CodeAnalysis.DiagnosticDescriptor"/> describing the diagnostic.</param>
<param name="location">An optional primary location of the diagnostic. If null, <see cref="P:Microsoft.CodeAnalysis.Diagnostic.Location"/> will return <see cref="P:Microsoft.CodeAnalysis.Location.None"/>.</param>
<param name="effectiveSeverity">Effective severity of the diagnostic.</param>
<param name="additionalLocations">
An optional set of additional locations related to the diagnostic.
Typically, these are locations of other items referenced in the message.
If null, <see cref="P:Microsoft.CodeAnalysis.Diagnostic.AdditionalLocations"/> will return an empty list.
</param>
<param name="properties">
An optional set of name-value pairs by means of which the analyzer that creates the diagnostic
can convey more detailed information to the fixer. If null, <see cref="P:Microsoft.CodeAnalysis.Diagnostic.Properties"/> will return
<see cref="F:System.Collections.Immutable.ImmutableDictionary`2.Empty"/>.
</param>
<param name="messageArgs">Arguments to the message of the diagnostic.</param>
<returns>The <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/> instance.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostic.Create(System.String,System.String,Microsoft.CodeAnalysis.LocalizableString,Microsoft.CodeAnalysis.DiagnosticSeverity,Microsoft.CodeAnalysis.DiagnosticSeverity,System.Boolean,System.Int32,Microsoft.CodeAnalysis.LocalizableString,Microsoft.CodeAnalysis.LocalizableString,System.String,Microsoft.CodeAnalysis.Location,System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.Location},System.Collections.Generic.IEnumerable{System.String},System.Collections.Immutable.ImmutableDictionary{System.String,System.String})">
<summary>
Creates a <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/> instance which is localizable.
</summary>
<param name="id">An identifier for the diagnostic. For diagnostics generated by the compiler, this will be a numeric code with a prefix such as "CS1001".</param>
<param name="category">The category of the diagnostic. For diagnostics generated by the compiler, the category will be "Compiler".</param>
<param name="message">The diagnostic message text.</param>
<param name="severity">The diagnostic's effective severity.</param>
<param name="defaultSeverity">The diagnostic's default severity.</param>
<param name="isEnabledByDefault">True if the diagnostic is enabled by default</param>
<param name="warningLevel">The warning level, between 1 and 4 if severity is <see cref="F:Microsoft.CodeAnalysis.DiagnosticSeverity.Warning"/>; otherwise 0.</param>
<param name="title">An optional short localizable title describing the diagnostic.</param>
<param name="description">An optional longer localizable description for the diagnostic.</param>
<param name="helpLink">An optional hyperlink that provides more detailed information regarding the diagnostic.</param>
<param name="location">An optional primary location of the diagnostic. If null, <see cref="P:Microsoft.CodeAnalysis.Diagnostic.Location"/> will return <see cref="P:Microsoft.CodeAnalysis.Location.None"/>.</param>
<param name="additionalLocations">
An optional set of additional locations related to the diagnostic.
Typically, these are locations of other items referenced in the message.
If null, <see cref="P:Microsoft.CodeAnalysis.Diagnostic.AdditionalLocations"/> will return an empty list.
</param>
<param name="customTags">
An optional set of custom tags for the diagnostic. See <see cref="T:Microsoft.CodeAnalysis.WellKnownDiagnosticTags"/> for some well known tags.
If null, <see cref="P:Microsoft.CodeAnalysis.Diagnostic.CustomTags"/> will return an empty list.
</param>
<param name="properties">
An optional set of name-value pairs by means of which the analyzer that creates the diagnostic
can convey more detailed information to the fixer. If null, <see cref="P:Microsoft.CodeAnalysis.Diagnostic.Properties"/> will return
<see cref="F:System.Collections.Immutable.ImmutableDictionary`2.Empty"/>.
</param>
<returns>The <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/> instance.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostic.Create(System.String,System.String,Microsoft.CodeAnalysis.LocalizableString,Microsoft.CodeAnalysis.DiagnosticSeverity,Microsoft.CodeAnalysis.DiagnosticSeverity,System.Boolean,System.Int32,System.Boolean,Microsoft.CodeAnalysis.LocalizableString,Microsoft.CodeAnalysis.LocalizableString,System.String,Microsoft.CodeAnalysis.Location,System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.Location},System.Collections.Generic.IEnumerable{System.String},System.Collections.Immutable.ImmutableDictionary{System.String,System.String})">
<summary>
Creates a <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/> instance which is localizable.
</summary>
<param name="id">An identifier for the diagnostic. For diagnostics generated by the compiler, this will be a numeric code with a prefix such as "CS1001".</param>
<param name="category">The category of the diagnostic. For diagnostics generated by the compiler, the category will be "Compiler".</param>
<param name="message">The diagnostic message text.</param>
<param name="severity">The diagnostic's effective severity.</param>
<param name="defaultSeverity">The diagnostic's default severity.</param>
<param name="isEnabledByDefault">True if the diagnostic is enabled by default</param>
<param name="warningLevel">The warning level, between 1 and 4 if severity is <see cref="F:Microsoft.CodeAnalysis.DiagnosticSeverity.Warning"/>; otherwise 0.</param>
<param name="isSuppressed">Flag indicating whether the diagnostic is suppressed by a source suppression.</param>
<param name="title">An optional short localizable title describing the diagnostic.</param>
<param name="description">An optional longer localizable description for the diagnostic.</param>
<param name="helpLink">An optional hyperlink that provides more detailed information regarding the diagnostic.</param>
<param name="location">An optional primary location of the diagnostic. If null, <see cref="P:Microsoft.CodeAnalysis.Diagnostic.Location"/> will return <see cref="P:Microsoft.CodeAnalysis.Location.None"/>.</param>
<param name="additionalLocations">
An optional set of additional locations related to the diagnostic.
Typically, these are locations of other items referenced in the message.
If null, <see cref="P:Microsoft.CodeAnalysis.Diagnostic.AdditionalLocations"/> will return an empty list.
</param>
<param name="customTags">
An optional set of custom tags for the diagnostic. See <see cref="T:Microsoft.CodeAnalysis.WellKnownDiagnosticTags"/> for some well known tags.
If null, <see cref="P:Microsoft.CodeAnalysis.Diagnostic.CustomTags"/> will return an empty list.
</param>
<param name="properties">
An optional set of name-value pairs by means of which the analyzer that creates the diagnostic
can convey more detailed information to the fixer. If null, <see cref="P:Microsoft.CodeAnalysis.Diagnostic.Properties"/> will return
<see cref="F:System.Collections.Immutable.ImmutableDictionary`2.Empty"/>.
</param>
<returns>The <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/> instance.</returns>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostic.Descriptor">
<summary>
Gets the diagnostic descriptor, which provides a description about a <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostic.Id">
<summary>
Gets the diagnostic identifier. For diagnostics generated by the compiler, this will be a numeric code with a prefix such as "CS1001".
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostic.Category">
<summary>
Gets the category of diagnostic. For diagnostics generated by the compiler, the category will be "Compiler".
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostic.GetMessage(System.IFormatProvider)">
<summary>
Get the culture specific text of the message.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostic.DefaultSeverity">
<summary>
Gets the default <see cref="T:Microsoft.CodeAnalysis.DiagnosticSeverity"/> of the diagnostic's <see cref="T:Microsoft.CodeAnalysis.DiagnosticDescriptor"/>.
</summary>
<remarks>
To get the effective severity of the diagnostic, use <see cref="P:Microsoft.CodeAnalysis.Diagnostic.Severity"/>.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostic.Severity">
<summary>
Gets the effective <see cref="T:Microsoft.CodeAnalysis.DiagnosticSeverity"/> of the diagnostic.
</summary>
<remarks>
To get the default severity of diagnostic's <see cref="T:Microsoft.CodeAnalysis.DiagnosticDescriptor"/>, use <see cref="P:Microsoft.CodeAnalysis.Diagnostic.DefaultSeverity"/>.
To determine if this is a warning treated as an error, use <see cref="P:Microsoft.CodeAnalysis.Diagnostic.IsWarningAsError"/>.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostic.WarningLevel">
<summary>
Gets the warning level. This is 0 for diagnostics with severity <see cref="F:Microsoft.CodeAnalysis.DiagnosticSeverity.Error"/>,
otherwise an integer greater than zero.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostic.IsSuppressed">
<summary>
Returns true if the diagnostic has a source suppression, i.e. an attribute or a pragma suppression.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostic.GetSuppressionInfo(Microsoft.CodeAnalysis.Compilation)">
<summary>
Gets the <see cref="T:Microsoft.CodeAnalysis.Diagnostics.SuppressionInfo"/> for suppressed diagnostics, i.e. <see cref="P:Microsoft.CodeAnalysis.Diagnostic.IsSuppressed"/> = true.
Otherwise, returns null.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostic.IsEnabledByDefault">
<summary>
Returns true if this diagnostic is enabled by default by the author of the diagnostic.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostic.IsWarningAsError">
<summary>
Returns true if this is a warning treated as an error; otherwise false.
</summary>
<remarks>
True implies <see cref="P:Microsoft.CodeAnalysis.Diagnostic.DefaultSeverity"/> = <see cref="F:Microsoft.CodeAnalysis.DiagnosticSeverity.Warning"/>
and <see cref="P:Microsoft.CodeAnalysis.Diagnostic.Severity"/> = <see cref="F:Microsoft.CodeAnalysis.DiagnosticSeverity.Error"/>.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostic.Location">
<summary>
Gets the primary location of the diagnostic, or <see cref="P:Microsoft.CodeAnalysis.Location.None"/> if no primary location.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostic.AdditionalLocations">
<summary>
Gets an array of additional locations related to the diagnostic.
Typically these are the locations of other items referenced in the message.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostic.CustomTags">
<summary>
Gets custom tags for the diagnostic.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostic.Properties">
<summary>
Gets property bag for the diagnostic. it will return <see cref="F:System.Collections.Immutable.ImmutableDictionary`2.Empty"/>
if there is no entry. This can be used to put diagnostic specific information you want
to pass around. for example, to corresponding fixer.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostic.WithLocation(Microsoft.CodeAnalysis.Location)">
<summary>
Create a new instance of this diagnostic with the Location property changed.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostic.WithSeverity(Microsoft.CodeAnalysis.DiagnosticSeverity)">
<summary>
Create a new instance of this diagnostic with the Severity property changed.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostic.WithIsSuppressed(System.Boolean)">
<summary>
Create a new instance of this diagnostic with the suppression info changed.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostic.WithProgrammaticSuppression(Microsoft.CodeAnalysis.Diagnostics.ProgrammaticSuppressionInfo)">
<summary>
Create a new instance of this diagnostic with the given programmatic suppression info.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostic.HasIntersectingLocation(Microsoft.CodeAnalysis.SyntaxTree,System.Nullable{Microsoft.CodeAnalysis.Text.TextSpan})">
<summary>
Returns true if the diagnostic location (or any additional location) is within the given tree and intersects with the filterSpanWithinTree, if non-null.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostic.GetDefaultWarningLevel(Microsoft.CodeAnalysis.DiagnosticSeverity)">
<summary>
Gets the default warning level for a diagnostic severity. Warning levels are used with the <c>/warn:N</c>
command line option to suppress diagnostics over a severity of interest. When N is 0, only error severity
messages are produced by the compiler. Values greater than 0 indicated that warnings up to and including
level N should also be included.
</summary>
<remarks>
<see cref="F:Microsoft.CodeAnalysis.DiagnosticSeverity.Info"/> and <see cref="F:Microsoft.CodeAnalysis.DiagnosticSeverity.Hidden"/> are treated as warning
level 1. In other words, these diagnostics which typically interact with editor features are enabled unless
the special <c>/warn:0</c> option is set.
</remarks>
<param name="severity">A <see cref="T:Microsoft.CodeAnalysis.DiagnosticSeverity"/> value.</param>
<returns>The default compiler warning level for <paramref name="severity"/>.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostic.IsNotConfigurable">
<summary>
Returns true if a diagnostic is not configurable, i.e. cannot be suppressed or filtered or have its severity changed.
For example, compiler errors are always non-configurable.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Diagnostic.IsUnsuppressableError">
<summary>
Returns true if this is an error diagnostic which cannot be suppressed and is guaranteed to break the build.
Only diagnostics which have default severity error and are tagged as NotConfigurable fall in this bucket.
This includes all compiler error diagnostics and specific analyzer error diagnostics that are marked as not configurable by the analyzer author.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Diagnostic.IsUnsuppressedError">
<summary>
Returns true if this is a unsuppressed diagnostic with an effective error severity.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.RequiredLanguageVersion">
<summary>
This type is attached to diagnostics for required language version and should only be used
on such diagnostics, as they are recognized by <see cref="M:Microsoft.CodeAnalysis.Compilation.GetRequiredLanguageVersion(Microsoft.CodeAnalysis.Diagnostic)"/>.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.DiagnosticBag">
<summary>
Represents a mutable bag of diagnostics. You can add diagnostics to the bag,
and also get all the diagnostics out of the bag (the bag implements
IEnumerable<Diagnostics>. Once added, diagnostics cannot be removed, and no ordering
is guaranteed.
It is ok to Add diagnostics to the same bag concurrently on multiple threads.
It is NOT ok to Add concurrently with Clear or Free operations.
</summary>
<remarks>The bag is optimized to be efficient when containing zero errors.</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.DiagnosticBag.IsEmptyWithoutResolution">
<summary>
Return true if the bag is completely empty - not even containing void diagnostics.
</summary>
<remarks>
This exists for short-circuiting purposes. Use <see cref="M:System.Linq.Enumerable.Any``1(System.Collections.Generic.IEnumerable{``0})"/>
to get a resolved Tuple(Of NamedTypeSymbol, ImmutableArray(Of Diagnostic)) (i.e. empty after eliminating void diagnostics).
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.DiagnosticBag.HasAnyErrors">
<summary>
Returns true if the bag has any diagnostics with DefaultSeverity=Error. Does not consider warnings or informationals
or warnings promoted to error via /warnaserror.
</summary>
<remarks>
Resolves any lazy diagnostics in the bag.
Generally, this should only be called by the creator (modulo pooling) of the bag (i.e. don't use bags to communicate -
if you need more info, pass more info).
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.DiagnosticBag.HasAnyResolvedErrors">
<summary>
Returns true if the bag has any non-lazy diagnostics with DefaultSeverity=Error. Does not consider warnings or informationals
or warnings promoted to error via /warnaserror.
</summary>
<remarks>
Does not resolve any lazy diagnostics in the bag.
Generally, this should only be called by the creator (modulo pooling) of the bag (i.e. don't use bags to communicate -
if you need more info, pass more info).
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.DiagnosticBag.Add(Microsoft.CodeAnalysis.Diagnostic)">
<summary>
Add a diagnostic to the bag.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.DiagnosticBag.AddRange``1(System.Collections.Immutable.ImmutableArray{``0})">
<summary>
Add multiple diagnostics to the bag.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.DiagnosticBag.AddRange(System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.Diagnostic})">
<summary>
Add multiple diagnostics to the bag.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.DiagnosticBag.AddRange(Microsoft.CodeAnalysis.DiagnosticBag)">
<summary>
Add another DiagnosticBag to the bag.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.DiagnosticBag.AddRangeAndFree(Microsoft.CodeAnalysis.DiagnosticBag)">
<summary>
Add another DiagnosticBag to the bag and free the argument.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.DiagnosticBag.ToReadOnlyAndFree``1">
<summary>
Seal the bag so no further errors can be added, while clearing it and returning the old set of errors.
Return the bag to the pool.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.DiagnosticBag.AsEnumerable">
<remarks>
Generally, this should only be called by the creator (modulo pooling) of the bag (i.e. don't use bags to communicate -
if you need more info, pass more info).
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.DiagnosticBag.AsEnumerableFiltered">
<remarks>
Using an iterator to avoid copying the list. If perf is a problem,
create an explicit enumerator type.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.DiagnosticBag.Bag">
<summary>
Get the underlying concurrent storage, creating it on demand if needed.
NOTE: Concurrent Adding to the bag is supported, but concurrent Clearing is not.
If one thread adds to the bug while another clears it, the scenario is
broken and we cannot do anything about it here.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.DiagnosticBag.Clear">
NOTE: Concurrent Adding to the bag is supported, but concurrent Clearing is not.
If one thread adds to the bug while another clears it, the scenario is
broken and we cannot do anything about it here.
</member>
<member name="T:Microsoft.CodeAnalysis.DiagnosticDescriptor">
<summary>
Provides a description about a <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.DiagnosticDescriptor.Id">
<summary>
An unique identifier for the diagnostic.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.DiagnosticDescriptor.Title">
<summary>
A short localizable title describing the diagnostic.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.DiagnosticDescriptor.Description">
<summary>
An optional longer localizable description for the diagnostic.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.DiagnosticDescriptor.HelpLinkUri">
<summary>
An optional hyperlink that provides more detailed information regarding the diagnostic.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.DiagnosticDescriptor.MessageFormat">
<summary>
A localizable format message string, which can be passed as the first argument to <see cref="M:System.String.Format(System.String,System.Object[])"/> when creating the diagnostic message with this descriptor.
</summary>
<returns></returns>
</member>
<member name="P:Microsoft.CodeAnalysis.DiagnosticDescriptor.Category">
<summary>
The category of the diagnostic (like Design, Naming etc.)
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.DiagnosticDescriptor.DefaultSeverity">
<summary>
The default severity of the diagnostic.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.DiagnosticDescriptor.IsEnabledByDefault">
<summary>
Returns true if the diagnostic is enabled by default.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.DiagnosticDescriptor.CustomTags">
<summary>
Custom tags for the diagnostic.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.DiagnosticDescriptor.#ctor(System.String,System.String,System.String,System.String,Microsoft.CodeAnalysis.DiagnosticSeverity,System.Boolean,System.String,System.String,System.String[])">
<summary>
Create a DiagnosticDescriptor, which provides description about a <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>.
NOTE: For localizable <paramref name="title"/>, <paramref name="description"/> and/or <paramref name="messageFormat"/>,
use constructor overload <see cref="M:Microsoft.CodeAnalysis.DiagnosticDescriptor.#ctor(System.String,Microsoft.CodeAnalysis.LocalizableString,Microsoft.CodeAnalysis.LocalizableString,System.String,Microsoft.CodeAnalysis.DiagnosticSeverity,System.Boolean,Microsoft.CodeAnalysis.LocalizableString,System.String,System.String[])"/>.
</summary>
<param name="id">A unique identifier for the diagnostic. For example, code analysis diagnostic ID "CA1001".</param>
<param name="title">A short title describing the diagnostic. For example, for CA1001: "Types that own disposable fields should be disposable".</param>
<param name="messageFormat">A format message string, which can be passed as the first argument to <see cref="M:System.String.Format(System.String,System.Object[])"/> when creating the diagnostic message with this descriptor.
For example, for CA1001: "Implement IDisposable on '{0}' because it creates members of the following IDisposable types: '{1}'."</param>
<param name="category">The category of the diagnostic (like Design, Naming etc.). For example, for CA1001: "Microsoft.Design".</param>
<param name="defaultSeverity">Default severity of the diagnostic.</param>
<param name="isEnabledByDefault">True if the diagnostic is enabled by default.</param>
<param name="description">An optional longer description of the diagnostic.</param>
<param name="helpLinkUri">An optional hyperlink that provides a more detailed description regarding the diagnostic.</param>
<param name="customTags">Optional custom tags for the diagnostic. See <see cref="T:Microsoft.CodeAnalysis.WellKnownDiagnosticTags"/> for some well known tags.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.DiagnosticDescriptor.#ctor(System.String,Microsoft.CodeAnalysis.LocalizableString,Microsoft.CodeAnalysis.LocalizableString,System.String,Microsoft.CodeAnalysis.DiagnosticSeverity,System.Boolean,Microsoft.CodeAnalysis.LocalizableString,System.String,System.String[])">
<summary>
Create a DiagnosticDescriptor, which provides description about a <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>.
</summary>
<param name="id">A unique identifier for the diagnostic. For example, code analysis diagnostic ID "CA1001".</param>
<param name="title">A short localizable title describing the diagnostic. For example, for CA1001: "Types that own disposable fields should be disposable".</param>
<param name="messageFormat">A localizable format message string, which can be passed as the first argument to <see cref="M:System.String.Format(System.String,System.Object[])"/> when creating the diagnostic message with this descriptor.
For example, for CA1001: "Implement IDisposable on '{0}' because it creates members of the following IDisposable types: '{1}'."</param>
<param name="category">The category of the diagnostic (like Design, Naming etc.). For example, for CA1001: "Microsoft.Design".</param>
<param name="defaultSeverity">Default severity of the diagnostic.</param>
<param name="isEnabledByDefault">True if the diagnostic is enabled by default.</param>
<param name="description">An optional longer localizable description of the diagnostic.</param>
<param name="helpLinkUri">An optional hyperlink that provides a more detailed description regarding the diagnostic.</param>
<param name="customTags">Optional custom tags for the diagnostic. See <see cref="T:Microsoft.CodeAnalysis.WellKnownDiagnosticTags"/> for some well known tags.</param>
<remarks>Example descriptor for rule CA1001:
internal static DiagnosticDescriptor Rule = new DiagnosticDescriptor(RuleId,
new LocalizableResourceString(nameof(FxCopRulesResources.TypesThatOwnDisposableFieldsShouldBeDisposable), FxCopRulesResources.ResourceManager, typeof(FxCopRulesResources)),
new LocalizableResourceString(nameof(FxCopRulesResources.TypeOwnsDisposableFieldButIsNotDisposable), FxCopRulesResources.ResourceManager, typeof(FxCopRulesResources)),
FxCopDiagnosticCategory.Design,
DiagnosticSeverity.Warning,
isEnabledByDefault: true,
helpLinkUri: "http://msdn.microsoft.com/library/ms182172.aspx",
customTags: DiagnosticCustomTags.Microsoft);
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.DiagnosticDescriptor.GetEffectiveSeverity(Microsoft.CodeAnalysis.CompilationOptions)">
<summary>
Gets the effective severity of diagnostics created based on this descriptor and the given <see cref="T:Microsoft.CodeAnalysis.CompilationOptions"/>.
</summary>
<param name="compilationOptions">Compilation options</param>
</member>
<member name="M:Microsoft.CodeAnalysis.DiagnosticDescriptor.IsNotConfigurable">
<summary>
Returns true if diagnostic descriptor is not configurable, i.e. cannot be suppressed or filtered or have its severity changed.
For example, compiler errors are always non-configurable.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.DiagnosticFormatter">
<summary>
Formats <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/> messages.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.DiagnosticFormatter.Format(Microsoft.CodeAnalysis.Diagnostic,System.IFormatProvider)">
<summary>
Formats the <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/> message using the optional <see cref="T:System.IFormatProvider"/>.
</summary>
<param name="diagnostic">The diagnostic.</param>
<param name="formatter">The formatter; or null to use the default formatter.</param>
<returns>The formatted message.</returns>
</member>
<member name="T:Microsoft.CodeAnalysis.DiagnosticInfo">
<summary>
A DiagnosticInfo object has information about a diagnostic, but without any attached location information.
</summary>
<remarks>
More specialized diagnostics with additional information (e.g., ambiguity errors) can derive from this class to
provide access to additional information about the error, such as what symbols were involved in the ambiguity.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.DiagnosticInfo.Code">
<summary>
The error code, as an integer.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.DiagnosticInfo.Severity">
<summary>
Returns the effective severity of the diagnostic: whether this diagnostic is informational, warning, or error.
If IsWarningsAsError is true, then this returns <see cref="F:Microsoft.CodeAnalysis.DiagnosticSeverity.Error"/>, while <see cref="P:Microsoft.CodeAnalysis.DiagnosticInfo.DefaultSeverity"/> returns <see cref="F:Microsoft.CodeAnalysis.DiagnosticSeverity.Warning"/>.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.DiagnosticInfo.DefaultSeverity">
<summary>
Returns whether this diagnostic is informational, warning, or error by default, based on the error code.
To get diagnostic's effective severity, use <see cref="P:Microsoft.CodeAnalysis.DiagnosticInfo.Severity"/>.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.DiagnosticInfo.WarningLevel">
<summary>
Gets the warning level. This is 0 for diagnostics with severity <see cref="F:Microsoft.CodeAnalysis.DiagnosticSeverity.Error"/>,
otherwise an integer greater than zero.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.DiagnosticInfo.IsWarningAsError">
<summary>
Returns true if this is a warning treated as an error.
</summary>
<remarks>
True implies <see cref="P:Microsoft.CodeAnalysis.DiagnosticInfo.Severity"/> = <see cref="F:Microsoft.CodeAnalysis.DiagnosticSeverity.Error"/> and
<see cref="P:Microsoft.CodeAnalysis.DiagnosticInfo.DefaultSeverity"/> = <see cref="F:Microsoft.CodeAnalysis.DiagnosticSeverity.Warning"/>.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.DiagnosticInfo.Category">
<summary>
Get the diagnostic category for the given diagnostic code.
Default category is <see cref="F:Microsoft.CodeAnalysis.Diagnostic.CompilerDiagnosticCategory"/>.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.DiagnosticInfo.AdditionalLocations">
<summary>
If a derived class has additional information about other referenced symbols, it can
expose the locations of those symbols in a general way, so they can be reported along
with the error.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.DiagnosticInfo.MessageIdentifier">
<summary>
Get the message id (for example "CS1001") for the message. This includes both the error number
and a prefix identifying the source.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.DiagnosticInfo.GetMessage(System.IFormatProvider)">
<summary>
Get the text of the message in the given language.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.DiagnosticInfo.GetResolvedInfo">
<summary>
For a DiagnosticInfo that is lazily evaluated, this method evaluates it
and returns a non-lazy DiagnosticInfo.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.DiagnosticSeverity">
<summary>
Describes how severe a diagnostic is.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.DiagnosticSeverity.Hidden">
<summary>
Something that is an issue, as determined by some authority,
but is not surfaced through normal means.
There may be different mechanisms that act on these issues.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.DiagnosticSeverity.Info">
<summary>
Information that does not indicate a problem (i.e. not prescriptive).
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.DiagnosticSeverity.Warning">
<summary>
Something suspicious but allowed.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.DiagnosticSeverity.Error">
<summary>
Something not allowed by the rules of the language or other authority.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.InternalDiagnosticSeverity">
<summary>
Values for severity that are used internally by the compiler but are not exposed.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.InternalDiagnosticSeverity.Unknown">
<summary>
An unknown severity diagnostic is something whose severity has not yet been determined.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.InternalDiagnosticSeverity.Void">
<summary>
If an unknown diagnostic is resolved and found to be unnecessary then it is
treated as a "Void" diagnostic
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.InternalErrorCode">
<summary>
Values for ErrorCode/ERRID that are used internally by the compiler but are not exposed.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.InternalErrorCode.Unknown">
<summary>
The code has yet to be determined.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.InternalErrorCode.Void">
<summary>
The code was lazily determined and does not need to be reported.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.DiagnosticWithInfo">
<summary>
A diagnostic (such as a compiler error or a warning), along with the location where it occurred.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.DiagnosticWithInfo.Info">
<summary>
Get the information about the diagnostic: the code, severity, message, etc.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.DiagnosticWithInfo.HasLazyInfo">
<summary>
True if the DiagnosticInfo for this diagnostic requires (or required - this property
is immutable) resolution.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.ExternalFileLocation">
<summary>
A program location in source code.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.FileLinePositionSpan">
<summary>
Represents a span of text in a source code file in terms of file name, line number, and offset within line.
However, the file is actually whatever was passed in when asked to parse; there may not really be a file.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.FileLinePositionSpan.Path">
<summary>
Path, or null if the span represents an invalid value.
</summary>
<remarks>
Path may be <see cref="F:System.String.Empty"/> if not available.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.FileLinePositionSpan.HasMappedPath">
<summary>
True if the <see cref="P:Microsoft.CodeAnalysis.FileLinePositionSpan.Path"/> is a mapped path.
</summary>
<remarks>
A mapped path is a path specified in source via <c>#line</c> (C#) or <c>#ExternalSource</c> (VB) directives.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.FileLinePositionSpan.StartLinePosition">
<summary>
Gets the <see cref="T:Microsoft.CodeAnalysis.Text.LinePosition"/> of the start of the span.
</summary>
<returns></returns>
</member>
<member name="P:Microsoft.CodeAnalysis.FileLinePositionSpan.EndLinePosition">
<summary>
Gets the <see cref="T:Microsoft.CodeAnalysis.Text.LinePosition"/> of the end of the span.
</summary>
<returns></returns>
</member>
<member name="P:Microsoft.CodeAnalysis.FileLinePositionSpan.Span">
<summary>
Gets the span.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.FileLinePositionSpan.#ctor(System.String,Microsoft.CodeAnalysis.Text.LinePosition,Microsoft.CodeAnalysis.Text.LinePosition)">
<summary>
Initializes the <see cref="T:Microsoft.CodeAnalysis.FileLinePositionSpan"/> instance.
</summary>
<param name="path">The file identifier - typically a relative or absolute path.</param>
<param name="start">The start line position.</param>
<param name="end">The end line position.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is null.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.FileLinePositionSpan.#ctor(System.String,Microsoft.CodeAnalysis.Text.LinePositionSpan)">
<summary>
Initializes the <see cref="T:Microsoft.CodeAnalysis.FileLinePositionSpan"/> instance.
</summary>
<param name="path">The file identifier - typically a relative or absolute path.</param>
<param name="span">The span.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is null.</exception>
</member>
<member name="P:Microsoft.CodeAnalysis.FileLinePositionSpan.IsValid">
<summary>
Returns true if the span represents a valid location.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.FileLinePositionSpan.Equals(Microsoft.CodeAnalysis.FileLinePositionSpan)">
<summary>
Determines if two FileLinePositionSpan objects are equal.
</summary>
<remarks>
The path is treated as an opaque string, i.e. a case-sensitive comparison is used.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.FileLinePositionSpan.Equals(System.Object)">
<summary>
Determines if two FileLinePositionSpan objects are equal.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.FileLinePositionSpan.GetHashCode">
<summary>
Serves as a hash function for FileLinePositionSpan.
</summary>
<returns>The hash code.</returns>
<remarks>
The path is treated as an opaque string, i.e. a case-sensitive hash is calculated.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.FileLinePositionSpan.ToString">
<summary>
Returns a <see cref="T:System.String"/> that represents FileLinePositionSpan.
</summary>
<returns>The string representation of FileLinePositionSpan.</returns>
<example>Path: (0,0)-(5,6)</example>
</member>
<member name="T:Microsoft.CodeAnalysis.LocalizableResourceString">
<summary>
A localizable resource string that may possibly be formatted differently depending on culture.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.LocalizableResourceString.#ctor(System.String,System.Resources.ResourceManager,System.Type)">
<summary>
Creates a localizable resource string with no formatting arguments.
</summary>
<param name="nameOfLocalizableResource">nameof the resource that needs to be localized.</param>
<param name="resourceManager"><see cref="T:System.Resources.ResourceManager"/> for the calling assembly.</param>
<param name="resourceSource">Type handling assembly's resource management. Typically, this is the static class generated for the resources file from which resources are accessed.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.LocalizableResourceString.#ctor(System.String,System.Resources.ResourceManager,System.Type,System.String[])">
<summary>
Creates a localizable resource string that may possibly be formatted differently depending on culture.
</summary>
<param name="nameOfLocalizableResource">nameof the resource that needs to be localized.</param>
<param name="resourceManager"><see cref="T:System.Resources.ResourceManager"/> for the calling assembly.</param>
<param name="resourceSource">Type handling assembly's resource management. Typically, this is the static class generated for the resources file from which resources are accessed.</param>
<param name="formatArguments">Optional arguments for formatting the localizable resource string.</param>
</member>
<member name="T:Microsoft.CodeAnalysis.LocalizableString">
<summary>
A string that may possibly be formatted differently depending on culture.
NOTE: Types implementing <see cref="T:Microsoft.CodeAnalysis.LocalizableString"/> must be serializable.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.LocalizableString.FixedLocalizableString.s_empty">
<summary>
FixedLocalizableString representing an empty string.
</summary>
</member>
<member name="E:Microsoft.CodeAnalysis.LocalizableString.OnException">
<summary>
Fired when an exception is raised by any of the public methods of <see cref="T:Microsoft.CodeAnalysis.LocalizableString"/>.
If the exception handler itself throws an exception, that exception is ignored.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.LocalizableString.ToString(System.IFormatProvider)">
<summary>
Formats the value of the current instance using the optionally specified format.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.LocalizableString.GetText(System.IFormatProvider)">
<summary>
Formats the value of the current instance using the optionally specified format.
Provides the implementation of ToString. ToString will provide a default value
if this method throws an exception.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.LocalizableString.GetHash">
<summary>
Provides the implementation of GetHashCode. GetHashCode will provide a default value
if this method throws an exception.
</summary>
<returns></returns>
</member>
<member name="M:Microsoft.CodeAnalysis.LocalizableString.AreEqual(System.Object)">
<summary>
Provides the implementation of Equals. Equals will provide a default value
if this method throws an exception.
</summary>
<returns></returns>
</member>
<member name="P:Microsoft.CodeAnalysis.LocalizableString.CanThrowExceptions">
<summary>
Flag indicating if any methods on this type can throw exceptions from public entrypoints.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Location">
<summary>
A program location in source code.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Location.Kind">
<summary>
Location kind (None/SourceFile/MetadataFile).
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Location.IsInSource">
<summary>
Returns true if the location represents a specific location in a source code file.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Location.IsInMetadata">
<summary>
Returns true if the location is in metadata.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Location.SourceTree">
<summary>
The syntax tree this location is located in or <c>null</c> if not in a syntax tree.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Location.MetadataModule">
<summary>
Returns the metadata module the location is associated with or <c>null</c> if the module is not available.
</summary>
<remarks>
Might return null even if <see cref="P:Microsoft.CodeAnalysis.Location.IsInMetadata"/> returns true. The module symbol might not be available anymore,
for example, if the location is serialized and deserialized.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Location.SourceSpan">
<summary>
The location within the syntax tree that this location is associated with.
</summary>
<remarks>
If <see cref="P:Microsoft.CodeAnalysis.Location.IsInSource"/> returns False this method returns an empty <see cref="T:Microsoft.CodeAnalysis.Text.TextSpan"/> which starts at position 0.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.Location.GetLineSpan">
<summary>
Gets the location in terms of path, line and column.
</summary>
<returns>
<see cref="T:Microsoft.CodeAnalysis.FileLinePositionSpan"/> that contains path, line and column information.
Returns an invalid span (see <see cref="P:Microsoft.CodeAnalysis.FileLinePositionSpan.IsValid"/>) if the information is not available.
The values are not affected by line mapping directives (#line in C# or #ExternalSource in VB).
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Location.GetMappedLineSpan">
<summary>
Gets the location in terms of path, line and column after applying source line mapping directives
(<c>#line</c> in C# or <c>#ExternalSource</c> in VB).
</summary>
<returns>
<see cref="T:Microsoft.CodeAnalysis.FileLinePositionSpan"/> that contains file, line and column information,
or an invalid span (see <see cref="P:Microsoft.CodeAnalysis.FileLinePositionSpan.IsValid"/>) if not available.
</returns>
</member>
<member name="P:Microsoft.CodeAnalysis.Location.None">
<summary>
A location of kind LocationKind.None.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Location.Create(Microsoft.CodeAnalysis.SyntaxTree,Microsoft.CodeAnalysis.Text.TextSpan)">
<summary>
Creates an instance of a <see cref="T:Microsoft.CodeAnalysis.Location"/> for a span in a <see cref="T:Microsoft.CodeAnalysis.SyntaxTree"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Location.Create(System.String,Microsoft.CodeAnalysis.Text.TextSpan,Microsoft.CodeAnalysis.Text.LinePositionSpan)">
<summary>
Creates an instance of a <see cref="T:Microsoft.CodeAnalysis.Location"/> for a span in a file.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.LocationKind">
<summary>
Specifies the kind of location (source vs. metadata).
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.LocationKind.None">
<summary>
Unspecified location.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.LocationKind.SourceFile">
<summary>
The location represents a position in a source file.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.LocationKind.MetadataFile">
<summary>
The location represents a metadata file.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.LocationKind.XmlFile">
<summary>
The location represents a position in an XML file.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.LocationKind.ExternalFile">
<summary>
The location in some external file.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.MetadataLocation">
<summary>
A program location in metadata.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.NoLocation">
<summary>
A class that represents no location at all. Useful for errors in command line options, for example.
</summary>
<remarks></remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.ReportDiagnostic">
<summary>
Describes how to report a warning diagnostic.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.ReportDiagnostic.Default">
<summary>
Report a diagnostic by default.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.ReportDiagnostic.Error">
<summary>
Report a diagnostic as an error.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.ReportDiagnostic.Warn">
<summary>
Report a diagnostic as a warning even though /warnaserror is specified.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.ReportDiagnostic.Info">
<summary>
Report a diagnostic as an info.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.ReportDiagnostic.Hidden">
<summary>
Report a diagnostic as hidden.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.ReportDiagnostic.Suppress">
<summary>
Suppress a diagnostic.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.SourceLocation">
<summary>
A program location in source code.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.SuppressionDescriptor">
<summary>
Provides a description about a programmatic suppression of a <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/> by a <see cref="T:Microsoft.CodeAnalysis.Diagnostics.DiagnosticSuppressor"/>.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SuppressionDescriptor.Id">
<summary>
An unique identifier for the suppression.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SuppressionDescriptor.SuppressedDiagnosticId">
<summary>
Identifier of the suppressed diagnostic, i.e. <see cref="P:Microsoft.CodeAnalysis.Diagnostic.Id"/>.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SuppressionDescriptor.Justification">
<summary>
A localizable justification about the suppression.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SuppressionDescriptor.#ctor(System.String,System.String,System.String)">
<summary>
Create a SuppressionDescriptor, which provides a justification about a programmatic suppression of a <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>.
NOTE: For localizable <paramref name="justification"/>,
use constructor overload <see cref="M:Microsoft.CodeAnalysis.SuppressionDescriptor.#ctor(System.String,System.String,Microsoft.CodeAnalysis.LocalizableString)"/>.
</summary>
<param name="id">A unique identifier for the suppression. For example, suppression ID "SP1001".</param>
<param name="suppressedDiagnosticId">Identifier of the suppressed diagnostic, i.e. <see cref="P:Microsoft.CodeAnalysis.Diagnostic.Id"/>. For example, compiler warning Id "CS0649".</param>
<param name="justification">Justification for the suppression. For example: "Suppress CS0649 on fields marked with YYY attribute as they are implicitly assigned.".</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SuppressionDescriptor.#ctor(System.String,System.String,Microsoft.CodeAnalysis.LocalizableString)">
<summary>
Create a SuppressionDescriptor, which provides a localizable justification about a programmatic suppression of a <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>.
</summary>
<param name="id">A unique identifier for the suppression. For example, suppression ID "SP1001".</param>
<param name="suppressedDiagnosticId">Identifier of the suppressed diagnostic, i.e. <see cref="P:Microsoft.CodeAnalysis.Diagnostic.Id"/>. For example, compiler warning Id "CS0649".</param>
<param name="justification">Justification for the suppression. For example: "Suppress CS0649 on fields marked with YYY attribute as they are implicitly assigned.".</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SuppressionDescriptor.IsDisabled(Microsoft.CodeAnalysis.CompilationOptions)">
<summary>
Returns a flag indicating if the suppression is disabled for the given <see cref="T:Microsoft.CodeAnalysis.CompilationOptions"/>.
</summary>
<param name="compilationOptions">Compilation options</param>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownDiagnosticTags.Unnecessary">
<summary>
Indicates that the diagnostic is related to some unnecessary source code.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownDiagnosticTags.EditAndContinue">
<summary>
Indicates that the diagnostic is related to edit and continue.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownDiagnosticTags.Build">
<summary>
Indicates that the diagnostic is related to build.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownDiagnosticTags.Compiler">
<summary>
Indicates that the diagnostic is reported by the compiler.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownDiagnosticTags.Telemetry">
<summary>
Indicates that the diagnostic can be used for telemetry
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownDiagnosticTags.NotConfigurable">
<summary>
Indicates that the diagnostic is not configurable, i.e. it cannot be suppressed or filtered or have its severity changed.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownDiagnosticTags.AnalyzerException">
<summary>
Indicates that the diagnostic is related to an exception thrown by a <see cref="T:Microsoft.CodeAnalysis.Diagnostics.DiagnosticAnalyzer"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownDiagnosticTags.CustomObsolete">
<summary>
Indicates that the diagnostic is an obsolete diagnostic with a custom ID
specified by the 'DiagnosticId' property on 'ObsoleteAttribute'.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownDiagnosticTags.CompilationEnd">
<summary>
Indicates that the diagnostic is a compilation end diagnostic reported
from a compilation end action.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.XmlLocation">
<summary>
A program location in an XML file.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.DocumentationCommentId">
<summary>
APIs for constructing documentation comment id's, and finding symbols that match ids.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.DocumentationCommentId.CreateDeclarationId(Microsoft.CodeAnalysis.ISymbol)">
<summary>
Creates an id string used by external documentation comment files to identify declarations
of types, namespaces, methods, properties, etc.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.DocumentationCommentId.CreateReferenceId(Microsoft.CodeAnalysis.ISymbol)">
<summary>
Creates an id string used to reference type symbols (not strictly declarations, includes
arrays, pointers, type parameters, etc.)
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.DocumentationCommentId.GetSymbolsForDeclarationId(System.String,Microsoft.CodeAnalysis.Compilation)">
<summary>
Gets all declaration symbols that match the declaration id string
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.DocumentationCommentId.TryGetSymbolsForDeclarationId(System.String,Microsoft.CodeAnalysis.Compilation,System.Collections.Generic.List{Microsoft.CodeAnalysis.ISymbol})">
<summary>
Try to get all the declaration symbols that match the declaration id string.
Returns true if at least one symbol matches.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.DocumentationCommentId.GetFirstSymbolForDeclarationId(System.String,Microsoft.CodeAnalysis.Compilation)">
<summary>
Gets the first declaration symbol that matches the declaration id string, order undefined.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.DocumentationCommentId.GetSymbolsForReferenceId(System.String,Microsoft.CodeAnalysis.Compilation)">
<summary>
Gets the symbols that match the reference id string.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.DocumentationCommentId.TryGetSymbolsForReferenceId(System.String,Microsoft.CodeAnalysis.Compilation,System.Collections.Generic.List{Microsoft.CodeAnalysis.ISymbol})">
<summary>
Try to get all symbols that match the reference id string.
Returns true if at least one symbol matches.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.DocumentationCommentId.GetFirstSymbolForReferenceId(System.String,Microsoft.CodeAnalysis.Compilation)">
<summary>
Gets the first symbol that matches the reference id string, order undefined.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.DocumentationCommentIncludeCache.CacheMissCount">
<summary>
WARN: This is a test hook - do not take a dependency on this.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.DocumentationCommentIncludeCache.MakeValue(Microsoft.CodeAnalysis.XmlReferenceResolver,System.String)">
<exception cref="T:System.IO.IOException"></exception>
<exception cref="T:System.Xml.XmlException"></exception>
<exception cref="T:System.InvalidOperationException"></exception>
</member>
<member name="T:Microsoft.CodeAnalysis.DocumentationProvider">
<summary>
A class used to provide XML documentation to the compiler for members from metadata. A
custom implementation of this class should be returned from a DocumentationResolver to provide XML
documentation comments from custom caches or locations.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.DocumentationProvider.GetDocumentationForSymbol(System.String,System.Globalization.CultureInfo,System.Threading.CancellationToken)">
<summary>
Fetches a documentation comment for the given member ID.
</summary>
<param name="documentationMemberID">The documentation member ID of the item to fetch.</param>
<param name="preferredCulture">The preferred culture to receive a comment in. Null if
there is no preference. This is a preference only, and providers may choose to provide
results from another culture if the preferred culture was unavailable.</param>
<param name="cancellationToken">A cancellation token for the search.</param>
<returns>A DocumentationComment.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.DocumentationProvider.Equals(System.Object)">
<summary>
DocumentationProviders are compared when determining whether an AssemblySymbol can be reused.
Hence, if multiple instances can represent the same documentation, it is imperative that
Equals (and GetHashCode) be overridden to capture this fact. Otherwise, it is possible to end
up with multiple AssemblySymbols for the same assembly, which plays havoc with the type hierarchy.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.DocumentationProvider.GetHashCode">
<summary>
DocumentationProviders are compared when determining whether an AssemblySymbol can be reused.
Hence, if multiple instances can represent the same documentation, it is imperative that
GetHashCode (and Equals) be overridden to capture this fact. Otherwise, it is possible to end
up with multiple AssemblySymbols for the same assembly, which plays havoc with the type hierarchy.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.DocumentationProvider.NullDocumentationProvider">
<summary>
A trivial DocumentationProvider which never returns documentation.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.XmlDocumentationCommentTextReader">
<summary>
Used by the DocumentationCommentCompiler(s) to check doc comments for XML parse errors.
As a performance optimization, this class tries to re-use the same underlying <see cref="T:System.Xml.XmlReader"/> instance
when possible.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.XmlDocumentationCommentTextReader.Reader._text">
<summary>
Current text to validate.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.XmlDocumentationCommentTextReader.Reader.maxReadsPastTheEnd">
<summary>
We use <see cref="T:System.Xml.XmlReader"/> to validate XML doc comments. Unfortunately it cannot be reset and thus can't be pooled.
Each time we need to validate a fragment of XML we "append" it to the underlying text reader, implemented by this class,
and advance the reader. By the end of the fragment validation, we keep the reader open in a state
that is ready for the next fragment validation unless the fragment was invalid, in which case we need to create a new XmlReader.
That is why <see cref="M:Microsoft.CodeAnalysis.XmlDocumentationCommentTextReader.Reader.Read(System.Char[],System.Int32,System.Int32)"/> pretends that the stream has extra <see cref="F:Microsoft.CodeAnalysis.XmlDocumentationCommentTextReader.Reader.maxReadsPastTheEnd"/> spaces
at the end. That should be sufficient for <see cref="T:System.Xml.XmlReader"/> to not reach the end of this reader before the next
fragment is appended, unless the current fragment is malformed in one way or another.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.DocumentationMode">
<summary>
Specifies the different documentation comment processing modes.
</summary>
<remarks>
Order matters: least processing to most processing.
</remarks>
</member>
<member name="F:Microsoft.CodeAnalysis.DocumentationMode.None">
<summary>
Treats documentation comments as regular comments.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.DocumentationMode.Parse">
<summary>
Parses documentation comments as structured trivia, but do not report any diagnostics.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.DocumentationMode.Diagnose">
<summary>
Parses documentation comments as structured trivia and report diagnostics.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.EmbeddedText">
<summary>
Represents text to be embedded in a PDB.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.EmbeddedText.CompressionThreshold">
<summary>
The maximum number of bytes in to write out uncompressed.
This prevents wasting resources on compressing tiny files with little to negative gain
in PDB file size.
Chosen as the point at which we start to see > 10% blob size reduction using all
current source files in corefx and roslyn as sample data.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.EmbeddedText.FilePath">
<summary>
The path to the file to embed.
</summary>
<remarks>See remarks of <see cref="P:Microsoft.CodeAnalysis.SyntaxTree.FilePath"/></remarks>
<remarks>Empty file paths are disallowed, as the debugger finds source by looking up files by their name (and then verifying their signature)</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.EmbeddedText.ChecksumAlgorithm">
<summary>
Hash algorithm to use to calculate checksum of the text that's saved to PDB.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.EmbeddedText.Checksum">
<summary>
The <see cref="P:Microsoft.CodeAnalysis.EmbeddedText.ChecksumAlgorithm"/> hash of the uncompressed bytes
that's saved to the PDB.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.EmbeddedText.Blob">
<summary>
The content that will be written to the PDB.
</summary>
<remarks>
Internal since this is an implementation detail. The only public
contract is that you can pass EmbeddedText instances to Emit.
It just so happened that doing this up-front was most practical
and efficient, but we don't want to be tied to it.
For efficiency, the format of this blob is exactly as it is written
to the PDB,which prevents extra copies being made during emit.
The first 4 bytes (little endian int32) indicate the format:
0: data that follows is uncompressed
Positive: data that follows is deflate compressed and value is original, uncompressed size
Negative: invalid at this time, but reserved to mark a different format in the future.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.EmbeddedText.FromSource(System.String,Microsoft.CodeAnalysis.Text.SourceText)">
<summary>
Constructs a <see cref="T:Microsoft.CodeAnalysis.EmbeddedText"/> for embedding the given <see cref="T:Microsoft.CodeAnalysis.Text.SourceText"/>.
</summary>
<param name="filePath">The file path (pre-normalization) to use in the PDB.</param>
<param name="text">The source text to embed.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="filePath"/> is null.
<paramref name="text"/> is null.
</exception>
<exception cref="T:System.ArgumentException">
<paramref name="filePath"/> empty.
<paramref name="text"/> cannot be embedded (see <see cref="P:Microsoft.CodeAnalysis.Text.SourceText.CanBeEmbedded"/>).
</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.EmbeddedText.FromStream(System.String,System.IO.Stream,Microsoft.CodeAnalysis.Text.SourceHashAlgorithm)">
<summary>
Constructs an <see cref="T:Microsoft.CodeAnalysis.EmbeddedText"/> from stream content.
</summary>
<param name="filePath">The file path (pre-normalization) to use in the PDB.</param>
<param name="stream">The stream.</param>
<param name="checksumAlgorithm">Hash algorithm to use to calculate checksum of the text that's saved to PDB.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="filePath" /> is null.
<paramref name="stream"/> is null.
</exception>
<exception cref="T:System.ArgumentException">
<paramref name="filePath" /> is empty.
<paramref name="stream"/> doesn't support reading or seeking.
<paramref name="checksumAlgorithm"/> is not supported.
</exception>
<exception cref="T:System.IO.IOException">An I/O error occurs.</exception>
<remarks>Reads from the beginning of the stream. Leaves the stream open.</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.EmbeddedText.FromBytes(System.String,System.ArraySegment{System.Byte},Microsoft.CodeAnalysis.Text.SourceHashAlgorithm)">
<summary>
Constructs an <see cref="T:Microsoft.CodeAnalysis.EmbeddedText"/> from bytes.
</summary>
<param name="filePath">The file path (pre-normalization) to use in the PDB.</param>
<param name="bytes">The bytes.</param>
<param name="checksumAlgorithm">Hash algorithm to use to calculate checksum of the text that's saved to PDB.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="bytes"/> is default-initialized.
<paramref name="filePath" /> is null.
</exception>
<exception cref="T:System.ArgumentException">
<paramref name="filePath" /> is empty.
<paramref name="checksumAlgorithm"/> is not supported.
</exception>
<exception cref="T:System.IO.IOException">An I/O error occurs.</exception>
<remarks>Reads from the beginning of the stream. Leaves the stream open.</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.EmbeddedText.ValidateFilePath(System.String)">
<exception cref="T:System.ArgumentNullException"><paramref name="filePath"/> is null.</exception>
<exception cref="T:System.ArgumentException"><paramref name="filePath"/> is empty.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.EmbeddedText.CreateBlob(System.IO.Stream)">
<summary>
Creates the blob to be saved to the PDB.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Text.EncodedStringText.s_utf8Encoding">
<summary>
Encoding to use when there is no byte order mark (BOM) on the stream. This encoder may throw a <see cref="T:System.Text.DecoderFallbackException"/>
if the stream contains invalid UTF-8 bytes.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.EncodedStringText.CreateFallbackEncoding">
<summary>
Encoding to use when UTF-8 fails. We try to find the following, in order, if available:
1. The default ANSI codepage
2. CodePage 1252.
3. Latin1.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.EncodedStringText.Create(System.IO.Stream,System.Text.Encoding,Microsoft.CodeAnalysis.Text.SourceHashAlgorithm,System.Boolean)">
<summary>
Initializes an instance of <see cref="T:Microsoft.CodeAnalysis.Text.SourceText"/> from the provided stream. This version differs
from <see cref="M:Microsoft.CodeAnalysis.Text.SourceText.From(System.IO.Stream,System.Text.Encoding,Microsoft.CodeAnalysis.Text.SourceHashAlgorithm,System.Boolean)"/> in two ways:
1. It attempts to minimize allocations by trying to read the stream into a byte array.
2. If <paramref name="defaultEncoding"/> is null, it will first try UTF8 and, if that fails, it will
try CodePage 1252. If CodePage 1252 is not available on the system, then it will try Latin1.
</summary>
<param name="stream">The stream containing encoded text.</param>
<param name="defaultEncoding">
Specifies an encoding to be used if the actual encoding can't be determined from the stream content (the stream doesn't start with Byte Order Mark).
If not specified auto-detect heuristics are used to determine the encoding. If these heuristics fail the decoding is assumed to be Encoding.Default.
Note that if the stream starts with Byte Order Mark the value of <paramref name="defaultEncoding"/> is ignored.
</param>
<param name="canBeEmbedded">Indicates if the file can be embedded in the PDB.</param>
<param name="checksumAlgorithm">Hash algorithm used to calculate document checksum.</param>
<exception cref="T:System.IO.InvalidDataException">
The stream content can't be decoded using the specified <paramref name="defaultEncoding"/>, or
<paramref name="defaultEncoding"/> is null and the stream appears to be a binary file.
</exception>
<exception cref="T:System.IO.IOException">An IO error occurred while reading from the stream.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.EncodedStringText.Decode(System.IO.Stream,System.Text.Encoding,Microsoft.CodeAnalysis.Text.SourceHashAlgorithm,System.Boolean,System.Boolean)">
<summary>
Try to create a <see cref="T:Microsoft.CodeAnalysis.Text.SourceText"/> from the given stream using the given encoding.
</summary>
<param name="data">The input stream containing the encoded text. The stream will not be closed.</param>
<param name="encoding">The expected encoding of the stream. The actual encoding used may be different if byte order marks are detected.</param>
<param name="checksumAlgorithm">The checksum algorithm to use.</param>
<param name="throwIfBinaryDetected">Throw <see cref="T:System.IO.InvalidDataException"/> if binary (non-text) data is detected.</param>
<param name="canBeEmbedded">Indicates if the text can be embedded in the PDB.</param>
<returns>The <see cref="T:Microsoft.CodeAnalysis.Text.SourceText"/> decoded from the stream.</returns>
<exception cref="T:System.Text.DecoderFallbackException">The decoder was unable to decode the stream with the given encoding.</exception>
<exception cref="T:System.IO.IOException">Error reading from stream.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.EncodedStringText.TryGetBytesFromStream(System.IO.Stream,System.ArraySegment{System.Byte}@)">
<summary>
Some streams are easily represented as bytes.
</summary>
<param name="data">The stream</param>
<param name="bytes">The bytes, if available.</param>
<returns>
True if the stream's bytes could easily be read, false otherwise.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.EncodedStringText.TryGetBytesFromFileStream(System.IO.FileStream,System.ArraySegment{System.Byte}@)">
<summary>
Read the contents of a FileStream into a byte array.
</summary>
<param name="stream">The FileStream with encoded text.</param>
<param name="bytes">A byte array filled with the contents of the file.</param>
<returns>True if a byte array could be created.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.ChangedText.GetLinesCore">
<summary>
Computes line starts faster given already computed line starts from text before the change.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Text.CompositeText">
<summary>
A composite of a sequence of <see cref="T:Microsoft.CodeAnalysis.Text.SourceText"/>s.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.CompositeText.CheckCopyToArguments(System.Int32,System.Char[],System.Int32,System.Int32)">
<summary>
Validates the arguments passed to <see cref="M:Microsoft.CodeAnalysis.Text.CompositeText.CopyTo(System.Int32,System.Char[],System.Int32,System.Int32)"/> against the published contract.
</summary>
<returns>True if should bother to proceed with copying.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.CompositeText.ReduceSegmentCountIfNecessary(Microsoft.CodeAnalysis.PooledObjects.ArrayBuilder{Microsoft.CodeAnalysis.Text.SourceText})">
<summary>
Reduces the number of segments toward the target number of segments,
if the number of segments is deemed to be too large (beyond the maximum).
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.CompositeText.GetMinimalSegmentSizeToUseForCombining(Microsoft.CodeAnalysis.PooledObjects.ArrayBuilder{Microsoft.CodeAnalysis.Text.SourceText})">
<summary>
Determines the segment size to use for call to CombineSegments, that will result in the segment count
being reduced to less than or equal to the target segment count.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.CompositeText.GetSegmentCountIfCombined(Microsoft.CodeAnalysis.PooledObjects.ArrayBuilder{Microsoft.CodeAnalysis.Text.SourceText},System.Int32)">
<summary>
Determines the segment count that would result if the segments of size less than or equal to
the specified segment size were to be combined.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.CompositeText.CombineSegments(Microsoft.CodeAnalysis.PooledObjects.ArrayBuilder{Microsoft.CodeAnalysis.Text.SourceText},System.Int32)">
<summary>
Combines contiguous segments with lengths that are each less than or equal to the specified segment size.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.CompositeText.ComputeLengthAndStorageSize(System.Collections.Generic.IReadOnlyList{Microsoft.CodeAnalysis.Text.SourceText},System.Int32@,System.Int32@)">
<summary>
Compute total text length and total size of storage buffers held
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.CompositeText.TrimInaccessibleText(Microsoft.CodeAnalysis.PooledObjects.ArrayBuilder{Microsoft.CodeAnalysis.Text.SourceText})">
<summary>
Trim excessive inaccessible text.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Text.LargeText">
<summary>
A <see cref="T:Microsoft.CodeAnalysis.Text.SourceText"/> optimized for very large sources. The text is stored as
a list of chunks (char arrays).
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Text.LargeText.ChunkSize">
<remarks>
internal for unit testing
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.LargeText.IsBinary(System.Char[])">
<summary>
Check for occurrence of two consecutive NUL (U+0000) characters.
This is unlikely to appear in genuine text, so it's a good heuristic
to detect binary files.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.LargeText.GetLinesCore">
<summary>
Called from <see cref="P:Microsoft.CodeAnalysis.Text.SourceText.Lines"/> to initialize the <see cref="T:Microsoft.CodeAnalysis.Text.TextLineCollection"/>. Thereafter,
the collection is cached.
</summary>
<returns>A new <see cref="T:Microsoft.CodeAnalysis.Text.TextLineCollection"/> representing the individual text lines.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.LargeTextWriter.AppendChunk(System.Char[])">
<summary>
Append chunk to writer (may reuse char array)
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Text.LinePosition">
<summary>
Immutable representation of a line number and position within a SourceText instance.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Text.LinePosition.Zero">
<summary>
A <see cref="T:Microsoft.CodeAnalysis.Text.LinePosition"/> that represents position 0 at line 0.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.LinePosition.#ctor(System.Int32,System.Int32)">
<summary>
Initializes a new instance of a <see cref="T:Microsoft.CodeAnalysis.Text.LinePosition"/> with the given line and character.
</summary>
<param name="line">
The line of the line position. The first line in a file is defined as line 0 (zero based line numbering).
</param>
<param name="character">
The character position in the line.
</param>
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="line"/> or <paramref name="character"/> is less than zero. </exception>
</member>
<member name="P:Microsoft.CodeAnalysis.Text.LinePosition.Line">
<summary>
The line number. The first line in a file is defined as line 0 (zero based line numbering).
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Text.LinePosition.Character">
<summary>
The character position within the line.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.LinePosition.op_Equality(Microsoft.CodeAnalysis.Text.LinePosition,Microsoft.CodeAnalysis.Text.LinePosition)">
<summary>
Determines whether two <see cref="T:Microsoft.CodeAnalysis.Text.LinePosition"/> are the same.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.LinePosition.op_Inequality(Microsoft.CodeAnalysis.Text.LinePosition,Microsoft.CodeAnalysis.Text.LinePosition)">
<summary>
Determines whether two <see cref="T:Microsoft.CodeAnalysis.Text.LinePosition"/> are different.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.LinePosition.Equals(Microsoft.CodeAnalysis.Text.LinePosition)">
<summary>
Determines whether two <see cref="T:Microsoft.CodeAnalysis.Text.LinePosition"/> are the same.
</summary>
<param name="other">The object to compare.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.LinePosition.Equals(System.Object)">
<summary>
Determines whether two <see cref="T:Microsoft.CodeAnalysis.Text.LinePosition"/> are the same.
</summary>
<param name="obj">The object to compare.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.LinePosition.GetHashCode">
<summary>
Provides a hash function for <see cref="T:Microsoft.CodeAnalysis.Text.LinePosition"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.LinePosition.ToString">
<summary>
Provides a string representation for <see cref="T:Microsoft.CodeAnalysis.Text.LinePosition"/>.
</summary>
<example>0,10</example>
</member>
<member name="T:Microsoft.CodeAnalysis.Text.LinePositionSpan">
<summary>
Immutable span represented by a pair of line number and index within the line.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.LinePositionSpan.#ctor(Microsoft.CodeAnalysis.Text.LinePosition,Microsoft.CodeAnalysis.Text.LinePosition)">
<summary>
Creates <see cref="T:Microsoft.CodeAnalysis.Text.LinePositionSpan"/>.
</summary>
<param name="start">Start position.</param>
<param name="end">End position.</param>
<exception cref="T:System.ArgumentException"><paramref name="end"/> precedes <paramref name="start"/>.</exception>
</member>
<member name="P:Microsoft.CodeAnalysis.Text.LinePositionSpan.Start">
<summary>
Gets the start position of the span.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Text.LinePositionSpan.End">
<summary>
Gets the end position of the span.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.LinePositionSpan.ToString">
<summary>
Provides a string representation for <see cref="T:Microsoft.CodeAnalysis.Text.LinePositionSpan"/>.
</summary>
<example>(0,0)-(5,6)</example>
</member>
<member name="T:Microsoft.CodeAnalysis.Text.SourceHashAlgorithm">
<summary>
Specifies a hash algorithms used for hashing source files.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Text.SourceHashAlgorithm.None">
<summary>
No algorithm specified.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Text.SourceHashAlgorithm.Sha1">
<summary>
Secure Hash Algorithm 1.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Text.SourceHashAlgorithm.Sha256">
<summary>
Secure Hash Algorithm 2 with a hash size of 256 bits.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Text.SourceText">
<summary>
An abstraction of source text.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.SourceText.From(System.String,System.Text.Encoding,Microsoft.CodeAnalysis.Text.SourceHashAlgorithm)">
<summary>
Constructs a <see cref="T:Microsoft.CodeAnalysis.Text.SourceText"/> from text in a string.
</summary>
<param name="text">Text.</param>
<param name="encoding">
Encoding of the file that the <paramref name="text"/> was read from or is going to be saved to.
<c>null</c> if the encoding is unspecified.
If the encoding is not specified the resulting <see cref="T:Microsoft.CodeAnalysis.Text.SourceText"/> isn't debuggable.
If an encoding-less <see cref="T:Microsoft.CodeAnalysis.Text.SourceText"/> is written to a file a <see cref="P:System.Text.Encoding.UTF8"/> shall be used as a default.
</param>
<param name="checksumAlgorithm">
Hash algorithm to use to calculate checksum of the text that's saved to PDB.
</param>
<exception cref="T:System.ArgumentNullException"><paramref name="text"/> is null.</exception>
<exception cref="T:System.ArgumentException"><paramref name="checksumAlgorithm"/> is not supported.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.SourceText.From(System.IO.TextReader,System.Int32,System.Text.Encoding,Microsoft.CodeAnalysis.Text.SourceHashAlgorithm)">
<summary>
Constructs a <see cref="T:Microsoft.CodeAnalysis.Text.SourceText"/> from text in a string.
</summary>
<param name="reader">TextReader</param>
<param name="length">length of content from <paramref name="reader"/></param>
<param name="encoding">
Encoding of the file that the <paramref name="reader"/> was read from or is going to be saved to.
<c>null</c> if the encoding is unspecified.
If the encoding is not specified the resulting <see cref="T:Microsoft.CodeAnalysis.Text.SourceText"/> isn't debuggable.
If an encoding-less <see cref="T:Microsoft.CodeAnalysis.Text.SourceText"/> is written to a file a <see cref="P:System.Text.Encoding.UTF8"/> shall be used as a default.
</param>
<param name="checksumAlgorithm">
Hash algorithm to use to calculate checksum of the text that's saved to PDB.
</param>
<exception cref="T:System.ArgumentNullException"><paramref name="reader"/> is null.</exception>
<exception cref="T:System.ArgumentException"><paramref name="checksumAlgorithm"/> is not supported.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.SourceText.From(System.IO.Stream,System.Text.Encoding,Microsoft.CodeAnalysis.Text.SourceHashAlgorithm,System.Boolean,System.Boolean)">
<summary>
Constructs a <see cref="T:Microsoft.CodeAnalysis.Text.SourceText"/> from stream content.
</summary>
<param name="stream">Stream. The stream must be seekable.</param>
<param name="encoding">
Data encoding to use if the stream doesn't start with Byte Order Mark specifying the encoding.
<see cref="P:System.Text.Encoding.UTF8"/> if not specified.
</param>
<param name="checksumAlgorithm">
Hash algorithm to use to calculate checksum of the text that's saved to PDB.
</param>
<param name="throwIfBinaryDetected">If the decoded text contains at least two consecutive NUL
characters, then an <see cref="T:System.IO.InvalidDataException"/> is thrown.</param>
<param name="canBeEmbedded">True if the text can be passed to <see cref="M:Microsoft.CodeAnalysis.EmbeddedText.FromSource(System.String,Microsoft.CodeAnalysis.Text.SourceText)"/> and be embedded in a PDB.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="stream"/> is null.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="stream"/> doesn't support reading or seeking.
<paramref name="checksumAlgorithm"/> is not supported.
</exception>
<exception cref="T:System.Text.DecoderFallbackException">If the given encoding is set to use a throwing decoder as a fallback</exception>
<exception cref="T:System.IO.InvalidDataException">Two consecutive NUL characters were detected in the decoded text and <paramref name="throwIfBinaryDetected"/> was true.</exception>
<exception cref="T:System.IO.IOException">An I/O error occurs.</exception>
<remarks>Reads from the beginning of the stream. Leaves the stream open.</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.SourceText.From(System.Byte[],System.Int32,System.Text.Encoding,Microsoft.CodeAnalysis.Text.SourceHashAlgorithm,System.Boolean,System.Boolean)">
<summary>
Constructs a <see cref="T:Microsoft.CodeAnalysis.Text.SourceText"/> from a byte array.
</summary>
<param name="buffer">The encoded source buffer.</param>
<param name="length">The number of bytes to read from the buffer.</param>
<param name="encoding">
Data encoding to use if the encoded buffer doesn't start with Byte Order Mark.
<see cref="P:System.Text.Encoding.UTF8"/> if not specified.
</param>
<param name="checksumAlgorithm">
Hash algorithm to use to calculate checksum of the text that's saved to PDB.
</param>
<param name="throwIfBinaryDetected">If the decoded text contains at least two consecutive NUL
characters, then an <see cref="T:System.IO.InvalidDataException"/> is thrown.</param>
<returns>The decoded text.</returns>
<param name="canBeEmbedded">True if the text can be passed to <see cref="M:Microsoft.CodeAnalysis.EmbeddedText.FromSource(System.String,Microsoft.CodeAnalysis.Text.SourceText)"/> and be embedded in a PDB.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="buffer"/> is null.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="length"/> is negative or longer than the <paramref name="buffer"/>.</exception>
<exception cref="T:System.ArgumentException"><paramref name="checksumAlgorithm"/> is not supported.</exception>
<exception cref="T:System.Text.DecoderFallbackException">If the given encoding is set to use a throwing decoder as a fallback</exception>
<exception cref="T:System.IO.InvalidDataException">Two consecutive NUL characters were detected in the decoded text and <paramref name="throwIfBinaryDetected"/> was true.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.SourceText.Decode(System.IO.Stream,System.Text.Encoding,System.Text.Encoding@)">
<summary>
Decode text from a stream.
</summary>
<param name="stream">The stream containing encoded text.</param>
<param name="encoding">The encoding to use if an encoding cannot be determined from the byte order mark.</param>
<param name="actualEncoding">The actual encoding used.</param>
<returns>The decoded text.</returns>
<exception cref="T:System.Text.DecoderFallbackException">If the given encoding is set to use a throwing decoder as a fallback</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.SourceText.Decode(System.Byte[],System.Int32,System.Text.Encoding,System.Text.Encoding@)">
<summary>
Decode text from a byte array.
</summary>
<param name="buffer">The byte array containing encoded text.</param>
<param name="length">The count of valid bytes in <paramref name="buffer"/>.</param>
<param name="encoding">The encoding to use if an encoding cannot be determined from the byte order mark.</param>
<param name="actualEncoding">The actual encoding used.</param>
<returns>The decoded text.</returns>
<exception cref="T:System.Text.DecoderFallbackException">If the given encoding is set to use a throwing decoder as a fallback</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.SourceText.IsBinary(System.String)">
<summary>
Check for occurrence of two consecutive NUL (U+0000) characters.
This is unlikely to appear in genuine text, so it's a good heuristic
to detect binary files.
</summary>
<remarks>
internal for unit testing
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Text.SourceText.ChecksumAlgorithm">
<summary>
Hash algorithm to use to calculate checksum of the text that's saved to PDB.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Text.SourceText.Encoding">
<summary>
Encoding of the file that the text was read from or is going to be saved to.
<c>null</c> if the encoding is unspecified.
</summary>
<remarks>
If the encoding is not specified the source isn't debuggable.
If an encoding-less <see cref="T:Microsoft.CodeAnalysis.Text.SourceText"/> is written to a file a <see cref="P:System.Text.Encoding.UTF8"/> shall be used as a default.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Text.SourceText.Length">
<summary>
The length of the text in characters.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Text.SourceText.StorageSize">
<summary>
The size of the storage representation of the text (in characters).
This can differ from length when storage buffers are reused to represent fragments/subtext.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Text.SourceText.CanBeEmbedded">
<summary>
Indicates whether this source text can be embedded in the PDB.
</summary>
<remarks>
If this text was constructed via <see cref="M:Microsoft.CodeAnalysis.Text.SourceText.From(System.Byte[],System.Int32,System.Text.Encoding,Microsoft.CodeAnalysis.Text.SourceHashAlgorithm,System.Boolean,System.Boolean)"/> or
<see cref="M:Microsoft.CodeAnalysis.Text.SourceText.From(System.IO.Stream,System.Text.Encoding,Microsoft.CodeAnalysis.Text.SourceHashAlgorithm,System.Boolean,System.Boolean)"/>, then the canBeEmbedded arg must have
been true.
Otherwise, <see cref="P:Microsoft.CodeAnalysis.Text.SourceText.Encoding" /> must be non-null.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Text.SourceText.PrecomputedEmbeddedTextBlob">
<summary>
If the text was created from a stream or byte[] and canBeEmbedded argument was true,
this provides the embedded text blob that was precomputed using the original stream
or byte[]. The precomputation was required in that case so that the bytes written to
the PDB match the original bytes exactly (and match the checksum of the original
bytes).
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Text.SourceText.Item(System.Int32)">
<summary>
Returns a character at given position.
</summary>
<param name="position">The position to get the character from.</param>
<returns>The character.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">When position is negative or
greater than <see cref="P:Microsoft.CodeAnalysis.Text.SourceText.Length"/>.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.SourceText.CopyTo(System.Int32,System.Char[],System.Int32,System.Int32)">
<summary>
Copy a range of characters from this SourceText to a destination array.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Text.SourceText.Container">
<summary>
The container of this <see cref="T:Microsoft.CodeAnalysis.Text.SourceText"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.SourceText.GetSubText(Microsoft.CodeAnalysis.Text.TextSpan)">
<summary>
Gets a <see cref="T:Microsoft.CodeAnalysis.Text.SourceText"/> that contains the characters in the specified span of this text.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.SourceText.GetSubText(System.Int32)">
<summary>
Returns a <see cref="T:Microsoft.CodeAnalysis.Text.SourceText"/> that has the contents of this text including and after the start position.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.SourceText.Write(System.IO.TextWriter,System.Threading.CancellationToken)">
<summary>
Write this <see cref="T:Microsoft.CodeAnalysis.Text.SourceText"/> to a text writer.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.SourceText.Write(System.IO.TextWriter,Microsoft.CodeAnalysis.Text.TextSpan,System.Threading.CancellationToken)">
<summary>
Write a span of text to a text writer.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.SourceText.ToString">
<summary>
Provides a string representation of the SourceText.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.SourceText.ToString(Microsoft.CodeAnalysis.Text.TextSpan)">
<summary>
Gets a string containing the characters in specified span.
</summary>
<exception cref="T:System.ArgumentOutOfRangeException">When given span is outside of the text range.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.SourceText.WithChanges(System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.Text.TextChange})">
<summary>
Constructs a new SourceText from this text with the specified changes.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.SourceText.WithChanges(Microsoft.CodeAnalysis.Text.TextChange[])">
<summary>
Constructs a new SourceText from this text with the specified changes.
<exception cref="T:System.ArgumentException">If any changes are not in bounds of this <see cref="T:Microsoft.CodeAnalysis.Text.SourceText"/>.</exception>
<exception cref="T:System.ArgumentException">If any changes overlap other changes.</exception>
</summary>
<remarks>
Changes do not have to be in sorted order. However, <see cref="M:Microsoft.CodeAnalysis.Text.SourceText.WithChanges(System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.Text.TextChange})"/> will
perform better if they are.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.SourceText.Replace(Microsoft.CodeAnalysis.Text.TextSpan,System.String)">
<summary>
Returns a new SourceText with the specified span of characters replaced by the new text.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.SourceText.Replace(System.Int32,System.Int32,System.String)">
<summary>
Returns a new SourceText with the specified range of characters replaced by the new text.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.SourceText.GetChangeRanges(Microsoft.CodeAnalysis.Text.SourceText)">
<summary>
Gets the set of <see cref="T:Microsoft.CodeAnalysis.Text.TextChangeRange"/> that describe how the text changed
between this text an older version. This may be multiple detailed changes
or a single change encompassing the entire text.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.SourceText.GetTextChanges(Microsoft.CodeAnalysis.Text.SourceText)">
<summary>
Gets the set of <see cref="T:Microsoft.CodeAnalysis.Text.TextChange"/> that describe how the text changed
between this text and an older version. This may be multiple detailed changes
or a single change encompassing the entire text.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Text.SourceText.Lines">
<summary>
The collection of individual text lines.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.SourceText.GetLinesCore">
<summary>
Called from <see cref="P:Microsoft.CodeAnalysis.Text.SourceText.Lines"/> to initialize the <see cref="T:Microsoft.CodeAnalysis.Text.TextLineCollection"/>. Thereafter,
the collection is cached.
</summary>
<returns>A new <see cref="T:Microsoft.CodeAnalysis.Text.TextLineCollection"/> representing the individual text lines.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.SourceText.ContentEquals(Microsoft.CodeAnalysis.Text.SourceText)">
<summary>
Compares the content with content of another <see cref="T:Microsoft.CodeAnalysis.Text.SourceText"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.SourceText.ContentEqualsImpl(Microsoft.CodeAnalysis.Text.SourceText)">
<summary>
Implements equality comparison of the content of two different instances of <see cref="T:Microsoft.CodeAnalysis.Text.SourceText"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.SourceText.TryReadByteOrderMark(System.Byte[],System.Int32,System.Int32@)">
<summary>
Detect an encoding by looking for byte order marks.
</summary>
<param name="source">A buffer containing the encoded text.</param>
<param name="length">The length of valid data in the buffer.</param>
<param name="preambleLength">The length of any detected byte order marks.</param>
<returns>The detected encoding or null if no recognized byte order mark was present.</returns>
</member>
<member name="T:Microsoft.CodeAnalysis.Text.SourceTextContainer">
<summary>
An object that contains an instance of a SourceText and raises events when its current instance
changes.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Text.SourceTextContainer.CurrentText">
<summary>
The current text instance.
</summary>
</member>
<member name="E:Microsoft.CodeAnalysis.Text.SourceTextContainer.TextChanged">
<summary>
Raised when the current text instance changes.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Text.SourceTextStream">
<summary>
A read-only, non-seekable <see cref="T:System.IO.Stream"/> over a <see cref="T:Microsoft.CodeAnalysis.Text.SourceText"/>.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Text.StringBuilderText">
<summary>
Implementation of <see cref="T:Microsoft.CodeAnalysis.Text.SourceText"/> based on a <see cref="T:System.Text.StringBuilder"/> input
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Text.StringBuilderText._builder">
<summary>
Underlying string on which this SourceText instance is based
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Text.StringBuilderText.Builder">
<summary>
Underlying string which is the source of this SourceText instance
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Text.StringBuilderText.Length">
<summary>
The length of the text represented by <see cref="T:Microsoft.CodeAnalysis.Text.StringBuilderText"/>.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Text.StringBuilderText.Item(System.Int32)">
<summary>
Returns a character at given position.
</summary>
<param name="position">The position to get the character from.</param>
<returns>The character.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">When position is negative or
greater than <see cref="P:Microsoft.CodeAnalysis.Text.StringBuilderText.Length"/>.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.StringBuilderText.ToString(Microsoft.CodeAnalysis.Text.TextSpan)">
<summary>
Provides a string representation of the StringBuilderText located within given span.
</summary>
<exception cref="T:System.ArgumentOutOfRangeException">When given span is outside of the text range.</exception>
</member>
<member name="T:Microsoft.CodeAnalysis.Text.StringText">
<summary>
Implementation of SourceText based on a <see cref="T:System.String"/> input
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Text.StringText.Source">
<summary>
Underlying string which is the source of this <see cref="T:Microsoft.CodeAnalysis.Text.StringText"/>instance
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Text.StringText.Length">
<summary>
The length of the text represented by <see cref="T:Microsoft.CodeAnalysis.Text.StringText"/>.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Text.StringText.Item(System.Int32)">
<summary>
Returns a character at given position.
</summary>
<param name="position">The position to get the character from.</param>
<returns>The character.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">When position is negative or
greater than <see cref="P:Microsoft.CodeAnalysis.Text.StringText.Length"/>.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.StringText.ToString(Microsoft.CodeAnalysis.Text.TextSpan)">
<summary>
Provides a string representation of the StringText located within given span.
</summary>
<exception cref="T:System.ArgumentOutOfRangeException">When given span is outside of the text range.</exception>
</member>
<member name="T:Microsoft.CodeAnalysis.Text.SubText">
<summary>
A <see cref="T:Microsoft.CodeAnalysis.Text.SourceText"/> that represents a subrange of another <see cref="T:Microsoft.CodeAnalysis.Text.SourceText"/>.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Text.TextChange">
<summary>
Describes a single change when a particular span is replaced with a new text.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Text.TextChange.Span">
<summary>
The original span of the changed text.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Text.TextChange.NewText">
<summary>
The new text.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.TextChange.#ctor(Microsoft.CodeAnalysis.Text.TextSpan,System.String)">
<summary>
Initializes a new instance of <see cref="T:Microsoft.CodeAnalysis.Text.TextChange"/>
</summary>
<param name="span">The original span of the changed text.</param>
<param name="newText">The new text.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.TextChange.ToString">
<summary>
Provides a string representation for <see cref="T:Microsoft.CodeAnalysis.Text.TextChange"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.TextChange.op_Implicit(Microsoft.CodeAnalysis.Text.TextChange)~Microsoft.CodeAnalysis.Text.TextChangeRange">
<summary>
Converts a <see cref="T:Microsoft.CodeAnalysis.Text.TextChange"/> to a <see cref="T:Microsoft.CodeAnalysis.Text.TextChangeRange"/>.
</summary>
<param name="change"></param>
</member>
<member name="P:Microsoft.CodeAnalysis.Text.TextChange.NoChanges">
<summary>
An empty set of changes.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Text.TextChangeEventArgs">
<summary>
Represents state for a TextChanged event.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.TextChangeEventArgs.#ctor(Microsoft.CodeAnalysis.Text.SourceText,Microsoft.CodeAnalysis.Text.SourceText,System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.Text.TextChangeRange})">
<summary>
Initializes an instance of <see cref="T:Microsoft.CodeAnalysis.Text.TextChangeEventArgs"/>.
</summary>
<param name="oldText">The text before the change.</param>
<param name="newText">The text after the change.</param>
<param name="changes">A set of ranges for the change.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.TextChangeEventArgs.#ctor(Microsoft.CodeAnalysis.Text.SourceText,Microsoft.CodeAnalysis.Text.SourceText,Microsoft.CodeAnalysis.Text.TextChangeRange[])">
<summary>
Initializes an instance of <see cref="T:Microsoft.CodeAnalysis.Text.TextChangeEventArgs"/>.
</summary>
<param name="oldText">The text before the change.</param>
<param name="newText">The text after the change.</param>
<param name="changes">A set of ranges for the change.</param>
</member>
<member name="P:Microsoft.CodeAnalysis.Text.TextChangeEventArgs.OldText">
<summary>
Gets the text before the change.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Text.TextChangeEventArgs.NewText">
<summary>
Gets the text after the change.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Text.TextChangeEventArgs.Changes">
<summary>
Gets the set of ranges for the change.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Text.TextChangeRange">
<summary>
Represents the change to a span of text.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Text.TextChangeRange.Span">
<summary>
The span of text before the edit which is being changed
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Text.TextChangeRange.NewLength">
<summary>
Width of the span after the edit. A 0 here would represent a delete
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.TextChangeRange.#ctor(Microsoft.CodeAnalysis.Text.TextSpan,System.Int32)">
<summary>
Initializes a new instance of <see cref="T:Microsoft.CodeAnalysis.Text.TextChangeRange"/>.
</summary>
<param name="span"></param>
<param name="newLength"></param>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.TextChangeRange.Equals(Microsoft.CodeAnalysis.Text.TextChangeRange)">
<summary>
Compares current instance of <see cref="T:Microsoft.CodeAnalysis.Text.TextChangeRange"/> to another.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.TextChangeRange.Equals(System.Object)">
<summary>
Compares current instance of <see cref="T:Microsoft.CodeAnalysis.Text.TextChangeRange"/> to another.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.TextChangeRange.GetHashCode">
<summary>
Provides hash code for current instance of <see cref="T:Microsoft.CodeAnalysis.Text.TextChangeRange"/>.
</summary>
<returns></returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.TextChangeRange.op_Equality(Microsoft.CodeAnalysis.Text.TextChangeRange,Microsoft.CodeAnalysis.Text.TextChangeRange)">
<summary>
Determines if two instances of <see cref="T:Microsoft.CodeAnalysis.Text.TextChangeRange"/> are same.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.TextChangeRange.op_Inequality(Microsoft.CodeAnalysis.Text.TextChangeRange,Microsoft.CodeAnalysis.Text.TextChangeRange)">
<summary>
Determines if two instances of <see cref="T:Microsoft.CodeAnalysis.Text.TextChangeRange"/> are different.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Text.TextChangeRange.NoChanges">
<summary>
An empty set of changes.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.TextChangeRange.Collapse(System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.Text.TextChangeRange})">
<summary>
Collapse a set of <see cref="T:Microsoft.CodeAnalysis.Text.TextChangeRange"/>s into a single encompassing range. If
the set of ranges provided is empty, an empty range is returned.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Text.TextLine">
<summary>
Information about the character boundaries of a single line of text.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.TextLine.FromSpan(Microsoft.CodeAnalysis.Text.SourceText,Microsoft.CodeAnalysis.Text.TextSpan)">
<summary>
Creates a <see cref="T:Microsoft.CodeAnalysis.Text.TextLine"/> instance.
</summary>
<param name="text">The source text.</param>
<param name="span">The span of the line.</param>
<returns>An instance of <see cref="T:Microsoft.CodeAnalysis.Text.TextLine"/>.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">The span does not represent a text line.</exception>
</member>
<member name="P:Microsoft.CodeAnalysis.Text.TextLine.Text">
<summary>
Gets the source text.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Text.TextLine.LineNumber">
<summary>
Gets the zero-based line number.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Text.TextLine.Start">
<summary>
Gets the start position of the line.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Text.TextLine.End">
<summary>
Gets the end position of the line not including the line break.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Text.TextLine.EndIncludingLineBreak">
<summary>
Gets the end position of the line including the line break.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Text.TextLine.Span">
<summary>
Gets the line span not including the line break.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Text.TextLine.SpanIncludingLineBreak">
<summary>
Gets the line span including the line break.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Text.TextLineCollection">
<summary>
Abstract base class for <see cref="T:Microsoft.CodeAnalysis.Text.TextLine"/> collections.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Text.TextLineCollection.Count">
<summary>
The count of <see cref="T:Microsoft.CodeAnalysis.Text.TextLine"/> items in the collection
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Text.TextLineCollection.Item(System.Int32)">
<summary>
Gets the <see cref="T:Microsoft.CodeAnalysis.Text.TextLine"/> item at the specified index.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.TextLineCollection.IndexOf(System.Int32)">
<summary>
The index of the TextLine that encompasses the character position.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.TextLineCollection.GetLineFromPosition(System.Int32)">
<summary>
Gets a <see cref="T:Microsoft.CodeAnalysis.Text.TextLine"/> that encompasses the character position.
</summary>
<param name="position"></param>
<returns></returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.TextLineCollection.GetLinePosition(System.Int32)">
<summary>
Gets a <see cref="T:Microsoft.CodeAnalysis.Text.LinePosition"/> corresponding to a character position.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.TextLineCollection.GetLinePositionSpan(Microsoft.CodeAnalysis.Text.TextSpan)">
<summary>
Convert a <see cref="T:Microsoft.CodeAnalysis.Text.TextSpan"/> to a <see cref="T:Microsoft.CodeAnalysis.Text.LinePositionSpan"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.TextLineCollection.GetPosition(Microsoft.CodeAnalysis.Text.LinePosition)">
<summary>
Convert a <see cref="T:Microsoft.CodeAnalysis.Text.LinePosition"/> to a position.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.TextLineCollection.GetTextSpan(Microsoft.CodeAnalysis.Text.LinePositionSpan)">
<summary>
Convert a <see cref="T:Microsoft.CodeAnalysis.Text.LinePositionSpan"/> to <see cref="T:Microsoft.CodeAnalysis.Text.TextSpan"/>.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Text.TextSpan">
<summary>
Immutable abstract representation of a span of text. For example, in an error diagnostic that reports a
location, it could come from a parsed string, text from a tool editor buffer, etc.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.TextSpan.#ctor(System.Int32,System.Int32)">
<summary>
Creates a TextSpan instance beginning with the position Start and having the Length
specified with <paramref name="length" />.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Text.TextSpan.Start">
<summary>
Start point of the span.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Text.TextSpan.End">
<summary>
End of the span.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Text.TextSpan.Length">
<summary>
Length of the span.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Text.TextSpan.IsEmpty">
<summary>
Determines whether or not the span is empty.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.TextSpan.Contains(System.Int32)">
<summary>
Determines whether the position lies within the span.
</summary>
<param name="position">
The position to check.
</param>
<returns>
<c>true</c> if the position is greater than or equal to Start and strictly less
than End, otherwise <c>false</c>.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.TextSpan.Contains(Microsoft.CodeAnalysis.Text.TextSpan)">
<summary>
Determines whether <paramref name="span"/> falls completely within this span.
</summary>
<param name="span">
The span to check.
</param>
<returns>
<c>true</c> if the specified span falls completely within this span, otherwise <c>false</c>.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.TextSpan.OverlapsWith(Microsoft.CodeAnalysis.Text.TextSpan)">
<summary>
Determines whether <paramref name="span"/> overlaps this span. Two spans are considered to overlap
if they have positions in common and neither is empty. Empty spans do not overlap with any
other span.
</summary>
<param name="span">
The span to check.
</param>
<returns>
<c>true</c> if the spans overlap, otherwise <c>false</c>.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.TextSpan.Overlap(Microsoft.CodeAnalysis.Text.TextSpan)">
<summary>
Returns the overlap with the given span, or null if there is no overlap.
</summary>
<param name="span">
The span to check.
</param>
<returns>
The overlap of the spans, or null if the overlap is empty.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.TextSpan.IntersectsWith(Microsoft.CodeAnalysis.Text.TextSpan)">
<summary>
Determines whether <paramref name="span"/> intersects this span. Two spans are considered to
intersect if they have positions in common or the end of one span
coincides with the start of the other span.
</summary>
<param name="span">
The span to check.
</param>
<returns>
<c>true</c> if the spans intersect, otherwise <c>false</c>.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.TextSpan.IntersectsWith(System.Int32)">
<summary>
Determines whether <paramref name="position"/> intersects this span.
A position is considered to intersect if it is between the start and
end positions (inclusive) of this span.
</summary>
<param name="position">
The position to check.
</param>
<returns>
<c>true</c> if the position intersects, otherwise <c>false</c>.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.TextSpan.Intersection(Microsoft.CodeAnalysis.Text.TextSpan)">
<summary>
Returns the intersection with the given span, or null if there is no intersection.
</summary>
<param name="span">
The span to check.
</param>
<returns>
The intersection of the spans, or null if the intersection is empty.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.TextSpan.FromBounds(System.Int32,System.Int32)">
<summary>
Creates a new <see cref="T:Microsoft.CodeAnalysis.Text.TextSpan"/> from <paramref name="start" /> and <paramref
name="end"/> positions as opposed to a position and length.
The returned TextSpan contains the range with <paramref name="start"/> inclusive,
and <paramref name="end"/> exclusive.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.TextSpan.op_Equality(Microsoft.CodeAnalysis.Text.TextSpan,Microsoft.CodeAnalysis.Text.TextSpan)">
<summary>
Determines if two instances of <see cref="T:Microsoft.CodeAnalysis.Text.TextSpan"/> are the same.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.TextSpan.op_Inequality(Microsoft.CodeAnalysis.Text.TextSpan,Microsoft.CodeAnalysis.Text.TextSpan)">
<summary>
Determines if two instances of <see cref="T:Microsoft.CodeAnalysis.Text.TextSpan"/> are different.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.TextSpan.Equals(Microsoft.CodeAnalysis.Text.TextSpan)">
<summary>
Determines if current instance of <see cref="T:Microsoft.CodeAnalysis.Text.TextSpan"/> is equal to another.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.TextSpan.Equals(System.Object)">
<summary>
Determines if current instance of <see cref="T:Microsoft.CodeAnalysis.Text.TextSpan"/> is equal to another.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.TextSpan.GetHashCode">
<summary>
Produces a hash code for <see cref="T:Microsoft.CodeAnalysis.Text.TextSpan"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.TextSpan.ToString">
<summary>
Provides a string representation for <see cref="T:Microsoft.CodeAnalysis.Text.TextSpan"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.TextSpan.CompareTo(Microsoft.CodeAnalysis.Text.TextSpan)">
<summary>
Compares current instance of <see cref="T:Microsoft.CodeAnalysis.Text.TextSpan"/> with another.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Text.TextUtilities">
<summary>
Holder for common Text Utility functions and values
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.TextUtilities.GetStartAndLengthOfLineBreakEndingAt(Microsoft.CodeAnalysis.Text.SourceText,System.Int32,System.Int32@,System.Int32@)">
<summary>
Return startLineBreak = index-1, lengthLineBreak = 2 if there is a \r\n at index-1
Return startLineBreak = index, lengthLineBreak = 1 if there is a 1-char newline at index
Return startLineBreak = index+1, lengthLineBreak = 0 if there is no newline at index.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Text.TextUtilities.IsAnyLineBreakCharacter(System.Char)">
<summary>
Determine if the character in question is any line break character
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.EnumConstantHelper.OffsetValue(Microsoft.CodeAnalysis.ConstantValue,System.UInt32,Microsoft.CodeAnalysis.ConstantValue@)">
<summary>
Generate a ConstantValue of the same integer type as the argument
and offset by the given non-negative amount. Return ConstantValue.Bad
if the generated constant would be outside the valid range of the type.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.FileSystemExtensions.Emit(Microsoft.CodeAnalysis.Compilation,System.String,System.String,System.String,System.String,System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.ResourceDescription},System.Threading.CancellationToken)">
<summary>
Emit the IL for the compilation into the specified stream.
</summary>
<param name="compilation">Compilation.</param>
<param name="outputPath">Path of the file to which the compilation will be written.</param>
<param name="pdbPath">Path of the file to which the compilation's debug info will be written.
Also embedded in the output file. Null to forego PDB generation.
</param>
<param name="xmlDocPath">Path of the file to which the compilation's XML documentation will be written. Null to forego XML generation.</param>
<param name="win32ResourcesPath">Path of the file from which the compilation's Win32 resources will be read (in RES format).
Null to indicate that there are none.</param>
<param name="manifestResources">List of the compilation's managed resources. Null to indicate that there are none.</param>
<param name="cancellationToken">To cancel the emit process.</param>
<exception cref="T:System.ArgumentNullException">Compilation or path is null.</exception>
<exception cref="T:System.ArgumentException">Path is empty or invalid.</exception>
<exception cref="T:System.IO.IOException">An error occurred while reading or writing a file.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.RelativePathResolver.#ctor(System.Collections.Immutable.ImmutableArray{System.String},System.String)">
<summary>
Initializes a new instance of the <see cref="T:Microsoft.CodeAnalysis.RelativePathResolver"/> class.
</summary>
<param name="searchPaths">An ordered set of fully qualified
paths which are searched when resolving assembly names.</param>
<param name="baseDirectory">Directory used when resolving relative paths.</param>
</member>
<member name="T:Microsoft.CodeAnalysis.FlowAnalysis.IFlowCaptureOperation">
<summary>
Represents that an intermediate result is being captured.
This node is produced only as part of a <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraph" />.
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.FlowCapture"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.FlowAnalysis.IFlowCaptureOperation.Id">
<summary>
An id used to match references to the same intermediate result.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.FlowAnalysis.IFlowCaptureOperation.Value">
<summary>
Value to be captured.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.FlowAnalysis.IFlowCaptureReferenceOperation">
<summary>
Represents a point of use of an intermediate result captured earlier.
The fact of capturing the result is represented by <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.IFlowCaptureOperation" />.
This node is produced only as part of a <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraph" />.
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.FlowCaptureReference"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.FlowAnalysis.IFlowCaptureReferenceOperation.Id">
<summary>
An id used to match references to the same intermediate result.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.FlowAnalysis.IIsNullOperation">
<summary>
Represents result of checking whether the <see cref="P:Microsoft.CodeAnalysis.FlowAnalysis.IIsNullOperation.Operand" /> is null.
For reference types this checks if the <see cref="P:Microsoft.CodeAnalysis.FlowAnalysis.IIsNullOperation.Operand" /> is a null reference,
for nullable types this checks if the <see cref="P:Microsoft.CodeAnalysis.FlowAnalysis.IIsNullOperation.Operand" /> doesn’t have a value.
The node is produced as part of a flow graph during rewrite of <see cref="T:Microsoft.CodeAnalysis.Operations.ICoalesceOperation" />
and <see cref="T:Microsoft.CodeAnalysis.Operations.IConditionalAccessOperation" /> nodes.
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.IsNull"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.FlowAnalysis.IIsNullOperation.Operand">
<summary>
Value to check.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.FlowAnalysis.ICaughtExceptionOperation">
<summary>
Represents a exception instance passed by an execution environment to an exception filter or handler.
This node is produced only as part of a <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraph" />.
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.CaughtException"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.FlowAnalysis.IStaticLocalInitializationSemaphoreOperation">
<summary>
Represents the check during initialization of a VB static local that is initialized on the first call of the function, and never again.
If the semaphore operation returns true, the static local has not yet been initialized, and the initializer will be run. If it returns
false, then the local has already been initialized, and the static local initializer region will be skipped.
This node is produced only as part of a <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraph" />.
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.StaticLocalInitializationSemaphore"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.FlowAnalysis.IStaticLocalInitializationSemaphoreOperation.Local">
<summary>
The static local variable that is possibly initialized.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.FlowAnalysis.IFlowAnonymousFunctionOperation">
<summary>
Represents an anonymous function operation in context of a <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraph" />.
<para>
Current usage:
(1) C# lambda expression.
(2) VB anonymous delegate expression.
</para>
A <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraph" /> for the body of the anonymous function is available from
the enclosing <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraph" />.
</summary>
<remarks>
<para>This node is associated with the following operation kinds:</para>
<list type="bullet">
<item><description><see cref="F:Microsoft.CodeAnalysis.OperationKind.FlowAnonymousFunction"/></description></item>
</list>
<para>This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.FlowAnalysis.IFlowAnonymousFunctionOperation.Symbol">
<summary>
Symbol of the anonymous function.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.FlowAnalysis.BasicBlock">
<summary>
Represents a basic block in a <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraph"/> with a sequence of <see cref="P:Microsoft.CodeAnalysis.FlowAnalysis.BasicBlock.Operations"/>.
Once a basic block is entered, all operations in it are always executed.
Optional <see cref="P:Microsoft.CodeAnalysis.FlowAnalysis.BasicBlock.BranchValue"/>, if non-null, is evaluated after the <see cref="P:Microsoft.CodeAnalysis.FlowAnalysis.BasicBlock.Operations"/>.
Control flow leaves the basic block by taking either the <see cref="P:Microsoft.CodeAnalysis.FlowAnalysis.BasicBlock.ConditionalSuccessor"/> branch or
the <see cref="P:Microsoft.CodeAnalysis.FlowAnalysis.BasicBlock.FallThroughSuccessor"/> branch.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.FlowAnalysis.BasicBlock.Kind">
<summary>
Basic block kind (entry, block, or exit).
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.FlowAnalysis.BasicBlock.Operations">
<summary>
Sequence of operations in the basic block.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.FlowAnalysis.BasicBlock.BranchValue">
<summary>
Optional branch value, which if non-null, is evaluated after <see cref="P:Microsoft.CodeAnalysis.FlowAnalysis.BasicBlock.Operations"/>.
For conditional branches, this value is used to represent the condition which determines if
<see cref="P:Microsoft.CodeAnalysis.FlowAnalysis.BasicBlock.ConditionalSuccessor"/> is taken or not.
For non-conditional branches, this value is used to represent the return or throw value associated
with the <see cref="P:Microsoft.CodeAnalysis.FlowAnalysis.BasicBlock.FallThroughSuccessor"/>.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.FlowAnalysis.BasicBlock.ConditionKind">
<summary>
Indicates the condition kind for the branch out of the basic block.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.FlowAnalysis.BasicBlock.FallThroughSuccessor">
<summary>
Optional fall through branch executed at the end of the basic block.
This branch is null for exit block, and non-null for all other basic blocks.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.FlowAnalysis.BasicBlock.ConditionalSuccessor">
<summary>
Optional conditional branch out of the basic block.
If non-null, this branch may be taken at the end of the basic block based
on the <see cref="P:Microsoft.CodeAnalysis.FlowAnalysis.BasicBlock.ConditionKind"/> and <see cref="P:Microsoft.CodeAnalysis.FlowAnalysis.BasicBlock.BranchValue"/>.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.FlowAnalysis.BasicBlock.Predecessors">
<summary>
List of basic blocks which have a control flow branch (<see cref="P:Microsoft.CodeAnalysis.FlowAnalysis.BasicBlock.FallThroughSuccessor"/> or <see cref="P:Microsoft.CodeAnalysis.FlowAnalysis.BasicBlock.ConditionalSuccessor"/>)
into this basic block.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.FlowAnalysis.BasicBlock.Ordinal">
<summary>
Unique ordinal for each basic block in a <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraph"/>,
which can be used to index into <see cref="P:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraph.Blocks"/> array.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.FlowAnalysis.BasicBlock.IsReachable">
<summary>
Indicates if control flow can reach this basic block from the entry block of the graph.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.FlowAnalysis.BasicBlock.EnclosingRegion">
<summary>
Enclosing region.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.FlowAnalysis.BasicBlockKind">
<summary>
<see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.BasicBlock"/> kind.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.FlowAnalysis.BasicBlockKind.Entry">
<summary>
Indicates an entry block for a <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraph"/>,
which is always the first block in <see cref="P:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraph.Blocks"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.FlowAnalysis.BasicBlockKind.Exit">
<summary>
Indicates an exit block for a <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraph"/>,
which is always the last block in <see cref="P:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraph.Blocks"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.FlowAnalysis.BasicBlockKind.Block">
<summary>
Indicates an intermediate block for a <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraph"/>.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.FlowAnalysis.CaptureId">
<summary>
Capture Id is an opaque identifier to represent an intermediate result from an <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.IFlowCaptureOperation"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.FlowAnalysis.CaptureId.Equals(Microsoft.CodeAnalysis.FlowAnalysis.CaptureId)">
<summary>
Compares <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.CaptureId"/>s.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.FlowAnalysis.CaptureId.Equals(System.Object)">
<inheritdoc/>
</member>
<member name="M:Microsoft.CodeAnalysis.FlowAnalysis.CaptureId.GetHashCode">
<inheritdoc/>
</member>
<member name="T:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowBranch">
<summary>
Represents a control flow branch from a <see cref="P:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowBranch.Source"/> basic block to a <see cref="P:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowBranch.Destination"/>
basic block in a <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraph"/>.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowBranch.Source">
<summary>
Source basic block of this branch.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowBranch.Destination">
<summary>
Destination basic block of this branch.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowBranch.Semantics">
<summary>
Semantics associated with this branch (such as "regular", "return", "throw", etc).
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowBranch.IsConditionalSuccessor">
<summary>
Indicates if this branch represents <see cref="P:Microsoft.CodeAnalysis.FlowAnalysis.BasicBlock.ConditionalSuccessor"/> of the <see cref="P:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowBranch.Source"/> basic block.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowBranch.LeavingRegions">
<summary>
Regions exited if this branch is taken.
Ordered from the innermost region to the outermost region.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowBranch.EnteringRegions">
<summary>
Regions entered if this branch is taken.
Ordered from the outermost region to the innermost region.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowBranch.FinallyRegions">
<summary>
The finally regions the control goes through if this branch is taken.
Ordered in the sequence by which the finally regions are executed.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowBranchSemantics">
<summary>
Semantics associated with a <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowBranch"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowBranchSemantics.None">
<summary>
Represents a <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowBranch"/> with no associated semantics.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowBranchSemantics.Regular">
<summary>
Represents a regular <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowBranch"/> from a source basic block to a non-null destination basic block.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowBranchSemantics.Return">
<summary>
Represents a <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowBranch"/> to the exit block, i.e. the destination block has <see cref="F:Microsoft.CodeAnalysis.FlowAnalysis.BasicBlockKind.Exit"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowBranchSemantics.StructuredExceptionHandling">
<summary>
Represents a <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowBranch"/> with special structured exception handling semantics:
1. The source basic block is the last block of an enclosing finally or filter region.
2. The destination basic block is null.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowBranchSemantics.ProgramTermination">
<summary>
Represents a <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowBranch"/> to indicate flow transfer to the end of program execution.
The destination basic block is null for this branch.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowBranchSemantics.Throw">
<summary>
Represents a <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowBranch"/> generated for an <see cref="T:Microsoft.CodeAnalysis.Operations.IThrowOperation"/> with an explicit thrown exception.
The destination basic block is null for this branch.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowBranchSemantics.Rethrow">
<summary>
Represents a <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowBranch"/> generated for an <see cref="T:Microsoft.CodeAnalysis.Operations.IThrowOperation"/> with in implicit rethrown exception.
The destination basic block is null for this branch.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowBranchSemantics.Error">
<summary>
Represents a <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowBranch"/> generated for error cases.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowConditionKind">
<summary>
Represents kind of conditional branch from a <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.BasicBlock"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowConditionKind.None">
<summary>
Indicates no conditional branch from a <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.BasicBlock"/>.
Associated <see cref="P:Microsoft.CodeAnalysis.FlowAnalysis.BasicBlock.ConditionalSuccessor"/> is null.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowConditionKind.WhenFalse">
<summary>
Indicates a conditional branch from a <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.BasicBlock"/>,
with a non-null <see cref="P:Microsoft.CodeAnalysis.FlowAnalysis.BasicBlock.BranchValue"/> and <see cref="P:Microsoft.CodeAnalysis.FlowAnalysis.BasicBlock.ConditionalSuccessor"/>.
If <see cref="P:Microsoft.CodeAnalysis.FlowAnalysis.BasicBlock.BranchValue"/> evaluates to <code>false</code>,
then the branch <see cref="P:Microsoft.CodeAnalysis.FlowAnalysis.BasicBlock.ConditionalSuccessor"/> is taken.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowConditionKind.WhenTrue">
<summary>
Indicates a conditional branch from a <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.BasicBlock"/>,
with a non-null <see cref="P:Microsoft.CodeAnalysis.FlowAnalysis.BasicBlock.BranchValue"/> and <see cref="P:Microsoft.CodeAnalysis.FlowAnalysis.BasicBlock.ConditionalSuccessor"/>.
If <see cref="P:Microsoft.CodeAnalysis.FlowAnalysis.BasicBlock.BranchValue"/> evaluates to <code>true</code>,
then the branch <see cref="P:Microsoft.CodeAnalysis.FlowAnalysis.BasicBlock.ConditionalSuccessor"/> is taken.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraph">
<summary>
Control flow graph representation for a given executable code block <see cref="P:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraph.OriginalOperation"/>.
This graph contains a set of <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.BasicBlock"/>s, with an entry block, zero
or more intermediate basic blocks and an exit block.
Each basic block contains zero or more <see cref="P:Microsoft.CodeAnalysis.FlowAnalysis.BasicBlock.Operations"/> and
explicit <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowBranch"/>(s) to other basic block(s).
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraph.Create(Microsoft.CodeAnalysis.SyntaxNode,Microsoft.CodeAnalysis.SemanticModel,System.Threading.CancellationToken)">
<summary>
Creates a <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraph"/> for the given executable code block root <paramref name="node"/>.
</summary>
<param name="node">Root syntax node for an executable code block.</param>
<param name="semanticModel">Semantic model for the syntax tree containing the <paramref name="node"/>.</param>
<param name="cancellationToken">Optional cancellation token.</param>
<returns>
Returns null if <see cref="M:Microsoft.CodeAnalysis.SemanticModel.GetOperation(Microsoft.CodeAnalysis.SyntaxNode,System.Threading.CancellationToken)"/> returns null for the given <paramref name="node"/> and <paramref name="semanticModel"/>.
Otherwise, returns a <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraph"/> for the executable code block.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraph.Create(Microsoft.CodeAnalysis.Operations.IBlockOperation,System.Threading.CancellationToken)">
<summary>
Creates a <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraph"/> for the given executable code block <paramref name="body"/>.
</summary>
<param name="body">Root operation block, which must have a null parent.</param>
<param name="cancellationToken">Optional cancellation token.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraph.Create(Microsoft.CodeAnalysis.Operations.IFieldInitializerOperation,System.Threading.CancellationToken)">
<summary>
Creates a <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraph"/> for the given executable code block <paramref name="initializer"/>.
</summary>
<param name="initializer">Root field initializer operation, which must have a null parent.</param>
<param name="cancellationToken">Optional cancellation token.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraph.Create(Microsoft.CodeAnalysis.Operations.IPropertyInitializerOperation,System.Threading.CancellationToken)">
<summary>
Creates a <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraph"/> for the given executable code block <paramref name="initializer"/>.
</summary>
<param name="initializer">Root property initializer operation, which must have a null parent.</param>
<param name="cancellationToken">Optional cancellation token.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraph.Create(Microsoft.CodeAnalysis.Operations.IParameterInitializerOperation,System.Threading.CancellationToken)">
<summary>
Creates a <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraph"/> for the given executable code block <paramref name="initializer"/>.
</summary>
<param name="initializer">Root parameter initializer operation, which must have a null parent.</param>
<param name="cancellationToken">Optional cancellation token.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraph.Create(Microsoft.CodeAnalysis.Operations.IConstructorBodyOperation,System.Threading.CancellationToken)">
<summary>
Creates a <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraph"/> for the given executable code block <paramref name="constructorBody"/>.
</summary>
<param name="constructorBody">Root constructor body operation, which must have a null parent.</param>
<param name="cancellationToken">Optional cancellation token.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraph.Create(Microsoft.CodeAnalysis.Operations.IMethodBodyOperation,System.Threading.CancellationToken)">
<summary>
Creates a <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraph"/> for the given executable code block <paramref name="methodBody"/>.
</summary>
<param name="methodBody">Root method body operation, which must have a null parent.</param>
<param name="cancellationToken">Optional cancellation token.</param>
</member>
<member name="P:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraph.OriginalOperation">
<summary>
Original operation, representing an executable code block, from which this control flow graph was generated.
Note that <see cref="P:Microsoft.CodeAnalysis.FlowAnalysis.BasicBlock.Operations"/> in the control flow graph are not in the same operation tree as
the original operation.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraph.Parent">
<summary>
Optional parent control flow graph for this graph.
Non-null for a control flow graph generated for a local function or a lambda.
Null otherwise.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraph.Blocks">
<summary>
Basic blocks for the control flow graph.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraph.Root">
<summary>
Root (<see cref="F:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowRegionKind.Root"/>) region for the graph.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraph.LocalFunctions">
<summary>
Local functions declared within <see cref="P:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraph.OriginalOperation"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraph.GetLocalFunctionControlFlowGraph(Microsoft.CodeAnalysis.IMethodSymbol,System.Threading.CancellationToken)">
<summary>
Creates a control flow graph for the given <paramref name="localFunction"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraph.GetAnonymousFunctionControlFlowGraph(Microsoft.CodeAnalysis.FlowAnalysis.IFlowAnonymousFunctionOperation,System.Threading.CancellationToken)">
<summary>
Creates a control flow graph for the given <paramref name="anonymousFunction"/>.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraphBuilder.Context">
<summary>
This structure is meant to capture a snapshot of the <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraphBuilder"/> state
that is needed to build graphs for lambdas and local functions.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraphBuilder._currentImplicitInstance">
<summary>
Holds the current object being initialized if we're visiting an object initializer.
Or the current anonymous type object being initialized if we're visiting an anonymous type object initializer.
Or the target of a VB With statement.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraphBuilder.Pack(Microsoft.CodeAnalysis.PooledObjects.ArrayBuilder{Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraphBuilder.BasicBlockBuilder},Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraphBuilder.RegionBuilder,Microsoft.CodeAnalysis.PooledObjects.PooledDictionary{Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraphBuilder.BasicBlockBuilder,Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraphBuilder.RegionBuilder})">
<summary>
Do a pass to eliminate blocks without statements that can be merged with predecessor(s) and
to eliminate regions that can be merged with parents.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraphBuilder.MergeSubRegionAndFree(Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraphBuilder.RegionBuilder,Microsoft.CodeAnalysis.PooledObjects.ArrayBuilder{Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraphBuilder.BasicBlockBuilder},Microsoft.CodeAnalysis.PooledObjects.PooledDictionary{Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraphBuilder.BasicBlockBuilder,Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraphBuilder.RegionBuilder},System.Boolean)">
<summary>
Merge content of <paramref name="subRegion"/> into its enclosing region and free it.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraphBuilder.PackBlocks(Microsoft.CodeAnalysis.PooledObjects.ArrayBuilder{Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraphBuilder.BasicBlockBuilder},Microsoft.CodeAnalysis.PooledObjects.PooledDictionary{Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraphBuilder.BasicBlockBuilder,Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraphBuilder.RegionBuilder})">
<summary>
Do a pass to eliminate blocks without statements that can be merged with predecessor(s).
Returns true if any blocks were eliminated
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraphBuilder.CheckUnresolvedBranches(Microsoft.CodeAnalysis.PooledObjects.ArrayBuilder{Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraphBuilder.BasicBlockBuilder},Microsoft.CodeAnalysis.PooledObjects.PooledDictionary{Microsoft.CodeAnalysis.ILabelSymbol,Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraphBuilder.BasicBlockBuilder})">
<summary>
Deal with labeled blocks that were not added to the graph because labels were never found
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraphBuilder.VisitStatementsOneOrAll(Microsoft.CodeAnalysis.IOperation,System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.IOperation},System.Int32)">
<summary>
Either visits a single operation, or a using <see cref="T:Microsoft.CodeAnalysis.Operations.IVariableDeclarationGroupOperation"/> and all subsequent statements
</summary>
<param name="operation">The statement to visit</param>
<param name="statements">All statements in the block containing this node</param>
<param name="startIndex">The current statement being visited in <paramref name="statements"/></param>
<returns>True if this visited all of the statements</returns>
<remarks>
The operation being visited is not necessarily equal to statements[startIndex].
When traversing down a set of labels, we set operation to the label.Operation and recurse, but statements[startIndex] still refers to the original parent label
as we haven't actually moved down the original statement list
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraphBuilder.EvalStackFrame">
<summary>
This class captures information about beginning of stack frame
and corresponding <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraphBuilder.RegionBuilder"/> if one was allocated to
track <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.CaptureId"/>s used by the stack spilling, etc.
Do not create instances of this type manually, use <see cref="M:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraphBuilder.PushStackFrame"/>
helper instead. Also, do not assign <see cref="P:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraphBuilder.EvalStackFrame.RegionBuilderOpt"/> explicitly.
Let the builder machinery do this when appropriate.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraphBuilder.VisitConditionalBranchCore(Microsoft.CodeAnalysis.IOperation,Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraphBuilder.BasicBlockBuilder@,System.Boolean)">
<summary>
This function does not change the current region. The stack should be spilled before calling it.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraphBuilder.NullCheckAndConvertCoalesceValue(Microsoft.CodeAnalysis.Operations.ICoalesceOperation,Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraphBuilder.BasicBlockBuilder)">
<summary>
Returns converted test expression.
Caller is responsible for spilling the stack and pushing a stack frame before calling this helper.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraphBuilder.PushTargetAndUnwrapTupleIfNecessary(Microsoft.CodeAnalysis.IOperation)">
<summary>
Recursively push nexted values onto the stack for visiting
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraphBuilder.PopTargetAndWrapTupleIfNecessary(Microsoft.CodeAnalysis.IOperation)">
<summary>
Recursively pop nested tuple values off the stack after visiting
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraphBuilder.ImplicitInstanceInfo">
<summary>
Holds the current object being initialized if we're visiting an object initializer.
Or the current anonymous type object being initialized if we're visiting an anonymous type object initializer.
Or the target of a VB With statement.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraphBuilder.ImplicitInstanceInfo.ImplicitInstance">
<summary>
Holds the current object instance being initialized if we're visiting an object initializer.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraphBuilder.ImplicitInstanceInfo.AnonymousType">
<summary>
Holds the current anonymous type instance being initialized if we're visiting an anonymous object initializer.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraphBuilder.ImplicitInstanceInfo.AnonymousTypePropertyValues">
<summary>
Holds the captured values for initialized anonymous type properties in an anonymous object initializer.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraphExtensions.GetLocalFunctionControlFlowGraphInScope(Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraph,Microsoft.CodeAnalysis.IMethodSymbol,System.Threading.CancellationToken)">
<summary>
Gets or creates a control flow graph for the given <paramref name="localFunction"/> defined in
the given <paramref name="controlFlowGraph"/> or any of it's parent control flow graphs.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraphExtensions.GetAnonymousFunctionControlFlowGraphInScope(Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraph,Microsoft.CodeAnalysis.FlowAnalysis.IFlowAnonymousFunctionOperation,System.Threading.CancellationToken)">
<summary>
Gets or creates a control flow graph for the given <paramref name="anonymousFunction"/> defined in
the given <paramref name="controlFlowGraph"/> or any of it's parent control flow graphs.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowRegion">
<summary>
Encapsulates information about regions of <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.BasicBlock"/>s in a <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraph"/>.
Regions can overlap, but never cross each other boundaries.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowRegion.Kind">
<summary>
Region's kind
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowRegion.EnclosingRegion">
<summary>
Enclosing region. Null for <see cref="F:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowRegionKind.Root"/>
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowRegion.ExceptionType">
<summary>
Target exception type for <see cref="F:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowRegionKind.Filter"/>, <see cref="F:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowRegionKind.Catch"/>,
<see cref="F:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowRegionKind.FilterAndHandler"/>
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowRegion.FirstBlockOrdinal">
<summary>
Ordinal (<see cref="P:Microsoft.CodeAnalysis.FlowAnalysis.BasicBlock.Ordinal"/>) of the first <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.BasicBlock"/> within the region.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowRegion.LastBlockOrdinal">
<summary>
Ordinal (<see cref="P:Microsoft.CodeAnalysis.FlowAnalysis.BasicBlock.Ordinal"/>) of the last <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.BasicBlock"/> within the region.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowRegion.NestedRegions">
<summary>
Regions nested within this region.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowRegion.Locals">
<summary>
Locals for which this region represent the life-time.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowRegion.LocalFunctions">
<summary>
Local functions declared within the region.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowRegion.CaptureIds">
<summary>
Capture Ids used for intermediate results within the region.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowRegionKind">
<summary>
Defines kinds of regions that can be present in a <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraph"/>
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowRegionKind.Root">
<summary>
A root region encapsulating all <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.BasicBlock"/>s in a <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraph"/>
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowRegionKind.LocalLifetime">
<summary>
Region with the only purpose to represent the life-time of locals, intermediate results, and nested methods (local functions, lambdas).
The lifetime of a local variable is the portion of program execution during which storage is guaranteed to be reserved for it.
The lifetime of a nested method is the portion of program execution within which the method can be referenced.
The lifetime of an intermediate result (capture) is the portion of program execution within which the result can be referenced.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowRegionKind.Try">
<summary>
Region representing a try region. For example, <see cref="P:Microsoft.CodeAnalysis.Operations.ITryOperation.Body"/>
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowRegionKind.Filter">
<summary>
Region representing <see cref="P:Microsoft.CodeAnalysis.Operations.ICatchClauseOperation.Filter"/>
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowRegionKind.Catch">
<summary>
Region representing <see cref="P:Microsoft.CodeAnalysis.Operations.ICatchClauseOperation.Handler"/>
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowRegionKind.FilterAndHandler">
<summary>
Region representing a union of a <see cref="F:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowRegionKind.Filter"/> and the corresponding catch <see cref="F:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowRegionKind.Catch"/> regions.
Doesn't contain any <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.BasicBlock"/>s directly.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowRegionKind.TryAndCatch">
<summary>
Region representing a union of a <see cref="F:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowRegionKind.Try"/> and all corresponding catch <see cref="F:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowRegionKind.Catch"/>
and <see cref="F:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowRegionKind.FilterAndHandler"/> regions. Doesn't contain any <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.BasicBlock"/>s directly.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowRegionKind.Finally">
<summary>
Region representing <see cref="P:Microsoft.CodeAnalysis.Operations.ITryOperation.Finally"/>
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowRegionKind.TryAndFinally">
<summary>
Region representing a union of a <see cref="F:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowRegionKind.Try"/> and corresponding finally <see cref="F:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowRegionKind.Finally"/>
region. Doesn't contain any <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.BasicBlock"/>s directly.
An <see cref="T:Microsoft.CodeAnalysis.Operations.ITryOperation"/> that has a set of <see cref="P:Microsoft.CodeAnalysis.Operations.ITryOperation.Catches"/> and a <see cref="P:Microsoft.CodeAnalysis.Operations.ITryOperation.Finally"/>
at the same time is mapped to a <see cref="F:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowRegionKind.TryAndFinally"/> region with <see cref="F:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowRegionKind.TryAndCatch"/> region inside its <see cref="F:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowRegionKind.Try"/> region.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowRegionKind.StaticLocalInitializer">
<summary>
Region representing the initialization for a VB <code>Static</code> local variable. This region will only be executed
the first time a function is called.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowRegionKind.ErroneousBody">
<summary>
Region representing erroneous block of code that is unreachable from the entry block.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.OperationKind">
<summary>
All of the kinds of operations, including statements and expressions.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.None">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.IOperation"/> for a construct that is not implemented yet.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.Invalid">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IInvalidOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.Block">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IBlockOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.VariableDeclarationGroup">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IVariableDeclarationGroupOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.Switch">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.ISwitchOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.Loop">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.ILoopOperation"/>. This is further differentiated by <see cref="P:Microsoft.CodeAnalysis.Operations.ILoopOperation.LoopKind"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.Labeled">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.ILabeledOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.Branch">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IBranchOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.Empty">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IEmptyOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.Return">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IReturnOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.YieldBreak">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IReturnOperation"/>. This has yield break semantics.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.Lock">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.ILockOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.Try">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.ITryOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.Using">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IUsingOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.YieldReturn">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IReturnOperation"/>. This has yield return semantics.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.ExpressionStatement">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IExpressionStatementOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.LocalFunction">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.ILocalFunctionOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.Stop">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IStopOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.End">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IEndOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.RaiseEvent">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IRaiseEventOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.Literal">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.ILiteralOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.Conversion">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IConversionOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.Invocation">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IInvocationOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.ArrayElementReference">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IArrayElementReferenceOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.LocalReference">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.ILocalReferenceOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.ParameterReference">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IParameterReferenceOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.FieldReference">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IFieldReferenceOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.MethodReference">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IMethodReferenceOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.PropertyReference">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IPropertyReferenceOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.EventReference">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IEventReferenceOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.Unary">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IUnaryOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.UnaryOperator">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IUnaryOperation"/>. Use <see cref="F:Microsoft.CodeAnalysis.OperationKind.Unary"/> instead.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.Binary">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IBinaryOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.BinaryOperator">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IBinaryOperation"/>. Use <see cref="F:Microsoft.CodeAnalysis.OperationKind.Binary"/> instead.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.Conditional">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IConditionalOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.Coalesce">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.ICoalesceOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.AnonymousFunction">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IAnonymousFunctionOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.ObjectCreation">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IObjectCreationOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.TypeParameterObjectCreation">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.ITypeParameterObjectCreationOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.ArrayCreation">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IArrayCreationOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.InstanceReference">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IInstanceReferenceOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.IsType">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IIsTypeOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.Await">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IAwaitOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.SimpleAssignment">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.ISimpleAssignmentOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.CompoundAssignment">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.ICompoundAssignmentOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.Parenthesized">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IParenthesizedOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.EventAssignment">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IEventAssignmentOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.ConditionalAccess">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IConditionalAccessOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.ConditionalAccessInstance">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IConditionalAccessInstanceOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.InterpolatedString">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IInterpolatedStringOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.AnonymousObjectCreation">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IAnonymousObjectCreationOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.ObjectOrCollectionInitializer">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IObjectOrCollectionInitializerOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.MemberInitializer">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IMemberInitializerOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.CollectionElementInitializer">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.ICollectionElementInitializerOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.NameOf">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.INameOfOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.Tuple">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.ITupleOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.DynamicObjectCreation">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IDynamicObjectCreationOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.DynamicMemberReference">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IDynamicMemberReferenceOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.DynamicInvocation">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IDynamicInvocationOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.DynamicIndexerAccess">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IDynamicIndexerAccessOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.TranslatedQuery">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.ITranslatedQueryOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.DelegateCreation">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IDelegateCreationOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.DefaultValue">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IDefaultValueOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.TypeOf">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.ITypeOfOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.SizeOf">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.ISizeOfOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.AddressOf">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IAddressOfOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.IsPattern">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IIsPatternOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.Increment">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IIncrementOrDecrementOperation"/>. This is used as an increment operator</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.Throw">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IThrowOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.Decrement">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IIncrementOrDecrementOperation"/>. This is used as a decrement operator</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.DeconstructionAssignment">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IDeconstructionAssignmentOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.DeclarationExpression">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IDeclarationExpressionOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.OmittedArgument">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IOmittedArgumentOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.FieldInitializer">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IFieldInitializerOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.VariableInitializer">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IVariableInitializerOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.PropertyInitializer">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IPropertyInitializerOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.ParameterInitializer">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IParameterInitializerOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.ArrayInitializer">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IArrayInitializerOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.VariableDeclarator">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IVariableDeclaratorOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.VariableDeclaration">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IVariableDeclarationOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.Argument">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IArgumentOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.CatchClause">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.ICatchClauseOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.SwitchCase">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.ISwitchCaseOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.CaseClause">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.ICaseClauseOperation"/>. This is further differentiated by <see cref="P:Microsoft.CodeAnalysis.Operations.ICaseClauseOperation.CaseKind"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.InterpolatedStringText">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IInterpolatedStringTextOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.Interpolation">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IInterpolationOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.ConstantPattern">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IConstantPatternOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.DeclarationPattern">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IDeclarationPatternOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.TupleBinary">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.ITupleBinaryOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.TupleBinaryOperator">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.ITupleBinaryOperation"/>. Use <see cref="F:Microsoft.CodeAnalysis.OperationKind.TupleBinary"/> instead.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.MethodBody">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IMethodBodyOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.MethodBodyOperation">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IMethodBodyOperation"/>. Use <see cref="F:Microsoft.CodeAnalysis.OperationKind.MethodBody"/> instead.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.ConstructorBody">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IConstructorBodyOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.ConstructorBodyOperation">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IConstructorBodyOperation"/>. Use <see cref="F:Microsoft.CodeAnalysis.OperationKind.ConstructorBody"/> instead.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.Discard">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IDiscardOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.FlowCapture">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.IFlowCaptureOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.FlowCaptureReference">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.IFlowCaptureReferenceOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.IsNull">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.IIsNullOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.CaughtException">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.ICaughtExceptionOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.StaticLocalInitializationSemaphore">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.IStaticLocalInitializationSemaphoreOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.FlowAnonymousFunction">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.IFlowAnonymousFunctionOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.CoalesceAssignment">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.ICoalesceAssignmentOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.Range">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IRangeOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.ReDim">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IReDimOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.ReDimClause">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IReDimClauseOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.RecursivePattern">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IRecursivePatternOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.DiscardPattern">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IDiscardPatternOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.SwitchExpression">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.ISwitchExpressionOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.SwitchExpressionArm">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.ISwitchExpressionArmOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.PropertySubpattern">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IPropertySubpatternOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.UsingDeclaration">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IUsingDeclarationOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.NegatedPattern">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.INegatedPatternOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.BinaryPattern">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IBinaryPatternOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.TypePattern">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.ITypePatternOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.RelationalPattern">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IRelationalPatternOperation"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OperationKind.With">
<summary>Indicates an <see cref="T:Microsoft.CodeAnalysis.Operations.IWithOperation"/>.</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.InternalUtilities.ConcurrentLruCache`2">
<summary>
Cache with a fixed size that evicts the least recently used members.
Thread-safe.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.InternalUtilities.ConcurrentLruCache`2.#ctor(System.Collections.Generic.KeyValuePair{`0,`1}[])">
<summary>
Create cache from an array. The cache capacity will be the size
of the array. All elements of the array will be added to the
cache. If any duplicate keys are found in the array a
<see cref="T:System.ArgumentException"/> will be thrown.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.InternalUtilities.ConcurrentLruCache`2.TestingEnumerable">
<summary>
For testing. Very expensive.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.InternalUtilities.ConcurrentLruCache`2.UnsafeEvictLastNode">
<summary>
Expects non-empty cache. Does not lock.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.InternalUtilities.ConcurrentLruCache`2.UnsafeAdd(`0,`1,System.Boolean)">
<summary>
Doesn't lock.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.InternalUtilities.ConcurrentLruCache`2.UnsafeTryGetValue(`0,`1@)">
<summary>
Doesn't lock.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.FailFast.DumpStackTrace(System.Exception,System.String)">
<summary>
Dumps the stack trace of the exception and the handler to the console. This is useful
for debugging unit tests that hit a fatal exception
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.FailFast.Assert(System.Boolean,System.String)">
<summary>
Checks for the given <paramref name="condition"/>; if the <paramref name="condition"/> is <c>true</c>,
immediately terminates the process without running any pending <c>finally</c> blocks or finalizers
and causes a crash dump to be collected (if the system is configured to do so).
Otherwise, the process continues normally.
</summary>
<param name="condition">The conditional expression to evaluate.</param>
<param name="message">An optional message to be recorded in the dump in case of failure. Can be <c>null</c>.</param>
</member>
<member name="P:Microsoft.CodeAnalysis.FatalError.Handler">
<summary>
Set by the host to a fail fast trigger,
if the host desires to crash the process on a fatal exception.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.FatalError.NonFatalHandler">
<summary>
Set by the host to a fail fast trigger,
if the host desires to NOT crash the process on a non fatal exception.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.FatalError.ReportAndPropagateUnlessCanceled(System.Exception)">
<summary>
Use in an exception filter to report a fatal error.
Unless the exception is <see cref="T:System.OperationCanceledException"/>
it calls <see cref="P:Microsoft.CodeAnalysis.FatalError.Handler"/>. The exception is passed through (the method returns false).
</summary>
<returns>False to avoid catching the exception.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.FatalError.ReportAndPropagateUnlessCanceled(System.Exception,System.Threading.CancellationToken)">
<summary>
Use in an exception filter to report a fatal error.
Calls <see cref="P:Microsoft.CodeAnalysis.FatalError.Handler"/> unless the operation has been cancelled.
The exception is passed through (the method returns false).
</summary>
<returns>False to avoid catching the exception.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.FatalError.ReportAndCatchUnlessCanceled(System.Exception)">
<summary>
Use in an exception filter to report a non-fatal error.
Unless the exception is <see cref="T:System.OperationCanceledException"/>
it calls <see cref="P:Microsoft.CodeAnalysis.FatalError.NonFatalHandler"/>. The exception isn't passed through (the method returns true).
</summary>
<returns>True to catch the exception.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.FatalError.ReportAndCatchUnlessCanceled(System.Exception,System.Threading.CancellationToken)">
<summary>
Use in an exception filter to report a non-fatal error.
Calls <see cref="P:Microsoft.CodeAnalysis.FatalError.NonFatalHandler"/> unless the operation has been cancelled.
The exception isn't passed through (the method returns true).
</summary>
<returns>True to catch the exception.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.FatalError.ReportAndPropagate(System.Exception)">
<summary>
Use in an exception filter to report a fatal error.
Calls <see cref="P:Microsoft.CodeAnalysis.FatalError.Handler"/> and passes the exception through (the method returns false).
</summary>
<returns>False to avoid catching the exception.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.FatalError.ReportAndCatch(System.Exception)">
<summary>
Report a non-fatal error.
Calls <see cref="P:Microsoft.CodeAnalysis.FatalError.NonFatalHandler"/> and doesn't pass the exception through (the method returns true).
This is generally expected to be used within an exception filter as that allows us to
capture data at the point the exception is thrown rather than when it is handled.
However, it can also be used outside of an exception filter. If the exception has not
already been thrown the method will throw and catch it itself to ensure we get a useful
stack trace.
</summary>
<returns>True to catch the exception.</returns>
</member>
<member name="T:Microsoft.CodeAnalysis.LittleEndianReader">
<summary>
A Span-compatible version of <see cref="T:System.IO.BinaryReader"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.StackGuard.EnsureSufficientExecutionStack(System.Int32)">
<summary>
Ensures that the remaining stack space is large enough to execute
the average function.
</summary>
<param name="recursionDepth">how many times the calling function has recursed</param>
<exception cref="T:System.InsufficientExecutionStackException">
The available stack space is insufficient to execute
the average function.
</exception>
</member>
<member name="T:Microsoft.CodeAnalysis.ThreeState">
<summary>
Represents an optional bool as a single byte.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.IReferenceOrISignature">
<summary>
Used to devirtualize ConcurrentDictionary for EqualityComparer{T}.Default and ReferenceEquals
This type is to enable fast-path devirtualization in the Jit. Dictionary{K, V}, HashTable{T}
and ConcurrentDictionary{K, V} will devirtualize (and potentially inline) the IEquatable{T}.Equals
method for a struct when the Comparer is unspecified in .NET Core, .NET 5; whereas specifying
a Comparer will make .Equals and GetHashcode slower interface calls.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.IVTConclusion">
<summary>
The result of <see cref="M:Microsoft.CodeAnalysis.ISymbolExtensions.PerformIVTCheck(Microsoft.CodeAnalysis.AssemblyIdentity,System.Collections.Immutable.ImmutableArray{System.Byte},System.Collections.Immutable.ImmutableArray{System.Byte})"/>
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.IVTConclusion.Match">
<summary>
This indicates that friend access should be granted.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.IVTConclusion.OneSignedOneNot">
<summary>
This indicates that friend access should be granted for the purposes of error recovery,
but the program is wrong.
That's because this indicates that a strong-named assembly has referred to a weak-named assembly
which has extended friend access to the strong-named assembly. This will ultimately
result in an error because strong-named assemblies may not refer to weak-named assemblies.
In Roslyn we give a new error, CS7029, before emit time. In the dev10 compiler we error at
emit time.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.IVTConclusion.PublicKeyDoesntMatch">
<summary>
This indicates that friend access should not be granted because the other assembly grants
friend access to a strong-named assembly, and either this assembly is weak-named, or
it is strong-named and the names don't match.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.IVTConclusion.NoRelationshipClaimed">
<summary>
This indicates that friend access should not be granted because the other assembly
does not name this assembly as a friend in any way whatsoever.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.RuntimeMembers.MemberDescriptor">
<summary>
Structure that describes a member of a type.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.RuntimeMembers.MemberDescriptor.DeclaringTypeId">
<summary>
Id/token of containing type, usually value from some enum.
For example from SpecialType enum.
I am not using SpecialType as the type for this field because
VB runtime types are not part of SpecialType.
So, the implication is that any type ids we use outside of the SpecialType
(either for the VB runtime classes, or types like System.Task etc.) will need
to use IDs that are all mutually disjoint.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.RuntimeMembers.MemberDescriptor.Signature">
<summary>
Signature of the field or method, similar to metadata signature,
but with the following exceptions:
1) Truncated on the left, for methods starts at [ParamCount], for fields at [Type]
2) Type tokens are not compressed
3) BOOLEAN | CHAR | I1 | U1 | I2 | U2 | I4 | U4 | I8 | U8 | R4 | R8 | I | U | Void types are encoded by
using VALUETYPE+typeId notation.
4) array bounds are not included.
5) modifiers are not included.
6) (CLASS | VALUETYPE) are omitted after GENERICINST
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.RuntimeMembers.MemberDescriptor.ParametersCount">
<summary>
Applicable only to properties and methods, throws otherwise.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.RuntimeMembers.MemberDescriptor.ReadTypeId(System.IO.Stream)">
<summary>
The type Id may be:
(1) encoded in a single byte (for types below 255)
(2) encoded in two bytes (255 + extension byte) for types below 512
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.RuntimeMembers.MemberDescriptor.ParseTypeHandle(System.Collections.Immutable.ImmutableArray{System.Byte}.Builder,System.IO.Stream)">
<summary>
Read a type Id from the stream and copy it into the builder.
This may copy one or two bytes depending on the first one.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.RuntimeMembers.SignatureComparer`5">
<summary>
Helper class to match signatures in format of
MemberDescriptor.Signature to members.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.RuntimeMembers.SignatureComparer`5.MatchFieldSignature(`1,System.Collections.Immutable.ImmutableArray{System.Byte})">
<summary>
Returns true if signature matches signature of the field.
Signature should be in format described in MemberDescriptor.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.RuntimeMembers.SignatureComparer`5.MatchPropertySignature(`2,System.Collections.Immutable.ImmutableArray{System.Byte})">
<summary>
Returns true if signature matches signature of the property.
Signature should be in format described in MemberDescriptor.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.RuntimeMembers.SignatureComparer`5.MatchMethodSignature(`0,System.Collections.Immutable.ImmutableArray{System.Byte})">
<summary>
Returns true if signature matches signature of the method.
Signature should be in format described in MemberDescriptor.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.RuntimeMembers.SignatureComparer`5.MatchType(`3,System.Collections.Immutable.ImmutableArray{System.Byte},System.Int32@)">
<summary>
Does pretty much the same thing as MetadataDecoder.DecodeType only instead of
producing a type symbol it compares encoded type to the target.
Signature should be in format described in MemberDescriptor.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.RuntimeMembers.SignatureComparer`5.ReadTypeId(System.Collections.Immutable.ImmutableArray{System.Byte},System.Int32@)">
<summary>
Read a type Id from the signature.
This may consume one or two bytes, and therefore increment the position correspondingly.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.RuntimeMembers.SignatureComparer`5.GetGenericTypeArgument(`3,System.Int32)">
<summary>
Should return null in case of error.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.RuntimeMembers.SignatureComparer`5.GetGenericTypeDefinition(`3)">
<summary>
Should return null in case of error.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.RuntimeMembers.SignatureComparer`5.GetPointedToType(`3)">
<summary>
Should only accept Pointer types.
Should return null in case of error.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.RuntimeMembers.SignatureComparer`5.GetSZArrayElementType(`3)">
<summary>
Should return null in case of error.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.RuntimeMembers.SignatureComparer`5.MatchArrayRank(`3,System.Int32)">
<summary>
Should only accept multi-dimensional arrays.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.RuntimeMembers.SignatureComparer`5.GetMDArrayElementType(`3)">
<summary>
Should only accept multi-dimensional arrays.
Should return null in case of error.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataDecoder`5.DecodeTypeOrThrow(System.Reflection.Metadata.BlobReader@,System.Boolean@)">
<exception cref="T:Microsoft.CodeAnalysis.UnsupportedSignatureContent">If the encoded type is invalid.</exception>
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataDecoder`5.DecodeTypeOrThrow(System.Reflection.Metadata.BlobReader@,System.Reflection.Metadata.SignatureTypeCode,System.Boolean@)">
<exception cref="T:Microsoft.CodeAnalysis.UnsupportedSignatureContent">If the encoded type is invalid.</exception>
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataDecoder`5.GetSymbolForTypeHandleOrThrow(System.Reflection.Metadata.EntityHandle,System.Boolean@,System.Boolean,System.Boolean)">
<exception cref="T:Microsoft.CodeAnalysis.UnsupportedSignatureContent">If the encoded type is invalid.</exception>
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataDecoder`5.GetTypeByNameOrThrow(Microsoft.CodeAnalysis.MetadataTypeName@,System.Reflection.Metadata.EntityHandle,System.Boolean@)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataDecoder`5.DecodeModifiersOrThrow(System.Reflection.Metadata.BlobReader@,System.Reflection.Metadata.SignatureTypeCode@)">
<exception cref="T:Microsoft.CodeAnalysis.UnsupportedSignatureContent">If the encoded type is invalid.</exception>
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataDecoder`5.DecodeLocalSignatureOrThrow(System.Reflection.Metadata.BlobReader@)">
<exception cref="T:Microsoft.CodeAnalysis.UnsupportedSignatureContent">If the encoded local variable type is invalid.</exception>
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataDecoder`5.DecodeLocalVariableOrThrow(System.Reflection.Metadata.BlobReader@)">
<exception cref="T:Microsoft.CodeAnalysis.UnsupportedSignatureContent">If the encoded local variable type is invalid.</exception>
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataDecoder`5.DecodeLocalVariableTypeOrThrow(System.Collections.Immutable.ImmutableArray{System.Byte})">
<summary>
Used to decode signatures of local constants returned by SymReader.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataDecoder`5.GetLocalInfo(System.Reflection.Metadata.StandaloneSignatureHandle)">
<summary>
Returns the local info for all locals indexed by slot.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataDecoder`5.DecodeParameterOrThrow(System.Reflection.Metadata.BlobReader@,Microsoft.CodeAnalysis.ParamInfo{`1}@)">
<exception cref="T:Microsoft.CodeAnalysis.UnsupportedSignatureContent">If the encoded parameter type is invalid.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataDecoder`5.GetSignatureCountsOrThrow(Microsoft.CodeAnalysis.PEModule,System.Reflection.Metadata.MethodDefinitionHandle,System.Int32@,System.Int32@)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataDecoder`5.DecodeCustomAttributeParameterTypeOrThrow(System.Reflection.Metadata.BlobReader@,System.Reflection.Metadata.SerializationTypeCode@,`1@,System.Reflection.Metadata.SerializationTypeCode@,`1@,System.Boolean)">
<summary>
Decodes attribute parameter type from method signature.
</summary>
<exception cref="T:Microsoft.CodeAnalysis.UnsupportedSignatureContent">If the encoded parameter type is invalid.</exception>
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataDecoder`5.DecodeCustomAttributeFieldOrPropTypeOrThrow(System.Reflection.Metadata.BlobReader@,System.Reflection.Metadata.SerializationTypeCode@,`1@,System.Reflection.Metadata.SerializationTypeCode@,`1@,System.Boolean)">
<summary>
Decodes attribute argument type from attribute blob (called FieldOrPropType in the spec).
</summary>
<exception cref="T:Microsoft.CodeAnalysis.UnsupportedSignatureContent">If the encoded argument type is invalid.</exception>
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataDecoder`5.DecodeCustomAttributeFixedArgumentOrThrow(System.Reflection.Metadata.BlobReader@,System.Reflection.Metadata.BlobReader@)">
<exception cref="T:Microsoft.CodeAnalysis.UnsupportedSignatureContent">If the encoded attribute argument is invalid.</exception>
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataDecoder`5.DecodeCustomAttributeElementOrThrow(System.Reflection.Metadata.BlobReader@,System.Reflection.Metadata.SerializationTypeCode,`1)">
<exception cref="T:Microsoft.CodeAnalysis.UnsupportedSignatureContent">If the encoded attribute argument is invalid.</exception>
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataDecoder`5.DecodeCustomAttributeElementArrayOrThrow(System.Reflection.Metadata.BlobReader@,System.Reflection.Metadata.SerializationTypeCode,`1,`1)">
<exception cref="T:Microsoft.CodeAnalysis.UnsupportedSignatureContent">If the encoded attribute argument is invalid.</exception>
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataDecoder`5.DecodeCustomAttributePrimitiveElementOrThrow(System.Reflection.Metadata.BlobReader@,System.Reflection.Metadata.SerializationTypeCode,`1)">
<exception cref="T:Microsoft.CodeAnalysis.UnsupportedSignatureContent">If the given <paramref name="typeCode"/> is invalid.</exception>
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataDecoder`5.DecodeCustomAttributeNamedArgumentOrThrow(System.Reflection.Metadata.BlobReader@)">
<exception cref="T:Microsoft.CodeAnalysis.UnsupportedSignatureContent">If the encoded named argument is invalid.</exception>
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataDecoder`5.DecodeMethodSpecTypeArgumentsOrThrow(System.Reflection.Metadata.BlobHandle)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataDecoder`5.DecodeSignatureHeaderOrThrow(System.Reflection.Metadata.BlobHandle,System.Reflection.Metadata.SignatureHeader@)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataDecoder`5.DecodeSignatureHeaderOrThrow(Microsoft.CodeAnalysis.PEModule,System.Reflection.Metadata.BlobHandle,System.Reflection.Metadata.SignatureHeader@)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataDecoder`5.DecodeSignatureParametersOrThrow(System.Reflection.Metadata.BlobReader@,System.Reflection.Metadata.SignatureHeader,System.Int32@,System.Boolean,System.Boolean)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataDecoder`5.GetSignatureCountsOrThrow(System.Reflection.Metadata.BlobReader@,System.Reflection.Metadata.SignatureHeader,System.Int32@,System.Int32@)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataDecoder`5.GetExplicitlyOverriddenMethods(System.Reflection.Metadata.TypeDefinitionHandle,System.Reflection.Metadata.MethodDefinitionHandle,`1)">
<summary>
Find the methods that a given method explicitly overrides.
</summary>
<remarks>
Methods may be on class or interfaces.
Containing classes/interfaces will be supertypes of the implementing type.
</remarks>
<param name="implementingTypeDef">TypeDef handle of the implementing type.</param>
<param name="implementingMethodDef">MethodDef handle of the implementing method.</param>
<param name="implementingTypeSymbol">The type symbol for the implementing type.</param>
<returns>Array of implemented methods.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataDecoder`5.FindMethodSymbolInSuperType(System.Reflection.Metadata.TypeDefinitionHandle,System.Reflection.Metadata.MethodDefinitionHandle)">
<summary>
Search for the <typeparamref name="MethodSymbol"/> corresponding to the given MethodDef token. Search amongst
the supertypes (classes and interfaces) of a designated type.
</summary>
<remarks>
Generally, the type will be a type that explicitly implements an interface and the method will be the
implemented method (i.e. on the interface).
</remarks>
<param name="searchTypeDef">TypeDef token of the type from which the search should begin.</param>
<param name="targetMethodDef">MethodDef token of the target method.</param>
<returns>Corresponding <typeparamref name="MethodSymbol"/> or null, if none is found.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataDecoder`5.EnqueueTypeDefInterfacesAndBaseTypeOrThrow(System.Collections.Generic.Queue{System.Reflection.Metadata.TypeDefinitionHandle},System.Collections.Generic.Queue{`1},System.Reflection.Metadata.TypeDefinitionHandle)">
<summary>
Enqueue the interfaces implemented and the type extended by a given TypeDef.
</summary>
<param name="typeDefsToSearch">Queue of TypeDefs to search.</param>
<param name="typeSymbolsToSearch">Queue of TypeSymbols (representing typeRefs to search).</param>
<param name="searchTypeDef">Handle of the TypeDef for which we want to enqueue supertypes.</param>
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataDecoder`5.EnqueueTypeToken(System.Collections.Generic.Queue{System.Reflection.Metadata.TypeDefinitionHandle},System.Collections.Generic.Queue{`1},System.Reflection.Metadata.EntityHandle)">
<summary>
Helper method for enqueuing a type token in the right queue.
Def -> typeDefsToSearch
Ref -> typeSymbolsToSearch
null -> neither
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataDecoder`5.EnqueueTypeSymbolInterfacesAndBaseTypes(System.Collections.Generic.Queue{System.Reflection.Metadata.TypeDefinitionHandle},System.Collections.Generic.Queue{`1},`1)">
<summary>
Enqueue the interfaces implemented and the type extended by a given TypeDef.
</summary>
<param name="typeDefsToSearch">Queue of TypeDefs to search.</param>
<param name="typeSymbolsToSearch">Queue of TypeSymbols (representing typeRefs to search).</param>
<param name="typeSymbol">Symbol for which we want to enqueue supertypes.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataDecoder`5.EnqueueTypeSymbol(System.Collections.Generic.Queue{System.Reflection.Metadata.TypeDefinitionHandle},System.Collections.Generic.Queue{`1},`1)">
<summary>
Enqueue the given type as either a def or a ref.
</summary>
<param name="typeDefsToSearch">Queue of TypeDefs to search.</param>
<param name="typeSymbolsToSearch">Queue of TypeSymbols (representing typeRefs to search).</param>
<param name="typeSymbol">Symbol to enqueue.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataDecoder`5.FindMethodSymbolInType(`1,System.Reflection.Metadata.MethodDefinitionHandle)">
<summary>
Search the members of a TypeSymbol to find the one that matches a given MethodDef token.
</summary>
<param name="type">Type to search for method.</param>
<param name="methodDef">MethodDef handle of the method to find.</param>
<returns>The corresponding MethodSymbol or null.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataDecoder`5.FindFieldSymbolInType(`1,System.Reflection.Metadata.FieldDefinitionHandle)">
<summary>
Search the members of a TypeSymbol to find the one that matches a given FieldDef token.
</summary>
<param name="type">Type to search for field.</param>
<param name="fieldDef">FieldDef handle of the field to find.</param>
<returns>The corresponding FieldSymbol or null.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataDecoder`5.GetSymbolForMemberRef(System.Reflection.Metadata.MemberReferenceHandle,`1,System.Boolean)">
<summary>
Given a MemberRef token for a method, we can find a corresponding MethodSymbol by
searching for the name and signature.
</summary>
<param name="memberRef">A MemberRef token for a method.</param>
<param name="implementingTypeSymbol">Scope the search to supertypes of the implementing type.</param>
<param name="methodsOnly">True to only return method symbols, null if the token resolves to a field.</param>
<returns>The corresponding MethodSymbol or null.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataDecoder`5.GetMethodHandle(`2)">
<summary>
Given a method symbol, return the MethodDef token, if it is defined in
this module, or a nil token, otherwise.
</summary>
<param name="method">The method symbol for which to return a MethodDef token.</param>
<returns>A MethodDef token or nil.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataDecoder`5.GetSymbolForILToken(System.Reflection.Metadata.EntityHandle)">
<summary>
Returns a symbol that given token resolves to or null of the token represents an entity that isn't represented by a symbol,
such as vararg MemberRef.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataDecoder`5.GetMemberRefTypeSymbol(System.Reflection.Metadata.MemberReferenceHandle)">
<summary>
Given a MemberRef token, return the TypeSymbol for its Class field.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataDecoder`5.DoPropertySignaturesMatch(Microsoft.CodeAnalysis.ParamInfo{`1}[],Microsoft.CodeAnalysis.ParamInfo{`1}[],System.Boolean,System.Boolean,System.Boolean)">
<summary>
Checks whether signatures match where the signatures are either from a property
and an accessor or two accessors. When comparing a property or getter to setter, the
setter signature must be the second argument and 'comparingToSetter' must be true.
</summary>
<param name="signature1">
Signature of the property containing the accessor, or the getter (type, then parameters).
</param>
<param name="signature2">
Signature of the accessor when comparing property and accessor,
or the setter when comparing getter and setter (return type and then parameters).
</param>
<param name="comparingToSetter">
True when comparing a property or getter to a setter, false otherwise.
</param>
<param name="compareParamByRef">
True if differences in IsByRef for parameters should be treated as significant.
</param>
<param name="compareReturnType">
True if differences in return type (or value parameter for setter) should be treated as significant.
</param>
<returns>True if the accessor signature is appropriate for the containing property.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataDecoder`5.DoesSignatureMatchEvent(`1,Microsoft.CodeAnalysis.ParamInfo{`1}[])">
<summary>
Check whether an event accessor has an appropriate signature.
</summary>
<param name="eventType">Type of the event containing the accessor.</param>
<param name="methodParams">Signature of the accessor (return type and then parameters).</param>
<returns>True if the accessor signature is appropriate for the containing event.</returns>
</member>
<member name="F:Microsoft.CodeAnalysis.MetadataHelpers.AssemblyQualifiedTypeName.ArrayRanks">
<summary>
Rank equal 0 is used to denote an SzArray, rank equal 1 denotes multi-dimensional array of rank 1.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.MetadataHelpers.SerializedTypeDecoder">
<summary>
Decodes a serialized type name in its canonical form. The canonical name is its full type name, followed
optionally by the assembly where it is defined, its version, culture and public key token. If the assembly
name is omitted, the type name is in the current assembly otherwise it is in the referenced assembly. The
full type name is the fully qualified metadata type name.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataHelpers.SerializedTypeDecoder.DecodeTypeName(System.Boolean,System.Boolean)">
<summary>
Decodes a type name. A type name is a string which is terminated by the end of the string or one of the
delimiters '+', ',', '[', ']'. '+' separates nested classes. '[' and ']'
enclosed generic type arguments. ',' separates types.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataHelpers.SerializedTypeDecoder.DecodeGenericName(System.Int32)">
<summary>
Decodes a generic name. This is a type name followed optionally by a type parameter count
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataHelpers.SerializedTypeDecoder.DecodeArrayShape(System.Text.StringBuilder,Microsoft.CodeAnalysis.PooledObjects.ArrayBuilder{System.Int32}@)">
<summary>
Rank equal 0 is used to denote an SzArray, rank equal 1 denotes multi-dimensional array of rank 1.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.MetadataHelpers.s_splitQualifiedNameSystem">
<summary>
An ImmutableArray representing the single string "System"
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataHelpers.GetInfoForImmediateNamespaceMembers(System.Boolean,System.Int32,System.Collections.Generic.IEnumerable{System.Linq.IGrouping{System.String,System.Reflection.Metadata.TypeDefinitionHandle}},System.StringComparer,System.Collections.Generic.IEnumerable{System.Linq.IGrouping{System.String,System.Reflection.Metadata.TypeDefinitionHandle}}@,System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.Collections.Generic.IEnumerable{System.Linq.IGrouping{System.String,System.Reflection.Metadata.TypeDefinitionHandle}}}}@)">
<summary>
Calculates information about types and namespaces immediately contained within a namespace.
</summary>
<param name="isGlobalNamespace">
Is current namespace a global namespace?
</param>
<param name="namespaceNameLength">
Length of the fully-qualified name of this namespace.
</param>
<param name="typesByNS">
The sequence of groups of TypeDef row ids for types contained within the namespace,
recursively including those from nested namespaces. The row ids must be grouped by the
fully-qualified namespace name in case-sensitive manner.
Key of each IGrouping is a fully-qualified namespace name, which starts with the name of
this namespace. There could be multiple groups for each fully-qualified namespace name.
The groups must be sorted by the keys in a manner consistent with comparer passed in as
nameComparer. Therefore, all types immediately contained within THIS namespace, if any,
must be in several IGrouping at the very beginning of the sequence.
</param>
<param name="nameComparer">
Equality comparer to compare namespace names.
</param>
<param name="types">
Output parameter, never null:
A sequence of groups of TypeDef row ids for types immediately contained within this namespace.
</param>
<param name="namespaces">
Output parameter, never null:
A sequence with information about namespaces immediately contained within this namespace.
For each pair:
Key - contains simple name of a child namespace.
Value - contains a sequence similar to the one passed to this function, but
calculated for the child namespace.
</param>
<remarks></remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataHelpers.ExtractSimpleNameOfChildNamespace(System.Int32,System.String)">
<summary>
Extract a simple name of a top level child namespace from potentially qualified namespace name.
</summary>
<param name="parentNamespaceNameLength">
Parent namespace name length plus the dot.
</param>
<param name="fullName">
Fully qualified namespace name.
</param>
<returns>
Simple name of a top level child namespace, the left-most name following parent namespace name
in the fully qualified name.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataHelpers.IsValidMetadataIdentifier(System.String)">
<summary>
Determines whether given string can be used as a non-empty metadata identifier (a NUL-terminated UTF8 string).
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataHelpers.IsValidUnicodeString(System.String)">
<summary>
True if the string doesn't contain incomplete surrogates.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataHelpers.IsValidMetadataFileName(System.String)">
<summary>
Checks that the specified name is a valid metadata String and a file name.
The specification isn't entirely consistent and complete but it mentions:
22.19.2: "Name shall index a non-empty string in the String heap. It shall be in the format {filename}.{extension} (e.g., 'goo.dll', but not 'c:\utils\goo.dll')."
22.30.2: "The format of Name is {file name}.{file extension} with no path or drive letter; on POSIX-compliant systems Name contains no colon, no forward-slash, no backslash."
As Microsoft specific constraint.
A reasonable restriction seems to be a valid UTF8 non-empty string that doesn't contain '\0', '\', '/', ':' characters.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataHelpers.SplitNameEqualsFullyQualifiedName(System.String,System.String,System.String)">
<summary>
Determine if the given namespace and type names combine to produce the given fully qualified name.
</summary>
<param name="namespaceName">The namespace part of the split name.</param>
<param name="typeName">The type name part of the split name.</param>
<param name="fullyQualified">The fully qualified name to compare with.</param>
<returns>true if the combination of <paramref name="namespaceName"/> and <paramref name="typeName"/> equals the fully-qualified name given by <paramref name="fullyQualified"/></returns>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataHelpers.MangleForTypeNameIfNeeded(System.String)">
<summary>
Given an input string changes it to be acceptable as a part of a type name.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.MetadataImportOptions">
<summary>
Specifies what symbols to import from metadata.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.MetadataImportOptions.Public">
<summary>
Only import public and protected symbols.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.MetadataImportOptions.Internal">
<summary>
Import public, protected and internal symbols.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.MetadataImportOptions.All">
<summary>
Import all symbols.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataReaderExtensions.ReadAssemblyIdentityOrThrow(System.Reflection.Metadata.MetadataReader)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataReaderExtensions.GetReferencedAssembliesOrThrow(System.Reflection.Metadata.MetadataReader)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataReaderExtensions.GetModuleVersionIdOrThrow(System.Reflection.Metadata.MetadataReader)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataReaderExtensions.CreateAssemblyIdentityOrThrow(System.Reflection.Metadata.MetadataReader,System.Version,System.Reflection.AssemblyFlags,System.Reflection.Metadata.BlobHandle,System.Reflection.Metadata.StringHandle,System.Reflection.Metadata.StringHandle,System.Boolean)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataReaderExtensions.IsPublicNonInterfaceType(System.Reflection.Metadata.MetadataReader,System.Reflection.Metadata.TypeDefinition,System.String,System.String)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="T:Microsoft.CodeAnalysis.MetadataTypeName">
<summary>
Helper structure to encapsulate/cache various information about metadata name of a type and
name resolution options.
Also, allows us to stop using strings in the APIs that accept only metadata names,
making usage of them less bug prone.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.MetadataTypeName._fullName">
<summary>
Full metadata name of a type, includes namespace name for top level types.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.MetadataTypeName._namespaceName">
<summary>
Namespace name for top level types.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.MetadataTypeName._typeName">
<summary>
Name of the type without namespace prefix, but possibly with generic arity mangling present.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.MetadataTypeName._unmangledTypeName">
<summary>
Name of the type without namespace prefix and without generic arity mangling.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.MetadataTypeName._inferredArity">
<summary>
Arity of the type inferred based on the name mangling. It doesn't have to match the actual
arity of the type.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.MetadataTypeName._forcedArity">
<summary>
While resolving the name, consider only types with this arity.
(-1) means allow any arity.
If forcedArity >= 0 and useCLSCompliantNameArityEncoding, lookup may
fail because forcedArity doesn't match the one encoded in the name.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.MetadataTypeName._useCLSCompliantNameArityEncoding">
<summary>
While resolving the name, consider only types following
CLS-compliant generic type names and arity encoding (ECMA-335, section 10.7.2).
I.e. arity is inferred from the name and matching type must have the same
emitted name and arity.
TODO: PERF: Encode this field elsewhere to save 4 bytes
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.MetadataTypeName._namespaceSegments">
<summary>
Individual parts of qualified namespace name.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.MetadataTypeName.FullName">
<summary>
Full metadata name of a type, includes namespace name for top level types.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.MetadataTypeName.NamespaceName">
<summary>
Namespace name for top level types, empty string for nested types.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.MetadataTypeName.TypeName">
<summary>
Name of the type without namespace prefix, but possibly with generic arity mangling present.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.MetadataTypeName.UnmangledTypeName">
<summary>
Name of the type without namespace prefix and without generic arity mangling.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.MetadataTypeName.InferredArity">
<summary>
Arity of the type inferred based on the name mangling. It doesn't have to match the actual
arity of the type.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.MetadataTypeName.IsMangled">
<summary>
Does name include arity mangling suffix.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.MetadataTypeName.UseCLSCompliantNameArityEncoding">
<summary>
While resolving the name, consider only types following
CLS-compliant generic type names and arity encoding (ECMA-335, section 10.7.2).
I.e. arity is inferred from the name and matching type must have the same
emitted name and arity.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.MetadataTypeName.ForcedArity">
<summary>
While resolving the name, consider only types with this arity.
(-1) means allow any arity.
If ForcedArity >= 0 and UseCLSCompliantNameArityEncoding, lookup may
fail because ForcedArity doesn't match the one encoded in the name.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.MetadataTypeName.NamespaceSegments">
<summary>
Individual parts of qualified namespace name.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.MetadataTypeName.Key">
<summary>
A digest of MetadataTypeName's fully qualified name which can be used as the key in a dictionary
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.ModuleExtensions.ShouldImportNestedType(Microsoft.CodeAnalysis.PEModule,System.Reflection.Metadata.TypeDefinitionHandle)">
<summary>
Returns true if the nested type should be imported.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.ModuleExtensions.ShouldImportField(Microsoft.CodeAnalysis.PEModule,System.Reflection.Metadata.FieldDefinitionHandle,Microsoft.CodeAnalysis.MetadataImportOptions)">
<summary>
Returns true if the field should be imported. Visibility
and the value of <paramref name="importOptions"/> are considered
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.ModuleExtensions.ShouldImportField(System.Reflection.FieldAttributes,Microsoft.CodeAnalysis.MetadataImportOptions)">
<summary>
Returns true if the flags represent a field that should be imported.
Visibility and the value of <paramref name="importOptions"/> are considered
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.ModuleExtensions.ShouldImportMethod(Microsoft.CodeAnalysis.PEModule,System.Reflection.Metadata.MethodDefinitionHandle,Microsoft.CodeAnalysis.MetadataImportOptions)">
<summary>
Returns true if the method should be imported. Returns false for private methods that are not
explicit interface implementations. For other methods, visibility and the value of
<paramref name="importOptions"/> are considered.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.ModuleExtensions.GetVTableGapSize(System.String)">
<summary>
Returns 0 if method name doesn't represent a v-table gap.
Otherwise, returns the gap size.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.PEAssembly.AssemblyReferences">
<summary>
All assemblies this assembly references.
</summary>
<remarks>
A concatenation of assemblies referenced by each module in the order they are listed in <see cref="F:Microsoft.CodeAnalysis.PEAssembly._modules"/>.
</remarks>
</member>
<member name="F:Microsoft.CodeAnalysis.PEAssembly.ModuleReferenceCounts">
<summary>
The number of assemblies referenced by each module in <see cref="F:Microsoft.CodeAnalysis.PEAssembly._modules"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.PEAssembly._identity">
<summary>
Assembly identity read from Assembly table, or null if the table is empty.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.PEAssembly._lazyContainsNoPiaLocalTypes">
<summary>
Using <see cref="T:Microsoft.CodeAnalysis.ThreeState"/> for atomicity.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.PEAssembly._owner">
<summary>
We need to store reference to the assembly metadata to keep the metadata alive while
symbols have reference to PEAssembly.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.PEAssembly.#ctor(Microsoft.CodeAnalysis.AssemblyMetadata,System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.PEModule})">
<exception cref="T:System.BadImageFormatException"/>
</member>
<member name="T:Microsoft.CodeAnalysis.PEModule">
<summary>
A set of helpers for extracting elements from metadata.
This type is not responsible for managing the underlying storage
backing the PE image.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.PEModule._owner">
<summary>
We need to store reference to the module metadata to keep the metadata alive while
symbols have reference to PEModule.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.PEModule._lazyForwardedTypesToAssemblyIndexMap">
<summary>
This is a tuple for optimization purposes. In valid cases, we need to store
only one assembly index per type. However, if we found more than one, we
keep a second one as well to use it for error reporting.
We use -1 in case there was no forward.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.PEModule._lazyContainsNoPiaLocalTypes">
<summary>
Using <see cref="T:Microsoft.CodeAnalysis.ThreeState"/> as a type for atomicity.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.PEModule._lazyNoPiaLocalTypeCheckBitMap">
<summary>
If bitmap is not null, each bit indicates whether a TypeDef
with corresponding RowId has been checked if it is a NoPia
local type. If the bit is 1, local type will have an entry
in m_lazyTypeDefToTypeIdentifierMap.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.PEModule._lazyTypeDefToTypeIdentifierMap">
<summary>
For each TypeDef that has 1 in m_lazyNoPiaLocalTypeCheckBitMap,
this map stores corresponding TypeIdentifier AttributeInfo.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.PEModule.Machine">
<summary>
Target architecture of the machine.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.PEModule.Bit32Required">
<summary>
Indicates that this PE file makes Win32 calls. See CorPEKind.pe32BitRequired for more information (http://msdn.microsoft.com/en-us/library/ms230275.aspx).
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetModuleVersionIdOrThrow">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetMetadataModuleNamesOrThrow">
<summary>
Returns the names of linked managed modules.
</summary>
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetReferencedManagedModulesOrThrow">
<summary>
Returns names of referenced modules.
</summary>
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetModuleRefNameOrThrow(System.Reflection.Metadata.ModuleReferenceHandle)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetMemoryReaderOrThrow(System.Reflection.Metadata.BlobHandle)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetFullNameOrThrow(System.Reflection.Metadata.StringHandle,System.Reflection.Metadata.StringHandle)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.ReadAssemblyIdentityOrThrow">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetContainingTypeOrThrow(System.Reflection.Metadata.TypeDefinitionHandle)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetTypeDefNameOrThrow(System.Reflection.Metadata.TypeDefinitionHandle)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetTypeDefNamespaceOrThrow(System.Reflection.Metadata.TypeDefinitionHandle)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetTypeDefExtendsOrThrow(System.Reflection.Metadata.TypeDefinitionHandle)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetTypeDefFlagsOrThrow(System.Reflection.Metadata.TypeDefinitionHandle)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetTypeDefGenericParamsOrThrow(System.Reflection.Metadata.TypeDefinitionHandle)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.HasGenericParametersOrThrow(System.Reflection.Metadata.TypeDefinitionHandle)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetTypeDefPropsOrThrow(System.Reflection.Metadata.TypeDefinitionHandle,System.String@,System.String@,System.Reflection.TypeAttributes@,System.Reflection.Metadata.EntityHandle@)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.IsNestedTypeDefOrThrow(System.Reflection.Metadata.TypeDefinitionHandle)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.IsNestedTypeDefOrThrow(System.Reflection.Metadata.MetadataReader,System.Reflection.Metadata.TypeDefinitionHandle)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.IsInterfaceOrThrow(System.Reflection.Metadata.TypeDefinitionHandle)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetTypeDefsOrThrow(System.Boolean)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GroupTypesByNamespaceOrThrow(System.StringComparer)">
<summary>
The function groups types defined in the module by their fully-qualified namespace name.
The case-sensitivity of the grouping depends upon the provided StringComparer.
The sequence is sorted by name by using provided comparer. Therefore, if there are multiple
groups for a namespace name (e.g. because they differ in case), the groups are going to be
adjacent to each other.
Empty string is used as namespace name for types in the Global namespace. Therefore, all types
in the Global namespace, if any, should be in the first group (assuming a reasonable StringComparer).
</summary>
Comparer to sort the groups.
<param name="nameComparer">
</param>
<returns>A sorted list of TypeDef row ids, grouped by fully-qualified namespace name.</returns>
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetTypeNamespaceNamesOrThrow(System.Collections.Generic.Dictionary{System.String,Microsoft.CodeAnalysis.PooledObjects.ArrayBuilder{System.Reflection.Metadata.TypeDefinitionHandle}})">
<summary>
Groups together the RowIds of types in a given namespaces. The types considered are
those defined in this module.
</summary>
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetForwardedTypeNamespaceNamesOrThrow(System.Collections.Generic.Dictionary{System.String,Microsoft.CodeAnalysis.PooledObjects.ArrayBuilder{System.Reflection.Metadata.TypeDefinitionHandle}})">
<summary>
Supplements the namespace-to-RowIDs map with the namespaces of forwarded types.
These types will not have associated row IDs (represented as null, for efficiency).
These namespaces are important because we want lookups of missing forwarded types
to succeed far enough that we can actually find the type forwarder and provide
information about the target assembly.
For example, consider the following forwarded type:
.class extern forwarder Namespace.Type {}
If this type is referenced in source as "Namespace.Type", then dev10 reports
error CS1070: The type name 'Namespace.Name' could not be found. This type has been
forwarded to assembly 'pe2, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null'.
Consider adding a reference to that assembly.
If we did not include "Namespace" as a child of the global namespace of this module
(the forwarding module), then Roslyn would report that the type "Namespace" was not
found and say nothing about "Name" (because of the diagnostic already attached to
the qualifier).
</summary>
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetNestedTypeDefsOrThrow(System.Reflection.Metadata.TypeDefinitionHandle)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetMethodImplementationsOrThrow(System.Reflection.Metadata.TypeDefinitionHandle)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetInterfaceImplementationsOrThrow(System.Reflection.Metadata.TypeDefinitionHandle)">
<summary>
Returns a collection of interfaces implemented by given type.
</summary>
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetMethodsOfTypeOrThrow(System.Reflection.Metadata.TypeDefinitionHandle)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetPropertiesOfTypeOrThrow(System.Reflection.Metadata.TypeDefinitionHandle)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetEventsOfTypeOrThrow(System.Reflection.Metadata.TypeDefinitionHandle)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetFieldsOfTypeOrThrow(System.Reflection.Metadata.TypeDefinitionHandle)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetBaseTypeOfTypeOrThrow(System.Reflection.Metadata.TypeDefinitionHandle)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetMemberNotNullAttributeValues(System.Reflection.Metadata.EntityHandle)">
<summary>
Find the MemberNotNull attribute(s) and extract the list of referenced member names
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetMemberNotNullWhenAttributeValues(System.Reflection.Metadata.EntityHandle)">
<summary>
Find the MemberNotNullWhen attribute(s) and extract the list of referenced member names
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.CrackObsoleteProperties(System.Reflection.Metadata.BlobReader@,Microsoft.CodeAnalysis.IAttributeNamedArgumentDecoder)">
<summary>
Gets the well-known optional named properties on ObsoleteAttribute, if present.
Both 'diagnosticId' and 'urlFormat' may be present, or only one, or neither.
</summary>
<remarks>
Failure to find any of these properties does not imply failure to decode the ObsoleteAttribute,
so we don't return a value indicating success or failure.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetParamArrayCountOrThrow(System.Reflection.Metadata.EntityHandle)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.IsTypeIdentifierAttribute(System.Reflection.Metadata.CustomAttributeHandle)">
<summary>
Determine if custom attribute application is
NoPia TypeIdentifier.
</summary>
<returns>
An index of the target constructor signature in
signaturesOfTypeIdentifierAttribute array, -1 if
this is not NoPia TypeIdentifier.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.IsTargetAttribute(System.Reflection.Metadata.CustomAttributeHandle,System.String,System.String,System.Reflection.Metadata.EntityHandle@,System.Boolean)">
<summary>
Determines if a custom attribute matches a namespace and name.
</summary>
<param name="customAttribute">Handle of the custom attribute.</param>
<param name="namespaceName">The custom attribute's namespace in metadata format (case sensitive)</param>
<param name="typeName">The custom attribute's type name in metadata format (case sensitive)</param>
<param name="ctor">Constructor of the custom attribute.</param>
<param name="ignoreCase">Should case be ignored for name comparison?</param>
<returns>true if match is found</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.IsTargetAttribute(System.Reflection.Metadata.MetadataReader,System.Reflection.Metadata.CustomAttributeHandle,System.String,System.String,System.Reflection.Metadata.EntityHandle@,System.Boolean)">
<summary>
Determines if a custom attribute matches a namespace and name.
</summary>
<param name="metadataReader">The metadata reader.</param>
<param name="customAttribute">Handle of the custom attribute.</param>
<param name="namespaceName">The custom attribute's namespace in metadata format (case sensitive)</param>
<param name="typeName">The custom attribute's type name in metadata format (case sensitive)</param>
<param name="ctor">Constructor of the custom attribute.</param>
<param name="ignoreCase">Should case be ignored for name comparison?</param>
<returns>true if match is found</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetAssemblyRef(System.String)">
<summary>
Returns MetadataToken for assembly ref matching name
</summary>
<param name="assemblyName">The assembly name in metadata format (case sensitive)</param>
<returns>Matching assembly ref token or nil (0)</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetTypeRef(System.Reflection.Metadata.EntityHandle,System.String,System.String)">
<summary>
Returns MetadataToken for type ref matching resolution scope and name
</summary>
<param name="resolutionScope">The resolution scope token</param>
<param name="namespaceName">The namespace name in metadata format (case sensitive)</param>
<param name="typeName">The type name in metadata format (case sensitive)</param>
<returns>Matching type ref token or nil (0)</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetTypeRefPropsOrThrow(System.Reflection.Metadata.TypeReferenceHandle,System.String@,System.String@,System.Reflection.Metadata.EntityHandle@)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetTargetAttributeSignatureIndex(System.Reflection.Metadata.CustomAttributeHandle,Microsoft.CodeAnalysis.AttributeDescription)">
<summary>
Determine if custom attribute matches the target attribute.
</summary>
<param name="customAttribute">
Handle of the custom attribute.
</param>
<param name="description">The attribute to match.</param>
<returns>
An index of the target constructor signature in
signatures array, -1 if
this is not the target attribute.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetTargetAttributeSignatureIndex(System.Reflection.Metadata.MetadataReader,System.Reflection.Metadata.CustomAttributeHandle,Microsoft.CodeAnalysis.AttributeDescription)">
<summary>
Determine if custom attribute matches the target attribute.
</summary>
<param name="metadataReader">
The metadata reader.
</param>
<param name="customAttribute">
Handle of the custom attribute.
</param>
<param name="description">The attribute to match.</param>
<returns>
An index of the target constructor signature in
signatures array, -1 if
this is not the target attribute.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetTypeAndConstructor(System.Reflection.Metadata.CustomAttributeHandle,System.Reflection.Metadata.EntityHandle@,System.Reflection.Metadata.EntityHandle@)">
<summary>
Given a token for a constructor, return the token for the constructor's type and the blob containing the
constructor's signature.
</summary>
<returns>True if the function successfully returns the type and signature.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetTypeAndConstructor(System.Reflection.Metadata.MetadataReader,System.Reflection.Metadata.CustomAttributeHandle,System.Reflection.Metadata.EntityHandle@,System.Reflection.Metadata.EntityHandle@)">
<summary>
Given a token for a constructor, return the token for the constructor's type and the blob containing the
constructor's signature.
</summary>
<returns>True if the function successfully returns the type and signature.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetAttributeNamespaceAndName(System.Reflection.Metadata.EntityHandle,System.Reflection.Metadata.StringHandle@,System.Reflection.Metadata.StringHandle@)">
<summary>
Given a token for a type, return the type's name and namespace. Only works for top level types.
namespaceHandle will be NamespaceDefinitionHandle for defs and StringHandle for refs.
</summary>
<returns>True if the function successfully returns the name and namespace.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetAttributeNamespaceAndName(System.Reflection.Metadata.MetadataReader,System.Reflection.Metadata.EntityHandle,System.Reflection.Metadata.StringHandle@,System.Reflection.Metadata.StringHandle@)">
<summary>
Given a token for a type, return the type's name and namespace. Only works for top level types.
namespaceHandle will be NamespaceDefinitionHandle for defs and StringHandle for refs.
</summary>
<returns>True if the function successfully returns the name and namespace.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.PretendThereArentNoPiaLocalTypes">
<summary>
For testing purposes only!!!
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetTypeSpecificationSignatureReaderOrThrow(System.Reflection.Metadata.TypeSpecificationHandle)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetMethodSpecificationOrThrow(System.Reflection.Metadata.MethodSpecificationHandle,System.Reflection.Metadata.EntityHandle@,System.Reflection.Metadata.BlobHandle@)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetGenericParamPropsOrThrow(System.Reflection.Metadata.GenericParameterHandle,System.String@,System.Reflection.GenericParameterAttributes@)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetMethodDefNameOrThrow(System.Reflection.Metadata.MethodDefinitionHandle)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetMethodSignatureOrThrow(System.Reflection.Metadata.MethodDefinitionHandle)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetMethodSignatureOrThrow(System.Reflection.Metadata.MetadataReader,System.Reflection.Metadata.MethodDefinitionHandle)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetMethodSignatureOrThrow(System.Reflection.Metadata.EntityHandle)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetMethodSignatureOrThrow(System.Reflection.Metadata.MetadataReader,System.Reflection.Metadata.EntityHandle)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetMethodDefFlagsOrThrow(System.Reflection.Metadata.MethodDefinitionHandle)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.FindContainingTypeOrThrow(System.Reflection.Metadata.MethodDefinitionHandle)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.FindContainingTypeOrThrow(System.Reflection.Metadata.FieldDefinitionHandle)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetContainingTypeOrThrow(System.Reflection.Metadata.MemberReferenceHandle)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetMethodDefPropsOrThrow(System.Reflection.Metadata.MethodDefinitionHandle,System.String@,System.Reflection.MethodImplAttributes@,System.Reflection.MethodAttributes@,System.Int32@)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetMethodImplPropsOrThrow(System.Reflection.Metadata.MethodImplementationHandle,System.Reflection.Metadata.EntityHandle@,System.Reflection.Metadata.EntityHandle@)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetGenericParametersForMethodOrThrow(System.Reflection.Metadata.MethodDefinitionHandle)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetParametersOfMethodOrThrow(System.Reflection.Metadata.MethodDefinitionHandle)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetMemberRefNameOrThrow(System.Reflection.Metadata.MemberReferenceHandle)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetMemberRefNameOrThrow(System.Reflection.Metadata.MetadataReader,System.Reflection.Metadata.MemberReferenceHandle)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetSignatureOrThrow(System.Reflection.Metadata.MemberReferenceHandle)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetSignatureOrThrow(System.Reflection.Metadata.MetadataReader,System.Reflection.Metadata.MemberReferenceHandle)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetMemberRefPropsOrThrow(System.Reflection.Metadata.MemberReferenceHandle,System.Reflection.Metadata.EntityHandle@,System.String@,System.Byte[]@)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetParamPropsOrThrow(System.Reflection.Metadata.ParameterHandle,System.String@,System.Reflection.ParameterAttributes@)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetParamNameOrThrow(System.Reflection.Metadata.ParameterHandle)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetParameterSequenceNumberOrThrow(System.Reflection.Metadata.ParameterHandle)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetPropertyDefNameOrThrow(System.Reflection.Metadata.PropertyDefinitionHandle)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetPropertySignatureOrThrow(System.Reflection.Metadata.PropertyDefinitionHandle)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetPropertyDefPropsOrThrow(System.Reflection.Metadata.PropertyDefinitionHandle,System.String@,System.Reflection.PropertyAttributes@)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetEventDefNameOrThrow(System.Reflection.Metadata.EventDefinitionHandle)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetEventDefPropsOrThrow(System.Reflection.Metadata.EventDefinitionHandle,System.String@,System.Reflection.EventAttributes@,System.Reflection.Metadata.EntityHandle@)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetFieldDefNameOrThrow(System.Reflection.Metadata.FieldDefinitionHandle)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetFieldSignatureOrThrow(System.Reflection.Metadata.FieldDefinitionHandle)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetFieldDefFlagsOrThrow(System.Reflection.Metadata.FieldDefinitionHandle)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetFieldDefPropsOrThrow(System.Reflection.Metadata.FieldDefinitionHandle,System.String@,System.Reflection.FieldAttributes@)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetCustomAttributesOrThrow(System.Reflection.Metadata.EntityHandle)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetCustomAttributeValueOrThrow(System.Reflection.Metadata.CustomAttributeHandle)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetMarshallingDescriptorHandleOrThrow(System.Reflection.Metadata.EntityHandle)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetConstantValueOrThrow(System.Reflection.Metadata.ConstantHandle)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetPropertyMethodsOrThrow(System.Reflection.Metadata.PropertyDefinitionHandle)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetEventMethodsOrThrow(System.Reflection.Metadata.EventDefinitionHandle)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetAssemblyReferenceIndexOrThrow(System.Reflection.Metadata.AssemblyReferenceHandle)">
<exception cref="T:System.BadImageFormatException">An exception from metadata reader.</exception>
</member>
<member name="P:Microsoft.CodeAnalysis.PEModule.HasIL">
<summary>
Returns true if method IL can be retrieved from the module.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.PEModule.IsEntireImageAvailable">
<summary>
Returns true if the full image of the module is available.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.PEModule.GetMethodBodyOrThrow(System.Reflection.Metadata.MethodDefinitionHandle)">
<exception cref="T:System.BadImageFormatException">Invalid metadata.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.SymbolFactory`2.MakeUnboundIfGeneric(`0,`1)">
<summary>
Produce unbound generic type symbol if the type is a generic type.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SymbolFactory`2.SubstituteTypeParameters(`0,`1,System.Collections.Immutable.ImmutableArray{System.Collections.Generic.KeyValuePair{`1,System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.ModifierInfo{`1}}}},System.Collections.Immutable.ImmutableArray{System.Boolean})">
<summary>
Produce constructed type symbol.
</summary>
<param name="moduleSymbol"></param>
<param name="generic">
Symbol for generic type.
</param>
<param name="arguments">
Generic type arguments, including those for containing types.
</param>
<param name="refersToNoPiaLocalType">
Flags for arguments. Each item indicates whether corresponding argument refers to NoPia local types.
</param>
</member>
<member name="M:Microsoft.CodeAnalysis.TypeAttributesExtensions.ToCharSet(System.Reflection.TypeAttributes)">
<summary>
Extracts <see cref="T:System.Runtime.InteropServices.CharSet"/> information from TypeDef flags.
Returns 0 if the value is invalid.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.TypeNameDecoder`2.LookupTopLevelTypeDefSymbol(Microsoft.CodeAnalysis.MetadataTypeName@,System.Boolean@)">
<summary>
Lookup a type defined in this module.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.TypeNameDecoder`2.LookupTopLevelTypeDefSymbol(System.Int32,Microsoft.CodeAnalysis.MetadataTypeName@)">
<summary>
Lookup a type defined in referenced assembly.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.TypeNameDecoder`2.GetIndexOfReferencedAssembly(Microsoft.CodeAnalysis.AssemblyIdentity)">
<summary>
Given the identity of an assembly referenced by this module, finds
the index of that assembly in the list of assemblies referenced by
the current module.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.AssemblyIdentity">
<summary>
Represents an identity of an assembly as defined by CLI metadata specification.
</summary>
<remarks>
May represent assembly definition or assembly reference identity.
</remarks>
<summary>
Represents an identity of an assembly as defined by CLI metadata specification.
</summary>
<remarks>
May represent assembly definition or assembly reference identity.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.AssemblyIdentity.#ctor(System.String,System.Version,System.String,System.Collections.Immutable.ImmutableArray{System.Byte},System.Boolean,System.Boolean,System.Reflection.AssemblyContentType)">
<summary>
Constructs an <see cref="T:Microsoft.CodeAnalysis.AssemblyIdentity"/> from its constituent parts.
</summary>
<param name="name">The simple name of the assembly.</param>
<param name="version">The version of the assembly.</param>
<param name="cultureName">
The name of the culture to associate with the assembly.
Specify null, <see cref="F:System.String.Empty"/>, or "neutral" (any casing) to represent <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>.
The name can be an arbitrary string that doesn't contain NUL character, the legality of the culture name is not validated.
</param>
<param name="publicKeyOrToken">The public key or public key token of the assembly.</param>
<param name="hasPublicKey">Indicates whether <paramref name="publicKeyOrToken"/> represents a public key.</param>
<param name="isRetargetable">Indicates whether the assembly is retargetable.</param>
<param name="contentType">Specifies the binding model for how this object will be treated in comparisons.</param>
<exception cref="T:System.ArgumentException">If <paramref name="name"/> is null, empty or contains a NUL character.</exception>
<exception cref="T:System.ArgumentException">If <paramref name="cultureName"/> contains a NUL character.</exception>
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="contentType"/> is not a value of the <see cref="T:System.Reflection.AssemblyContentType"/> enumeration.</exception>
<exception cref="T:System.ArgumentException"><paramref name="version"/> contains values that are not greater than or equal to zero and less than or equal to ushort.MaxValue.</exception>
<exception cref="T:System.ArgumentException"><paramref name="hasPublicKey"/> is true and <paramref name="publicKeyOrToken"/> is not set.</exception>
<exception cref="T:System.ArgumentException"><paramref name="hasPublicKey"/> is false and <paramref name="publicKeyOrToken"/>
contains a value that is not the size of a public key token, 8 bytes.</exception>
</member>
<member name="P:Microsoft.CodeAnalysis.AssemblyIdentity.Name">
<summary>
The simple name of the assembly.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.AssemblyIdentity.Version">
<summary>
The version of the assembly.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.AssemblyIdentity.CultureName">
<summary>
The culture name of the assembly, or empty if the culture is neutral.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.AssemblyIdentity.Flags">
<summary>
The AssemblyNameFlags.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.AssemblyIdentity.ContentType">
<summary>
Specifies assembly binding model for the assembly definition or reference;
that is how assembly references are matched to assembly definitions.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.AssemblyIdentity.HasPublicKey">
<summary>
True if the assembly identity includes full public key.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.AssemblyIdentity.PublicKey">
<summary>
Full public key or empty.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.AssemblyIdentity.PublicKeyToken">
<summary>
Low 8 bytes of SHA1 hash of the public key, or empty.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.AssemblyIdentity.IsStrongName">
<summary>
True if the assembly identity has a strong name, ie. either a full public key or a token.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.AssemblyIdentity.IsRetargetable">
<summary>
Gets the value which specifies if the assembly is retargetable.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.AssemblyIdentity.op_Equality(Microsoft.CodeAnalysis.AssemblyIdentity,Microsoft.CodeAnalysis.AssemblyIdentity)">
<summary>
Determines whether two <see cref="T:Microsoft.CodeAnalysis.AssemblyIdentity"/> instances are equal.
</summary>
<param name="left">The operand appearing on the left side of the operator.</param>
<param name="right">The operand appearing on the right side of the operator.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.AssemblyIdentity.op_Inequality(Microsoft.CodeAnalysis.AssemblyIdentity,Microsoft.CodeAnalysis.AssemblyIdentity)">
<summary>
Determines whether two <see cref="T:Microsoft.CodeAnalysis.AssemblyIdentity"/> instances are not equal.
</summary>
<param name="left">The operand appearing on the left side of the operator.</param>
<param name="right">The operand appearing on the right side of the operator.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.AssemblyIdentity.Equals(Microsoft.CodeAnalysis.AssemblyIdentity)">
<summary>
Determines whether the specified instance is equal to the current instance.
</summary>
<param name="obj">The object to be compared with the current instance.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.AssemblyIdentity.Equals(System.Object)">
<summary>
Determines whether the specified instance is equal to the current instance.
</summary>
<param name="obj">The object to be compared with the current instance.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.AssemblyIdentity.GetHashCode">
<summary>
Returns the hash code for the current instance.
</summary>
<returns></returns>
</member>
<member name="M:Microsoft.CodeAnalysis.AssemblyIdentity.MemberwiseEqual(Microsoft.CodeAnalysis.AssemblyIdentity,Microsoft.CodeAnalysis.AssemblyIdentity)">
<summary>
Returns true (false) if specified assembly identities are (not) equal
regardless of unification, retargeting or other assembly binding policies.
Returns null if these policies must be consulted to determine name equivalence.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.AssemblyIdentity.FromAssemblyDefinition(System.Reflection.Assembly)">
<summary>
Retrieves assembly definition identity from given runtime assembly.
</summary>
<param name="assembly">The runtime assembly.</param>
<returns>Assembly definition identity.</returns>
<exception cref="T:System.ArgumentNullException"><paramref name="assembly"/> is null.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.AssemblyIdentity.GetDisplayName(System.Boolean)">
<summary>
Returns the display name of the assembly identity.
</summary>
<param name="fullKey">True if the full public key should be included in the name. Otherwise public key token is used.</param>
<returns>The display name.</returns>
<remarks>
Characters ',', '=', '"', '\'', '\' occurring in the simple name are escaped by backslash in the display name.
Any character '\t' is replaced by two characters '\' and 't',
Any character '\n' is replaced by two characters '\' and 'n',
Any character '\r' is replaced by two characters '\' and 'r',
The assembly name in the display name is enclosed in double quotes if it starts or ends with
a whitespace character (' ', '\t', '\r', '\n').
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.AssemblyIdentity.ToString">
<summary>
Returns the display name of the current instance.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.AssemblyIdentity.TryParseDisplayName(System.String,Microsoft.CodeAnalysis.AssemblyIdentity@,Microsoft.CodeAnalysis.AssemblyIdentityParts@)">
<summary>
Parses display name filling defaults for any basic properties that are missing.
</summary>
<param name="displayName">Display name.</param>
<param name="identity">A full assembly identity.</param>
<param name="parts">
Parts of the assembly identity that were specified in the display name,
or 0 if the parsing failed.
</param>
<returns>True if display name parsed correctly.</returns>
<remarks>
The simple name has to be non-empty.
A partially specified version might be missing build and/or revision number. The default value for these is 65535.
The default culture is neutral (<see cref="P:Microsoft.CodeAnalysis.AssemblyIdentity.CultureName"/> is <see cref="F:System.String.Empty"/>.
If neither public key nor token is specified the identity is considered weak.
</remarks>
<exception cref="T:System.ArgumentNullException"><paramref name="displayName"/> is null.</exception>
</member>
<member name="T:Microsoft.CodeAnalysis.AssemblyIdentityComparer">
<summary>
Compares assembly identities.
Derived types may implement platform specific unification and portability policies.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.AssemblyIdentityComparer.ComparisonResult">
<summary>
A set of possible outcomes of <see cref="T:Microsoft.CodeAnalysis.AssemblyIdentity"/> comparison.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.AssemblyIdentityComparer.ComparisonResult.NotEquivalent">
<summary>
Reference doesn't match definition.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.AssemblyIdentityComparer.ComparisonResult.Equivalent">
<summary>
Strongly named reference matches strongly named definition (strong identity is identity with public key or token),
Or weak reference matches weak definition.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.AssemblyIdentityComparer.ComparisonResult.EquivalentIgnoringVersion">
<summary>
Reference matches definition except for version (reference version is lower or higher than definition version).
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.AssemblyIdentityComparer.ReferenceMatchesDefinition(System.String,Microsoft.CodeAnalysis.AssemblyIdentity)">
<summary>
Compares assembly reference name (possibly partial) with definition identity.
</summary>
<param name="referenceDisplayName">Partial or full assembly display name.</param>
<param name="definition">Full assembly display name.</param>
<returns>True if the reference name matches the definition identity.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.AssemblyIdentityComparer.ReferenceMatchesDefinition(Microsoft.CodeAnalysis.AssemblyIdentity,Microsoft.CodeAnalysis.AssemblyIdentity)">
<summary>
Compares assembly reference identity with definition identity.
</summary>
<param name="reference">Reference assembly identity.</param>
<param name="definition">Full assembly display name.</param>
<returns>True if the reference identity matches the definition identity.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.AssemblyIdentityComparer.Compare(Microsoft.CodeAnalysis.AssemblyIdentity,Microsoft.CodeAnalysis.AssemblyIdentity)">
<summary>
Compares reference assembly identity with definition identity and returns their relationship.
</summary>
<param name="reference">Reference identity.</param>
<param name="definition">Definition identity.</param>
</member>
<member name="T:Microsoft.CodeAnalysis.AssemblyIdentityMap`1">
<summary>
Implements a map from an assembly identity to a value. The map allows to look up the value by an identity
that either exactly matches the original identity key, or corresponds to a key with the lowest version among identities
with higher version than the requested identity key.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.AssemblyMetadata">
<summary>
Represents an immutable snapshot of assembly CLI metadata.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.AssemblyMetadata._moduleFactoryOpt">
<summary>
Factory that provides the <see cref="T:Microsoft.CodeAnalysis.ModuleMetadata"/> for additional modules (other than <see cref="F:Microsoft.CodeAnalysis.AssemblyMetadata._initialModules"/>) of the assembly.
Shall only throw <see cref="T:System.BadImageFormatException"/> or <see cref="T:System.IO.IOException"/>.
Null of all modules were specified at construction time.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.AssemblyMetadata._initialModules">
<summary>
Modules the <see cref="T:Microsoft.CodeAnalysis.AssemblyMetadata"/> was created with, in case they are eagerly allocated.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.AssemblyMetadata.CachedSymbols">
<summary>
Cached assembly symbols.
</summary>
<remarks>
Guarded by <see cref="F:Microsoft.CodeAnalysis.CommonReferenceManager.SymbolCacheAndReferenceManagerStateGuard"/>.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.AssemblyMetadata.CreateFromImage(System.Collections.Immutable.ImmutableArray{System.Byte})">
<summary>
Creates a single-module assembly.
</summary>
<param name="peImage">
Manifest module image.
</param>
<exception cref="T:System.ArgumentNullException"><paramref name="peImage"/> is null.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.AssemblyMetadata.CreateFromImage(System.Collections.Generic.IEnumerable{System.Byte})">
<summary>
Creates a single-module assembly.
</summary>
<param name="peImage">
Manifest module image.
</param>
<exception cref="T:System.ArgumentNullException"><paramref name="peImage"/> is null.</exception>
<exception cref="T:System.BadImageFormatException">The PE image format is invalid.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.AssemblyMetadata.CreateFromStream(System.IO.Stream,System.Boolean)">
<summary>
Creates a single-module assembly.
</summary>
<param name="peStream">Manifest module PE image stream.</param>
<param name="leaveOpen">False to close the stream upon disposal of the metadata.</param>
<exception cref="T:System.BadImageFormatException">The PE image format is invalid.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.AssemblyMetadata.CreateFromStream(System.IO.Stream,System.Reflection.PortableExecutable.PEStreamOptions)">
<summary>
Creates a single-module assembly.
</summary>
<param name="peStream">Manifest module PE image stream.</param>
<param name="options">False to close the stream upon disposal of the metadata.</param>
<exception cref="T:System.BadImageFormatException">The PE image format is invalid.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.AssemblyMetadata.CreateFromFile(System.String)">
<summary>
Finds all modules of an assembly on a specified path and builds an instance of <see cref="T:Microsoft.CodeAnalysis.AssemblyMetadata"/> that represents them.
</summary>
<param name="path">The full path to the assembly on disk.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is null.</exception>
<exception cref="T:System.ArgumentException"><paramref name="path"/> is invalid.</exception>
<exception cref="T:System.IO.IOException">Error reading file <paramref name="path"/>. See <see cref="P:System.Exception.InnerException"/> for details.</exception>
<exception cref="T:System.NotSupportedException">Reading from a file path is not supported by the platform.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.AssemblyMetadata.Create(Microsoft.CodeAnalysis.ModuleMetadata)">
<summary>
Creates a single-module assembly.
</summary>
<param name="module">
Manifest module.
</param>
<remarks>This object disposes <paramref name="module"/> it when it is itself disposed.</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.AssemblyMetadata.Create(System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.ModuleMetadata})">
<summary>
Creates a multi-module assembly.
</summary>
<param name="modules">
Modules comprising the assembly. The first module is the manifest module of the assembly.</param>
<remarks>This object disposes the elements of <paramref name="modules"/> it when it is itself <see cref="M:Microsoft.CodeAnalysis.AssemblyMetadata.Dispose"/>.</remarks>
<exception cref="T:System.ArgumentException"><paramref name="modules"/> is default value.</exception>
<exception cref="T:System.ArgumentNullException"><paramref name="modules"/> contains null elements.</exception>
<exception cref="T:System.ArgumentException"><paramref name="modules"/> is empty or contains a module that doesn't own its image (was created via <see cref="M:Microsoft.CodeAnalysis.Metadata.Copy"/>).</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.AssemblyMetadata.Create(System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.ModuleMetadata})">
<summary>
Creates a multi-module assembly.
</summary>
<param name="modules">
Modules comprising the assembly. The first module is the manifest module of the assembly.</param>
<remarks>This object disposes the elements of <paramref name="modules"/> it when it is itself <see cref="M:Microsoft.CodeAnalysis.AssemblyMetadata.Dispose"/>.</remarks>
<exception cref="T:System.ArgumentException"><paramref name="modules"/> is default value.</exception>
<exception cref="T:System.ArgumentNullException"><paramref name="modules"/> contains null elements.</exception>
<exception cref="T:System.ArgumentException"><paramref name="modules"/> is empty or contains a module that doesn't own its image (was created via <see cref="M:Microsoft.CodeAnalysis.Metadata.Copy"/>).</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.AssemblyMetadata.Create(Microsoft.CodeAnalysis.ModuleMetadata[])">
<summary>
Creates a multi-module assembly.
</summary>
<param name="modules">Modules comprising the assembly. The first module is the manifest module of the assembly.</param>
<remarks>This object disposes the elements of <paramref name="modules"/> it when it is itself <see cref="M:Microsoft.CodeAnalysis.AssemblyMetadata.Dispose"/>.</remarks>
<exception cref="T:System.ArgumentException"><paramref name="modules"/> is default value.</exception>
<exception cref="T:System.ArgumentNullException"><paramref name="modules"/> contains null elements.</exception>
<exception cref="T:System.ArgumentException"><paramref name="modules"/> is empty or contains a module that doesn't own its image (was created via <see cref="M:Microsoft.CodeAnalysis.Metadata.Copy"/>).</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.AssemblyMetadata.Copy">
<summary>
Creates a shallow copy of contained modules and wraps them into a new instance of <see cref="T:Microsoft.CodeAnalysis.AssemblyMetadata"/>.
</summary>
<remarks>
The resulting copy shares the metadata images and metadata information read from them with the original.
It doesn't own the underlying metadata images and is not responsible for its disposal.
This is used, for example, when a metadata cache needs to return the cached metadata to its users
while keeping the ownership of the cached metadata object.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.AssemblyMetadata.GetModules">
<summary>
Modules comprising this assembly. The first module is the manifest module.
</summary>
<exception cref="T:System.BadImageFormatException">The PE image format is invalid.</exception>
<exception cref="T:System.IO.IOException">IO error reading the metadata. See <see cref="P:System.Exception.InnerException"/> for details.</exception>
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.AssemblyMetadata.GetAssembly">
<exception cref="T:System.BadImageFormatException">The PE image format is invalid.</exception>
<exception cref="T:System.IO.IOException">IO error while reading the metadata. See <see cref="P:System.Exception.InnerException"/> for details.</exception>
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.AssemblyMetadata.GetOrCreateData">
<exception cref="T:System.BadImageFormatException">The PE image format is invalid.</exception>
<exception cref="T:System.IO.IOException">IO error while reading the metadata. See <see cref="P:System.Exception.InnerException"/> for details.</exception>
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.AssemblyMetadata.Dispose">
<summary>
Disposes all modules contained in the assembly.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.AssemblyMetadata.IsValidAssembly">
<summary>
Checks if the first module has a single row in Assembly table and that all other modules have none.
</summary>
<exception cref="T:System.BadImageFormatException">The PE image format is invalid.</exception>
<exception cref="T:System.IO.IOException">IO error reading the metadata. See <see cref="P:System.Exception.InnerException"/> for details.</exception>
<exception cref="T:System.ObjectDisposedException">The object has been disposed.</exception>
</member>
<member name="P:Microsoft.CodeAnalysis.AssemblyMetadata.Kind">
<summary>
Returns the metadata kind. <seealso cref="T:Microsoft.CodeAnalysis.MetadataImageKind"/>
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.AssemblyMetadata.GetReference(Microsoft.CodeAnalysis.DocumentationProvider,System.Collections.Immutable.ImmutableArray{System.String},System.Boolean,System.String,System.String)">
<summary>
Creates a reference to the assembly metadata.
</summary>
<param name="documentation">Provider of XML documentation comments for the metadata symbols contained in the module.</param>
<param name="aliases">Aliases that can be used to refer to the assembly from source code (see "extern alias" directive in C#).</param>
<param name="embedInteropTypes">True to embed interop types from the referenced assembly to the referencing compilation. Must be false for a module.</param>
<param name="filePath">Path describing the location of the metadata, or null if the metadata have no location.</param>
<param name="display">Display string used in error messages to identity the reference.</param>
<returns>A reference to the assembly metadata.</returns>
</member>
<member name="T:Microsoft.CodeAnalysis.CompilationReference">
<summary>
Reference to another C# or VB compilation.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CompilationReference.WithAliases(System.Collections.Generic.IEnumerable{System.String})">
<summary>
Returns an instance of the reference with specified aliases.
</summary>
<param name="aliases">The new aliases for the reference.</param>
<exception cref="T:System.ArgumentException">Alias is invalid for the metadata kind.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.CompilationReference.WithAliases(System.Collections.Immutable.ImmutableArray{System.String})">
<summary>
Returns an instance of the reference with specified aliases.
</summary>
<param name="aliases">The new aliases for the reference.</param>
<exception cref="T:System.ArgumentException">Alias is invalid for the metadata kind.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.CompilationReference.WithEmbedInteropTypes(System.Boolean)">
<summary>
Returns an instance of the reference with specified interop types embedding.
</summary>
<param name="value">The new value for <see cref="P:Microsoft.CodeAnalysis.MetadataReferenceProperties.EmbedInteropTypes"/>.</param>
<exception cref="T:System.ArgumentException">Interop types can't be embedded from modules.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.CompilationReference.WithProperties(Microsoft.CodeAnalysis.MetadataReferenceProperties)">
<summary>
Returns an instance of the reference with specified properties, or this instance if properties haven't changed.
</summary>
<param name="properties">The new properties for the reference.</param>
<exception cref="T:System.ArgumentException">Specified values not valid for this reference.</exception>
</member>
<member name="T:Microsoft.CodeAnalysis.MetadataId">
<summary>
An Id that can be used to identify a metadata instance. If two metadata instances
have the same id then they are guaranteed to have the same content. If two metadata
instances have different ids, then the contents may or may not be the same. As such,
the id is useful as a key in a cache when a client wants to share data for a metadata
reference as long as it has not changed.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Metadata">
<summary>
Represents immutable assembly or module CLI metadata.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Metadata.Id">
<summary>
The id for this metadata instance. If two metadata instances have the same id, then
they have the same content. If they have different ids they may or may not have the
same content.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Metadata.Kind">
<summary>
Retrieves the <see cref="T:Microsoft.CodeAnalysis.MetadataImageKind"/> for this instance.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Metadata.Dispose">
<summary>
Releases any resources associated with this instance.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Metadata.Copy">
<summary>
Creates a copy of this object.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.MetadataImageKind">
<summary>
The kind of metadata a PE file image contains.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.MetadataImageKind.Assembly">
<summary>
The PE file is an assembly.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.MetadataImageKind.Module">
<summary>
The PE file is a module.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.MetadataImageReference">
<summary>
Represents an in-memory Portable-Executable image.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.MetadataReference">
<summary>
Represents metadata image reference.
</summary>
<remarks>
Represents a logical location of the image, not the content of the image.
The content might change in time. A snapshot is taken when the compiler queries the reference for its metadata.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.MetadataReference.Display">
<summary>
Path or name used in error messages to identity the reference.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.MetadataReference.IsUnresolved">
<summary>
Returns true if this reference is an unresolved reference.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataReference.WithAliases(System.Collections.Generic.IEnumerable{System.String})">
<summary>
Returns an instance of the reference with specified aliases.
</summary>
<param name="aliases">The new aliases for the reference.</param>
<exception cref="T:System.ArgumentException">Alias is invalid for the metadata kind.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataReference.WithEmbedInteropTypes(System.Boolean)">
<summary>
Returns an instance of the reference with specified interop types embedding.
</summary>
<param name="value">The new value for <see cref="P:Microsoft.CodeAnalysis.MetadataReferenceProperties.EmbedInteropTypes"/>.</param>
<exception cref="T:System.ArgumentException">Interop types can't be embedded from modules.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataReference.WithAliases(System.Collections.Immutable.ImmutableArray{System.String})">
<summary>
Returns an instance of the reference with specified aliases.
</summary>
<param name="aliases">The new aliases for the reference.</param>
<exception cref="T:System.ArgumentException">Alias is invalid for the metadata kind.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataReference.WithProperties(Microsoft.CodeAnalysis.MetadataReferenceProperties)">
<summary>
Returns an instance of the reference with specified properties, or this instance if properties haven't changed.
</summary>
<param name="properties">The new properties for the reference.</param>
<exception cref="T:System.ArgumentException">Specified values not valid for this reference.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataReference.CreateFromImage(System.Collections.Immutable.ImmutableArray{System.Byte},Microsoft.CodeAnalysis.MetadataReferenceProperties,Microsoft.CodeAnalysis.DocumentationProvider,System.String)">
<summary>
Creates a reference to a single-module assembly or a standalone module stored in memory.
</summary>
<param name="peImage">Assembly image.</param>
<param name="properties">Reference properties (extern aliases, type embedding, <see cref="T:Microsoft.CodeAnalysis.MetadataImageKind"/>).</param>
<param name="documentation">Provides XML documentation for symbol found in the reference.</param>
<param name="filePath">Optional path that describes the location of the metadata. The file doesn't need to exist on disk. The path is opaque to the compiler.</param>
<remarks>
Performance considerations:
<para>
It is recommended to use <see cref="M:Microsoft.CodeAnalysis.AssemblyMetadata.CreateFromImage(System.Collections.Immutable.ImmutableArray{System.Byte})"/> or <see cref="M:Microsoft.CodeAnalysis.ModuleMetadata.CreateFromImage(System.Collections.Immutable.ImmutableArray{System.Byte})"/>
API when creating multiple references to the same metadata.
Reusing <see cref="T:Microsoft.CodeAnalysis.Metadata"/> object to create multiple references allows for sharing data across these references.
</para>
<para>
The method pins <paramref name="peImage"/> in managed heap. The pinned memory is released
when the resulting reference becomes unreachable and GC collects it. To control the lifetime of the pinned memory
deterministically use <see cref="M:Microsoft.CodeAnalysis.AssemblyMetadata.CreateFromImage(System.Collections.Immutable.ImmutableArray{System.Byte})"/>
to create an <see cref="T:System.IDisposable"/> metadata object and
<see cref="M:Microsoft.CodeAnalysis.AssemblyMetadata.GetReference(Microsoft.CodeAnalysis.DocumentationProvider,System.Collections.Immutable.ImmutableArray{System.String},System.Boolean,System.String,System.String)"/> to get a reference to it.
</para>
<para>
The method creates a reference to a single-module assembly. To create a reference to a multi-module assembly or a stand-alone module use
<see cref="M:Microsoft.CodeAnalysis.ModuleMetadata.CreateFromImage(System.Collections.Immutable.ImmutableArray{System.Byte})"/> and <see cref="M:Microsoft.CodeAnalysis.ModuleMetadata.GetReference(Microsoft.CodeAnalysis.DocumentationProvider,System.String,System.String)"/>.
</para>
</remarks>
<exception cref="T:System.ArgumentNullException"><paramref name="peImage"/> is null.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataReference.CreateFromImage(System.Collections.Generic.IEnumerable{System.Byte},Microsoft.CodeAnalysis.MetadataReferenceProperties,Microsoft.CodeAnalysis.DocumentationProvider,System.String)">
<summary>
Creates a reference to a single-module assembly or a standalone module stored in memory.
</summary>
<param name="peImage">Assembly image.</param>
<param name="properties">Reference properties (extern aliases, type embedding, <see cref="T:Microsoft.CodeAnalysis.MetadataImageKind"/>).</param>
<param name="documentation">Provides XML documentation for symbol found in the reference.</param>
<param name="filePath">Optional path that describes the location of the metadata. The file doesn't need to exist on disk. The path is opaque to the compiler.</param>
<remarks>
Performance considerations:
<para>
It is recommended to use <see cref="M:Microsoft.CodeAnalysis.AssemblyMetadata.CreateFromImage(System.Collections.Generic.IEnumerable{System.Byte})"/> or <see cref="M:Microsoft.CodeAnalysis.ModuleMetadata.CreateFromImage(System.Collections.Generic.IEnumerable{System.Byte})"/>
API when creating multiple references to the same metadata.
Reusing <see cref="T:Microsoft.CodeAnalysis.Metadata"/> object to create multiple references allows for sharing data across these references.
</para>
<para>
The method makes a copy of the data and pins it. To avoid making a copy use an overload that takes an <see cref="T:System.Collections.Immutable.ImmutableArray`1"/>.
The pinned memory is released when the resulting reference becomes unreachable and GC collects it. To control the lifetime of the pinned memory
deterministically use <see cref="M:Microsoft.CodeAnalysis.AssemblyMetadata.CreateFromStream(System.IO.Stream,System.Reflection.PortableExecutable.PEStreamOptions)"/>
to create an <see cref="T:System.IDisposable"/> metadata object and
<see cref="M:Microsoft.CodeAnalysis.AssemblyMetadata.GetReference(Microsoft.CodeAnalysis.DocumentationProvider,System.Collections.Immutable.ImmutableArray{System.String},System.Boolean,System.String,System.String)"/> to get a reference to it.
to get a reference to it.
</para>
</remarks>
<exception cref="T:System.ArgumentNullException"><paramref name="peImage"/> is null.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataReference.CreateFromStream(System.IO.Stream,Microsoft.CodeAnalysis.MetadataReferenceProperties,Microsoft.CodeAnalysis.DocumentationProvider,System.String)">
<summary>
Creates a reference to a single-module assembly or a stand-alone module from data in specified stream.
Reads the content of the stream into memory and closes the stream upon return.
</summary>
<param name="peStream">Assembly image.</param>
<param name="properties">Reference properties (extern aliases, type embedding, <see cref="T:Microsoft.CodeAnalysis.MetadataImageKind"/>).</param>
<param name="documentation">Provides XML documentation for symbol found in the reference.</param>
<param name="filePath">Optional path that describes the location of the metadata. The file doesn't need to exist on disk. The path is opaque to the compiler.</param>
<exception cref="T:System.ArgumentException"><paramref name="peStream"/> doesn't support read and seek operations.</exception>
<exception cref="T:System.ArgumentNullException"><paramref name="peStream"/> is null.</exception>
<exception cref="T:System.IO.IOException">An error occurred while reading the stream.</exception>
<remarks>
Performance considerations:
<para>
It is recommended to use <see cref="M:Microsoft.CodeAnalysis.AssemblyMetadata.CreateFromStream(System.IO.Stream,System.Reflection.PortableExecutable.PEStreamOptions)"/> or <see cref="M:Microsoft.CodeAnalysis.ModuleMetadata.CreateFromStream(System.IO.Stream,System.Reflection.PortableExecutable.PEStreamOptions)"/>
API when creating multiple references to the same metadata.
Reusing <see cref="T:Microsoft.CodeAnalysis.Metadata"/> object to create multiple references allows for sharing data across these references.
</para>
<para>
The method eagerly reads the entire content of <paramref name="peStream"/> into native heap. The native memory block is released
when the resulting reference becomes unreachable and GC collects it. To decrease memory footprint of the reference and/or manage
the lifetime deterministically use <see cref="M:Microsoft.CodeAnalysis.AssemblyMetadata.CreateFromStream(System.IO.Stream,System.Reflection.PortableExecutable.PEStreamOptions)"/>
to create an <see cref="T:System.IDisposable"/> metadata object and
<see cref="M:Microsoft.CodeAnalysis.AssemblyMetadata.GetReference(Microsoft.CodeAnalysis.DocumentationProvider,System.Collections.Immutable.ImmutableArray{System.String},System.Boolean,System.String,System.String)"/>
to get a reference to it.
</para>
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataReference.CreateFromFile(System.String,Microsoft.CodeAnalysis.MetadataReferenceProperties,Microsoft.CodeAnalysis.DocumentationProvider)">
<summary>
Creates a reference to an assembly or standalone module stored in a file.
Reads the content of the file into memory.
</summary>
<param name="path">Path to the assembly file.</param>
<param name="properties">Reference properties (extern aliases, type embedding, <see cref="T:Microsoft.CodeAnalysis.MetadataImageKind"/>).</param>
<param name="documentation">Provides XML documentation for symbol found in the reference.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is null.</exception>
<exception cref="T:System.ArgumentException"><paramref name="path"/> is invalid.</exception>
<exception cref="T:System.IO.IOException">An error occurred while reading the file.</exception>
<remarks>
Performance considerations:
<para>
It is recommended to use <see cref="M:Microsoft.CodeAnalysis.AssemblyMetadata.CreateFromFile(System.String)"/> or <see cref="M:Microsoft.CodeAnalysis.ModuleMetadata.CreateFromFile(System.String)"/>
API when creating multiple references to the same file.
Reusing <see cref="T:Microsoft.CodeAnalysis.Metadata"/> object allows for sharing data across these references.
</para>
<para>
The method eagerly reads the entire content of the file into native heap. The native memory block is released
when the resulting reference becomes unreachable and GC collects it. To decrease memory footprint of the reference and/or manage
the lifetime deterministically use <see cref="M:Microsoft.CodeAnalysis.AssemblyMetadata.CreateFromFile(System.String)"/>
to create an <see cref="T:System.IDisposable"/> metadata object and
<see cref="M:Microsoft.CodeAnalysis.AssemblyMetadata.GetReference(Microsoft.CodeAnalysis.DocumentationProvider,System.Collections.Immutable.ImmutableArray{System.String},System.Boolean,System.String,System.String)"/>
to get a reference to it.
</para>
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataReference.CreateFromAssembly(System.Reflection.Assembly)">
<summary>
Creates a reference to a loaded assembly.
</summary>
<param name="assembly">Path to the module file.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="assembly"/> is null.</exception>
<exception cref="T:System.NotSupportedException"><paramref name="assembly"/> is dynamic, doesn't have a location, or the platform doesn't support reading from the location.</exception>
<remarks>
Performance considerations:
<para>
It is recommended to use <see cref="M:Microsoft.CodeAnalysis.AssemblyMetadata.CreateFromFile(System.String)"/> API when creating multiple references to the same assembly.
Reusing <see cref="T:Microsoft.CodeAnalysis.AssemblyMetadata"/> object allows for sharing data across these references.
</para>
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataReference.CreateFromAssembly(System.Reflection.Assembly,Microsoft.CodeAnalysis.MetadataReferenceProperties,Microsoft.CodeAnalysis.DocumentationProvider)">
<summary>
Creates a reference to a loaded assembly.
</summary>
<param name="assembly">Path to the module file.</param>
<param name="properties">Reference properties (extern aliases, type embedding).</param>
<param name="documentation">Provides XML documentation for symbol found in the reference.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="assembly"/> is null.</exception>
<exception cref="T:System.ArgumentException"><paramref name="properties"/>.<see cref="P:Microsoft.CodeAnalysis.MetadataReferenceProperties.Kind"/> is not <see cref="F:Microsoft.CodeAnalysis.MetadataImageKind.Assembly"/>.</exception>
<exception cref="T:System.NotSupportedException"><paramref name="assembly"/> is dynamic, doesn't have a location, or the platform doesn't support reading from the location.</exception>
<remarks>
Performance considerations:
<para>
It is recommended to use <see cref="M:Microsoft.CodeAnalysis.AssemblyMetadata.CreateFromFile(System.String)"/> API when creating multiple references to the same assembly.
Reusing <see cref="T:Microsoft.CodeAnalysis.AssemblyMetadata"/> object allows for sharing data across these references.
</para>
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.MetadataReferenceProperties">
<summary>
Information about a metadata reference.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.MetadataReferenceProperties.Module">
<summary>
Default properties for a module reference.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.MetadataReferenceProperties.Assembly">
<summary>
Default properties for an assembly reference.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataReferenceProperties.#ctor(Microsoft.CodeAnalysis.MetadataImageKind,System.Collections.Immutable.ImmutableArray{System.String},System.Boolean)">
<summary>
Initializes reference properties.
</summary>
<param name="kind">The image kind - assembly or module.</param>
<param name="aliases">Assembly aliases. Can't be set for a module.</param>
<param name="embedInteropTypes">True to embed interop types from the referenced assembly to the referencing compilation. Must be false for a module.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataReferenceProperties.WithAliases(System.Collections.Generic.IEnumerable{System.String})">
<summary>
Returns <see cref="T:Microsoft.CodeAnalysis.MetadataReferenceProperties"/> with specified aliases.
</summary>
<exception cref="T:System.ArgumentException">
<see cref="P:Microsoft.CodeAnalysis.MetadataReferenceProperties.Kind"/> is <see cref="F:Microsoft.CodeAnalysis.MetadataImageKind.Module"/>, as modules can't be aliased.
</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataReferenceProperties.WithAliases(System.Collections.Immutable.ImmutableArray{System.String})">
<summary>
Returns <see cref="T:Microsoft.CodeAnalysis.MetadataReferenceProperties"/> with specified aliases.
</summary>
<exception cref="T:System.ArgumentException">
<see cref="P:Microsoft.CodeAnalysis.MetadataReferenceProperties.Kind"/> is <see cref="F:Microsoft.CodeAnalysis.MetadataImageKind.Module"/>, as modules can't be aliased.
</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataReferenceProperties.WithEmbedInteropTypes(System.Boolean)">
<summary>
Returns <see cref="T:Microsoft.CodeAnalysis.MetadataReferenceProperties"/> with <see cref="P:Microsoft.CodeAnalysis.MetadataReferenceProperties.EmbedInteropTypes"/> set to specified value.
</summary>
<exception cref="T:System.ArgumentException"><see cref="P:Microsoft.CodeAnalysis.MetadataReferenceProperties.Kind"/> is <see cref="F:Microsoft.CodeAnalysis.MetadataImageKind.Module"/>, as interop types can't be embedded from modules.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataReferenceProperties.WithRecursiveAliases(System.Boolean)">
<summary>
Returns <see cref="T:Microsoft.CodeAnalysis.MetadataReferenceProperties"/> with <see cref="P:Microsoft.CodeAnalysis.MetadataReferenceProperties.HasRecursiveAliases"/> set to specified value.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.MetadataReferenceProperties.Kind">
<summary>
The image kind (assembly or module) the reference refers to.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.MetadataReferenceProperties.GlobalAlias">
<summary>
Alias that represents a global declaration space.
</summary>
<remarks>
Namespaces in references whose <see cref="P:Microsoft.CodeAnalysis.MetadataReferenceProperties.Aliases"/> contain <see cref="P:Microsoft.CodeAnalysis.MetadataReferenceProperties.GlobalAlias"/> are available in global declaration space.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.MetadataReferenceProperties.Aliases">
<summary>
Aliases for the metadata reference. Empty if the reference has no aliases.
</summary>
<remarks>
In C# these aliases can be used in "extern alias" syntax to disambiguate type names.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.MetadataReferenceProperties.EmbedInteropTypes">
<summary>
True if interop types defined in the referenced metadata should be embedded into the compilation referencing the metadata.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.MetadataReferenceProperties.HasRecursiveAliases">
<summary>
True to apply <see cref="P:Microsoft.CodeAnalysis.MetadataReferenceProperties.Aliases"/> recursively on the target assembly and on all its transitive dependencies.
False to apply <see cref="P:Microsoft.CodeAnalysis.MetadataReferenceProperties.Aliases"/> only on the target assembly.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.MetadataReferenceResolver">
<summary>
Resolves references to metadata specified in the source (#r directives).
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.MetadataReferenceResolver.ResolveMissingAssemblies">
<summary>
True to instruct the compiler to invoke <see cref="M:Microsoft.CodeAnalysis.MetadataReferenceResolver.ResolveMissingAssembly(Microsoft.CodeAnalysis.MetadataReference,Microsoft.CodeAnalysis.AssemblyIdentity)"/> for each assembly reference that
doesn't match any of the assemblies explicitly referenced by the <see cref="T:Microsoft.CodeAnalysis.Compilation"/> (via <see cref="P:Microsoft.CodeAnalysis.Compilation.ExternalReferences"/>, or #r directives.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.MetadataReferenceResolver.ResolveMissingAssembly(Microsoft.CodeAnalysis.MetadataReference,Microsoft.CodeAnalysis.AssemblyIdentity)">
<summary>
Resolves a missing assembly reference.
</summary>
<param name="definition">The metadata definition (assembly or module) that declares assembly reference <paramref name="referenceIdentity"/> in its list of dependencies.</param>
<param name="referenceIdentity">Identity of the assembly reference that couldn't be resolved against metadata references explicitly specified to in the compilation.</param>
<returns>Resolved reference or null if the identity can't be resolved.</returns>
</member>
<member name="T:Microsoft.CodeAnalysis.ModuleMetadata">
<summary>
Represents an immutable snapshot of module CLI metadata.
</summary>
<remarks>This object may allocate significant resources or lock files depending upon how it is constructed.</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.ModuleMetadata.CreateFromMetadata(System.IntPtr,System.Int32)">
<summary>
Create metadata module from a raw memory pointer to metadata directory of a PE image or .cormeta section of an object file.
Only manifest modules are currently supported.
</summary>
<param name="metadata">Pointer to the start of metadata block.</param>
<param name="size">The size of the metadata block.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="metadata"/> is null.</exception>
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="size"/> is not positive.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.ModuleMetadata.CreateFromImage(System.IntPtr,System.Int32)">
<summary>
Create metadata module from a raw memory pointer to a PE image or an object file.
</summary>
<param name="peImage">Pointer to the DOS header ("MZ") of a portable executable image.</param>
<param name="size">The size of the image pointed to by <paramref name="peImage"/>.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="peImage"/> is null.</exception>
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="size"/> is not positive.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.ModuleMetadata.CreateFromImage(System.Collections.Generic.IEnumerable{System.Byte})">
<summary>
Create metadata module from a sequence of bytes.
</summary>
<param name="peImage">The portable executable image beginning with the DOS header ("MZ").</param>
<exception cref="T:System.ArgumentNullException"><paramref name="peImage"/> is null.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.ModuleMetadata.CreateFromImage(System.Collections.Immutable.ImmutableArray{System.Byte})">
<summary>
Create metadata module from a byte array.
</summary>
<param name="peImage">Portable executable image beginning with the DOS header ("MZ").</param>
<exception cref="T:System.ArgumentNullException"><paramref name="peImage"/> is null.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.ModuleMetadata.CreateFromStream(System.IO.Stream,System.Boolean)">
<summary>
Create metadata module from a stream.
</summary>
<param name="peStream">Stream containing portable executable image. Position zero should contain the first byte of the DOS header ("MZ").</param>
<param name="leaveOpen">
False to close the stream upon disposal of the metadata (the responsibility for disposal of the stream is transferred upon entry of the constructor
unless the arguments given are invalid).
</param>
<exception cref="T:System.ArgumentNullException"><paramref name="peStream"/> is null.</exception>
<exception cref="T:System.ArgumentException">The stream doesn't support seek operations.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.ModuleMetadata.CreateFromStream(System.IO.Stream,System.Reflection.PortableExecutable.PEStreamOptions)">
<summary>
Create metadata module from a stream.
</summary>
<param name="peStream">Stream containing portable executable image. Position zero should contain the first byte of the DOS header ("MZ").</param>
<param name="options">
Options specifying how sections of the PE image are read from the stream.
Unless <see cref="F:System.Reflection.PortableExecutable.PEStreamOptions.LeaveOpen"/> is specified, the responsibility for disposal of the stream is transferred upon entry of the constructor
unless the arguments given are invalid.
</param>
<exception cref="T:System.ArgumentNullException"><paramref name="peStream"/> is null.</exception>
<exception cref="T:System.ArgumentException">The stream doesn't support read and seek operations.</exception>
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="options"/> has an invalid value.</exception>
<exception cref="T:System.BadImageFormatException">
<see cref="F:System.Reflection.PortableExecutable.PEStreamOptions.PrefetchMetadata"/> or <see cref="F:System.Reflection.PortableExecutable.PEStreamOptions.PrefetchEntireImage"/> is specified and the PE headers of the image are invalid.
</exception>
<exception cref="T:System.IO.IOException">
<see cref="F:System.Reflection.PortableExecutable.PEStreamOptions.PrefetchMetadata"/> or <see cref="F:System.Reflection.PortableExecutable.PEStreamOptions.PrefetchEntireImage"/> is specified and an error occurs while reading the stream.
</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.ModuleMetadata.CreateFromFile(System.String)">
<summary>
Creates metadata module from a file containing a portable executable image.
</summary>
<param name="path">File path.</param>
<remarks>
The file might remain mapped (and read-locked) until this object is disposed.
The memory map is only created for large files. Small files are read into memory.
</remarks>
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is null.</exception>
<exception cref="T:System.ArgumentException"><paramref name="path"/> is invalid.</exception>
<exception cref="T:System.IO.IOException">Error opening file <paramref name="path"/>. See <see cref="P:System.Exception.InnerException"/> for details.</exception>
<exception cref="T:System.IO.FileNotFoundException">File <paramref name="path"/> not found.</exception>
<exception cref="T:System.NotSupportedException">Reading from a file path is not supported by the platform.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.ModuleMetadata.Copy">
<summary>
Creates a shallow copy of this object.
</summary>
<remarks>
The resulting copy shares the metadata image and metadata information read from it with the original.
It doesn't own the underlying metadata image and is not responsible for its disposal.
This is used, for example, when a metadata cache needs to return the cached metadata to its users
while keeping the ownership of the cached metadata object.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.ModuleMetadata.Dispose">
<summary>
Frees memory and handles allocated for the module.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ModuleMetadata.IsDisposed">
<summary>
True if the module has been disposed.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ModuleMetadata.Name">
<summary>
Name of the module.
</summary>
<exception cref="T:System.BadImageFormatException">Invalid metadata.</exception>
<exception cref="T:System.ObjectDisposedException">Module has been disposed.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.ModuleMetadata.GetModuleVersionId">
<summary>
Version of the module content.
</summary>
<exception cref="T:System.BadImageFormatException">Invalid metadata.</exception>
<exception cref="T:System.ObjectDisposedException">Module has been disposed.</exception>
</member>
<member name="P:Microsoft.CodeAnalysis.ModuleMetadata.Kind">
<summary>
Returns the <see cref="T:Microsoft.CodeAnalysis.MetadataImageKind"/> for this instance.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.ModuleMetadata.GetModuleNames">
<summary>
Returns the file names of linked managed modules.
</summary>
<exception cref="T:System.BadImageFormatException">When an invalid module name is encountered.</exception>
<exception cref="T:System.ObjectDisposedException">Module has been disposed.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.ModuleMetadata.GetMetadataReader">
<summary>
Returns the metadata reader.
</summary>
<exception cref="T:System.ObjectDisposedException">Module has been disposed.</exception>
<exception cref="T:System.BadImageFormatException">When an invalid module name is encountered.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.ModuleMetadata.GetReference(Microsoft.CodeAnalysis.DocumentationProvider,System.String,System.String)">
<summary>
Creates a reference to the module metadata.
</summary>
<param name="documentation">Provider of XML documentation comments for the metadata symbols contained in the module.</param>
<param name="filePath">Path describing the location of the metadata, or null if the metadata have no location.</param>
<param name="display">Display string used in error messages to identity the reference.</param>
<returns>A reference to the module metadata.</returns>
</member>
<member name="T:Microsoft.CodeAnalysis.PortableExecutableReference">
<summary>
Reference to metadata stored in the standard ECMA-335 metadata format.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.PortableExecutableReference.Display">
<summary>
Display string used in error messages to identity the reference.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.PortableExecutableReference.FilePath">
<summary>
Path describing the location of the metadata, or null if the metadata have no location.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.PortableExecutableReference.DocumentationProvider">
<summary>
XML documentation comments provider for the reference.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.PortableExecutableReference.CreateDocumentationProvider">
<summary>
Create documentation provider for the reference.
</summary>
<remarks>
Called when the compiler needs to read the documentation for the reference.
This method can be called multiple times from different threads. The result of one of the calls
is cached on the reference object.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.PortableExecutableReference.WithAliases(System.Collections.Generic.IEnumerable{System.String})">
<summary>
Returns an instance of the reference with specified aliases.
</summary>
<param name="aliases">The new aliases for the reference.</param>
<exception cref="T:System.ArgumentException">Alias is invalid for the metadata kind.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PortableExecutableReference.WithAliases(System.Collections.Immutable.ImmutableArray{System.String})">
<summary>
Returns an instance of the reference with specified aliases.
</summary>
<param name="aliases">The new aliases for the reference.</param>
<exception cref="T:System.ArgumentException">Alias is invalid for the metadata kind.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PortableExecutableReference.WithEmbedInteropTypes(System.Boolean)">
<summary>
Returns an instance of the reference with specified interop types embedding.
</summary>
<param name="value">The new value for <see cref="P:Microsoft.CodeAnalysis.MetadataReferenceProperties.EmbedInteropTypes"/>.</param>
<exception cref="T:System.ArgumentException">Interop types can't be embedded from modules.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PortableExecutableReference.WithProperties(Microsoft.CodeAnalysis.MetadataReferenceProperties)">
<summary>
Returns an instance of the reference with specified properties, or this instance if properties haven't changed.
</summary>
<param name="properties">The new properties for the reference.</param>
<exception cref="T:System.ArgumentException">Specified values not valid for this reference.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PortableExecutableReference.WithPropertiesImpl(Microsoft.CodeAnalysis.MetadataReferenceProperties)">
<summary>
Returns an instance of the reference with specified properties.
</summary>
<param name="properties">The new properties for the reference.</param>
<exception cref="T:System.NotSupportedException">Specified values not supported.</exception>
<remarks>Only invoked if the properties changed.</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.PortableExecutableReference.GetMetadataImpl">
<summary>
Get metadata representation for the PE file.
</summary>
<exception cref="T:System.BadImageFormatException">If the PE image format is invalid.</exception>
<exception cref="T:System.IO.IOException">The metadata image content can't be read.</exception>
<exception cref="T:System.IO.FileNotFoundException">The metadata image is stored in a file that can't be found.</exception>
<remarks>
Called when the <see cref="T:Microsoft.CodeAnalysis.Compilation"/> needs to read the reference metadata.
The listed exceptions are caught and converted to compilation diagnostics.
Any other exception is considered an unexpected error in the implementation and is not caught.
<see cref="T:Microsoft.CodeAnalysis.Metadata"/> objects may cache information decoded from the PE image.
Reusing <see cref="T:Microsoft.CodeAnalysis.Metadata"/> instances across metadata references will result in better performance.
The calling <see cref="T:Microsoft.CodeAnalysis.Compilation"/> doesn't take ownership of the <see cref="T:Microsoft.CodeAnalysis.Metadata"/> objects returned by this method.
The implementation needs to retrieve the object from a provider that manages their lifetime (such as metadata cache).
The <see cref="T:Microsoft.CodeAnalysis.Metadata"/> object is kept alive by the <see cref="T:Microsoft.CodeAnalysis.Compilation"/> that called <see cref="M:Microsoft.CodeAnalysis.PortableExecutableReference.GetMetadataNoCopy"/>
and by all compilations created from it via calls to With- factory methods on <see cref="T:Microsoft.CodeAnalysis.Compilation"/>,
other than <see cref="M:Microsoft.CodeAnalysis.Compilation.WithReferences(Microsoft.CodeAnalysis.MetadataReference[])"/> overloads. A compilation created using
<see cref="M:Microsoft.CodeAnalysis.Compilation.WithReferences(Microsoft.CodeAnalysis.MetadataReference[])"/> will call to <see cref="M:Microsoft.CodeAnalysis.PortableExecutableReference.GetMetadataNoCopy"/> again.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.PortableExecutableReference.GetMetadata">
<summary>
Returns a copy of the <see cref="T:Microsoft.CodeAnalysis.Metadata"/> object this <see cref="T:Microsoft.CodeAnalysis.PortableExecutableReference"/>
contains. This copy does not need to be <see cref="M:System.IDisposable.Dispose"/>d.
</summary>
<exception cref="T:System.BadImageFormatException">If the PE image format is invalid.</exception>
<exception cref="T:System.IO.IOException">The metadata image content can't be read.</exception>
<exception cref="T:System.IO.FileNotFoundException">The metadata image is stored in a file that can't be found.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.PortableExecutableReference.GetMetadataId">
<summary>
Returns the <see cref="T:Microsoft.CodeAnalysis.MetadataId"/> for this reference's <see cref="T:Microsoft.CodeAnalysis.Metadata"/>.
This will be equivalent to calling <see cref="M:Microsoft.CodeAnalysis.PortableExecutableReference.GetMetadata"/>.<see cref="P:Microsoft.CodeAnalysis.Metadata.Id"/>,
but can be done more efficiently.
</summary>
<exception cref="T:System.BadImageFormatException">If the PE image format is invalid.</exception>
<exception cref="T:System.IO.IOException">The metadata image content can't be read.</exception>
<exception cref="T:System.IO.FileNotFoundException">The metadata image is stored in a file that can't be found.</exception>
</member>
<member name="T:Microsoft.CodeAnalysis.ReferenceDirective">
<summary>
Represents the value of #r reference along with its source location.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.UnresolvedMetadataReference">
<summary>
Represents a metadata reference that can't be or is not yet resolved.
</summary>
<remarks>
For error reporting only, can't be used to reference a metadata file.
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.IOperation">
<summary>
Root type for representing the abstract semantics of C# and VB statements and expressions.
</summary>
<remarks>
This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.IOperation.Parent">
<summary>
IOperation that has this operation as a child. Null for the root.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IOperation.Kind">
<summary>
Identifies the kind of the operation.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IOperation.Syntax">
<summary>
Syntax that was analyzed to produce the operation.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IOperation.Type">
<summary>
Result type of the operation, or null if the operation does not produce a result.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IOperation.ConstantValue">
<summary>
If the operation is an expression that evaluates to a constant value, <see cref="P:Microsoft.CodeAnalysis.Optional`1.HasValue"/> is true and <see cref="P:Microsoft.CodeAnalysis.Optional`1.Value"/> is the value of the expression. Otherwise, <see cref="P:Microsoft.CodeAnalysis.Optional`1.HasValue"/> is false.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IOperation.Children">
<summary>
An array of child operations for this operation.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IOperation.Language">
<summary>
The source language of the IOperation. Possible values are <see cref="F:Microsoft.CodeAnalysis.LanguageNames.CSharp"/> and <see cref="F:Microsoft.CodeAnalysis.LanguageNames.VisualBasic"/>.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IOperation.IsImplicit">
<summary>
Set to True if compiler generated /implicitly computed by compiler code
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IOperation.SemanticModel">
<summary>
Optional semantic model that was used to generate this operation.
Non-null for operations generated from source with <see cref="M:Microsoft.CodeAnalysis.SemanticModel.GetOperation(Microsoft.CodeAnalysis.SyntaxNode,System.Threading.CancellationToken)"/> API
and operation callbacks made to analyzers.
Null for operations inside a <see cref="T:Microsoft.CodeAnalysis.FlowAnalysis.ControlFlowGraph"/>.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operation">
<summary>
Root type for representing the abstract semantics of C# and VB statements and expressions.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operation.Parent">
<summary>
IOperation that has this operation as a child
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operation.IsImplicit">
<summary>
Set to True if compiler generated /implicitly computed by compiler code
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operation.Kind">
<summary>
Identifies the kind of the operation.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operation.Syntax">
<summary>
Syntax that was analyzed to produce the operation.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operation.Type">
<summary>
Result type of the operation, or null if the operation does not produce a result.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operation.Language">
<summary>
The source language of the IOperation. Possible values are <see cref="F:Microsoft.CodeAnalysis.LanguageNames.CSharp"/> and <see cref="F:Microsoft.CodeAnalysis.LanguageNames.VisualBasic"/>.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operation.ConstantValue">
<summary>
If the operation is an expression that evaluates to a constant value, <see cref="P:Microsoft.CodeAnalysis.Optional`1.HasValue"/> is true and <see cref="P:Microsoft.CodeAnalysis.Optional`1.Value"/> is the value of the expression. Otherwise, <see cref="P:Microsoft.CodeAnalysis.Optional`1.HasValue"/> is false.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operation.Microsoft#CodeAnalysis#IOperation#Children">
<summary>
In the compiler layer, always prefer <see cref="P:Microsoft.CodeAnalysis.Operation.ChildOperations"/>.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Operation.ChildOperations">
<remarks>
Always prefer this over <see cref="P:Microsoft.CodeAnalysis.IOperation.Children"/> in the compiler layer, as this does not introduce allocations.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Operation.OwningSemanticModel">
<summary>
Gets the owning semantic model for this operation node.
Note that this may be different than <see cref="P:Microsoft.CodeAnalysis.IOperation.SemanticModel"/>, which
is the semantic model on which <see cref="M:Microsoft.CodeAnalysis.SemanticModel.GetOperation(Microsoft.CodeAnalysis.SyntaxNode,System.Threading.CancellationToken)"/> was invoked
to create this node.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operation.Enumerable">
<summary>
Implements a struct-based enumerable for <see cref="T:Microsoft.CodeAnalysis.Operation"/> nodes, using a slot-based system that tracks
the current slot, and the current index in the slot if the current slot is an immutable array. This type is not hardened
to <code>default(Enumerable)</code>, and will null reference in these cases.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Operation.Enumerator">
<summary>
Implements a struct-based enumerator for <see cref="T:Microsoft.CodeAnalysis.Operation"/> nodes, using a slot-based system that tracks
the current slot, and the current index in the slot if the current slot is an immutable array. This type is not hardened
to <code>default(Enumerator)</code>, and will null reference in these cases. Implementation of the <see cref="M:Microsoft.CodeAnalysis.Operation.Enumerator.MoveNext"/>
and <see cref="P:Microsoft.CodeAnalysis.Operation.Enumerator.Current"/> members are delegated to the virtual <see cref="M:Microsoft.CodeAnalysis.Operation.MoveNext(System.Int32,System.Int32)"/> and
<see cref="M:Microsoft.CodeAnalysis.Operation.GetCurrent(System.Int32,System.Int32)"/> methods, respectively. Calling <see cref="P:Microsoft.CodeAnalysis.Operation.Enumerator.Current"/> after
<see cref="M:Microsoft.CodeAnalysis.Operation.Enumerator.MoveNext"/> has returned false will throw an <see cref="T:System.InvalidOperationException"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.OperationMapBuilder.AddToMap(Microsoft.CodeAnalysis.IOperation,System.Collections.Generic.Dictionary{Microsoft.CodeAnalysis.SyntaxNode,Microsoft.CodeAnalysis.IOperation})">
<summary>
Populates a empty dictionary of SyntaxNode->IOperation, where every key corresponds to an explicit IOperation node.
If there is a SyntaxNode with more than one explicit IOperation, this will throw.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Optional`1">
<summary>
Combines a value, <see cref="P:Microsoft.CodeAnalysis.Optional`1.Value"/>, and a flag, <see cref="P:Microsoft.CodeAnalysis.Optional`1.HasValue"/>,
indicating whether or not that value is meaningful.
</summary>
<typeparam name="T">The type of the value.</typeparam>
</member>
<member name="M:Microsoft.CodeAnalysis.Optional`1.#ctor(`0)">
<summary>
Constructs an <see cref="T:Microsoft.CodeAnalysis.Optional`1"/> with a meaningful value.
</summary>
<param name="value"></param>
</member>
<member name="P:Microsoft.CodeAnalysis.Optional`1.HasValue">
<summary>
Returns <see langword="true"/> if the <see cref="P:Microsoft.CodeAnalysis.Optional`1.Value"/> will return a meaningful value.
</summary>
<returns></returns>
</member>
<member name="P:Microsoft.CodeAnalysis.Optional`1.Value">
<summary>
Gets the value of the current object. Not meaningful unless <see cref="P:Microsoft.CodeAnalysis.Optional`1.HasValue"/> returns <see langword="true"/>.
</summary>
<remarks>
<para>Unlike <see cref="P:System.Nullable`1.Value"/>, this property does not throw an exception when
<see cref="P:Microsoft.CodeAnalysis.Optional`1.HasValue"/> is <see langword="false"/>.</para>
</remarks>
<returns>
<para>The value if <see cref="P:Microsoft.CodeAnalysis.Optional`1.HasValue"/> is <see langword="true"/>; otherwise, the default value for type
<typeparamref name="T"/>.</para>
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.Optional`1.op_Implicit(`0)~Microsoft.CodeAnalysis.Optional{`0}">
<summary>
Creates a new object initialized to a meaningful value.
</summary>
<param name="value"></param>
</member>
<member name="M:Microsoft.CodeAnalysis.Optional`1.ToString">
<summary>
Returns a string representation of this object.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.OutputKind">
<summary>
Specifies output assembly kinds generated by compiler.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OutputKind.ConsoleApplication">
<summary>
An .exe with an entry point and a console.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OutputKind.WindowsApplication">
<summary>
An .exe with an entry point but no console.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OutputKind.DynamicallyLinkedLibrary">
<summary>
A .dll file.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OutputKind.NetModule">
<summary>
A .netmodule file.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OutputKind.WindowsRuntimeMetadata">
<summary>
A .winmdobj file.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.OutputKind.WindowsRuntimeApplication">
<summary>
An .exe that can run in an app container.
</summary>
<remarks>
Equivalent to a WindowsApplication, but with an extra bit set in the Portable Executable file
so that the application can only be run in an app container.
Also known as a "Windows Store app".
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.RealParser">
<summary>
A set of utilities for converting from a decimal floating-point literal string to its IEEE float
or double representation, which considers all digits significant and correctly rounds according to
the IEEE round-to-nearest-ties-to-even mode. This code does not support a leading sign character,
as that is not part of the C# or VB floating-point literal lexical syntax.
If you change this code, please run the set of long-running random tests in the solution
RandomRealParserTests.sln. That solution is not included in Roslyn.sln as it is Windows-specific.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.RealParser.TryParseDouble(System.String,System.Double@)">
<summary>
Try parsing a correctly-formatted double floating-point literal into the nearest representable double
using IEEE round-to-nearest-ties-to-even rounding mode. Behavior is not defined for inputs that are
not valid C# floating-point literals.
</summary>
<param name="s">The decimal floating-point constant's string</param>
<param name="d">The nearest double value, if conversion succeeds</param>
<returns>True if the input was converted; false if there was an overflow</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.RealParser.TryParseFloat(System.String,System.Single@)">
<summary>
Try parsing a correctly-formatted float floating-point literal into the nearest representable float
using IEEE round-to-nearest-ties-to-even rounding mode. Behavior is not defined for inputs that are
not valid C# floating-point literals.
</summary>
<param name="s">The float floating-point constant's string</param>
<param name="f">The nearest float value, if conversion succeeds</param>
<returns>True if the input was converted; false if there was an overflow</returns>
</member>
<member name="T:Microsoft.CodeAnalysis.RealParser.FloatingPointType">
<summary>
Properties of an IEEE floating-point representation.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.RealParser.FloatingPointType.AssembleFloatingPointValue(System.UInt64,System.Int32,System.Boolean,System.UInt64@)">
<summary>
Converts the floating point value 0.mantissa * 2^exponent into the
correct form for the FloatingPointType and stores the bits of the resulting value
into the result object.
The caller must ensure that the mantissa and exponent are correctly computed
such that either [1] the most significant bit of the mantissa is in the
correct position for the FloatingType, or [2] the exponent has been correctly
adjusted to account for the shift of the mantissa that will be required.
This function correctly handles range errors and stores a zero or infinity in
the result object on underflow and overflow errors, respectively. This
function correctly forms denormal numbers when required.
If the provided mantissa has more bits of precision than can be stored in the
result object, the mantissa is rounded to the available precision. Thus, if
possible, the caller should provide a mantissa with at least one more bit of
precision than is required, to ensure that the mantissa is correctly rounded.
(The caller should not round the mantissa before calling this function.)
</summary>
<param name="initialMantissa">The bits of the mantissa</param>
<param name="initialExponent">The exponent</param>
<param name="hasZeroTail">Whether there are any nonzero bits past the supplied mantissa</param>
<param name="result">Where the bits of the floating-point number are stored</param>
<returns>A status indicating whether the conversion succeeded and why</returns>
</member>
<member name="T:Microsoft.CodeAnalysis.RealParser.FloatFloatingPointType">
<summary>
Properties of a C# float.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.RealParser.DoubleFloatingPointType">
<summary>
Properties of a C# double.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.RealParser.DecimalFloatingPointString">
<summary>
This type is used to hold a partially-parsed string representation of a
floating point number. The number is stored in the following form:
<pre>
0.Mantissa * 10^Exponent
</pre>
The Mantissa buffer stores the mantissa digits as characters in a string.
The MantissaCount gives the number of digits present in the Mantissa buffer.
There shall be neither leading nor trailing zero digits in the Mantissa.
Note that this represents only nonnegative floating-point literals; the
negative sign in C# and VB is actually a separate unary negation operator.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.RealParser.DecimalFloatingPointString.FromSource(System.String)">
<summary>
Create a DecimalFloatingPointString from a string representing a floating-point literal.
</summary>
<param name="source">The text of the floating-point literal</param>
</member>
<member name="M:Microsoft.CodeAnalysis.RealParser.ConvertDecimalToFloatingPointBits(Microsoft.CodeAnalysis.RealParser.DecimalFloatingPointString,Microsoft.CodeAnalysis.RealParser.FloatingPointType,System.UInt64@)">
<summary>
Convert a DecimalFloatingPointString to the bits of the given floating-point type.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.RealParser.ConvertBigIntegerToFloatingPointBits(System.Byte[],System.UInt32,System.Boolean,Microsoft.CodeAnalysis.RealParser.FloatingPointType,System.UInt64@)">
<summary>
This function is part of the fast track for integer floating point strings.
It takes an integer stored as an array of bytes (lsb first) and converts the value into its FloatingType
representation, storing the bits into "result". If the value is not
representable, +/-infinity is stored and overflow is reported (since this
function only deals with integers, underflow is impossible).
</summary>
<param name="integerValueAsBytes">the bits of the integer, least significant bits first</param>
<param name="integerBitsOfPrecision">the number of bits of precision in integerValueAsBytes</param>
<param name="hasNonzeroFractionalPart">whether there are nonzero digits after the decimal</param>
<param name="type">the kind of real number to build</param>
<param name="result">the result</param>
<returns>An indicator of the kind of result</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.RealParser.AccumulateDecimalDigitsIntoBigInteger(Microsoft.CodeAnalysis.RealParser.DecimalFloatingPointString,System.UInt32,System.UInt32)">
<summary>
Parse a sequence of digits into a BigInteger.
</summary>
<param name="data">The DecimalFloatingPointString containing the digits in its Mantissa</param>
<param name="integer_first_index">The index of the first digit to convert</param>
<param name="integer_last_index">The index just past the last digit to convert</param>
<returns>The BigInteger result</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.RealParser.CountSignificantBits(System.UInt64)">
<summary>
Return the number of significant bits set.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.RealParser.CountSignificantBits(System.Byte)">
<summary>
Return the number of significant bits set.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.RealParser.CountSignificantBits(System.Numerics.BigInteger,System.Byte[]@)">
<summary>
Return the number of significant bits set.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.RealParser.CountSignificantBits(System.Numerics.BigInteger)">
<summary>
Return the number of significant bits set.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.RealParser.RightShiftWithRounding(System.UInt64,System.Int32,System.Boolean)">
<summary>
Computes value / 2^shift, then rounds the result according to the current
rounding mode. By the time we call this function, we will already have
discarded most digits. The caller must pass true for has_zero_tail if
all discarded bits were zeroes.
</summary>
<param name="value">The value to shift</param>
<param name="shift">The amount of shift</param>
<param name="hasZeroTail">Whether there are any less significant nonzero bits in the value</param>
<returns></returns>
</member>
<member name="M:Microsoft.CodeAnalysis.RealParser.ShouldRoundUp(System.Boolean,System.Boolean,System.Boolean)">
<summary>
Determines whether a mantissa should be rounded up in the
round-to-nearest-ties-to-even mode given [1] the value of the least
significant bit of the mantissa, [2] the value of the next bit after
the least significant bit (the "round" bit) and [3] whether any
trailing bits after the round bit are set.
The mantissa is treated as an unsigned integer magnitude.
For this function, "round up" is defined as "increase the magnitude" of the
mantissa.
</summary>
<param name="lsbBit">the least-significant bit of the representable value</param>
<param name="roundBit">the bit following the least-significant bit</param>
<param name="hasTailBits">true if there are any (less significant) bits set following roundBit</param>
<returns></returns>
</member>
<member name="M:Microsoft.CodeAnalysis.RealParser.ShiftLeft(System.Numerics.BigInteger@,System.UInt32)">
<summary>
Multiply a BigInteger by the given power of two.
</summary>
<param name="number">The BigInteger to multiply by a power of two and replace with the product</param>
<param name="shift">The power of two to multiply it by</param>
</member>
<member name="M:Microsoft.CodeAnalysis.RealParser.MultiplyByPowerOfTen(System.Numerics.BigInteger@,System.UInt32)">
<summary>
Multiply a BigInteger by the given power of ten.
</summary>
<param name="number">The BigInteger to multiply by a power of ten and replace with the product</param>
<param name="power">The power of ten to multiply it by</param>
</member>
<member name="M:Microsoft.CodeAnalysis.RealParser.FloatToInt32Bits(System.Single)">
<summary>
Convert a float value to the bits of its representation
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.RealParser.Int32BitsToFloat(System.UInt32)">
<summary>
Convert the bits of its representation to a float
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.RealParser.FloatUnion">
<summary>
A union used to convert between a float and the bits of its representation
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CommonReferenceManager`2">
<summary>
The base class for language specific assembly managers.
</summary>
<typeparam name="TCompilation">Language specific representation for a compilation</typeparam>
<typeparam name="TAssemblySymbol">Language specific representation for an assembly symbol.</typeparam>
</member>
<member name="T:Microsoft.CodeAnalysis.CommonReferenceManager`2.AssemblyData">
<summary>
Information about an assembly, used as an input for the Binder class.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommonReferenceManager`2.AssemblyData.Identity">
<summary>
Identity of the assembly.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommonReferenceManager`2.AssemblyData.AssemblyReferences">
<summary>
Identity of assemblies referenced by this assembly.
References should always be returned in the same order.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommonReferenceManager`2.AssemblyData.AvailableSymbols">
<summary>
The sequence of AssemblySymbols the Binder can choose from.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonReferenceManager`2.AssemblyData.IsMatchingAssembly(`1)">
<summary>
Check if provided AssemblySymbol is created for assembly described by this instance.
This method is expected to return true for every AssemblySymbol returned by
AvailableSymbols property.
</summary>
<param name="assembly">
The AssemblySymbol to check.
</param>
<returns>Boolean.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonReferenceManager`2.AssemblyData.BindAssemblyReferences(System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.CommonReferenceManager{`0,`1}.AssemblyData},Microsoft.CodeAnalysis.AssemblyIdentityComparer)">
<summary>
Resolve assembly references against assemblies described by provided AssemblyData objects.
In other words, match assembly identities returned by AssemblyReferences property against
assemblies described by provided AssemblyData objects.
</summary>
<param name="assemblies">An array of AssemblyData objects to match against.</param>
<param name="assemblyIdentityComparer">Used to compare assembly identities.</param>
<returns>
For each assembly referenced by this assembly (<see cref="P:Microsoft.CodeAnalysis.CommonReferenceManager`2.AssemblyData.AssemblyReferences"/>)
a description of how it binds to one of the input assemblies.
</returns>
</member>
<member name="P:Microsoft.CodeAnalysis.CommonReferenceManager`2.AssemblyData.SourceCompilation">
<summary>
Get the source compilation backing this assembly, if one exists.
Returns null otherwise.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CommonReferenceManager`2.AssemblyReferenceBinding">
<summary>
Result of binding an AssemblyRef to an AssemblyDef.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonReferenceManager`2.AssemblyReferenceBinding.#ctor(Microsoft.CodeAnalysis.AssemblyIdentity)">
<summary>
Failed binding.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonReferenceManager`2.AssemblyReferenceBinding.#ctor(Microsoft.CodeAnalysis.AssemblyIdentity,System.Int32,System.Int32)">
<summary>
Successful binding.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommonReferenceManager`2.AssemblyReferenceBinding.BoundToAssemblyBeingBuilt">
<summary>
Returns true if the reference was matched with the identity of the assembly being built.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommonReferenceManager`2.AssemblyReferenceBinding.IsBound">
<summary>
True if the definition index is available (reference was successfully matched with the definition).
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommonReferenceManager`2.AssemblyReferenceBinding.VersionDifference">
<summary>
0 if the reference is equivalent to the definition.
-1 if version of the matched definition is lower than version of the reference, but the reference otherwise matches the definition.
+1 if version of the matched definition is higher than version of the reference, but the reference otherwise matches the definition.
Undefined unless <see cref="P:Microsoft.CodeAnalysis.CommonReferenceManager`2.AssemblyReferenceBinding.IsBound"/> is true.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommonReferenceManager`2.AssemblyReferenceBinding.DefinitionIndex">
<summary>
Index into assembly definition list.
Undefined unless <see cref="P:Microsoft.CodeAnalysis.CommonReferenceManager`2.AssemblyReferenceBinding.IsBound"/> is true.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CommonReferenceManager`2.AssemblyReferenceCandidate">
<summary>
Private helper class to capture information about AssemblySymbol instance we
should check for suitability. Used by the Bind method.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CommonReferenceManager`2.AssemblyReferenceCandidate.DefinitionIndex">
<summary>
An index of the AssemblyData object in the input array. AssemblySymbol instance should
be checked for suitability against assembly described by that object, taking into account
assemblies described by other AssemblyData objects in the input array.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CommonReferenceManager`2.AssemblyReferenceCandidate.AssemblySymbol">
<summary>
AssemblySymbol instance to check for suitability.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonReferenceManager`2.AssemblyReferenceCandidate.#ctor(System.Int32,`1)">
<summary>
Convenience constructor to initialize fields of this structure.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CommonReferenceManager`2.BoundInputAssembly">
<summary>
Result of binding an input assembly and its references.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CommonReferenceManager`2.BoundInputAssembly.AssemblySymbol">
<summary>
Suitable AssemblySymbol instance for the corresponding assembly,
null reference if none is available/found.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CommonReferenceManager`2.BoundInputAssembly.ReferenceBinding">
<summary>
For each AssemblyRef of this AssemblyDef specifies which AssemblyDef matches the reference.
</summary>
<remarks>
Result of resolving assembly references of the corresponding assembly
against provided set of assemblies. Essentially, this is an array returned by
AssemblyData.BindAssemblyReferences method.
Each element describes the assembly the corresponding reference of the input assembly
is bound to.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonReferenceManager`2.Bind(`0,System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.CommonReferenceManager{`0,`1}.AssemblyData},System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.PEModule},System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.MetadataReference},System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.CommonReferenceManager{`0,`1}.ResolvedReference},Microsoft.CodeAnalysis.MetadataReferenceResolver,Microsoft.CodeAnalysis.MetadataImportOptions,System.Boolean,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{Microsoft.CodeAnalysis.CommonReferenceManager{`0,`1}.ReferencedAssemblyIdentity}},System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.CommonReferenceManager{`0,`1}.AssemblyData}@,System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.MetadataReference}@,System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.CommonReferenceManager{`0,`1}.ResolvedReference}@,System.Collections.Immutable.ImmutableDictionary{Microsoft.CodeAnalysis.AssemblyIdentity,Microsoft.CodeAnalysis.PortableExecutableReference}@,Microsoft.CodeAnalysis.DiagnosticBag,System.Boolean@,System.Int32@)">
<summary>
For the given set of AssemblyData objects, do the following:
1) Resolve references from each assembly against other assemblies in the set.
2) Choose suitable AssemblySymbol instance for each AssemblyData object.
The first element (index==0) of the assemblies array represents the assembly being built.
One can think about the rest of the items in assemblies array as assembly references given to the compiler to
build executable for the assembly being built.
</summary>
<param name="compilation">Compilation.</param>
<param name="explicitAssemblies">
An array of <see cref="T:Microsoft.CodeAnalysis.CommonReferenceManager`2.AssemblyData"/> objects describing assemblies, for which this method should
resolve references and find suitable AssemblySymbols. The first slot contains the assembly being built.
</param>
<param name="explicitModules">
An array of <see cref="T:Microsoft.CodeAnalysis.PEModule"/> objects describing standalone modules referenced by the compilation.
</param>
<param name="explicitReferences">
An array of references passed to the compilation and resolved from #r directives.
May contain references that were skipped during resolution (they don't have a corresponding explicit assembly).
</param>
<param name="explicitReferenceMap">
Maps index to <paramref name="explicitReferences"/> to an index of a resolved assembly or module in <paramref name="explicitAssemblies"/> or modules.
</param>
<param name="resolverOpt">
Reference resolver used to look up missing assemblies.
</param>
<param name="supersedeLowerVersions">
Hide lower versions of dependencies that have multiple versions behind an alias.
</param>
<param name="assemblyReferencesBySimpleName">
Used to filter out assemblies that have the same strong or weak identity.
Maps simple name to a list of identities. The highest version of each name is the first.
</param>
<param name="importOptions">
Import options applied to implicitly resolved references.
</param>
<param name="allAssemblies">
Updated array <paramref name="explicitAssemblies"/> with resolved implicitly referenced assemblies appended.
</param>
<param name="implicitlyResolvedReferences">
Implicitly resolved references.
</param>
<param name="implicitlyResolvedReferenceMap">
Maps indices of implicitly resolved references to the corresponding indices of resolved assemblies in <paramref name="allAssemblies"/> (explicit + implicit).
</param>
<param name="implicitReferenceResolutions">
Map of implicit reference resolutions performed in the preceding script compilation.
Output contains additional implicit resolutions performed during binding of this script compilation references.
</param>
<param name="resolutionDiagnostics">
Any diagnostics reported while resolving missing assemblies.
</param>
<param name="hasCircularReference">
True if the assembly being compiled is indirectly referenced through some of its own references.
</param>
<param name="corLibraryIndex">
The definition index of the COR library.
</param>
<return>
An array of <see cref="T:Microsoft.CodeAnalysis.CommonReferenceManager`2.BoundInputAssembly"/> structures describing the result. It has the same amount of items as
the input assemblies array, <see cref="T:Microsoft.CodeAnalysis.CommonReferenceManager`2.BoundInputAssembly"/> for each input AssemblyData object resides
at the same position.
Each <see cref="T:Microsoft.CodeAnalysis.CommonReferenceManager`2.BoundInputAssembly"/> contains the following data:
- Suitable AssemblySymbol instance for the corresponding assembly,
null reference if none is available/found. Always null for the first element, which corresponds to the assembly being built.
- Result of resolving assembly references of the corresponding assembly
against provided set of assembly definitions. Essentially, this is an array returned by
<see cref="M:Microsoft.CodeAnalysis.CommonReferenceManager`2.AssemblyData.BindAssemblyReferences(System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.CommonReferenceManager{`0,`1}.AssemblyData},Microsoft.CodeAnalysis.AssemblyIdentityComparer)"/> method.
</return>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonReferenceManager`2.TryResolveMissingReference(Microsoft.CodeAnalysis.MetadataReference,Microsoft.CodeAnalysis.AssemblyIdentity,System.Collections.Immutable.ImmutableDictionary{Microsoft.CodeAnalysis.AssemblyIdentity,Microsoft.CodeAnalysis.PortableExecutableReference}@,Microsoft.CodeAnalysis.MetadataReferenceResolver,Microsoft.CodeAnalysis.DiagnosticBag,Microsoft.CodeAnalysis.AssemblyIdentity@,Microsoft.CodeAnalysis.AssemblyMetadata@,Microsoft.CodeAnalysis.PortableExecutableReference@)">
<summary>
Resolve <paramref name="referenceIdentity"/> using a given <paramref name="resolver"/>.
We make sure not to query the resolver for the same identity multiple times (across submissions).
Doing so ensures that we don't create multiple assembly symbols within the same chain of script compilations
for the same implicitly resolved identity. Failure to do so results in cast errors like "can't convert T to T".
The method only records successful resolution results by updating <paramref name="implicitReferenceResolutions"/>.
Failures are only recorded after all resolution attempts have been completed.
This approach addresses the following scenario. Consider a script:
<code>
#r "dir1\a.dll"
#r "dir2\b.dll"
</code>
where both a.dll and b.dll reference x.dll, which is present only in dir2. Let's assume the resolver first
attempts to resolve "x" referenced from "dir1\a.dll". The resolver may fail to find the dependency if it only
looks up the directory containing the referencing assembly (dir1). If we recorded and this failure immediately
we would not call the resolver to resolve "x" within the context of "dir2\b.dll" (or any other referencing assembly).
This behavior would ensure consistency and if the types from x.dll do leak thru to the script compilation, but it
would result in a missing assembly error. By recording the failure after all resolution attempts are complete
we also achieve a consistent behavior but are able to bind the reference to "x.dll". Besides, this approach
also avoids dependency on the order in which we evaluate the assembly references in the scenario above.
In general, the result of the resolution may still depend on the order of #r - if there are different assemblies
of the same identity in different directories.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonReferenceManager`2.InternalsMayBeVisibleToAssemblyBeingCompiled(System.String,Microsoft.CodeAnalysis.PEAssembly)">
<summary>
Determines if it is possible that <paramref name="assembly"/> gives internals
access to assembly <paramref name="compilationName"/>. It does not make a conclusive
determination of visibility because the compilation's strong name key is not supplied.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonReferenceManager`2.GetActualBoundReferencesUsedBy(`1,System.Collections.Generic.List{`1})">
<summary>
Compute AssemblySymbols referenced by the input AssemblySymbol and fill in <paramref name="referencedAssemblySymbols"/> with the result.
The AssemblySymbols must correspond
to the AssemblyNames returned by AssemblyData.AssemblyReferences property. If reference is not
resolved, null reference should be returned in the corresponding item.
</summary>
<param name="assemblySymbol">The target AssemblySymbol instance.</param>
<param name="referencedAssemblySymbols">A list which will be filled in with
AssemblySymbols referenced by the input AssemblySymbol. The caller is expected to clear
the list before calling this method.
Implementer may not cache the list; the caller may mutate it.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonReferenceManager`2.GetNoPiaResolutionAssemblies(`1)">
<summary>
Return collection of assemblies involved in canonical type resolution of
NoPia local types defined within target assembly. In other words, all
references used by previous compilation referencing the target assembly.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonReferenceManager`2.IsLinked(`1)">
<summary>
Assembly is /l-ed by compilation that is using it as a reference.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonReferenceManager`2.GetCorLibrary(`1)">
<summary>
Get Assembly used as COR library for the candidate.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonReferenceManager`2.CheckPropertiesConsistency(Microsoft.CodeAnalysis.MetadataReference,Microsoft.CodeAnalysis.MetadataReference,Microsoft.CodeAnalysis.DiagnosticBag)">
<summary>
Checks if the properties of <paramref name="duplicateReference"/> are compatible with properties of <paramref name="primaryReference"/>.
Reports inconsistencies to the given diagnostic bag.
</summary>
<returns>True if the properties are compatible and hence merged, false if the duplicate reference should not merge it's properties with primary reference.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonReferenceManager`2.WeakIdentityPropertiesEquivalent(Microsoft.CodeAnalysis.AssemblyIdentity,Microsoft.CodeAnalysis.AssemblyIdentity)">
<summary>
Called to compare two weakly named identities with the same name.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommonReferenceManager`2.ResolvedReference.AliasesOpt">
<summary>
Aliases that should be applied to the referenced assembly.
Empty array means {"global"} (all namespaces and types in the global namespace of the assembly are accessible without qualification).
Null if not applicable (the reference only has recursive aliases).
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommonReferenceManager`2.ResolvedReference.RecursiveAliasesOpt">
<summary>
Aliases that should be applied recursively to all dependent assemblies.
Empty array means {"global"} (all namespaces and types in the global namespace of the assembly are accessible without qualification).
Null if not applicable (the reference only has simple aliases).
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommonReferenceManager`2.ResolvedReference.IsSkipped">
<summary>
default(<see cref="T:Microsoft.CodeAnalysis.CommonReferenceManager`2.ResolvedReference"/>) is considered skipped.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommonReferenceManager`2.ResolvedReference.Index">
<summary>
Index into an array of assemblies (not including the assembly being built) or an array of modules, depending on <see cref="P:Microsoft.CodeAnalysis.CommonReferenceManager`2.ResolvedReference.Kind"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CommonReferenceManager`2.ReferencedAssemblyIdentity.RelativeAssemblyIndex">
<summary>
non-negative: Index into the array of all (explicitly and implicitly) referenced assemblies.
negative: ExplicitlyReferencedAssemblies.Count + RelativeAssemblyIndex is an index into the array of assemblies.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonReferenceManager`2.ResolveMetadataReferences(`0,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{Microsoft.CodeAnalysis.CommonReferenceManager{`0,`1}.ReferencedAssemblyIdentity}},System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.MetadataReference}@,System.Collections.Generic.IDictionary{System.ValueTuple{System.String,System.String},Microsoft.CodeAnalysis.MetadataReference}@,System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.MetadataReference}@,System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.CommonReferenceManager{`0,`1}.AssemblyData}@,System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.PEModule}@,Microsoft.CodeAnalysis.DiagnosticBag)">
<summary>
Resolves given metadata references to assemblies and modules.
</summary>
<param name="compilation">The compilation whose references are being resolved.</param>
<param name="assemblyReferencesBySimpleName">
Used to filter out assemblies that have the same strong or weak identity.
Maps simple name to a list of identities. The highest version of each name is the first.
</param>
<param name="references">List where to store resolved references. References from #r directives will follow references passed to the compilation constructor.</param>
<param name="boundReferenceDirectiveMap">Maps #r values to successfully resolved metadata references. Does not contain values that failed to resolve.</param>
<param name="boundReferenceDirectives">Unique metadata references resolved from #r directives.</param>
<param name="assemblies">List where to store information about resolved assemblies to.</param>
<param name="modules">List where to store information about resolved modules to.</param>
<param name="diagnostics">Diagnostic bag where to report resolution errors.</param>
<returns>
Maps index to <paramref name="references"/> to an index of a resolved assembly or module in <paramref name="assemblies"/> or <paramref name="modules"/>, respectively.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonReferenceManager`2.GetMetadata(Microsoft.CodeAnalysis.PortableExecutableReference,Microsoft.CodeAnalysis.CommonMessageProvider,Microsoft.CodeAnalysis.Location,Microsoft.CodeAnalysis.DiagnosticBag)">
<summary>
Creates or gets metadata for PE reference.
</summary>
<remarks>
If any of the following exceptions: <see cref="T:System.BadImageFormatException"/>, <see cref="T:System.IO.FileNotFoundException"/>, <see cref="T:System.IO.IOException"/>,
are thrown while reading the metadata file, the exception is caught and an appropriate diagnostic stored in <paramref name="diagnostics"/>.
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.CommonReferenceManager`2.MetadataReferenceEqualityComparer">
<summary>
Determines whether references are the same. Compilation references are the same if they refer to the same compilation.
Otherwise, references are represented by their object identities.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonReferenceManager`2.MergeReferenceProperties(Microsoft.CodeAnalysis.MetadataReference,Microsoft.CodeAnalysis.MetadataReference,Microsoft.CodeAnalysis.DiagnosticBag,System.Collections.Generic.Dictionary{Microsoft.CodeAnalysis.MetadataReference,Microsoft.CodeAnalysis.MergedAliases}@)">
<summary>
Merges aliases of the first observed reference (<paramref name="primaryReference"/>) with aliases specified for an equivalent reference (<paramref name="newReference"/>).
Empty alias list is considered to be the same as a list containing "global", since in both cases C# allows unqualified access to the symbols.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonReferenceManager`2.AddAssembly(Microsoft.CodeAnalysis.CommonReferenceManager{`0,`1}.AssemblyData,System.Int32,Microsoft.CodeAnalysis.CommonReferenceManager{`0,`1}.ResolvedReference[],Microsoft.CodeAnalysis.PooledObjects.ArrayBuilder{Microsoft.CodeAnalysis.CommonReferenceManager{`0,`1}.AssemblyData})">
<remarks>
Caller is responsible for freeing any allocated ArrayBuilders.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonReferenceManager`2.AddModule(Microsoft.CodeAnalysis.PEModule,System.Int32,Microsoft.CodeAnalysis.CommonReferenceManager{`0,`1}.ResolvedReference[],Microsoft.CodeAnalysis.PooledObjects.ArrayBuilder{Microsoft.CodeAnalysis.PEModule}@)">
<remarks>
Caller is responsible for freeing any allocated ArrayBuilders.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonReferenceManager`2.TryAddAssembly(Microsoft.CodeAnalysis.AssemblyIdentity,Microsoft.CodeAnalysis.MetadataReference,System.Int32,Microsoft.CodeAnalysis.DiagnosticBag,Microsoft.CodeAnalysis.Location,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{Microsoft.CodeAnalysis.CommonReferenceManager{`0,`1}.ReferencedAssemblyIdentity}},System.Boolean)">
<summary>
Returns null if an assembly of an equivalent identity has not been added previously, otherwise returns the reference that added it.
Two identities are considered equivalent if
- both assembly names are strong (have keys) and are either equal or FX unified
- both assembly names are weak (no keys) and have the same simple name.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonReferenceManager`2.ResolveReferenceDirective(System.String,Microsoft.CodeAnalysis.Location,`0)">
<summary>
For each given directive return a bound PE reference, or null if the binding fails.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonReferenceManager`2.ResolveReferencedAssembly(Microsoft.CodeAnalysis.AssemblyIdentity,System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.CommonReferenceManager{`0,`1}.AssemblyData},System.Int32,Microsoft.CodeAnalysis.AssemblyIdentityComparer)">
<summary>
Used to match AssemblyRef with AssemblyDef.
</summary>
<param name="definitions">Array of definition identities to match against.</param>
<param name="definitionStartIndex">An index of the first definition to consider, <paramref name="definitions"/> preceding this index are ignored.</param>
<param name="reference">Reference identity to resolve.</param>
<param name="assemblyIdentityComparer">Assembly identity comparer.</param>
<returns>
Returns an index the reference is bound.
</returns>
</member>
<member name="F:Microsoft.CodeAnalysis.CommonReferenceManager`2.SimpleAssemblyName">
<summary>
If the compilation being built represents an assembly its assembly name.
If the compilation being built represents a module, the name of the
containing assembly or <see cref="F:Microsoft.CodeAnalysis.Compilation.UnspecifiedModuleAssemblyName"/>
if not specified (/moduleassemblyname command line option).
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CommonReferenceManager`2.IdentityComparer">
<summary>
Used to compares assembly identities.
May implement unification and portability policies specific to the target platform.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CommonReferenceManager`2.ObservedMetadata">
<summary>
Metadata observed by the compiler.
May be shared across multiple Reference Managers.
Access only under lock(<see cref="F:Microsoft.CodeAnalysis.CommonReferenceManager`2.ObservedMetadata"/>).
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CommonReferenceManager`2._isBound">
<summary>
Once this is non-zero the state of the manager is fully initialized and immutable.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CommonReferenceManager`2._lazyHasCircularReference">
<summary>
True if the compilation has a reference that refers back to the assembly being compiled.
</summary>
<remarks>
If we have a circular reference the bound references can't be shared with other compilations.
</remarks>
</member>
<member name="F:Microsoft.CodeAnalysis.CommonReferenceManager`2._lazyReferencedAssembliesMap">
<summary>
A map from a metadata reference to an index to <see cref="F:Microsoft.CodeAnalysis.CommonReferenceManager`2._lazyReferencedAssemblies"/> array. Do not access
directly, use <see cref="F:Microsoft.CodeAnalysis.CommonReferenceManager`2._lazyReferencedAssembliesMap"/> property instead.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CommonReferenceManager`2._lazyReferencedModuleIndexMap">
<summary>
A map from a net-module metadata reference to the index of the corresponding module
symbol in the source assembly symbol for the current compilation.
</summary>
<remarks>
Subtract one from the index (for the manifest module) to find the corresponding elements
of <see cref="F:Microsoft.CodeAnalysis.CommonReferenceManager`2._lazyReferencedModules"/> and <see cref="F:Microsoft.CodeAnalysis.CommonReferenceManager`2._lazyReferencedModulesReferences"/>.
</remarks>
</member>
<member name="F:Microsoft.CodeAnalysis.CommonReferenceManager`2._lazyReferenceDirectiveMap">
<summary>
Maps (containing syntax tree file name, reference string) of #r directive to a resolved metadata reference.
If multiple #r's in the same tree use the same value as a reference the resolved metadata reference is the same as well.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CommonReferenceManager`2._lazyDirectiveReferences">
<summary>
Array of unique bound #r references.
</summary>
<remarks>
The references are in the order they appear in syntax trees. This order is currently preserved
as syntax trees are added or removed, but we might decide to share reference manager between compilations
with different order of #r's. It doesn't seem this would be an issue since all #r's within the compilation
have the same "priority" with respect to each other.
</remarks>
</member>
<member name="F:Microsoft.CodeAnalysis.CommonReferenceManager`2._lazyImplicitReferenceResolutions">
<summary>
Stores the results of implicit reference resolutions.
If <see cref="P:Microsoft.CodeAnalysis.MetadataReferenceResolver.ResolveMissingAssemblies"/> is true the reference manager attempts to resolve assembly identities,
that do not match any explicit metadata references passed to the compilation (or specified via #r directive).
For each such assembly identity <see cref="M:Microsoft.CodeAnalysis.MetadataReferenceResolver.ResolveMissingAssembly(Microsoft.CodeAnalysis.MetadataReference,Microsoft.CodeAnalysis.AssemblyIdentity)"/> is called
and its result is captured in this map.
The map also stores failures - the reference is null if the assembly of the given identity is not found by the resolver.
This is important to maintain consistency, especially across multiple submissions (e.g. the reference is not found during compilation of the first submission
but then it is available when the second submission is compiled).
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CommonReferenceManager`2._lazyDiagnostics">
<summary>
Diagnostics produced during reference resolution and binding.
</summary>
<remarks>
When reporting diagnostics be sure not to include any information that can't be shared among
compilations that share the same reference manager (such as full identity of the compilation,
simple assembly name is ok).
</remarks>
</member>
<member name="F:Microsoft.CodeAnalysis.CommonReferenceManager`2._lazyCorLibraryOpt">
<summary>
COR library symbol, or null if the compilation itself is the COR library.
</summary>
<remarks>
If the compilation being built is the COR library we don't want to store its source assembly symbol
here since we wouldn't be able to share the state among subsequent compilations that are derived from it
(each of them has its own source assembly symbol).
</remarks>
</member>
<member name="F:Microsoft.CodeAnalysis.CommonReferenceManager`2._lazyReferencedModules">
<summary>
Standalone modules referenced by the compilation (doesn't include the manifest module of the compilation).
</summary>
<remarks>
<see cref="F:Microsoft.CodeAnalysis.CommonReferenceManager`2._lazyReferencedModules"/>[i] corresponds to <see cref="F:Microsoft.CodeAnalysis.CommonReferenceManager`2._lazyReferencedModulesReferences"/>[i].
</remarks>
</member>
<member name="F:Microsoft.CodeAnalysis.CommonReferenceManager`2._lazyReferencedModulesReferences">
<summary>
References of standalone modules referenced by the compilation (doesn't include the manifest module of the compilation).
</summary>
<remarks>
<see cref="F:Microsoft.CodeAnalysis.CommonReferenceManager`2._lazyReferencedModules"/>[i] corresponds to <see cref="F:Microsoft.CodeAnalysis.CommonReferenceManager`2._lazyReferencedModulesReferences"/>[i].
</remarks>
</member>
<member name="F:Microsoft.CodeAnalysis.CommonReferenceManager`2._lazyReferencedAssemblies">
<summary>
Assemblies referenced directly by the source module of the compilation.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CommonReferenceManager`2._lazyAliasesOfReferencedAssemblies">
<summary>
Assemblies referenced directly by the source module of the compilation.
</summary>
<remarks>
Aliases <see cref="F:Microsoft.CodeAnalysis.CommonReferenceManager`2._lazyAliasesOfReferencedAssemblies"/>[i] are of an assembly <see cref="F:Microsoft.CodeAnalysis.CommonReferenceManager`2._lazyReferencedAssemblies"/>[i].
</remarks>
</member>
<member name="F:Microsoft.CodeAnalysis.CommonReferenceManager`2._lazyUnifiedAssemblies">
<summary>
Unified assemblies referenced directly by the source module of the compilation.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonReferenceManager`2.AssertUnbound">
<summary>
Call only while holding <see cref="F:Microsoft.CodeAnalysis.CommonReferenceManager.SymbolCacheAndReferenceManagerStateGuard"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonReferenceManager`2.InitializeNoLock(System.Collections.Generic.Dictionary{Microsoft.CodeAnalysis.MetadataReference,System.Int32},System.Collections.Generic.Dictionary{Microsoft.CodeAnalysis.MetadataReference,System.Int32},System.Collections.Generic.IDictionary{System.ValueTuple{System.String,System.String},Microsoft.CodeAnalysis.MetadataReference},System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.MetadataReference},System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.MetadataReference},System.Collections.Immutable.ImmutableDictionary{Microsoft.CodeAnalysis.AssemblyIdentity,Microsoft.CodeAnalysis.PortableExecutableReference},System.Boolean,System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.Diagnostic},`1,System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.PEModule},System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.ModuleReferences{`1}},System.Collections.Immutable.ImmutableArray{`1},System.Collections.Immutable.ImmutableArray{System.Collections.Immutable.ImmutableArray{System.String}},System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.UnifiedAssembly{`1}})">
<summary>
Call only while holding <see cref="F:Microsoft.CodeAnalysis.CommonReferenceManager.SymbolCacheAndReferenceManagerStateGuard"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CommonReferenceManager`2.s_supersededAlias">
<summary>
Global namespaces of assembly references that have been superseded by an assembly reference with a higher version are
hidden behind <see cref="F:Microsoft.CodeAnalysis.CommonReferenceManager`2.s_supersededAlias"/> to avoid ambiguity when they are accessed from source.
All existing aliases of a superseded assembly are discarded.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonReferenceManager`2.GetAssemblyReferenceIdentityBaselineMap(System.Collections.Immutable.ImmutableArray{`1},System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.AssemblyIdentity})">
<summary>
Calculates map from the identities of specified symbols to the corresponding identities in the original EnC baseline metadata.
The map only includes an entry for identities that differ, i.e. for symbols representing assembly references of the current compilation that have different identities
than the corresponding identity in baseline metadata AssemblyRef table. The key comparer of the map ignores build and revision parts of the version number,
since these might change if the original version included wildcard.
</summary>
<param name="symbols">Assembly symbols for references of the current compilation.</param>
<param name="originalIdentities">Identities in the baseline. <paramref name="originalIdentities"/>[i] corresponds to <paramref name="symbols"/>[i].</param>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonReferenceManager`2.GetMetadataReference(Microsoft.CodeAnalysis.Symbols.IAssemblySymbolInternal)">
<summary>
Gets the <see cref="T:Microsoft.CodeAnalysis.MetadataReference"/> that corresponds to the assembly symbol.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CommonReferenceManager.SymbolCacheAndReferenceManagerStateGuard">
<summary>
Must be acquired whenever the following data are about to be modified:
- Compilation.lazyAssemblySymbol
- Compilation.referenceManager
- ReferenceManager state
- <see cref="F:Microsoft.CodeAnalysis.AssemblyMetadata.CachedSymbols"/>
- <see cref="P:Microsoft.CodeAnalysis.Compilation.RetargetingAssemblySymbols"/>
All the above data should be updated at once while holding this lock.
Once lazyAssemblySymbol is set the Compilation.referenceManager field and ReferenceManager
state should not change.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonReferenceManager.GetReferencedAssemblies">
<summary>
Enumerates all referenced assemblies.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CommonReferenceManager.GetReferencedAssemblyAliases">
<summary>
Enumerates all referenced assemblies and their aliases.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.MergedAliases.Merge(Microsoft.CodeAnalysis.MetadataReference)">
<summary>
Adds aliases of a specified reference to the merged set of aliases.
Consider the following special cases:
o {} + {} = {}
If neither reference has any aliases then the result has no aliases.
o {A} + {} = {A, global}
{} + {A} = {A, global}
If one and only one of the references has aliases we add the global alias since the
referenced declarations should now be accessible both via existing aliases
as well as unqualified.
o {A, A} + {A, B, B} = {A, A, B, B}
We preserve dups in each alias array, but avoid making more dups when merging.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.ModuleReferences`1">
<summary>
A record of the assemblies referenced by a module (their identities, symbols, and unification).
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.ModuleReferences`1.Identities">
<summary>
Identities of referenced assemblies (those that are or will be emitted to metadata).
</summary>
<remarks>
Names[i] is the identity of assembly Symbols[i].
</remarks>
</member>
<member name="F:Microsoft.CodeAnalysis.ModuleReferences`1.Symbols">
<summary>
Assembly symbols that the identities are resolved against.
</summary>
<remarks>
Names[i] is the identity of assembly Symbols[i].
Unresolved references are represented as MissingAssemblySymbols.
</remarks>
</member>
<member name="F:Microsoft.CodeAnalysis.ModuleReferences`1.UnifiedAssemblies">
<summary>
A subset of <see cref="F:Microsoft.CodeAnalysis.ModuleReferences`1.Symbols"/> that correspond to references with non-matching (unified)
version along with unification details.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.UnifiedAssembly`1">
<summary>
Assembly symbol referenced by a AssemblyRef for which we couldn't find a matching
compilation reference but we found one that differs in version.
Created only for assemblies that require runtime binding redirection policy,
i.e. not for Framework assemblies.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.UnifiedAssembly`1.OriginalReference">
<summary>
Original reference that was unified to the identity of the <see cref="F:Microsoft.CodeAnalysis.UnifiedAssembly`1.TargetAssembly"/>.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.ResourceDescription">
<summary>
Representation of a resource whose contents are to be embedded in the output assembly.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.ResourceDescription.#ctor(System.String,System.Func{System.IO.Stream},System.Boolean)">
<summary>
Creates a representation of a resource whose contents are to be embedded in the output assembly.
</summary>
<param name="resourceName">Resource name.</param>
<param name="dataProvider">The callers will dispose the result after use.
This allows the resources to be opened and read one at a time.
</param>
<param name="isPublic">True if the resource is public.</param>
<remarks>
Returns a stream of the data to embed.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.ResourceDescription.#ctor(System.String,System.String,System.Func{System.IO.Stream},System.Boolean)">
<summary>
Creates a representation of a resource whose file name will be recorded in the assembly.
</summary>
<param name="resourceName">Resource name.</param>
<param name="fileName">File name with an extension to be stored in metadata.</param>
<param name="dataProvider">The callers will dispose the result after use.
This allows the resources to be opened and read one at a time.
</param>
<param name="isPublic">True if the resource is public.</param>
<remarks>
Function returning a stream of the resource content (used to calculate hash).
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.InvalidRuleSetException">
<summary>
Represents errors that occur while parsing RuleSet files.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.RuleSet">
<summary>
Represents a set of rules as specified in a ruleset file.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.RuleSet.FilePath">
<summary>
The file path of the ruleset file.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.RuleSet.GeneralDiagnosticOption">
<summary>
The global option specified by the IncludeAll tag.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.RuleSet.SpecificDiagnosticOptions">
<summary>
Individual rule ids and their associated actions.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.RuleSet.Includes">
<summary>
List of rulesets included by this ruleset.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.RuleSet.#ctor(System.String,Microsoft.CodeAnalysis.ReportDiagnostic,System.Collections.Immutable.ImmutableDictionary{System.String,Microsoft.CodeAnalysis.ReportDiagnostic},System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.RuleSetInclude})">
<summary>
Create a RuleSet.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.RuleSet.WithEffectiveAction(Microsoft.CodeAnalysis.ReportDiagnostic)">
<summary>
Create a RuleSet with a global effective action applied on it.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.RuleSet.GetEffectiveRuleSet(System.Collections.Generic.HashSet{System.String})">
<summary>
Get the effective ruleset after resolving all the included rulesets.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.RuleSet.GetEffectiveIncludes">
<summary>
Get all the files involved in resolving this ruleset.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.RuleSet.IsStricterThan(Microsoft.CodeAnalysis.ReportDiagnostic,Microsoft.CodeAnalysis.ReportDiagnostic)">
<summary>
Returns true if the action1 is stricter than action2.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.RuleSet.LoadEffectiveRuleSetFromFile(System.String)">
<summary>
Load the ruleset from the specified file. This ruleset will contain
all the rules resolved from the includes specified in the ruleset file
as well. See also: <seealso cref="M:Microsoft.CodeAnalysis.RuleSet.GetEffectiveIncludesFromFile(System.String)" />.
</summary>
<returns>
A ruleset that contains resolved rules or null if there were errors.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.RuleSet.GetEffectiveIncludesFromFile(System.String)">
<summary>
Get the paths to all files contributing rules to the ruleset from the specified file.
See also: <seealso cref="M:Microsoft.CodeAnalysis.RuleSet.LoadEffectiveRuleSetFromFile(System.String)" />.
</summary>
<returns>
The full paths to included files, or an empty array if there were errors.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.RuleSet.GetDiagnosticOptionsFromRulesetFile(System.String,System.Collections.Generic.Dictionary{System.String,Microsoft.CodeAnalysis.ReportDiagnostic}@)">
<summary>
Parses the ruleset file at the given <paramref name="rulesetFileFullPath"/> and returns the following diagnostic options from the parsed file:
1) A map of <paramref name="specificDiagnosticOptions"/> from rule ID to <see cref="T:Microsoft.CodeAnalysis.ReportDiagnostic"/> option.
2) A global <see cref="T:Microsoft.CodeAnalysis.ReportDiagnostic"/> option for all rules in the ruleset file.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.RuleSetInclude">
<summary>
Represents a Include tag in a RuleSet file.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.RuleSetInclude.IncludePath">
<summary>
The path of the included file.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.RuleSetInclude.Action">
<summary>
The effective action to apply on this included ruleset.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.RuleSetInclude.#ctor(System.String,Microsoft.CodeAnalysis.ReportDiagnostic)">
<summary>
Create a RuleSetInclude given the include path and the effective action.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.RuleSetInclude.LoadRuleSet(Microsoft.CodeAnalysis.RuleSet)">
<summary>
Gets the RuleSet associated with this ruleset include
</summary>
<param name="parent">The parent of this ruleset include</param>
</member>
<member name="M:Microsoft.CodeAnalysis.RuleSetInclude.GetIncludePath(Microsoft.CodeAnalysis.RuleSet)">
<summary>
Returns a full path to the include file. Relative paths are expanded relative to the current rule set file.
</summary>
<param name="parent">The parent of this rule set include</param>
</member>
<member name="T:Microsoft.CodeAnalysis.RuleSetProcessor">
<summary>
This type is responsible for parsing a ruleset xml file and producing a <see cref="T:Microsoft.CodeAnalysis.RuleSet"/> object.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.RuleSetProcessor.LoadFromFile(System.String)">
<summary>
Creates and loads the rule set from a file
</summary>
<param name="filePath">The file path to load the rule set</param>
</member>
<member name="M:Microsoft.CodeAnalysis.RuleSetProcessor.ReadRuleSet(System.Xml.Linq.XElement,System.String)">
<summary>
Load the rule set from the XML node
</summary>
<param name="ruleSetNode">The rule set node from which to create a rule set object</param>
<param name="filePath">The file path to the rule set file</param>
<returns>A rule set object with data from the given XML node</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.RuleSetProcessor.ReadRules(System.Xml.Linq.XElement)">
<summary>
Load the rules from the XML node
</summary>
<param name="rulesNode">The rules node from which to loop through each child rule node</param>
<returns>A list of rule objects with data from the given XML node</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.RuleSetProcessor.ReadRule(System.Xml.Linq.XElement,System.String,System.String)">
<summary>
Load the rule from the XML node
</summary>
<param name="ruleNode">The rule node from which to create a rule object</param>
<param name="analyzer">The analyzer this rule belongs to</param>
<param name="space">The namespace this rule belongs to</param>
<returns>A rule object with data from the given XML node</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.RuleSetProcessor.ReadRuleSetInclude(System.Xml.Linq.XElement)">
<summary>
Load the included rule set from the XML node
</summary>
<param name="includeNode">The include node from which to create a RuleSetInclude object</param>
<returns>A RuleSetInclude object with data from the given XML node</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.RuleSetProcessor.ReadAction(System.Xml.Linq.XElement,System.Boolean)">
<summary>
Reads the action from the given node
</summary>
<param name="node">The node to read the action, it can be a rule node or an include node.</param>
<param name="allowDefault">Whether or not the default value is allowed.</param>
<returns>The rule action</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.RuleSetProcessor.ReadIncludeAll(System.Xml.Linq.XElement)">
<summary>
Load the IncludedAll from the XML node
</summary>
<param name="includeAllNode">The IncludeAll node from which to create a IncludeAll object</param>
<returns>A IncludeAll object with data from the given XML node</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.RuleSetProcessor.ReadNonEmptyAttribute(System.Xml.Linq.XElement,System.String)">
<summary>
Reads an attribute from a node and validates that it is not empty.
</summary>
<param name="node">The XML node that contains the attribute</param>
<param name="attributeName">The name of the attribute to read</param>
<returns>The attribute value</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.RuleSetProcessor.GetDefaultXmlReaderSettings">
<summary>
Gets the default settings to read the ruleset xml file.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.SourceCodeKind">
<summary>
Specifies the C# or VB source code kind.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SourceCodeKind.Regular">
<summary>
No scripting. Used for .cs/.vb file parsing.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SourceCodeKind.Script">
<summary>
Allows top-level statements, declarations, and optional trailing expression.
Used for parsing .csx/.vbx and interactive submissions.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SourceCodeKind.Interactive">
<summary>
The same as <see cref="F:Microsoft.CodeAnalysis.SourceCodeKind.Script"/>.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.SourceFileResolver">
<summary>
Resolves references to source files specified in source code.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.GeneratedSourceText">
<summary>
A source text created by an <see cref="T:Microsoft.CodeAnalysis.ISourceGenerator"/>
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.GeneratedSyntaxTree">
<summary>
A syntax tree created by a <see cref="T:Microsoft.CodeAnalysis.ISourceGenerator"/>
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.GeneratorAttribute">
<summary>
Place this attribute onto a type to cause it to be considered a source generator
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.GeneratorAttribute.Languages">
<summary>
The source languages to which this generator applies. See <see cref="T:Microsoft.CodeAnalysis.LanguageNames"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.GeneratorAttribute.#ctor">
<summary>
Attribute constructor used to specify the attached class is a source generator that provides CSharp sources.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.GeneratorAttribute.#ctor(System.String,System.String[])">
<summary>
Attribute constructor used to specify the attached class is a source generator and indicate which language(s) it supports.
</summary>
<param name="firstLanguage">One language to which the generator applies.</param>
<param name="additionalLanguages">Additional languages to which the generator applies. See <see cref="T:Microsoft.CodeAnalysis.LanguageNames"/>.</param>
</member>
<member name="T:Microsoft.CodeAnalysis.GeneratorExecutionContext">
<summary>
Context passed to a source generator when <see cref="M:Microsoft.CodeAnalysis.ISourceGenerator.Execute(Microsoft.CodeAnalysis.GeneratorExecutionContext)"/> is called
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.GeneratorExecutionContext.Compilation">
<summary>
Get the current <see cref="P:Microsoft.CodeAnalysis.GeneratorExecutionContext.Compilation"/> at the time of execution.
</summary>
<remarks>
This compilation contains only the user supplied code; other generated code is not
available. As user code can depend on the results of generation, it is possible that
this compilation will contain errors.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.GeneratorExecutionContext.ParseOptions">
<summary>
Get the <see cref="P:Microsoft.CodeAnalysis.GeneratorExecutionContext.ParseOptions"/> that will be used to parse any added sources.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.GeneratorExecutionContext.AdditionalFiles">
<summary>
A set of additional non-code text files that can be used by generators.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.GeneratorExecutionContext.AnalyzerConfigOptions">
<summary>
Allows access to options provided by an analyzer config
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.GeneratorExecutionContext.SyntaxReceiver">
<summary>
If the generator registered an <see cref="T:Microsoft.CodeAnalysis.ISyntaxReceiver"/> during initialization, this will be the instance created for this generation pass.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.GeneratorExecutionContext.SyntaxContextReceiver">
<summary>
If the generator registered an <see cref="T:Microsoft.CodeAnalysis.ISyntaxContextReceiver"/> during initialization, this will be the instance created for this generation pass.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.GeneratorExecutionContext.CancellationToken">
<summary>
A <see cref="P:Microsoft.CodeAnalysis.GeneratorExecutionContext.CancellationToken"/> that can be checked to see if the generation should be cancelled.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.GeneratorExecutionContext.AddSource(System.String,System.String)">
<summary>
Adds source code in the form of a <see cref="T:System.String"/> to the compilation.
</summary>
<param name="hintName">An identifier that can be used to reference this source text, must be unique within this generator</param>
<param name="source">The source code to add to the compilation</param>
</member>
<member name="M:Microsoft.CodeAnalysis.GeneratorExecutionContext.AddSource(System.String,Microsoft.CodeAnalysis.Text.SourceText)">
<summary>
Adds a <see cref="T:Microsoft.CodeAnalysis.Text.SourceText"/> to the compilation
</summary>
<param name="hintName">An identifier that can be used to reference this source text, must be unique within this generator</param>
<param name="sourceText">The <see cref="T:Microsoft.CodeAnalysis.Text.SourceText"/> to add to the compilation</param>
</member>
<member name="M:Microsoft.CodeAnalysis.GeneratorExecutionContext.ReportDiagnostic(Microsoft.CodeAnalysis.Diagnostic)">
<summary>
Adds a <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/> to the users compilation
</summary>
<param name="diagnostic">The diagnostic that should be added to the compilation</param>
<remarks>
The severity of the diagnostic may cause the compilation to fail, depending on the <see cref="P:Microsoft.CodeAnalysis.GeneratorExecutionContext.Compilation"/> settings.
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.GeneratorInitializationContext">
<summary>
Context passed to a source generator when <see cref="M:Microsoft.CodeAnalysis.ISourceGenerator.Initialize(Microsoft.CodeAnalysis.GeneratorInitializationContext)"/> is called
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.GeneratorInitializationContext.CancellationToken">
<summary>
A <see cref="P:Microsoft.CodeAnalysis.GeneratorInitializationContext.CancellationToken"/> that can be checked to see if the initialization should be cancelled.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.GeneratorInitializationContext.RegisterForSyntaxNotifications(Microsoft.CodeAnalysis.SyntaxReceiverCreator)">
<summary>
Register a <see cref="T:Microsoft.CodeAnalysis.SyntaxReceiverCreator"/> for this generator, which can be used to create an instance of an <see cref="T:Microsoft.CodeAnalysis.ISyntaxReceiver"/>.
</summary>
<remarks>
This method allows generators to be 'syntax aware'. Before each generation the <paramref name="receiverCreator"/> will be invoked to create
an instance of <see cref="T:Microsoft.CodeAnalysis.ISyntaxReceiver"/>. This receiver will have its <see cref="M:Microsoft.CodeAnalysis.ISyntaxReceiver.OnVisitSyntaxNode(Microsoft.CodeAnalysis.SyntaxNode)"/>
invoked for each syntax node in the compilation, allowing the receiver to build up information about the compilation before generation occurs.
During <see cref="M:Microsoft.CodeAnalysis.ISourceGenerator.Execute(Microsoft.CodeAnalysis.GeneratorExecutionContext)"/> the generator can obtain the <see cref="T:Microsoft.CodeAnalysis.ISyntaxReceiver"/> instance that was
created by accessing the <see cref="P:Microsoft.CodeAnalysis.GeneratorExecutionContext.SyntaxReceiver"/> property. Any information that was collected by the receiver can be
used to generate the final output.
A new instance of <see cref="T:Microsoft.CodeAnalysis.ISyntaxReceiver"/> is created per-generation, meaning there is no need to manage the lifetime of the
receiver or its contents.
</remarks>
<param name="receiverCreator">A <see cref="T:Microsoft.CodeAnalysis.SyntaxReceiverCreator"/> that can be invoked to create an instance of <see cref="T:Microsoft.CodeAnalysis.ISyntaxReceiver"/></param>
</member>
<member name="M:Microsoft.CodeAnalysis.GeneratorInitializationContext.RegisterForSyntaxNotifications(Microsoft.CodeAnalysis.SyntaxContextReceiverCreator)">
<summary>
Register a <see cref="T:Microsoft.CodeAnalysis.SyntaxContextReceiverCreator"/> for this generator, which can be used to create an instance of an <see cref="T:Microsoft.CodeAnalysis.ISyntaxContextReceiver"/>.
</summary>
<remarks>
This method allows generators to be 'syntax aware'. Before each generation the <paramref name="receiverCreator"/> will be invoked to create
an instance of <see cref="T:Microsoft.CodeAnalysis.ISyntaxContextReceiver"/>. This receiver will have its <see cref="M:Microsoft.CodeAnalysis.ISyntaxContextReceiver.OnVisitSyntaxNode(Microsoft.CodeAnalysis.GeneratorSyntaxContext)"/>
invoked for each syntax node in the compilation, allowing the receiver to build up information about the compilation before generation occurs.
During <see cref="M:Microsoft.CodeAnalysis.ISourceGenerator.Execute(Microsoft.CodeAnalysis.GeneratorExecutionContext)"/> the generator can obtain the <see cref="T:Microsoft.CodeAnalysis.ISyntaxContextReceiver"/> instance that was
created by accessing the <see cref="P:Microsoft.CodeAnalysis.GeneratorExecutionContext.SyntaxContextReceiver"/> property. Any information that was collected by the receiver can be
used to generate the final output.
A new instance of <see cref="T:Microsoft.CodeAnalysis.ISyntaxContextReceiver"/> is created prior to every call to <see cref="M:Microsoft.CodeAnalysis.ISourceGenerator.Execute(Microsoft.CodeAnalysis.GeneratorExecutionContext)"/>,
meaning there is no need to manage the lifetime of the receiver or its contents.
</remarks>
<param name="receiverCreator">A <see cref="T:Microsoft.CodeAnalysis.SyntaxContextReceiverCreator"/> that can be invoked to create an instance of <see cref="T:Microsoft.CodeAnalysis.ISyntaxContextReceiver"/></param>
</member>
<member name="M:Microsoft.CodeAnalysis.GeneratorInitializationContext.RegisterForPostInitialization(System.Action{Microsoft.CodeAnalysis.GeneratorPostInitializationContext})">
<summary>
Register a callback that is invoked after initialization.
</summary>
<remarks>
This method allows a generator to opt-in to an extra phase in the generator lifecycle called PostInitialization. After being initialized
any generators that have opted in will have their provided callback invoked with a <see cref="T:Microsoft.CodeAnalysis.GeneratorPostInitializationContext"/> instance
that can be used to alter the compilation that is provided to subsequent generator phases.
For example a generator may choose to add sources during PostInitialization. These will be added to the compilation before execution and
will be visited by a registered <see cref="T:Microsoft.CodeAnalysis.ISyntaxReceiver"/> and available for semantic analysis as part of the <see cref="P:Microsoft.CodeAnalysis.GeneratorExecutionContext.Compilation"/>
Note that any sources added during PostInitialization <i>will</i> be visible to the later phases of other generators operation on the compilation.
</remarks>
<param name="callback">An <see cref="T:System.Action`1"/> that accepts a <see cref="T:Microsoft.CodeAnalysis.GeneratorPostInitializationContext"/> that will be invoked after initialization.</param>
</member>
<member name="T:Microsoft.CodeAnalysis.GeneratorSyntaxContext">
<summary>
Context passed to an <see cref="T:Microsoft.CodeAnalysis.ISyntaxContextReceiver"/> when <see cref="M:Microsoft.CodeAnalysis.ISyntaxContextReceiver.OnVisitSyntaxNode(Microsoft.CodeAnalysis.GeneratorSyntaxContext)"/> is called
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.GeneratorSyntaxContext.Node">
<summary>
The <see cref="T:Microsoft.CodeAnalysis.SyntaxNode"/> currently being visited
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.GeneratorSyntaxContext.SemanticModel">
<summary>
The <see cref="P:Microsoft.CodeAnalysis.GeneratorSyntaxContext.SemanticModel" /> that can be queried to obtain information about <see cref="P:Microsoft.CodeAnalysis.GeneratorSyntaxContext.Node"/>.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.GeneratorPostInitializationContext">
<summary>
Context passed to a source generator when it has opted-in to PostInitialization via <see cref="M:Microsoft.CodeAnalysis.GeneratorInitializationContext.RegisterForPostInitialization(System.Action{Microsoft.CodeAnalysis.GeneratorPostInitializationContext})"/>
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.GeneratorPostInitializationContext.CancellationToken">
<summary>
A <see cref="P:Microsoft.CodeAnalysis.GeneratorPostInitializationContext.CancellationToken"/> that can be checked to see if the PostInitialization should be cancelled.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.GeneratorPostInitializationContext.AddSource(System.String,System.String)">
<summary>
Adds source code in the form of a <see cref="T:System.String"/> to the compilation that will be available during subsequent phases
</summary>
<param name="hintName">An identifier that can be used to reference this source text, must be unique within this generator</param>
<param name="source">The source code to add to the compilation</param>
</member>
<member name="M:Microsoft.CodeAnalysis.GeneratorPostInitializationContext.AddSource(System.String,Microsoft.CodeAnalysis.Text.SourceText)">
<summary>
Adds a <see cref="T:Microsoft.CodeAnalysis.Text.SourceText"/> to the compilation that will be available during subsequent phases
</summary>
<param name="hintName">An identifier that can be used to reference this source text, must be unique within this generator</param>
<param name="sourceText">The <see cref="T:Microsoft.CodeAnalysis.Text.SourceText"/> to add to the compilation</param>
</member>
<member name="T:Microsoft.CodeAnalysis.GeneratorDriver">
<summary>
Responsible for orchestrating a source generation pass
</summary>
<remarks>
GeneratorDriver is an immutable class that can be manipulated by returning a mutated copy of itself.
In the compiler we only ever create a single instance and ignore the mutated copy. The IDE may perform
multiple edits, or generation passes of the same driver, re-using the state as needed.
A generator driver works like a small state machine:
- It starts off with no generated sources
- A full generation pass will run every generator and produce all possible generated source
- At any time an 'edit' maybe supplied, which represents potential future work
- TryApplyChanges can be called, which will iterate through the pending edits and try and attempt to
bring the state back to what it would be if a full generation occurred by running partial generation
on generators that support it
- At any time a full generation pass can be re-run, resetting the pending edits
</remarks>
</member>
<member name="F:Microsoft.CodeAnalysis.GeneratorDriverState.Generators">
<summary>
The set of <see cref="T:Microsoft.CodeAnalysis.ISourceGenerator"/>s associated with this state.
</summary>
<remarks>
This is the set of generators that will run on next generation.
If there are any states present in <see cref="F:Microsoft.CodeAnalysis.GeneratorDriverState.GeneratorStates" />, they were produced by a subset of these generators.
</remarks>
</member>
<member name="F:Microsoft.CodeAnalysis.GeneratorDriverState.GeneratorStates">
<summary>
The last run state of each generator, by the generator that created it
</summary>
<remarks>
There will be a 1-to-1 mapping for each generator. If a generator has yet to
be initialized or failed during initialization it's state will be <c>default(GeneratorState)</c>
</remarks>
</member>
<member name="F:Microsoft.CodeAnalysis.GeneratorDriverState.AdditionalTexts">
<summary>
The set of <see cref="T:Microsoft.CodeAnalysis.AdditionalText"/>s available to source generators during a run
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.GeneratorDriverState.OptionsProvider">
<summary>
Gets a provider for analyzer options
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.GeneratorDriverState.Edits">
<summary>
An ordered list of <see cref="T:Microsoft.CodeAnalysis.PendingEdit"/>s that are waiting to be applied to the compilation.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.GeneratorDriverState.EditsFailed">
<summary>
Tracks if previous edits have failed to apply. A generator driver will not try and apply any edits when this flag is set.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.GeneratorDriverState.ParseOptions">
<summary>
ParseOptions to use when parsing generator provided source.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.GeneratorState">
<summary>
Represents the current state of a generator
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.GeneratorState.Uninitialized">
<summary>
Gets an uninitialized generator state
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.GeneratorState.#ctor(Microsoft.CodeAnalysis.GeneratorInfo)">
<summary>
Creates a new generator state that just contains information
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.GeneratorState.#ctor(Microsoft.CodeAnalysis.GeneratorInfo,System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.GeneratedSyntaxTree})">
<summary>
Creates a new generator state that contains information and constant trees
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.GeneratorState.#ctor(Microsoft.CodeAnalysis.GeneratorInfo,System.Exception,Microsoft.CodeAnalysis.Diagnostic)">
<summary>
Creates a new generator state that contains an exception and the associated diagnostic
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.GeneratorState.#ctor(Microsoft.CodeAnalysis.GeneratorInfo,System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.GeneratedSyntaxTree},System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.GeneratedSyntaxTree},System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.Diagnostic})">
<summary>
Creates a generator state that contains results
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.GeneratorState.WithReceiver(Microsoft.CodeAnalysis.ISyntaxContextReceiver)">
<summary>
Adds a syntax receiver to this generator state
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.ISourceGenerator">
<summary>
The base interface required to implement a source generator
</summary>
<remarks>
The lifetime of a generator is controlled by the compiler.
State should not be stored directly on the generator, as there
is no guarantee that the same instance will be used on a
subsequent generation pass.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.ISourceGenerator.Initialize(Microsoft.CodeAnalysis.GeneratorInitializationContext)">
<summary>
Called before generation occurs. A generator can use the <paramref name="context"/>
to register callbacks required to perform generation.
</summary>
<param name="context">The <see cref="T:Microsoft.CodeAnalysis.GeneratorInitializationContext"/> to register callbacks on</param>
</member>
<member name="M:Microsoft.CodeAnalysis.ISourceGenerator.Execute(Microsoft.CodeAnalysis.GeneratorExecutionContext)">
<summary>
Called to perform source generation. A generator can use the <paramref name="context"/>
to add source files via the <see cref="M:Microsoft.CodeAnalysis.GeneratorExecutionContext.AddSource(System.String,Microsoft.CodeAnalysis.Text.SourceText)"/>
method.
</summary>
<param name="context">The <see cref="T:Microsoft.CodeAnalysis.GeneratorExecutionContext"/> to add source to</param>
<remarks>
This call represents the main generation step. It is called after a <see cref="T:Microsoft.CodeAnalysis.Compilation"/> is
created that contains the user written code.
A generator can use the <see cref="P:Microsoft.CodeAnalysis.GeneratorExecutionContext.Compilation"/> property to
discover information about the users compilation and make decisions on what source to
provide.
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.ISyntaxReceiver">
<summary>
Receives notifications of each <see cref="T:Microsoft.CodeAnalysis.SyntaxNode"/> in the compilation before generation runs
</summary>
<remarks>
A <see cref="T:Microsoft.CodeAnalysis.ISourceGenerator"/> can provide an instance of <see cref="T:Microsoft.CodeAnalysis.ISyntaxReceiver"/>
via a <see cref="T:Microsoft.CodeAnalysis.SyntaxReceiverCreator"/>.
The compiler will invoke the <see cref="T:Microsoft.CodeAnalysis.SyntaxReceiverCreator"/> prior to generation to
obtain an instance of <see cref="T:Microsoft.CodeAnalysis.ISyntaxReceiver"/>. This instance will have its
<see cref="M:Microsoft.CodeAnalysis.ISyntaxReceiver.OnVisitSyntaxNode(Microsoft.CodeAnalysis.SyntaxNode)"/> called for every syntax node in the compilation.
The <see cref="T:Microsoft.CodeAnalysis.ISyntaxReceiver"/> can record any information about the nodes visited. During
<see cref="M:Microsoft.CodeAnalysis.ISourceGenerator.Execute(Microsoft.CodeAnalysis.GeneratorExecutionContext)"/> the generator can obtain the
created instance via the <see cref="P:Microsoft.CodeAnalysis.GeneratorExecutionContext.SyntaxReceiver"/> property. The
information contained can be used to perform final generation.
A new instance of <see cref="T:Microsoft.CodeAnalysis.ISyntaxReceiver"/> is created per-generation, meaning the instance
is free to store state without worrying about lifetime or reuse.
An <see cref="T:Microsoft.CodeAnalysis.ISourceGenerator"/> may provide only a single <see cref="T:Microsoft.CodeAnalysis.ISyntaxReceiver"/> or
<see cref="T:Microsoft.CodeAnalysis.ISyntaxContextReceiver" />, not both.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.ISyntaxReceiver.OnVisitSyntaxNode(Microsoft.CodeAnalysis.SyntaxNode)">
<summary>
Called for each <see cref="T:Microsoft.CodeAnalysis.SyntaxNode"/> in the compilation
</summary>
<param name="syntaxNode">The current <see cref="T:Microsoft.CodeAnalysis.SyntaxNode"/> being visited</param>
</member>
<member name="T:Microsoft.CodeAnalysis.SyntaxReceiverCreator">
<summary>
Allows a generator to provide instances of an <see cref="T:Microsoft.CodeAnalysis.ISyntaxReceiver"/>
</summary>
<returns>An instance of an <see cref="T:Microsoft.CodeAnalysis.ISyntaxReceiver"/></returns>
</member>
<member name="T:Microsoft.CodeAnalysis.ISyntaxContextReceiver">
<summary>
Receives notifications of each <see cref="T:Microsoft.CodeAnalysis.SyntaxNode"/> in the compilation, along with a
<see cref="T:Microsoft.CodeAnalysis.SemanticModel"/> that can be queried to obtain more information, before generation
runs.
</summary>
<remarks>
A <see cref="T:Microsoft.CodeAnalysis.ISourceGenerator"/> can provide an instance of <see cref="T:Microsoft.CodeAnalysis.ISyntaxContextReceiver"/>
via a <see cref="T:Microsoft.CodeAnalysis.SyntaxReceiverCreator"/>.
The compiler will invoke the <see cref="T:Microsoft.CodeAnalysis.SyntaxReceiverCreator"/> prior to generation to
obtain an instance of <see cref="T:Microsoft.CodeAnalysis.ISyntaxContextReceiver"/>. This instance will have its
<see cref="M:Microsoft.CodeAnalysis.ISyntaxContextReceiver.OnVisitSyntaxNode(Microsoft.CodeAnalysis.GeneratorSyntaxContext)"/> called for every syntax node
in the compilation.
The <see cref="T:Microsoft.CodeAnalysis.ISyntaxContextReceiver"/> can record any information about the nodes visited.
During <see cref="M:Microsoft.CodeAnalysis.ISourceGenerator.Execute(Microsoft.CodeAnalysis.GeneratorExecutionContext)"/> the generator can obtain the
created instance via the <see cref="P:Microsoft.CodeAnalysis.GeneratorExecutionContext.SyntaxContextReceiver"/> property. The
information contained can be used to perform final generation.
A new instance of <see cref="T:Microsoft.CodeAnalysis.ISyntaxContextReceiver"/> is created per-generation, meaning the instance
is free to store state without worrying about lifetime or reuse.
An <see cref="T:Microsoft.CodeAnalysis.ISourceGenerator"/> may provide only a single <see cref="T:Microsoft.CodeAnalysis.ISyntaxReceiver"/> or
<see cref="T:Microsoft.CodeAnalysis.ISyntaxContextReceiver" />, not both.
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.SyntaxContextReceiverCreator">
<summary>
Allows a generator to provide instances of an <see cref="T:Microsoft.CodeAnalysis.ISyntaxContextReceiver"/>
</summary>
<returns>An instance of an <see cref="T:Microsoft.CodeAnalysis.ISyntaxContextReceiver"/></returns>
</member>
<member name="T:Microsoft.CodeAnalysis.GeneratorDriverRunResult">
<summary>
Represents the results of running a generation pass over a set of <see cref="T:Microsoft.CodeAnalysis.ISourceGenerator"/>s.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.GeneratorDriverRunResult.Results">
<summary>
The individual result of each <see cref="T:Microsoft.CodeAnalysis.ISourceGenerator"/> that was run in this generator pass, one per generator.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.GeneratorDriverRunResult.Diagnostics">
<summary>
The <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s produced by all generators run during this generation pass.
</summary>
<remarks>
This is equivalent to the union of all <see cref="P:Microsoft.CodeAnalysis.GeneratorRunResult.Diagnostics"/> in <see cref="P:Microsoft.CodeAnalysis.GeneratorDriverRunResult.Results"/>.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.GeneratorDriverRunResult.GeneratedTrees">
<summary>
The <see cref="T:Microsoft.CodeAnalysis.SyntaxTree"/>s produced during this generation pass by parsing each <see cref="T:Microsoft.CodeAnalysis.Text.SourceText"/> added by each generator.
</summary>
<remarks>
This is equivalent to the union of all <see cref="P:Microsoft.CodeAnalysis.GeneratedSourceResult.SyntaxTree"/>s in each <see cref="P:Microsoft.CodeAnalysis.GeneratorRunResult.GeneratedSources"/> in each <see cref="P:Microsoft.CodeAnalysis.GeneratorDriverRunResult.Results"/>
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.GeneratorRunResult">
<summary>
Represents the results of a single <see cref="T:Microsoft.CodeAnalysis.ISourceGenerator"/> generation pass.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.GeneratorRunResult.Generator">
<summary>
The <see cref="T:Microsoft.CodeAnalysis.ISourceGenerator"/> that produced this result.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.GeneratorRunResult.GeneratedSources">
<summary>
The sources that were added by <see cref="P:Microsoft.CodeAnalysis.GeneratorRunResult.Generator"/> during the generation pass this result represents.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.GeneratorRunResult.Diagnostics">
<summary>
A collection of <see cref="T:Microsoft.CodeAnalysis.Diagnostic"/>s reported by <see cref="P:Microsoft.CodeAnalysis.GeneratorRunResult.Generator"/>
</summary>
<remarks>
When generation fails due to an <see cref="P:Microsoft.CodeAnalysis.GeneratorRunResult.Exception"/> being thrown, a single diagnostic is added
to represent the failure. Any generator reported diagnostics up to the failure point are not included.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.GeneratorRunResult.Exception">
<summary>
An <see cref="T:System.Exception"/> instance that was thrown by the generator, or <c>null</c> if the generator completed without error.
</summary>
<remarks>
When this property has a value, <see cref="P:Microsoft.CodeAnalysis.GeneratorRunResult.GeneratedSources"/> property is guaranteed to be empty, and the <see cref="P:Microsoft.CodeAnalysis.GeneratorRunResult.Diagnostics"/>
collection will contain a single diagnostic indicating that the generator failed.
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.GeneratedSourceResult">
<summary>
Represents the results of an <see cref="T:Microsoft.CodeAnalysis.ISourceGenerator"/> calling <see cref="M:Microsoft.CodeAnalysis.GeneratorExecutionContext.AddSource(System.String,Microsoft.CodeAnalysis.Text.SourceText)"/>.
</summary>
<remarks>
This contains the original <see cref="P:Microsoft.CodeAnalysis.GeneratedSourceResult.SourceText"/> added by the generator, along with the parsed representation of that text in <see cref="P:Microsoft.CodeAnalysis.GeneratedSourceResult.SyntaxTree"/>.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.GeneratedSourceResult.SyntaxTree">
<summary>
The <see cref="P:Microsoft.CodeAnalysis.GeneratedSourceResult.SyntaxTree"/> that was produced from parsing the <see cref="P:Microsoft.CodeAnalysis.GeneratedSourceResult.SourceText"/>.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.GeneratedSourceResult.SourceText">
<summary>
The <see cref="P:Microsoft.CodeAnalysis.GeneratedSourceResult.SourceText"/> that was added by the generator.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.GeneratedSourceResult.HintName">
<summary>
An identifier provided by the generator that identifies the added <see cref="P:Microsoft.CodeAnalysis.GeneratedSourceResult.SourceText"/>.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.SyntaxContextReceiverAdaptor">
<summary>
Wraps an <see cref="T:Microsoft.CodeAnalysis.ISyntaxReceiver"/> in an <see cref="T:Microsoft.CodeAnalysis.ISyntaxContextReceiver"/>
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.SpecialType">
<summary>
Specifies the Ids of special runtime types.
</summary>
<remarks>
Only types explicitly mentioned in "Co-located core types" spec
(https://github.com/dotnet/roslyn/blob/master/docs/compilers/Co-located%20core%20types.md)
can be in this enum.
The following things should be in sync:
1) SpecialType enum
2) names in SpecialTypes.EmittedNames array.
</remarks>
</member>
<member name="F:Microsoft.CodeAnalysis.SpecialType.None">
<summary>
Indicates a non-special type (default value).
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SpecialType.System_Object">
<summary>
Indicates that the type is <see cref="T:System.Object"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SpecialType.System_Enum">
<summary>
Indicates that the type is <see cref="T:System.Enum"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SpecialType.System_MulticastDelegate">
<summary>
Indicates that the type is <see cref="T:System.MulticastDelegate"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SpecialType.System_Delegate">
<summary>
Indicates that the type is <see cref="T:System.Delegate"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SpecialType.System_ValueType">
<summary>
Indicates that the type is <see cref="T:System.ValueType"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SpecialType.System_Void">
<summary>
Indicates that the type is <see cref="T:System.Void"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SpecialType.System_Boolean">
<summary>
Indicates that the type is <see cref="T:System.Boolean"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SpecialType.System_Char">
<summary>
Indicates that the type is <see cref="T:System.Char"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SpecialType.System_SByte">
<summary>
Indicates that the type is <see cref="T:System.SByte"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SpecialType.System_Byte">
<summary>
Indicates that the type is <see cref="T:System.Byte"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SpecialType.System_Int16">
<summary>
Indicates that the type is <see cref="T:System.Int16"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SpecialType.System_UInt16">
<summary>
Indicates that the type is <see cref="T:System.UInt16"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SpecialType.System_Int32">
<summary>
Indicates that the type is <see cref="T:System.Int32"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SpecialType.System_UInt32">
<summary>
Indicates that the type is <see cref="T:System.UInt32"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SpecialType.System_Int64">
<summary>
Indicates that the type is <see cref="T:System.Int64"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SpecialType.System_UInt64">
<summary>
Indicates that the type is <see cref="T:System.UInt64"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SpecialType.System_Decimal">
<summary>
Indicates that the type is <see cref="T:System.Decimal"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SpecialType.System_Single">
<summary>
Indicates that the type is <see cref="T:System.Single"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SpecialType.System_Double">
<summary>
Indicates that the type is <see cref="T:System.Double"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SpecialType.System_String">
<summary>
Indicates that the type is <see cref="T:System.String"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SpecialType.System_IntPtr">
<summary>
Indicates that the type is <see cref="T:System.IntPtr" />.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SpecialType.System_UIntPtr">
<summary>
Indicates that the type is <see cref="T:System.UIntPtr"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SpecialType.System_Array">
<summary>
Indicates that the type is <see cref="T:System.Array"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SpecialType.System_Collections_IEnumerable">
<summary>
Indicates that the type is <see cref="T:System.Collections.IEnumerable"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SpecialType.System_Collections_Generic_IEnumerable_T">
<summary>
Indicates that the type is <see cref="T:System.Collections.Generic.IEnumerable`1"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SpecialType.System_Collections_Generic_IList_T">
<summary>
Indicates that the type is <see cref="T:System.Collections.Generic.IList`1"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SpecialType.System_Collections_Generic_ICollection_T">
<summary>
Indicates that the type is <see cref="T:System.Collections.Generic.ICollection`1"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SpecialType.System_Collections_IEnumerator">
<summary>
Indicates that the type is <see cref="T:System.Collections.IEnumerator"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SpecialType.System_Collections_Generic_IEnumerator_T">
<summary>
Indicates that the type is <see cref="T:System.Collections.Generic.IEnumerator`1"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SpecialType.System_Collections_Generic_IReadOnlyList_T">
<summary>
Indicates that the type is <see cref="T:System.Collections.Generic.IReadOnlyList`1"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SpecialType.System_Collections_Generic_IReadOnlyCollection_T">
<summary>
Indicates that the type is <see cref="T:System.Collections.Generic.IReadOnlyCollection`1"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SpecialType.System_Nullable_T">
<summary>
Indicates that the type is <see cref="T:System.Nullable`1"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SpecialType.System_DateTime">
<summary>
Indicates that the type is <see cref="T:System.DateTime"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SpecialType.System_Runtime_CompilerServices_IsVolatile">
<summary>
Indicates that the type is <see cref="T:System.Runtime.CompilerServices.IsVolatile"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SpecialType.System_IDisposable">
<summary>
Indicates that the type is <see cref="T:System.IDisposable"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SpecialType.System_TypedReference">
<summary>
Indicates that the type is <see cref="T:System.TypedReference"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SpecialType.System_ArgIterator">
<summary>
Indicates that the type is <see cref="T:System.ArgIterator"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SpecialType.System_RuntimeArgumentHandle">
<summary>
Indicates that the type is <see cref="T:System.RuntimeArgumentHandle"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SpecialType.System_RuntimeFieldHandle">
<summary>
Indicates that the type is <see cref="T:System.RuntimeFieldHandle"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SpecialType.System_RuntimeMethodHandle">
<summary>
Indicates that the type is <see cref="T:System.RuntimeMethodHandle"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SpecialType.System_RuntimeTypeHandle">
<summary>
Indicates that the type is <see cref="T:System.RuntimeTypeHandle"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SpecialType.System_IAsyncResult">
<summary>
Indicates that the type is <see cref="T:System.IAsyncResult"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SpecialType.System_AsyncCallback">
<summary>
Indicates that the type is <see cref="T:System.AsyncCallback"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SpecialType.System_Runtime_CompilerServices_RuntimeFeature">
<summary>
Indicates that the type is System.Runtime.CompilerServices.RuntimeFeature.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SpecialType.System_Runtime_CompilerServices_PreserveBaseOverridesAttribute">
<summary>
An attribute that is placed on each method with a 'methodimpl" aka ".override" in metadata.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SpecialType.Count">
<summary>
Count of special types. This is not a count of enum members.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SpecialTypeExtensions.IsClrInteger(Microsoft.CodeAnalysis.SpecialType)">
<summary>
Checks if a type is considered a "built-in integral" by CLR.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SpecialTypeExtensions.IsBlittable(Microsoft.CodeAnalysis.SpecialType)">
<summary>
Checks if a type is a primitive of a fixed size.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SpecialTypeExtensions.IsPrimitiveRecursiveStruct(Microsoft.CodeAnalysis.SpecialType)">
<summary>
These special types are structs that contain fields of the same type
(e.g. System.Int32 contains a field of type System.Int32).
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SpecialTypeExtensions.IsIntegralType(Microsoft.CodeAnalysis.SpecialType)">
<summary>
Checks if a type is considered a "built-in integral" by CLR.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SpecialTypeExtensions.VBForToShiftBits(Microsoft.CodeAnalysis.SpecialType)">
<summary>
For signed integer types return number of bits for their representation minus 1.
I.e. 7 for Int8, 31 for Int32, etc.
Used for checking loop end condition for VB for loop.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SpecialTypes.s_emittedNames">
<summary>
Array of names for types from Cor Library.
The names should correspond to ids from TypeId enum so
that we could use ids to index into the array
</summary>
<remarks></remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.SpecialTypes.GetMetadataName(Microsoft.CodeAnalysis.SpecialType)">
<summary>
Gets the name of the special type as it would appear in metadata.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CryptoBlobParser.TryParseKey(System.Collections.Immutable.ImmutableArray{System.Byte},System.Collections.Immutable.ImmutableArray{System.Byte}@,System.Nullable{System.Security.Cryptography.RSAParameters}@)">
<summary>
Try to retrieve the public key from a crypto blob.
</summary>
<remarks>
Can be either a PUBLICKEYBLOB or PRIVATEKEYBLOB. The BLOB must be unencrypted.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.CryptoBlobParser.ToRSAParameters(System.ReadOnlySpan{System.Byte},System.Boolean)">
<summary>
Helper for RsaCryptoServiceProvider.ExportParameters()
Copied from https://github.com/dotnet/corefx/blob/5fe5f9aae7b2987adc7082f90712b265bee5eefc/src/System.Security.Cryptography.Csp/src/System/Security/Cryptography/CapiHelper.Shared.cs
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CryptoBlobParser.ExponentAsBytes(System.UInt32)">
<summary>
Helper for converting a UInt32 exponent to bytes.
Copied from https://github.com/dotnet/corefx/blob/5fe5f9aae7b2987adc7082f90712b265bee5eefc/src/System.Security.Cryptography.Csp/src/System/Security/Cryptography/CapiHelper.Shared.cs
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CryptoBlobParser.ReadReversed(System.IO.BinaryReader,System.Int32)">
<summary>
Read in a byte array in reverse order.
Copied from https://github.com/dotnet/corefx/blob/5fe5f9aae7b2987adc7082f90712b265bee5eefc/src/System.Security.Cryptography.Csp/src/System/Security/Cryptography/CapiHelper.Shared.cs
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.DesktopStrongNameProvider">
<summary>
Provides strong name and signs source assemblies.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.DesktopStrongNameProvider.#ctor(System.Collections.Immutable.ImmutableArray{System.String},System.String)">
<summary>
Creates an instance of <see cref="T:Microsoft.CodeAnalysis.DesktopStrongNameProvider"/>.
</summary>
<param name="tempPath">Path to use for any temporary file generation.</param>
<param name="keyFileSearchPaths">An ordered set of fully qualified paths which are searched when locating a cryptographic key file.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.DesktopStrongNameProvider.ResolveStrongNameKeyFile(System.String,Microsoft.CodeAnalysis.StrongNameFileSystem,System.Collections.Immutable.ImmutableArray{System.String})">
<summary>
Resolves assembly strong name key file path.
</summary>
<returns>Normalized key file path or null if not found.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.DesktopStrongNameProvider.Sign(System.String,System.String)">
<exception cref="T:System.IO.IOException"/>
</member>
<member name="T:Microsoft.CodeAnalysis.StrongNameFileSystem">
<summary>
This is an abstraction over the file system which allows for us to do more thorough unit testing.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.StrongNameKeys.KeyPair">
<summary>
The strong name key associated with the identity of this assembly.
This contains the contents of the user-supplied key file exactly as extracted.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.StrongNameKeys.PublicKey">
<summary>
Determines source assembly identity.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.StrongNameKeys.PrivateKey">
<summary>
The Private key information that will exist if it was a private key file that was parsed.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.StrongNameKeys.DiagnosticOpt">
<summary>
A diagnostic created in the process of determining the key.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.StrongNameKeys.KeyContainer">
<summary>
The CSP key container containing the public key used to produce the key,
or null if the key was retrieved from <see cref="F:Microsoft.CodeAnalysis.StrongNameKeys.KeyFilePath"/>.
</summary>
<remarks>
The original value as specified by <see cref="T:System.Reflection.AssemblyKeyNameAttribute"/> or
<see cref="P:Microsoft.CodeAnalysis.CompilationOptions.CryptoKeyContainer"/>.
</remarks>
</member>
<member name="F:Microsoft.CodeAnalysis.StrongNameKeys.KeyFilePath">
<summary>
Original key file path, or null if the key is provided by the <see cref="F:Microsoft.CodeAnalysis.StrongNameKeys.KeyContainer"/>.
</summary>
<remarks>
The original value as specified by <see cref="T:System.Reflection.AssemblyKeyFileAttribute"/> or
<see cref="P:Microsoft.CodeAnalysis.CompilationOptions.CryptoKeyFile"/>
</remarks>
</member>
<member name="F:Microsoft.CodeAnalysis.StrongNameKeys.HasCounterSignature">
<summary>
True when the assembly contains a <see cref="T:System.Reflection.AssemblySignatureKeyAttribute"/> value
and hence signing requires counter signature verification.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.StrongNameKeys.CanSign">
<summary>
True if the compilation can be signed using these keys.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.StrongNameKeys.CanProvideStrongName">
<summary>
True if a strong name can be created for the compilation using these keys.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.StrongNameProvider">
<summary>
Provides strong name and signs source assemblies.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.StrongNameProvider.SignFile(Microsoft.CodeAnalysis.StrongNameKeys,System.String)">
<summary>
Signs the <paramref name="filePath"/> value using <paramref name="keys"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.StrongNameProvider.SignBuilder(Microsoft.Cci.ExtendedPEBuilder,System.Reflection.Metadata.BlobBuilder,System.Security.Cryptography.RSAParameters)">
<summary>
Signs the contents of <paramref name="peBlob"/> using <paramref name="peBuilder"/> and <paramref name="privateKey"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.StrongNameProvider.CreateKeys(System.String,System.String,System.Boolean,Microsoft.CodeAnalysis.CommonMessageProvider)">
<summary>
Create a <see cref="T:Microsoft.CodeAnalysis.StrongNameKeys"/> for the provided information.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.SwitchConstantValueHelper">
<summary>
Contains helper methods for switch statement label constants
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SwitchConstantValueHelper.CompareSwitchCaseLabelConstants(Microsoft.CodeAnalysis.ConstantValue,Microsoft.CodeAnalysis.ConstantValue)">
<summary>
Method used to compare ConstantValues for switch statement case labels
</summary>
<param name="first"></param>
<param name="second"></param>
<returns>A value that indicates the relative order of the objects being compared. The return value has these meanings:
Less than zero: first instance precedes second in the sort order.
Zero: first instance occurs in the same position in the sort order as second.
Greater than zero: first instance follows second in the sort order.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SymbolDisplay.AbstractSymbolDisplayVisitor.AddNonNullConstantValue(Microsoft.CodeAnalysis.ITypeSymbol,System.Object,System.Boolean)">
<summary>
Append a default argument (i.e. the default argument of an optional parameter).
Assumed to be non-null.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SymbolDisplay.AbstractSymbolDisplayVisitor.IsFlagsEnum(Microsoft.CodeAnalysis.ITypeSymbol)">
<summary>
Check if the given type is an enum with System.FlagsAttribute.
</summary>
<remarks>
TODO: Can/should this be done using WellKnownAttributes?
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.FormattedSymbol">
<summary>
This class associates a symbol with particular format for display.
It can be passed as an argument for an error message in place where symbol display should go,
which allows to defer building strings and doing many other things (like loading metadata)
associated with that until the error message is actually requested.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.ObjectDisplayExtensions.IncludesOption(Microsoft.CodeAnalysis.ObjectDisplayOptions,Microsoft.CodeAnalysis.ObjectDisplayOptions)">
<summary>
Determines if a flag is set on the <see cref="T:Microsoft.CodeAnalysis.ObjectDisplayOptions"/> enum.
</summary>
<param name="options">The value to check.</param>
<param name="flag">An enum field that specifies the flag.</param>
<returns>Whether the <paramref name="flag"/> is set on the <paramref name="options"/>.</returns>
</member>
<member name="T:Microsoft.CodeAnalysis.ObjectDisplayOptions">
<summary>
Specifies the options for how generics are displayed in the description of a symbol.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.ObjectDisplayOptions.None">
<summary>
Format object using default options.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.ObjectDisplayOptions.IncludeCodePoints">
<summary>
In C#, include the numeric code point before character literals.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.ObjectDisplayOptions.IncludeTypeSuffix">
<summary>
Whether or not to include type suffix for applicable integral literals.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.ObjectDisplayOptions.UseHexadecimalNumbers">
<summary>
Whether or not to display integral literals in hexadecimal.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.ObjectDisplayOptions.UseQuotes">
<summary>
Whether or not to quote character and string literals.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.ObjectDisplayOptions.EscapeNonPrintableCharacters">
<summary>
In C#, replace non-printable (e.g. control) characters with dedicated (e.g. \t) or unicode (\u0001) escape sequences.
In Visual Basic, replace non-printable characters with calls to ChrW and vb* constants.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayCompilerInternalOptions.None">
<summary>
None
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayCompilerInternalOptions.UseMetadataMethodNames">
<summary>
".ctor" instead of "Goo"
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayCompilerInternalOptions.UseArityForGenericTypes">
<summary>
"List`1" instead of "List<T>" ("List(of T)" in VB). Overrides GenericsOptions on
types.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayCompilerInternalOptions.FlagMissingMetadataTypes">
<summary>
Append "[Missing]" to missing Metadata types (for testing).
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayCompilerInternalOptions.IncludeScriptType">
<summary>
Include the Script type when qualifying type names.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayCompilerInternalOptions.IncludeCustomModifiers">
<summary>
Include custom modifiers (e.g. modopt([mscorlib]System.Runtime.CompilerServices.IsConst)) on
the member (return) type and parameters.
</summary>
<remarks>
CONSIDER: custom modifiers are part of the public API, so we might want to move this to SymbolDisplayMemberOptions.
</remarks>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayCompilerInternalOptions.ReverseArrayRankSpecifiers">
<summary>
For a type written as "int[][,]" in C#, then
a) setting this option will produce "int[,][]", and
b) not setting this option will produce "int[][,]".
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayCompilerInternalOptions.UseValueTuple">
<summary>
Display `System.ValueTuple` instead of tuple syntax `(...)`.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayCompilerInternalOptions.UseNativeIntegerUnderlyingType">
<summary>
Display `System.[U]IntPtr` instead of `n[u]int`.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.SymbolDisplayDelegateStyle">
<summary>
Specifies how to display delegates (just the name or the name with the signature).
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayDelegateStyle.NameOnly">
<summary>
Shows only the name of the delegate (e.g. "SomeDelegate").
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayDelegateStyle.NameAndParameters">
<summary>
Shows the name and the parameters of the delegate (e.g. "SomeDelegate(int x)").
</summary>
<remarks>
The format of the parameters will be determined by the other flags passed.
</remarks>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayDelegateStyle.NameAndSignature">
<summary>
Shows the name and the signature of the delegate (e.g. "void SomeDelegate(int x)").
</summary>
<remarks>
The format of the signature will be determined by the other flags passed.
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.SymbolDisplayExtensionMethodStyle">
<summary>
Specifies how to display extension methods.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayExtensionMethodStyle.Default">
<summary>
Displays the extension method based on its <see cref="T:Microsoft.CodeAnalysis.MethodKind"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayExtensionMethodStyle.InstanceMethod">
<summary>
Displays the extension method in the form of an instance method.
For example, IEnumerable<TSource>.ElementAt<TSource>(int index).
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayExtensionMethodStyle.StaticMethod">
<summary>
Displays the extension method as a static method.
For example, Enumerable.ElementAt<TSource>(this IEnumerable<TSource> source, int index).
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.SymbolDisplayExtensions">
<summary>
Exposes extension methods for displaying symbol descriptions.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SymbolDisplayExtensions.ToDisplayString(System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.SymbolDisplayPart})">
<summary>
Converts an immutable array of <see cref="T:Microsoft.CodeAnalysis.SymbolDisplayPart"/>s to a string.
</summary>
<param name="parts">The array of parts.</param>
<returns>The concatenation of the parts into a single string.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SymbolDisplayExtensions.IncludesOption(Microsoft.CodeAnalysis.SymbolDisplayCompilerInternalOptions,Microsoft.CodeAnalysis.SymbolDisplayCompilerInternalOptions)">
<summary>
Determines if a flag is set on the <see cref="T:Microsoft.CodeAnalysis.SymbolDisplayCompilerInternalOptions"/> enum.
</summary>
<param name="options">The value to check.</param>
<param name="flag">An enum field that specifies the flag.</param>
<returns>Whether the <paramref name="flag"/> is set on the <paramref name="options"/>.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SymbolDisplayExtensions.IncludesOption(Microsoft.CodeAnalysis.SymbolDisplayGenericsOptions,Microsoft.CodeAnalysis.SymbolDisplayGenericsOptions)">
<summary>
Determines if a flag is set on the <see cref="T:Microsoft.CodeAnalysis.SymbolDisplayGenericsOptions"/> enum.
</summary>
<param name="options">The value to check.</param>
<param name="flag">An enum field that specifies the flag.</param>
<returns>Whether the <paramref name="flag"/> is set on the <paramref name="options"/>.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SymbolDisplayExtensions.IncludesOption(Microsoft.CodeAnalysis.SymbolDisplayMemberOptions,Microsoft.CodeAnalysis.SymbolDisplayMemberOptions)">
<summary>
Determines if a flag is set on the <see cref="T:Microsoft.CodeAnalysis.SymbolDisplayMemberOptions"/> enum.
</summary>
<param name="options">The value to check.</param>
<param name="flag">An enum field that specifies the flag.</param>
<returns>Whether the <paramref name="flag"/> is set on the <paramref name="options"/>.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SymbolDisplayExtensions.IncludesOption(Microsoft.CodeAnalysis.SymbolDisplayMiscellaneousOptions,Microsoft.CodeAnalysis.SymbolDisplayMiscellaneousOptions)">
<summary>
Determines if a flag is set on the <see cref="T:Microsoft.CodeAnalysis.SymbolDisplayMiscellaneousOptions"/> enum.
</summary>
<param name="options">The value to check.</param>
<param name="flag">An enum field that specifies the flag.</param>
<returns>Whether the <paramref name="flag"/> is set on the <paramref name="options"/>.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SymbolDisplayExtensions.IncludesOption(Microsoft.CodeAnalysis.SymbolDisplayParameterOptions,Microsoft.CodeAnalysis.SymbolDisplayParameterOptions)">
<summary>
Determines if a flag is set on the <see cref="T:Microsoft.CodeAnalysis.SymbolDisplayParameterOptions"/> enum.
</summary>
<param name="options">The value to check.</param>
<param name="flag">An enum field that specifies the flag.</param>
<returns>Whether the <paramref name="flag"/> is set on the <paramref name="options"/>.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SymbolDisplayExtensions.IncludesOption(Microsoft.CodeAnalysis.SymbolDisplayKindOptions,Microsoft.CodeAnalysis.SymbolDisplayKindOptions)">
<summary>
Determines if a flag is set on the <see cref="T:Microsoft.CodeAnalysis.SymbolDisplayKindOptions"/> enum.
</summary>
<param name="options">The value to check.</param>
<param name="flag">An enum field that specifies the flag.</param>
<returns>Whether the <paramref name="flag"/> is set on the <paramref name="options"/>.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SymbolDisplayExtensions.IncludesOption(Microsoft.CodeAnalysis.SymbolDisplayLocalOptions,Microsoft.CodeAnalysis.SymbolDisplayLocalOptions)">
<summary>
Determines if a flag is set on the <see cref="T:Microsoft.CodeAnalysis.SymbolDisplayLocalOptions"/> enum.
</summary>
<param name="options">The value to check.</param>
<param name="flag">An enum field that specifies the flag.</param>
<returns>Whether the <paramref name="flag"/> is set on the <paramref name="options"/>.</returns>
</member>
<member name="T:Microsoft.CodeAnalysis.SymbolDisplayFormat">
<summary>
Describes the formatting rules that should be used when displaying symbols.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SymbolDisplayFormat.CSharpErrorMessageFormat">
<summary>
Formats a symbol description as in a C# compiler error message.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SymbolDisplayFormat.CSharpShortErrorMessageFormat">
<summary>
Formats a symbol description as in a C# compiler short error message.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SymbolDisplayFormat.VisualBasicErrorMessageFormat">
<summary>
Formats a symbol description as in a Visual Basic compiler error message.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SymbolDisplayFormat.VisualBasicShortErrorMessageFormat">
<summary>
Formats a symbol description as in a Visual Basic compiler short error message.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SymbolDisplayFormat.FullyQualifiedFormat">
<summary>
Formats the names of all types and namespaces in a fully qualified style (including the global alias).
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SymbolDisplayFormat.MinimallyQualifiedFormat">
<summary>
Formats a symbol description in a form that suits <see cref="M:Microsoft.CodeAnalysis.ISymbol.ToMinimalDisplayString(Microsoft.CodeAnalysis.SemanticModel,System.Int32,Microsoft.CodeAnalysis.SymbolDisplayFormat)"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayFormat.TestFormat">
<summary>
A verbose format for displaying symbols (useful for testing).
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayFormat.TestFormatWithConstraints">
<summary>
A verbose format for displaying symbols (useful for testing).
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayFormat.QualifiedNameOnlyFormat">
<summary>
this.QualifiedNameOnly = containingSymbol.QualifiedNameOnly + "." + this.Name
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayFormat.QualifiedNameArityFormat">
<summary>
this.QualifiedNameArity = containingSymbol.QualifiedNameArity + "." + this.Name + "`" + this.Arity
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayFormat.ShortFormat">
<summary>
A succinct format for displaying symbols.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayFormat.ILVisualizationFormat">
<summary>
The format used for displaying symbols when visualizing IL.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayFormat.ExplicitInterfaceImplementationFormat">
<summary>
Used to normalize explicit interface implementation member names.
Only expected to be applied to interface types (and their type arguments).
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SymbolDisplayFormat.GlobalNamespaceStyle">
<summary>
Determines how the global namespace is displayed.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SymbolDisplayFormat.TypeQualificationStyle">
<summary>
Determines how types are qualified (e.g. Nested vs Containing.Nested vs Namespace.Containing.Nested).
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SymbolDisplayFormat.GenericsOptions">
<summary>
Determines how generics (on types and methods) should be described (i.e. the level of detail).
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SymbolDisplayFormat.MemberOptions">
<summary>
Determines how fields, properties, events, and methods are displayed.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SymbolDisplayFormat.ParameterOptions">
<summary>
Determines how parameters (of methods, properties/indexers, and delegates) are displayed.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SymbolDisplayFormat.DelegateStyle">
<summary>
Determines how delegates are displayed (e.g. name vs full signature).
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SymbolDisplayFormat.ExtensionMethodStyle">
<summary>
Determines how extension methods are displayed.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SymbolDisplayFormat.PropertyStyle">
<summary>
Determines how properties are displayed.
For example, "Prop" vs "Prop { get; set; }" in C# or "Prop" vs. "ReadOnly Prop" in Visual Basic.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SymbolDisplayFormat.LocalOptions">
<summary>
Determines how local variables are displayed.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SymbolDisplayFormat.KindOptions">
<summary>
Determines which kind keywords should be included when displaying symbols.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SymbolDisplayFormat.MiscellaneousOptions">
<summary>
Determines other characteristics of how symbols are displayed.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SymbolDisplayFormat.CompilerInternalOptions">
<summary>
Flags that can only be set within the compiler.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SymbolDisplayFormat.#ctor(Microsoft.CodeAnalysis.SymbolDisplayGlobalNamespaceStyle,Microsoft.CodeAnalysis.SymbolDisplayTypeQualificationStyle,Microsoft.CodeAnalysis.SymbolDisplayGenericsOptions,Microsoft.CodeAnalysis.SymbolDisplayMemberOptions,Microsoft.CodeAnalysis.SymbolDisplayDelegateStyle,Microsoft.CodeAnalysis.SymbolDisplayExtensionMethodStyle,Microsoft.CodeAnalysis.SymbolDisplayParameterOptions,Microsoft.CodeAnalysis.SymbolDisplayPropertyStyle,Microsoft.CodeAnalysis.SymbolDisplayLocalOptions,Microsoft.CodeAnalysis.SymbolDisplayKindOptions,Microsoft.CodeAnalysis.SymbolDisplayMiscellaneousOptions)">
<summary>
Constructs a new instance of <see cref="T:Microsoft.CodeAnalysis.SymbolDisplayFormat"/> accepting a variety of optional parameters.
</summary>
<param name="globalNamespaceStyle">
The settings that determine how the global namespace is displayed.
</param>
<param name="typeQualificationStyle">
The settings that determine how types are qualified (e.g. Nested vs Containing.Nested vs Namespace.Containing.Nested).
</param>
<param name="genericsOptions">
The settings that determine how generics (on types and methods) should be described (i.e. the level of detail).
</param>
<param name="memberOptions">
The settings that determine how fields, properties, events, and methods are displayed.
</param>
<param name="delegateStyle">
The settings that determine how delegates are displayed (e.g. name vs full signature).
</param>
<param name="extensionMethodStyle">
The settings that determine how extension methods are displayed.
</param>
<param name="parameterOptions">
The settings that determine how parameters (of methods, properties/indexers, and delegates) are displayed.
</param>
<param name="propertyStyle">
The settings that determine how properties are displayed.
For example, "Prop" vs "Prop { get; set; }" in C# or "Prop" vs. "ReadOnly Prop" in Visual Basic.
</param>
<param name="localOptions">
The settings that determine how local variables are displayed.
</param>
<param name="kindOptions">
The settings that determine which kind keywords should be included when displaying symbols.
</param>
<param name="miscellaneousOptions">
The settings that determine other characteristics of how symbols are displayed.
</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SymbolDisplayFormat.#ctor(Microsoft.CodeAnalysis.SymbolDisplayCompilerInternalOptions,Microsoft.CodeAnalysis.SymbolDisplayGlobalNamespaceStyle,Microsoft.CodeAnalysis.SymbolDisplayTypeQualificationStyle,Microsoft.CodeAnalysis.SymbolDisplayGenericsOptions,Microsoft.CodeAnalysis.SymbolDisplayMemberOptions,Microsoft.CodeAnalysis.SymbolDisplayParameterOptions,Microsoft.CodeAnalysis.SymbolDisplayDelegateStyle,Microsoft.CodeAnalysis.SymbolDisplayExtensionMethodStyle,Microsoft.CodeAnalysis.SymbolDisplayPropertyStyle,Microsoft.CodeAnalysis.SymbolDisplayLocalOptions,Microsoft.CodeAnalysis.SymbolDisplayKindOptions,Microsoft.CodeAnalysis.SymbolDisplayMiscellaneousOptions)">
<summary>
This version also accepts <see cref="T:Microsoft.CodeAnalysis.SymbolDisplayCompilerInternalOptions"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SymbolDisplayFormat.WithMiscellaneousOptions(Microsoft.CodeAnalysis.SymbolDisplayMiscellaneousOptions)">
<summary>
Creates a copy of the SymbolDisplayFormat but with replaced set of <seealso cref="T:Microsoft.CodeAnalysis.SymbolDisplayMiscellaneousOptions"/>.
</summary>
<param name="options">
An object representing how miscellaneous symbols will be formatted.
</param>
<returns>A duplicate of the SymbolDisplayFormat, with a replaced set of <seealso cref="T:Microsoft.CodeAnalysis.SymbolDisplayMiscellaneousOptions"/>.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SymbolDisplayFormat.AddMiscellaneousOptions(Microsoft.CodeAnalysis.SymbolDisplayMiscellaneousOptions)">
<summary>
Creates a copy of the SymbolDisplayFormat but with an additional set of <seealso cref="T:Microsoft.CodeAnalysis.SymbolDisplayMiscellaneousOptions"/>.
</summary>
<param name="options">
An object specifying additional parameters for how miscellaneous symbols will be formatted.
</param>
<returns>A duplicate of the SymbolDisplayFormat, with an additional set of <seealso cref="T:Microsoft.CodeAnalysis.SymbolDisplayMiscellaneousOptions"/>.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SymbolDisplayFormat.RemoveMiscellaneousOptions(Microsoft.CodeAnalysis.SymbolDisplayMiscellaneousOptions)">
<summary>
Creates a copy of the SymbolDisplayFormat without the specified <seealso cref="T:Microsoft.CodeAnalysis.SymbolDisplayMiscellaneousOptions"/>.
</summary>
<param name="options">
An object specifying which parameters should not be applied to how miscellaneous symbols will be formatted.
</param>
<returns>A duplicate of the SymbolDisplayFormat, without the specified <seealso cref="T:Microsoft.CodeAnalysis.SymbolDisplayMiscellaneousOptions"/>.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SymbolDisplayFormat.WithGenericsOptions(Microsoft.CodeAnalysis.SymbolDisplayGenericsOptions)">
<summary>
Creates a copy of the SymbolDisplayFormat but with replaced set of <seealso cref="T:Microsoft.CodeAnalysis.SymbolDisplayGenericsOptions"/>.
</summary>
<param name="options">
An object specifying how generic symbols will be formatted.
</param>
<returns>A duplicate of the SymbolDisplayFormat, with a replaced set of <seealso cref="T:Microsoft.CodeAnalysis.SymbolDisplayGenericsOptions"/>.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SymbolDisplayFormat.AddGenericsOptions(Microsoft.CodeAnalysis.SymbolDisplayGenericsOptions)">
<summary>
Creates a copy of the SymbolDisplayFormat but with an additional set of <seealso cref="T:Microsoft.CodeAnalysis.SymbolDisplayGenericsOptions"/>.
</summary>
<param name="options">
An object specifying additional parameters for how generic symbols will be formatted.
</param>
<returns>A duplicate of the SymbolDisplayFormat, with an additional set of <seealso cref="T:Microsoft.CodeAnalysis.SymbolDisplayGenericsOptions"/>.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SymbolDisplayFormat.RemoveGenericsOptions(Microsoft.CodeAnalysis.SymbolDisplayGenericsOptions)">
<summary>
Creates a copy of the SymbolDisplayFormat but with a set of <seealso cref="T:Microsoft.CodeAnalysis.SymbolDisplayGenericsOptions"/> stripped away from the original object.
</summary>
<param name="options">
An object specifying which parameters should not be applied to how generic symbols will be formatted.
</param>
<returns>
A duplicate of the SymbolDisplayFormat, with a set of <seealso cref="T:Microsoft.CodeAnalysis.SymbolDisplayGenericsOptions"/> stripped away from the original object.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SymbolDisplayFormat.WithMemberOptions(Microsoft.CodeAnalysis.SymbolDisplayMemberOptions)">
<summary>
Creates a copy of the SymbolDisplayFormat but with replaced set of <seealso cref="T:Microsoft.CodeAnalysis.SymbolDisplayMemberOptions"/>.
</summary>
<param name="options">
An object specifying how members will be formatted.
</param>
<returns>A duplicate of the SymbolDisplayFormat, with a replaced set of <seealso cref="T:Microsoft.CodeAnalysis.SymbolDisplayMemberOptions"/>.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SymbolDisplayFormat.AddMemberOptions(Microsoft.CodeAnalysis.SymbolDisplayMemberOptions)">
<summary>
Creates a copy of the SymbolDisplayFormat but with an additional set of <seealso cref="T:Microsoft.CodeAnalysis.SymbolDisplayMemberOptions"/>.
</summary>
<param name="options">
An object specifying additional parameters for how members will be formatted.
</param>
<returns>
A duplicate of the SymbolDisplayFormat, with an additional set of <seealso cref="T:Microsoft.CodeAnalysis.SymbolDisplayMemberOptions"/>.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SymbolDisplayFormat.RemoveMemberOptions(Microsoft.CodeAnalysis.SymbolDisplayMemberOptions)">
<summary>
Creates a copy of the SymbolDisplayFormat but with a set of <seealso cref="T:Microsoft.CodeAnalysis.SymbolDisplayMemberOptions"/> stripped away from the original object.
</summary>
<param name="options">
An object specifying which parameters should not be applied to how members will be formatted.
</param>
<returns>
A duplicate of the SymbolDisplayFormat, with a set of <seealso cref="T:Microsoft.CodeAnalysis.SymbolDisplayMemberOptions"/> stripped away from the original object.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SymbolDisplayFormat.WithKindOptions(Microsoft.CodeAnalysis.SymbolDisplayKindOptions)">
<summary>
Creates a copy of the SymbolDisplayFormat but with replaced set of <seealso cref="T:Microsoft.CodeAnalysis.SymbolDisplayKindOptions"/>.
</summary>
<param name="options">
An object specifying parameters with which symbols belonging to kind keywords should be formatted.
</param>
<returns>
A duplicate of the SymbolDisplayFormat, with a replaced set of <seealso cref="T:Microsoft.CodeAnalysis.SymbolDisplayKindOptions"/>.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SymbolDisplayFormat.AddKindOptions(Microsoft.CodeAnalysis.SymbolDisplayKindOptions)">
<summary>
Creates a copy of the SymbolDisplayFormat but with an additional set of <seealso cref="T:Microsoft.CodeAnalysis.SymbolDisplayKindOptions"/>.
</summary>
<param name="options">
An object specifying additional parameters with which symbols belonging to kind keywords should be formatted.
</param>
<returns>
A duplicate of the SymbolDisplayFormat, with an additional set of <seealso cref="T:Microsoft.CodeAnalysis.SymbolDisplayKindOptions"/>.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SymbolDisplayFormat.RemoveKindOptions(Microsoft.CodeAnalysis.SymbolDisplayKindOptions)">
<summary>
Creates a copy of the SymbolDisplayFormat but with a set of <seealso cref="T:Microsoft.CodeAnalysis.SymbolDisplayKindOptions"/> stripped away from the original object.
</summary>
<param name="options">
The settings that determine other characteristics of how symbols are displayed.
</param>
<returns>
A duplicate of the SymbolDisplayFormat, with a set of <seealso cref="T:Microsoft.CodeAnalysis.SymbolDisplayKindOptions"/> stripped away from the original object.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SymbolDisplayFormat.WithParameterOptions(Microsoft.CodeAnalysis.SymbolDisplayParameterOptions)">
<summary>
Creates a copy of the SymbolDisplayFormat but with replaced set of <seealso cref="T:Microsoft.CodeAnalysis.SymbolDisplayParameterOptions"/>.
</summary>
<param name="options">
An object specifying how parameters should be formatted.
</param>
<returns>A duplicate of the SymbolDisplayFormat, with a replaced set of <seealso cref="T:Microsoft.CodeAnalysis.SymbolDisplayParameterOptions"/>.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SymbolDisplayFormat.AddParameterOptions(Microsoft.CodeAnalysis.SymbolDisplayParameterOptions)">
<summary>
Creates a copy of the SymbolDisplayFormat but with an additional set of <seealso cref="T:Microsoft.CodeAnalysis.SymbolDisplayParameterOptions"/>.
</summary>
<param name="options">
An object specifying additional parameters on how parameters should be formatted.
</param>
<returns>
A duplicate of the SymbolDisplayFormat, with an additional set of <seealso cref="T:Microsoft.CodeAnalysis.SymbolDisplayParameterOptions"/>.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SymbolDisplayFormat.RemoveParameterOptions(Microsoft.CodeAnalysis.SymbolDisplayParameterOptions)">
<summary>
Creates a copy of the SymbolDisplayFormat but with a set of <seealso cref="T:Microsoft.CodeAnalysis.SymbolDisplayParameterOptions"/> stripped away from the original object.
</summary>
<param name="options">
An object specifying parameters that should not be applied when formatting parameters.
</param>
<returns>
A duplicate of the SymbolDisplayFormat, with a set of <seealso cref="T:Microsoft.CodeAnalysis.SymbolDisplayParameterOptions"/> stripped away from the original object.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SymbolDisplayFormat.WithGlobalNamespaceStyle(Microsoft.CodeAnalysis.SymbolDisplayGlobalNamespaceStyle)">
<summary>
Creates a copy of the SymbolDisplayFormat but with replaced <seealso cref="T:Microsoft.CodeAnalysis.SymbolDisplayGlobalNamespaceStyle"/>.
</summary>
<param name="style">
An object specifying parameters on how namespace symbols should be formatted.
</param>
<returns>A duplicate of the SymbolDisplayFormat, with a replaced set of <seealso cref="T:Microsoft.CodeAnalysis.SymbolDisplayGlobalNamespaceStyle"/>.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SymbolDisplayFormat.WithLocalOptions(Microsoft.CodeAnalysis.SymbolDisplayLocalOptions)">
<summary>
Creates a copy of the SymbolDisplayFormat but with replaced set of <seealso cref="T:Microsoft.CodeAnalysis.SymbolDisplayLocalOptions"/>.
</summary>
<param name="options">
An object specifying parameters on how symbols belonging to locals should be formatted.
</param>
<returns>A duplicate of the SymbolDisplayFormat, with a replaced set of <seealso cref="T:Microsoft.CodeAnalysis.SymbolDisplayLocalOptions"/>.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SymbolDisplayFormat.AddLocalOptions(Microsoft.CodeAnalysis.SymbolDisplayLocalOptions)">
<summary>
Creates a copy of the SymbolDisplayFormat but with an additional set of <seealso cref="T:Microsoft.CodeAnalysis.SymbolDisplayLocalOptions"/>.
</summary>
<param name="options">
An object specifying additional parameters on how symbols belonging to locals should be formatted.
</param>
<returns>
A duplicate of the SymbolDisplayFormat, with an additional set of <seealso cref="T:Microsoft.CodeAnalysis.SymbolDisplayLocalOptions"/>.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SymbolDisplayFormat.RemoveLocalOptions(Microsoft.CodeAnalysis.SymbolDisplayLocalOptions)">
<summary>
Creates a copy of the SymbolDisplayFormat but with a set of <seealso cref="T:Microsoft.CodeAnalysis.SymbolDisplayLocalOptions"/> stripped away from the original object.
</summary>
<param name="options">
An object specifying parameters that should not be applied when formatting symbols belonging to locals.
</param>
<returns>
A duplicate of the SymbolDisplayFormat, with a set of <seealso cref="T:Microsoft.CodeAnalysis.SymbolDisplayLocalOptions"/> stripped away from the original object.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SymbolDisplayFormat.WithCompilerInternalOptions(Microsoft.CodeAnalysis.SymbolDisplayCompilerInternalOptions)">
<summary>
Creates a copy of the SymbolDisplayFormat but with replaced set of <seealso cref="T:Microsoft.CodeAnalysis.SymbolDisplayCompilerInternalOptions"/>.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.SymbolDisplayGenericsOptions">
<summary>
Specifies the options for how generics are displayed in the description of a symbol.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayGenericsOptions.None">
<summary>
Omits the type parameter list entirely.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayGenericsOptions.IncludeTypeParameters">
<summary>
Includes the type parameters.
For example, "Goo<T>" in C# or "Goo(Of T)" in Visual Basic.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayGenericsOptions.IncludeTypeConstraints">
<summary>
Includes type parameters and constraints.
For example, "where T : new()" in C# or "Of T as New" in Visual Basic.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayGenericsOptions.IncludeVariance">
<summary>
Includes <c>in</c> or <c>out</c> keywords before variant type parameters.
For example, "Goo<out T>" in C# or (Goo Of Out T" in Visual Basic.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.SymbolDisplayGlobalNamespaceStyle">
<summary>
Specifies the options for how to display the global namespace in the description of a symbol.
</summary>
<remarks>
Any of these styles may be overridden by <see cref="T:Microsoft.CodeAnalysis.SymbolDisplayTypeQualificationStyle"/>.
</remarks>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayGlobalNamespaceStyle.Omitted">
<summary>
Omits the global namespace, unconditionally.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayGlobalNamespaceStyle.OmittedAsContaining">
<summary>
Omits the global namespace if it is being displayed as a containing symbol (i.e. not on its own).
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayGlobalNamespaceStyle.Included">
<summary>
Include the global namespace, unconditionally.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.SymbolDisplayKindOptions">
<summary>
Specifies which kind keywords should be included when displaying symbols.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayKindOptions.None">
<summary>
Omits all kind keywords.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayKindOptions.IncludeNamespaceKeyword">
<summary>
Includes the <c>namespace</c> keyword before namespaces.
For example, "namespace System", rather than "System".
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayKindOptions.IncludeTypeKeyword">
<summary>
Includes the type keyword before types.
For example, "class C" in C# or "Structure S" in Visual Basic.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayKindOptions.IncludeMemberKeyword">
<summary>
Include the member keyword before members (if one exists).
For example, "event D E" in C# or "Function MyFun()" in Visual Basic.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.SymbolDisplayLocalOptions">
<summary>
Specifies the options for how locals are displayed in the description of a symbol.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayLocalOptions.None">
<summary>
Shows only the name of the local.
For example, "x".
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayLocalOptions.IncludeType">
<summary>
Shows the type of the local in addition to its name.
For example, "int x" in C# or "x As Integer" in Visual Basic.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayLocalOptions.IncludeConstantValue">
<summary>
Shows the constant value of the local, if there is one, in addition to its name.
For example "x = 1".
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayLocalOptions.IncludeRef">
<summary>
Includes the <c>ref</c> keyword for ref-locals.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.SymbolDisplayMemberOptions">
<summary>
Specifies the options for how members are displayed in the description of a symbol.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayMemberOptions.None">
<summary>
Includes only the name of the member.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayMemberOptions.IncludeType">
<summary>
Includes the (return) type of the method/field/property/event.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayMemberOptions.IncludeModifiers">
<summary>
Includes the modifiers of the member.
For example, "static readonly" in C# or "Shared ReadOnly" in Visual Basic.
</summary>
<remarks>
Accessibility modifiers are controlled separately by <see cref="F:Microsoft.CodeAnalysis.SymbolDisplayMemberOptions.IncludeAccessibility"/>.
</remarks>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayMemberOptions.IncludeAccessibility">
<summary>
Includes the accessibility modifiers of the member.
For example, "public" in C# or "Public" in Visual Basic.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayMemberOptions.IncludeExplicitInterface">
<summary>
Includes the name of corresponding interface on members that explicitly implement
interface members.
For example, "IGoo.Bar { get; }".
</summary>
<remarks>
This option has no effect in Visual Basic.
</remarks>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayMemberOptions.IncludeParameters">
<summary>
Includes the parameters of methods and properties/indexers.
</summary>
<remarks>
See <see cref="T:Microsoft.CodeAnalysis.SymbolDisplayParameterOptions"/> for finer-grained settings.
</remarks>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayMemberOptions.IncludeContainingType">
<summary>
Includes the name of the type containing the member.
</summary>
<remarks>
The format of the containing type is determined by <see cref="T:Microsoft.CodeAnalysis.SymbolDisplayTypeQualificationStyle"/>.
</remarks>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayMemberOptions.IncludeConstantValue">
<summary>
Includes the value of the member if is a constant.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayMemberOptions.IncludeRef">
<summary>
Includes the <c>ref</c>, <c>ref readonly</c>, <c>ByRef</c> keywords for ref-returning methods and properties/indexers.
Also includes the <c>readonly</c> keyword on methods, properties/indexers, and events due to the keyword
changing the <c>this</c> parameter's ref kind from <c>ref</c> to <c>ref readonly</c>.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.SymbolDisplayMiscellaneousOptions">
<summary>
Specifies miscellaneous options about the format of symbol descriptions.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayMiscellaneousOptions.None">
<summary>
Specifies that no miscellaneous options should be applied.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayMiscellaneousOptions.UseSpecialTypes">
<summary>
Uses keywords for predefined types.
For example, "int" instead of "System.Int32" in C#
or "Integer" instead of "System.Integer" in Visual Basic.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayMiscellaneousOptions.EscapeKeywordIdentifiers">
<summary>
Escapes identifiers that are also keywords.
For example, "@true" instead of "true" in C# or
"[True]" instead of "True" in Visual Basic.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayMiscellaneousOptions.UseAsterisksInMultiDimensionalArrays">
<summary>
Displays asterisks between commas in multi-dimensional arrays.
For example, "int[][*,*]" instead of "int[][,]" in C# or
"Integer()(*,*)" instead of "Integer()(*,*) in Visual Basic.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayMiscellaneousOptions.UseErrorTypeSymbolName">
<summary>
Displays "?" for erroneous types that lack names (perhaps due to faulty metadata).
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayMiscellaneousOptions.RemoveAttributeSuffix">
<summary>
Displays attributes names without the "Attribute" suffix, if possible.
</summary>
<remarks>
Has no effect outside <see cref="M:Microsoft.CodeAnalysis.ISymbol.ToMinimalDisplayString(Microsoft.CodeAnalysis.SemanticModel,System.Int32,Microsoft.CodeAnalysis.SymbolDisplayFormat)"/> and only applies
if the context location is one where an attribute ca be referenced without the suffix.
</remarks>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayMiscellaneousOptions.ExpandNullable">
<summary>
Displays <see cref="T:System.Nullable`1"/> as a normal generic type, rather than with
the special question mark syntax.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayMiscellaneousOptions.IncludeNullableReferenceTypeModifier">
<summary>
Append '?' to nullable reference types.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayMiscellaneousOptions.AllowDefaultLiteral">
<summary>
Allow the use of <c>default</c> instead of <c>default(T)</c> where applicable.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayMiscellaneousOptions.IncludeNotNullableReferenceTypeModifier">
<summary>
Append '!' to non-nullable reference types.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.SymbolDisplayParameterOptions">
<summary>
Specifies how parameters are displayed in the description of a (member, property/indexer, or delegate) symbol.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayParameterOptions.None">
<summary>
Omits parameters from symbol descriptions.
</summary>
<remarks>
If this option is combined with <see cref="F:Microsoft.CodeAnalysis.SymbolDisplayMemberOptions.IncludeParameters"/>, then only
the parentheses will be shown (e.g. M()).
</remarks>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayParameterOptions.IncludeExtensionThis">
<summary>
Includes the <c>this</c> keyword before the first parameter of an extension method in C#.
</summary>
<remarks>
This option has no effect in Visual Basic.
</remarks>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayParameterOptions.IncludeParamsRefOut">
<summary>
Includes the <c>params</c>, <c>ref</c>, <c>in</c>, <c>out</c>, <c>ByRef</c>, <c>ByVal</c> keywords before parameters.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayParameterOptions.IncludeType">
<summary>
Includes parameter types in symbol descriptions.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayParameterOptions.IncludeName">
<summary>
Includes parameter names in symbol descriptions.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayParameterOptions.IncludeDefaultValue">
<summary>
Includes parameter default values in symbol descriptions.
</summary>
<remarks>Ignored if <see cref="F:Microsoft.CodeAnalysis.SymbolDisplayParameterOptions.IncludeName"/> is not set.</remarks>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayParameterOptions.IncludeOptionalBrackets">
<summary>
Includes square brackets around optional parameters.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.SymbolDisplayPart">
<summary>
A single element of a symbol description. For example, a keyword, a punctuation character or
a class name.
</summary>
<seealso cref="M:Microsoft.CodeAnalysis.ISymbol.ToDisplayParts(Microsoft.CodeAnalysis.SymbolDisplayFormat)"/>
<seealso cref="M:Microsoft.CodeAnalysis.ISymbol.ToMinimalDisplayParts(Microsoft.CodeAnalysis.SemanticModel,System.Int32,Microsoft.CodeAnalysis.SymbolDisplayFormat)"/>
<seealso cref="T:Microsoft.CodeAnalysis.SymbolDisplayPartKind"/>
</member>
<member name="P:Microsoft.CodeAnalysis.SymbolDisplayPart.Kind">
<summary>
Gets the kind of this display part.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SymbolDisplayPart.Symbol">
<summary>
Gets the symbol associated with this display part, if there is one.
For example, the <see cref="T:Microsoft.CodeAnalysis.ITypeSymbol"/> associated with a class name.
</summary>
<returns></returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SymbolDisplayPart.#ctor(Microsoft.CodeAnalysis.SymbolDisplayPartKind,Microsoft.CodeAnalysis.ISymbol,System.String)">
<summary>
Construct a non-formattable <see cref="T:Microsoft.CodeAnalysis.SymbolDisplayPart"/> (i.e. with a fixed string value).
</summary>
<param name="kind">The kind of the display part.</param>
<param name="symbol">An optional associated symbol.</param>
<param name="text">The fixed string value of the part.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SymbolDisplayPart.ToString">
<summary>
Returns the string value of this symbol display part.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.SymbolDisplayPartKind">
<summary>
Specifies the kinds of a piece of classified text (SymbolDisplayPart).
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayPartKind.AliasName">
<summary>The name of an alias.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayPartKind.AssemblyName">
<summary>The name of an assembly.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayPartKind.ClassName">
<summary>The name of a class.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayPartKind.DelegateName">
<summary>The name of a delegate.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayPartKind.EnumName">
<summary>The name of an enum.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayPartKind.ErrorTypeName">
<summary>The name of an error type.</summary>
<seealso cref="T:Microsoft.CodeAnalysis.IErrorTypeSymbol"/>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayPartKind.EventName">
<summary>The name of an event.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayPartKind.FieldName">
<summary>The name of a field.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayPartKind.InterfaceName">
<summary>The name of an interface.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayPartKind.Keyword">
<summary>A language keyword.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayPartKind.LabelName">
<summary>The name of a label.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayPartKind.LineBreak">
<summary>A line-break (i.e. whitespace).</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayPartKind.NumericLiteral">
<summary>A numeric literal.</summary>
<remarks>Typically for the default values of parameters and the constant values of fields.</remarks>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayPartKind.StringLiteral">
<summary>A string literal.</summary>
<remarks>Typically for the default values of parameters and the constant values of fields.</remarks>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayPartKind.LocalName">
<summary>The name of a local.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayPartKind.MethodName">
<summary>The name of a method.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayPartKind.ModuleName">
<summary>The name of a module.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayPartKind.NamespaceName">
<summary>The name of a namespace.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayPartKind.Operator">
<summary>The symbol of an operator (e.g. "+").</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayPartKind.ParameterName">
<summary>The name of a parameter.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayPartKind.PropertyName">
<summary>The name of a property.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayPartKind.Punctuation">
<summary>A punctuation character (e.g. "(", ".", ",") other than an <see cref="F:Microsoft.CodeAnalysis.SymbolDisplayPartKind.Operator"/>.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayPartKind.Space">
<summary>A single space character.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayPartKind.StructName">
<summary>The name of a struct (structure in Visual Basic).</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayPartKind.AnonymousTypeIndicator">
<summary>A keyword-like part for anonymous types (not actually a keyword).</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayPartKind.Text">
<summary>An unclassified part.</summary>
<remarks>Never returned - only set in user-constructed parts.</remarks>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayPartKind.TypeParameterName">
<summary>The name of a type parameter.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayPartKind.RangeVariableName">
<summary>The name of a query range variable.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayPartKind.EnumMemberName">
<summary>The name of an enum member.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayPartKind.ExtensionMethodName">
<summary>The name of a reduced extension method.</summary>
<remarks>
When an extension method is in it's non-reduced form it will be will be marked as MethodName.
</remarks>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayPartKind.ConstantName">
<summary>The name of a field or local constant.</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayPartKind.RecordClassName">
<summary>The name of a record.</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.SymbolDisplayPropertyStyle">
<summary>
Specifies the options for how properties are displayed in symbol descriptions.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayPropertyStyle.NameOnly">
<summary>
Shows only the names of properties.
<seealso cref="T:Microsoft.CodeAnalysis.SymbolDisplayMemberOptions"/>
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayPropertyStyle.ShowReadWriteDescriptor">
<summary>
Indicates whether the property is readable and/or writable.
In C#, this is accomplished by including accessors.
In Visual Basic, this is accomplished by including the <c>ReadOnly</c> or <c>WriteOnly</c>
keyword, as appropriate.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.SymbolDisplayTypeQualificationStyle">
<summary>
Specifies how much qualification is used in symbol descriptions.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayTypeQualificationStyle.NameOnly">
<summary>
Shows only the name of the symbol.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayTypeQualificationStyle.NameAndContainingTypes">
<summary>
Shows the name of the symbol and the names of all containing types.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolDisplayTypeQualificationStyle.NameAndContainingTypesAndNamespaces">
<summary>
Shows the name of the symbol the names of all containing types and namespaces.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Accessibility">
<summary>
Enumeration for common accessibility combinations.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Accessibility.NotApplicable">
<summary>
No accessibility specified.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Accessibility.ProtectedAndInternal">
<summary>
Only accessible where both protected and internal members are accessible
(more restrictive than <see cref="F:Microsoft.CodeAnalysis.Accessibility.Protected"/>, <see cref="F:Microsoft.CodeAnalysis.Accessibility.Internal"/> and <see cref="F:Microsoft.CodeAnalysis.Accessibility.ProtectedOrInternal"/>).
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Accessibility.ProtectedAndFriend">
<summary>
Only accessible where both protected and friend members are accessible
(more restrictive than <see cref="F:Microsoft.CodeAnalysis.Accessibility.Protected"/>, <see cref="F:Microsoft.CodeAnalysis.Accessibility.Friend"/> and <see cref="F:Microsoft.CodeAnalysis.Accessibility.ProtectedOrFriend"/>).
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Accessibility.ProtectedOrInternal">
<summary>
Accessible wherever either protected or internal members are accessible
(less restrictive than <see cref="F:Microsoft.CodeAnalysis.Accessibility.Protected"/>, <see cref="F:Microsoft.CodeAnalysis.Accessibility.Internal"/> and <see cref="F:Microsoft.CodeAnalysis.Accessibility.ProtectedAndInternal"/>).
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Accessibility.ProtectedOrFriend">
<summary>
Accessible wherever either protected or friend members are accessible
(less restrictive than <see cref="F:Microsoft.CodeAnalysis.Accessibility.Protected"/>, <see cref="F:Microsoft.CodeAnalysis.Accessibility.Friend"/> and <see cref="F:Microsoft.CodeAnalysis.Accessibility.ProtectedAndFriend"/>).
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Symbols.CommonAnonymousTypeManager._templatesSealed">
<summary>
We should not see new anonymous types from source after we finished emit phase.
If this field is true, the collection is sealed; in DEBUG it also is used to check the assertion.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Symbols.CommonAnonymousTypeManager.AreTemplatesSealed">
<summary>
Collection of anonymous type templates is sealed
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Symbols.IAssemblySymbolInternal.Identity">
<summary>
Gets the name of this assembly.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Symbols.IFieldSymbolInternal.IsVolatile">
<summary>
Returns true if this field was declared as "volatile".
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Symbols.IMethodSymbolInternal.IsIterator">
<summary>
True if the method is a source method implemented as an iterator.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Symbols.IMethodSymbolInternal.IsAsync">
<summary>
Returns true if this method is an async method
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Symbols.IMethodSymbolInternal.Construct(Microsoft.CodeAnalysis.Symbols.ITypeSymbolInternal[])">
<summary>
Returns a constructed method given its type arguments.
</summary>
<param name="typeArguments">The immediate type arguments to be replaced for type
parameters in the method.</param>
</member>
<member name="P:Microsoft.CodeAnalysis.Symbols.INamedTypeSymbolInternal.EnumUnderlyingType">
<summary>
For enum types, gets the underlying type. Returns null on all other
kinds of types.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Symbols.INamespaceSymbolInternal.IsGlobalNamespace">
<summary>
Returns whether this namespace is the unnamed, global namespace that is
at the root of all namespaces.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Symbols.ISourceAssemblySymbolInternal.SignatureKey">
<summary>
The contents of the AssemblySignatureKeyAttribute
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Symbols.ISymbolInternal">
<summary>
Interface implemented by the compiler's internal representation of a symbol.
An object implementing this interface might also implement <see cref="T:Microsoft.CodeAnalysis.ISymbol"/> (as is done in VB),
or the compiler's symbols might be wrapped to implement ISymbol (as is done in C#).
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Symbols.ISymbolInternal.Kind">
<summary>
Gets the <see cref="T:Microsoft.CodeAnalysis.SymbolKind"/> indicating what kind of symbol it is.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Symbols.ISymbolInternal.Name">
<summary>
Gets the symbol name. Returns the empty string if unnamed.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Symbols.ISymbolInternal.Equals(Microsoft.CodeAnalysis.Symbols.ISymbolInternal,Microsoft.CodeAnalysis.TypeCompareKind)">
<summary>
Allows a symbol to support comparisons that involve child type symbols
</summary>
<remarks>
Because TypeSymbol equality can differ based on e.g. nullability, any symbols that contain TypeSymbols can also differ in the same way
This call allows the symbol to accept a comparison kind that should be used when comparing its contained types
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Symbols.ISymbolInternal.ContainingSymbol">
<summary>
Gets the <see cref="T:Microsoft.CodeAnalysis.Symbols.ISymbolInternal"/> for the immediately containing symbol.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Symbols.ISymbolInternal.ContainingAssembly">
<summary>
Gets the <see cref="T:Microsoft.CodeAnalysis.Symbols.IAssemblySymbolInternal"/> for the containing assembly. Returns null if the
symbol is shared across multiple assemblies.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Symbols.ISymbolInternal.ContainingModule">
<summary>
Gets the <see cref="T:Microsoft.CodeAnalysis.Symbols.IModuleSymbolInternal"/> for the containing module. Returns null if the
symbol is shared across multiple modules.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Symbols.ISymbolInternal.ContainingType">
<summary>
Gets the <see cref="T:Microsoft.CodeAnalysis.Symbols.INamedTypeSymbolInternal"/> for the containing type. Returns null if the
symbol is not contained within a type.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Symbols.ISymbolInternal.ContainingNamespace">
<summary>
Gets the <see cref="T:Microsoft.CodeAnalysis.Symbols.INamespaceSymbolInternal"/> for the nearest enclosing namespace. Returns null if the
symbol isn't contained in a namespace.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Symbols.ISymbolInternal.IsDefinition">
<summary>
Gets a value indicating whether the symbol is the original definition. Returns false
if the symbol is derived from another symbol, by type substitution for instance.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Symbols.ISymbolInternal.Locations">
<summary>
Gets the locations where the symbol was originally defined, either in source or
metadata. Some symbols (for example, partial classes) may be defined in more than one
location.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Symbols.ISymbolInternal.IsImplicitlyDeclared">
<summary>
Returns true if this symbol was automatically created by the compiler, and does not have
an explicit corresponding source code declaration.
</summary>
<remarks>
This is intended for symbols that are ordinary symbols in the language sense, and may be
used by code, but that are simply declared implicitly rather than with explicit language
syntax.
<para>
Examples include (this list is not exhaustive):
<list type="bullet">
<item><description>The default constructor for a class or struct that is created if one is not provided.</description></item>
<item><description>The BeginInvoke/Invoke/EndInvoke methods for a delegate.</description></item>
<item><description>The generated backing field for an auto property or a field-like event.</description></item>
<item><description>The "this" parameter for non-static methods.</description></item>
<item><description>The "value" parameter for a property setter.</description></item>
<item><description>The parameters on indexer accessor methods (not on the indexer itself).</description></item>
<item><description>Methods in anonymous types.</description></item>
</list>
</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Symbols.ISymbolInternal.DeclaredAccessibility">
<summary>
Gets a <see cref="T:Microsoft.CodeAnalysis.Accessibility"/> indicating the declared accessibility for the symbol.
Returns NotApplicable if no accessibility is declared.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Symbols.ISymbolInternal.IsStatic">
<summary>
Gets a value indicating whether the symbol is static.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Symbols.ISymbolInternal.IsVirtual">
<summary>
Gets a value indicating whether the symbol is virtual.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Symbols.ISymbolInternal.IsOverride">
<summary>
Gets a value indicating whether the symbol is an override of a base class symbol.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Symbols.ISymbolInternal.IsAbstract">
<summary>
Gets a value indicating whether the symbol is abstract.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Symbols.ISymbolInternal.GetISymbol">
<summary>
Returns an <see cref="T:Microsoft.CodeAnalysis.ISymbol"/> instance associated with this symbol.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Symbols.ISymbolInternal.GetCciAdapter">
<summary>
Returns an <see cref="T:Microsoft.Cci.IReference"/> instance associated with this symbol.
In general, this API is not safe to use. Transition from symbols to Cci interfaces
should be handled by PEModuleBuilder translation layer. One relatively safe scenario
is to use it on a symbol that is a definition.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Symbols.ISynthesizedMethodBodyImplementationSymbol">
<summary>
Synthesized symbol that implements a method body feature (iterator, async, lambda, etc.)
</summary>
<remarks>
This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.Symbols.ISynthesizedMethodBodyImplementationSymbol.Method">
<summary>
The symbol whose body lowering produced this synthesized symbol,
or null if the symbol is synthesized based on declaration.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Symbols.ISynthesizedMethodBodyImplementationSymbol.HasMethodBodyDependency">
<summary>
True if this symbol body needs to be updated when the <see cref="P:Microsoft.CodeAnalysis.Symbols.ISynthesizedMethodBodyImplementationSymbol.Method"/> body is updated.
False if <see cref="P:Microsoft.CodeAnalysis.Symbols.ISynthesizedMethodBodyImplementationSymbol.Method"/> is null.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Symbols.ITypeSymbolInternal.TypeKind">
<summary>
An enumerated value that identifies whether this type is an array, pointer, enum, and so on.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Symbols.ITypeSymbolInternal.SpecialType">
<summary>
An enumerated value that identifies certain 'special' types such as <see cref="T:System.Object"/>.
Returns <see cref="F:Microsoft.CodeAnalysis.SpecialType.None"/> if the type is not special.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Symbols.ITypeSymbolInternal.IsReferenceType">
<summary>
True if this type is known to be a reference type. It is never the case that
<see cref="P:Microsoft.CodeAnalysis.Symbols.ITypeSymbolInternal.IsReferenceType"/> and <see cref="P:Microsoft.CodeAnalysis.Symbols.ITypeSymbolInternal.IsValueType"/> both return true. However, for an unconstrained type
parameter, <see cref="P:Microsoft.CodeAnalysis.Symbols.ITypeSymbolInternal.IsReferenceType"/> and <see cref="P:Microsoft.CodeAnalysis.Symbols.ITypeSymbolInternal.IsValueType"/> will both return false.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.Symbols.ITypeSymbolInternal.IsValueType">
<summary>
True if this type is known to be a value type. It is never the case that
<see cref="P:Microsoft.CodeAnalysis.Symbols.ITypeSymbolInternal.IsReferenceType"/> and <see cref="P:Microsoft.CodeAnalysis.Symbols.ITypeSymbolInternal.IsValueType"/> both return true. However, for an unconstrained type
parameter, <see cref="P:Microsoft.CodeAnalysis.Symbols.ITypeSymbolInternal.IsReferenceType"/> and <see cref="P:Microsoft.CodeAnalysis.Symbols.ITypeSymbolInternal.IsValueType"/> will both return false.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Symbols.ITypeSymbolInternal.GetITypeSymbol">
<summary>
Returns an <see cref="T:Microsoft.CodeAnalysis.ITypeSymbol"/> instance associated with this symbol.
This API and <see cref="M:Microsoft.CodeAnalysis.Symbols.ISymbolInternal.GetISymbol"/> should return the same object.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.AttributeUsageInfo.Default">
<summary>
Default attribute usage for attribute types:
(a) Valid targets: AttributeTargets.All
(b) AllowMultiple: false
(c) Inherited: true
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CommonAssemblyWellKnownAttributeData`1">
<summary>
Information decoded from well-known custom attributes applied on an assembly.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommonAssemblyWellKnownAttributeData`1.AssemblyVersionAttributeSetting">
<summary>
Raw assembly version as specified in the AssemblyVersionAttribute, or Nothing if none specified.
If the string passed to AssemblyVersionAttribute contains * the version build and/or revision numbers are set to <see cref="F:System.UInt16.MaxValue"/>.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommonAssemblyWellKnownAttributeData`1.SecurityInformation">
<summary>
Returns data decoded from security attributes or null if there are no security attributes.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.AttributeData.AttributeClass">
<summary>
The attribute class.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.AttributeData.AttributeConstructor">
<summary>
The constructor on the attribute class.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.AttributeData.ConstructorArguments">
<summary>
Constructor arguments on the attribute.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.AttributeData.NamedArguments">
<summary>
Named (property value) arguments on the attribute.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.AttributeData.IsConditionallyOmitted">
<summary>
Attribute is conditionally omitted if it is a source attribute and both the following are true:
(a) It has at least one applied conditional attribute AND
(b) None of conditional symbols are true at the attribute source location.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.AttributeData.IsTargetEarlyAttribute(Microsoft.CodeAnalysis.Symbols.INamedTypeSymbolInternal,System.Int32,Microsoft.CodeAnalysis.AttributeDescription)">
<summary>
Checks if an applied attribute with the given attributeType matches the namespace name and type name of the given early attribute's description
and the attribute description has a signature with parameter count equal to the given attributeArgCount.
NOTE: We don't allow early decoded attributes to have optional parameters.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.AttributeData.GetConstructorArgument``1(System.Int32,Microsoft.CodeAnalysis.SpecialType)">
<summary>
Returns the value of a constructor argument as type <typeparamref name="T"/>.
Throws if no constructor argument exists or the argument cannot be converted to the type.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.AttributeData.DecodeNamedArgument``1(System.String,Microsoft.CodeAnalysis.SpecialType,``0)">
<summary>
Returns named attribute argument with the given <paramref name="name"/> as type <typeparamref name="T"/>.
If there is more than one named argument with this name, it returns the last one.
If no named argument is found then the <paramref name="defaultValue"/> is returned.
</summary>
<param name="name">The metadata property or field name. This name is case sensitive (both VB and C#).</param>
<param name="specialType">SpecialType of the named argument.</param>
<param name="defaultValue">Default value for the named argument.</param>
<remarks>
For user defined attributes VB allows duplicate named arguments and uses the last value.
Dev11 reports an error for pseudo-custom attributes when emitting metadata. We don't.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.AttributeData.DecodeObsoleteAttribute">
<summary>
Decode the arguments to ObsoleteAttribute. ObsoleteAttribute can have 0, 1 or 2 arguments.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.AttributeData.DecodeDeprecatedAttribute">
<summary>
Decode the arguments to DeprecatedAttribute. DeprecatedAttribute can have 3 or 4 arguments.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.AttributeData.DecodeExperimentalAttribute">
<summary>
Decode the arguments to ExperimentalAttribute. ExperimentalAttribute has 0 arguments.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CommonAttributeDataComparer">
<summary>
Used to determine if two <see cref="T:Microsoft.CodeAnalysis.AttributeData"/> instances are identical,
i.e. they have the same attribute type, attribute constructor and have identical arguments.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CommonEventEarlyWellKnownAttributeData">
<summary>
Information decoded from early well-known custom attributes applied on an event.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CommonEventWellKnownAttributeData">
<summary>
Information decoded from well-known custom attributes applied on an event.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CommonFieldEarlyWellKnownAttributeData">
<summary>
Information decoded from early well-known custom attributes applied on a field.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CommonFieldWellKnownAttributeData">
<summary>
Information decoded from well-known custom attributes applied on a field.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommonFieldWellKnownAttributeData.MarshallingInformation">
<summary>
Returns marshalling data or null of MarshalAs attribute isn't applied on the field.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CommonMethodEarlyWellKnownAttributeData">
<summary>
Information decoded from early well-known custom attributes applied on a method.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CommonMethodWellKnownAttributeData">
<summary>
Information decoded from well-known custom attributes applied on a method.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommonMethodWellKnownAttributeData.SecurityInformation">
<summary>
Returns data decoded from security attributes or null if there are no security attributes.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CommonModuleWellKnownAttributeData">
<summary>
Information decoded from well-known custom attributes applied on a module.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CommonParameterEarlyWellKnownAttributeData">
<summary>
Information decoded from early well-known custom attributes applied on a parameter.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CommonParameterWellKnownAttributeData">
<summary>
Information decoded from well-known custom attributes applied on a parameter.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommonParameterWellKnownAttributeData.MarshallingInformation">
<summary>
Returns marshalling data or null of MarshalAs attribute isn't applied on the parameter.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CommonPropertyEarlyWellKnownAttributeData">
<summary>
Information decoded from early well-known custom attributes applied on a property.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CommonPropertyWellKnownAttributeData">
<summary>
Information decoded from well-known custom attributes applied on a property.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CommonReturnTypeWellKnownAttributeData">
<summary>
Information decoded from well-known custom attributes applied on a method return value.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommonReturnTypeWellKnownAttributeData.MarshallingInformation">
<summary>
Returns marshalling data or null of MarshalAs attribute isn't applied on the return value.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CommonTypeEarlyWellKnownAttributeData">
<summary>
Information decoded from early well-known custom attributes applied on a type.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CommonTypeWellKnownAttributeData">
<summary>
Information decoded from well-known custom attributes applied on a type.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CommonTypeWellKnownAttributeData.SecurityInformation">
<summary>
Returns data decoded from security attributes or null if there are no security attributes.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CustomAttributesBag`1">
<summary>
Represents a bag of custom attributes and the associated decoded well-known attribute data.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CustomAttributesBag`1.Empty">
<summary>
Instance representing sealed custom attribute bag with no attributes.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CustomAttributesBag`1.WithEmptyData">
<summary>
Returns a non-sealed custom attribute bag with null initialized <see cref="F:Microsoft.CodeAnalysis.CustomAttributesBag`1._earlyDecodedWellKnownAttributeData"/>, null initialized <see cref="F:Microsoft.CodeAnalysis.CustomAttributesBag`1._decodedWellKnownAttributeData"/> and uninitialized <see cref="F:Microsoft.CodeAnalysis.CustomAttributesBag`1._customAttributes"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.CustomAttributesBag`1.SetEarlyDecodedWellKnownAttributeData(Microsoft.CodeAnalysis.EarlyWellKnownAttributeData)">
<summary>
Sets the early decoded well-known attribute data on the bag in a thread safe manner.
Stored early decoded data is immutable and cannot be updated further.
</summary>
<returns>Returns true if early decoded data were stored into the bag on this thread.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.CustomAttributesBag`1.SetDecodedWellKnownAttributeData(Microsoft.CodeAnalysis.WellKnownAttributeData)">
<summary>
Sets the decoded well-known attribute data (except the early data) on the bag in a thread safe manner.
Stored decoded data is immutable and cannot be updated further.
</summary>
<returns>Returns true if decoded data were stored into the bag on this thread.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.CustomAttributesBag`1.SetAttributes(System.Collections.Immutable.ImmutableArray{`0})">
<summary>
Sets the bound attributes on the bag in a thread safe manner.
If store succeeds, it seals the bag and makes the bag immutable.
</summary>
<returns>Returns true if bound attributes were stored into the bag on this thread.</returns>
</member>
<member name="P:Microsoft.CodeAnalysis.CustomAttributesBag`1.Attributes">
<summary>
Gets the stored bound attributes in the bag.
</summary>
<remarks>This property can only be accessed on a sealed bag.</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.CustomAttributesBag`1.DecodedWellKnownAttributeData">
<summary>
Gets the decoded well-known attribute data (except the early data) in the bag.
</summary>
<remarks>This property can only be accessed on the bag after <see cref="M:Microsoft.CodeAnalysis.CustomAttributesBag`1.SetDecodedWellKnownAttributeData(Microsoft.CodeAnalysis.WellKnownAttributeData)"/> has been invoked.</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.CustomAttributesBag`1.EarlyDecodedWellKnownAttributeData">
<summary>
Gets the early decoded well-known attribute data in the bag.
</summary>
<remarks>This property can only be accessed on the bag after <see cref="M:Microsoft.CodeAnalysis.CustomAttributesBag`1.SetEarlyDecodedWellKnownAttributeData(Microsoft.CodeAnalysis.EarlyWellKnownAttributeData)"/> has been invoked.</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.CustomAttributesBag`1.IsEarlyDecodedWellKnownAttributeDataComputed">
<summary>
Return whether early decoded attribute data has been computed and stored on the bag and it is safe to access <see cref="P:Microsoft.CodeAnalysis.CustomAttributesBag`1.EarlyDecodedWellKnownAttributeData"/> from this bag.
Return value of true doesn't guarantee that bound attributes or remaining decoded attribute data has also been initialized.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CustomAttributesBag`1.IsDecodedWellKnownAttributeDataComputed">
<summary>
Return whether all decoded attribute data has been computed and stored on the bag and it is safe to access <see cref="P:Microsoft.CodeAnalysis.CustomAttributesBag`1.DecodedWellKnownAttributeData"/> from this bag.
Return value of true doesn't guarantee that bound attributes have also been initialized.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.CustomAttributesBag`1.CustomAttributeBagCompletionPart">
<summary>
Enum representing the current state of attribute binding/decoding for a corresponding CustomAttributeBag.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CustomAttributesBag`1.CustomAttributeBagCompletionPart.None">
<summary>
Bag has been created, but no decoded data or attributes have been stored.
CustomAttributeBag is in this state during early decoding phase.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CustomAttributesBag`1.CustomAttributeBagCompletionPart.EarlyDecodedWellKnownAttributeData">
<summary>
Early decoded attribute data has been computed and stored on the bag, but bound attributes or remaining decoded attribute data is not stored.
Only <see cref="F:Microsoft.CodeAnalysis.CustomAttributesBag`1.CustomAttributeBagCompletionPart.EarlyDecodedWellKnownAttributeData"/> can be accessed from this bag.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CustomAttributesBag`1.CustomAttributeBagCompletionPart.DecodedWellKnownAttributeData">
<summary>
All decoded attribute data has been computed and stored on the bag, but bound attributes are not yet stored.
Both <see cref="F:Microsoft.CodeAnalysis.CustomAttributesBag`1.CustomAttributeBagCompletionPart.EarlyDecodedWellKnownAttributeData"/> and <see cref="F:Microsoft.CodeAnalysis.CustomAttributesBag`1.CustomAttributeBagCompletionPart.DecodedWellKnownAttributeData"/> can be accessed from this bag.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CustomAttributesBag`1.CustomAttributeBagCompletionPart.Attributes">
<summary>
Bound attributes have been computed and stored on this bag.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.CustomAttributesBag`1.CustomAttributeBagCompletionPart.All">
<summary>
CustomAttributeBag is completely initialized and immutable.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.DecodeWellKnownAttributeArguments`3">
<summary>
Contains common arguments to Symbol.DecodeWellKnownAttribute method in both the language compilers.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.DecodeWellKnownAttributeArguments`3._lazyDecodeData">
<summary>
Object to store the decoded data from bound well-known attributes.
Created lazily only when some decoded data needs to be stored, null otherwise.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.DecodeWellKnownAttributeArguments`3.GetOrCreateData``1">
<summary>
Gets or creates the decoded data object.
</summary>
<remarks>
This method must be called only when some decoded data will be stored into it subsequently.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.DecodeWellKnownAttributeArguments`3.HasDecodedData">
<summary>
Returns true if some decoded data has been stored into <see cref="F:Microsoft.CodeAnalysis.DecodeWellKnownAttributeArguments`3._lazyDecodeData"/>.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.DecodeWellKnownAttributeArguments`3.DecodedData">
<summary>
Gets the stored decoded data.
</summary>
<remarks>
Assumes <see cref="P:Microsoft.CodeAnalysis.DecodeWellKnownAttributeArguments`3.HasDecodedData"/> is true.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.DecodeWellKnownAttributeArguments`3.AttributeSyntaxOpt">
<summary>
Syntax of the attribute to decode. Might be null when the attribute information is not coming
from syntax. For example, an assembly attribute propagated from added module to the resulting assembly.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.DecodeWellKnownAttributeArguments`3.Attribute">
<summary>
Bound attribute to decode.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.DecodeWellKnownAttributeArguments`3.Index">
<summary>
The index of the attribute in the list of attributes to decode.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.DecodeWellKnownAttributeArguments`3.AttributesCount">
<summary>
Total count of attributes to decode.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.DecodeWellKnownAttributeArguments`3.Diagnostics">
<summary>
Diagnostic bag.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.DecodeWellKnownAttributeArguments`3.SymbolPart">
<summary>
Specific part of the symbol to which the attributes apply, or AttributeLocation.None if the attributes apply to the symbol itself.
Used e.g. for return type attributes of a method symbol.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.EarlyDecodeWellKnownAttributeArguments`4">
<summary>
Contains common arguments to Symbol.EarlyDecodeWellKnownAttribute method in both the language compilers.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.EarlyDecodeWellKnownAttributeArguments`4._lazyDecodeData">
<summary>
Object to store the decoded data from early bound well-known attributes.
Created lazily only when some decoded data needs to be stored, null otherwise.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.EarlyDecodeWellKnownAttributeArguments`4.GetOrCreateData``1">
<summary>
Gets or creates the decoded data object.
</summary>
<remarks>
This method must be called only when some decoded data will be stored into it subsequently.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.EarlyDecodeWellKnownAttributeArguments`4.HasDecodedData">
<summary>
Returns true if some decoded data has been stored into <see cref="F:Microsoft.CodeAnalysis.EarlyDecodeWellKnownAttributeArguments`4._lazyDecodeData"/>.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.EarlyDecodeWellKnownAttributeArguments`4.DecodedData">
<summary>
Gets the stored decoded data.
</summary>
<remarks>
Assumes <see cref="P:Microsoft.CodeAnalysis.EarlyDecodeWellKnownAttributeArguments`4.HasDecodedData"/> is true.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.EarlyDecodeWellKnownAttributeArguments`4.Binder">
<summary>
Binder to bind early well-known attributes.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.EarlyDecodeWellKnownAttributeArguments`4.AttributeType">
<summary>
Bound type of the attribute to decode.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.EarlyDecodeWellKnownAttributeArguments`4.AttributeSyntax">
<summary>
Syntax of the attribute to decode.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.EarlyDecodeWellKnownAttributeArguments`4.SymbolPart">
<summary>
Specific part of the symbol to which the attributes apply, or AttributeLocation.None if the attributes apply to the symbol itself.
Used e.g. for return type attributes of a method symbol.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.EarlyWellKnownAttributeData">
<summary>
Base class for storing information decoded from early well-known custom attributes.
</summary>
<remarks>
CONSIDER: Should we remove this class and let the sub-classes derived from WellKnownAttributeData?
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.MarshalPseudoCustomAttributeData">
<summary>
Information decoded from <see cref="T:System.Runtime.InteropServices.MarshalAsAttribute"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.MarshalPseudoCustomAttributeData.WithTranslatedTypes``2(System.Func{``0,``1,``0},``1)">
<summary>
Returns an instance of <see cref="T:Microsoft.CodeAnalysis.MarshalPseudoCustomAttributeData"/> with all types replaced by types returned by specified translator.
Returns this instance if it doesn't hold on any types.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.ObsoleteAttributeData">
<summary>
Information decoded from <see cref="T:System.ObsoleteAttribute"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.ObsoleteAttributeData.IsError">
<summary>
True if an error should be thrown for the <see cref="T:System.ObsoleteAttribute"/>. Default is false in which case
a warning is thrown.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.ObsoleteAttributeData.Message">
<summary>
The message that will be shown when an error/warning is created for <see cref="T:System.ObsoleteAttribute"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.ObsoleteAttributeData.DiagnosticId">
<summary>
The custom diagnostic ID to use for obsolete diagnostics.
If null, diagnostics are produced using the compiler default diagnostic IDs.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.ObsoleteAttributeData.UrlFormat">
<summary>
<para>
The custom help URL format string for obsolete diagnostics.
Expected to contain zero or one format items.
</para>
<para>
When specified, the obsolete diagnostic's <see cref="P:Microsoft.CodeAnalysis.DiagnosticDescriptor.HelpLinkUri"/> will be produced
by formatting this string using the <see cref="F:Microsoft.CodeAnalysis.ObsoleteAttributeData.DiagnosticId"/> as the single argument.
</para>
<example>
e.g. with a <see cref="F:Microsoft.CodeAnalysis.ObsoleteAttributeData.DiagnosticId"/> value <c>"TEST1"</c>,
and a <see cref="F:Microsoft.CodeAnalysis.ObsoleteAttributeData.UrlFormat"/> value <a href="https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/compiler-messages/{0}/"/>,<br/>
the diagnostic will have the HelpLinkUri <a href="https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/compiler-messages/TEST1/"/>.
</example>
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.SecurityWellKnownAttributeData">
<summary>
Information decoded from security attributes, i.e. attributes derived from well-known SecurityAttribute, applied on a method/type/assembly.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SecurityWellKnownAttributeData.GetSecurityAttributes``1(System.Collections.Immutable.ImmutableArray{``0})">
<summary>
Used for retrieving applied source security attributes, i.e. attributes derived from well-known SecurityAttribute.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.WellKnownAttributeData">
<summary>
Base class for storing information decoded from well-known custom attributes.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownAttributeData.StringMissingValue">
<summary>
Used to distinguish cases when attribute is applied with null value and when attribute is not applied.
For some well-known attributes, the latter case will return string stored in <see cref="F:Microsoft.CodeAnalysis.WellKnownAttributeData.StringMissingValue"/>
field.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CustomModifier.IsOptional">
<summary>
If true, a language may use the modified storage location without
being aware of the meaning of the modification, modopt vs. modreq.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CustomModifier.Modifier">
<summary>
A type used as a tag that indicates which type of modification applies.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.IAliasSymbol">
<summary>
Represents a using alias (Imports alias in Visual Basic).
</summary>
<remarks>
This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.IAliasSymbol.Target">
<summary>
Gets the <see cref="T:Microsoft.CodeAnalysis.INamespaceOrTypeSymbol"/> for the
namespace or type referenced by the alias.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.IArrayTypeSymbol">
<summary>
Represents an array.
</summary>
<remarks>
This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.IArrayTypeSymbol.Rank">
<summary>
Gets the number of dimensions of this array. A regular single-dimensional array
has rank 1, a two-dimensional array has rank 2, etc.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IArrayTypeSymbol.IsSZArray">
<summary>
Is this a zero-based one-dimensional array, i.e. SZArray in CLR terms.
SZArray is an array type encoded in metadata with ELEMENT_TYPE_SZARRAY (always single-dim array with 0 lower bound).
Non-SZArray type is encoded in metadata with ELEMENT_TYPE_ARRAY and with optional sizes and lower bounds. Even though
non-SZArray can also be a single-dim array with 0 lower bound, the encoding of these types in metadata is distinct.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IArrayTypeSymbol.LowerBounds">
<summary>
Specified lower bounds for dimensions, by position. The length can be less than <see cref="P:Microsoft.CodeAnalysis.IArrayTypeSymbol.Rank"/>,
meaning that some trailing dimensions don't have the lower bound specified.
The most common case is all dimensions are zero bound - a default (Nothing in VB) array is returned in this case.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IArrayTypeSymbol.Sizes">
<summary>
Specified sizes for dimensions, by position. The length can be less than <see cref="P:Microsoft.CodeAnalysis.IArrayTypeSymbol.Rank"/>,
meaning that some trailing dimensions don't have the size specified.
The most common case is none of the dimensions have the size specified - an empty array is returned.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IArrayTypeSymbol.ElementType">
<summary>
Gets the type of the elements stored in the array.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IArrayTypeSymbol.ElementNullableAnnotation">
<summary>
Gets the top-level nullability of the elements stored in the array.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IArrayTypeSymbol.CustomModifiers">
<summary>
Custom modifiers associated with the array type, or an empty array if there are none.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.IAssemblySymbol">
<summary>
Represents a .NET assembly, consisting of one or more modules.
</summary>
<remarks>
This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.IAssemblySymbol.IsInteractive">
<summary>
True if the assembly contains interactive code.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IAssemblySymbol.Identity">
<summary>
Gets the name of this assembly.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IAssemblySymbol.GlobalNamespace">
<summary>
Gets the merged root namespace that contains all namespaces and types defined in the modules
of this assembly. If there is just one module in this assembly, this property just returns the
GlobalNamespace of that module.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IAssemblySymbol.Modules">
<summary>
Gets the modules in this assembly. (There must be at least one.) The first one is the main module
that holds the assembly manifest.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IAssemblySymbol.TypeNames">
<summary>
Gets the set of type identifiers from this assembly.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IAssemblySymbol.NamespaceNames">
<summary>
Gets the set of namespace names from this assembly.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.IAssemblySymbol.GivesAccessTo(Microsoft.CodeAnalysis.IAssemblySymbol)">
<summary>
Gets a value indicating whether this assembly gives
<paramref name="toAssembly"/> access to internal symbols</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.IAssemblySymbol.GetTypeByMetadataName(System.String)">
<summary>
Lookup a type within the assembly using the canonical CLR metadata name of the type.
</summary>
<param name="fullyQualifiedMetadataName">Type name.</param>
<returns>Symbol for the type or null if type cannot be found or is ambiguous. </returns>
</member>
<member name="P:Microsoft.CodeAnalysis.IAssemblySymbol.MightContainExtensionMethods">
<summary>
Determines if the assembly might contain extension methods.
If false, the assembly does not contain extension methods.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.IAssemblySymbol.ResolveForwardedType(System.String)">
<summary>
Returns the type symbol for a forwarded type based its canonical CLR metadata name.
The name should refer to a non-nested type. If type with this name is not forwarded,
null is returned.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.IAssemblySymbol.GetForwardedTypes">
<summary>
Returns type symbols for top-level (non-nested) types forwarded by this assembly.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.IAssemblySymbol.GetMetadata">
<summary>
If this symbol represents a metadata assembly returns the underlying <see cref="T:Microsoft.CodeAnalysis.AssemblyMetadata"/>.
Otherwise, this returns <see langword="null"/>.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.IDiscardSymbol">
<summary>
A symbol representing a discarded value, e.g. a symbol in the result of
GetSymbolInfo for <c>_</c> in <c>M(out _)</c> or <c>(x, _) = e</c>.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IDiscardSymbol.Type">
<summary>
The type of the discarded value.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IDiscardSymbol.NullableAnnotation">
<summary>
The top-level nullability of the discarded value.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.IDynamicTypeSymbol">
<summary>
Represents the 'dynamic' type in C#.
</summary>
<remarks>
This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.IErrorTypeSymbol">
<summary>
An IErrorTypeSymbol is used when the compiler cannot determine a symbol object to return because
of an error. For example, if a field is declared "Goo x;", and the type "Goo" cannot be
found, an IErrorTypeSymbol is returned when asking the field "x" what it's type is.
</summary>
<remarks>
This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.IErrorTypeSymbol.CandidateSymbols">
<summary>
When constructing this type, there may have been symbols that seemed to
be what the user intended, but were unsuitable. For example, a type might have been
inaccessible, or ambiguous. This property returns the possible symbols that the user
might have intended. It will return no symbols if no possible symbols were found.
See the CandidateReason property to understand why the symbols were unsuitable.
</summary>
<remarks>
This only applies if this INamedTypeSymbol has TypeKind TypeKind.Error.
If not, an empty ImmutableArray is returned.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.IErrorTypeSymbol.CandidateReason">
<summary>
If CandidateSymbols returns one or more symbols, returns the reason that those
symbols were not chosen. Otherwise, returns None.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.IEventSymbol">
<summary>
Represents an event.
</summary>
<remarks>
This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.IEventSymbol.Type">
<summary>
The type of the event.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IEventSymbol.NullableAnnotation">
<summary>
The top-level nullability of the event.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IEventSymbol.IsWindowsRuntimeEvent">
<summary>
Returns true if the event is a WinRT type event.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IEventSymbol.AddMethod">
<summary>
The 'add' accessor of the event. Null only in error scenarios.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IEventSymbol.RemoveMethod">
<summary>
The 'remove' accessor of the event. Null only in error scenarios.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IEventSymbol.RaiseMethod">
<summary>
The 'raise' accessor of the event. Null if there is no raise method.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IEventSymbol.OriginalDefinition">
<summary>
The original definition of the event. If the event is constructed from another
symbol by type substitution, OriginalDefinition gets the original symbol, as it was
defined in source or metadata.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IEventSymbol.OverriddenEvent">
<summary>
Returns the overridden event, or null.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IEventSymbol.ExplicitInterfaceImplementations">
<summary>
Returns interface properties explicitly implemented by this event.
</summary>
<remarks>
Properties imported from metadata can explicitly implement more than one event.
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.IFieldSymbol">
<summary>
Represents a field in a class, struct or enum.
</summary>
<remarks>
This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.IFieldSymbol.AssociatedSymbol">
<summary>
If this field serves as a backing variable for an automatically generated
property or a field-like event, returns that
property/event. Otherwise returns null.
Note, the set of possible associated symbols might be expanded in the future to
reflect changes in the languages.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IFieldSymbol.IsConst">
<summary>
Returns true if this field was declared as "const" (i.e. is a constant declaration).
Also returns true for an enum member.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IFieldSymbol.IsReadOnly">
<summary>
Returns true if this field was declared as "readonly".
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IFieldSymbol.IsVolatile">
<summary>
Returns true if this field was declared as "volatile".
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IFieldSymbol.IsFixedSizeBuffer">
<summary>
Returns true if this field was declared as "fixed".
Note that for a fixed-size buffer declaration, this.Type will be a pointer type, of which
the pointed-to type will be the declared element type of the fixed-size buffer.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IFieldSymbol.Type">
<summary>
Gets the type of this field.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IFieldSymbol.NullableAnnotation">
<summary>
Gets the top-level nullability of this field.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IFieldSymbol.HasConstantValue">
<summary>
Returns false if the field wasn't declared as "const", or constant value was omitted or erroneous.
True otherwise.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IFieldSymbol.ConstantValue">
<summary>
Gets the constant value of this field
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IFieldSymbol.CustomModifiers">
<summary>
Returns custom modifiers associated with the field, or an empty array if there are none.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IFieldSymbol.OriginalDefinition">
<summary>
Get the original definition of this symbol. If this symbol is derived from another
symbol by (say) type substitution, this gets the original symbol, as it was defined in
source or metadata.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IFieldSymbol.CorrespondingTupleField">
<summary>
If this field represents a tuple element, returns a corresponding default element field.
Otherwise returns null.
</summary>
<remarks>
A tuple type will always have default elements such as Item1, Item2, Item3...
This API allows matching a field that represents a named element, such as "Alice"
to the corresponding default element field such as "Item1"
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.IFunctionPointerTypeSymbol">
<summary>
Represents a function pointer type such as "delegate*<void>".
</summary>
<remarks>
This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.IFunctionPointerTypeSymbol.Signature">
<summary>
Gets the signature of the function pointed to by an instance of the function pointer type.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.ILabelSymbol">
<summary>
Represents a label in method body
</summary>
<remarks>
This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.ILabelSymbol.ContainingMethod">
<summary>
Gets the immediately containing <see cref="T:Microsoft.CodeAnalysis.IMethodSymbol"/> of this <see cref="T:Microsoft.CodeAnalysis.ILocalSymbol"/>.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.ILocalSymbol">
<summary>
Represents a local variable in method body.
</summary>
<remarks>
This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.ILocalSymbol.Type">
<summary>
Gets the type of this local variable.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ILocalSymbol.NullableAnnotation">
<summary>
Gets the top-level nullability of this local variable.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ILocalSymbol.IsConst">
<summary>
Returns true if this local variable was declared as "const" (i.e. is a constant declaration).
Also returns true for an enum member.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ILocalSymbol.IsRef">
<summary>
Returns true if this local is a ref local or a ref readonly local.
Use <see cref="P:Microsoft.CodeAnalysis.ILocalSymbol.RefKind"/> to get more detailed information.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ILocalSymbol.RefKind">
<summary>
Whether the variable is a ref or ref readonly local.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ILocalSymbol.HasConstantValue">
<summary>
Returns false if the local variable wasn't declared as "const", or constant value was omitted or erroneous.
True otherwise.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ILocalSymbol.ConstantValue">
<summary>
Gets the constant value of this local variable.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ILocalSymbol.IsFunctionValue">
<summary>
Returns true if this local variable is function return variable whose name is the function's name,
whose type is the return type of the function and whose initial value is the default of its type.
</summary>
<remarks>
Is always false for the C# local variable
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.ILocalSymbol.IsFixed">
<summary>
Returns true if the local variable is declared with fixed-pointer-initializer (in unsafe context).
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.IMethodSymbol">
<summary>
Represents a method or method-like symbol (including constructor,
destructor, operator, or property/event accessor).
</summary>
<remarks>
This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.IMethodSymbol.MethodKind">
<summary>
Gets what kind of method this is. There are several different kinds of things in the
C# language that are represented as methods. This property allow distinguishing those things
without having to decode the name of the method.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IMethodSymbol.Arity">
<summary>
Returns the arity of this method, or the number of type parameters it takes.
A non-generic method has zero arity.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IMethodSymbol.IsGenericMethod">
<summary>
Returns whether this method is generic; i.e., does it have any type parameters?
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IMethodSymbol.IsExtensionMethod">
<summary>
Returns true if this method is an extension method.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IMethodSymbol.IsAsync">
<summary>
Returns true if this method is an async method
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IMethodSymbol.IsVararg">
<summary>
Returns whether this method is using CLI VARARG calling convention. This is used for
C-style variable argument lists. This is used extremely rarely in C# code and is
represented using the undocumented "__arglist" keyword.
Note that methods with "params" on the last parameter are indicated with the "IsParams"
property on ParameterSymbol, and are not represented with this property.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IMethodSymbol.IsCheckedBuiltin">
<summary>
Returns whether this built-in operator checks for integer overflow.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IMethodSymbol.HidesBaseMethodsByName">
<summary>
Returns true if this method hides base methods by name. This cannot be specified directly
in the C# language, but can be true for methods defined in other languages imported from
metadata. The equivalent of the "hidebyname" flag in metadata.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IMethodSymbol.ReturnsVoid">
<summary>
Returns true if this method has no return type; i.e., returns "void".
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IMethodSymbol.ReturnsByRef">
<summary>
Returns true if this method returns by reference.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IMethodSymbol.ReturnsByRefReadonly">
<summary>
Returns true if this method returns by ref readonly.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IMethodSymbol.RefKind">
<summary>
Returns the RefKind of the method.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IMethodSymbol.ReturnType">
<summary>
Gets the return type of the method.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IMethodSymbol.ReturnNullableAnnotation">
<summary>
Gets the top-level nullability of the return type of the method.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IMethodSymbol.TypeArguments">
<summary>
Returns the type arguments that have been substituted for the type parameters.
If nothing has been substituted for a given type parameter,
then the type parameter itself is consider the type argument.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IMethodSymbol.TypeArgumentNullableAnnotations">
<summary>
Returns the top-level nullability of the type arguments that have been substituted
for the type parameters. If nothing has been substituted for a given type parameter,
then <see cref="F:Microsoft.CodeAnalysis.NullableAnnotation.None"/> is returned.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IMethodSymbol.TypeParameters">
<summary>
Get the type parameters on this method. If the method has not generic,
returns an empty list.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IMethodSymbol.Parameters">
<summary>
Gets the parameters of this method. If this method has no parameters, returns
an empty list.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IMethodSymbol.ConstructedFrom">
<summary>
Returns the method symbol that this method was constructed from. The resulting
method symbol
has the same containing type (if any), but has type arguments that are the same
as the type parameters (although its containing type might not).
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IMethodSymbol.IsReadOnly">
<summary>
Indicates whether the method is readonly,
i.e. whether the 'this' receiver parameter is 'ref readonly'.
Returns true for readonly instance methods and accessors
and for reduced extension methods with a 'this in' parameter.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IMethodSymbol.IsInitOnly">
<summary>
Returns true for 'init' set accessors, and false otherwise.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IMethodSymbol.OriginalDefinition">
<summary>
Get the original definition of this symbol. If this symbol is derived from another
symbol by (say) type substitution, this gets the original symbol, as it was defined in
source or metadata.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IMethodSymbol.OverriddenMethod">
<summary>
If this method overrides another method (because it both had the override modifier
and there correctly was a method to override), returns the overridden method.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IMethodSymbol.ReceiverType">
<summary>
If this method can be applied to an object, returns the type of object it is applied to.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IMethodSymbol.ReceiverNullableAnnotation">
<summary>
If this method can be applied to an object, returns the top-level nullability of the object it is applied to.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IMethodSymbol.ReducedFrom">
<summary>
If this method is a reduced extension method, returns the definition of extension
method from which this was reduced. Otherwise, returns null.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.IMethodSymbol.GetTypeInferredDuringReduction(Microsoft.CodeAnalysis.ITypeParameterSymbol)">
<summary>
If this method is a reduced extension method, returns a type inferred during reduction process for the type parameter.
</summary>
<param name="reducedFromTypeParameter">Type parameter of the corresponding <see cref="P:Microsoft.CodeAnalysis.IMethodSymbol.ReducedFrom"/> method.</param>
<returns>Inferred type or Nothing if nothing was inferred.</returns>
<exception cref="T:System.InvalidOperationException">If this is not a reduced extension method.</exception>
<exception cref="T:System.ArgumentNullException">If <paramref name="reducedFromTypeParameter"/> is null.</exception>
<exception cref="T:System.ArgumentException">If <paramref name="reducedFromTypeParameter"/> doesn't belong to the corresponding <see cref="P:Microsoft.CodeAnalysis.IMethodSymbol.ReducedFrom"/> method.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.IMethodSymbol.ReduceExtensionMethod(Microsoft.CodeAnalysis.ITypeSymbol)">
<summary>
If this is an extension method that can be applied to a receiver of the given type,
returns a reduced extension method symbol thus formed. Otherwise, returns null.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IMethodSymbol.ExplicitInterfaceImplementations">
<summary>
Returns interface methods explicitly implemented by this method.
</summary>
<remarks>
Methods imported from metadata can explicitly implement more than one method,
that is why return type is ImmutableArray.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.IMethodSymbol.ReturnTypeCustomModifiers">
<summary>
Returns the list of custom modifiers, if any, associated with the return type.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IMethodSymbol.RefCustomModifiers">
<summary>
Custom modifiers associated with the ref modifier, or an empty array if there are none.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.IMethodSymbol.GetReturnTypeAttributes">
<summary>
Returns the list of custom attributes, if any, associated with the returned value.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IMethodSymbol.CallingConvention">
<summary>
The calling convention enum of the method symbol.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IMethodSymbol.UnmanagedCallingConventionTypes">
<summary>
Modifier types that are considered part of the calling convention of this method, if the <see cref="P:Microsoft.CodeAnalysis.IMethodSymbol.MethodKind"/> is <see cref="F:Microsoft.CodeAnalysis.MethodKind.FunctionPointerSignature"/>
and the <see cref="P:Microsoft.CodeAnalysis.IMethodSymbol.CallingConvention"/> is <see cref="F:System.Reflection.Metadata.SignatureCallingConvention.Unmanaged"/>. If this is not a function pointer signature or the calling convention is
not unmanaged, this is an empty array. Order and duplication of these modifiers reflect source/metadata order and duplication, whichever this symbol came from.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IMethodSymbol.AssociatedSymbol">
<summary>
Returns a symbol (e.g. property, event, etc.) associated with the method.
</summary>
<remarks>
If this method has <see cref="P:Microsoft.CodeAnalysis.IMethodSymbol.MethodKind"/> of <see cref="F:Microsoft.CodeAnalysis.MethodKind.PropertyGet"/> or <see cref="F:Microsoft.CodeAnalysis.MethodKind.PropertySet"/>,
returns the property that this method is the getter or setter for.
If this method has <see cref="P:Microsoft.CodeAnalysis.IMethodSymbol.MethodKind"/> of <see cref="F:Microsoft.CodeAnalysis.MethodKind.EventAdd"/> or <see cref="F:Microsoft.CodeAnalysis.MethodKind.EventRemove"/>,
returns the event that this method is the adder or remover for.
Note, the set of possible associated symbols might be expanded in the future to
reflect changes in the languages.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.IMethodSymbol.Construct(Microsoft.CodeAnalysis.ITypeSymbol[])">
<summary>
Returns a constructed method given its type arguments.
</summary>
<param name="typeArguments">The immediate type arguments to be replaced for type
parameters in the method.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.IMethodSymbol.Construct(System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.ITypeSymbol},System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.NullableAnnotation})">
<summary>
Returns a constructed method given its type arguments and type argument nullable annotations.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IMethodSymbol.PartialDefinitionPart">
<summary>
If this is a partial method implementation part, returns the corresponding
definition part. Otherwise null.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IMethodSymbol.PartialImplementationPart">
<summary>
If this is a partial method declaration without a body, and the method is
implemented with a body, returns that implementing definition. Otherwise
null.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.IMethodSymbol.GetDllImportData">
<summary>
Platform invoke information, or null if the method isn't a P/Invoke.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IMethodSymbol.AssociatedAnonymousDelegate">
<summary>
If this method is a Lambda method (MethodKind = MethodKind.LambdaMethod) and
there is an anonymous delegate associated with it, returns this delegate.
Returns null if the symbol is not a lambda or if it does not have an
anonymous delegate associated with it.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IMethodSymbol.IsConditional">
<summary>
Returns a flag indicating whether this symbol has at least one applied/inherited conditional attribute.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.IModuleSymbol">
<summary>
Represents a module within an assembly. Every assembly contains one or more modules.
</summary>
<remarks>
This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.IModuleSymbol.GlobalNamespace">
<summary>
Returns a NamespaceSymbol representing the global (root) namespace, with
module extent, that can be used to browse all of the symbols defined in this module.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.IModuleSymbol.GetModuleNamespace(Microsoft.CodeAnalysis.INamespaceSymbol)">
<summary>
Given a namespace symbol, returns the corresponding module specific namespace symbol
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IModuleSymbol.ReferencedAssemblies">
<summary>
Returns an array of assembly identities for assemblies referenced by this module.
Items at the same position from ReferencedAssemblies and from ReferencedAssemblySymbols
correspond to each other.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IModuleSymbol.ReferencedAssemblySymbols">
<summary>
Returns an array of AssemblySymbol objects corresponding to assemblies referenced
by this module. Items at the same position from ReferencedAssemblies and
from ReferencedAssemblySymbols correspond to each other.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.IModuleSymbol.GetMetadata">
<summary>
If this symbol represents a metadata module returns the underlying <see cref="T:Microsoft.CodeAnalysis.ModuleMetadata"/>.
Otherwise, this returns <see langword="null"/>.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.INamedTypeSymbol">
<summary>
Represents a type other than an array, a pointer, a type parameter.
</summary>
<remarks>
This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.INamedTypeSymbol.Arity">
<summary>
Returns the arity of this type, or the number of type parameters it takes.
A non-generic type has zero arity.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.INamedTypeSymbol.IsGenericType">
<summary>
True if this type or some containing type has type parameters.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.INamedTypeSymbol.IsUnboundGenericType">
<summary>
True if this is a reference to an <em>unbound</em> generic type. A generic type is
considered <em>unbound</em> if all of the type argument lists in its fully qualified
name are empty. Note that the type arguments of an unbound generic type will be
returned as error types because they do not really have type arguments. An unbound
generic type yields null for its BaseType and an empty result for its Interfaces.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.INamedTypeSymbol.IsScriptClass">
<summary>
Returns true if the type is a Script class.
It might be an interactive submission class or a Script class in a csx file.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.INamedTypeSymbol.IsImplicitClass">
<summary>
Returns true if the type is the implicit class that holds onto invalid global members (like methods or
statements in a non script file).
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.INamedTypeSymbol.IsComImport">
<summary>
Specifies that the class or interface is imported from another module. See
<see cref="F:System.Reflection.TypeAttributes.Import"/> and <see cref="T:System.Runtime.InteropServices.ComImportAttribute"/>
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.INamedTypeSymbol.MemberNames">
<summary>
Returns collection of names of members declared within this type.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.INamedTypeSymbol.TypeParameters">
<summary>
Returns the type parameters that this type has. If this is a non-generic type,
returns an empty ImmutableArray.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.INamedTypeSymbol.TypeArguments">
<summary>
Returns the type arguments that have been substituted for the type parameters.
If nothing has been substituted for a given type parameter,
then the type parameter itself is considered the type argument.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.INamedTypeSymbol.TypeArgumentNullableAnnotations">
<summary>
Returns the top-level nullability of the type arguments that have been substituted
for the type parameters. If nothing has been substituted for a given type parameter,
then <see cref="F:Microsoft.CodeAnalysis.NullableAnnotation.None"/> is returned for that type argument.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.INamedTypeSymbol.GetTypeArgumentCustomModifiers(System.Int32)">
<summary>
Returns custom modifiers for the type argument that has been substituted for the type parameter.
The modifiers correspond to the type argument at the same ordinal within the <see cref="P:Microsoft.CodeAnalysis.INamedTypeSymbol.TypeArguments"/>
array. Returns an empty array if there are no modifiers.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.INamedTypeSymbol.OriginalDefinition">
<summary>
Get the original definition of this type symbol. If this symbol is derived from another
symbol by (say) type substitution, this gets the original symbol, as it was defined in
source or metadata.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.INamedTypeSymbol.DelegateInvokeMethod">
<summary>
For delegate types, gets the delegate's invoke method. Returns null on
all other kinds of types. Note that it is possible to have an ill-formed
delegate type imported from metadata which does not have an Invoke method.
Such a type will be classified as a delegate but its DelegateInvokeMethod
would be null.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.INamedTypeSymbol.EnumUnderlyingType">
<summary>
For enum types, gets the underlying type. Returns null on all other
kinds of types.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.INamedTypeSymbol.ConstructedFrom">
<summary>
Returns the type symbol that this type was constructed from. This type symbol
has the same containing type (if any), but has type arguments that are the same
as the type parameters (although its containing type might not).
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.INamedTypeSymbol.Construct(Microsoft.CodeAnalysis.ITypeSymbol[])">
<summary>
Returns a constructed type given its type arguments.
</summary>
<param name="typeArguments">The immediate type arguments to be replaced for type
parameters in the type.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.INamedTypeSymbol.Construct(System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.ITypeSymbol},System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.NullableAnnotation})">
<summary>
Returns a constructed type given its type arguments and type argument nullable annotations.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.INamedTypeSymbol.ConstructUnboundGenericType">
<summary>
Returns an unbound generic type of this named type.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.INamedTypeSymbol.InstanceConstructors">
<summary>
Get the instance constructors for this type.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.INamedTypeSymbol.StaticConstructors">
<summary>
Get the static constructors for this type.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.INamedTypeSymbol.Constructors">
<summary>
Get the both instance and static constructors for this type.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.INamedTypeSymbol.AssociatedSymbol">
<summary>
For implicitly declared delegate types returns the EventSymbol that caused this
delegate type to be generated.
For all other types returns null.
Note, the set of possible associated symbols might be expanded in the future to
reflect changes in the languages.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.INamedTypeSymbol.MightContainExtensionMethods">
<summary>
Determines if the symbol might contain extension methods.
If false, the symbol does not contain extension methods.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.INamedTypeSymbol.TupleUnderlyingType">
<summary>
If this is a tuple type with element names, returns the symbol for the tuple type without names.
Otherwise, returns null.
The type argument corresponding to the type of the extension field (VT[8].Rest),
which is at the 8th (one based) position is always a symbol for another tuple,
rather than its underlying type.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.INamedTypeSymbol.TupleElements">
<summary>
Returns fields that represent tuple elements for types that are tuples.
If this type is not a tuple, then returns default.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.INamedTypeSymbol.IsSerializable">
<summary>
True if the type is serializable (has Serializable metadata flag).
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.INamedTypeSymbol.NativeIntegerUnderlyingType">
<summary>
If this is a native integer, returns the symbol for the underlying type,
either <see cref="T:System.IntPtr"/> or <see cref="T:System.UIntPtr"/>.
Otherwise, returns null.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.INamespaceOrTypeSymbol">
<summary>
Represents either a namespace or a type.
</summary>
<remarks>
This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.INamespaceOrTypeSymbol.GetMembers">
<summary>
Get all the members of this symbol.
</summary>
<returns>An ImmutableArray containing all the members of this symbol. If this symbol has no members,
returns an empty ImmutableArray. Never returns Null.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.INamespaceOrTypeSymbol.GetMembers(System.String)">
<summary>
Get all the members of this symbol that have a particular name.
</summary>
<returns>An ImmutableArray containing all the members of this symbol with the given name. If there are
no members with this name, returns an empty ImmutableArray. Never returns Null.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.INamespaceOrTypeSymbol.GetTypeMembers">
<summary>
Get all the members of this symbol that are types.
</summary>
<returns>An ImmutableArray containing all the types that are members of this symbol. If this symbol has no type members,
returns an empty ImmutableArray. Never returns null.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.INamespaceOrTypeSymbol.GetTypeMembers(System.String)">
<summary>
Get all the members of this symbol that are types that have a particular name, of any arity.
</summary>
<returns>An ImmutableArray containing all the types that are members of this symbol with the given name.
If this symbol has no type members with this name,
returns an empty ImmutableArray. Never returns null.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.INamespaceOrTypeSymbol.GetTypeMembers(System.String,System.Int32)">
<summary>
Get all the members of this symbol that are types that have a particular name and arity
</summary>
<returns>An ImmutableArray containing all the types that are members of this symbol with the given name and arity.
If this symbol has no type members with this name and arity,
returns an empty ImmutableArray. Never returns null.</returns>
</member>
<member name="P:Microsoft.CodeAnalysis.INamespaceOrTypeSymbol.IsNamespace">
<summary>
Returns true if this symbol is a namespace. If it is not a namespace, it must be a type.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.INamespaceOrTypeSymbol.IsType">
<summary>
Returns true if this symbols is a type. If it is not a type, it must be a namespace.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.INamespaceSymbol">
<summary>
Represents a namespace.
</summary>
<remarks>
This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.INamespaceSymbol.GetMembers">
<summary>
Get all the members of this symbol.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.INamespaceSymbol.GetMembers(System.String)">
<summary>
Get all the members of this symbol that have a particular name.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.INamespaceSymbol.GetNamespaceMembers">
<summary>
Get all the members of this symbol that are namespaces.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.INamespaceSymbol.IsGlobalNamespace">
<summary>
Returns whether this namespace is the unnamed, global namespace that is
at the root of all namespaces.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.INamespaceSymbol.NamespaceKind">
<summary>
The kind of namespace: Module, Assembly or Compilation.
Module namespaces contain only members from the containing module that share the same namespace name.
Assembly namespaces contain members for all modules in the containing assembly that share the same namespace name.
Compilation namespaces contain all members, from source or referenced metadata (assemblies and modules) that share the same namespace name.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.INamespaceSymbol.ContainingCompilation">
<summary>
The containing compilation for compilation namespaces.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.INamespaceSymbol.ConstituentNamespaces">
<summary>
If a namespace is an assembly or compilation namespace, it may be composed of multiple
namespaces that are merged together. If so, ConstituentNamespaces returns
all the namespaces that were merged. If this namespace was not merged, returns
an array containing only this namespace.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.IParameterSymbol">
<summary>
Represents a parameter of a method or property.
</summary>
<remarks>
This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.IParameterSymbol.RefKind">
<summary>
Whether the parameter passed by value or by reference.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IParameterSymbol.IsParams">
<summary>
Returns true if the parameter was declared as a parameter array.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IParameterSymbol.IsOptional">
<summary>
Returns true if the parameter is optional.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IParameterSymbol.IsThis">
<summary>
Returns true if the parameter is the hidden 'this' ('Me' in Visual Basic) parameter.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IParameterSymbol.IsDiscard">
<summary>
Returns true if the parameter is a discard parameter.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IParameterSymbol.Type">
<summary>
Gets the type of the parameter.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IParameterSymbol.NullableAnnotation">
<summary>
Gets the top-level nullability of the parameter.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IParameterSymbol.CustomModifiers">
<summary>
Custom modifiers associated with the parameter type, or an empty array if there are none.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IParameterSymbol.RefCustomModifiers">
<summary>
Custom modifiers associated with the ref modifier, or an empty array if there are none.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IParameterSymbol.Ordinal">
<summary>
Gets the ordinal position of the parameter. The first parameter has ordinal zero.
The 'this' parameter ('Me' in Visual Basic) has ordinal -1.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IParameterSymbol.HasExplicitDefaultValue">
<summary>
Returns true if the parameter specifies a default value to be passed
when no value is provided as an argument to a call. The default value
can be obtained with the <see cref="P:Microsoft.CodeAnalysis.IParameterSymbol.ExplicitDefaultValue"/> property.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IParameterSymbol.ExplicitDefaultValue">
<summary>
Returns the default value of the parameter.
</summary>
<remarks>
Returns null if the parameter type is a struct and the default value of the parameter
is the default value of the struct type.
</remarks>
<exception cref="T:System.InvalidOperationException">The parameter has no default value.</exception>
</member>
<member name="P:Microsoft.CodeAnalysis.IParameterSymbol.OriginalDefinition">
<summary>
Get the original definition of this symbol. If this symbol is derived from another
symbol by (say) type substitution, this gets the original symbol, as it was defined in
source or metadata.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.IPointerTypeSymbol">
<summary>
Represents a pointer type such as "int *". Pointer types
are used only in unsafe code.
</summary>
<remarks>
This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.IPointerTypeSymbol.PointedAtType">
<summary>
Gets the type of the storage location that an instance of the pointer type points to.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IPointerTypeSymbol.CustomModifiers">
<summary>
Custom modifiers associated with the pointer type, or an empty array if there are none.
</summary>
<remarks>
Some managed languages may represent special information about the pointer type
as a custom modifier on either the pointer type or the element type, or
both.
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.IPreprocessingSymbol">
<summary>
Represents a preprocessing conditional compilation symbol.
</summary>
<remarks>
This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.IPropertySymbol">
<summary>
Represents a property or indexer.
</summary>
<remarks>
This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.IPropertySymbol.IsIndexer">
<summary>
Returns whether the property is really an indexer.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IPropertySymbol.IsReadOnly">
<summary>
True if this is a read-only property; that is, a property with no set accessor.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IPropertySymbol.IsWriteOnly">
<summary>
True if this is a write-only property; that is, a property with no get accessor.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IPropertySymbol.IsWithEvents">
<summary>
Returns true if this property is an auto-created WithEvents property that takes place of
a field member when the field is marked as WithEvents.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IPropertySymbol.ReturnsByRef">
<summary>
Returns true if this property returns by reference.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IPropertySymbol.ReturnsByRefReadonly">
<summary>
Returns true if this property returns by reference a readonly variable.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IPropertySymbol.RefKind">
<summary>
Returns the RefKind of the property.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IPropertySymbol.Type">
<summary>
The type of the property.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IPropertySymbol.Parameters">
<summary>
The parameters of this property. If this property has no parameters, returns
an empty list. Parameters are only present on indexers, or on some properties
imported from a COM interface.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IPropertySymbol.GetMethod">
<summary>
The 'get' accessor of the property, or null if the property is write-only.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IPropertySymbol.SetMethod">
<summary>
The 'set' accessor of the property, or null if the property is read-only.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IPropertySymbol.OriginalDefinition">
<summary>
The original definition of the property. If the property is constructed from another
symbol by type substitution, OriginalDefinition gets the original symbol, as it was
defined in source or metadata.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IPropertySymbol.OverriddenProperty">
<summary>
Returns the overridden property, or null.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IPropertySymbol.ExplicitInterfaceImplementations">
<summary>
Returns interface properties explicitly implemented by this property.
</summary>
<remarks>
Properties imported from metadata can explicitly implement more than one property.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.IPropertySymbol.RefCustomModifiers">
<summary>
Custom modifiers associated with the ref modifier, or an empty array if there are none.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IPropertySymbol.TypeCustomModifiers">
<summary>
The list of custom modifiers, if any, associated with the type of the property.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.IRangeVariableSymbol">
<summary>
Represents a range variable in a query expression.
</summary>
<remarks>
This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.ISourceAssemblySymbol">
<summary>
Represents a source assembly symbol exposed by the compiler.
</summary>
<remarks>
This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.ISymbol">
<summary>
Represents a symbol (namespace, class, method, parameter, etc.)
exposed by the compiler.
</summary>
<remarks>
This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.ISymbol.Kind">
<summary>
Gets the <see cref="T:Microsoft.CodeAnalysis.SymbolKind"/> indicating what kind of symbol it is.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ISymbol.Language">
<summary>
Gets the source language ("C#" or "Visual Basic").
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ISymbol.Name">
<summary>
Gets the symbol name. Returns the empty string if unnamed.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ISymbol.MetadataName">
<summary>
Gets the name of a symbol as it appears in metadata. Most of the time, this
is the same as the Name property, with the following exceptions:
<list type="number">
<item>
<description>The metadata name of generic types includes the "`1", "`2" etc. suffix that
indicates the number of type parameters (it does not include, however, names of
containing types or namespaces). </description>
</item>
<item>
<description>The metadata name of explicit interface names have spaces removed, compared to
the name property.</description>
</item>
<item>
<description>The length of names is limited to not exceed metadata restrictions.</description>
</item>
</list>
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ISymbol.ContainingSymbol">
<summary>
Gets the <see cref="T:Microsoft.CodeAnalysis.ISymbol"/> for the immediately containing symbol.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ISymbol.ContainingAssembly">
<summary>
Gets the <see cref="T:Microsoft.CodeAnalysis.IAssemblySymbol"/> for the containing assembly. Returns null if the
symbol is shared across multiple assemblies.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ISymbol.ContainingModule">
<summary>
Gets the <see cref="T:Microsoft.CodeAnalysis.IModuleSymbol"/> for the containing module. Returns null if the
symbol is shared across multiple modules.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ISymbol.ContainingType">
<summary>
Gets the <see cref="T:Microsoft.CodeAnalysis.INamedTypeSymbol"/> for the containing type. Returns null if the
symbol is not contained within a type.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ISymbol.ContainingNamespace">
<summary>
Gets the <see cref="T:Microsoft.CodeAnalysis.INamespaceSymbol"/> for the nearest enclosing namespace. Returns null if the
symbol isn't contained in a namespace.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ISymbol.IsDefinition">
<summary>
Gets a value indicating whether the symbol is the original definition. Returns false
if the symbol is derived from another symbol, by type substitution for instance.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ISymbol.IsStatic">
<summary>
Gets a value indicating whether the symbol is static.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ISymbol.IsVirtual">
<summary>
Gets a value indicating whether the symbol is virtual.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ISymbol.IsOverride">
<summary>
Gets a value indicating whether the symbol is an override of a base class symbol.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ISymbol.IsAbstract">
<summary>
Gets a value indicating whether the symbol is abstract.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ISymbol.IsSealed">
<summary>
Gets a value indicating whether the symbol is sealed.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ISymbol.IsExtern">
<summary>
Gets a value indicating whether the symbol is defined externally.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ISymbol.IsImplicitlyDeclared">
<summary>
Returns true if this symbol was automatically created by the compiler, and does not have
an explicit corresponding source code declaration.
</summary>
<remarks>
This is intended for symbols that are ordinary symbols in the language sense, and may be
used by code, but that are simply declared implicitly rather than with explicit language
syntax.
<para>
Examples include (this list is not exhaustive):
<list type="bullet">
<item><description>The default constructor for a class or struct that is created if one is not provided.</description></item>
<item><description>The BeginInvoke/Invoke/EndInvoke methods for a delegate.</description></item>
<item><description>The generated backing field for an auto property or a field-like event.</description></item>
<item><description>The "this" parameter for non-static methods.</description></item>
<item><description>The "value" parameter for a property setter.</description></item>
<item><description>The parameters on indexer accessor methods (not on the indexer itself).</description></item>
<item><description>Methods in anonymous types.</description></item>
</list>
</para>
<para>
The class and entry point method for top-level statements are not considered as implicitly declared.
</para>
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.ISymbol.CanBeReferencedByName">
<summary>
Returns true if this symbol can be referenced by its name in code.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ISymbol.Locations">
<summary>
Gets the locations where the symbol was originally defined, either in source or
metadata. Some symbols (for example, partial classes) may be defined in more than one
location.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ISymbol.DeclaringSyntaxReferences">
<summary>
Get the syntax node(s) where this symbol was declared in source. Some symbols (for example,
partial classes) may be defined in more than one location. This property should return
one or more syntax nodes only if the symbol was declared in source code and also was
not implicitly declared (see the IsImplicitlyDeclared property).
<para>
Note that for namespace symbol, the declaring syntax might be declaring a nested namespace.
For example, the declaring syntax node for N1 in "namespace N1.N2 {...}" is the entire
NamespaceDeclarationSyntax for N1.N2. For the global namespace, the declaring syntax will
be the CompilationUnitSyntax.
</para>
</summary>
<returns>
The syntax node(s) that declared the symbol. If the symbol was declared in metadata
or was implicitly declared, returns an empty read-only array.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.ISymbol.GetAttributes">
<summary>
Gets the attributes for the symbol. Returns an empty <see cref="T:System.Collections.Generic.IEnumerable`1"/>
if there are no attributes.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ISymbol.DeclaredAccessibility">
<summary>
Gets a <see cref="T:Microsoft.CodeAnalysis.Accessibility"/> indicating the declared accessibility for the symbol.
Returns NotApplicable if no accessibility is declared.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ISymbol.OriginalDefinition">
<summary>
Gets the <see cref="T:Microsoft.CodeAnalysis.ISymbol"/> for the original definition of the symbol.
If this symbol is derived from another symbol, by type substitution for instance,
this gets the original symbol, as it was defined in source or metadata.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.ISymbol.GetDocumentationCommentId">
<summary>
Returns the Documentation Comment ID for the symbol, or null if the symbol doesn't
support documentation comments.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.ISymbol.GetDocumentationCommentXml(System.Globalization.CultureInfo,System.Boolean,System.Threading.CancellationToken)">
<summary>
Gets the XML (as text) for the comment associated with the symbol.
</summary>
<param name="preferredCulture">Preferred culture or null for the default.</param>
<param name="expandIncludes">Optionally, expand <include> elements. No impact on non-source documentation comments.</param>
<param name="cancellationToken">Token allowing cancellation of request.</param>
<returns>The XML that would be written to the documentation file for the symbol.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.ISymbol.ToDisplayString(Microsoft.CodeAnalysis.SymbolDisplayFormat)">
<summary>
Converts the symbol to a string representation.
</summary>
<param name="format">Format or null for the default.</param>
<returns>A formatted string representation of the symbol.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.ISymbol.ToDisplayParts(Microsoft.CodeAnalysis.SymbolDisplayFormat)">
<summary>
Convert a symbol to an array of string parts, each of which has a kind. Useful for
colorizing the display string.
</summary>
<param name="format">Formatting rules - null implies
SymbolDisplayFormat.ErrorMessageFormat.</param>
<returns>A read-only array of string parts.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.ISymbol.ToMinimalDisplayString(Microsoft.CodeAnalysis.SemanticModel,System.Int32,Microsoft.CodeAnalysis.SymbolDisplayFormat)">
<summary>
Convert a symbol to a string that can be displayed to the user. May be tailored to a
specific location in the source code.
</summary>
<param name="semanticModel">Binding information (for determining names appropriate to
the context).</param>
<param name="position">A position in the source code (context).</param>
<param name="format">Formatting rules - null implies
SymbolDisplayFormat.MinimallyQualifiedFormat.</param>
<returns>A formatted string that can be displayed to the user.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.ISymbol.ToMinimalDisplayParts(Microsoft.CodeAnalysis.SemanticModel,System.Int32,Microsoft.CodeAnalysis.SymbolDisplayFormat)">
<summary>
Convert a symbol to an array of string parts, each of which has a kind. May be tailored
to a specific location in the source code. Useful for colorizing the display string.
</summary>
<param name="semanticModel">Binding information (for determining names appropriate to
the context).</param>
<param name="position">A position in the source code (context).</param>
<param name="format">Formatting rules - null implies
SymbolDisplayFormat.MinimallyQualifiedFormat.</param>
<returns>A read-only array of string parts.</returns>
</member>
<member name="P:Microsoft.CodeAnalysis.ISymbol.HasUnsupportedMetadata">
<summary>
Indicates that this symbol uses metadata that cannot be supported by the language.
<para>
Examples include:
<list type="bullet">
<item><description>Pointer types in VB</description></item>
<item><description>ByRef return type</description></item>
<item><description>Required custom modifiers</description></item>
</list>
</para>
<para>
This is distinguished from, for example, references to metadata symbols defined in assemblies that weren't referenced.
Symbols where this returns true can never be used successfully, and thus should never appear in any IDE feature.
</para>
<para>
This is set for metadata symbols, as follows:
<list type="bullet">
<item><description>Type - if a type is unsupported (for example, a pointer type)</description></item>
<item><description>Method - parameter or return type is unsupported</description></item>
<item><description>Field - type is unsupported</description></item>
<item><description>Event - type is unsupported</description></item>
<item><description>Property - type is unsupported</description></item>
<item><description>Parameter - type is unsupported</description></item>
</list>
</para>
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.ISymbol.Equals(Microsoft.CodeAnalysis.ISymbol,Microsoft.CodeAnalysis.SymbolEqualityComparer)">
<summary>
Determines if this symbol is equal to another, according to the rules of the provided <see cref="T:Microsoft.CodeAnalysis.SymbolEqualityComparer"/>
</summary>
<param name="other">The other symbol to compare against</param>
<param name="equalityComparer">The <see cref="T:Microsoft.CodeAnalysis.SymbolEqualityComparer"/> to use when comparing symbols</param>
<returns>True if the symbols are equivalent.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.ISymbolExtensions.GetConstructedReducedFrom(Microsoft.CodeAnalysis.IMethodSymbol)">
<summary>
Returns the constructed form of the ReducedFrom property,
including the type arguments that were either inferred during reduction or supplied at the call site.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.ISymbolExtensions.IsDefaultTupleElement(Microsoft.CodeAnalysis.IFieldSymbol)">
<summary>
Returns true if a given field is a default tuple element
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.ISymbolExtensions.IsTupleElement(Microsoft.CodeAnalysis.IFieldSymbol)">
<summary>
Returns true if a given field is a tuple element
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.ISymbolExtensions.ProvidedTupleElementNameOrNull(Microsoft.CodeAnalysis.IFieldSymbol)">
<summary>
Return the name of the field if the field is an explicitly named tuple element.
Otherwise returns null.
</summary>
<remarks>
Note that it is possible for an element to be both "Default" and to have a user provided name.
That could happen if the provided name matches the default name such as "Item10"
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.ISymbolExtensions.PerformIVTCheck(Microsoft.CodeAnalysis.AssemblyIdentity,System.Collections.Immutable.ImmutableArray{System.Byte},System.Collections.Immutable.ImmutableArray{System.Byte})">
<summary>
Given that an assembly with identity assemblyGrantingAccessIdentity granted access to assemblyWantingAccess,
check the public keys to ensure the internals-visible-to check should succeed. This is used by both the
C# and VB implementations as a helper to implement `bool IAssemblySymbol.GivesAccessTo(IAssemblySymbol toAssembly)`.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.ITypeParameterSymbol">
<summary>
Represents a type parameter in a generic type or generic method.
</summary>
<remarks>
This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.ITypeParameterSymbol.Ordinal">
<summary>
The ordinal position of the type parameter in the parameter list which declares
it. The first type parameter has ordinal zero.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ITypeParameterSymbol.Variance">
<summary>
The variance annotation, if any, of the type parameter declaration. Type parameters may be
declared as covariant (<c>out</c>), contravariant (<c>in</c>), or neither.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ITypeParameterSymbol.TypeParameterKind">
<summary>
The type parameter kind of this type parameter.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ITypeParameterSymbol.DeclaringMethod">
<summary>
The method that declares the type parameter, or null.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ITypeParameterSymbol.DeclaringType">
<summary>
The type that declares the type parameter, or null.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ITypeParameterSymbol.HasReferenceTypeConstraint">
<summary>
True if the reference type constraint (<c>class</c>) was specified for the type parameter.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ITypeParameterSymbol.ReferenceTypeConstraintNullableAnnotation">
<summary>
If <see cref="P:Microsoft.CodeAnalysis.ITypeParameterSymbol.HasReferenceTypeConstraint"/> is true, returns the top-level nullability of the
<c>class</c> constraint that was specified for the type parameter. If there was no <c>class</c>
constraint, this returns <see cref="F:Microsoft.CodeAnalysis.NullableAnnotation.None"/>.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ITypeParameterSymbol.HasValueTypeConstraint">
<summary>
True if the value type constraint (<c>struct</c>) was specified for the type parameter.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ITypeParameterSymbol.HasUnmanagedTypeConstraint">
<summary>
True if the value type constraint (<c>unmanaged</c>) was specified for the type parameter.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ITypeParameterSymbol.HasNotNullConstraint">
<summary>
True if the notnull constraint (<c>notnull</c>) was specified for the type parameter.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ITypeParameterSymbol.HasConstructorConstraint">
<summary>
True if the parameterless constructor constraint (<c>new()</c>) was specified for the type parameter.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ITypeParameterSymbol.ConstraintTypes">
<summary>
The types that were directly specified as constraints on the type parameter.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ITypeParameterSymbol.ConstraintNullableAnnotations">
<summary>
The top-level nullabilities that were directly specified as constraints on the
constraint types.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ITypeParameterSymbol.OriginalDefinition">
<summary>
Get the original definition of this type symbol. If this symbol is derived from another
symbol by (say) type substitution, this gets the original symbol, as it was defined in
source or metadata.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ITypeParameterSymbol.ReducedFrom">
<summary>
If this is a type parameter of a reduced extension method, gets the type parameter definition that
this type parameter was reduced from. Otherwise, returns Nothing.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.ITypeSymbol">
<summary>
Represents a type.
</summary>
<remarks>
This interface is reserved for implementation by its associated APIs. We reserve the right to
change it in the future.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.ITypeSymbol.TypeKind">
<summary>
An enumerated value that identifies whether this type is an array, pointer, enum, and so on.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ITypeSymbol.BaseType">
<summary>
The declared base type of this type, or null. The object type, interface types,
and pointer types do not have a base type. The base type of a type parameter
is its effective base class.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ITypeSymbol.Interfaces">
<summary>
Gets the set of interfaces that this type directly implements. This set does not include
interfaces that are base interfaces of directly implemented interfaces. This does
include the interfaces declared as constraints on type parameters.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ITypeSymbol.AllInterfaces">
<summary>
The list of all interfaces of which this type is a declared subtype, excluding this type
itself. This includes all declared base interfaces, all declared base interfaces of base
types, and all declared base interfaces of those results (recursively). This also is the effective
interface set of a type parameter. Each result
appears exactly once in the list. This list is topologically sorted by the inheritance
relationship: if interface type A extends interface type B, then A precedes B in the
list. This is not quite the same as "all interfaces of which this type is a proper
subtype" because it does not take into account variance: AllInterfaces for
IEnumerable<string> will not include IEnumerable<object>.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ITypeSymbol.IsReferenceType">
<summary>
True if this type is known to be a reference type. It is never the case that
<see cref="P:Microsoft.CodeAnalysis.ITypeSymbol.IsReferenceType"/> and <see cref="P:Microsoft.CodeAnalysis.ITypeSymbol.IsValueType"/> both return true. However, for an unconstrained type
parameter, <see cref="P:Microsoft.CodeAnalysis.ITypeSymbol.IsReferenceType"/> and <see cref="P:Microsoft.CodeAnalysis.ITypeSymbol.IsValueType"/> will both return false.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ITypeSymbol.IsValueType">
<summary>
True if this type is known to be a value type. It is never the case that
<see cref="P:Microsoft.CodeAnalysis.ITypeSymbol.IsReferenceType"/> and <see cref="P:Microsoft.CodeAnalysis.ITypeSymbol.IsValueType"/> both return true. However, for an unconstrained type
parameter, <see cref="P:Microsoft.CodeAnalysis.ITypeSymbol.IsReferenceType"/> and <see cref="P:Microsoft.CodeAnalysis.ITypeSymbol.IsValueType"/> will both return false.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ITypeSymbol.IsAnonymousType">
<summary>
Is this a symbol for an anonymous type (including anonymous VB delegate).
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ITypeSymbol.IsTupleType">
<summary>
Is this a symbol for a tuple .
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ITypeSymbol.IsNativeIntegerType">
<summary>
True if the type represents a native integer. In C#, the types represented
by language keywords 'nint' and 'nuint'.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ITypeSymbol.OriginalDefinition">
<summary>
The original definition of this symbol. If this symbol is constructed from another
symbol by type substitution then <see cref="P:Microsoft.CodeAnalysis.ITypeSymbol.OriginalDefinition"/> gets the original symbol as it was defined in
source or metadata.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ITypeSymbol.SpecialType">
<summary>
An enumerated value that identifies certain 'special' types such as <see cref="T:System.Object"/>.
Returns <see cref="F:Microsoft.CodeAnalysis.SpecialType.None"/> if the type is not special.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.ITypeSymbol.FindImplementationForInterfaceMember(Microsoft.CodeAnalysis.ISymbol)">
<summary>
Returns the corresponding symbol in this type or a base type that implements
interfaceMember (either implicitly or explicitly), or null if no such symbol exists
(which might be either because this type doesn't implement the container of
interfaceMember, or this type doesn't supply a member that successfully implements
interfaceMember).
</summary>
<param name="interfaceMember">
Must be a non-null interface property, method, or event.
</param>
</member>
<member name="P:Microsoft.CodeAnalysis.ITypeSymbol.IsRefLikeType">
<summary>
True if the type is ref-like, meaning it follows rules similar to CLR by-ref variables. False if the type
is not ref-like or if the language has no concept of ref-like types.
</summary>
<remarks>
<see cref="T:System.Span`1" /> is a commonly used ref-like type.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.ITypeSymbol.IsUnmanagedType">
<summary>
True if the type is unmanaged according to language rules. False if managed or if the language
has no concept of unmanaged types.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ITypeSymbol.IsReadOnly">
<summary>
True if the type is readonly.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ITypeSymbol.IsRecord">
<summary>
True if the type is a record.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.ITypeSymbol.ToDisplayString(Microsoft.CodeAnalysis.NullableFlowState,Microsoft.CodeAnalysis.SymbolDisplayFormat)">
<summary>
Converts an <c>ITypeSymbol</c> and a nullable flow state to a string representation.
</summary>
<param name="topLevelNullability">The top-level nullability to use for formatting.</param>
<param name="format">Format or null for the default.</param>
<returns>A formatted string representation of the symbol with the given nullability.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.ITypeSymbol.ToDisplayParts(Microsoft.CodeAnalysis.NullableFlowState,Microsoft.CodeAnalysis.SymbolDisplayFormat)">
<summary>
Converts a symbol to an array of string parts, each of which has a kind. Useful
for colorizing the display string.
</summary>
<param name="topLevelNullability">The top-level nullability to use for formatting.</param>
<param name="format">Format or null for the default.</param>
<returns>A read-only array of string parts.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.ITypeSymbol.ToMinimalDisplayString(Microsoft.CodeAnalysis.SemanticModel,Microsoft.CodeAnalysis.NullableFlowState,System.Int32,Microsoft.CodeAnalysis.SymbolDisplayFormat)">
<summary>
Converts a symbol to a string that can be displayed to the user. May be tailored to a
specific location in the source code.
</summary>
<param name="semanticModel">Binding information (for determining names appropriate to
the context).</param>
<param name="topLevelNullability">The top-level nullability to use for formatting.</param>
<param name="position">A position in the source code (context).</param>
<param name="format">Formatting rules - null implies <see cref="P:Microsoft.CodeAnalysis.SymbolDisplayFormat.MinimallyQualifiedFormat"/></param>
<returns>A formatted string that can be displayed to the user.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.ITypeSymbol.ToMinimalDisplayParts(Microsoft.CodeAnalysis.SemanticModel,Microsoft.CodeAnalysis.NullableFlowState,System.Int32,Microsoft.CodeAnalysis.SymbolDisplayFormat)">
<summary>
Convert a symbol to an array of string parts, each of which has a kind. May be tailored
to a specific location in the source code. Useful for colorizing the display string.
</summary>
<param name="semanticModel">Binding information (for determining names appropriate to
the context).</param>
<param name="topLevelNullability">The top-level nullability to use for formatting.</param>
<param name="position">A position in the source code (context).</param>
<param name="format">Formatting rules - null implies <see cref="P:Microsoft.CodeAnalysis.SymbolDisplayFormat.MinimallyQualifiedFormat"/></param>
<returns>A read-only array of string parts.</returns>
</member>
<member name="P:Microsoft.CodeAnalysis.ITypeSymbol.NullableAnnotation">
<summary>
Nullable annotation associated with the type, or <see cref="F:Microsoft.CodeAnalysis.NullableAnnotation.None"/> if there are none.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.ITypeSymbol.WithNullableAnnotation(Microsoft.CodeAnalysis.NullableAnnotation)">
<summary>
Returns the same type as this type but with the given nullable annotation.
</summary>
<param name="nullableAnnotation">The nullable annotation to use</param>
</member>
<member name="T:Microsoft.CodeAnalysis.LanguageNames">
<summary>
A class that provides constants for common language names.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.LanguageNames.CSharp">
<summary>
The common name used for the C# language.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.LanguageNames.VisualBasic">
<summary>
The common name used for the Visual Basic language.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.LanguageNames.FSharp">
<summary>
The common name used for the F# language.
</summary>
<remarks>
F# is not a supported compile target for the Roslyn compiler.
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.ManagedKind">
<summary>
Enumeration of the possible "degrees of managed" for a type.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.MethodKind">
<summary>
Enumeration for possible kinds of method symbols.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.MethodKind.AnonymousFunction">
<summary>
An anonymous method or lambda expression
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.MethodKind.LambdaMethod">
<summary>
<inheritdoc cref="F:Microsoft.CodeAnalysis.MethodKind.AnonymousFunction"/>
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.MethodKind.Constructor">
<summary>
Method is a constructor.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.MethodKind.Conversion">
<summary>
Method is a conversion.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.MethodKind.DelegateInvoke">
<summary>
Method is a delegate invoke.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.MethodKind.Destructor">
<summary>
Method is a destructor.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.MethodKind.EventAdd">
<summary>
Method is an event add.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.MethodKind.EventRaise">
<summary>
Method is an event raise.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.MethodKind.EventRemove">
<summary>
Method is an event remove.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.MethodKind.ExplicitInterfaceImplementation">
<summary>
Method is an explicit interface implementation.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.MethodKind.UserDefinedOperator">
<summary>
Method is an operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.MethodKind.Ordinary">
<summary>
Method is an ordinary method.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.MethodKind.PropertyGet">
<summary>
Method is a property get.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.MethodKind.PropertySet">
<summary>
Method is a property set.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.MethodKind.ReducedExtension">
<summary>
An extension method with the "this" parameter removed.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.MethodKind.StaticConstructor">
<summary>
Method is a static constructor.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.MethodKind.SharedConstructor">
<summary>
<inheritdoc cref="F:Microsoft.CodeAnalysis.MethodKind.StaticConstructor"/>
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.MethodKind.BuiltinOperator">
<summary>
A built-in operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.MethodKind.DeclareMethod">
<summary>
Declare Sub or Function.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.MethodKind.LocalFunction">
<summary>
Method is declared inside of another method.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.MethodKind.FunctionPointerSignature">
<summary>
Method represents the signature of a function pointer type.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.NamespaceKind">
<summary>
Describes the kind of the namespace extent.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.NullabilityInfo.Annotation">
<summary>
The nullable annotation of the expression represented by the syntax node. This represents
the nullability of expressions that can be assigned to this expression, if this expression
can be used as an lvalue.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.NullabilityInfo.FlowState">
<summary>
The nullable flow state of the expression represented by the syntax node. This represents
the compiler's understanding of whether this expression can currently contain null, if
this expression can be used as an rvalue.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.NullableAnnotation">
<summary>
Represents the nullability of values that can be assigned
to an expression used as an lvalue.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.NullableAnnotation.None">
<summary>
The expression has not been analyzed, or the syntax is
not an expression (such as a statement).
</summary>
<remarks>
There are a few different reasons the expression could
have not been analyzed:
1) The symbol producing the expression comes from
a method that has not been annotated, such as
invoking a C# 7.3 or earlier method, or a
method in this compilation that is in a disabled
context.
2) Nullable is completely disabled in this
compilation.
</remarks>
</member>
<member name="F:Microsoft.CodeAnalysis.NullableAnnotation.NotAnnotated">
<summary>
The expression is not annotated (does not have a ?).
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.NullableAnnotation.Annotated">
<summary>
The expression is annotated (does have a ?).
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.NullableFlowState">
<summary>
Represents the compiler's analysis of whether an expression may be null
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.NullableFlowState.None">
<summary>
Syntax is not an expression, or was not analyzed.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.NullableFlowState.NotNull">
<summary>
Expression is not null.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.NullableFlowState.MaybeNull">
<summary>
Expression may be null.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.NullableFlowStateExtensions.ToAnnotation(Microsoft.CodeAnalysis.NullableFlowState)">
<summary>
This method directly converts a <see cref="T:Microsoft.CodeAnalysis.NullableFlowState"/> to a <see cref="T:Microsoft.CodeAnalysis.NullableAnnotation"/>,
ignoring the <see cref="T:Microsoft.CodeAnalysis.ITypeSymbol"/> to which it is attached. It should only be used when converting
an RValue flow state to an RValue annotation for returning via the public API. For general use, please
use Microsoft.CodeAnalysis.CSharp.Symbols.TypeWithState.ToTypeWithAnnotations.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.DllImportData">
<summary>
Information that describes how a method from the underlying Platform is to be invoked.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.DllImportData.ModuleName">
<summary>
Module name. Null if value specified in the attribute is not valid.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.DllImportData.EntryPointName">
<summary>
Name of the native entry point or null if not specified (the effective name is the same as the name of the target method).
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.DllImportData.ExactSpelling">
<summary>
Controls whether the <see cref="P:Microsoft.CodeAnalysis.DllImportData.CharacterSet"/> field causes the common language runtime
to search an unmanaged DLL for entry-point names other than the one specified.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.DllImportData.CharacterSet">
<summary>
Indicates how to marshal string parameters and controls name mangling.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.DllImportData.SetLastError">
<summary>
Indicates whether the callee calls the SetLastError Win32 API function before returning from the attributed method.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.DllImportData.CallingConvention">
<summary>
Indicates the calling convention of an entry point.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.DllImportData.BestFitMapping">
<summary>
Enables or disables best-fit mapping behavior when converting Unicode characters to ANSI characters.
Null if not specified (the setting for the containing type or assembly should be used, <see cref="T:System.Runtime.InteropServices.BestFitMappingAttribute"/>).
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.DllImportData.ThrowOnUnmappableCharacter">
<summary>
Enables or disables the throwing of an exception on an unmappable Unicode character that is converted to an ANSI "?" character.
Null if not specified.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.RefKind">
<summary>
Denotes the kind of reference.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.RefKind.None">
<summary>
Indicates a "value" parameter or return type.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.RefKind.Ref">
<summary>
Indicates a "ref" parameter or return type.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.RefKind.Out">
<summary>
Indicates an "out" parameter.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.RefKind.In">
<summary>
Indicates an "in" parameter.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.RefKind.RefReadOnly">
<summary>
Indicates a "ref readonly" return type.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.SymbolEqualityComparer">
<summary>
Allows for the comparison of two <see cref="T:Microsoft.CodeAnalysis.ISymbol"/> instances
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolEqualityComparer.Default">
<summary>
Compares two <see cref="T:Microsoft.CodeAnalysis.ISymbol"/> instances based on the default comparison rules, equivalent to calling <see cref="M:System.IEquatable`1.Equals(`0)"/>
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolEqualityComparer.IncludeNullability">
<summary>
Compares two <see cref="T:Microsoft.CodeAnalysis.ISymbol"/> instances, considering their nullability
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SymbolEqualityComparer.Equals(Microsoft.CodeAnalysis.ISymbol,Microsoft.CodeAnalysis.ISymbol)">
<summary>
Determines if two <see cref="T:Microsoft.CodeAnalysis.ISymbol" /> instances are equal according to the rules of this comparer
</summary>
<param name="x">The first symbol to compare</param>
<param name="y">The second symbol to compare</param>
<returns>True if the symbols are equivalent</returns>
</member>
<member name="T:Microsoft.CodeAnalysis.SymbolKind">
<summary>
Specifies the possible kinds of symbols.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolKind.Alias">
<summary>
Symbol is an alias.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolKind.ArrayType">
<summary>
Symbol is an array type.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolKind.Assembly">
<summary>
Symbol is an assembly.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolKind.DynamicType">
<summary>
Symbol is a dynamic type.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolKind.ErrorType">
<summary>
Symbol that represents an error
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolKind.Event">
<summary>
Symbol is an Event.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolKind.Field">
<summary>
Symbol is a field.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolKind.Label">
<summary>
Symbol is a label.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolKind.Local">
<summary>
Symbol is a local.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolKind.Method">
<summary>
Symbol is a method.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolKind.NetModule">
<summary>
Symbol is a netmodule.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolKind.NamedType">
<summary>
Symbol is a named type (e.g. class).
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolKind.Namespace">
<summary>
Symbol is a namespace.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolKind.Parameter">
<summary>
Symbol is a parameter.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolKind.PointerType">
<summary>
Symbol is a pointer type.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolKind.Property">
<summary>
Symbol is a property.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolKind.RangeVariable">
<summary>
Symbol is a range variable of a query expression.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolKind.TypeParameter">
<summary>
Symbol is a type parameter.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolKind.Preprocessing">
<summary>
Symbol is a preprocessing/conditional compilation constant.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolKind.Discard">
<summary>
Symbol represents a value that is discarded, e.g. in M(out _)
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SymbolKind.FunctionPointerType">
<summary>
Symbol represents a function pointer type
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.TypeCompareKind">
<summary>
Specifies the different kinds of comparison between types.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.TypedConstant">
<summary>
Represents a constant value used as an argument to a custom attribute.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.TypedConstant.Kind">
<summary>
The kind of the constant.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.TypedConstant.Type">
<summary>
Returns the <see cref="T:Microsoft.CodeAnalysis.ITypeSymbol"/> of the constant,
or null if the type can't be determined (error).
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.TypedConstant.IsNull">
<summary>
True if the constant represents a null reference.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.TypedConstant.Value">
<summary>
The value for a non-array constant.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.TypedConstant.ValueInternal">
<summary>
Unlike <see cref="P:Microsoft.CodeAnalysis.TypedConstant.Value"/> returns <see cref="T:Microsoft.CodeAnalysis.Symbols.ISymbolInternal"/> when the value is a symbol.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.TypedConstant.Values">
<summary>
The value for a <see cref="T:Microsoft.CodeAnalysis.TypedConstant"/> array.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.TypedConstant.GetTypedConstantKind(Microsoft.CodeAnalysis.Symbols.ITypeSymbolInternal,Microsoft.CodeAnalysis.Compilation)">
<remarks>
TypedConstant isn't computing its own kind from the type symbol because it doesn't
have a way to recognize the well-known type System.Type.
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.TypedConstantKind">
<summary>
Represents the kind of a TypedConstant.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.TypedConstantValue">
<summary>
Represents a simple value or a read-only array of <see cref="T:Microsoft.CodeAnalysis.TypedConstant"/>.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.TypedConstantValue.IsNull">
<summary>
True if the constant represents a null literal.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.TypeKind">
<summary>
Enumeration for possible kinds of type symbols.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.TypeKind.Unknown">
<summary>
Type's kind is undefined.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.TypeKind.Array">
<summary>
Type is an array type.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.TypeKind.Class">
<summary>
Type is a class.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.TypeKind.Delegate">
<summary>
Type is a delegate.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.TypeKind.Dynamic">
<summary>
Type is dynamic.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.TypeKind.Enum">
<summary>
Type is an enumeration.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.TypeKind.Error">
<summary>
Type is an error type.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.TypeKind.Interface">
<summary>
Type is an interface.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.TypeKind.Module">
<summary>
Type is a module.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.TypeKind.Pointer">
<summary>
Type is a pointer.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.TypeKind.Struct">
<summary>
Type is a C# struct or VB Structure
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.TypeKind.Structure">
<summary>
Type is a C# struct or VB Structure
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.TypeKind.TypeParameter">
<summary>
Type is a type parameter.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.TypeKind.Submission">
<summary>
Type is an interactive submission.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.TypeKind.FunctionPointer">
<summary>
Type is a function pointer.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.TypeLayout">
<summary>
Type layout information.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.TypeLayout.Kind">
<summary>
Layout kind (Layout flags in metadata).
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.TypeLayout.Alignment">
<summary>
Field alignment (PackingSize field in metadata).
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.TypeLayout.Size">
<summary>
Size of the type.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.TypeParameterKind">
<summary>
Represents the different kinds of type parameters.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.TypeParameterKind.Type">
<summary>
Type parameter of a named type. For example: <c>T</c> in <c><![CDATA[List<T>]]></c>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.TypeParameterKind.Method">
<summary>
Type parameter of a method. For example: <c>T</c> in <c><![CDATA[void M<T>()]]></c>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.TypeParameterKind.Cref">
<summary>
Type parameter in a <c>cref</c> attribute in XML documentation comments. For example: <c>T</c> in <c><![CDATA[<see cref="List{T}"/>]]></c>.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.VarianceKind">
<summary>
An enumeration declaring the kinds of variance supported for generic type parameters.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.VarianceKind.None">
<summary>
Invariant.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.VarianceKind.Out">
<summary>
Covariant (<c>out</c>).
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.VarianceKind.In">
<summary>
Contravariant (<c>in</c>).
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.WellKnownMemberNames">
<summary>
Specifies the member names known to the compiler (such as <c>.ctor</c> or <c>op_Explicit</c>).
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.EnumBackingFieldName">
<summary>
Name of the enum backing field.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.InstanceConstructorName">
<summary>
The name assigned to an instance constructor.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.StaticConstructorName">
<summary>
The name assigned to the static constructor.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.Indexer">
<summary>
The symbol name assigned to all indexers, other than explicit interface implementations.
</summary>
<remarks>
Will not correspond to the name that appears in metadata.
</remarks>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.DestructorName">
<summary>
The name assigned to the destructor.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.DelegateInvokeName">
<summary>
The name assigned to the delegate <c>Invoke</c> method.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.DelegateBeginInvokeName">
<summary>
The name assigned to the delegate <c>BeginInvoke</c> method.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.DelegateEndInvokeName">
<summary>
The name assigned to the delegate <c>EndInvoke</c> method.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.EntryPointMethodName">
<summary>
The name of an entry point method.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.DefaultScriptClassName">
<summary>
The default fully qualified name of a <c>Script</c> class.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.ObjectToString">
<summary>
The name assigned to <c>Object.ToString</c> method.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.ObjectEquals">
<summary>
The name assigned to <c>Object.Equals</c> method.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.ObjectGetHashCode">
<summary>
The name assigned to <c>Object.GetHashCode</c> method.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.ImplicitConversionName">
<summary>
The name assigned to an implicit (widening) conversion.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.ExplicitConversionName">
<summary>
The name assigned to an explicit (narrowing) conversion.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.AdditionOperatorName">
<summary>
The name assigned to the Addition operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.BitwiseAndOperatorName">
<summary>
The name assigned to the BitwiseAnd operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.BitwiseOrOperatorName">
<summary>
The name assigned to the BitwiseOr operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.DecrementOperatorName">
<summary>
The name assigned to the Decrement operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.DivisionOperatorName">
<summary>
The name assigned to the Division operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.EqualityOperatorName">
<summary>
The name assigned to the Equality operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.ExclusiveOrOperatorName">
<summary>
The name assigned to the ExclusiveOr operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.FalseOperatorName">
<summary>
The name assigned to the False operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.GreaterThanOperatorName">
<summary>
The name assigned to the GreaterThan operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.GreaterThanOrEqualOperatorName">
<summary>
The name assigned to the GreaterThanOrEqual operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.IncrementOperatorName">
<summary>
The name assigned to the Increment operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.InequalityOperatorName">
<summary>
The name assigned to the Inequality operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.LeftShiftOperatorName">
<summary>
The name assigned to the LeftShift operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.UnsignedLeftShiftOperatorName">
<summary>
The name assigned to the UnsignedLeftShift operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.LessThanOperatorName">
<summary>
The name assigned to the LessThan operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.LessThanOrEqualOperatorName">
<summary>
The name assigned to the LessThanOrEqual operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.LogicalNotOperatorName">
<summary>
The name assigned to the LogicalNot operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.LogicalOrOperatorName">
<summary>
The name assigned to the LogicalOr operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.LogicalAndOperatorName">
<summary>
The name assigned to the LogicalAnd operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.ModulusOperatorName">
<summary>
The name assigned to the Modulus operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.MultiplyOperatorName">
<summary>
The name assigned to the Multiply operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.OnesComplementOperatorName">
<summary>
The name assigned to the OnesComplement operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.RightShiftOperatorName">
<summary>
The name assigned to the RightShift operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.UnsignedRightShiftOperatorName">
<summary>
The name assigned to the UnsignedRightShift operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.SubtractionOperatorName">
<summary>
The name assigned to the Subtraction operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.TrueOperatorName">
<summary>
The name assigned to the True operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.UnaryNegationOperatorName">
<summary>
The name assigned to the UnaryNegation operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.UnaryPlusOperatorName">
<summary>
The name assigned to the UnaryPlus operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.ConcatenateOperatorName">
<summary>
The name assigned to the Concatenate operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.ExponentOperatorName">
<summary>
The name assigned to the Exponent operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.IntegerDivisionOperatorName">
<summary>
The name assigned to the IntegerDivision operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.LikeOperatorName">
<summary>
The name assigned to the <c>Like</c> operator.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.GetEnumeratorMethodName">
<summary>
The required name for the <c>GetEnumerator</c> method used in a ForEach statement.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.GetAsyncEnumeratorMethodName">
<summary>
The required name for the <c>GetAsyncEnumerator</c> method used in a ForEach statement.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.MoveNextAsyncMethodName">
<summary>
The required name for the <c>MoveNextAsync</c> method used in a ForEach-await statement.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.DeconstructMethodName">
<summary>
The required name for the <c>Deconstruct</c> method used in a deconstruction.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.MoveNextMethodName">
<summary>
The required name for the <c>MoveNext</c> method used in a ForEach statement.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.CurrentPropertyName">
<summary>
The required name for the <c>Current</c> property used in a ForEach statement.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.ValuePropertyName">
<summary>
The required name for the <see cref="P:System.Nullable`1.Value"/> property used in
a ForEach statement when the collection is a nullable struct.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.CollectionInitializerAddMethodName">
<summary>
The name for the <c>Add</c> method to be invoked for each element in a collection initializer expression
(see C# Specification, §7.6.10.3 Collection initializers).
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.GetAwaiter">
<summary>
The required name for the <c>GetAwaiter</c> method used to obtain an awaiter for a task
(see C# Specification, §7.7.7.1 Awaitable expressions).
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.IsCompleted">
<summary>
The required name for the <c>IsCompleted</c> property used to determine if a task is already complete
(see C# Specification, §7.7.7.1 Awaitable expressions).
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.GetResult">
<summary>
The required name for the <c>GetResult</c> method used to obtain the outcome of a task once it is complete
(see C# Specification, §7.7.7.1 Awaitable expressions).
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.OnCompleted">
<summary>
The name of the <see cref="M:System.Runtime.CompilerServices.INotifyCompletion.OnCompleted(System.Action)"/> method used to register a resumption delegate
(see C# Specification, §7.7.7.1 Awaitable expressions).
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.DisposeMethodName">
<summary>
The required name for the <c>Dispose</c> method used in a Using statement.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.DisposeAsyncMethodName">
<summary>
The required name for the <c>DisposeAsync</c> method used in an await using statement.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.CountPropertyName">
<summary>
The required name for the <c>Count</c> property used in a pattern-based Index or Range indexer.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.LengthPropertyName">
<summary>
The required name for the <c>Length</c> property used in a pattern-based Index or Range indexer.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.SliceMethodName">
<summary>
The required name for the <c>Slice</c> method used in a pattern-based Range indexer.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.TopLevelStatementsEntryPointMethodName">
<summary>
The name of an entry point method synthesized for top-level statements.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownMemberNames.TopLevelStatementsEntryPointTypeName">
<summary>
The name of a type synthesized for a top-level statements entry point method.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.Syntax.AbstractWarningStateMap`1._warningStateMapEntries">
<summary>
List of entries sorted in source order, each of which captures a
position in the supplied syntax tree and the set of diagnostics (warnings)
whose reporting should either be suppressed or enabled at this position.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Syntax.AbstractWarningStateMap`1.CreateWarningStateMapEntries(Microsoft.CodeAnalysis.SyntaxTree)">
<summary>
Returns list of entries sorted in source order, each of which captures a
position in the supplied syntax tree and the set of diagnostics (warnings)
whose reporting should either be suppressed or enabled at this position.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Syntax.AbstractWarningStateMap`1.GetWarningState(System.String,System.Int32)">
<summary>
Returns the reporting state for the supplied diagnostic id at the supplied position
in the associated syntax tree.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Syntax.AbstractWarningStateMap`1.GetEntryAtOrBeforePosition(System.Int32)">
<summary>
Gets the entry with the largest position less than or equal to supplied position.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Syntax.AbstractWarningStateMap`1.WarningStateMapEntry">
<summary>
Struct that represents an entry in the warning state map. Sorts by position in the associated syntax tree.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.Syntax.InternalSyntax.SeparatedSyntaxList`1.GetSeparator(System.Int32)">
<summary>
Gets the separator at the given index in this list.
</summary>
<param name="index">The index.</param>
<returns></returns>
</member>
<member name="P:Microsoft.CodeAnalysis.Syntax.InternalSyntax.SeparatedSyntaxListBuilder`1.UnderlyingBuilder">
<summary>
WARN WARN WARN: This should be used with extreme caution - the underlying builder does
not give any indication that it is from a separated syntax list but the constraints
(node, token, node, token, ...) should still be maintained.
</summary>
<remarks>
In order to avoid creating a separate pool of SeparatedSyntaxListBuilders, we expose
our underlying SyntaxListBuilder to SyntaxListPool.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.Syntax.InternalSyntax.SyntaxList.WithLotsOfChildren.FindSlotIndexContainingOffset(System.Int32)">
<summary>
Find the slot that contains the given offset.
</summary>
<param name="offset">The target offset. Must be between 0 and <see cref="P:Microsoft.CodeAnalysis.GreenNode.FullWidth"/>.</param>
<returns>The slot index of the slot containing the given offset.</returns>
<remarks>
This implementation uses a binary search to find the first slot that contains
the given offset.
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.Syntax.InternalSyntax.GreenStats">
<summary>
Provides caching functionality for green nonterminals with up to 3 children.
Example:
When constructing a node with given kind, flags, child1 and child2, we can look up
in the cache whether we already have a node that contains same kind, flags,
child1 and child2 and use that.
For the purpose of children comparison, reference equality is used as a much cheaper
alternative to the structural/recursive equality. This implies that in order to de-duplicate
a node to a cache node, the children of two nodes must be already de-duplicated.
When adding a node to the cache we verify that cache does contain node's children,
since otherwise there is no reason for the node to be used.
Tokens/nulls are for this purpose considered deduplicated. Indeed most of the tokens
are deduplicated via quick-scanner caching, so we just assume they all are.
As a result of above, "fat" nodes with 4 or more children or their recursive parents
will never be in the cache. This naturally limits the typical single cache item to be
a relatively simple expression. We do not want the cache to be completely unbounded
on the item size.
While it still may be possible to store a gigantic nested binary expression,
it should be a rare occurrence.
We only consider "normal" nodes to be cacheable.
Nodes with diagnostics/annotations/directives/skipped, etc... have more complicated identity
and are not likely to be repetitive.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.Syntax.TranslationSyntaxReference">
<summary>
This is a SyntaxReference implementation that lazily translates the result (SyntaxNode) of the
original syntax reference to another one.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.AnnotationExtensions.WithAdditionalAnnotations``1(``0,Microsoft.CodeAnalysis.SyntaxAnnotation[])">
<summary>
Creates a new node identical to this node with the specified annotations attached.
</summary>
<param name="node">Original node.</param>
<param name="annotations">Annotations to be added to the new node.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.AnnotationExtensions.WithAdditionalAnnotations``1(``0,System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.SyntaxAnnotation})">
<summary>
Creates a new node identical to this node with the specified annotations attached.
</summary>
<param name="node">Original node.</param>
<param name="annotations">Annotations to be added to the new node.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.AnnotationExtensions.WithoutAnnotations``1(``0,Microsoft.CodeAnalysis.SyntaxAnnotation[])">
<summary>
Creates a new node identical to this node with the specified annotations removed.
</summary>
<param name="node">Original node.</param>
<param name="annotations">Annotations to be removed from the new node.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.AnnotationExtensions.WithoutAnnotations``1(``0,System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.SyntaxAnnotation})">
<summary>
Creates a new node identical to this node with the specified annotations removed.
</summary>
<param name="node">Original node.</param>
<param name="annotations">Annotations to be removed from the new node.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.AnnotationExtensions.WithoutAnnotations``1(``0,System.String)">
<summary>
Creates a new node identical to this node with the annotations of the specified kind removed.
</summary>
<param name="node">Original node.</param>
<param name="annotationKind">The kind of annotation to remove.</param>
</member>
<member name="P:Microsoft.CodeAnalysis.ChildSyntaxList.Count">
<summary>
Gets the number of children contained in the <see cref="T:Microsoft.CodeAnalysis.ChildSyntaxList"/>.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ChildSyntaxList.Item(System.Int32)">
<summary>Gets the child at the specified index.</summary>
<param name="index">The zero-based index of the child to get.</param>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="index"/> is less than 0.-or-<paramref name="index" /> is equal to or greater than <see cref="P:Microsoft.CodeAnalysis.ChildSyntaxList.Count"/>. </exception>
</member>
<member name="M:Microsoft.CodeAnalysis.ChildSyntaxList.ItemInternal(Microsoft.CodeAnalysis.SyntaxNode,System.Int32)">
<summary>
internal indexer that does not verify index.
Used when caller has already ensured that index is within bounds.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.ChildSyntaxList.ChildThatContainsPosition(Microsoft.CodeAnalysis.SyntaxNode,System.Int32)">
<summary>
Locate the node or token that is a child of the given <see cref="T:Microsoft.CodeAnalysis.SyntaxNode"/> and contains the given position.
</summary>
<param name="node">The <see cref="T:Microsoft.CodeAnalysis.SyntaxNode"/> to search.</param>
<param name="targetPosition">The position.</param>
<returns>The node or token that spans the given position.</returns>
<remarks>
Assumes that <paramref name="targetPosition"/> is within the span of <paramref name="node"/>.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.ChildSyntaxList.ItemInternalAsNode(Microsoft.CodeAnalysis.SyntaxNode,System.Int32)">
<summary>
internal indexer that does not verify index.
Used when caller has already ensured that index is within bounds.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.ChildSyntaxList.First">
<summary>
Returns the first child in the list.
</summary>
<returns>The first child in the list.</returns>
<exception cref="T:System.InvalidOperationException">The list is empty.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.ChildSyntaxList.Last">
<summary>
Returns the last child in the list.
</summary>
<returns>The last child in the list.</returns>
<exception cref="T:System.InvalidOperationException">The list is empty.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.ChildSyntaxList.Reverse">
<summary>
Returns a list which contains all children of <see cref="T:Microsoft.CodeAnalysis.ChildSyntaxList"/> in reversed order.
</summary>
<returns><see cref="T:Microsoft.CodeAnalysis.ChildSyntaxList.Reversed"/> which contains all children of <see cref="T:Microsoft.CodeAnalysis.ChildSyntaxList"/> in reversed order</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.ChildSyntaxList.GetEnumerator">
<summary>Returns an enumerator that iterates through the <see cref="T:Microsoft.CodeAnalysis.ChildSyntaxList"/>.</summary>
<returns>A <see cref="T:Microsoft.CodeAnalysis.ChildSyntaxList.Enumerator"/> for the <see cref="T:Microsoft.CodeAnalysis.ChildSyntaxList"/>.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.ChildSyntaxList.Equals(System.Object)">
<summary>Determines whether the specified object is equal to the current instance.</summary>
<returns>true if the specified object is a <see cref="T:Microsoft.CodeAnalysis.ChildSyntaxList" /> structure and is equal to the current instance; otherwise, false.</returns>
<param name="obj">The object to be compared with the current instance.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.ChildSyntaxList.Equals(Microsoft.CodeAnalysis.ChildSyntaxList)">
<summary>Determines whether the specified <see cref="T:Microsoft.CodeAnalysis.ChildSyntaxList" /> structure is equal to the current instance.</summary>
<returns>true if the specified <see cref="T:Microsoft.CodeAnalysis.ChildSyntaxList" /> structure is equal to the current instance; otherwise, false.</returns>
<param name="other">The <see cref="T:Microsoft.CodeAnalysis.ChildSyntaxList" /> structure to be compared with the current instance.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.ChildSyntaxList.GetHashCode">
<summary>Returns the hash code for the current instance.</summary>
<returns>A 32-bit signed integer hash code.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.ChildSyntaxList.op_Equality(Microsoft.CodeAnalysis.ChildSyntaxList,Microsoft.CodeAnalysis.ChildSyntaxList)">
<summary>Indicates whether two <see cref="T:Microsoft.CodeAnalysis.ChildSyntaxList" /> structures are equal.</summary>
<returns>true if <paramref name="list1" /> is equal to <paramref name="list2" />; otherwise, false.</returns>
<param name="list1">The <see cref="T:Microsoft.CodeAnalysis.ChildSyntaxList" /> structure on the left side of the equality operator.</param>
<param name="list2">The <see cref="T:Microsoft.CodeAnalysis.ChildSyntaxList" /> structure on the right side of the equality operator.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.ChildSyntaxList.op_Inequality(Microsoft.CodeAnalysis.ChildSyntaxList,Microsoft.CodeAnalysis.ChildSyntaxList)">
<summary>Indicates whether two <see cref="T:Microsoft.CodeAnalysis.ChildSyntaxList" /> structures are unequal.</summary>
<returns>true if <paramref name="list1" /> is equal to <paramref name="list2" />; otherwise, false.</returns>
<param name="list1">The <see cref="T:Microsoft.CodeAnalysis.ChildSyntaxList" /> structure on the left side of the inequality operator.</param>
<param name="list2">The <see cref="T:Microsoft.CodeAnalysis.ChildSyntaxList" /> structure on the right side of the inequality operator.</param>
</member>
<member name="T:Microsoft.CodeAnalysis.ChildSyntaxList.Enumerator">
<summary>Enumerates the elements of a <see cref="T:Microsoft.CodeAnalysis.ChildSyntaxList" />.</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.ChildSyntaxList.Enumerator.MoveNext">
<summary>Advances the enumerator to the next element of the <see cref="T:Microsoft.CodeAnalysis.ChildSyntaxList" />.</summary>
<returns>true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.</returns>
</member>
<member name="P:Microsoft.CodeAnalysis.ChildSyntaxList.Enumerator.Current">
<summary>Gets the element at the current position of the enumerator.</summary>
<returns>The element in the <see cref="T:Microsoft.CodeAnalysis.ChildSyntaxList" /> at the current position of the enumerator.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.ChildSyntaxList.Enumerator.Reset">
<summary>Sets the enumerator to its initial position, which is before the first element in the collection.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ChildSyntaxList.EnumeratorImpl.Current">
<summary>
Gets the element in the collection at the current position of the enumerator.
</summary>
<returns>
The element in the collection at the current position of the enumerator.
</returns>
</member>
<member name="P:Microsoft.CodeAnalysis.ChildSyntaxList.EnumeratorImpl.System#Collections#IEnumerator#Current">
<summary>
Gets the element in the collection at the current position of the enumerator.
</summary>
<returns>
The element in the collection at the current position of the enumerator.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.ChildSyntaxList.EnumeratorImpl.MoveNext">
<summary>
Advances the enumerator to the next element of the collection.
</summary>
<returns>
true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.ChildSyntaxList.EnumeratorImpl.Reset">
<summary>
Sets the enumerator to its initial position, which is before the first element in the collection.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.ChildSyntaxList.EnumeratorImpl.Dispose">
<summary>
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ChildSyntaxList.Reversed.EnumeratorImpl.Current">
<summary>
Gets the element in the collection at the current position of the enumerator.
</summary>
<returns>
The element in the collection at the current position of the enumerator.
</returns>
</member>
<member name="P:Microsoft.CodeAnalysis.ChildSyntaxList.Reversed.EnumeratorImpl.System#Collections#IEnumerator#Current">
<summary>
Gets the element in the collection at the current position of the enumerator.
</summary>
<returns>
The element in the collection at the current position of the enumerator.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.ChildSyntaxList.Reversed.EnumeratorImpl.MoveNext">
<summary>
Advances the enumerator to the next element of the collection.
</summary>
<returns>
true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.
</returns>
<exception cref="T:System.InvalidOperationException">The collection was modified after the enumerator was created. </exception>
</member>
<member name="M:Microsoft.CodeAnalysis.ChildSyntaxList.Reversed.EnumeratorImpl.Reset">
<summary>
Sets the enumerator to its initial position, which is before the first element in the collection.
</summary>
<exception cref="T:System.InvalidOperationException">The collection was modified after the enumerator was created. </exception>
</member>
<member name="M:Microsoft.CodeAnalysis.ChildSyntaxList.Reversed.EnumeratorImpl.Dispose">
<summary>
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.GreenNode.EnumerateNodes">
<summary>
Enumerates all nodes of the tree rooted by this node (including this node).
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.GreenNode.FindSlotIndexContainingOffset(System.Int32)">
<summary>
Find the slot that contains the given offset.
</summary>
<param name="offset">The target offset. Must be between 0 and <see cref="P:Microsoft.CodeAnalysis.GreenNode.FullWidth"/>.</param>
<returns>The slot index of the slot containing the given offset.</returns>
<remarks>
The base implementation is a linear search. This should be overridden
if a derived class can implement it more efficiently.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.GreenNode.AddError(Microsoft.CodeAnalysis.DiagnosticInfo)">
<summary>
Add an error to the given node, creating a new node that is the same except it has no parent,
and has the given error attached to it. The error span is the entire span of this node.
</summary>
<param name="err">The error to attach to this node</param>
<returns>A new node, with no parent, that has this error added to it.</returns>
<remarks>Since nodes are immutable, the only way to create nodes with errors attached is to create a node without an error,
then add an error with this method to create another node.</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.ICompilationUnitSyntax">
<summary>
Interface implemented by any node that is the root 'CompilationUnit' of a <see cref="T:Microsoft.CodeAnalysis.SyntaxTree"/>. i.e.
any node returned by <see cref="M:Microsoft.CodeAnalysis.SyntaxTree.GetRoot(System.Threading.CancellationToken)"/> where <see cref="P:Microsoft.CodeAnalysis.SyntaxTree.HasCompilationUnitRoot"/>
is <see langword="true"/> will implement this interface.
This interface provides a common way to both easily find the root of a <see cref="T:Microsoft.CodeAnalysis.SyntaxTree"/>
given any <see cref="T:Microsoft.CodeAnalysis.SyntaxNode"/>, as well as a common way for handling the special
<see cref="P:Microsoft.CodeAnalysis.ICompilationUnitSyntax.EndOfFileToken"/> that is needed to store all final trivia in a <see cref="T:Microsoft.CodeAnalysis.Text.SourceText"/>
that is not owned by any other <see cref="T:Microsoft.CodeAnalysis.SyntaxToken"/>.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.ICompilationUnitSyntax.EndOfFileToken">
<summary>
Represents the end of the source file. This <see cref="T:Microsoft.CodeAnalysis.SyntaxToken"/> may have
<see cref="T:Microsoft.CodeAnalysis.SyntaxTrivia"/> (whitespace, comments, directives) attached to it.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.ISkippedTokensTriviaSyntax">
<summary>
Represents structured trivia that contains skipped tokens. This is implemented by
<see cref="T:Microsoft.CodeAnalysis.CSharp.Syntax.SkippedTokensTriviaSyntax"/> and
<see cref="T:Microsoft.CodeAnalysis.VisualBasic.Syntax.SkippedTokensTriviaSyntax"/>.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.IStructuredTriviaSyntax">
<summary>
Represents the root node of a structured trivia tree (for example, a preprocessor directive
or a documentation comment). From this root node you can traverse back up to the containing
trivia in the outer tree that contains it.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.IStructuredTriviaSyntax.ParentTrivia">
<summary>
Returns the parent trivia syntax for this structured trivia syntax.
</summary>
<returns>The parent trivia syntax for this structured trivia syntax.</returns>
</member>
<member name="T:Microsoft.CodeAnalysis.LineDirectiveMap`1">
<summary>
The LineDirectiveMap is created to enable translating positions, using the #line directives
in a file. The basic implementation creates an ordered array of line mapping entries, one
for each #line directive in the file (plus one at the beginning). If the file has no
directives, then the array has just one element in it. To map line numbers, a binary search
of the mapping entries is done and nearest line mapping is applied.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.LineDirectiveMap`1.GetLineVisibility(Microsoft.CodeAnalysis.Text.SourceText,System.Int32)">
<summary>
Determines whether the position is considered to be hidden from the debugger or not.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.LineDirectiveMap`1.TranslateSpanAndVisibility(Microsoft.CodeAnalysis.Text.SourceText,System.String,Microsoft.CodeAnalysis.Text.TextSpan,System.Boolean@)">
<summary>
Combines TranslateSpan and IsHiddenPosition to not search the entries twice when emitting sequence points
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.LineDirectiveMap`1.HasAnyHiddenRegions">
<summary>
Are there any hidden regions in the map?
</summary>
<returns>True if there's at least one hidden region in the map.</returns>
</member>
<member name="T:Microsoft.CodeAnalysis.LineDirectiveMap`1.PositionState">
<summary>
Enum that describes the state related to the #line or #externalsource directives at a position in source.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.LineDirectiveMap`1.PositionState.Unknown">
<summary>
Used in VB when the position is not hidden, but it's not known yet that there is a (nonempty) #ExternalSource
following.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.LineDirectiveMap`1.PositionState.Unmapped">
<summary>
Used in C# for spans outside of #line directives
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.LineDirectiveMap`1.PositionState.Remapped">
<summary>
Used in C# for spans inside of "#line linenumber" directive
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.LineDirectiveMap`1.PositionState.RemappedAfterUnknown">
<summary>
Used in VB for spans inside of a "#ExternalSource" directive that followed an unknown span
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.LineDirectiveMap`1.PositionState.RemappedAfterHidden">
<summary>
Used in VB for spans inside of a "#ExternalSource" directive that followed a hidden span
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.LineDirectiveMap`1.PositionState.Hidden">
<summary>
Used in C# and VB for spans that are inside of #line hidden (C#) or outside of #ExternalSource (VB)
directives
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.LineVisibility">
<summary>
The state of the visibility of a line.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.LineVisibility.BeforeFirstLineDirective">
<summary>
The line is located before any #line directive and there is at least one #line directive present in this syntax tree.
This enum value is used for C# only to enable the consumer to define how to interpret the lines before the first
line directive.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.LineVisibility.Hidden">
<summary>
The line is following a #line hidden directive.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.LineVisibility.Visible">
<summary>
The line is following a #line default directive or a #line directive with at least a line number.
If there is no line directive at all, Visible is returned for all lines.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SeparatedSyntaxList`1.GetSeparator(System.Int32)">
<summary>
Gets the separator at the given index in this list.
</summary>
<param name="index">The index.</param>
<returns></returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SeparatedSyntaxList`1.GetSeparators">
<summary>
Returns the sequence of just the separator tokens.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SeparatedSyntaxList`1.FullSpan">
<summary>
The absolute span of the list elements in characters, including the leading and trailing trivia of the first and last elements.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SeparatedSyntaxList`1.Span">
<summary>
The absolute span of the list elements in characters, not including the leading and trailing trivia of the first and last elements.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SeparatedSyntaxList`1.ToString">
<summary>
Returns the string representation of the nodes in this list including separators but not including
the first node's leading trivia and the last node or token's trailing trivia.
</summary>
<returns>
The string representation of the nodes in this list including separators but not including
the first node's leading trivia and the last node or token's trailing trivia.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SeparatedSyntaxList`1.ToFullString">
<summary>
Returns the full string representation of the nodes in this list including separators,
the first node's leading trivia, and the last node or token's trailing trivia.
</summary>
<returns>
The full string representation of the nodes in this list including separators including separators,
the first node's leading trivia, and the last node or token's trailing trivia.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SeparatedSyntaxList`1.Add(`0)">
<summary>
Creates a new list with the specified node added to the end.
</summary>
<param name="node">The node to add.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SeparatedSyntaxList`1.AddRange(System.Collections.Generic.IEnumerable{`0})">
<summary>
Creates a new list with the specified nodes added to the end.
</summary>
<param name="nodes">The nodes to add.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SeparatedSyntaxList`1.Insert(System.Int32,`0)">
<summary>
Creates a new list with the specified node inserted at the index.
</summary>
<param name="index">The index to insert at.</param>
<param name="node">The node to insert.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SeparatedSyntaxList`1.InsertRange(System.Int32,System.Collections.Generic.IEnumerable{`0})">
<summary>
Creates a new list with the specified nodes inserted at the index.
</summary>
<param name="index">The index to insert at.</param>
<param name="nodes">The nodes to insert.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SeparatedSyntaxList`1.RemoveAt(System.Int32)">
<summary>
Creates a new list with the element at the specified index removed.
</summary>
<param name="index">The index of the element to remove.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SeparatedSyntaxList`1.Remove(`0)">
<summary>
Creates a new list with specified element removed.
</summary>
<param name="node">The element to remove.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SeparatedSyntaxList`1.Replace(`0,`0)">
<summary>
Creates a new list with the specified element replaced by the new node.
</summary>
<param name="nodeInList">The element to replace.</param>
<param name="newNode">The new node.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SeparatedSyntaxList`1.ReplaceRange(`0,System.Collections.Generic.IEnumerable{`0})">
<summary>
Creates a new list with the specified element replaced by the new nodes.
</summary>
<param name="nodeInList">The element to replace.</param>
<param name="newNodes">The new nodes.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SeparatedSyntaxList`1.ReplaceSeparator(Microsoft.CodeAnalysis.SyntaxToken,Microsoft.CodeAnalysis.SyntaxToken)">
<summary>
Creates a new list with the specified separator token replaced with the new separator.
</summary>
<param name="separatorToken">The separator token to be replaced.</param>
<param name="newSeparator">The new separator token.</param>
</member>
<member name="T:Microsoft.CodeAnalysis.SyntaxAnnotation">
<summary>
A SyntaxAnnotation is used to annotate syntax elements with additional information.
Since syntax elements are immutable, annotating them requires creating new instances of them
with the annotations attached.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxAnnotation.ElasticAnnotation">
<summary>
A predefined syntax annotation that indicates whether the syntax element has elastic trivia.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.SyntaxList`1">
<summary>
A list of <see cref="T:Microsoft.CodeAnalysis.SyntaxNode"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxList`1.#ctor(`0)">
<summary>
Creates a singleton list of syntax nodes.
</summary>
<param name="node">The single element node.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxList`1.#ctor(System.Collections.Generic.IEnumerable{`0})">
<summary>
Creates a list of syntax nodes.
</summary>
<param name="nodes">A sequence of element nodes.</param>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxList`1.Count">
<summary>
The number of nodes in the list.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxList`1.Item(System.Int32)">
<summary>
Gets the node at the specified index.
</summary>
<param name="index">The zero-based index of the node to get or set.</param>
<returns>The node at the specified index.</returns>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxList`1.FullSpan">
<summary>
The absolute span of the list elements in characters, including the leading and trailing trivia of the first and last elements.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxList`1.Span">
<summary>
The absolute span of the list elements in characters, not including the leading and trailing trivia of the first and last elements.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxList`1.ToString">
<summary>
Returns the string representation of the nodes in this list, not including
the first node's leading trivia and the last node's trailing trivia.
</summary>
<returns>
The string representation of the nodes in this list, not including
the first node's leading trivia and the last node's trailing trivia.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxList`1.ToFullString">
<summary>
Returns the full string representation of the nodes in this list including
the first node's leading trivia and the last node's trailing trivia.
</summary>
<returns>
The full string representation of the nodes in this list including
the first node's leading trivia and the last node's trailing trivia.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxList`1.Add(`0)">
<summary>
Creates a new list with the specified node added at the end.
</summary>
<param name="node">The node to add.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxList`1.AddRange(System.Collections.Generic.IEnumerable{`0})">
<summary>
Creates a new list with the specified nodes added at the end.
</summary>
<param name="nodes">The nodes to add.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxList`1.Insert(System.Int32,`0)">
<summary>
Creates a new list with the specified node inserted at the index.
</summary>
<param name="index">The index to insert at.</param>
<param name="node">The node to insert.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxList`1.InsertRange(System.Int32,System.Collections.Generic.IEnumerable{`0})">
<summary>
Creates a new list with the specified nodes inserted at the index.
</summary>
<param name="index">The index to insert at.</param>
<param name="nodes">The nodes to insert.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxList`1.RemoveAt(System.Int32)">
<summary>
Creates a new list with the element at specified index removed.
</summary>
<param name="index">The index of the element to remove.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxList`1.Remove(`0)">
<summary>
Creates a new list with the element removed.
</summary>
<param name="node">The element to remove.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxList`1.Replace(`0,`0)">
<summary>
Creates a new list with the specified element replaced with the new node.
</summary>
<param name="nodeInList">The element to replace.</param>
<param name="newNode">The new node.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxList`1.ReplaceRange(`0,System.Collections.Generic.IEnumerable{`0})">
<summary>
Creates a new list with the specified element replaced with new nodes.
</summary>
<param name="nodeInList">The element to replace.</param>
<param name="newNodes">The new nodes.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxList`1.First">
<summary>
The first node in the list.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxList`1.FirstOrDefault">
<summary>
The first node in the list or default if the list is empty.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxList`1.Last">
<summary>
The last node in the list.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxList`1.LastOrDefault">
<summary>
The last node in the list or default if the list is empty.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxList`1.Any">
<summary>
True if the list has at least one node.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxList`1.GetEnumerator">
<summary>
Get's the enumerator for this list.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxList`1.IndexOf(`0)">
<summary>
The index of the node in this list, or -1 if the node is not in the list.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.SyntaxNode">
<summary>
Represents a non-terminal node in the syntax tree. This is the language agnostic equivalent of <see
cref="T:Microsoft.CodeAnalysis.CSharp.CSharpSyntaxNode"/> and <see cref="T:Microsoft.CodeAnalysis.VisualBasic.VisualBasicSyntaxNode"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.#ctor(Microsoft.CodeAnalysis.GreenNode,System.Int32,Microsoft.CodeAnalysis.SyntaxTree)">
<summary>
Used by structured trivia which has "parent == null", and therefore must know its
SyntaxTree explicitly when created.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxNode.RawKind">
<summary>
An integer representing the language specific kind of this node.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxNode.Language">
<summary>
The language name that this node is syntax of.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxNode.SyntaxTree">
<summary>
Returns SyntaxTree that owns the node or null if node does not belong to a
SyntaxTree
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxNode.FullSpan">
<summary>
The absolute span of this node in characters, including its leading and trailing trivia.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxNode.Span">
<summary>
The absolute span of this node in characters, not including its leading and trailing trivia.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxNode.SpanStart">
<summary>
Same as accessing <see cref="P:Microsoft.CodeAnalysis.Text.TextSpan.Start"/> on <see cref="P:Microsoft.CodeAnalysis.SyntaxNode.Span"/>.
</summary>
<remarks>
Slight performance improvement.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxNode.Width">
<summary>
The width of the node in characters, not including leading and trailing trivia.
</summary>
<remarks>
The Width property returns the same value as Span.Length, but is somewhat more efficient.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxNode.FullWidth">
<summary>
The complete width of the node in characters, including leading and trailing trivia.
</summary>
<remarks>The FullWidth property returns the same value as FullSpan.Length, but is
somewhat more efficient.</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.GetRedElement(Microsoft.CodeAnalysis.SyntaxNode@,System.Int32)">
<summary>
This works the same as GetRed, but intended to be used in lists
The only difference is that the public parent of the node is not the list,
but the list's parent. (element's grand parent).
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.GetRedElementIfNotToken(Microsoft.CodeAnalysis.SyntaxNode@)">
<summary>
special cased helper for 2 and 3 children lists where child #1 may map to a token
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.ToString">
<summary>
Returns the string representation of this node, not including its leading and trailing trivia.
</summary>
<returns>The string representation of this node, not including its leading and trailing trivia.</returns>
<remarks>The length of the returned string is always the same as Span.Length</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.ToFullString">
<summary>
Returns full string representation of this node including its leading and trailing trivia.
</summary>
<returns>The full string representation of this node including its leading and trailing trivia.</returns>
<remarks>The length of the returned string is always the same as FullSpan.Length</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.WriteTo(System.IO.TextWriter)">
<summary>
Writes the full text of this node to the specified <see cref="T:System.IO.TextWriter"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.GetText(System.Text.Encoding,Microsoft.CodeAnalysis.Text.SourceHashAlgorithm)">
<summary>
Gets the full text of this node as a new <see cref="T:Microsoft.CodeAnalysis.Text.SourceText"/> instance.
</summary>
<param name="encoding">
Encoding of the file that the text was read from or is going to be saved to.
<c>null</c> if the encoding is unspecified.
If the encoding is not specified the <see cref="T:Microsoft.CodeAnalysis.Text.SourceText"/> isn't debuggable.
If an encoding-less <see cref="T:Microsoft.CodeAnalysis.Text.SourceText"/> is written to a file a <see cref="P:System.Text.Encoding.UTF8"/> shall be used as a default.
</param>
<param name="checksumAlgorithm">
Hash algorithm to use to calculate checksum of the text that's saved to PDB.
</param>
<exception cref="T:System.ArgumentException"><paramref name="checksumAlgorithm"/> is not supported.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.IsEquivalentTo(Microsoft.CodeAnalysis.SyntaxNode)">
<summary>
Determine whether this node is structurally equivalent to another.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxNode.IsMissing">
<summary>
Determines whether the node represents a language construct that was actually parsed
from the source code. Missing nodes are generated by the parser in error scenarios to
represent constructs that should have been present in the source code in order to
compile successfully but were actually missing.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.IsPartOfStructuredTrivia">
<summary>
Determines whether this node is a descendant of a structured trivia.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxNode.IsStructuredTrivia">
<summary>
Determines whether this node represents a structured trivia.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxNode.HasStructuredTrivia">
<summary>
Determines whether a descendant trivia of this node is structured.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxNode.ContainsSkippedText">
<summary>
Determines whether this node has any descendant skipped text.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxNode.ContainsDirectives">
<summary>
Determines whether this node has any descendant preprocessor directives.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxNode.ContainsDiagnostics">
<summary>
Determines whether this node or any of its descendant nodes, tokens or trivia have any diagnostics on them.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.Contains(Microsoft.CodeAnalysis.SyntaxNode)">
<summary>
Determines if the specified node is a descendant of this node.
Returns true for current node.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxNode.HasLeadingTrivia">
<summary>
Determines whether this node has any leading trivia.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxNode.HasTrailingTrivia">
<summary>
Determines whether this node has any trailing trivia.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.GetCachedSlot(System.Int32)">
<summary>
Gets a node at given node index without forcing its creation.
If node was not created it would return null.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.GetChildPosition(System.Int32)">
<summary>
This function calculates the offset of a child at given position. It is very common that
some children to the left of the given index already know their positions so we first
check if that is the case. In a worst case the cost is O(n), but it is not generally an
issue because number of children in regular nodes is fixed and small. In a case where
the number of children could be large (lists) this function is overridden with more
efficient implementations.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.GetDiagnostics">
<summary>
Gets a list of all the diagnostics in the sub tree that has this node as its root.
This method does not filter diagnostics based on #pragmas and compiler options
like nowarn, warnaserror etc.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.GetReference">
<summary>
Gets a <see cref="T:Microsoft.CodeAnalysis.SyntaxReference"/> for this syntax node. CommonSyntaxReferences can be used to
regain access to a syntax node without keeping the entire tree and source text in
memory.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxNode.Parent">
<summary>
The node that contains this node in its <see cref="M:Microsoft.CodeAnalysis.SyntaxNode.ChildNodes"/> collection.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.ChildNodesAndTokens">
<summary>
The list of child nodes and tokens of this node, where each element is a SyntaxNodeOrToken instance.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.GetNodeSlot(System.Int32)">
<summary>
Gets node at given node index.
This WILL force node creation if node has not yet been created.
Can still return null for invalid slot numbers
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.ChildNodes">
<summary>
Gets a list of the child nodes in prefix document order.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.Ancestors(System.Boolean)">
<summary>
Gets a list of ancestor nodes
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.AncestorsAndSelf(System.Boolean)">
<summary>
Gets a list of ancestor nodes (including this node)
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.FirstAncestorOrSelf``1(System.Func{``0,System.Boolean},System.Boolean)">
<summary>
Gets the first node of type TNode that matches the predicate.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.FirstAncestorOrSelf``2(System.Func{``0,``1,System.Boolean},``1,System.Boolean)">
<summary>
Gets the first node of type TNode that matches the predicate.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.DescendantNodes(System.Func{Microsoft.CodeAnalysis.SyntaxNode,System.Boolean},System.Boolean)">
<summary>
Gets a list of descendant nodes in prefix document order.
</summary>
<param name="descendIntoChildren">An optional function that determines if the search descends into the argument node's children.</param>
<param name="descendIntoTrivia">Determines if nodes that are part of structured trivia are included in the list.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.DescendantNodes(Microsoft.CodeAnalysis.Text.TextSpan,System.Func{Microsoft.CodeAnalysis.SyntaxNode,System.Boolean},System.Boolean)">
<summary>
Gets a list of descendant nodes in prefix document order.
</summary>
<param name="span">The span the node's full span must intersect.</param>
<param name="descendIntoChildren">An optional function that determines if the search descends into the argument node's children.</param>
<param name="descendIntoTrivia">Determines if nodes that are part of structured trivia are included in the list.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.DescendantNodesAndSelf(System.Func{Microsoft.CodeAnalysis.SyntaxNode,System.Boolean},System.Boolean)">
<summary>
Gets a list of descendant nodes (including this node) in prefix document order.
</summary>
<param name="descendIntoChildren">An optional function that determines if the search descends into the argument node's children.</param>
<param name="descendIntoTrivia">Determines if nodes that are part of structured trivia are included in the list.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.DescendantNodesAndSelf(Microsoft.CodeAnalysis.Text.TextSpan,System.Func{Microsoft.CodeAnalysis.SyntaxNode,System.Boolean},System.Boolean)">
<summary>
Gets a list of descendant nodes (including this node) in prefix document order.
</summary>
<param name="span">The span the node's full span must intersect.</param>
<param name="descendIntoChildren">An optional function that determines if the search descends into the argument node's children.</param>
<param name="descendIntoTrivia">Determines if nodes that are part of structured trivia are included in the list.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.DescendantNodesAndTokens(System.Func{Microsoft.CodeAnalysis.SyntaxNode,System.Boolean},System.Boolean)">
<summary>
Gets a list of descendant nodes and tokens in prefix document order.
</summary>
<param name="descendIntoChildren">An optional function that determines if the search descends into the argument node's children.</param>
<param name="descendIntoTrivia">Determines if nodes that are part of structured trivia are included in the list.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.DescendantNodesAndTokens(Microsoft.CodeAnalysis.Text.TextSpan,System.Func{Microsoft.CodeAnalysis.SyntaxNode,System.Boolean},System.Boolean)">
<summary>
Gets a list of the descendant nodes and tokens in prefix document order.
</summary>
<param name="span">The span the node's full span must intersect.</param>
<param name="descendIntoChildren">An optional function that determines if the search descends into the argument node's children.</param>
<param name="descendIntoTrivia">Determines if nodes that are part of structured trivia are included in the list.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.DescendantNodesAndTokensAndSelf(System.Func{Microsoft.CodeAnalysis.SyntaxNode,System.Boolean},System.Boolean)">
<summary>
Gets a list of descendant nodes and tokens (including this node) in prefix document order.
</summary>
<param name="descendIntoChildren">An optional function that determines if the search descends into the argument node's children.</param>
<param name="descendIntoTrivia">Determines if nodes that are part of structured trivia are included in the list.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.DescendantNodesAndTokensAndSelf(Microsoft.CodeAnalysis.Text.TextSpan,System.Func{Microsoft.CodeAnalysis.SyntaxNode,System.Boolean},System.Boolean)">
<summary>
Gets a list of the descendant nodes and tokens (including this node) in prefix document order.
</summary>
<param name="span">The span the node's full span must intersect.</param>
<param name="descendIntoChildren">An optional function that determines if the search descends into the argument node's children.</param>
<param name="descendIntoTrivia">Determines if nodes that are part of structured trivia are included in the list.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.FindNode(Microsoft.CodeAnalysis.Text.TextSpan,System.Boolean,System.Boolean)">
<summary>
Finds the node with the smallest <see cref="P:Microsoft.CodeAnalysis.SyntaxNode.FullSpan"/> that contains <paramref name="span"/>.
<paramref name="getInnermostNodeForTie"/> is used to determine the behavior in case of a tie (i.e. a node having the same span as its parent).
If <paramref name="getInnermostNodeForTie"/> is true, then it returns lowest descending node encompassing the given <paramref name="span"/>.
Otherwise, it returns the outermost node encompassing the given <paramref name="span"/>.
</summary>
<devdoc>
TODO: This should probably be reimplemented with <see cref="M:Microsoft.CodeAnalysis.SyntaxNode.ChildThatContainsPosition(System.Int32)"/>
</devdoc>
<exception cref="T:System.ArgumentOutOfRangeException">This exception is thrown if <see cref="P:Microsoft.CodeAnalysis.SyntaxNode.FullSpan"/> doesn't contain the given span.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.FindToken(System.Int32,System.Boolean)">
<summary>
Finds a descendant token of this node whose span includes the supplied position.
</summary>
<param name="position">The character position of the token relative to the beginning of the file.</param>
<param name="findInsideTrivia">
True to return tokens that are part of trivia. If false finds the token whose full span (including trivia)
includes the position.
</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.GetFirstToken(System.Boolean,System.Boolean,System.Boolean,System.Boolean)">
<summary>
Gets the first token of the tree rooted by this node. Skips zero-width tokens.
</summary>
<returns>The first token or <c>default(SyntaxToken)</c> if it doesn't exist.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.GetLastToken(System.Boolean,System.Boolean,System.Boolean,System.Boolean)">
<summary>
Gets the last token of the tree rooted by this node. Skips zero-width tokens.
</summary>
<returns>The last token or <c>default(SyntaxToken)</c> if it doesn't exist.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.ChildTokens">
<summary>
Gets a list of the direct child tokens of this node.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.DescendantTokens(System.Func{Microsoft.CodeAnalysis.SyntaxNode,System.Boolean},System.Boolean)">
<summary>
Gets a list of all the tokens in the span of this node.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.DescendantTokens(Microsoft.CodeAnalysis.Text.TextSpan,System.Func{Microsoft.CodeAnalysis.SyntaxNode,System.Boolean},System.Boolean)">
<summary>
Gets a list of all the tokens in the full span of this node.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.GetLeadingTrivia">
<summary>
The list of trivia that appears before this node in the source code and are attached to a token that is a
descendant of this node.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.GetTrailingTrivia">
<summary>
The list of trivia that appears after this node in the source code and are attached to a token that is a
descendant of this node.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.FindTrivia(System.Int32,System.Boolean)">
<summary>
Finds a descendant trivia of this node whose span includes the supplied position.
</summary>
<param name="position">The character position of the trivia relative to the beginning of the file.</param>
<param name="findInsideTrivia">
True to return tokens that are part of trivia. If false finds the token whose full span (including trivia)
includes the position.
</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.FindTrivia(System.Int32,System.Func{Microsoft.CodeAnalysis.SyntaxTrivia,System.Boolean})">
<summary>
Finds a descendant trivia of this node at the specified position, where the position is
within the span of the node.
</summary>
<param name="position">The character position of the trivia relative to the beginning of
the file.</param>
<param name="stepInto">Specifies a function that determines per trivia node, whether to
descend into structured trivia of that node.</param>
<returns></returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.DescendantTrivia(System.Func{Microsoft.CodeAnalysis.SyntaxNode,System.Boolean},System.Boolean)">
<summary>
Get a list of all the trivia associated with the descendant nodes and tokens.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.DescendantTrivia(Microsoft.CodeAnalysis.Text.TextSpan,System.Func{Microsoft.CodeAnalysis.SyntaxNode,System.Boolean},System.Boolean)">
<summary>
Get a list of all the trivia associated with the descendant nodes and tokens.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxNode.ContainsAnnotations">
<summary>
Determines whether this node or any sub node, token or trivia has annotations.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.HasAnnotations(System.String)">
<summary>
Determines whether this node has any annotations with the specific annotation kind.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.HasAnnotations(System.Collections.Generic.IEnumerable{System.String})">
<summary>
Determines whether this node has any annotations with any of the specific annotation kinds.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.HasAnnotation(Microsoft.CodeAnalysis.SyntaxAnnotation)">
<summary>
Determines whether this node has the specific annotation.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.GetAnnotations(System.String)">
<summary>
Gets all the annotations with the specified annotation kind.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.GetAnnotations(System.Collections.Generic.IEnumerable{System.String})">
<summary>
Gets all the annotations with the specified annotation kinds.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.GetAnnotatedNodesAndTokens(System.String)">
<summary>
Gets all nodes and tokens with an annotation of the specified annotation kind.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.GetAnnotatedNodesAndTokens(System.String[])">
<summary>
Gets all nodes and tokens with an annotation of the specified annotation kinds.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.GetAnnotatedNodesAndTokens(Microsoft.CodeAnalysis.SyntaxAnnotation)">
<summary>
Gets all nodes and tokens with the specified annotation.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.GetAnnotatedNodes(Microsoft.CodeAnalysis.SyntaxAnnotation)">
<summary>
Gets all nodes with the specified annotation.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.GetAnnotatedNodes(System.String)">
<summary>
Gets all nodes with the specified annotation kind.
</summary>
<param name="annotationKind"></param>
<returns></returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.GetAnnotatedTokens(Microsoft.CodeAnalysis.SyntaxAnnotation)">
<summary>
Gets all tokens with the specified annotation.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.GetAnnotatedTokens(System.String)">
<summary>
Gets all tokens with the specified annotation kind.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.GetAnnotatedTrivia(System.String)">
<summary>
Gets all trivia with an annotation of the specified annotation kind.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.GetAnnotatedTrivia(System.String[])">
<summary>
Gets all trivia with an annotation of the specified annotation kinds.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.GetAnnotatedTrivia(Microsoft.CodeAnalysis.SyntaxAnnotation)">
<summary>
Gets all trivia with the specified annotation.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.CopyAnnotationsTo``1(``0)">
<summary>
Copies all SyntaxAnnotations, if any, from this SyntaxNode instance and attaches them to a new instance based on <paramref name="node" />.
</summary>
<remarks>
<para>
If no annotations are copied, just returns <paramref name="node" />.
</para>
<para>
It can also be used manually to preserve annotations in a more complex tree
modification, even if the type of a node changes.
</para>
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.IsEquivalentTo(Microsoft.CodeAnalysis.SyntaxNode,System.Boolean)">
<summary>
Determines if two nodes are the same, disregarding trivia differences.
</summary>
<param name="node">The node to compare against.</param>
<param name="topLevel"> If true then the nodes are equivalent if the contained nodes and
tokens declaring metadata visible symbolic information are equivalent, ignoring any
differences of nodes inside method bodies or initializer expressions, otherwise all
nodes and tokens must be equivalent.
</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.SerializeTo(System.IO.Stream,System.Threading.CancellationToken)">
<summary>
Serializes the node to the given <paramref name="stream"/>.
Leaves the <paramref name="stream"/> open for further writes.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.EquivalentToCore(Microsoft.CodeAnalysis.SyntaxNode)">
<summary>
Determine if this node is structurally equivalent to another.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxNode.SyntaxTreeCore">
<summary>
Returns SyntaxTree that owns the node. If the node does not belong to a tree then
one will be generated.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.FindTokenCore(System.Int32,System.Boolean)">
<summary>
Finds a descendant token of this node whose span includes the supplied position.
</summary>
<param name="position">The character position of the token relative to the beginning of the file.</param>
<param name="findInsideTrivia">
True to return tokens that are part of trivia.
If false finds the token whose full span (including trivia) includes the position.
</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.FindTokenCore(System.Int32,System.Func{Microsoft.CodeAnalysis.SyntaxTrivia,System.Boolean})">
<summary>
Finds a descendant token of this node whose span includes the supplied position.
</summary>
<param name="position">The character position of the token relative to the beginning of the file.</param>
<param name="stepInto">
Applied on every structured trivia. Return false if the tokens included in the trivia should be skipped.
Pass null to skip all structured trivia.
</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.FindTriviaCore(System.Int32,System.Boolean)">
<summary>
Finds a descendant trivia of this node whose span includes the supplied position.
</summary>
<param name="position">The character position of the trivia relative to the beginning of the file.</param>
<param name="findInsideTrivia">Whether to search inside structured trivia.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.ReplaceCore``1(System.Collections.Generic.IEnumerable{``0},System.Func{``0,``0,Microsoft.CodeAnalysis.SyntaxNode},System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.SyntaxToken},System.Func{Microsoft.CodeAnalysis.SyntaxToken,Microsoft.CodeAnalysis.SyntaxToken,Microsoft.CodeAnalysis.SyntaxToken},System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.SyntaxTrivia},System.Func{Microsoft.CodeAnalysis.SyntaxTrivia,Microsoft.CodeAnalysis.SyntaxTrivia,Microsoft.CodeAnalysis.SyntaxTrivia})">
<summary>
Creates a new tree of nodes with the specified nodes, tokens or trivia replaced.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.RemoveNodesCore(System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.SyntaxNode},Microsoft.CodeAnalysis.SyntaxRemoveOptions)">
<summary>
Creates a new tree of nodes with the specified node removed.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.IsEquivalentToCore(Microsoft.CodeAnalysis.SyntaxNode,System.Boolean)">
<summary>
Determines if two nodes are the same, disregarding trivia differences.
</summary>
<param name="node">The node to compare against.</param>
<param name="topLevel"> If true then the nodes are equivalent if the contained nodes and
tokens declaring metadata visible symbolic information are equivalent, ignoring any
differences of nodes inside method bodies or initializer expressions, otherwise all
nodes and tokens must be equivalent.
</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.ShouldCreateWeakList">
<summary>
Whether or not this parent node wants its child SyntaxList node to be
converted to a Weak-SyntaxList when creating the red-node equivalent.
For example, in C# the statements of a Block-Node that is parented by a
MethodDeclaration will be held weakly.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNode.CloneNodeAsRoot``1(``0,Microsoft.CodeAnalysis.SyntaxTree)">
<summary>
Creates a clone of a red node that can be used as a root of given syntaxTree.
New node has no parents, position == 0, and syntaxTree as specified.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeExtensions.ReplaceSyntax``1(``0,System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.SyntaxNode},System.Func{Microsoft.CodeAnalysis.SyntaxNode,Microsoft.CodeAnalysis.SyntaxNode,Microsoft.CodeAnalysis.SyntaxNode},System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.SyntaxToken},System.Func{Microsoft.CodeAnalysis.SyntaxToken,Microsoft.CodeAnalysis.SyntaxToken,Microsoft.CodeAnalysis.SyntaxToken},System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.SyntaxTrivia},System.Func{Microsoft.CodeAnalysis.SyntaxTrivia,Microsoft.CodeAnalysis.SyntaxTrivia,Microsoft.CodeAnalysis.SyntaxTrivia})">
<summary>
Creates a new tree of nodes with the specified nodes, tokens and trivia replaced.
</summary>
<typeparam name="TRoot">The type of the root node.</typeparam>
<param name="root">The root node of the tree of nodes.</param>
<param name="nodes">The nodes to be replaced.</param>
<param name="computeReplacementNode">A function that computes a replacement node for the
argument nodes. The first argument is the original node. The second argument is the same
node potentially rewritten with replaced descendants.</param>
<param name="tokens">The tokens to be replaced.</param>
<param name="computeReplacementToken">A function that computes a replacement token for
the argument tokens. The first argument is the original token. The second argument is
the same token potentially rewritten with replaced trivia.</param>
<param name="trivia">The trivia to be replaced.</param>
<param name="computeReplacementTrivia">A function that computes replacement trivia for
the specified arguments. The first argument is the original trivia. The second argument is
the same trivia with potentially rewritten sub structure.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeExtensions.ReplaceNodes``2(``0,System.Collections.Generic.IEnumerable{``1},System.Func{``1,``1,Microsoft.CodeAnalysis.SyntaxNode})">
<summary>
Creates a new tree of nodes with the specified old node replaced with a new node.
</summary>
<typeparam name="TRoot">The type of the root node.</typeparam>
<typeparam name="TNode">The type of the nodes being replaced.</typeparam>
<param name="root">The root node of the tree of nodes.</param>
<param name="nodes">The nodes to be replaced; descendants of the root node.</param>
<param name="computeReplacementNode">A function that computes a replacement node for the
argument nodes. The first argument is the original node. The second argument is the same
node potentially rewritten with replaced descendants.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeExtensions.ReplaceNode``1(``0,Microsoft.CodeAnalysis.SyntaxNode,Microsoft.CodeAnalysis.SyntaxNode)">
<summary>
Creates a new tree of nodes with the specified old node replaced with a new node.
</summary>
<typeparam name="TRoot">The type of the root node.</typeparam>
<param name="root">The root node of the tree of nodes.</param>
<param name="oldNode">The node to be replaced; a descendant of the root node.</param>
<param name="newNode">The new node to use in the new tree in place of the old node.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeExtensions.ReplaceNode``1(``0,Microsoft.CodeAnalysis.SyntaxNode,System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.SyntaxNode})">
<summary>
Creates a new tree of nodes with specified old node replaced with a new nodes.
</summary>
<typeparam name="TRoot">The type of the root node.</typeparam>
<param name="root">The root of the tree of nodes.</param>
<param name="oldNode">The node to be replaced; a descendant of the root node and an element of a list member.</param>
<param name="newNodes">A sequence of nodes to use in the tree in place of the old node.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeExtensions.InsertNodesBefore``1(``0,Microsoft.CodeAnalysis.SyntaxNode,System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.SyntaxNode})">
<summary>
Creates a new tree of nodes with new nodes inserted before the specified node.
</summary>
<typeparam name="TRoot">The type of the root node.</typeparam>
<param name="root">The root of the tree of nodes.</param>
<param name="nodeInList">The node to insert before; a descendant of the root node an element of a list member.</param>
<param name="newNodes">A sequence of nodes to insert into the tree immediately before the specified node.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeExtensions.InsertNodesAfter``1(``0,Microsoft.CodeAnalysis.SyntaxNode,System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.SyntaxNode})">
<summary>
Creates a new tree of nodes with new nodes inserted after the specified node.
</summary>
<typeparam name="TRoot">The type of the root node.</typeparam>
<param name="root">The root of the tree of nodes.</param>
<param name="nodeInList">The node to insert after; a descendant of the root node an element of a list member.</param>
<param name="newNodes">A sequence of nodes to insert into the tree immediately after the specified node.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeExtensions.ReplaceToken``1(``0,Microsoft.CodeAnalysis.SyntaxToken,System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.SyntaxToken})">
<summary>
Creates a new tree of nodes with the specified old token replaced with new tokens.
</summary>
<typeparam name="TRoot">The type of the root node.</typeparam>
<param name="root">The root of the tree of nodes.</param>
<param name="tokenInList">The token to be replaced; a descendant of the root node and an element of a list member.</param>
<param name="newTokens">A sequence of tokens to use in the tree in place of the specified token.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeExtensions.InsertTokensBefore``1(``0,Microsoft.CodeAnalysis.SyntaxToken,System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.SyntaxToken})">
<summary>
Creates a new tree of nodes with new tokens inserted before the specified token.
</summary>
<typeparam name="TRoot">The type of the root node.</typeparam>
<param name="root">The root of the tree of nodes.</param>
<param name="tokenInList">The token to insert before; a descendant of the root node and an element of a list member.</param>
<param name="newTokens">A sequence of tokens to insert into the tree immediately before the specified token.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeExtensions.InsertTokensAfter``1(``0,Microsoft.CodeAnalysis.SyntaxToken,System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.SyntaxToken})">
<summary>
Creates a new tree of nodes with new tokens inserted after the specified token.
</summary>
<typeparam name="TRoot">The type of the root node.</typeparam>
<param name="root">The root of the tree of nodes.</param>
<param name="tokenInList">The token to insert after; a descendant of the root node and an element of a list member.</param>
<param name="newTokens">A sequence of tokens to insert into the tree immediately after the specified token.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeExtensions.ReplaceTrivia``1(``0,Microsoft.CodeAnalysis.SyntaxTrivia,System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.SyntaxTrivia})">
<summary>
Creates a new tree of nodes with the specified old trivia replaced with new trivia.
</summary>
<typeparam name="TRoot">The type of the root node.</typeparam>
<param name="root">The root of the tree of nodes.</param>
<param name="oldTrivia">The trivia to be replaced; a descendant of the root node.</param>
<param name="newTrivia">A sequence of trivia to use in the tree in place of the specified trivia.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeExtensions.InsertTriviaBefore``1(``0,Microsoft.CodeAnalysis.SyntaxTrivia,System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.SyntaxTrivia})">
<summary>
Creates a new tree of nodes with new trivia inserted before the specified trivia.
</summary>
<typeparam name="TRoot">The type of the root node.</typeparam>
<param name="root">The root of the tree of nodes.</param>
<param name="trivia">The trivia to insert before; a descendant of the root node.</param>
<param name="newTrivia">A sequence of trivia to insert into the tree immediately before the specified trivia.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeExtensions.InsertTriviaAfter``1(``0,Microsoft.CodeAnalysis.SyntaxTrivia,System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.SyntaxTrivia})">
<summary>
Creates a new tree of nodes with new trivia inserted after the specified trivia.
</summary>
<typeparam name="TRoot">The type of the root node.</typeparam>
<param name="root">The root of the tree of nodes.</param>
<param name="trivia">The trivia to insert after; a descendant of the root node.</param>
<param name="newTrivia">A sequence of trivia to insert into the tree immediately after the specified trivia.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeExtensions.ReplaceTokens``1(``0,System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.SyntaxToken},System.Func{Microsoft.CodeAnalysis.SyntaxToken,Microsoft.CodeAnalysis.SyntaxToken,Microsoft.CodeAnalysis.SyntaxToken})">
<summary>
Creates a new tree of nodes with the specified old node replaced with a new node.
</summary>
<typeparam name="TRoot">The type of the root node.</typeparam>
<param name="root">The root node of the tree of nodes.</param>
<param name="tokens">The token to be replaced; descendants of the root node.</param>
<param name="computeReplacementToken">A function that computes a replacement token for
the argument tokens. The first argument is the original token. The second argument is
the same token potentially rewritten with replaced trivia.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeExtensions.ReplaceToken``1(``0,Microsoft.CodeAnalysis.SyntaxToken,Microsoft.CodeAnalysis.SyntaxToken)">
<summary>
Creates a new tree of nodes with the specified old token replaced with a new token.
</summary>
<typeparam name="TRoot">The type of the root node.</typeparam>
<param name="root">The root node of the tree of nodes.</param>
<param name="oldToken">The token to be replaced.</param>
<param name="newToken">The new token to use in the new tree in place of the old
token.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeExtensions.ReplaceTrivia``1(``0,System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.SyntaxTrivia},System.Func{Microsoft.CodeAnalysis.SyntaxTrivia,Microsoft.CodeAnalysis.SyntaxTrivia,Microsoft.CodeAnalysis.SyntaxTrivia})">
<summary>
Creates a new tree of nodes with the specified trivia replaced with new trivia.
</summary>
<typeparam name="TRoot">The type of the root node.</typeparam>
<param name="root">The root node of the tree of nodes.</param>
<param name="trivia">The trivia to be replaced; descendants of the root node.</param>
<param name="computeReplacementTrivia">A function that computes replacement trivia for
the specified arguments. The first argument is the original trivia. The second argument is
the same trivia with potentially rewritten sub structure.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeExtensions.ReplaceTrivia``1(``0,Microsoft.CodeAnalysis.SyntaxTrivia,Microsoft.CodeAnalysis.SyntaxTrivia)">
<summary>
Creates a new tree of nodes with the specified trivia replaced with new trivia.
</summary>
<typeparam name="TRoot">The type of the root node.</typeparam>
<param name="root">The root node of the tree of nodes.</param>
<param name="trivia">The trivia to be replaced.</param>
<param name="newTrivia">The new trivia to use in the new tree in place of the old trivia.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeExtensions.RemoveNode``1(``0,Microsoft.CodeAnalysis.SyntaxNode,Microsoft.CodeAnalysis.SyntaxRemoveOptions)">
<summary>
Creates a new tree of nodes with the specified node removed.
</summary>
<typeparam name="TRoot">The type of the root node.</typeparam>
<param name="root">The root node from which to remove a descendant node from.</param>
<param name="node">The node to remove.</param>
<param name="options">Options that determine how the node's trivia is treated.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeExtensions.RemoveNodes``1(``0,System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.SyntaxNode},Microsoft.CodeAnalysis.SyntaxRemoveOptions)">
<summary>
Creates a new tree of nodes with the specified nodes removed.
</summary>
<typeparam name="TRoot">The type of the root node.</typeparam>
<param name="root">The root node from which to remove a descendant node from.</param>
<param name="nodes">The nodes to remove.</param>
<param name="options">Options that determine how the nodes' trivia is treated.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeExtensions.NormalizeWhitespace``1(``0,System.String,System.Boolean)">
<summary>
Creates a new syntax node with all whitespace and end of line trivia replaced with
regularly formatted trivia.
</summary>
<typeparam name="TNode">The type of the node.</typeparam>
<param name="node">The node to format.</param>
<param name="indentation">A sequence of whitespace characters that defines a single level of indentation.</param>
<param name="elasticTrivia">If true the replaced trivia is elastic trivia.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeExtensions.NormalizeWhitespace``1(``0,System.String,System.String,System.Boolean)">
<summary>
Creates a new syntax node with all whitespace and end of line trivia replaced with
regularly formatted trivia.
</summary>
<typeparam name="TNode">The type of the node.</typeparam>
<param name="node">The node to format.</param>
<param name="indentation">An optional sequence of whitespace characters that defines a single level of indentation.</param>
<param name="eol">An optional sequence of whitespace characters used for end of line.</param>
<param name="elasticTrivia">If true the replaced trivia is elastic trivia.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeExtensions.WithTriviaFrom``1(``0,Microsoft.CodeAnalysis.SyntaxNode)">
<summary>
Creates a new node from this node with both the leading and trailing trivia of the specified node.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeExtensions.WithoutTrivia``1(``0)">
<summary>
Creates a new node from this node without leading or trailing trivia.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeExtensions.WithoutTrivia(Microsoft.CodeAnalysis.SyntaxToken)">
<summary>
Creates a new token from this token without leading or trailing trivia.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeExtensions.WithLeadingTrivia``1(``0,Microsoft.CodeAnalysis.SyntaxTriviaList)">
<summary>
Creates a new node from this node with the leading trivia replaced.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeExtensions.WithLeadingTrivia``1(``0,System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.SyntaxTrivia})">
<summary>
Creates a new node from this node with the leading trivia replaced.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeExtensions.WithoutLeadingTrivia``1(``0)">
<summary>
Creates a new node from this node with the leading trivia removed.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeExtensions.WithLeadingTrivia``1(``0,Microsoft.CodeAnalysis.SyntaxTrivia[])">
<summary>
Creates a new node from this node with the leading trivia replaced.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeExtensions.WithTrailingTrivia``1(``0,Microsoft.CodeAnalysis.SyntaxTriviaList)">
<summary>
Creates a new node from this node with the trailing trivia replaced.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeExtensions.WithTrailingTrivia``1(``0,System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.SyntaxTrivia})">
<summary>
Creates a new node from this node with the trailing trivia replaced.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeExtensions.WithoutTrailingTrivia``1(``0)">
<summary>
Creates a new node from this node with the trailing trivia removed.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeExtensions.WithTrailingTrivia``1(``0,Microsoft.CodeAnalysis.SyntaxTrivia[])">
<summary>
Creates a new node from this node with the trailing trivia replaced.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeExtensions.AsRootOfNewTreeWithOptionsFrom(Microsoft.CodeAnalysis.SyntaxNode,Microsoft.CodeAnalysis.SyntaxTree)">
<summary>
Attaches the node to a SyntaxTree that the same options as <paramref name="oldTree"/>
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeExtensions.TrackNodes``1(``0,System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.SyntaxNode})">
<summary>
Creates a new tree of nodes with the specified nodes being tracked.
Use GetCurrentNode on the subtree resulting from this operation, or any transformation of it,
to get the current node corresponding to the original tracked node.
</summary>
<param name="root">The root of the subtree containing the nodes to be tracked.</param>
<param name="nodes">One or more nodes that are descendants of the root node.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeExtensions.TrackNodes``1(``0,Microsoft.CodeAnalysis.SyntaxNode[])">
<summary>
Creates a new tree of nodes with the specified nodes being tracked.
Use GetCurrentNode on the subtree resulting from this operation, or any transformation of it,
to get the current node corresponding to the original tracked node.
</summary>
<param name="root">The root of the subtree containing the nodes to be tracked.</param>
<param name="nodes">One or more nodes that are descendants of the root node.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeExtensions.GetCurrentNodes``1(Microsoft.CodeAnalysis.SyntaxNode,``0)">
<summary>
Gets the nodes within the subtree corresponding to the original tracked node.
Use TrackNodes to start tracking nodes.
</summary>
<param name="root">The root of the subtree containing the current node corresponding to the original tracked node.</param>
<param name="node">The node instance originally tracked.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeExtensions.GetCurrentNode``1(Microsoft.CodeAnalysis.SyntaxNode,``0)">
<summary>
Gets the node within the subtree corresponding to the original tracked node.
Use TrackNodes to start tracking nodes.
</summary>
<param name="root">The root of the subtree containing the current node corresponding to the original tracked node.</param>
<param name="node">The node instance originally tracked.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeExtensions.GetCurrentNodes``1(Microsoft.CodeAnalysis.SyntaxNode,System.Collections.Generic.IEnumerable{``0})">
<summary>
Gets the nodes within the subtree corresponding to the original tracked nodes.
Use TrackNodes to start tracking nodes.
</summary>
<param name="root">The root of the subtree containing the current nodes corresponding to the original tracked nodes.</param>
<param name="nodes">One or more node instances originally tracked.</param>
</member>
<member name="T:Microsoft.CodeAnalysis.SyntaxNodeOrToken">
<summary>
A wrapper for either a syntax node (<see cref="T:Microsoft.CodeAnalysis.SyntaxNode"/>) or a syntax token (<see
cref="T:Microsoft.CodeAnalysis.SyntaxToken"/>).
</summary>
<remarks>
Note that we do not store the token directly, we just store enough information to reconstruct it.
This allows us to reuse nodeOrToken as a token's parent.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxNodeOrToken.RawKind">
<summary>
An integer representing the language specific kind of the underlying node or token.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxNodeOrToken.Language">
<summary>
The language name that this node or token is syntax of.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxNodeOrToken.IsMissing">
<summary>
Determines whether the underlying node or token represents a language construct that was actually parsed
from source code. Missing nodes and tokens are typically generated by the parser in error scenarios to
represent constructs that should have been present in the source code for the source code to compile
successfully but were actually missing.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxNodeOrToken.Parent">
<summary>
The node that contains the underlying node or token in its Children collection.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxNodeOrToken.IsToken">
<summary>
Determines whether this <see cref="T:Microsoft.CodeAnalysis.SyntaxNodeOrToken"/> is wrapping a token.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxNodeOrToken.IsNode">
<summary>
Determines whether this <see cref="T:Microsoft.CodeAnalysis.SyntaxNodeOrToken"/> is wrapping a node.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrToken.AsToken">
<summary>
Returns the underlying token if this <see cref="T:Microsoft.CodeAnalysis.SyntaxNodeOrToken"/> is wrapping a
token.
</summary>
<returns>
The underlying token if this <see cref="T:Microsoft.CodeAnalysis.SyntaxNodeOrToken"/> is wrapping a token.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrToken.AsNode">
<summary>
Returns the underlying node if this <see cref="T:Microsoft.CodeAnalysis.SyntaxNodeOrToken"/> is wrapping a
node.
</summary>
<returns>
The underlying node if this <see cref="T:Microsoft.CodeAnalysis.SyntaxNodeOrToken"/> is wrapping a node.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrToken.ChildNodesAndTokens">
<summary>
The list of child nodes and tokens of the underlying node or token.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxNodeOrToken.Span">
<summary>
The absolute span of the underlying node or token in characters, not including its leading and trailing
trivia.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxNodeOrToken.SpanStart">
<summary>
Same as accessing <see cref="P:Microsoft.CodeAnalysis.Text.TextSpan.Start"/> on <see cref="P:Microsoft.CodeAnalysis.SyntaxNodeOrToken.Span"/>.
</summary>
<remarks>
Slight performance improvement.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxNodeOrToken.FullSpan">
<summary>
The absolute span of the underlying node or token in characters, including its leading and trailing trivia.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrToken.ToString">
<summary>
Returns the string representation of this node or token, not including its leading and trailing
trivia.
</summary>
<returns>
The string representation of this node or token, not including its leading and trailing trivia.
</returns>
<remarks>The length of the returned string is always the same as Span.Length</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrToken.ToFullString">
<summary>
Returns the full string representation of this node or token including its leading and trailing trivia.
</summary>
<returns>The full string representation of this node or token including its leading and trailing
trivia.</returns>
<remarks>The length of the returned string is always the same as FullSpan.Length</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrToken.WriteTo(System.IO.TextWriter)">
<summary>
Writes the full text of this node or token to the specified TextWriter.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxNodeOrToken.HasLeadingTrivia">
<summary>
Determines whether the underlying node or token has any leading trivia.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrToken.GetLeadingTrivia">
<summary>
The list of trivia that appear before the underlying node or token in the source code and are attached to a
token that is a descendant of the underlying node or token.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxNodeOrToken.HasTrailingTrivia">
<summary>
Determines whether the underlying node or token has any trailing trivia.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrToken.GetTrailingTrivia">
<summary>
The list of trivia that appear after the underlying node or token in the source code and are attached to a
token that is a descendant of the underlying node or token.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxNodeOrToken.ContainsDiagnostics">
<summary>
Determines whether the underlying node or token or any of its descendant nodes, tokens or trivia have any
diagnostics on them.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrToken.GetDiagnostics">
<summary>
Gets a list of all the diagnostics in either the sub tree that has this node as its root or
associated with this token and its related trivia.
This method does not filter diagnostics based on #pragmas and compiler options
like nowarn, warnaserror etc.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxNodeOrToken.ContainsDirectives">
<summary>
Determines whether the underlying node or token has any descendant preprocessor directives.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxNodeOrToken.ContainsAnnotations">
<summary>
Determines whether this node or token (or any sub node, token or trivia) as annotations.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrToken.HasAnnotations(System.String)">
<summary>
Determines whether this node or token has annotations of the specified kind.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrToken.HasAnnotations(System.Collections.Generic.IEnumerable{System.String})">
<summary>
Determines whether this node or token has annotations of the specified kind.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrToken.HasAnnotation(Microsoft.CodeAnalysis.SyntaxAnnotation)">
<summary>
Determines if this node or token has the specific annotation.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrToken.GetAnnotations(System.String)">
<summary>
Gets all annotations of the specified annotation kind.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrToken.GetAnnotations(System.Collections.Generic.IEnumerable{System.String})">
<summary>
Gets all annotations of the specified annotation kind.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrToken.WithAdditionalAnnotations(Microsoft.CodeAnalysis.SyntaxAnnotation[])">
<summary>
Creates a new node or token identical to this one with the specified annotations.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrToken.WithAdditionalAnnotations(System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.SyntaxAnnotation})">
<summary>
Creates a new node or token identical to this one with the specified annotations.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrToken.WithoutAnnotations(Microsoft.CodeAnalysis.SyntaxAnnotation[])">
<summary>
Creates a new node or token identical to this one without the specified annotations.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrToken.WithoutAnnotations(System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.SyntaxAnnotation})">
<summary>
Creates a new node or token identical to this one without the specified annotations.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrToken.WithoutAnnotations(System.String)">
<summary>
Creates a new node or token identical to this one without annotations of the specified kind.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrToken.Equals(Microsoft.CodeAnalysis.SyntaxNodeOrToken)">
<summary>
Determines whether the supplied <see cref="T:Microsoft.CodeAnalysis.SyntaxNodeOrToken"/> is equal to this
<see cref="T:Microsoft.CodeAnalysis.SyntaxNodeOrToken"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrToken.op_Equality(Microsoft.CodeAnalysis.SyntaxNodeOrToken,Microsoft.CodeAnalysis.SyntaxNodeOrToken)">
<summary>
Determines whether two <see cref="T:Microsoft.CodeAnalysis.SyntaxNodeOrToken"/>s are equal.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrToken.op_Inequality(Microsoft.CodeAnalysis.SyntaxNodeOrToken,Microsoft.CodeAnalysis.SyntaxNodeOrToken)">
<summary>
Determines whether two <see cref="T:Microsoft.CodeAnalysis.SyntaxNodeOrToken"/>s are unequal.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrToken.Equals(System.Object)">
<summary>
Determines whether the supplied <see cref="T:Microsoft.CodeAnalysis.SyntaxNodeOrToken"/> is equal to this
<see cref="T:Microsoft.CodeAnalysis.SyntaxNodeOrToken"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrToken.GetHashCode">
<summary>
Serves as hash function for <see cref="T:Microsoft.CodeAnalysis.SyntaxNodeOrToken"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrToken.IsEquivalentTo(Microsoft.CodeAnalysis.SyntaxNodeOrToken)">
<summary>
Determines if the two nodes or tokens are equivalent.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrToken.op_Implicit(Microsoft.CodeAnalysis.SyntaxToken)~Microsoft.CodeAnalysis.SyntaxNodeOrToken">
<summary>
Returns a new <see cref="T:Microsoft.CodeAnalysis.SyntaxNodeOrToken"/> that wraps the supplied token.
</summary>
<param name="token">The input token.</param>
<returns>
A <see cref="T:Microsoft.CodeAnalysis.SyntaxNodeOrToken"/> that wraps the supplied token.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrToken.op_Explicit(Microsoft.CodeAnalysis.SyntaxNodeOrToken)~Microsoft.CodeAnalysis.SyntaxToken">
<summary>
Returns the underlying token wrapped by the supplied <see cref="T:Microsoft.CodeAnalysis.SyntaxNodeOrToken"/>.
</summary>
<param name="nodeOrToken">
The input <see cref="T:Microsoft.CodeAnalysis.SyntaxNodeOrToken"/>.
</param>
<returns>
The underlying token wrapped by the supplied <see cref="T:Microsoft.CodeAnalysis.SyntaxNodeOrToken"/>.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrToken.op_Implicit(Microsoft.CodeAnalysis.SyntaxNode)~Microsoft.CodeAnalysis.SyntaxNodeOrToken">
<summary>
Returns a new <see cref="T:Microsoft.CodeAnalysis.SyntaxNodeOrToken"/> that wraps the supplied node.
</summary>
<param name="node">The input node.</param>
<returns>
A <see cref="T:Microsoft.CodeAnalysis.SyntaxNodeOrToken"/> that wraps the supplied node.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrToken.op_Explicit(Microsoft.CodeAnalysis.SyntaxNodeOrToken)~Microsoft.CodeAnalysis.SyntaxNode">
<summary>
Returns the underlying node wrapped by the supplied <see cref="T:Microsoft.CodeAnalysis.SyntaxNodeOrToken"/>.
</summary>
<param name="nodeOrToken">
The input <see cref="T:Microsoft.CodeAnalysis.SyntaxNodeOrToken"/>.
</param>
<returns>
The underlying node wrapped by the supplied <see cref="T:Microsoft.CodeAnalysis.SyntaxNodeOrToken"/>.
</returns>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxNodeOrToken.SyntaxTree">
<summary>
SyntaxTree which contains current SyntaxNodeOrToken.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrToken.GetLocation">
<summary>
Get the location of this node or token.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.SyntaxNodeOrTokenList">
<summary>
A list of <see cref="T:Microsoft.CodeAnalysis.SyntaxNodeOrToken"/> structures.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SyntaxNodeOrTokenList._node">
<summary>
The underlying field
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SyntaxNodeOrTokenList.index">
<summary>
The index from the parent's children list of this node.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrTokenList.#ctor(Microsoft.CodeAnalysis.SyntaxNode,System.Int32)">
<summary>
Initializes a new instance of the <see cref="T:Microsoft.CodeAnalysis.SyntaxNodeOrTokenList"/> structure.
</summary>
<param name="node">The underlying syntax node.</param>
<param name="index">The index.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrTokenList.#ctor(System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.SyntaxNodeOrToken})">
<summary>
Create a <see cref="T:Microsoft.CodeAnalysis.SyntaxNodeOrTokenList"/> from a sequence of <see cref="T:Microsoft.CodeAnalysis.SyntaxNodeOrToken"/>.
</summary>
<param name="nodesAndTokens">The sequence of nodes and tokens</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrTokenList.#ctor(Microsoft.CodeAnalysis.SyntaxNodeOrToken[])">
<summary>
Create a <see cref="T:Microsoft.CodeAnalysis.SyntaxNodeOrTokenList"/> from one or more <see cref="T:Microsoft.CodeAnalysis.SyntaxNodeOrToken"/>.
</summary>
<param name="nodesAndTokens">The nodes and tokens</param>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxNodeOrTokenList.Node">
<summary>
Gets the underlying syntax node.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxNodeOrTokenList.Count">
<summary>
Gets the count of nodes in this list
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxNodeOrTokenList.Item(System.Int32)">
<summary>
Gets the <see cref="T:Microsoft.CodeAnalysis.SyntaxNodeOrToken"/> at the specified index.
</summary>
<exception cref="T:System.IndexOutOfRangeException"><paramref name="index"/> is out of range.</exception>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxNodeOrTokenList.FullSpan">
<summary>
The absolute span of the list elements in characters, including the leading and trailing trivia of the first and last elements.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxNodeOrTokenList.Span">
<summary>
The absolute span of the list elements in characters, not including the leading and trailing trivia of the first and last elements.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrTokenList.ToString">
<summary>
Returns the string representation of the nodes and tokens in this list, not including the first node or token's leading trivia
and the last node or token's trailing trivia.
</summary>
<returns>
The string representation of the nodes and tokens in this list, not including the first node or token's leading trivia
and the last node or token's trailing trivia.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrTokenList.ToFullString">
<summary>
Returns the full string representation of the nodes and tokens in this list including the first node or token's leading trivia
and the last node or token's trailing trivia.
</summary>
<returns>
The full string representation of the nodes and tokens in this list including the first node or token's leading trivia
and the last node or token's trailing trivia.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrTokenList.First">
<summary>
Gets the first SyntaxNodeOrToken structure from this list.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrTokenList.FirstOrDefault">
<summary>
Gets the first SyntaxNodeOrToken structure from this list if present, else default(SyntaxNodeOrToken).
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrTokenList.Last">
<summary>
Gets the last SyntaxNodeOrToken structure from this list.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrTokenList.LastOrDefault">
<summary>
Gets the last SyntaxNodeOrToken structure from this list if present, else default(SyntaxNodeOrToken).
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrTokenList.IndexOf(Microsoft.CodeAnalysis.SyntaxNodeOrToken)">
<summary>
Returns the index from the list for the given <see cref="T:Microsoft.CodeAnalysis.SyntaxNodeOrToken"/>.
</summary>
<param name="nodeOrToken">The node or token to search for in the list.</param>
<returns>The index of the found nodeOrToken, or -1 if it wasn't found</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrTokenList.Any">
<summary>
Indicates whether there is any element in the list.
</summary>
<returns><c>true</c> if there are any elements in the list, else <c>false</c>.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrTokenList.CopyTo(System.Int32,Microsoft.CodeAnalysis.GreenNode[],System.Int32,System.Int32)">
<summary>
Copies a given count of elements into the given array at specified offsets.
</summary>
<param name="offset">The offset to start copying from.</param>
<param name="array">The array to copy the elements into.</param>
<param name="arrayOffset">The array offset to start writing to.</param>
<param name="count">The count of elements to copy.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrTokenList.Add(Microsoft.CodeAnalysis.SyntaxNodeOrToken)">
<summary>
Creates a new <see cref="T:Microsoft.CodeAnalysis.SyntaxNodeOrTokenList"/> with the specified node or token added to the end.
</summary>
<param name="nodeOrToken">The node or token to add.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrTokenList.AddRange(System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.SyntaxNodeOrToken})">
<summary>
Creates a new <see cref="T:Microsoft.CodeAnalysis.SyntaxNodeOrTokenList"/> with the specified nodes or tokens added to the end.
</summary>
<param name="nodesOrTokens">The nodes or tokens to add.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrTokenList.Insert(System.Int32,Microsoft.CodeAnalysis.SyntaxNodeOrToken)">
<summary>
Creates a new <see cref="T:Microsoft.CodeAnalysis.SyntaxNodeOrTokenList"/> with the specified node or token inserted at the index.
</summary>
<param name="index">The index to insert at.</param>
<param name="nodeOrToken">The node or token to insert.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrTokenList.InsertRange(System.Int32,System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.SyntaxNodeOrToken})">
<summary>
Creates a new <see cref="T:Microsoft.CodeAnalysis.SyntaxNodeOrTokenList"/> with the specified nodes or tokens inserted at the index.
</summary>
<param name="index">The index to insert at.</param>
<param name="nodesAndTokens">The nodes or tokens to insert.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrTokenList.RemoveAt(System.Int32)">
<summary>
Creates a new <see cref="T:Microsoft.CodeAnalysis.SyntaxNodeOrTokenList"/> with the element at the specified index removed.
</summary>
<param name="index">The index of the element to remove.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrTokenList.Remove(Microsoft.CodeAnalysis.SyntaxNodeOrToken)">
<summary>
Creates a new <see cref="T:Microsoft.CodeAnalysis.SyntaxNodeOrTokenList"/> with the specified element removed.
</summary>
<param name="nodeOrTokenInList">The element to remove.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrTokenList.Replace(Microsoft.CodeAnalysis.SyntaxNodeOrToken,Microsoft.CodeAnalysis.SyntaxNodeOrToken)">
<summary>
Creates a new <see cref="T:Microsoft.CodeAnalysis.SyntaxNodeOrTokenList"/> with the specified element replaced with a new node or token.
</summary>
<param name="nodeOrTokenInList">The element to replace.</param>
<param name="newNodeOrToken">The new node or token.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrTokenList.ReplaceRange(Microsoft.CodeAnalysis.SyntaxNodeOrToken,System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.SyntaxNodeOrToken})">
<summary>
Creates a new <see cref="T:Microsoft.CodeAnalysis.SyntaxNodeOrTokenList"/> with the specified element replaced with a new nodes and tokens.
</summary>
<param name="nodeOrTokenInList">The element to replace.</param>
<param name="newNodesAndTokens">The new nodes and tokens.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrTokenList.GetEnumerator">
<summary>
Gets the enumerator.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrTokenList.System#Collections#Generic#IEnumerable{Microsoft#CodeAnalysis#SyntaxNodeOrToken}#GetEnumerator">
<summary>
Returns an enumerator that iterates through the collection.
</summary>
<returns>
A <see cref="T:System.Collections.Generic.IEnumerator`1"/> that can be used to iterate through the collection.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrTokenList.System#Collections#IEnumerable#GetEnumerator">
<summary>
Returns an enumerator that iterates through a collection.
</summary>
<returns>
An <see cref="T:System.Collections.IEnumerator"/> object that can be used to iterate through the collection.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrTokenList.op_Equality(Microsoft.CodeAnalysis.SyntaxNodeOrTokenList,Microsoft.CodeAnalysis.SyntaxNodeOrTokenList)">
<summary>
Implements the operator ==.
</summary>
<param name="left">The left SyntaxNodeOrTokenList</param>
<param name="right">The right SyntaxNodeOrTokenList</param>
<returns>
<c>true</c> if both lists equal, else <c>false</c>.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrTokenList.op_Inequality(Microsoft.CodeAnalysis.SyntaxNodeOrTokenList,Microsoft.CodeAnalysis.SyntaxNodeOrTokenList)">
<summary>
Implements the operator !=.
</summary>
<param name="left">The left SyntaxNodeOrTokenList</param>
<param name="right">The right SyntaxNodeOrTokenList</param>
<returns>
<c>true</c> if both lists not equal, else <c>false</c>.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrTokenList.Equals(Microsoft.CodeAnalysis.SyntaxNodeOrTokenList)">
<summary>
Indicates whether the current object is equal to another object of the same type.
</summary>
<param name="other">An object to compare with this object.</param>
<returns>
<c>true</c> if the current object is equal to the <paramref name="other"/> parameter; otherwise,
<c>false</c>.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrTokenList.Equals(System.Object)">
<summary>
Determines whether the specified <see cref="T:System.Object"/> is equal to this instance.
</summary>
<param name="obj">The <see cref="T:System.Object"/> to compare with this instance.</param>
<returns>
<c>true</c> if the specified <see cref="T:System.Object"/> is equal to this instance; otherwise, <c>false</c>.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrTokenList.GetHashCode">
<summary>
Returns a hash code for this instance.
</summary>
<returns>
A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
</returns>
</member>
<member name="T:Microsoft.CodeAnalysis.SyntaxNodeOrTokenList.Enumerator">
<summary>
Enumerator for lists of SyntaxNodeOrToken structs.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrTokenList.Enumerator.MoveNext">
<summary>
Advances the enumerator to the next element of the collection.
</summary>
<returns>
true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.
</returns>
<exception cref="T:System.InvalidOperationException">The collection was modified after the enumerator was created. </exception>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxNodeOrTokenList.Enumerator.Current">
<summary>
Gets the struct that this enumerator instance is currently pointing to.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxNodeOrTokenList.Enumerator.System#Collections#IEnumerator#Current">
<summary>
Gets the struct that this enumerator instance is currently pointing to.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrTokenList.Enumerator.System#Collections#IEnumerator#Reset">
<summary>
Sets the enumerator to its initial position, which is before the first element in the collection.
</summary>
<exception cref="T:System.InvalidOperationException">The collection was modified after the enumerator was created. </exception>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxNodeOrTokenList.Enumerator.System#IDisposable#Dispose">
<summary>
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.SyntaxReference">
<summary>
A reference to a syntax node.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxReference.SyntaxTree">
<summary>
The syntax tree that this references a node within.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxReference.Span">
<summary>
The span of the node referenced.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxReference.GetSyntax(System.Threading.CancellationToken)">
<summary>
Retrieves the original referenced syntax node.
This action may cause a parse to happen to recover the syntax node.
</summary>
<returns>The original referenced syntax node.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxReference.GetSyntaxAsync(System.Threading.CancellationToken)">
<summary>
Retrieves the original referenced syntax node.
This action may cause a parse to happen to recover the syntax node.
</summary>
<returns>The original referenced syntax node.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxReference.GetLocation">
<summary>
The location of this syntax reference.
</summary>
<returns>The location of this syntax reference.</returns>
<remarks>
More performant than GetSyntax().GetLocation().
</remarks>
</member>
<member name="F:Microsoft.CodeAnalysis.SyntaxRemoveOptions.KeepNoTrivia">
<summary>
None of the trivia associated with the node or token is kept.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SyntaxRemoveOptions.KeepLeadingTrivia">
<summary>
The leading trivia associated with the node or token is kept.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SyntaxRemoveOptions.KeepTrailingTrivia">
<summary>
The trailing trivia associated with the node or token is kept.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SyntaxRemoveOptions.KeepExteriorTrivia">
<summary>
The leading and trailing trivia associated with the node or token is kept.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SyntaxRemoveOptions.KeepUnbalancedDirectives">
<summary>
Any directives that would become unbalanced are kept.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SyntaxRemoveOptions.KeepDirectives">
<summary>
All directives are kept
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SyntaxRemoveOptions.KeepEndOfLine">
<summary>
Ensure that at least one EndOfLine trivia is kept if one was present
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SyntaxRemoveOptions.AddElasticMarker">
<summary>
Adds elastic marker trivia
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.SyntaxToken">
<summary>
Represents a token in the syntax tree. This is the language agnostic equivalent of <see
cref="T:Microsoft.CodeAnalysis.CSharp.SyntaxToken"/> and <see cref="T:Microsoft.CodeAnalysis.VisualBasic.SyntaxToken"/>.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxToken.RawKind">
<summary>
An integer representing the language specific kind of this token.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxToken.Language">
<summary>
The language name that this token is syntax of.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxToken.RawContextualKind">
<summary>
The kind of token, given its position in the syntax. This differs from <see
cref="P:Microsoft.CodeAnalysis.SyntaxToken.RawKind"/> when a contextual keyword is used in a place in the syntax that gives it
its keyword meaning.
</summary>
<remarks>
The ContextualKind is relevant only on contextual keyword tokens. ContextualKind differs
from Kind when a token is used in context where the token should be interpreted as a
keyword.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxToken.Parent">
<summary>
The node that contains this token in its Children collection.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxToken.Width">
<summary>
The width of the token in characters, not including its leading and trailing trivia.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxToken.FullWidth">
<summary>
The complete width of the token in characters including its leading and trailing trivia.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxToken.Span">
<summary>
The absolute span of this token in characters, not including its leading and trailing trivia.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxToken.SpanStart">
<summary>
Same as accessing <see cref="P:Microsoft.CodeAnalysis.Text.TextSpan.Start"/> on <see cref="P:Microsoft.CodeAnalysis.SyntaxToken.Span"/>.
</summary>
<remarks>
Slight performance improvement.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxToken.FullSpan">
<summary>
The absolute span of this token in characters, including its leading and trailing trivia.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxToken.IsMissing">
<summary>
Determines whether this token represents a language construct that was actually parsed from source code.
Missing tokens are typically generated by the parser in error scenarios to represent constructs that should
have been present in the source code for the source code to compile successfully but were actually missing.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxToken.Value">
<summary>
Returns the value of the token. For example, if the token represents an integer literal, then this property
would return the actual integer.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxToken.ValueText">
<summary>
Returns the text representation of the value of the token. For example, if the token represents an integer
literal, then this property would return a string representing the integer.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxToken.ToString">
<summary>
Returns the string representation of this token, not including its leading and trailing trivia.
</summary>
<returns>The string representation of this token, not including its leading and trailing trivia.</returns>
<remarks>The length of the returned string is always the same as Span.Length</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxToken.ToFullString">
<summary>
Returns the full string representation of this token including its leading and trailing trivia.
</summary>
<returns>The full string representation of this token including its leading and trailing trivia.</returns>
<remarks>The length of the returned string is always the same as FullSpan.Length</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxToken.WriteTo(System.IO.TextWriter)">
<summary>
Writes the full text of this token to the specified <paramref name="writer"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxToken.WriteTo(System.IO.TextWriter,System.Boolean,System.Boolean)">
<summary>
Writes the text of this token to the specified TextWriter, optionally including trivia.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxToken.HasLeadingTrivia">
<summary>
Determines whether this token has any leading trivia.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxToken.HasTrailingTrivia">
<summary>
Determines whether this token has any trailing trivia.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxToken.LeadingWidth">
<summary>
Full width of the leading trivia of this token.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxToken.TrailingWidth">
<summary>
Full width of the trailing trivia of this token.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxToken.ContainsDiagnostics">
<summary>
Determines whether this token or any of its descendant trivia have any diagnostics on them.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxToken.ContainsDirectives">
<summary>
Determines whether this token has any descendant preprocessor directives.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxToken.IsPartOfStructuredTrivia">
<summary>
Determines whether this token is a descendant of a structured trivia.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxToken.HasStructuredTrivia">
<summary>
Determines whether any of this token's trivia is structured.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxToken.ContainsAnnotations">
<summary>
True if this token or its trivia has any annotations.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxToken.HasAnnotations(System.String)">
<summary>
True if this token has annotations of the specified annotation kind.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxToken.HasAnnotations(System.String[])">
<summary>
True if this token has annotations of the specified annotation kinds.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxToken.HasAnnotation(Microsoft.CodeAnalysis.SyntaxAnnotation)">
<summary>
True if this token has the specified annotation.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxToken.GetAnnotations(System.String)">
<summary>
Gets all the annotations of the specified annotation kind.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxToken.GetAnnotations(System.String[])">
<summary>
Gets all the annotations of the specified annotation kind.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxToken.GetAnnotations(System.Collections.Generic.IEnumerable{System.String})">
<summary>
Gets all the annotations of the specified annotation kind.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxToken.WithAdditionalAnnotations(Microsoft.CodeAnalysis.SyntaxAnnotation[])">
<summary>
Adds this annotation to a given syntax token, creating a new syntax token of the same type with the
annotation on it.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxToken.WithAdditionalAnnotations(System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.SyntaxAnnotation})">
<summary>
Adds this annotation to a given syntax token, creating a new syntax token of the same type with the
annotation on it.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxToken.WithoutAnnotations(Microsoft.CodeAnalysis.SyntaxAnnotation[])">
<summary>
Creates a new syntax token identical to this one without the specified annotations.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxToken.WithoutAnnotations(System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.SyntaxAnnotation})">
<summary>
Creates a new syntax token identical to this one without the specified annotations.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxToken.WithoutAnnotations(System.String)">
<summary>
Creates a new syntax token identical to this one without annotations of the specified kind.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxToken.CopyAnnotationsTo(Microsoft.CodeAnalysis.SyntaxToken)">
<summary>
Copies all SyntaxAnnotations, if any, from this SyntaxToken instance and attaches them to a new instance based on <paramref name="token" />.
</summary>
<remarks>
If no annotations are copied, just returns <paramref name="token" />.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxToken.LeadingTrivia">
<summary>
The list of trivia that appear before this token in the source code.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxToken.TrailingTrivia">
<summary>
The list of trivia that appear after this token in the source code and are attached to this token or any of
its descendants.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxToken.WithTriviaFrom(Microsoft.CodeAnalysis.SyntaxToken)">
<summary>
Creates a new token from this token with the leading and trailing trivia from the specified token.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxToken.WithLeadingTrivia(Microsoft.CodeAnalysis.SyntaxTriviaList)">
<summary>
Creates a new token from this token with the leading trivia specified.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxToken.WithLeadingTrivia(Microsoft.CodeAnalysis.SyntaxTrivia[])">
<summary>
Creates a new token from this token with the leading trivia specified..
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxToken.WithLeadingTrivia(System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.SyntaxTrivia})">
<summary>
Creates a new token from this token with the leading trivia specified.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxToken.WithTrailingTrivia(Microsoft.CodeAnalysis.SyntaxTriviaList)">
<summary>
Creates a new token from this token with the trailing trivia specified.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxToken.WithTrailingTrivia(Microsoft.CodeAnalysis.SyntaxTrivia[])">
<summary>
Creates a new token from this token with the trailing trivia specified.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxToken.WithTrailingTrivia(System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.SyntaxTrivia})">
<summary>
Creates a new token from this token with the trailing trivia specified.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxToken.GetAllTrivia">
<summary>
Gets a list of all the trivia (both leading and trailing) for this token.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxToken.op_Equality(Microsoft.CodeAnalysis.SyntaxToken,Microsoft.CodeAnalysis.SyntaxToken)">
<summary>
Determines whether two <see cref="T:Microsoft.CodeAnalysis.SyntaxToken"/>s are equal.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxToken.op_Inequality(Microsoft.CodeAnalysis.SyntaxToken,Microsoft.CodeAnalysis.SyntaxToken)">
<summary>
Determines whether two <see cref="T:Microsoft.CodeAnalysis.SyntaxToken"/>s are unequal.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxToken.Equals(Microsoft.CodeAnalysis.SyntaxToken)">
<summary>
Determines whether the supplied <see cref="T:Microsoft.CodeAnalysis.SyntaxToken"/> is equal to this
<see cref="T:Microsoft.CodeAnalysis.SyntaxToken"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxToken.Equals(System.Object)">
<summary>
Determines whether the supplied <see cref="T:Microsoft.CodeAnalysis.SyntaxToken"/> is equal to this
<see cref="T:Microsoft.CodeAnalysis.SyntaxToken"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxToken.GetHashCode">
<summary>
Serves as hash function for <see cref="T:Microsoft.CodeAnalysis.SyntaxToken"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxToken.GetNextToken(System.Boolean,System.Boolean,System.Boolean,System.Boolean)">
<summary>
Gets the token that follows this token in the syntax tree.
</summary>
<returns>The token that follows this token in the syntax tree.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxToken.GetNextToken(System.Func{Microsoft.CodeAnalysis.SyntaxToken,System.Boolean},System.Func{Microsoft.CodeAnalysis.SyntaxTrivia,System.Boolean})">
<summary>
Returns the token after this token in the syntax tree.
</summary>
<param name="predicate">Delegate applied to each token. The token is returned if the predicate returns
true.</param>
<param name="stepInto">Delegate applied to trivia. If this delegate is present then trailing trivia is
included in the search.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxToken.GetPreviousToken(System.Boolean,System.Boolean,System.Boolean,System.Boolean)">
<summary>
Gets the token that precedes this token in the syntax tree.
</summary>
<returns>The next token that follows this token in the syntax tree.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxToken.GetPreviousToken(System.Func{Microsoft.CodeAnalysis.SyntaxToken,System.Boolean},System.Func{Microsoft.CodeAnalysis.SyntaxTrivia,System.Boolean})">
<summary>
Returns the token before this token in the syntax tree.
</summary>
<param name="predicate">Delegate applied to each token. The token is returned if the predicate returns
true.</param>
<param name="stepInto">Delegate applied to trivia. If this delegate is present then trailing trivia is
included in the search.</param>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxToken.SyntaxTree">
<summary>
The SyntaxTree that contains this token.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxToken.GetLocation">
<summary>
Gets the location for this token.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxToken.GetDiagnostics">
<summary>
Gets a list of all the diagnostics associated with this token and any related trivia.
This method does not filter diagnostics based on #pragmas and compiler options
like nowarn, warnaserror etc.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxToken.IsEquivalentTo(Microsoft.CodeAnalysis.SyntaxToken)">
<summary>
Determines if this token is equivalent to the specified token.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.SyntaxTokenList">
<summary>
Represents a read-only list of <see cref="T:Microsoft.CodeAnalysis.SyntaxToken"/>.
</summary>
<summary>
Represents a read-only list of <see cref="T:Microsoft.CodeAnalysis.SyntaxToken"/>s.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTokenList.#ctor(Microsoft.CodeAnalysis.SyntaxToken[])">
<summary>
Creates a list of tokens.
</summary>
<param name="tokens">An array of tokens.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTokenList.#ctor(System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.SyntaxToken})">
<summary>
Creates a list of tokens.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxTokenList.Count">
<summary>
Returns the number of tokens in the list.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxTokenList.Item(System.Int32)">
<summary>
Gets the token at the specified index.
</summary>
<param name="index">The zero-based index of the token to get.</param>
<returns>The token at the specified index.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="index" /> is less than 0.-or-<paramref name="index" /> is equal to or greater than <see cref="P:Microsoft.CodeAnalysis.SyntaxTokenList.Count" />. </exception>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxTokenList.FullSpan">
<summary>
The absolute span of the list elements in characters, including the leading and trailing trivia of the first and last elements.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxTokenList.Span">
<summary>
The absolute span of the list elements in characters, not including the leading and trailing trivia of the first and last elements.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTokenList.ToString">
<summary>
Returns the string representation of the tokens in this list, not including
the first token's leading trivia and the last token's trailing trivia.
</summary>
<returns>
The string representation of the tokens in this list, not including
the first token's leading trivia and the last token's trailing trivia.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTokenList.ToFullString">
<summary>
Returns the full string representation of the tokens in this list including
the first token's leading trivia and the last token's trailing trivia.
</summary>
<returns>
The full string representation of the tokens in this list including
the first token's leading trivia and the last token's trailing trivia.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTokenList.First">
<summary>
Returns the first token in the list.
</summary>
<returns>The first token in the list.</returns>
<exception cref="T:System.InvalidOperationException">The list is empty.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTokenList.Last">
<summary>
Returns the last token in the list.
</summary>
<returns> The last token in the list.</returns>
<exception cref="T:System.InvalidOperationException">The list is empty.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTokenList.Any">
<summary>
Tests whether the list is non-empty.
</summary>
<returns>True if the list contains any tokens.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTokenList.Reverse">
<summary>
Returns a list which contains all elements of <see cref="T:Microsoft.CodeAnalysis.SyntaxTokenList"/> in reversed order.
</summary>
<returns><see cref="T:Microsoft.CodeAnalysis.SyntaxTokenList.Reversed"/> which contains all elements of <see cref="T:Microsoft.CodeAnalysis.SyntaxTokenList"/> in reversed order</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTokenList.GetGreenNodeAt(System.Int32)">
<summary>
get the green node at the given slot
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTokenList.GetGreenNodeAt(Microsoft.CodeAnalysis.GreenNode,System.Int32)">
<summary>
get the green node at the given slot
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTokenList.Add(Microsoft.CodeAnalysis.SyntaxToken)">
<summary>
Creates a new <see cref="T:Microsoft.CodeAnalysis.SyntaxTokenList"/> with the specified token added to the end.
</summary>
<param name="token">The token to add.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTokenList.AddRange(System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.SyntaxToken})">
<summary>
Creates a new <see cref="T:Microsoft.CodeAnalysis.SyntaxTokenList"/> with the specified tokens added to the end.
</summary>
<param name="tokens">The tokens to add.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTokenList.Insert(System.Int32,Microsoft.CodeAnalysis.SyntaxToken)">
<summary>
Creates a new <see cref="T:Microsoft.CodeAnalysis.SyntaxTokenList"/> with the specified token insert at the index.
</summary>
<param name="index">The index to insert the new token.</param>
<param name="token">The token to insert.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTokenList.InsertRange(System.Int32,System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.SyntaxToken})">
<summary>
Creates a new <see cref="T:Microsoft.CodeAnalysis.SyntaxTokenList"/> with the specified tokens insert at the index.
</summary>
<param name="index">The index to insert the new tokens.</param>
<param name="tokens">The tokens to insert.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTokenList.RemoveAt(System.Int32)">
<summary>
Creates a new <see cref="T:Microsoft.CodeAnalysis.SyntaxTokenList"/> with the token at the specified index removed.
</summary>
<param name="index">The index of the token to remove.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTokenList.Remove(Microsoft.CodeAnalysis.SyntaxToken)">
<summary>
Creates a new <see cref="T:Microsoft.CodeAnalysis.SyntaxTokenList"/> with the specified token removed.
</summary>
<param name="tokenInList">The token to remove.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTokenList.Replace(Microsoft.CodeAnalysis.SyntaxToken,Microsoft.CodeAnalysis.SyntaxToken)">
<summary>
Creates a new <see cref="T:Microsoft.CodeAnalysis.SyntaxTokenList"/> with the specified token replaced with a new token.
</summary>
<param name="tokenInList">The token to replace.</param>
<param name="newToken">The new token.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTokenList.ReplaceRange(Microsoft.CodeAnalysis.SyntaxToken,System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.SyntaxToken})">
<summary>
Creates a new <see cref="T:Microsoft.CodeAnalysis.SyntaxTokenList"/> with the specified token replaced with new tokens.
</summary>
<param name="tokenInList">The token to replace.</param>
<param name="newTokens">The new tokens.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTokenList.GetEnumerator">
<summary>
Returns an enumerator for the tokens in the <see cref="T:Microsoft.CodeAnalysis.SyntaxTokenList"/>
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTokenList.op_Equality(Microsoft.CodeAnalysis.SyntaxTokenList,Microsoft.CodeAnalysis.SyntaxTokenList)">
<summary>
Compares <paramref name="left"/> and <paramref name="right"/> for equality.
</summary>
<param name="left"></param>
<param name="right"></param>
<returns>True if the two <see cref="T:Microsoft.CodeAnalysis.SyntaxTokenList"/>s are equal.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTokenList.op_Inequality(Microsoft.CodeAnalysis.SyntaxTokenList,Microsoft.CodeAnalysis.SyntaxTokenList)">
<summary>
Compares <paramref name="left"/> and <paramref name="right"/> for inequality.
</summary>
<param name="left"></param>
<param name="right"></param>
<returns>True if the two <see cref="T:Microsoft.CodeAnalysis.SyntaxTokenList"/>s are not equal.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTokenList.Equals(System.Object)">
<summary>
Compares this <see cref="T:Microsoft.CodeAnalysis.SyntaxTokenList"/> with the <paramref name="obj"/> for equality.
</summary>
<returns>True if the two objects are equal.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTokenList.GetHashCode">
<summary>
Serves as a hash function for the <see cref="T:Microsoft.CodeAnalysis.SyntaxTokenList"/>
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTokenList.Create(Microsoft.CodeAnalysis.SyntaxToken)">
<summary>
Create a new Token List
</summary>
<param name="token">Element of the return Token List</param>
</member>
<member name="T:Microsoft.CodeAnalysis.SyntaxTokenList.Enumerator">
<summary>
A structure for enumerating a <see cref="T:Microsoft.CodeAnalysis.SyntaxTokenList"/>
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTokenList.Enumerator.MoveNext">
<summary>
Advances the enumerator to the next token in the collection.
</summary>
<returns>true if the enumerator was successfully advanced to the next element; false if the enumerator
has passed the end of the collection.</returns>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxTokenList.Enumerator.Current">
<summary>
Gets the current element in the collection.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.SyntaxTokenList.Reversed">
<summary>
Reversed enumerable.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.SyntaxTree">
<summary>
The parsed representation of a source document.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SyntaxTree.EmptyDiagnosticOptions">
<summary>
Cached value for empty <see cref="P:Microsoft.CodeAnalysis.SyntaxTree.DiagnosticOptions"/>.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxTree.FilePath">
<summary>
The path of the source document file.
</summary>
<remarks>
If this syntax tree is not associated with a file, this value can be empty.
The path shall not be null.
The file doesn't need to exist on disk. The path is opaque to the compiler.
The only requirement on the path format is that the implementations of
<see cref="T:Microsoft.CodeAnalysis.SourceReferenceResolver"/>, <see cref="T:Microsoft.CodeAnalysis.XmlReferenceResolver"/> and <see cref="T:Microsoft.CodeAnalysis.MetadataReferenceResolver"/>
passed to the compilation that contains the tree understand it.
Clients must also not assume that the values of this property are unique
within a Compilation.
The path is used as follows:
- When debug information is emitted, this path is embedded in the debug information.
- When resolving and normalizing relative paths in #r, #load, #line/#ExternalSource,
#pragma checksum, #ExternalChecksum directives, XML doc comment include elements, etc.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxTree.HasCompilationUnitRoot">
<summary>
Returns true if this syntax tree has a root with SyntaxKind "CompilationUnit".
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxTree.Options">
<summary>
The options used by the parser to produce the syntax tree.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxTree.OptionsCore">
<summary>
The options used by the parser to produce the syntax tree.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxTree.DiagnosticOptions">
<summary>
Option to specify custom behavior for each warning in this tree.
</summary>
<returns>
A map from diagnostic ID to diagnostic reporting level. The diagnostic
ID string may be case insensitive depending on the language.
</returns>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxTree.Length">
<summary>
The length of the text of the syntax tree.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTree.TryGetText(Microsoft.CodeAnalysis.Text.SourceText@)">
<summary>
Gets the syntax tree's text if it is available.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTree.GetText(System.Threading.CancellationToken)">
<summary>
Gets the text of the source document.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxTree.Encoding">
<summary>
The text encoding of the source document.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTree.GetTextAsync(System.Threading.CancellationToken)">
<summary>
Gets the text of the source document asynchronously.
</summary>
<remarks>
By default, the work associated with this method will be executed immediately on the current thread.
Implementations that wish to schedule this work differently should override <see cref="M:Microsoft.CodeAnalysis.SyntaxTree.GetTextAsync(System.Threading.CancellationToken)"/>.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTree.TryGetRoot(Microsoft.CodeAnalysis.SyntaxNode@)">
<summary>
Gets the root of the syntax tree if it is available.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTree.TryGetRootCore(Microsoft.CodeAnalysis.SyntaxNode@)">
<summary>
Gets the root of the syntax tree if it is available.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTree.GetRoot(System.Threading.CancellationToken)">
<summary>
Gets the root node of the syntax tree, causing computation if necessary.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTree.GetRootCore(System.Threading.CancellationToken)">
<summary>
Gets the root node of the syntax tree, causing computation if necessary.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTree.GetRootAsync(System.Threading.CancellationToken)">
<summary>
Gets the root node of the syntax tree asynchronously.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTree.GetRootAsyncCore(System.Threading.CancellationToken)">
<summary>
Gets the root node of the syntax tree asynchronously.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTree.WithChangedText(Microsoft.CodeAnalysis.Text.SourceText)">
<summary>
Create a new syntax tree based off this tree using a new source text.
If the new source text is a minor change from the current source text an incremental
parse will occur reusing most of the current syntax tree internal data. Otherwise, a
full parse will occur using the new source text.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTree.GetDiagnostics(System.Threading.CancellationToken)">
<summary>
Gets a list of all the diagnostics in the syntax tree.
This method does not filter diagnostics based on #pragmas and compiler options
like nowarn, warnaserror etc.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTree.GetDiagnostics(Microsoft.CodeAnalysis.SyntaxNode)">
<summary>
Gets a list of all the diagnostics in the sub tree that has the specified node as its root.
This method does not filter diagnostics based on #pragmas and compiler options
like nowarn, warnaserror etc.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTree.GetDiagnostics(Microsoft.CodeAnalysis.SyntaxToken)">
<summary>
Gets a list of all the diagnostics associated with the token and any related trivia.
This method does not filter diagnostics based on #pragmas and compiler options
like nowarn, warnaserror etc.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTree.GetDiagnostics(Microsoft.CodeAnalysis.SyntaxTrivia)">
<summary>
Gets a list of all the diagnostics associated with the trivia.
This method does not filter diagnostics based on #pragmas and compiler options
like nowarn, warnaserror etc.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTree.GetDiagnostics(Microsoft.CodeAnalysis.SyntaxNodeOrToken)">
<summary>
Gets a list of all the diagnostics in either the sub tree that has the specified node as its root or
associated with the token and its related trivia.
This method does not filter diagnostics based on #pragmas and compiler options
like nowarn, warnaserror etc.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTree.GetLineSpan(Microsoft.CodeAnalysis.Text.TextSpan,System.Threading.CancellationToken)">
<summary>
Gets the location in terms of path, line and column for a given span.
</summary>
<param name="span">Span within the tree.</param>
<param name="cancellationToken">Cancellation token.</param>
<returns>
A valid <see cref="T:Microsoft.CodeAnalysis.FileLinePositionSpan"/> that contains path, line and column information.
The values are not affected by line mapping directives (<c>#line</c>).
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTree.GetMappedLineSpan(Microsoft.CodeAnalysis.Text.TextSpan,System.Threading.CancellationToken)">
<summary>
Gets the location in terms of path, line and column after applying source line mapping directives
(<c>#line</c> in C# or <c>#ExternalSource</c> in VB).
</summary>
<param name="span">Span within the tree.</param>
<param name="cancellationToken">Cancellation token.</param>
<returns>
A valid <see cref="T:Microsoft.CodeAnalysis.FileLinePositionSpan"/> that contains path, line and column information.
If the location path is mapped the resulting path is the path specified in the corresponding <c>#line</c>,
otherwise it's <see cref="P:Microsoft.CodeAnalysis.SyntaxTree.FilePath"/>.
A location path is considered mapped if the first <c>#line</c> directive that precedes it and that
either specifies an explicit file path or is <c>#line default</c> exists and specifies an explicit path.
</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTree.GetLineVisibility(System.Int32,System.Threading.CancellationToken)">
<summary>
Returns the visibility for the line at the given position.
</summary>
<param name="position">The position to check.</param>
<param name="cancellationToken">The cancellation token.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTree.GetMappedLineSpanAndVisibility(Microsoft.CodeAnalysis.Text.TextSpan,System.Boolean@)">
<summary>
Gets a FileLinePositionSpan for a TextSpan and the information whether this span is considered to be hidden or not.
FileLinePositionSpans are used primarily for diagnostics and source locations.
This method combines a call to GetLineSpan and IsHiddenPosition.
</summary>
<param name="span"></param>
<param name="isHiddenPosition">Returns a boolean indicating whether this span is considered hidden or not.</param>
<remarks>This function is being called only in the context of sequence point creation and therefore interprets the
LineVisibility accordingly (BeforeFirstRemappingDirective -> Visible).</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTree.GetDisplayPath(Microsoft.CodeAnalysis.Text.TextSpan,Microsoft.CodeAnalysis.SourceReferenceResolver)">
<summary>
Returns a path for particular location in source that is presented to the user.
</summary>
<remarks>
Used for implementation of <see cref="T:System.Runtime.CompilerServices.CallerFilePathAttribute"/>
or for embedding source paths in error messages.
Unlike Dev12 we do account for #line and #ExternalSource directives when determining value for
<see cref="T:System.Runtime.CompilerServices.CallerFilePathAttribute"/>.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTree.GetDisplayLineNumber(Microsoft.CodeAnalysis.Text.TextSpan)">
<summary>
Returns a line number for particular location in source that is presented to the user.
</summary>
<remarks>
Used for implementation of <see cref="T:System.Runtime.CompilerServices.CallerLineNumberAttribute"/>
or for embedding source line numbers in error messages.
Unlike Dev12 we do account for #line and #ExternalSource directives when determining value for
<see cref="T:System.Runtime.CompilerServices.CallerLineNumberAttribute"/>.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTree.HasHiddenRegions">
<summary>
Are there any hidden regions in the tree?
</summary>
<returns>True if there is at least one hidden region.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTree.GetChangedSpans(Microsoft.CodeAnalysis.SyntaxTree)">
<summary>
Returns a list of the changed regions between this tree and the specified tree. The list is conservative for
performance reasons. It may return larger regions than what has actually changed.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTree.GetLocation(Microsoft.CodeAnalysis.Text.TextSpan)">
<summary>
Gets a location for the specified text span.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTree.IsEquivalentTo(Microsoft.CodeAnalysis.SyntaxTree,System.Boolean)">
<summary>
Determines if two trees are the same, disregarding trivia differences.
</summary>
<param name="tree">The tree to compare against.</param>
<param name="topLevel"> If true then the trees are equivalent if the contained nodes and tokens declaring
metadata visible symbolic information are equivalent, ignoring any differences of nodes inside method bodies
or initializer expressions, otherwise all nodes and tokens must be equivalent.
</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTree.GetReference(Microsoft.CodeAnalysis.SyntaxNode)">
<summary>
Gets a SyntaxReference for a specified syntax node. SyntaxReferences can be used to
regain access to a syntax node without keeping the entire tree and source text in
memory.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTree.GetChanges(Microsoft.CodeAnalysis.SyntaxTree)">
<summary>
Gets a list of text changes that when applied to the old tree produce this tree.
</summary>
<param name="oldTree">The old tree.</param>
<remarks>The list of changes may be different than the original changes that produced
this tree.</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTree.GetDebugSourceInfo">
<summary>
Gets the checksum + algorithm id to use in the PDB.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTree.WithRootAndOptions(Microsoft.CodeAnalysis.SyntaxNode,Microsoft.CodeAnalysis.ParseOptions)">
<summary>
Returns a new tree whose root and options are as specified and other properties are copied from the current tree.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTree.WithFilePath(System.String)">
<summary>
Returns a new tree whose <see cref="P:Microsoft.CodeAnalysis.SyntaxTree.FilePath"/> is the specified node and other properties are copied from the current tree.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTree.WithDiagnosticOptions(System.Collections.Immutable.ImmutableDictionary{System.String,Microsoft.CodeAnalysis.ReportDiagnostic})">
<summary>
Returns a new tree whose <see cref="P:Microsoft.CodeAnalysis.SyntaxTree.DiagnosticOptions" /> are the specified value and other properties are copied
from the current tree.
</summary>
<param name="options">
A mapping from diagnostic id to diagnostic reporting level. The diagnostic ID may be case-sensitive depending
on the language.
</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTree.ToString">
<summary>
Returns a <see cref="T:System.String" /> that represents the entire source text of this <see cref="T:Microsoft.CodeAnalysis.SyntaxTree"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTreeExtensions.VerifySource(Microsoft.CodeAnalysis.SyntaxTree,System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.Text.TextChangeRange})">
<summary>
Verify nodes match source.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTreeExtensions.FindFirstDifference(System.String,System.String)">
<summary>
Return the index of the first difference between
the two strings, or -1 if the strings are the same.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTreeExtensions.IsHiddenPosition(Microsoft.CodeAnalysis.SyntaxTree,System.Int32,System.Threading.CancellationToken)">
<summary>
Returns <c>true</c> if the provided position is in a hidden region inaccessible to the user.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.SyntaxTrivia">
<summary>
Represents a trivia in the syntax tree.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxTrivia.RawKind">
<summary>
An integer representing the language specific kind of this trivia.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxTrivia.Language">
<summary>
The language name that this trivia is syntax of.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxTrivia.Token">
<summary>
The parent token that contains this token in its LeadingTrivia or TrailingTrivia collection.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxTrivia.Width">
<summary>
The width of this trivia in characters. If this trivia is a structured trivia then the returned width will
not include the widths of any leading or trailing trivia present on the child non-terminal node of this
trivia.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxTrivia.FullWidth">
<summary>
The width of this trivia in characters. If this trivia is a structured trivia then the returned width will
include the widths of any leading or trailing trivia present on the child non-terminal node of this trivia.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxTrivia.Span">
<summary>
The absolute span of this trivia in characters. If this trivia is a structured trivia then the returned span
will not include spans of any leading or trailing trivia present on the child non-terminal node of this
trivia.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxTrivia.SpanStart">
<summary>
Same as accessing <see cref="P:Microsoft.CodeAnalysis.Text.TextSpan.Start"/> on <see cref="P:Microsoft.CodeAnalysis.SyntaxTrivia.Span"/>.
</summary>
<remarks>
Slight performance improvement.
</remarks>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxTrivia.FullSpan">
<summary>
The absolute span of this trivia in characters. If this trivia is a structured trivia then the returned span
will include spans of any leading or trailing trivia present on the child non-terminal node of this trivia.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxTrivia.ContainsDiagnostics">
<summary>
Determines whether this trivia has any diagnostics on it. If this trivia is a structured trivia then the
returned value will indicate whether this trivia or any of its descendant nodes, tokens or trivia have any
diagnostics on them.
</summary>>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxTrivia.HasStructure">
<summary>
Determines whether this trivia is a structured trivia.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTrivia.IsPartOfStructuredTrivia">
<summary>
Determines whether this trivia is a descendant of a structured trivia.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxTrivia.ContainsAnnotations">
<summary>
Determines whether this trivia or any of its structure has annotations.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTrivia.HasAnnotations(System.String)">
<summary>
Determines where this trivia has annotations of the specified annotation kind.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTrivia.HasAnnotations(System.String[])">
<summary>
Determines where this trivia has any annotations of the specified annotation kinds.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTrivia.HasAnnotation(Microsoft.CodeAnalysis.SyntaxAnnotation)">
<summary>
Determines whether this trivia has the specific annotation.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTrivia.GetAnnotations(System.String)">
<summary>
Get all the annotations of the specified annotation kind.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTrivia.GetAnnotations(System.String[])">
<summary>
Get all the annotations of the specified annotation kinds.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxTrivia.IsDirective">
<summary>
Determines whether this trivia represents a preprocessor directive.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTrivia.GetStructure">
<summary>
Returns the child non-terminal node representing the syntax tree structure under this structured trivia.
</summary>
<returns>The child non-terminal node representing the syntax tree structure under this structured
trivia.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTrivia.ToString">
<summary>
Returns the string representation of this trivia. If this trivia is structured trivia then the returned string
will not include any leading or trailing trivia present on the StructuredTriviaSyntax node of this trivia.
</summary>
<returns>The string representation of this trivia.</returns>
<remarks>The length of the returned string is always the same as Span.Length</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTrivia.ToFullString">
<summary>
Returns the full string representation of this trivia. If this trivia is structured trivia then the returned string will
include any leading or trailing trivia present on the StructuredTriviaSyntax node of this trivia.
</summary>
<returns>The full string representation of this trivia.</returns>
<remarks>The length of the returned string is always the same as FullSpan.Length</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTrivia.WriteTo(System.IO.TextWriter)">
<summary>
Writes the full text of this trivia to the specified TextWriter.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTrivia.op_Equality(Microsoft.CodeAnalysis.SyntaxTrivia,Microsoft.CodeAnalysis.SyntaxTrivia)">
<summary>
Determines whether two <see cref="T:Microsoft.CodeAnalysis.SyntaxTrivia"/>s are equal.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTrivia.op_Inequality(Microsoft.CodeAnalysis.SyntaxTrivia,Microsoft.CodeAnalysis.SyntaxTrivia)">
<summary>
Determines whether two <see cref="T:Microsoft.CodeAnalysis.SyntaxTrivia"/>s are unequal.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTrivia.Equals(Microsoft.CodeAnalysis.SyntaxTrivia)">
<summary>
Determines whether the supplied <see cref="T:Microsoft.CodeAnalysis.SyntaxTrivia"/> is equal to this
<see cref="T:Microsoft.CodeAnalysis.SyntaxTrivia"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTrivia.Equals(System.Object)">
<summary>
Determines whether the supplied <see cref="T:Microsoft.CodeAnalysis.SyntaxTrivia"/> is equal to this
<see cref="T:Microsoft.CodeAnalysis.SyntaxTrivia"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTrivia.GetHashCode">
<summary>
Serves as hash function for <see cref="T:Microsoft.CodeAnalysis.SyntaxTrivia"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTrivia.WithAdditionalAnnotations(Microsoft.CodeAnalysis.SyntaxAnnotation[])">
<summary>
Creates a new SyntaxTrivia with the specified annotations.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTrivia.WithAdditionalAnnotations(System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.SyntaxAnnotation})">
<summary>
Creates a new SyntaxTrivia with the specified annotations.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTrivia.WithoutAnnotations(Microsoft.CodeAnalysis.SyntaxAnnotation[])">
<summary>
Creates a new SyntaxTrivia without the specified annotations.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTrivia.WithoutAnnotations(System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.SyntaxAnnotation})">
<summary>
Creates a new SyntaxTrivia without the specified annotations.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTrivia.WithoutAnnotations(System.String)">
<summary>
Creates a new SyntaxTrivia without annotations of the specified kind.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTrivia.CopyAnnotationsTo(Microsoft.CodeAnalysis.SyntaxTrivia)">
<summary>
Copies all SyntaxAnnotations, if any, from this SyntaxTrivia instance and attaches them to a new instance based on <paramref name="trivia" />.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxTrivia.SyntaxTree">
<summary>
SyntaxTree which contains current SyntaxTrivia.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTrivia.GetLocation">
<summary>
Get the location of this trivia.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTrivia.GetDiagnostics">
<summary>
Gets a list of all the diagnostics associated with this trivia.
This method does not filter diagnostics based on #pragmas and compiler options
like nowarn, warnaserror etc.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTrivia.IsEquivalentTo(Microsoft.CodeAnalysis.SyntaxTrivia)">
<summary>
Determines if this trivia is equivalent to the specified trivia.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.SyntaxTriviaList">
<summary>
Represents a read-only list of <see cref="T:Microsoft.CodeAnalysis.SyntaxTrivia"/>.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTriviaList.#ctor(Microsoft.CodeAnalysis.SyntaxTrivia[])">
<summary>
Creates a list of trivia.
</summary>
<param name="trivias">An array of trivia.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTriviaList.#ctor(System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.SyntaxTrivia})">
<summary>
Creates a list of trivia.
</summary>
<param name="trivias">A sequence of trivia.</param>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxTriviaList.Item(System.Int32)">
<summary>
Gets the trivia at the specified index.
</summary>
<param name="index">The zero-based index of the trivia to get.</param>
<returns>The token at the specified index.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="index" /> is less than 0.-or-<paramref name="index" /> is equal to or greater than <see cref="P:Microsoft.CodeAnalysis.SyntaxTriviaList.Count" />. </exception>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxTriviaList.FullSpan">
<summary>
The absolute span of the list elements in characters, including the leading and trailing trivia of the first and last elements.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxTriviaList.Span">
<summary>
The absolute span of the list elements in characters, not including the leading and trailing trivia of the first and last elements.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTriviaList.First">
<summary>
Returns the first trivia in the list.
</summary>
<returns>The first trivia in the list.</returns>
<exception cref="T:System.InvalidOperationException">The list is empty.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTriviaList.Last">
<summary>
Returns the last trivia in the list.
</summary>
<returns>The last trivia in the list.</returns>
<exception cref="T:System.InvalidOperationException">The list is empty.</exception>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTriviaList.Any">
<summary>
Does this list have any items.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTriviaList.Reverse">
<summary>
Returns a list which contains all elements of <see cref="T:Microsoft.CodeAnalysis.SyntaxTriviaList"/> in reversed order.
</summary>
<returns><see cref="T:Microsoft.CodeAnalysis.SyntaxTriviaList.Reversed"/> which contains all elements of <see cref="T:Microsoft.CodeAnalysis.SyntaxTriviaList"/> in reversed order</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTriviaList.Add(Microsoft.CodeAnalysis.SyntaxTrivia)">
<summary>
Creates a new <see cref="T:Microsoft.CodeAnalysis.SyntaxTriviaList"/> with the specified trivia added to the end.
</summary>
<param name="trivia">The trivia to add.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTriviaList.AddRange(System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.SyntaxTrivia})">
<summary>
Creates a new <see cref="T:Microsoft.CodeAnalysis.SyntaxTriviaList"/> with the specified trivia added to the end.
</summary>
<param name="trivia">The trivia to add.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTriviaList.Insert(System.Int32,Microsoft.CodeAnalysis.SyntaxTrivia)">
<summary>
Creates a new <see cref="T:Microsoft.CodeAnalysis.SyntaxTriviaList"/> with the specified trivia inserted at the index.
</summary>
<param name="index">The index in the list to insert the trivia at.</param>
<param name="trivia">The trivia to insert.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTriviaList.InsertRange(System.Int32,System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.SyntaxTrivia})">
<summary>
Creates a new <see cref="T:Microsoft.CodeAnalysis.SyntaxTriviaList"/> with the specified trivia inserted at the index.
</summary>
<param name="index">The index in the list to insert the trivia at.</param>
<param name="trivia">The trivia to insert.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTriviaList.RemoveAt(System.Int32)">
<summary>
Creates a new <see cref="T:Microsoft.CodeAnalysis.SyntaxTriviaList"/> with the element at the specified index removed.
</summary>
<param name="index">The index identifying the element to remove.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTriviaList.Remove(Microsoft.CodeAnalysis.SyntaxTrivia)">
<summary>
Creates a new <see cref="T:Microsoft.CodeAnalysis.SyntaxTriviaList"/> with the specified element removed.
</summary>
<param name="triviaInList">The trivia element to remove.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTriviaList.Replace(Microsoft.CodeAnalysis.SyntaxTrivia,Microsoft.CodeAnalysis.SyntaxTrivia)">
<summary>
Creates a new <see cref="T:Microsoft.CodeAnalysis.SyntaxTriviaList"/> with the specified element replaced with new trivia.
</summary>
<param name="triviaInList">The trivia element to replace.</param>
<param name="newTrivia">The trivia to replace the element with.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTriviaList.ReplaceRange(Microsoft.CodeAnalysis.SyntaxTrivia,System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.SyntaxTrivia})">
<summary>
Creates a new <see cref="T:Microsoft.CodeAnalysis.SyntaxTriviaList"/> with the specified element replaced with new trivia.
</summary>
<param name="triviaInList">The trivia element to replace.</param>
<param name="newTrivia">The trivia to replace the element with.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTriviaList.GetGreenNodeAt(System.Int32)">
<summary>
get the green node at the specific slot
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxTriviaList.CopyTo(System.Int32,Microsoft.CodeAnalysis.SyntaxTrivia[],System.Int32,System.Int32)">
<summary>
Copy <paramref name="count"/> number of items starting at <paramref name="offset"/> from this list into <paramref name="array"/> starting at <paramref name="arrayOffset"/>.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.SyntaxTriviaList.Reversed">
<summary>
Reversed enumerable.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.SyntaxWalker">
<summary>
Walks the syntax tree, allowing subclasses to operate on all nodes, token and trivia. The
walker will perform a depth first walk of the tree.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.SyntaxWalker.Depth">
<summary>
Syntax the <see cref="T:Microsoft.CodeAnalysis.SyntaxWalker"/> should descend into.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxWalker.#ctor(Microsoft.CodeAnalysis.SyntaxWalkerDepth)">
<summary>
Creates a new walker instance.
</summary>
<param name="depth">Syntax the <see cref="T:Microsoft.CodeAnalysis.SyntaxWalker"/> should descend into.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxWalker.Visit(Microsoft.CodeAnalysis.SyntaxNode)">
<summary>
Called when the walker visits a node. This method may be overridden if subclasses want
to handle the node. Overrides should call back into this base method if they want the
children of this node to be visited.
</summary>
<param name="node">The current node that the walker is visiting.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxWalker.VisitToken(Microsoft.CodeAnalysis.SyntaxToken)">
<summary>
Called when the walker visits a token. This method may be overridden if subclasses want
to handle the token. Overrides should call back into this base method if they want the
trivia of this token to be visited.
</summary>
<param name="token">The current token that the walker is visiting.</param>
</member>
<member name="M:Microsoft.CodeAnalysis.SyntaxWalker.VisitTrivia(Microsoft.CodeAnalysis.SyntaxTrivia)">
<summary>
Called when the walker visits a trivia syntax. This method may be overridden if
subclasses want to handle the token. Overrides should call back into this base method if
they want the children of this trivia syntax to be visited.
</summary>
<param name="trivia">The current trivia syntax that the walker is visiting.</param>
</member>
<member name="T:Microsoft.CodeAnalysis.SyntaxWalkerDepth">
<summary>
Syntax the <see cref="T:Microsoft.CodeAnalysis.SyntaxWalker"/> should descend into.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SyntaxWalkerDepth.Node">
<summary>
descend into only nodes
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SyntaxWalkerDepth.Token">
<summary>
descend into nodes and tokens
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SyntaxWalkerDepth.Trivia">
<summary>
descend into nodes, tokens and trivia
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SyntaxWalkerDepth.StructuredTrivia">
<summary>
descend into everything
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.SynthesizedLocalKind">
<summary>
Kind of a synthesized local variable.
</summary>
<remarks>
Synthesized local variables are either
1) Short-lived (temporary)
The lifespan of a temporary variable shall not cross a statement boundary (a PDB sequence point).
These variables are not tracked by EnC and don't have names.
2) Long-lived
All variables whose lifespan might cross a statement boundary (include a PDB sequence point)
must be named in a build configuration that supports EnC. Some of them might need to be named in release, to support EE.
The kind of such local must be encoded in the name, so that we can retrieve it from debug metadata during EnC.
The integer value of the kind must match corresponding Dev11/12 TEMP_KIND enum values for
compatibility with assemblies generated by the native compiler.
Long-lived local variables must be assigned slots in source order.
</remarks>
</member>
<member name="F:Microsoft.CodeAnalysis.SynthesizedLocalKind.FrameCache">
<summary>
Temp created for caching "this".
Technically it is long-lived, but will happen only in optimized code.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SynthesizedLocalKind.OptimizerTemp">
<summary>
Temp variable created by the optimizer.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SynthesizedLocalKind.LoweringTemp">
<summary>
Temp variable created during lowering.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SynthesizedLocalKind.EmitterTemp">
<summary>
Temp variable created by the emitter.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SynthesizedLocalKind.UserDefined">
<summary>
The variable is not synthesized (C#, VB). Note that SynthesizedLocalKind values
greater than or equal to this are considered long-lived;
see <see cref="M:Microsoft.CodeAnalysis.SynthesizedLocalKindExtensions.IsLongLived(Microsoft.CodeAnalysis.SynthesizedLocalKind)"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SynthesizedLocalKind.ConditionalBranchDiscriminator">
<summary>
Local variable that stores value of an expression consumed by a subsequent conditional branch instruction that might jump across PDB sequence points.
The value needs to be preserved when remapping the IL offset from old method body to new method body during EnC.
A hidden sequence point also needs to be inserted at the offset where this variable is loaded to be consumed by the branch instruction.
(VB, C#).
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SynthesizedLocalKind.LockTaken">
<summary>
Boolean passed to Monitor.Enter (C#, VB).
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SynthesizedLocalKind.Lock">
<summary>
Variable holding on the object being locked while the execution is within the block of the lock statement (C#) or SyncLock statement (VB).
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SynthesizedLocalKind.Using">
<summary>
Local variable that stores the resources to be disposed at the end of using statement (C#, VB).
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SynthesizedLocalKind.ForEachEnumerator">
<summary>
Local variable that stores the enumerator instance (C#, VB).
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SynthesizedLocalKind.ForEachArray">
<summary>
Local variable that stores the array instance (C#, VB?).
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SynthesizedLocalKind.ForEachArrayLimit">
<summary>
Local variables that store upper bound of multi-dimensional array, for each dimension (C#, VB?).
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SynthesizedLocalKind.ForEachArrayIndex">
<summary>
Local variables that store the current index, for each dimension (C#, VB?).
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SynthesizedLocalKind.FixedReference">
<summary>
Local variable that holds a pinned handle of a managed reference passed to a fixed statement (C#).
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SynthesizedLocalKind.With">
<summary>
Local variable that holds the object passed to With statement (VB).
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SynthesizedLocalKind.SelectCaseValue">
<summary>
Local variable used to store the value of Select Case during the execution of Case statements.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SynthesizedLocalKind.AsyncMethodReturnValue">
<summary>
Local variable that stores the return value of an async method.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SynthesizedLocalKind.FunctionReturnValue">
<summary>
VB: Stores the return value of a function that is not accessible from user code (e.g. operator, lambda, async, iterator).
C#: Stores the return value of a method/lambda with a block body, so that we can put a sequence point on the closing brace of the body.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SynthesizedLocalKind.ExceptionFilterAwaitHoistedExceptionLocal">
<summary>
Very special corner case involving filters, await and lambdas.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SynthesizedLocalKind.StateMachineCachedState">
<summary>
Local variable that stores the current state of the state machine while MoveNext method is executing.
Used to avoid race conditions due to multiple reads from the lifted state.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SynthesizedLocalKind.Spill">
<summary>
Local that stores an expression value which needs to be spilled.
Such a local arises from the translation of an await or switch expression,
and might be hoisted to an async state machine if it remains alive
after an await expression.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SynthesizedLocalKind.LambdaDisplayClass">
<summary>
Local variable that holds on the display class instance.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SynthesizedLocalKind.CachedAnonymousMethodDelegate">
<summary>
Local variable used to cache a delegate that is used in inner block (possibly a loop),
and can be reused for all iterations of the loop.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SynthesizedLocalKind.Awaiter">
<summary>
Local variable that stores the result of an await expression (the awaiter object).
The variable is assigned the result of a call to await-expression.GetAwaiter() and subsequently used
to check whether the task completed. Eventually the value is stored in an awaiter field.
The value assigned to the variable needs to be preserved when remapping the IL offset from old method body
to new method body during EnC. If the awaiter expression is contained in an active statement and the
containing MoveNext method changes the debugger finds the next sequence point that follows the await expression
and transfers the execution to the new method version. This sequence point is placed by the compiler at
the immediately after the stloc instruction that stores the awaiter object to this variable.
The subsequent ldloc then restores it in the new method version.
(VB, C#).
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SynthesizedLocalKind.InstrumentationPayload">
<summary>
Stores a dynamic analysis instrumentation payload array. The value is initialized in
synthesized method prologue code and referred to throughout the method body.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SynthesizedLocalKind.SwitchCasePatternMatching">
<summary>
Temp created for pattern matching by type. This holds the value of an input value provisionally
converted to the type against which it is being matched.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SynthesizedLocalKind.MaxValidValueForLocalVariableSerializedToDebugInformation">
<summary>
All values have to be less than or equal to <see cref="F:Microsoft.CodeAnalysis.SynthesizedLocalKind.MaxValidValueForLocalVariableSerializedToDebugInformation"/>
(<see cref="T:Microsoft.CodeAnalysis.Emit.EditAndContinueMethodDebugInformation"/>)
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SynthesizedLocalKind.AwaiterField">
<summary>
An awaiter in async method.
Never actually created as a local variable, immediately lifted to a state machine field.
Not serialized to <see cref="T:Microsoft.CodeAnalysis.Emit.EditAndContinueMethodDebugInformation"/>.
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.SynthesizedLocalKind.DelegateRelaxationReceiver">
<summary>
The receiver of a delegate relaxation stub.
Created as a local variable but always lifted to a relaxation display class field.
We never emit debug info for hoisted relaxation variable.
TODO: Avoid using lambdas and display classes for implementation of relaxation stubs and remove this kind.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.TreeDumper">
<summary>
This is ONLY used id BoundNode.cs Debug method - Dump()
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.TreeDumperNode">
<summary>
This is ONLY used for debugging purpose
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.VersionHelper.TryParse(System.String,System.Version@)">
<summary>
Parses a version string of the form "major [ '.' minor [ '.' build [ '.' revision ] ] ]".
</summary>
<param name="s">The version string to parse.</param>
<param name="version">If parsing succeeds, the parsed version. Otherwise a version that represents as much of the input as could be parsed successfully.</param>
<returns>True when parsing succeeds completely (i.e. every character in the string was consumed), false otherwise.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.VersionHelper.TryParseAssemblyVersion(System.String,System.Boolean,System.Version@)">
<summary>
Parses a version string of the form "major [ '.' minor [ '.' ( '*' | ( build [ '.' ( '*' | revision ) ] ) ) ] ]"
as accepted by System.Reflection.AssemblyVersionAttribute.
</summary>
<param name="s">The version string to parse.</param>
<param name="allowWildcard">Indicates whether or not a wildcard is accepted as the terminal component.</param>
<param name="version">
If parsing succeeded, the parsed version. Otherwise a version instance with all parts set to zero.
If <paramref name="s"/> contains * the version build and/or revision numbers are set to <see cref="F:System.UInt16.MaxValue"/>.
</param>
<returns>True when parsing succeeds completely (i.e. every character in the string was consumed), false otherwise.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.VersionHelper.TryParse(System.String,System.Boolean,System.UInt16,System.Boolean,System.Version@)">
<summary>
Parses a version string of the form "major [ '.' minor [ '.' ( '*' | ( build [ '.' ( '*' | revision ) ] ) ) ] ]"
as accepted by System.Reflection.AssemblyVersionAttribute.
</summary>
<param name="s">The version string to parse.</param>
<param name="allowWildcard">Indicates whether or not we're parsing an assembly version string. If so, wildcards are accepted and each component must be less than 65535.</param>
<param name="maxValue">The maximum value that a version component may have.</param>
<param name="allowPartialParse">Allow the parsing of version elements where invalid characters exist. e.g. 1.2.2a.1</param>
<param name="version">
If parsing succeeded, the parsed version. When <paramref name="allowPartialParse"/> is true a version with values up to the first invalid character set. Otherwise a version with all parts set to zero.
If <paramref name="s"/> contains * and wildcard is allowed the version build and/or revision numbers are set to <see cref="F:System.UInt16.MaxValue"/>.
</param>
<returns>True when parsing succeeds completely (i.e. every character in the string was consumed), false otherwise.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.VersionHelper.GenerateVersionFromPatternAndCurrentTime(System.DateTime,System.Version)">
<summary>
If build and/or revision numbers are 65535 they are replaced with time-based values.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.WellKnownMembers.IsSynthesizedAttributeOptional(Microsoft.CodeAnalysis.WellKnownMember)">
<summary>
This function defines whether an attribute is optional or not.
</summary>
<param name="attributeMember">The attribute member.</param>
</member>
<member name="T:Microsoft.CodeAnalysis.WellKnownType">
<summary>
Ids of well known runtime types.
Values should not intersect with SpecialType enum!
</summary>
<remarks></remarks>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownTypes.Count">
<summary>
Number of well known types in WellKnownType enum
</summary>
</member>
<member name="F:Microsoft.CodeAnalysis.WellKnownTypes.s_metadataNames">
<summary>
Array of names for types.
The names should correspond to ids from WellKnownType enum so
that we could use ids to index into the array
</summary>
<remarks></remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.XmlFileResolver">
<summary>
Resolves references to XML files specified in the source.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.XmlFileResolver.ResolveReference(System.String,System.String)">
<summary>
Resolves XML document file path.
</summary>
<param name="path">
Value of the "file" attribute of an <include> documentation comment element.
</param>
<param name="baseFilePath">
Path of the source file (<see cref="P:Microsoft.CodeAnalysis.SyntaxTree.FilePath"/>) or XML document that contains the <paramref name="path"/>.
If not null used as a base path of <paramref name="path"/>, if <paramref name="path"/> is relative.
If <paramref name="baseFilePath"/> is relative <see cref="P:Microsoft.CodeAnalysis.XmlFileResolver.BaseDirectory"/> is used as the base path of <paramref name="baseFilePath"/>.
</param>
<returns>Normalized XML document file path or null if not found.</returns>
</member>
<member name="T:Microsoft.CodeAnalysis.XmlCharType">
The XmlCharType class is used for quick character type recognition
which is optimized for the first 127 ascii characters.
</member>
<member name="M:Microsoft.CodeAnalysis.XmlCharType.InRange(System.Char,System.Char,System.Char)">
<summary>
start >= value <= end
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.DeclarationInfo">
<summary>
Struct containing information about a source declaration.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.DeclarationInfo.DeclaredNode">
<summary>
Topmost syntax node for this declaration.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.DeclarationInfo.ExecutableCodeBlocks">
<summary>
Syntax nodes for executable code blocks (method body, initializers, etc.) associated with this declaration.
</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.DeclarationInfo.DeclaredSymbol">
<summary>
Symbol declared by this declaration.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.PooledObjects.ArrayBuilder`1.ToImmutable">
<summary>
Realizes the array.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.PooledObjects.ArrayBuilder`1.ToImmutableAndClear">
<summary>
Realizes the array and clears the collection.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.PooledObjects.ArrayBuilder`1.SetItem(System.Int32,`0)">
<summary>
Write <paramref name="value"/> to slot <paramref name="index"/>.
Fills in unallocated slots preceding the <paramref name="index"/>, if any.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.PooledObjects.ArrayBuilder`1.ToImmutableOrNull">
<summary>
Realizes the array.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.PooledObjects.ArrayBuilder`1.ToDowncastedImmutable``1">
<summary>
Realizes the array, downcasting each element to a derived type.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.PooledObjects.ArrayBuilder`1.ToImmutableAndFree">
<summary>
Realizes the array and disposes the builder in one operation.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.PooledObjects.ArrayBuilder`1.Enumerator">
<summary>
struct enumerator used in foreach.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.PooledObjects.ObjectPool`1">
<summary>
Generic implementation of object pooling pattern with predefined pool size limit. The main
purpose is that limited number of frequently used objects can be kept in the pool for
further recycling.
Notes:
1) it is not the goal to keep all returned objects. Pool is not meant for storage. If there
is no space in the pool, extra returned objects will be dropped.
2) it is implied that if object was obtained from a pool, the caller will return it back in
a relatively short time. Keeping checked out objects for long durations is ok, but
reduces usefulness of pooling. Just new up your own.
Not returning objects to the pool in not detrimental to the pool's work, but is a bad practice.
Rationale:
If there is no intent for reusing the object, do not use pool - just use "new".
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.PooledObjects.ObjectPool`1.Factory">
<remarks>
Not using System.Func{T} because this file is linked into the (debugger) Formatter,
which does not have that type (since it compiles against .NET 2.0).
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.PooledObjects.ObjectPool`1.Allocate">
<summary>
Produces an instance.
</summary>
<remarks>
Search strategy is a simple linear probing which is chosen for it cache-friendliness.
Note that Free will try to store recycled objects close to the start thus statistically
reducing how far we will typically search.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.PooledObjects.ObjectPool`1.Free(`0)">
<summary>
Returns objects to the pool.
</summary>
<remarks>
Search strategy is a simple linear probing which is chosen for it cache-friendliness.
Note that Free will try to store recycled objects close to the start thus statistically
reducing how far we will typically search in Allocate.
</remarks>
</member>
<member name="M:Microsoft.CodeAnalysis.PooledObjects.ObjectPool`1.ForgetTrackedObject(`0,`0)">
<summary>
Removes an object from leak tracking.
This is called when an object is returned to the pool. It may also be explicitly
called if an object allocated from the pool is intentionally not being returned
to the pool. This can be of use with pooled arrays if the consumer wants to
return a larger array to the pool than was originally allocated.
</summary>
</member>
<member name="T:Microsoft.CodeAnalysis.PooledObjects.PooledDelegates">
<summary>
Provides pooled delegate instances to help avoid closure allocations for delegates that require a state argument
with APIs that do not provide appropriate overloads with state arguments.
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.PooledObjects.PooledDelegates.GetPooledAction``1(System.Action{``0},``0,System.Action@)">
<summary>
Gets an <see cref="T:System.Action"/> delegate, which calls <paramref name="unboundAction"/> with the specified
<paramref name="argument"/>. The resulting <paramref name="boundAction"/> may be called any number of times
until the returned <see cref="T:Microsoft.CodeAnalysis.PooledObjects.PooledDelegates.Releaser"/> is disposed.
</summary>
<example>
<para>The following example shows the use of a capturing delegate for a callback action that requires an
argument:</para>
<code>
int x = 3;
RunWithActionCallback(() => this.DoSomething(x));
</code>
<para>The following example shows the use of a pooled delegate to avoid capturing allocations for the same
callback action:</para>
<code>
int x = 3;
using var _ = GetPooledAction(arg => arg.self.DoSomething(arg.x), (self: this, x), out Action action);
RunWithActionCallback(action);
</code>
</example>
<typeparam name="TArg">The type of argument to pass to <paramref name="unboundAction"/>.</typeparam>
<param name="unboundAction">The unbound action delegate.</param>
<param name="argument">The argument to pass to the unbound action delegate.</param>
<param name="boundAction">A delegate which calls <paramref name="unboundAction"/> with the specified
<paramref name="argument"/>.</param>
<returns>A disposable <see cref="T:Microsoft.CodeAnalysis.PooledObjects.PooledDelegates.Releaser"/> which returns the object to the delegate pool.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.PooledObjects.PooledDelegates.GetPooledAction``2(System.Action{``0,``1},``1,System.Action{``0}@)">
<summary>
Gets an <see cref="T:System.Action`1"/> delegate, which calls <paramref name="unboundAction"/> with the specified
<paramref name="argument"/>. The resulting <paramref name="boundAction"/> may be called any number of times
until the returned <see cref="T:Microsoft.CodeAnalysis.PooledObjects.PooledDelegates.Releaser"/> is disposed.
</summary>
<example>
<para>The following example shows the use of a capturing delegate for a callback action that requires an
argument:</para>
<code>
int x = 3;
RunWithActionCallback(a => this.DoSomething(a, x));
</code>
<para>The following example shows the use of a pooled delegate to avoid capturing allocations for the same
callback action:</para>
<code>
int x = 3;
using var _ = GetPooledAction((a, arg) => arg.self.DoSomething(a, arg.x), (self: this, x), out Action<int> action);
RunWithActionCallback(action);
</code>
</example>
<typeparam name="T1">The type of the first parameter of the bound action.</typeparam>
<typeparam name="TArg">The type of argument to pass to <paramref name="unboundAction"/>.</typeparam>
<param name="unboundAction">The unbound action delegate.</param>
<param name="argument">The argument to pass to the unbound action delegate.</param>
<param name="boundAction">A delegate which calls <paramref name="unboundAction"/> with the specified
<paramref name="argument"/>.</param>
<returns>A disposable <see cref="T:Microsoft.CodeAnalysis.PooledObjects.PooledDelegates.Releaser"/> which returns the object to the delegate pool.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.PooledObjects.PooledDelegates.GetPooledAction``3(System.Action{``0,``1,``2},``2,System.Action{``0,``1}@)">
<summary>
Gets an <see cref="T:System.Action`2"/> delegate, which calls <paramref name="unboundAction"/> with the specified
<paramref name="argument"/>. The resulting <paramref name="boundAction"/> may be called any number of times
until the returned <see cref="T:Microsoft.CodeAnalysis.PooledObjects.PooledDelegates.Releaser"/> is disposed.
</summary>
<example>
<para>The following example shows the use of a capturing delegate for a callback action that requires an
argument:</para>
<code>
int x = 3;
RunWithActionCallback((a, b) => this.DoSomething(a, b, x));
</code>
<para>The following example shows the use of a pooled delegate to avoid capturing allocations for the same
callback action:</para>
<code>
int x = 3;
using var _ = GetPooledAction((a, b, arg) => arg.self.DoSomething(a, b, arg.x), (self: this, x), out Action<int, int> action);
RunWithActionCallback(action);
</code>
</example>
<typeparam name="T1">The type of the first parameter of the bound action.</typeparam>
<typeparam name="T2">The type of the second parameter of the bound action.</typeparam>
<typeparam name="TArg">The type of argument to pass to <paramref name="unboundAction"/>.</typeparam>
<param name="unboundAction">The unbound action delegate.</param>
<param name="argument">The argument to pass to the unbound action delegate.</param>
<param name="boundAction">A delegate which calls <paramref name="unboundAction"/> with the specified
<paramref name="argument"/>.</param>
<returns>A disposable <see cref="T:Microsoft.CodeAnalysis.PooledObjects.PooledDelegates.Releaser"/> which returns the object to the delegate pool.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.PooledObjects.PooledDelegates.GetPooledAction``4(System.Action{``0,``1,``2,``3},``3,System.Action{``0,``1,``2}@)">
<summary>
Gets an <see cref="T:System.Action`3"/> delegate, which calls <paramref name="unboundAction"/> with the specified
<paramref name="argument"/>. The resulting <paramref name="boundAction"/> may be called any number of times
until the returned <see cref="T:Microsoft.CodeAnalysis.PooledObjects.PooledDelegates.Releaser"/> is disposed.
</summary>
<example>
<para>The following example shows the use of a capturing delegate for a callback action that requires an
argument:</para>
<code>
int x = 3;
RunWithActionCallback((a, b, c) => this.DoSomething(a, b, c, x));
</code>
<para>The following example shows the use of a pooled delegate to avoid capturing allocations for the same
callback action:</para>
<code>
int x = 3;
using var _ = GetPooledAction((a, b, c, arg) => arg.self.DoSomething(a, b, c, arg.x), (self: this, x), out Action<int, int, int> action);
RunWithActionCallback(action);
</code>
</example>
<typeparam name="T1">The type of the first parameter of the bound action.</typeparam>
<typeparam name="T2">The type of the second parameter of the bound action.</typeparam>
<typeparam name="T3">The type of the third parameter of the bound action.</typeparam>
<typeparam name="TArg">The type of argument to pass to <paramref name="unboundAction"/>.</typeparam>
<param name="unboundAction">The unbound action delegate.</param>
<param name="argument">The argument to pass to the unbound action delegate.</param>
<param name="boundAction">A delegate which calls <paramref name="unboundAction"/> with the specified
<paramref name="argument"/>.</param>
<returns>A disposable <see cref="T:Microsoft.CodeAnalysis.PooledObjects.PooledDelegates.Releaser"/> which returns the object to the delegate pool.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.PooledObjects.PooledDelegates.GetPooledFunction``2(System.Func{``0,``1},``0,System.Func{``1}@)">
<summary>
Gets a <see cref="T:System.Func`1"/> delegate, which calls <paramref name="unboundFunction"/> with the
specified <paramref name="argument"/>. The resulting <paramref name="boundFunction"/> may be called any
number of times until the returned <see cref="T:Microsoft.CodeAnalysis.PooledObjects.PooledDelegates.Releaser"/> is disposed.
</summary>
<example>
<para>The following example shows the use of a capturing delegate for a predicate that requires an
argument:</para>
<code>
int x = 3;
RunWithPredicate(() => this.IsSomething(x));
</code>
<para>The following example shows the use of a pooled delegate to avoid capturing allocations for the same
predicate:</para>
<code>
int x = 3;
using var _ = GetPooledFunction(arg => arg.self.IsSomething(arg.x), (self: this, x), out Func<bool> predicate);
RunWithPredicate(predicate);
</code>
</example>
<typeparam name="TArg">The type of argument to pass to <paramref name="unboundFunction"/>.</typeparam>
<typeparam name="TResult">The type of the return value of the function.</typeparam>
<param name="unboundFunction">The unbound function delegate.</param>
<param name="argument">The argument to pass to the unbound function delegate.</param>
<param name="boundFunction">A delegate which calls <paramref name="unboundFunction"/> with the specified
<paramref name="argument"/>.</param>
<returns>A disposable <see cref="T:Microsoft.CodeAnalysis.PooledObjects.PooledDelegates.Releaser"/> which returns the object to the delegate pool.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.PooledObjects.PooledDelegates.GetPooledFunction``3(System.Func{``0,``1,``2},``1,System.Func{``0,``2}@)">
<summary>
Gets a <see cref="T:System.Func`2"/> delegate, which calls <paramref name="unboundFunction"/> with the
specified <paramref name="argument"/>. The resulting <paramref name="boundFunction"/> may be called any
number of times until the returned <see cref="T:Microsoft.CodeAnalysis.PooledObjects.PooledDelegates.Releaser"/> is disposed.
</summary>
<example>
<para>The following example shows the use of a capturing delegate for a predicate that requires an
argument:</para>
<code>
int x = 3;
RunWithPredicate(a => this.IsSomething(a, x));
</code>
<para>The following example shows the use of a pooled delegate to avoid capturing allocations for the same
predicate:</para>
<code>
int x = 3;
using var _ = GetPooledFunction((a, arg) => arg.self.IsSomething(a, arg.x), (self: this, x), out Func<int, bool> predicate);
RunWithPredicate(predicate);
</code>
</example>
<typeparam name="T1">The type of the first parameter of the bound function.</typeparam>
<typeparam name="TArg">The type of argument to pass to <paramref name="unboundFunction"/>.</typeparam>
<typeparam name="TResult">The type of the return value of the function.</typeparam>
<param name="unboundFunction">The unbound function delegate.</param>
<param name="argument">The argument to pass to the unbound function delegate.</param>
<param name="boundFunction">A delegate which calls <paramref name="unboundFunction"/> with the specified
<paramref name="argument"/>.</param>
<returns>A disposable <see cref="T:Microsoft.CodeAnalysis.PooledObjects.PooledDelegates.Releaser"/> which returns the object to the delegate pool.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.PooledObjects.PooledDelegates.GetPooledFunction``4(System.Func{``0,``1,``2,``3},``2,System.Func{``0,``1,``3}@)">
<summary>
Gets a <see cref="T:System.Func`3"/> delegate, which calls <paramref name="unboundFunction"/> with the
specified <paramref name="argument"/>. The resulting <paramref name="boundFunction"/> may be called any
number of times until the returned <see cref="T:Microsoft.CodeAnalysis.PooledObjects.PooledDelegates.Releaser"/> is disposed.
</summary>
<example>
<para>The following example shows the use of a capturing delegate for a predicate that requires an
argument:</para>
<code>
int x = 3;
RunWithPredicate((a, b) => this.IsSomething(a, b, x));
</code>
<para>The following example shows the use of a pooled delegate to avoid capturing allocations for the same
predicate:</para>
<code>
int x = 3;
using var _ = GetPooledFunction((a, b, arg) => arg.self.IsSomething(a, b, arg.x), (self: this, x), out Func<int, int, bool> predicate);
RunWithPredicate(predicate);
</code>
</example>
<typeparam name="T1">The type of the first parameter of the bound function.</typeparam>
<typeparam name="T2">The type of the second parameter of the bound function.</typeparam>
<typeparam name="TArg">The type of argument to pass to <paramref name="unboundFunction"/>.</typeparam>
<typeparam name="TResult">The type of the return value of the function.</typeparam>
<param name="unboundFunction">The unbound function delegate.</param>
<param name="argument">The argument to pass to the unbound function delegate.</param>
<param name="boundFunction">A delegate which calls <paramref name="unboundFunction"/> with the specified
<paramref name="argument"/>.</param>
<returns>A disposable <see cref="T:Microsoft.CodeAnalysis.PooledObjects.PooledDelegates.Releaser"/> which returns the object to the delegate pool.</returns>
</member>
<member name="M:Microsoft.CodeAnalysis.PooledObjects.PooledDelegates.GetPooledFunction``5(System.Func{``0,``1,``2,``3,``4},``3,System.Func{``0,``1,``2,``4}@)">
<summary>
Gets a <see cref="T:System.Func`4"/> delegate, which calls <paramref name="unboundFunction"/> with the
specified <paramref name="argument"/>. The resulting <paramref name="boundFunction"/> may be called any
number of times until the returned <see cref="T:Microsoft.CodeAnalysis.PooledObjects.PooledDelegates.Releaser"/> is disposed.
</summary>
<example>
<para>The following example shows the use of a capturing delegate for a predicate that requires an
argument:</para>
<code>
int x = 3;
RunWithPredicate((a, b, c) => this.IsSomething(a, b, c, x));
</code>
<para>The following example shows the use of a pooled delegate to avoid capturing allocations for the same
predicate:</para>
<code>
int x = 3;
using var _ = GetPooledFunction((a, b, c, arg) => arg.self.IsSomething(a, b, c, arg.x), (self: this, x), out Func<int, int, int, bool> predicate);
RunWithPredicate(predicate);
</code>
</example>
<typeparam name="T1">The type of the first parameter of the bound function.</typeparam>
<typeparam name="T2">The type of the second parameter of the bound function.</typeparam>
<typeparam name="T3">The type of the third parameter of the bound function.</typeparam>
<typeparam name="TArg">The type of argument to pass to <paramref name="unboundFunction"/>.</typeparam>
<typeparam name="TResult">The type of the return value of the function.</typeparam>
<param name="unboundFunction">The unbound function delegate.</param>
<param name="argument">The argument to pass to the unbound function delegate.</param>
<param name="boundFunction">A delegate which calls <paramref name="unboundFunction"/> with the specified
<paramref name="argument"/>.</param>
<returns>A disposable <see cref="T:Microsoft.CodeAnalysis.PooledObjects.PooledDelegates.Releaser"/> which returns the object to the delegate pool.</returns>
</member>
<member name="T:Microsoft.CodeAnalysis.PooledObjects.PooledDelegates.Releaser">
<summary>
A releaser for a pooled delegate.
</summary>
<remarks>
<para>This type is intended for use as the resource of a <c>using</c> statement. When used in this manner,
<see cref="M:Microsoft.CodeAnalysis.PooledObjects.PooledDelegates.Releaser.Dispose"/> should not be called explicitly.</para>
<para>If used without a <c>using</c> statement, calling <see cref="M:Microsoft.CodeAnalysis.PooledObjects.PooledDelegates.Releaser.Dispose"/> is optional. If the call is
omitted, the object will not be returned to the pool. The behavior of this type if <see cref="M:Microsoft.CodeAnalysis.PooledObjects.PooledDelegates.Releaser.Dispose"/> is
called multiple times is undefined.</para>
</remarks>
</member>
<member name="T:Microsoft.CodeAnalysis.PooledObjects.PooledStringBuilder">
<summary>
The usage is:
var inst = PooledStringBuilder.GetInstance();
var sb = inst.builder;
... Do Stuff...
... sb.ToString() ...
inst.Free();
</summary>
</member>
<member name="M:Microsoft.CodeAnalysis.PooledObjects.PooledStringBuilder.CreatePool(System.Int32)">
<summary>
If someone need to create a private pool
</summary>
<param name="size">The size of the pool.</param>
<returns></returns>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.OutputKindNotSupported">
<summary>Output kind not supported.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.PathReturnedByResolveMetadataFileMustBeAbsolute">
<summary>Path returned by {0}.ResolveMetadataFile must be absolute: '{1}'</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.AssemblyMustHaveAtLeastOneModule">
<summary>Assembly must have at least one module.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.ModuleCopyCannotBeUsedToCreateAssemblyMetadata">
<summary>Module copy can't be used to create an assembly metadata.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.Unresolved">
<summary>Unresolved:</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.Assembly">
<summary>assembly</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.Class1">
<summary>class</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.Constructor">
<summary>constructor</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.Delegate1">
<summary>delegate</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.Enum1">
<summary>enum</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.Event1">
<summary>event</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.Field">
<summary>field</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.TypeParameter">
<summary>type parameter</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.Interface1">
<summary>interface</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.Method">
<summary>method</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.Module">
<summary>module</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.Parameter">
<summary>parameter</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.Property">
<summary>property, indexer</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.Return1">
<summary>return</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.Struct1">
<summary>struct</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.CannotCreateReferenceToSubmission">
<summary>Can't create a reference to a submission.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.CannotCreateReferenceToModule">
<summary>Can't create a reference to a module.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.InMemoryAssembly">
<summary><in-memory assembly></summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.InMemoryModule">
<summary><in-memory module></summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.SizeHasToBePositive">
<summary>Size has to be positive.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.AssemblyFileNotFound">
<summary>Assembly file not found</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.CannotEmbedInteropTypesFromModule">
<summary>Can't embed interop types from module.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.CannotAliasModule">
<summary>Can't alias a module.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.InvalidAlias">
<summary>Invalid alias.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.GetMetadataMustReturnInstance">
<summary>{0}.GetMetadata() must return an instance of {1}.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.Value_too_large_to_be_represented_as_a_30_bit_unsigned_integer">
<summary>Value too large to be represented as a 30 bit unsigned integer.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.Arrays_with_more_than_one_dimension_cannot_be_serialized">
<summary>Arrays with more than one dimension cannot be serialized.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.InvalidAssemblyName">
<summary>Invalid assembly name: '{0}'</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.AbsolutePathExpected">
<summary>Absolute path expected.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.EmptyKeyInPathMap">
<summary>A key in the pathMap is empty.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.NullValueInPathMap">
<summary>A value in the pathMap is null.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.CompilationOptionsMustNotHaveErrors">
<summary>Compilation options must not have errors.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.ReturnTypeCannotBeValuePointerbyRefOrOpen">
<summary>Return type can't be a value type, pointer, by-ref or open generic type</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.ReturnTypeCannotBeVoidByRefOrOpen">
<summary>Return type can't be void, by-ref or open generic type</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.TypeMustBeSameAsHostObjectTypeOfPreviousSubmission">
<summary>Type must be same as host object type of previous submission.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.PreviousSubmissionHasErrors">
<summary>Previous submission has errors.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.InvalidOutputKindForSubmission">
<summary>Invalid output kind for submission. DynamicallyLinkedLibrary expected.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.InvalidCompilationOptions">
<summary>Invalid compilation options -- submission can't be signed.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.ResourceStreamProviderShouldReturnNonNullStream">
<summary>Resource stream provider should return non-null stream.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.ReferenceResolverShouldReturnReadableNonNullStream">
<summary>Reference resolver should return readable non-null stream.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.EmptyOrInvalidResourceName">
<summary>Empty or invalid resource name</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.EmptyOrInvalidFileName">
<summary>Empty or invalid file name</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.ResourceDataProviderShouldReturnNonNullStream">
<summary>Resource data provider should return non-null stream</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.FileNotFound">
<summary>File not found.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.PathReturnedByResolveStrongNameKeyFileMustBeAbsolute">
<summary>Path returned by {0}.ResolveStrongNameKeyFile must be absolute: '{1}'</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.TypeMustBeASubclassOfSyntaxAnnotation">
<summary>type must be a subclass of SyntaxAnnotation.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.InvalidModuleName">
<summary>Invalid module name specified in metadata module '{0}': '{1}'</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.FileSizeExceedsMaximumAllowed">
<summary>File size exceeds maximum allowed size of a valid metadata file.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.NameCannotBeNull">
<summary>Name cannot be null.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.NameCannotBeEmpty">
<summary>Name cannot be empty.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.NameCannotStartWithWhitespace">
<summary>Name cannot start with whitespace.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.NameContainsInvalidCharacter">
<summary>Name contains invalid characters.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.SpanDoesNotIncludeStartOfLine">
<summary>The span does not include the start of a line.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.SpanDoesNotIncludeEndOfLine">
<summary>The span does not include the end of a line.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.StartMustNotBeNegative">
<summary>'start' must not be negative</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.EndMustNotBeLessThanStart">
<summary>'end' must not be less than 'start'</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.InvalidContentType">
<summary>Invalid content type</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.ExpectedNonEmptyPublicKey">
<summary>Expected non-empty public key</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.InvalidSizeOfPublicKeyToken">
<summary>Invalid size of public key token.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.InvalidCharactersInAssemblyName">
<summary>Invalid characters in assembly name</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.InvalidCharactersInAssemblyCultureName">
<summary>Invalid characters in assembly culture name</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.StreamMustSupportReadAndSeek">
<summary>Stream must support read and seek operations.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.StreamMustSupportRead">
<summary>Stream must be readable.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.StreamMustSupportWrite">
<summary>Stream must be writable.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.PdbStreamUnexpectedWhenEmbedding">
<summary>PDB stream should not be given when embedding PDB into the PE stream.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.PdbStreamUnexpectedWhenEmittingMetadataOnly">
<summary>PDB stream should not be given when emitting metadata only.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.MetadataPeStreamUnexpectedWhenEmittingMetadataOnly">
<summary>Metadata PE stream should not be given when emitting metadata only.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.IncludingPrivateMembersUnexpectedWhenEmittingToMetadataPeStream">
<summary>Including private members should not be used when emitting to the secondary assembly output.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.MustIncludePrivateMembersUnlessRefAssembly">
<summary>Must include private members unless emitting a ref assembly.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.EmbeddingPdbUnexpectedWhenEmittingMetadata">
<summary>Embedding PDB is not allowed when emitting metadata.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.CannotTargetNetModuleWhenEmittingRefAssembly">
<summary>Cannot target net module when emitting ref assembly.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.InvalidHash">
<summary>Invalid hash.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.UnsupportedHashAlgorithm">
<summary>Unsupported hash algorithm.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.InconsistentLanguageVersions">
<summary>Inconsistent language versions</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.CoffResourceInvalidRelocation">
<summary>Win32 resources, assumed to be in COFF object format, have one or more invalid relocation header values.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.CoffResourceInvalidSectionSize">
<summary>Win32 resources, assumed to be in COFF object format, have an invalid section size.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.CoffResourceInvalidSymbol">
<summary>Win32 resources, assumed to be in COFF object format, have one or more invalid symbol values.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.CoffResourceMissingSection">
<summary>Win32 resources, assumed to be in COFF object format, are missing one or both of sections '.rsrc$01' and '.rsrc$02'</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.IconStreamUnexpectedFormat">
<summary>Icon stream is not in the expected format.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.InvalidCultureName">
<summary>Invalid culture name: '{0}'</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.WinRTIdentityCantBeRetargetable">
<summary>WindowsRuntime identity can't be retargetable</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.PEImageNotAvailable">
<summary>PE image not available.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.AssemblySigningNotSupported">
<summary>Assembly signing not supported.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.XmlReferencesNotSupported">
<summary>References to XML documents are not supported.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.FailedToResolveRuleSetName">
<summary>Could not locate the rule set file '{0}'.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.InvalidRuleSetInclude">
<summary>An error occurred while loading the included rule set file {0} - {1}</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.CompilerAnalyzerFailure">
<summary>Analyzer Failure</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.CompilerAnalyzerThrows">
<summary>Analyzer '{0}' threw an exception of type '{1}' with message '{2}'.
{3}</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.CompilerAnalyzerThrowsDescription">
<summary>Analyzer '{0}' threw the following exception:
'{1}'.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.AnalyzerDriverFailure">
<summary>Analyzer Driver Failure</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.AnalyzerDriverThrows">
<summary>Analyzer driver threw an exception of type '{0}' with message '{1}'.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.AnalyzerDriverThrowsDescription">
<summary>Analyzer driver threw the following exception:
'{0}'.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.PEImageDoesntContainManagedMetadata">
<summary>PE image doesn't contain managed metadata.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.ChangesMustNotOverlap">
<summary>The changes must not overlap.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.DiagnosticIdCantBeNullOrWhitespace">
<summary>A DiagnosticDescriptor must have an Id that is neither null nor an empty string nor a string that only contains white space.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.SuppressionIdCantBeNullOrWhitespace">
<summary>A SuppressionDescriptor must have an Id that is neither null nor an empty string nor a string that only contains white space.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.RuleSetHasDuplicateRules">
<summary>The rule set file has duplicate rules for '{0}' with differing actions '{1}' and '{2}'.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.CantCreateModuleReferenceToAssembly">
<summary>Can't create a module reference to an assembly.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.CantCreateReferenceToDynamicAssembly">
<summary>Can't create a metadata reference to a dynamic assembly.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.CantCreateReferenceToAssemblyWithoutLocation">
<summary>Can't create a metadata reference to an assembly without location.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.ArgumentCannotBeEmpty">
<summary>Argument cannot be empty.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.ArgumentElementCannotBeNull">
<summary>Argument cannot have a null element.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.AsyncAnalyzerActionCannotBeRegistered">
<summary>Analyzer attempted to register an 'async' action, which is not supported.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.UnsupportedDiagnosticReported">
<summary>Reported diagnostic with ID '{0}' is not supported by the analyzer.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.UnsupportedSuppressionReported">
<summary>Reported suppression with ID '{0}' is not supported by the suppressor.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.InvalidDiagnosticSuppressionReported">
<summary>Suppressed diagnostic ID '{0}' does not match suppressable ID '{1}' for the given suppression descriptor.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.NonReportedDiagnosticCannotBeSuppressed">
<summary>Non-reported diagnostic with ID '{0}' cannot be suppressed.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.InvalidDiagnosticIdReported">
<summary>Reported diagnostic has an ID '{0}', which is not a valid identifier.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.InvalidDiagnosticLocationReported">
<summary>Reported diagnostic '{0}' has a source location in file '{1}', which is not part of the compilation being analyzed.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.SupportedDiagnosticsHasNullDescriptor">
<summary>Analyzer '{0}' contains a null descriptor in its 'SupportedDiagnostics'.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.SupportedSuppressionsHasNullDescriptor">
<summary>Analyzer '{0}' contains a null descriptor in its 'SupportedSuppressions'.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.The_type_0_is_not_understood_by_the_serialization_binder">
<summary>The type '{0}' is not understood by the serialization binder.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.Cannot_deserialize_type_0">
<summary>Cannot deserialize type '{0}'.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.Cannot_serialize_type_0">
<summary>Cannot serialize type '{0}'.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.InvalidNodeToTrack">
<summary>Node to track is not a descendant of the root.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.NodeOrTokenOutOfSequence">
<summary>A node or token is out of sequence.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.UnexpectedTypeOfNodeInList">
<summary>A node in the list is not of the expected type.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.MissingListItem">
<summary>The item specified is not the element of a list.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.InvalidPublicKey">
<summary>Invalid public key.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.InvalidPublicKeyToken">
<summary>Invalid public key token.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.InvalidDataAtOffset">
<summary>Invalid data at offset {0}: {1}{2}*{3}{4}</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.SymWriterNotDeterministic">
<summary>Windows PDB writer doesn't support deterministic compilation: '{0}'</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.SymWriterOlderVersionThanRequired">
<summary>The version of Windows PDB writer is older than required: '{0}'</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.SymWriterDoesNotSupportSourceLink">
<summary>Windows PDB writer doesn't support SourceLink feature: '{0}'</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.RuleSetBadAttributeValue">
<summary>The attribute {0} has an invalid value of {1}.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.RuleSetMissingAttribute">
<summary>The element {0} is missing an attribute named {1}.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.KeepAliveIsNotAnInteger">
<summary>Argument to '/keepalive' option is not a 32-bit integer.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.KeepAliveIsTooSmall">
<summary>Arguments to '/keepalive' option below -1 are invalid.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.KeepAliveWithoutShared">
<summary>'/keepalive' option is only valid with '/shared' option.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.MismatchedVersion">
<summary>Roslyn compiler server reports different protocol version than build task.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.MissingKeepAlive">
<summary>Missing argument for '/keepalive' option.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.AnalyzerTotalExecutionTime">
<summary>Total analyzer execution time: {0} seconds.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.MultithreadedAnalyzerExecutionNote">
<summary>NOTE: Elapsed time may be less than analyzer execution time because analyzers can run concurrently.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.AnalyzerExecutionTimeColumnHeader">
<summary>Time (s)</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.AnalyzerNameColumnHeader">
<summary>Analyzer</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.NoAnalyzersFound">
<summary>No analyzers found</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.DuplicateAnalyzerInstances">
<summary>Argument contains duplicate analyzer instances.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.UnsupportedAnalyzerInstance">
<summary>Argument contains an analyzer instance that does not belong to the 'Analyzers' for this CompilationWithAnalyzers instance.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.InvalidTree">
<summary>Syntax tree doesn't belong to the underlying 'Compilation'.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.InvalidAdditionalFile">
<summary>Additional file doesn't belong to the underlying 'CompilationWithAnalyzers'.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.ResourceStreamEndedUnexpectedly">
<summary>Resource stream ended at {0} bytes, expected {1} bytes.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.SharedArgumentMissing">
<summary>Value for argument '/shared:' must not be empty</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.ExceptionContext">
<summary>Exception occurred with following context:
{0}</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.AnonymousTypeMemberAndNamesCountMismatch2">
<summary>{0} and {1} must have the same length.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.AnonymousTypeArgumentCountMismatch2">
<summary>{0} must either be 'default' or have the same length as {1}.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.InconsistentSyntaxTreeFeature">
<summary>Inconsistent syntax tree features</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.ReferenceOfTypeIsInvalid1">
<summary>Reference of type '{0}' is not valid for this compilation.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.MetadataRefNotFoundToRemove1">
<summary>MetadataReference '{0}' not found to remove.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.TupleElementNameCountMismatch">
<summary>If tuple element names are specified, the number of element names must match the cardinality of the tuple.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.TupleElementNameEmpty">
<summary>Tuple element name cannot be an empty string.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.TupleElementLocationCountMismatch">
<summary>If tuple element locations are specified, the number of locations must match the cardinality of the tuple.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.TupleElementNullableAnnotationCountMismatch">
<summary>If tuple element nullable annotations are specified, the number of annotations must match the cardinality of the tuple.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.TuplesNeedAtLeastTwoElements">
<summary>Tuples must have at least two elements.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.CompilationReferencesAssembliesWithDifferentAutoGeneratedVersion">
<summary>The compilation references multiple assemblies whose versions only differ in auto-generated build and/or revision numbers.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.TupleUnderlyingTypeMustBeTupleCompatible">
<summary>The underlying type for a tuple must be tuple-compatible.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.UnrecognizedResourceFileFormat">
<summary>Unrecognized resource file format.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.SourceTextCannotBeEmbedded">
<summary>SourceText cannot be embedded. Provide encoding or canBeEmbedded=true at construction.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.StreamIsTooLong">
<summary>Stream is too long.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.EmbeddedTextsRequirePdb">
<summary>Embedded texts are only supported when emitting a PDB.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.TheStreamCannotBeWrittenTo">
<summary>The stream cannot be written to.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.ElementIsExpected">
<summary>element is expected</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.SeparatorIsExpected">
<summary>separator is expected</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.TheStreamCannotBeReadFrom">
<summary>The stream cannot be read from.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.Deserialization_reader_for_0_read_incorrect_number_of_values">
<summary>Deserialization reader for '{0}' read incorrect number of values.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.Stream_contains_invalid_data">
<summary>Stream contains invalid data</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.InvalidDiagnosticSpanReported">
<summary>Reported diagnostic '{0}' has a source location '{1}' in file '{2}', which is outside of the given file.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.ExceptionEnablingMulticoreJit">
<summary>Warning: Could not enable multicore JIT due to exception: {0}.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.NotARootOperation">
<summary>Given operation has a non-null parent.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.OperationHasNullSemanticModel">
<summary>Given operation has a null semantic model.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.InvalidOperationBlockForAnalysisContext">
<summary>Given operation block does not belong to the current analysis context.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.IsSymbolAccessibleBadWithin">
<summary>Parameter '{0}' must be an 'INamedTypeSymbol' or an 'IAssemblySymbol'.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.IsSymbolAccessibleWrongAssembly">
<summary>Parameter '{0}' must be a symbol from this compilation or some referenced assembly.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.OperationMustNotBeControlFlowGraphPart">
<summary>The provided operation must not be part of a Control Flow Graph.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.A_language_name_cannot_be_specified_for_this_option">
<summary>A language name cannot be specified for this option.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.A_language_name_must_be_specified_for_this_option">
<summary>A language name must be specified for this option.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.WRN_InvalidSeverityInAnalyzerConfig">
<summary>The diagnostic '{0}' was given an invalid severity '{1}' in the analyzer config file at '{2}'.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.WRN_InvalidSeverityInAnalyzerConfig_Title">
<summary>Invalid severity in analyzer config file.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.SuppressionDiagnosticDescriptorTitle">
<summary>Programmatic suppression of an analyzer diagnostic</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.SuppressionDiagnosticDescriptorMessage">
<summary>Diagnostic '{0}: {1}' was programmatically suppressed by a DiagnosticSuppressor with suppression ID '{2}' and justification '{3}'</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.ModuleHasInvalidAttributes">
<summary>Module has invalid attributes.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.UnableToDetermineSpecificCauseOfFailure">
<summary>Unable to determine specific cause of the failure.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.ChangingVersionOfAssemblyReferenceIsNotAllowedDuringDebugging">
<summary>Changing the version of an assembly reference is not allowed during debugging: '{0}' changed version to '{1}'.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.DisableAnalyzerDiagnosticsMessage">
<summary>Suppress the following diagnostics to disable this analyzer: {0}</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.Single_type_per_generator_0">
<summary>Only a single {0} can be registered per generator.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.WRN_MultipleGlobalAnalyzerKeys">
<summary>Multiple global analyzer config files set the same key '{0}' in section '{1}'. It has been unset. Key was set by the following files: '{2}'</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.WRN_MultipleGlobalAnalyzerKeys_Title">
<summary>Multiple global analyzer config files set the same key. It has been unset.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.HintNameUniquePerGenerator">
<summary>The hintName of the added source file must be unique within a generator.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.HintNameInvalidChar">
<summary>The hintName contains an invalid character '{0}' at position {1}.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.SourceTextRequiresEncoding">
<summary>The provided SourceText must have an explicit encoding set.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.AssemblyReferencesNetFramework">
<summary>The assembly containing type '{0}' references .NET Framework, which is not supported.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.WRN_InvalidGlobalSectionName">
<summary>Global analyzer config section name '{0}' is invalid as it is not an absolute path. Section will be ignored. Section was declared in file: '{1}'</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.WRN_InvalidGlobalSectionName_Title">
<summary>Global analyzer config section name is invalid as it is not an absolute path. Section will be ignored.</summary>
</member>
<member name="P:Microsoft.CodeAnalysis.CodeAnalysisResources.ChangesMustBeWithinBoundsOfSourceText">
<summary>Changes must be within bounds of SourceText</summary>
</member>
<member name="M:Microsoft.DiaSymReader.IMetadataImport.ResolveTypeRef(System.Int32,System.Guid@,System.Object@,System.Int32@)">
<summary>
Resolves type reference.
</summary>
<param name="typeRef">The TypeRef metadata token to return the referenced type information for.</param>
<param name="scopeInterfaceId">The IID of the interface to return in scope. Typically, this would be IID_IMetaDataImport.</param>
<param name="scope">An interface to the module scope in which the referenced type is defined.</param>
<param name="typeDef">A pointer to a TypeDef token that represents the referenced type.</param>
<remarks>
TypeDefs define a type within a scope. TypeRefs refer to type-defs in other scopes
and allow you to import a type from another scope. This function attempts to determine
which type-def a type-ref points to.
This resolve (type-ref, this cope) --> (type-def=*ptd, other scope=*ppIScope)
However, this resolution requires knowing what modules have been loaded, which is not decided
until runtime via loader / fusion policy. Thus this interface can't possibly be correct since
it doesn't have that knowledge. Furthermore, when inspecting metadata from another process
(such as a debugger inspecting the debuggee's metadata), this API can be truly misleading.
This API usage should be avoided.
</remarks>
</member>
<member name="T:Microsoft.DiaSymReader.SymWriterMetadataAdapter">
<summary>
Minimal implementation of IMetadataImport that implements APIs used by SymReader and SymWriter.
</summary>
</member>
<member name="T:Microsoft.DiaSymReader.ComMemoryStream">
<summary>
A COM IStream implementation over memory. Supports just enough for DiaSymReader's PDB writing.
Also tuned for performance:
1. SetSize (and Seek beyond the length) is very fast and doesn't re-allocate the underlying memory.
2. Read and Write are optimized to avoid copying (see <see cref="T:Microsoft.DiaSymReader.IUnsafeComStream"/>)
3. Allocates in chunks instead of a contiguous buffer to avoid re-alloc and copy costs when growing.
</summary>
</member>
<member name="T:Microsoft.DiaSymReader.IUnsafeComStream">
<summary>
This is a re-definition of COM's IStream interface. The important change is that
the Read and Write methods take an <see cref="T:System.IntPtr"/> instead of a byte[] to avoid the
allocation cost when called from native code.
</summary>
</member>
<member name="T:Microsoft.DiaSymReader.ISymUnmanagedWriter5">
<summary>
The highest version of the interface available on Desktop FX 4.0+.
</summary>
</member>
<member name="M:Microsoft.DiaSymReader.ISymUnmanagedWriter5.DefineConstant2(System.String,Microsoft.DiaSymReader.VariantStructure,System.Int32)">
<remarks>
<paramref name="value"/> has type <see cref="T:Microsoft.DiaSymReader.VariantStructure"/>, rather than <see cref="T:System.Object"/>,
so that we can do custom marshalling of <see cref="T:System.DateTime"/>. Unfortunately, .NET marshals
<see cref="T:System.DateTime"/>s as the number of days since 1899/12/30, whereas the native VB compiler
marshalled them as the number of ticks since the Unix epoch (i.e. a much, much larger number).
</remarks>
</member>
<member name="M:Microsoft.DiaSymReader.ISymUnmanagedWriter5.OpenMapTokensToSourceSpans">
<summary>
Open a special custom data section to emit token to source span mapping information into.
Opening this section while a method is already open or vice versa is an error.
</summary>
</member>
<member name="M:Microsoft.DiaSymReader.ISymUnmanagedWriter5.CloseMapTokensToSourceSpans">
<summary>
Close the special custom data section for token to source span mapping
information. Once it is closed no more mapping information can be added.
</summary>
</member>
<member name="M:Microsoft.DiaSymReader.ISymUnmanagedWriter5.MapTokenToSourceSpan(System.Int32,Microsoft.DiaSymReader.ISymUnmanagedDocumentWriter,System.Int32,System.Int32,System.Int32,System.Int32)">
<summary>
Maps the given metadata token to the given source line span in the specified source file.
Must be called between calls to <see cref="M:Microsoft.DiaSymReader.ISymUnmanagedWriter5.OpenMapTokensToSourceSpans"/> and <see cref="M:Microsoft.DiaSymReader.ISymUnmanagedWriter5.CloseMapTokensToSourceSpans"/>.
</summary>
</member>
<member name="T:Microsoft.DiaSymReader.ISymUnmanagedWriter8">
<summary>
The highest version of the interface available in Microsoft.DiaSymReader.Native.
</summary>
</member>
<member name="T:Microsoft.DiaSymReader.VariantStructure">
<summary>
A struct with the same size and layout as the native VARIANT type:
2 bytes for a discriminator (i.e. which type of variant it is).
6 bytes of padding
8 or 16 bytes of data
</summary>
</member>
<member name="F:Microsoft.DiaSymReader.VariantStructure._padding">
<summary>
This field determines the size of the struct
(16 bytes on 32-bit platforms, 24 bytes on 64-bit platforms).
</summary>
</member>
<member name="T:Microsoft.DiaSymReader.VariantPadding">
<summary>
This type is 8 bytes on a 32-bit platforms and 16 bytes on 64-bit platforms.
</summary>
</member>
<member name="T:Microsoft.DiaSymReader.SymUnmanagedWriter">
<summary>
Windows PDB writer.
</summary>
</member>
<member name="M:Microsoft.DiaSymReader.SymUnmanagedWriter.Dispose">
<summary>
Disposes the writer.
</summary>
</member>
<member name="M:Microsoft.DiaSymReader.SymUnmanagedWriter.GetUnderlyingData">
<summary>
Gets the raw data blobs that comprise the written PDB content so far.
</summary>
</member>
<member name="M:Microsoft.DiaSymReader.SymUnmanagedWriter.WriteTo(System.IO.Stream)">
<summary>
Writes the PDB data to specified stream. Once called no more changes to the data can be made using this writer.
May be called multiple times. Always writes the same data.
</summary>
<param name="stream">Stream to write PDB data to.</param>
<exception cref="T:Microsoft.DiaSymReader.SymUnmanagedWriterException">Error occurred while writing data to the stream.</exception>
</member>
<member name="P:Microsoft.DiaSymReader.SymUnmanagedWriter.DocumentTableCapacity">
<summary>
The capacity of document table.
</summary>
<remarks>
Whenever a document is defined an entry is added to this table.
If the number of documents is known upfront setting this value may reduce memory consumption.
</remarks>
</member>
<member name="M:Microsoft.DiaSymReader.SymUnmanagedWriter.DefineDocument(System.String,System.Guid,System.Guid,System.Guid,System.Guid,System.ReadOnlySpan{System.Byte},System.ReadOnlySpan{System.Byte})">
<summary>
Defines a source document.
</summary>
<exception cref="T:System.ObjectDisposedException">Object has been disposed.</exception>
<exception cref="T:System.InvalidOperationException">Writes are not allowed to the underlying stream.</exception>
<exception cref="T:Microsoft.DiaSymReader.SymUnmanagedWriterException">Error occurred while writing PDB data.</exception>
</member>
<member name="M:Microsoft.DiaSymReader.SymUnmanagedWriter.DefineSequencePoints(System.Int32,System.Int32,System.Int32[],System.Int32[],System.Int32[],System.Int32[],System.Int32[])">
<summary>
Defines sequence points.
</summary>
<exception cref="T:System.ObjectDisposedException">Object has been disposed.</exception>
<exception cref="T:System.InvalidOperationException">Writes are not allowed to the underlying stream.</exception>
<exception cref="T:Microsoft.DiaSymReader.SymUnmanagedWriterException">Error occurred while writing PDB data.</exception>
</member>
<member name="M:Microsoft.DiaSymReader.SymUnmanagedWriter.OpenMethod(System.Int32)">
<summary>
Opens a method.
</summary>
<exception cref="T:System.ObjectDisposedException">Object has been disposed.</exception>
<exception cref="T:System.InvalidOperationException">Writes are not allowed to the underlying stream.</exception>
<exception cref="T:Microsoft.DiaSymReader.SymUnmanagedWriterException">Error occurred while writing PDB data.</exception>
</member>
<member name="M:Microsoft.DiaSymReader.SymUnmanagedWriter.CloseMethod">
<summary>
Closes a method previously open using <see cref="M:Microsoft.DiaSymReader.SymUnmanagedWriter.OpenMethod(System.Int32)"/>.
</summary>
<exception cref="T:System.ObjectDisposedException">Object has been disposed.</exception>
<exception cref="T:System.InvalidOperationException">Writes are not allowed to the underlying stream.</exception>
<exception cref="T:Microsoft.DiaSymReader.SymUnmanagedWriterException">Error occurred while writing PDB data.</exception>
</member>
<member name="M:Microsoft.DiaSymReader.SymUnmanagedWriter.OpenScope(System.Int32)">
<summary>
Opens a local scope.
</summary>
<exception cref="T:System.ObjectDisposedException">Object has been disposed.</exception>
<exception cref="T:System.InvalidOperationException">Writes are not allowed to the underlying stream.</exception>
</member>
<member name="M:Microsoft.DiaSymReader.SymUnmanagedWriter.CloseScope(System.Int32)">
<summary>
Closes a local scope previously open using <see cref="M:Microsoft.DiaSymReader.SymUnmanagedWriter.OpenScope(System.Int32)"/>.
</summary>
<exception cref="T:System.ObjectDisposedException">Object has been disposed.</exception>
<exception cref="T:System.InvalidOperationException">Writes are not allowed to the underlying stream.</exception>
<exception cref="T:Microsoft.DiaSymReader.SymUnmanagedWriterException">Error occurred while writing PDB data.</exception>
</member>
<member name="M:Microsoft.DiaSymReader.SymUnmanagedWriter.DefineLocalVariable(System.Int32,System.String,System.Int32,System.Int32)">
<summary>
Defines a local variable.
</summary>
<exception cref="T:System.ObjectDisposedException">Object has been disposed.</exception>
<exception cref="T:System.InvalidOperationException">Writes are not allowed to the underlying stream.</exception>
<exception cref="T:Microsoft.DiaSymReader.SymUnmanagedWriterException">Error occurred while writing PDB data.</exception>
</member>
<member name="M:Microsoft.DiaSymReader.SymUnmanagedWriter.DefineLocalConstant(System.String,System.Object,System.Int32)">
<summary>
Defines a local constant.
</summary>
<param name="name">Name of the constant.</param>
<param name="value">Value.</param>
<param name="constantSignatureToken">Standalone signature token encoding the static type of the constant.</param>
<returns>False if the constant representation is too long (e.g. long string).</returns>
<exception cref="T:System.ObjectDisposedException">Object has been disposed.</exception>
<exception cref="T:System.InvalidOperationException">Writes are not allowed to the underlying stream.</exception>
<exception cref="T:Microsoft.DiaSymReader.SymUnmanagedWriterException">Error occurred while writing PDB data.</exception>
<exception cref="T:System.ArgumentNullException"><paramref name="name"/> is null</exception>
</member>
<member name="M:Microsoft.DiaSymReader.SymUnmanagedWriter.UsingNamespace(System.String)">
<summary>
Adds namespace import.
</summary>
<exception cref="T:System.ObjectDisposedException">Object has been disposed.</exception>
<exception cref="T:System.InvalidOperationException">Writes are not allowed to the underlying stream.</exception>
<exception cref="T:Microsoft.DiaSymReader.SymUnmanagedWriterException">Error occurred while writing PDB data.</exception>
<exception cref="T:System.ArgumentNullException"><paramref name="importString"/> is null</exception>
</member>
<member name="M:Microsoft.DiaSymReader.SymUnmanagedWriter.SetAsyncInfo(System.Int32,System.Int32,System.Int32,System.ReadOnlySpan{System.Int32},System.ReadOnlySpan{System.Int32})">
<summary>
Sets method async information.
</summary>
<exception cref="T:System.ObjectDisposedException">Object has been disposed.</exception>
<exception cref="T:System.InvalidOperationException">Writes are not allowed to the underlying stream.</exception>
<exception cref="T:Microsoft.DiaSymReader.SymUnmanagedWriterException">Error occurred while writing PDB data.</exception>
<exception cref="T:System.ArgumentNullException"><paramref name="yieldOffsets"/> or <paramref name="resumeOffsets"/> is null</exception>
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="yieldOffsets"/> or <paramref name="resumeOffsets"/> differ in length.</exception>
</member>
<member name="M:Microsoft.DiaSymReader.SymUnmanagedWriter.DefineCustomMetadata(System.Byte[])">
<summary>
Associates custom debug information blob with the current method.
</summary>
<exception cref="T:System.ObjectDisposedException">Object has been disposed.</exception>
<exception cref="T:System.InvalidOperationException">Writes are not allowed to the underlying stream.</exception>
<exception cref="T:Microsoft.DiaSymReader.SymUnmanagedWriterException">Error occurred while writing PDB data.</exception>
<exception cref="T:System.ArgumentNullException"><paramref name="metadata"/> is null</exception>
</member>
<member name="M:Microsoft.DiaSymReader.SymUnmanagedWriter.SetEntryPoint(System.Int32)">
<summary>
Designates specified method as an entry point.
</summary>
<exception cref="T:System.ObjectDisposedException">Object has been disposed.</exception>
<exception cref="T:System.InvalidOperationException">Writes are not allowed to the underlying stream.</exception>
<exception cref="T:Microsoft.DiaSymReader.SymUnmanagedWriterException">Error occurred while writing PDB data.</exception>
</member>
<member name="M:Microsoft.DiaSymReader.SymUnmanagedWriter.UpdateSignature(System.Guid,System.UInt32,System.Int32)">
<summary>
Updates the current PDB signature.
</summary>
<exception cref="T:System.ObjectDisposedException">Object has been disposed.</exception>
<exception cref="T:System.InvalidOperationException">Writes are not allowed to the underlying stream.</exception>
<exception cref="T:Microsoft.DiaSymReader.SymUnmanagedWriterException">Error occurred while writing PDB data.</exception>
</member>
<member name="M:Microsoft.DiaSymReader.SymUnmanagedWriter.GetSignature(System.Guid@,System.UInt32@,System.Int32@)">
<summary>
Gets the current PDB signature.
</summary>
<exception cref="T:System.ObjectDisposedException">Object has been disposed.</exception>
<exception cref="T:Microsoft.DiaSymReader.SymUnmanagedWriterException">Error occurred while writing PDB data.</exception>
</member>
<member name="M:Microsoft.DiaSymReader.SymUnmanagedWriter.SetSourceServerData(System.Byte[])">
<summary>
Sets source server data blob (srcsvr stream).
</summary>
<exception cref="T:System.ObjectDisposedException">Object has been disposed.</exception>
<exception cref="T:System.InvalidOperationException">Writes are not allowed to the underlying stream.</exception>
<exception cref="T:Microsoft.DiaSymReader.SymUnmanagedWriterException">Error occurred while writing PDB data.</exception>
<exception cref="T:System.ArgumentNullException"><paramref name="data"/> is null</exception>
</member>
<member name="M:Microsoft.DiaSymReader.SymUnmanagedWriter.SetSourceLinkData(System.Byte[])">
<summary>
Sets source link data blob (sourcelink stream).
</summary>
<exception cref="T:System.ObjectDisposedException">Object has been disposed.</exception>
<exception cref="T:System.InvalidOperationException">Writes are not allowed to the underlying stream.</exception>
<exception cref="T:Microsoft.DiaSymReader.SymUnmanagedWriterException">Error occurred while writing PDB data.</exception>
<exception cref="T:System.ArgumentNullException"><paramref name="data"/> is null</exception>
</member>
<member name="M:Microsoft.DiaSymReader.SymUnmanagedWriter.OpenTokensToSourceSpansMap">
<summary>
Opens a map of tokens to source spans.
</summary>
<exception cref="T:System.ObjectDisposedException">Object has been disposed.</exception>
<exception cref="T:System.InvalidOperationException">Writes are not allowed to the underlying stream.</exception>
<exception cref="T:Microsoft.DiaSymReader.SymUnmanagedWriterException">Error occurred while writing PDB data.</exception>
</member>
<member name="M:Microsoft.DiaSymReader.SymUnmanagedWriter.MapTokenToSourceSpan(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
<summary>
Maps specified token to a source span.
</summary>
<exception cref="T:System.ObjectDisposedException">Object has been disposed.</exception>
<exception cref="T:System.InvalidOperationException">Writes are not allowed to the underlying stream.</exception>
<exception cref="T:Microsoft.DiaSymReader.SymUnmanagedWriterException">Error occurred while writing PDB data.</exception>
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="documentIndex"/> doesn't correspond to any defined document.</exception>
</member>
<member name="M:Microsoft.DiaSymReader.SymUnmanagedWriter.CloseTokensToSourceSpansMap">
<summary>
Closes map of tokens to source spans previously opened using <see cref="M:Microsoft.DiaSymReader.SymUnmanagedWriter.OpenTokensToSourceSpansMap"/>.
</summary>
<exception cref="T:System.ObjectDisposedException">Object has been disposed.</exception>
<exception cref="T:System.InvalidOperationException">Writes are not allowed to the underlying stream.</exception>
<exception cref="T:Microsoft.DiaSymReader.SymUnmanagedWriterException">Error occurred while writing PDB data.</exception>
</member>
<member name="T:Microsoft.DiaSymReader.SymUnmanagedWriterCreationOptions">
<summary>
<see cref="T:Microsoft.DiaSymReader.SymUnmanagedWriter"/> creation options.
</summary>
</member>
<member name="F:Microsoft.DiaSymReader.SymUnmanagedWriterCreationOptions.Default">
<summary>
Default options.
</summary>
</member>
<member name="F:Microsoft.DiaSymReader.SymUnmanagedWriterCreationOptions.UseAlternativeLoadPath">
<summary>
Use environment variable MICROSOFT_DIASYMREADER_NATIVE_ALT_LOAD_PATH to locate Microsoft.DiaSymReader.Native.{platform}.dll.
</summary>
</member>
<member name="F:Microsoft.DiaSymReader.SymUnmanagedWriterCreationOptions.UseComRegistry">
<summary>
Use COM registry to locate an implementation of the writer.
</summary>
</member>
<member name="F:Microsoft.DiaSymReader.SymUnmanagedWriterCreationOptions.Deterministic">
<summary>
Create a deterministic PDB writer.
</summary>
</member>
<member name="T:Microsoft.DiaSymReader.SymUnmanagedWriterException">
<summary>
Exception reported when PDB write operation fails.
</summary>
</member>
<member name="P:Microsoft.DiaSymReader.SymUnmanagedWriterException.ImplementationModuleName">
<summary>
The name of the module that implements the underlying PDB writer (e.g. diasymreader.dll), or null if not available.
</summary>
</member>
<member name="M:Microsoft.DiaSymReader.SymUnmanagedWriterFactory.CreateWriter(Microsoft.DiaSymReader.ISymWriterMetadataProvider,Microsoft.DiaSymReader.SymUnmanagedWriterCreationOptions)">
<summary>
Creates a Windows PDB writer.
</summary>
<param name="metadataProvider"><see cref="T:Microsoft.DiaSymReader.ISymWriterMetadataProvider"/> implementation.</param>
<param name="options">Options.</param>
<remarks>
Tries to load the implementation of the PDB writer from Microsoft.DiaSymReader.Native.{platform}.dll library first.
It searches for this library in the directory Microsoft.DiaSymReader.dll is loaded from,
the application directory, the %WinDir%\System32 directory, and user directories in the DLL search path, in this order.
If not found in the above locations and <see cref="F:Microsoft.DiaSymReader.SymUnmanagedWriterCreationOptions.UseAlternativeLoadPath"/> option is specified
the directory specified by MICROSOFT_DIASYMREADER_NATIVE_ALT_LOAD_PATH environment variable is also searched.
If the Microsoft.DiaSymReader.Native.{platform}.dll library can't be found and <see cref="F:Microsoft.DiaSymReader.SymUnmanagedWriterCreationOptions.UseComRegistry"/>
option is specified checks if the PDB reader is available from a globally registered COM object. This COM object is provided
by .NET Framework and has limited functionality (features like determinism and source link are not supported).
</remarks>
<exception cref="T:System.ArgumentNullException"><paramref name="metadataProvider"/>is null.</exception>
<exception cref="T:System.DllNotFoundException">The SymWriter implementation is not available or failed to load.</exception>
<exception cref="T:Microsoft.DiaSymReader.SymUnmanagedWriterException">Error creating the PDB writer. See inner exception for root cause.</exception>
</member>
<member name="M:Microsoft.DiaSymReader.SymUnmanagedWriterImpl.WriteTo(System.IO.Stream)">
<summary>
Writes the content to the given stream. The writer is disposed and can't be used for further writing.
</summary>
</member>
<member name="T:Microsoft.Cci.ModulePropertiesForSerialization">
<summary>
This class is used to store the module serialization properties for a compilation.
</summary>
</member>
<member name="F:Microsoft.Cci.ModulePropertiesForSerialization.FileAlignment">
<summary>
The alignment factor (in bytes) that is used to align the raw data of sections in the image file.
The value should be a power of 2 between 512 and 64K, inclusive. The default is 512.
</summary>
</member>
<member name="F:Microsoft.Cci.ModulePropertiesForSerialization.SectionAlignment">
<summary>
The alignment (in bytes) of sections when they are loaded into memory.
It must be greater than or equal to <see cref="F:Microsoft.Cci.ModulePropertiesForSerialization.FileAlignment"/>.
The default is the page size for the architecture.
</summary>
</member>
<member name="F:Microsoft.Cci.ModulePropertiesForSerialization.TargetRuntimeVersion">
<summary>
Identifies the version of the CLR that is required to load this module or assembly.
</summary>
</member>
<member name="F:Microsoft.Cci.ModulePropertiesForSerialization.Machine">
<summary>
Specifies the target CPU. <see cref="F:System.Reflection.PortableExecutable.Machine.Unknown"/> means AnyCPU.
</summary>
</member>
<member name="F:Microsoft.Cci.ModulePropertiesForSerialization.PersistentIdentifier">
<summary>
A globally unique persistent identifier for this module.
</summary>
</member>
<member name="F:Microsoft.Cci.ModulePropertiesForSerialization.BaseAddress">
<summary>
The preferred memory address at which the module is to be loaded at runtime.
</summary>
</member>
<member name="F:Microsoft.Cci.ModulePropertiesForSerialization.SizeOfHeapReserve">
<summary>
The size of the virtual memory to reserve for the initial process heap.
Must fit into 32 bits if the target platform is 32 bit.
</summary>
</member>
<member name="F:Microsoft.Cci.ModulePropertiesForSerialization.SizeOfHeapCommit">
<summary>
The size of the virtual memory initially committed for the initial process heap.
Must fit into 32 bits if the target platform is 32 bit.
</summary>
</member>
<member name="F:Microsoft.Cci.ModulePropertiesForSerialization.SizeOfStackReserve">
<summary>
The size of the virtual memory to reserve for the initial thread's stack.
Must fit into 32 bits if the target platform is 32 bit.
</summary>
</member>
<member name="F:Microsoft.Cci.ModulePropertiesForSerialization.LinkerMajorVersion">
<summary>
The first part of a two part version number indicating the version of the linker that produced this module. For example, the 8 in 8.0.
</summary>
</member>
<member name="F:Microsoft.Cci.ModulePropertiesForSerialization.LinkerMinorVersion">
<summary>
The first part of a two part version number indicating the version of the linker that produced this module. For example, the 0 in 8.0.
</summary>
</member>
<member name="P:Microsoft.Cci.ModulePropertiesForSerialization.DllCharacteristics">
<summary>
Flags that control the behavior of the target operating system. CLI implementations are supposed to ignore this, but some operating system pay attention.
</summary>
</member>
<member name="M:Microsoft.Cci.PdbWriter.WriteRemainingDebugDocuments(System.Collections.Generic.IReadOnlyDictionary{System.String,Microsoft.Cci.DebugSourceDocument})">
<summary>
Write document entries for all debug documents that do not yet have an entry.
</summary>
<remarks>
This is done after serializing method debug info to ensure that we embed all requested
text even if there are no corresponding sequence points.
</remarks>
</member>
<member name="T:Microsoft.Cci.AssemblyReferenceAlias">
<summary>
Represents an assembly reference with an alias (C# only, /r:Name=Reference on command line).
</summary>
</member>
<member name="F:Microsoft.Cci.AssemblyReferenceAlias.Name">
<summary>
An alias for the global namespace of the assembly.
</summary>
</member>
<member name="F:Microsoft.Cci.AssemblyReferenceAlias.Assembly">
<summary>
The assembly reference.
</summary>
</member>
<member name="T:Microsoft.Cci.CompilationOptionNames">
<summary>
Names for compilation options that get embedded as debug information
in the PDB as key-value pairs.
</summary>
<remarks>
REMOVAL OR CHANGES TO EXISTING VALUES IS CONSIDERED A BREAKING CHANGE FOR PDB FORMAT
</remarks>
</member>
<member name="T:Microsoft.Cci.VarEnum">
<summary>
System.Runtime.InteropServices.VarEnum is obsolete.
</summary>
</member>
<member name="T:Microsoft.Cci.IDefinition">
<summary>
An object corresponding to a metadata entity such as a type or a field.
</summary>
</member>
<member name="T:Microsoft.Cci.IReference">
<summary>
An object corresponding to reference to a metadata entity such as a type or a field.
</summary>
</member>
<member name="M:Microsoft.Cci.IReference.GetAttributes(Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
A collection of metadata custom attributes that are associated with this definition.
</summary>
</member>
<member name="M:Microsoft.Cci.IReference.Dispatch(Microsoft.Cci.MetadataVisitor)">
<summary>
Calls the visitor.Visit(T) method where T is the most derived object model node interface type implemented by the concrete type
of the object implementing IDefinition. The dispatch method does not invoke Dispatch on any child objects. If child traversal
is desired, the implementations of the Visit methods should do the subsequent dispatching.
</summary>
</member>
<member name="M:Microsoft.Cci.IReference.AsDefinition(Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
Gets the definition object corresponding to this reference within the given context,
or null if the referenced entity isn't defined in the context.
</summary>
</member>
<member name="M:Microsoft.Cci.IReference.GetInternalSymbol">
<summary>
Returns underlying internal symbol object, if any.
</summary>
</member>
<member name="M:Microsoft.Cci.CustomDebugInfoWriter.ShouldForwardNamespaceScopes(Microsoft.CodeAnalysis.Emit.EmitContext,Microsoft.Cci.IMethodBody,System.Reflection.Metadata.MethodDefinitionHandle,Microsoft.Cci.IMethodDefinition@)">
<summary>
Returns true if the namespace scope for this method should be forwarded to another method.
Returns non-null <paramref name="forwardToMethod"/> if the forwarding should be done directly via UsingNamespace,
null if the forwarding is done via custom debug info.
</summary>
</member>
<member name="M:Microsoft.Cci.DebugSourceDocument.#ctor(System.String,System.Guid,System.Func{Microsoft.Cci.DebugSourceInfo})">
<summary>
Use to create a document when checksum is computed based on actual source stream.
</summary>
</member>
<member name="M:Microsoft.Cci.DebugSourceDocument.#ctor(System.String,System.Guid,System.Collections.Immutable.ImmutableArray{System.Byte},System.Guid)">
<summary>
Use to create a document when checksum is suggested via external checksum pragma/directive
</summary>
</member>
<member name="P:Microsoft.Cci.DebugSourceDocument.IsComputedChecksum">
<summary>
returns true when checksum was computed base on an actual source stream
as opposed to be suggested via a checksum directive/pragma
</summary>
</member>
<member name="T:Microsoft.Cci.DebugSourceInfo">
<summary>
Represents the portion of a <see cref="T:Microsoft.Cci.DebugSourceDocument"/> that are derived
from the source document content, and which can be computed asynchronously.
</summary>
</member>
<member name="F:Microsoft.Cci.DebugSourceInfo.ChecksumAlgorithmId">
<summary>
The ID of the hash algorithm used.
</summary>
</member>
<member name="F:Microsoft.Cci.DebugSourceInfo.Checksum">
<summary>
The hash of the document content.
</summary>
</member>
<member name="F:Microsoft.Cci.DebugSourceInfo.EmbeddedTextBlob">
<summary>
The source text to embed in the PDB. (If any, otherwise default.)
</summary>
</member>
<member name="T:Microsoft.Cci.ExceptionHandlerRegion">
<summary>
A region representing an exception handler clause. The region exposes the type (catch or
finally) and the bounds of the try block and catch or finally block as needed by
</summary>
</member>
<member name="P:Microsoft.Cci.ExceptionHandlerRegion.TryStartOffset">
<summary>
Label instruction corresponding to the start of try block
</summary>
</member>
<member name="P:Microsoft.Cci.ExceptionHandlerRegion.TryEndOffset">
<summary>
Label instruction corresponding to the end of try block
</summary>
</member>
<member name="P:Microsoft.Cci.ExceptionHandlerRegion.HandlerStartOffset">
<summary>
Label instruction corresponding to the start of handler block
</summary>
</member>
<member name="P:Microsoft.Cci.ExceptionHandlerRegion.HandlerEndOffset">
<summary>
Label instruction corresponding to the end of handler block
</summary>
</member>
<member name="P:Microsoft.Cci.ExceptionHandlerRegion.HandlerKind">
<summary>
Handler kind for this SEH info
</summary>
</member>
<member name="P:Microsoft.Cci.ExceptionHandlerRegion.ExceptionType">
<summary>
If HandlerKind == HandlerKind.Catch, this is the type of exception to catch. If HandlerKind == HandlerKind.Filter, this is System.Object.
Otherwise this is a Dummy.TypeReference.
</summary>
</member>
<member name="P:Microsoft.Cci.ExceptionHandlerRegion.FilterDecisionStartOffset">
<summary>
Label instruction corresponding to the start of filter decision block
</summary>
</member>
<member name="T:Microsoft.Cci.ExportedType">
<summary>
Info needed when emitting ExportedType table entry.
</summary>
</member>
<member name="F:Microsoft.Cci.ExportedType.Type">
<summary>
The target type reference.
</summary>
</member>
<member name="F:Microsoft.Cci.ExportedType.IsForwarder">
<summary>
True if this <see cref="T:Microsoft.Cci.ExportedType"/> represents a type forwarder definition,
false if it represents a type from a linked netmodule.
</summary>
</member>
<member name="F:Microsoft.Cci.ExportedType.ParentIndex">
<summary>
If <see cref="F:Microsoft.Cci.ExportedType.Type"/> is a nested type defined in a linked netmodule,
the index of the <see cref="T:Microsoft.Cci.ExportedType"/> entry that represents the enclosing type.
</summary>
</member>
<member name="T:Microsoft.Cci.IMetadataExpression">
<summary>
An expression that can be represented directly in metadata.
</summary>
</member>
<member name="M:Microsoft.Cci.IMetadataExpression.Dispatch(Microsoft.Cci.MetadataVisitor)">
<summary>
Calls the visitor.Visit(T) method where T is the most derived object model node interface type implemented by the concrete type
of the object implementing IStatement. The dispatch method does not invoke Dispatch on any child objects. If child traversal
is desired, the implementations of the Visit methods should do the subsequent dispatching.
</summary>
</member>
<member name="P:Microsoft.Cci.IMetadataExpression.Type">
<summary>
The type of value the expression represents.
</summary>
</member>
<member name="T:Microsoft.Cci.IMetadataNamedArgument">
<summary>
An expression that represents a (name, value) pair and that is typically used in method calls, custom attributes and object initializers.
</summary>
</member>
<member name="P:Microsoft.Cci.IMetadataNamedArgument.ArgumentName">
<summary>
The name of the parameter or property or field that corresponds to the argument.
</summary>
</member>
<member name="P:Microsoft.Cci.IMetadataNamedArgument.ArgumentValue">
<summary>
The value of the argument.
</summary>
</member>
<member name="P:Microsoft.Cci.IMetadataNamedArgument.IsField">
<summary>
True if the named argument provides the value of a field.
</summary>
</member>
<member name="T:Microsoft.Cci.ExtendedPEBuilder">
<summary>
This PEBuilder adds an .mvid section.
</summary>
</member>
<member name="T:Microsoft.Cci.ICustomAttribute">
<summary>
A metadata custom attribute.
</summary>
</member>
<member name="M:Microsoft.Cci.ICustomAttribute.GetArguments(Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
Zero or more positional arguments for the attribute constructor.
</summary>
</member>
<member name="M:Microsoft.Cci.ICustomAttribute.Constructor(Microsoft.CodeAnalysis.Emit.EmitContext,System.Boolean)">
<summary>
A reference to the constructor that will be used to instantiate this custom attribute during execution (if the attribute is inspected via Reflection).
</summary>
</member>
<member name="M:Microsoft.Cci.ICustomAttribute.GetNamedArguments(Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
Zero or more named arguments that specify values for fields and properties of the attribute.
</summary>
</member>
<member name="P:Microsoft.Cci.ICustomAttribute.ArgumentCount">
<summary>
The number of positional arguments.
</summary>
</member>
<member name="P:Microsoft.Cci.ICustomAttribute.NamedArgumentCount">
<summary>
The number of named arguments.
</summary>
</member>
<member name="M:Microsoft.Cci.ICustomAttribute.GetType(Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
The type of the attribute. For example System.AttributeUsageAttribute.
</summary>
</member>
<member name="P:Microsoft.Cci.ICustomAttribute.AllowMultiple">
<summary>
Whether attribute allows multiple.
</summary>
</member>
<member name="T:Microsoft.Cci.IFileReference">
<summary>
Represents a file referenced by an assembly.
</summary>
</member>
<member name="P:Microsoft.Cci.IFileReference.HasMetadata">
<summary>
True if the file has metadata.
</summary>
</member>
<member name="P:Microsoft.Cci.IFileReference.FileName">
<summary>
File name with extension.
</summary>
</member>
<member name="M:Microsoft.Cci.IFileReference.GetHashValue(System.Reflection.AssemblyHashAlgorithm)">
<summary>
A hash of the file contents.
</summary>
</member>
<member name="T:Microsoft.Cci.IImportScope">
<summary>
Represents a lexical scope that declares imports.
</summary>
</member>
<member name="M:Microsoft.Cci.IImportScope.GetUsedNamespaces">
<summary>
Zero or more used namespaces. These correspond to using directives in C# or Imports syntax in VB.
Multiple invocations return the same array instance.
</summary>
</member>
<member name="P:Microsoft.Cci.IImportScope.Parent">
<summary>
Parent import scope, or null.
</summary>
</member>
<member name="T:Microsoft.Cci.LocalScope">
<summary>
A range of CLR IL operations that comprise a lexical scope.
</summary>
</member>
<member name="F:Microsoft.Cci.LocalScope.StartOffset">
<summary>
The offset of the first operation in the scope.
</summary>
</member>
<member name="F:Microsoft.Cci.LocalScope.EndOffset">
<summary>
The offset of the first operation outside of the scope, or the method body length.
</summary>
</member>
<member name="P:Microsoft.Cci.LocalScope.Constants">
<summary>
Returns zero or more local constant definitions that are local to the given scope.
</summary>
</member>
<member name="P:Microsoft.Cci.LocalScope.Variables">
<summary>
Returns zero or more local variable definitions that are local to the given scope.
</summary>
</member>
<member name="M:Microsoft.Cci.ManagedResource.#ctor(System.String,System.Boolean,System.Func{System.IO.Stream},Microsoft.Cci.IFileReference,System.UInt32)">
<summary>
<paramref name="streamProvider"/> streamProvider callers will dispose result after use.
<paramref name="streamProvider"/> and <paramref name="fileReference"/> are mutually exclusive.
</summary>
</member>
<member name="T:Microsoft.Cci.CallingConvention">
<summary>
Specifies how the caller passes parameters to the callee and who cleans up the stack.
</summary>
</member>
<member name="F:Microsoft.Cci.CallingConvention.CDecl">
<summary>
C/C++ style calling convention for unmanaged methods. The call stack is cleaned up by the caller,
which makes this convention suitable for calling methods that accept extra arguments.
</summary>
</member>
<member name="F:Microsoft.Cci.CallingConvention.Default">
<summary>
The convention for calling managed methods with a fixed number of arguments.
</summary>
</member>
<member name="F:Microsoft.Cci.CallingConvention.ExtraArguments">
<summary>
The convention for calling managed methods that accept extra arguments.
</summary>
</member>
<member name="F:Microsoft.Cci.CallingConvention.FastCall">
<summary>
Arguments are passed in registers when possible. This calling convention is not yet supported.
</summary>
</member>
<member name="F:Microsoft.Cci.CallingConvention.Standard">
<summary>
Win32 API calling convention for calling unmanaged methods via PlatformInvoke. The call stack is cleaned up by the callee.
</summary>
</member>
<member name="F:Microsoft.Cci.CallingConvention.ThisCall">
<summary>
C++ member unmanaged method (non-vararg) calling convention. The callee cleans the stack and the this pointer is pushed on the stack last.
</summary>
</member>
<member name="F:Microsoft.Cci.CallingConvention.Unmanaged">
<summary>
Extensible calling convention protocol. This represents either the union of calling convention modopts after the paramcount specifier
in IL, or platform default if none are present
</summary>
</member>
<member name="F:Microsoft.Cci.CallingConvention.Generic">
<summary>
The convention for calling a generic method.
</summary>
</member>
<member name="F:Microsoft.Cci.CallingConvention.HasThis">
<summary>
The convention for calling an instance method with an implicit this parameter (the method does not have an explicit parameter definition for this).
</summary>
</member>
<member name="F:Microsoft.Cci.CallingConvention.ExplicitThis">
<summary>
The convention for calling an instance method that explicitly declares its first parameter to correspond to the this instance.
</summary>
</member>
<member name="M:Microsoft.Cci.CallingConventionUtils.IsCallingConvention(Microsoft.Cci.CallingConvention,Microsoft.Cci.CallingConvention)">
<summary>
Compares calling conventions, ignoring calling convention attributes.
</summary>
</member>
<member name="T:Microsoft.Cci.IEventDefinition">
<summary>
An event is a member that enables an object or class to provide notifications. Clients can attach executable code for events by supplying event handlers.
This interface models the metadata representation of an event.
</summary>
</member>
<member name="M:Microsoft.Cci.IEventDefinition.GetAccessors(Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
A list of methods that are associated with the event.
</summary>
</member>
<member name="P:Microsoft.Cci.IEventDefinition.Adder">
<summary>
The method used to add a handler to the event.
</summary>
</member>
<member name="P:Microsoft.Cci.IEventDefinition.Caller">
<summary>
The method used to call the event handlers when the event occurs. May be null.
</summary>
</member>
<member name="P:Microsoft.Cci.IEventDefinition.IsRuntimeSpecial">
<summary>
True if the event gets special treatment from the runtime.
</summary>
</member>
<member name="P:Microsoft.Cci.IEventDefinition.IsSpecialName">
<summary>
This event is special in some way, as specified by the name.
</summary>
</member>
<member name="P:Microsoft.Cci.IEventDefinition.Remover">
<summary>
The method used to add a handler to the event.
</summary>
</member>
<member name="M:Microsoft.Cci.IEventDefinition.GetType(Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
The (delegate) type of the handlers that will handle the event.
</summary>
</member>
<member name="T:Microsoft.Cci.IFieldDefinition">
<summary>
A field is a member that represents a variable associated with an object or class.
This interface models the metadata representation of a field.
</summary>
</member>
<member name="M:Microsoft.Cci.IFieldDefinition.GetCompileTimeValue(Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
The compile time value of the field. This value should be used directly in IL, rather than a reference to the field.
If the field does not have a valid compile time value, Dummy.Constant is returned.
</summary>
</member>
<member name="P:Microsoft.Cci.IFieldDefinition.MappedData">
<summary>
Mapped field data, or null if the field is not mapped.
</summary>
</member>
<member name="P:Microsoft.Cci.IFieldDefinition.IsCompileTimeConstant">
<summary>
This field is a compile-time constant. The field has no runtime location and cannot be directly addressed from IL.
</summary>
</member>
<member name="P:Microsoft.Cci.IFieldDefinition.IsMarshalledExplicitly">
<summary>
This field has associated field marshalling information.
</summary>
</member>
<member name="P:Microsoft.Cci.IFieldDefinition.IsNotSerialized">
<summary>
The field does not have to be serialized when its containing instance is serialized.
</summary>
</member>
<member name="P:Microsoft.Cci.IFieldDefinition.IsReadOnly">
<summary>
This field can only be read. Initialization takes place in a constructor.
</summary>
</member>
<member name="P:Microsoft.Cci.IFieldDefinition.IsRuntimeSpecial">
<summary>
True if the field gets special treatment from the runtime.
</summary>
</member>
<member name="P:Microsoft.Cci.IFieldDefinition.IsSpecialName">
<summary>
This field is special in some way, as specified by the name.
</summary>
</member>
<member name="P:Microsoft.Cci.IFieldDefinition.IsStatic">
<summary>
This field is static (shared by all instances of its declaring type).
</summary>
</member>
<member name="P:Microsoft.Cci.IFieldDefinition.MarshallingInformation">
<summary>
Specifies how this field is marshalled when it is accessed from unmanaged code.
</summary>
</member>
<member name="P:Microsoft.Cci.IFieldDefinition.MarshallingDescriptor">
<summary>
Checked if IsMarshalledExplicitly == true and MarshallingInformation is null
</summary>
</member>
<member name="P:Microsoft.Cci.IFieldDefinition.Offset">
<summary>
Offset of the field.
</summary>
</member>
<member name="T:Microsoft.Cci.IFieldReference">
<summary>
A reference to a field.
</summary>
</member>
<member name="M:Microsoft.Cci.IFieldReference.GetType(Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
The type of value that is stored in this field.
</summary>
</member>
<member name="M:Microsoft.Cci.IFieldReference.GetResolvedField(Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
The Field being referred to.
</summary>
</member>
<member name="P:Microsoft.Cci.IFieldReference.IsContextualNamedEntity">
<summary>
True, if field is an IContextualNamedEntity, even if field reference implements the interface,
doesn't mean it is contextual.
</summary>
</member>
<member name="T:Microsoft.Cci.ILocalDefinition">
<summary>
An object that represents a local variable or constant.
</summary>
</member>
<member name="P:Microsoft.Cci.ILocalDefinition.CompileTimeValue">
<summary>
The compile time value of the definition, if it is a local constant.
</summary>
</member>
<member name="P:Microsoft.Cci.ILocalDefinition.CustomModifiers">
<summary>
Custom modifiers associated with local variable definition.
</summary>
</member>
<member name="P:Microsoft.Cci.ILocalDefinition.IsPinned">
<summary>
TODO: use <see cref="P:Microsoft.Cci.ILocalDefinition.Constraints"/> instead.
True if the value referenced by the local must not be moved by the actions of the garbage collector.
</summary>
</member>
<member name="P:Microsoft.Cci.ILocalDefinition.IsReference">
<summary>
TODO: use <see cref="P:Microsoft.Cci.ILocalDefinition.Constraints"/> instead.
True if the local contains a managed pointer (for example a reference to a local variable or a reference to a field of an object).
</summary>
</member>
<member name="P:Microsoft.Cci.ILocalDefinition.PdbAttributes">
<summary>
Each local has an attributes field in the PDB. To match the native compiler,
we emit <see cref="F:System.Reflection.Metadata.LocalVariableAttributes.DebuggerHidden"/> for locals that should
definitely not bind in the debugger and <see cref="F:System.Reflection.Metadata.LocalVariableAttributes.None"/>
for all other locals.
</summary>
<remarks>
A value of <see cref="F:System.Reflection.Metadata.LocalVariableAttributes.DebuggerHidden"/> is a sufficient, but not a necessary, condition for hiding the
local in the debugger. Locals with value <see cref="F:System.Reflection.Metadata.LocalVariableAttributes.None"/> may also be hidden.
Hidden locals must still be emitted because they participate in evaluation.
</remarks>
</member>
<member name="P:Microsoft.Cci.ILocalDefinition.DynamicTransformFlags">
<summary>
The synthesized dynamic attributes of the local definition if any, or empty.
</summary>
</member>
<member name="P:Microsoft.Cci.ILocalDefinition.TupleElementNames">
<summary>
The tuple element names of the local definition if any, or empty.
</summary>
</member>
<member name="P:Microsoft.Cci.ILocalDefinition.Type">
<summary>
The type of the local.
</summary>
</member>
<member name="P:Microsoft.Cci.ILocalDefinition.Location">
<summary>
Location for reporting diagnostics about the local.
</summary>
<remark>
Use <see cref="P:Microsoft.CodeAnalysis.Location.None"/> rather than null.
</remark>
</member>
<member name="P:Microsoft.Cci.ILocalDefinition.SlotIndex">
<summary>
Slot index or -1 if not applicable.
</summary>
</member>
<member name="P:Microsoft.Cci.ILocalDefinition.Signature">
<summary>
Optional serialized local signature.
</summary>
</member>
<member name="P:Microsoft.Cci.ILocalDefinition.SlotInfo">
<summary>
Local id, or <see cref="F:Microsoft.CodeAnalysis.CodeGen.LocalDebugId.None"/> if this is a local constant, short-lived temp variable,
or we are not emitting local variable ids (release builds).
</summary>
</member>
<member name="T:Microsoft.Cci.IMethodBody">
<summary>
A metadata (IL) level representation of the body of a method or of a property/event accessor.
</summary>
</member>
<member name="P:Microsoft.Cci.IMethodBody.ExceptionRegions">
<summary>
A list exception data within the method body IL.
</summary>
</member>
<member name="P:Microsoft.Cci.IMethodBody.AreLocalsZeroed">
<summary>
True if the locals are initialized by zeroing the stack upon method entry.
</summary>
</member>
<member name="P:Microsoft.Cci.IMethodBody.HasStackalloc">
<summary>
True if there's a stackalloc somewhere in the method.
</summary>
</member>
<member name="P:Microsoft.Cci.IMethodBody.LocalVariables">
<summary>
The local variables of the method.
</summary>
</member>
<member name="P:Microsoft.Cci.IMethodBody.MethodDefinition">
<summary>
The definition of the method whose body this is.
If this is the body of an event or property accessor, this will hold the corresponding adder/remover/setter or getter method.
</summary>
</member>
<member name="P:Microsoft.Cci.IMethodBody.MoveNextBodyInfo">
<summary>
Debugging information associated with a MoveNext method of a state machine.
</summary>
</member>
<member name="P:Microsoft.Cci.IMethodBody.MaxStack">
<summary>
The maximum number of elements on the evaluation stack during the execution of the method.
</summary>
</member>
<member name="P:Microsoft.Cci.IMethodBody.HasDynamicLocalVariables">
<summary>
Returns true if there is at least one dynamic local within the MethodBody
</summary>
</member>
<member name="P:Microsoft.Cci.IMethodBody.LocalScopes">
<summary>
Returns zero or more local (block) scopes into which the CLR IL operations in the given method body is organized.
</summary>
</member>
<member name="P:Microsoft.Cci.IMethodBody.ImportScope">
<summary>
Returns an import scope the method is declared within, or null if there is none
(e.g. the method doesn't contain user code).
</summary>
<remarks>
The chain is a spine of a tree in a forest of import scopes. A tree of import scopes is created by the language for each source file
based on namespace declarations. In VB each tree is trivial single-node tree that declares the imports of a file.
In C# the tree copies the nesting of namespace declarations in the file. There is a separate scope for each dotted component in
the namespace type name. For instance namespace type x.y.z will have two namespace scopes, the first is for the x and the second
is for the y.
</remarks>
</member>
<member name="P:Microsoft.Cci.IMethodBody.StateMachineHoistedLocalScopes">
<summary>
Returns debug information for local variables hoisted to state machine fields,
or null if this method isn't MoveNext method of a state machine.
</summary>
<remarks>
Returns zero or more local (block) scopes, each defining an IL range in which an iterator local is defined.
The scopes are returned for the MoveNext method of the object returned by the iterator method.
The index of the scope corresponds to the index of the local. Specifically local scope i corresponds
to the local stored in a field named <localName>5__i of the class used to store the local values in
between calls to MoveNext, where localName is the original name of the local variable. For example, if
the first local to be moved into the class is named "xyzzy", it will be stored in a field named
"<xyzzy>5__1", and the ILocalScope returned from this method at index 1 (i.e. the second one) will
have the scope information for where that variable is in scope.
</remarks>
</member>
<member name="P:Microsoft.Cci.IMethodBody.StateMachineTypeName">
<summary>
The name of the state machine generated for the method,
or null if the method isn't the kickoff method of a state machine.
</summary>
</member>
<member name="P:Microsoft.Cci.IMethodBody.StateMachineHoistedLocalSlots">
<summary>
Returns information relevant to EnC on slots of local variables hoisted to state machine fields,
or null if the method isn't the kickoff method of a state machine.
</summary>
</member>
<member name="P:Microsoft.Cci.IMethodBody.StateMachineAwaiterSlots">
<summary>
Returns types of awaiter slots allocated on the state machine,
or null if the method isn't the kickoff method of a state machine.
</summary>
</member>
<member name="T:Microsoft.Cci.IMethodDefinition">
<summary>
This interface models the metadata representation of a method.
</summary>
</member>
<member name="M:Microsoft.Cci.IMethodDefinition.GetBody(Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
A container for a list of IL instructions providing the implementation (if any) of this method.
</summary>
<remarks>
When emitting metadata-only assemblies this returns null even if <see cref="M:Microsoft.Cci.Extensions.HasBody(Microsoft.Cci.IMethodDefinition)"/> returns true.
</remarks>
</member>
<member name="P:Microsoft.Cci.IMethodDefinition.GenericParameters">
<summary>
If the method is generic then this list contains the type parameters.
</summary>
</member>
<member name="P:Microsoft.Cci.IMethodDefinition.HasDeclarativeSecurity">
<summary>
True if this method has a non empty collection of SecurityAttributes or the System.Security.SuppressUnmanagedCodeSecurityAttribute.
</summary>
</member>
<member name="P:Microsoft.Cci.IMethodDefinition.IsAbstract">
<summary>
True if the method does not provide an implementation.
</summary>
</member>
<member name="P:Microsoft.Cci.IMethodDefinition.IsAccessCheckedOnOverride">
<summary>
True if the method can only be overridden when it is also accessible.
</summary>
</member>
<member name="P:Microsoft.Cci.IMethodDefinition.IsConstructor">
<summary>
True if the method is a constructor.
</summary>
</member>
<member name="P:Microsoft.Cci.IMethodDefinition.IsExternal">
<summary>
True if the method has an external implementation (i.e. not supplied by this definition).
</summary>
<remarks>
If the method is not external and not abstract it has to provide an IL body.
</remarks>
</member>
<member name="P:Microsoft.Cci.IMethodDefinition.IsHiddenBySignature">
<summary>
True if this method is hidden if a derived type declares a method with the same name and signature.
If false, any method with the same name hides this method. This flag is ignored by the runtime and is only used by compilers.
</summary>
</member>
<member name="P:Microsoft.Cci.IMethodDefinition.IsNewSlot">
<summary>
The method always gets a new slot in the virtual method table.
This means the method will hide (not override) a base type method with the same name and signature.
</summary>
</member>
<member name="P:Microsoft.Cci.IMethodDefinition.IsPlatformInvoke">
<summary>
True if the method is implemented via the invocation of an underlying platform method.
</summary>
</member>
<member name="P:Microsoft.Cci.IMethodDefinition.IsRuntimeSpecial">
<summary>
True if the method gets special treatment from the runtime. For example, it might be a constructor.
</summary>
</member>
<member name="P:Microsoft.Cci.IMethodDefinition.IsSealed">
<summary>
True if the method may not be overridden.
</summary>
</member>
<member name="P:Microsoft.Cci.IMethodDefinition.IsSpecialName">
<summary>
True if the method is special in some way for tools. For example, it might be a property getter or setter.
</summary>
</member>
<member name="P:Microsoft.Cci.IMethodDefinition.IsStatic">
<summary>
True if the method does not require an instance of its declaring type as its first argument.
</summary>
</member>
<member name="P:Microsoft.Cci.IMethodDefinition.IsVirtual">
<summary>
True if the method may be overridden (or if it is an override).
</summary>
</member>
<member name="M:Microsoft.Cci.IMethodDefinition.GetImplementationAttributes(Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
Implementation flags.
</summary>
</member>
<member name="P:Microsoft.Cci.IMethodDefinition.Parameters">
<summary>
The parameters forming part of this signature.
</summary>
</member>
<member name="P:Microsoft.Cci.IMethodDefinition.PlatformInvokeData">
<summary>
Detailed information about the PInvoke stub. Identifies which method to call, which module has the method and the calling convention among other things.
</summary>
</member>
<member name="P:Microsoft.Cci.IMethodDefinition.RequiresSecurityObject">
<summary>
True if the method calls another method containing security code. If this flag is set, the method
should have System.Security.DynamicSecurityMethodAttribute present in its list of custom attributes.
</summary>
</member>
<member name="M:Microsoft.Cci.IMethodDefinition.GetReturnValueAttributes(Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
Custom attributes associated with the method's return value.
</summary>
</member>
<member name="P:Microsoft.Cci.IMethodDefinition.ReturnValueIsMarshalledExplicitly">
<summary>
The return value has associated marshalling information.
</summary>
</member>
<member name="P:Microsoft.Cci.IMethodDefinition.ReturnValueMarshallingInformation">
<summary>
Specifies how the return value is marshalled when the method is called from unmanaged code.
</summary>
</member>
<member name="P:Microsoft.Cci.IMethodDefinition.ReturnValueMarshallingDescriptor">
<summary>
Checked if ReturnValueIsMarshalledExplicitly == true and ReturnValueMarshallingInformation is null
</summary>
</member>
<member name="P:Microsoft.Cci.IMethodDefinition.SecurityAttributes">
<summary>
Declarative security actions for this method.
</summary>
</member>
<member name="P:Microsoft.Cci.IMethodDefinition.ContainingNamespace">
<summary>
Namespace containing this method.
TODO: Ideally we would expose INamespace on INamespaceTypeDefinition. Right now we can only get the qualified namespace name.
</summary>
</member>
<member name="T:Microsoft.Cci.IParameterDefinition">
<summary>
This interface models the metadata representation of a method or property parameter.
</summary>
</member>
<member name="M:Microsoft.Cci.IParameterDefinition.GetDefaultValue(Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
A compile time constant value that should be supplied as the corresponding argument value by callers that do not explicitly specify an argument value for this parameter.
Null if the parameter doesn't have default value.
</summary>
</member>
<member name="P:Microsoft.Cci.IParameterDefinition.HasDefaultValue">
<summary>
True if the parameter has a default value that should be supplied as the argument value by a caller for which the argument value has not been explicitly specified.
</summary>
</member>
<member name="P:Microsoft.Cci.IParameterDefinition.IsIn">
<summary>
True if the argument value must be included in the marshalled arguments passed to a remote callee.
</summary>
</member>
<member name="P:Microsoft.Cci.IParameterDefinition.IsMarshalledExplicitly">
<summary>
This parameter has associated marshalling information.
</summary>
</member>
<member name="P:Microsoft.Cci.IParameterDefinition.IsOptional">
<summary>
True if the argument value must be included in the marshalled arguments passed to a remote callee only if it is different from the default value (if there is one).
</summary>
</member>
<member name="P:Microsoft.Cci.IParameterDefinition.IsOut">
<summary>
True if the final value assigned to the parameter will be marshalled with the return values passed back from a remote callee.
</summary>
</member>
<member name="P:Microsoft.Cci.IParameterDefinition.MarshallingInformation">
<summary>
Specifies how this parameter is marshalled when it is accessed from unmanaged code.
</summary>
</member>
<member name="P:Microsoft.Cci.IParameterDefinition.MarshallingDescriptor">
<summary>
Checked if IsMarshalledExplicitly == true and MarshallingInformation is null
</summary>
</member>
<member name="T:Microsoft.Cci.IPropertyDefinition">
<summary>
A property is a member that provides access to an attribute of an object or a class.
This interface models the metadata representation of a property.
</summary>
</member>
<member name="M:Microsoft.Cci.IPropertyDefinition.GetAccessors(Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
A list of methods that are associated with the property.
</summary>
</member>
<member name="P:Microsoft.Cci.IPropertyDefinition.DefaultValue">
<summary>
A compile time constant value that provides the default value for the property. (Who uses this and why?)
</summary>
</member>
<member name="P:Microsoft.Cci.IPropertyDefinition.Getter">
<summary>
The method used to get the value of this property. May be absent (null).
</summary>
</member>
<member name="P:Microsoft.Cci.IPropertyDefinition.HasDefaultValue">
<summary>
True if this property has a compile time constant associated with that serves as a default value for the property. (Who uses this and why?)
</summary>
</member>
<member name="P:Microsoft.Cci.IPropertyDefinition.IsRuntimeSpecial">
<summary>
True if this property gets special treatment from the runtime.
</summary>
</member>
<member name="P:Microsoft.Cci.IPropertyDefinition.IsSpecialName">
<summary>
True if this property is special in some way, as specified by the name.
</summary>
</member>
<member name="P:Microsoft.Cci.IPropertyDefinition.Parameters">
<summary>
The parameters forming part of this signature.
</summary>
</member>
<member name="P:Microsoft.Cci.IPropertyDefinition.Setter">
<summary>
The method used to set the value of this property. May be absent (null).
</summary>
</member>
<member name="T:Microsoft.Cci.ISignature">
<summary>
The parameters and return type that makes up a method or property signature.
This interface models the metadata representation of a signature.
</summary>
</member>
<member name="P:Microsoft.Cci.ISignature.CallingConvention">
<summary>
Calling convention of the signature.
</summary>
</member>
<member name="P:Microsoft.Cci.ISignature.ParameterCount">
<summary>
The number of required parameters of the signature.
</summary>
</member>
<member name="M:Microsoft.Cci.ISignature.GetParameters(Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
The parameters forming part of this signature.
</summary>
</member>
<member name="P:Microsoft.Cci.ISignature.ReturnValueCustomModifiers">
<summary>
Returns the list of custom modifiers, if any, associated with the return type.
</summary>
</member>
<member name="P:Microsoft.Cci.ISignature.RefCustomModifiers">
<summary>
Returns the list of custom modifiers, if any, associated with the ref modifier.
</summary>
</member>
<member name="P:Microsoft.Cci.ISignature.ReturnValueIsByRef">
<summary>
True if the return value is passed by reference (using a managed pointer).
</summary>
</member>
<member name="M:Microsoft.Cci.ISignature.GetType(Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
The return type of the method or type of the property.
</summary>
</member>
<member name="T:Microsoft.Cci.ITypeDefinitionMember">
<summary>
A member of a type definition, such as a field or a method.
This interface models the metadata representation of a type member.
</summary>
</member>
<member name="P:Microsoft.Cci.ITypeDefinitionMember.ContainingTypeDefinition">
<summary>
The type definition that contains this member.
</summary>
</member>
<member name="P:Microsoft.Cci.ITypeDefinitionMember.Visibility">
<summary>
Indicates if the member is public or confined to its containing type, derived types and/or declaring assembly.
</summary>
</member>
<member name="T:Microsoft.Cci.ITypeMemberReference">
<summary>
A reference to a member of a type, such as a field or a method.
This interface models the metadata representation of a type member reference.
</summary>
</member>
<member name="M:Microsoft.Cci.ITypeMemberReference.GetContainingType(Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
A reference to the containing type of the referenced type member.
</summary>
</member>
<member name="T:Microsoft.Cci.ISpecializedEventDefinition">
<summary>
Represents the specialized event definition.
</summary>
</member>
<member name="P:Microsoft.Cci.ISpecializedEventDefinition.UnspecializedVersion">
<summary>
The event that has been specialized to obtain this event. When the containing type is an instance of type which is itself a specialized member (i.e. it is a nested
type of a generic type instance), then the unspecialized member refers to a member from the unspecialized containing type. (I.e. the unspecialized member always
corresponds to a definition that is not obtained via specialization.)
</summary>
</member>
<member name="T:Microsoft.Cci.ISpecializedFieldReference">
<summary>
Represents reference specialized field.
</summary>
</member>
<member name="P:Microsoft.Cci.ISpecializedFieldReference.UnspecializedVersion">
<summary>
A reference to the field definition that has been specialized to obtain the field definition referred to by this field reference.
When the containing type of the referenced specialized field definition is itself a specialized nested type of a generic type instance,
then the unspecialized field reference refers to the corresponding field definition from the unspecialized containing type definition.
(I.e. the unspecialized field reference always refers to a field definition that is not obtained via specialization.)
</summary>
</member>
<member name="T:Microsoft.Cci.ISpecializedMethodReference">
<summary>
Represents reference specialized method.
</summary>
</member>
<member name="P:Microsoft.Cci.ISpecializedMethodReference.UnspecializedVersion">
<summary>
A reference to the method definition that has been specialized to obtain the method definition referred to by this method reference.
When the containing type of the referenced specialized method definition is itself a specialized nested type of a generic type instance,
then the unspecialized method reference refers to the corresponding method definition from the unspecialized containing type definition.
(I.e. the unspecialized method reference always refers to a method definition that is not obtained via specialization.)
</summary>
</member>
<member name="T:Microsoft.Cci.ISpecializedPropertyDefinition">
<summary>
Represents the specialized property definition.
</summary>
</member>
<member name="P:Microsoft.Cci.ISpecializedPropertyDefinition.UnspecializedVersion">
<summary>
The property that has been specialized to obtain this property. When the containing type is an instance of type which is itself a specialized member (i.e. it is a nested
type of a generic type instance), then the unspecialized member refers to a member from the unspecialized containing type. (I.e. the unspecialized member always
corresponds to a definition that is not obtained via specialization.)
</summary>
</member>
<member name="T:Microsoft.Cci.IMethodReference">
<summary>
A reference to a method.
</summary>
</member>
<member name="P:Microsoft.Cci.IMethodReference.AcceptsExtraArguments">
<summary>
True if the call sites that references the method with this object supply extra arguments.
</summary>
</member>
<member name="P:Microsoft.Cci.IMethodReference.GenericParameterCount">
<summary>
The number of generic parameters of the method. Zero if the referenced method is not generic.
</summary>
</member>
<member name="P:Microsoft.Cci.IMethodReference.IsGeneric">
<summary>
True if the method has generic parameters;
</summary>
</member>
<member name="M:Microsoft.Cci.IMethodReference.GetResolvedMethod(Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
The method being referred to.
</summary>
</member>
<member name="P:Microsoft.Cci.IMethodReference.ExtraParameters">
<summary>
Information about this types of the extra arguments supplied at the call sites that references the method with this object.
</summary>
</member>
<member name="T:Microsoft.Cci.IGenericMethodInstanceReference">
<summary>
A reference to generic method instantiated with a list of type arguments.
</summary>
</member>
<member name="M:Microsoft.Cci.IGenericMethodInstanceReference.GetGenericArguments(Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
The type arguments that were used to instantiate this.GenericMethod in order to create this method.
</summary>
</member>
<member name="M:Microsoft.Cci.IGenericMethodInstanceReference.GetGenericMethod(Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
Returns the generic method of which this method is an instance.
</summary>
</member>
<member name="T:Microsoft.Cci.IGlobalFieldDefinition">
<summary>
Represents a global field in symbol table.
</summary>
</member>
<member name="T:Microsoft.Cci.IGlobalMethodDefinition">
<summary>
Represents a global method in symbol table.
</summary>
</member>
<member name="P:Microsoft.Cci.IGlobalMethodDefinition.Name">
<summary>
The name of the method.
</summary>
</member>
<member name="M:Microsoft.Cci.Extensions.ShouldInclude(Microsoft.Cci.ITypeDefinitionMember,Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
When emitting ref assemblies, some members will not be included.
</summary>
</member>
<member name="T:Microsoft.Cci.MetadataVisitor">
<summary>
A visitor base class that traverses the object model in depth first, left to right order.
</summary>
</member>
<member name="M:Microsoft.Cci.MetadataVisitor.DispatchAsReference(Microsoft.Cci.ITypeReference)">
<summary>
Use this routine, rather than ITypeReference.Dispatch, to call the appropriate derived overload of an ITypeReference.
The former routine will call Visit(INamespaceTypeDefinition) rather than Visit(INamespaceTypeReference), etc.,
in the case where a definition is used as a reference to itself.
</summary>
<param name="typeReference">A reference to a type definition. Note that a type definition can serve as a reference to itself.</param>
</member>
<member name="M:Microsoft.Cci.MetadataVisitor.DispatchAsReference(Microsoft.Cci.IUnitReference)">
<summary>
Use this routine, rather than IUnitReference.Dispatch, to call the appropriate derived overload of an IUnitReference.
The former routine will call Visit(IAssembly) rather than Visit(IAssemblyReference), etc.
in the case where a definition is used as the reference to itself.
</summary>
<param name="unitReference">A reference to a unit. Note that a unit can serve as a reference to itself.</param>
</member>
<member name="F:Microsoft.Cci.MetadataWriter.NameLengthLimit">
<summary>
This is the maximum length of a type or member name in metadata, assuming
the name is in UTF-8 format and not (yet) null-terminated.
</summary>
<remarks>
Source names may have to be shorter still to accommodate mangling.
Used for event names, field names, property names, field names, method def names,
member ref names, type def (full) names, type ref (full) names, exported type
(full) names, parameter names, manifest resource names, and unmanaged method names
(ImplMap table).
See CLI Part II, section 22.
</remarks>
</member>
<member name="F:Microsoft.Cci.MetadataWriter.PathLengthLimit">
<summary>
This is the maximum length of a path in metadata, assuming the path is in UTF-8
format and not (yet) null-terminated.
</summary>
<remarks>
Used for file names, module names, and module ref names.
See CLI Part II, section 22.
</remarks>
</member>
<member name="F:Microsoft.Cci.MetadataWriter.PdbLengthLimit">
<summary>
This is the maximum length of a string in the PDB, assuming it is in UTF-8 format
and not (yet) null-terminated.
</summary>
<remarks>
Used for import strings, locals, and local constants.
</remarks>
</member>
<member name="P:Microsoft.Cci.MetadataWriter.IsFullMetadata">
<summary>
Returns true if writing full metadata, false if writing delta.
</summary>
</member>
<member name="P:Microsoft.Cci.MetadataWriter.IsMinimalDelta">
<summary>
True if writing delta metadata in a minimal format.
</summary>
</member>
<member name="P:Microsoft.Cci.MetadataWriter.EmitAssemblyDefinition">
<summary>
NetModules and EnC deltas don't have AssemblyDef record.
We don't emit it for EnC deltas since assembly identity has to be preserved across generations (CLR/debugger get confused otherwise).
</summary>
</member>
<member name="P:Microsoft.Cci.MetadataWriter.Generation">
<summary>
Returns metadata generation ordinal. Zero for
full metadata and non-zero for delta.
</summary>
</member>
<member name="P:Microsoft.Cci.MetadataWriter.EncId">
<summary>
Returns unique Guid for this delta, or default(Guid)
if full metadata.
</summary>
</member>
<member name="P:Microsoft.Cci.MetadataWriter.EncBaseId">
<summary>
Returns Guid of previous delta, or default(Guid)
if full metadata or generation 1 delta.
</summary>
</member>
<member name="M:Microsoft.Cci.MetadataWriter.TryGetTypeDefinitionHandle(Microsoft.Cci.ITypeDefinition,System.Reflection.Metadata.TypeDefinitionHandle@)">
<summary>
Returns true and full metadata handle of the type definition
if the type definition is recognized. Otherwise returns false.
</summary>
</member>
<member name="M:Microsoft.Cci.MetadataWriter.GetTypeDefinitionHandle(Microsoft.Cci.ITypeDefinition)">
<summary>
Get full metadata handle of the type definition.
</summary>
</member>
<member name="M:Microsoft.Cci.MetadataWriter.GetTypeDef(System.Reflection.Metadata.TypeDefinitionHandle)">
<summary>
The type definition corresponding to full metadata type handle.
Deltas are only required to support indexing into current generation.
</summary>
</member>
<member name="M:Microsoft.Cci.MetadataWriter.GetTypeDefs">
<summary>
The type definitions to be emitted, in row order. These
are just the type definitions from the current generation.
</summary>
</member>
<member name="M:Microsoft.Cci.MetadataWriter.GetEventDefinitionHandle(Microsoft.Cci.IEventDefinition)">
<summary>
Get full metadata handle of the event definition.
</summary>
</member>
<member name="M:Microsoft.Cci.MetadataWriter.GetEventDefs">
<summary>
The event definitions to be emitted, in row order. These
are just the event definitions from the current generation.
</summary>
</member>
<member name="M:Microsoft.Cci.MetadataWriter.GetFieldDefinitionHandle(Microsoft.Cci.IFieldDefinition)">
<summary>
Get full metadata handle of the field definition.
</summary>
</member>
<member name="M:Microsoft.Cci.MetadataWriter.GetFieldDefs">
<summary>
The field definitions to be emitted, in row order. These
are just the field definitions from the current generation.
</summary>
</member>
<member name="M:Microsoft.Cci.MetadataWriter.TryGetMethodDefinitionHandle(Microsoft.Cci.IMethodDefinition,System.Reflection.Metadata.MethodDefinitionHandle@)">
<summary>
Returns true and handle of the method definition
if the method definition is recognized. Otherwise returns false.
The index is into the full metadata.
</summary>
</member>
<member name="M:Microsoft.Cci.MetadataWriter.GetMethodDefinitionHandle(Microsoft.Cci.IMethodDefinition)">
<summary>
Get full metadata handle of the method definition.
</summary>
</member>
<member name="M:Microsoft.Cci.MetadataWriter.GetMethodDef(System.Reflection.Metadata.MethodDefinitionHandle)">
<summary>
The method definition corresponding to full metadata method handle.
Deltas are only required to support indexing into current generation.
</summary>
</member>
<member name="M:Microsoft.Cci.MetadataWriter.GetMethodDefs">
<summary>
The method definitions to be emitted, in row order. These
are just the method definitions from the current generation.
</summary>
</member>
<member name="M:Microsoft.Cci.MetadataWriter.GetPropertyDefIndex(Microsoft.Cci.IPropertyDefinition)">
<summary>
Get full metadata handle of the property definition.
</summary>
</member>
<member name="M:Microsoft.Cci.MetadataWriter.GetPropertyDefs">
<summary>
The property definitions to be emitted, in row order. These
are just the property definitions from the current generation.
</summary>
</member>
<member name="M:Microsoft.Cci.MetadataWriter.GetParameterHandle(Microsoft.Cci.IParameterDefinition)">
<summary>
The full metadata handle of the parameter definition.
</summary>
</member>
<member name="M:Microsoft.Cci.MetadataWriter.GetParameterDefs">
<summary>
The parameter definitions to be emitted, in row order. These
are just the parameter definitions from the current generation.
</summary>
</member>
<member name="M:Microsoft.Cci.MetadataWriter.GetGenericParameters">
<summary>
The generic parameter definitions to be emitted, in row order. These
are just the generic parameter definitions from the current generation.
</summary>
</member>
<member name="M:Microsoft.Cci.MetadataWriter.GetFirstFieldDefinitionHandle(Microsoft.Cci.INamedTypeDefinition)">
<summary>
The handle of the first field of the type.
</summary>
</member>
<member name="M:Microsoft.Cci.MetadataWriter.GetFirstMethodDefinitionHandle(Microsoft.Cci.INamedTypeDefinition)">
<summary>
The handle of the first method of the type.
</summary>
</member>
<member name="M:Microsoft.Cci.MetadataWriter.GetFirstParameterHandle(Microsoft.Cci.IMethodDefinition)">
<summary>
The handle of the first parameter of the method.
</summary>
</member>
<member name="M:Microsoft.Cci.MetadataWriter.GetOrAddAssemblyReferenceHandle(Microsoft.Cci.IAssemblyReference)">
<summary>
Return full metadata handle of the assembly reference, adding
the reference to the index for this generation if missing.
Deltas are not required to return rows from previous generations.
</summary>
</member>
<member name="M:Microsoft.Cci.MetadataWriter.GetAssemblyRefs">
<summary>
The assembly references to be emitted, in row order. These
are just the assembly references from the current generation.
</summary>
</member>
<member name="M:Microsoft.Cci.MetadataWriter.GetOrAddModuleReferenceHandle(System.String)">
<summary>
Return full metadata handle of the module reference, adding
the reference to the index for this generation if missing.
Deltas are not required to return rows from previous generations.
</summary>
</member>
<member name="M:Microsoft.Cci.MetadataWriter.GetModuleRefs">
<summary>
The module references to be emitted, in row order. These
are just the module references from the current generation.
</summary>
</member>
<member name="M:Microsoft.Cci.MetadataWriter.GetOrAddMemberReferenceHandle(Microsoft.Cci.ITypeMemberReference)">
<summary>
Return full metadata handle of the member reference, adding
the reference to the index for this generation if missing.
Deltas are not required to return rows from previous generations.
</summary>
</member>
<member name="M:Microsoft.Cci.MetadataWriter.GetMemberRefs">
<summary>
The member references to be emitted, in row order. These
are just the member references from the current generation.
</summary>
</member>
<member name="M:Microsoft.Cci.MetadataWriter.GetOrAddMethodSpecificationHandle(Microsoft.Cci.IGenericMethodInstanceReference)">
<summary>
Return full metadata handle of the method spec, adding
the spec to the index for this generation if missing.
Deltas are not required to return rows from previous generations.
</summary>
</member>
<member name="M:Microsoft.Cci.MetadataWriter.GetMethodSpecs">
<summary>
The method specs to be emitted, in row order. These
are just the method specs from the current generation.
</summary>
</member>
<member name="P:Microsoft.Cci.MetadataWriter.GreatestMethodDefIndex">
<summary>
The greatest index given to any method definition.
</summary>
</member>
<member name="M:Microsoft.Cci.MetadataWriter.TryGetTypeReferenceHandle(Microsoft.Cci.ITypeReference,System.Reflection.Metadata.TypeReferenceHandle@)">
<summary>
Return true and full metadata handle of the type reference
if the reference is available in the current generation.
Deltas are not required to return rows from previous generations.
</summary>
</member>
<member name="M:Microsoft.Cci.MetadataWriter.GetOrAddTypeReferenceHandle(Microsoft.Cci.ITypeReference)">
<summary>
Return full metadata handle of the type reference, adding
the reference to the index for this generation if missing.
Deltas are not required to return rows from previous generations.
</summary>
</member>
<member name="M:Microsoft.Cci.MetadataWriter.GetTypeRefs">
<summary>
The type references to be emitted, in row order. These
are just the type references from the current generation.
</summary>
</member>
<member name="M:Microsoft.Cci.MetadataWriter.GetOrAddTypeSpecificationHandle(Microsoft.Cci.ITypeReference)">
<summary>
Returns full metadata handle of the type spec, adding
the spec to the index for this generation if missing.
Deltas are not required to return rows from previous generations.
</summary>
</member>
<member name="M:Microsoft.Cci.MetadataWriter.GetTypeSpecs">
<summary>
The type specs to be emitted, in row order. These
are just the type specs from the current generation.
</summary>
</member>
<member name="M:Microsoft.Cci.MetadataWriter.GetOrAddStandaloneSignatureHandle(System.Reflection.Metadata.BlobHandle)">
<summary>
Returns full metadata handle the standalone signature, adding
the signature to the index for this generation if missing.
Deltas are not required to return rows from previous generations.
</summary>
</member>
<member name="M:Microsoft.Cci.MetadataWriter.GetStandaloneSignatureBlobHandles">
<summary>
The signature blob handles to be emitted, in row order. These
are just the signature indices from the current generation.
</summary>
</member>
<member name="M:Microsoft.Cci.MetadataWriter.CreateReferenceVisitor">
<summary>
Return a visitor for traversing all references to be emitted.
</summary>
</member>
<member name="M:Microsoft.Cci.MetadataWriter.PopulateEventMapTableRows">
<summary>
Populate EventMap table.
</summary>
</member>
<member name="M:Microsoft.Cci.MetadataWriter.PopulatePropertyMapTableRows">
<summary>
Populate PropertyMap table.
</summary>
</member>
<member name="M:Microsoft.Cci.MetadataWriter.PopulateEncLogTableRows(System.Collections.Immutable.ImmutableArray{System.Int32})">
<summary>
Populate EncLog table.
</summary>
</member>
<member name="M:Microsoft.Cci.MetadataWriter.PopulateEncMapTableRows(System.Collections.Immutable.ImmutableArray{System.Int32})">
<summary>
Populate EncMap table.
</summary>
</member>
<member name="M:Microsoft.Cci.MetadataWriter.GetDefiningUnitReference(Microsoft.Cci.ITypeReference,Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
Returns a reference to the unit that defines the given referenced type. If the referenced type is a structural type, such as a pointer or a generic type instance,
then the result is null.
</summary>
</member>
<member name="M:Microsoft.Cci.MetadataWriter.GetStringHandleForNamespaceAndCheckLength(Microsoft.Cci.INamespaceTypeReference,System.String)">
<summary>
The Microsoft CLR requires that {namespace} + "." + {name} fit in MAX_CLASS_NAME
(even though the name and namespace are stored separately in the Microsoft
implementation). Note that the namespace name of a nested type is always blank
(since comes from the container).
</summary>
<param name="namespaceType">We're trying to add the containing namespace of this type to the string heap.</param>
<param name="mangledTypeName">Namespace names are never used on their own - this is the type that is adding the namespace name.
Used only for length checking.</param>
</member>
<member name="M:Microsoft.Cci.MetadataWriter.IsTooLongInternal(System.String,System.Int32)">
<summary>
Test the given name to see if it fits in metadata.
</summary>
<param name="str">String to test (non-null).</param>
<param name="maxLength">Max length for name. (Expected to be at least 5.)</param>
<returns>True if the name is too long.</returns>
<remarks>Internal for test purposes.</remarks>
</member>
<member name="M:Microsoft.Cci.MetadataWriter.SerializeLocalVariablesSignature(Microsoft.Cci.IMethodBody)">
<summary>
Serialize the method local signature to the blob.
</summary>
<returns>Standalone signature token</returns>
</member>
<member name="M:Microsoft.Cci.MetadataWriter.StrongName(Microsoft.Cci.IAssemblyReference)">
<summary>
Computes the string representing the strong name of the given assembly reference.
</summary>
</member>
<member name="T:Microsoft.Cci.MetadataWriter.ImportScopeEqualityComparer">
<summary>
Import scopes are associated with binders (in C#) and thus multiple instances might be created for a single set of imports.
We consider scopes with the same parent and the same imports the same.
Internal for testing.
</summary>
</member>
<member name="M:Microsoft.Cci.MetadataWriter.WriteUtf8String(System.Reflection.Metadata.BlobBuilder,System.String)">
<summary>
Write string as UTF8 with null terminator.
</summary>
</member>
<member name="M:Microsoft.Cci.MetadataWriter.AddRemainingDebugDocuments(System.Collections.Generic.IReadOnlyDictionary{System.String,Microsoft.Cci.DebugSourceDocument})">
<summary>
Add document entries for all debug documents that do not yet have an entry.
</summary>
<remarks>
This is done after serializing method debug info to ensure that we embed all requested
text even if there are no corresponding sequence points.
</remarks>
</member>
<member name="F:Microsoft.Cci.MetadataWriter.CompilationOptionsSchemaVersion">
<summary>The version of the compilation options schema to be written to the PDB.</summary>
</member>
<member name="M:Microsoft.Cci.MetadataWriter.EmbedCompilationOptions(Microsoft.CodeAnalysis.Emit.CommonPEModuleBuilder)">
<summary>
Capture the set of compilation options to allow a compilation
to be reconstructed from the pdb
</summary>
</member>
<member name="M:Microsoft.Cci.MetadataWriter.EmbedMetadataReferenceInformation(Microsoft.CodeAnalysis.Emit.CommonPEModuleBuilder)">
<summary>
Writes information about metadata references to the pdb so the same
reference can be found on sourcelink to create the compilation again
</summary>
</member>
<member name="T:Microsoft.Cci.IteratorHelper">
<summary>
A container for static helper methods that are used for manipulating and computing iterators.
</summary>
</member>
<member name="M:Microsoft.Cci.IteratorHelper.EnumerableIsNotEmpty``1(System.Collections.Generic.IEnumerable{``0})">
<summary>
True if the given enumerable is not null and contains at least one element.
</summary>
</member>
<member name="M:Microsoft.Cci.IteratorHelper.EnumerableIsEmpty``1(System.Collections.Generic.IEnumerable{``0})">
<summary>
True if the given enumerable is null or contains no elements
</summary>
</member>
<member name="M:Microsoft.Cci.IteratorHelper.EnumerableCount``1(System.Collections.Generic.IEnumerable{``0})">
<summary>
Returns the number of elements in the given enumerable. A null enumerable is allowed and results in 0.
</summary>
</member>
<member name="T:Microsoft.Cci.SecurityAttribute">
<summary>
A declarative specification of a security action applied to a set of permissions. Used by the CLR loader to enforce security restrictions.
Each security attribute represents a serialized permission or permission set for a specified security action.
The union of the security attributes with identical security action, define the permission set to which the security action applies.
</summary>
</member>
<member name="T:Microsoft.Cci.IMarshallingInformation">
<summary>
Information about how values of managed types should be marshalled to and from unmanaged types.
</summary>
</member>
<member name="M:Microsoft.Cci.IMarshallingInformation.GetCustomMarshaller(Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
<see cref="T:Microsoft.Cci.ITypeReference"/> or a string (usually a fully-qualified type name of a type implementing the custom marshaller, but Dev11 allows any string).
</summary>
</member>
<member name="P:Microsoft.Cci.IMarshallingInformation.CustomMarshallerRuntimeArgument">
<summary>
An argument string (cookie) passed to the custom marshaller at run time.
</summary>
</member>
<member name="P:Microsoft.Cci.IMarshallingInformation.ElementType">
<summary>
The unmanaged element type of the unmanaged array.
-1 if it should be omitted from the marshal blob.
</summary>
</member>
<member name="P:Microsoft.Cci.IMarshallingInformation.IidParameterIndex">
<summary>
Specifies the index of the parameter that contains the value of the Interface Identifier (IID) of the marshalled object.
-1 if it should be omitted from the marshal blob.
</summary>
</member>
<member name="P:Microsoft.Cci.IMarshallingInformation.UnmanagedType">
<summary>
The unmanaged type to which the managed type will be marshalled. This can be UnmanagedType.CustomMarshaler, in which case the unmanaged type
is decided at runtime.
</summary>
</member>
<member name="P:Microsoft.Cci.IMarshallingInformation.NumberOfElements">
<summary>
The number of elements in the fixed size portion of the unmanaged array.
-1 if it should be omitted from the marshal blob.
</summary>
</member>
<member name="P:Microsoft.Cci.IMarshallingInformation.ParamIndex">
<summary>
The zero based index of the parameter in the unmanaged method that contains the number of elements in the variable portion of unmanaged array.
If -1, the variable portion is of size zero, or the caller conveys the size of the variable portion of the array to the unmanaged method in some other way.
</summary>
</member>
<member name="P:Microsoft.Cci.IMarshallingInformation.SafeArrayElementSubtype">
<summary>
The type to which the variant values of all elements of the safe array must belong. See also SafeArrayElementUserDefinedSubtype.
(The element type of a safe array is VARIANT. The "sub type" specifies the value of all of the tag fields (vt) of the element values. )
-1 if it should be omitted from the marshal blob.
</summary>
</member>
<member name="M:Microsoft.Cci.IMarshallingInformation.GetSafeArrayElementUserDefinedSubtype(Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
A reference to the user defined type to which the variant values of all elements of the safe array must belong.
(The element type of a safe array is VARIANT. The tag fields will all be either VT_DISPATCH or VT_UNKNOWN or VT_RECORD.
The "user defined sub type" specifies the type of value the ppdispVal/ppunkVal/pvRecord fields of the element values may point to.)
</summary>
</member>
<member name="T:Microsoft.Cci.INamedEntity">
<summary>
Implemented by any entity that has a name.
</summary>
</member>
<member name="P:Microsoft.Cci.INamedEntity.Name">
<summary>
The name of the entity.
</summary>
</member>
<member name="T:Microsoft.Cci.IContextualNamedEntity">
<summary>
The name of the entity depends on other metadata (tokens, signatures) originated from
PeWriter.
</summary>
</member>
<member name="M:Microsoft.Cci.IContextualNamedEntity.AssociateWithMetadataWriter(Microsoft.Cci.MetadataWriter)">
<summary>
Method must be called before calling INamedEntity.Name.
</summary>
</member>
<member name="T:Microsoft.Cci.IParameterListEntry">
<summary>
Implemented by an entity that is always a member of a particular parameter list, such as an IParameterDefinition.
Provides a way to determine the position where the entity appears in the parameter list.
</summary>
</member>
<member name="P:Microsoft.Cci.IParameterListEntry.Index">
<summary>
The position in the parameter list where this instance can be found.
</summary>
</member>
<member name="T:Microsoft.Cci.IPlatformInvokeInformation">
<summary>
Information that describes how a method from the underlying Platform is to be invoked.
</summary>
</member>
<member name="P:Microsoft.Cci.IPlatformInvokeInformation.ModuleName">
<summary>
Module providing the method/field.
</summary>
</member>
<member name="P:Microsoft.Cci.IPlatformInvokeInformation.EntryPointName">
<summary>
Name of the method providing the implementation.
</summary>
</member>
<member name="P:Microsoft.Cci.IPlatformInvokeInformation.Flags">
<summary>
Flags that determine marshalling behavior.
</summary>
</member>
<member name="T:Microsoft.Cci.IWin32Resource">
<summary>
A resource file formatted according to Win32 API conventions and typically obtained from a Portable Executable (PE) file.
See the Win32 UpdateResource method for more details.
</summary>
</member>
<member name="P:Microsoft.Cci.IWin32Resource.TypeName">
<summary>
A string that identifies what type of resource this is. Only valid if this.TypeId < 0.
</summary>
</member>
<member name="P:Microsoft.Cci.IWin32Resource.TypeId">
<summary>
An integer tag that identifies what type of resource this is. If the value is less than 0, this.TypeName should be used instead.
</summary>
</member>
<member name="P:Microsoft.Cci.IWin32Resource.Name">
<summary>
The name of the resource. Only valid if this.Id < 0.
</summary>
</member>
<member name="P:Microsoft.Cci.IWin32Resource.Id">
<summary>
An integer tag that identifies this resource. If the value is less than 0, this.Name should be used instead.
</summary>
</member>
<member name="P:Microsoft.Cci.IWin32Resource.LanguageId">
<summary>
The language for which this resource is appropriate.
</summary>
</member>
<member name="P:Microsoft.Cci.IWin32Resource.CodePage">
<summary>
The code page for which this resource is appropriate.
</summary>
</member>
<member name="P:Microsoft.Cci.IWin32Resource.Data">
<summary>
The data of the resource.
</summary>
</member>
<member name="T:Microsoft.Cci.RootModuleType">
<summary>
Special type <Module>
</summary>
</member>
<member name="T:Microsoft.Cci.SymbolEquivalentEqualityComparer">
<summary>
Allows for the comparison of two <see cref="T:Microsoft.Cci.IReference"/> instances or two <see cref="T:Microsoft.Cci.INamespace"/>
instances based on underlying symbols, if any.
</summary>
</member>
<member name="M:Microsoft.Cci.TypeNameSerializer.UnwrapTypeReference(Microsoft.Cci.ITypeReference,Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
Strip off *, &, and [].
</summary>
</member>
<member name="M:Microsoft.Cci.TypeNameSerializer.BuildQualifiedNamespaceName(Microsoft.Cci.INamespace)">
<summary>
Qualified name of namespace.
e.g. "A.B.C"
</summary>
</member>
<member name="T:Microsoft.Cci.TypeReferenceIndexer">
<summary>
Visitor to force translation of all symbols that will be referred to
in metadata. Allows us to build the set of types that must be embedded
as local types (for NoPia).
</summary>
</member>
<member name="T:Microsoft.Cci.IArrayTypeReference">
<summary>
This interface models the metadata representation of an array type reference.
</summary>
</member>
<member name="M:Microsoft.Cci.IArrayTypeReference.GetElementType(Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
The type of the elements of this array.
</summary>
</member>
<member name="P:Microsoft.Cci.IArrayTypeReference.IsSZArray">
<summary>
This type of array is a single dimensional array with zero lower bound for index values.
</summary>
</member>
<member name="P:Microsoft.Cci.IArrayTypeReference.LowerBounds">
<summary>
A possibly empty list of lower bounds for dimension indices. When not explicitly specified, a lower bound defaults to zero.
The first lower bound in the list corresponds to the first dimension. Dimensions cannot be skipped.
</summary>
</member>
<member name="P:Microsoft.Cci.IArrayTypeReference.Rank">
<summary>
The number of array dimensions.
</summary>
</member>
<member name="P:Microsoft.Cci.IArrayTypeReference.Sizes">
<summary>
A possible empty list of upper bounds for dimension indices.
The first upper bound in the list corresponds to the first dimension. Dimensions cannot be skipped.
An unspecified upper bound means that instances of this type can have an arbitrary upper bound for that dimension.
</summary>
</member>
<member name="T:Microsoft.Cci.ICustomModifier">
<summary>
Modifies the set of allowed values for a type, or the semantics of operations allowed on those values.
Custom modifiers are not associated directly with types, but rather with typed storage locations for values.
</summary>
</member>
<member name="P:Microsoft.Cci.ICustomModifier.IsOptional">
<summary>
If true, a language may use the modified storage location without being aware of the meaning of the modification.
</summary>
</member>
<member name="M:Microsoft.Cci.ICustomModifier.GetModifier(Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
A type used as a tag that indicates which type of modification applies to the storage location.
</summary>
</member>
<member name="T:Microsoft.Cci.IParameterTypeInformation">
<summary>
Information that describes a method or property parameter, but does not include all the information in a IParameterDefinition.
</summary>
</member>
<member name="P:Microsoft.Cci.IParameterTypeInformation.CustomModifiers">
<summary>
The list of custom modifiers, if any, associated with the parameter type.
</summary>
</member>
<member name="P:Microsoft.Cci.IParameterTypeInformation.RefCustomModifiers">
<summary>
The list of custom modifiers, if any, associated with the ref modifier.
</summary>
</member>
<member name="P:Microsoft.Cci.IParameterTypeInformation.IsByReference">
<summary>
True if the parameter is passed by reference (using a managed pointer).
</summary>
</member>
<member name="M:Microsoft.Cci.IParameterTypeInformation.GetType(Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
The type of argument value that corresponds to this parameter.
</summary>
</member>
<member name="T:Microsoft.Cci.IGenericParameter">
<summary>
The definition of a type parameter of a generic type or method.
</summary>
</member>
<member name="M:Microsoft.Cci.IGenericParameter.GetConstraints(Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
A list of classes or interfaces. All type arguments matching this parameter must be derived from all of the classes and implement all of the interfaces.
</summary>
</member>
<member name="P:Microsoft.Cci.IGenericParameter.MustBeReferenceType">
<summary>
True if all type arguments matching this parameter are constrained to be reference types.
</summary>
</member>
<member name="P:Microsoft.Cci.IGenericParameter.MustBeValueType">
<summary>
True if all type arguments matching this parameter are constrained to be value types.
</summary>
</member>
<member name="P:Microsoft.Cci.IGenericParameter.MustHaveDefaultConstructor">
<summary>
True if all type arguments matching this parameter are constrained to be value types or concrete classes with visible default constructors.
</summary>
</member>
<member name="P:Microsoft.Cci.IGenericParameter.Variance">
<summary>
Indicates if the generic type or method with this type parameter is co-, contra-, or non variant with respect to this type parameter.
</summary>
</member>
<member name="T:Microsoft.Cci.IGenericParameterReference">
<summary>
A reference to the definition of a type parameter of a generic type or method.
</summary>
</member>
<member name="T:Microsoft.Cci.IGenericMethodParameter">
<summary>
The definition of a type parameter of a generic method.
</summary>
</member>
<member name="P:Microsoft.Cci.IGenericMethodParameter.DefiningMethod">
<summary>
The generic method that defines this type parameter.
</summary>
</member>
<member name="T:Microsoft.Cci.IGenericMethodParameterReference">
<summary>
A reference to a type parameter of a generic method.
</summary>
</member>
<member name="P:Microsoft.Cci.IGenericMethodParameterReference.DefiningMethod">
<summary>
A reference to the generic method that defines the referenced type parameter.
</summary>
</member>
<member name="T:Microsoft.Cci.IGenericTypeInstanceReference">
<summary>
A generic type instantiated with a list of type arguments
</summary>
</member>
<member name="M:Microsoft.Cci.IGenericTypeInstanceReference.GetGenericArguments(Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
The type arguments that were used to instantiate this.GenericType in order to create this type.
</summary>
</member>
<member name="M:Microsoft.Cci.IGenericTypeInstanceReference.GetGenericType(Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
Returns the generic type of which this type is an instance.
Equivalent to Symbol.OriginalDefinition
</summary>
</member>
<member name="T:Microsoft.Cci.IGenericTypeParameter">
<summary>
The definition of a type parameter of a generic type.
</summary>
</member>
<member name="P:Microsoft.Cci.IGenericTypeParameter.DefiningType">
<summary>
The generic type that defines this type parameter.
</summary>
</member>
<member name="T:Microsoft.Cci.IGenericTypeParameterReference">
<summary>
A reference to a type parameter of a generic type.
</summary>
</member>
<member name="P:Microsoft.Cci.IGenericTypeParameterReference.DefiningType">
<summary>
A reference to the generic type that defines the referenced type parameter.
</summary>
</member>
<member name="T:Microsoft.Cci.INamedTypeReference">
<summary>
A reference to a named type, such as an INamespaceTypeReference or an INestedTypeReference.
</summary>
</member>
<member name="P:Microsoft.Cci.INamedTypeReference.GenericParameterCount">
<summary>
The number of generic parameters. Zero if the type is not generic.
</summary>
</member>
<member name="P:Microsoft.Cci.INamedTypeReference.MangleName">
<summary>
If true, the persisted type name is mangled by appending "`n" where n is the number of type parameters, if the number of type parameters is greater than 0.
</summary>
</member>
<member name="T:Microsoft.Cci.INamedTypeDefinition">
<summary>
A named type definition, such as an INamespaceTypeDefinition or an INestedTypeDefinition.
</summary>
</member>
<member name="T:Microsoft.Cci.INamespaceTypeDefinition">
<summary>
A type definition that is a member of a namespace definition.
</summary>
</member>
<member name="P:Microsoft.Cci.INamespaceTypeDefinition.IsPublic">
<summary>
True if the type can be accessed from other assemblies.
</summary>
</member>
<member name="T:Microsoft.Cci.INamespace">
<summary>
Represents a namespace.
</summary>
</member>
<member name="P:Microsoft.Cci.INamespace.ContainingNamespace">
<summary>
Containing namespace or null if this namespace is global.
</summary>
</member>
<member name="M:Microsoft.Cci.INamespace.GetInternalSymbol">
<summary>
Returns underlying internal symbol object, if any.
</summary>
</member>
<member name="T:Microsoft.Cci.INamespaceTypeReference">
<summary>
A reference to a type definition that is a member of a namespace definition.
</summary>
</member>
<member name="M:Microsoft.Cci.INamespaceTypeReference.GetUnit(Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
A reference to the unit that defines the referenced type.
</summary>
</member>
<member name="P:Microsoft.Cci.INamespaceTypeReference.NamespaceName">
<summary>
Fully qualified name of the containing namespace.
</summary>
</member>
<member name="T:Microsoft.Cci.INestedTypeDefinition">
<summary>
A type definition that is a member of another type definition.
</summary>
</member>
<member name="T:Microsoft.Cci.INestedTypeReference">
<summary>
A type definition that is a member of another type definition.
</summary>
</member>
<member name="T:Microsoft.Cci.ISpecializedNestedTypeReference">
<summary>
A reference to a type definition that is a specialized nested type.
</summary>
</member>
<member name="M:Microsoft.Cci.ISpecializedNestedTypeReference.GetUnspecializedVersion(Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
A reference to the nested type that has been specialized to obtain this nested type reference. When the containing type is an instance of type which is itself a specialized member (i.e. it is a nested
type of a generic type instance), then the unspecialized member refers to a member from the unspecialized containing type. (I.e. the unspecialized member always
corresponds to a definition that is not obtained via specialization.)
</summary>
</member>
<member name="T:Microsoft.Cci.MethodImplementation">
<summary>
Models an explicit implementation or override of a base class virtual method or an explicit implementation of an interface method.
</summary>
</member>
<member name="F:Microsoft.Cci.MethodImplementation.ImplementingMethod">
<summary>
The type that is explicitly implementing or overriding the base class virtual method or explicitly implementing an interface method.
</summary>
</member>
<member name="F:Microsoft.Cci.MethodImplementation.ImplementedMethod">
<summary>
A reference to the method that provides the implementation.
</summary>
</member>
<member name="P:Microsoft.Cci.MethodImplementation.ContainingType">
<summary>
The type that is explicitly implementing or overriding the base class virtual method or explicitly implementing an interface method.
</summary>
</member>
<member name="T:Microsoft.Cci.IModifiedTypeReference">
<summary>
A type reference that has custom modifiers associated with it. For example a reference to the target type of a managed pointer to a constant.
</summary>
</member>
<member name="P:Microsoft.Cci.IModifiedTypeReference.CustomModifiers">
<summary>
Returns the list of custom modifiers associated with the type reference.
</summary>
</member>
<member name="P:Microsoft.Cci.IModifiedTypeReference.UnmodifiedType">
<summary>
An unmodified type reference.
</summary>
</member>
<member name="T:Microsoft.Cci.IPointerTypeReference">
<summary>
This interface models the metadata representation of a pointer to a location in unmanaged memory.
</summary>
</member>
<member name="M:Microsoft.Cci.IPointerTypeReference.GetTargetType(Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
The type of value stored at the target memory location.
</summary>
</member>
<member name="T:Microsoft.Cci.IFunctionPointerTypeReference">
<summary>
This interface models the metadata representation of a pointer to a function in unmanaged memory.
</summary>
</member>
<member name="P:Microsoft.Cci.IFunctionPointerTypeReference.Signature">
<summary>
The signature of the function located at the target memory address.
</summary>
</member>
<member name="T:Microsoft.Cci.TypeReferenceWithAttributes">
<summary>
A type ref with attributes attached directly to the type reference
itself. Unlike <see cref="M:Microsoft.Cci.IReference.GetAttributes(Microsoft.CodeAnalysis.Emit.EmitContext)"/> a
<see cref="T:Microsoft.Cci.TypeReferenceWithAttributes"/> will never provide attributes
for the "pointed at" declaration, and all attributes will be emitted
directly on the type ref, rather than the declaration.
</summary>
</member>
<member name="P:Microsoft.Cci.TypeReferenceWithAttributes.TypeRef">
<summary>
The type reference.
</summary>
</member>
<member name="P:Microsoft.Cci.TypeReferenceWithAttributes.Attributes">
<summary>
The attributes on the type reference itself.
</summary>
</member>
<member name="T:Microsoft.Cci.ITypeDefinition">
<summary>
This interface models the metadata representation of a type.
</summary>
</member>
<member name="P:Microsoft.Cci.ITypeDefinition.Alignment">
<summary>
The byte alignment that values of the given type ought to have. Must be a power of 2. If zero, the alignment is decided at runtime.
</summary>
</member>
<member name="M:Microsoft.Cci.ITypeDefinition.GetBaseClass(Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
Returns null for interfaces and System.Object.
</summary>
</member>
<member name="M:Microsoft.Cci.ITypeDefinition.GetEvents(Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
Zero or more events defined by this type.
</summary>
</member>
<member name="M:Microsoft.Cci.ITypeDefinition.GetExplicitImplementationOverrides(Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
Zero or more implementation overrides provided by the class.
</summary>
</member>
<member name="M:Microsoft.Cci.ITypeDefinition.GetFields(Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
Zero or more fields defined by this type.
</summary>
</member>
<member name="P:Microsoft.Cci.ITypeDefinition.GenericParameters">
<summary>
Zero or more parameters that can be used as type annotations.
</summary>
</member>
<member name="P:Microsoft.Cci.ITypeDefinition.GenericParameterCount">
<summary>
The number of generic parameters. Zero if the type is not generic.
</summary>
</member>
<member name="P:Microsoft.Cci.ITypeDefinition.HasDeclarativeSecurity">
<summary>
True if this type has a non empty collection of SecurityAttributes or the System.Security.SuppressUnmanagedCodeSecurityAttribute.
</summary>
</member>
<member name="M:Microsoft.Cci.ITypeDefinition.Interfaces(Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
Zero or more interfaces implemented by this type.
</summary>
</member>
<member name="P:Microsoft.Cci.ITypeDefinition.IsAbstract">
<summary>
True if the type may not be instantiated.
</summary>
</member>
<member name="P:Microsoft.Cci.ITypeDefinition.IsBeforeFieldInit">
<summary>
Is type initialized anytime before first access to static field
</summary>
</member>
<member name="P:Microsoft.Cci.ITypeDefinition.IsComObject">
<summary>
Is this imported from COM type library
</summary>
</member>
<member name="P:Microsoft.Cci.ITypeDefinition.IsGeneric">
<summary>
True if this type is parameterized (this.GenericParameters is a non empty collection).
</summary>
</member>
<member name="P:Microsoft.Cci.ITypeDefinition.IsInterface">
<summary>
True if the type is an interface.
</summary>
</member>
<member name="P:Microsoft.Cci.ITypeDefinition.IsDelegate">
<summary>
True if the type is a delegate.
</summary>
</member>
<member name="P:Microsoft.Cci.ITypeDefinition.IsRuntimeSpecial">
<summary>
True if this type gets special treatment from the runtime.
</summary>
</member>
<member name="P:Microsoft.Cci.ITypeDefinition.IsSerializable">
<summary>
True if this type is serializable.
</summary>
</member>
<member name="P:Microsoft.Cci.ITypeDefinition.IsSpecialName">
<summary>
True if the type has special name.
</summary>
</member>
<member name="P:Microsoft.Cci.ITypeDefinition.IsWindowsRuntimeImport">
<summary>
True if the type is a Windows runtime type.
</summary>
<remarks>
A type can me marked as a Windows runtime type in source by applying the WindowsRuntimeImportAttribute.
WindowsRuntimeImportAttribute is a pseudo custom attribute defined as an internal class in System.Runtime.InteropServices.WindowsRuntime namespace.
This is needed to mark Windows runtime types which are redefined in mscorlib.dll and System.Runtime.WindowsRuntime.dll.
These two assemblies are special as they implement the CLR's support for WinRT.
</remarks>
</member>
<member name="P:Microsoft.Cci.ITypeDefinition.IsSealed">
<summary>
True if the type may not be subtyped.
</summary>
</member>
<member name="P:Microsoft.Cci.ITypeDefinition.Layout">
<summary>
Layout of the type.
</summary>
</member>
<member name="M:Microsoft.Cci.ITypeDefinition.GetMethods(Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
Zero or more methods defined by this type.
</summary>
</member>
<member name="M:Microsoft.Cci.ITypeDefinition.GetNestedTypes(Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
Zero or more nested types defined by this type.
</summary>
</member>
<member name="M:Microsoft.Cci.ITypeDefinition.GetProperties(Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
Zero or more properties defined by this type.
</summary>
</member>
<member name="P:Microsoft.Cci.ITypeDefinition.SecurityAttributes">
<summary>
Declarative security actions for this type. Will be empty if this.HasSecurity is false.
</summary>
</member>
<member name="P:Microsoft.Cci.ITypeDefinition.SizeOf">
<summary>
Size of an object of this type. In bytes. If zero, the size is unspecified and will be determined at runtime.
</summary>
</member>
<member name="P:Microsoft.Cci.ITypeDefinition.StringFormat">
<summary>
Default marshalling of the Strings in this class.
</summary>
</member>
<member name="T:Microsoft.Cci.ITypeReference">
<summary>
A reference to a type.
</summary>
</member>
<member name="P:Microsoft.Cci.ITypeReference.IsEnum">
<summary>
True if the type is an enumeration (it extends System.Enum and is sealed). Corresponds to C# enum.
</summary>
</member>
<member name="P:Microsoft.Cci.ITypeReference.IsValueType">
<summary>
True if the type is a value type.
Value types are sealed and extend System.ValueType or System.Enum.
A type parameter for which MustBeValueType (the struct constraint in C#) is true also returns true for this property.
</summary>
</member>
<member name="M:Microsoft.Cci.ITypeReference.GetResolvedType(Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
The type definition being referred to.
</summary>
</member>
<member name="P:Microsoft.Cci.ITypeReference.TypeCode">
<summary>
Unless the value of TypeCode is PrimitiveTypeCode.NotPrimitive, the type corresponds to a "primitive" CLR type (such as System.Int32) and
the type code identifies which of the primitive types it corresponds to.
</summary>
</member>
<member name="P:Microsoft.Cci.ITypeReference.TypeDef">
<summary>
TypeDefs defined in modules linked to the assembly being emitted are listed in the ExportedTypes table.
</summary>
</member>
<member name="T:Microsoft.Cci.PrimitiveTypeCode">
<summary>
A enumeration of all of the value types that are built into the Runtime (and thus have specialized IL instructions that manipulate them).
</summary>
</member>
<member name="F:Microsoft.Cci.PrimitiveTypeCode.Boolean">
<summary>
A single bit.
</summary>
</member>
<member name="F:Microsoft.Cci.PrimitiveTypeCode.Char">
<summary>
An unsigned 16 bit integer representing a Unicode UTF16 code point.
</summary>
</member>
<member name="F:Microsoft.Cci.PrimitiveTypeCode.Int8">
<summary>
A signed 8 bit integer.
</summary>
</member>
<member name="F:Microsoft.Cci.PrimitiveTypeCode.Float32">
<summary>
A 32 bit IEEE floating point number.
</summary>
</member>
<member name="F:Microsoft.Cci.PrimitiveTypeCode.Float64">
<summary>
A 64 bit IEEE floating point number.
</summary>
</member>
<member name="F:Microsoft.Cci.PrimitiveTypeCode.Int16">
<summary>
A signed 16 bit integer.
</summary>
</member>
<member name="F:Microsoft.Cci.PrimitiveTypeCode.Int32">
<summary>
A signed 32 bit integer.
</summary>
</member>
<member name="F:Microsoft.Cci.PrimitiveTypeCode.Int64">
<summary>
A signed 64 bit integer.
</summary>
</member>
<member name="F:Microsoft.Cci.PrimitiveTypeCode.IntPtr">
<summary>
A signed 32 bit integer or 64 bit integer, depending on the native word size of the underlying processor.
</summary>
</member>
<member name="F:Microsoft.Cci.PrimitiveTypeCode.Pointer">
<summary>
A pointer to fixed or unmanaged memory.
</summary>
</member>
<member name="F:Microsoft.Cci.PrimitiveTypeCode.Reference">
<summary>
A reference to managed memory.
</summary>
</member>
<member name="F:Microsoft.Cci.PrimitiveTypeCode.String">
<summary>
A string.
</summary>
</member>
<member name="F:Microsoft.Cci.PrimitiveTypeCode.UInt8">
<summary>
An unsigned 8 bit integer.
</summary>
</member>
<member name="F:Microsoft.Cci.PrimitiveTypeCode.UInt16">
<summary>
An unsigned 16 bit integer.
</summary>
</member>
<member name="F:Microsoft.Cci.PrimitiveTypeCode.UInt32">
<summary>
An unsigned 32 bit integer.
</summary>
</member>
<member name="F:Microsoft.Cci.PrimitiveTypeCode.UInt64">
<summary>
An unsigned 64 bit integer.
</summary>
</member>
<member name="F:Microsoft.Cci.PrimitiveTypeCode.UIntPtr">
<summary>
An unsigned 32 bit integer or 64 bit integer, depending on the native word size of the underlying processor.
</summary>
</member>
<member name="F:Microsoft.Cci.PrimitiveTypeCode.Void">
<summary>
A type that denotes the absence of a value.
</summary>
</member>
<member name="F:Microsoft.Cci.PrimitiveTypeCode.NotPrimitive">
<summary>
Not a primitive type.
</summary>
</member>
<member name="F:Microsoft.Cci.PrimitiveTypeCode.FunctionPointer">
<summary>
A pointer to a function in fixed or managed memory.
</summary>
</member>
<member name="F:Microsoft.Cci.PrimitiveTypeCode.Invalid">
<summary>
Type is a dummy type.
</summary>
</member>
<member name="T:Microsoft.Cci.TypeMemberVisibility">
<summary>
Enumerates the different kinds of levels of visibility a type member can have.
</summary>
</member>
<member name="F:Microsoft.Cci.TypeMemberVisibility.Private">
<summary>
The member is visible only within its own type.
</summary>
</member>
<member name="F:Microsoft.Cci.TypeMemberVisibility.FamilyAndAssembly">
<summary>
The member is visible only within the intersection of its family (its own type and any subtypes) and assembly.
</summary>
</member>
<member name="F:Microsoft.Cci.TypeMemberVisibility.Assembly">
<summary>
The member is visible only within its own assembly.
</summary>
</member>
<member name="F:Microsoft.Cci.TypeMemberVisibility.Family">
<summary>
The member is visible only within its own type and any subtypes.
</summary>
</member>
<member name="F:Microsoft.Cci.TypeMemberVisibility.FamilyOrAssembly">
<summary>
The member is visible only within the union of its family and assembly.
</summary>
</member>
<member name="F:Microsoft.Cci.TypeMemberVisibility.Public">
<summary>
The member is visible everywhere its declaring type is visible.
</summary>
</member>
<member name="T:Microsoft.Cci.TypeParameterVariance">
<summary>
Enumerates the different kinds of variance a generic method or generic type parameter may have.
</summary>
</member>
<member name="F:Microsoft.Cci.TypeParameterVariance.NonVariant">
<summary>
Two type or method instances are compatible only if they have exactly the same type argument for this parameter.
</summary>
</member>
<member name="F:Microsoft.Cci.TypeParameterVariance.Covariant">
<summary>
A type or method instance will match another instance if it has a type for this parameter that is the same or a subtype of the type the
other instance has for this parameter.
</summary>
</member>
<member name="F:Microsoft.Cci.TypeParameterVariance.Contravariant">
<summary>
A type or method instance will match another instance if it has a type for this parameter that is the same or a supertype of the type the
other instance has for this parameter.
</summary>
</member>
<member name="T:Microsoft.Cci.IAssemblyReference">
<summary>
A reference to a .NET assembly.
</summary>
</member>
<member name="T:Microsoft.Cci.IModuleReference">
<summary>
A reference to a .NET module.
</summary>
</member>
<member name="M:Microsoft.Cci.IModuleReference.GetContainingAssembly(Microsoft.CodeAnalysis.Emit.EmitContext)">
<summary>
The Assembly that contains this module. May be null if the module is not part of an assembly.
</summary>
</member>
<member name="T:Microsoft.Cci.IUnit">
<summary>
A unit of metadata stored as a single artifact and potentially produced and revised independently from other units.
Examples of units include .NET assemblies and modules, as well C++ object files and compiled headers.
</summary>
</member>
<member name="T:Microsoft.Cci.IUnitReference">
<summary>
A reference to a instance of <see cref="T:Microsoft.Cci.IUnit"/>.
</summary>
</member>
<member name="T:Microsoft.Cci.UsedNamespaceOrType">
<summary>
Represents a single using directive (Imports clause).
</summary>
</member>
<member name="M:Roslyn.Utilities.AssemblyUtilities.FindAssemblySet(System.String)">
<summary>
Given a path to an assembly, identifies files in the same directory
that could satisfy the assembly's dependencies. May throw.
</summary>
<remarks>
Dependencies are identified by simply checking the name of an assembly
reference against a file name; if they match the file is considered a
dependency. Other factors, such as version, culture, public key, etc.,
are not considered, and so the returned collection may include items that
cannot in fact satisfy the original assembly's dependencies.
</remarks>
<exception cref="T:System.IO.IOException">If the file at <paramref name="filePath"/> does not exist or cannot be accessed.</exception>
<exception cref="T:System.BadImageFormatException">If the file is not an assembly or is somehow corrupted.</exception>
</member>
<member name="M:Roslyn.Utilities.AssemblyUtilities.ReadMvid(System.String)">
<summary>
Given a path to an assembly, returns its MVID (Module Version ID).
May throw.
</summary>
<exception cref="T:System.IO.IOException">If the file at <paramref name="filePath"/> does not exist or cannot be accessed.</exception>
<exception cref="T:System.BadImageFormatException">If the file is not an assembly or is somehow corrupted.</exception>
</member>
<member name="M:Roslyn.Utilities.AssemblyUtilities.FindSatelliteAssemblies(System.String)">
<summary>
Given a path to an assembly, finds the paths to all of its satellite
assemblies.
</summary>
<exception cref="T:System.IO.IOException">If the file at <paramref name="filePath"/> does not exist or cannot be accessed.</exception>
<exception cref="T:System.BadImageFormatException">If the file is not an assembly or is somehow corrupted.</exception>
</member>
<member name="M:Roslyn.Utilities.AssemblyUtilities.IdentifyMissingDependencies(System.String,System.Collections.Generic.IEnumerable{System.String})">
<summary>
Given a path to an assembly and a set of paths to possible dependencies,
identifies which of the assembly's references are missing. May throw.
</summary>
<exception cref="T:System.IO.IOException">If the files does not exist or cannot be accessed.</exception>
<exception cref="T:System.BadImageFormatException">If one of the files is not an assembly or is somehow corrupted.</exception>
</member>
<member name="M:Roslyn.Utilities.AssemblyUtilities.GetAssemblyIdentity(System.String)">
<summary>
Given a path to an assembly, returns the <see cref="T:Microsoft.CodeAnalysis.AssemblyIdentity"/> for the assembly.
May throw.
</summary>
<exception cref="T:System.IO.IOException">If the file at <paramref name="assemblyPath"/> does not exist or cannot be accessed.</exception>
<exception cref="T:System.BadImageFormatException">If the file is not an assembly or is somehow corrupted.</exception>
</member>
<member name="F:Roslyn.Utilities.FileKey.FullPath">
<summary>
Full case-insensitive path.
</summary>
</member>
<member name="F:Roslyn.Utilities.FileKey.Timestamp">
<summary>
Last write time (UTC).
</summary>
</member>
<member name="M:Roslyn.Utilities.FileKey.#ctor(System.String,System.DateTime)">
<summary>
Constructor.
</summary>
<param name="fullPath">Full path.</param>
<param name="timestamp">Last write time (UTC).</param>
</member>
<member name="M:Roslyn.Utilities.FileKey.Create(System.String)">
<exception cref="T:System.IO.IOException"/>
</member>
<member name="M:Roslyn.Utilities.FileUtilities.ResolveRelativePath(System.String,System.String,System.String,System.Collections.Generic.IEnumerable{System.String},System.Func{System.String,System.Boolean})">
<summary>
Resolves relative path and returns absolute path.
The method depends only on values of its parameters and their implementation (for fileExists).
It doesn't itself depend on the state of the current process (namely on the current drive directories) or
the state of file system.
</summary>
<param name="path">
Path to resolve.
</param>
<param name="basePath">
Base file path to resolve CWD-relative paths against. Null if not available.
</param>
<param name="baseDirectory">
Base directory to resolve CWD-relative paths against if <paramref name="basePath"/> isn't specified.
Must be absolute path.
Null if not available.
</param>
<param name="searchPaths">
Sequence of paths used to search for unqualified relative paths.
</param>
<param name="fileExists">
Method that tests existence of a file.
</param>
<returns>
The resolved path or null if the path can't be resolved or does not exist.
</returns>
</member>
<member name="M:Roslyn.Utilities.FileUtilities.NormalizeAbsolutePath(System.String)">
<summary>
Normalizes an absolute path.
</summary>
<param name="path">Path to normalize.</param>
<exception cref="T:System.IO.IOException"/>
<returns>Normalized path.</returns>
</member>
<member name="M:Roslyn.Utilities.FileUtilities.CreateFileStreamChecked(System.Func{System.String,System.IO.Stream},System.String,System.String)">
<summary>
Used to create a file given a path specified by the user.
paramName - Provided by the Public surface APIs to have a clearer message. Internal API just rethrow the exception
</summary>
</member>
<member name="M:Roslyn.Utilities.FileUtilities.GetFileTimeStamp(System.String)">
<exception cref="T:System.IO.IOException"/>
</member>
<member name="M:Roslyn.Utilities.FileUtilities.GetFileLength(System.String)">
<exception cref="T:System.IO.IOException"/>
</member>
<member name="F:Roslyn.Utilities.PathKind.Empty">
<summary>
Null or empty.
</summary>
</member>
<member name="F:Roslyn.Utilities.PathKind.Relative">
<summary>
"file"
</summary>
</member>
<member name="F:Roslyn.Utilities.PathKind.RelativeToCurrentDirectory">
<summary>
".\file"
</summary>
</member>
<member name="F:Roslyn.Utilities.PathKind.RelativeToCurrentParent">
<summary>
"..\file"
</summary>
</member>
<member name="F:Roslyn.Utilities.PathKind.RelativeToCurrentRoot">
<summary>
"\dir\file"
</summary>
</member>
<member name="F:Roslyn.Utilities.PathKind.RelativeToDriveDirectory">
<summary>
"C:dir\file"
</summary>
</member>
<member name="F:Roslyn.Utilities.PathKind.Absolute">
<summary>
"C:\file" or "\\machine" (UNC).
</summary>
</member>
<member name="M:Roslyn.Utilities.PathUtilities.IsDirectorySeparator(System.Char)">
<summary>
True if the character is the platform directory separator character or the alternate directory separator.
</summary>
</member>
<member name="M:Roslyn.Utilities.PathUtilities.IsAnyDirectorySeparator(System.Char)">
<summary>
True if the character is any recognized directory separator character.
</summary>
</member>
<member name="M:Roslyn.Utilities.PathUtilities.TrimTrailingSeparators(System.String)">
<summary>
Removes trailing directory separator characters
</summary>
<remarks>
This will trim the root directory separator:
"C:\" maps to "C:", and "/" maps to ""
</remarks>
</member>
<member name="M:Roslyn.Utilities.PathUtilities.EnsureTrailingSeparator(System.String)">
<summary>
Ensures a trailing directory separator character
</summary>
</member>
<member name="M:Roslyn.Utilities.PathUtilities.GetDirectoryName(System.String)">
<summary>
Get directory name from path.
</summary>
<remarks>
Unlike <see cref="M:System.IO.Path.GetDirectoryName(System.String)"/> it doesn't check for invalid path characters
</remarks>
<returns>Prefix of path that represents a directory</returns>
</member>
<member name="M:Roslyn.Utilities.PathUtilities.GetPathRoot(System.String)">
<summary>
Gets the root part of the path.
</summary>
</member>
<member name="M:Roslyn.Utilities.PathUtilities.GetPathKind(System.String)">
<summary>
Gets the specific kind of relative or absolute path.
</summary>
</member>
<member name="M:Roslyn.Utilities.PathUtilities.IsAbsolute(System.String)">
<summary>
True if the path is an absolute path (rooted to drive or network share)
</summary>
</member>
<member name="M:Roslyn.Utilities.PathUtilities.IsDriveRootedAbsolutePath(System.String)">
<summary>
Returns true if given path is absolute and starts with a drive specification ("C:\").
</summary>
</member>
<member name="M:Roslyn.Utilities.PathUtilities.CombineAbsoluteAndRelativePaths(System.String,System.String)">
<summary>
Combines an absolute path with a relative.
</summary>
<param name="root">Absolute root path.</param>
<param name="relativePath">Relative path.</param>
<returns>
An absolute combined path, or null if <paramref name="relativePath"/> is
absolute (e.g. "C:\abc", "\\machine\share\abc"),
relative to the current root (e.g. "\abc"),
or relative to a drive directory (e.g. "C:abc\def").
</returns>
<seealso cref="M:Roslyn.Utilities.PathUtilities.CombinePossiblyRelativeAndRelativePaths(System.String,System.String)"/>
</member>
<member name="M:Roslyn.Utilities.PathUtilities.CombinePossiblyRelativeAndRelativePaths(System.String,System.String)">
<summary>
Combine two paths, the first of which may be absolute.
</summary>
<param name="root">First path: absolute, relative, or null.</param>
<param name="relativePath">Second path: relative and non-null.</param>
<returns>null, if <paramref name="root"/> is null; a combined path, otherwise.</returns>
<seealso cref="M:Roslyn.Utilities.PathUtilities.CombineAbsoluteAndRelativePaths(System.String,System.String)"/>
</member>
<member name="M:Roslyn.Utilities.PathUtilities.IsFilePath(System.String)">
<summary>
Determines whether an assembly reference is considered an assembly file path or an assembly name.
used, for example, on values of /r and #r.
</summary>
</member>
<member name="M:Roslyn.Utilities.PathUtilities.ContainsPathComponent(System.String,System.String,System.Boolean)">
<summary>
Determines if "path" contains 'component' within itself.
i.e. asking if the path "c:\goo\bar\baz" has component "bar" would return 'true'.
On the other hand, if you had "c:\goo\bar1\baz" then it would not have "bar" as a
component.
A path contains a component if any file name or directory name in the path
matches 'component'. As such, if you had something like "\\goo" then that would
not have "goo" as a component. That's because here "goo" is the server name portion
of the UNC path, and not an actual directory or file name.
</summary>
</member>
<member name="M:Roslyn.Utilities.PathUtilities.GetRelativePath(System.String,System.String)">
<summary>
Gets a path relative to a directory.
</summary>
</member>
<member name="M:Roslyn.Utilities.PathUtilities.IsChildPath(System.String,System.String)">
<summary>
True if the child path is a child of the parent path.
</summary>
</member>
<member name="M:Roslyn.Utilities.PathUtilities.PathsEqual(System.String,System.String)">
<summary>
True if the two paths are the same.
</summary>
</member>
<member name="M:Roslyn.Utilities.PathUtilities.PathsEqual(System.String,System.String,System.Int32)">
<summary>
True if the two paths are the same. (but only up to the specified length)
</summary>
</member>
<member name="M:Roslyn.Utilities.PathUtilities.IsValidFilePath(System.String)">
<summary>
Unfortunately, we cannot depend on Path.GetInvalidPathChars() or Path.GetInvalidFileNameChars()
From MSDN: The array returned from this method is not guaranteed to contain the complete set of characters
that are invalid in file and directory names. The full set of invalid characters can vary by file system.
https://msdn.microsoft.com/en-us/library/system.io.path.getinvalidfilenamechars.aspx
Additionally, Path.GetInvalidPathChars() doesn't include "?" or "*" which are invalid characters,
and Path.GetInvalidFileNameChars() includes ":" and "\" which are valid characters.
The more accurate way is to let the framework parse the path and throw on any errors.
</summary>
</member>
<member name="M:Roslyn.Utilities.PathUtilities.NormalizeWithForwardSlash(System.String)">
<summary>
If the current environment uses the '\' directory separator, replaces all uses of '\'
in the given string with '/'. Otherwise, returns the string.
</summary>
<remarks>
This method is equivalent to Microsoft.CodeAnalysis.BuildTasks.GenerateMSBuildEditorConfig.NormalizeWithForwardSlash
Both methods should be kept in sync.
</remarks>
</member>
<member name="M:Roslyn.Utilities.ArrayExtensions.BinarySearchUpperBound(System.Int32[],System.Int32)">
<summary>
Search a sorted integer array for the target value in O(log N) time.
</summary>
<param name="array">The array of integers which must be sorted in ascending order.</param>
<param name="value">The target value.</param>
<returns>An index in the array pointing to the position where <paramref name="value"/> should be
inserted in order to maintain the sorted order. All values to the right of this position will be
strictly greater than <paramref name="value"/>. Note that this may return a position off the end
of the array if all elements are less than or equal to <paramref name="value"/>.</returns>
</member>
<member name="T:Roslyn.Utilities.BlobBuildingStream">
<summary>
A write-only memory stream backed by a <see cref="T:System.Reflection.Metadata.BlobBuilder"/>.
</summary>
</member>
<member name="F:Roslyn.Utilities.BlobBuildingStream.ChunkSize">
<summary>
The chunk size to be used by the underlying BlobBuilder.
</summary>
<remarks>
The current single use case for this type is embedded sources in PDBs.
32 KB is:
* Large enough to handle 99.6% all VB and C# files in Roslyn and CoreFX
without allocating additional chunks.
* Small enough to avoid the large object heap.
* Large enough to handle the files in the 0.4% case without allocating tons
of small chunks. Very large source files are often generated in build
(e.g. Syntax.xml.Generated.vb is 390KB compressed!) and those are actually
attractive candidates for embedding, so we don't want to discount the large
case too heavily.)
* We pool the outer BlobBuildingStream but only retain the first allocated chunk.
</remarks>
</member>
<member name="T:Roslyn.Utilities.CharMemoryEqualityComparer">
<summary>
Provide structural equality for ReadOnlyMemory{char} instances.
</summary>
</member>
<member name="M:Roslyn.Utilities.CommandLineUtilities.SplitCommandLineIntoArguments(System.String,System.Boolean)">
<summary>
Split a command line by the same rules as Main would get the commands except the original
state of backslashes and quotes are preserved. For example in normal Windows command line
parsing the following command lines would produce equivalent Main arguments:
- /r:a,b
- /r:"a,b"
This method will differ as the latter will have the quotes preserved. The only case where
quotes are removed is when the entire argument is surrounded by quotes without any inner
quotes.
</summary>
<remarks>
Rules for command line parsing, according to MSDN:
Arguments are delimited by white space, which is either a space or a tab.
A string surrounded by double quotation marks ("string") is interpreted
as a single argument, regardless of white space contained within.
A quoted string can be embedded in an argument.
A double quotation mark preceded by a backslash (\") is interpreted as a
literal double quotation mark character (").
Backslashes are interpreted literally, unless they immediately precede a
double quotation mark.
If an even number of backslashes is followed by a double quotation mark,
one backslash is placed in the argv array for every pair of backslashes,
and the double quotation mark is interpreted as a string delimiter.
If an odd number of backslashes is followed by a double quotation mark,
one backslash is placed in the argv array for every pair of backslashes,
and the double quotation mark is "escaped" by the remaining backslash,
causing a literal double quotation mark (") to be placed in argv.
</remarks>
</member>
<member name="M:Roslyn.Utilities.CompilerOptionParseUtilities.ParseFeatureFromMSBuild(System.String)">
<summary>
Parse the value provided to an MSBuild Feature option into a list of entries. This will
leave name=value in their raw form.
</summary>
</member>
<member name="M:Roslyn.Utilities.ConcurrentDictionaryExtensions.Add``2(System.Collections.Concurrent.ConcurrentDictionary{``0,``1},``0,``1)">
<summary>
NOTE!!! adding duplicates will result in exceptions.
Being concurrent only allows accessing the dictionary without taking locks.
Duplicate keys are still not allowed in the hashtable.
If unsure about adding unique items use APIs such as TryAdd, GetOrAdd, etc...
</summary>
</member>
<member name="T:Roslyn.Utilities.ConcurrentSet`1">
<summary>
A concurrent, simplified HashSet.
</summary>
</member>
<member name="F:Roslyn.Utilities.ConcurrentSet`1.DefaultConcurrencyLevel">
<summary>
The default concurrency level is 2. That means the collection can cope with up to two
threads making simultaneous modifications without blocking.
Note ConcurrentDictionary's default concurrency level is dynamic, scaling according to
the number of processors.
</summary>
</member>
<member name="F:Roslyn.Utilities.ConcurrentSet`1.DefaultCapacity">
<summary>
Taken from ConcurrentDictionary.DEFAULT_CAPACITY
</summary>
</member>
<member name="F:Roslyn.Utilities.ConcurrentSet`1._dictionary">
<summary>
The backing dictionary. The values are never used; just the keys.
</summary>
</member>
<member name="M:Roslyn.Utilities.ConcurrentSet`1.#ctor">
<summary>
Construct a concurrent set with the default concurrency level.
</summary>
</member>
<member name="M:Roslyn.Utilities.ConcurrentSet`1.#ctor(System.Collections.Generic.IEqualityComparer{`0})">
<summary>
Construct a concurrent set using the specified equality comparer.
</summary>
<param name="equalityComparer">The equality comparer for values in the set.</param>
</member>
<member name="P:Roslyn.Utilities.ConcurrentSet`1.Count">
<summary>
Obtain the number of elements in the set.
</summary>
<returns>The number of elements in the set.</returns>
</member>
<member name="P:Roslyn.Utilities.ConcurrentSet`1.IsEmpty">
<summary>
Determine whether the set is empty.</summary>
<returns>true if the set is empty; otherwise, false.</returns>
</member>
<member name="M:Roslyn.Utilities.ConcurrentSet`1.Contains(`0)">
<summary>
Determine whether the given value is in the set.
</summary>
<param name="value">The value to test.</param>
<returns>true if the set contains the specified value; otherwise, false.</returns>
</member>
<member name="M:Roslyn.Utilities.ConcurrentSet`1.Add(`0)">
<summary>
Attempts to add a value to the set.
</summary>
<param name="value">The value to add.</param>
<returns>true if the value was added to the set. If the value already exists, this method returns false.</returns>
</member>
<member name="M:Roslyn.Utilities.ConcurrentSet`1.Remove(`0)">
<summary>
Attempts to remove a value from the set.
</summary>
<param name="value">The value to remove.</param>
<returns>true if the value was removed successfully; otherwise false.</returns>
</member>
<member name="M:Roslyn.Utilities.ConcurrentSet`1.Clear">
<summary>
Clear the set
</summary>
</member>
<member name="M:Roslyn.Utilities.ConcurrentSet`1.GetEnumerator">
<summary>
Obtain an enumerator that iterates through the elements in the set.
</summary>
<returns>An enumerator for the set.</returns>
</member>
<member name="T:Roslyn.Utilities.ConfiguredYieldAwaitable">
<summary>
A custom awaiter that supports <see cref="M:Roslyn.Utilities.YieldAwaitableExtensions.ConfigureAwait(System.Runtime.CompilerServices.YieldAwaitable,System.Boolean)"/> for
<see cref="M:System.Threading.Tasks.Task.Yield"/>.
</summary>
</member>
<member name="T:Roslyn.Utilities.ConsList`1">
<summary>
a simple Lisp-like immutable list. Good to use when lists are always accessed from the head.
</summary>
</member>
<member name="M:Roslyn.Utilities.RoslynDebug.Assert(System.Boolean)">
<inheritdoc cref="M:System.Diagnostics.Debug.Assert(System.Boolean)"/>
</member>
<member name="M:Roslyn.Utilities.RoslynDebug.Assert(System.Boolean,System.String)">
<inheritdoc cref="M:System.Diagnostics.Debug.Assert(System.Boolean,System.String)"/>
</member>
<member name="T:Roslyn.Utilities.DocumentationCommentXmlNames">
<summary>
Names of well-known XML attributes and elements.
</summary>
</member>
<member name="T:Roslyn.Utilities.EmptyComparer">
<summary>
Very cheap trivial comparer that never matches the keys,
should only be used in empty dictionaries.
</summary>
</member>
<member name="M:Roslyn.Utilities.EncodingExtensions.GetMaxCharCountOrThrowIfHuge(System.Text.Encoding,System.IO.Stream)">
<summary>
Get maximum char count needed to decode the entire stream.
</summary>
<exception cref="T:System.IO.IOException">Stream is so big that max char count can't fit in <see cref="T:System.Int32"/>.</exception>
</member>
<member name="M:Roslyn.Utilities.EnumerableExtensions.IsEmpty``1(``0[])">
<remarks>
This method is necessary to avoid an ambiguity between <see cref="M:Roslyn.Utilities.EnumerableExtensions.IsEmpty``1(System.Collections.Generic.IReadOnlyCollection{``0})"/> and <see cref="M:Roslyn.Utilities.EnumerableExtensions.IsEmpty``1(System.Collections.Generic.ICollection{``0})"/>.
</remarks>
</member>
<member name="M:Roslyn.Utilities.EnumerableExtensions.IsEmpty``1(System.Collections.Generic.List{``0})">
<remarks>
This method is necessary to avoid an ambiguity between <see cref="M:Roslyn.Utilities.EnumerableExtensions.IsEmpty``1(System.Collections.Generic.IReadOnlyCollection{``0})"/> and <see cref="M:Roslyn.Utilities.EnumerableExtensions.IsEmpty``1(System.Collections.Generic.ICollection{``0})"/>.
</remarks>
</member>
<member name="M:Roslyn.Utilities.EnumerableExtensions.AsSingleton``1(System.Collections.Generic.IEnumerable{``0})">
<summary>
Returns the only element of specified sequence if it has exactly one, and default(TSource) otherwise.
Unlike <see cref="M:System.Linq.Enumerable.SingleOrDefault``1(System.Collections.Generic.IEnumerable{``0})"/> doesn't throw if there is more than one element in the sequence.
</summary>
</member>
<member name="T:Roslyn.Utilities.Functions`1">
<summary>
Cached versions of commonly used delegates.
</summary>
<typeparam name="T"></typeparam>
</member>
<member name="T:Roslyn.Utilities.Predicates`1">
<summary>
Cached versions of commonly used delegates.
</summary>
<typeparam name="T"></typeparam>
</member>
<member name="M:Roslyn.Utilities.EnumUtilities.ConvertEnumUnderlyingTypeToUInt64(System.Object,Microsoft.CodeAnalysis.SpecialType)">
<summary>
Convert a boxed primitive (generally of the backing type of an enum) into a ulong.
</summary>
<remarks>
</remarks>
</member>
<member name="M:Roslyn.Utilities.ExceptionUtilities.UnexpectedValue(System.Object)">
<summary>
Creates an <see cref="T:System.InvalidOperationException"/> with information about an unexpected value.
</summary>
<param name="o">The unexpected value.</param>
<returns>The <see cref="T:System.InvalidOperationException"/>, which should be thrown by the caller.</returns>
</member>
<member name="T:Roslyn.Utilities.FileNameUtilities">
<summary>
Implements a few file name utilities that are needed by the compiler.
In general the compiler is not supposed to understand the format of the paths.
In rare cases it needs to check if a string is a valid file name or change the extension
(embedded resources, netmodules, output name).
The APIs are intentionally limited to cover just these rare cases. Do not add more APIs.
</summary>
</member>
<member name="M:Roslyn.Utilities.FileNameUtilities.IsFileName(System.String)">
<summary>
Returns true if the string represents an unqualified file name.
The name may contain any characters but directory and volume separators.
</summary>
<param name="path">Path.</param>
<returns>
True if <paramref name="path"/> is a simple file name, false if it is null or includes a directory specification.
</returns>
</member>
<member name="M:Roslyn.Utilities.FileNameUtilities.IndexOfExtension(System.String)">
<summary>
Returns the offset in <paramref name="path"/> where the dot that starts an extension is, or -1 if the path doesn't have an extension.
</summary>
<remarks>
Returns 0 for path ".goo".
Returns -1 for path "goo.".
</remarks>
</member>
<member name="M:Roslyn.Utilities.FileNameUtilities.GetExtension(System.String)">
<summary>
Returns an extension of the specified path string.
</summary>
<remarks>
The same functionality as <see cref="M:System.IO.Path.GetExtension(System.String)"/> but doesn't throw an exception
if there are invalid characters in the path.
</remarks>
</member>
<member name="M:Roslyn.Utilities.FileNameUtilities.RemoveExtension(System.String)">
<summary>
Removes extension from path.
</summary>
<remarks>
Returns "goo" for path "goo.".
Returns "goo.." for path "goo...".
</remarks>
</member>
<member name="M:Roslyn.Utilities.FileNameUtilities.ChangeExtension(System.String,System.String)">
<summary>
Returns path with the extension changed to <paramref name="extension"/>.
</summary>
<returns>
Equivalent of <see cref="M:System.IO.Path.ChangeExtension(System.String,System.String)"/>
If <paramref name="path"/> is null, returns null.
If path does not end with an extension, the new extension is appended to the path.
If extension is null, equivalent to <see cref="M:Roslyn.Utilities.FileNameUtilities.RemoveExtension(System.String)"/>.
</returns>
</member>
<member name="M:Roslyn.Utilities.FileNameUtilities.IndexOfFileName(System.String)">
<summary>
Returns the position in given path where the file name starts.
</summary>
<returns>-1 if path is null.</returns>
</member>
<member name="M:Roslyn.Utilities.FileNameUtilities.GetFileName(System.String,System.Boolean)">
<summary>
Get file name from path.
</summary>
<remarks>Unlike <see cref="M:System.IO.Path.GetFileName(System.String)"/> doesn't check for invalid path characters.</remarks>
</member>
<member name="M:Roslyn.Utilities.Hash.Combine(System.Int32,System.Int32)">
<summary>
This is how VB Anonymous Types combine hash values for fields.
</summary>
</member>
<member name="M:Roslyn.Utilities.Hash.Combine``1(``0,System.Int32)">
<summary>
This is how VB Anonymous Types combine hash values for fields.
PERF: Do not use with enum types because that involves multiple
unnecessary boxing operations. Unfortunately, we can't constrain
T to "non-enum", so we'll use a more restrictive constraint.
</summary>
</member>
<member name="F:Roslyn.Utilities.Hash.FnvOffsetBias">
<summary>
The offset bias value used in the FNV-1a algorithm
See http://en.wikipedia.org/wiki/Fowler%E2%80%93Noll%E2%80%93Vo_hash_function
</summary>
</member>
<member name="F:Roslyn.Utilities.Hash.FnvPrime">
<summary>
The generative factor used in the FNV-1a algorithm
See http://en.wikipedia.org/wiki/Fowler%E2%80%93Noll%E2%80%93Vo_hash_function
</summary>
</member>
<member name="M:Roslyn.Utilities.Hash.GetFNVHashCode(System.Byte[])">
<summary>
Compute the FNV-1a hash of a sequence of bytes
See http://en.wikipedia.org/wiki/Fowler%E2%80%93Noll%E2%80%93Vo_hash_function
</summary>
<param name="data">The sequence of bytes</param>
<returns>The FNV-1a hash of <paramref name="data"/></returns>
</member>
<member name="M:Roslyn.Utilities.Hash.GetFNVHashCode(System.ReadOnlySpan{System.Byte},System.Boolean@)">
<summary>
Compute the FNV-1a hash of a sequence of bytes and determines if the byte
sequence is valid ASCII and hence the hash code matches a char sequence
encoding the same text.
See http://en.wikipedia.org/wiki/Fowler%E2%80%93Noll%E2%80%93Vo_hash_function
</summary>
<param name="data">The sequence of bytes that are likely to be ASCII text.</param>
<param name="isAscii">True if the sequence contains only characters in the ASCII range.</param>
<returns>The FNV-1a hash of <paramref name="data"/></returns>
</member>
<member name="M:Roslyn.Utilities.Hash.GetFNVHashCode(System.Collections.Immutable.ImmutableArray{System.Byte})">
<summary>
Compute the FNV-1a hash of a sequence of bytes
See http://en.wikipedia.org/wiki/Fowler%E2%80%93Noll%E2%80%93Vo_hash_function
</summary>
<param name="data">The sequence of bytes</param>
<returns>The FNV-1a hash of <paramref name="data"/></returns>
</member>
<member name="M:Roslyn.Utilities.Hash.GetFNVHashCode(System.ReadOnlySpan{System.Char})">
<summary>
Compute the hashcode of a sub-string using FNV-1a
See http://en.wikipedia.org/wiki/Fowler%E2%80%93Noll%E2%80%93Vo_hash_function
Note: FNV-1a was developed and tuned for 8-bit sequences. We're using it here
for 16-bit Unicode chars on the understanding that the majority of chars will
fit into 8-bits and, therefore, the algorithm will retain its desirable traits
for generating hash codes.
</summary>
</member>
<member name="M:Roslyn.Utilities.Hash.GetFNVHashCode(System.String,System.Int32,System.Int32)">
<summary>
Compute the hashcode of a sub-string using FNV-1a
See http://en.wikipedia.org/wiki/Fowler%E2%80%93Noll%E2%80%93Vo_hash_function
Note: FNV-1a was developed and tuned for 8-bit sequences. We're using it here
for 16-bit Unicode chars on the understanding that the majority of chars will
fit into 8-bits and, therefore, the algorithm will retain its desirable traits
for generating hash codes.
</summary>
<param name="text">The input string</param>
<param name="start">The start index of the first character to hash</param>
<param name="length">The number of characters, beginning with <paramref name="start"/> to hash</param>
<returns>The FNV-1a hash code of the substring beginning at <paramref name="start"/> and ending after <paramref name="length"/> characters.</returns>
</member>
<member name="M:Roslyn.Utilities.Hash.GetFNVHashCode(System.String,System.Int32)">
<summary>
Compute the hashcode of a sub-string using FNV-1a
See http://en.wikipedia.org/wiki/Fowler%E2%80%93Noll%E2%80%93Vo_hash_function
</summary>
<param name="text">The input string</param>
<param name="start">The start index of the first character to hash</param>
<returns>The FNV-1a hash code of the substring beginning at <paramref name="start"/> and ending at the end of the string.</returns>
</member>
<member name="M:Roslyn.Utilities.Hash.GetFNVHashCode(System.String)">
<summary>
Compute the hashcode of a string using FNV-1a
See http://en.wikipedia.org/wiki/Fowler%E2%80%93Noll%E2%80%93Vo_hash_function
</summary>
<param name="text">The input string</param>
<returns>The FNV-1a hash code of <paramref name="text"/></returns>
</member>
<member name="M:Roslyn.Utilities.Hash.GetFNVHashCode(System.Text.StringBuilder)">
<summary>
Compute the hashcode of a string using FNV-1a
See http://en.wikipedia.org/wiki/Fowler%E2%80%93Noll%E2%80%93Vo_hash_function
</summary>
<param name="text">The input string</param>
<returns>The FNV-1a hash code of <paramref name="text"/></returns>
</member>
<member name="M:Roslyn.Utilities.Hash.GetFNVHashCode(System.Char[],System.Int32,System.Int32)">
<summary>
Compute the hashcode of a sub string using FNV-1a
See http://en.wikipedia.org/wiki/Fowler%E2%80%93Noll%E2%80%93Vo_hash_function
</summary>
<param name="text">The input string as a char array</param>
<param name="start">The start index of the first character to hash</param>
<param name="length">The number of characters, beginning with <paramref name="start"/> to hash</param>
<returns>The FNV-1a hash code of the substring beginning at <paramref name="start"/> and ending after <paramref name="length"/> characters.</returns>
</member>
<member name="M:Roslyn.Utilities.Hash.GetFNVHashCode(System.Char)">
<summary>
Compute the hashcode of a single character using the FNV-1a algorithm
See http://en.wikipedia.org/wiki/Fowler%E2%80%93Noll%E2%80%93Vo_hash_function
Note: In general, this isn't any more useful than "char.GetHashCode". However,
it may be needed if you need to generate the same hash code as a string or
substring with just a single character.
</summary>
<param name="ch">The character to hash</param>
<returns>The FNV-1a hash code of the character.</returns>
</member>
<member name="M:Roslyn.Utilities.Hash.CombineFNVHash(System.Int32,System.String)">
<summary>
Combine a string with an existing FNV-1a hash code
See http://en.wikipedia.org/wiki/Fowler%E2%80%93Noll%E2%80%93Vo_hash_function
</summary>
<param name="hashCode">The accumulated hash code</param>
<param name="text">The string to combine</param>
<returns>The result of combining <paramref name="hashCode"/> with <paramref name="text"/> using the FNV-1a algorithm</returns>
</member>
<member name="M:Roslyn.Utilities.Hash.CombineFNVHash(System.Int32,System.Char)">
<summary>
Combine a char with an existing FNV-1a hash code
See http://en.wikipedia.org/wiki/Fowler%E2%80%93Noll%E2%80%93Vo_hash_function
</summary>
<param name="hashCode">The accumulated hash code</param>
<param name="ch">The new character to combine</param>
<returns>The result of combining <paramref name="hashCode"/> with <paramref name="ch"/> using the FNV-1a algorithm</returns>
</member>
<member name="M:Roslyn.Utilities.InterlockedOperations.Initialize``1(``0@,``0)">
<summary>
Initialize the value referenced by <paramref name="target"/> in a thread-safe manner.
The value is changed to <paramref name="value"/> only if the current value is null.
</summary>
<typeparam name="T">Type of value.</typeparam>
<param name="target">Reference to the target location.</param>
<param name="value">The value to use if the target is currently null.</param>
<returns>The new value referenced by <paramref name="target"/>. Note that this is
nearly always more useful than the usual return from <see cref="M:System.Threading.Interlocked.CompareExchange``1(``0@,``0,``0)"/>
because it saves another read to <paramref name="target"/>.</returns>
</member>
<member name="M:Roslyn.Utilities.InterlockedOperations.Initialize``1(``0@,``0,``0)">
<summary>
Initialize the value referenced by <paramref name="target"/> in a thread-safe manner.
The value is changed to <paramref name="initializedValue"/> only if the current value
is <paramref name="uninitializedValue"/>.
</summary>
<typeparam name="T">Type of value.</typeparam>
<param name="target">Reference to the target location.</param>
<param name="initializedValue">The value to use if the target is currently uninitialized.</param>
<param name="uninitializedValue">The uninitialized value.</param>
<returns>The new value referenced by <paramref name="target"/>. Note that this is
nearly always more useful than the usual return from <see cref="M:System.Threading.Interlocked.CompareExchange``1(``0@,``0,``0)"/>
because it saves another read to <paramref name="target"/>.</returns>
</member>
<member name="M:Roslyn.Utilities.InterlockedOperations.Initialize``1(System.Collections.Immutable.ImmutableArray{``0}@,System.Collections.Immutable.ImmutableArray{``0})">
<summary>
Initialize the immutable array referenced by <paramref name="target"/> in a thread-safe manner.
</summary>
<typeparam name="T">Elemental type of the array.</typeparam>
<param name="target">Reference to the target location.</param>
<param name="initializedValue">The value to use if the target is currently uninitialized (default).</param>
<returns>The new value referenced by <paramref name="target"/>. Note that this is
nearly always more useful than the usual return from <see cref="M:System.Threading.Interlocked.CompareExchange``1(``0@,``0,``0)"/>
because it saves another read to <paramref name="target"/>.</returns>
</member>
<member name="T:Roslyn.Utilities.JsonWriter">
<summary>
A simple, forward-only JSON writer to avoid adding dependencies to the compiler.
Used to generate /errorlogger output.
Does not guarantee well-formed JSON if misused. It is the caller's responsibility
to balance array/object start/end, to only write key-value pairs to objects and
elements to arrays, etc.
Takes ownership of the given <see cref="T:System.IO.TextWriter" /> at construction and handles its disposal.
</summary>
</member>
<member name="T:Roslyn.Utilities.NoThrowStreamDisposer">
<summary>
Catches exceptions thrown during disposal of the underlying stream and
writes them to the given <see cref="T:System.IO.TextWriter"/>. Check
<see cref="P:Roslyn.Utilities.NoThrowStreamDisposer.HasFailedToDispose" /> after disposal to see if any
exceptions were thrown during disposal.
</summary>
</member>
<member name="P:Roslyn.Utilities.NoThrowStreamDisposer.Stream">
<summary>
Underlying stream
</summary>
</member>
<member name="P:Roslyn.Utilities.NoThrowStreamDisposer.HasFailedToDispose">
<summary>
True iff an exception was thrown during a call to <see cref="M:Roslyn.Utilities.NoThrowStreamDisposer.Dispose"/>
</summary>
</member>
<member name="T:Roslyn.Utilities.OneOrMany`1">
<summary>
Represents a single item or many items.
</summary>
<remarks>
Used when a collection usually contains a single item but sometimes might contain multiple.
</remarks>
</member>
<member name="T:Roslyn.Utilities.PlatformInformation">
<summary>
This class provides simple properties for determining whether the current platform is Windows or Unix-based.
We intentionally do not use System.Runtime.InteropServices.RuntimeInformation.IsOSPlatform(...) because
it incorrectly reports 'true' for 'Windows' in desktop builds running on Unix-based platforms via Mono.
</summary>
</member>
<member name="T:Roslyn.Utilities.ReferenceEqualityComparer">
<summary>
Compares objects based upon their reference identity.
</summary>
</member>
<member name="M:Roslyn.Utilities.ReflectionUtilities.GetTypeFromEither(System.String,System.String)">
<summary>
Find a <see cref="T:System.Type"/> instance by first probing the contract name and then the name as it
would exist in mscorlib. This helps satisfy both the CoreCLR and Desktop scenarios.
</summary>
</member>
<member name="M:Roslyn.Utilities.RoslynLazyInitializer.EnsureInitialized``1(``0@)">
<inheritdoc cref="M:System.Threading.LazyInitializer.EnsureInitialized``1(``0@)"/>
</member>
<member name="M:Roslyn.Utilities.RoslynLazyInitializer.EnsureInitialized``1(``0@,System.Func{``0})">
<inheritdoc cref="M:System.Threading.LazyInitializer.EnsureInitialized``1(``0@,System.Func{``0})"/>
</member>
<member name="M:Roslyn.Utilities.RoslynLazyInitializer.EnsureInitialized``1(``0@,System.Boolean@,System.Object@)">
<inheritdoc cref="M:System.Threading.LazyInitializer.EnsureInitialized``1(``0@,System.Boolean@,System.Object@)"/>
</member>
<member name="M:Roslyn.Utilities.RoslynLazyInitializer.EnsureInitialized``1(``0@,System.Boolean@,System.Object@,System.Func{``0})">
<inheritdoc cref="M:System.Threading.LazyInitializer.EnsureInitialized``1(``0@,System.Boolean@,System.Object@,System.Func{``0})"/>
</member>
<member name="M:Roslyn.Utilities.RoslynParallel.For(System.Int32,System.Int32,System.Action{System.Int32},System.Threading.CancellationToken)">
<inheritdoc cref="M:System.Threading.Tasks.Parallel.For(System.Int32,System.Int32,System.Threading.Tasks.ParallelOptions,System.Action{System.Int32})"/>
</member>
<member name="M:Roslyn.Utilities.RoslynString.IsNullOrEmpty(System.String)">
<inheritdoc cref="M:System.String.IsNullOrEmpty(System.String)"/>
</member>
<member name="M:Roslyn.Utilities.RoslynString.IsNullOrWhiteSpace(System.String)">
<inheritdoc cref="M:System.String.IsNullOrWhiteSpace(System.String)"/>
</member>
<member name="T:Roslyn.Utilities.SetWithInsertionOrder`1">
<summary>
A set that returns the inserted values in insertion order.
The mutation operations are not thread-safe.
</summary>
</member>
<member name="M:Roslyn.Utilities.StreamExtensions.TryReadAll(System.IO.Stream,System.Byte[],System.Int32,System.Int32)">
<summary>
Attempts to read all of the requested bytes from the stream into the buffer
</summary>
<returns>
The number of bytes read. Less than <paramref name="count" /> will
only be returned if the end of stream is reached before all bytes can be read.
</returns>
<remarks>
Unlike <see cref="M:System.IO.Stream.Read(System.Byte[],System.Int32,System.Int32)"/> it is not guaranteed that
the stream position or the output buffer will be unchanged if an exception is
returned.
</remarks>
</member>
<member name="M:Roslyn.Utilities.StreamExtensions.ReadAllBytes(System.IO.Stream)">
<summary>
Reads all bytes from the current position of the given stream to its end.
</summary>
</member>
<member name="M:Roslyn.Utilities.StringExtensions.IsValidClrNamespaceName(System.String)">
<summary>
Checks if the given name is a sequence of valid CLR names separated by a dot.
</summary>
</member>
<member name="M:Roslyn.Utilities.StringExtensions.Unquote(System.String)">
<summary>
Remove one set of leading and trailing double quote characters, if both are present.
</summary>
</member>
<member name="T:Roslyn.Utilities.StringOrdinalComparer">
<summary>
Compares string based upon their ordinal equality.
We use this comparer for string identifiers because it does exactly what we need and nothing more
The StringComparer.Ordinal as implemented by StringComparer is more complex to support
case sensitive and insensitive compares depending on flags.
It also defers to the default string hash function that might not be the best for our scenarios.
</summary>
</member>
<member name="T:Roslyn.Utilities.StringTable">
<summary>
This is basically a lossy cache of strings that is searchable by
strings, string sub ranges, character array ranges or string-builder.
</summary>
</member>
<member name="M:Roslyn.Utilities.TextChangeRangeExtensions.Merge(System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.Text.TextChangeRange},System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.Text.TextChangeRange})">
<summary>
Merges the new change ranges into the old change ranges, adjusting the new ranges to be with respect to the original text
(with neither old or new changes applied) instead of with respect to the original text after "old changes" are applied.
This may require splitting, concatenation, etc. of individual change ranges.
</summary>
<remarks>
Both `oldChanges` and `newChanges` must contain non-overlapping spans in ascending order.
</remarks>
</member>
<member name="T:Roslyn.Utilities.TextChangeRangeExtensions.UnadjustedNewChange">
<summary>
Represents a new change being processed by <see cref="M:Roslyn.Utilities.TextChangeRangeExtensions.Merge(System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.Text.TextChangeRange},System.Collections.Immutable.ImmutableArray{Microsoft.CodeAnalysis.Text.TextChangeRange})"/>.
Such a new change must be adjusted before being added to the result list.
</summary>
<remarks>
A value of this type may represent the intermediate state of merging of an old change into an unadjusted new change,
resulting in a temporary unadjusted new change whose <see cref="P:Roslyn.Utilities.TextChangeRangeExtensions.UnadjustedNewChange.SpanStart"/> is negative (not valid) until it is adjusted.
This tends to happen when we need to merge an old change deletion into a new change near the beginning of the text. (see TextChangeTests.Fuzz_4)
</remarks>
</member>
<member name="T:Roslyn.Utilities.UnicodeCharacterUtilities">
<summary>
Defines a set of helper methods to classify Unicode characters.
</summary>
</member>
<member name="M:Roslyn.Utilities.UnicodeCharacterUtilities.IsIdentifierPartCharacter(System.Char)">
<summary>
Returns true if the Unicode character can be a part of an identifier.
</summary>
<param name="ch">The Unicode character.</param>
</member>
<member name="M:Roslyn.Utilities.UnicodeCharacterUtilities.IsValidIdentifier(System.String)">
<summary>
Check that the name is a valid Unicode identifier.
</summary>
</member>
<member name="M:Roslyn.Utilities.UnicodeCharacterUtilities.IsFormattingChar(System.Char)">
<summary>
Returns true if the Unicode character is a formatting character (Unicode class Cf).
</summary>
<param name="ch">The Unicode character.</param>
</member>
<member name="M:Roslyn.Utilities.UnicodeCharacterUtilities.IsFormattingChar(System.Globalization.UnicodeCategory)">
<summary>
Returns true if the Unicode character is a formatting character (Unicode class Cf).
</summary>
<param name="cat">The Unicode character.</param>
</member>
<member name="T:Roslyn.Utilities.ValueTaskFactory">
<summary>
Implements <see cref="T:System.Threading.Tasks.ValueTask"/> and <see cref="T:System.Threading.Tasks.ValueTask`1"/> static members that are only available in .NET 5.
</summary>
</member>
<member name="T:Roslyn.Utilities.WeakList`1">
<summary>
Represents an ordered sequence of weak references.
</summary>
</member>
<member name="M:Roslyn.Utilities.WeakList`1.Compact(System.Int32,System.WeakReference{`0}[])">
<summary>
Copies all live references from <see cref="F:Roslyn.Utilities.WeakList`1._items"/> to <paramref name="result"/>.
Assumes that all references prior <paramref name="firstDead"/> are alive.
</summary>
</member>
<member name="P:Roslyn.Utilities.WeakList`1.WeakCount">
<summary>
Returns the number of weak references in this list.
Note that some of them might not point to live objects anymore.
</summary>
</member>
<member name="M:Roslyn.Utilities.YieldAwaitableExtensions.ConfigureAwait(System.Runtime.CompilerServices.YieldAwaitable,System.Boolean)">
<summary>
Implements <c>ConfigureAwait(bool)</c> for <see cref="M:System.Threading.Tasks.Task.Yield"/>. The resulting behavior in asynchronous code
is the same as one would expect for <see cref="M:System.Threading.Tasks.Task.ConfigureAwait(System.Boolean)"/>.
</summary>
<param name="awaitable">The awaitable provided by <see cref="M:System.Threading.Tasks.Task.Yield"/>.</param>
<param name="continueOnCapturedContext"><inheritdoc cref="M:System.Threading.Tasks.Task.ConfigureAwait(System.Boolean)"/></param>
<returns>An object used to await this yield.</returns>
</member>
<member name="T:Roslyn.Utilities.IObjectWritable">
<summary>
Objects that implement this interface know how to write their contents to an <see cref="T:Roslyn.Utilities.ObjectWriter"/>,
so they can be reconstructed later by an <see cref="T:Roslyn.Utilities.ObjectReader"/>.
</summary>
</member>
<member name="P:Roslyn.Utilities.IObjectWritable.ShouldReuseInSerialization">
<summary>
Returns 'true' when the same instance could be used more than once.
Instances that return 'false' should not be tracked for the purpose
of de-duplication while serializing/deserializing.
</summary>
</member>
<member name="T:Roslyn.Utilities.ObjectBinder">
<summary>
<see cref="T:Roslyn.Utilities.ObjectBinder"/> is a registry that maps between arbitrary <see cref="T:System.Type"/>s and
the 'reader' function used to deserialize serialized instances of those types. Registration
must happen ahead of time using the <see cref="M:Roslyn.Utilities.ObjectBinder.RegisterTypeReader(System.Type,System.Func{Roslyn.Utilities.ObjectReader,Roslyn.Utilities.IObjectWritable})"/> method.
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectBinder.s_gate">
<summary>
Lock for all data in this type.
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectBinder.s_lastSnapshot">
<summary>
Last created snapshot of our data. We hand this out instead of exposing our raw
data so that <see cref="T:Roslyn.Utilities.ObjectReader"/> and <see cref="T:Roslyn.Utilities.ObjectWriter"/> do not need to
take any locks while processing.
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectBinder.s_typeToIndex">
<summary>
Map from a <see cref="T:System.Type"/> to the corresponding index in <see cref="F:Roslyn.Utilities.ObjectBinder.s_types"/> and
<see cref="F:Roslyn.Utilities.ObjectBinder.s_typeReaders"/>. <see cref="T:Roslyn.Utilities.ObjectWriter"/> will write out the index into
the stream, and <see cref="T:Roslyn.Utilities.ObjectReader"/> will use that index to get the reader used
for deserialization.
</summary>
</member>
<member name="M:Roslyn.Utilities.ObjectBinder.GetSnapshot">
<summary>
Gets an immutable copy of the state of this binder. This copy does not need to be
locked while it is used.
</summary>
</member>
<member name="T:Roslyn.Utilities.ObjectReader">
<summary>
An <see cref="T:Roslyn.Utilities.ObjectReader"/> that deserializes objects from a byte stream.
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectReader.VersionByte1">
<summary>
We start the version at something reasonably random. That way an older file, with
some random start-bytes, has little chance of matching our version. When incrementing
this version, just change VersionByte2.
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectReader._objectReferenceMap">
<summary>
Map of reference id's to deserialized objects.
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectReader._binderSnapshot">
<summary>
Copy of the global binder data that maps from Types to the appropriate reading-function
for that type. Types register functions directly with <see cref="T:Roslyn.Utilities.ObjectBinder"/>, but
that means that <see cref="T:Roslyn.Utilities.ObjectBinder"/> is both static and locked. This gives us
local copy we can work with without needing to worry about anyone else mutating.
</summary>
</member>
<member name="M:Roslyn.Utilities.ObjectReader.#ctor(System.IO.Stream,System.Boolean,System.Threading.CancellationToken)">
<summary>
Creates a new instance of a <see cref="T:Roslyn.Utilities.ObjectReader"/>.
</summary>
<param name="stream">The stream to read objects from.</param>
<param name="leaveOpen">True to leave the <paramref name="stream"/> open after the <see cref="T:Roslyn.Utilities.ObjectWriter"/> is disposed.</param>
<param name="cancellationToken"></param>
</member>
<member name="M:Roslyn.Utilities.ObjectReader.TryGetReader(System.IO.Stream,System.Boolean,System.Threading.CancellationToken)">
<summary>
Attempts to create a <see cref="T:Roslyn.Utilities.ObjectReader"/> from the provided <paramref name="stream"/>.
If the <paramref name="stream"/> does not start with a valid header, then <see langword="null"/> will
be returned.
</summary>
</member>
<member name="M:Roslyn.Utilities.ObjectReader.GetReader(System.IO.Stream,System.Boolean,System.Threading.CancellationToken)">
<summary>
Creates an <see cref="T:Roslyn.Utilities.ObjectReader"/> from the provided <paramref name="stream"/>.
Unlike <see cref="M:Roslyn.Utilities.ObjectReader.TryGetReader(System.IO.Stream,System.Boolean,System.Threading.CancellationToken)"/>, it requires the version
of the data in the stream to exactly match the current format version.
Should only be used to read data written by the same version of Roslyn.
</summary>
</member>
<member name="T:Roslyn.Utilities.ObjectReader.ReaderReferenceMap`1">
<summary>
A reference-id to object map, that can share base data efficiently.
</summary>
</member>
<member name="T:Roslyn.Utilities.ObjectWriter">
<summary>
An <see cref="T:Roslyn.Utilities.ObjectWriter"/> that serializes objects to a byte stream.
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter._objectReferenceMap">
<summary>
Map of serialized object's reference ids. The object-reference-map uses reference equality
for performance. While the string-reference-map uses value-equality for greater cache hits
and reuse.
These are not readonly because they're structs and we mutate them.
When we write out objects/strings we give each successive, unique, item a monotonically
increasing integral ID starting at 0. I.e. the first object gets ID-0, the next gets
ID-1 and so on and so forth. We do *not* include these IDs with the object when it is
written out. We only include the ID if we hit the object *again* while writing.
During reading, the reader knows to give each object it reads the same monotonically
increasing integral value. i.e. the first object it reads is put into an array at position
0, the next at position 1, and so on. Then, when the reader reads in an object-reference
it can just retrieved it directly from that array.
In other words, writing and reading take advantage of the fact that they know they will
write and read objects in the exact same order. So they only need the IDs for references
and not the objects themselves because the ID is inferred from the order the object is
written or read in.
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter._binderSnapshot">
<summary>
Copy of the global binder data that maps from Types to the appropriate reading-function
for that type. Types register functions directly with <see cref="T:Roslyn.Utilities.ObjectBinder"/>, but
that means that <see cref="T:Roslyn.Utilities.ObjectBinder"/> is both static and locked. This gives us
local copy we can work with without needing to worry about anyone else mutating.
</summary>
</member>
<member name="M:Roslyn.Utilities.ObjectWriter.#ctor(System.IO.Stream,System.Boolean,System.Threading.CancellationToken)">
<summary>
Creates a new instance of a <see cref="T:Roslyn.Utilities.ObjectWriter"/>.
</summary>
<param name="stream">The stream to write to.</param>
<param name="leaveOpen">True to leave the <paramref name="stream"/> open after the <see cref="T:Roslyn.Utilities.ObjectWriter"/> is disposed.</param>
<param name="cancellationToken">Cancellation token.</param>
</member>
<member name="T:Roslyn.Utilities.ObjectWriter.GuidAccessor">
<summary>
Used so we can easily grab the low/high 64bits of a guid for serialization.
</summary>
</member>
<member name="M:Roslyn.Utilities.ObjectWriter.WriteValue(System.ReadOnlySpan{System.Byte})">
<summary>
Write an array of bytes. The array data is provided as a
<see cref="T:System.ReadOnlySpan`1">ReadOnlySpan</see><<see cref="T:System.Byte"/>>, and deserialized to a byte array.
</summary>
<param name="span">The array data.</param>
</member>
<member name="T:Roslyn.Utilities.ObjectWriter.WriterReferenceMap">
<summary>
An object reference to reference-id map, that can share base data efficiently.
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.s_reverseTypeMap">
<summary>
Indexed by EncodingKind.
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.ByteMarkerMask">
<summary>
byte marker mask for encoding compressed uint
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.Byte1Marker">
<summary>
byte marker bits for uint encoded in 1 byte.
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.Byte2Marker">
<summary>
byte marker bits for uint encoded in 2 bytes.
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.Byte4Marker">
<summary>
byte marker bits for uint encoded in 4 bytes.
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.Null">
<summary>
The null value
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.Type">
<summary>
A type
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.Object">
<summary>
An object with member values encoded as variants
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.ObjectRef_1Byte">
<summary>
An object reference with the id encoded as 1 byte.
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.ObjectRef_2Bytes">
<summary>
An object reference with the id encode as 2 bytes.
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.ObjectRef_4Bytes">
<summary>
An object reference with the id encoded as 4 bytes.
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.StringUtf8">
<summary>
A string encoded as UTF8 (using BinaryWriter.Write(string))
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.StringUtf16">
<summary>
A string encoded as UTF16 (as array of UInt16 values)
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.StringRef_1Byte">
<summary>
A reference to a string with the id encoded as 1 byte.
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.StringRef_2Bytes">
<summary>
A reference to a string with the id encoded as 2 bytes.
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.StringRef_4Bytes">
<summary>
A reference to a string with the id encoded as 4 bytes.
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.Boolean_True">
<summary>
The boolean value true.
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.Boolean_False">
<summary>
The boolean value char.
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.Char">
<summary>
A character value encoded as 2 bytes.
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.Int8">
<summary>
An Int8 value encoded as 1 byte.
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.Int16">
<summary>
An Int16 value encoded as 2 bytes.
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.Int32">
<summary>
An Int32 value encoded as 4 bytes.
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.Int32_1Byte">
<summary>
An Int32 value encoded as 1 byte.
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.Int32_2Bytes">
<summary>
An Int32 value encoded as 2 bytes.
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.Int32_0">
<summary>
The Int32 value 0
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.Int32_1">
<summary>
The Int32 value 1
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.Int32_2">
<summary>
The Int32 value 2
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.Int32_3">
<summary>
The Int32 value 3
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.Int32_4">
<summary>
The Int32 value 4
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.Int32_5">
<summary>
The Int32 value 5
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.Int32_6">
<summary>
The Int32 value 6
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.Int32_7">
<summary>
The Int32 value 7
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.Int32_8">
<summary>
The Int32 value 8
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.Int32_9">
<summary>
The Int32 value 9
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.Int32_10">
<summary>
The Int32 value 10
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.Int64">
<summary>
An Int64 value encoded as 8 bytes
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.UInt8">
<summary>
A UInt8 value encoded as 1 byte.
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.UInt16">
<summary>
A UIn16 value encoded as 2 bytes.
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.UInt32">
<summary>
A UInt32 value encoded as 4 bytes.
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.UInt32_1Byte">
<summary>
A UInt32 value encoded as 1 byte.
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.UInt32_2Bytes">
<summary>
A UInt32 value encoded as 2 bytes.
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.UInt32_0">
<summary>
The UInt32 value 0
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.UInt32_1">
<summary>
The UInt32 value 1
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.UInt32_2">
<summary>
The UInt32 value 2
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.UInt32_3">
<summary>
The UInt32 value 3
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.UInt32_4">
<summary>
The UInt32 value 4
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.UInt32_5">
<summary>
The UInt32 value 5
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.UInt32_6">
<summary>
The UInt32 value 6
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.UInt32_7">
<summary>
The UInt32 value 7
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.UInt32_8">
<summary>
The UInt32 value 8
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.UInt32_9">
<summary>
The UInt32 value 9
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.UInt32_10">
<summary>
The UInt32 value 10
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.UInt64">
<summary>
A UInt64 value encoded as 8 bytes.
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.Float4">
<summary>
A float value encoded as 4 bytes.
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.Float8">
<summary>
A double value encoded as 8 bytes.
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.Decimal">
<summary>
A decimal value encoded as 12 bytes.
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.DateTime">
<summary>
A DateTime value
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.Array">
<summary>
An array with length encoded as compressed uint
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.Array_0">
<summary>
An array with zero elements
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.Array_1">
<summary>
An array with one element
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.Array_2">
<summary>
An array with 2 elements
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.Array_3">
<summary>
An array with 3 elements
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.BooleanType">
<summary>
The boolean type
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.StringType">
<summary>
The string type
</summary>
</member>
<member name="F:Roslyn.Utilities.ObjectWriter.EncodingKind.EncodingName">
<summary>
Encoding serialized as <see cref="P:System.Text.Encoding.WebName"/>.
</summary>
</member>
<member name="T:Roslyn.Utilities.PerformanceSensitiveAttribute">
<summary>
Indicates that a code element is performance sensitive under a known scenario.
</summary>
<remarks>
<para>When applying this attribute, only explicitly set the values for properties specifically indicated by the
test/measurement technique described in the associated <see cref="P:Roslyn.Utilities.PerformanceSensitiveAttribute.Uri"/>.</para>
</remarks>
</member>
<member name="P:Roslyn.Utilities.PerformanceSensitiveAttribute.Uri">
<summary>
Gets the location where the original problem is documented, likely with steps to reproduce the issue and/or
validate performance related to a change in the method.
</summary>
</member>
<member name="P:Roslyn.Utilities.PerformanceSensitiveAttribute.Constraint">
<summary>
Gets or sets a description of the constraint imposed by the original performance issue.
</summary>
<remarks>
<para>Constraints are normally specified by other specific properties that allow automated validation of the
constraint. This property supports documenting constraints which cannot be described in terms of other
constraint properties.</para>
</remarks>
</member>
<member name="P:Roslyn.Utilities.PerformanceSensitiveAttribute.AllowCaptures">
<summary>
Gets or sets a value indicating whether captures are allowed.
</summary>
</member>
<member name="P:Roslyn.Utilities.PerformanceSensitiveAttribute.AllowImplicitBoxing">
<summary>
Gets or sets a value indicating whether implicit boxing of value types is allowed.
</summary>
</member>
<member name="P:Roslyn.Utilities.PerformanceSensitiveAttribute.AllowGenericEnumeration">
<summary>
Gets or sets a value indicating whether enumeration of a generic
<see cref="T:System.Collections.Generic.IEnumerable`1"/> is allowed.
</summary>
</member>
<member name="P:Roslyn.Utilities.PerformanceSensitiveAttribute.AllowLocks">
<summary>
Gets or sets a value indicating whether locks are allowed.
</summary>
</member>
<member name="P:Roslyn.Utilities.PerformanceSensitiveAttribute.OftenCompletesSynchronously">
<summary>
Gets or sets a value indicating whether the asynchronous state machine typically completes synchronously.
</summary>
<remarks>
<para>When <see langword="true"/>, validation of this performance constraint typically involves analyzing
the method to ensure synchronous completion of the state machine does not require the allocation of a
<see cref="T:System.Threading.Tasks.Task"/>, either through caching the result or by using
<see cref="T:System.Threading.Tasks.ValueTask`1"/>.</para>
</remarks>
</member>
<member name="P:Roslyn.Utilities.PerformanceSensitiveAttribute.IsParallelEntry">
<summary>
Gets or sets a value indicating whether this is an entry point to a parallel algorithm.
</summary>
<remarks>
<para>Parallelization APIs and algorithms, e.g. <c>Parallel.ForEach</c>, may be efficient for parallel entry
points (few direct calls but large amounts of iterative work), but are problematic when called inside the
iterations themselves. Performance-sensitive code should avoid the use of heavy parallelization APIs except
for known entry points to the parallel portion of code.</para>
</remarks>
</member>
<member name="T:System.Runtime.CompilerServices.InternalImplementationOnlyAttribute">
<summary>
This is a marker attribute that can be put on an interface to denote that only internal implementations
of that interface should exist.
</summary>
</member>
<member name="T:System.Runtime.CompilerServices.IsExternalInit">
<summary>
Reserved to be used by the compiler for tracking metadata.
This class should not be used by developers in source code.
</summary>
</member>
<member name="T:System.Runtime.Versioning.OSPlatformAttribute">
<summary>
Base type for all platform-specific API attributes.
</summary>
</member>
<member name="T:System.Runtime.Versioning.TargetPlatformAttribute">
<summary>
Records the platform that the project targeted.
</summary>
</member>
<member name="T:System.Runtime.Versioning.SupportedOSPlatformAttribute">
<summary>
Records the operating system (and minimum version) that supports an API. Multiple attributes can be
applied to indicate support on multiple operating systems.
</summary>
<remarks>
<para>Callers can apply a <see cref="T:System.Runtime.Versioning.SupportedOSPlatformAttribute" />
or use guards to prevent calls to APIs on unsupported operating systems.</para>
<para>A given platform should only be specified once.</para>
</remarks>
</member>
<member name="T:System.Runtime.Versioning.UnsupportedOSPlatformAttribute">
<summary>
Marks APIs that were removed in a given operating system version.
</summary>
<remarks>
Primarily used by OS bindings to indicate APIs that are only available in
earlier versions.
</remarks>
</member>
<member name="T:System.Linq.EnumerableExtensions">
<summary>
Declare the following extension methods in System.Linq namespace to avoid accidental boxing of ImmutableArray{T} that implements IEnumerable{T}.
The boxing would occur if the methods were defined in Roslyn.Utilities and the file calling these methods has <c>using Roslyn.Utilities</c>
but not <c>using System.Linq</c>.
</summary>
</member>
<member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute">
<summary>Specifies that the method or property will ensure that the listed field and property members have not-null values.</summary>
</member>
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String)">
<summary>Initializes the attribute with a field or property member.</summary>
<param name="member">
The field or property member that is promised to be not-null.
</param>
</member>
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String[])">
<summary>Initializes the attribute with the list of field and property members.</summary>
<param name="members">
The list of field and property members that are promised to be not-null.
</param>
</member>
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.Members">
<summary>Gets field or property member names.</summary>
</member>
<member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute">
<summary>Specifies that the method or property will ensure that the listed field and property members have not-null values when returning with the specified return value condition.</summary>
</member>
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String)">
<summary>Initializes the attribute with the specified return value condition and a field or property member.</summary>
<param name="returnValue">
The return value condition. If the method returns this value, the associated parameter will not be null.
</param>
<param name="member">
The field or property member that is promised to be not-null.
</param>
</member>
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String[])">
<summary>Initializes the attribute with the specified return value condition and list of field and property members.</summary>
<param name="returnValue">
The return value condition. If the method returns this value, the associated parameter will not be null.
</param>
<param name="members">
The list of field and property members that are promised to be not-null.
</param>
</member>
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.ReturnValue">
<summary>Gets the return value condition.</summary>
</member>
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.Members">
<summary>Gets field or property member names.</summary>
</member>
</members>
</doc>
md5: 5127DDC4377A4FEC97EAC8E991477D00 | sha1: EB1C84DA67D382390397E30FE801A38944BCF48C | sha256: B4BF70C7E2AA5EA0090E13817B895339259CC435DD16D8BD32CE4EBD85DE4A3C | sha512: 86904AC640009CD7F11C1694E3CCB96F482CABB7A098498E9A76F84FB87060B01C6E7D1F73CD8451F031DD4A88DD802B715C337D58FB47B1F1CEBABE4DC735A9
<?xml version="1.0"?>
<doc>
<assembly>
<name>Microsoft.Extensions.Logging.Abstractions</name>
</assembly>
<members>
<member name="T:Microsoft.Extensions.Logging.EventId">
<summary>
Identifies a logging event. The primary identifier is the "Id" property, with the "Name" property providing a short description of this type of event.
</summary>
</member>
<member name="M:Microsoft.Extensions.Logging.EventId.op_Implicit(System.Int32)~Microsoft.Extensions.Logging.EventId">
<summary>
Implicitly creates an EventId from the given <see cref="T:System.Int32"/>.
</summary>
<param name="i">The <see cref="T:System.Int32"/> to convert to an EventId.</param>
</member>
<member name="M:Microsoft.Extensions.Logging.EventId.op_Equality(Microsoft.Extensions.Logging.EventId,Microsoft.Extensions.Logging.EventId)">
<summary>
Checks if two specified <see cref="T:Microsoft.Extensions.Logging.EventId"/> instances have the same value. They are equal if they have the same Id.
</summary>
<param name="left">The first <see cref="T:Microsoft.Extensions.Logging.EventId"/>.</param>
<param name="right">The second <see cref="T:Microsoft.Extensions.Logging.EventId"/>.</param>
<returns><see langword="true" /> if the objects are equal.</returns>
</member>
<member name="M:Microsoft.Extensions.Logging.EventId.op_Inequality(Microsoft.Extensions.Logging.EventId,Microsoft.Extensions.Logging.EventId)">
<summary>
Checks if two specified <see cref="T:Microsoft.Extensions.Logging.EventId"/> instances have different values.
</summary>
<param name="left">The first <see cref="T:Microsoft.Extensions.Logging.EventId"/>.</param>
<param name="right">The second <see cref="T:Microsoft.Extensions.Logging.EventId"/>.</param>
<returns><see langword="true" /> if the objects are not equal.</returns>
</member>
<member name="M:Microsoft.Extensions.Logging.EventId.#ctor(System.Int32,System.String)">
<summary>
Initializes an instance of the <see cref="T:Microsoft.Extensions.Logging.EventId"/> struct.
</summary>
<param name="id">The numeric identifier for this event.</param>
<param name="name">The name of this event.</param>
</member>
<member name="P:Microsoft.Extensions.Logging.EventId.Id">
<summary>
Gets the numeric identifier for this event.
</summary>
</member>
<member name="P:Microsoft.Extensions.Logging.EventId.Name">
<summary>
Gets the name of this event.
</summary>
</member>
<member name="M:Microsoft.Extensions.Logging.EventId.ToString">
<inheritdoc />
</member>
<member name="M:Microsoft.Extensions.Logging.EventId.Equals(Microsoft.Extensions.Logging.EventId)">
<summary>
Indicates whether the current object is equal to another object of the same type. Two events are equal if they have the same id.
</summary>
<param name="other">An object to compare with this object.</param>
<returns><see langword="true" /> if the current object is equal to the other parameter; otherwise, <see langword="false" />.</returns>
</member>
<member name="M:Microsoft.Extensions.Logging.EventId.Equals(System.Object)">
<inheritdoc />
</member>
<member name="M:Microsoft.Extensions.Logging.EventId.GetHashCode">
<inheritdoc />
</member>
<member name="T:Microsoft.Extensions.Logging.FormattedLogValues">
<summary>
LogValues to enable formatting options supported by <see cref="M:System.String.Format(System.IFormatProvider,System.String,System.Object)"/>.
This also enables using {NamedformatItem} in the format string.
</summary>
</member>
<member name="T:Microsoft.Extensions.Logging.IExternalScopeProvider">
<summary>
Represents a storage of common scope data.
</summary>
</member>
<member name="M:Microsoft.Extensions.Logging.IExternalScopeProvider.ForEachScope``1(System.Action{System.Object,``0},``0)">
<summary>
Executes callback for each currently active scope objects in order of creation.
All callbacks are guaranteed to be called inline from this method.
</summary>
<param name="callback">The callback to be executed for every scope object</param>
<param name="state">The state object to be passed into the callback</param>
<typeparam name="TState">The type of state to accept.</typeparam>
</member>
<member name="M:Microsoft.Extensions.Logging.IExternalScopeProvider.Push(System.Object)">
<summary>
Adds scope object to the list
</summary>
<param name="state">The scope object</param>
<returns>The <see cref="T:System.IDisposable"/> token that removes scope on dispose.</returns>
</member>
<member name="T:Microsoft.Extensions.Logging.ILogger">
<summary>
Represents a type used to perform logging.
</summary>
<remarks>Aggregates most logging patterns to a single method.</remarks>
</member>
<member name="M:Microsoft.Extensions.Logging.ILogger.Log``1(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,``0,System.Exception,System.Func{``0,System.Exception,System.String})">
<summary>
Writes a log entry.
</summary>
<param name="logLevel">Entry will be written on this level.</param>
<param name="eventId">Id of the event.</param>
<param name="state">The entry to be written. Can be also an object.</param>
<param name="exception">The exception related to this entry.</param>
<param name="formatter">Function to create a <see cref="T:System.String"/> message of the <paramref name="state"/> and <paramref name="exception"/>.</param>
<typeparam name="TState">The type of the object to be written.</typeparam>
</member>
<member name="M:Microsoft.Extensions.Logging.ILogger.IsEnabled(Microsoft.Extensions.Logging.LogLevel)">
<summary>
Checks if the given <paramref name="logLevel"/> is enabled.
</summary>
<param name="logLevel">Level to be checked.</param>
<returns><c>true</c> if enabled.</returns>
</member>
<member name="M:Microsoft.Extensions.Logging.ILogger.BeginScope``1(``0)">
<summary>
Begins a logical operation scope.
</summary>
<param name="state">The identifier for the scope.</param>
<typeparam name="TState">The type of the state to begin scope for.</typeparam>
<returns>An <see cref="T:System.IDisposable"/> that ends the logical operation scope on dispose.</returns>
</member>
<member name="T:Microsoft.Extensions.Logging.ILoggerFactory">
<summary>
Represents a type used to configure the logging system and create instances of <see cref="T:Microsoft.Extensions.Logging.ILogger"/> from
the registered <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider"/>s.
</summary>
</member>
<member name="M:Microsoft.Extensions.Logging.ILoggerFactory.CreateLogger(System.String)">
<summary>
Creates a new <see cref="T:Microsoft.Extensions.Logging.ILogger"/> instance.
</summary>
<param name="categoryName">The category name for messages produced by the logger.</param>
<returns>The <see cref="T:Microsoft.Extensions.Logging.ILogger"/>.</returns>
</member>
<member name="M:Microsoft.Extensions.Logging.ILoggerFactory.AddProvider(Microsoft.Extensions.Logging.ILoggerProvider)">
<summary>
Adds an <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider"/> to the logging system.
</summary>
<param name="provider">The <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider"/>.</param>
</member>
<member name="T:Microsoft.Extensions.Logging.ILoggerProvider">
<summary>
Represents a type that can create instances of <see cref="T:Microsoft.Extensions.Logging.ILogger"/>.
</summary>
</member>
<member name="M:Microsoft.Extensions.Logging.ILoggerProvider.CreateLogger(System.String)">
<summary>
Creates a new <see cref="T:Microsoft.Extensions.Logging.ILogger"/> instance.
</summary>
<param name="categoryName">The category name for messages produced by the logger.</param>
<returns>The instance of <see cref="T:Microsoft.Extensions.Logging.ILogger"/> that was created.</returns>
</member>
<member name="T:Microsoft.Extensions.Logging.ILogger`1">
<summary>
A generic interface for logging where the category name is derived from the specified
<typeparamref name="TCategoryName"/> type name.
Generally used to enable activation of a named <see cref="T:Microsoft.Extensions.Logging.ILogger"/> from dependency injection.
</summary>
<typeparam name="TCategoryName">The type whose name is used for the logger category name.</typeparam>
</member>
<member name="T:Microsoft.Extensions.Logging.ISupportExternalScope">
<summary>
Represents a <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider"/> that is able to consume external scope information.
</summary>
</member>
<member name="M:Microsoft.Extensions.Logging.ISupportExternalScope.SetScopeProvider(Microsoft.Extensions.Logging.IExternalScopeProvider)">
<summary>
Sets external scope information source for logger provider.
</summary>
<param name="scopeProvider">The provider of scope data.</param>
</member>
<member name="T:Microsoft.Extensions.Logging.LogDefineOptions">
<summary>
Options for <see cref="M:Microsoft.Extensions.Logging.LoggerMessage.Define(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String)"/> and its overloads
</summary>
</member>
<member name="P:Microsoft.Extensions.Logging.LogDefineOptions.SkipEnabledCheck">
<summary>
Gets or sets the flag to skip IsEnabled check for the logging method.
</summary>
</member>
<member name="T:Microsoft.Extensions.Logging.Abstractions.LogEntry`1">
<summary>
Holds the information for a single log entry.
</summary>
</member>
<member name="M:Microsoft.Extensions.Logging.Abstractions.LogEntry`1.#ctor(Microsoft.Extensions.Logging.LogLevel,System.String,Microsoft.Extensions.Logging.EventId,`0,System.Exception,System.Func{`0,System.Exception,System.String})">
<summary>
Initializes an instance of the LogEntry struct.
</summary>
<param name="logLevel">The log level.</param>
<param name="category">The category name for the log.</param>
<param name="eventId">The log event Id.</param>
<param name="state">The state for which log is being written.</param>
<param name="exception">The log exception.</param>
<param name="formatter">The formatter.</param>
</member>
<member name="P:Microsoft.Extensions.Logging.Abstractions.LogEntry`1.LogLevel">
<summary>
Gets the LogLevel
</summary>
</member>
<member name="P:Microsoft.Extensions.Logging.Abstractions.LogEntry`1.Category">
<summary>
Gets the log category
</summary>
</member>
<member name="P:Microsoft.Extensions.Logging.Abstractions.LogEntry`1.EventId">
<summary>
Gets the log EventId
</summary>
</member>
<member name="P:Microsoft.Extensions.Logging.Abstractions.LogEntry`1.State">
<summary>
Gets the TState
</summary>
</member>
<member name="P:Microsoft.Extensions.Logging.Abstractions.LogEntry`1.Exception">
<summary>
Gets the log exception
</summary>
</member>
<member name="P:Microsoft.Extensions.Logging.Abstractions.LogEntry`1.Formatter">
<summary>
Gets the formatter
</summary>
</member>
<member name="T:Microsoft.Extensions.Logging.Abstractions.NullLogger">
<summary>
Minimalistic logger that does nothing.
</summary>
</member>
<member name="P:Microsoft.Extensions.Logging.Abstractions.NullLogger.Instance">
<summary>
Returns the shared instance of <see cref="T:Microsoft.Extensions.Logging.Abstractions.NullLogger"/>.
</summary>
</member>
<member name="M:Microsoft.Extensions.Logging.Abstractions.NullLogger.BeginScope``1(``0)">
<inheritdoc />
</member>
<member name="M:Microsoft.Extensions.Logging.Abstractions.NullLogger.IsEnabled(Microsoft.Extensions.Logging.LogLevel)">
<inheritdoc />
</member>
<member name="M:Microsoft.Extensions.Logging.Abstractions.NullLogger.Log``1(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,``0,System.Exception,System.Func{``0,System.Exception,System.String})">
<inheritdoc />
</member>
<member name="T:Microsoft.Extensions.Logging.Abstractions.NullLoggerFactory">
<summary>
An <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory"/> used to create instance of
<see cref="T:Microsoft.Extensions.Logging.Abstractions.NullLogger"/> that logs nothing.
</summary>
</member>
<member name="M:Microsoft.Extensions.Logging.Abstractions.NullLoggerFactory.#ctor">
<summary>
Creates a new <see cref="T:Microsoft.Extensions.Logging.Abstractions.NullLoggerFactory"/> instance.
</summary>
</member>
<member name="F:Microsoft.Extensions.Logging.Abstractions.NullLoggerFactory.Instance">
<summary>
Returns the shared instance of <see cref="T:Microsoft.Extensions.Logging.Abstractions.NullLoggerFactory"/>.
</summary>
</member>
<member name="M:Microsoft.Extensions.Logging.Abstractions.NullLoggerFactory.CreateLogger(System.String)">
<inheritdoc />
<remarks>
This returns a <see cref="T:Microsoft.Extensions.Logging.Abstractions.NullLogger"/> instance which logs nothing.
</remarks>
</member>
<member name="M:Microsoft.Extensions.Logging.Abstractions.NullLoggerFactory.AddProvider(Microsoft.Extensions.Logging.ILoggerProvider)">
<inheritdoc />
<remarks>
This method ignores the parameter and does nothing.
</remarks>
</member>
<member name="M:Microsoft.Extensions.Logging.Abstractions.NullLoggerFactory.Dispose">
<inheritdoc />
</member>
<member name="T:Microsoft.Extensions.Logging.Abstractions.NullLoggerProvider">
<summary>
Provider for the <see cref="T:Microsoft.Extensions.Logging.Abstractions.NullLogger"/>.
</summary>
</member>
<member name="P:Microsoft.Extensions.Logging.Abstractions.NullLoggerProvider.Instance">
<summary>
Returns an instance of <see cref="T:Microsoft.Extensions.Logging.Abstractions.NullLoggerProvider"/>.
</summary>
</member>
<member name="M:Microsoft.Extensions.Logging.Abstractions.NullLoggerProvider.CreateLogger(System.String)">
<inheritdoc />
</member>
<member name="M:Microsoft.Extensions.Logging.Abstractions.NullLoggerProvider.Dispose">
<inheritdoc />
</member>
<member name="T:Microsoft.Extensions.Logging.Abstractions.NullLogger`1">
<summary>
Minimalistic logger that does nothing.
</summary>
</member>
<member name="F:Microsoft.Extensions.Logging.Abstractions.NullLogger`1.Instance">
<summary>
Returns an instance of <see cref="T:Microsoft.Extensions.Logging.Abstractions.NullLogger`1"/>.
</summary>
<returns>An instance of <see cref="T:Microsoft.Extensions.Logging.Abstractions.NullLogger`1"/>.</returns>
</member>
<member name="M:Microsoft.Extensions.Logging.Abstractions.NullLogger`1.BeginScope``1(``0)">
<inheritdoc />
</member>
<member name="M:Microsoft.Extensions.Logging.Abstractions.NullLogger`1.Log``1(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,``0,System.Exception,System.Func{``0,System.Exception,System.String})">
<inheritdoc />
<remarks>
This method ignores the parameters and does nothing.
</remarks>
</member>
<member name="M:Microsoft.Extensions.Logging.Abstractions.NullLogger`1.IsEnabled(Microsoft.Extensions.Logging.LogLevel)">
<inheritdoc />
</member>
<member name="T:Microsoft.Extensions.Logging.LoggerExtensions">
<summary>
ILogger extension methods for common scenarios.
</summary>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogDebug(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.Exception,System.String,System.Object[])">
<summary>
Formats and writes a debug log message.
</summary>
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
<param name="eventId">The event id associated with the log.</param>
<param name="exception">The exception to log.</param>
<param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
<param name="args">An object array that contains zero or more objects to format.</param>
<example>logger.LogDebug(0, exception, "Error while processing request from {Address}", address)</example>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogDebug(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.String,System.Object[])">
<summary>
Formats and writes a debug log message.
</summary>
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
<param name="eventId">The event id associated with the log.</param>
<param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
<param name="args">An object array that contains zero or more objects to format.</param>
<example>logger.LogDebug(0, "Processing request from {Address}", address)</example>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogDebug(Microsoft.Extensions.Logging.ILogger,System.Exception,System.String,System.Object[])">
<summary>
Formats and writes a debug log message.
</summary>
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
<param name="exception">The exception to log.</param>
<param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
<param name="args">An object array that contains zero or more objects to format.</param>
<example>logger.LogDebug(exception, "Error while processing request from {Address}", address)</example>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogDebug(Microsoft.Extensions.Logging.ILogger,System.String,System.Object[])">
<summary>
Formats and writes a debug log message.
</summary>
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
<param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
<param name="args">An object array that contains zero or more objects to format.</param>
<example>logger.LogDebug("Processing request from {Address}", address)</example>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogTrace(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.Exception,System.String,System.Object[])">
<summary>
Formats and writes a trace log message.
</summary>
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
<param name="eventId">The event id associated with the log.</param>
<param name="exception">The exception to log.</param>
<param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
<param name="args">An object array that contains zero or more objects to format.</param>
<example>logger.LogTrace(0, exception, "Error while processing request from {Address}", address)</example>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogTrace(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.String,System.Object[])">
<summary>
Formats and writes a trace log message.
</summary>
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
<param name="eventId">The event id associated with the log.</param>
<param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
<param name="args">An object array that contains zero or more objects to format.</param>
<example>logger.LogTrace(0, "Processing request from {Address}", address)</example>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogTrace(Microsoft.Extensions.Logging.ILogger,System.Exception,System.String,System.Object[])">
<summary>
Formats and writes a trace log message.
</summary>
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
<param name="exception">The exception to log.</param>
<param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
<param name="args">An object array that contains zero or more objects to format.</param>
<example>logger.LogTrace(exception, "Error while processing request from {Address}", address)</example>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogTrace(Microsoft.Extensions.Logging.ILogger,System.String,System.Object[])">
<summary>
Formats and writes a trace log message.
</summary>
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
<param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
<param name="args">An object array that contains zero or more objects to format.</param>
<example>logger.LogTrace("Processing request from {Address}", address)</example>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogInformation(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.Exception,System.String,System.Object[])">
<summary>
Formats and writes an informational log message.
</summary>
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
<param name="eventId">The event id associated with the log.</param>
<param name="exception">The exception to log.</param>
<param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
<param name="args">An object array that contains zero or more objects to format.</param>
<example>logger.LogInformation(0, exception, "Error while processing request from {Address}", address)</example>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogInformation(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.String,System.Object[])">
<summary>
Formats and writes an informational log message.
</summary>
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
<param name="eventId">The event id associated with the log.</param>
<param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
<param name="args">An object array that contains zero or more objects to format.</param>
<example>logger.LogInformation(0, "Processing request from {Address}", address)</example>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogInformation(Microsoft.Extensions.Logging.ILogger,System.Exception,System.String,System.Object[])">
<summary>
Formats and writes an informational log message.
</summary>
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
<param name="exception">The exception to log.</param>
<param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
<param name="args">An object array that contains zero or more objects to format.</param>
<example>logger.LogInformation(exception, "Error while processing request from {Address}", address)</example>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogInformation(Microsoft.Extensions.Logging.ILogger,System.String,System.Object[])">
<summary>
Formats and writes an informational log message.
</summary>
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
<param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
<param name="args">An object array that contains zero or more objects to format.</param>
<example>logger.LogInformation("Processing request from {Address}", address)</example>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogWarning(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.Exception,System.String,System.Object[])">
<summary>
Formats and writes a warning log message.
</summary>
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
<param name="eventId">The event id associated with the log.</param>
<param name="exception">The exception to log.</param>
<param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
<param name="args">An object array that contains zero or more objects to format.</param>
<example>logger.LogWarning(0, exception, "Error while processing request from {Address}", address)</example>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogWarning(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.String,System.Object[])">
<summary>
Formats and writes a warning log message.
</summary>
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
<param name="eventId">The event id associated with the log.</param>
<param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
<param name="args">An object array that contains zero or more objects to format.</param>
<example>logger.LogWarning(0, "Processing request from {Address}", address)</example>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogWarning(Microsoft.Extensions.Logging.ILogger,System.Exception,System.String,System.Object[])">
<summary>
Formats and writes a warning log message.
</summary>
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
<param name="exception">The exception to log.</param>
<param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
<param name="args">An object array that contains zero or more objects to format.</param>
<example>logger.LogWarning(exception, "Error while processing request from {Address}", address)</example>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogWarning(Microsoft.Extensions.Logging.ILogger,System.String,System.Object[])">
<summary>
Formats and writes a warning log message.
</summary>
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
<param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
<param name="args">An object array that contains zero or more objects to format.</param>
<example>logger.LogWarning("Processing request from {Address}", address)</example>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogError(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.Exception,System.String,System.Object[])">
<summary>
Formats and writes an error log message.
</summary>
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
<param name="eventId">The event id associated with the log.</param>
<param name="exception">The exception to log.</param>
<param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
<param name="args">An object array that contains zero or more objects to format.</param>
<example>logger.LogError(0, exception, "Error while processing request from {Address}", address)</example>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogError(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.String,System.Object[])">
<summary>
Formats and writes an error log message.
</summary>
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
<param name="eventId">The event id associated with the log.</param>
<param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
<param name="args">An object array that contains zero or more objects to format.</param>
<example>logger.LogError(0, "Processing request from {Address}", address)</example>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogError(Microsoft.Extensions.Logging.ILogger,System.Exception,System.String,System.Object[])">
<summary>
Formats and writes an error log message.
</summary>
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
<param name="exception">The exception to log.</param>
<param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
<param name="args">An object array that contains zero or more objects to format.</param>
<example>logger.LogError(exception, "Error while processing request from {Address}", address)</example>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogError(Microsoft.Extensions.Logging.ILogger,System.String,System.Object[])">
<summary>
Formats and writes an error log message.
</summary>
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
<param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
<param name="args">An object array that contains zero or more objects to format.</param>
<example>logger.LogError("Processing request from {Address}", address)</example>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogCritical(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.Exception,System.String,System.Object[])">
<summary>
Formats and writes a critical log message.
</summary>
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
<param name="eventId">The event id associated with the log.</param>
<param name="exception">The exception to log.</param>
<param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
<param name="args">An object array that contains zero or more objects to format.</param>
<example>logger.LogCritical(0, exception, "Error while processing request from {Address}", address)</example>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogCritical(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.String,System.Object[])">
<summary>
Formats and writes a critical log message.
</summary>
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
<param name="eventId">The event id associated with the log.</param>
<param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
<param name="args">An object array that contains zero or more objects to format.</param>
<example>logger.LogCritical(0, "Processing request from {Address}", address)</example>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogCritical(Microsoft.Extensions.Logging.ILogger,System.Exception,System.String,System.Object[])">
<summary>
Formats and writes a critical log message.
</summary>
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
<param name="exception">The exception to log.</param>
<param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
<param name="args">An object array that contains zero or more objects to format.</param>
<example>logger.LogCritical(exception, "Error while processing request from {Address}", address)</example>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogCritical(Microsoft.Extensions.Logging.ILogger,System.String,System.Object[])">
<summary>
Formats and writes a critical log message.
</summary>
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
<param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
<param name="args">An object array that contains zero or more objects to format.</param>
<example>logger.LogCritical("Processing request from {Address}", address)</example>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.Log(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.LogLevel,System.String,System.Object[])">
<summary>
Formats and writes a log message at the specified log level.
</summary>
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
<param name="logLevel">Entry will be written on this level.</param>
<param name="message">Format string of the log message.</param>
<param name="args">An object array that contains zero or more objects to format.</param>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.Log(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String,System.Object[])">
<summary>
Formats and writes a log message at the specified log level.
</summary>
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
<param name="logLevel">Entry will be written on this level.</param>
<param name="eventId">The event id associated with the log.</param>
<param name="message">Format string of the log message.</param>
<param name="args">An object array that contains zero or more objects to format.</param>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.Log(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.LogLevel,System.Exception,System.String,System.Object[])">
<summary>
Formats and writes a log message at the specified log level.
</summary>
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
<param name="logLevel">Entry will be written on this level.</param>
<param name="exception">The exception to log.</param>
<param name="message">Format string of the log message.</param>
<param name="args">An object array that contains zero or more objects to format.</param>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.Log(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.Exception,System.String,System.Object[])">
<summary>
Formats and writes a log message at the specified log level.
</summary>
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
<param name="logLevel">Entry will be written on this level.</param>
<param name="eventId">The event id associated with the log.</param>
<param name="exception">The exception to log.</param>
<param name="message">Format string of the log message.</param>
<param name="args">An object array that contains zero or more objects to format.</param>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.BeginScope(Microsoft.Extensions.Logging.ILogger,System.String,System.Object[])">
<summary>
Formats the message and creates a scope.
</summary>
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to create the scope in.</param>
<param name="messageFormat">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}"</c></param>
<param name="args">An object array that contains zero or more objects to format.</param>
<returns>A disposable scope object. Can be null.</returns>
<example>
using(logger.BeginScope("Processing request from {Address}", address))
{
}
</example>
</member>
<member name="T:Microsoft.Extensions.Logging.LoggerExternalScopeProvider">
<summary>
Default implementation of <see cref="T:Microsoft.Extensions.Logging.IExternalScopeProvider"/>
</summary>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerExternalScopeProvider.#ctor">
<summary>
Creates a new <see cref="T:Microsoft.Extensions.Logging.LoggerExternalScopeProvider"/>.
</summary>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerExternalScopeProvider.ForEachScope``1(System.Action{System.Object,``0},``0)">
<inheritdoc />
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerExternalScopeProvider.Push(System.Object)">
<inheritdoc />
</member>
<member name="T:Microsoft.Extensions.Logging.LoggerFactoryExtensions">
<summary>
ILoggerFactory extension methods for common scenarios.
</summary>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerFactoryExtensions.CreateLogger``1(Microsoft.Extensions.Logging.ILoggerFactory)">
<summary>
Creates a new <see cref="T:Microsoft.Extensions.Logging.ILogger"/> instance using the full name of the given type.
</summary>
<param name="factory">The factory.</param>
<typeparam name="T">The type.</typeparam>
<returns>The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> that was created.</returns>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerFactoryExtensions.CreateLogger(Microsoft.Extensions.Logging.ILoggerFactory,System.Type)">
<summary>
Creates a new <see cref="T:Microsoft.Extensions.Logging.ILogger"/> instance using the full name of the given <paramref name="type"/>.
</summary>
<param name="factory">The factory.</param>
<param name="type">The type.</param>
<returns>The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> that was created.</returns>
</member>
<member name="T:Microsoft.Extensions.Logging.LoggerMessage">
<summary>
Creates delegates which can be later cached to log messages in a performant way.
</summary>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerMessage.DefineScope(System.String)">
<summary>
Creates a delegate which can be invoked to create a log scope.
</summary>
<param name="formatString">The named format string</param>
<returns>A delegate which when invoked creates a log scope.</returns>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerMessage.DefineScope``1(System.String)">
<summary>
Creates a delegate which can be invoked to create a log scope.
</summary>
<typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
<param name="formatString">The named format string</param>
<returns>A delegate which when invoked creates a log scope.</returns>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerMessage.DefineScope``2(System.String)">
<summary>
Creates a delegate which can be invoked to create a log scope.
</summary>
<typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
<typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
<param name="formatString">The named format string</param>
<returns>A delegate which when invoked creates a log scope.</returns>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerMessage.DefineScope``3(System.String)">
<summary>
Creates a delegate which can be invoked to create a log scope.
</summary>
<typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
<typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
<typeparam name="T3">The type of the third parameter passed to the named format string.</typeparam>
<param name="formatString">The named format string</param>
<returns>A delegate which when invoked creates a log scope.</returns>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerMessage.DefineScope``4(System.String)">
<summary>
Creates a delegate which can be invoked to create a log scope.
</summary>
<typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
<typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
<typeparam name="T3">The type of the third parameter passed to the named format string.</typeparam>
<typeparam name="T4">The type of the fourth parameter passed to the named format string.</typeparam>
<param name="formatString">The named format string</param>
<returns>A delegate which when invoked creates a log scope.</returns>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerMessage.DefineScope``5(System.String)">
<summary>
Creates a delegate which can be invoked to create a log scope.
</summary>
<typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
<typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
<typeparam name="T3">The type of the third parameter passed to the named format string.</typeparam>
<typeparam name="T4">The type of the fourth parameter passed to the named format string.</typeparam>
<typeparam name="T5">The type of the fifth parameter passed to the named format string.</typeparam>
<param name="formatString">The named format string</param>
<returns>A delegate which when invoked creates a log scope.</returns>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerMessage.DefineScope``6(System.String)">
<summary>
Creates a delegate which can be invoked to create a log scope.
</summary>
<typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
<typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
<typeparam name="T3">The type of the third parameter passed to the named format string.</typeparam>
<typeparam name="T4">The type of the fourth parameter passed to the named format string.</typeparam>
<typeparam name="T5">The type of the fifth parameter passed to the named format string.</typeparam>
<typeparam name="T6">The type of the sixth parameter passed to the named format string.</typeparam>
<param name="formatString">The named format string</param>
<returns>A delegate which when invoked creates a log scope.</returns>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String)">
<summary>
Creates a delegate which can be invoked for logging a message.
</summary>
<param name="logLevel">The <see cref="T:Microsoft.Extensions.Logging.LogLevel"/></param>
<param name="eventId">The event id</param>
<param name="formatString">The named format string</param>
<returns>A delegate which when invoked creates a log message.</returns>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String,Microsoft.Extensions.Logging.LogDefineOptions)">
<summary>
Creates a delegate which can be invoked for logging a message.
</summary>
<param name="logLevel">The <see cref="T:Microsoft.Extensions.Logging.LogLevel"/></param>
<param name="eventId">The event id</param>
<param name="formatString">The named format string</param>
<param name="options">The <see cref="T:Microsoft.Extensions.Logging.LogDefineOptions"/></param>
<returns>A delegate which when invoked creates a log message.</returns>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define``1(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String)">
<summary>
Creates a delegate which can be invoked for logging a message.
</summary>
<typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
<param name="logLevel">The <see cref="T:Microsoft.Extensions.Logging.LogLevel"/></param>
<param name="eventId">The event id</param>
<param name="formatString">The named format string</param>
<returns>A delegate which when invoked creates a log message.</returns>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define``1(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String,Microsoft.Extensions.Logging.LogDefineOptions)">
<summary>
Creates a delegate which can be invoked for logging a message.
</summary>
<typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
<param name="logLevel">The <see cref="T:Microsoft.Extensions.Logging.LogLevel"/></param>
<param name="eventId">The event id</param>
<param name="formatString">The named format string</param>
<param name="options">The <see cref="T:Microsoft.Extensions.Logging.LogDefineOptions"/></param>
<returns>A delegate which when invoked creates a log message.</returns>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define``2(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String)">
<summary>
Creates a delegate which can be invoked for logging a message.
</summary>
<typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
<typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
<param name="logLevel">The <see cref="T:Microsoft.Extensions.Logging.LogLevel"/></param>
<param name="eventId">The event id</param>
<param name="formatString">The named format string</param>
<returns>A delegate which when invoked creates a log message.</returns>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define``2(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String,Microsoft.Extensions.Logging.LogDefineOptions)">
<summary>
Creates a delegate which can be invoked for logging a message.
</summary>
<typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
<typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
<param name="logLevel">The <see cref="T:Microsoft.Extensions.Logging.LogLevel"/></param>
<param name="eventId">The event id</param>
<param name="formatString">The named format string</param>
<param name="options">The <see cref="T:Microsoft.Extensions.Logging.LogDefineOptions"/></param>
<returns>A delegate which when invoked creates a log message.</returns>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define``3(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String)">
<summary>
Creates a delegate which can be invoked for logging a message.
</summary>
<typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
<typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
<typeparam name="T3">The type of the third parameter passed to the named format string.</typeparam>
<param name="logLevel">The <see cref="T:Microsoft.Extensions.Logging.LogLevel"/></param>
<param name="eventId">The event id</param>
<param name="formatString">The named format string</param>
<returns>A delegate which when invoked creates a log message.</returns>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define``3(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String,Microsoft.Extensions.Logging.LogDefineOptions)">
<summary>
Creates a delegate which can be invoked for logging a message.
</summary>
<typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
<typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
<typeparam name="T3">The type of the third parameter passed to the named format string.</typeparam>
<param name="logLevel">The <see cref="T:Microsoft.Extensions.Logging.LogLevel"/></param>
<param name="eventId">The event id</param>
<param name="formatString">The named format string</param>
<param name="options">The <see cref="T:Microsoft.Extensions.Logging.LogDefineOptions"/></param>
<returns>A delegate which when invoked creates a log message.</returns>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define``4(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String)">
<summary>
Creates a delegate which can be invoked for logging a message.
</summary>
<typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
<typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
<typeparam name="T3">The type of the third parameter passed to the named format string.</typeparam>
<typeparam name="T4">The type of the fourth parameter passed to the named format string.</typeparam>
<param name="logLevel">The <see cref="T:Microsoft.Extensions.Logging.LogLevel"/></param>
<param name="eventId">The event id</param>
<param name="formatString">The named format string</param>
<returns>A delegate which when invoked creates a log message.</returns>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define``4(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String,Microsoft.Extensions.Logging.LogDefineOptions)">
<summary>
Creates a delegate which can be invoked for logging a message.
</summary>
<typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
<typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
<typeparam name="T3">The type of the third parameter passed to the named format string.</typeparam>
<typeparam name="T4">The type of the fourth parameter passed to the named format string.</typeparam>
<param name="logLevel">The <see cref="T:Microsoft.Extensions.Logging.LogLevel"/></param>
<param name="eventId">The event id</param>
<param name="formatString">The named format string</param>
<param name="options">The <see cref="T:Microsoft.Extensions.Logging.LogDefineOptions"/></param>
<returns>A delegate which when invoked creates a log message.</returns>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define``5(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String)">
<summary>
Creates a delegate which can be invoked for logging a message.
</summary>
<typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
<typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
<typeparam name="T3">The type of the third parameter passed to the named format string.</typeparam>
<typeparam name="T4">The type of the fourth parameter passed to the named format string.</typeparam>
<typeparam name="T5">The type of the fifth parameter passed to the named format string.</typeparam>
<param name="logLevel">The <see cref="T:Microsoft.Extensions.Logging.LogLevel"/></param>
<param name="eventId">The event id</param>
<param name="formatString">The named format string</param>
<returns>A delegate which when invoked creates a log message.</returns>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define``5(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String,Microsoft.Extensions.Logging.LogDefineOptions)">
<summary>
Creates a delegate which can be invoked for logging a message.
</summary>
<typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
<typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
<typeparam name="T3">The type of the third parameter passed to the named format string.</typeparam>
<typeparam name="T4">The type of the fourth parameter passed to the named format string.</typeparam>
<typeparam name="T5">The type of the fifth parameter passed to the named format string.</typeparam>
<param name="logLevel">The <see cref="T:Microsoft.Extensions.Logging.LogLevel"/></param>
<param name="eventId">The event id</param>
<param name="formatString">The named format string</param>
<param name="options">The <see cref="T:Microsoft.Extensions.Logging.LogDefineOptions"/></param>
<returns>A delegate which when invoked creates a log message.</returns>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define``6(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String)">
<summary>
Creates a delegate which can be invoked for logging a message.
</summary>
<typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
<typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
<typeparam name="T3">The type of the third parameter passed to the named format string.</typeparam>
<typeparam name="T4">The type of the fourth parameter passed to the named format string.</typeparam>
<typeparam name="T5">The type of the fifth parameter passed to the named format string.</typeparam>
<typeparam name="T6">The type of the sixth parameter passed to the named format string.</typeparam>
<param name="logLevel">The <see cref="T:Microsoft.Extensions.Logging.LogLevel"/></param>
<param name="eventId">The event id</param>
<param name="formatString">The named format string</param>
<returns>A delegate which when invoked creates a log message.</returns>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define``6(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String,Microsoft.Extensions.Logging.LogDefineOptions)">
<summary>
Creates a delegate which can be invoked for logging a message.
</summary>
<typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
<typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
<typeparam name="T3">The type of the third parameter passed to the named format string.</typeparam>
<typeparam name="T4">The type of the fourth parameter passed to the named format string.</typeparam>
<typeparam name="T5">The type of the fifth parameter passed to the named format string.</typeparam>
<typeparam name="T6">The type of the sixth parameter passed to the named format string.</typeparam>
<param name="logLevel">The <see cref="T:Microsoft.Extensions.Logging.LogLevel"/></param>
<param name="eventId">The event id</param>
<param name="formatString">The named format string</param>
<param name="options">The <see cref="T:Microsoft.Extensions.Logging.LogDefineOptions"/></param>
<returns>A delegate which when invoked creates a log message.</returns>
</member>
<member name="T:Microsoft.Extensions.Logging.LoggerMessageAttribute">
<summary>
Provides information to guide the production of a strongly-typed logging method.
</summary>
<remarks>
<para>The method this attribute is applied to:</para>
<para> - Must be a partial method.</para>
<para> - Must return <c>void</c>.</para>
<para> - Must not be generic.</para>
<para> - Must have an <see cref="T:Microsoft.Extensions.Logging.ILogger"/> as one of its parameters.</para>
<para> - Must have a <see cref="T:Microsoft.Extensions.Logging.LogLevel"/> as one of its parameters.</para>
<para> - None of the parameters can be generic.</para>
</remarks>
<example>
<format type="text/markdown"><![CDATA[
```csharp
static partial class Log
{
[LoggerMessage(EventId = 0, Message = "Could not open socket for {hostName}")]
static partial void CouldNotOpenSocket(ILogger logger, LogLevel level, string hostName);
}
```
]]></format>
</example>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerMessageAttribute.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Extensions.Logging.LoggerMessageAttribute"/> class
which is used to guide the production of a strongly-typed logging method.
</summary>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerMessageAttribute.#ctor(System.Int32,Microsoft.Extensions.Logging.LogLevel,System.String)">
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Extensions.Logging.LoggerMessageAttribute"/> class
which is used to guide the production of a strongly-typed logging method.
</summary>
<param name="eventId">The log event Id.</param>
<param name="level">The log level.</param>
<param name="message">Format string of the log message.</param>
</member>
<member name="P:Microsoft.Extensions.Logging.LoggerMessageAttribute.EventId">
<summary>
Gets the logging event id for the logging method.
</summary>
</member>
<member name="P:Microsoft.Extensions.Logging.LoggerMessageAttribute.EventName">
<summary>
Gets or sets the logging event name for the logging method.
</summary>
<remarks>
This will equal the method name if not specified.
</remarks>
</member>
<member name="P:Microsoft.Extensions.Logging.LoggerMessageAttribute.Level">
<summary>
Gets the logging level for the logging method.
</summary>
</member>
<member name="P:Microsoft.Extensions.Logging.LoggerMessageAttribute.Message">
<summary>
Gets the message text for the logging method.
</summary>
</member>
<member name="P:Microsoft.Extensions.Logging.LoggerMessageAttribute.SkipEnabledCheck">
<summary>
Gets the flag to skip IsEnabled check for the logging method.
</summary>
</member>
<member name="T:Microsoft.Extensions.Logging.Logger`1">
<summary>
Delegates to a new <see cref="T:Microsoft.Extensions.Logging.ILogger"/> instance using the full name of the given type, created by the
provided <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory"/>.
</summary>
<typeparam name="T">The type.</typeparam>
</member>
<member name="M:Microsoft.Extensions.Logging.Logger`1.#ctor(Microsoft.Extensions.Logging.ILoggerFactory)">
<summary>
Creates a new <see cref="T:Microsoft.Extensions.Logging.Logger`1"/>.
</summary>
<param name="factory">The factory.</param>
</member>
<member name="M:Microsoft.Extensions.Logging.Logger`1.Microsoft#Extensions#Logging#ILogger#BeginScope``1(``0)">
<inheritdoc />
</member>
<member name="M:Microsoft.Extensions.Logging.Logger`1.Microsoft#Extensions#Logging#ILogger#IsEnabled(Microsoft.Extensions.Logging.LogLevel)">
<inheritdoc />
</member>
<member name="M:Microsoft.Extensions.Logging.Logger`1.Microsoft#Extensions#Logging#ILogger#Log``1(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,``0,System.Exception,System.Func{``0,System.Exception,System.String})">
<inheritdoc />
</member>
<member name="T:Microsoft.Extensions.Logging.LogLevel">
<summary>
Defines logging severity levels.
</summary>
</member>
<member name="F:Microsoft.Extensions.Logging.LogLevel.Trace">
<summary>
Logs that contain the most detailed messages. These messages may contain sensitive application data.
These messages are disabled by default and should never be enabled in a production environment.
</summary>
</member>
<member name="F:Microsoft.Extensions.Logging.LogLevel.Debug">
<summary>
Logs that are used for interactive investigation during development. These logs should primarily contain
information useful for debugging and have no long-term value.
</summary>
</member>
<member name="F:Microsoft.Extensions.Logging.LogLevel.Information">
<summary>
Logs that track the general flow of the application. These logs should have long-term value.
</summary>
</member>
<member name="F:Microsoft.Extensions.Logging.LogLevel.Warning">
<summary>
Logs that highlight an abnormal or unexpected event in the application flow, but do not otherwise cause the
application execution to stop.
</summary>
</member>
<member name="F:Microsoft.Extensions.Logging.LogLevel.Error">
<summary>
Logs that highlight when the current flow of execution is stopped due to a failure. These should indicate a
failure in the current activity, not an application-wide failure.
</summary>
</member>
<member name="F:Microsoft.Extensions.Logging.LogLevel.Critical">
<summary>
Logs that describe an unrecoverable application or system crash, or a catastrophic failure that requires
immediate attention.
</summary>
</member>
<member name="F:Microsoft.Extensions.Logging.LogLevel.None">
<summary>
Not used for writing log messages. Specifies that a logging category should not write any messages.
</summary>
</member>
<member name="T:Microsoft.Extensions.Logging.LogValuesFormatter">
<summary>
Formatter to convert the named format items like {NamedformatItem} to <see cref="M:System.String.Format(System.IFormatProvider,System.String,System.Object)"/> format.
</summary>
</member>
<member name="T:Microsoft.Extensions.Logging.NullExternalScopeProvider">
<summary>
Scope provider that does nothing.
</summary>
</member>
<member name="P:Microsoft.Extensions.Logging.NullExternalScopeProvider.Instance">
<summary>
Returns a cached instance of <see cref="T:Microsoft.Extensions.Logging.NullExternalScopeProvider"/>.
</summary>
</member>
<member name="M:Microsoft.Extensions.Logging.NullExternalScopeProvider.Microsoft#Extensions#Logging#IExternalScopeProvider#ForEachScope``1(System.Action{System.Object,``0},``0)">
<inheritdoc />
</member>
<member name="M:Microsoft.Extensions.Logging.NullExternalScopeProvider.Microsoft#Extensions#Logging#IExternalScopeProvider#Push(System.Object)">
<inheritdoc />
</member>
<member name="T:Microsoft.Extensions.Logging.NullScope">
<summary>
An empty scope without any logic
</summary>
</member>
<member name="M:Microsoft.Extensions.Logging.NullScope.Dispose">
<inheritdoc />
</member>
<member name="M:Microsoft.Extensions.Internal.TypeNameHelper.GetTypeDisplayName(System.Type,System.Boolean,System.Boolean,System.Boolean,System.Char)">
<summary>
Pretty print a type name.
</summary>
<param name="type">The <see cref="T:System.Type"/>.</param>
<param name="fullName"><c>true</c> to print a fully qualified name.</param>
<param name="includeGenericParameterNames"><c>true</c> to include generic parameter names.</param>
<param name="includeGenericParameters"><c>true</c> to include generic parameters.</param>
<param name="nestedTypeDelimiter">Character to use as a delimiter in nested type names</param>
<returns>The pretty printed type name.</returns>
</member>
<member name="M:System.Text.ValueStringBuilder.GetPinnableReference">
<summary>
Get a pinnable reference to the builder.
Does not ensure there is a null char after <see cref="P:System.Text.ValueStringBuilder.Length"/>
This overload is pattern matched in the C# 7.3+ compiler so you can omit
the explicit method call, and write eg "fixed (char* c = builder)"
</summary>
</member>
<member name="M:System.Text.ValueStringBuilder.GetPinnableReference(System.Boolean)">
<summary>
Get a pinnable reference to the builder.
</summary>
<param name="terminate">Ensures that the builder has a null char after <see cref="P:System.Text.ValueStringBuilder.Length"/></param>
</member>
<member name="P:System.Text.ValueStringBuilder.RawChars">
<summary>Returns the underlying storage of the builder.</summary>
</member>
<member name="M:System.Text.ValueStringBuilder.AsSpan(System.Boolean)">
<summary>
Returns a span around the contents of the builder.
</summary>
<param name="terminate">Ensures that the builder has a null char after <see cref="P:System.Text.ValueStringBuilder.Length"/></param>
</member>
<member name="M:System.Text.ValueStringBuilder.Grow(System.Int32)">
<summary>
Resize the internal buffer either by doubling current buffer size or
by adding <paramref name="additionalCapacityBeyondPos"/> to
<see cref="F:System.Text.ValueStringBuilder._pos"/> whichever is greater.
</summary>
<param name="additionalCapacityBeyondPos">
Number of chars requested beyond current position.
</param>
</member>
<member name="M:System.ThrowHelper.ThrowIfNull(System.Object,System.String)">
<summary>Throws an <see cref="T:System.ArgumentNullException"/> if <paramref name="argument"/> is null.</summary>
<param name="argument">The reference type argument to validate as non-null.</param>
<param name="paramName">The name of the parameter with which <paramref name="argument"/> corresponds.</param>
</member>
<member name="P:System.SR.UnexpectedNumberOfNamedParameters">
<summary>The format string '{0}' does not have the expected number of named parameters. Expected {1} parameter(s) but found {2} parameter(s).</summary>
</member>
<member name="T:System.Runtime.InteropServices.LibraryImportAttribute">
<summary>
Attribute used to indicate a source generator should create a function for marshalling
arguments instead of relying on the runtime to generate an equivalent marshalling function at run-time.
</summary>
<remarks>
This attribute is meaningless if the source generator associated with it is not enabled.
The current built-in source generator only supports C# and only supplies an implementation when
applied to static, partial, non-generic methods.
</remarks>
</member>
<member name="M:System.Runtime.InteropServices.LibraryImportAttribute.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:System.Runtime.InteropServices.LibraryImportAttribute"/>.
</summary>
<param name="libraryName">Name of the library containing the import.</param>
</member>
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.LibraryName">
<summary>
Gets the name of the library containing the import.
</summary>
</member>
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.EntryPoint">
<summary>
Gets or sets the name of the entry point to be called.
</summary>
</member>
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling">
<summary>
Gets or sets how to marshal string arguments to the method.
</summary>
<remarks>
If this field is set to a value other than <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />,
<see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType" /> must not be specified.
</remarks>
</member>
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType">
<summary>
Gets or sets the <see cref="T:System.Type"/> used to control how string arguments to the method are marshalled.
</summary>
<remarks>
If this field is specified, <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling" /> must not be specified
or must be set to <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />.
</remarks>
</member>
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.SetLastError">
<summary>
Gets or sets whether the callee sets an error (SetLastError on Windows or errno
on other platforms) before returning from the attributed method.
</summary>
</member>
<member name="T:System.Runtime.InteropServices.StringMarshalling">
<summary>
Specifies how strings should be marshalled for generated p/invokes
</summary>
</member>
<member name="F:System.Runtime.InteropServices.StringMarshalling.Custom">
<summary>
Indicates the user is suppling a specific marshaller in <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType"/>.
</summary>
</member>
<member name="F:System.Runtime.InteropServices.StringMarshalling.Utf8">
<summary>
Use the platform-provided UTF-8 marshaller.
</summary>
</member>
<member name="F:System.Runtime.InteropServices.StringMarshalling.Utf16">
<summary>
Use the platform-provided UTF-16 marshaller.
</summary>
</member>
</members>
</doc>
md5: 3F6480B7C509FC21AAF73C32B9FF7AA8 | sha1: C623BA7AAF28DFE6B54FC0AD43C6EBA912C6B336 | sha256: 6833A9076B9A4BB4195C87CDAC7CCF4B99B86D1FC848A08E074D668D1E03530E | sha512: D8CE36217497231FACAA58FD66C560DE785521C86B04233DE20D7D25446C74D9D75504D24F5F691058773CBA62381FFA2EB66F2254CAECA3287D883888E80586
<?xml version="1.0"?>
<doc>
<assembly>
<name>Microsoft.Extensions.Logging</name>
</assembly>
<members>
<member name="T:Microsoft.Extensions.Logging.ActivityTrackingOptions">
<summary>
Flags to indicate which trace context parts should be included with the logging scopes.
</summary>
</member>
<member name="F:Microsoft.Extensions.Logging.ActivityTrackingOptions.None">
<summary>
None of the trace context part will be included in the logging.
</summary>
</member>
<member name="F:Microsoft.Extensions.Logging.ActivityTrackingOptions.SpanId">
<summary>
Span Id will be included in the logging.
</summary>
</member>
<member name="F:Microsoft.Extensions.Logging.ActivityTrackingOptions.TraceId">
<summary>
Trace Id will be included in the logging.
</summary>
</member>
<member name="F:Microsoft.Extensions.Logging.ActivityTrackingOptions.ParentId">
<summary>
Parent Id will be included in the logging.
</summary>
</member>
<member name="F:Microsoft.Extensions.Logging.ActivityTrackingOptions.TraceState">
<summary>
Trace State will be included in the logging.
</summary>
</member>
<member name="F:Microsoft.Extensions.Logging.ActivityTrackingOptions.TraceFlags">
<summary>
Trace flags will be included in the logging.
</summary>
</member>
<member name="F:Microsoft.Extensions.Logging.ActivityTrackingOptions.Tags">
<summary>
Tags will be included in the logging.
</summary>
</member>
<member name="F:Microsoft.Extensions.Logging.ActivityTrackingOptions.Baggage">
<summary>
Items of baggage will be included in the logging.
</summary>
</member>
<member name="T:Microsoft.Extensions.Logging.FilterLoggingBuilderExtensions">
<summary>
Extension methods for setting up logging services in an <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />.
</summary>
</member>
<member name="M:Microsoft.Extensions.Logging.FilterLoggingBuilderExtensions.AddFilter(Microsoft.Extensions.Logging.ILoggingBuilder,System.Func{System.String,System.String,Microsoft.Extensions.Logging.LogLevel,System.Boolean})">
<summary>
Adds a log filter to the factory.
</summary>
<param name="builder">The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> to add the filter to.</param>
<param name="filter">The filter to be added.</param>
<returns>The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> so that additional calls can be chained.</returns>
</member>
<member name="M:Microsoft.Extensions.Logging.FilterLoggingBuilderExtensions.AddFilter(Microsoft.Extensions.Logging.ILoggingBuilder,System.Func{System.String,Microsoft.Extensions.Logging.LogLevel,System.Boolean})">
<summary>
Adds a log filter to the factory.
</summary>
<param name="builder">The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> to add the filter to.</param>
<param name="categoryLevelFilter">The filter to be added.</param>
<returns>The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> so that additional calls can be chained.</returns>
</member>
<member name="M:Microsoft.Extensions.Logging.FilterLoggingBuilderExtensions.AddFilter``1(Microsoft.Extensions.Logging.ILoggingBuilder,System.Func{System.String,Microsoft.Extensions.Logging.LogLevel,System.Boolean})">
<summary>
Adds a log filter for the given <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider"/>.
</summary>
<param name="builder">The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> to add the filter to.</param>
<param name="categoryLevelFilter">The filter to be added.</param>
<typeparam name="T">The <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider"/> which this filter will be added for.</typeparam>
<returns>The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> so that additional calls can be chained.</returns>
</member>
<member name="M:Microsoft.Extensions.Logging.FilterLoggingBuilderExtensions.AddFilter(Microsoft.Extensions.Logging.ILoggingBuilder,System.Func{Microsoft.Extensions.Logging.LogLevel,System.Boolean})">
<summary>
Adds a log filter to the factory.
</summary>
<param name="builder">The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> to add the filter to.</param>
<param name="levelFilter">The filter to be added.</param>
<returns>The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> so that additional calls can be chained.</returns>
</member>
<member name="M:Microsoft.Extensions.Logging.FilterLoggingBuilderExtensions.AddFilter``1(Microsoft.Extensions.Logging.ILoggingBuilder,System.Func{Microsoft.Extensions.Logging.LogLevel,System.Boolean})">
<summary>
Adds a log filter for the given <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider"/>.
</summary>
<param name="builder">The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> to add the filter to.</param>
<param name="levelFilter">The filter to be added.</param>
<typeparam name="T">The <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider"/> which this filter will be added for.</typeparam>
<returns>The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> so that additional calls can be chained.</returns>
</member>
<member name="M:Microsoft.Extensions.Logging.FilterLoggingBuilderExtensions.AddFilter(Microsoft.Extensions.Logging.ILoggingBuilder,System.String,Microsoft.Extensions.Logging.LogLevel)">
<summary>
Adds a log filter to the factory.
</summary>
<param name="builder">The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> to add the filter to.</param>
<param name="category">The category to filter.</param>
<param name="level">The level to filter.</param>
<returns>The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> so that additional calls can be chained.</returns>
</member>
<member name="M:Microsoft.Extensions.Logging.FilterLoggingBuilderExtensions.AddFilter``1(Microsoft.Extensions.Logging.ILoggingBuilder,System.String,Microsoft.Extensions.Logging.LogLevel)">
<summary>
Adds a log filter for the given <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider"/>.
</summary>
<param name="builder">The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> to add the filter to.</param>
<param name="category">The category to filter.</param>
<param name="level">The level to filter.</param>
<typeparam name="T">The <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider"/> which this filter will be added for.</typeparam>
<returns>The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> so that additional calls can be chained.</returns>
</member>
<member name="M:Microsoft.Extensions.Logging.FilterLoggingBuilderExtensions.AddFilter(Microsoft.Extensions.Logging.ILoggingBuilder,System.String,System.Func{Microsoft.Extensions.Logging.LogLevel,System.Boolean})">
<summary>
Adds a log filter to the factory.
</summary>
<param name="builder">The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> to add the filter to.</param>
<param name="category">The category to filter.</param>
<param name="levelFilter">The filter function to apply.</param>
<returns>The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> so that additional calls can be chained.</returns>
</member>
<member name="M:Microsoft.Extensions.Logging.FilterLoggingBuilderExtensions.AddFilter``1(Microsoft.Extensions.Logging.ILoggingBuilder,System.String,System.Func{Microsoft.Extensions.Logging.LogLevel,System.Boolean})">
<summary>
Adds a log filter for the given <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider"/>.
</summary>
<param name="builder">The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> to add the filter to.</param>
<param name="category">The category to filter.</param>
<param name="levelFilter">The filter function to apply.</param>
<typeparam name="T">The <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider"/> which this filter will be added for.</typeparam>
<returns>The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> so that additional calls can be chained.</returns>
</member>
<member name="M:Microsoft.Extensions.Logging.FilterLoggingBuilderExtensions.AddFilter(Microsoft.Extensions.Logging.LoggerFilterOptions,System.Func{System.String,System.String,Microsoft.Extensions.Logging.LogLevel,System.Boolean})">
<summary>
Adds a log filter to the factory.
</summary>
<param name="builder">The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> to add the filter to.</param>
<param name="filter">The filter function to apply.</param>
<returns>The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> so that additional calls can be chained.</returns>
</member>
<member name="M:Microsoft.Extensions.Logging.FilterLoggingBuilderExtensions.AddFilter(Microsoft.Extensions.Logging.LoggerFilterOptions,System.Func{System.String,Microsoft.Extensions.Logging.LogLevel,System.Boolean})">
<summary>
Adds a log filter to the factory.
</summary>
<param name="builder">The <see cref="T:Microsoft.Extensions.Logging.LoggerFilterOptions"/> to add the filter to.</param>
<param name="categoryLevelFilter">The filter function to apply.</param>
<returns>The <see cref="T:Microsoft.Extensions.Logging.LoggerFilterOptions"/> so that additional calls can be chained.</returns>
</member>
<member name="M:Microsoft.Extensions.Logging.FilterLoggingBuilderExtensions.AddFilter``1(Microsoft.Extensions.Logging.LoggerFilterOptions,System.Func{System.String,Microsoft.Extensions.Logging.LogLevel,System.Boolean})">
<summary>
Adds a log filter for the given <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider"/>.
</summary>
<param name="builder">The <see cref="T:Microsoft.Extensions.Logging.LoggerFilterOptions"/> to add the filter to.</param>
<param name="categoryLevelFilter">The filter function to apply.</param>
<typeparam name="T">The <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider"/> which this filter will be added for.</typeparam>
<returns>The <see cref="T:Microsoft.Extensions.Logging.LoggerFilterOptions"/> so that additional calls can be chained.</returns>
</member>
<member name="M:Microsoft.Extensions.Logging.FilterLoggingBuilderExtensions.AddFilter(Microsoft.Extensions.Logging.LoggerFilterOptions,System.Func{Microsoft.Extensions.Logging.LogLevel,System.Boolean})">
<summary>
Adds a log filter to the factory.
</summary>
<param name="builder">The <see cref="T:Microsoft.Extensions.Logging.LoggerFilterOptions"/> to add the filter to.</param>
<param name="levelFilter">The filter function to apply.</param>
<returns>The <see cref="T:Microsoft.Extensions.Logging.LoggerFilterOptions"/> so that additional calls can be chained.</returns>
</member>
<member name="M:Microsoft.Extensions.Logging.FilterLoggingBuilderExtensions.AddFilter``1(Microsoft.Extensions.Logging.LoggerFilterOptions,System.Func{Microsoft.Extensions.Logging.LogLevel,System.Boolean})">
<summary>
Adds a log filter for the given <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider"/>.
</summary>
<param name="builder">The <see cref="T:Microsoft.Extensions.Logging.LoggerFilterOptions"/> to add the filter to.</param>
<param name="levelFilter">The filter function to apply.</param>
<typeparam name="T">The <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider"/> which this filter will be added for.</typeparam>
<returns>The <see cref="T:Microsoft.Extensions.Logging.LoggerFilterOptions"/> so that additional calls can be chained.</returns>
</member>
<member name="M:Microsoft.Extensions.Logging.FilterLoggingBuilderExtensions.AddFilter(Microsoft.Extensions.Logging.LoggerFilterOptions,System.String,Microsoft.Extensions.Logging.LogLevel)">
<summary>
Adds a log filter to the factory.
</summary>
<param name="builder">The <see cref="T:Microsoft.Extensions.Logging.LoggerFilterOptions"/> to add the filter to.</param>
<param name="category">The category to filter.</param>
<param name="level">The level to filter.</param>
<returns>The <see cref="T:Microsoft.Extensions.Logging.LoggerFilterOptions"/> so that additional calls can be chained.</returns>
</member>
<member name="M:Microsoft.Extensions.Logging.FilterLoggingBuilderExtensions.AddFilter``1(Microsoft.Extensions.Logging.LoggerFilterOptions,System.String,Microsoft.Extensions.Logging.LogLevel)">
<summary>
Adds a log filter for the given <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider"/>.
</summary>
<param name="builder">The <see cref="T:Microsoft.Extensions.Logging.LoggerFilterOptions"/> to add the filter to.</param>
<param name="category">The category to filter.</param>
<param name="level">The level to filter.</param>
<typeparam name="T">The <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider"/> which this filter will be added for.</typeparam>
<returns>The <see cref="T:Microsoft.Extensions.Logging.LoggerFilterOptions"/> so that additional calls can be chained.</returns>
</member>
<member name="M:Microsoft.Extensions.Logging.FilterLoggingBuilderExtensions.AddFilter(Microsoft.Extensions.Logging.LoggerFilterOptions,System.String,System.Func{Microsoft.Extensions.Logging.LogLevel,System.Boolean})">
<summary>
Adds a log filter to the factory.
</summary>
<param name="builder">The <see cref="T:Microsoft.Extensions.Logging.LoggerFilterOptions"/> to add the filter to.</param>
<param name="category">The category to filter.</param>
<param name="levelFilter">The filter function to apply.</param>
<returns>The <see cref="T:Microsoft.Extensions.Logging.LoggerFilterOptions"/> so that additional calls can be chained.</returns>
</member>
<member name="M:Microsoft.Extensions.Logging.FilterLoggingBuilderExtensions.AddFilter``1(Microsoft.Extensions.Logging.LoggerFilterOptions,System.String,System.Func{Microsoft.Extensions.Logging.LogLevel,System.Boolean})">
<summary>
Adds a log filter for the given <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider"/>.
</summary>
<param name="builder">The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> to add the filter to.</param>
<param name="category">The category to filter.</param>
<param name="levelFilter">The filter function to apply.</param>
<typeparam name="T">The <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider"/> which this filter will be added for.</typeparam>
<returns>The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> so that additional calls can be chained.</returns>
</member>
<member name="T:Microsoft.Extensions.Logging.ILoggingBuilder">
<summary>
An interface for configuring logging providers.
</summary>
</member>
<member name="P:Microsoft.Extensions.Logging.ILoggingBuilder.Services">
<summary>
Gets the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> where Logging services are configured.
</summary>
</member>
<member name="T:Microsoft.Extensions.Logging.LoggerFactory">
<summary>
Produces instances of <see cref="T:Microsoft.Extensions.Logging.ILogger"/> classes based on the given providers.
</summary>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerFactory.#ctor">
<summary>
Creates a new <see cref="T:Microsoft.Extensions.Logging.LoggerFactory"/> instance.
</summary>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerFactory.#ctor(System.Collections.Generic.IEnumerable{Microsoft.Extensions.Logging.ILoggerProvider})">
<summary>
Creates a new <see cref="T:Microsoft.Extensions.Logging.LoggerFactory"/> instance.
</summary>
<param name="providers">The providers to use in producing <see cref="T:Microsoft.Extensions.Logging.ILogger"/> instances.</param>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerFactory.#ctor(System.Collections.Generic.IEnumerable{Microsoft.Extensions.Logging.ILoggerProvider},Microsoft.Extensions.Logging.LoggerFilterOptions)">
<summary>
Creates a new <see cref="T:Microsoft.Extensions.Logging.LoggerFactory"/> instance.
</summary>
<param name="providers">The providers to use in producing <see cref="T:Microsoft.Extensions.Logging.ILogger"/> instances.</param>
<param name="filterOptions">The filter options to use.</param>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerFactory.#ctor(System.Collections.Generic.IEnumerable{Microsoft.Extensions.Logging.ILoggerProvider},Microsoft.Extensions.Options.IOptionsMonitor{Microsoft.Extensions.Logging.LoggerFilterOptions})">
<summary>
Creates a new <see cref="T:Microsoft.Extensions.Logging.LoggerFactory"/> instance.
</summary>
<param name="providers">The providers to use in producing <see cref="T:Microsoft.Extensions.Logging.ILogger"/> instances.</param>
<param name="filterOption">The filter option to use.</param>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerFactory.#ctor(System.Collections.Generic.IEnumerable{Microsoft.Extensions.Logging.ILoggerProvider},Microsoft.Extensions.Options.IOptionsMonitor{Microsoft.Extensions.Logging.LoggerFilterOptions},Microsoft.Extensions.Options.IOptions{Microsoft.Extensions.Logging.LoggerFactoryOptions})">
<summary>
Creates a new <see cref="T:Microsoft.Extensions.Logging.LoggerFactory"/> instance.
</summary>
<param name="providers">The providers to use in producing <see cref="T:Microsoft.Extensions.Logging.ILogger"/> instances.</param>
<param name="filterOption">The filter option to use.</param>
<param name="options">The <see cref="T:Microsoft.Extensions.Logging.LoggerFactoryOptions"/>.</param>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerFactory.#ctor(System.Collections.Generic.IEnumerable{Microsoft.Extensions.Logging.ILoggerProvider},Microsoft.Extensions.Options.IOptionsMonitor{Microsoft.Extensions.Logging.LoggerFilterOptions},Microsoft.Extensions.Options.IOptions{Microsoft.Extensions.Logging.LoggerFactoryOptions},Microsoft.Extensions.Logging.IExternalScopeProvider)">
<summary>
Creates a new <see cref="T:Microsoft.Extensions.Logging.LoggerFactory"/> instance.
</summary>
<param name="providers">The providers to use in producing <see cref="T:Microsoft.Extensions.Logging.ILogger"/> instances.</param>
<param name="filterOption">The filter option to use.</param>
<param name="options">The <see cref="T:Microsoft.Extensions.Logging.LoggerFactoryOptions"/>.</param>
<param name="scopeProvider">The <see cref="T:Microsoft.Extensions.Logging.IExternalScopeProvider"/>.</param>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerFactory.Create(System.Action{Microsoft.Extensions.Logging.ILoggingBuilder})">
<summary>
Creates new instance of <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory"/> configured using provided <paramref name="configure"/> delegate.
</summary>
<param name="configure">A delegate to configure the <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/>.</param>
<returns>The <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory"/> that was created.</returns>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerFactory.CreateLogger(System.String)">
<summary>
Creates an <see cref="T:Microsoft.Extensions.Logging.ILogger"/> with the given <paramref name="categoryName"/>.
</summary>
<param name="categoryName">The category name for messages produced by the logger.</param>
<returns>The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> that was created.</returns>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerFactory.AddProvider(Microsoft.Extensions.Logging.ILoggerProvider)">
<summary>
Adds the given provider to those used in creating <see cref="T:Microsoft.Extensions.Logging.ILogger"/> instances.
</summary>
<param name="provider">The <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider"/> to add.</param>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerFactory.CheckDisposed">
<summary>
Check if the factory has been disposed.
</summary>
<returns>True when <see cref="M:Microsoft.Extensions.Logging.LoggerFactory.Dispose"/> as been called</returns>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerFactory.Dispose">
<inheritdoc/>
</member>
<member name="T:Microsoft.Extensions.Logging.LoggerFactoryOptions">
<summary>
The options for a LoggerFactory.
</summary>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerFactoryOptions.#ctor">
<summary>
Creates a new <see cref="T:Microsoft.Extensions.Logging.LoggerFactoryOptions"/> instance.
</summary>
</member>
<member name="P:Microsoft.Extensions.Logging.LoggerFactoryOptions.ActivityTrackingOptions">
<summary>
Gets or sets <see cref="T:Microsoft.Extensions.Logging.LoggerFactoryOptions"/> value to indicate which parts of the tracing context information should be included with the logging scopes.
</summary>
</member>
<member name="T:Microsoft.Extensions.Logging.LoggerFactoryScopeProvider">
<summary>
Default implementation of <see cref="T:Microsoft.Extensions.Logging.IExternalScopeProvider"/>
</summary>
</member>
<member name="T:Microsoft.Extensions.Logging.LoggerFilterOptions">
<summary>
The options for a LoggerFilter.
</summary>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerFilterOptions.#ctor">
<summary>
Creates a new <see cref="T:Microsoft.Extensions.Logging.LoggerFilterOptions"/> instance.
</summary>
</member>
<member name="P:Microsoft.Extensions.Logging.LoggerFilterOptions.CaptureScopes">
<summary>
Gets or sets value indicating whether logging scopes are being captured. Defaults to <c>true</c>
</summary>
</member>
<member name="P:Microsoft.Extensions.Logging.LoggerFilterOptions.MinLevel">
<summary>
Gets or sets the minimum level of log messages if none of the rules match.
</summary>
</member>
<member name="P:Microsoft.Extensions.Logging.LoggerFilterOptions.Rules">
<summary>
Gets the collection of <see cref="T:Microsoft.Extensions.Logging.LoggerFilterRule"/> used for filtering log messages.
</summary>
</member>
<member name="T:Microsoft.Extensions.Logging.LoggerFilterRule">
<summary>
Defines a rule used to filter log messages
</summary>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerFilterRule.#ctor(System.String,System.String,System.Nullable{Microsoft.Extensions.Logging.LogLevel},System.Func{System.String,System.String,Microsoft.Extensions.Logging.LogLevel,System.Boolean})">
<summary>
Creates a new <see cref="T:Microsoft.Extensions.Logging.LoggerFilterRule"/> instance.
</summary>
<param name="providerName">The provider name to use in this filter rule.</param>
<param name="categoryName">The category name to use in this filter rule.</param>
<param name="logLevel">The <see cref="P:Microsoft.Extensions.Logging.LoggerFilterRule.LogLevel"/> to use in this filter rule.</param>
<param name="filter">The filter to apply.</param>
</member>
<member name="P:Microsoft.Extensions.Logging.LoggerFilterRule.ProviderName">
<summary>
Gets the logger provider type or alias this rule applies to.
</summary>
</member>
<member name="P:Microsoft.Extensions.Logging.LoggerFilterRule.CategoryName">
<summary>
Gets the logger category this rule applies to.
</summary>
</member>
<member name="P:Microsoft.Extensions.Logging.LoggerFilterRule.LogLevel">
<summary>
Gets the minimum <see cref="P:Microsoft.Extensions.Logging.LoggerFilterRule.LogLevel"/> of messages.
</summary>
</member>
<member name="P:Microsoft.Extensions.Logging.LoggerFilterRule.Filter">
<summary>
Gets the filter delegate that would be applied to messages that passed the <see cref="P:Microsoft.Extensions.Logging.LoggerFilterRule.LogLevel"/>.
</summary>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggerFilterRule.ToString">
<inheritdoc/>
</member>
<member name="T:Microsoft.Extensions.Logging.LoggingBuilderExtensions">
<summary>
Extension methods for setting up logging services in an <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder" />.
</summary>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggingBuilderExtensions.SetMinimumLevel(Microsoft.Extensions.Logging.ILoggingBuilder,Microsoft.Extensions.Logging.LogLevel)">
<summary>
Sets a minimum <see cref="T:Microsoft.Extensions.Logging.LogLevel"/> requirement for log messages to be logged.
</summary>
<param name="builder">The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> to set the minimum level on.</param>
<param name="level">The <see cref="T:Microsoft.Extensions.Logging.LogLevel"/> to set as the minimum.</param>
<returns>The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> so that additional calls can be chained.</returns>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggingBuilderExtensions.AddProvider(Microsoft.Extensions.Logging.ILoggingBuilder,Microsoft.Extensions.Logging.ILoggerProvider)">
<summary>
Adds the given <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider"/> to the <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/>
</summary>
<param name="builder">The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> to add the <paramref name="provider"/> to.</param>
<param name="provider">The <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider"/> to add to the <paramref name="builder"/>.</param>
<returns>The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> so that additional calls can be chained.</returns>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggingBuilderExtensions.ClearProviders(Microsoft.Extensions.Logging.ILoggingBuilder)">
<summary>
Removes all <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider"/>s from <paramref name="builder"/>.
</summary>
<param name="builder">The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> to remove <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider"/>s from.</param>
<returns>The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> so that additional calls can be chained.</returns>
</member>
<member name="M:Microsoft.Extensions.Logging.LoggingBuilderExtensions.Configure(Microsoft.Extensions.Logging.ILoggingBuilder,System.Action{Microsoft.Extensions.Logging.LoggerFactoryOptions})">
<summary>
Configure the <paramref name="builder"/> with the <see cref="T:Microsoft.Extensions.Logging.LoggerFactoryOptions"/>.
</summary>
<param name="builder">The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> to be configured with <see cref="T:Microsoft.Extensions.Logging.LoggerFactoryOptions"/></param>
<param name="action">The action used to configure the logger factory</param>
<returns>The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> so that additional calls can be chained.</returns>
</member>
<member name="T:Microsoft.Extensions.Logging.ProviderAliasAttribute">
<summary>
Defines alias for <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider"/> implementation to be used in filtering rules.
</summary>
</member>
<member name="M:Microsoft.Extensions.Logging.ProviderAliasAttribute.#ctor(System.String)">
<summary>
Creates a new <see cref="T:Microsoft.Extensions.Logging.ProviderAliasAttribute"/> instance.
</summary>
<param name="alias">The alias to set.</param>
</member>
<member name="P:Microsoft.Extensions.Logging.ProviderAliasAttribute.Alias">
<summary>
The alias of the provider.
</summary>
</member>
<member name="T:Microsoft.Extensions.Logging.NullExternalScopeProvider">
<summary>
Scope provider that does nothing.
</summary>
</member>
<member name="P:Microsoft.Extensions.Logging.NullExternalScopeProvider.Instance">
<summary>
Returns a cached instance of <see cref="T:Microsoft.Extensions.Logging.NullExternalScopeProvider"/>.
</summary>
</member>
<member name="M:Microsoft.Extensions.Logging.NullExternalScopeProvider.Microsoft#Extensions#Logging#IExternalScopeProvider#ForEachScope``1(System.Action{System.Object,``0},``0)">
<inheritdoc />
</member>
<member name="M:Microsoft.Extensions.Logging.NullExternalScopeProvider.Microsoft#Extensions#Logging#IExternalScopeProvider#Push(System.Object)">
<inheritdoc />
</member>
<member name="T:Microsoft.Extensions.Logging.NullScope">
<summary>
An empty scope without any logic
</summary>
</member>
<member name="M:Microsoft.Extensions.Logging.NullScope.Dispose">
<inheritdoc />
</member>
<member name="T:Microsoft.Extensions.DependencyInjection.LoggingServiceCollectionExtensions">
<summary>
Extension methods for setting up logging services in an <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />.
</summary>
</member>
<member name="M:Microsoft.Extensions.DependencyInjection.LoggingServiceCollectionExtensions.AddLogging(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
<summary>
Adds logging services to the specified <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />.
</summary>
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add services to.</param>
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
</member>
<member name="M:Microsoft.Extensions.DependencyInjection.LoggingServiceCollectionExtensions.AddLogging(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{Microsoft.Extensions.Logging.ILoggingBuilder})">
<summary>
Adds logging services to the specified <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />.
</summary>
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add services to.</param>
<param name="configure">The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> configuration delegate.</param>
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
</member>
<member name="M:System.ThrowHelper.ThrowIfNull(System.Object,System.String)">
<summary>Throws an <see cref="T:System.ArgumentNullException"/> if <paramref name="argument"/> is null.</summary>
<param name="argument">The reference type argument to validate as non-null.</param>
<param name="paramName">The name of the parameter with which <paramref name="argument"/> corresponds.</param>
</member>
<member name="T:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute">
<summary>
Indicates that the specified method requires the ability to generate new code at runtime,
for example through <see cref="N:System.Reflection"/>.
</summary>
<remarks>
This allows tools to understand which methods are unsafe to call when compiling ahead of time.
</remarks>
</member>
<member name="M:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute"/> class
with the specified message.
</summary>
<param name="message">
A message that contains information about the usage of dynamic code.
</param>
</member>
<member name="P:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute.Message">
<summary>
Gets a message that contains information about the usage of dynamic code.
</summary>
</member>
<member name="P:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute.Url">
<summary>
Gets or sets an optional URL that contains more information about the method,
why it requires dynamic code, and what options a consumer has to deal with it.
</summary>
</member>
<member name="P:System.SR.InvalidActivityTrackingOptions">
<summary>{0} is invalid ActivityTrackingOptions value.</summary>
</member>
<member name="P:System.SR.MoreThanOneWildcard">
<summary>Only one wildcard character is allowed in category name.</summary>
</member>
<member name="T:System.Runtime.InteropServices.LibraryImportAttribute">
<summary>
Attribute used to indicate a source generator should create a function for marshalling
arguments instead of relying on the runtime to generate an equivalent marshalling function at run-time.
</summary>
<remarks>
This attribute is meaningless if the source generator associated with it is not enabled.
The current built-in source generator only supports C# and only supplies an implementation when
applied to static, partial, non-generic methods.
</remarks>
</member>
<member name="M:System.Runtime.InteropServices.LibraryImportAttribute.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:System.Runtime.InteropServices.LibraryImportAttribute"/>.
</summary>
<param name="libraryName">Name of the library containing the import.</param>
</member>
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.LibraryName">
<summary>
Gets the name of the library containing the import.
</summary>
</member>
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.EntryPoint">
<summary>
Gets or sets the name of the entry point to be called.
</summary>
</member>
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling">
<summary>
Gets or sets how to marshal string arguments to the method.
</summary>
<remarks>
If this field is set to a value other than <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />,
<see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType" /> must not be specified.
</remarks>
</member>
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType">
<summary>
Gets or sets the <see cref="T:System.Type"/> used to control how string arguments to the method are marshalled.
</summary>
<remarks>
If this field is specified, <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling" /> must not be specified
or must be set to <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />.
</remarks>
</member>
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.SetLastError">
<summary>
Gets or sets whether the callee sets an error (SetLastError on Windows or errno
on other platforms) before returning from the attributed method.
</summary>
</member>
<member name="T:System.Runtime.InteropServices.StringMarshalling">
<summary>
Specifies how strings should be marshalled for generated p/invokes
</summary>
</member>
<member name="F:System.Runtime.InteropServices.StringMarshalling.Custom">
<summary>
Indicates the user is suppling a specific marshaller in <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType"/>.
</summary>
</member>
<member name="F:System.Runtime.InteropServices.StringMarshalling.Utf8">
<summary>
Use the platform-provided UTF-8 marshaller.
</summary>
</member>
<member name="F:System.Runtime.InteropServices.StringMarshalling.Utf16">
<summary>
Use the platform-provided UTF-16 marshaller.
</summary>
</member>
</members>
</doc>
md5: 3BA07A6760BE077504734E9C0BE0CCE3 | sha1: A51ACEA6A9183D6C73DCEDB5B0536F2A5EFD5F43 | sha256: 8578454489A439D5DEBD8A8CA9844B3B38076563EAF195CC5ED4BD27A8C54EA3 | sha512: 1E3AB31B03826F634271246505F72FA4CD16EB0E23CA71BCA1EB5A398A3229DF6BFE87EB1B6A30EA2E0379E33D1F2AF951F178F950C0A520B07740AB11C8B0BA
<?xml version="1.0"?>
<doc>
<assembly>
<name>Microsoft.Extensions.Primitives</name>
</assembly>
<members>
<member name="T:Microsoft.Extensions.Primitives.CancellationChangeToken">
<summary>
A <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> implementation using <see cref="T:System.Threading.CancellationToken"/>.
</summary>
</member>
<member name="M:Microsoft.Extensions.Primitives.CancellationChangeToken.#ctor(System.Threading.CancellationToken)">
<summary>
Initializes a new instance of <see cref="T:Microsoft.Extensions.Primitives.CancellationChangeToken"/>.
</summary>
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/>.</param>
</member>
<member name="P:Microsoft.Extensions.Primitives.CancellationChangeToken.ActiveChangeCallbacks">
<inheritdoc />
</member>
<member name="P:Microsoft.Extensions.Primitives.CancellationChangeToken.HasChanged">
<inheritdoc />
</member>
<member name="M:Microsoft.Extensions.Primitives.CancellationChangeToken.RegisterChangeCallback(System.Action{System.Object},System.Object)">
<inheritdoc />
</member>
<member name="T:Microsoft.Extensions.Primitives.ChangeToken">
<summary>
Propagates notifications that a change has occurred.
</summary>
</member>
<member name="M:Microsoft.Extensions.Primitives.ChangeToken.OnChange(System.Func{Microsoft.Extensions.Primitives.IChangeToken},System.Action)">
<summary>
Registers the <paramref name="changeTokenConsumer"/> action to be called whenever the token produced changes.
</summary>
<param name="changeTokenProducer">Produces the change token.</param>
<param name="changeTokenConsumer">Action called when the token changes.</param>
<returns></returns>
</member>
<member name="M:Microsoft.Extensions.Primitives.ChangeToken.OnChange``1(System.Func{Microsoft.Extensions.Primitives.IChangeToken},System.Action{``0},``0)">
<summary>
Registers the <paramref name="changeTokenConsumer"/> action to be called whenever the token produced changes.
</summary>
<param name="changeTokenProducer">Produces the change token.</param>
<param name="changeTokenConsumer">Action called when the token changes.</param>
<param name="state">state for the consumer.</param>
<returns></returns>
</member>
<member name="T:Microsoft.Extensions.Primitives.CompositeChangeToken">
<summary>
An <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> which represents one or more <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> instances.
</summary>
</member>
<member name="M:Microsoft.Extensions.Primitives.CompositeChangeToken.#ctor(System.Collections.Generic.IReadOnlyList{Microsoft.Extensions.Primitives.IChangeToken})">
<summary>
Creates a new instance of <see cref="T:Microsoft.Extensions.Primitives.CompositeChangeToken"/>.
</summary>
<param name="changeTokens">The list of <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> to compose.</param>
</member>
<member name="P:Microsoft.Extensions.Primitives.CompositeChangeToken.ChangeTokens">
<summary>
Returns the list of <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> which compose the current <see cref="T:Microsoft.Extensions.Primitives.CompositeChangeToken"/>.
</summary>
</member>
<member name="M:Microsoft.Extensions.Primitives.CompositeChangeToken.RegisterChangeCallback(System.Action{System.Object},System.Object)">
<inheritdoc />
</member>
<member name="P:Microsoft.Extensions.Primitives.CompositeChangeToken.HasChanged">
<inheritdoc />
</member>
<member name="P:Microsoft.Extensions.Primitives.CompositeChangeToken.ActiveChangeCallbacks">
<inheritdoc />
</member>
<member name="M:Microsoft.Extensions.Primitives.Extensions.Append(System.Text.StringBuilder,Microsoft.Extensions.Primitives.StringSegment)">
<summary>
Add the given <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> to the <see cref="T:System.Text.StringBuilder"/>.
</summary>
<param name="builder">The <see cref="T:System.Text.StringBuilder"/> to add to.</param>
<param name="segment">The <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> to add.</param>
<returns>The original <see cref="T:System.Text.StringBuilder"/>.</returns>
</member>
<member name="T:Microsoft.Extensions.Primitives.IChangeToken">
<summary>
Propagates notifications that a change has occurred.
</summary>
</member>
<member name="P:Microsoft.Extensions.Primitives.IChangeToken.HasChanged">
<summary>
Gets a value that indicates if a change has occurred.
</summary>
</member>
<member name="P:Microsoft.Extensions.Primitives.IChangeToken.ActiveChangeCallbacks">
<summary>
Indicates if this token will pro-actively raise callbacks. If <c>false</c>, the token consumer must
poll <see cref="P:Microsoft.Extensions.Primitives.IChangeToken.HasChanged" /> to detect changes.
</summary>
</member>
<member name="M:Microsoft.Extensions.Primitives.IChangeToken.RegisterChangeCallback(System.Action{System.Object},System.Object)">
<summary>
Registers for a callback that will be invoked when the entry has changed.
<see cref="P:Microsoft.Extensions.Primitives.IChangeToken.HasChanged"/> MUST be set before the callback is invoked.
</summary>
<param name="callback">The <see cref="T:System.Action`1"/> to invoke.</param>
<param name="state">State to be passed into the callback.</param>
<returns>An <see cref="T:System.IDisposable"/> that is used to unregister the callback.</returns>
</member>
<member name="T:Microsoft.Extensions.Primitives.StringSegment">
<summary>
An optimized representation of a substring.
</summary>
</member>
<member name="F:Microsoft.Extensions.Primitives.StringSegment.Empty">
<summary>
A <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> for <see cref="F:System.String.Empty"/>.
</summary>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringSegment.#ctor(System.String)">
<summary>
Initializes an instance of the <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> struct.
</summary>
<param name="buffer">
The original <see cref="T:System.String"/>. The <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> includes the whole <see cref="T:System.String"/>.
</param>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringSegment.#ctor(System.String,System.Int32,System.Int32)">
<summary>
Initializes an instance of the <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> struct.
</summary>
<param name="buffer">The original <see cref="T:System.String"/> used as buffer.</param>
<param name="offset">The offset of the segment within the <paramref name="buffer"/>.</param>
<param name="length">The length of the segment.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="buffer"/> is <see langword="null" />.
</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="offset"/> or <paramref name="length"/> is less than zero, or <paramref name="offset"/> +
<paramref name="length"/> is greater than the number of characters in <paramref name="buffer"/>.
</exception>
</member>
<member name="P:Microsoft.Extensions.Primitives.StringSegment.Buffer">
<summary>
Gets the <see cref="T:System.String"/> buffer for this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.
</summary>
</member>
<member name="P:Microsoft.Extensions.Primitives.StringSegment.Offset">
<summary>
Gets the offset within the buffer for this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.
</summary>
</member>
<member name="P:Microsoft.Extensions.Primitives.StringSegment.Length">
<summary>
Gets the length of this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.
</summary>
</member>
<member name="P:Microsoft.Extensions.Primitives.StringSegment.Value">
<summary>
Gets the value of this segment as a <see cref="T:System.String"/>.
</summary>
</member>
<member name="P:Microsoft.Extensions.Primitives.StringSegment.HasValue">
<summary>
Gets whether this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> contains a valid value.
</summary>
</member>
<member name="P:Microsoft.Extensions.Primitives.StringSegment.Item(System.Int32)">
<summary>
Gets the <see cref="T:System.Char"/> at a specified position in the current <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.
</summary>
<param name="index">The offset into the <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/></param>
<returns>The <see cref="T:System.Char"/> at a specified position.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="index"/> is greater than or equal to <see cref="P:Microsoft.Extensions.Primitives.StringSegment.Length"/> or less than zero.
</exception>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringSegment.AsSpan">
<summary>
Gets a <see cref="T:System.ReadOnlySpan`1"/> from the current <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.
</summary>
<returns>The <see cref="T:System.ReadOnlySpan`1"/> from this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.</returns>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringSegment.AsSpan(System.Int32)">
<summary>
Gets a <see cref="T:System.ReadOnlySpan`1"/> from the current <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> that starts
at the position specified by <paramref name="start"/>, and has the remaining length.
</summary>
<param name="start">The zero-based starting character position in this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.</param>
<returns>A <see cref="T:System.ReadOnlySpan`1"/> with the remaining chars that begins at <paramref name="start"/> in
this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="start"/> is greater than or equal to <see cref="P:Microsoft.Extensions.Primitives.StringSegment.Length"/> or less than zero.
</exception>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringSegment.AsSpan(System.Int32,System.Int32)">
<summary>
Gets a <see cref="T:System.ReadOnlySpan`1"/> from the current <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> that starts
at the position specified by <paramref name="start"/>, and has the specified <paramref name="length"/>.
</summary>
<param name="start">The zero-based starting character position in this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.</param>
<param name="length">The number of characters in the span.</param>
<returns>A <see cref="T:System.ReadOnlySpan`1"/> with length <paramref name="length"/> that begins at
<paramref name="start"/> in this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="start"/> or <paramref name="length"/> is less than zero, or <paramref name="start"/> + <paramref name="length"/> is
greater than <see cref="P:Microsoft.Extensions.Primitives.StringSegment.Length"/>.
</exception>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringSegment.AsMemory">
<summary>
Gets a <see cref="T:System.ReadOnlyMemory`1"/> from the current <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.
</summary>
<returns>The <see cref="T:System.ReadOnlyMemory`1"/> from this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.</returns>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringSegment.Compare(Microsoft.Extensions.Primitives.StringSegment,Microsoft.Extensions.Primitives.StringSegment,System.StringComparison)">
<summary>
Compares substrings of two specified <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> objects using the specified rules,
and returns an integer that indicates their relative position in the sort order.
</summary>
<param name="a">The first <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> to compare.</param>
<param name="b">The second <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> to compare.</param>
<param name="comparisonType">One of the enumeration values that specifies the rules for the comparison.</param>
<returns>
A 32-bit signed integer indicating the lexical relationship between the two comparands.
The value is negative if <paramref name="a"/> is less than <paramref name="b"/>, 0 if the two comparands are equal,
and positive if <paramref name="a"/> is greater than <paramref name="b"/>.
</returns>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringSegment.Equals(System.Object)">
<summary>
Indicates whether the current object is equal to another object of the same type.
</summary>
<param name="obj">An object to compare with this object.</param>
<returns><see langword="true" /> if the current object is equal to the other parameter; otherwise, <see langword="false" />.</returns>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringSegment.Equals(Microsoft.Extensions.Primitives.StringSegment)">
<summary>
Indicates whether the current object is equal to another object of the same type.
</summary>
<param name="other">An object to compare with this object.</param>
<returns><see langword="true" /> if the current object is equal to the other parameter; otherwise, <see langword="false" />.</returns>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringSegment.Equals(Microsoft.Extensions.Primitives.StringSegment,System.StringComparison)">
<summary>
Indicates whether the current object is equal to another object of the same type.
</summary>
<param name="other">An object to compare with this object.</param>
<param name="comparisonType">One of the enumeration values that specifies the rules to use in the comparison.</param>
<returns><see langword="true" /> if the current object is equal to the other parameter; otherwise, <see langword="false" />.</returns>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringSegment.Equals(Microsoft.Extensions.Primitives.StringSegment,Microsoft.Extensions.Primitives.StringSegment,System.StringComparison)">
<summary>
Determines whether two specified <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> objects have the same value. A parameter specifies the culture, case, and
sort rules used in the comparison.
</summary>
<param name="a">The first <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> to compare.</param>
<param name="b">The second <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> to compare.</param>
<param name="comparisonType">One of the enumeration values that specifies the rules for the comparison.</param>
<returns><see langword="true" /> if the objects are equal; otherwise, <see langword="false" />.</returns>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringSegment.Equals(System.String)">
<summary>
Checks if the specified <see cref="T:System.String"/> is equal to the current <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.
</summary>
<param name="text">The <see cref="T:System.String"/> to compare with the current <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.</param>
<returns><see langword="true" /> if the specified <see cref="T:System.String"/> is equal to the current <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>; otherwise, <see langword="false" />.</returns>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringSegment.Equals(System.String,System.StringComparison)">
<summary>
Checks if the specified <see cref="T:System.String"/> is equal to the current <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.
</summary>
<param name="text">The <see cref="T:System.String"/> to compare with the current <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.</param>
<param name="comparisonType">One of the enumeration values that specifies the rules to use in the comparison.</param>
<returns><see langword="true" /> if the specified <see cref="T:System.String"/> is equal to the current <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>; otherwise, <see langword="false" />.</returns>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringSegment.GetHashCode">
<summary>
Returns a hash code for this instance.
</summary>
<returns>
A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
</returns>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringSegment.op_Equality(Microsoft.Extensions.Primitives.StringSegment,Microsoft.Extensions.Primitives.StringSegment)">
<summary>
Checks if two specified <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> have the same value.
</summary>
<param name="left">The first <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> to compare, or <see langword="null" />.</param>
<param name="right">The second <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> to compare, or <see langword="null" />.</param>
<returns><see langword="true" /> if the value of <paramref name="left"/> is the same as the value of <paramref name="right"/>; otherwise, <see langword="false" />.</returns>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringSegment.op_Inequality(Microsoft.Extensions.Primitives.StringSegment,Microsoft.Extensions.Primitives.StringSegment)">
<summary>
Checks if two specified <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> have different values.
</summary>
<param name="left">The first <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> to compare, or <see langword="null" />.</param>
<param name="right">The second <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> to compare, or <see langword="null" />.</param>
<returns><see langword="true" /> if the value of <paramref name="left"/> is different from the value of <paramref name="right"/>; otherwise, <see langword="false" />.</returns>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringSegment.op_Implicit(System.String)~Microsoft.Extensions.Primitives.StringSegment">
<summary>
Creates a new <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> from the given <see cref="T:System.String"/>.
</summary>
<param name="value">The <see cref="T:System.String"/> to convert to a <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/></param>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringSegment.op_Implicit(Microsoft.Extensions.Primitives.StringSegment)~System.ReadOnlySpan{System.Char}">
<summary>
Creates a see <see cref="T:System.ReadOnlySpan`1"/> from the given <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.
</summary>
<param name="segment">The <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> to convert to a <see cref="T:System.ReadOnlySpan`1"/>.</param>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringSegment.op_Implicit(Microsoft.Extensions.Primitives.StringSegment)~System.ReadOnlyMemory{System.Char}">
<summary>
Creates a see <see cref="T:System.ReadOnlyMemory`1"/> from the given <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.
</summary>
<param name="segment">The <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> to convert to a <see cref="T:System.ReadOnlyMemory`1"/>.</param>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringSegment.StartsWith(System.String,System.StringComparison)">
<summary>
Checks if the beginning of this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> matches the specified <see cref="T:System.String"/> when compared using the specified <paramref name="comparisonType"/>.
</summary>
<param name="text">The <see cref="T:System.String"/>to compare.</param>
<param name="comparisonType">One of the enumeration values that specifies the rules to use in the comparison.</param>
<returns><see langword="true" /> if <paramref name="text"/> matches the beginning of this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>; otherwise, <see langword="false" />.</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="text"/> is <see langword="null" />.
</exception>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringSegment.EndsWith(System.String,System.StringComparison)">
<summary>
Checks if the end of this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> matches the specified <see cref="T:System.String"/> when compared using the specified <paramref name="comparisonType"/>.
</summary>
<param name="text">The <see cref="T:System.String"/>to compare.</param>
<param name="comparisonType">One of the enumeration values that specifies the rules to use in the comparison.</param>
<returns><see langword="true" /> if <paramref name="text"/> matches the end of this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>; otherwise, <see langword="false" />.</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="text"/> is <see langword="null" />.
</exception>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringSegment.Substring(System.Int32)">
<summary>
Retrieves a substring from this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.
The substring starts at the position specified by <paramref name="offset"/> and has the remaining length.
</summary>
<param name="offset">The zero-based starting character position of a substring in this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.</param>
<returns>A <see cref="T:System.String"/> that is equivalent to the substring of remaining length that begins at
<paramref name="offset"/> in this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/></returns>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="offset"/> is greater than or equal to <see cref="P:Microsoft.Extensions.Primitives.StringSegment.Length"/> or less than zero.
</exception>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringSegment.Substring(System.Int32,System.Int32)">
<summary>
Retrieves a substring from this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.
The substring starts at the position specified by <paramref name="offset"/> and has the specified <paramref name="length"/>.
</summary>
<param name="offset">The zero-based starting character position of a substring in this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.</param>
<param name="length">The number of characters in the substring.</param>
<returns>A <see cref="T:System.String"/> that is equivalent to the substring of length <paramref name="length"/> that begins at
<paramref name="offset"/> in this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/></returns>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="offset"/> or <paramref name="length"/> is less than zero, or <paramref name="offset"/> + <paramref name="length"/> is
greater than <see cref="P:Microsoft.Extensions.Primitives.StringSegment.Length"/>.
</exception>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringSegment.Subsegment(System.Int32)">
<summary>
Retrieves a <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> that represents a substring from this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.
The <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> starts at the position specified by <paramref name="offset"/>.
</summary>
<param name="offset">The zero-based starting character position of a substring in this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.</param>
<returns>A <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> that begins at <paramref name="offset"/> in this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>
whose length is the remainder.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="offset"/> is greater than or equal to <see cref="P:Microsoft.Extensions.Primitives.StringSegment.Length"/> or less than zero.
</exception>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringSegment.Subsegment(System.Int32,System.Int32)">
<summary>
Retrieves a <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> that represents a substring from this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.
The <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> starts at the position specified by <paramref name="offset"/> and has the specified <paramref name="length"/>.
</summary>
<param name="offset">The zero-based starting character position of a substring in this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.</param>
<param name="length">The number of characters in the substring.</param>
<returns>A <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> that is equivalent to the substring of length <paramref name="length"/> that begins at <paramref name="offset"/> in this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/></returns>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="offset"/> or <paramref name="length"/> is less than zero, or <paramref name="offset"/> + <paramref name="length"/> is
greater than <see cref="P:Microsoft.Extensions.Primitives.StringSegment.Length"/>.
</exception>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringSegment.IndexOf(System.Char,System.Int32,System.Int32)">
<summary>
Gets the zero-based index of the first occurrence of the character <paramref name="c"/> in this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.
The search starts at <paramref name="start"/> and examines a specified number of <paramref name="count"/> character positions.
</summary>
<param name="c">The Unicode character to seek.</param>
<param name="start">The zero-based index position at which the search starts. </param>
<param name="count">The number of characters to examine.</param>
<returns>The zero-based index position of <paramref name="c"/> from the beginning of the <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> if that character is found, or -1 if it is not.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="start"/> or <paramref name="count"/> is less than zero, or <paramref name="start"/> + <paramref name="count"/> is
greater than <see cref="P:Microsoft.Extensions.Primitives.StringSegment.Length"/>.
</exception>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringSegment.IndexOf(System.Char,System.Int32)">
<summary>
Gets the zero-based index of the first occurrence of the character <paramref name="c"/> in this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.
The search starts at <paramref name="start"/>.
</summary>
<param name="c">The Unicode character to seek.</param>
<param name="start">The zero-based index position at which the search starts. </param>
<returns>The zero-based index position of <paramref name="c"/> from the beginning of the <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> if that character is found, or -1 if it is not.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="start"/> is greater than or equal to <see cref="P:Microsoft.Extensions.Primitives.StringSegment.Length"/> or less than zero.
</exception>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringSegment.IndexOf(System.Char)">
<summary>
Gets the zero-based index of the first occurrence of the character <paramref name="c"/> in this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.
</summary>
<param name="c">The Unicode character to seek.</param>
<returns>The zero-based index position of <paramref name="c"/> from the beginning of the <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> if that character is found, or -1 if it is not.</returns>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringSegment.IndexOfAny(System.Char[],System.Int32,System.Int32)">
<summary>
Reports the zero-based index of the first occurrence in this instance of any character in a specified array
of Unicode characters. The search starts at a specified character position and examines a specified number
of character positions.
</summary>
<param name="anyOf">A Unicode character array containing one or more characters to seek.</param>
<param name="startIndex">The search starting position.</param>
<param name="count">The number of character positions to examine.</param>
<returns>The zero-based index position of the first occurrence in this instance where any character in <paramref name="anyOf"/>
was found; -1 if no character in <paramref name="anyOf"/> was found.</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="anyOf"/> is <see langword="null" />.
</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="startIndex"/> or <paramref name="count"/> is less than zero, or <paramref name="startIndex"/> + <paramref name="count"/> is
greater than <see cref="P:Microsoft.Extensions.Primitives.StringSegment.Length"/>.
</exception>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringSegment.IndexOfAny(System.Char[],System.Int32)">
<summary>
Reports the zero-based index of the first occurrence in this instance of any character in a specified array
of Unicode characters. The search starts at a specified character position.
</summary>
<param name="anyOf">A Unicode character array containing one or more characters to seek.</param>
<param name="startIndex">The search starting position.</param>
<returns>The zero-based index position of the first occurrence in this instance where any character in <paramref name="anyOf"/>
was found; -1 if no character in <paramref name="anyOf"/> was found.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="startIndex"/> is greater than or equal to <see cref="P:Microsoft.Extensions.Primitives.StringSegment.Length"/> or less than zero.
</exception>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringSegment.IndexOfAny(System.Char[])">
<summary>
Reports the zero-based index of the first occurrence in this instance of any character in a specified array
of Unicode characters.
</summary>
<param name="anyOf">A Unicode character array containing one or more characters to seek.</param>
<returns>The zero-based index position of the first occurrence in this instance where any character in <paramref name="anyOf"/>
was found; -1 if no character in <paramref name="anyOf"/> was found.</returns>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringSegment.LastIndexOf(System.Char)">
<summary>
Reports the zero-based index position of the last occurrence of a specified Unicode character within this instance.
</summary>
<param name="value">The Unicode character to seek.</param>
<returns>The zero-based index position of value if that character is found, or -1 if it is not.</returns>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringSegment.Trim">
<summary>
Removes all leading and trailing whitespaces.
</summary>
<returns>The trimmed <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.</returns>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringSegment.TrimStart">
<summary>
Removes all leading whitespaces.
</summary>
<returns>The trimmed <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.</returns>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringSegment.TrimEnd">
<summary>
Removes all trailing whitespaces.
</summary>
<returns>The trimmed <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.</returns>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringSegment.Split(System.Char[])">
<summary>
Splits a string into <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>s that are based on the characters in an array.
</summary>
<param name="chars">A character array that delimits the substrings in this string, an empty array that
contains no delimiters, or null.</param>
<returns>An <see cref="T:Microsoft.Extensions.Primitives.StringTokenizer"/> whose elements contain the <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>s from this instance
that are delimited by one or more characters in <paramref name="chars"/>.</returns>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringSegment.IsNullOrEmpty(Microsoft.Extensions.Primitives.StringSegment)">
<summary>
Indicates whether the specified <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> is null or an Empty string.
</summary>
<param name="value">The <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> to test.</param>
<returns></returns>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringSegment.ToString">
<summary>
Returns the <see cref="T:System.String"/> represented by this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> or <see cref="F:System.String.Empty" /> if the <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> does not contain a value.
</summary>
<returns>The <see cref="T:System.String"/> represented by this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> or <see cref="F:System.String.Empty" /> if the <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> does not contain a value.</returns>
</member>
<member name="T:Microsoft.Extensions.Primitives.StringTokenizer">
<summary>
Tokenizes a <see cref="T:System.String"/> into <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>s.
</summary>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringTokenizer.#ctor(System.String,System.Char[])">
<summary>
Initializes a new instance of <see cref="T:Microsoft.Extensions.Primitives.StringTokenizer"/>.
</summary>
<param name="value">The <see cref="T:System.String"/> to tokenize.</param>
<param name="separators">The characters to tokenize by.</param>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringTokenizer.#ctor(Microsoft.Extensions.Primitives.StringSegment,System.Char[])">
<summary>
Initializes a new instance of <see cref="T:Microsoft.Extensions.Primitives.StringTokenizer"/>.
</summary>
<param name="value">The <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> to tokenize.</param>
<param name="separators">The characters to tokenize by.</param>
</member>
<member name="T:Microsoft.Extensions.Primitives.StringValues">
<summary>
Represents zero/null, one, or many strings in an efficient way.
</summary>
</member>
<member name="F:Microsoft.Extensions.Primitives.StringValues.Empty">
<summary>
A readonly instance of the <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> struct whose value is an empty string array.
</summary>
<remarks>
In application code, this field is most commonly used to safely represent a <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> that has null string values.
</remarks>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringValues.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> structure using the specified string.
</summary>
<param name="value">A string value or <c>null</c>.</param>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringValues.#ctor(System.String[])">
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> structure using the specified array of strings.
</summary>
<param name="values">A string array.</param>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringValues.op_Implicit(System.String)~Microsoft.Extensions.Primitives.StringValues">
<summary>
Defines an implicit conversion of a given string to a <see cref="T:Microsoft.Extensions.Primitives.StringValues"/>.
</summary>
<param name="value">A string to implicitly convert.</param>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringValues.op_Implicit(System.String[])~Microsoft.Extensions.Primitives.StringValues">
<summary>
Defines an implicit conversion of a given string array to a <see cref="T:Microsoft.Extensions.Primitives.StringValues"/>.
</summary>
<param name="values">A string array to implicitly convert.</param>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringValues.op_Implicit(Microsoft.Extensions.Primitives.StringValues)~System.String">
<summary>
Defines an implicit conversion of a given <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> to a string, with multiple values joined as a comma separated string.
</summary>
<remarks>
Returns <c>null</c> where <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> has been initialized from an empty string array or is <see cref="F:Microsoft.Extensions.Primitives.StringValues.Empty"/>.
</remarks>
<param name="values">A <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> to implicitly convert.</param>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringValues.op_Implicit(Microsoft.Extensions.Primitives.StringValues)~System.String[]">
<summary>
Defines an implicit conversion of a given <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> to a string array.
</summary>
<param name="value">A <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> to implicitly convert.</param>
</member>
<member name="P:Microsoft.Extensions.Primitives.StringValues.Count">
<summary>
Gets the number of <see cref="T:System.String"/> elements contained in this <see cref="T:Microsoft.Extensions.Primitives.StringValues" />.
</summary>
</member>
<member name="P:Microsoft.Extensions.Primitives.StringValues.System#Collections#Generic#IList{System#String}#Item(System.Int32)">
<summary>
Gets the <see cref="T:System.String"/> at index.
</summary>
<value>The string at the specified index.</value>
<param name="index">The zero-based index of the element to get.</param>
<exception cref="T:System.NotSupportedException">Set operations are not supported on readonly <see cref="T:Microsoft.Extensions.Primitives.StringValues"/>.</exception>
</member>
<member name="P:Microsoft.Extensions.Primitives.StringValues.Item(System.Int32)">
<summary>
Gets the <see cref="T:System.String"/> at index.
</summary>
<value>The string at the specified index.</value>
<param name="index">The zero-based index of the element to get.</param>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringValues.ToString">
<summary>
Converts the value of the current <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> object to its equivalent string representation, with multiple values joined as a comma separated string.
</summary>
<returns>A string representation of the value of the current <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> object.</returns>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringValues.ToArray">
<summary>
Creates a string array from the current <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> object.
</summary>
<returns>A string array represented by this instance.</returns>
<remarks>
<para>If the <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> contains a single string internally, it is copied to a new array.</para>
<para>If the <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> contains an array internally it returns that array instance.</para>
</remarks>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringValues.System#Collections#Generic#IList{System#String}#IndexOf(System.String)">
<summary>
Returns the zero-based index of the first occurrence of an item in the <see cref="T:Microsoft.Extensions.Primitives.StringValues" />.
</summary>
<param name="item">The string to locate in the <see cref="T:Microsoft.Extensions.Primitives.StringValues"></see>.</param>
<returns>the zero-based index of the first occurrence of <paramref name="item" /> within the <see cref="T:Microsoft.Extensions.Primitives.StringValues"></see>, if found; otherwise, -1.</returns>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringValues.System#Collections#Generic#ICollection{System#String}#Contains(System.String)">
<summary>Determines whether a string is in the <see cref="T:Microsoft.Extensions.Primitives.StringValues" />.</summary>
<param name="item">The <see cref="T:System.String"/> to locate in the <see cref="T:Microsoft.Extensions.Primitives.StringValues" />.</param>
<returns>true if <paramref name="item">item</paramref> is found in the <see cref="T:Microsoft.Extensions.Primitives.StringValues" />; otherwise, false.</returns>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringValues.System#Collections#Generic#ICollection{System#String}#CopyTo(System.String[],System.Int32)">
<summary>
Copies the entire <see cref="T:Microsoft.Extensions.Primitives.StringValues" />to a string array, starting at the specified index of the target array.
</summary>
<param name="array">The one-dimensional <see cref="T:System.Array" /> that is the destination of the elements copied from. The <see cref="T:System.Array" /> must have zero-based indexing.</param>
<param name="arrayIndex">The zero-based index in the destination array at which copying begins.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="array">array</paramref> is null.</exception>
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="arrayIndex">arrayIndex</paramref> is less than 0.</exception>
<exception cref="T:System.ArgumentException">The number of elements in the source <see cref="T:Microsoft.Extensions.Primitives.StringValues"></see> is greater than the available space from <paramref name="arrayIndex">arrayIndex</paramref> to the end of the destination <paramref name="array">array</paramref>.</exception>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringValues.GetEnumerator">
<summary>Retrieves an object that can iterate through the individual strings in this <see cref="T:Microsoft.Extensions.Primitives.StringValues" />.</summary>
<returns>An enumerator that can be used to iterate through the <see cref="T:Microsoft.Extensions.Primitives.StringValues" />.</returns>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringValues.System#Collections#Generic#IEnumerable{System#String}#GetEnumerator">
<inheritdoc cref="M:Microsoft.Extensions.Primitives.StringValues.GetEnumerator" />
</member>
<member name="M:Microsoft.Extensions.Primitives.StringValues.System#Collections#IEnumerable#GetEnumerator">
<inheritdoc cref="M:Microsoft.Extensions.Primitives.StringValues.GetEnumerator" />
</member>
<member name="M:Microsoft.Extensions.Primitives.StringValues.IsNullOrEmpty(Microsoft.Extensions.Primitives.StringValues)">
<summary>
Indicates whether the specified <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> contains no string values.
</summary>
<param name="value">The <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> to test.</param>
<returns>true if <paramref name="value">value</paramref> contains a single null or empty string or an empty array; otherwise, false.</returns>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringValues.Concat(Microsoft.Extensions.Primitives.StringValues,Microsoft.Extensions.Primitives.StringValues)">
<summary>
Concatenates two specified instances of <see cref="T:Microsoft.Extensions.Primitives.StringValues"/>.
</summary>
<param name="values1">The first <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> to concatenate.</param>
<param name="values2">The second <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> to concatenate.</param>
<returns>The concatenation of <paramref name="values1"/> and <paramref name="values2"/>.</returns>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringValues.Concat(Microsoft.Extensions.Primitives.StringValues@,System.String)">
<summary>
Concatenates specified instance of <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> with specified <see cref="T:System.String"/>.
</summary>
<param name="values">The <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> to concatenate.</param>
<param name="value">The <see cref="T:System.String" /> to concatenate.</param>
<returns>The concatenation of <paramref name="values"/> and <paramref name="value"/>.</returns>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringValues.Concat(System.String,Microsoft.Extensions.Primitives.StringValues@)">
<summary>
Concatenates specified instance of <see cref="T:System.String"/> with specified <see cref="T:Microsoft.Extensions.Primitives.StringValues"/>.
</summary>
<param name="value">The <see cref="T:System.String" /> to concatenate.</param>
<param name="values">The <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> to concatenate.</param>
<returns>The concatenation of <paramref name="values"/> and <paramref name="values"/>.</returns>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringValues.Equals(Microsoft.Extensions.Primitives.StringValues,Microsoft.Extensions.Primitives.StringValues)">
<summary>
Determines whether two specified <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> objects have the same values in the same order.
</summary>
<param name="left">The first <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> to compare.</param>
<param name="right">The second <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> to compare.</param>
<returns><c>true</c> if the value of <paramref name="left"/> is the same as the value of <paramref name="right"/>; otherwise, <c>false</c>.</returns>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringValues.op_Equality(Microsoft.Extensions.Primitives.StringValues,Microsoft.Extensions.Primitives.StringValues)">
<summary>
Determines whether two specified <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> have the same values.
</summary>
<param name="left">The first <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> to compare.</param>
<param name="right">The second <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> to compare.</param>
<returns><c>true</c> if the value of <paramref name="left"/> is the same as the value of <paramref name="right"/>; otherwise, <c>false</c>.</returns>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringValues.op_Inequality(Microsoft.Extensions.Primitives.StringValues,Microsoft.Extensions.Primitives.StringValues)">
<summary>
Determines whether two specified <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> have different values.
</summary>
<param name="left">The first <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> to compare.</param>
<param name="right">The second <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> to compare.</param>
<returns><c>true</c> if the value of <paramref name="left"/> is different to the value of <paramref name="right"/>; otherwise, <c>false</c>.</returns>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringValues.Equals(Microsoft.Extensions.Primitives.StringValues)">
<summary>
Determines whether this instance and another specified <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> object have the same values.
</summary>
<param name="other">The string to compare to this instance.</param>
<returns><c>true</c> if the value of <paramref name="other"/> is the same as the value of this instance; otherwise, <c>false</c>.</returns>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringValues.Equals(System.String,Microsoft.Extensions.Primitives.StringValues)">
<summary>
Determines whether the specified <see cref="T:System.String"/> and <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> objects have the same values.
</summary>
<param name="left">The <see cref="T:System.String"/> to compare.</param>
<param name="right">The <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> to compare.</param>
<returns><c>true</c> if the value of <paramref name="left"/> is the same as the value of <paramref name="right"/>; otherwise, <c>false</c>. If <paramref name="left"/> is <c>null</c>, the method returns <c>false</c>.</returns>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringValues.Equals(Microsoft.Extensions.Primitives.StringValues,System.String)">
<summary>
Determines whether the specified <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> and <see cref="T:System.String"/> objects have the same values.
</summary>
<param name="left">The <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> to compare.</param>
<param name="right">The <see cref="T:System.String"/> to compare.</param>
<returns><c>true</c> if the value of <paramref name="left"/> is the same as the value of <paramref name="right"/>; otherwise, <c>false</c>. If <paramref name="right"/> is <c>null</c>, the method returns <c>false</c>.</returns>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringValues.Equals(System.String)">
<summary>
Determines whether this instance and a specified <see cref="T:System.String"/>, have the same value.
</summary>
<param name="other">The <see cref="T:System.String"/> to compare to this instance.</param>
<returns><c>true</c> if the value of <paramref name="other"/> is the same as this instance; otherwise, <c>false</c>. If <paramref name="other"/> is <c>null</c>, returns <c>false</c>.</returns>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringValues.Equals(System.String[],Microsoft.Extensions.Primitives.StringValues)">
<summary>
Determines whether the specified string array and <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> objects have the same values.
</summary>
<param name="left">The string array to compare.</param>
<param name="right">The <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> to compare.</param>
<returns><c>true</c> if the value of <paramref name="left"/> is the same as the value of <paramref name="right"/>; otherwise, <c>false</c>.</returns>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringValues.Equals(Microsoft.Extensions.Primitives.StringValues,System.String[])">
<summary>
Determines whether the specified <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> and string array objects have the same values.
</summary>
<param name="left">The <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> to compare.</param>
<param name="right">The string array to compare.</param>
<returns><c>true</c> if the value of <paramref name="left"/> is the same as the value of <paramref name="right"/>; otherwise, <c>false</c>.</returns>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringValues.Equals(System.String[])">
<summary>
Determines whether this instance and a specified string array have the same values.
</summary>
<param name="other">The string array to compare to this instance.</param>
<returns><c>true</c> if the value of <paramref name="other"/> is the same as this instance; otherwise, <c>false</c>.</returns>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringValues.op_Equality(Microsoft.Extensions.Primitives.StringValues,System.String)">
<inheritdoc cref="M:Microsoft.Extensions.Primitives.StringValues.Equals(Microsoft.Extensions.Primitives.StringValues,System.String)" />
</member>
<member name="M:Microsoft.Extensions.Primitives.StringValues.op_Inequality(Microsoft.Extensions.Primitives.StringValues,System.String)">
<summary>
Determines whether the specified <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> and <see cref="T:System.String"/> objects have different values.
</summary>
<param name="left">The <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> to compare.</param>
<param name="right">The <see cref="T:System.String"/> to compare.</param>
<returns><c>true</c> if the value of <paramref name="left"/> is different to the value of <paramref name="right"/>; otherwise, <c>false</c>.</returns>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringValues.op_Equality(System.String,Microsoft.Extensions.Primitives.StringValues)">
<inheritdoc cref="M:Microsoft.Extensions.Primitives.StringValues.Equals(System.String,Microsoft.Extensions.Primitives.StringValues)" />
</member>
<member name="M:Microsoft.Extensions.Primitives.StringValues.op_Inequality(System.String,Microsoft.Extensions.Primitives.StringValues)">
<summary>
Determines whether the specified <see cref="T:System.String"/> and <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> objects have different values.
</summary>
<param name="left">The <see cref="T:System.String"/> to compare.</param>
<param name="right">The <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> to compare.</param>
<returns><c>true</c> if the value of <paramref name="left"/> is different to the value of <paramref name="right"/>; otherwise, <c>false</c>.</returns>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringValues.op_Equality(Microsoft.Extensions.Primitives.StringValues,System.String[])">
<inheritdoc cref="M:Microsoft.Extensions.Primitives.StringValues.Equals(Microsoft.Extensions.Primitives.StringValues,System.String[])" />
</member>
<member name="M:Microsoft.Extensions.Primitives.StringValues.op_Inequality(Microsoft.Extensions.Primitives.StringValues,System.String[])">
<summary>
Determines whether the specified <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> and string array have different values.
</summary>
<param name="left">The <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> to compare.</param>
<param name="right">The string array to compare.</param>
<returns><c>true</c> if the value of <paramref name="left"/> is different to the value of <paramref name="right"/>; otherwise, <c>false</c>.</returns>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringValues.op_Equality(System.String[],Microsoft.Extensions.Primitives.StringValues)">
<inheritdoc cref="M:Microsoft.Extensions.Primitives.StringValues.Equals(System.String[],Microsoft.Extensions.Primitives.StringValues)" />
</member>
<member name="M:Microsoft.Extensions.Primitives.StringValues.op_Inequality(System.String[],Microsoft.Extensions.Primitives.StringValues)">
<summary>
Determines whether the specified string array and <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> have different values.
</summary>
<param name="left">The string array to compare.</param>
<param name="right">The <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> to compare.</param>
<returns><c>true</c> if the value of <paramref name="left"/> is different to the value of <paramref name="right"/>; otherwise, <c>false</c>.</returns>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringValues.op_Equality(Microsoft.Extensions.Primitives.StringValues,System.Object)">
<summary>
Determines whether the specified <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> and <see cref="T:System.Object"/>, which must be a
<see cref="T:Microsoft.Extensions.Primitives.StringValues"/>, <see cref="T:System.String"/>, or array of <see cref="T:System.String"/>, have the same value.
</summary>
<param name="left">The <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> to compare.</param>
<param name="right">The <see cref="T:System.Object"/> to compare.</param>
<returns><c>true</c> if the <paramref name="left"/> object is equal to the <paramref name="right"/>; otherwise, <c>false</c>.</returns>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringValues.op_Inequality(Microsoft.Extensions.Primitives.StringValues,System.Object)">
<summary>
Determines whether the specified <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> and <see cref="T:System.Object"/>, which must be a
<see cref="T:Microsoft.Extensions.Primitives.StringValues"/>, <see cref="T:System.String"/>, or array of <see cref="T:System.String"/>, have different values.
</summary>
<param name="left">The <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> to compare.</param>
<param name="right">The <see cref="T:System.Object"/> to compare.</param>
<returns><c>true</c> if the <paramref name="left"/> object is equal to the <paramref name="right"/>; otherwise, <c>false</c>.</returns>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringValues.op_Equality(System.Object,Microsoft.Extensions.Primitives.StringValues)">
<summary>
Determines whether the specified <see cref="T:System.Object"/>, which must be a
<see cref="T:Microsoft.Extensions.Primitives.StringValues"/>, <see cref="T:System.String"/>, or array of <see cref="T:System.String"/>, and specified <see cref="T:Microsoft.Extensions.Primitives.StringValues"/>, have the same value.
</summary>
<param name="left">The <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> to compare.</param>
<param name="right">The <see cref="T:System.Object"/> to compare.</param>
<returns><c>true</c> if the <paramref name="left"/> object is equal to the <paramref name="right"/>; otherwise, <c>false</c>.</returns>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringValues.op_Inequality(System.Object,Microsoft.Extensions.Primitives.StringValues)">
<summary>
Determines whether the specified <see cref="T:System.Object"/> and <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> object have the same values.
</summary>
<param name="left">The <see cref="T:System.Object"/> to compare.</param>
<param name="right">The <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> to compare.</param>
<returns><c>true</c> if the <paramref name="left"/> object is equal to the <paramref name="right"/>; otherwise, <c>false</c>.</returns>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringValues.Equals(System.Object)">
<summary>
Determines whether this instance and a specified object have the same value.
</summary>
<param name="obj">An object to compare with this object.</param>
<returns><c>true</c> if the current object is equal to <paramref name="obj"/>; otherwise, <c>false</c>.</returns>
</member>
<member name="M:Microsoft.Extensions.Primitives.StringValues.GetHashCode">
<inheritdoc />
</member>
<member name="T:Microsoft.Extensions.Primitives.StringValues.Enumerator">
<summary>
Enumerates the string values of a <see cref="T:Microsoft.Extensions.Primitives.StringValues" />.
</summary>
</member>
<member name="P:System.SR.Argument_InvalidOffsetLength">
<summary>Offset and length are out of bounds for the string or length is greater than the number of characters from index to the end of the string.</summary>
</member>
<member name="P:System.SR.Argument_InvalidOffsetLengthStringSegment">
<summary>Offset and length are out of bounds for this StringSegment or length is greater than the number of characters to the end of this StringSegment.</summary>
</member>
<member name="P:System.SR.Capacity_CannotChangeAfterWriteStarted">
<summary>Cannot change capacity after write started.</summary>
</member>
<member name="P:System.SR.Capacity_NotEnough">
<summary>Not enough capacity to write '{0}' characters, only '{1}' left.</summary>
</member>
<member name="P:System.SR.Capacity_NotUsedEntirely">
<summary>Entire reserved capacity was not used. Capacity: '{0}', written '{1}'.</summary>
</member>
<member name="T:System.Runtime.InteropServices.LibraryImportAttribute">
<summary>
Attribute used to indicate a source generator should create a function for marshalling
arguments instead of relying on the runtime to generate an equivalent marshalling function at run-time.
</summary>
<remarks>
This attribute is meaningless if the source generator associated with it is not enabled.
The current built-in source generator only supports C# and only supplies an implementation when
applied to static, partial, non-generic methods.
</remarks>
</member>
<member name="M:System.Runtime.InteropServices.LibraryImportAttribute.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:System.Runtime.InteropServices.LibraryImportAttribute"/>.
</summary>
<param name="libraryName">Name of the library containing the import.</param>
</member>
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.LibraryName">
<summary>
Gets the name of the library containing the import.
</summary>
</member>
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.EntryPoint">
<summary>
Gets or sets the name of the entry point to be called.
</summary>
</member>
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling">
<summary>
Gets or sets how to marshal string arguments to the method.
</summary>
<remarks>
If this field is set to a value other than <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />,
<see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType" /> must not be specified.
</remarks>
</member>
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType">
<summary>
Gets or sets the <see cref="T:System.Type"/> used to control how string arguments to the method are marshalled.
</summary>
<remarks>
If this field is specified, <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling" /> must not be specified
or must be set to <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />.
</remarks>
</member>
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.SetLastError">
<summary>
Gets or sets whether the callee sets an error (SetLastError on Windows or errno
on other platforms) before returning from the attributed method.
</summary>
</member>
<member name="T:System.Runtime.InteropServices.StringMarshalling">
<summary>
Specifies how strings should be marshalled for generated p/invokes
</summary>
</member>
<member name="F:System.Runtime.InteropServices.StringMarshalling.Custom">
<summary>
Indicates the user is suppling a specific marshaller in <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType"/>.
</summary>
</member>
<member name="F:System.Runtime.InteropServices.StringMarshalling.Utf8">
<summary>
Use the platform-provided UTF-8 marshaller.
</summary>
</member>
<member name="F:System.Runtime.InteropServices.StringMarshalling.Utf16">
<summary>
Use the platform-provided UTF-16 marshaller.
</summary>
</member>
</members>
</doc>
md5: 7C40214D60B54749A1A7F79EA6F62BAC | sha1: A240D705B52FB1A78CCEEDAB268DB42CBEB47512 | sha256: 769A59793D4B8885BBBFBC5AEE8F57A0D4E34D275C56C60C03994309B87F67E9 | sha512: 66A489988D15F1C651061656703B6FB03C4C6EBE82BCB0D48246C760E3764E4A7F2AD8D1653C90401FBA6AA9974586D36256AD3A47E1112C1F38488A8818AB92
md5: 0C4EC4EB146BFE047755669C8060A967 | sha1: F663CC3BC174A98A49893E0CF334B479B05E453D | sha256: 61637F9940E5E336571CBF945BE0F36D6D6050E06288DF0F0232D93B26F0BDE7 | sha512: 478DBA76DE5B20906A31F2FF72A559779A262ABE0265D475AA60D555D4F94F79887F237F393F256134BE758D565AA46B30A39E81B23E1F3048FC80AB779405AF
md5: 743102D277A8754DC74F7644E03A8956 | sha1: 31971747D45F995BC8D05C26C728DF293A074DB6 | sha256: A5249A04AD8FD7DFD47E4D0A620AED0F7EB6051E1DDEC102C541CA3E12F6E2A8 | sha512: 00BB76043A3A147B570E0421F768A2F2238954922C45C611D10D8FD4A1F8BA56DA8A7B7377FACFE54FF6DBEE2D81BE87C0D6E3DE9E884625697AE478A82677E9
md5: FE8C2B2EEF6E5E7284DC9B522A7BE468 | sha1: 8779911266EA9BFEA924AAD33A7E1C7855F41857 | sha256: 273292BABD45F9F34DE5054BD9CDFE1D859A7DBF6F4AD5974FE4EAD70698ED5B | sha512: B78F759568FA5CE77F87DB6F02688493877CED8C9B289934C6ADC95DB5581D3EBC858092C650A47D5D7EB44C2DD2ED01A8491930ACD8173D45F777285D0990AB
md5: 916D32B899F1BC23B209648D007B99FD | sha1: E3673D05D46F29E68241D4536BDDF18CDD0A913D | sha256: 72CF291D4BAB0EDD08A9B07C6173E1E7AD1ABB7AB727FD7044BF6305D7515661 | sha512: 60BD2693DAA42637F8AE6D6460C3013C87F46F28E9B0DBF9D7F6764703B904A7C8C22E30B4BA13F1F23F6CBEE7D9640EE3821C48110E67440F237C2BB2EE5EB6
<?xml version="1.0"?>
<doc>
<assembly>
<name>Newtonsoft.Json</name>
</assembly>
<members>
<member name="T:Newtonsoft.Json.Bson.BsonObjectId">
<summary>
Represents a BSON Oid (object id).
</summary>
</member>
<member name="P:Newtonsoft.Json.Bson.BsonObjectId.Value">
<summary>
Gets or sets the value of the Oid.
</summary>
<value>The value of the Oid.</value>
</member>
<member name="M:Newtonsoft.Json.Bson.BsonObjectId.#ctor(System.Byte[])">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Bson.BsonObjectId"/> class.
</summary>
<param name="value">The Oid value.</param>
</member>
<member name="T:Newtonsoft.Json.Bson.BsonReader">
<summary>
Represents a reader that provides fast, non-cached, forward-only access to serialized BSON data.
</summary>
</member>
<member name="P:Newtonsoft.Json.Bson.BsonReader.JsonNet35BinaryCompatibility">
<summary>
Gets or sets a value indicating whether binary data reading should be compatible with incorrect Json.NET 3.5 written binary.
</summary>
<value>
<c>true</c> if binary data reading will be compatible with incorrect Json.NET 3.5 written binary; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Newtonsoft.Json.Bson.BsonReader.ReadRootValueAsArray">
<summary>
Gets or sets a value indicating whether the root object will be read as a JSON array.
</summary>
<value>
<c>true</c> if the root object will be read as a JSON array; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Newtonsoft.Json.Bson.BsonReader.DateTimeKindHandling">
<summary>
Gets or sets the <see cref="T:System.DateTimeKind" /> used when reading <see cref="T:System.DateTime"/> values from BSON.
</summary>
<value>The <see cref="T:System.DateTimeKind" /> used when reading <see cref="T:System.DateTime"/> values from BSON.</value>
</member>
<member name="M:Newtonsoft.Json.Bson.BsonReader.#ctor(System.IO.Stream)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Bson.BsonReader"/> class.
</summary>
<param name="stream">The <see cref="T:System.IO.Stream"/> containing the BSON data to read.</param>
</member>
<member name="M:Newtonsoft.Json.Bson.BsonReader.#ctor(System.IO.BinaryReader)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Bson.BsonReader"/> class.
</summary>
<param name="reader">The <see cref="T:System.IO.BinaryReader"/> containing the BSON data to read.</param>
</member>
<member name="M:Newtonsoft.Json.Bson.BsonReader.#ctor(System.IO.Stream,System.Boolean,System.DateTimeKind)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Bson.BsonReader"/> class.
</summary>
<param name="stream">The <see cref="T:System.IO.Stream"/> containing the BSON data to read.</param>
<param name="readRootValueAsArray">if set to <c>true</c> the root object will be read as a JSON array.</param>
<param name="dateTimeKindHandling">The <see cref="T:System.DateTimeKind" /> used when reading <see cref="T:System.DateTime"/> values from BSON.</param>
</member>
<member name="M:Newtonsoft.Json.Bson.BsonReader.#ctor(System.IO.BinaryReader,System.Boolean,System.DateTimeKind)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Bson.BsonReader"/> class.
</summary>
<param name="reader">The <see cref="T:System.IO.BinaryReader"/> containing the BSON data to read.</param>
<param name="readRootValueAsArray">if set to <c>true</c> the root object will be read as a JSON array.</param>
<param name="dateTimeKindHandling">The <see cref="T:System.DateTimeKind" /> used when reading <see cref="T:System.DateTime"/> values from BSON.</param>
</member>
<member name="M:Newtonsoft.Json.Bson.BsonReader.Read">
<summary>
Reads the next JSON token from the underlying <see cref="T:System.IO.Stream"/>.
</summary>
<returns>
<c>true</c> if the next token was read successfully; <c>false</c> if there are no more tokens to read.
</returns>
</member>
<member name="M:Newtonsoft.Json.Bson.BsonReader.Close">
<summary>
Changes the reader's state to <see cref="F:Newtonsoft.Json.JsonReader.State.Closed"/>.
If <see cref="P:Newtonsoft.Json.JsonReader.CloseInput"/> is set to <c>true</c>, the underlying <see cref="T:System.IO.Stream"/> is also closed.
</summary>
</member>
<member name="T:Newtonsoft.Json.Bson.BsonWriter">
<summary>
Represents a writer that provides a fast, non-cached, forward-only way of generating BSON data.
</summary>
</member>
<member name="P:Newtonsoft.Json.Bson.BsonWriter.DateTimeKindHandling">
<summary>
Gets or sets the <see cref="T:System.DateTimeKind" /> used when writing <see cref="T:System.DateTime"/> values to BSON.
When set to <see cref="F:System.DateTimeKind.Unspecified" /> no conversion will occur.
</summary>
<value>The <see cref="T:System.DateTimeKind" /> used when writing <see cref="T:System.DateTime"/> values to BSON.</value>
</member>
<member name="M:Newtonsoft.Json.Bson.BsonWriter.#ctor(System.IO.Stream)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Bson.BsonWriter"/> class.
</summary>
<param name="stream">The <see cref="T:System.IO.Stream"/> to write to.</param>
</member>
<member name="M:Newtonsoft.Json.Bson.BsonWriter.#ctor(System.IO.BinaryWriter)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Bson.BsonWriter"/> class.
</summary>
<param name="writer">The <see cref="T:System.IO.BinaryWriter"/> to write to.</param>
</member>
<member name="M:Newtonsoft.Json.Bson.BsonWriter.Flush">
<summary>
Flushes whatever is in the buffer to the underlying <see cref="T:System.IO.Stream"/> and also flushes the underlying stream.
</summary>
</member>
<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteEnd(Newtonsoft.Json.JsonToken)">
<summary>
Writes the end.
</summary>
<param name="token">The token.</param>
</member>
<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteComment(System.String)">
<summary>
Writes a comment <c>/*...*/</c> containing the specified text.
</summary>
<param name="text">Text to place inside the comment.</param>
</member>
<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteStartConstructor(System.String)">
<summary>
Writes the start of a constructor with the given name.
</summary>
<param name="name">The name of the constructor.</param>
</member>
<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteRaw(System.String)">
<summary>
Writes raw JSON.
</summary>
<param name="json">The raw JSON to write.</param>
</member>
<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteRawValue(System.String)">
<summary>
Writes raw JSON where a value is expected and updates the writer's state.
</summary>
<param name="json">The raw JSON to write.</param>
</member>
<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteStartArray">
<summary>
Writes the beginning of a JSON array.
</summary>
</member>
<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteStartObject">
<summary>
Writes the beginning of a JSON object.
</summary>
</member>
<member name="M:Newtonsoft.Json.Bson.BsonWriter.WritePropertyName(System.String)">
<summary>
Writes the property name of a name/value pair on a JSON object.
</summary>
<param name="name">The name of the property.</param>
</member>
<member name="M:Newtonsoft.Json.Bson.BsonWriter.Close">
<summary>
Closes this writer.
If <see cref="P:Newtonsoft.Json.JsonWriter.CloseOutput"/> is set to <c>true</c>, the underlying <see cref="T:System.IO.Stream"/> is also closed.
If <see cref="P:Newtonsoft.Json.JsonWriter.AutoCompleteOnClose"/> is set to <c>true</c>, the JSON is auto-completed.
</summary>
</member>
<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.Object)">
<summary>
Writes a <see cref="T:System.Object"/> value.
An error will raised if the value cannot be written as a single JSON token.
</summary>
<param name="value">The <see cref="T:System.Object"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteNull">
<summary>
Writes a null value.
</summary>
</member>
<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteUndefined">
<summary>
Writes an undefined value.
</summary>
</member>
<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.String)">
<summary>
Writes a <see cref="T:System.String"/> value.
</summary>
<param name="value">The <see cref="T:System.String"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.Int32)">
<summary>
Writes a <see cref="T:System.Int32"/> value.
</summary>
<param name="value">The <see cref="T:System.Int32"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.UInt32)">
<summary>
Writes a <see cref="T:System.UInt32"/> value.
</summary>
<param name="value">The <see cref="T:System.UInt32"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.Int64)">
<summary>
Writes a <see cref="T:System.Int64"/> value.
</summary>
<param name="value">The <see cref="T:System.Int64"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.UInt64)">
<summary>
Writes a <see cref="T:System.UInt64"/> value.
</summary>
<param name="value">The <see cref="T:System.UInt64"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.Single)">
<summary>
Writes a <see cref="T:System.Single"/> value.
</summary>
<param name="value">The <see cref="T:System.Single"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.Double)">
<summary>
Writes a <see cref="T:System.Double"/> value.
</summary>
<param name="value">The <see cref="T:System.Double"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.Boolean)">
<summary>
Writes a <see cref="T:System.Boolean"/> value.
</summary>
<param name="value">The <see cref="T:System.Boolean"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.Int16)">
<summary>
Writes a <see cref="T:System.Int16"/> value.
</summary>
<param name="value">The <see cref="T:System.Int16"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.UInt16)">
<summary>
Writes a <see cref="T:System.UInt16"/> value.
</summary>
<param name="value">The <see cref="T:System.UInt16"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.Char)">
<summary>
Writes a <see cref="T:System.Char"/> value.
</summary>
<param name="value">The <see cref="T:System.Char"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.Byte)">
<summary>
Writes a <see cref="T:System.Byte"/> value.
</summary>
<param name="value">The <see cref="T:System.Byte"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.SByte)">
<summary>
Writes a <see cref="T:System.SByte"/> value.
</summary>
<param name="value">The <see cref="T:System.SByte"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.Decimal)">
<summary>
Writes a <see cref="T:System.Decimal"/> value.
</summary>
<param name="value">The <see cref="T:System.Decimal"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.DateTime)">
<summary>
Writes a <see cref="T:System.DateTime"/> value.
</summary>
<param name="value">The <see cref="T:System.DateTime"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.DateTimeOffset)">
<summary>
Writes a <see cref="T:System.DateTimeOffset"/> value.
</summary>
<param name="value">The <see cref="T:System.DateTimeOffset"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.Byte[])">
<summary>
Writes a <see cref="T:System.Byte"/>[] value.
</summary>
<param name="value">The <see cref="T:System.Byte"/>[] value to write.</param>
</member>
<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.Guid)">
<summary>
Writes a <see cref="T:System.Guid"/> value.
</summary>
<param name="value">The <see cref="T:System.Guid"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.TimeSpan)">
<summary>
Writes a <see cref="T:System.TimeSpan"/> value.
</summary>
<param name="value">The <see cref="T:System.TimeSpan"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.Uri)">
<summary>
Writes a <see cref="T:System.Uri"/> value.
</summary>
<param name="value">The <see cref="T:System.Uri"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteObjectId(System.Byte[])">
<summary>
Writes a <see cref="T:System.Byte"/>[] value that represents a BSON object id.
</summary>
<param name="value">The Object ID value to write.</param>
</member>
<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteRegex(System.String,System.String)">
<summary>
Writes a BSON regex.
</summary>
<param name="pattern">The regex pattern.</param>
<param name="options">The regex options.</param>
</member>
<member name="T:Newtonsoft.Json.ConstructorHandling">
<summary>
Specifies how constructors are used when initializing objects during deserialization by the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
</summary>
</member>
<member name="F:Newtonsoft.Json.ConstructorHandling.Default">
<summary>
First attempt to use the public default constructor, then fall back to a single parameterized constructor, then to the non-public default constructor.
</summary>
</member>
<member name="F:Newtonsoft.Json.ConstructorHandling.AllowNonPublicDefaultConstructor">
<summary>
Json.NET will use a non-public default constructor before falling back to a parameterized constructor.
</summary>
</member>
<member name="T:Newtonsoft.Json.Converters.BinaryConverter">
<summary>
Converts a binary value to and from a base 64 string value.
</summary>
</member>
<member name="M:Newtonsoft.Json.Converters.BinaryConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Writes the JSON representation of the object.
</summary>
<param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param>
<param name="value">The value.</param>
<param name="serializer">The calling serializer.</param>
</member>
<member name="M:Newtonsoft.Json.Converters.BinaryConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Reads the JSON representation of the object.
</summary>
<param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param>
<param name="objectType">Type of the object.</param>
<param name="existingValue">The existing value of object being read.</param>
<param name="serializer">The calling serializer.</param>
<returns>The object value.</returns>
</member>
<member name="M:Newtonsoft.Json.Converters.BinaryConverter.CanConvert(System.Type)">
<summary>
Determines whether this instance can convert the specified object type.
</summary>
<param name="objectType">Type of the object.</param>
<returns>
<c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>.
</returns>
</member>
<member name="T:Newtonsoft.Json.Converters.BsonObjectIdConverter">
<summary>
Converts a <see cref="T:Newtonsoft.Json.Bson.BsonObjectId"/> to and from JSON and BSON.
</summary>
</member>
<member name="M:Newtonsoft.Json.Converters.BsonObjectIdConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Writes the JSON representation of the object.
</summary>
<param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param>
<param name="value">The value.</param>
<param name="serializer">The calling serializer.</param>
</member>
<member name="M:Newtonsoft.Json.Converters.BsonObjectIdConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Reads the JSON representation of the object.
</summary>
<param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param>
<param name="objectType">Type of the object.</param>
<param name="existingValue">The existing value of object being read.</param>
<param name="serializer">The calling serializer.</param>
<returns>The object value.</returns>
</member>
<member name="M:Newtonsoft.Json.Converters.BsonObjectIdConverter.CanConvert(System.Type)">
<summary>
Determines whether this instance can convert the specified object type.
</summary>
<param name="objectType">Type of the object.</param>
<returns>
<c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>.
</returns>
</member>
<member name="T:Newtonsoft.Json.Converters.CustomCreationConverter`1">
<summary>
Creates a custom object.
</summary>
<typeparam name="T">The object type to convert.</typeparam>
</member>
<member name="M:Newtonsoft.Json.Converters.CustomCreationConverter`1.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Writes the JSON representation of the object.
</summary>
<param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param>
<param name="value">The value.</param>
<param name="serializer">The calling serializer.</param>
</member>
<member name="M:Newtonsoft.Json.Converters.CustomCreationConverter`1.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Reads the JSON representation of the object.
</summary>
<param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param>
<param name="objectType">Type of the object.</param>
<param name="existingValue">The existing value of object being read.</param>
<param name="serializer">The calling serializer.</param>
<returns>The object value.</returns>
</member>
<member name="M:Newtonsoft.Json.Converters.CustomCreationConverter`1.Create(System.Type)">
<summary>
Creates an object which will then be populated by the serializer.
</summary>
<param name="objectType">Type of the object.</param>
<returns>The created object.</returns>
</member>
<member name="M:Newtonsoft.Json.Converters.CustomCreationConverter`1.CanConvert(System.Type)">
<summary>
Determines whether this instance can convert the specified object type.
</summary>
<param name="objectType">Type of the object.</param>
<returns>
<c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>.
</returns>
</member>
<member name="P:Newtonsoft.Json.Converters.CustomCreationConverter`1.CanWrite">
<summary>
Gets a value indicating whether this <see cref="T:Newtonsoft.Json.JsonConverter"/> can write JSON.
</summary>
<value>
<c>true</c> if this <see cref="T:Newtonsoft.Json.JsonConverter"/> can write JSON; otherwise, <c>false</c>.
</value>
</member>
<member name="T:Newtonsoft.Json.Converters.DataSetConverter">
<summary>
Converts a <see cref="T:System.Data.DataSet"/> to and from JSON.
</summary>
</member>
<member name="M:Newtonsoft.Json.Converters.DataSetConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Writes the JSON representation of the object.
</summary>
<param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param>
<param name="value">The value.</param>
<param name="serializer">The calling serializer.</param>
</member>
<member name="M:Newtonsoft.Json.Converters.DataSetConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Reads the JSON representation of the object.
</summary>
<param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param>
<param name="objectType">Type of the object.</param>
<param name="existingValue">The existing value of object being read.</param>
<param name="serializer">The calling serializer.</param>
<returns>The object value.</returns>
</member>
<member name="M:Newtonsoft.Json.Converters.DataSetConverter.CanConvert(System.Type)">
<summary>
Determines whether this instance can convert the specified value type.
</summary>
<param name="valueType">Type of the value.</param>
<returns>
<c>true</c> if this instance can convert the specified value type; otherwise, <c>false</c>.
</returns>
</member>
<member name="T:Newtonsoft.Json.Converters.DataTableConverter">
<summary>
Converts a <see cref="T:System.Data.DataTable"/> to and from JSON.
</summary>
</member>
<member name="M:Newtonsoft.Json.Converters.DataTableConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Writes the JSON representation of the object.
</summary>
<param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param>
<param name="value">The value.</param>
<param name="serializer">The calling serializer.</param>
</member>
<member name="M:Newtonsoft.Json.Converters.DataTableConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Reads the JSON representation of the object.
</summary>
<param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param>
<param name="objectType">Type of the object.</param>
<param name="existingValue">The existing value of object being read.</param>
<param name="serializer">The calling serializer.</param>
<returns>The object value.</returns>
</member>
<member name="M:Newtonsoft.Json.Converters.DataTableConverter.CanConvert(System.Type)">
<summary>
Determines whether this instance can convert the specified value type.
</summary>
<param name="valueType">Type of the value.</param>
<returns>
<c>true</c> if this instance can convert the specified value type; otherwise, <c>false</c>.
</returns>
</member>
<member name="T:Newtonsoft.Json.Converters.DateTimeConverterBase">
<summary>
Provides a base class for converting a <see cref="T:System.DateTime"/> to and from JSON.
</summary>
</member>
<member name="M:Newtonsoft.Json.Converters.DateTimeConverterBase.CanConvert(System.Type)">
<summary>
Determines whether this instance can convert the specified object type.
</summary>
<param name="objectType">Type of the object.</param>
<returns>
<c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>.
</returns>
</member>
<member name="T:Newtonsoft.Json.Converters.DiscriminatedUnionConverter">
<summary>
Converts a F# discriminated union type to and from JSON.
</summary>
</member>
<member name="M:Newtonsoft.Json.Converters.DiscriminatedUnionConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Writes the JSON representation of the object.
</summary>
<param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param>
<param name="value">The value.</param>
<param name="serializer">The calling serializer.</param>
</member>
<member name="M:Newtonsoft.Json.Converters.DiscriminatedUnionConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Reads the JSON representation of the object.
</summary>
<param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param>
<param name="objectType">Type of the object.</param>
<param name="existingValue">The existing value of object being read.</param>
<param name="serializer">The calling serializer.</param>
<returns>The object value.</returns>
</member>
<member name="M:Newtonsoft.Json.Converters.DiscriminatedUnionConverter.CanConvert(System.Type)">
<summary>
Determines whether this instance can convert the specified object type.
</summary>
<param name="objectType">Type of the object.</param>
<returns>
<c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>.
</returns>
</member>
<member name="T:Newtonsoft.Json.Converters.EntityKeyMemberConverter">
<summary>
Converts an Entity Framework <see cref="T:System.Data.EntityKeyMember"/> to and from JSON.
</summary>
</member>
<member name="M:Newtonsoft.Json.Converters.EntityKeyMemberConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Writes the JSON representation of the object.
</summary>
<param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param>
<param name="value">The value.</param>
<param name="serializer">The calling serializer.</param>
</member>
<member name="M:Newtonsoft.Json.Converters.EntityKeyMemberConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Reads the JSON representation of the object.
</summary>
<param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param>
<param name="objectType">Type of the object.</param>
<param name="existingValue">The existing value of object being read.</param>
<param name="serializer">The calling serializer.</param>
<returns>The object value.</returns>
</member>
<member name="M:Newtonsoft.Json.Converters.EntityKeyMemberConverter.CanConvert(System.Type)">
<summary>
Determines whether this instance can convert the specified object type.
</summary>
<param name="objectType">Type of the object.</param>
<returns>
<c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>.
</returns>
</member>
<member name="T:Newtonsoft.Json.Converters.ExpandoObjectConverter">
<summary>
Converts an <see cref="T:System.Dynamic.ExpandoObject"/> to and from JSON.
</summary>
</member>
<member name="M:Newtonsoft.Json.Converters.ExpandoObjectConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Writes the JSON representation of the object.
</summary>
<param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param>
<param name="value">The value.</param>
<param name="serializer">The calling serializer.</param>
</member>
<member name="M:Newtonsoft.Json.Converters.ExpandoObjectConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Reads the JSON representation of the object.
</summary>
<param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param>
<param name="objectType">Type of the object.</param>
<param name="existingValue">The existing value of object being read.</param>
<param name="serializer">The calling serializer.</param>
<returns>The object value.</returns>
</member>
<member name="M:Newtonsoft.Json.Converters.ExpandoObjectConverter.CanConvert(System.Type)">
<summary>
Determines whether this instance can convert the specified object type.
</summary>
<param name="objectType">Type of the object.</param>
<returns>
<c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>.
</returns>
</member>
<member name="P:Newtonsoft.Json.Converters.ExpandoObjectConverter.CanWrite">
<summary>
Gets a value indicating whether this <see cref="T:Newtonsoft.Json.JsonConverter"/> can write JSON.
</summary>
<value>
<c>true</c> if this <see cref="T:Newtonsoft.Json.JsonConverter"/> can write JSON; otherwise, <c>false</c>.
</value>
</member>
<member name="T:Newtonsoft.Json.Converters.IsoDateTimeConverter">
<summary>
Converts a <see cref="T:System.DateTime"/> to and from the ISO 8601 date format (e.g. <c>"2008-04-12T12:53Z"</c>).
</summary>
</member>
<member name="P:Newtonsoft.Json.Converters.IsoDateTimeConverter.DateTimeStyles">
<summary>
Gets or sets the date time styles used when converting a date to and from JSON.
</summary>
<value>The date time styles used when converting a date to and from JSON.</value>
</member>
<member name="P:Newtonsoft.Json.Converters.IsoDateTimeConverter.DateTimeFormat">
<summary>
Gets or sets the date time format used when converting a date to and from JSON.
</summary>
<value>The date time format used when converting a date to and from JSON.</value>
</member>
<member name="P:Newtonsoft.Json.Converters.IsoDateTimeConverter.Culture">
<summary>
Gets or sets the culture used when converting a date to and from JSON.
</summary>
<value>The culture used when converting a date to and from JSON.</value>
</member>
<member name="M:Newtonsoft.Json.Converters.IsoDateTimeConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Writes the JSON representation of the object.
</summary>
<param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param>
<param name="value">The value.</param>
<param name="serializer">The calling serializer.</param>
</member>
<member name="M:Newtonsoft.Json.Converters.IsoDateTimeConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Reads the JSON representation of the object.
</summary>
<param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param>
<param name="objectType">Type of the object.</param>
<param name="existingValue">The existing value of object being read.</param>
<param name="serializer">The calling serializer.</param>
<returns>The object value.</returns>
</member>
<member name="T:Newtonsoft.Json.Converters.JavaScriptDateTimeConverter">
<summary>
Converts a <see cref="T:System.DateTime"/> to and from a JavaScript <c>Date</c> constructor (e.g. <c>new Date(52231943)</c>).
</summary>
</member>
<member name="M:Newtonsoft.Json.Converters.JavaScriptDateTimeConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Writes the JSON representation of the object.
</summary>
<param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param>
<param name="value">The value.</param>
<param name="serializer">The calling serializer.</param>
</member>
<member name="M:Newtonsoft.Json.Converters.JavaScriptDateTimeConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Reads the JSON representation of the object.
</summary>
<param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param>
<param name="objectType">Type of the object.</param>
<param name="existingValue">The existing property value of the JSON that is being converted.</param>
<param name="serializer">The calling serializer.</param>
<returns>The object value.</returns>
</member>
<member name="T:Newtonsoft.Json.Converters.KeyValuePairConverter">
<summary>
Converts a <see cref="T:System.Collections.Generic.KeyValuePair`2"/> to and from JSON.
</summary>
</member>
<member name="M:Newtonsoft.Json.Converters.KeyValuePairConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Writes the JSON representation of the object.
</summary>
<param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param>
<param name="value">The value.</param>
<param name="serializer">The calling serializer.</param>
</member>
<member name="M:Newtonsoft.Json.Converters.KeyValuePairConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Reads the JSON representation of the object.
</summary>
<param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param>
<param name="objectType">Type of the object.</param>
<param name="existingValue">The existing value of object being read.</param>
<param name="serializer">The calling serializer.</param>
<returns>The object value.</returns>
</member>
<member name="M:Newtonsoft.Json.Converters.KeyValuePairConverter.CanConvert(System.Type)">
<summary>
Determines whether this instance can convert the specified object type.
</summary>
<param name="objectType">Type of the object.</param>
<returns>
<c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>.
</returns>
</member>
<member name="T:Newtonsoft.Json.Converters.RegexConverter">
<summary>
Converts a <see cref="T:System.Text.RegularExpressions.Regex"/> to and from JSON and BSON.
</summary>
</member>
<member name="M:Newtonsoft.Json.Converters.RegexConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Writes the JSON representation of the object.
</summary>
<param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param>
<param name="value">The value.</param>
<param name="serializer">The calling serializer.</param>
</member>
<member name="M:Newtonsoft.Json.Converters.RegexConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Reads the JSON representation of the object.
</summary>
<param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param>
<param name="objectType">Type of the object.</param>
<param name="existingValue">The existing value of object being read.</param>
<param name="serializer">The calling serializer.</param>
<returns>The object value.</returns>
</member>
<member name="M:Newtonsoft.Json.Converters.RegexConverter.CanConvert(System.Type)">
<summary>
Determines whether this instance can convert the specified object type.
</summary>
<param name="objectType">Type of the object.</param>
<returns>
<c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>.
</returns>
</member>
<member name="T:Newtonsoft.Json.Converters.StringEnumConverter">
<summary>
Converts an <see cref="T:System.Enum"/> to and from its name string value.
</summary>
</member>
<member name="P:Newtonsoft.Json.Converters.StringEnumConverter.CamelCaseText">
<summary>
Gets or sets a value indicating whether the written enum text should be camel case.
The default value is <c>false</c>.
</summary>
<value><c>true</c> if the written enum text will be camel case; otherwise, <c>false</c>.</value>
</member>
<member name="P:Newtonsoft.Json.Converters.StringEnumConverter.NamingStrategy">
<summary>
Gets or sets the naming strategy used to resolve how enum text is written.
</summary>
<value>The naming strategy used to resolve how enum text is written.</value>
</member>
<member name="P:Newtonsoft.Json.Converters.StringEnumConverter.AllowIntegerValues">
<summary>
Gets or sets a value indicating whether integer values are allowed when serializing and deserializing.
The default value is <c>true</c>.
</summary>
<value><c>true</c> if integers are allowed when serializing and deserializing; otherwise, <c>false</c>.</value>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Converters.StringEnumConverter"/> class.
</summary>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.#ctor(System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Converters.StringEnumConverter"/> class.
</summary>
<param name="camelCaseText"><c>true</c> if the written enum text will be camel case; otherwise, <c>false</c>.</param>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.#ctor(Newtonsoft.Json.Serialization.NamingStrategy,System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Converters.StringEnumConverter"/> class.
</summary>
<param name="namingStrategy">The naming strategy used to resolve how enum text is written.</param>
<param name="allowIntegerValues"><c>true</c> if integers are allowed when serializing and deserializing; otherwise, <c>false</c>.</param>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.#ctor(System.Type)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Converters.StringEnumConverter"/> class.
</summary>
<param name="namingStrategyType">The <see cref="T:System.Type"/> of the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> used to write enum text.</param>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.#ctor(System.Type,System.Object[])">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Converters.StringEnumConverter"/> class.
</summary>
<param name="namingStrategyType">The <see cref="T:System.Type"/> of the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> used to write enum text.</param>
<param name="namingStrategyParameters">
The parameter list to use when constructing the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> described by <paramref name="namingStrategyType"/>.
If <c>null</c>, the default constructor is used.
When non-<c>null</c>, there must be a constructor defined in the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> that exactly matches the number,
order, and type of these parameters.
</param>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.#ctor(System.Type,System.Object[],System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Converters.StringEnumConverter"/> class.
</summary>
<param name="namingStrategyType">The <see cref="T:System.Type"/> of the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> used to write enum text.</param>
<param name="namingStrategyParameters">
The parameter list to use when constructing the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> described by <paramref name="namingStrategyType"/>.
If <c>null</c>, the default constructor is used.
When non-<c>null</c>, there must be a constructor defined in the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> that exactly matches the number,
order, and type of these parameters.
</param>
<param name="allowIntegerValues"><c>true</c> if integers are allowed when serializing and deserializing; otherwise, <c>false</c>.</param>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Writes the JSON representation of the object.
</summary>
<param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param>
<param name="value">The value.</param>
<param name="serializer">The calling serializer.</param>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Reads the JSON representation of the object.
</summary>
<param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param>
<param name="objectType">Type of the object.</param>
<param name="existingValue">The existing value of object being read.</param>
<param name="serializer">The calling serializer.</param>
<returns>The object value.</returns>
</member>
<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.CanConvert(System.Type)">
<summary>
Determines whether this instance can convert the specified object type.
</summary>
<param name="objectType">Type of the object.</param>
<returns>
<c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>.
</returns>
</member>
<member name="T:Newtonsoft.Json.Converters.UnixDateTimeConverter">
<summary>
Converts a <see cref="T:System.DateTime"/> to and from Unix epoch time
</summary>
</member>
<member name="M:Newtonsoft.Json.Converters.UnixDateTimeConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Writes the JSON representation of the object.
</summary>
<param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param>
<param name="value">The value.</param>
<param name="serializer">The calling serializer.</param>
</member>
<member name="M:Newtonsoft.Json.Converters.UnixDateTimeConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Reads the JSON representation of the object.
</summary>
<param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param>
<param name="objectType">Type of the object.</param>
<param name="existingValue">The existing property value of the JSON that is being converted.</param>
<param name="serializer">The calling serializer.</param>
<returns>The object value.</returns>
</member>
<member name="T:Newtonsoft.Json.Converters.VersionConverter">
<summary>
Converts a <see cref="T:System.Version"/> to and from a string (e.g. <c>"1.2.3.4"</c>).
</summary>
</member>
<member name="M:Newtonsoft.Json.Converters.VersionConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Writes the JSON representation of the object.
</summary>
<param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param>
<param name="value">The value.</param>
<param name="serializer">The calling serializer.</param>
</member>
<member name="M:Newtonsoft.Json.Converters.VersionConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Reads the JSON representation of the object.
</summary>
<param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param>
<param name="objectType">Type of the object.</param>
<param name="existingValue">The existing property value of the JSON that is being converted.</param>
<param name="serializer">The calling serializer.</param>
<returns>The object value.</returns>
</member>
<member name="M:Newtonsoft.Json.Converters.VersionConverter.CanConvert(System.Type)">
<summary>
Determines whether this instance can convert the specified object type.
</summary>
<param name="objectType">Type of the object.</param>
<returns>
<c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>.
</returns>
</member>
<member name="T:Newtonsoft.Json.Converters.XmlNodeConverter">
<summary>
Converts XML to and from JSON.
</summary>
</member>
<member name="P:Newtonsoft.Json.Converters.XmlNodeConverter.DeserializeRootElementName">
<summary>
Gets or sets the name of the root element to insert when deserializing to XML if the JSON structure has produced multiple root elements.
</summary>
<value>The name of the deserialized root element.</value>
</member>
<member name="P:Newtonsoft.Json.Converters.XmlNodeConverter.WriteArrayAttribute">
<summary>
Gets or sets a value to indicate whether to write the Json.NET array attribute.
This attribute helps preserve arrays when converting the written XML back to JSON.
</summary>
<value><c>true</c> if the array attribute is written to the XML; otherwise, <c>false</c>.</value>
</member>
<member name="P:Newtonsoft.Json.Converters.XmlNodeConverter.OmitRootObject">
<summary>
Gets or sets a value indicating whether to write the root JSON object.
</summary>
<value><c>true</c> if the JSON root object is omitted; otherwise, <c>false</c>.</value>
</member>
<member name="P:Newtonsoft.Json.Converters.XmlNodeConverter.EncodeSpecialCharacters">
<summary>
Gets or sets a value indicating whether to encode special characters when converting JSON to XML.
If <c>true</c>, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify
XML namespaces, attributes or processing directives. Instead special characters are encoded and written
as part of the XML element name.
</summary>
<value><c>true</c> if special characters are encoded; otherwise, <c>false</c>.</value>
</member>
<member name="M:Newtonsoft.Json.Converters.XmlNodeConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Writes the JSON representation of the object.
</summary>
<param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param>
<param name="serializer">The calling serializer.</param>
<param name="value">The value.</param>
</member>
<member name="M:Newtonsoft.Json.Converters.XmlNodeConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Reads the JSON representation of the object.
</summary>
<param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param>
<param name="objectType">Type of the object.</param>
<param name="existingValue">The existing value of object being read.</param>
<param name="serializer">The calling serializer.</param>
<returns>The object value.</returns>
</member>
<member name="M:Newtonsoft.Json.Converters.XmlNodeConverter.IsNamespaceAttribute(System.String,System.String@)">
<summary>
Checks if the <paramref name="attributeName"/> is a namespace attribute.
</summary>
<param name="attributeName">Attribute name to test.</param>
<param name="prefix">The attribute name prefix if it has one, otherwise an empty string.</param>
<returns><c>true</c> if attribute name is for a namespace attribute, otherwise <c>false</c>.</returns>
</member>
<member name="M:Newtonsoft.Json.Converters.XmlNodeConverter.CanConvert(System.Type)">
<summary>
Determines whether this instance can convert the specified value type.
</summary>
<param name="valueType">Type of the value.</param>
<returns>
<c>true</c> if this instance can convert the specified value type; otherwise, <c>false</c>.
</returns>
</member>
<member name="T:Newtonsoft.Json.DateFormatHandling">
<summary>
Specifies how dates are formatted when writing JSON text.
</summary>
</member>
<member name="F:Newtonsoft.Json.DateFormatHandling.IsoDateFormat">
<summary>
Dates are written in the ISO 8601 format, e.g. <c>"2012-03-21T05:40Z"</c>.
</summary>
</member>
<member name="F:Newtonsoft.Json.DateFormatHandling.MicrosoftDateFormat">
<summary>
Dates are written in the Microsoft JSON format, e.g. <c>"\/Date(1198908717056)\/"</c>.
</summary>
</member>
<member name="T:Newtonsoft.Json.DateParseHandling">
<summary>
Specifies how date formatted strings, e.g. <c>"\/Date(1198908717056)\/"</c> and <c>"2012-03-21T05:40Z"</c>, are parsed when reading JSON text.
</summary>
</member>
<member name="F:Newtonsoft.Json.DateParseHandling.None">
<summary>
Date formatted strings are not parsed to a date type and are read as strings.
</summary>
</member>
<member name="F:Newtonsoft.Json.DateParseHandling.DateTime">
<summary>
Date formatted strings, e.g. <c>"\/Date(1198908717056)\/"</c> and <c>"2012-03-21T05:40Z"</c>, are parsed to <see cref="T:System.DateTime"/>.
</summary>
</member>
<member name="F:Newtonsoft.Json.DateParseHandling.DateTimeOffset">
<summary>
Date formatted strings, e.g. <c>"\/Date(1198908717056)\/"</c> and <c>"2012-03-21T05:40Z"</c>, are parsed to <see cref="T:System.DateTimeOffset"/>.
</summary>
</member>
<member name="T:Newtonsoft.Json.DateTimeZoneHandling">
<summary>
Specifies how to treat the time value when converting between string and <see cref="T:System.DateTime"/>.
</summary>
</member>
<member name="F:Newtonsoft.Json.DateTimeZoneHandling.Local">
<summary>
Treat as local time. If the <see cref="T:System.DateTime"/> object represents a Coordinated Universal Time (UTC), it is converted to the local time.
</summary>
</member>
<member name="F:Newtonsoft.Json.DateTimeZoneHandling.Utc">
<summary>
Treat as a UTC. If the <see cref="T:System.DateTime"/> object represents a local time, it is converted to a UTC.
</summary>
</member>
<member name="F:Newtonsoft.Json.DateTimeZoneHandling.Unspecified">
<summary>
Treat as a local time if a <see cref="T:System.DateTime"/> is being converted to a string.
If a string is being converted to <see cref="T:System.DateTime"/>, convert to a local time if a time zone is specified.
</summary>
</member>
<member name="F:Newtonsoft.Json.DateTimeZoneHandling.RoundtripKind">
<summary>
Time zone information should be preserved when converting.
</summary>
</member>
<member name="T:Newtonsoft.Json.DefaultJsonNameTable">
<summary>
The default JSON name table implementation.
</summary>
</member>
<member name="M:Newtonsoft.Json.DefaultJsonNameTable.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.DefaultJsonNameTable"/> class.
</summary>
</member>
<member name="M:Newtonsoft.Json.DefaultJsonNameTable.Get(System.Char[],System.Int32,System.Int32)">
<summary>
Gets a string containing the same characters as the specified range of characters in the given array.
</summary>
<param name="key">The character array containing the name to find.</param>
<param name="start">The zero-based index into the array specifying the first character of the name.</param>
<param name="length">The number of characters in the name.</param>
<returns>A string containing the same characters as the specified range of characters in the given array.</returns>
</member>
<member name="M:Newtonsoft.Json.DefaultJsonNameTable.Add(System.String)">
<summary>
Adds the specified string into name table.
</summary>
<param name="key">The string to add.</param>
<remarks>This method is not thread-safe.</remarks>
<returns>The resolved string.</returns>
</member>
<member name="T:Newtonsoft.Json.DefaultValueHandling">
<summary>
Specifies default value handling options for the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
</summary>
<example>
<code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\SerializationTests.cs" region="ReducingSerializedJsonSizeDefaultValueHandlingObject" title="DefaultValueHandling Class" />
<code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\SerializationTests.cs" region="ReducingSerializedJsonSizeDefaultValueHandlingExample" title="DefaultValueHandling Ignore Example" />
</example>
</member>
<member name="F:Newtonsoft.Json.DefaultValueHandling.Include">
<summary>
Include members where the member value is the same as the member's default value when serializing objects.
Included members are written to JSON. Has no effect when deserializing.
</summary>
</member>
<member name="F:Newtonsoft.Json.DefaultValueHandling.Ignore">
<summary>
Ignore members where the member value is the same as the member's default value when serializing objects
so that it is not written to JSON.
This option will ignore all default values (e.g. <c>null</c> for objects and nullable types; <c>0</c> for integers,
decimals and floating point numbers; and <c>false</c> for booleans). The default value ignored can be changed by
placing the <see cref="T:System.ComponentModel.DefaultValueAttribute"/> on the property.
</summary>
</member>
<member name="F:Newtonsoft.Json.DefaultValueHandling.Populate">
<summary>
Members with a default value but no JSON will be set to their default value when deserializing.
</summary>
</member>
<member name="F:Newtonsoft.Json.DefaultValueHandling.IgnoreAndPopulate">
<summary>
Ignore members where the member value is the same as the member's default value when serializing objects
and set members to their default value when deserializing.
</summary>
</member>
<member name="T:Newtonsoft.Json.FloatFormatHandling">
<summary>
Specifies float format handling options when writing special floating point numbers, e.g. <see cref="F:System.Double.NaN"/>,
<see cref="F:System.Double.PositiveInfinity"/> and <see cref="F:System.Double.NegativeInfinity"/> with <see cref="T:Newtonsoft.Json.JsonWriter"/>.
</summary>
</member>
<member name="F:Newtonsoft.Json.FloatFormatHandling.String">
<summary>
Write special floating point values as strings in JSON, e.g. <c>"NaN"</c>, <c>"Infinity"</c>, <c>"-Infinity"</c>.
</summary>
</member>
<member name="F:Newtonsoft.Json.FloatFormatHandling.Symbol">
<summary>
Write special floating point values as symbols in JSON, e.g. <c>NaN</c>, <c>Infinity</c>, <c>-Infinity</c>.
Note that this will produce non-valid JSON.
</summary>
</member>
<member name="F:Newtonsoft.Json.FloatFormatHandling.DefaultValue">
<summary>
Write special floating point values as the property's default value in JSON, e.g. 0.0 for a <see cref="T:System.Double"/> property, <c>null</c> for a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Double"/> property.
</summary>
</member>
<member name="T:Newtonsoft.Json.FloatParseHandling">
<summary>
Specifies how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text.
</summary>
</member>
<member name="F:Newtonsoft.Json.FloatParseHandling.Double">
<summary>
Floating point numbers are parsed to <see cref="F:Newtonsoft.Json.FloatParseHandling.Double"/>.
</summary>
</member>
<member name="F:Newtonsoft.Json.FloatParseHandling.Decimal">
<summary>
Floating point numbers are parsed to <see cref="F:Newtonsoft.Json.FloatParseHandling.Decimal"/>.
</summary>
</member>
<member name="T:Newtonsoft.Json.Formatting">
<summary>
Specifies formatting options for the <see cref="T:Newtonsoft.Json.JsonTextWriter"/>.
</summary>
</member>
<member name="F:Newtonsoft.Json.Formatting.None">
<summary>
No special formatting is applied. This is the default.
</summary>
</member>
<member name="F:Newtonsoft.Json.Formatting.Indented">
<summary>
Causes child objects to be indented according to the <see cref="P:Newtonsoft.Json.JsonTextWriter.Indentation"/> and <see cref="P:Newtonsoft.Json.JsonTextWriter.IndentChar"/> settings.
</summary>
</member>
<member name="T:Newtonsoft.Json.IArrayPool`1">
<summary>
Provides an interface for using pooled arrays.
</summary>
<typeparam name="T">The array type content.</typeparam>
</member>
<member name="M:Newtonsoft.Json.IArrayPool`1.Rent(System.Int32)">
<summary>
Rent an array from the pool. This array must be returned when it is no longer needed.
</summary>
<param name="minimumLength">The minimum required length of the array. The returned array may be longer.</param>
<returns>The rented array from the pool. This array must be returned when it is no longer needed.</returns>
</member>
<member name="M:Newtonsoft.Json.IArrayPool`1.Return(`0[])">
<summary>
Return an array to the pool.
</summary>
<param name="array">The array that is being returned.</param>
</member>
<member name="T:Newtonsoft.Json.IJsonLineInfo">
<summary>
Provides an interface to enable a class to return line and position information.
</summary>
</member>
<member name="M:Newtonsoft.Json.IJsonLineInfo.HasLineInfo">
<summary>
Gets a value indicating whether the class can return line information.
</summary>
<returns>
<c>true</c> if <see cref="P:Newtonsoft.Json.IJsonLineInfo.LineNumber"/> and <see cref="P:Newtonsoft.Json.IJsonLineInfo.LinePosition"/> can be provided; otherwise, <c>false</c>.
</returns>
</member>
<member name="P:Newtonsoft.Json.IJsonLineInfo.LineNumber">
<summary>
Gets the current line number.
</summary>
<value>The current line number or 0 if no line information is available (for example, when <see cref="M:Newtonsoft.Json.IJsonLineInfo.HasLineInfo"/> returns <c>false</c>).</value>
</member>
<member name="P:Newtonsoft.Json.IJsonLineInfo.LinePosition">
<summary>
Gets the current line position.
</summary>
<value>The current line position or 0 if no line information is available (for example, when <see cref="M:Newtonsoft.Json.IJsonLineInfo.HasLineInfo"/> returns <c>false</c>).</value>
</member>
<member name="T:Newtonsoft.Json.JsonArrayAttribute">
<summary>
Instructs the <see cref="T:Newtonsoft.Json.JsonSerializer"/> how to serialize the collection.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonArrayAttribute.AllowNullItems">
<summary>
Gets or sets a value indicating whether null items are allowed in the collection.
</summary>
<value><c>true</c> if null items are allowed in the collection; otherwise, <c>false</c>.</value>
</member>
<member name="M:Newtonsoft.Json.JsonArrayAttribute.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonArrayAttribute"/> class.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonArrayAttribute.#ctor(System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonObjectAttribute"/> class with a flag indicating whether the array can contain null items.
</summary>
<param name="allowNullItems">A flag indicating whether the array can contain null items.</param>
</member>
<member name="M:Newtonsoft.Json.JsonArrayAttribute.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonArrayAttribute"/> class with the specified container Id.
</summary>
<param name="id">The container Id.</param>
</member>
<member name="T:Newtonsoft.Json.JsonConstructorAttribute">
<summary>
Instructs the <see cref="T:Newtonsoft.Json.JsonSerializer"/> to use the specified constructor when deserializing that object.
</summary>
</member>
<member name="T:Newtonsoft.Json.JsonContainerAttribute">
<summary>
Instructs the <see cref="T:Newtonsoft.Json.JsonSerializer"/> how to serialize the object.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonContainerAttribute.Id">
<summary>
Gets or sets the id.
</summary>
<value>The id.</value>
</member>
<member name="P:Newtonsoft.Json.JsonContainerAttribute.Title">
<summary>
Gets or sets the title.
</summary>
<value>The title.</value>
</member>
<member name="P:Newtonsoft.Json.JsonContainerAttribute.Description">
<summary>
Gets or sets the description.
</summary>
<value>The description.</value>
</member>
<member name="P:Newtonsoft.Json.JsonContainerAttribute.ItemConverterType">
<summary>
Gets or sets the collection's items converter.
</summary>
<value>The collection's items converter.</value>
</member>
<member name="P:Newtonsoft.Json.JsonContainerAttribute.ItemConverterParameters">
<summary>
The parameter list to use when constructing the <see cref="T:Newtonsoft.Json.JsonConverter"/> described by <see cref="P:Newtonsoft.Json.JsonContainerAttribute.ItemConverterType"/>.
If <c>null</c>, the default constructor is used.
When non-<c>null</c>, there must be a constructor defined in the <see cref="T:Newtonsoft.Json.JsonConverter"/> that exactly matches the number,
order, and type of these parameters.
</summary>
<example>
<code>
[JsonContainer(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })]
</code>
</example>
</member>
<member name="P:Newtonsoft.Json.JsonContainerAttribute.NamingStrategyType">
<summary>
Gets or sets the <see cref="T:System.Type"/> of the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/>.
</summary>
<value>The <see cref="T:System.Type"/> of the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/>.</value>
</member>
<member name="P:Newtonsoft.Json.JsonContainerAttribute.NamingStrategyParameters">
<summary>
The parameter list to use when constructing the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> described by <see cref="P:Newtonsoft.Json.JsonContainerAttribute.NamingStrategyType"/>.
If <c>null</c>, the default constructor is used.
When non-<c>null</c>, there must be a constructor defined in the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> that exactly matches the number,
order, and type of these parameters.
</summary>
<example>
<code>
[JsonContainer(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })]
</code>
</example>
</member>
<member name="P:Newtonsoft.Json.JsonContainerAttribute.IsReference">
<summary>
Gets or sets a value that indicates whether to preserve object references.
</summary>
<value>
<c>true</c> to keep object reference; otherwise, <c>false</c>. The default is <c>false</c>.
</value>
</member>
<member name="P:Newtonsoft.Json.JsonContainerAttribute.ItemIsReference">
<summary>
Gets or sets a value that indicates whether to preserve collection's items references.
</summary>
<value>
<c>true</c> to keep collection's items object references; otherwise, <c>false</c>. The default is <c>false</c>.
</value>
</member>
<member name="P:Newtonsoft.Json.JsonContainerAttribute.ItemReferenceLoopHandling">
<summary>
Gets or sets the reference loop handling used when serializing the collection's items.
</summary>
<value>The reference loop handling.</value>
</member>
<member name="P:Newtonsoft.Json.JsonContainerAttribute.ItemTypeNameHandling">
<summary>
Gets or sets the type name handling used when serializing the collection's items.
</summary>
<value>The type name handling.</value>
</member>
<member name="M:Newtonsoft.Json.JsonContainerAttribute.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonContainerAttribute"/> class.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonContainerAttribute.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonContainerAttribute"/> class with the specified container Id.
</summary>
<param name="id">The container Id.</param>
</member>
<member name="T:Newtonsoft.Json.JsonConvert">
<summary>
Provides methods for converting between .NET types and JSON types.
</summary>
<example>
<code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\SerializationTests.cs" region="SerializeObject" title="Serializing and Deserializing JSON with JsonConvert" />
</example>
</member>
<member name="P:Newtonsoft.Json.JsonConvert.DefaultSettings">
<summary>
Gets or sets a function that creates default <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>.
Default settings are automatically used by serialization methods on <see cref="T:Newtonsoft.Json.JsonConvert"/>,
and <see cref="M:Newtonsoft.Json.Linq.JToken.ToObject``1"/> and <see cref="M:Newtonsoft.Json.Linq.JToken.FromObject(System.Object)"/> on <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
To serialize without using any default settings create a <see cref="T:Newtonsoft.Json.JsonSerializer"/> with
<see cref="M:Newtonsoft.Json.JsonSerializer.Create"/>.
</summary>
</member>
<member name="F:Newtonsoft.Json.JsonConvert.True">
<summary>
Represents JavaScript's boolean value <c>true</c> as a string. This field is read-only.
</summary>
</member>
<member name="F:Newtonsoft.Json.JsonConvert.False">
<summary>
Represents JavaScript's boolean value <c>false</c> as a string. This field is read-only.
</summary>
</member>
<member name="F:Newtonsoft.Json.JsonConvert.Null">
<summary>
Represents JavaScript's <c>null</c> as a string. This field is read-only.
</summary>
</member>
<member name="F:Newtonsoft.Json.JsonConvert.Undefined">
<summary>
Represents JavaScript's <c>undefined</c> as a string. This field is read-only.
</summary>
</member>
<member name="F:Newtonsoft.Json.JsonConvert.PositiveInfinity">
<summary>
Represents JavaScript's positive infinity as a string. This field is read-only.
</summary>
</member>
<member name="F:Newtonsoft.Json.JsonConvert.NegativeInfinity">
<summary>
Represents JavaScript's negative infinity as a string. This field is read-only.
</summary>
</member>
<member name="F:Newtonsoft.Json.JsonConvert.NaN">
<summary>
Represents JavaScript's <c>NaN</c> as a string. This field is read-only.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.DateTime)">
<summary>
Converts the <see cref="T:System.DateTime"/> to its JSON string representation.
</summary>
<param name="value">The value to convert.</param>
<returns>A JSON string representation of the <see cref="T:System.DateTime"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.DateTime,Newtonsoft.Json.DateFormatHandling,Newtonsoft.Json.DateTimeZoneHandling)">
<summary>
Converts the <see cref="T:System.DateTime"/> to its JSON string representation using the <see cref="T:Newtonsoft.Json.DateFormatHandling"/> specified.
</summary>
<param name="value">The value to convert.</param>
<param name="format">The format the date will be converted to.</param>
<param name="timeZoneHandling">The time zone handling when the date is converted to a string.</param>
<returns>A JSON string representation of the <see cref="T:System.DateTime"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.DateTimeOffset)">
<summary>
Converts the <see cref="T:System.DateTimeOffset"/> to its JSON string representation.
</summary>
<param name="value">The value to convert.</param>
<returns>A JSON string representation of the <see cref="T:System.DateTimeOffset"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.DateTimeOffset,Newtonsoft.Json.DateFormatHandling)">
<summary>
Converts the <see cref="T:System.DateTimeOffset"/> to its JSON string representation using the <see cref="T:Newtonsoft.Json.DateFormatHandling"/> specified.
</summary>
<param name="value">The value to convert.</param>
<param name="format">The format the date will be converted to.</param>
<returns>A JSON string representation of the <see cref="T:System.DateTimeOffset"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Boolean)">
<summary>
Converts the <see cref="T:System.Boolean"/> to its JSON string representation.
</summary>
<param name="value">The value to convert.</param>
<returns>A JSON string representation of the <see cref="T:System.Boolean"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Char)">
<summary>
Converts the <see cref="T:System.Char"/> to its JSON string representation.
</summary>
<param name="value">The value to convert.</param>
<returns>A JSON string representation of the <see cref="T:System.Char"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Enum)">
<summary>
Converts the <see cref="T:System.Enum"/> to its JSON string representation.
</summary>
<param name="value">The value to convert.</param>
<returns>A JSON string representation of the <see cref="T:System.Enum"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Int32)">
<summary>
Converts the <see cref="T:System.Int32"/> to its JSON string representation.
</summary>
<param name="value">The value to convert.</param>
<returns>A JSON string representation of the <see cref="T:System.Int32"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Int16)">
<summary>
Converts the <see cref="T:System.Int16"/> to its JSON string representation.
</summary>
<param name="value">The value to convert.</param>
<returns>A JSON string representation of the <see cref="T:System.Int16"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.UInt16)">
<summary>
Converts the <see cref="T:System.UInt16"/> to its JSON string representation.
</summary>
<param name="value">The value to convert.</param>
<returns>A JSON string representation of the <see cref="T:System.UInt16"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.UInt32)">
<summary>
Converts the <see cref="T:System.UInt32"/> to its JSON string representation.
</summary>
<param name="value">The value to convert.</param>
<returns>A JSON string representation of the <see cref="T:System.UInt32"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Int64)">
<summary>
Converts the <see cref="T:System.Int64"/> to its JSON string representation.
</summary>
<param name="value">The value to convert.</param>
<returns>A JSON string representation of the <see cref="T:System.Int64"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.UInt64)">
<summary>
Converts the <see cref="T:System.UInt64"/> to its JSON string representation.
</summary>
<param name="value">The value to convert.</param>
<returns>A JSON string representation of the <see cref="T:System.UInt64"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Single)">
<summary>
Converts the <see cref="T:System.Single"/> to its JSON string representation.
</summary>
<param name="value">The value to convert.</param>
<returns>A JSON string representation of the <see cref="T:System.Single"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Double)">
<summary>
Converts the <see cref="T:System.Double"/> to its JSON string representation.
</summary>
<param name="value">The value to convert.</param>
<returns>A JSON string representation of the <see cref="T:System.Double"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Byte)">
<summary>
Converts the <see cref="T:System.Byte"/> to its JSON string representation.
</summary>
<param name="value">The value to convert.</param>
<returns>A JSON string representation of the <see cref="T:System.Byte"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.SByte)">
<summary>
Converts the <see cref="T:System.SByte"/> to its JSON string representation.
</summary>
<param name="value">The value to convert.</param>
<returns>A JSON string representation of the <see cref="T:System.SByte"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Decimal)">
<summary>
Converts the <see cref="T:System.Decimal"/> to its JSON string representation.
</summary>
<param name="value">The value to convert.</param>
<returns>A JSON string representation of the <see cref="T:System.Decimal"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Guid)">
<summary>
Converts the <see cref="T:System.Guid"/> to its JSON string representation.
</summary>
<param name="value">The value to convert.</param>
<returns>A JSON string representation of the <see cref="T:System.Guid"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.TimeSpan)">
<summary>
Converts the <see cref="T:System.TimeSpan"/> to its JSON string representation.
</summary>
<param name="value">The value to convert.</param>
<returns>A JSON string representation of the <see cref="T:System.TimeSpan"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Uri)">
<summary>
Converts the <see cref="T:System.Uri"/> to its JSON string representation.
</summary>
<param name="value">The value to convert.</param>
<returns>A JSON string representation of the <see cref="T:System.Uri"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.String)">
<summary>
Converts the <see cref="T:System.String"/> to its JSON string representation.
</summary>
<param name="value">The value to convert.</param>
<returns>A JSON string representation of the <see cref="T:System.String"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.String,System.Char)">
<summary>
Converts the <see cref="T:System.String"/> to its JSON string representation.
</summary>
<param name="value">The value to convert.</param>
<param name="delimiter">The string delimiter character.</param>
<returns>A JSON string representation of the <see cref="T:System.String"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.String,System.Char,Newtonsoft.Json.StringEscapeHandling)">
<summary>
Converts the <see cref="T:System.String"/> to its JSON string representation.
</summary>
<param name="value">The value to convert.</param>
<param name="delimiter">The string delimiter character.</param>
<param name="stringEscapeHandling">The string escape handling.</param>
<returns>A JSON string representation of the <see cref="T:System.String"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Object)">
<summary>
Converts the <see cref="T:System.Object"/> to its JSON string representation.
</summary>
<param name="value">The value to convert.</param>
<returns>A JSON string representation of the <see cref="T:System.Object"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.SerializeObject(System.Object)">
<summary>
Serializes the specified object to a JSON string.
</summary>
<param name="value">The object to serialize.</param>
<returns>A JSON string representation of the object.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.SerializeObject(System.Object,Newtonsoft.Json.Formatting)">
<summary>
Serializes the specified object to a JSON string using formatting.
</summary>
<param name="value">The object to serialize.</param>
<param name="formatting">Indicates how the output should be formatted.</param>
<returns>
A JSON string representation of the object.
</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.SerializeObject(System.Object,Newtonsoft.Json.JsonConverter[])">
<summary>
Serializes the specified object to a JSON string using a collection of <see cref="T:Newtonsoft.Json.JsonConverter"/>.
</summary>
<param name="value">The object to serialize.</param>
<param name="converters">A collection of converters used while serializing.</param>
<returns>A JSON string representation of the object.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.SerializeObject(System.Object,Newtonsoft.Json.Formatting,Newtonsoft.Json.JsonConverter[])">
<summary>
Serializes the specified object to a JSON string using formatting and a collection of <see cref="T:Newtonsoft.Json.JsonConverter"/>.
</summary>
<param name="value">The object to serialize.</param>
<param name="formatting">Indicates how the output should be formatted.</param>
<param name="converters">A collection of converters used while serializing.</param>
<returns>A JSON string representation of the object.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.SerializeObject(System.Object,Newtonsoft.Json.JsonSerializerSettings)">
<summary>
Serializes the specified object to a JSON string using <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>.
</summary>
<param name="value">The object to serialize.</param>
<param name="settings">The <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/> used to serialize the object.
If this is <c>null</c>, default serialization settings will be used.</param>
<returns>
A JSON string representation of the object.
</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.SerializeObject(System.Object,System.Type,Newtonsoft.Json.JsonSerializerSettings)">
<summary>
Serializes the specified object to a JSON string using a type, formatting and <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>.
</summary>
<param name="value">The object to serialize.</param>
<param name="settings">The <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/> used to serialize the object.
If this is <c>null</c>, default serialization settings will be used.</param>
<param name="type">
The type of the value being serialized.
This parameter is used when <see cref="P:Newtonsoft.Json.JsonSerializer.TypeNameHandling"/> is <see cref="F:Newtonsoft.Json.TypeNameHandling.Auto"/> to write out the type name if the type of the value does not match.
Specifying the type is optional.
</param>
<returns>
A JSON string representation of the object.
</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.SerializeObject(System.Object,Newtonsoft.Json.Formatting,Newtonsoft.Json.JsonSerializerSettings)">
<summary>
Serializes the specified object to a JSON string using formatting and <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>.
</summary>
<param name="value">The object to serialize.</param>
<param name="formatting">Indicates how the output should be formatted.</param>
<param name="settings">The <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/> used to serialize the object.
If this is <c>null</c>, default serialization settings will be used.</param>
<returns>
A JSON string representation of the object.
</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.SerializeObject(System.Object,System.Type,Newtonsoft.Json.Formatting,Newtonsoft.Json.JsonSerializerSettings)">
<summary>
Serializes the specified object to a JSON string using a type, formatting and <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>.
</summary>
<param name="value">The object to serialize.</param>
<param name="formatting">Indicates how the output should be formatted.</param>
<param name="settings">The <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/> used to serialize the object.
If this is <c>null</c>, default serialization settings will be used.</param>
<param name="type">
The type of the value being serialized.
This parameter is used when <see cref="P:Newtonsoft.Json.JsonSerializer.TypeNameHandling"/> is <see cref="F:Newtonsoft.Json.TypeNameHandling.Auto"/> to write out the type name if the type of the value does not match.
Specifying the type is optional.
</param>
<returns>
A JSON string representation of the object.
</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.DeserializeObject(System.String)">
<summary>
Deserializes the JSON to a .NET object.
</summary>
<param name="value">The JSON to deserialize.</param>
<returns>The deserialized object from the JSON string.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.DeserializeObject(System.String,Newtonsoft.Json.JsonSerializerSettings)">
<summary>
Deserializes the JSON to a .NET object using <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>.
</summary>
<param name="value">The JSON to deserialize.</param>
<param name="settings">
The <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/> used to deserialize the object.
If this is <c>null</c>, default serialization settings will be used.
</param>
<returns>The deserialized object from the JSON string.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.DeserializeObject(System.String,System.Type)">
<summary>
Deserializes the JSON to the specified .NET type.
</summary>
<param name="value">The JSON to deserialize.</param>
<param name="type">The <see cref="T:System.Type"/> of object being deserialized.</param>
<returns>The deserialized object from the JSON string.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.DeserializeObject``1(System.String)">
<summary>
Deserializes the JSON to the specified .NET type.
</summary>
<typeparam name="T">The type of the object to deserialize to.</typeparam>
<param name="value">The JSON to deserialize.</param>
<returns>The deserialized object from the JSON string.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.DeserializeAnonymousType``1(System.String,``0)">
<summary>
Deserializes the JSON to the given anonymous type.
</summary>
<typeparam name="T">
The anonymous type to deserialize to. This can't be specified
traditionally and must be inferred from the anonymous type passed
as a parameter.
</typeparam>
<param name="value">The JSON to deserialize.</param>
<param name="anonymousTypeObject">The anonymous type object.</param>
<returns>The deserialized anonymous type from the JSON string.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.DeserializeAnonymousType``1(System.String,``0,Newtonsoft.Json.JsonSerializerSettings)">
<summary>
Deserializes the JSON to the given anonymous type using <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>.
</summary>
<typeparam name="T">
The anonymous type to deserialize to. This can't be specified
traditionally and must be inferred from the anonymous type passed
as a parameter.
</typeparam>
<param name="value">The JSON to deserialize.</param>
<param name="anonymousTypeObject">The anonymous type object.</param>
<param name="settings">
The <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/> used to deserialize the object.
If this is <c>null</c>, default serialization settings will be used.
</param>
<returns>The deserialized anonymous type from the JSON string.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.DeserializeObject``1(System.String,Newtonsoft.Json.JsonConverter[])">
<summary>
Deserializes the JSON to the specified .NET type using a collection of <see cref="T:Newtonsoft.Json.JsonConverter"/>.
</summary>
<typeparam name="T">The type of the object to deserialize to.</typeparam>
<param name="value">The JSON to deserialize.</param>
<param name="converters">Converters to use while deserializing.</param>
<returns>The deserialized object from the JSON string.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.DeserializeObject``1(System.String,Newtonsoft.Json.JsonSerializerSettings)">
<summary>
Deserializes the JSON to the specified .NET type using <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>.
</summary>
<typeparam name="T">The type of the object to deserialize to.</typeparam>
<param name="value">The object to deserialize.</param>
<param name="settings">
The <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/> used to deserialize the object.
If this is <c>null</c>, default serialization settings will be used.
</param>
<returns>The deserialized object from the JSON string.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.DeserializeObject(System.String,System.Type,Newtonsoft.Json.JsonConverter[])">
<summary>
Deserializes the JSON to the specified .NET type using a collection of <see cref="T:Newtonsoft.Json.JsonConverter"/>.
</summary>
<param name="value">The JSON to deserialize.</param>
<param name="type">The type of the object to deserialize.</param>
<param name="converters">Converters to use while deserializing.</param>
<returns>The deserialized object from the JSON string.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.DeserializeObject(System.String,System.Type,Newtonsoft.Json.JsonSerializerSettings)">
<summary>
Deserializes the JSON to the specified .NET type using <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>.
</summary>
<param name="value">The JSON to deserialize.</param>
<param name="type">The type of the object to deserialize to.</param>
<param name="settings">
The <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/> used to deserialize the object.
If this is <c>null</c>, default serialization settings will be used.
</param>
<returns>The deserialized object from the JSON string.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.PopulateObject(System.String,System.Object)">
<summary>
Populates the object with values from the JSON string.
</summary>
<param name="value">The JSON to populate values from.</param>
<param name="target">The target object to populate values onto.</param>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.PopulateObject(System.String,System.Object,Newtonsoft.Json.JsonSerializerSettings)">
<summary>
Populates the object with values from the JSON string using <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>.
</summary>
<param name="value">The JSON to populate values from.</param>
<param name="target">The target object to populate values onto.</param>
<param name="settings">
The <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/> used to deserialize the object.
If this is <c>null</c>, default serialization settings will be used.
</param>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.SerializeXmlNode(System.Xml.XmlNode)">
<summary>
Serializes the <see cref="T:System.Xml.XmlNode"/> to a JSON string.
</summary>
<param name="node">The node to serialize.</param>
<returns>A JSON string of the <see cref="T:System.Xml.XmlNode"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.SerializeXmlNode(System.Xml.XmlNode,Newtonsoft.Json.Formatting)">
<summary>
Serializes the <see cref="T:System.Xml.XmlNode"/> to a JSON string using formatting.
</summary>
<param name="node">The node to serialize.</param>
<param name="formatting">Indicates how the output should be formatted.</param>
<returns>A JSON string of the <see cref="T:System.Xml.XmlNode"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.SerializeXmlNode(System.Xml.XmlNode,Newtonsoft.Json.Formatting,System.Boolean)">
<summary>
Serializes the <see cref="T:System.Xml.XmlNode"/> to a JSON string using formatting and omits the root object if <paramref name="omitRootObject"/> is <c>true</c>.
</summary>
<param name="node">The node to serialize.</param>
<param name="formatting">Indicates how the output should be formatted.</param>
<param name="omitRootObject">Omits writing the root object.</param>
<returns>A JSON string of the <see cref="T:System.Xml.XmlNode"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.DeserializeXmlNode(System.String)">
<summary>
Deserializes the <see cref="T:System.Xml.XmlNode"/> from a JSON string.
</summary>
<param name="value">The JSON string.</param>
<returns>The deserialized <see cref="T:System.Xml.XmlNode"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.DeserializeXmlNode(System.String,System.String)">
<summary>
Deserializes the <see cref="T:System.Xml.XmlNode"/> from a JSON string nested in a root element specified by <paramref name="deserializeRootElementName"/>.
</summary>
<param name="value">The JSON string.</param>
<param name="deserializeRootElementName">The name of the root element to append when deserializing.</param>
<returns>The deserialized <see cref="T:System.Xml.XmlNode"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.DeserializeXmlNode(System.String,System.String,System.Boolean)">
<summary>
Deserializes the <see cref="T:System.Xml.XmlNode"/> from a JSON string nested in a root element specified by <paramref name="deserializeRootElementName"/>
and writes a Json.NET array attribute for collections.
</summary>
<param name="value">The JSON string.</param>
<param name="deserializeRootElementName">The name of the root element to append when deserializing.</param>
<param name="writeArrayAttribute">
A value to indicate whether to write the Json.NET array attribute.
This attribute helps preserve arrays when converting the written XML back to JSON.
</param>
<returns>The deserialized <see cref="T:System.Xml.XmlNode"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.DeserializeXmlNode(System.String,System.String,System.Boolean,System.Boolean)">
<summary>
Deserializes the <see cref="T:System.Xml.XmlNode"/> from a JSON string nested in a root element specified by <paramref name="deserializeRootElementName"/>,
writes a Json.NET array attribute for collections, and encodes special characters.
</summary>
<param name="value">The JSON string.</param>
<param name="deserializeRootElementName">The name of the root element to append when deserializing.</param>
<param name="writeArrayAttribute">
A value to indicate whether to write the Json.NET array attribute.
This attribute helps preserve arrays when converting the written XML back to JSON.
</param>
<param name="encodeSpecialCharacters">
A value to indicate whether to encode special characters when converting JSON to XML.
If <c>true</c>, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify
XML namespaces, attributes or processing directives. Instead special characters are encoded and written
as part of the XML element name.
</param>
<returns>The deserialized <see cref="T:System.Xml.XmlNode"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.SerializeXNode(System.Xml.Linq.XObject)">
<summary>
Serializes the <see cref="T:System.Xml.Linq.XNode"/> to a JSON string.
</summary>
<param name="node">The node to convert to JSON.</param>
<returns>A JSON string of the <see cref="T:System.Xml.Linq.XNode"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.SerializeXNode(System.Xml.Linq.XObject,Newtonsoft.Json.Formatting)">
<summary>
Serializes the <see cref="T:System.Xml.Linq.XNode"/> to a JSON string using formatting.
</summary>
<param name="node">The node to convert to JSON.</param>
<param name="formatting">Indicates how the output should be formatted.</param>
<returns>A JSON string of the <see cref="T:System.Xml.Linq.XNode"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.SerializeXNode(System.Xml.Linq.XObject,Newtonsoft.Json.Formatting,System.Boolean)">
<summary>
Serializes the <see cref="T:System.Xml.Linq.XNode"/> to a JSON string using formatting and omits the root object if <paramref name="omitRootObject"/> is <c>true</c>.
</summary>
<param name="node">The node to serialize.</param>
<param name="formatting">Indicates how the output should be formatted.</param>
<param name="omitRootObject">Omits writing the root object.</param>
<returns>A JSON string of the <see cref="T:System.Xml.Linq.XNode"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.DeserializeXNode(System.String)">
<summary>
Deserializes the <see cref="T:System.Xml.Linq.XNode"/> from a JSON string.
</summary>
<param name="value">The JSON string.</param>
<returns>The deserialized <see cref="T:System.Xml.Linq.XNode"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.DeserializeXNode(System.String,System.String)">
<summary>
Deserializes the <see cref="T:System.Xml.Linq.XNode"/> from a JSON string nested in a root element specified by <paramref name="deserializeRootElementName"/>.
</summary>
<param name="value">The JSON string.</param>
<param name="deserializeRootElementName">The name of the root element to append when deserializing.</param>
<returns>The deserialized <see cref="T:System.Xml.Linq.XNode"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.DeserializeXNode(System.String,System.String,System.Boolean)">
<summary>
Deserializes the <see cref="T:System.Xml.Linq.XNode"/> from a JSON string nested in a root element specified by <paramref name="deserializeRootElementName"/>
and writes a Json.NET array attribute for collections.
</summary>
<param name="value">The JSON string.</param>
<param name="deserializeRootElementName">The name of the root element to append when deserializing.</param>
<param name="writeArrayAttribute">
A value to indicate whether to write the Json.NET array attribute.
This attribute helps preserve arrays when converting the written XML back to JSON.
</param>
<returns>The deserialized <see cref="T:System.Xml.Linq.XNode"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConvert.DeserializeXNode(System.String,System.String,System.Boolean,System.Boolean)">
<summary>
Deserializes the <see cref="T:System.Xml.Linq.XNode"/> from a JSON string nested in a root element specified by <paramref name="deserializeRootElementName"/>,
writes a Json.NET array attribute for collections, and encodes special characters.
</summary>
<param name="value">The JSON string.</param>
<param name="deserializeRootElementName">The name of the root element to append when deserializing.</param>
<param name="writeArrayAttribute">
A value to indicate whether to write the Json.NET array attribute.
This attribute helps preserve arrays when converting the written XML back to JSON.
</param>
<param name="encodeSpecialCharacters">
A value to indicate whether to encode special characters when converting JSON to XML.
If <c>true</c>, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify
XML namespaces, attributes or processing directives. Instead special characters are encoded and written
as part of the XML element name.
</param>
<returns>The deserialized <see cref="T:System.Xml.Linq.XNode"/>.</returns>
</member>
<member name="T:Newtonsoft.Json.JsonConverter">
<summary>
Converts an object to and from JSON.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Writes the JSON representation of the object.
</summary>
<param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param>
<param name="value">The value.</param>
<param name="serializer">The calling serializer.</param>
</member>
<member name="M:Newtonsoft.Json.JsonConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Reads the JSON representation of the object.
</summary>
<param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param>
<param name="objectType">Type of the object.</param>
<param name="existingValue">The existing value of object being read.</param>
<param name="serializer">The calling serializer.</param>
<returns>The object value.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConverter.CanConvert(System.Type)">
<summary>
Determines whether this instance can convert the specified object type.
</summary>
<param name="objectType">Type of the object.</param>
<returns>
<c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>.
</returns>
</member>
<member name="P:Newtonsoft.Json.JsonConverter.CanRead">
<summary>
Gets a value indicating whether this <see cref="T:Newtonsoft.Json.JsonConverter"/> can read JSON.
</summary>
<value><c>true</c> if this <see cref="T:Newtonsoft.Json.JsonConverter"/> can read JSON; otherwise, <c>false</c>.</value>
</member>
<member name="P:Newtonsoft.Json.JsonConverter.CanWrite">
<summary>
Gets a value indicating whether this <see cref="T:Newtonsoft.Json.JsonConverter"/> can write JSON.
</summary>
<value><c>true</c> if this <see cref="T:Newtonsoft.Json.JsonConverter"/> can write JSON; otherwise, <c>false</c>.</value>
</member>
<member name="T:Newtonsoft.Json.JsonConverter`1">
<summary>
Converts an object to and from JSON.
</summary>
<typeparam name="T">The object type to convert.</typeparam>
</member>
<member name="M:Newtonsoft.Json.JsonConverter`1.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Writes the JSON representation of the object.
</summary>
<param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param>
<param name="value">The value.</param>
<param name="serializer">The calling serializer.</param>
</member>
<member name="M:Newtonsoft.Json.JsonConverter`1.WriteJson(Newtonsoft.Json.JsonWriter,`0,Newtonsoft.Json.JsonSerializer)">
<summary>
Writes the JSON representation of the object.
</summary>
<param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param>
<param name="value">The value.</param>
<param name="serializer">The calling serializer.</param>
</member>
<member name="M:Newtonsoft.Json.JsonConverter`1.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Reads the JSON representation of the object.
</summary>
<param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param>
<param name="objectType">Type of the object.</param>
<param name="existingValue">The existing value of object being read.</param>
<param name="serializer">The calling serializer.</param>
<returns>The object value.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConverter`1.ReadJson(Newtonsoft.Json.JsonReader,System.Type,`0,System.Boolean,Newtonsoft.Json.JsonSerializer)">
<summary>
Reads the JSON representation of the object.
</summary>
<param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param>
<param name="objectType">Type of the object.</param>
<param name="existingValue">The existing value of object being read. If there is no existing value then <c>null</c> will be used.</param>
<param name="hasExistingValue">The existing value has a value.</param>
<param name="serializer">The calling serializer.</param>
<returns>The object value.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonConverter`1.CanConvert(System.Type)">
<summary>
Determines whether this instance can convert the specified object type.
</summary>
<param name="objectType">Type of the object.</param>
<returns>
<c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>.
</returns>
</member>
<member name="T:Newtonsoft.Json.JsonConverterAttribute">
<summary>
Instructs the <see cref="T:Newtonsoft.Json.JsonSerializer"/> to use the specified <see cref="T:Newtonsoft.Json.JsonConverter"/> when serializing the member or class.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonConverterAttribute.ConverterType">
<summary>
Gets the <see cref="T:System.Type"/> of the <see cref="T:Newtonsoft.Json.JsonConverter"/>.
</summary>
<value>The <see cref="T:System.Type"/> of the <see cref="T:Newtonsoft.Json.JsonConverter"/>.</value>
</member>
<member name="P:Newtonsoft.Json.JsonConverterAttribute.ConverterParameters">
<summary>
The parameter list to use when constructing the <see cref="T:Newtonsoft.Json.JsonConverter"/> described by <see cref="P:Newtonsoft.Json.JsonConverterAttribute.ConverterType"/>.
If <c>null</c>, the default constructor is used.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonConverterAttribute.#ctor(System.Type)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonConverterAttribute"/> class.
</summary>
<param name="converterType">Type of the <see cref="T:Newtonsoft.Json.JsonConverter"/>.</param>
</member>
<member name="M:Newtonsoft.Json.JsonConverterAttribute.#ctor(System.Type,System.Object[])">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonConverterAttribute"/> class.
</summary>
<param name="converterType">Type of the <see cref="T:Newtonsoft.Json.JsonConverter"/>.</param>
<param name="converterParameters">Parameter list to use when constructing the <see cref="T:Newtonsoft.Json.JsonConverter"/>. Can be <c>null</c>.</param>
</member>
<member name="T:Newtonsoft.Json.JsonConverterCollection">
<summary>
Represents a collection of <see cref="T:Newtonsoft.Json.JsonConverter"/>.
</summary>
</member>
<member name="T:Newtonsoft.Json.JsonDictionaryAttribute">
<summary>
Instructs the <see cref="T:Newtonsoft.Json.JsonSerializer"/> how to serialize the collection.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonDictionaryAttribute.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonDictionaryAttribute"/> class.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonDictionaryAttribute.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonDictionaryAttribute"/> class with the specified container Id.
</summary>
<param name="id">The container Id.</param>
</member>
<member name="T:Newtonsoft.Json.JsonException">
<summary>
The exception thrown when an error occurs during JSON serialization or deserialization.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonException"/> class.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonException"/> class
with a specified error message.
</summary>
<param name="message">The error message that explains the reason for the exception.</param>
</member>
<member name="M:Newtonsoft.Json.JsonException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonException"/> class
with a specified error message and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">The error message that explains the reason for the exception.</param>
<param name="innerException">The exception that is the cause of the current exception, or <c>null</c> if no inner exception is specified.</param>
</member>
<member name="M:Newtonsoft.Json.JsonException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <c>null</c>.</exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <c>null</c> or <see cref="P:System.Exception.HResult"/> is zero (0).</exception>
</member>
<member name="T:Newtonsoft.Json.JsonExtensionDataAttribute">
<summary>
Instructs the <see cref="T:Newtonsoft.Json.JsonSerializer"/> to deserialize properties with no matching class member into the specified collection
and write values during serialization.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonExtensionDataAttribute.WriteData">
<summary>
Gets or sets a value that indicates whether to write extension data when serializing the object.
</summary>
<value>
<c>true</c> to write extension data when serializing the object; otherwise, <c>false</c>. The default is <c>true</c>.
</value>
</member>
<member name="P:Newtonsoft.Json.JsonExtensionDataAttribute.ReadData">
<summary>
Gets or sets a value that indicates whether to read extension data when deserializing the object.
</summary>
<value>
<c>true</c> to read extension data when deserializing the object; otherwise, <c>false</c>. The default is <c>true</c>.
</value>
</member>
<member name="M:Newtonsoft.Json.JsonExtensionDataAttribute.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonExtensionDataAttribute"/> class.
</summary>
</member>
<member name="T:Newtonsoft.Json.JsonIgnoreAttribute">
<summary>
Instructs the <see cref="T:Newtonsoft.Json.JsonSerializer"/> not to serialize the public field or public read/write property value.
</summary>
</member>
<member name="T:Newtonsoft.Json.JsonNameTable">
<summary>
Base class for a table of atomized string objects.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonNameTable.Get(System.Char[],System.Int32,System.Int32)">
<summary>
Gets a string containing the same characters as the specified range of characters in the given array.
</summary>
<param name="key">The character array containing the name to find.</param>
<param name="start">The zero-based index into the array specifying the first character of the name.</param>
<param name="length">The number of characters in the name.</param>
<returns>A string containing the same characters as the specified range of characters in the given array.</returns>
</member>
<member name="T:Newtonsoft.Json.JsonObjectAttribute">
<summary>
Instructs the <see cref="T:Newtonsoft.Json.JsonSerializer"/> how to serialize the object.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonObjectAttribute.MemberSerialization">
<summary>
Gets or sets the member serialization.
</summary>
<value>The member serialization.</value>
</member>
<member name="P:Newtonsoft.Json.JsonObjectAttribute.MissingMemberHandling">
<summary>
Gets or sets the missing member handling used when deserializing this object.
</summary>
<value>The missing member handling.</value>
</member>
<member name="P:Newtonsoft.Json.JsonObjectAttribute.ItemNullValueHandling">
<summary>
Gets or sets how the object's properties with null values are handled during serialization and deserialization.
</summary>
<value>How the object's properties with null values are handled during serialization and deserialization.</value>
</member>
<member name="P:Newtonsoft.Json.JsonObjectAttribute.ItemRequired">
<summary>
Gets or sets a value that indicates whether the object's properties are required.
</summary>
<value>
A value indicating whether the object's properties are required.
</value>
</member>
<member name="M:Newtonsoft.Json.JsonObjectAttribute.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonObjectAttribute"/> class.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonObjectAttribute.#ctor(Newtonsoft.Json.MemberSerialization)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonObjectAttribute"/> class with the specified member serialization.
</summary>
<param name="memberSerialization">The member serialization.</param>
</member>
<member name="M:Newtonsoft.Json.JsonObjectAttribute.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonObjectAttribute"/> class with the specified container Id.
</summary>
<param name="id">The container Id.</param>
</member>
<member name="T:Newtonsoft.Json.JsonPropertyAttribute">
<summary>
Instructs the <see cref="T:Newtonsoft.Json.JsonSerializer"/> to always serialize the member with the specified name.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonPropertyAttribute.ItemConverterType">
<summary>
Gets or sets the <see cref="T:Newtonsoft.Json.JsonConverter"/> type used when serializing the property's collection items.
</summary>
<value>The collection's items <see cref="T:Newtonsoft.Json.JsonConverter"/> type.</value>
</member>
<member name="P:Newtonsoft.Json.JsonPropertyAttribute.ItemConverterParameters">
<summary>
The parameter list to use when constructing the <see cref="T:Newtonsoft.Json.JsonConverter"/> described by <see cref="P:Newtonsoft.Json.JsonPropertyAttribute.ItemConverterType"/>.
If <c>null</c>, the default constructor is used.
When non-<c>null</c>, there must be a constructor defined in the <see cref="T:Newtonsoft.Json.JsonConverter"/> that exactly matches the number,
order, and type of these parameters.
</summary>
<example>
<code>
[JsonProperty(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })]
</code>
</example>
</member>
<member name="P:Newtonsoft.Json.JsonPropertyAttribute.NamingStrategyType">
<summary>
Gets or sets the <see cref="T:System.Type"/> of the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/>.
</summary>
<value>The <see cref="T:System.Type"/> of the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/>.</value>
</member>
<member name="P:Newtonsoft.Json.JsonPropertyAttribute.NamingStrategyParameters">
<summary>
The parameter list to use when constructing the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> described by <see cref="P:Newtonsoft.Json.JsonPropertyAttribute.NamingStrategyType"/>.
If <c>null</c>, the default constructor is used.
When non-<c>null</c>, there must be a constructor defined in the <see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/> that exactly matches the number,
order, and type of these parameters.
</summary>
<example>
<code>
[JsonProperty(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })]
</code>
</example>
</member>
<member name="P:Newtonsoft.Json.JsonPropertyAttribute.NullValueHandling">
<summary>
Gets or sets the null value handling used when serializing this property.
</summary>
<value>The null value handling.</value>
</member>
<member name="P:Newtonsoft.Json.JsonPropertyAttribute.DefaultValueHandling">
<summary>
Gets or sets the default value handling used when serializing this property.
</summary>
<value>The default value handling.</value>
</member>
<member name="P:Newtonsoft.Json.JsonPropertyAttribute.ReferenceLoopHandling">
<summary>
Gets or sets the reference loop handling used when serializing this property.
</summary>
<value>The reference loop handling.</value>
</member>
<member name="P:Newtonsoft.Json.JsonPropertyAttribute.ObjectCreationHandling">
<summary>
Gets or sets the object creation handling used when deserializing this property.
</summary>
<value>The object creation handling.</value>
</member>
<member name="P:Newtonsoft.Json.JsonPropertyAttribute.TypeNameHandling">
<summary>
Gets or sets the type name handling used when serializing this property.
</summary>
<value>The type name handling.</value>
</member>
<member name="P:Newtonsoft.Json.JsonPropertyAttribute.IsReference">
<summary>
Gets or sets whether this property's value is serialized as a reference.
</summary>
<value>Whether this property's value is serialized as a reference.</value>
</member>
<member name="P:Newtonsoft.Json.JsonPropertyAttribute.Order">
<summary>
Gets or sets the order of serialization of a member.
</summary>
<value>The numeric order of serialization.</value>
</member>
<member name="P:Newtonsoft.Json.JsonPropertyAttribute.Required">
<summary>
Gets or sets a value indicating whether this property is required.
</summary>
<value>
A value indicating whether this property is required.
</value>
</member>
<member name="P:Newtonsoft.Json.JsonPropertyAttribute.PropertyName">
<summary>
Gets or sets the name of the property.
</summary>
<value>The name of the property.</value>
</member>
<member name="P:Newtonsoft.Json.JsonPropertyAttribute.ItemReferenceLoopHandling">
<summary>
Gets or sets the reference loop handling used when serializing the property's collection items.
</summary>
<value>The collection's items reference loop handling.</value>
</member>
<member name="P:Newtonsoft.Json.JsonPropertyAttribute.ItemTypeNameHandling">
<summary>
Gets or sets the type name handling used when serializing the property's collection items.
</summary>
<value>The collection's items type name handling.</value>
</member>
<member name="P:Newtonsoft.Json.JsonPropertyAttribute.ItemIsReference">
<summary>
Gets or sets whether this property's collection items are serialized as a reference.
</summary>
<value>Whether this property's collection items are serialized as a reference.</value>
</member>
<member name="M:Newtonsoft.Json.JsonPropertyAttribute.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonPropertyAttribute"/> class.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonPropertyAttribute.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonPropertyAttribute"/> class with the specified name.
</summary>
<param name="propertyName">Name of the property.</param>
</member>
<member name="T:Newtonsoft.Json.JsonReader">
<summary>
Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonReader.ReadAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously reads the next JSON token from the source.
</summary>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous read. The <see cref="P:System.Threading.Tasks.Task`1.Result"/>
property returns <c>true</c> if the next token was read successfully; <c>false</c> if there are no more tokens to read.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonReader.SkipAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously skips the children of the current token.
</summary>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonReader.ReadAsBooleanAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously reads the next JSON token from the source as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Boolean"/>.
</summary>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous read. The <see cref="P:System.Threading.Tasks.Task`1.Result"/>
property returns the <see cref="T:System.Nullable`1"/> of <see cref="T:System.Boolean"/>. This result will be <c>null</c> at the end of an array.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonReader.ReadAsBytesAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously reads the next JSON token from the source as a <see cref="T:System.Byte"/>[].
</summary>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous read. The <see cref="P:System.Threading.Tasks.Task`1.Result"/>
property returns the <see cref="T:System.Byte"/>[]. This result will be <c>null</c> at the end of an array.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonReader.ReadAsDateTimeAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously reads the next JSON token from the source as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTime"/>.
</summary>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous read. The <see cref="P:System.Threading.Tasks.Task`1.Result"/>
property returns the <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTime"/>. This result will be <c>null</c> at the end of an array.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonReader.ReadAsDateTimeOffsetAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously reads the next JSON token from the source as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTimeOffset"/>.
</summary>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous read. The <see cref="P:System.Threading.Tasks.Task`1.Result"/>
property returns the <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTimeOffset"/>. This result will be <c>null</c> at the end of an array.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonReader.ReadAsDecimalAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously reads the next JSON token from the source as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Decimal"/>.
</summary>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous read. The <see cref="P:System.Threading.Tasks.Task`1.Result"/>
property returns the <see cref="T:System.Nullable`1"/> of <see cref="T:System.Decimal"/>. This result will be <c>null</c> at the end of an array.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonReader.ReadAsDoubleAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously reads the next JSON token from the source as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Double"/>.
</summary>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous read. The <see cref="P:System.Threading.Tasks.Task`1.Result"/>
property returns the <see cref="T:System.Nullable`1"/> of <see cref="T:System.Double"/>. This result will be <c>null</c> at the end of an array.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonReader.ReadAsInt32Async(System.Threading.CancellationToken)">
<summary>
Asynchronously reads the next JSON token from the source as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int32"/>.
</summary>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous read. The <see cref="P:System.Threading.Tasks.Task`1.Result"/>
property returns the <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int32"/>. This result will be <c>null</c> at the end of an array.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonReader.ReadAsStringAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously reads the next JSON token from the source as a <see cref="T:System.String"/>.
</summary>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous read. The <see cref="P:System.Threading.Tasks.Task`1.Result"/>
property returns the <see cref="T:System.String"/>. This result will be <c>null</c> at the end of an array.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="T:Newtonsoft.Json.JsonReader.State">
<summary>
Specifies the state of the reader.
</summary>
</member>
<member name="F:Newtonsoft.Json.JsonReader.State.Start">
<summary>
A <see cref="T:Newtonsoft.Json.JsonReader"/> read method has not been called.
</summary>
</member>
<member name="F:Newtonsoft.Json.JsonReader.State.Complete">
<summary>
The end of the file has been reached successfully.
</summary>
</member>
<member name="F:Newtonsoft.Json.JsonReader.State.Property">
<summary>
Reader is at a property.
</summary>
</member>
<member name="F:Newtonsoft.Json.JsonReader.State.ObjectStart">
<summary>
Reader is at the start of an object.
</summary>
</member>
<member name="F:Newtonsoft.Json.JsonReader.State.Object">
<summary>
Reader is in an object.
</summary>
</member>
<member name="F:Newtonsoft.Json.JsonReader.State.ArrayStart">
<summary>
Reader is at the start of an array.
</summary>
</member>
<member name="F:Newtonsoft.Json.JsonReader.State.Array">
<summary>
Reader is in an array.
</summary>
</member>
<member name="F:Newtonsoft.Json.JsonReader.State.Closed">
<summary>
The <see cref="M:Newtonsoft.Json.JsonReader.Close"/> method has been called.
</summary>
</member>
<member name="F:Newtonsoft.Json.JsonReader.State.PostValue">
<summary>
Reader has just read a value.
</summary>
</member>
<member name="F:Newtonsoft.Json.JsonReader.State.ConstructorStart">
<summary>
Reader is at the start of a constructor.
</summary>
</member>
<member name="F:Newtonsoft.Json.JsonReader.State.Constructor">
<summary>
Reader is in a constructor.
</summary>
</member>
<member name="F:Newtonsoft.Json.JsonReader.State.Error">
<summary>
An error occurred that prevents the read operation from continuing.
</summary>
</member>
<member name="F:Newtonsoft.Json.JsonReader.State.Finished">
<summary>
The end of the file has been reached successfully.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonReader.CurrentState">
<summary>
Gets the current reader state.
</summary>
<value>The current reader state.</value>
</member>
<member name="P:Newtonsoft.Json.JsonReader.CloseInput">
<summary>
Gets or sets a value indicating whether the source should be closed when this reader is closed.
</summary>
<value>
<c>true</c> to close the source when this reader is closed; otherwise <c>false</c>. The default is <c>true</c>.
</value>
</member>
<member name="P:Newtonsoft.Json.JsonReader.SupportMultipleContent">
<summary>
Gets or sets a value indicating whether multiple pieces of JSON content can
be read from a continuous stream without erroring.
</summary>
<value>
<c>true</c> to support reading multiple pieces of JSON content; otherwise <c>false</c>.
The default is <c>false</c>.
</value>
</member>
<member name="P:Newtonsoft.Json.JsonReader.QuoteChar">
<summary>
Gets the quotation mark character used to enclose the value of a string.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonReader.DateTimeZoneHandling">
<summary>
Gets or sets how <see cref="T:System.DateTime"/> time zones are handled when reading JSON.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonReader.DateParseHandling">
<summary>
Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonReader.FloatParseHandling">
<summary>
Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonReader.DateFormatString">
<summary>
Gets or sets how custom date formatted strings are parsed when reading JSON.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonReader.MaxDepth">
<summary>
Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a <see cref="T:Newtonsoft.Json.JsonReaderException"/>.
A null value means there is no maximum.
The default value is <c>128</c>.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonReader.TokenType">
<summary>
Gets the type of the current JSON token.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonReader.Value">
<summary>
Gets the text value of the current JSON token.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonReader.ValueType">
<summary>
Gets the .NET type for the current JSON token.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonReader.Depth">
<summary>
Gets the depth of the current token in the JSON document.
</summary>
<value>The depth of the current token in the JSON document.</value>
</member>
<member name="P:Newtonsoft.Json.JsonReader.Path">
<summary>
Gets the path of the current JSON token.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonReader.Culture">
<summary>
Gets or sets the culture used when reading JSON. Defaults to <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonReader.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonReader"/> class.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonReader.Read">
<summary>
Reads the next JSON token from the source.
</summary>
<returns><c>true</c> if the next token was read successfully; <c>false</c> if there are no more tokens to read.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonReader.ReadAsInt32">
<summary>
Reads the next JSON token from the source as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int32"/>.
</summary>
<returns>A <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int32"/>. This method will return <c>null</c> at the end of an array.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonReader.ReadAsString">
<summary>
Reads the next JSON token from the source as a <see cref="T:System.String"/>.
</summary>
<returns>A <see cref="T:System.String"/>. This method will return <c>null</c> at the end of an array.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonReader.ReadAsBytes">
<summary>
Reads the next JSON token from the source as a <see cref="T:System.Byte"/>[].
</summary>
<returns>A <see cref="T:System.Byte"/>[] or <c>null</c> if the next JSON token is null. This method will return <c>null</c> at the end of an array.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonReader.ReadAsDouble">
<summary>
Reads the next JSON token from the source as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Double"/>.
</summary>
<returns>A <see cref="T:System.Nullable`1"/> of <see cref="T:System.Double"/>. This method will return <c>null</c> at the end of an array.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonReader.ReadAsBoolean">
<summary>
Reads the next JSON token from the source as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Boolean"/>.
</summary>
<returns>A <see cref="T:System.Nullable`1"/> of <see cref="T:System.Boolean"/>. This method will return <c>null</c> at the end of an array.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonReader.ReadAsDecimal">
<summary>
Reads the next JSON token from the source as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Decimal"/>.
</summary>
<returns>A <see cref="T:System.Nullable`1"/> of <see cref="T:System.Decimal"/>. This method will return <c>null</c> at the end of an array.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonReader.ReadAsDateTime">
<summary>
Reads the next JSON token from the source as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTime"/>.
</summary>
<returns>A <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTime"/>. This method will return <c>null</c> at the end of an array.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonReader.ReadAsDateTimeOffset">
<summary>
Reads the next JSON token from the source as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTimeOffset"/>.
</summary>
<returns>A <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTimeOffset"/>. This method will return <c>null</c> at the end of an array.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonReader.Skip">
<summary>
Skips the children of the current token.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonReader.SetToken(Newtonsoft.Json.JsonToken)">
<summary>
Sets the current token.
</summary>
<param name="newToken">The new token.</param>
</member>
<member name="M:Newtonsoft.Json.JsonReader.SetToken(Newtonsoft.Json.JsonToken,System.Object)">
<summary>
Sets the current token and value.
</summary>
<param name="newToken">The new token.</param>
<param name="value">The value.</param>
</member>
<member name="M:Newtonsoft.Json.JsonReader.SetToken(Newtonsoft.Json.JsonToken,System.Object,System.Boolean)">
<summary>
Sets the current token and value.
</summary>
<param name="newToken">The new token.</param>
<param name="value">The value.</param>
<param name="updateIndex">A flag indicating whether the position index inside an array should be updated.</param>
</member>
<member name="M:Newtonsoft.Json.JsonReader.SetStateBasedOnCurrent">
<summary>
Sets the state based on current token type.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonReader.Dispose(System.Boolean)">
<summary>
Releases unmanaged and - optionally - managed resources.
</summary>
<param name="disposing"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
</member>
<member name="M:Newtonsoft.Json.JsonReader.Close">
<summary>
Changes the reader's state to <see cref="F:Newtonsoft.Json.JsonReader.State.Closed"/>.
If <see cref="P:Newtonsoft.Json.JsonReader.CloseInput"/> is set to <c>true</c>, the source is also closed.
</summary>
</member>
<member name="T:Newtonsoft.Json.JsonReaderException">
<summary>
The exception thrown when an error occurs while reading JSON text.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonReaderException.LineNumber">
<summary>
Gets the line number indicating where the error occurred.
</summary>
<value>The line number indicating where the error occurred.</value>
</member>
<member name="P:Newtonsoft.Json.JsonReaderException.LinePosition">
<summary>
Gets the line position indicating where the error occurred.
</summary>
<value>The line position indicating where the error occurred.</value>
</member>
<member name="P:Newtonsoft.Json.JsonReaderException.Path">
<summary>
Gets the path to the JSON where the error occurred.
</summary>
<value>The path to the JSON where the error occurred.</value>
</member>
<member name="M:Newtonsoft.Json.JsonReaderException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonReaderException"/> class.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonReaderException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonReaderException"/> class
with a specified error message.
</summary>
<param name="message">The error message that explains the reason for the exception.</param>
</member>
<member name="M:Newtonsoft.Json.JsonReaderException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonReaderException"/> class
with a specified error message and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">The error message that explains the reason for the exception.</param>
<param name="innerException">The exception that is the cause of the current exception, or <c>null</c> if no inner exception is specified.</param>
</member>
<member name="M:Newtonsoft.Json.JsonReaderException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonReaderException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <c>null</c>.</exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <c>null</c> or <see cref="P:System.Exception.HResult"/> is zero (0).</exception>
</member>
<member name="M:Newtonsoft.Json.JsonReaderException.#ctor(System.String,System.String,System.Int32,System.Int32,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonReaderException"/> class
with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">The error message that explains the reason for the exception.</param>
<param name="path">The path to the JSON where the error occurred.</param>
<param name="lineNumber">The line number indicating where the error occurred.</param>
<param name="linePosition">The line position indicating where the error occurred.</param>
<param name="innerException">The exception that is the cause of the current exception, or <c>null</c> if no inner exception is specified.</param>
</member>
<member name="T:Newtonsoft.Json.JsonRequiredAttribute">
<summary>
Instructs the <see cref="T:Newtonsoft.Json.JsonSerializer"/> to always serialize the member, and to require that the member has a value.
</summary>
</member>
<member name="T:Newtonsoft.Json.JsonSerializationException">
<summary>
The exception thrown when an error occurs during JSON serialization or deserialization.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonSerializationException.LineNumber">
<summary>
Gets the line number indicating where the error occurred.
</summary>
<value>The line number indicating where the error occurred.</value>
</member>
<member name="P:Newtonsoft.Json.JsonSerializationException.LinePosition">
<summary>
Gets the line position indicating where the error occurred.
</summary>
<value>The line position indicating where the error occurred.</value>
</member>
<member name="P:Newtonsoft.Json.JsonSerializationException.Path">
<summary>
Gets the path to the JSON where the error occurred.
</summary>
<value>The path to the JSON where the error occurred.</value>
</member>
<member name="M:Newtonsoft.Json.JsonSerializationException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonSerializationException"/> class.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonSerializationException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonSerializationException"/> class
with a specified error message.
</summary>
<param name="message">The error message that explains the reason for the exception.</param>
</member>
<member name="M:Newtonsoft.Json.JsonSerializationException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonSerializationException"/> class
with a specified error message and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">The error message that explains the reason for the exception.</param>
<param name="innerException">The exception that is the cause of the current exception, or <c>null</c> if no inner exception is specified.</param>
</member>
<member name="M:Newtonsoft.Json.JsonSerializationException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonSerializationException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <c>null</c>.</exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <c>null</c> or <see cref="P:System.Exception.HResult"/> is zero (0).</exception>
</member>
<member name="M:Newtonsoft.Json.JsonSerializationException.#ctor(System.String,System.String,System.Int32,System.Int32,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonSerializationException"/> class
with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">The error message that explains the reason for the exception.</param>
<param name="path">The path to the JSON where the error occurred.</param>
<param name="lineNumber">The line number indicating where the error occurred.</param>
<param name="linePosition">The line position indicating where the error occurred.</param>
<param name="innerException">The exception that is the cause of the current exception, or <c>null</c> if no inner exception is specified.</param>
</member>
<member name="T:Newtonsoft.Json.JsonSerializer">
<summary>
Serializes and deserializes objects into and from the JSON format.
The <see cref="T:Newtonsoft.Json.JsonSerializer"/> enables you to control how objects are encoded into JSON.
</summary>
</member>
<member name="E:Newtonsoft.Json.JsonSerializer.Error">
<summary>
Occurs when the <see cref="T:Newtonsoft.Json.JsonSerializer"/> errors during serialization and deserialization.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonSerializer.ReferenceResolver">
<summary>
Gets or sets the <see cref="T:Newtonsoft.Json.Serialization.IReferenceResolver"/> used by the serializer when resolving references.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonSerializer.Binder">
<summary>
Gets or sets the <see cref="P:Newtonsoft.Json.JsonSerializer.SerializationBinder"/> used by the serializer when resolving type names.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonSerializer.SerializationBinder">
<summary>
Gets or sets the <see cref="T:Newtonsoft.Json.Serialization.ISerializationBinder"/> used by the serializer when resolving type names.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonSerializer.TraceWriter">
<summary>
Gets or sets the <see cref="T:Newtonsoft.Json.Serialization.ITraceWriter"/> used by the serializer when writing trace messages.
</summary>
<value>The trace writer.</value>
</member>
<member name="P:Newtonsoft.Json.JsonSerializer.EqualityComparer">
<summary>
Gets or sets the equality comparer used by the serializer when comparing references.
</summary>
<value>The equality comparer.</value>
</member>
<member name="P:Newtonsoft.Json.JsonSerializer.TypeNameHandling">
<summary>
Gets or sets how type name writing and reading is handled by the serializer.
The default value is <see cref="F:Newtonsoft.Json.TypeNameHandling.None" />.
</summary>
<remarks>
<see cref="P:Newtonsoft.Json.JsonSerializer.TypeNameHandling"/> should be used with caution when your application deserializes JSON from an external source.
Incoming types should be validated with a custom <see cref="P:Newtonsoft.Json.JsonSerializer.SerializationBinder"/>
when deserializing with a value other than <see cref="F:Newtonsoft.Json.TypeNameHandling.None"/>.
</remarks>
</member>
<member name="P:Newtonsoft.Json.JsonSerializer.TypeNameAssemblyFormat">
<summary>
Gets or sets how a type name assembly is written and resolved by the serializer.
The default value is <see cref="F:System.Runtime.Serialization.Formatters.FormatterAssemblyStyle.Simple" />.
</summary>
<value>The type name assembly format.</value>
</member>
<member name="P:Newtonsoft.Json.JsonSerializer.TypeNameAssemblyFormatHandling">
<summary>
Gets or sets how a type name assembly is written and resolved by the serializer.
The default value is <see cref="F:Newtonsoft.Json.TypeNameAssemblyFormatHandling.Simple" />.
</summary>
<value>The type name assembly format.</value>
</member>
<member name="P:Newtonsoft.Json.JsonSerializer.PreserveReferencesHandling">
<summary>
Gets or sets how object references are preserved by the serializer.
The default value is <see cref="F:Newtonsoft.Json.PreserveReferencesHandling.None" />.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonSerializer.ReferenceLoopHandling">
<summary>
Gets or sets how reference loops (e.g. a class referencing itself) is handled.
The default value is <see cref="F:Newtonsoft.Json.ReferenceLoopHandling.Error" />.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonSerializer.MissingMemberHandling">
<summary>
Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization.
The default value is <see cref="F:Newtonsoft.Json.MissingMemberHandling.Ignore" />.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonSerializer.NullValueHandling">
<summary>
Gets or sets how null values are handled during serialization and deserialization.
The default value is <see cref="F:Newtonsoft.Json.NullValueHandling.Include" />.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonSerializer.DefaultValueHandling">
<summary>
Gets or sets how default values are handled during serialization and deserialization.
The default value is <see cref="F:Newtonsoft.Json.DefaultValueHandling.Include" />.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonSerializer.ObjectCreationHandling">
<summary>
Gets or sets how objects are created during deserialization.
The default value is <see cref="F:Newtonsoft.Json.ObjectCreationHandling.Auto" />.
</summary>
<value>The object creation handling.</value>
</member>
<member name="P:Newtonsoft.Json.JsonSerializer.ConstructorHandling">
<summary>
Gets or sets how constructors are used during deserialization.
The default value is <see cref="F:Newtonsoft.Json.ConstructorHandling.Default" />.
</summary>
<value>The constructor handling.</value>
</member>
<member name="P:Newtonsoft.Json.JsonSerializer.MetadataPropertyHandling">
<summary>
Gets or sets how metadata properties are used during deserialization.
The default value is <see cref="F:Newtonsoft.Json.MetadataPropertyHandling.Default" />.
</summary>
<value>The metadata properties handling.</value>
</member>
<member name="P:Newtonsoft.Json.JsonSerializer.Converters">
<summary>
Gets a collection <see cref="T:Newtonsoft.Json.JsonConverter"/> that will be used during serialization.
</summary>
<value>Collection <see cref="T:Newtonsoft.Json.JsonConverter"/> that will be used during serialization.</value>
</member>
<member name="P:Newtonsoft.Json.JsonSerializer.ContractResolver">
<summary>
Gets or sets the contract resolver used by the serializer when
serializing .NET objects to JSON and vice versa.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonSerializer.Context">
<summary>
Gets or sets the <see cref="T:System.Runtime.Serialization.StreamingContext"/> used by the serializer when invoking serialization callback methods.
</summary>
<value>The context.</value>
</member>
<member name="P:Newtonsoft.Json.JsonSerializer.Formatting">
<summary>
Indicates how JSON text output is formatted.
The default value is <see cref="F:Newtonsoft.Json.Formatting.None" />.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonSerializer.DateFormatHandling">
<summary>
Gets or sets how dates are written to JSON text.
The default value is <see cref="F:Newtonsoft.Json.DateFormatHandling.IsoDateFormat" />.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonSerializer.DateTimeZoneHandling">
<summary>
Gets or sets how <see cref="T:System.DateTime"/> time zones are handled during serialization and deserialization.
The default value is <see cref="F:Newtonsoft.Json.DateTimeZoneHandling.RoundtripKind" />.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonSerializer.DateParseHandling">
<summary>
Gets or sets how date formatted strings, e.g. <c>"\/Date(1198908717056)\/"</c> and <c>"2012-03-21T05:40Z"</c>, are parsed when reading JSON.
The default value is <see cref="F:Newtonsoft.Json.DateParseHandling.DateTime" />.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonSerializer.FloatParseHandling">
<summary>
Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text.
The default value is <see cref="F:Newtonsoft.Json.FloatParseHandling.Double" />.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonSerializer.FloatFormatHandling">
<summary>
Gets or sets how special floating point numbers, e.g. <see cref="F:System.Double.NaN"/>,
<see cref="F:System.Double.PositiveInfinity"/> and <see cref="F:System.Double.NegativeInfinity"/>,
are written as JSON text.
The default value is <see cref="F:Newtonsoft.Json.FloatFormatHandling.String" />.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonSerializer.StringEscapeHandling">
<summary>
Gets or sets how strings are escaped when writing JSON text.
The default value is <see cref="F:Newtonsoft.Json.StringEscapeHandling.Default" />.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonSerializer.DateFormatString">
<summary>
Gets or sets how <see cref="T:System.DateTime"/> and <see cref="T:System.DateTimeOffset"/> values are formatted when writing JSON text,
and the expected date format when reading JSON text.
The default value is <c>"yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK"</c>.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonSerializer.Culture">
<summary>
Gets or sets the culture used when reading JSON.
The default value is <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonSerializer.MaxDepth">
<summary>
Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a <see cref="T:Newtonsoft.Json.JsonReaderException"/>.
A null value means there is no maximum.
The default value is <c>128</c>.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonSerializer.CheckAdditionalContent">
<summary>
Gets a value indicating whether there will be a check for additional JSON content after deserializing an object.
The default value is <c>false</c>.
</summary>
<value>
<c>true</c> if there will be a check for additional JSON content after deserializing an object; otherwise, <c>false</c>.
</value>
</member>
<member name="M:Newtonsoft.Json.JsonSerializer.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonSerializer"/> class.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonSerializer.Create">
<summary>
Creates a new <see cref="T:Newtonsoft.Json.JsonSerializer"/> instance.
The <see cref="T:Newtonsoft.Json.JsonSerializer"/> will not use default settings
from <see cref="P:Newtonsoft.Json.JsonConvert.DefaultSettings"/>.
</summary>
<returns>
A new <see cref="T:Newtonsoft.Json.JsonSerializer"/> instance.
The <see cref="T:Newtonsoft.Json.JsonSerializer"/> will not use default settings
from <see cref="P:Newtonsoft.Json.JsonConvert.DefaultSettings"/>.
</returns>
</member>
<member name="M:Newtonsoft.Json.JsonSerializer.Create(Newtonsoft.Json.JsonSerializerSettings)">
<summary>
Creates a new <see cref="T:Newtonsoft.Json.JsonSerializer"/> instance using the specified <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>.
The <see cref="T:Newtonsoft.Json.JsonSerializer"/> will not use default settings
from <see cref="P:Newtonsoft.Json.JsonConvert.DefaultSettings"/>.
</summary>
<param name="settings">The settings to be applied to the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.</param>
<returns>
A new <see cref="T:Newtonsoft.Json.JsonSerializer"/> instance using the specified <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>.
The <see cref="T:Newtonsoft.Json.JsonSerializer"/> will not use default settings
from <see cref="P:Newtonsoft.Json.JsonConvert.DefaultSettings"/>.
</returns>
</member>
<member name="M:Newtonsoft.Json.JsonSerializer.CreateDefault">
<summary>
Creates a new <see cref="T:Newtonsoft.Json.JsonSerializer"/> instance.
The <see cref="T:Newtonsoft.Json.JsonSerializer"/> will use default settings
from <see cref="P:Newtonsoft.Json.JsonConvert.DefaultSettings"/>.
</summary>
<returns>
A new <see cref="T:Newtonsoft.Json.JsonSerializer"/> instance.
The <see cref="T:Newtonsoft.Json.JsonSerializer"/> will use default settings
from <see cref="P:Newtonsoft.Json.JsonConvert.DefaultSettings"/>.
</returns>
</member>
<member name="M:Newtonsoft.Json.JsonSerializer.CreateDefault(Newtonsoft.Json.JsonSerializerSettings)">
<summary>
Creates a new <see cref="T:Newtonsoft.Json.JsonSerializer"/> instance using the specified <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>.
The <see cref="T:Newtonsoft.Json.JsonSerializer"/> will use default settings
from <see cref="P:Newtonsoft.Json.JsonConvert.DefaultSettings"/> as well as the specified <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>.
</summary>
<param name="settings">The settings to be applied to the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.</param>
<returns>
A new <see cref="T:Newtonsoft.Json.JsonSerializer"/> instance using the specified <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>.
The <see cref="T:Newtonsoft.Json.JsonSerializer"/> will use default settings
from <see cref="P:Newtonsoft.Json.JsonConvert.DefaultSettings"/> as well as the specified <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>.
</returns>
</member>
<member name="M:Newtonsoft.Json.JsonSerializer.Populate(System.IO.TextReader,System.Object)">
<summary>
Populates the JSON values onto the target object.
</summary>
<param name="reader">The <see cref="T:System.IO.TextReader"/> that contains the JSON structure to read values from.</param>
<param name="target">The target object to populate values onto.</param>
</member>
<member name="M:Newtonsoft.Json.JsonSerializer.Populate(Newtonsoft.Json.JsonReader,System.Object)">
<summary>
Populates the JSON values onto the target object.
</summary>
<param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> that contains the JSON structure to read values from.</param>
<param name="target">The target object to populate values onto.</param>
</member>
<member name="M:Newtonsoft.Json.JsonSerializer.Deserialize(Newtonsoft.Json.JsonReader)">
<summary>
Deserializes the JSON structure contained by the specified <see cref="T:Newtonsoft.Json.JsonReader"/>.
</summary>
<param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> that contains the JSON structure to deserialize.</param>
<returns>The <see cref="T:System.Object"/> being deserialized.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonSerializer.Deserialize(System.IO.TextReader,System.Type)">
<summary>
Deserializes the JSON structure contained by the specified <see cref="T:System.IO.TextReader"/>
into an instance of the specified type.
</summary>
<param name="reader">The <see cref="T:System.IO.TextReader"/> containing the object.</param>
<param name="objectType">The <see cref="T:System.Type"/> of object being deserialized.</param>
<returns>The instance of <paramref name="objectType"/> being deserialized.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonSerializer.Deserialize``1(Newtonsoft.Json.JsonReader)">
<summary>
Deserializes the JSON structure contained by the specified <see cref="T:Newtonsoft.Json.JsonReader"/>
into an instance of the specified type.
</summary>
<param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> containing the object.</param>
<typeparam name="T">The type of the object to deserialize.</typeparam>
<returns>The instance of <typeparamref name="T"/> being deserialized.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonSerializer.Deserialize(Newtonsoft.Json.JsonReader,System.Type)">
<summary>
Deserializes the JSON structure contained by the specified <see cref="T:Newtonsoft.Json.JsonReader"/>
into an instance of the specified type.
</summary>
<param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> containing the object.</param>
<param name="objectType">The <see cref="T:System.Type"/> of object being deserialized.</param>
<returns>The instance of <paramref name="objectType"/> being deserialized.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonSerializer.Serialize(System.IO.TextWriter,System.Object)">
<summary>
Serializes the specified <see cref="T:System.Object"/> and writes the JSON structure
using the specified <see cref="T:System.IO.TextWriter"/>.
</summary>
<param name="textWriter">The <see cref="T:System.IO.TextWriter"/> used to write the JSON structure.</param>
<param name="value">The <see cref="T:System.Object"/> to serialize.</param>
</member>
<member name="M:Newtonsoft.Json.JsonSerializer.Serialize(Newtonsoft.Json.JsonWriter,System.Object,System.Type)">
<summary>
Serializes the specified <see cref="T:System.Object"/> and writes the JSON structure
using the specified <see cref="T:Newtonsoft.Json.JsonWriter"/>.
</summary>
<param name="jsonWriter">The <see cref="T:Newtonsoft.Json.JsonWriter"/> used to write the JSON structure.</param>
<param name="value">The <see cref="T:System.Object"/> to serialize.</param>
<param name="objectType">
The type of the value being serialized.
This parameter is used when <see cref="P:Newtonsoft.Json.JsonSerializer.TypeNameHandling"/> is <see cref="F:Newtonsoft.Json.TypeNameHandling.Auto"/> to write out the type name if the type of the value does not match.
Specifying the type is optional.
</param>
</member>
<member name="M:Newtonsoft.Json.JsonSerializer.Serialize(System.IO.TextWriter,System.Object,System.Type)">
<summary>
Serializes the specified <see cref="T:System.Object"/> and writes the JSON structure
using the specified <see cref="T:System.IO.TextWriter"/>.
</summary>
<param name="textWriter">The <see cref="T:System.IO.TextWriter"/> used to write the JSON structure.</param>
<param name="value">The <see cref="T:System.Object"/> to serialize.</param>
<param name="objectType">
The type of the value being serialized.
This parameter is used when <see cref="P:Newtonsoft.Json.JsonSerializer.TypeNameHandling"/> is Auto to write out the type name if the type of the value does not match.
Specifying the type is optional.
</param>
</member>
<member name="M:Newtonsoft.Json.JsonSerializer.Serialize(Newtonsoft.Json.JsonWriter,System.Object)">
<summary>
Serializes the specified <see cref="T:System.Object"/> and writes the JSON structure
using the specified <see cref="T:Newtonsoft.Json.JsonWriter"/>.
</summary>
<param name="jsonWriter">The <see cref="T:Newtonsoft.Json.JsonWriter"/> used to write the JSON structure.</param>
<param name="value">The <see cref="T:System.Object"/> to serialize.</param>
</member>
<member name="T:Newtonsoft.Json.JsonSerializerSettings">
<summary>
Specifies the settings on a <see cref="T:Newtonsoft.Json.JsonSerializer"/> object.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonSerializerSettings.ReferenceLoopHandling">
<summary>
Gets or sets how reference loops (e.g. a class referencing itself) are handled.
The default value is <see cref="F:Newtonsoft.Json.ReferenceLoopHandling.Error" />.
</summary>
<value>Reference loop handling.</value>
</member>
<member name="P:Newtonsoft.Json.JsonSerializerSettings.MissingMemberHandling">
<summary>
Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization.
The default value is <see cref="F:Newtonsoft.Json.MissingMemberHandling.Ignore" />.
</summary>
<value>Missing member handling.</value>
</member>
<member name="P:Newtonsoft.Json.JsonSerializerSettings.ObjectCreationHandling">
<summary>
Gets or sets how objects are created during deserialization.
The default value is <see cref="F:Newtonsoft.Json.ObjectCreationHandling.Auto" />.
</summary>
<value>The object creation handling.</value>
</member>
<member name="P:Newtonsoft.Json.JsonSerializerSettings.NullValueHandling">
<summary>
Gets or sets how null values are handled during serialization and deserialization.
The default value is <see cref="F:Newtonsoft.Json.NullValueHandling.Include" />.
</summary>
<value>Null value handling.</value>
</member>
<member name="P:Newtonsoft.Json.JsonSerializerSettings.DefaultValueHandling">
<summary>
Gets or sets how default values are handled during serialization and deserialization.
The default value is <see cref="F:Newtonsoft.Json.DefaultValueHandling.Include" />.
</summary>
<value>The default value handling.</value>
</member>
<member name="P:Newtonsoft.Json.JsonSerializerSettings.Converters">
<summary>
Gets or sets a <see cref="T:Newtonsoft.Json.JsonConverter"/> collection that will be used during serialization.
</summary>
<value>The converters.</value>
</member>
<member name="P:Newtonsoft.Json.JsonSerializerSettings.PreserveReferencesHandling">
<summary>
Gets or sets how object references are preserved by the serializer.
The default value is <see cref="F:Newtonsoft.Json.PreserveReferencesHandling.None" />.
</summary>
<value>The preserve references handling.</value>
</member>
<member name="P:Newtonsoft.Json.JsonSerializerSettings.TypeNameHandling">
<summary>
Gets or sets how type name writing and reading is handled by the serializer.
The default value is <see cref="F:Newtonsoft.Json.TypeNameHandling.None" />.
</summary>
<remarks>
<see cref="P:Newtonsoft.Json.JsonSerializerSettings.TypeNameHandling"/> should be used with caution when your application deserializes JSON from an external source.
Incoming types should be validated with a custom <see cref="P:Newtonsoft.Json.JsonSerializerSettings.SerializationBinder"/>
when deserializing with a value other than <see cref="F:Newtonsoft.Json.TypeNameHandling.None"/>.
</remarks>
<value>The type name handling.</value>
</member>
<member name="P:Newtonsoft.Json.JsonSerializerSettings.MetadataPropertyHandling">
<summary>
Gets or sets how metadata properties are used during deserialization.
The default value is <see cref="F:Newtonsoft.Json.MetadataPropertyHandling.Default" />.
</summary>
<value>The metadata properties handling.</value>
</member>
<member name="P:Newtonsoft.Json.JsonSerializerSettings.TypeNameAssemblyFormat">
<summary>
Gets or sets how a type name assembly is written and resolved by the serializer.
The default value is <see cref="F:System.Runtime.Serialization.Formatters.FormatterAssemblyStyle.Simple" />.
</summary>
<value>The type name assembly format.</value>
</member>
<member name="P:Newtonsoft.Json.JsonSerializerSettings.TypeNameAssemblyFormatHandling">
<summary>
Gets or sets how a type name assembly is written and resolved by the serializer.
The default value is <see cref="F:Newtonsoft.Json.TypeNameAssemblyFormatHandling.Simple" />.
</summary>
<value>The type name assembly format.</value>
</member>
<member name="P:Newtonsoft.Json.JsonSerializerSettings.ConstructorHandling">
<summary>
Gets or sets how constructors are used during deserialization.
The default value is <see cref="F:Newtonsoft.Json.ConstructorHandling.Default" />.
</summary>
<value>The constructor handling.</value>
</member>
<member name="P:Newtonsoft.Json.JsonSerializerSettings.ContractResolver">
<summary>
Gets or sets the contract resolver used by the serializer when
serializing .NET objects to JSON and vice versa.
</summary>
<value>The contract resolver.</value>
</member>
<member name="P:Newtonsoft.Json.JsonSerializerSettings.EqualityComparer">
<summary>
Gets or sets the equality comparer used by the serializer when comparing references.
</summary>
<value>The equality comparer.</value>
</member>
<member name="P:Newtonsoft.Json.JsonSerializerSettings.ReferenceResolver">
<summary>
Gets or sets the <see cref="T:Newtonsoft.Json.Serialization.IReferenceResolver"/> used by the serializer when resolving references.
</summary>
<value>The reference resolver.</value>
</member>
<member name="P:Newtonsoft.Json.JsonSerializerSettings.ReferenceResolverProvider">
<summary>
Gets or sets a function that creates the <see cref="T:Newtonsoft.Json.Serialization.IReferenceResolver"/> used by the serializer when resolving references.
</summary>
<value>A function that creates the <see cref="T:Newtonsoft.Json.Serialization.IReferenceResolver"/> used by the serializer when resolving references.</value>
</member>
<member name="P:Newtonsoft.Json.JsonSerializerSettings.TraceWriter">
<summary>
Gets or sets the <see cref="T:Newtonsoft.Json.Serialization.ITraceWriter"/> used by the serializer when writing trace messages.
</summary>
<value>The trace writer.</value>
</member>
<member name="P:Newtonsoft.Json.JsonSerializerSettings.Binder">
<summary>
Gets or sets the <see cref="P:Newtonsoft.Json.JsonSerializerSettings.SerializationBinder"/> used by the serializer when resolving type names.
</summary>
<value>The binder.</value>
</member>
<member name="P:Newtonsoft.Json.JsonSerializerSettings.SerializationBinder">
<summary>
Gets or sets the <see cref="T:Newtonsoft.Json.Serialization.ISerializationBinder"/> used by the serializer when resolving type names.
</summary>
<value>The binder.</value>
</member>
<member name="P:Newtonsoft.Json.JsonSerializerSettings.Error">
<summary>
Gets or sets the error handler called during serialization and deserialization.
</summary>
<value>The error handler called during serialization and deserialization.</value>
</member>
<member name="P:Newtonsoft.Json.JsonSerializerSettings.Context">
<summary>
Gets or sets the <see cref="T:System.Runtime.Serialization.StreamingContext"/> used by the serializer when invoking serialization callback methods.
</summary>
<value>The context.</value>
</member>
<member name="P:Newtonsoft.Json.JsonSerializerSettings.DateFormatString">
<summary>
Gets or sets how <see cref="T:System.DateTime"/> and <see cref="T:System.DateTimeOffset"/> values are formatted when writing JSON text,
and the expected date format when reading JSON text.
The default value is <c>"yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK"</c>.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonSerializerSettings.MaxDepth">
<summary>
Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a <see cref="T:Newtonsoft.Json.JsonReaderException"/>.
A null value means there is no maximum.
The default value is <c>128</c>.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonSerializerSettings.Formatting">
<summary>
Indicates how JSON text output is formatted.
The default value is <see cref="F:Newtonsoft.Json.Formatting.None" />.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonSerializerSettings.DateFormatHandling">
<summary>
Gets or sets how dates are written to JSON text.
The default value is <see cref="F:Newtonsoft.Json.DateFormatHandling.IsoDateFormat" />.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonSerializerSettings.DateTimeZoneHandling">
<summary>
Gets or sets how <see cref="T:System.DateTime"/> time zones are handled during serialization and deserialization.
The default value is <see cref="F:Newtonsoft.Json.DateTimeZoneHandling.RoundtripKind" />.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonSerializerSettings.DateParseHandling">
<summary>
Gets or sets how date formatted strings, e.g. <c>"\/Date(1198908717056)\/"</c> and <c>"2012-03-21T05:40Z"</c>, are parsed when reading JSON.
The default value is <see cref="F:Newtonsoft.Json.DateParseHandling.DateTime" />.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonSerializerSettings.FloatFormatHandling">
<summary>
Gets or sets how special floating point numbers, e.g. <see cref="F:System.Double.NaN"/>,
<see cref="F:System.Double.PositiveInfinity"/> and <see cref="F:System.Double.NegativeInfinity"/>,
are written as JSON.
The default value is <see cref="F:Newtonsoft.Json.FloatFormatHandling.String" />.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonSerializerSettings.FloatParseHandling">
<summary>
Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text.
The default value is <see cref="F:Newtonsoft.Json.FloatParseHandling.Double" />.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonSerializerSettings.StringEscapeHandling">
<summary>
Gets or sets how strings are escaped when writing JSON text.
The default value is <see cref="F:Newtonsoft.Json.StringEscapeHandling.Default" />.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonSerializerSettings.Culture">
<summary>
Gets or sets the culture used when reading JSON.
The default value is <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonSerializerSettings.CheckAdditionalContent">
<summary>
Gets a value indicating whether there will be a check for additional content after deserializing an object.
The default value is <c>false</c>.
</summary>
<value>
<c>true</c> if there will be a check for additional content after deserializing an object; otherwise, <c>false</c>.
</value>
</member>
<member name="M:Newtonsoft.Json.JsonSerializerSettings.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/> class.
</summary>
</member>
<member name="T:Newtonsoft.Json.JsonTextReader">
<summary>
Represents a reader that provides fast, non-cached, forward-only access to JSON text data.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonTextReader.ReadAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously reads the next JSON token from the source.
</summary>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous read. The <see cref="P:System.Threading.Tasks.Task`1.Result"/>
property returns <c>true</c> if the next token was read successfully; <c>false</c> if there are no more tokens to read.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextReader.ReadAsBooleanAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously reads the next JSON token from the source as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Boolean"/>.
</summary>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous read. The <see cref="P:System.Threading.Tasks.Task`1.Result"/>
property returns the <see cref="T:System.Nullable`1"/> of <see cref="T:System.Boolean"/>. This result will be <c>null</c> at the end of an array.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextReader.ReadAsBytesAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously reads the next JSON token from the source as a <see cref="T:System.Byte"/>[].
</summary>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous read. The <see cref="P:System.Threading.Tasks.Task`1.Result"/>
property returns the <see cref="T:System.Byte"/>[]. This result will be <c>null</c> at the end of an array.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextReader.ReadAsDateTimeAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously reads the next JSON token from the source as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTime"/>.
</summary>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous read. The <see cref="P:System.Threading.Tasks.Task`1.Result"/>
property returns the <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTime"/>. This result will be <c>null</c> at the end of an array.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextReader.ReadAsDateTimeOffsetAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously reads the next JSON token from the source as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTimeOffset"/>.
</summary>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous read. The <see cref="P:System.Threading.Tasks.Task`1.Result"/>
property returns the <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTimeOffset"/>. This result will be <c>null</c> at the end of an array.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextReader.ReadAsDecimalAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously reads the next JSON token from the source as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Decimal"/>.
</summary>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous read. The <see cref="P:System.Threading.Tasks.Task`1.Result"/>
property returns the <see cref="T:System.Nullable`1"/> of <see cref="T:System.Decimal"/>. This result will be <c>null</c> at the end of an array.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextReader.ReadAsDoubleAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously reads the next JSON token from the source as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Double"/>.
</summary>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous read. The <see cref="P:System.Threading.Tasks.Task`1.Result"/>
property returns the <see cref="T:System.Nullable`1"/> of <see cref="T:System.Double"/>. This result will be <c>null</c> at the end of an array.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextReader.ReadAsInt32Async(System.Threading.CancellationToken)">
<summary>
Asynchronously reads the next JSON token from the source as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int32"/>.
</summary>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous read. The <see cref="P:System.Threading.Tasks.Task`1.Result"/>
property returns the <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int32"/>. This result will be <c>null</c> at the end of an array.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextReader.ReadAsStringAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously reads the next JSON token from the source as a <see cref="T:System.String"/>.
</summary>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous read. The <see cref="P:System.Threading.Tasks.Task`1.Result"/>
property returns the <see cref="T:System.String"/>. This result will be <c>null</c> at the end of an array.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextReader.#ctor(System.IO.TextReader)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonTextReader"/> class with the specified <see cref="T:System.IO.TextReader"/>.
</summary>
<param name="reader">The <see cref="T:System.IO.TextReader"/> containing the JSON data to read.</param>
</member>
<member name="P:Newtonsoft.Json.JsonTextReader.PropertyNameTable">
<summary>
Gets or sets the reader's property name table.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonTextReader.ArrayPool">
<summary>
Gets or sets the reader's character buffer pool.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonTextReader.Read">
<summary>
Reads the next JSON token from the underlying <see cref="T:System.IO.TextReader"/>.
</summary>
<returns>
<c>true</c> if the next token was read successfully; <c>false</c> if there are no more tokens to read.
</returns>
</member>
<member name="M:Newtonsoft.Json.JsonTextReader.ReadAsInt32">
<summary>
Reads the next JSON token from the underlying <see cref="T:System.IO.TextReader"/> as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int32"/>.
</summary>
<returns>A <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int32"/>. This method will return <c>null</c> at the end of an array.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonTextReader.ReadAsDateTime">
<summary>
Reads the next JSON token from the underlying <see cref="T:System.IO.TextReader"/> as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTime"/>.
</summary>
<returns>A <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTime"/>. This method will return <c>null</c> at the end of an array.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonTextReader.ReadAsString">
<summary>
Reads the next JSON token from the underlying <see cref="T:System.IO.TextReader"/> as a <see cref="T:System.String"/>.
</summary>
<returns>A <see cref="T:System.String"/>. This method will return <c>null</c> at the end of an array.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonTextReader.ReadAsBytes">
<summary>
Reads the next JSON token from the underlying <see cref="T:System.IO.TextReader"/> as a <see cref="T:System.Byte"/>[].
</summary>
<returns>A <see cref="T:System.Byte"/>[] or <c>null</c> if the next JSON token is null. This method will return <c>null</c> at the end of an array.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonTextReader.ReadAsBoolean">
<summary>
Reads the next JSON token from the underlying <see cref="T:System.IO.TextReader"/> as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Boolean"/>.
</summary>
<returns>A <see cref="T:System.Nullable`1"/> of <see cref="T:System.Boolean"/>. This method will return <c>null</c> at the end of an array.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonTextReader.ReadAsDateTimeOffset">
<summary>
Reads the next JSON token from the underlying <see cref="T:System.IO.TextReader"/> as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTimeOffset"/>.
</summary>
<returns>A <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTimeOffset"/>. This method will return <c>null</c> at the end of an array.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonTextReader.ReadAsDecimal">
<summary>
Reads the next JSON token from the underlying <see cref="T:System.IO.TextReader"/> as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Decimal"/>.
</summary>
<returns>A <see cref="T:System.Nullable`1"/> of <see cref="T:System.Decimal"/>. This method will return <c>null</c> at the end of an array.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonTextReader.ReadAsDouble">
<summary>
Reads the next JSON token from the underlying <see cref="T:System.IO.TextReader"/> as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Double"/>.
</summary>
<returns>A <see cref="T:System.Nullable`1"/> of <see cref="T:System.Double"/>. This method will return <c>null</c> at the end of an array.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonTextReader.Close">
<summary>
Changes the reader's state to <see cref="F:Newtonsoft.Json.JsonReader.State.Closed"/>.
If <see cref="P:Newtonsoft.Json.JsonReader.CloseInput"/> is set to <c>true</c>, the underlying <see cref="T:System.IO.TextReader"/> is also closed.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonTextReader.HasLineInfo">
<summary>
Gets a value indicating whether the class can return line information.
</summary>
<returns>
<c>true</c> if <see cref="P:Newtonsoft.Json.JsonTextReader.LineNumber"/> and <see cref="P:Newtonsoft.Json.JsonTextReader.LinePosition"/> can be provided; otherwise, <c>false</c>.
</returns>
</member>
<member name="P:Newtonsoft.Json.JsonTextReader.LineNumber">
<summary>
Gets the current line number.
</summary>
<value>
The current line number or 0 if no line information is available (for example, <see cref="M:Newtonsoft.Json.JsonTextReader.HasLineInfo"/> returns <c>false</c>).
</value>
</member>
<member name="P:Newtonsoft.Json.JsonTextReader.LinePosition">
<summary>
Gets the current line position.
</summary>
<value>
The current line position or 0 if no line information is available (for example, <see cref="M:Newtonsoft.Json.JsonTextReader.HasLineInfo"/> returns <c>false</c>).
</value>
</member>
<member name="T:Newtonsoft.Json.JsonTextWriter">
<summary>
Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.FlushAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously flushes whatever is in the buffer to the destination and also flushes the destination.
</summary>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValueDelimiterAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously writes the JSON value delimiter.
</summary>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteEndAsync(Newtonsoft.Json.JsonToken,System.Threading.CancellationToken)">
<summary>
Asynchronously writes the specified end token.
</summary>
<param name="token">The end token to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.CloseAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously closes this writer.
If <see cref="P:Newtonsoft.Json.JsonWriter.CloseOutput"/> is set to <c>true</c>, the destination is also closed.
</summary>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteEndAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously writes the end of the current JSON object or array.
</summary>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteIndentAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously writes indent characters.
</summary>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteIndentSpaceAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously writes an indent space.
</summary>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteRawAsync(System.String,System.Threading.CancellationToken)">
<summary>
Asynchronously writes raw JSON without changing the writer's state.
</summary>
<param name="json">The raw JSON to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteNullAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously writes a null value.
</summary>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WritePropertyNameAsync(System.String,System.Threading.CancellationToken)">
<summary>
Asynchronously writes the property name of a name/value pair of a JSON object.
</summary>
<param name="name">The name of the property.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WritePropertyNameAsync(System.String,System.Boolean,System.Threading.CancellationToken)">
<summary>
Asynchronously writes the property name of a name/value pair of a JSON object.
</summary>
<param name="name">The name of the property.</param>
<param name="escape">A flag to indicate whether the text should be escaped when it is written as a JSON property name.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteStartArrayAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously writes the beginning of a JSON array.
</summary>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteStartObjectAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously writes the beginning of a JSON object.
</summary>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteStartConstructorAsync(System.String,System.Threading.CancellationToken)">
<summary>
Asynchronously writes the start of a constructor with the given name.
</summary>
<param name="name">The name of the constructor.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteUndefinedAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously writes an undefined value.
</summary>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteWhitespaceAsync(System.String,System.Threading.CancellationToken)">
<summary>
Asynchronously writes the given white space.
</summary>
<param name="ws">The string of white space characters.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValueAsync(System.Boolean,System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Boolean"/> value.
</summary>
<param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Boolean"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValueAsync(System.Nullable{System.Boolean},System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Boolean"/> value.
</summary>
<param name="value">The <see cref="T:System.Boolean"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValueAsync(System.Byte,System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Byte"/> value.
</summary>
<param name="value">The <see cref="T:System.Byte"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValueAsync(System.Nullable{System.Byte},System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Byte"/> value.
</summary>
<param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Byte"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValueAsync(System.Byte[],System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Byte"/>[] value.
</summary>
<param name="value">The <see cref="T:System.Byte"/>[] value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValueAsync(System.Char,System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Char"/> value.
</summary>
<param name="value">The <see cref="T:System.Char"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValueAsync(System.Nullable{System.Char},System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Char"/> value.
</summary>
<param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Char"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValueAsync(System.DateTime,System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.DateTime"/> value.
</summary>
<param name="value">The <see cref="T:System.DateTime"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValueAsync(System.Nullable{System.DateTime},System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTime"/> value.
</summary>
<param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTime"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValueAsync(System.DateTimeOffset,System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.DateTimeOffset"/> value.
</summary>
<param name="value">The <see cref="T:System.DateTimeOffset"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValueAsync(System.Nullable{System.DateTimeOffset},System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTimeOffset"/> value.
</summary>
<param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTimeOffset"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValueAsync(System.Decimal,System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Decimal"/> value.
</summary>
<param name="value">The <see cref="T:System.Decimal"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValueAsync(System.Nullable{System.Decimal},System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Decimal"/> value.
</summary>
<param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Decimal"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValueAsync(System.Double,System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Double"/> value.
</summary>
<param name="value">The <see cref="T:System.Double"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValueAsync(System.Nullable{System.Double},System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Double"/> value.
</summary>
<param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Double"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValueAsync(System.Single,System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Single"/> value.
</summary>
<param name="value">The <see cref="T:System.Single"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValueAsync(System.Nullable{System.Single},System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Single"/> value.
</summary>
<param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Single"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValueAsync(System.Guid,System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Guid"/> value.
</summary>
<param name="value">The <see cref="T:System.Guid"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValueAsync(System.Nullable{System.Guid},System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Guid"/> value.
</summary>
<param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Guid"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValueAsync(System.Int32,System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Int32"/> value.
</summary>
<param name="value">The <see cref="T:System.Int32"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValueAsync(System.Nullable{System.Int32},System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int32"/> value.
</summary>
<param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int32"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValueAsync(System.Int64,System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Int64"/> value.
</summary>
<param name="value">The <see cref="T:System.Int64"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValueAsync(System.Nullable{System.Int64},System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int64"/> value.
</summary>
<param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int64"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValueAsync(System.Object,System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Object"/> value.
</summary>
<param name="value">The <see cref="T:System.Object"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValueAsync(System.SByte,System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.SByte"/> value.
</summary>
<param name="value">The <see cref="T:System.SByte"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValueAsync(System.Nullable{System.SByte},System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.SByte"/> value.
</summary>
<param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.SByte"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValueAsync(System.Int16,System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Int16"/> value.
</summary>
<param name="value">The <see cref="T:System.Int16"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValueAsync(System.Nullable{System.Int16},System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int16"/> value.
</summary>
<param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int16"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValueAsync(System.String,System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.String"/> value.
</summary>
<param name="value">The <see cref="T:System.String"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValueAsync(System.TimeSpan,System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.TimeSpan"/> value.
</summary>
<param name="value">The <see cref="T:System.TimeSpan"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValueAsync(System.Nullable{System.TimeSpan},System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.TimeSpan"/> value.
</summary>
<param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.TimeSpan"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValueAsync(System.UInt32,System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.UInt32"/> value.
</summary>
<param name="value">The <see cref="T:System.UInt32"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValueAsync(System.Nullable{System.UInt32},System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.UInt32"/> value.
</summary>
<param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.UInt32"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValueAsync(System.UInt64,System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.UInt64"/> value.
</summary>
<param name="value">The <see cref="T:System.UInt64"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValueAsync(System.Nullable{System.UInt64},System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.UInt64"/> value.
</summary>
<param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.UInt64"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValueAsync(System.Uri,System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Uri"/> value.
</summary>
<param name="value">The <see cref="T:System.Uri"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValueAsync(System.UInt16,System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.UInt16"/> value.
</summary>
<param name="value">The <see cref="T:System.UInt16"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValueAsync(System.Nullable{System.UInt16},System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.UInt16"/> value.
</summary>
<param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.UInt16"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteCommentAsync(System.String,System.Threading.CancellationToken)">
<summary>
Asynchronously writes a comment <c>/*...*/</c> containing the specified text.
</summary>
<param name="text">Text to place inside the comment.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteEndArrayAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously writes the end of an array.
</summary>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteEndConstructorAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously writes the end of a constructor.
</summary>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteEndObjectAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously writes the end of a JSON object.
</summary>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteRawValueAsync(System.String,System.Threading.CancellationToken)">
<summary>
Asynchronously writes raw JSON where a value is expected and updates the writer's state.
</summary>
<param name="json">The raw JSON to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
execute synchronously, returning an already-completed task.</remarks>
</member>
<member name="P:Newtonsoft.Json.JsonTextWriter.ArrayPool">
<summary>
Gets or sets the writer's character array pool.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonTextWriter.Indentation">
<summary>
Gets or sets how many <see cref="P:Newtonsoft.Json.JsonTextWriter.IndentChar"/>s to write for each level in the hierarchy when <see cref="P:Newtonsoft.Json.JsonWriter.Formatting"/> is set to <see cref="F:Newtonsoft.Json.Formatting.Indented"/>.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonTextWriter.QuoteChar">
<summary>
Gets or sets which character to use to quote attribute values.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonTextWriter.IndentChar">
<summary>
Gets or sets which character to use for indenting when <see cref="P:Newtonsoft.Json.JsonWriter.Formatting"/> is set to <see cref="F:Newtonsoft.Json.Formatting.Indented"/>.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonTextWriter.QuoteName">
<summary>
Gets or sets a value indicating whether object names will be surrounded with quotes.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.#ctor(System.IO.TextWriter)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonTextWriter"/> class using the specified <see cref="T:System.IO.TextWriter"/>.
</summary>
<param name="textWriter">The <see cref="T:System.IO.TextWriter"/> to write to.</param>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.Flush">
<summary>
Flushes whatever is in the buffer to the underlying <see cref="T:System.IO.TextWriter"/> and also flushes the underlying <see cref="T:System.IO.TextWriter"/>.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.Close">
<summary>
Closes this writer.
If <see cref="P:Newtonsoft.Json.JsonWriter.CloseOutput"/> is set to <c>true</c>, the underlying <see cref="T:System.IO.TextWriter"/> is also closed.
If <see cref="P:Newtonsoft.Json.JsonWriter.AutoCompleteOnClose"/> is set to <c>true</c>, the JSON is auto-completed.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteStartObject">
<summary>
Writes the beginning of a JSON object.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteStartArray">
<summary>
Writes the beginning of a JSON array.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteStartConstructor(System.String)">
<summary>
Writes the start of a constructor with the given name.
</summary>
<param name="name">The name of the constructor.</param>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteEnd(Newtonsoft.Json.JsonToken)">
<summary>
Writes the specified end token.
</summary>
<param name="token">The end token to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WritePropertyName(System.String)">
<summary>
Writes the property name of a name/value pair on a JSON object.
</summary>
<param name="name">The name of the property.</param>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WritePropertyName(System.String,System.Boolean)">
<summary>
Writes the property name of a name/value pair on a JSON object.
</summary>
<param name="name">The name of the property.</param>
<param name="escape">A flag to indicate whether the text should be escaped when it is written as a JSON property name.</param>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteIndent">
<summary>
Writes indent characters.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValueDelimiter">
<summary>
Writes the JSON value delimiter.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteIndentSpace">
<summary>
Writes an indent space.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.Object)">
<summary>
Writes a <see cref="T:System.Object"/> value.
An error will raised if the value cannot be written as a single JSON token.
</summary>
<param name="value">The <see cref="T:System.Object"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteNull">
<summary>
Writes a null value.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteUndefined">
<summary>
Writes an undefined value.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteRaw(System.String)">
<summary>
Writes raw JSON.
</summary>
<param name="json">The raw JSON to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.String)">
<summary>
Writes a <see cref="T:System.String"/> value.
</summary>
<param name="value">The <see cref="T:System.String"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.Int32)">
<summary>
Writes a <see cref="T:System.Int32"/> value.
</summary>
<param name="value">The <see cref="T:System.Int32"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.UInt32)">
<summary>
Writes a <see cref="T:System.UInt32"/> value.
</summary>
<param name="value">The <see cref="T:System.UInt32"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.Int64)">
<summary>
Writes a <see cref="T:System.Int64"/> value.
</summary>
<param name="value">The <see cref="T:System.Int64"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.UInt64)">
<summary>
Writes a <see cref="T:System.UInt64"/> value.
</summary>
<param name="value">The <see cref="T:System.UInt64"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.Single)">
<summary>
Writes a <see cref="T:System.Single"/> value.
</summary>
<param name="value">The <see cref="T:System.Single"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.Nullable{System.Single})">
<summary>
Writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Single"/> value.
</summary>
<param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Single"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.Double)">
<summary>
Writes a <see cref="T:System.Double"/> value.
</summary>
<param name="value">The <see cref="T:System.Double"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.Nullable{System.Double})">
<summary>
Writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Double"/> value.
</summary>
<param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Double"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.Boolean)">
<summary>
Writes a <see cref="T:System.Boolean"/> value.
</summary>
<param name="value">The <see cref="T:System.Boolean"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.Int16)">
<summary>
Writes a <see cref="T:System.Int16"/> value.
</summary>
<param name="value">The <see cref="T:System.Int16"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.UInt16)">
<summary>
Writes a <see cref="T:System.UInt16"/> value.
</summary>
<param name="value">The <see cref="T:System.UInt16"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.Char)">
<summary>
Writes a <see cref="T:System.Char"/> value.
</summary>
<param name="value">The <see cref="T:System.Char"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.Byte)">
<summary>
Writes a <see cref="T:System.Byte"/> value.
</summary>
<param name="value">The <see cref="T:System.Byte"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.SByte)">
<summary>
Writes a <see cref="T:System.SByte"/> value.
</summary>
<param name="value">The <see cref="T:System.SByte"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.Decimal)">
<summary>
Writes a <see cref="T:System.Decimal"/> value.
</summary>
<param name="value">The <see cref="T:System.Decimal"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.DateTime)">
<summary>
Writes a <see cref="T:System.DateTime"/> value.
</summary>
<param name="value">The <see cref="T:System.DateTime"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.Byte[])">
<summary>
Writes a <see cref="T:System.Byte"/>[] value.
</summary>
<param name="value">The <see cref="T:System.Byte"/>[] value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.DateTimeOffset)">
<summary>
Writes a <see cref="T:System.DateTimeOffset"/> value.
</summary>
<param name="value">The <see cref="T:System.DateTimeOffset"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.Guid)">
<summary>
Writes a <see cref="T:System.Guid"/> value.
</summary>
<param name="value">The <see cref="T:System.Guid"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.TimeSpan)">
<summary>
Writes a <see cref="T:System.TimeSpan"/> value.
</summary>
<param name="value">The <see cref="T:System.TimeSpan"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.Uri)">
<summary>
Writes a <see cref="T:System.Uri"/> value.
</summary>
<param name="value">The <see cref="T:System.Uri"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteComment(System.String)">
<summary>
Writes a comment <c>/*...*/</c> containing the specified text.
</summary>
<param name="text">Text to place inside the comment.</param>
</member>
<member name="M:Newtonsoft.Json.JsonTextWriter.WriteWhitespace(System.String)">
<summary>
Writes the given white space.
</summary>
<param name="ws">The string of white space characters.</param>
</member>
<member name="T:Newtonsoft.Json.JsonToken">
<summary>
Specifies the type of JSON token.
</summary>
</member>
<member name="F:Newtonsoft.Json.JsonToken.None">
<summary>
This is returned by the <see cref="T:Newtonsoft.Json.JsonReader"/> if a read method has not been called.
</summary>
</member>
<member name="F:Newtonsoft.Json.JsonToken.StartObject">
<summary>
An object start token.
</summary>
</member>
<member name="F:Newtonsoft.Json.JsonToken.StartArray">
<summary>
An array start token.
</summary>
</member>
<member name="F:Newtonsoft.Json.JsonToken.StartConstructor">
<summary>
A constructor start token.
</summary>
</member>
<member name="F:Newtonsoft.Json.JsonToken.PropertyName">
<summary>
An object property name.
</summary>
</member>
<member name="F:Newtonsoft.Json.JsonToken.Comment">
<summary>
A comment.
</summary>
</member>
<member name="F:Newtonsoft.Json.JsonToken.Raw">
<summary>
Raw JSON.
</summary>
</member>
<member name="F:Newtonsoft.Json.JsonToken.Integer">
<summary>
An integer.
</summary>
</member>
<member name="F:Newtonsoft.Json.JsonToken.Float">
<summary>
A float.
</summary>
</member>
<member name="F:Newtonsoft.Json.JsonToken.String">
<summary>
A string.
</summary>
</member>
<member name="F:Newtonsoft.Json.JsonToken.Boolean">
<summary>
A boolean.
</summary>
</member>
<member name="F:Newtonsoft.Json.JsonToken.Null">
<summary>
A null token.
</summary>
</member>
<member name="F:Newtonsoft.Json.JsonToken.Undefined">
<summary>
An undefined token.
</summary>
</member>
<member name="F:Newtonsoft.Json.JsonToken.EndObject">
<summary>
An object end token.
</summary>
</member>
<member name="F:Newtonsoft.Json.JsonToken.EndArray">
<summary>
An array end token.
</summary>
</member>
<member name="F:Newtonsoft.Json.JsonToken.EndConstructor">
<summary>
A constructor end token.
</summary>
</member>
<member name="F:Newtonsoft.Json.JsonToken.Date">
<summary>
A Date.
</summary>
</member>
<member name="F:Newtonsoft.Json.JsonToken.Bytes">
<summary>
Byte data.
</summary>
</member>
<member name="T:Newtonsoft.Json.JsonValidatingReader">
<summary>
<para>
Represents a reader that provides <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> validation.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
<member name="E:Newtonsoft.Json.JsonValidatingReader.ValidationEventHandler">
<summary>
Sets an event handler for receiving schema validation errors.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonValidatingReader.Value">
<summary>
Gets the text value of the current JSON token.
</summary>
<value></value>
</member>
<member name="P:Newtonsoft.Json.JsonValidatingReader.Depth">
<summary>
Gets the depth of the current token in the JSON document.
</summary>
<value>The depth of the current token in the JSON document.</value>
</member>
<member name="P:Newtonsoft.Json.JsonValidatingReader.Path">
<summary>
Gets the path of the current JSON token.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonValidatingReader.QuoteChar">
<summary>
Gets the quotation mark character used to enclose the value of a string.
</summary>
<value></value>
</member>
<member name="P:Newtonsoft.Json.JsonValidatingReader.TokenType">
<summary>
Gets the type of the current JSON token.
</summary>
<value></value>
</member>
<member name="P:Newtonsoft.Json.JsonValidatingReader.ValueType">
<summary>
Gets the .NET type for the current JSON token.
</summary>
<value></value>
</member>
<member name="M:Newtonsoft.Json.JsonValidatingReader.#ctor(Newtonsoft.Json.JsonReader)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonValidatingReader"/> class that
validates the content returned from the given <see cref="T:Newtonsoft.Json.JsonReader"/>.
</summary>
<param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from while validating.</param>
</member>
<member name="P:Newtonsoft.Json.JsonValidatingReader.Schema">
<summary>
Gets or sets the schema.
</summary>
<value>The schema.</value>
</member>
<member name="P:Newtonsoft.Json.JsonValidatingReader.Reader">
<summary>
Gets the <see cref="T:Newtonsoft.Json.JsonReader"/> used to construct this <see cref="T:Newtonsoft.Json.JsonValidatingReader"/>.
</summary>
<value>The <see cref="T:Newtonsoft.Json.JsonReader"/> specified in the constructor.</value>
</member>
<member name="M:Newtonsoft.Json.JsonValidatingReader.Close">
<summary>
Changes the reader's state to <see cref="F:Newtonsoft.Json.JsonReader.State.Closed"/>.
If <see cref="P:Newtonsoft.Json.JsonReader.CloseInput"/> is set to <c>true</c>, the underlying <see cref="T:Newtonsoft.Json.JsonReader"/> is also closed.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonValidatingReader.ReadAsInt32">
<summary>
Reads the next JSON token from the underlying <see cref="T:Newtonsoft.Json.JsonReader"/> as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int32"/>.
</summary>
<returns>A <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int32"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonValidatingReader.ReadAsBytes">
<summary>
Reads the next JSON token from the underlying <see cref="T:Newtonsoft.Json.JsonReader"/> as a <see cref="T:System.Byte"/>[].
</summary>
<returns>
A <see cref="T:System.Byte"/>[] or <c>null</c> if the next JSON token is null.
</returns>
</member>
<member name="M:Newtonsoft.Json.JsonValidatingReader.ReadAsDecimal">
<summary>
Reads the next JSON token from the underlying <see cref="T:Newtonsoft.Json.JsonReader"/> as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Decimal"/>.
</summary>
<returns>A <see cref="T:System.Nullable`1"/> of <see cref="T:System.Decimal"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonValidatingReader.ReadAsDouble">
<summary>
Reads the next JSON token from the underlying <see cref="T:Newtonsoft.Json.JsonReader"/> as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Double"/>.
</summary>
<returns>A <see cref="T:System.Nullable`1"/> of <see cref="T:System.Double"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonValidatingReader.ReadAsBoolean">
<summary>
Reads the next JSON token from the underlying <see cref="T:Newtonsoft.Json.JsonReader"/> as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Boolean"/>.
</summary>
<returns>A <see cref="T:System.Nullable`1"/> of <see cref="T:System.Boolean"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonValidatingReader.ReadAsString">
<summary>
Reads the next JSON token from the underlying <see cref="T:Newtonsoft.Json.JsonReader"/> as a <see cref="T:System.String"/>.
</summary>
<returns>A <see cref="T:System.String"/>. This method will return <c>null</c> at the end of an array.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonValidatingReader.ReadAsDateTime">
<summary>
Reads the next JSON token from the underlying <see cref="T:Newtonsoft.Json.JsonReader"/> as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTime"/>.
</summary>
<returns>A <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTime"/>. This method will return <c>null</c> at the end of an array.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonValidatingReader.ReadAsDateTimeOffset">
<summary>
Reads the next JSON token from the underlying <see cref="T:Newtonsoft.Json.JsonReader"/> as a <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTimeOffset"/>.
</summary>
<returns>A <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTimeOffset"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.JsonValidatingReader.Read">
<summary>
Reads the next JSON token from the underlying <see cref="T:Newtonsoft.Json.JsonReader"/>.
</summary>
<returns>
<c>true</c> if the next token was read successfully; <c>false</c> if there are no more tokens to read.
</returns>
</member>
<member name="T:Newtonsoft.Json.JsonWriter">
<summary>
Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.CloseAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously closes this writer.
If <see cref="P:Newtonsoft.Json.JsonWriter.CloseOutput"/> is set to <c>true</c>, the destination is also closed.
</summary>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.FlushAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously flushes whatever is in the buffer to the destination and also flushes the destination.
</summary>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteEndAsync(Newtonsoft.Json.JsonToken,System.Threading.CancellationToken)">
<summary>
Asynchronously writes the specified end token.
</summary>
<param name="token">The end token to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteIndentAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously writes indent characters.
</summary>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValueDelimiterAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously writes the JSON value delimiter.
</summary>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteIndentSpaceAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously writes an indent space.
</summary>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteRawAsync(System.String,System.Threading.CancellationToken)">
<summary>
Asynchronously writes raw JSON without changing the writer's state.
</summary>
<param name="json">The raw JSON to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteEndAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously writes the end of the current JSON object or array.
</summary>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteEndArrayAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously writes the end of an array.
</summary>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteEndConstructorAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously writes the end of a constructor.
</summary>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteEndObjectAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously writes the end of a JSON object.
</summary>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteNullAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously writes a null value.
</summary>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WritePropertyNameAsync(System.String,System.Threading.CancellationToken)">
<summary>
Asynchronously writes the property name of a name/value pair of a JSON object.
</summary>
<param name="name">The name of the property.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WritePropertyNameAsync(System.String,System.Boolean,System.Threading.CancellationToken)">
<summary>
Asynchronously writes the property name of a name/value pair of a JSON object.
</summary>
<param name="name">The name of the property.</param>
<param name="escape">A flag to indicate whether the text should be escaped when it is written as a JSON property name.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteStartArrayAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously writes the beginning of a JSON array.
</summary>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteCommentAsync(System.String,System.Threading.CancellationToken)">
<summary>
Asynchronously writes a comment <c>/*...*/</c> containing the specified text.
</summary>
<param name="text">Text to place inside the comment.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteRawValueAsync(System.String,System.Threading.CancellationToken)">
<summary>
Asynchronously writes raw JSON where a value is expected and updates the writer's state.
</summary>
<param name="json">The raw JSON to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteStartConstructorAsync(System.String,System.Threading.CancellationToken)">
<summary>
Asynchronously writes the start of a constructor with the given name.
</summary>
<param name="name">The name of the constructor.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteStartObjectAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously writes the beginning of a JSON object.
</summary>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteTokenAsync(Newtonsoft.Json.JsonReader,System.Threading.CancellationToken)">
<summary>
Asynchronously writes the current <see cref="T:Newtonsoft.Json.JsonReader"/> token.
</summary>
<param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read the token from.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteTokenAsync(Newtonsoft.Json.JsonReader,System.Boolean,System.Threading.CancellationToken)">
<summary>
Asynchronously writes the current <see cref="T:Newtonsoft.Json.JsonReader"/> token.
</summary>
<param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read the token from.</param>
<param name="writeChildren">A flag indicating whether the current token's children should be written.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteTokenAsync(Newtonsoft.Json.JsonToken,System.Threading.CancellationToken)">
<summary>
Asynchronously writes the <see cref="T:Newtonsoft.Json.JsonToken"/> token and its value.
</summary>
<param name="token">The <see cref="T:Newtonsoft.Json.JsonToken"/> to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteTokenAsync(Newtonsoft.Json.JsonToken,System.Object,System.Threading.CancellationToken)">
<summary>
Asynchronously writes the <see cref="T:Newtonsoft.Json.JsonToken"/> token and its value.
</summary>
<param name="token">The <see cref="T:Newtonsoft.Json.JsonToken"/> to write.</param>
<param name="value">
The value to write.
A value is only required for tokens that have an associated value, e.g. the <see cref="T:System.String"/> property name for <see cref="F:Newtonsoft.Json.JsonToken.PropertyName"/>.
<c>null</c> can be passed to the method for tokens that don't have a value, e.g. <see cref="F:Newtonsoft.Json.JsonToken.StartObject"/>.
</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValueAsync(System.Boolean,System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Boolean"/> value.
</summary>
<param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Boolean"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValueAsync(System.Nullable{System.Boolean},System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Boolean"/> value.
</summary>
<param name="value">The <see cref="T:System.Boolean"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValueAsync(System.Byte,System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Byte"/> value.
</summary>
<param name="value">The <see cref="T:System.Byte"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValueAsync(System.Nullable{System.Byte},System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Byte"/> value.
</summary>
<param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Byte"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValueAsync(System.Byte[],System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Byte"/>[] value.
</summary>
<param name="value">The <see cref="T:System.Byte"/>[] value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValueAsync(System.Char,System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Char"/> value.
</summary>
<param name="value">The <see cref="T:System.Char"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValueAsync(System.Nullable{System.Char},System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Char"/> value.
</summary>
<param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Char"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValueAsync(System.DateTime,System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.DateTime"/> value.
</summary>
<param name="value">The <see cref="T:System.DateTime"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValueAsync(System.Nullable{System.DateTime},System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTime"/> value.
</summary>
<param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTime"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValueAsync(System.DateTimeOffset,System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.DateTimeOffset"/> value.
</summary>
<param name="value">The <see cref="T:System.DateTimeOffset"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValueAsync(System.Nullable{System.DateTimeOffset},System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTimeOffset"/> value.
</summary>
<param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTimeOffset"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValueAsync(System.Decimal,System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Decimal"/> value.
</summary>
<param name="value">The <see cref="T:System.Decimal"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValueAsync(System.Nullable{System.Decimal},System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Decimal"/> value.
</summary>
<param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Decimal"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValueAsync(System.Double,System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Double"/> value.
</summary>
<param name="value">The <see cref="T:System.Double"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValueAsync(System.Nullable{System.Double},System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Double"/> value.
</summary>
<param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Double"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValueAsync(System.Single,System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Single"/> value.
</summary>
<param name="value">The <see cref="T:System.Single"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValueAsync(System.Nullable{System.Single},System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Single"/> value.
</summary>
<param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Single"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValueAsync(System.Guid,System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Guid"/> value.
</summary>
<param name="value">The <see cref="T:System.Guid"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValueAsync(System.Nullable{System.Guid},System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Guid"/> value.
</summary>
<param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Guid"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValueAsync(System.Int32,System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Int32"/> value.
</summary>
<param name="value">The <see cref="T:System.Int32"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValueAsync(System.Nullable{System.Int32},System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int32"/> value.
</summary>
<param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int32"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValueAsync(System.Int64,System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Int64"/> value.
</summary>
<param name="value">The <see cref="T:System.Int64"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValueAsync(System.Nullable{System.Int64},System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int64"/> value.
</summary>
<param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int64"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValueAsync(System.Object,System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Object"/> value.
</summary>
<param name="value">The <see cref="T:System.Object"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValueAsync(System.SByte,System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.SByte"/> value.
</summary>
<param name="value">The <see cref="T:System.SByte"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValueAsync(System.Nullable{System.SByte},System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.SByte"/> value.
</summary>
<param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.SByte"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValueAsync(System.Int16,System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Int16"/> value.
</summary>
<param name="value">The <see cref="T:System.Int16"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValueAsync(System.Nullable{System.Int16},System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int16"/> value.
</summary>
<param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int16"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValueAsync(System.String,System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.String"/> value.
</summary>
<param name="value">The <see cref="T:System.String"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValueAsync(System.TimeSpan,System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.TimeSpan"/> value.
</summary>
<param name="value">The <see cref="T:System.TimeSpan"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValueAsync(System.Nullable{System.TimeSpan},System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.TimeSpan"/> value.
</summary>
<param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.TimeSpan"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValueAsync(System.UInt32,System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.UInt32"/> value.
</summary>
<param name="value">The <see cref="T:System.UInt32"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValueAsync(System.Nullable{System.UInt32},System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.UInt32"/> value.
</summary>
<param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.UInt32"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValueAsync(System.UInt64,System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.UInt64"/> value.
</summary>
<param name="value">The <see cref="T:System.UInt64"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValueAsync(System.Nullable{System.UInt64},System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.UInt64"/> value.
</summary>
<param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.UInt64"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValueAsync(System.Uri,System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Uri"/> value.
</summary>
<param name="value">The <see cref="T:System.Uri"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValueAsync(System.UInt16,System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.UInt16"/> value.
</summary>
<param name="value">The <see cref="T:System.UInt16"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValueAsync(System.Nullable{System.UInt16},System.Threading.CancellationToken)">
<summary>
Asynchronously writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.UInt16"/> value.
</summary>
<param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.UInt16"/> value to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteUndefinedAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously writes an undefined value.
</summary>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteWhitespaceAsync(System.String,System.Threading.CancellationToken)">
<summary>
Asynchronously writes the given white space.
</summary>
<param name="ws">The string of white space characters.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.SetWriteStateAsync(Newtonsoft.Json.JsonToken,System.Object,System.Threading.CancellationToken)">
<summary>
Asynchronously ets the state of the <see cref="T:Newtonsoft.Json.JsonWriter"/>.
</summary>
<param name="token">The <see cref="T:Newtonsoft.Json.JsonToken"/> being written.</param>
<param name="value">The value being written.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derived
classes can override this behaviour for true asynchronicity.</remarks>
</member>
<member name="P:Newtonsoft.Json.JsonWriter.CloseOutput">
<summary>
Gets or sets a value indicating whether the destination should be closed when this writer is closed.
</summary>
<value>
<c>true</c> to close the destination when this writer is closed; otherwise <c>false</c>. The default is <c>true</c>.
</value>
</member>
<member name="P:Newtonsoft.Json.JsonWriter.AutoCompleteOnClose">
<summary>
Gets or sets a value indicating whether the JSON should be auto-completed when this writer is closed.
</summary>
<value>
<c>true</c> to auto-complete the JSON when this writer is closed; otherwise <c>false</c>. The default is <c>true</c>.
</value>
</member>
<member name="P:Newtonsoft.Json.JsonWriter.Top">
<summary>
Gets the top.
</summary>
<value>The top.</value>
</member>
<member name="P:Newtonsoft.Json.JsonWriter.WriteState">
<summary>
Gets the state of the writer.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonWriter.Path">
<summary>
Gets the path of the writer.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonWriter.Formatting">
<summary>
Gets or sets a value indicating how JSON text output should be formatted.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonWriter.DateFormatHandling">
<summary>
Gets or sets how dates are written to JSON text.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonWriter.DateTimeZoneHandling">
<summary>
Gets or sets how <see cref="T:System.DateTime"/> time zones are handled when writing JSON text.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonWriter.StringEscapeHandling">
<summary>
Gets or sets how strings are escaped when writing JSON text.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonWriter.FloatFormatHandling">
<summary>
Gets or sets how special floating point numbers, e.g. <see cref="F:System.Double.NaN"/>,
<see cref="F:System.Double.PositiveInfinity"/> and <see cref="F:System.Double.NegativeInfinity"/>,
are written to JSON text.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonWriter.DateFormatString">
<summary>
Gets or sets how <see cref="T:System.DateTime"/> and <see cref="T:System.DateTimeOffset"/> values are formatted when writing JSON text.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonWriter.Culture">
<summary>
Gets or sets the culture used when writing JSON. Defaults to <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonWriter"/> class.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.Flush">
<summary>
Flushes whatever is in the buffer to the destination and also flushes the destination.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.Close">
<summary>
Closes this writer.
If <see cref="P:Newtonsoft.Json.JsonWriter.CloseOutput"/> is set to <c>true</c>, the destination is also closed.
If <see cref="P:Newtonsoft.Json.JsonWriter.AutoCompleteOnClose"/> is set to <c>true</c>, the JSON is auto-completed.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteStartObject">
<summary>
Writes the beginning of a JSON object.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteEndObject">
<summary>
Writes the end of a JSON object.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteStartArray">
<summary>
Writes the beginning of a JSON array.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteEndArray">
<summary>
Writes the end of an array.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteStartConstructor(System.String)">
<summary>
Writes the start of a constructor with the given name.
</summary>
<param name="name">The name of the constructor.</param>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteEndConstructor">
<summary>
Writes the end constructor.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WritePropertyName(System.String)">
<summary>
Writes the property name of a name/value pair of a JSON object.
</summary>
<param name="name">The name of the property.</param>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WritePropertyName(System.String,System.Boolean)">
<summary>
Writes the property name of a name/value pair of a JSON object.
</summary>
<param name="name">The name of the property.</param>
<param name="escape">A flag to indicate whether the text should be escaped when it is written as a JSON property name.</param>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteEnd">
<summary>
Writes the end of the current JSON object or array.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteToken(Newtonsoft.Json.JsonReader)">
<summary>
Writes the current <see cref="T:Newtonsoft.Json.JsonReader"/> token and its children.
</summary>
<param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read the token from.</param>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteToken(Newtonsoft.Json.JsonReader,System.Boolean)">
<summary>
Writes the current <see cref="T:Newtonsoft.Json.JsonReader"/> token.
</summary>
<param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read the token from.</param>
<param name="writeChildren">A flag indicating whether the current token's children should be written.</param>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteToken(Newtonsoft.Json.JsonToken,System.Object)">
<summary>
Writes the <see cref="T:Newtonsoft.Json.JsonToken"/> token and its value.
</summary>
<param name="token">The <see cref="T:Newtonsoft.Json.JsonToken"/> to write.</param>
<param name="value">
The value to write.
A value is only required for tokens that have an associated value, e.g. the <see cref="T:System.String"/> property name for <see cref="F:Newtonsoft.Json.JsonToken.PropertyName"/>.
<c>null</c> can be passed to the method for tokens that don't have a value, e.g. <see cref="F:Newtonsoft.Json.JsonToken.StartObject"/>.
</param>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteToken(Newtonsoft.Json.JsonToken)">
<summary>
Writes the <see cref="T:Newtonsoft.Json.JsonToken"/> token.
</summary>
<param name="token">The <see cref="T:Newtonsoft.Json.JsonToken"/> to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteEnd(Newtonsoft.Json.JsonToken)">
<summary>
Writes the specified end token.
</summary>
<param name="token">The end token to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteIndent">
<summary>
Writes indent characters.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValueDelimiter">
<summary>
Writes the JSON value delimiter.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteIndentSpace">
<summary>
Writes an indent space.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteNull">
<summary>
Writes a null value.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteUndefined">
<summary>
Writes an undefined value.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteRaw(System.String)">
<summary>
Writes raw JSON without changing the writer's state.
</summary>
<param name="json">The raw JSON to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteRawValue(System.String)">
<summary>
Writes raw JSON where a value is expected and updates the writer's state.
</summary>
<param name="json">The raw JSON to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.String)">
<summary>
Writes a <see cref="T:System.String"/> value.
</summary>
<param name="value">The <see cref="T:System.String"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Int32)">
<summary>
Writes a <see cref="T:System.Int32"/> value.
</summary>
<param name="value">The <see cref="T:System.Int32"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.UInt32)">
<summary>
Writes a <see cref="T:System.UInt32"/> value.
</summary>
<param name="value">The <see cref="T:System.UInt32"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Int64)">
<summary>
Writes a <see cref="T:System.Int64"/> value.
</summary>
<param name="value">The <see cref="T:System.Int64"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.UInt64)">
<summary>
Writes a <see cref="T:System.UInt64"/> value.
</summary>
<param name="value">The <see cref="T:System.UInt64"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Single)">
<summary>
Writes a <see cref="T:System.Single"/> value.
</summary>
<param name="value">The <see cref="T:System.Single"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Double)">
<summary>
Writes a <see cref="T:System.Double"/> value.
</summary>
<param name="value">The <see cref="T:System.Double"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Boolean)">
<summary>
Writes a <see cref="T:System.Boolean"/> value.
</summary>
<param name="value">The <see cref="T:System.Boolean"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Int16)">
<summary>
Writes a <see cref="T:System.Int16"/> value.
</summary>
<param name="value">The <see cref="T:System.Int16"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.UInt16)">
<summary>
Writes a <see cref="T:System.UInt16"/> value.
</summary>
<param name="value">The <see cref="T:System.UInt16"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Char)">
<summary>
Writes a <see cref="T:System.Char"/> value.
</summary>
<param name="value">The <see cref="T:System.Char"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Byte)">
<summary>
Writes a <see cref="T:System.Byte"/> value.
</summary>
<param name="value">The <see cref="T:System.Byte"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.SByte)">
<summary>
Writes a <see cref="T:System.SByte"/> value.
</summary>
<param name="value">The <see cref="T:System.SByte"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Decimal)">
<summary>
Writes a <see cref="T:System.Decimal"/> value.
</summary>
<param name="value">The <see cref="T:System.Decimal"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.DateTime)">
<summary>
Writes a <see cref="T:System.DateTime"/> value.
</summary>
<param name="value">The <see cref="T:System.DateTime"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.DateTimeOffset)">
<summary>
Writes a <see cref="T:System.DateTimeOffset"/> value.
</summary>
<param name="value">The <see cref="T:System.DateTimeOffset"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Guid)">
<summary>
Writes a <see cref="T:System.Guid"/> value.
</summary>
<param name="value">The <see cref="T:System.Guid"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.TimeSpan)">
<summary>
Writes a <see cref="T:System.TimeSpan"/> value.
</summary>
<param name="value">The <see cref="T:System.TimeSpan"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Nullable{System.Int32})">
<summary>
Writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int32"/> value.
</summary>
<param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int32"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Nullable{System.UInt32})">
<summary>
Writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.UInt32"/> value.
</summary>
<param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.UInt32"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Nullable{System.Int64})">
<summary>
Writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int64"/> value.
</summary>
<param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int64"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Nullable{System.UInt64})">
<summary>
Writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.UInt64"/> value.
</summary>
<param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.UInt64"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Nullable{System.Single})">
<summary>
Writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Single"/> value.
</summary>
<param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Single"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Nullable{System.Double})">
<summary>
Writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Double"/> value.
</summary>
<param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Double"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Nullable{System.Boolean})">
<summary>
Writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Boolean"/> value.
</summary>
<param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Boolean"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Nullable{System.Int16})">
<summary>
Writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int16"/> value.
</summary>
<param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int16"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Nullable{System.UInt16})">
<summary>
Writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.UInt16"/> value.
</summary>
<param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.UInt16"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Nullable{System.Char})">
<summary>
Writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Char"/> value.
</summary>
<param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Char"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Nullable{System.Byte})">
<summary>
Writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Byte"/> value.
</summary>
<param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Byte"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Nullable{System.SByte})">
<summary>
Writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.SByte"/> value.
</summary>
<param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.SByte"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Nullable{System.Decimal})">
<summary>
Writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Decimal"/> value.
</summary>
<param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Decimal"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Nullable{System.DateTime})">
<summary>
Writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTime"/> value.
</summary>
<param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTime"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Nullable{System.DateTimeOffset})">
<summary>
Writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTimeOffset"/> value.
</summary>
<param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTimeOffset"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Nullable{System.Guid})">
<summary>
Writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.Guid"/> value.
</summary>
<param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.Guid"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Nullable{System.TimeSpan})">
<summary>
Writes a <see cref="T:System.Nullable`1"/> of <see cref="T:System.TimeSpan"/> value.
</summary>
<param name="value">The <see cref="T:System.Nullable`1"/> of <see cref="T:System.TimeSpan"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Byte[])">
<summary>
Writes a <see cref="T:System.Byte"/>[] value.
</summary>
<param name="value">The <see cref="T:System.Byte"/>[] value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Uri)">
<summary>
Writes a <see cref="T:System.Uri"/> value.
</summary>
<param name="value">The <see cref="T:System.Uri"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Object)">
<summary>
Writes a <see cref="T:System.Object"/> value.
An error will raised if the value cannot be written as a single JSON token.
</summary>
<param name="value">The <see cref="T:System.Object"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteComment(System.String)">
<summary>
Writes a comment <c>/*...*/</c> containing the specified text.
</summary>
<param name="text">Text to place inside the comment.</param>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.WriteWhitespace(System.String)">
<summary>
Writes the given white space.
</summary>
<param name="ws">The string of white space characters.</param>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.Dispose(System.Boolean)">
<summary>
Releases unmanaged and - optionally - managed resources.
</summary>
<param name="disposing"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
</member>
<member name="M:Newtonsoft.Json.JsonWriter.SetWriteState(Newtonsoft.Json.JsonToken,System.Object)">
<summary>
Sets the state of the <see cref="T:Newtonsoft.Json.JsonWriter"/>.
</summary>
<param name="token">The <see cref="T:Newtonsoft.Json.JsonToken"/> being written.</param>
<param name="value">The value being written.</param>
</member>
<member name="T:Newtonsoft.Json.JsonWriterException">
<summary>
The exception thrown when an error occurs while writing JSON text.
</summary>
</member>
<member name="P:Newtonsoft.Json.JsonWriterException.Path">
<summary>
Gets the path to the JSON where the error occurred.
</summary>
<value>The path to the JSON where the error occurred.</value>
</member>
<member name="M:Newtonsoft.Json.JsonWriterException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonWriterException"/> class.
</summary>
</member>
<member name="M:Newtonsoft.Json.JsonWriterException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonWriterException"/> class
with a specified error message.
</summary>
<param name="message">The error message that explains the reason for the exception.</param>
</member>
<member name="M:Newtonsoft.Json.JsonWriterException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonWriterException"/> class
with a specified error message and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">The error message that explains the reason for the exception.</param>
<param name="innerException">The exception that is the cause of the current exception, or <c>null</c> if no inner exception is specified.</param>
</member>
<member name="M:Newtonsoft.Json.JsonWriterException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonWriterException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <c>null</c>.</exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <c>null</c> or <see cref="P:System.Exception.HResult"/> is zero (0).</exception>
</member>
<member name="M:Newtonsoft.Json.JsonWriterException.#ctor(System.String,System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonWriterException"/> class
with a specified error message, JSON path and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">The error message that explains the reason for the exception.</param>
<param name="path">The path to the JSON where the error occurred.</param>
<param name="innerException">The exception that is the cause of the current exception, or <c>null</c> if no inner exception is specified.</param>
</member>
<member name="T:Newtonsoft.Json.Linq.CommentHandling">
<summary>
Specifies how JSON comments are handled when loading JSON.
</summary>
</member>
<member name="F:Newtonsoft.Json.Linq.CommentHandling.Ignore">
<summary>
Ignore comments.
</summary>
</member>
<member name="F:Newtonsoft.Json.Linq.CommentHandling.Load">
<summary>
Load comments as a <see cref="T:Newtonsoft.Json.Linq.JValue"/> with type <see cref="F:Newtonsoft.Json.Linq.JTokenType.Comment"/>.
</summary>
</member>
<member name="T:Newtonsoft.Json.Linq.DuplicatePropertyNameHandling">
<summary>
Specifies how duplicate property names are handled when loading JSON.
</summary>
</member>
<member name="F:Newtonsoft.Json.Linq.DuplicatePropertyNameHandling.Replace">
<summary>
Replace the existing value when there is a duplicate property. The value of the last property in the JSON object will be used.
</summary>
</member>
<member name="F:Newtonsoft.Json.Linq.DuplicatePropertyNameHandling.Ignore">
<summary>
Ignore the new value when there is a duplicate property. The value of the first property in the JSON object will be used.
</summary>
</member>
<member name="F:Newtonsoft.Json.Linq.DuplicatePropertyNameHandling.Error">
<summary>
Throw a <see cref="T:Newtonsoft.Json.JsonReaderException"/> when a duplicate property is encountered.
</summary>
</member>
<member name="T:Newtonsoft.Json.Linq.Extensions">
<summary>
Contains the LINQ to JSON extension methods.
</summary>
</member>
<member name="M:Newtonsoft.Json.Linq.Extensions.Ancestors``1(System.Collections.Generic.IEnumerable{``0})">
<summary>
Returns a collection of tokens that contains the ancestors of every token in the source collection.
</summary>
<typeparam name="T">The type of the objects in source, constrained to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</typeparam>
<param name="source">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the source collection.</param>
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the ancestors of every token in the source collection.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.Extensions.AncestorsAndSelf``1(System.Collections.Generic.IEnumerable{``0})">
<summary>
Returns a collection of tokens that contains every token in the source collection, and the ancestors of every token in the source collection.
</summary>
<typeparam name="T">The type of the objects in source, constrained to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</typeparam>
<param name="source">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the source collection.</param>
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains every token in the source collection, the ancestors of every token in the source collection.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.Extensions.Descendants``1(System.Collections.Generic.IEnumerable{``0})">
<summary>
Returns a collection of tokens that contains the descendants of every token in the source collection.
</summary>
<typeparam name="T">The type of the objects in source, constrained to <see cref="T:Newtonsoft.Json.Linq.JContainer"/>.</typeparam>
<param name="source">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the source collection.</param>
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the descendants of every token in the source collection.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.Extensions.DescendantsAndSelf``1(System.Collections.Generic.IEnumerable{``0})">
<summary>
Returns a collection of tokens that contains every token in the source collection, and the descendants of every token in the source collection.
</summary>
<typeparam name="T">The type of the objects in source, constrained to <see cref="T:Newtonsoft.Json.Linq.JContainer"/>.</typeparam>
<param name="source">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the source collection.</param>
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains every token in the source collection, and the descendants of every token in the source collection.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.Extensions.Properties(System.Collections.Generic.IEnumerable{Newtonsoft.Json.Linq.JObject})">
<summary>
Returns a collection of child properties of every object in the source collection.
</summary>
<param name="source">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JObject"/> that contains the source collection.</param>
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JProperty"/> that contains the properties of every object in the source collection.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.Extensions.Values(System.Collections.Generic.IEnumerable{Newtonsoft.Json.Linq.JToken},System.Object)">
<summary>
Returns a collection of child values of every object in the source collection with the given key.
</summary>
<param name="source">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the source collection.</param>
<param name="key">The token key.</param>
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the values of every token in the source collection with the given key.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.Extensions.Values(System.Collections.Generic.IEnumerable{Newtonsoft.Json.Linq.JToken})">
<summary>
Returns a collection of child values of every object in the source collection.
</summary>
<param name="source">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the source collection.</param>
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the values of every token in the source collection.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.Extensions.Values``1(System.Collections.Generic.IEnumerable{Newtonsoft.Json.Linq.JToken},System.Object)">
<summary>
Returns a collection of converted child values of every object in the source collection with the given key.
</summary>
<typeparam name="U">The type to convert the values to.</typeparam>
<param name="source">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the source collection.</param>
<param name="key">The token key.</param>
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> that contains the converted values of every token in the source collection with the given key.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.Extensions.Values``1(System.Collections.Generic.IEnumerable{Newtonsoft.Json.Linq.JToken})">
<summary>
Returns a collection of converted child values of every object in the source collection.
</summary>
<typeparam name="U">The type to convert the values to.</typeparam>
<param name="source">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the source collection.</param>
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> that contains the converted values of every token in the source collection.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.Extensions.Value``1(System.Collections.Generic.IEnumerable{Newtonsoft.Json.Linq.JToken})">
<summary>
Converts the value.
</summary>
<typeparam name="U">The type to convert the value to.</typeparam>
<param name="value">A <see cref="T:Newtonsoft.Json.Linq.JToken"/> cast as a <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</param>
<returns>A converted value.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.Extensions.Value``2(System.Collections.Generic.IEnumerable{``0})">
<summary>
Converts the value.
</summary>
<typeparam name="T">The source collection type.</typeparam>
<typeparam name="U">The type to convert the value to.</typeparam>
<param name="value">A <see cref="T:Newtonsoft.Json.Linq.JToken"/> cast as a <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</param>
<returns>A converted value.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.Extensions.Children``1(System.Collections.Generic.IEnumerable{``0})">
<summary>
Returns a collection of child tokens of every array in the source collection.
</summary>
<typeparam name="T">The source collection type.</typeparam>
<param name="source">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the source collection.</param>
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the values of every token in the source collection.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.Extensions.Children``2(System.Collections.Generic.IEnumerable{``0})">
<summary>
Returns a collection of converted child tokens of every array in the source collection.
</summary>
<param name="source">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the source collection.</param>
<typeparam name="U">The type to convert the values to.</typeparam>
<typeparam name="T">The source collection type.</typeparam>
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> that contains the converted values of every token in the source collection.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.Extensions.AsJEnumerable(System.Collections.Generic.IEnumerable{Newtonsoft.Json.Linq.JToken})">
<summary>
Returns the input typed as <see cref="T:Newtonsoft.Json.Linq.IJEnumerable`1"/>.
</summary>
<param name="source">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the source collection.</param>
<returns>The input typed as <see cref="T:Newtonsoft.Json.Linq.IJEnumerable`1"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.Extensions.AsJEnumerable``1(System.Collections.Generic.IEnumerable{``0})">
<summary>
Returns the input typed as <see cref="T:Newtonsoft.Json.Linq.IJEnumerable`1"/>.
</summary>
<typeparam name="T">The source collection type.</typeparam>
<param name="source">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the source collection.</param>
<returns>The input typed as <see cref="T:Newtonsoft.Json.Linq.IJEnumerable`1"/>.</returns>
</member>
<member name="T:Newtonsoft.Json.Linq.IJEnumerable`1">
<summary>
Represents a collection of <see cref="T:Newtonsoft.Json.Linq.JToken"/> objects.
</summary>
<typeparam name="T">The type of token.</typeparam>
</member>
<member name="P:Newtonsoft.Json.Linq.IJEnumerable`1.Item(System.Object)">
<summary>
Gets the <see cref="T:Newtonsoft.Json.Linq.IJEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> with the specified key.
</summary>
<value></value>
</member>
<member name="T:Newtonsoft.Json.Linq.JArray">
<summary>
Represents a JSON array.
</summary>
<example>
<code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\LinqToJsonTests.cs" region="LinqToJsonCreateParseArray" title="Parsing a JSON Array from Text" />
</example>
</member>
<member name="M:Newtonsoft.Json.Linq.JArray.WriteToAsync(Newtonsoft.Json.JsonWriter,System.Threading.CancellationToken,Newtonsoft.Json.JsonConverter[])">
<summary>
Writes this token to a <see cref="T:Newtonsoft.Json.JsonWriter"/> asynchronously.
</summary>
<param name="writer">A <see cref="T:Newtonsoft.Json.JsonWriter"/> into which this method will write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
<param name="converters">A collection of <see cref="T:Newtonsoft.Json.JsonConverter"/> which will be used when writing the token.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous write operation.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JArray.LoadAsync(Newtonsoft.Json.JsonReader,System.Threading.CancellationToken)">
<summary>
Asynchronously loads a <see cref="T:Newtonsoft.Json.Linq.JArray"/> from a <see cref="T:Newtonsoft.Json.JsonReader"/>.
</summary>
<param name="reader">A <see cref="T:Newtonsoft.Json.JsonReader"/> that will be read for the content of the <see cref="T:Newtonsoft.Json.Linq.JArray"/>.
If this is <c>null</c>, default load settings will be used.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task`1"/> representing the asynchronous load. The <see cref="P:System.Threading.Tasks.Task`1.Result"/> property contains the JSON that was read from the specified <see cref="T:Newtonsoft.Json.JsonReader"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JArray.LoadAsync(Newtonsoft.Json.JsonReader,Newtonsoft.Json.Linq.JsonLoadSettings,System.Threading.CancellationToken)">
<summary>
Asynchronously loads a <see cref="T:Newtonsoft.Json.Linq.JArray"/> from a <see cref="T:Newtonsoft.Json.JsonReader"/>.
</summary>
<param name="reader">A <see cref="T:Newtonsoft.Json.JsonReader"/> that will be read for the content of the <see cref="T:Newtonsoft.Json.Linq.JArray"/>.</param>
<param name="settings">The <see cref="T:Newtonsoft.Json.Linq.JsonLoadSettings"/> used to load the JSON.
If this is <c>null</c>, default load settings will be used.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task`1"/> representing the asynchronous load. The <see cref="P:System.Threading.Tasks.Task`1.Result"/> property contains the JSON that was read from the specified <see cref="T:Newtonsoft.Json.JsonReader"/>.</returns>
</member>
<member name="P:Newtonsoft.Json.Linq.JArray.ChildrenTokens">
<summary>
Gets the container's children tokens.
</summary>
<value>The container's children tokens.</value>
</member>
<member name="P:Newtonsoft.Json.Linq.JArray.Type">
<summary>
Gets the node type for this <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<value>The type.</value>
</member>
<member name="M:Newtonsoft.Json.Linq.JArray.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JArray"/> class.
</summary>
</member>
<member name="M:Newtonsoft.Json.Linq.JArray.#ctor(Newtonsoft.Json.Linq.JArray)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JArray"/> class from another <see cref="T:Newtonsoft.Json.Linq.JArray"/> object.
</summary>
<param name="other">A <see cref="T:Newtonsoft.Json.Linq.JArray"/> object to copy from.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JArray.#ctor(System.Object[])">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JArray"/> class with the specified content.
</summary>
<param name="content">The contents of the array.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JArray.#ctor(System.Object)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JArray"/> class with the specified content.
</summary>
<param name="content">The contents of the array.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JArray.Load(Newtonsoft.Json.JsonReader)">
<summary>
Loads an <see cref="T:Newtonsoft.Json.Linq.JArray"/> from a <see cref="T:Newtonsoft.Json.JsonReader"/>.
</summary>
<param name="reader">A <see cref="T:Newtonsoft.Json.JsonReader"/> that will be read for the content of the <see cref="T:Newtonsoft.Json.Linq.JArray"/>.</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JArray"/> that contains the JSON that was read from the specified <see cref="T:Newtonsoft.Json.JsonReader"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JArray.Load(Newtonsoft.Json.JsonReader,Newtonsoft.Json.Linq.JsonLoadSettings)">
<summary>
Loads an <see cref="T:Newtonsoft.Json.Linq.JArray"/> from a <see cref="T:Newtonsoft.Json.JsonReader"/>.
</summary>
<param name="reader">A <see cref="T:Newtonsoft.Json.JsonReader"/> that will be read for the content of the <see cref="T:Newtonsoft.Json.Linq.JArray"/>.</param>
<param name="settings">The <see cref="T:Newtonsoft.Json.Linq.JsonLoadSettings"/> used to load the JSON.
If this is <c>null</c>, default load settings will be used.</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JArray"/> that contains the JSON that was read from the specified <see cref="T:Newtonsoft.Json.JsonReader"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JArray.Parse(System.String)">
<summary>
Load a <see cref="T:Newtonsoft.Json.Linq.JArray"/> from a string that contains JSON.
</summary>
<param name="json">A <see cref="T:System.String"/> that contains JSON.</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JArray"/> populated from the string that contains JSON.</returns>
<example>
<code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\LinqToJsonTests.cs" region="LinqToJsonCreateParseArray" title="Parsing a JSON Array from Text" />
</example>
</member>
<member name="M:Newtonsoft.Json.Linq.JArray.Parse(System.String,Newtonsoft.Json.Linq.JsonLoadSettings)">
<summary>
Load a <see cref="T:Newtonsoft.Json.Linq.JArray"/> from a string that contains JSON.
</summary>
<param name="json">A <see cref="T:System.String"/> that contains JSON.</param>
<param name="settings">The <see cref="T:Newtonsoft.Json.Linq.JsonLoadSettings"/> used to load the JSON.
If this is <c>null</c>, default load settings will be used.</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JArray"/> populated from the string that contains JSON.</returns>
<example>
<code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\LinqToJsonTests.cs" region="LinqToJsonCreateParseArray" title="Parsing a JSON Array from Text" />
</example>
</member>
<member name="M:Newtonsoft.Json.Linq.JArray.FromObject(System.Object)">
<summary>
Creates a <see cref="T:Newtonsoft.Json.Linq.JArray"/> from an object.
</summary>
<param name="o">The object that will be used to create <see cref="T:Newtonsoft.Json.Linq.JArray"/>.</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JArray"/> with the values of the specified object.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JArray.FromObject(System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Creates a <see cref="T:Newtonsoft.Json.Linq.JArray"/> from an object.
</summary>
<param name="o">The object that will be used to create <see cref="T:Newtonsoft.Json.Linq.JArray"/>.</param>
<param name="jsonSerializer">The <see cref="T:Newtonsoft.Json.JsonSerializer"/> that will be used to read the object.</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JArray"/> with the values of the specified object.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JArray.WriteTo(Newtonsoft.Json.JsonWriter,Newtonsoft.Json.JsonConverter[])">
<summary>
Writes this token to a <see cref="T:Newtonsoft.Json.JsonWriter"/>.
</summary>
<param name="writer">A <see cref="T:Newtonsoft.Json.JsonWriter"/> into which this method will write.</param>
<param name="converters">A collection of <see cref="T:Newtonsoft.Json.JsonConverter"/> which will be used when writing the token.</param>
</member>
<member name="P:Newtonsoft.Json.Linq.JArray.Item(System.Object)">
<summary>
Gets the <see cref="T:Newtonsoft.Json.Linq.JToken"/> with the specified key.
</summary>
<value>The <see cref="T:Newtonsoft.Json.Linq.JToken"/> with the specified key.</value>
</member>
<member name="P:Newtonsoft.Json.Linq.JArray.Item(System.Int32)">
<summary>
Gets or sets the <see cref="T:Newtonsoft.Json.Linq.JToken"/> at the specified index.
</summary>
<value></value>
</member>
<member name="M:Newtonsoft.Json.Linq.JArray.IndexOf(Newtonsoft.Json.Linq.JToken)">
<summary>
Determines the index of a specific item in the <see cref="T:Newtonsoft.Json.Linq.JArray"/>.
</summary>
<param name="item">The object to locate in the <see cref="T:Newtonsoft.Json.Linq.JArray"/>.</param>
<returns>
The index of <paramref name="item"/> if found in the list; otherwise, -1.
</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JArray.Insert(System.Int32,Newtonsoft.Json.Linq.JToken)">
<summary>
Inserts an item to the <see cref="T:Newtonsoft.Json.Linq.JArray"/> at the specified index.
</summary>
<param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
<param name="item">The object to insert into the <see cref="T:Newtonsoft.Json.Linq.JArray"/>.</param>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="index"/> is not a valid index in the <see cref="T:Newtonsoft.Json.Linq.JArray"/>.
</exception>
</member>
<member name="M:Newtonsoft.Json.Linq.JArray.RemoveAt(System.Int32)">
<summary>
Removes the <see cref="T:Newtonsoft.Json.Linq.JArray"/> item at the specified index.
</summary>
<param name="index">The zero-based index of the item to remove.</param>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="index"/> is not a valid index in the <see cref="T:Newtonsoft.Json.Linq.JArray"/>.
</exception>
</member>
<member name="M:Newtonsoft.Json.Linq.JArray.GetEnumerator">
<summary>
Returns an enumerator that iterates through the collection.
</summary>
<returns>
A <see cref="T:System.Collections.Generic.IEnumerator`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that can be used to iterate through the collection.
</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JArray.Add(Newtonsoft.Json.Linq.JToken)">
<summary>
Adds an item to the <see cref="T:Newtonsoft.Json.Linq.JArray"/>.
</summary>
<param name="item">The object to add to the <see cref="T:Newtonsoft.Json.Linq.JArray"/>.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JArray.Clear">
<summary>
Removes all items from the <see cref="T:Newtonsoft.Json.Linq.JArray"/>.
</summary>
</member>
<member name="M:Newtonsoft.Json.Linq.JArray.Contains(Newtonsoft.Json.Linq.JToken)">
<summary>
Determines whether the <see cref="T:Newtonsoft.Json.Linq.JArray"/> contains a specific value.
</summary>
<param name="item">The object to locate in the <see cref="T:Newtonsoft.Json.Linq.JArray"/>.</param>
<returns>
<c>true</c> if <paramref name="item"/> is found in the <see cref="T:Newtonsoft.Json.Linq.JArray"/>; otherwise, <c>false</c>.
</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JArray.CopyTo(Newtonsoft.Json.Linq.JToken[],System.Int32)">
<summary>
Copies the elements of the <see cref="T:Newtonsoft.Json.Linq.JArray"/> to an array, starting at a particular array index.
</summary>
<param name="array">The array.</param>
<param name="arrayIndex">Index of the array.</param>
</member>
<member name="P:Newtonsoft.Json.Linq.JArray.IsReadOnly">
<summary>
Gets a value indicating whether the <see cref="T:Newtonsoft.Json.Linq.JArray"/> is read-only.
</summary>
<returns><c>true</c> if the <see cref="T:Newtonsoft.Json.Linq.JArray"/> is read-only; otherwise, <c>false</c>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JArray.Remove(Newtonsoft.Json.Linq.JToken)">
<summary>
Removes the first occurrence of a specific object from the <see cref="T:Newtonsoft.Json.Linq.JArray"/>.
</summary>
<param name="item">The object to remove from the <see cref="T:Newtonsoft.Json.Linq.JArray"/>.</param>
<returns>
<c>true</c> if <paramref name="item"/> was successfully removed from the <see cref="T:Newtonsoft.Json.Linq.JArray"/>; otherwise, <c>false</c>. This method also returns <c>false</c> if <paramref name="item"/> is not found in the original <see cref="T:Newtonsoft.Json.Linq.JArray"/>.
</returns>
</member>
<member name="T:Newtonsoft.Json.Linq.JConstructor">
<summary>
Represents a JSON constructor.
</summary>
</member>
<member name="M:Newtonsoft.Json.Linq.JConstructor.WriteToAsync(Newtonsoft.Json.JsonWriter,System.Threading.CancellationToken,Newtonsoft.Json.JsonConverter[])">
<summary>
Writes this token to a <see cref="T:Newtonsoft.Json.JsonWriter"/> asynchronously.
</summary>
<param name="writer">A <see cref="T:Newtonsoft.Json.JsonWriter"/> into which this method will write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
<param name="converters">A collection of <see cref="T:Newtonsoft.Json.JsonConverter"/> which will be used when writing the token.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous write operation.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JConstructor.LoadAsync(Newtonsoft.Json.JsonReader,System.Threading.CancellationToken)">
<summary>
Asynchronously loads a <see cref="T:Newtonsoft.Json.Linq.JConstructor"/> from a <see cref="T:Newtonsoft.Json.JsonReader"/>.
</summary>
<param name="reader">A <see cref="T:Newtonsoft.Json.JsonReader"/> that will be read for the content of the <see cref="T:Newtonsoft.Json.Linq.JConstructor"/>.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>
A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous load. The <see cref="P:System.Threading.Tasks.Task`1.Result"/>
property returns a <see cref="T:Newtonsoft.Json.Linq.JConstructor"/> that contains the JSON that was read from the specified <see cref="T:Newtonsoft.Json.JsonReader"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JConstructor.LoadAsync(Newtonsoft.Json.JsonReader,Newtonsoft.Json.Linq.JsonLoadSettings,System.Threading.CancellationToken)">
<summary>
Asynchronously loads a <see cref="T:Newtonsoft.Json.Linq.JConstructor"/> from a <see cref="T:Newtonsoft.Json.JsonReader"/>.
</summary>
<param name="reader">A <see cref="T:Newtonsoft.Json.JsonReader"/> that will be read for the content of the <see cref="T:Newtonsoft.Json.Linq.JConstructor"/>.</param>
<param name="settings">The <see cref="T:Newtonsoft.Json.Linq.JsonLoadSettings"/> used to load the JSON.
If this is <c>null</c>, default load settings will be used.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>
A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous load. The <see cref="P:System.Threading.Tasks.Task`1.Result"/>
property returns a <see cref="T:Newtonsoft.Json.Linq.JConstructor"/> that contains the JSON that was read from the specified <see cref="T:Newtonsoft.Json.JsonReader"/>.</returns>
</member>
<member name="P:Newtonsoft.Json.Linq.JConstructor.ChildrenTokens">
<summary>
Gets the container's children tokens.
</summary>
<value>The container's children tokens.</value>
</member>
<member name="P:Newtonsoft.Json.Linq.JConstructor.Name">
<summary>
Gets or sets the name of this constructor.
</summary>
<value>The constructor name.</value>
</member>
<member name="P:Newtonsoft.Json.Linq.JConstructor.Type">
<summary>
Gets the node type for this <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<value>The type.</value>
</member>
<member name="M:Newtonsoft.Json.Linq.JConstructor.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JConstructor"/> class.
</summary>
</member>
<member name="M:Newtonsoft.Json.Linq.JConstructor.#ctor(Newtonsoft.Json.Linq.JConstructor)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JConstructor"/> class from another <see cref="T:Newtonsoft.Json.Linq.JConstructor"/> object.
</summary>
<param name="other">A <see cref="T:Newtonsoft.Json.Linq.JConstructor"/> object to copy from.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JConstructor.#ctor(System.String,System.Object[])">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JConstructor"/> class with the specified name and content.
</summary>
<param name="name">The constructor name.</param>
<param name="content">The contents of the constructor.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JConstructor.#ctor(System.String,System.Object)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JConstructor"/> class with the specified name and content.
</summary>
<param name="name">The constructor name.</param>
<param name="content">The contents of the constructor.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JConstructor.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JConstructor"/> class with the specified name.
</summary>
<param name="name">The constructor name.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JConstructor.WriteTo(Newtonsoft.Json.JsonWriter,Newtonsoft.Json.JsonConverter[])">
<summary>
Writes this token to a <see cref="T:Newtonsoft.Json.JsonWriter"/>.
</summary>
<param name="writer">A <see cref="T:Newtonsoft.Json.JsonWriter"/> into which this method will write.</param>
<param name="converters">A collection of <see cref="T:Newtonsoft.Json.JsonConverter"/> which will be used when writing the token.</param>
</member>
<member name="P:Newtonsoft.Json.Linq.JConstructor.Item(System.Object)">
<summary>
Gets the <see cref="T:Newtonsoft.Json.Linq.JToken"/> with the specified key.
</summary>
<value>The <see cref="T:Newtonsoft.Json.Linq.JToken"/> with the specified key.</value>
</member>
<member name="M:Newtonsoft.Json.Linq.JConstructor.Load(Newtonsoft.Json.JsonReader)">
<summary>
Loads a <see cref="T:Newtonsoft.Json.Linq.JConstructor"/> from a <see cref="T:Newtonsoft.Json.JsonReader"/>.
</summary>
<param name="reader">A <see cref="T:Newtonsoft.Json.JsonReader"/> that will be read for the content of the <see cref="T:Newtonsoft.Json.Linq.JConstructor"/>.</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JConstructor"/> that contains the JSON that was read from the specified <see cref="T:Newtonsoft.Json.JsonReader"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JConstructor.Load(Newtonsoft.Json.JsonReader,Newtonsoft.Json.Linq.JsonLoadSettings)">
<summary>
Loads a <see cref="T:Newtonsoft.Json.Linq.JConstructor"/> from a <see cref="T:Newtonsoft.Json.JsonReader"/>.
</summary>
<param name="reader">A <see cref="T:Newtonsoft.Json.JsonReader"/> that will be read for the content of the <see cref="T:Newtonsoft.Json.Linq.JConstructor"/>.</param>
<param name="settings">The <see cref="T:Newtonsoft.Json.Linq.JsonLoadSettings"/> used to load the JSON.
If this is <c>null</c>, default load settings will be used.</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JConstructor"/> that contains the JSON that was read from the specified <see cref="T:Newtonsoft.Json.JsonReader"/>.</returns>
</member>
<member name="T:Newtonsoft.Json.Linq.JContainer">
<summary>
Represents a token that can contain other tokens.
</summary>
</member>
<member name="E:Newtonsoft.Json.Linq.JContainer.ListChanged">
<summary>
Occurs when the list changes or an item in the list changes.
</summary>
</member>
<member name="E:Newtonsoft.Json.Linq.JContainer.AddingNew">
<summary>
Occurs before an item is added to the collection.
</summary>
</member>
<member name="E:Newtonsoft.Json.Linq.JContainer.CollectionChanged">
<summary>
Occurs when the items list of the collection has changed, or the collection is reset.
</summary>
</member>
<member name="P:Newtonsoft.Json.Linq.JContainer.ChildrenTokens">
<summary>
Gets the container's children tokens.
</summary>
<value>The container's children tokens.</value>
</member>
<member name="M:Newtonsoft.Json.Linq.JContainer.OnAddingNew(System.ComponentModel.AddingNewEventArgs)">
<summary>
Raises the <see cref="E:Newtonsoft.Json.Linq.JContainer.AddingNew"/> event.
</summary>
<param name="e">The <see cref="T:System.ComponentModel.AddingNewEventArgs"/> instance containing the event data.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JContainer.OnListChanged(System.ComponentModel.ListChangedEventArgs)">
<summary>
Raises the <see cref="E:Newtonsoft.Json.Linq.JContainer.ListChanged"/> event.
</summary>
<param name="e">The <see cref="T:System.ComponentModel.ListChangedEventArgs"/> instance containing the event data.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JContainer.OnCollectionChanged(System.Collections.Specialized.NotifyCollectionChangedEventArgs)">
<summary>
Raises the <see cref="E:Newtonsoft.Json.Linq.JContainer.CollectionChanged"/> event.
</summary>
<param name="e">The <see cref="T:System.Collections.Specialized.NotifyCollectionChangedEventArgs"/> instance containing the event data.</param>
</member>
<member name="P:Newtonsoft.Json.Linq.JContainer.HasValues">
<summary>
Gets a value indicating whether this token has child tokens.
</summary>
<value>
<c>true</c> if this token has child values; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Newtonsoft.Json.Linq.JContainer.First">
<summary>
Get the first child token of this token.
</summary>
<value>
A <see cref="T:Newtonsoft.Json.Linq.JToken"/> containing the first child token of the <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</value>
</member>
<member name="P:Newtonsoft.Json.Linq.JContainer.Last">
<summary>
Get the last child token of this token.
</summary>
<value>
A <see cref="T:Newtonsoft.Json.Linq.JToken"/> containing the last child token of the <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</value>
</member>
<member name="M:Newtonsoft.Json.Linq.JContainer.Children">
<summary>
Returns a collection of the child tokens of this token, in document order.
</summary>
<returns>
An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> containing the child tokens of this <see cref="T:Newtonsoft.Json.Linq.JToken"/>, in document order.
</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JContainer.Values``1">
<summary>
Returns a collection of the child values of this token, in document order.
</summary>
<typeparam name="T">The type to convert the values to.</typeparam>
<returns>
A <see cref="T:System.Collections.Generic.IEnumerable`1"/> containing the child values of this <see cref="T:Newtonsoft.Json.Linq.JToken"/>, in document order.
</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JContainer.Descendants">
<summary>
Returns a collection of the descendant tokens for this token in document order.
</summary>
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> containing the descendant tokens of the <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JContainer.DescendantsAndSelf">
<summary>
Returns a collection of the tokens that contain this token, and all descendant tokens of this token, in document order.
</summary>
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> containing this token, and all the descendant tokens of the <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JContainer.Add(System.Object)">
<summary>
Adds the specified content as children of this <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<param name="content">The content to be added.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JContainer.AddFirst(System.Object)">
<summary>
Adds the specified content as the first children of this <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<param name="content">The content to be added.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JContainer.CreateWriter">
<summary>
Creates a <see cref="T:Newtonsoft.Json.JsonWriter"/> that can be used to add tokens to the <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<returns>A <see cref="T:Newtonsoft.Json.JsonWriter"/> that is ready to have content written to it.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JContainer.ReplaceAll(System.Object)">
<summary>
Replaces the child nodes of this token with the specified content.
</summary>
<param name="content">The content.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JContainer.RemoveAll">
<summary>
Removes the child nodes from this token.
</summary>
</member>
<member name="M:Newtonsoft.Json.Linq.JContainer.Merge(System.Object)">
<summary>
Merge the specified content into this <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<param name="content">The content to be merged.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JContainer.Merge(System.Object,Newtonsoft.Json.Linq.JsonMergeSettings)">
<summary>
Merge the specified content into this <see cref="T:Newtonsoft.Json.Linq.JToken"/> using <see cref="T:Newtonsoft.Json.Linq.JsonMergeSettings"/>.
</summary>
<param name="content">The content to be merged.</param>
<param name="settings">The <see cref="T:Newtonsoft.Json.Linq.JsonMergeSettings"/> used to merge the content.</param>
</member>
<member name="P:Newtonsoft.Json.Linq.JContainer.Count">
<summary>
Gets the count of child JSON tokens.
</summary>
<value>The count of child JSON tokens.</value>
</member>
<member name="T:Newtonsoft.Json.Linq.JEnumerable`1">
<summary>
Represents a collection of <see cref="T:Newtonsoft.Json.Linq.JToken"/> objects.
</summary>
<typeparam name="T">The type of token.</typeparam>
</member>
<member name="F:Newtonsoft.Json.Linq.JEnumerable`1.Empty">
<summary>
An empty collection of <see cref="T:Newtonsoft.Json.Linq.JToken"/> objects.
</summary>
</member>
<member name="M:Newtonsoft.Json.Linq.JEnumerable`1.#ctor(System.Collections.Generic.IEnumerable{`0})">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JEnumerable`1"/> struct.
</summary>
<param name="enumerable">The enumerable.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JEnumerable`1.GetEnumerator">
<summary>
Returns an enumerator that can be used to iterate through the collection.
</summary>
<returns>
A <see cref="T:System.Collections.Generic.IEnumerator`1"/> that can be used to iterate through the collection.
</returns>
</member>
<member name="P:Newtonsoft.Json.Linq.JEnumerable`1.Item(System.Object)">
<summary>
Gets the <see cref="T:Newtonsoft.Json.Linq.IJEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> with the specified key.
</summary>
<value></value>
</member>
<member name="M:Newtonsoft.Json.Linq.JEnumerable`1.Equals(Newtonsoft.Json.Linq.JEnumerable{`0})">
<summary>
Determines whether the specified <see cref="T:Newtonsoft.Json.Linq.JEnumerable`1"/> is equal to this instance.
</summary>
<param name="other">The <see cref="T:Newtonsoft.Json.Linq.JEnumerable`1"/> to compare with this instance.</param>
<returns>
<c>true</c> if the specified <see cref="T:Newtonsoft.Json.Linq.JEnumerable`1"/> is equal to this instance; otherwise, <c>false</c>.
</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JEnumerable`1.Equals(System.Object)">
<summary>
Determines whether the specified <see cref="T:System.Object"/> is equal to this instance.
</summary>
<param name="obj">The <see cref="T:System.Object"/> to compare with this instance.</param>
<returns>
<c>true</c> if the specified <see cref="T:System.Object"/> is equal to this instance; otherwise, <c>false</c>.
</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JEnumerable`1.GetHashCode">
<summary>
Returns a hash code for this instance.
</summary>
<returns>
A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
</returns>
</member>
<member name="T:Newtonsoft.Json.Linq.JObject">
<summary>
Represents a JSON object.
</summary>
<example>
<code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\LinqToJsonTests.cs" region="LinqToJsonCreateParse" title="Parsing a JSON Object from Text" />
</example>
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.WriteToAsync(Newtonsoft.Json.JsonWriter,System.Threading.CancellationToken,Newtonsoft.Json.JsonConverter[])">
<summary>
Writes this token to a <see cref="T:Newtonsoft.Json.JsonWriter"/> asynchronously.
</summary>
<param name="writer">A <see cref="T:Newtonsoft.Json.JsonWriter"/> into which this method will write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
<param name="converters">A collection of <see cref="T:Newtonsoft.Json.JsonConverter"/> which will be used when writing the token.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous write operation.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.LoadAsync(Newtonsoft.Json.JsonReader,System.Threading.CancellationToken)">
<summary>
Asynchronously loads a <see cref="T:Newtonsoft.Json.Linq.JObject"/> from a <see cref="T:Newtonsoft.Json.JsonReader"/>.
</summary>
<param name="reader">A <see cref="T:Newtonsoft.Json.JsonReader"/> that will be read for the content of the <see cref="T:Newtonsoft.Json.Linq.JObject"/>.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>
A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous load. The <see cref="P:System.Threading.Tasks.Task`1.Result"/>
property returns a <see cref="T:Newtonsoft.Json.Linq.JObject"/> that contains the JSON that was read from the specified <see cref="T:Newtonsoft.Json.JsonReader"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.LoadAsync(Newtonsoft.Json.JsonReader,Newtonsoft.Json.Linq.JsonLoadSettings,System.Threading.CancellationToken)">
<summary>
Asynchronously loads a <see cref="T:Newtonsoft.Json.Linq.JObject"/> from a <see cref="T:Newtonsoft.Json.JsonReader"/>.
</summary>
<param name="reader">A <see cref="T:Newtonsoft.Json.JsonReader"/> that will be read for the content of the <see cref="T:Newtonsoft.Json.Linq.JObject"/>.</param>
<param name="settings">The <see cref="T:Newtonsoft.Json.Linq.JsonLoadSettings"/> used to load the JSON.
If this is <c>null</c>, default load settings will be used.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>
A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous load. The <see cref="P:System.Threading.Tasks.Task`1.Result"/>
property returns a <see cref="T:Newtonsoft.Json.Linq.JObject"/> that contains the JSON that was read from the specified <see cref="T:Newtonsoft.Json.JsonReader"/>.</returns>
</member>
<member name="P:Newtonsoft.Json.Linq.JObject.ChildrenTokens">
<summary>
Gets the container's children tokens.
</summary>
<value>The container's children tokens.</value>
</member>
<member name="E:Newtonsoft.Json.Linq.JObject.PropertyChanged">
<summary>
Occurs when a property value changes.
</summary>
</member>
<member name="E:Newtonsoft.Json.Linq.JObject.PropertyChanging">
<summary>
Occurs when a property value is changing.
</summary>
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JObject"/> class.
</summary>
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.#ctor(Newtonsoft.Json.Linq.JObject)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JObject"/> class from another <see cref="T:Newtonsoft.Json.Linq.JObject"/> object.
</summary>
<param name="other">A <see cref="T:Newtonsoft.Json.Linq.JObject"/> object to copy from.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.#ctor(System.Object[])">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JObject"/> class with the specified content.
</summary>
<param name="content">The contents of the object.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.#ctor(System.Object)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JObject"/> class with the specified content.
</summary>
<param name="content">The contents of the object.</param>
</member>
<member name="P:Newtonsoft.Json.Linq.JObject.Type">
<summary>
Gets the node type for this <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<value>The type.</value>
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.Properties">
<summary>
Gets an <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JProperty"/> of this object's properties.
</summary>
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JProperty"/> of this object's properties.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.Property(System.String)">
<summary>
Gets a <see cref="T:Newtonsoft.Json.Linq.JProperty"/> with the specified name.
</summary>
<param name="name">The property name.</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JProperty"/> with the specified name or <c>null</c>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.Property(System.String,System.StringComparison)">
<summary>
Gets the <see cref="T:Newtonsoft.Json.Linq.JProperty"/> with the specified name.
The exact name will be searched for first and if no matching property is found then
the <see cref="T:System.StringComparison"/> will be used to match a property.
</summary>
<param name="name">The property name.</param>
<param name="comparison">One of the enumeration values that specifies how the strings will be compared.</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JProperty"/> matched with the specified name or <c>null</c>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.PropertyValues">
<summary>
Gets a <see cref="T:Newtonsoft.Json.Linq.JEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> of this object's property values.
</summary>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> of this object's property values.</returns>
</member>
<member name="P:Newtonsoft.Json.Linq.JObject.Item(System.Object)">
<summary>
Gets the <see cref="T:Newtonsoft.Json.Linq.JToken"/> with the specified key.
</summary>
<value>The <see cref="T:Newtonsoft.Json.Linq.JToken"/> with the specified key.</value>
</member>
<member name="P:Newtonsoft.Json.Linq.JObject.Item(System.String)">
<summary>
Gets or sets the <see cref="T:Newtonsoft.Json.Linq.JToken"/> with the specified property name.
</summary>
<value></value>
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.Load(Newtonsoft.Json.JsonReader)">
<summary>
Loads a <see cref="T:Newtonsoft.Json.Linq.JObject"/> from a <see cref="T:Newtonsoft.Json.JsonReader"/>.
</summary>
<param name="reader">A <see cref="T:Newtonsoft.Json.JsonReader"/> that will be read for the content of the <see cref="T:Newtonsoft.Json.Linq.JObject"/>.</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JObject"/> that contains the JSON that was read from the specified <see cref="T:Newtonsoft.Json.JsonReader"/>.</returns>
<exception cref="T:Newtonsoft.Json.JsonReaderException">
<paramref name="reader"/> is not valid JSON.
</exception>
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.Load(Newtonsoft.Json.JsonReader,Newtonsoft.Json.Linq.JsonLoadSettings)">
<summary>
Loads a <see cref="T:Newtonsoft.Json.Linq.JObject"/> from a <see cref="T:Newtonsoft.Json.JsonReader"/>.
</summary>
<param name="reader">A <see cref="T:Newtonsoft.Json.JsonReader"/> that will be read for the content of the <see cref="T:Newtonsoft.Json.Linq.JObject"/>.</param>
<param name="settings">The <see cref="T:Newtonsoft.Json.Linq.JsonLoadSettings"/> used to load the JSON.
If this is <c>null</c>, default load settings will be used.</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JObject"/> that contains the JSON that was read from the specified <see cref="T:Newtonsoft.Json.JsonReader"/>.</returns>
<exception cref="T:Newtonsoft.Json.JsonReaderException">
<paramref name="reader"/> is not valid JSON.
</exception>
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.Parse(System.String)">
<summary>
Load a <see cref="T:Newtonsoft.Json.Linq.JObject"/> from a string that contains JSON.
</summary>
<param name="json">A <see cref="T:System.String"/> that contains JSON.</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JObject"/> populated from the string that contains JSON.</returns>
<exception cref="T:Newtonsoft.Json.JsonReaderException">
<paramref name="json"/> is not valid JSON.
</exception>
<example>
<code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\LinqToJsonTests.cs" region="LinqToJsonCreateParse" title="Parsing a JSON Object from Text" />
</example>
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.Parse(System.String,Newtonsoft.Json.Linq.JsonLoadSettings)">
<summary>
Load a <see cref="T:Newtonsoft.Json.Linq.JObject"/> from a string that contains JSON.
</summary>
<param name="json">A <see cref="T:System.String"/> that contains JSON.</param>
<param name="settings">The <see cref="T:Newtonsoft.Json.Linq.JsonLoadSettings"/> used to load the JSON.
If this is <c>null</c>, default load settings will be used.</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JObject"/> populated from the string that contains JSON.</returns>
<exception cref="T:Newtonsoft.Json.JsonReaderException">
<paramref name="json"/> is not valid JSON.
</exception>
<example>
<code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\LinqToJsonTests.cs" region="LinqToJsonCreateParse" title="Parsing a JSON Object from Text" />
</example>
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.FromObject(System.Object)">
<summary>
Creates a <see cref="T:Newtonsoft.Json.Linq.JObject"/> from an object.
</summary>
<param name="o">The object that will be used to create <see cref="T:Newtonsoft.Json.Linq.JObject"/>.</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JObject"/> with the values of the specified object.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.FromObject(System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Creates a <see cref="T:Newtonsoft.Json.Linq.JObject"/> from an object.
</summary>
<param name="o">The object that will be used to create <see cref="T:Newtonsoft.Json.Linq.JObject"/>.</param>
<param name="jsonSerializer">The <see cref="T:Newtonsoft.Json.JsonSerializer"/> that will be used to read the object.</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JObject"/> with the values of the specified object.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.WriteTo(Newtonsoft.Json.JsonWriter,Newtonsoft.Json.JsonConverter[])">
<summary>
Writes this token to a <see cref="T:Newtonsoft.Json.JsonWriter"/>.
</summary>
<param name="writer">A <see cref="T:Newtonsoft.Json.JsonWriter"/> into which this method will write.</param>
<param name="converters">A collection of <see cref="T:Newtonsoft.Json.JsonConverter"/> which will be used when writing the token.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.GetValue(System.String)">
<summary>
Gets the <see cref="T:Newtonsoft.Json.Linq.JToken"/> with the specified property name.
</summary>
<param name="propertyName">Name of the property.</param>
<returns>The <see cref="T:Newtonsoft.Json.Linq.JToken"/> with the specified property name.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.GetValue(System.String,System.StringComparison)">
<summary>
Gets the <see cref="T:Newtonsoft.Json.Linq.JToken"/> with the specified property name.
The exact property name will be searched for first and if no matching property is found then
the <see cref="T:System.StringComparison"/> will be used to match a property.
</summary>
<param name="propertyName">Name of the property.</param>
<param name="comparison">One of the enumeration values that specifies how the strings will be compared.</param>
<returns>The <see cref="T:Newtonsoft.Json.Linq.JToken"/> with the specified property name.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.TryGetValue(System.String,System.StringComparison,Newtonsoft.Json.Linq.JToken@)">
<summary>
Tries to get the <see cref="T:Newtonsoft.Json.Linq.JToken"/> with the specified property name.
The exact property name will be searched for first and if no matching property is found then
the <see cref="T:System.StringComparison"/> will be used to match a property.
</summary>
<param name="propertyName">Name of the property.</param>
<param name="value">The value.</param>
<param name="comparison">One of the enumeration values that specifies how the strings will be compared.</param>
<returns><c>true</c> if a value was successfully retrieved; otherwise, <c>false</c>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.Add(System.String,Newtonsoft.Json.Linq.JToken)">
<summary>
Adds the specified property name.
</summary>
<param name="propertyName">Name of the property.</param>
<param name="value">The value.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.ContainsKey(System.String)">
<summary>
Determines whether the JSON object has the specified property name.
</summary>
<param name="propertyName">Name of the property.</param>
<returns><c>true</c> if the JSON object has the specified property name; otherwise, <c>false</c>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.Remove(System.String)">
<summary>
Removes the property with the specified name.
</summary>
<param name="propertyName">Name of the property.</param>
<returns><c>true</c> if item was successfully removed; otherwise, <c>false</c>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.TryGetValue(System.String,Newtonsoft.Json.Linq.JToken@)">
<summary>
Tries to get the <see cref="T:Newtonsoft.Json.Linq.JToken"/> with the specified property name.
</summary>
<param name="propertyName">Name of the property.</param>
<param name="value">The value.</param>
<returns><c>true</c> if a value was successfully retrieved; otherwise, <c>false</c>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.GetEnumerator">
<summary>
Returns an enumerator that can be used to iterate through the collection.
</summary>
<returns>
A <see cref="T:System.Collections.Generic.IEnumerator`1"/> that can be used to iterate through the collection.
</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.OnPropertyChanged(System.String)">
<summary>
Raises the <see cref="E:Newtonsoft.Json.Linq.JObject.PropertyChanged"/> event with the provided arguments.
</summary>
<param name="propertyName">Name of the property.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.OnPropertyChanging(System.String)">
<summary>
Raises the <see cref="E:Newtonsoft.Json.Linq.JObject.PropertyChanging"/> event with the provided arguments.
</summary>
<param name="propertyName">Name of the property.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JObject.GetMetaObject(System.Linq.Expressions.Expression)">
<summary>
Returns the <see cref="T:System.Dynamic.DynamicMetaObject"/> responsible for binding operations performed on this object.
</summary>
<param name="parameter">The expression tree representation of the runtime value.</param>
<returns>
The <see cref="T:System.Dynamic.DynamicMetaObject"/> to bind this object.
</returns>
</member>
<member name="T:Newtonsoft.Json.Linq.JProperty">
<summary>
Represents a JSON property.
</summary>
</member>
<member name="M:Newtonsoft.Json.Linq.JProperty.WriteToAsync(Newtonsoft.Json.JsonWriter,System.Threading.CancellationToken,Newtonsoft.Json.JsonConverter[])">
<summary>
Writes this token to a <see cref="T:Newtonsoft.Json.JsonWriter"/> asynchronously.
</summary>
<param name="writer">A <see cref="T:Newtonsoft.Json.JsonWriter"/> into which this method will write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
<param name="converters">A collection of <see cref="T:Newtonsoft.Json.JsonConverter"/> which will be used when writing the token.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous write operation.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JProperty.LoadAsync(Newtonsoft.Json.JsonReader,System.Threading.CancellationToken)">
<summary>
Asynchronously loads a <see cref="T:Newtonsoft.Json.Linq.JProperty"/> from a <see cref="T:Newtonsoft.Json.JsonReader"/>.
</summary>
<param name="reader">A <see cref="T:Newtonsoft.Json.JsonReader"/> that will be read for the content of the <see cref="T:Newtonsoft.Json.Linq.JProperty"/>.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task`1"/> representing the asynchronous creation. The <see cref="P:System.Threading.Tasks.Task`1.Result"/>
property returns a <see cref="T:Newtonsoft.Json.Linq.JProperty"/> that contains the JSON that was read from the specified <see cref="T:Newtonsoft.Json.JsonReader"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JProperty.LoadAsync(Newtonsoft.Json.JsonReader,Newtonsoft.Json.Linq.JsonLoadSettings,System.Threading.CancellationToken)">
<summary>
Asynchronously loads a <see cref="T:Newtonsoft.Json.Linq.JProperty"/> from a <see cref="T:Newtonsoft.Json.JsonReader"/>.
</summary>
<param name="reader">A <see cref="T:Newtonsoft.Json.JsonReader"/> that will be read for the content of the <see cref="T:Newtonsoft.Json.Linq.JProperty"/>.</param>
<param name="settings">The <see cref="T:Newtonsoft.Json.Linq.JsonLoadSettings"/> used to load the JSON.
If this is <c>null</c>, default load settings will be used.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task`1"/> representing the asynchronous creation. The <see cref="P:System.Threading.Tasks.Task`1.Result"/>
property returns a <see cref="T:Newtonsoft.Json.Linq.JProperty"/> that contains the JSON that was read from the specified <see cref="T:Newtonsoft.Json.JsonReader"/>.</returns>
</member>
<member name="P:Newtonsoft.Json.Linq.JProperty.ChildrenTokens">
<summary>
Gets the container's children tokens.
</summary>
<value>The container's children tokens.</value>
</member>
<member name="P:Newtonsoft.Json.Linq.JProperty.Name">
<summary>
Gets the property name.
</summary>
<value>The property name.</value>
</member>
<member name="P:Newtonsoft.Json.Linq.JProperty.Value">
<summary>
Gets or sets the property value.
</summary>
<value>The property value.</value>
</member>
<member name="M:Newtonsoft.Json.Linq.JProperty.#ctor(Newtonsoft.Json.Linq.JProperty)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JProperty"/> class from another <see cref="T:Newtonsoft.Json.Linq.JProperty"/> object.
</summary>
<param name="other">A <see cref="T:Newtonsoft.Json.Linq.JProperty"/> object to copy from.</param>
</member>
<member name="P:Newtonsoft.Json.Linq.JProperty.Type">
<summary>
Gets the node type for this <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<value>The type.</value>
</member>
<member name="M:Newtonsoft.Json.Linq.JProperty.#ctor(System.String,System.Object[])">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JProperty"/> class.
</summary>
<param name="name">The property name.</param>
<param name="content">The property content.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JProperty.#ctor(System.String,System.Object)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JProperty"/> class.
</summary>
<param name="name">The property name.</param>
<param name="content">The property content.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JProperty.WriteTo(Newtonsoft.Json.JsonWriter,Newtonsoft.Json.JsonConverter[])">
<summary>
Writes this token to a <see cref="T:Newtonsoft.Json.JsonWriter"/>.
</summary>
<param name="writer">A <see cref="T:Newtonsoft.Json.JsonWriter"/> into which this method will write.</param>
<param name="converters">A collection of <see cref="T:Newtonsoft.Json.JsonConverter"/> which will be used when writing the token.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JProperty.Load(Newtonsoft.Json.JsonReader)">
<summary>
Loads a <see cref="T:Newtonsoft.Json.Linq.JProperty"/> from a <see cref="T:Newtonsoft.Json.JsonReader"/>.
</summary>
<param name="reader">A <see cref="T:Newtonsoft.Json.JsonReader"/> that will be read for the content of the <see cref="T:Newtonsoft.Json.Linq.JProperty"/>.</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JProperty"/> that contains the JSON that was read from the specified <see cref="T:Newtonsoft.Json.JsonReader"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JProperty.Load(Newtonsoft.Json.JsonReader,Newtonsoft.Json.Linq.JsonLoadSettings)">
<summary>
Loads a <see cref="T:Newtonsoft.Json.Linq.JProperty"/> from a <see cref="T:Newtonsoft.Json.JsonReader"/>.
</summary>
<param name="reader">A <see cref="T:Newtonsoft.Json.JsonReader"/> that will be read for the content of the <see cref="T:Newtonsoft.Json.Linq.JProperty"/>.</param>
<param name="settings">The <see cref="T:Newtonsoft.Json.Linq.JsonLoadSettings"/> used to load the JSON.
If this is <c>null</c>, default load settings will be used.</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JProperty"/> that contains the JSON that was read from the specified <see cref="T:Newtonsoft.Json.JsonReader"/>.</returns>
</member>
<member name="T:Newtonsoft.Json.Linq.JPropertyDescriptor">
<summary>
Represents a view of a <see cref="T:Newtonsoft.Json.Linq.JProperty"/>.
</summary>
</member>
<member name="M:Newtonsoft.Json.Linq.JPropertyDescriptor.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JPropertyDescriptor"/> class.
</summary>
<param name="name">The name.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JPropertyDescriptor.CanResetValue(System.Object)">
<summary>
When overridden in a derived class, returns whether resetting an object changes its value.
</summary>
<returns>
<c>true</c> if resetting the component changes its value; otherwise, <c>false</c>.
</returns>
<param name="component">The component to test for reset capability.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JPropertyDescriptor.GetValue(System.Object)">
<summary>
When overridden in a derived class, gets the current value of the property on a component.
</summary>
<returns>
The value of a property for a given component.
</returns>
<param name="component">The component with the property for which to retrieve the value.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JPropertyDescriptor.ResetValue(System.Object)">
<summary>
When overridden in a derived class, resets the value for this property of the component to the default value.
</summary>
<param name="component">The component with the property value that is to be reset to the default value.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JPropertyDescriptor.SetValue(System.Object,System.Object)">
<summary>
When overridden in a derived class, sets the value of the component to a different value.
</summary>
<param name="component">The component with the property value that is to be set.</param>
<param name="value">The new value.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JPropertyDescriptor.ShouldSerializeValue(System.Object)">
<summary>
When overridden in a derived class, determines a value indicating whether the value of this property needs to be persisted.
</summary>
<returns>
<c>true</c> if the property should be persisted; otherwise, <c>false</c>.
</returns>
<param name="component">The component with the property to be examined for persistence.</param>
</member>
<member name="P:Newtonsoft.Json.Linq.JPropertyDescriptor.ComponentType">
<summary>
When overridden in a derived class, gets the type of the component this property is bound to.
</summary>
<returns>
A <see cref="T:System.Type"/> that represents the type of component this property is bound to.
When the <see cref="M:System.ComponentModel.PropertyDescriptor.GetValue(System.Object)"/> or
<see cref="M:System.ComponentModel.PropertyDescriptor.SetValue(System.Object,System.Object)"/>
methods are invoked, the object specified might be an instance of this type.
</returns>
</member>
<member name="P:Newtonsoft.Json.Linq.JPropertyDescriptor.IsReadOnly">
<summary>
When overridden in a derived class, gets a value indicating whether this property is read-only.
</summary>
<returns>
<c>true</c> if the property is read-only; otherwise, <c>false</c>.
</returns>
</member>
<member name="P:Newtonsoft.Json.Linq.JPropertyDescriptor.PropertyType">
<summary>
When overridden in a derived class, gets the type of the property.
</summary>
<returns>
A <see cref="T:System.Type"/> that represents the type of the property.
</returns>
</member>
<member name="P:Newtonsoft.Json.Linq.JPropertyDescriptor.NameHashCode">
<summary>
Gets the hash code for the name of the member.
</summary>
<value></value>
<returns>
The hash code for the name of the member.
</returns>
</member>
<member name="T:Newtonsoft.Json.Linq.JRaw">
<summary>
Represents a raw JSON string.
</summary>
</member>
<member name="M:Newtonsoft.Json.Linq.JRaw.CreateAsync(Newtonsoft.Json.JsonReader,System.Threading.CancellationToken)">
<summary>
Asynchronously creates an instance of <see cref="T:Newtonsoft.Json.Linq.JRaw"/> with the content of the reader's current token.
</summary>
<param name="reader">The reader.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task`1"/> representing the asynchronous creation. The <see cref="P:System.Threading.Tasks.Task`1.Result"/>
property returns an instance of <see cref="T:Newtonsoft.Json.Linq.JRaw"/> with the content of the reader's current token.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JRaw.#ctor(Newtonsoft.Json.Linq.JRaw)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JRaw"/> class from another <see cref="T:Newtonsoft.Json.Linq.JRaw"/> object.
</summary>
<param name="other">A <see cref="T:Newtonsoft.Json.Linq.JRaw"/> object to copy from.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JRaw.#ctor(System.Object)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JRaw"/> class.
</summary>
<param name="rawJson">The raw json.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JRaw.Create(Newtonsoft.Json.JsonReader)">
<summary>
Creates an instance of <see cref="T:Newtonsoft.Json.Linq.JRaw"/> with the content of the reader's current token.
</summary>
<param name="reader">The reader.</param>
<returns>An instance of <see cref="T:Newtonsoft.Json.Linq.JRaw"/> with the content of the reader's current token.</returns>
</member>
<member name="T:Newtonsoft.Json.Linq.JsonLoadSettings">
<summary>
Specifies the settings used when loading JSON.
</summary>
</member>
<member name="M:Newtonsoft.Json.Linq.JsonLoadSettings.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JsonLoadSettings"/> class.
</summary>
</member>
<member name="P:Newtonsoft.Json.Linq.JsonLoadSettings.CommentHandling">
<summary>
Gets or sets how JSON comments are handled when loading JSON.
The default value is <see cref="F:Newtonsoft.Json.Linq.CommentHandling.Ignore" />.
</summary>
<value>The JSON comment handling.</value>
</member>
<member name="P:Newtonsoft.Json.Linq.JsonLoadSettings.LineInfoHandling">
<summary>
Gets or sets how JSON line info is handled when loading JSON.
The default value is <see cref="F:Newtonsoft.Json.Linq.LineInfoHandling.Load" />.
</summary>
<value>The JSON line info handling.</value>
</member>
<member name="P:Newtonsoft.Json.Linq.JsonLoadSettings.DuplicatePropertyNameHandling">
<summary>
Gets or sets how duplicate property names in JSON objects are handled when loading JSON.
The default value is <see cref="F:Newtonsoft.Json.Linq.DuplicatePropertyNameHandling.Replace" />.
</summary>
<value>The JSON duplicate property name handling.</value>
</member>
<member name="T:Newtonsoft.Json.Linq.JsonMergeSettings">
<summary>
Specifies the settings used when merging JSON.
</summary>
</member>
<member name="M:Newtonsoft.Json.Linq.JsonMergeSettings.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JsonMergeSettings"/> class.
</summary>
</member>
<member name="P:Newtonsoft.Json.Linq.JsonMergeSettings.MergeArrayHandling">
<summary>
Gets or sets the method used when merging JSON arrays.
</summary>
<value>The method used when merging JSON arrays.</value>
</member>
<member name="P:Newtonsoft.Json.Linq.JsonMergeSettings.MergeNullValueHandling">
<summary>
Gets or sets how null value properties are merged.
</summary>
<value>How null value properties are merged.</value>
</member>
<member name="P:Newtonsoft.Json.Linq.JsonMergeSettings.PropertyNameComparison">
<summary>
Gets or sets the comparison used to match property names while merging.
The exact property name will be searched for first and if no matching property is found then
the <see cref="T:System.StringComparison"/> will be used to match a property.
</summary>
<value>The comparison used to match property names while merging.</value>
</member>
<member name="T:Newtonsoft.Json.Linq.JsonSelectSettings">
<summary>
Specifies the settings used when selecting JSON.
</summary>
</member>
<member name="P:Newtonsoft.Json.Linq.JsonSelectSettings.RegexMatchTimeout">
<summary>
Gets or sets a timeout that will be used when executing regular expressions.
</summary>
<value>The timeout that will be used when executing regular expressions.</value>
</member>
<member name="P:Newtonsoft.Json.Linq.JsonSelectSettings.ErrorWhenNoMatch">
<summary>
Gets or sets a flag that indicates whether an error should be thrown if
no tokens are found when evaluating part of the expression.
</summary>
<value>
A flag that indicates whether an error should be thrown if
no tokens are found when evaluating part of the expression.
</value>
</member>
<member name="T:Newtonsoft.Json.Linq.JToken">
<summary>
Represents an abstract JSON token.
</summary>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.WriteToAsync(Newtonsoft.Json.JsonWriter,System.Threading.CancellationToken,Newtonsoft.Json.JsonConverter[])">
<summary>
Writes this token to a <see cref="T:Newtonsoft.Json.JsonWriter"/> asynchronously.
</summary>
<param name="writer">A <see cref="T:Newtonsoft.Json.JsonWriter"/> into which this method will write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
<param name="converters">A collection of <see cref="T:Newtonsoft.Json.JsonConverter"/> which will be used when writing the token.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous write operation.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.WriteToAsync(Newtonsoft.Json.JsonWriter,Newtonsoft.Json.JsonConverter[])">
<summary>
Writes this token to a <see cref="T:Newtonsoft.Json.JsonWriter"/> asynchronously.
</summary>
<param name="writer">A <see cref="T:Newtonsoft.Json.JsonWriter"/> into which this method will write.</param>
<param name="converters">A collection of <see cref="T:Newtonsoft.Json.JsonConverter"/> which will be used when writing the token.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous write operation.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.ReadFromAsync(Newtonsoft.Json.JsonReader,System.Threading.CancellationToken)">
<summary>
Asynchronously creates a <see cref="T:Newtonsoft.Json.Linq.JToken"/> from a <see cref="T:Newtonsoft.Json.JsonReader"/>.
</summary>
<param name="reader">An <see cref="T:Newtonsoft.Json.JsonReader"/> positioned at the token to read into this <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>
A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous creation. The
<see cref="P:System.Threading.Tasks.Task`1.Result"/> property returns a <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains
the token and its descendant tokens
that were read from the reader. The runtime type of the token is determined
by the token type of the first token encountered in the reader.
</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.ReadFromAsync(Newtonsoft.Json.JsonReader,Newtonsoft.Json.Linq.JsonLoadSettings,System.Threading.CancellationToken)">
<summary>
Asynchronously creates a <see cref="T:Newtonsoft.Json.Linq.JToken"/> from a <see cref="T:Newtonsoft.Json.JsonReader"/>.
</summary>
<param name="reader">An <see cref="T:Newtonsoft.Json.JsonReader"/> positioned at the token to read into this <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</param>
<param name="settings">The <see cref="T:Newtonsoft.Json.Linq.JsonLoadSettings"/> used to load the JSON.
If this is <c>null</c>, default load settings will be used.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>
A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous creation. The
<see cref="P:System.Threading.Tasks.Task`1.Result"/> property returns a <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains
the token and its descendant tokens
that were read from the reader. The runtime type of the token is determined
by the token type of the first token encountered in the reader.
</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.LoadAsync(Newtonsoft.Json.JsonReader,System.Threading.CancellationToken)">
<summary>
Asynchronously creates a <see cref="T:Newtonsoft.Json.Linq.JToken"/> from a <see cref="T:Newtonsoft.Json.JsonReader"/>.
</summary>
<param name="reader">A <see cref="T:Newtonsoft.Json.JsonReader"/> positioned at the token to read into this <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>
A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous creation. The <see cref="P:System.Threading.Tasks.Task`1.Result"/>
property returns a <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the token and its descendant tokens
that were read from the reader. The runtime type of the token is determined
by the token type of the first token encountered in the reader.
</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.LoadAsync(Newtonsoft.Json.JsonReader,Newtonsoft.Json.Linq.JsonLoadSettings,System.Threading.CancellationToken)">
<summary>
Asynchronously creates a <see cref="T:Newtonsoft.Json.Linq.JToken"/> from a <see cref="T:Newtonsoft.Json.JsonReader"/>.
</summary>
<param name="reader">A <see cref="T:Newtonsoft.Json.JsonReader"/> positioned at the token to read into this <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</param>
<param name="settings">The <see cref="T:Newtonsoft.Json.Linq.JsonLoadSettings"/> used to load the JSON.
If this is <c>null</c>, default load settings will be used.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
<returns>
A <see cref="T:System.Threading.Tasks.Task`1"/> that represents the asynchronous creation. The <see cref="P:System.Threading.Tasks.Task`1.Result"/>
property returns a <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the token and its descendant tokens
that were read from the reader. The runtime type of the token is determined
by the token type of the first token encountered in the reader.
</returns>
</member>
<member name="P:Newtonsoft.Json.Linq.JToken.EqualityComparer">
<summary>
Gets a comparer that can compare two tokens for value equality.
</summary>
<value>A <see cref="T:Newtonsoft.Json.Linq.JTokenEqualityComparer"/> that can compare two nodes for value equality.</value>
</member>
<member name="P:Newtonsoft.Json.Linq.JToken.Parent">
<summary>
Gets or sets the parent.
</summary>
<value>The parent.</value>
</member>
<member name="P:Newtonsoft.Json.Linq.JToken.Root">
<summary>
Gets the root <see cref="T:Newtonsoft.Json.Linq.JToken"/> of this <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<value>The root <see cref="T:Newtonsoft.Json.Linq.JToken"/> of this <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</value>
</member>
<member name="P:Newtonsoft.Json.Linq.JToken.Type">
<summary>
Gets the node type for this <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<value>The type.</value>
</member>
<member name="P:Newtonsoft.Json.Linq.JToken.HasValues">
<summary>
Gets a value indicating whether this token has child tokens.
</summary>
<value>
<c>true</c> if this token has child values; otherwise, <c>false</c>.
</value>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.DeepEquals(Newtonsoft.Json.Linq.JToken,Newtonsoft.Json.Linq.JToken)">
<summary>
Compares the values of two tokens, including the values of all descendant tokens.
</summary>
<param name="t1">The first <see cref="T:Newtonsoft.Json.Linq.JToken"/> to compare.</param>
<param name="t2">The second <see cref="T:Newtonsoft.Json.Linq.JToken"/> to compare.</param>
<returns><c>true</c> if the tokens are equal; otherwise <c>false</c>.</returns>
</member>
<member name="P:Newtonsoft.Json.Linq.JToken.Next">
<summary>
Gets the next sibling token of this node.
</summary>
<value>The <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the next sibling token.</value>
</member>
<member name="P:Newtonsoft.Json.Linq.JToken.Previous">
<summary>
Gets the previous sibling token of this node.
</summary>
<value>The <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the previous sibling token.</value>
</member>
<member name="P:Newtonsoft.Json.Linq.JToken.Path">
<summary>
Gets the path of the JSON token.
</summary>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.AddAfterSelf(System.Object)">
<summary>
Adds the specified content immediately after this token.
</summary>
<param name="content">A content object that contains simple content or a collection of content objects to be added after this token.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.AddBeforeSelf(System.Object)">
<summary>
Adds the specified content immediately before this token.
</summary>
<param name="content">A content object that contains simple content or a collection of content objects to be added before this token.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.Ancestors">
<summary>
Returns a collection of the ancestor tokens of this token.
</summary>
<returns>A collection of the ancestor tokens of this token.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.AncestorsAndSelf">
<summary>
Returns a collection of tokens that contain this token, and the ancestors of this token.
</summary>
<returns>A collection of tokens that contain this token, and the ancestors of this token.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.AfterSelf">
<summary>
Returns a collection of the sibling tokens after this token, in document order.
</summary>
<returns>A collection of the sibling tokens after this tokens, in document order.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.BeforeSelf">
<summary>
Returns a collection of the sibling tokens before this token, in document order.
</summary>
<returns>A collection of the sibling tokens before this token, in document order.</returns>
</member>
<member name="P:Newtonsoft.Json.Linq.JToken.Item(System.Object)">
<summary>
Gets the <see cref="T:Newtonsoft.Json.Linq.JToken"/> with the specified key.
</summary>
<value>The <see cref="T:Newtonsoft.Json.Linq.JToken"/> with the specified key.</value>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.Value``1(System.Object)">
<summary>
Gets the <see cref="T:Newtonsoft.Json.Linq.JToken"/> with the specified key converted to the specified type.
</summary>
<typeparam name="T">The type to convert the token to.</typeparam>
<param name="key">The token key.</param>
<returns>The converted token value.</returns>
</member>
<member name="P:Newtonsoft.Json.Linq.JToken.First">
<summary>
Get the first child token of this token.
</summary>
<value>A <see cref="T:Newtonsoft.Json.Linq.JToken"/> containing the first child token of the <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</value>
</member>
<member name="P:Newtonsoft.Json.Linq.JToken.Last">
<summary>
Get the last child token of this token.
</summary>
<value>A <see cref="T:Newtonsoft.Json.Linq.JToken"/> containing the last child token of the <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</value>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.Children">
<summary>
Returns a collection of the child tokens of this token, in document order.
</summary>
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> containing the child tokens of this <see cref="T:Newtonsoft.Json.Linq.JToken"/>, in document order.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.Children``1">
<summary>
Returns a collection of the child tokens of this token, in document order, filtered by the specified type.
</summary>
<typeparam name="T">The type to filter the child tokens on.</typeparam>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JEnumerable`1"/> containing the child tokens of this <see cref="T:Newtonsoft.Json.Linq.JToken"/>, in document order.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.Values``1">
<summary>
Returns a collection of the child values of this token, in document order.
</summary>
<typeparam name="T">The type to convert the values to.</typeparam>
<returns>A <see cref="T:System.Collections.Generic.IEnumerable`1"/> containing the child values of this <see cref="T:Newtonsoft.Json.Linq.JToken"/>, in document order.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.Remove">
<summary>
Removes this token from its parent.
</summary>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.Replace(Newtonsoft.Json.Linq.JToken)">
<summary>
Replaces this token with the specified token.
</summary>
<param name="value">The value.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.WriteTo(Newtonsoft.Json.JsonWriter,Newtonsoft.Json.JsonConverter[])">
<summary>
Writes this token to a <see cref="T:Newtonsoft.Json.JsonWriter"/>.
</summary>
<param name="writer">A <see cref="T:Newtonsoft.Json.JsonWriter"/> into which this method will write.</param>
<param name="converters">A collection of <see cref="T:Newtonsoft.Json.JsonConverter"/> which will be used when writing the token.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.ToString">
<summary>
Returns the indented JSON for this token.
</summary>
<remarks>
<c>ToString()</c> returns a non-JSON string value for tokens with a type of <see cref="F:Newtonsoft.Json.Linq.JTokenType.String"/>.
If you want the JSON for all token types then you should use <see cref="M:Newtonsoft.Json.Linq.JToken.WriteTo(Newtonsoft.Json.JsonWriter,Newtonsoft.Json.JsonConverter[])"/>.
</remarks>
<returns>
The indented JSON for this token.
</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.ToString(Newtonsoft.Json.Formatting,Newtonsoft.Json.JsonConverter[])">
<summary>
Returns the JSON for this token using the given formatting and converters.
</summary>
<param name="formatting">Indicates how the output should be formatted.</param>
<param name="converters">A collection of <see cref="T:Newtonsoft.Json.JsonConverter"/>s which will be used when writing the token.</param>
<returns>The JSON for this token using the given formatting and converters.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Boolean">
<summary>
Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Boolean"/>.
</summary>
<param name="value">The value.</param>
<returns>The result of the conversion.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.DateTimeOffset">
<summary>
Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.DateTimeOffset"/>.
</summary>
<param name="value">The value.</param>
<returns>The result of the conversion.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Nullable{System.Boolean}">
<summary>
Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/> of <see cref="T:System.Boolean"/>.
</summary>
<param name="value">The value.</param>
<returns>The result of the conversion.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Int64">
<summary>
Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int64"/>.
</summary>
<param name="value">The value.</param>
<returns>The result of the conversion.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Nullable{System.DateTime}">
<summary>
Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTime"/>.
</summary>
<param name="value">The value.</param>
<returns>The result of the conversion.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Nullable{System.DateTimeOffset}">
<summary>
Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTimeOffset"/>.
</summary>
<param name="value">The value.</param>
<returns>The result of the conversion.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Nullable{System.Decimal}">
<summary>
Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/> of <see cref="T:System.Decimal"/>.
</summary>
<param name="value">The value.</param>
<returns>The result of the conversion.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Nullable{System.Double}">
<summary>
Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/> of <see cref="T:System.Double"/>.
</summary>
<param name="value">The value.</param>
<returns>The result of the conversion.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Nullable{System.Char}">
<summary>
Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/> of <see cref="T:System.Char"/>.
</summary>
<param name="value">The value.</param>
<returns>The result of the conversion.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Int32">
<summary>
Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Int32"/>.
</summary>
<param name="value">The value.</param>
<returns>The result of the conversion.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Int16">
<summary>
Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Int16"/>.
</summary>
<param name="value">The value.</param>
<returns>The result of the conversion.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.UInt16">
<summary>
Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.UInt16"/>.
</summary>
<param name="value">The value.</param>
<returns>The result of the conversion.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Char">
<summary>
Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Char"/>.
</summary>
<param name="value">The value.</param>
<returns>The result of the conversion.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Byte">
<summary>
Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Byte"/>.
</summary>
<param name="value">The value.</param>
<returns>The result of the conversion.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.SByte">
<summary>
Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.SByte"/>.
</summary>
<param name="value">The value.</param>
<returns>The result of the conversion.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Nullable{System.Int32}">
<summary>
Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int32"/> .
</summary>
<param name="value">The value.</param>
<returns>The result of the conversion.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Nullable{System.Int16}">
<summary>
Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int16"/>.
</summary>
<param name="value">The value.</param>
<returns>The result of the conversion.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Nullable{System.UInt16}">
<summary>
Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/> of <see cref="T:System.UInt16"/>.
</summary>
<param name="value">The value.</param>
<returns>The result of the conversion.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Nullable{System.Byte}">
<summary>
Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/> of <see cref="T:System.Byte"/>.
</summary>
<param name="value">The value.</param>
<returns>The result of the conversion.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Nullable{System.SByte}">
<summary>
Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/> of <see cref="T:System.SByte"/>.
</summary>
<param name="value">The value.</param>
<returns>The result of the conversion.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.DateTime">
<summary>
Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTime"/>.
</summary>
<param name="value">The value.</param>
<returns>The result of the conversion.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Nullable{System.Int64}">
<summary>
Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int64"/>.
</summary>
<param name="value">The value.</param>
<returns>The result of the conversion.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Nullable{System.Single}">
<summary>
Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/> of <see cref="T:System.Single"/>.
</summary>
<param name="value">The value.</param>
<returns>The result of the conversion.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Decimal">
<summary>
Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Decimal"/>.
</summary>
<param name="value">The value.</param>
<returns>The result of the conversion.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Nullable{System.UInt32}">
<summary>
Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/> of <see cref="T:System.UInt32"/>.
</summary>
<param name="value">The value.</param>
<returns>The result of the conversion.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Nullable{System.UInt64}">
<summary>
Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/> of <see cref="T:System.UInt64"/>.
</summary>
<param name="value">The value.</param>
<returns>The result of the conversion.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Double">
<summary>
Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Double"/>.
</summary>
<param name="value">The value.</param>
<returns>The result of the conversion.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Single">
<summary>
Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Single"/>.
</summary>
<param name="value">The value.</param>
<returns>The result of the conversion.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.String">
<summary>
Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.String"/>.
</summary>
<param name="value">The value.</param>
<returns>The result of the conversion.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.UInt32">
<summary>
Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.UInt32"/>.
</summary>
<param name="value">The value.</param>
<returns>The result of the conversion.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.UInt64">
<summary>
Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.UInt64"/>.
</summary>
<param name="value">The value.</param>
<returns>The result of the conversion.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Byte[]">
<summary>
Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Byte"/>[].
</summary>
<param name="value">The value.</param>
<returns>The result of the conversion.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Guid">
<summary>
Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Guid"/>.
</summary>
<param name="value">The value.</param>
<returns>The result of the conversion.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Nullable{System.Guid}">
<summary>
Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/> of <see cref="T:System.Guid"/> .
</summary>
<param name="value">The value.</param>
<returns>The result of the conversion.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.TimeSpan">
<summary>
Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.TimeSpan"/>.
</summary>
<param name="value">The value.</param>
<returns>The result of the conversion.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Nullable{System.TimeSpan}">
<summary>
Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/> of <see cref="T:System.TimeSpan"/>.
</summary>
<param name="value">The value.</param>
<returns>The result of the conversion.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Uri">
<summary>
Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Uri"/>.
</summary>
<param name="value">The value.</param>
<returns>The result of the conversion.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Boolean)~Newtonsoft.Json.Linq.JToken">
<summary>
Performs an implicit conversion from <see cref="T:System.Boolean"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
<returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.DateTimeOffset)~Newtonsoft.Json.Linq.JToken">
<summary>
Performs an implicit conversion from <see cref="T:System.DateTimeOffset"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
<returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Byte)~Newtonsoft.Json.Linq.JToken">
<summary>
Performs an implicit conversion from <see cref="T:System.Byte"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
<returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Nullable{System.Byte})~Newtonsoft.Json.Linq.JToken">
<summary>
Performs an implicit conversion from <see cref="T:System.Nullable`1"/> of <see cref="T:System.Byte"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
<returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.SByte)~Newtonsoft.Json.Linq.JToken">
<summary>
Performs an implicit conversion from <see cref="T:System.SByte"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
<returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Nullable{System.SByte})~Newtonsoft.Json.Linq.JToken">
<summary>
Performs an implicit conversion from <see cref="T:System.Nullable`1"/> of <see cref="T:System.SByte"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
<returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Nullable{System.Boolean})~Newtonsoft.Json.Linq.JToken">
<summary>
Performs an implicit conversion from <see cref="T:System.Nullable`1"/> of <see cref="T:System.Boolean"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
<returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Int64)~Newtonsoft.Json.Linq.JToken">
<summary>
Performs an implicit conversion from <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int64"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
<returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Nullable{System.DateTime})~Newtonsoft.Json.Linq.JToken">
<summary>
Performs an implicit conversion from <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTime"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
<returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Nullable{System.DateTimeOffset})~Newtonsoft.Json.Linq.JToken">
<summary>
Performs an implicit conversion from <see cref="T:System.Nullable`1"/> of <see cref="T:System.DateTimeOffset"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
<returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Nullable{System.Decimal})~Newtonsoft.Json.Linq.JToken">
<summary>
Performs an implicit conversion from <see cref="T:System.Nullable`1"/> of <see cref="T:System.Decimal"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
<returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Nullable{System.Double})~Newtonsoft.Json.Linq.JToken">
<summary>
Performs an implicit conversion from <see cref="T:System.Nullable`1"/> of <see cref="T:System.Double"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
<returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Int16)~Newtonsoft.Json.Linq.JToken">
<summary>
Performs an implicit conversion from <see cref="T:System.Int16"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
<returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.UInt16)~Newtonsoft.Json.Linq.JToken">
<summary>
Performs an implicit conversion from <see cref="T:System.UInt16"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
<returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Int32)~Newtonsoft.Json.Linq.JToken">
<summary>
Performs an implicit conversion from <see cref="T:System.Int32"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
<returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Nullable{System.Int32})~Newtonsoft.Json.Linq.JToken">
<summary>
Performs an implicit conversion from <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int32"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
<returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.DateTime)~Newtonsoft.Json.Linq.JToken">
<summary>
Performs an implicit conversion from <see cref="T:System.DateTime"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
<returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Nullable{System.Int64})~Newtonsoft.Json.Linq.JToken">
<summary>
Performs an implicit conversion from <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int64"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
<returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Nullable{System.Single})~Newtonsoft.Json.Linq.JToken">
<summary>
Performs an implicit conversion from <see cref="T:System.Nullable`1"/> of <see cref="T:System.Single"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
<returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Decimal)~Newtonsoft.Json.Linq.JToken">
<summary>
Performs an implicit conversion from <see cref="T:System.Decimal"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
<returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Nullable{System.Int16})~Newtonsoft.Json.Linq.JToken">
<summary>
Performs an implicit conversion from <see cref="T:System.Nullable`1"/> of <see cref="T:System.Int16"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
<returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Nullable{System.UInt16})~Newtonsoft.Json.Linq.JToken">
<summary>
Performs an implicit conversion from <see cref="T:System.Nullable`1"/> of <see cref="T:System.UInt16"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
<returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Nullable{System.UInt32})~Newtonsoft.Json.Linq.JToken">
<summary>
Performs an implicit conversion from <see cref="T:System.Nullable`1"/> of <see cref="T:System.UInt32"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
<returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Nullable{System.UInt64})~Newtonsoft.Json.Linq.JToken">
<summary>
Performs an implicit conversion from <see cref="T:System.Nullable`1"/> of <see cref="T:System.UInt64"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
<returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Double)~Newtonsoft.Json.Linq.JToken">
<summary>
Performs an implicit conversion from <see cref="T:System.Double"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
<returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Single)~Newtonsoft.Json.Linq.JToken">
<summary>
Performs an implicit conversion from <see cref="T:System.Single"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
<returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.String)~Newtonsoft.Json.Linq.JToken">
<summary>
Performs an implicit conversion from <see cref="T:System.String"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
<returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.UInt32)~Newtonsoft.Json.Linq.JToken">
<summary>
Performs an implicit conversion from <see cref="T:System.UInt32"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
<returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.UInt64)~Newtonsoft.Json.Linq.JToken">
<summary>
Performs an implicit conversion from <see cref="T:System.UInt64"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
<returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Byte[])~Newtonsoft.Json.Linq.JToken">
<summary>
Performs an implicit conversion from <see cref="T:System.Byte"/>[] to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
<returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Uri)~Newtonsoft.Json.Linq.JToken">
<summary>
Performs an implicit conversion from <see cref="T:System.Uri"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
<returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.TimeSpan)~Newtonsoft.Json.Linq.JToken">
<summary>
Performs an implicit conversion from <see cref="T:System.TimeSpan"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
<returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Nullable{System.TimeSpan})~Newtonsoft.Json.Linq.JToken">
<summary>
Performs an implicit conversion from <see cref="T:System.Nullable`1"/> of <see cref="T:System.TimeSpan"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
<returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Guid)~Newtonsoft.Json.Linq.JToken">
<summary>
Performs an implicit conversion from <see cref="T:System.Guid"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
<returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Nullable{System.Guid})~Newtonsoft.Json.Linq.JToken">
<summary>
Performs an implicit conversion from <see cref="T:System.Nullable`1"/> of <see cref="T:System.Guid"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
<returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.CreateReader">
<summary>
Creates a <see cref="T:Newtonsoft.Json.JsonReader"/> for this token.
</summary>
<returns>A <see cref="T:Newtonsoft.Json.JsonReader"/> that can be used to read this token and its descendants.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.FromObject(System.Object)">
<summary>
Creates a <see cref="T:Newtonsoft.Json.Linq.JToken"/> from an object.
</summary>
<param name="o">The object that will be used to create <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JToken"/> with the value of the specified object.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.FromObject(System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Creates a <see cref="T:Newtonsoft.Json.Linq.JToken"/> from an object using the specified <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
</summary>
<param name="o">The object that will be used to create <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</param>
<param name="jsonSerializer">The <see cref="T:Newtonsoft.Json.JsonSerializer"/> that will be used when reading the object.</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JToken"/> with the value of the specified object.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.ToObject``1">
<summary>
Creates an instance of the specified .NET type from the <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<typeparam name="T">The object type that the token will be deserialized to.</typeparam>
<returns>The new object created from the JSON value.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.ToObject(System.Type)">
<summary>
Creates an instance of the specified .NET type from the <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<param name="objectType">The object type that the token will be deserialized to.</param>
<returns>The new object created from the JSON value.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.ToObject``1(Newtonsoft.Json.JsonSerializer)">
<summary>
Creates an instance of the specified .NET type from the <see cref="T:Newtonsoft.Json.Linq.JToken"/> using the specified <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
</summary>
<typeparam name="T">The object type that the token will be deserialized to.</typeparam>
<param name="jsonSerializer">The <see cref="T:Newtonsoft.Json.JsonSerializer"/> that will be used when creating the object.</param>
<returns>The new object created from the JSON value.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.ToObject(System.Type,Newtonsoft.Json.JsonSerializer)">
<summary>
Creates an instance of the specified .NET type from the <see cref="T:Newtonsoft.Json.Linq.JToken"/> using the specified <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
</summary>
<param name="objectType">The object type that the token will be deserialized to.</param>
<param name="jsonSerializer">The <see cref="T:Newtonsoft.Json.JsonSerializer"/> that will be used when creating the object.</param>
<returns>The new object created from the JSON value.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.ReadFrom(Newtonsoft.Json.JsonReader)">
<summary>
Creates a <see cref="T:Newtonsoft.Json.Linq.JToken"/> from a <see cref="T:Newtonsoft.Json.JsonReader"/>.
</summary>
<param name="reader">A <see cref="T:Newtonsoft.Json.JsonReader"/> positioned at the token to read into this <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</param>
<returns>
A <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the token and its descendant tokens
that were read from the reader. The runtime type of the token is determined
by the token type of the first token encountered in the reader.
</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.ReadFrom(Newtonsoft.Json.JsonReader,Newtonsoft.Json.Linq.JsonLoadSettings)">
<summary>
Creates a <see cref="T:Newtonsoft.Json.Linq.JToken"/> from a <see cref="T:Newtonsoft.Json.JsonReader"/>.
</summary>
<param name="reader">An <see cref="T:Newtonsoft.Json.JsonReader"/> positioned at the token to read into this <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</param>
<param name="settings">The <see cref="T:Newtonsoft.Json.Linq.JsonLoadSettings"/> used to load the JSON.
If this is <c>null</c>, default load settings will be used.</param>
<returns>
A <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the token and its descendant tokens
that were read from the reader. The runtime type of the token is determined
by the token type of the first token encountered in the reader.
</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.Parse(System.String)">
<summary>
Load a <see cref="T:Newtonsoft.Json.Linq.JToken"/> from a string that contains JSON.
</summary>
<param name="json">A <see cref="T:System.String"/> that contains JSON.</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JToken"/> populated from the string that contains JSON.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.Parse(System.String,Newtonsoft.Json.Linq.JsonLoadSettings)">
<summary>
Load a <see cref="T:Newtonsoft.Json.Linq.JToken"/> from a string that contains JSON.
</summary>
<param name="json">A <see cref="T:System.String"/> that contains JSON.</param>
<param name="settings">The <see cref="T:Newtonsoft.Json.Linq.JsonLoadSettings"/> used to load the JSON.
If this is <c>null</c>, default load settings will be used.</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JToken"/> populated from the string that contains JSON.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.Load(Newtonsoft.Json.JsonReader,Newtonsoft.Json.Linq.JsonLoadSettings)">
<summary>
Creates a <see cref="T:Newtonsoft.Json.Linq.JToken"/> from a <see cref="T:Newtonsoft.Json.JsonReader"/>.
</summary>
<param name="reader">A <see cref="T:Newtonsoft.Json.JsonReader"/> positioned at the token to read into this <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</param>
<param name="settings">The <see cref="T:Newtonsoft.Json.Linq.JsonLoadSettings"/> used to load the JSON.
If this is <c>null</c>, default load settings will be used.</param>
<returns>
A <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the token and its descendant tokens
that were read from the reader. The runtime type of the token is determined
by the token type of the first token encountered in the reader.
</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.Load(Newtonsoft.Json.JsonReader)">
<summary>
Creates a <see cref="T:Newtonsoft.Json.Linq.JToken"/> from a <see cref="T:Newtonsoft.Json.JsonReader"/>.
</summary>
<param name="reader">A <see cref="T:Newtonsoft.Json.JsonReader"/> positioned at the token to read into this <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</param>
<returns>
A <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the token and its descendant tokens
that were read from the reader. The runtime type of the token is determined
by the token type of the first token encountered in the reader.
</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.SelectToken(System.String)">
<summary>
Selects a <see cref="T:Newtonsoft.Json.Linq.JToken"/> using a JSONPath expression. Selects the token that matches the object path.
</summary>
<param name="path">
A <see cref="T:System.String"/> that contains a JSONPath expression.
</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JToken"/>, or <c>null</c>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.SelectToken(System.String,System.Boolean)">
<summary>
Selects a <see cref="T:Newtonsoft.Json.Linq.JToken"/> using a JSONPath expression. Selects the token that matches the object path.
</summary>
<param name="path">
A <see cref="T:System.String"/> that contains a JSONPath expression.
</param>
<param name="errorWhenNoMatch">A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression.</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.SelectToken(System.String,Newtonsoft.Json.Linq.JsonSelectSettings)">
<summary>
Selects a <see cref="T:Newtonsoft.Json.Linq.JToken"/> using a JSONPath expression. Selects the token that matches the object path.
</summary>
<param name="path">
A <see cref="T:System.String"/> that contains a JSONPath expression.
</param>
<param name="settings">The <see cref="T:Newtonsoft.Json.Linq.JsonSelectSettings"/> used to select tokens.</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.SelectTokens(System.String)">
<summary>
Selects a collection of elements using a JSONPath expression.
</summary>
<param name="path">
A <see cref="T:System.String"/> that contains a JSONPath expression.
</param>
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the selected elements.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.SelectTokens(System.String,System.Boolean)">
<summary>
Selects a collection of elements using a JSONPath expression.
</summary>
<param name="path">
A <see cref="T:System.String"/> that contains a JSONPath expression.
</param>
<param name="errorWhenNoMatch">A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression.</param>
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the selected elements.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.SelectTokens(System.String,Newtonsoft.Json.Linq.JsonSelectSettings)">
<summary>
Selects a collection of elements using a JSONPath expression.
</summary>
<param name="path">
A <see cref="T:System.String"/> that contains a JSONPath expression.
</param>
<param name="settings">The <see cref="T:Newtonsoft.Json.Linq.JsonSelectSettings"/> used to select tokens.</param>
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the selected elements.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.GetMetaObject(System.Linq.Expressions.Expression)">
<summary>
Returns the <see cref="T:System.Dynamic.DynamicMetaObject"/> responsible for binding operations performed on this object.
</summary>
<param name="parameter">The expression tree representation of the runtime value.</param>
<returns>
The <see cref="T:System.Dynamic.DynamicMetaObject"/> to bind this object.
</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.System#Dynamic#IDynamicMetaObjectProvider#GetMetaObject(System.Linq.Expressions.Expression)">
<summary>
Returns the <see cref="T:System.Dynamic.DynamicMetaObject"/> responsible for binding operations performed on this object.
</summary>
<param name="parameter">The expression tree representation of the runtime value.</param>
<returns>
The <see cref="T:System.Dynamic.DynamicMetaObject"/> to bind this object.
</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.DeepClone">
<summary>
Creates a new instance of the <see cref="T:Newtonsoft.Json.Linq.JToken"/>. All child tokens are recursively cloned.
</summary>
<returns>A new instance of the <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.AddAnnotation(System.Object)">
<summary>
Adds an object to the annotation list of this <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<param name="annotation">The annotation to add.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.Annotation``1">
<summary>
Get the first annotation object of the specified type from this <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<typeparam name="T">The type of the annotation to retrieve.</typeparam>
<returns>The first annotation object that matches the specified type, or <c>null</c> if no annotation is of the specified type.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.Annotation(System.Type)">
<summary>
Gets the first annotation object of the specified type from this <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<param name="type">The <see cref="P:Newtonsoft.Json.Linq.JToken.Type"/> of the annotation to retrieve.</param>
<returns>The first annotation object that matches the specified type, or <c>null</c> if no annotation is of the specified type.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.Annotations``1">
<summary>
Gets a collection of annotations of the specified type for this <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<typeparam name="T">The type of the annotations to retrieve.</typeparam>
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> that contains the annotations for this <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.Annotations(System.Type)">
<summary>
Gets a collection of annotations of the specified type for this <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<param name="type">The <see cref="P:Newtonsoft.Json.Linq.JToken.Type"/> of the annotations to retrieve.</param>
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:System.Object"/> that contains the annotations that match the specified type for this <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.RemoveAnnotations``1">
<summary>
Removes the annotations of the specified type from this <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<typeparam name="T">The type of annotations to remove.</typeparam>
</member>
<member name="M:Newtonsoft.Json.Linq.JToken.RemoveAnnotations(System.Type)">
<summary>
Removes the annotations of the specified type from this <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<param name="type">The <see cref="P:Newtonsoft.Json.Linq.JToken.Type"/> of annotations to remove.</param>
</member>
<member name="T:Newtonsoft.Json.Linq.JTokenEqualityComparer">
<summary>
Compares tokens to determine whether they are equal.
</summary>
</member>
<member name="M:Newtonsoft.Json.Linq.JTokenEqualityComparer.Equals(Newtonsoft.Json.Linq.JToken,Newtonsoft.Json.Linq.JToken)">
<summary>
Determines whether the specified objects are equal.
</summary>
<param name="x">The first object of type <see cref="T:Newtonsoft.Json.Linq.JToken"/> to compare.</param>
<param name="y">The second object of type <see cref="T:Newtonsoft.Json.Linq.JToken"/> to compare.</param>
<returns>
<c>true</c> if the specified objects are equal; otherwise, <c>false</c>.
</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JTokenEqualityComparer.GetHashCode(Newtonsoft.Json.Linq.JToken)">
<summary>
Returns a hash code for the specified object.
</summary>
<param name="obj">The <see cref="T:System.Object"/> for which a hash code is to be returned.</param>
<returns>A hash code for the specified object.</returns>
<exception cref="T:System.ArgumentNullException">The type of <paramref name="obj"/> is a reference type and <paramref name="obj"/> is <c>null</c>.</exception>
</member>
<member name="T:Newtonsoft.Json.Linq.JTokenReader">
<summary>
Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data.
</summary>
</member>
<member name="P:Newtonsoft.Json.Linq.JTokenReader.CurrentToken">
<summary>
Gets the <see cref="T:Newtonsoft.Json.Linq.JToken"/> at the reader's current position.
</summary>
</member>
<member name="M:Newtonsoft.Json.Linq.JTokenReader.#ctor(Newtonsoft.Json.Linq.JToken)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JTokenReader"/> class.
</summary>
<param name="token">The token to read from.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JTokenReader.#ctor(Newtonsoft.Json.Linq.JToken,System.String)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JTokenReader"/> class.
</summary>
<param name="token">The token to read from.</param>
<param name="initialPath">The initial path of the token. It is prepended to the returned <see cref="P:Newtonsoft.Json.Linq.JTokenReader.Path"/>.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JTokenReader.Read">
<summary>
Reads the next JSON token from the underlying <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<returns>
<c>true</c> if the next token was read successfully; <c>false</c> if there are no more tokens to read.
</returns>
</member>
<member name="P:Newtonsoft.Json.Linq.JTokenReader.Path">
<summary>
Gets the path of the current JSON token.
</summary>
</member>
<member name="T:Newtonsoft.Json.Linq.JTokenType">
<summary>
Specifies the type of token.
</summary>
</member>
<member name="F:Newtonsoft.Json.Linq.JTokenType.None">
<summary>
No token type has been set.
</summary>
</member>
<member name="F:Newtonsoft.Json.Linq.JTokenType.Object">
<summary>
A JSON object.
</summary>
</member>
<member name="F:Newtonsoft.Json.Linq.JTokenType.Array">
<summary>
A JSON array.
</summary>
</member>
<member name="F:Newtonsoft.Json.Linq.JTokenType.Constructor">
<summary>
A JSON constructor.
</summary>
</member>
<member name="F:Newtonsoft.Json.Linq.JTokenType.Property">
<summary>
A JSON object property.
</summary>
</member>
<member name="F:Newtonsoft.Json.Linq.JTokenType.Comment">
<summary>
A comment.
</summary>
</member>
<member name="F:Newtonsoft.Json.Linq.JTokenType.Integer">
<summary>
An integer value.
</summary>
</member>
<member name="F:Newtonsoft.Json.Linq.JTokenType.Float">
<summary>
A float value.
</summary>
</member>
<member name="F:Newtonsoft.Json.Linq.JTokenType.String">
<summary>
A string value.
</summary>
</member>
<member name="F:Newtonsoft.Json.Linq.JTokenType.Boolean">
<summary>
A boolean value.
</summary>
</member>
<member name="F:Newtonsoft.Json.Linq.JTokenType.Null">
<summary>
A null value.
</summary>
</member>
<member name="F:Newtonsoft.Json.Linq.JTokenType.Undefined">
<summary>
An undefined value.
</summary>
</member>
<member name="F:Newtonsoft.Json.Linq.JTokenType.Date">
<summary>
A date value.
</summary>
</member>
<member name="F:Newtonsoft.Json.Linq.JTokenType.Raw">
<summary>
A raw JSON value.
</summary>
</member>
<member name="F:Newtonsoft.Json.Linq.JTokenType.Bytes">
<summary>
A collection of bytes value.
</summary>
</member>
<member name="F:Newtonsoft.Json.Linq.JTokenType.Guid">
<summary>
A Guid value.
</summary>
</member>
<member name="F:Newtonsoft.Json.Linq.JTokenType.Uri">
<summary>
A Uri value.
</summary>
</member>
<member name="F:Newtonsoft.Json.Linq.JTokenType.TimeSpan">
<summary>
A TimeSpan value.
</summary>
</member>
<member name="T:Newtonsoft.Json.Linq.JTokenWriter">
<summary>
Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data.
</summary>
</member>
<member name="P:Newtonsoft.Json.Linq.JTokenWriter.CurrentToken">
<summary>
Gets the <see cref="T:Newtonsoft.Json.Linq.JToken"/> at the writer's current position.
</summary>
</member>
<member name="P:Newtonsoft.Json.Linq.JTokenWriter.Token">
<summary>
Gets the token being written.
</summary>
<value>The token being written.</value>
</member>
<member name="M:Newtonsoft.Json.Linq.JTokenWriter.#ctor(Newtonsoft.Json.Linq.JContainer)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JTokenWriter"/> class writing to the given <see cref="T:Newtonsoft.Json.Linq.JContainer"/>.
</summary>
<param name="container">The container being written to.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JTokenWriter.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JTokenWriter"/> class.
</summary>
</member>
<member name="M:Newtonsoft.Json.Linq.JTokenWriter.Flush">
<summary>
Flushes whatever is in the buffer to the underlying <see cref="T:Newtonsoft.Json.Linq.JContainer"/>.
</summary>
</member>
<member name="M:Newtonsoft.Json.Linq.JTokenWriter.Close">
<summary>
Closes this writer.
If <see cref="P:Newtonsoft.Json.JsonWriter.AutoCompleteOnClose"/> is set to <c>true</c>, the JSON is auto-completed.
</summary>
<remarks>
Setting <see cref="P:Newtonsoft.Json.JsonWriter.CloseOutput"/> to <c>true</c> has no additional effect, since the underlying <see cref="T:Newtonsoft.Json.Linq.JContainer"/> is a type that cannot be closed.
</remarks>
</member>
<member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteStartObject">
<summary>
Writes the beginning of a JSON object.
</summary>
</member>
<member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteStartArray">
<summary>
Writes the beginning of a JSON array.
</summary>
</member>
<member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteStartConstructor(System.String)">
<summary>
Writes the start of a constructor with the given name.
</summary>
<param name="name">The name of the constructor.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteEnd(Newtonsoft.Json.JsonToken)">
<summary>
Writes the end.
</summary>
<param name="token">The token.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JTokenWriter.WritePropertyName(System.String)">
<summary>
Writes the property name of a name/value pair on a JSON object.
</summary>
<param name="name">The name of the property.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.Object)">
<summary>
Writes a <see cref="T:System.Object"/> value.
An error will be raised if the value cannot be written as a single JSON token.
</summary>
<param name="value">The <see cref="T:System.Object"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteNull">
<summary>
Writes a null value.
</summary>
</member>
<member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteUndefined">
<summary>
Writes an undefined value.
</summary>
</member>
<member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteRaw(System.String)">
<summary>
Writes raw JSON.
</summary>
<param name="json">The raw JSON to write.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteComment(System.String)">
<summary>
Writes a comment <c>/*...*/</c> containing the specified text.
</summary>
<param name="text">Text to place inside the comment.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.String)">
<summary>
Writes a <see cref="T:System.String"/> value.
</summary>
<param name="value">The <see cref="T:System.String"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.Int32)">
<summary>
Writes a <see cref="T:System.Int32"/> value.
</summary>
<param name="value">The <see cref="T:System.Int32"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.UInt32)">
<summary>
Writes a <see cref="T:System.UInt32"/> value.
</summary>
<param name="value">The <see cref="T:System.UInt32"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.Int64)">
<summary>
Writes a <see cref="T:System.Int64"/> value.
</summary>
<param name="value">The <see cref="T:System.Int64"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.UInt64)">
<summary>
Writes a <see cref="T:System.UInt64"/> value.
</summary>
<param name="value">The <see cref="T:System.UInt64"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.Single)">
<summary>
Writes a <see cref="T:System.Single"/> value.
</summary>
<param name="value">The <see cref="T:System.Single"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.Double)">
<summary>
Writes a <see cref="T:System.Double"/> value.
</summary>
<param name="value">The <see cref="T:System.Double"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.Boolean)">
<summary>
Writes a <see cref="T:System.Boolean"/> value.
</summary>
<param name="value">The <see cref="T:System.Boolean"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.Int16)">
<summary>
Writes a <see cref="T:System.Int16"/> value.
</summary>
<param name="value">The <see cref="T:System.Int16"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.UInt16)">
<summary>
Writes a <see cref="T:System.UInt16"/> value.
</summary>
<param name="value">The <see cref="T:System.UInt16"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.Char)">
<summary>
Writes a <see cref="T:System.Char"/> value.
</summary>
<param name="value">The <see cref="T:System.Char"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.Byte)">
<summary>
Writes a <see cref="T:System.Byte"/> value.
</summary>
<param name="value">The <see cref="T:System.Byte"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.SByte)">
<summary>
Writes a <see cref="T:System.SByte"/> value.
</summary>
<param name="value">The <see cref="T:System.SByte"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.Decimal)">
<summary>
Writes a <see cref="T:System.Decimal"/> value.
</summary>
<param name="value">The <see cref="T:System.Decimal"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.DateTime)">
<summary>
Writes a <see cref="T:System.DateTime"/> value.
</summary>
<param name="value">The <see cref="T:System.DateTime"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.DateTimeOffset)">
<summary>
Writes a <see cref="T:System.DateTimeOffset"/> value.
</summary>
<param name="value">The <see cref="T:System.DateTimeOffset"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.Byte[])">
<summary>
Writes a <see cref="T:System.Byte"/>[] value.
</summary>
<param name="value">The <see cref="T:System.Byte"/>[] value to write.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.TimeSpan)">
<summary>
Writes a <see cref="T:System.TimeSpan"/> value.
</summary>
<param name="value">The <see cref="T:System.TimeSpan"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.Guid)">
<summary>
Writes a <see cref="T:System.Guid"/> value.
</summary>
<param name="value">The <see cref="T:System.Guid"/> value to write.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.Uri)">
<summary>
Writes a <see cref="T:System.Uri"/> value.
</summary>
<param name="value">The <see cref="T:System.Uri"/> value to write.</param>
</member>
<member name="T:Newtonsoft.Json.Linq.JValue">
<summary>
Represents a value in JSON (string, integer, date, etc).
</summary>
</member>
<member name="M:Newtonsoft.Json.Linq.JValue.WriteToAsync(Newtonsoft.Json.JsonWriter,System.Threading.CancellationToken,Newtonsoft.Json.JsonConverter[])">
<summary>
Writes this token to a <see cref="T:Newtonsoft.Json.JsonWriter"/> asynchronously.
</summary>
<param name="writer">A <see cref="T:Newtonsoft.Json.JsonWriter"/> into which this method will write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
<param name="converters">A collection of <see cref="T:Newtonsoft.Json.JsonConverter"/> which will be used when writing the token.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous write operation.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JValue.#ctor(Newtonsoft.Json.Linq.JValue)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JValue"/> class from another <see cref="T:Newtonsoft.Json.Linq.JValue"/> object.
</summary>
<param name="other">A <see cref="T:Newtonsoft.Json.Linq.JValue"/> object to copy from.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JValue.#ctor(System.Int64)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JValue"/> class with the given value.
</summary>
<param name="value">The value.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JValue.#ctor(System.Decimal)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JValue"/> class with the given value.
</summary>
<param name="value">The value.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JValue.#ctor(System.Char)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JValue"/> class with the given value.
</summary>
<param name="value">The value.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JValue.#ctor(System.UInt64)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JValue"/> class with the given value.
</summary>
<param name="value">The value.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JValue.#ctor(System.Double)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JValue"/> class with the given value.
</summary>
<param name="value">The value.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JValue.#ctor(System.Single)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JValue"/> class with the given value.
</summary>
<param name="value">The value.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JValue.#ctor(System.DateTime)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JValue"/> class with the given value.
</summary>
<param name="value">The value.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JValue.#ctor(System.DateTimeOffset)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JValue"/> class with the given value.
</summary>
<param name="value">The value.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JValue.#ctor(System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JValue"/> class with the given value.
</summary>
<param name="value">The value.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JValue.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JValue"/> class with the given value.
</summary>
<param name="value">The value.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JValue.#ctor(System.Guid)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JValue"/> class with the given value.
</summary>
<param name="value">The value.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JValue.#ctor(System.Uri)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JValue"/> class with the given value.
</summary>
<param name="value">The value.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JValue.#ctor(System.TimeSpan)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JValue"/> class with the given value.
</summary>
<param name="value">The value.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JValue.#ctor(System.Object)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JValue"/> class with the given value.
</summary>
<param name="value">The value.</param>
</member>
<member name="P:Newtonsoft.Json.Linq.JValue.HasValues">
<summary>
Gets a value indicating whether this token has child tokens.
</summary>
<value>
<c>true</c> if this token has child values; otherwise, <c>false</c>.
</value>
</member>
<member name="M:Newtonsoft.Json.Linq.JValue.CreateComment(System.String)">
<summary>
Creates a <see cref="T:Newtonsoft.Json.Linq.JValue"/> comment with the given value.
</summary>
<param name="value">The value.</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JValue"/> comment with the given value.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JValue.CreateString(System.String)">
<summary>
Creates a <see cref="T:Newtonsoft.Json.Linq.JValue"/> string with the given value.
</summary>
<param name="value">The value.</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JValue"/> string with the given value.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JValue.CreateNull">
<summary>
Creates a <see cref="T:Newtonsoft.Json.Linq.JValue"/> null value.
</summary>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JValue"/> null value.</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JValue.CreateUndefined">
<summary>
Creates a <see cref="T:Newtonsoft.Json.Linq.JValue"/> undefined value.
</summary>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JValue"/> undefined value.</returns>
</member>
<member name="P:Newtonsoft.Json.Linq.JValue.Type">
<summary>
Gets the node type for this <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</summary>
<value>The type.</value>
</member>
<member name="P:Newtonsoft.Json.Linq.JValue.Value">
<summary>
Gets or sets the underlying token value.
</summary>
<value>The underlying token value.</value>
</member>
<member name="M:Newtonsoft.Json.Linq.JValue.WriteTo(Newtonsoft.Json.JsonWriter,Newtonsoft.Json.JsonConverter[])">
<summary>
Writes this token to a <see cref="T:Newtonsoft.Json.JsonWriter"/>.
</summary>
<param name="writer">A <see cref="T:Newtonsoft.Json.JsonWriter"/> into which this method will write.</param>
<param name="converters">A collection of <see cref="T:Newtonsoft.Json.JsonConverter"/>s which will be used when writing the token.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JValue.Equals(Newtonsoft.Json.Linq.JValue)">
<summary>
Indicates whether the current object is equal to another object of the same type.
</summary>
<returns>
<c>true</c> if the current object is equal to the <paramref name="other"/> parameter; otherwise, <c>false</c>.
</returns>
<param name="other">An object to compare with this object.</param>
</member>
<member name="M:Newtonsoft.Json.Linq.JValue.Equals(System.Object)">
<summary>
Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>.
</summary>
<param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:System.Object"/>.</param>
<returns>
<c>true</c> if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>; otherwise, <c>false</c>.
</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JValue.GetHashCode">
<summary>
Serves as a hash function for a particular type.
</summary>
<returns>
A hash code for the current <see cref="T:System.Object"/>.
</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JValue.ToString">
<summary>
Returns a <see cref="T:System.String"/> that represents this instance.
</summary>
<remarks>
<c>ToString()</c> returns a non-JSON string value for tokens with a type of <see cref="F:Newtonsoft.Json.Linq.JTokenType.String"/>.
If you want the JSON for all token types then you should use <see cref="M:Newtonsoft.Json.Linq.JValue.WriteTo(Newtonsoft.Json.JsonWriter,Newtonsoft.Json.JsonConverter[])"/>.
</remarks>
<returns>
A <see cref="T:System.String"/> that represents this instance.
</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JValue.ToString(System.String)">
<summary>
Returns a <see cref="T:System.String"/> that represents this instance.
</summary>
<param name="format">The format.</param>
<returns>
A <see cref="T:System.String"/> that represents this instance.
</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JValue.ToString(System.IFormatProvider)">
<summary>
Returns a <see cref="T:System.String"/> that represents this instance.
</summary>
<param name="formatProvider">The format provider.</param>
<returns>
A <see cref="T:System.String"/> that represents this instance.
</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JValue.ToString(System.String,System.IFormatProvider)">
<summary>
Returns a <see cref="T:System.String"/> that represents this instance.
</summary>
<param name="format">The format.</param>
<param name="formatProvider">The format provider.</param>
<returns>
A <see cref="T:System.String"/> that represents this instance.
</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JValue.GetMetaObject(System.Linq.Expressions.Expression)">
<summary>
Returns the <see cref="T:System.Dynamic.DynamicMetaObject"/> responsible for binding operations performed on this object.
</summary>
<param name="parameter">The expression tree representation of the runtime value.</param>
<returns>
The <see cref="T:System.Dynamic.DynamicMetaObject"/> to bind this object.
</returns>
</member>
<member name="M:Newtonsoft.Json.Linq.JValue.CompareTo(Newtonsoft.Json.Linq.JValue)">
<summary>
Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.
</summary>
<param name="obj">An object to compare with this instance.</param>
<returns>
A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has these meanings:
Value
Meaning
Less than zero
This instance is less than <paramref name="obj"/>.
Zero
This instance is equal to <paramref name="obj"/>.
Greater than zero
This instance is greater than <paramref name="obj"/>.
</returns>
<exception cref="T:System.ArgumentException">
<paramref name="obj"/> is not of the same type as this instance.
</exception>
</member>
<member name="T:Newtonsoft.Json.Linq.LineInfoHandling">
<summary>
Specifies how line information is handled when loading JSON.
</summary>
</member>
<member name="F:Newtonsoft.Json.Linq.LineInfoHandling.Ignore">
<summary>
Ignore line information.
</summary>
</member>
<member name="F:Newtonsoft.Json.Linq.LineInfoHandling.Load">
<summary>
Load line information.
</summary>
</member>
<member name="T:Newtonsoft.Json.Linq.MergeArrayHandling">
<summary>
Specifies how JSON arrays are merged together.
</summary>
</member>
<member name="F:Newtonsoft.Json.Linq.MergeArrayHandling.Concat">
<summary>Concatenate arrays.</summary>
</member>
<member name="F:Newtonsoft.Json.Linq.MergeArrayHandling.Union">
<summary>Union arrays, skipping items that already exist.</summary>
</member>
<member name="F:Newtonsoft.Json.Linq.MergeArrayHandling.Replace">
<summary>Replace all array items.</summary>
</member>
<member name="F:Newtonsoft.Json.Linq.MergeArrayHandling.Merge">
<summary>Merge array items together, matched by index.</summary>
</member>
<member name="T:Newtonsoft.Json.Linq.MergeNullValueHandling">
<summary>
Specifies how null value properties are merged.
</summary>
</member>
<member name="F:Newtonsoft.Json.Linq.MergeNullValueHandling.Ignore">
<summary>
The content's null value properties will be ignored during merging.
</summary>
</member>
<member name="F:Newtonsoft.Json.Linq.MergeNullValueHandling.Merge">
<summary>
The content's null value properties will be merged.
</summary>
</member>
<member name="T:Newtonsoft.Json.MemberSerialization">
<summary>
Specifies the member serialization options for the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
</summary>
</member>
<member name="F:Newtonsoft.Json.MemberSerialization.OptOut">
<summary>
All public members are serialized by default. Members can be excluded using <see cref="T:Newtonsoft.Json.JsonIgnoreAttribute"/> or <see cref="T:System.NonSerializedAttribute"/>.
This is the default member serialization mode.
</summary>
</member>
<member name="F:Newtonsoft.Json.MemberSerialization.OptIn">
<summary>
Only members marked with <see cref="T:Newtonsoft.Json.JsonPropertyAttribute"/> or <see cref="T:System.Runtime.Serialization.DataMemberAttribute"/> are serialized.
This member serialization mode can also be set by marking the class with <see cref="T:System.Runtime.Serialization.DataContractAttribute"/>.
</summary>
</member>
<member name="F:Newtonsoft.Json.MemberSerialization.Fields">
<summary>
All public and private fields are serialized. Members can be excluded using <see cref="T:Newtonsoft.Json.JsonIgnoreAttribute"/> or <see cref="T:System.NonSerializedAttribute"/>.
This member serialization mode can also be set by marking the class with <see cref="T:System.SerializableAttribute"/>
and setting IgnoreSerializableAttribute on <see cref="T:Newtonsoft.Json.Serialization.DefaultContractResolver"/> to <c>false</c>.
</summary>
</member>
<member name="T:Newtonsoft.Json.MetadataPropertyHandling">
<summary>
Specifies metadata property handling options for the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
</summary>
</member>
<member name="F:Newtonsoft.Json.MetadataPropertyHandling.Default">
<summary>
Read metadata properties located at the start of a JSON object.
</summary>
</member>
<member name="F:Newtonsoft.Json.MetadataPropertyHandling.ReadAhead">
<summary>
Read metadata properties located anywhere in a JSON object. Note that this setting will impact performance.
</summary>
</member>
<member name="F:Newtonsoft.Json.MetadataPropertyHandling.Ignore">
<summary>
Do not try to read metadata properties.
</summary>
</member>
<member name="T:Newtonsoft.Json.MissingMemberHandling">
<summary>
Specifies missing member handling options for the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
</summary>
</member>
<member name="F:Newtonsoft.Json.MissingMemberHandling.Ignore">
<summary>
Ignore a missing member and do not attempt to deserialize it.
</summary>
</member>
<member name="F:Newtonsoft.Json.MissingMemberHandling.Error">
<summary>
Throw a <see cref="T:Newtonsoft.Json.JsonSerializationException"/> when a missing member is encountered during deserialization.
</summary>
</member>
<member name="T:Newtonsoft.Json.NullValueHandling">
<summary>
Specifies null value handling options for the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
</summary>
<example>
<code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\SerializationTests.cs" region="ReducingSerializedJsonSizeNullValueHandlingObject" title="NullValueHandling Class" />
<code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\SerializationTests.cs" region="ReducingSerializedJsonSizeNullValueHandlingExample" title="NullValueHandling Ignore Example" />
</example>
</member>
<member name="F:Newtonsoft.Json.NullValueHandling.Include">
<summary>
Include null values when serializing and deserializing objects.
</summary>
</member>
<member name="F:Newtonsoft.Json.NullValueHandling.Ignore">
<summary>
Ignore null values when serializing and deserializing objects.
</summary>
</member>
<member name="T:Newtonsoft.Json.ObjectCreationHandling">
<summary>
Specifies how object creation is handled by the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
</summary>
</member>
<member name="F:Newtonsoft.Json.ObjectCreationHandling.Auto">
<summary>
Reuse existing objects, create new objects when needed.
</summary>
</member>
<member name="F:Newtonsoft.Json.ObjectCreationHandling.Reuse">
<summary>
Only reuse existing objects.
</summary>
</member>
<member name="F:Newtonsoft.Json.ObjectCreationHandling.Replace">
<summary>
Always create new objects.
</summary>
</member>
<member name="T:Newtonsoft.Json.PreserveReferencesHandling">
<summary>
Specifies reference handling options for the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
Note that references cannot be preserved when a value is set via a non-default constructor such as types that implement <see cref="T:System.Runtime.Serialization.ISerializable"/>.
</summary>
<example>
<code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\SerializationTests.cs" region="PreservingObjectReferencesOn" title="Preserve Object References" />
</example>
</member>
<member name="F:Newtonsoft.Json.PreserveReferencesHandling.None">
<summary>
Do not preserve references when serializing types.
</summary>
</member>
<member name="F:Newtonsoft.Json.PreserveReferencesHandling.Objects">
<summary>
Preserve references when serializing into a JSON object structure.
</summary>
</member>
<member name="F:Newtonsoft.Json.PreserveReferencesHandling.Arrays">
<summary>
Preserve references when serializing into a JSON array structure.
</summary>
</member>
<member name="F:Newtonsoft.Json.PreserveReferencesHandling.All">
<summary>
Preserve references when serializing.
</summary>
</member>
<member name="T:Newtonsoft.Json.ReferenceLoopHandling">
<summary>
Specifies reference loop handling options for the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
</summary>
</member>
<member name="F:Newtonsoft.Json.ReferenceLoopHandling.Error">
<summary>
Throw a <see cref="T:Newtonsoft.Json.JsonSerializationException"/> when a loop is encountered.
</summary>
</member>
<member name="F:Newtonsoft.Json.ReferenceLoopHandling.Ignore">
<summary>
Ignore loop references and do not serialize.
</summary>
</member>
<member name="F:Newtonsoft.Json.ReferenceLoopHandling.Serialize">
<summary>
Serialize loop references.
</summary>
</member>
<member name="T:Newtonsoft.Json.Required">
<summary>
Indicating whether a property is required.
</summary>
</member>
<member name="F:Newtonsoft.Json.Required.Default">
<summary>
The property is not required. The default state.
</summary>
</member>
<member name="F:Newtonsoft.Json.Required.AllowNull">
<summary>
The property must be defined in JSON but can be a null value.
</summary>
</member>
<member name="F:Newtonsoft.Json.Required.Always">
<summary>
The property must be defined in JSON and cannot be a null value.
</summary>
</member>
<member name="F:Newtonsoft.Json.Required.DisallowNull">
<summary>
The property is not required but it cannot be a null value.
</summary>
</member>
<member name="T:Newtonsoft.Json.Schema.Extensions">
<summary>
<para>
Contains the JSON schema extension methods.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
<member name="M:Newtonsoft.Json.Schema.Extensions.IsValid(Newtonsoft.Json.Linq.JToken,Newtonsoft.Json.Schema.JsonSchema)">
<summary>
<para>
Determines whether the <see cref="T:Newtonsoft.Json.Linq.JToken"/> is valid.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
<param name="source">The source <see cref="T:Newtonsoft.Json.Linq.JToken"/> to test.</param>
<param name="schema">The schema to test with.</param>
<returns>
<c>true</c> if the specified <see cref="T:Newtonsoft.Json.Linq.JToken"/> is valid; otherwise, <c>false</c>.
</returns>
</member>
<member name="M:Newtonsoft.Json.Schema.Extensions.IsValid(Newtonsoft.Json.Linq.JToken,Newtonsoft.Json.Schema.JsonSchema,System.Collections.Generic.IList{System.String}@)">
<summary>
<para>
Determines whether the <see cref="T:Newtonsoft.Json.Linq.JToken"/> is valid.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
<param name="source">The source <see cref="T:Newtonsoft.Json.Linq.JToken"/> to test.</param>
<param name="schema">The schema to test with.</param>
<param name="errorMessages">When this method returns, contains any error messages generated while validating. </param>
<returns>
<c>true</c> if the specified <see cref="T:Newtonsoft.Json.Linq.JToken"/> is valid; otherwise, <c>false</c>.
</returns>
</member>
<member name="M:Newtonsoft.Json.Schema.Extensions.Validate(Newtonsoft.Json.Linq.JToken,Newtonsoft.Json.Schema.JsonSchema)">
<summary>
<para>
Validates the specified <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
<param name="source">The source <see cref="T:Newtonsoft.Json.Linq.JToken"/> to test.</param>
<param name="schema">The schema to test with.</param>
</member>
<member name="M:Newtonsoft.Json.Schema.Extensions.Validate(Newtonsoft.Json.Linq.JToken,Newtonsoft.Json.Schema.JsonSchema,Newtonsoft.Json.Schema.ValidationEventHandler)">
<summary>
<para>
Validates the specified <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
<param name="source">The source <see cref="T:Newtonsoft.Json.Linq.JToken"/> to test.</param>
<param name="schema">The schema to test with.</param>
<param name="validationEventHandler">The validation event handler.</param>
</member>
<member name="T:Newtonsoft.Json.Schema.JsonSchema">
<summary>
<para>
An in-memory representation of a JSON Schema.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
<member name="P:Newtonsoft.Json.Schema.JsonSchema.Id">
<summary>
Gets or sets the id.
</summary>
</member>
<member name="P:Newtonsoft.Json.Schema.JsonSchema.Title">
<summary>
Gets or sets the title.
</summary>
</member>
<member name="P:Newtonsoft.Json.Schema.JsonSchema.Required">
<summary>
Gets or sets whether the object is required.
</summary>
</member>
<member name="P:Newtonsoft.Json.Schema.JsonSchema.ReadOnly">
<summary>
Gets or sets whether the object is read-only.
</summary>
</member>
<member name="P:Newtonsoft.Json.Schema.JsonSchema.Hidden">
<summary>
Gets or sets whether the object is visible to users.
</summary>
</member>
<member name="P:Newtonsoft.Json.Schema.JsonSchema.Transient">
<summary>
Gets or sets whether the object is transient.
</summary>
</member>
<member name="P:Newtonsoft.Json.Schema.JsonSchema.Description">
<summary>
Gets or sets the description of the object.
</summary>
</member>
<member name="P:Newtonsoft.Json.Schema.JsonSchema.Type">
<summary>
Gets or sets the types of values allowed by the object.
</summary>
<value>The type.</value>
</member>
<member name="P:Newtonsoft.Json.Schema.JsonSchema.Pattern">
<summary>
Gets or sets the pattern.
</summary>
<value>The pattern.</value>
</member>
<member name="P:Newtonsoft.Json.Schema.JsonSchema.MinimumLength">
<summary>
Gets or sets the minimum length.
</summary>
<value>The minimum length.</value>
</member>
<member name="P:Newtonsoft.Json.Schema.JsonSchema.MaximumLength">
<summary>
Gets or sets the maximum length.
</summary>
<value>The maximum length.</value>
</member>
<member name="P:Newtonsoft.Json.Schema.JsonSchema.DivisibleBy">
<summary>
Gets or sets a number that the value should be divisible by.
</summary>
<value>A number that the value should be divisible by.</value>
</member>
<member name="P:Newtonsoft.Json.Schema.JsonSchema.Minimum">
<summary>
Gets or sets the minimum.
</summary>
<value>The minimum.</value>
</member>
<member name="P:Newtonsoft.Json.Schema.JsonSchema.Maximum">
<summary>
Gets or sets the maximum.
</summary>
<value>The maximum.</value>
</member>
<member name="P:Newtonsoft.Json.Schema.JsonSchema.ExclusiveMinimum">
<summary>
Gets or sets a flag indicating whether the value can not equal the number defined by the <c>minimum</c> attribute (<see cref="P:Newtonsoft.Json.Schema.JsonSchema.Minimum"/>).
</summary>
<value>A flag indicating whether the value can not equal the number defined by the <c>minimum</c> attribute (<see cref="P:Newtonsoft.Json.Schema.JsonSchema.Minimum"/>).</value>
</member>
<member name="P:Newtonsoft.Json.Schema.JsonSchema.ExclusiveMaximum">
<summary>
Gets or sets a flag indicating whether the value can not equal the number defined by the <c>maximum</c> attribute (<see cref="P:Newtonsoft.Json.Schema.JsonSchema.Maximum"/>).
</summary>
<value>A flag indicating whether the value can not equal the number defined by the <c>maximum</c> attribute (<see cref="P:Newtonsoft.Json.Schema.JsonSchema.Maximum"/>).</value>
</member>
<member name="P:Newtonsoft.Json.Schema.JsonSchema.MinimumItems">
<summary>
Gets or sets the minimum number of items.
</summary>
<value>The minimum number of items.</value>
</member>
<member name="P:Newtonsoft.Json.Schema.JsonSchema.MaximumItems">
<summary>
Gets or sets the maximum number of items.
</summary>
<value>The maximum number of items.</value>
</member>
<member name="P:Newtonsoft.Json.Schema.JsonSchema.Items">
<summary>
Gets or sets the <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> of items.
</summary>
<value>The <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> of items.</value>
</member>
<member name="P:Newtonsoft.Json.Schema.JsonSchema.PositionalItemsValidation">
<summary>
Gets or sets a value indicating whether items in an array are validated using the <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> instance at their array position from <see cref="P:Newtonsoft.Json.Schema.JsonSchema.Items"/>.
</summary>
<value>
<c>true</c> if items are validated using their array position; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Newtonsoft.Json.Schema.JsonSchema.AdditionalItems">
<summary>
Gets or sets the <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> of additional items.
</summary>
<value>The <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> of additional items.</value>
</member>
<member name="P:Newtonsoft.Json.Schema.JsonSchema.AllowAdditionalItems">
<summary>
Gets or sets a value indicating whether additional items are allowed.
</summary>
<value>
<c>true</c> if additional items are allowed; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Newtonsoft.Json.Schema.JsonSchema.UniqueItems">
<summary>
Gets or sets whether the array items must be unique.
</summary>
</member>
<member name="P:Newtonsoft.Json.Schema.JsonSchema.Properties">
<summary>
Gets or sets the <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> of properties.
</summary>
<value>The <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> of properties.</value>
</member>
<member name="P:Newtonsoft.Json.Schema.JsonSchema.AdditionalProperties">
<summary>
Gets or sets the <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> of additional properties.
</summary>
<value>The <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> of additional properties.</value>
</member>
<member name="P:Newtonsoft.Json.Schema.JsonSchema.PatternProperties">
<summary>
Gets or sets the pattern properties.
</summary>
<value>The pattern properties.</value>
</member>
<member name="P:Newtonsoft.Json.Schema.JsonSchema.AllowAdditionalProperties">
<summary>
Gets or sets a value indicating whether additional properties are allowed.
</summary>
<value>
<c>true</c> if additional properties are allowed; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Newtonsoft.Json.Schema.JsonSchema.Requires">
<summary>
Gets or sets the required property if this property is present.
</summary>
<value>The required property if this property is present.</value>
</member>
<member name="P:Newtonsoft.Json.Schema.JsonSchema.Enum">
<summary>
Gets or sets the a collection of valid enum values allowed.
</summary>
<value>A collection of valid enum values allowed.</value>
</member>
<member name="P:Newtonsoft.Json.Schema.JsonSchema.Disallow">
<summary>
Gets or sets disallowed types.
</summary>
<value>The disallowed types.</value>
</member>
<member name="P:Newtonsoft.Json.Schema.JsonSchema.Default">
<summary>
Gets or sets the default value.
</summary>
<value>The default value.</value>
</member>
<member name="P:Newtonsoft.Json.Schema.JsonSchema.Extends">
<summary>
Gets or sets the collection of <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> that this schema extends.
</summary>
<value>The collection of <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> that this schema extends.</value>
</member>
<member name="P:Newtonsoft.Json.Schema.JsonSchema.Format">
<summary>
Gets or sets the format.
</summary>
<value>The format.</value>
</member>
<member name="M:Newtonsoft.Json.Schema.JsonSchema.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> class.
</summary>
</member>
<member name="M:Newtonsoft.Json.Schema.JsonSchema.Read(Newtonsoft.Json.JsonReader)">
<summary>
Reads a <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from the specified <see cref="T:Newtonsoft.Json.JsonReader"/>.
</summary>
<param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> containing the JSON Schema to read.</param>
<returns>The <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> object representing the JSON Schema.</returns>
</member>
<member name="M:Newtonsoft.Json.Schema.JsonSchema.Read(Newtonsoft.Json.JsonReader,Newtonsoft.Json.Schema.JsonSchemaResolver)">
<summary>
Reads a <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from the specified <see cref="T:Newtonsoft.Json.JsonReader"/>.
</summary>
<param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> containing the JSON Schema to read.</param>
<param name="resolver">The <see cref="T:Newtonsoft.Json.Schema.JsonSchemaResolver"/> to use when resolving schema references.</param>
<returns>The <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> object representing the JSON Schema.</returns>
</member>
<member name="M:Newtonsoft.Json.Schema.JsonSchema.Parse(System.String)">
<summary>
Load a <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from a string that contains JSON Schema.
</summary>
<param name="json">A <see cref="T:System.String"/> that contains JSON Schema.</param>
<returns>A <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> populated from the string that contains JSON Schema.</returns>
</member>
<member name="M:Newtonsoft.Json.Schema.JsonSchema.Parse(System.String,Newtonsoft.Json.Schema.JsonSchemaResolver)">
<summary>
Load a <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from a string that contains JSON Schema using the specified <see cref="T:Newtonsoft.Json.Schema.JsonSchemaResolver"/>.
</summary>
<param name="json">A <see cref="T:System.String"/> that contains JSON Schema.</param>
<param name="resolver">The resolver.</param>
<returns>A <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> populated from the string that contains JSON Schema.</returns>
</member>
<member name="M:Newtonsoft.Json.Schema.JsonSchema.WriteTo(Newtonsoft.Json.JsonWriter)">
<summary>
Writes this schema to a <see cref="T:Newtonsoft.Json.JsonWriter"/>.
</summary>
<param name="writer">A <see cref="T:Newtonsoft.Json.JsonWriter"/> into which this method will write.</param>
</member>
<member name="M:Newtonsoft.Json.Schema.JsonSchema.WriteTo(Newtonsoft.Json.JsonWriter,Newtonsoft.Json.Schema.JsonSchemaResolver)">
<summary>
Writes this schema to a <see cref="T:Newtonsoft.Json.JsonWriter"/> using the specified <see cref="T:Newtonsoft.Json.Schema.JsonSchemaResolver"/>.
</summary>
<param name="writer">A <see cref="T:Newtonsoft.Json.JsonWriter"/> into which this method will write.</param>
<param name="resolver">The resolver used.</param>
</member>
<member name="M:Newtonsoft.Json.Schema.JsonSchema.ToString">
<summary>
Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
</summary>
<returns>
A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
</returns>
</member>
<member name="T:Newtonsoft.Json.Schema.JsonSchemaException">
<summary>
<para>
Returns detailed information about the schema exception.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
<member name="P:Newtonsoft.Json.Schema.JsonSchemaException.LineNumber">
<summary>
Gets the line number indicating where the error occurred.
</summary>
<value>The line number indicating where the error occurred.</value>
</member>
<member name="P:Newtonsoft.Json.Schema.JsonSchemaException.LinePosition">
<summary>
Gets the line position indicating where the error occurred.
</summary>
<value>The line position indicating where the error occurred.</value>
</member>
<member name="P:Newtonsoft.Json.Schema.JsonSchemaException.Path">
<summary>
Gets the path to the JSON where the error occurred.
</summary>
<value>The path to the JSON where the error occurred.</value>
</member>
<member name="M:Newtonsoft.Json.Schema.JsonSchemaException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Schema.JsonSchemaException"/> class.
</summary>
</member>
<member name="M:Newtonsoft.Json.Schema.JsonSchemaException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Schema.JsonSchemaException"/> class
with a specified error message.
</summary>
<param name="message">The error message that explains the reason for the exception.</param>
</member>
<member name="M:Newtonsoft.Json.Schema.JsonSchemaException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Schema.JsonSchemaException"/> class
with a specified error message and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">The error message that explains the reason for the exception.</param>
<param name="innerException">The exception that is the cause of the current exception, or <c>null</c> if no inner exception is specified.</param>
</member>
<member name="M:Newtonsoft.Json.Schema.JsonSchemaException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Schema.JsonSchemaException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <c>null</c>.</exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <c>null</c> or <see cref="P:System.Exception.HResult"/> is zero (0).</exception>
</member>
<member name="T:Newtonsoft.Json.Schema.JsonSchemaGenerator">
<summary>
<para>
Generates a <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from a specified <see cref="T:System.Type"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
<member name="P:Newtonsoft.Json.Schema.JsonSchemaGenerator.UndefinedSchemaIdHandling">
<summary>
Gets or sets how undefined schemas are handled by the serializer.
</summary>
</member>
<member name="P:Newtonsoft.Json.Schema.JsonSchemaGenerator.ContractResolver">
<summary>
Gets or sets the contract resolver.
</summary>
<value>The contract resolver.</value>
</member>
<member name="M:Newtonsoft.Json.Schema.JsonSchemaGenerator.Generate(System.Type)">
<summary>
Generate a <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from the specified type.
</summary>
<param name="type">The type to generate a <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from.</param>
<returns>A <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> generated from the specified type.</returns>
</member>
<member name="M:Newtonsoft.Json.Schema.JsonSchemaGenerator.Generate(System.Type,Newtonsoft.Json.Schema.JsonSchemaResolver)">
<summary>
Generate a <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from the specified type.
</summary>
<param name="type">The type to generate a <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from.</param>
<param name="resolver">The <see cref="T:Newtonsoft.Json.Schema.JsonSchemaResolver"/> used to resolve schema references.</param>
<returns>A <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> generated from the specified type.</returns>
</member>
<member name="M:Newtonsoft.Json.Schema.JsonSchemaGenerator.Generate(System.Type,System.Boolean)">
<summary>
Generate a <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from the specified type.
</summary>
<param name="type">The type to generate a <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from.</param>
<param name="rootSchemaNullable">Specify whether the generated root <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> will be nullable.</param>
<returns>A <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> generated from the specified type.</returns>
</member>
<member name="M:Newtonsoft.Json.Schema.JsonSchemaGenerator.Generate(System.Type,Newtonsoft.Json.Schema.JsonSchemaResolver,System.Boolean)">
<summary>
Generate a <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from the specified type.
</summary>
<param name="type">The type to generate a <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from.</param>
<param name="resolver">The <see cref="T:Newtonsoft.Json.Schema.JsonSchemaResolver"/> used to resolve schema references.</param>
<param name="rootSchemaNullable">Specify whether the generated root <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> will be nullable.</param>
<returns>A <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> generated from the specified type.</returns>
</member>
<member name="T:Newtonsoft.Json.Schema.JsonSchemaResolver">
<summary>
<para>
Resolves <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from an id.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
<member name="P:Newtonsoft.Json.Schema.JsonSchemaResolver.LoadedSchemas">
<summary>
Gets or sets the loaded schemas.
</summary>
<value>The loaded schemas.</value>
</member>
<member name="M:Newtonsoft.Json.Schema.JsonSchemaResolver.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Schema.JsonSchemaResolver"/> class.
</summary>
</member>
<member name="M:Newtonsoft.Json.Schema.JsonSchemaResolver.GetSchema(System.String)">
<summary>
Gets a <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> for the specified reference.
</summary>
<param name="reference">The id.</param>
<returns>A <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> for the specified reference.</returns>
</member>
<member name="T:Newtonsoft.Json.Schema.JsonSchemaType">
<summary>
<para>
The value types allowed by the <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
<member name="F:Newtonsoft.Json.Schema.JsonSchemaType.None">
<summary>
No type specified.
</summary>
</member>
<member name="F:Newtonsoft.Json.Schema.JsonSchemaType.String">
<summary>
String type.
</summary>
</member>
<member name="F:Newtonsoft.Json.Schema.JsonSchemaType.Float">
<summary>
Float type.
</summary>
</member>
<member name="F:Newtonsoft.Json.Schema.JsonSchemaType.Integer">
<summary>
Integer type.
</summary>
</member>
<member name="F:Newtonsoft.Json.Schema.JsonSchemaType.Boolean">
<summary>
Boolean type.
</summary>
</member>
<member name="F:Newtonsoft.Json.Schema.JsonSchemaType.Object">
<summary>
Object type.
</summary>
</member>
<member name="F:Newtonsoft.Json.Schema.JsonSchemaType.Array">
<summary>
Array type.
</summary>
</member>
<member name="F:Newtonsoft.Json.Schema.JsonSchemaType.Null">
<summary>
Null type.
</summary>
</member>
<member name="F:Newtonsoft.Json.Schema.JsonSchemaType.Any">
<summary>
Any type.
</summary>
</member>
<member name="T:Newtonsoft.Json.Schema.UndefinedSchemaIdHandling">
<summary>
<para>
Specifies undefined schema Id handling options for the <see cref="T:Newtonsoft.Json.Schema.JsonSchemaGenerator"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
<member name="F:Newtonsoft.Json.Schema.UndefinedSchemaIdHandling.None">
<summary>
Do not infer a schema Id.
</summary>
</member>
<member name="F:Newtonsoft.Json.Schema.UndefinedSchemaIdHandling.UseTypeName">
<summary>
Use the .NET type name as the schema Id.
</summary>
</member>
<member name="F:Newtonsoft.Json.Schema.UndefinedSchemaIdHandling.UseAssemblyQualifiedName">
<summary>
Use the assembly qualified .NET type name as the schema Id.
</summary>
</member>
<member name="T:Newtonsoft.Json.Schema.ValidationEventArgs">
<summary>
<para>
Returns detailed information related to the <see cref="T:Newtonsoft.Json.Schema.ValidationEventHandler"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
<member name="P:Newtonsoft.Json.Schema.ValidationEventArgs.Exception">
<summary>
Gets the <see cref="T:Newtonsoft.Json.Schema.JsonSchemaException"/> associated with the validation error.
</summary>
<value>The JsonSchemaException associated with the validation error.</value>
</member>
<member name="P:Newtonsoft.Json.Schema.ValidationEventArgs.Path">
<summary>
Gets the path of the JSON location where the validation error occurred.
</summary>
<value>The path of the JSON location where the validation error occurred.</value>
</member>
<member name="P:Newtonsoft.Json.Schema.ValidationEventArgs.Message">
<summary>
Gets the text description corresponding to the validation error.
</summary>
<value>The text description.</value>
</member>
<member name="T:Newtonsoft.Json.Schema.ValidationEventHandler">
<summary>
<para>
Represents the callback method that will handle JSON schema validation events and the <see cref="T:Newtonsoft.Json.Schema.ValidationEventArgs"/>.
</para>
<note type="caution">
JSON Schema validation has been moved to its own package. See <see href="https://www.newtonsoft.com/jsonschema">https://www.newtonsoft.com/jsonschema</see> for more details.
</note>
</summary>
</member>
<member name="T:Newtonsoft.Json.Serialization.CamelCaseNamingStrategy">
<summary>
A camel case naming strategy.
</summary>
</member>
<member name="M:Newtonsoft.Json.Serialization.CamelCaseNamingStrategy.#ctor(System.Boolean,System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.CamelCaseNamingStrategy"/> class.
</summary>
<param name="processDictionaryKeys">
A flag indicating whether dictionary keys should be processed.
</param>
<param name="overrideSpecifiedNames">
A flag indicating whether explicitly specified property names should be processed,
e.g. a property name customized with a <see cref="T:Newtonsoft.Json.JsonPropertyAttribute"/>.
</param>
</member>
<member name="M:Newtonsoft.Json.Serialization.CamelCaseNamingStrategy.#ctor(System.Boolean,System.Boolean,System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.CamelCaseNamingStrategy"/> class.
</summary>
<param name="processDictionaryKeys">
A flag indicating whether dictionary keys should be processed.
</param>
<param name="overrideSpecifiedNames">
A flag indicating whether explicitly specified property names should be processed,
e.g. a property name customized with a <see cref="T:Newtonsoft.Json.JsonPropertyAttribute"/>.
</param>
<param name="processExtensionDataNames">
A flag indicating whether extension data names should be processed.
</param>
</member>
<member name="M:Newtonsoft.Json.Serialization.CamelCaseNamingStrategy.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.CamelCaseNamingStrategy"/> class.
</summary>
</member>
<member name="M:Newtonsoft.Json.Serialization.CamelCaseNamingStrategy.ResolvePropertyName(System.String)">
<summary>
Resolves the specified property name.
</summary>
<param name="name">The property name to resolve.</param>
<returns>The resolved property name.</returns>
</member>
<member name="T:Newtonsoft.Json.Serialization.CamelCasePropertyNamesContractResolver">
<summary>
Resolves member mappings for a type, camel casing property names.
</summary>
</member>
<member name="M:Newtonsoft.Json.Serialization.CamelCasePropertyNamesContractResolver.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.CamelCasePropertyNamesContractResolver"/> class.
</summary>
</member>
<member name="M:Newtonsoft.Json.Serialization.CamelCasePropertyNamesContractResolver.ResolveContract(System.Type)">
<summary>
Resolves the contract for a given type.
</summary>
<param name="type">The type to resolve a contract for.</param>
<returns>The contract for a given type.</returns>
</member>
<member name="T:Newtonsoft.Json.Serialization.DefaultContractResolver">
<summary>
Used by <see cref="T:Newtonsoft.Json.JsonSerializer"/> to resolve a <see cref="T:Newtonsoft.Json.Serialization.JsonContract"/> for a given <see cref="T:System.Type"/>.
</summary>
</member>
<member name="P:Newtonsoft.Json.Serialization.DefaultContractResolver.DynamicCodeGeneration">
<summary>
Gets a value indicating whether members are being get and set using dynamic code generation.
This value is determined by the runtime permissions available.
</summary>
<value>
<c>true</c> if using dynamic code generation; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.DefaultContractResolver.DefaultMembersSearchFlags">
<summary>
Gets or sets the default members search flags.
</summary>
<value>The default members search flags.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.DefaultContractResolver.SerializeCompilerGeneratedMembers">
<summary>
Gets or sets a value indicating whether compiler generated members should be serialized.
</summary>
<value>
<c>true</c> if serialized compiler generated members; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.DefaultContractResolver.IgnoreSerializableInterface">
<summary>
Gets or sets a value indicating whether to ignore the <see cref="T:System.Runtime.Serialization.ISerializable"/> interface when serializing and deserializing types.
</summary>
<value>
<c>true</c> if the <see cref="T:System.Runtime.Serialization.ISerializable"/> interface will be ignored when serializing and deserializing types; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.DefaultContractResolver.IgnoreSerializableAttribute">
<summary>
Gets or sets a value indicating whether to ignore the <see cref="T:System.SerializableAttribute"/> attribute when serializing and deserializing types.
</summary>
<value>
<c>true</c> if the <see cref="T:System.SerializableAttribute"/> attribute will be ignored when serializing and deserializing types; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.DefaultContractResolver.IgnoreIsSpecifiedMembers">
<summary>
Gets or sets a value indicating whether to ignore IsSpecified members when serializing and deserializing types.
</summary>
<value>
<c>true</c> if the IsSpecified members will be ignored when serializing and deserializing types; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.DefaultContractResolver.IgnoreShouldSerializeMembers">
<summary>
Gets or sets a value indicating whether to ignore ShouldSerialize members when serializing and deserializing types.
</summary>
<value>
<c>true</c> if the ShouldSerialize members will be ignored when serializing and deserializing types; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.DefaultContractResolver.NamingStrategy">
<summary>
Gets or sets the naming strategy used to resolve how property names and dictionary keys are serialized.
</summary>
<value>The naming strategy used to resolve how property names and dictionary keys are serialized.</value>
</member>
<member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.DefaultContractResolver"/> class.
</summary>
</member>
<member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.ResolveContract(System.Type)">
<summary>
Resolves the contract for a given type.
</summary>
<param name="type">The type to resolve a contract for.</param>
<returns>The contract for a given type.</returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.GetSerializableMembers(System.Type)">
<summary>
Gets the serializable members for the type.
</summary>
<param name="objectType">The type to get serializable members for.</param>
<returns>The serializable members for the type.</returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.CreateObjectContract(System.Type)">
<summary>
Creates a <see cref="T:Newtonsoft.Json.Serialization.JsonObjectContract"/> for the given type.
</summary>
<param name="objectType">Type of the object.</param>
<returns>A <see cref="T:Newtonsoft.Json.Serialization.JsonObjectContract"/> for the given type.</returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.CreateConstructorParameters(System.Reflection.ConstructorInfo,Newtonsoft.Json.Serialization.JsonPropertyCollection)">
<summary>
Creates the constructor parameters.
</summary>
<param name="constructor">The constructor to create properties for.</param>
<param name="memberProperties">The type's member properties.</param>
<returns>Properties for the given <see cref="T:System.Reflection.ConstructorInfo"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.CreatePropertyFromConstructorParameter(Newtonsoft.Json.Serialization.JsonProperty,System.Reflection.ParameterInfo)">
<summary>
Creates a <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> for the given <see cref="T:System.Reflection.ParameterInfo"/>.
</summary>
<param name="matchingMemberProperty">The matching member property.</param>
<param name="parameterInfo">The constructor parameter.</param>
<returns>A created <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> for the given <see cref="T:System.Reflection.ParameterInfo"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.ResolveContractConverter(System.Type)">
<summary>
Resolves the default <see cref="T:Newtonsoft.Json.JsonConverter" /> for the contract.
</summary>
<param name="objectType">Type of the object.</param>
<returns>The contract's default <see cref="T:Newtonsoft.Json.JsonConverter" />.</returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.CreateDictionaryContract(System.Type)">
<summary>
Creates a <see cref="T:Newtonsoft.Json.Serialization.JsonDictionaryContract"/> for the given type.
</summary>
<param name="objectType">Type of the object.</param>
<returns>A <see cref="T:Newtonsoft.Json.Serialization.JsonDictionaryContract"/> for the given type.</returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.CreateArrayContract(System.Type)">
<summary>
Creates a <see cref="T:Newtonsoft.Json.Serialization.JsonArrayContract"/> for the given type.
</summary>
<param name="objectType">Type of the object.</param>
<returns>A <see cref="T:Newtonsoft.Json.Serialization.JsonArrayContract"/> for the given type.</returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.CreatePrimitiveContract(System.Type)">
<summary>
Creates a <see cref="T:Newtonsoft.Json.Serialization.JsonPrimitiveContract"/> for the given type.
</summary>
<param name="objectType">Type of the object.</param>
<returns>A <see cref="T:Newtonsoft.Json.Serialization.JsonPrimitiveContract"/> for the given type.</returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.CreateLinqContract(System.Type)">
<summary>
Creates a <see cref="T:Newtonsoft.Json.Serialization.JsonLinqContract"/> for the given type.
</summary>
<param name="objectType">Type of the object.</param>
<returns>A <see cref="T:Newtonsoft.Json.Serialization.JsonLinqContract"/> for the given type.</returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.CreateISerializableContract(System.Type)">
<summary>
Creates a <see cref="T:Newtonsoft.Json.Serialization.JsonISerializableContract"/> for the given type.
</summary>
<param name="objectType">Type of the object.</param>
<returns>A <see cref="T:Newtonsoft.Json.Serialization.JsonISerializableContract"/> for the given type.</returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.CreateDynamicContract(System.Type)">
<summary>
Creates a <see cref="T:Newtonsoft.Json.Serialization.JsonDynamicContract"/> for the given type.
</summary>
<param name="objectType">Type of the object.</param>
<returns>A <see cref="T:Newtonsoft.Json.Serialization.JsonDynamicContract"/> for the given type.</returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.CreateStringContract(System.Type)">
<summary>
Creates a <see cref="T:Newtonsoft.Json.Serialization.JsonStringContract"/> for the given type.
</summary>
<param name="objectType">Type of the object.</param>
<returns>A <see cref="T:Newtonsoft.Json.Serialization.JsonStringContract"/> for the given type.</returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.CreateContract(System.Type)">
<summary>
Determines which contract type is created for the given type.
</summary>
<param name="objectType">Type of the object.</param>
<returns>A <see cref="T:Newtonsoft.Json.Serialization.JsonContract"/> for the given type.</returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.CreateProperties(System.Type,Newtonsoft.Json.MemberSerialization)">
<summary>
Creates properties for the given <see cref="T:Newtonsoft.Json.Serialization.JsonContract"/>.
</summary>
<param name="type">The type to create properties for.</param>
/// <param name="memberSerialization">The member serialization mode for the type.</param>
<returns>Properties for the given <see cref="T:Newtonsoft.Json.Serialization.JsonContract"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.CreateMemberValueProvider(System.Reflection.MemberInfo)">
<summary>
Creates the <see cref="T:Newtonsoft.Json.Serialization.IValueProvider"/> used by the serializer to get and set values from a member.
</summary>
<param name="member">The member.</param>
<returns>The <see cref="T:Newtonsoft.Json.Serialization.IValueProvider"/> used by the serializer to get and set values from a member.</returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.CreateProperty(System.Reflection.MemberInfo,Newtonsoft.Json.MemberSerialization)">
<summary>
Creates a <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> for the given <see cref="T:System.Reflection.MemberInfo"/>.
</summary>
<param name="memberSerialization">The member's parent <see cref="T:Newtonsoft.Json.MemberSerialization"/>.</param>
<param name="member">The member to create a <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> for.</param>
<returns>A created <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> for the given <see cref="T:System.Reflection.MemberInfo"/>.</returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.ResolvePropertyName(System.String)">
<summary>
Resolves the name of the property.
</summary>
<param name="propertyName">Name of the property.</param>
<returns>Resolved name of the property.</returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.ResolveExtensionDataName(System.String)">
<summary>
Resolves the name of the extension data. By default no changes are made to extension data names.
</summary>
<param name="extensionDataName">Name of the extension data.</param>
<returns>Resolved name of the extension data.</returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.ResolveDictionaryKey(System.String)">
<summary>
Resolves the key of the dictionary. By default <see cref="M:Newtonsoft.Json.Serialization.DefaultContractResolver.ResolvePropertyName(System.String)"/> is used to resolve dictionary keys.
</summary>
<param name="dictionaryKey">Key of the dictionary.</param>
<returns>Resolved key of the dictionary.</returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.GetResolvedPropertyName(System.String)">
<summary>
Gets the resolved name of the property.
</summary>
<param name="propertyName">Name of the property.</param>
<returns>Name of the property.</returns>
</member>
<member name="T:Newtonsoft.Json.Serialization.DefaultNamingStrategy">
<summary>
The default naming strategy. Property names and dictionary keys are unchanged.
</summary>
</member>
<member name="M:Newtonsoft.Json.Serialization.DefaultNamingStrategy.ResolvePropertyName(System.String)">
<summary>
Resolves the specified property name.
</summary>
<param name="name">The property name to resolve.</param>
<returns>The resolved property name.</returns>
</member>
<member name="T:Newtonsoft.Json.Serialization.DefaultSerializationBinder">
<summary>
The default serialization binder used when resolving and loading classes from type names.
</summary>
</member>
<member name="M:Newtonsoft.Json.Serialization.DefaultSerializationBinder.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.DefaultSerializationBinder"/> class.
</summary>
</member>
<member name="M:Newtonsoft.Json.Serialization.DefaultSerializationBinder.BindToType(System.String,System.String)">
<summary>
When overridden in a derived class, controls the binding of a serialized object to a type.
</summary>
<param name="assemblyName">Specifies the <see cref="T:System.Reflection.Assembly"/> name of the serialized object.</param>
<param name="typeName">Specifies the <see cref="T:System.Type"/> name of the serialized object.</param>
<returns>
The type of the object the formatter creates a new instance of.
</returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.DefaultSerializationBinder.BindToName(System.Type,System.String@,System.String@)">
<summary>
When overridden in a derived class, controls the binding of a serialized object to a type.
</summary>
<param name="serializedType">The type of the object the formatter creates a new instance of.</param>
<param name="assemblyName">Specifies the <see cref="T:System.Reflection.Assembly"/> name of the serialized object.</param>
<param name="typeName">Specifies the <see cref="T:System.Type"/> name of the serialized object.</param>
</member>
<member name="T:Newtonsoft.Json.Serialization.DiagnosticsTraceWriter">
<summary>
Represents a trace writer that writes to the application's <see cref="T:System.Diagnostics.TraceListener"/> instances.
</summary>
</member>
<member name="P:Newtonsoft.Json.Serialization.DiagnosticsTraceWriter.LevelFilter">
<summary>
Gets the <see cref="T:System.Diagnostics.TraceLevel"/> that will be used to filter the trace messages passed to the writer.
For example a filter level of <see cref="F:System.Diagnostics.TraceLevel.Info"/> will exclude <see cref="F:System.Diagnostics.TraceLevel.Verbose"/> messages and include <see cref="F:System.Diagnostics.TraceLevel.Info"/>,
<see cref="F:System.Diagnostics.TraceLevel.Warning"/> and <see cref="F:System.Diagnostics.TraceLevel.Error"/> messages.
</summary>
<value>
The <see cref="T:System.Diagnostics.TraceLevel"/> that will be used to filter the trace messages passed to the writer.
</value>
</member>
<member name="M:Newtonsoft.Json.Serialization.DiagnosticsTraceWriter.Trace(System.Diagnostics.TraceLevel,System.String,System.Exception)">
<summary>
Writes the specified trace level, message and optional exception.
</summary>
<param name="level">The <see cref="T:System.Diagnostics.TraceLevel"/> at which to write this trace.</param>
<param name="message">The trace message.</param>
<param name="ex">The trace exception. This parameter is optional.</param>
</member>
<member name="T:Newtonsoft.Json.Serialization.ErrorContext">
<summary>
Provides information surrounding an error.
</summary>
</member>
<member name="P:Newtonsoft.Json.Serialization.ErrorContext.Error">
<summary>
Gets the error.
</summary>
<value>The error.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.ErrorContext.OriginalObject">
<summary>
Gets the original object that caused the error.
</summary>
<value>The original object that caused the error.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.ErrorContext.Member">
<summary>
Gets the member that caused the error.
</summary>
<value>The member that caused the error.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.ErrorContext.Path">
<summary>
Gets the path of the JSON location where the error occurred.
</summary>
<value>The path of the JSON location where the error occurred.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.ErrorContext.Handled">
<summary>
Gets or sets a value indicating whether this <see cref="T:Newtonsoft.Json.Serialization.ErrorContext"/> is handled.
</summary>
<value><c>true</c> if handled; otherwise, <c>false</c>.</value>
</member>
<member name="T:Newtonsoft.Json.Serialization.ErrorEventArgs">
<summary>
Provides data for the Error event.
</summary>
</member>
<member name="P:Newtonsoft.Json.Serialization.ErrorEventArgs.CurrentObject">
<summary>
Gets the current object the error event is being raised against.
</summary>
<value>The current object the error event is being raised against.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.ErrorEventArgs.ErrorContext">
<summary>
Gets the error context.
</summary>
<value>The error context.</value>
</member>
<member name="M:Newtonsoft.Json.Serialization.ErrorEventArgs.#ctor(System.Object,Newtonsoft.Json.Serialization.ErrorContext)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.ErrorEventArgs"/> class.
</summary>
<param name="currentObject">The current object.</param>
<param name="errorContext">The error context.</param>
</member>
<member name="T:Newtonsoft.Json.Serialization.ExpressionValueProvider">
<summary>
Get and set values for a <see cref="T:System.Reflection.MemberInfo"/> using dynamic methods.
</summary>
</member>
<member name="M:Newtonsoft.Json.Serialization.ExpressionValueProvider.#ctor(System.Reflection.MemberInfo)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.ExpressionValueProvider"/> class.
</summary>
<param name="memberInfo">The member info.</param>
</member>
<member name="M:Newtonsoft.Json.Serialization.ExpressionValueProvider.SetValue(System.Object,System.Object)">
<summary>
Sets the value.
</summary>
<param name="target">The target to set the value on.</param>
<param name="value">The value to set on the target.</param>
</member>
<member name="M:Newtonsoft.Json.Serialization.ExpressionValueProvider.GetValue(System.Object)">
<summary>
Gets the value.
</summary>
<param name="target">The target to get the value from.</param>
<returns>The value.</returns>
</member>
<member name="T:Newtonsoft.Json.Serialization.IAttributeProvider">
<summary>
Provides methods to get attributes.
</summary>
</member>
<member name="M:Newtonsoft.Json.Serialization.IAttributeProvider.GetAttributes(System.Boolean)">
<summary>
Returns a collection of all of the attributes, or an empty collection if there are no attributes.
</summary>
<param name="inherit">When <c>true</c>, look up the hierarchy chain for the inherited custom attribute.</param>
<returns>A collection of <see cref="T:System.Attribute"/>s, or an empty collection.</returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.IAttributeProvider.GetAttributes(System.Type,System.Boolean)">
<summary>
Returns a collection of attributes, identified by type, or an empty collection if there are no attributes.
</summary>
<param name="attributeType">The type of the attributes.</param>
<param name="inherit">When <c>true</c>, look up the hierarchy chain for the inherited custom attribute.</param>
<returns>A collection of <see cref="T:System.Attribute"/>s, or an empty collection.</returns>
</member>
<member name="T:Newtonsoft.Json.Serialization.IContractResolver">
<summary>
Used by <see cref="T:Newtonsoft.Json.JsonSerializer"/> to resolve a <see cref="T:Newtonsoft.Json.Serialization.JsonContract"/> for a given <see cref="T:System.Type"/>.
</summary>
<example>
<code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\SerializationTests.cs" region="ReducingSerializedJsonSizeContractResolverObject" title="IContractResolver Class" />
<code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\SerializationTests.cs" region="ReducingSerializedJsonSizeContractResolverExample" title="IContractResolver Example" />
</example>
</member>
<member name="M:Newtonsoft.Json.Serialization.IContractResolver.ResolveContract(System.Type)">
<summary>
Resolves the contract for a given type.
</summary>
<param name="type">The type to resolve a contract for.</param>
<returns>The contract for a given type.</returns>
</member>
<member name="T:Newtonsoft.Json.Serialization.IReferenceResolver">
<summary>
Used to resolve references when serializing and deserializing JSON by the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
</summary>
</member>
<member name="M:Newtonsoft.Json.Serialization.IReferenceResolver.ResolveReference(System.Object,System.String)">
<summary>
Resolves a reference to its object.
</summary>
<param name="context">The serialization context.</param>
<param name="reference">The reference to resolve.</param>
<returns>The object that was resolved from the reference.</returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.IReferenceResolver.GetReference(System.Object,System.Object)">
<summary>
Gets the reference for the specified object.
</summary>
<param name="context">The serialization context.</param>
<param name="value">The object to get a reference for.</param>
<returns>The reference to the object.</returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.IReferenceResolver.IsReferenced(System.Object,System.Object)">
<summary>
Determines whether the specified object is referenced.
</summary>
<param name="context">The serialization context.</param>
<param name="value">The object to test for a reference.</param>
<returns>
<c>true</c> if the specified object is referenced; otherwise, <c>false</c>.
</returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.IReferenceResolver.AddReference(System.Object,System.String,System.Object)">
<summary>
Adds a reference to the specified object.
</summary>
<param name="context">The serialization context.</param>
<param name="reference">The reference.</param>
<param name="value">The object to reference.</param>
</member>
<member name="T:Newtonsoft.Json.Serialization.ISerializationBinder">
<summary>
Allows users to control class loading and mandate what class to load.
</summary>
</member>
<member name="M:Newtonsoft.Json.Serialization.ISerializationBinder.BindToType(System.String,System.String)">
<summary>
When implemented, controls the binding of a serialized object to a type.
</summary>
<param name="assemblyName">Specifies the <see cref="T:System.Reflection.Assembly"/> name of the serialized object.</param>
<param name="typeName">Specifies the <see cref="T:System.Type"/> name of the serialized object</param>
<returns>The type of the object the formatter creates a new instance of.</returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.ISerializationBinder.BindToName(System.Type,System.String@,System.String@)">
<summary>
When implemented, controls the binding of a serialized object to a type.
</summary>
<param name="serializedType">The type of the object the formatter creates a new instance of.</param>
<param name="assemblyName">Specifies the <see cref="T:System.Reflection.Assembly"/> name of the serialized object.</param>
<param name="typeName">Specifies the <see cref="T:System.Type"/> name of the serialized object.</param>
</member>
<member name="T:Newtonsoft.Json.Serialization.ITraceWriter">
<summary>
Represents a trace writer.
</summary>
</member>
<member name="P:Newtonsoft.Json.Serialization.ITraceWriter.LevelFilter">
<summary>
Gets the <see cref="T:System.Diagnostics.TraceLevel"/> that will be used to filter the trace messages passed to the writer.
For example a filter level of <see cref="F:System.Diagnostics.TraceLevel.Info"/> will exclude <see cref="F:System.Diagnostics.TraceLevel.Verbose"/> messages and include <see cref="F:System.Diagnostics.TraceLevel.Info"/>,
<see cref="F:System.Diagnostics.TraceLevel.Warning"/> and <see cref="F:System.Diagnostics.TraceLevel.Error"/> messages.
</summary>
<value>The <see cref="T:System.Diagnostics.TraceLevel"/> that will be used to filter the trace messages passed to the writer.</value>
</member>
<member name="M:Newtonsoft.Json.Serialization.ITraceWriter.Trace(System.Diagnostics.TraceLevel,System.String,System.Exception)">
<summary>
Writes the specified trace level, message and optional exception.
</summary>
<param name="level">The <see cref="T:System.Diagnostics.TraceLevel"/> at which to write this trace.</param>
<param name="message">The trace message.</param>
<param name="ex">The trace exception. This parameter is optional.</param>
</member>
<member name="T:Newtonsoft.Json.Serialization.IValueProvider">
<summary>
Provides methods to get and set values.
</summary>
</member>
<member name="M:Newtonsoft.Json.Serialization.IValueProvider.SetValue(System.Object,System.Object)">
<summary>
Sets the value.
</summary>
<param name="target">The target to set the value on.</param>
<param name="value">The value to set on the target.</param>
</member>
<member name="M:Newtonsoft.Json.Serialization.IValueProvider.GetValue(System.Object)">
<summary>
Gets the value.
</summary>
<param name="target">The target to get the value from.</param>
<returns>The value.</returns>
</member>
<member name="T:Newtonsoft.Json.Serialization.JsonArrayContract">
<summary>
Contract details for a <see cref="T:System.Type"/> used by the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
</summary>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonArrayContract.CollectionItemType">
<summary>
Gets the <see cref="T:System.Type"/> of the collection items.
</summary>
<value>The <see cref="T:System.Type"/> of the collection items.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonArrayContract.IsMultidimensionalArray">
<summary>
Gets a value indicating whether the collection type is a multidimensional array.
</summary>
<value><c>true</c> if the collection type is a multidimensional array; otherwise, <c>false</c>.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonArrayContract.OverrideCreator">
<summary>
Gets or sets the function used to create the object. When set this function will override <see cref="P:Newtonsoft.Json.Serialization.JsonContract.DefaultCreator"/>.
</summary>
<value>The function used to create the object.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonArrayContract.HasParameterizedCreator">
<summary>
Gets a value indicating whether the creator has a parameter with the collection values.
</summary>
<value><c>true</c> if the creator has a parameter with the collection values; otherwise, <c>false</c>.</value>
</member>
<member name="M:Newtonsoft.Json.Serialization.JsonArrayContract.#ctor(System.Type)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.JsonArrayContract"/> class.
</summary>
<param name="underlyingType">The underlying type for the contract.</param>
</member>
<member name="T:Newtonsoft.Json.Serialization.JsonContainerContract">
<summary>
Contract details for a <see cref="T:System.Type"/> used by the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
</summary>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonContainerContract.ItemConverter">
<summary>
Gets or sets the default collection items <see cref="T:Newtonsoft.Json.JsonConverter" />.
</summary>
<value>The converter.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonContainerContract.ItemIsReference">
<summary>
Gets or sets a value indicating whether the collection items preserve object references.
</summary>
<value><c>true</c> if collection items preserve object references; otherwise, <c>false</c>.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonContainerContract.ItemReferenceLoopHandling">
<summary>
Gets or sets the collection item reference loop handling.
</summary>
<value>The reference loop handling.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonContainerContract.ItemTypeNameHandling">
<summary>
Gets or sets the collection item type name handling.
</summary>
<value>The type name handling.</value>
</member>
<member name="M:Newtonsoft.Json.Serialization.JsonContainerContract.#ctor(System.Type)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.JsonContainerContract"/> class.
</summary>
<param name="underlyingType">The underlying type for the contract.</param>
</member>
<member name="T:Newtonsoft.Json.Serialization.SerializationCallback">
<summary>
Handles <see cref="T:Newtonsoft.Json.JsonSerializer"/> serialization callback events.
</summary>
<param name="o">The object that raised the callback event.</param>
<param name="context">The streaming context.</param>
</member>
<member name="T:Newtonsoft.Json.Serialization.SerializationErrorCallback">
<summary>
Handles <see cref="T:Newtonsoft.Json.JsonSerializer"/> serialization error callback events.
</summary>
<param name="o">The object that raised the callback event.</param>
<param name="context">The streaming context.</param>
<param name="errorContext">The error context.</param>
</member>
<member name="T:Newtonsoft.Json.Serialization.ExtensionDataSetter">
<summary>
Sets extension data for an object during deserialization.
</summary>
<param name="o">The object to set extension data on.</param>
<param name="key">The extension data key.</param>
<param name="value">The extension data value.</param>
</member>
<member name="T:Newtonsoft.Json.Serialization.ExtensionDataGetter">
<summary>
Gets extension data for an object during serialization.
</summary>
<param name="o">The object to set extension data on.</param>
</member>
<member name="T:Newtonsoft.Json.Serialization.JsonContract">
<summary>
Contract details for a <see cref="T:System.Type"/> used by the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
</summary>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonContract.UnderlyingType">
<summary>
Gets the underlying type for the contract.
</summary>
<value>The underlying type for the contract.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonContract.CreatedType">
<summary>
Gets or sets the type created during deserialization.
</summary>
<value>The type created during deserialization.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonContract.IsReference">
<summary>
Gets or sets whether this type contract is serialized as a reference.
</summary>
<value>Whether this type contract is serialized as a reference.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonContract.Converter">
<summary>
Gets or sets the default <see cref="T:Newtonsoft.Json.JsonConverter" /> for this contract.
</summary>
<value>The converter.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonContract.InternalConverter">
<summary>
Gets the internally resolved <see cref="T:Newtonsoft.Json.JsonConverter"/> for the contract's type.
This converter is used as a fallback converter when no other converter is resolved.
Setting <see cref="P:Newtonsoft.Json.Serialization.JsonContract.Converter"/> will always override this converter.
</summary>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonContract.OnDeserializedCallbacks">
<summary>
Gets or sets all methods called immediately after deserialization of the object.
</summary>
<value>The methods called immediately after deserialization of the object.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonContract.OnDeserializingCallbacks">
<summary>
Gets or sets all methods called during deserialization of the object.
</summary>
<value>The methods called during deserialization of the object.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonContract.OnSerializedCallbacks">
<summary>
Gets or sets all methods called after serialization of the object graph.
</summary>
<value>The methods called after serialization of the object graph.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonContract.OnSerializingCallbacks">
<summary>
Gets or sets all methods called before serialization of the object.
</summary>
<value>The methods called before serialization of the object.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonContract.OnErrorCallbacks">
<summary>
Gets or sets all method called when an error is thrown during the serialization of the object.
</summary>
<value>The methods called when an error is thrown during the serialization of the object.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonContract.DefaultCreator">
<summary>
Gets or sets the default creator method used to create the object.
</summary>
<value>The default creator method used to create the object.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonContract.DefaultCreatorNonPublic">
<summary>
Gets or sets a value indicating whether the default creator is non-public.
</summary>
<value><c>true</c> if the default object creator is non-public; otherwise, <c>false</c>.</value>
</member>
<member name="T:Newtonsoft.Json.Serialization.JsonDictionaryContract">
<summary>
Contract details for a <see cref="T:System.Type"/> used by the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
</summary>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonDictionaryContract.DictionaryKeyResolver">
<summary>
Gets or sets the dictionary key resolver.
</summary>
<value>The dictionary key resolver.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonDictionaryContract.DictionaryKeyType">
<summary>
Gets the <see cref="T:System.Type"/> of the dictionary keys.
</summary>
<value>The <see cref="T:System.Type"/> of the dictionary keys.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonDictionaryContract.DictionaryValueType">
<summary>
Gets the <see cref="T:System.Type"/> of the dictionary values.
</summary>
<value>The <see cref="T:System.Type"/> of the dictionary values.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonDictionaryContract.OverrideCreator">
<summary>
Gets or sets the function used to create the object. When set this function will override <see cref="P:Newtonsoft.Json.Serialization.JsonContract.DefaultCreator"/>.
</summary>
<value>The function used to create the object.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonDictionaryContract.HasParameterizedCreator">
<summary>
Gets a value indicating whether the creator has a parameter with the dictionary values.
</summary>
<value><c>true</c> if the creator has a parameter with the dictionary values; otherwise, <c>false</c>.</value>
</member>
<member name="M:Newtonsoft.Json.Serialization.JsonDictionaryContract.#ctor(System.Type)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.JsonDictionaryContract"/> class.
</summary>
<param name="underlyingType">The underlying type for the contract.</param>
</member>
<member name="T:Newtonsoft.Json.Serialization.JsonDynamicContract">
<summary>
Contract details for a <see cref="T:System.Type"/> used by the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
</summary>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonDynamicContract.Properties">
<summary>
Gets the object's properties.
</summary>
<value>The object's properties.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonDynamicContract.PropertyNameResolver">
<summary>
Gets or sets the property name resolver.
</summary>
<value>The property name resolver.</value>
</member>
<member name="M:Newtonsoft.Json.Serialization.JsonDynamicContract.#ctor(System.Type)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.JsonDynamicContract"/> class.
</summary>
<param name="underlyingType">The underlying type for the contract.</param>
</member>
<member name="T:Newtonsoft.Json.Serialization.JsonISerializableContract">
<summary>
Contract details for a <see cref="T:System.Type"/> used by the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
</summary>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonISerializableContract.ISerializableCreator">
<summary>
Gets or sets the <see cref="T:System.Runtime.Serialization.ISerializable"/> object constructor.
</summary>
<value>The <see cref="T:System.Runtime.Serialization.ISerializable"/> object constructor.</value>
</member>
<member name="M:Newtonsoft.Json.Serialization.JsonISerializableContract.#ctor(System.Type)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.JsonISerializableContract"/> class.
</summary>
<param name="underlyingType">The underlying type for the contract.</param>
</member>
<member name="T:Newtonsoft.Json.Serialization.JsonLinqContract">
<summary>
Contract details for a <see cref="T:System.Type"/> used by the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
</summary>
</member>
<member name="M:Newtonsoft.Json.Serialization.JsonLinqContract.#ctor(System.Type)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.JsonLinqContract"/> class.
</summary>
<param name="underlyingType">The underlying type for the contract.</param>
</member>
<member name="T:Newtonsoft.Json.Serialization.JsonObjectContract">
<summary>
Contract details for a <see cref="T:System.Type"/> used by the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
</summary>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonObjectContract.MemberSerialization">
<summary>
Gets or sets the object member serialization.
</summary>
<value>The member object serialization.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonObjectContract.MissingMemberHandling">
<summary>
Gets or sets the missing member handling used when deserializing this object.
</summary>
<value>The missing member handling.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonObjectContract.ItemRequired">
<summary>
Gets or sets a value that indicates whether the object's properties are required.
</summary>
<value>
A value indicating whether the object's properties are required.
</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonObjectContract.ItemNullValueHandling">
<summary>
Gets or sets how the object's properties with null values are handled during serialization and deserialization.
</summary>
<value>How the object's properties with null values are handled during serialization and deserialization.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonObjectContract.Properties">
<summary>
Gets the object's properties.
</summary>
<value>The object's properties.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonObjectContract.CreatorParameters">
<summary>
Gets a collection of <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> instances that define the parameters used with <see cref="P:Newtonsoft.Json.Serialization.JsonObjectContract.OverrideCreator"/>.
</summary>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonObjectContract.OverrideCreator">
<summary>
Gets or sets the function used to create the object. When set this function will override <see cref="P:Newtonsoft.Json.Serialization.JsonContract.DefaultCreator"/>.
This function is called with a collection of arguments which are defined by the <see cref="P:Newtonsoft.Json.Serialization.JsonObjectContract.CreatorParameters"/> collection.
</summary>
<value>The function used to create the object.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonObjectContract.ExtensionDataSetter">
<summary>
Gets or sets the extension data setter.
</summary>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonObjectContract.ExtensionDataGetter">
<summary>
Gets or sets the extension data getter.
</summary>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonObjectContract.ExtensionDataValueType">
<summary>
Gets or sets the extension data value type.
</summary>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonObjectContract.ExtensionDataNameResolver">
<summary>
Gets or sets the extension data name resolver.
</summary>
<value>The extension data name resolver.</value>
</member>
<member name="M:Newtonsoft.Json.Serialization.JsonObjectContract.#ctor(System.Type)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.JsonObjectContract"/> class.
</summary>
<param name="underlyingType">The underlying type for the contract.</param>
</member>
<member name="T:Newtonsoft.Json.Serialization.JsonPrimitiveContract">
<summary>
Contract details for a <see cref="T:System.Type"/> used by the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
</summary>
</member>
<member name="M:Newtonsoft.Json.Serialization.JsonPrimitiveContract.#ctor(System.Type)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.JsonPrimitiveContract"/> class.
</summary>
<param name="underlyingType">The underlying type for the contract.</param>
</member>
<member name="T:Newtonsoft.Json.Serialization.JsonProperty">
<summary>
Maps a JSON property to a .NET member or constructor parameter.
</summary>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonProperty.PropertyName">
<summary>
Gets or sets the name of the property.
</summary>
<value>The name of the property.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonProperty.DeclaringType">
<summary>
Gets or sets the type that declared this property.
</summary>
<value>The type that declared this property.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonProperty.Order">
<summary>
Gets or sets the order of serialization of a member.
</summary>
<value>The numeric order of serialization.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonProperty.UnderlyingName">
<summary>
Gets or sets the name of the underlying member or parameter.
</summary>
<value>The name of the underlying member or parameter.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonProperty.ValueProvider">
<summary>
Gets the <see cref="T:Newtonsoft.Json.Serialization.IValueProvider"/> that will get and set the <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> during serialization.
</summary>
<value>The <see cref="T:Newtonsoft.Json.Serialization.IValueProvider"/> that will get and set the <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> during serialization.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonProperty.AttributeProvider">
<summary>
Gets or sets the <see cref="T:Newtonsoft.Json.Serialization.IAttributeProvider"/> for this property.
</summary>
<value>The <see cref="T:Newtonsoft.Json.Serialization.IAttributeProvider"/> for this property.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonProperty.PropertyType">
<summary>
Gets or sets the type of the property.
</summary>
<value>The type of the property.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonProperty.Converter">
<summary>
Gets or sets the <see cref="T:Newtonsoft.Json.JsonConverter" /> for the property.
If set this converter takes precedence over the contract converter for the property type.
</summary>
<value>The converter.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonProperty.MemberConverter">
<summary>
Gets or sets the member converter.
</summary>
<value>The member converter.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonProperty.Ignored">
<summary>
Gets or sets a value indicating whether this <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> is ignored.
</summary>
<value><c>true</c> if ignored; otherwise, <c>false</c>.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonProperty.Readable">
<summary>
Gets or sets a value indicating whether this <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> is readable.
</summary>
<value><c>true</c> if readable; otherwise, <c>false</c>.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonProperty.Writable">
<summary>
Gets or sets a value indicating whether this <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> is writable.
</summary>
<value><c>true</c> if writable; otherwise, <c>false</c>.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonProperty.HasMemberAttribute">
<summary>
Gets or sets a value indicating whether this <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> has a member attribute.
</summary>
<value><c>true</c> if has a member attribute; otherwise, <c>false</c>.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonProperty.DefaultValue">
<summary>
Gets the default value.
</summary>
<value>The default value.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonProperty.Required">
<summary>
Gets or sets a value indicating whether this <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> is required.
</summary>
<value>A value indicating whether this <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> is required.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonProperty.IsRequiredSpecified">
<summary>
Gets a value indicating whether <see cref="P:Newtonsoft.Json.Serialization.JsonProperty.Required"/> has a value specified.
</summary>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonProperty.IsReference">
<summary>
Gets or sets a value indicating whether this property preserves object references.
</summary>
<value>
<c>true</c> if this instance is reference; otherwise, <c>false</c>.
</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonProperty.NullValueHandling">
<summary>
Gets or sets the property null value handling.
</summary>
<value>The null value handling.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonProperty.DefaultValueHandling">
<summary>
Gets or sets the property default value handling.
</summary>
<value>The default value handling.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonProperty.ReferenceLoopHandling">
<summary>
Gets or sets the property reference loop handling.
</summary>
<value>The reference loop handling.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonProperty.ObjectCreationHandling">
<summary>
Gets or sets the property object creation handling.
</summary>
<value>The object creation handling.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonProperty.TypeNameHandling">
<summary>
Gets or sets or sets the type name handling.
</summary>
<value>The type name handling.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonProperty.ShouldSerialize">
<summary>
Gets or sets a predicate used to determine whether the property should be serialized.
</summary>
<value>A predicate used to determine whether the property should be serialized.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonProperty.ShouldDeserialize">
<summary>
Gets or sets a predicate used to determine whether the property should be deserialized.
</summary>
<value>A predicate used to determine whether the property should be deserialized.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonProperty.GetIsSpecified">
<summary>
Gets or sets a predicate used to determine whether the property should be serialized.
</summary>
<value>A predicate used to determine whether the property should be serialized.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonProperty.SetIsSpecified">
<summary>
Gets or sets an action used to set whether the property has been deserialized.
</summary>
<value>An action used to set whether the property has been deserialized.</value>
</member>
<member name="M:Newtonsoft.Json.Serialization.JsonProperty.ToString">
<summary>
Returns a <see cref="T:System.String"/> that represents this instance.
</summary>
<returns>
A <see cref="T:System.String"/> that represents this instance.
</returns>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonProperty.ItemConverter">
<summary>
Gets or sets the converter used when serializing the property's collection items.
</summary>
<value>The collection's items converter.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonProperty.ItemIsReference">
<summary>
Gets or sets whether this property's collection items are serialized as a reference.
</summary>
<value>Whether this property's collection items are serialized as a reference.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonProperty.ItemTypeNameHandling">
<summary>
Gets or sets the type name handling used when serializing the property's collection items.
</summary>
<value>The collection's items type name handling.</value>
</member>
<member name="P:Newtonsoft.Json.Serialization.JsonProperty.ItemReferenceLoopHandling">
<summary>
Gets or sets the reference loop handling used when serializing the property's collection items.
</summary>
<value>The collection's items reference loop handling.</value>
</member>
<member name="T:Newtonsoft.Json.Serialization.JsonPropertyCollection">
<summary>
A collection of <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> objects.
</summary>
</member>
<member name="M:Newtonsoft.Json.Serialization.JsonPropertyCollection.#ctor(System.Type)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.JsonPropertyCollection"/> class.
</summary>
<param name="type">The type.</param>
</member>
<member name="M:Newtonsoft.Json.Serialization.JsonPropertyCollection.GetKeyForItem(Newtonsoft.Json.Serialization.JsonProperty)">
<summary>
When implemented in a derived class, extracts the key from the specified element.
</summary>
<param name="item">The element from which to extract the key.</param>
<returns>The key for the specified element.</returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.JsonPropertyCollection.AddProperty(Newtonsoft.Json.Serialization.JsonProperty)">
<summary>
Adds a <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> object.
</summary>
<param name="property">The property to add to the collection.</param>
</member>
<member name="M:Newtonsoft.Json.Serialization.JsonPropertyCollection.GetClosestMatchProperty(System.String)">
<summary>
Gets the closest matching <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> object.
First attempts to get an exact case match of <paramref name="propertyName"/> and then
a case insensitive match.
</summary>
<param name="propertyName">Name of the property.</param>
<returns>A matching property if found.</returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.JsonPropertyCollection.GetProperty(System.String,System.StringComparison)">
<summary>
Gets a property by property name.
</summary>
<param name="propertyName">The name of the property to get.</param>
<param name="comparisonType">Type property name string comparison.</param>
<returns>A matching property if found.</returns>
</member>
<member name="T:Newtonsoft.Json.Serialization.JsonStringContract">
<summary>
Contract details for a <see cref="T:System.Type"/> used by the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
</summary>
</member>
<member name="M:Newtonsoft.Json.Serialization.JsonStringContract.#ctor(System.Type)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.JsonStringContract"/> class.
</summary>
<param name="underlyingType">The underlying type for the contract.</param>
</member>
<member name="M:Newtonsoft.Json.Serialization.JsonTypeReflector.CreateJsonConverterInstance(System.Type,System.Object[])">
<summary>
Lookup and create an instance of the <see cref="T:Newtonsoft.Json.JsonConverter"/> type described by the argument.
</summary>
<param name="converterType">The <see cref="T:Newtonsoft.Json.JsonConverter"/> type to create.</param>
<param name="args">Optional arguments to pass to an initializing constructor of the JsonConverter.
If <c>null</c>, the default constructor is used.</param>
</member>
<member name="T:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy">
<summary>
A kebab case naming strategy.
</summary>
</member>
<member name="M:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy.#ctor(System.Boolean,System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy"/> class.
</summary>
<param name="processDictionaryKeys">
A flag indicating whether dictionary keys should be processed.
</param>
<param name="overrideSpecifiedNames">
A flag indicating whether explicitly specified property names should be processed,
e.g. a property name customized with a <see cref="T:Newtonsoft.Json.JsonPropertyAttribute"/>.
</param>
</member>
<member name="M:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy.#ctor(System.Boolean,System.Boolean,System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy"/> class.
</summary>
<param name="processDictionaryKeys">
A flag indicating whether dictionary keys should be processed.
</param>
<param name="overrideSpecifiedNames">
A flag indicating whether explicitly specified property names should be processed,
e.g. a property name customized with a <see cref="T:Newtonsoft.Json.JsonPropertyAttribute"/>.
</param>
<param name="processExtensionDataNames">
A flag indicating whether extension data names should be processed.
</param>
</member>
<member name="M:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy"/> class.
</summary>
</member>
<member name="M:Newtonsoft.Json.Serialization.KebabCaseNamingStrategy.ResolvePropertyName(System.String)">
<summary>
Resolves the specified property name.
</summary>
<param name="name">The property name to resolve.</param>
<returns>The resolved property name.</returns>
</member>
<member name="T:Newtonsoft.Json.Serialization.MemoryTraceWriter">
<summary>
Represents a trace writer that writes to memory. When the trace message limit is
reached then old trace messages will be removed as new messages are added.
</summary>
</member>
<member name="P:Newtonsoft.Json.Serialization.MemoryTraceWriter.LevelFilter">
<summary>
Gets the <see cref="T:System.Diagnostics.TraceLevel"/> that will be used to filter the trace messages passed to the writer.
For example a filter level of <see cref="F:System.Diagnostics.TraceLevel.Info"/> will exclude <see cref="F:System.Diagnostics.TraceLevel.Verbose"/> messages and include <see cref="F:System.Diagnostics.TraceLevel.Info"/>,
<see cref="F:System.Diagnostics.TraceLevel.Warning"/> and <see cref="F:System.Diagnostics.TraceLevel.Error"/> messages.
</summary>
<value>
The <see cref="T:System.Diagnostics.TraceLevel"/> that will be used to filter the trace messages passed to the writer.
</value>
</member>
<member name="M:Newtonsoft.Json.Serialization.MemoryTraceWriter.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.MemoryTraceWriter"/> class.
</summary>
</member>
<member name="M:Newtonsoft.Json.Serialization.MemoryTraceWriter.Trace(System.Diagnostics.TraceLevel,System.String,System.Exception)">
<summary>
Writes the specified trace level, message and optional exception.
</summary>
<param name="level">The <see cref="T:System.Diagnostics.TraceLevel"/> at which to write this trace.</param>
<param name="message">The trace message.</param>
<param name="ex">The trace exception. This parameter is optional.</param>
</member>
<member name="M:Newtonsoft.Json.Serialization.MemoryTraceWriter.GetTraceMessages">
<summary>
Returns an enumeration of the most recent trace messages.
</summary>
<returns>An enumeration of the most recent trace messages.</returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.MemoryTraceWriter.ToString">
<summary>
Returns a <see cref="T:System.String"/> of the most recent trace messages.
</summary>
<returns>
A <see cref="T:System.String"/> of the most recent trace messages.
</returns>
</member>
<member name="T:Newtonsoft.Json.Serialization.NamingStrategy">
<summary>
A base class for resolving how property names and dictionary keys are serialized.
</summary>
</member>
<member name="P:Newtonsoft.Json.Serialization.NamingStrategy.ProcessDictionaryKeys">
<summary>
A flag indicating whether dictionary keys should be processed.
Defaults to <c>false</c>.
</summary>
</member>
<member name="P:Newtonsoft.Json.Serialization.NamingStrategy.ProcessExtensionDataNames">
<summary>
A flag indicating whether extension data names should be processed.
Defaults to <c>false</c>.
</summary>
</member>
<member name="P:Newtonsoft.Json.Serialization.NamingStrategy.OverrideSpecifiedNames">
<summary>
A flag indicating whether explicitly specified property names,
e.g. a property name customized with a <see cref="T:Newtonsoft.Json.JsonPropertyAttribute"/>, should be processed.
Defaults to <c>false</c>.
</summary>
</member>
<member name="M:Newtonsoft.Json.Serialization.NamingStrategy.GetPropertyName(System.String,System.Boolean)">
<summary>
Gets the serialized name for a given property name.
</summary>
<param name="name">The initial property name.</param>
<param name="hasSpecifiedName">A flag indicating whether the property has had a name explicitly specified.</param>
<returns>The serialized property name.</returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.NamingStrategy.GetExtensionDataName(System.String)">
<summary>
Gets the serialized name for a given extension data name.
</summary>
<param name="name">The initial extension data name.</param>
<returns>The serialized extension data name.</returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.NamingStrategy.GetDictionaryKey(System.String)">
<summary>
Gets the serialized key for a given dictionary key.
</summary>
<param name="key">The initial dictionary key.</param>
<returns>The serialized dictionary key.</returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.NamingStrategy.ResolvePropertyName(System.String)">
<summary>
Resolves the specified property name.
</summary>
<param name="name">The property name to resolve.</param>
<returns>The resolved property name.</returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.NamingStrategy.GetHashCode">
<summary>
Hash code calculation
</summary>
<returns></returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.NamingStrategy.Equals(System.Object)">
<summary>
Object equality implementation
</summary>
<param name="obj"></param>
<returns></returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.NamingStrategy.Equals(Newtonsoft.Json.Serialization.NamingStrategy)">
<summary>
Compare to another NamingStrategy
</summary>
<param name="other"></param>
<returns></returns>
</member>
<member name="T:Newtonsoft.Json.Serialization.ObjectConstructor`1">
<summary>
Represents a method that constructs an object.
</summary>
<typeparam name="T">The object type to create.</typeparam>
</member>
<member name="T:Newtonsoft.Json.Serialization.OnErrorAttribute">
<summary>
When applied to a method, specifies that the method is called when an error occurs serializing an object.
</summary>
</member>
<member name="T:Newtonsoft.Json.Serialization.ReflectionAttributeProvider">
<summary>
Provides methods to get attributes from a <see cref="T:System.Type"/>, <see cref="T:System.Reflection.MemberInfo"/>, <see cref="T:System.Reflection.ParameterInfo"/> or <see cref="T:System.Reflection.Assembly"/>.
</summary>
</member>
<member name="M:Newtonsoft.Json.Serialization.ReflectionAttributeProvider.#ctor(System.Object)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.ReflectionAttributeProvider"/> class.
</summary>
<param name="attributeProvider">The instance to get attributes for. This parameter should be a <see cref="T:System.Type"/>, <see cref="T:System.Reflection.MemberInfo"/>, <see cref="T:System.Reflection.ParameterInfo"/> or <see cref="T:System.Reflection.Assembly"/>.</param>
</member>
<member name="M:Newtonsoft.Json.Serialization.ReflectionAttributeProvider.GetAttributes(System.Boolean)">
<summary>
Returns a collection of all of the attributes, or an empty collection if there are no attributes.
</summary>
<param name="inherit">When <c>true</c>, look up the hierarchy chain for the inherited custom attribute.</param>
<returns>A collection of <see cref="T:System.Attribute"/>s, or an empty collection.</returns>
</member>
<member name="M:Newtonsoft.Json.Serialization.ReflectionAttributeProvider.GetAttributes(System.Type,System.Boolean)">
<summary>
Returns a collection of attributes, identified by type, or an empty collection if there are no attributes.
</summary>
<param name="attributeType">The type of the attributes.</param>
<param name="inherit">When <c>true</c>, look up the hierarchy chain for the inherited custom attribute.</param>
<returns>A collection of <see cref="T:System.Attribute"/>s, or an empty collection.</returns>
</member>
<member name="T:Newtonsoft.Json.Serialization.ReflectionValueProvider">
<summary>
Get and set values for a <see cref="T:System.Reflection.MemberInfo"/> using reflection.
</summary>
</member>
<member name="M:Newtonsoft.Json.Serialization.ReflectionValueProvider.#ctor(System.Reflection.MemberInfo)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.ReflectionValueProvider"/> class.
</summary>
<param name="memberInfo">The member info.</param>
</member>
<member name="M:Newtonsoft.Json.Serialization.ReflectionValueProvider.SetValue(System.Object,System.Object)">
<summary>
Sets the value.
</summary>
<param name="target">The target to set the value on.</param>
<param name="value">The value to set on the target.</param>
</member>
<member name="M:Newtonsoft.Json.Serialization.ReflectionValueProvider.GetValue(System.Object)">
<summary>
Gets the value.
</summary>
<param name="target">The target to get the value from.</param>
<returns>The value.</returns>
</member>
<member name="T:Newtonsoft.Json.Serialization.SnakeCaseNamingStrategy">
<summary>
A snake case naming strategy.
</summary>
</member>
<member name="M:Newtonsoft.Json.Serialization.SnakeCaseNamingStrategy.#ctor(System.Boolean,System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.SnakeCaseNamingStrategy"/> class.
</summary>
<param name="processDictionaryKeys">
A flag indicating whether dictionary keys should be processed.
</param>
<param name="overrideSpecifiedNames">
A flag indicating whether explicitly specified property names should be processed,
e.g. a property name customized with a <see cref="T:Newtonsoft.Json.JsonPropertyAttribute"/>.
</param>
</member>
<member name="M:Newtonsoft.Json.Serialization.SnakeCaseNamingStrategy.#ctor(System.Boolean,System.Boolean,System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.SnakeCaseNamingStrategy"/> class.
</summary>
<param name="processDictionaryKeys">
A flag indicating whether dictionary keys should be processed.
</param>
<param name="overrideSpecifiedNames">
A flag indicating whether explicitly specified property names should be processed,
e.g. a property name customized with a <see cref="T:Newtonsoft.Json.JsonPropertyAttribute"/>.
</param>
<param name="processExtensionDataNames">
A flag indicating whether extension data names should be processed.
</param>
</member>
<member name="M:Newtonsoft.Json.Serialization.SnakeCaseNamingStrategy.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.SnakeCaseNamingStrategy"/> class.
</summary>
</member>
<member name="M:Newtonsoft.Json.Serialization.SnakeCaseNamingStrategy.ResolvePropertyName(System.String)">
<summary>
Resolves the specified property name.
</summary>
<param name="name">The property name to resolve.</param>
<returns>The resolved property name.</returns>
</member>
<member name="T:Newtonsoft.Json.StringEscapeHandling">
<summary>
Specifies how strings are escaped when writing JSON text.
</summary>
</member>
<member name="F:Newtonsoft.Json.StringEscapeHandling.Default">
<summary>
Only control characters (e.g. newline) are escaped.
</summary>
</member>
<member name="F:Newtonsoft.Json.StringEscapeHandling.EscapeNonAscii">
<summary>
All non-ASCII and control characters (e.g. newline) are escaped.
</summary>
</member>
<member name="F:Newtonsoft.Json.StringEscapeHandling.EscapeHtml">
<summary>
HTML (<, >, &, ', ") and control characters (e.g. newline) are escaped.
</summary>
</member>
<member name="T:Newtonsoft.Json.TypeNameAssemblyFormatHandling">
<summary>
Indicates the method that will be used during deserialization for locating and loading assemblies.
</summary>
</member>
<member name="F:Newtonsoft.Json.TypeNameAssemblyFormatHandling.Simple">
<summary>
In simple mode, the assembly used during deserialization need not match exactly the assembly used during serialization. Specifically, the version numbers need not match as the <c>LoadWithPartialName</c> method of the <see cref="T:System.Reflection.Assembly"/> class is used to load the assembly.
</summary>
</member>
<member name="F:Newtonsoft.Json.TypeNameAssemblyFormatHandling.Full">
<summary>
In full mode, the assembly used during deserialization must match exactly the assembly used during serialization. The <c>Load</c> method of the <see cref="T:System.Reflection.Assembly"/> class is used to load the assembly.
</summary>
</member>
<member name="T:Newtonsoft.Json.TypeNameHandling">
<summary>
Specifies type name handling options for the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
</summary>
<remarks>
<see cref="P:Newtonsoft.Json.JsonSerializer.TypeNameHandling"/> should be used with caution when your application deserializes JSON from an external source.
Incoming types should be validated with a custom <see cref="P:Newtonsoft.Json.JsonSerializer.SerializationBinder"/>
when deserializing with a value other than <see cref="F:Newtonsoft.Json.TypeNameHandling.None"/>.
</remarks>
</member>
<member name="F:Newtonsoft.Json.TypeNameHandling.None">
<summary>
Do not include the .NET type name when serializing types.
</summary>
</member>
<member name="F:Newtonsoft.Json.TypeNameHandling.Objects">
<summary>
Include the .NET type name when serializing into a JSON object structure.
</summary>
</member>
<member name="F:Newtonsoft.Json.TypeNameHandling.Arrays">
<summary>
Include the .NET type name when serializing into a JSON array structure.
</summary>
</member>
<member name="F:Newtonsoft.Json.TypeNameHandling.All">
<summary>
Always include the .NET type name when serializing.
</summary>
</member>
<member name="F:Newtonsoft.Json.TypeNameHandling.Auto">
<summary>
Include the .NET type name when the type of the object being serialized is not the same as its declared type.
Note that this doesn't include the root serialized object by default. To include the root object's type name in JSON
you must specify a root type object with <see cref="M:Newtonsoft.Json.JsonConvert.SerializeObject(System.Object,System.Type,Newtonsoft.Json.JsonSerializerSettings)"/>
or <see cref="M:Newtonsoft.Json.JsonSerializer.Serialize(Newtonsoft.Json.JsonWriter,System.Object,System.Type)"/>.
</summary>
</member>
<member name="M:Newtonsoft.Json.Utilities.CollectionUtils.IsNullOrEmpty``1(System.Collections.Generic.ICollection{``0})">
<summary>
Determines whether the collection is <c>null</c> or empty.
</summary>
<param name="collection">The collection.</param>
<returns>
<c>true</c> if the collection is <c>null</c> or empty; otherwise, <c>false</c>.
</returns>
</member>
<member name="M:Newtonsoft.Json.Utilities.CollectionUtils.AddRange``1(System.Collections.Generic.IList{``0},System.Collections.Generic.IEnumerable{``0})">
<summary>
Adds the elements of the specified collection to the specified generic <see cref="T:System.Collections.Generic.IList`1"/>.
</summary>
<param name="initial">The list to add to.</param>
<param name="collection">The collection of elements to add.</param>
</member>
<member name="M:Newtonsoft.Json.Utilities.ConvertUtils.ConvertOrCast(System.Object,System.Globalization.CultureInfo,System.Type)">
<summary>
Converts the value to the specified type. If the value is unable to be converted, the
value is checked whether it assignable to the specified type.
</summary>
<param name="initialValue">The value to convert.</param>
<param name="culture">The culture to use when converting.</param>
<param name="targetType">The type to convert or cast the value to.</param>
<returns>
The converted type. If conversion was unsuccessful, the initial value
is returned if assignable to the target type.
</returns>
</member>
<member name="M:Newtonsoft.Json.Utilities.DynamicProxyMetaObject`1.CallMethodWithResult(System.String,System.Dynamic.DynamicMetaObjectBinder,System.Collections.Generic.IEnumerable{System.Linq.Expressions.Expression},Newtonsoft.Json.Utilities.DynamicProxyMetaObject{`0}.Fallback,Newtonsoft.Json.Utilities.DynamicProxyMetaObject{`0}.Fallback)">
<summary>
Helper method for generating a MetaObject which calls a
specific method on Dynamic that returns a result
</summary>
</member>
<member name="M:Newtonsoft.Json.Utilities.DynamicProxyMetaObject`1.CallMethodReturnLast(System.String,System.Dynamic.DynamicMetaObjectBinder,System.Collections.Generic.IEnumerable{System.Linq.Expressions.Expression},Newtonsoft.Json.Utilities.DynamicProxyMetaObject{`0}.Fallback)">
<summary>
Helper method for generating a MetaObject which calls a
specific method on Dynamic, but uses one of the arguments for
the result.
</summary>
</member>
<member name="M:Newtonsoft.Json.Utilities.DynamicProxyMetaObject`1.CallMethodNoResult(System.String,System.Dynamic.DynamicMetaObjectBinder,System.Linq.Expressions.Expression[],Newtonsoft.Json.Utilities.DynamicProxyMetaObject{`0}.Fallback)">
<summary>
Helper method for generating a MetaObject which calls a
specific method on Dynamic, but uses one of the arguments for
the result.
</summary>
</member>
<member name="M:Newtonsoft.Json.Utilities.DynamicProxyMetaObject`1.GetRestrictions">
<summary>
Returns a Restrictions object which includes our current restrictions merged
with a restriction limiting our type
</summary>
</member>
<member name="T:Newtonsoft.Json.Utilities.ImmutableCollectionsUtils">
<summary>
Helper class for serializing immutable collections.
Note that this is used by all builds, even those that don't support immutable collections, in case the DLL is GACed
https://github.com/JamesNK/Newtonsoft.Json/issues/652
</summary>
</member>
<member name="M:Newtonsoft.Json.Utilities.ReflectionUtils.GetCollectionItemType(System.Type)">
<summary>
Gets the type of the typed collection's items.
</summary>
<param name="type">The type.</param>
<returns>The type of the typed collection's items.</returns>
</member>
<member name="M:Newtonsoft.Json.Utilities.ReflectionUtils.GetMemberUnderlyingType(System.Reflection.MemberInfo)">
<summary>
Gets the member's underlying type.
</summary>
<param name="member">The member.</param>
<returns>The underlying type of the member.</returns>
</member>
<member name="M:Newtonsoft.Json.Utilities.ReflectionUtils.IsIndexedProperty(System.Reflection.PropertyInfo)">
<summary>
Determines whether the property is an indexed property.
</summary>
<param name="property">The property.</param>
<returns>
<c>true</c> if the property is an indexed property; otherwise, <c>false</c>.
</returns>
</member>
<member name="M:Newtonsoft.Json.Utilities.ReflectionUtils.GetMemberValue(System.Reflection.MemberInfo,System.Object)">
<summary>
Gets the member's value on the object.
</summary>
<param name="member">The member.</param>
<param name="target">The target object.</param>
<returns>The member's value on the object.</returns>
</member>
<member name="M:Newtonsoft.Json.Utilities.ReflectionUtils.SetMemberValue(System.Reflection.MemberInfo,System.Object,System.Object)">
<summary>
Sets the member's value on the target object.
</summary>
<param name="member">The member.</param>
<param name="target">The target.</param>
<param name="value">The value.</param>
</member>
<member name="M:Newtonsoft.Json.Utilities.ReflectionUtils.CanReadMemberValue(System.Reflection.MemberInfo,System.Boolean)">
<summary>
Determines whether the specified MemberInfo can be read.
</summary>
<param name="member">The MemberInfo to determine whether can be read.</param>
/// <param name="nonPublic">if set to <c>true</c> then allow the member to be gotten non-publicly.</param>
<returns>
<c>true</c> if the specified MemberInfo can be read; otherwise, <c>false</c>.
</returns>
</member>
<member name="M:Newtonsoft.Json.Utilities.ReflectionUtils.CanSetMemberValue(System.Reflection.MemberInfo,System.Boolean,System.Boolean)">
<summary>
Determines whether the specified MemberInfo can be set.
</summary>
<param name="member">The MemberInfo to determine whether can be set.</param>
<param name="nonPublic">if set to <c>true</c> then allow the member to be set non-publicly.</param>
<param name="canSetReadOnly">if set to <c>true</c> then allow the member to be set if read-only.</param>
<returns>
<c>true</c> if the specified MemberInfo can be set; otherwise, <c>false</c>.
</returns>
</member>
<member name="T:Newtonsoft.Json.Utilities.StringBuffer">
<summary>
Builds a string. Unlike <see cref="T:System.Text.StringBuilder"/> this class lets you reuse its internal buffer.
</summary>
</member>
<member name="M:Newtonsoft.Json.Utilities.StringUtils.IsWhiteSpace(System.String)">
<summary>
Determines whether the string is all white space. Empty string will return <c>false</c>.
</summary>
<param name="s">The string to test whether it is all white space.</param>
<returns>
<c>true</c> if the string is all white space; otherwise, <c>false</c>.
</returns>
</member>
<member name="T:Newtonsoft.Json.WriteState">
<summary>
Specifies the state of the <see cref="T:Newtonsoft.Json.JsonWriter"/>.
</summary>
</member>
<member name="F:Newtonsoft.Json.WriteState.Error">
<summary>
An exception has been thrown, which has left the <see cref="T:Newtonsoft.Json.JsonWriter"/> in an invalid state.
You may call the <see cref="M:Newtonsoft.Json.JsonWriter.Close"/> method to put the <see cref="T:Newtonsoft.Json.JsonWriter"/> in the <c>Closed</c> state.
Any other <see cref="T:Newtonsoft.Json.JsonWriter"/> method calls result in an <see cref="T:System.InvalidOperationException"/> being thrown.
</summary>
</member>
<member name="F:Newtonsoft.Json.WriteState.Closed">
<summary>
The <see cref="M:Newtonsoft.Json.JsonWriter.Close"/> method has been called.
</summary>
</member>
<member name="F:Newtonsoft.Json.WriteState.Object">
<summary>
An object is being written.
</summary>
</member>
<member name="F:Newtonsoft.Json.WriteState.Array">
<summary>
An array is being written.
</summary>
</member>
<member name="F:Newtonsoft.Json.WriteState.Constructor">
<summary>
A constructor is being written.
</summary>
</member>
<member name="F:Newtonsoft.Json.WriteState.Property">
<summary>
A property is being written.
</summary>
</member>
<member name="F:Newtonsoft.Json.WriteState.Start">
<summary>
A <see cref="T:Newtonsoft.Json.JsonWriter"/> write method has not been called.
</summary>
</member>
<member name="T:System.Diagnostics.CodeAnalysis.NotNullAttribute">
<summary>Specifies that an output will not be null even if the corresponding type allows it.</summary>
</member>
<member name="T:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute">
<summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue"/>, the parameter will not be null even if the corresponding type allows it.</summary>
</member>
<member name="M:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.#ctor(System.Boolean)">
<summary>Initializes the attribute with the specified return value condition.</summary>
<param name="returnValue">
The return value condition. If the method returns this value, the associated parameter will not be null.
</param>
</member>
<member name="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue">
<summary>Gets the return value condition.</summary>
</member>
<member name="T:System.Diagnostics.CodeAnalysis.MaybeNullAttribute">
<summary>Specifies that an output may be null even if the corresponding type disallows it.</summary>
</member>
<member name="T:System.Diagnostics.CodeAnalysis.AllowNullAttribute">
<summary>Specifies that null is allowed as an input even if the corresponding type disallows it.</summary>
</member>
<member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute">
<summary>
Specifies that the method will not return if the associated Boolean parameter is passed the specified value.
</summary>
</member>
<member name="M:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.#ctor(System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute"/> class.
</summary>
<param name="parameterValue">
The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to
the associated parameter matches this value.
</param>
</member>
<member name="P:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.ParameterValue">
<summary>Gets the condition parameter value.</summary>
</member>
</members>
</doc>
md5: A5C076BC389037D1A144FA141B85AFCF | sha1: B878CF34726A2E04A9114D5D7DBEAB56028BFF0B | sha256: 7F4819F271C8B78E05F0801B0F760AB18442D62C472D150347185A48B19DBACA | sha512: 9C79B7E08ED5F973F5731F29D61BAE76FD6CC497CFF1671176CF7F687C6E464996992B39541B04364D501046EC48A550891636B789BE0716405BB9226C086A6E
<?xml version="1.0"?>
<doc>
<assembly>
<name>NuGet.Common</name>
</assembly>
<members>
<member name="T:NuGet.Common.ActivityCorrelationId">
<summary>
Ambient correlation ID used to associate information pertaining to a current activity. A single activity
engages multiple method calls at different layers. Sometimes it's necessary to identify separate calls
belonging to the same activity if shared state is needed.
</summary>
</member>
<member name="P:NuGet.Common.ActivityCorrelationId.Current">
<summary>
Returns current activity correlation ID or a default if not set previously.
</summary>
</member>
<member name="M:NuGet.Common.ActivityCorrelationId.StartNew">
<summary>
Starts a new activity activity correlation ID by updating ambient context value.
</summary>
</member>
<member name="T:NuGet.Common.AggregateEnumerableAsync`1">
<summary>
Aggregates from a list of already ordered enumerables
The ordered result will contain only unique values
If comparer/EqualityComparer are not provided the default ones for that type will be used.
If the provided enumerables are not sorted already, the behavior is undefined
</summary>
</member>
<member name="T:NuGet.Common.AggregateEnumeratorAsync`1">
<summary>
Aggregates from a list of already ordered enumerables
The ordered result will contain only unique values
If comparer/EqualityComparer are not provided the default ones for that type will be used.
If the provided enumerables are not sorted already, the behavior is undefined
</summary>
</member>
<member name="T:NuGet.Common.IEnumeratorAsync`1">
<summary>
Supports async iteration over a generic collection.
Prior to calling Current, MoveNextAsync needs to be called otherwise the behavior is undefined
</summary>
<typeparam name="T">The type of objects to enumerate.This type parameter is covariant. That is, you can use either the type you specified or any type that is more derived. For more information about covariance and contravariance, see Covariance and Contravariance in Generics.</typeparam><filterpriority>1</filterpriority>
</member>
<member name="P:NuGet.Common.IEnumeratorAsync`1.Current">
<summary>
Gets the element in the collection at the current position of the enumerator.
If <ref>MoveNextAsync</ref> has not been called prior to calling current the behavior is undefined
If the last <ref>MoveNextAsync</ref> call returned false then the next call to Current should throw an InvalidOperationException
</summary>
<returns>
The element in the collection at the current position of the enumerator.
</returns>
</member>
<member name="M:NuGet.Common.IEnumeratorAsync`1.MoveNextAsync">
<summary>
Moves the pointer to the next element in the collection.
</summary>
<returns>
Success status of the pointer move
</returns>
</member>
<member name="T:NuGet.Common.AsyncLazy`1">
<summary>
Wrapper class representing shorter syntax of Lazy<Task<T>>"/>.
Useful when declaring a lazy async factory of value T.
</summary>
<typeparam name="T">Value type</typeparam>
</member>
<member name="T:NuGet.Common.AsyncLazy">
<summary>
Shortcuts to common Lazy<Task<T>> constructor calls
</summary>
</member>
<member name="T:NuGet.Common.AuthTypeFilteredCredentials">
<summary>
Wraps a NetworkCredentials object by returning null if the authType is not in a specified allow list
</summary>
</member>
<member name="M:NuGet.Common.AuthTypeFilteredCredentials.#ctor(System.Net.NetworkCredential,System.Collections.Generic.IEnumerable{System.String})">
<summary>
Initializes a new AuthTypeFilteredCredentials
</summary>
<param name="innerCredential">Credential to delegate to</param>
<param name="authTypes">List of authTypes to respond to. If empty, responds to all authTypes.</param>
</member>
<member name="M:NuGet.Common.ClientVersionUtility.GetNuGetAssemblyVersion">
<summary>
Find the current NuGet client version from the assembly info as a string.
If no value can be found an InvalidOperationException will be thrown.
</summary>
<remarks>This can contain prerelease labels if AssemblyInformationalVersionAttribute exists.</remarks>
</member>
<member name="T:NuGet.Common.CryptoHashProvider">
<summary>
CryptoHashProvider helps calculate or verify hash based on SHA256 or SHA512 algorithms
</summary>
</member>
<member name="F:NuGet.Common.CryptoHashProvider.SHA512HashAlgorithm">
<summary>
Server token used to represent that the hash being used is SHA 512
</summary>
</member>
<member name="F:NuGet.Common.CryptoHashProvider.SHA256HashAlgorithm">
<summary>
Server token used to represent that the hash being used is SHA 256
</summary>
</member>
<member name="M:NuGet.Common.CryptoHashProvider.#ctor">
<summary>
Creates an instance of CryptoHashProvider. Since the algorithm is not specified, SHA512 is assumed
</summary>
</member>
<member name="M:NuGet.Common.CryptoHashProvider.#ctor(System.String)">
<summary>
Creates an instance of CryptoHashProvider using the hashAlgorithm
</summary>
</member>
<member name="M:NuGet.Common.CryptoHashProvider.CalculateHash(System.IO.Stream)">
<summary>
Calculates the hash for a given stream
</summary>
</member>
<member name="M:NuGet.Common.CryptoHashProvider.CalculateHash(System.Byte[])">
<summary>
Calculates the hash for a byte array
</summary>
</member>
<member name="M:NuGet.Common.CryptoHashProvider.VerifyHash(System.Byte[],System.Byte[])">
<summary>
Verifies the hash for the given data and hash
</summary>
</member>
<member name="M:NuGet.Common.CryptoHashUtility.ComputeHashAsBase64(System.Security.Cryptography.HashAlgorithm,System.IO.Stream)">
<summary>
Compute the hash as a base64 encoded string.
</summary>
<remarks>Closes the stream by default.</remarks>
<param name="hashAlgorithm">Algorithm to use for hashing.</param>
<param name="data">Stream to hash.</param>
</member>
<member name="M:NuGet.Common.CryptoHashUtility.ComputeHashAsBase64(System.Security.Cryptography.HashAlgorithm,System.IO.Stream,System.Boolean)">
<summary>
Compute the hash as a base64 encoded string.
</summary>
<param name="hashAlgorithm">Algorithm to use for hashing.</param>
<param name="data">Stream to hash.</param>
<param name="leaveStreamOpen">If false the stream will be closed.</param>
<returns>A base64 encoded hash string.</returns>
</member>
<member name="M:NuGet.Common.CryptoHashUtility.ComputeHash(NuGet.Common.HashAlgorithmName,System.Byte[])">
<summary>
Compute the hash as a byte[].
</summary>
</member>
<member name="M:NuGet.Common.CryptoHashUtility.ComputeHash(System.Security.Cryptography.HashAlgorithm,System.IO.Stream)">
<summary>
Compute the hash as a byte[].
</summary>
<remarks>Closes the stream by default.</remarks>
<param name="hashAlgorithm">Algorithm to use for hashing.</param>
<param name="data">Stream to hash.</param>
<returns>A hash byte[].</returns>
</member>
<member name="M:NuGet.Common.CryptoHashUtility.ComputeHash(System.Security.Cryptography.HashAlgorithm,System.IO.Stream,System.Boolean)">
<summary>
Compute the hash as a byte[].
</summary>
<param name="hashAlgorithm">Algorithm to use for hashing.</param>
<param name="data">Stream to hash.</param>
<param name="leaveStreamOpen">If false the stream will be closed.</param>
<returns>A hash byte[].</returns>
</member>
<member name="M:NuGet.Common.CryptoHashUtility.ConvertToSystemSecurityHashAlgorithmName(NuGet.Common.HashAlgorithmName)">
<summary>
Extension method to convert NuGet.Common.HashAlgorithmName to System.Security.Cryptography.HashAlgorithmName
</summary>
<returns>System.Security.Cryptography.HashAlgorithmName equivalent of the NuGet.Common.HashAlgorithmName</returns>
</member>
<member name="M:NuGet.Common.CryptoHashUtility.ConvertToOidString(NuGet.Common.HashAlgorithmName)">
<summary>
Extension method to convert NuGet.Common.HashAlgorithmName to an Oid string
</summary>
<returns>Oid string equivalent of the NuGet.Common.HashAlgorithmName</returns>
</member>
<member name="M:NuGet.Common.CryptoHashUtility.ConvertToOid(NuGet.Common.HashAlgorithmName)">
<summary>
Extension method to convert NuGet.Common.HashAlgorithmName to an OID
</summary>
<returns>OID equivalent of the NuGet.Common.HashAlgorithmName</returns>
</member>
<member name="M:NuGet.Common.CryptoHashUtility.OidToHashAlgorithmName(System.String)">
<summary>
Helper method to convert an Oid string to NuGet.Common.HashAlgorithmName
</summary>
<param name="oid">An oid string.</param>
<returns>NuGet.Common.HashAlgorithmName equivalent of the oid string</returns>
</member>
<member name="M:NuGet.Common.CryptoHashUtility.ConvertToOidString(NuGet.Common.SignatureAlgorithmName)">
<summary>
Extension method to convert NuGet.Common.SignatureAlgorithmName to an Oid string
</summary>
<returns>Oid string equivalent of the NuGet.Common.SignatureAlgorithmName</returns>
</member>
<member name="T:NuGet.Common.DatetimeUtility">
<summary>
static class to provide datetime common utility apis
</summary>
</member>
<member name="M:NuGet.Common.DatetimeUtility.ToReadableTimeFormat(System.TimeSpan)">
<summary>
take timespan n return in appropriate unit like ms, or seconds, or minutes, or hours
</summary>
<param name="time">timespan</param>
<returns>A human-readable timespan string</returns>
</member>
<member name="P:NuGet.Common.ILogFileContext.FilePath">
<summary>
Indicates the file for which the error was thrown.
</summary>
</member>
<member name="P:NuGet.Common.ILogFileContext.StartLineNumber">
<summary>
Indicates the starting line for which the error was thrown.
</summary>
</member>
<member name="P:NuGet.Common.ILogFileContext.StartColumnNumber">
<summary>
Indicates the starting column for which the error was thrown.
</summary>
</member>
<member name="P:NuGet.Common.ILogFileContext.EndLineNumber">
<summary>
Indicates the ending line for which the error was thrown.
</summary>
</member>
<member name="P:NuGet.Common.ILogFileContext.EndColumnNumber">
<summary>
Indicates the ending column for which the error was thrown.
</summary>
</member>
<member name="P:NuGet.Common.ILogMessage.Level">
<summary>
Level to indicate if this is an error or warning.
</summary>
</member>
<member name="P:NuGet.Common.ILogMessage.WarningLevel">
<summary>
Level to indicate the warning level for the message.
This is relevant only if the Level == LogLevel.Warning.
</summary>
</member>
<member name="P:NuGet.Common.ILogMessage.Code">
<summary>
Indicates the NuGet error code.
</summary>
</member>
<member name="P:NuGet.Common.ILogMessage.Message">
<summary>
Indicates the staring generated by the code to go with the error code.
</summary>
</member>
<member name="P:NuGet.Common.ILogMessage.ProjectPath">
<summary>
Indicates the project for which the error was thrown.
</summary>
</member>
<member name="P:NuGet.Common.ILogMessage.Time">
<summary>
Indicates the date time at which the error occurred.
</summary>
</member>
<member name="T:NuGet.Common.ILogMessageException">
<summary>
Allows converting an Exception to an ILogMessage.
</summary>
</member>
<member name="M:NuGet.Common.ILogMessageException.AsLogMessage">
<summary>
Retrieve the exception as a log message.
</summary>
</member>
<member name="P:NuGet.Common.IPackLogMessage.LibraryId">
<summary>
Project or Package Id.
</summary>
</member>
<member name="P:NuGet.Common.IPackLogMessage.Framework">
<summary>
NuGet Framework
</summary>
</member>
<member name="P:NuGet.Common.IRestoreLogMessage.LibraryId">
<summary>
Project or Package Id.
</summary>
</member>
<member name="P:NuGet.Common.IRestoreLogMessage.TargetGraphs">
<summary>
List of TargetGraphs.
</summary>
</member>
<member name="P:NuGet.Common.IRestoreLogMessage.ShouldDisplay">
<summary>
Bool indicating if this message needs to be logged to the inner logger.
</summary>
</member>
<member name="T:NuGet.Common.LogMessage">
<summary>
Basic log message.
</summary>
</member>
<member name="T:NuGet.Common.NuGetLogCode">
<summary>
This enum is used to quantify NuGet error and warning codes.
</summary>
<remarks>
<para>
Format - NUxyzw where NU is the prefix indicating NuGet and xyzw is a 4 digit code
</para>
Numbers - xyzw
x - 'x' is the largest digit and should be used to quantify a set of errors.
For example 1yzw are set of restore related errors and no other code path should use the range 1000 to 1999 for errors or warnings.
y - 'y' is the second largest digit and should be used for sub sections withing a broad category.
For example 12zw cvould be http related errors.
Further 'y' = 0-4 should be used for errors and 'y' = 5-9 should be warnings.
zw - 'zw' are the least two digit.
These could be used for different errors or warnings within the broad categories set by digits 'xy'.
<para>
Groups:
1000-1999 - Restore
3000-3999 - Signing
5000-5999 - Packaging
</para>
<para>
Sub groups for Restore:
error/warning - Reason
1000/1500 - Input
1100/1600 - Resolver
1200/1700 - Compat
1300/1800 - Feed
1400/1900 - Package
</para>
<para>
All new codes need a corresponding MarkDown file under https://github.com/NuGet/docs.microsoft.com-nuget/tree/master/docs/reference/errors-and-warnings.
</para>
</remarks>
</member>
<member name="F:NuGet.Common.NuGetLogCode.Undefined">
<summary>
Do not display the code.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1000">
<summary>
Undefined error
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1001">
<summary>
Project has zero target frameworks.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1002">
<summary>
Invalid combination with CLEAR
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1003">
<summary>
Invalid combination of PTF and ATF
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1004">
<summary>
Locked mode, but restore needs to update the lock file.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1005">
<summary>
Invalid combination of RestorePackagesWithLockFile and packages.lock.json file.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1006">
<summary>
NuGet configuration file has an invalid package source value.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1007">
<summary>
Project provided runtime graph is invalid. Either does not exist or cannot be parsed.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1008">
<summary>
Projects that use central package version management should not define the version on the PackageReference items but on the PackageVersion items.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1009">
<summary>
Projects that use central package version management should not define SDK implicit referenced packages. For more information, see https://aka.ms/sdkimplicitrefs
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1010">
<summary>
The PackageReference items {0} do not have corresponding PackageVersions.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1011">
<summary>
Central floating versions are not allowed.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1012">
<summary>
Platform version not found.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1013">
<summary>
Projects that use central package version management are not configured to allow package version overrides.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1100">
<summary>
Unable to resolve package, generic message for unknown type constraints.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1101">
<summary>
No versions of the package exist on any of the sources.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1102">
<summary>
Versions of the package exist, but none are in the range.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1103">
<summary>
Range does not allow prerelease packages and only prerelease versions were found
within the range.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1104">
<summary>
Project path does not exist on disk.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1105">
<summary>
Unable to read project information for 'ProjectFile'. The project file may be invalid or missing targets required for restore.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1106">
<summary>
Resolver conflict
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1107">
<summary>
Version conflict.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1108">
<summary>
Circular dependency.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1109">
<summary>
Package dependency downgraded because of centrally defined package version.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1201">
<summary>
Dependency project has an incompatible framework.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1202">
<summary>
Dependency package does not contain assets for the current framework.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1203">
<summary>
un-matched reference assemblies
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1204">
<summary>
Invalid package types
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1211">
<summary>
Project has an invalid dependency count
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1212">
<summary>
Incompatible tools package/project combination
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1213">
<summary>
Incompatible package type
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1301">
<summary>
Package Source is unreachable.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1401">
<summary>
Package MinClientVersion did not match.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1402">
<summary>
Package contains unsafe zip entry.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1403">
<summary>
Package sha512 validation failed.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1410">
<summary>
Package Signature is invalid
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1500">
<summary>
Undefined warning
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1501">
<summary>
Missing restore target.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1502">
<summary>
Unknown compatibility profile
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1503">
<summary>
Skipping project that does not support restore.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1504">
<summary>
Duplicate PackageReference found
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1505">
<summary>
Duplicate PackageDownload found
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1506">
<summary>
Duplicate PackageVersion found
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1507">
<summary>
Central package management is in use but there are multiple feeds configured without using package source mapping.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1601">
<summary>
Dependency bumped up
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1602">
<summary>
Non-exact match on dependency range due to non inclusive minimum bound.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1603">
<summary>
Non-exact match on dependency range due to missing package version.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1604">
<summary>
Project dependency does not include a lower bound.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1605">
<summary>
Package dependency downgraded.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1608">
<summary>
Version is higher than upper bound.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1701">
<summary>
Fallback framework used for a package reference.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1702">
<summary>
Fallback framework used for a project reference.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1703">
<summary>
MacCatalyst platform fell back to xamarin.ios - Added in 6.0, removed in 6.1.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1801">
<summary>
Feed error converted to a warning when ignoreFailedSources is true.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1802">
<summary>
Could not update package .nupkg.metadata timestamp
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU1803">
<summary>
HTTP Source specified, but HTTP sources will be deprecated.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU3000">
<summary>
Undefined signature error
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU3001">
<summary>
Invalid input error
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU3002">
<summary>
The '-Timestamper' option was not provided. The signed package will not be timestamped.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU3003">
<summary>
The package signature is invalid.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU3004">
<summary>
The package is not signed.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU3005">
<summary>
The package signature file entry is invalid.
</summary>
<remarks>
Examples which would trigger this include:
* the entry has incorrect external file attributes
* the entry is compressed not stored
* the entry's compressed and uncompressed sizes differ
</remarks>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU3006">
<summary>
Signed Zip64 packages are not supported.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU3007">
<summary>
The package signature format version is not supported.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU3008">
<summary>
The package integrity check failed.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU3009">
<summary>
The package signature file does not contain exactly one primary signature.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU3010">
<summary>
The primary signature does not have a signing certificate.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU3011">
<summary>
The primary signature is invalid.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU3012">
<summary>
Primary signature validation failed.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU3013">
<summary>
The signing certificate has an unsupported signature algorithm.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU3014">
<summary>
The signing certificate does not meet a minimum public key length requirement.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU3015">
<summary>
Certificates with lifetime signer EKU are not supported.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU3016">
<summary>
The package hash uses an unsupported hash algorithm.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU3017">
<summary>
The signing certificate is not yet valid.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU3018">
<summary>
Chain building failed for primary signature
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU3019">
<summary>
The timestamp integrity check failed.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU3020">
<summary>
The timestamp signature does not have a signing certificate.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU3021">
<summary>
Timestamp signature validation failed.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU3022">
<summary>
The timestamp certificate has an unsupported signature algorithm.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU3023">
<summary>
The timestamp's certificate does not meet a minimum public key length requirement.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU3024">
<summary>
The timestamp signature has an unsupported digest algorithm.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU3025">
<summary>
The timestamp signing certificate is not yet valid.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU3026">
<summary>
The timestamp response is invalid. Nonces did not match.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU3027">
<summary>
The primary signature should be timestamped to enable long-term signature validity after the certificate has expired.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU3028">
<summary>
Chain building failed for timestamp
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU3029">
<summary>
The timestamp signature is invalid.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU3030">
<summary>
The timestamp's message imprint uses an unsupported hash algorithm.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU3031">
<summary>
The repository countersignature is invalid.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU3032">
<summary>
The package signature contains multiple repository countersignatures.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU3033">
<summary>
A repository primary signature must not have a repository countersignature.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU3034">
<summary>
The package signature certificate does not match the trusted certificate list.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU3035">
<summary>
Chain building failed for the repository countersignature.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU3036">
<summary>
Timestamp Generalized time is outside certificate's valdity period
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU3037">
<summary>
The signature has expired.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU3038">
<summary>
Verification settings require a repository countersignature, but the package does not have a repository countersignature.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU3039">
<summary>
The package cannot be signed as it would require the Zip64 format.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU3040">
<summary>
There where two equal certificate entries with conflicting attributes in the nuget.config
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU3041">
<summary>
Downloading a package from a plugin is not supported since unsigned packages are not allowed and package download plugins do not support signed package verification.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5000">
<summary>
Undefined Package Error.
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5001">
<summary>
Error_WriteResolvedNuSpecOverwriteOriginal
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5002">
<summary>
Error_InputFileNotSpecified
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5003">
<summary>
Error_InvalidTargetFramework
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5004">
<summary>
Error_PackageCommandNoFilesForLibPackage
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5005">
<summary>
Error_PackageCommandNoFilesForSymbolsPackage
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5007">
<summary>
Error_UnableToLocateBuildOutput
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5008">
<summary>
ErrorManifestFileNotFound
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5009">
<summary>
Error_CannotFindMsbuild
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5010">
<summary>
Error_InvalidVersionInPackage
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5011">
<summary>
Error_UnableToExtractAssemblyMetadata
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5012">
<summary>
Error_UnableToFindBuildOutput
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5013">
<summary>
Error_FailedToBuildProject
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5014">
<summary>
Error_ProcessingNuspecFile
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5015">
<summary>
Error_MultipleTargetFrameworks
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5016">
<summary>
Error_InvalidDependencyVersionConstraints
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5017">
<summary>
Error_CannotCreateEmptyPackage
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5018">
<summary>
Error_Manifest_InvalidReference
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5019">
<summary>
Error_PackageAuthoring_FileNotFound
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5020">
<summary>
Error_EmptySourceFilePath
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5021">
<summary>
Error_EmptySourceFileProjectDirectory
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5022">
<summary>
Error_InvalidMinClientVersion
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5023">
<summary>
Error_AssetsFileNotFound
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5024">
<summary>
Error_InvalidPackageVersion
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5025">
<summary>
Error_AssetsFileDoesNotHaveValidPackageSpec
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5026">
<summary>
Error_FileNotFound
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5027">
<summary>
Error_InvalidTargetFramework
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5028">
<summary>
Error_NoPackItemProvided
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5029">
<summary>
Error_InvalidNuspecProperties
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5030">
<summary>
Error_Manifest_LicenseFileNotInNupkg
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5031">
<summary>
Error_Manifest_LicenseFileExtensionIsInvalid
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5032">
<summary>
Error_Manifest_LicenseExpressionIsUnparseable
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5033">
<summary>
Error_Manifest_InvalidLicenseMetadata
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5034">
<summary>
Error_Manifest_InvalidLicenseExpressionVersion
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5035">
<summary>
Error_Manifest_LicenseUrlCannotBeUsedWithLicenses
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5036">
<summary>
https://aka.ms/malformedNuGetLicenseUrl
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5037">
<summary>
Error_MissingNuspecFile
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5038">
<summary>
Error_ReadmeFileExtensionIsInvalid
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5039">
<summary>
Error_ReadmeNoFileElement
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5040">
<summary>
Error_ReadmeErrorEmpty
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5041">
<summary>
Error_ReadmeCannotOpenFile
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5042">
<summary>
Error_ProjectJsonPack_Deprecated_And_Disabled
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5045">
<summary>
Invalid icon extension error
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5046">
<summary>
Error_Manifest_IconCannotOpenFile
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5047">
<summary>
Error_Icon_InvalidSize
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5048">
<summary>
IconUrlDeprecationWarning
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5050">
<summary>
Attempted to write files from multiple sources into the same location
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5100">
<summary>
AssemblyOutsideLibWarning
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5101">
<summary>
AssemblyDirectlyUnderLibWarning
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5102">
<summary>
DefaultSpecValueWarning
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5103">
<summary>
InvalidFrameworkWarning
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5104">
<summary>
InvalidPrereleaseDependencyWarning
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5105">
<summary>
LegacyVersionWarning
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5106">
<summary>
WinRTObsoleteWarning
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5107">
<summary>
MisplacedInitScriptWarning
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5108">
<summary>
MisplacedTransformFileWarning
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5109">
<summary>
PlaceholderFileInPackageWarning
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5110">
<summary>
ScriptOutsideToolsWarning
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5111">
<summary>
UnrecognizedScriptWarning
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5112">
<summary>
UnspecifiedDependencyVersionWarning
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5114">
<summary>
Warning_DuplicatePropertyKey
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5115">
<summary>
Warning_UnspecifiedField
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5116">
<summary>
Warning_FileDoesNotExist
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5117">
<summary>
Warning_UnresolvedFilePath
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5118">
<summary>
Warning_FileNotAddedToPackage
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5119">
<summary>
Warning_FileExcludedByDefault
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5120">
<summary>
Migrator_PackageHasInstallScript
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5121">
<summary>
Migrator_PackageHasContentFolder
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5122">
<summary>
Migrator_XdtTransformInPackage
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5123">
<summary>
Warning_FilePathTooLong
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5124">
<summary>
Warning_UnrecognizedLicenseIdentifier
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5125">
<summary>
LicenseUrlDeprecated
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5126">
<summary>
ProjectJsonPack_Deprecated
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5127">
<summary>
No ref or lib folder in the package
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5128">
<summary>
TFM dependencies in the lib or ref folder don't have exact matches in the nuspec
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5129">
<summary>
No build files that follow the build convention ("package_id".props)
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5130">
<summary>
TFM dependencies in the lib or ref folder has a compatible match, but not an exact match
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5131">
<summary>
References in the nuspec don't match up with the ref folder in the package
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5132">
<summary>
File last write timestamp is out of range of what the zip format supports warning
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5133">
<summary>
NuGet.exe needs to be unblocked after downloading
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5500">
<summary>
Undefined package warning
</summary>
</member>
<member name="F:NuGet.Common.NuGetLogCode.NU5501">
<summary>
InvalidUndottedFrameworkWarning
</summary>
</member>
<member name="M:NuGet.Common.PackagingLogMessage.#ctor(NuGet.Common.LogLevel,NuGet.Common.NuGetLogCode,System.String)">
<summary>
Initializes a new instance of the PackLogMessage class
</summary>
<param name="logLevel">The log level</param>
<param name="logCode">The NuGet log code</param>
<param name="message">The log message</param>
</member>
<member name="M:NuGet.Common.PackagingLogMessage.#ctor(NuGet.Common.LogLevel,NuGet.Common.NuGetLogCode,System.String,System.String,NuGet.Frameworks.NuGetFramework)">
<summary>
Initializes a new instance of the PackLogMessage class
</summary>
<param name="logLevel">The log level</param>
<param name="logCode">The NuGet log code</param>
<param name="message">The log message</param>
<param name="libraryId">The package Id</param>
<param name="framework">The NuGet framework</param>
</member>
<member name="M:NuGet.Common.PackagingLogMessage.CreateError(System.String,NuGet.Common.NuGetLogCode)">
<summary>
Create an error log message.
</summary>
<param name="code">The logging code</param>
<param name="message">The log message</param>
</member>
<member name="M:NuGet.Common.PackagingLogMessage.GetDefaultLogCode(NuGet.Common.LogLevel)">
<summary>
Get default LogCode based on the log level
</summary>
<param name="logLevel">The log level</param>
</member>
<member name="M:NuGet.Common.RestoreLogMessage.CreateWarning(NuGet.Common.NuGetLogCode,System.String,System.String,System.String[])">
<summary>
Create a log message for a target graph library.
</summary>
</member>
<member name="M:NuGet.Common.RestoreLogMessage.CreateWarning(NuGet.Common.NuGetLogCode,System.String)">
<summary>
Create a warning log message.
</summary>
</member>
<member name="M:NuGet.Common.RestoreLogMessage.CreateError(NuGet.Common.NuGetLogCode,System.String)">
<summary>
Create an error log message.
</summary>
</member>
<member name="M:NuGet.Common.RestoreLogMessage.CreateError(NuGet.Common.NuGetLogCode,System.String,System.String,System.String[])">
<summary>
Create an error log message for a target graph.
</summary>
</member>
<member name="M:NuGet.Common.RestoreLogMessage.GetDefaultLogCode(NuGet.Common.LogLevel)">
<summary>
Get default LogCode based on the log level
</summary>
</member>
<member name="T:NuGet.Common.WarningLevel">
<summary>
These are Warning Levels used by NuGet while throwing warnings.
These logically correspond to .NET spec at https://msdn.microsoft.com/en-us/library/13b90fz7(v=vs.140).aspx
We do not have a level 0 as that has no logical meaning of having a warning with level 0.
Severe - This should be used to throw warnings that are just short of being an error.
Important - Lower level than severe.
Minimal - Lower level than important.
Default - Lowest level of warnings.
Default NuGet logging will ignore these warnings.
</summary>
</member>
<member name="T:NuGet.Common.ExceptionUtilities">
<summary>
For internal use only
</summary>
</member>
<member name="M:NuGet.Common.ExceptionUtilities.LogException(System.Exception,NuGet.Common.ILogger)">
<summary>
Log an exception to an ILogger.
This will log using NU1000 if the exception does not contain a code.
</summary>
</member>
<member name="M:NuGet.Common.ExceptionUtilities.LogException(System.Exception,NuGet.Common.ILogger,System.Boolean)">
<summary>
Log an exception to an ILogger.
This will log using NU1000 if the exception does not contain a code.
</summary>
</member>
<member name="P:NuGet.Common.ExceptionLogger.ShowStack">
<summary>
Determines whether the full exception (including stack trace) should be displayed to
the user. In prerelease or dogfooding scenarios, it is useful to have a non-verbose
logging level but, in the case of an unhandled exception, print the full exception for
bug reporting.
</summary>
<returns>
True if the exception stack should be displayed to the user. False, otherwise.
</returns>
</member>
<member name="P:NuGet.Common.ICollectorLogger.Errors">
<summary>
Fetch all of the errors logged so far. This method is useful when error log messages
should be redisplayed after the initial log message is emitted.
</summary>
</member>
<member name="T:NuGet.Common.ILogger">
<summary>
A generic interface for logging.
</summary>
</member>
<member name="T:NuGet.Common.LegacyLoggerAdapter">
<summary>
Call legacy Log* methods from LogAsync/Log.
This is for legacy ILogger implementations,
new loggers should use LoggerBase.
</summary>
</member>
<member name="M:NuGet.Common.LoggerBase.DisplayMessage(NuGet.Common.LogLevel)">
<summary>
True if the message meets the verbosity level.
</summary>
</member>
<member name="M:NuGet.Common.LoggerBase.CollectMessage(NuGet.Common.LogLevel)">
<summary>
True if the message is an error or warning.
</summary>
</member>
<member name="M:NuGet.Common.LoggingExtensions.FormatWithCode(NuGet.Common.ILogMessage)">
<summary>
Formats a ILogMessage into a string representation containg the log code and message.
The log code is added only if it is a valid NuGetLogCode and is greater than NuGetLogCode.Undefined.
</summary>
<param name="message">ILogMessage to be formatted.</param>
<returns>string representation of the ILogMessage.</returns>
</member>
<member name="M:NuGet.Common.LoggingExtensions.GetName(NuGet.Common.NuGetLogCode)">
<summary>
Formats a NuGetLogCode into a string representation.
</summary>
<param name="code">NuGetLogCode to be formatted into string.</param>
<returns>strings representation of the NuGetLogCode.</returns>
</member>
<member name="M:NuGet.Common.LoggingExtensions.TryGetName(NuGet.Common.NuGetLogCode,System.String@)">
<summary>
Tries to get the string from the NuGetLogCode enum.
</summary>
<param name="code">NuGetLogCode to be formatted into string.</param>
<param name="codeString">strings representation of the NuGetLogCode if the result is true else null.</param>
<returns>bool indcating if the GetName operation was successfull or not.</returns>
</member>
<member name="M:NuGet.Common.MSBuildStringUtility.Split(System.String)">
<summary>
Split on ; and trim. Null or empty inputs will return an
empty array.
</summary>
</member>
<member name="M:NuGet.Common.MSBuildStringUtility.Split(System.String,System.Char[])">
<summary>
Split on ; and trim. Null or empty inputs will return an
empty array.
</summary>
</member>
<member name="M:NuGet.Common.MSBuildStringUtility.TrimAndGetNullForEmpty(System.String)">
<summary>
Trims the provided string and converts empty strings to null.
</summary>
</member>
<member name="M:NuGet.Common.MSBuildStringUtility.TrimAndExcludeNullOrEmpty(System.String[])">
<summary>
Trims the provided strings and excludes empty or null strings.
</summary>
</member>
<member name="M:NuGet.Common.MSBuildStringUtility.IsTrue(System.String)">
<summary>
True if the property is set to true
</summary>
</member>
<member name="M:NuGet.Common.MSBuildStringUtility.IsTrueOrEmpty(System.String)">
<summary>
True if the property is set to true or empty.
</summary>
</member>
<member name="M:NuGet.Common.MSBuildStringUtility.GetNuGetLogCodes(System.String)">
<summary>
Splits and parses a ; or , delimited list of log codes.
Ignores codes that are unknown.
</summary>
</member>
<member name="M:NuGet.Common.MSBuildStringUtility.GetBooleanOrNull(System.String)">
<summary>
Convert the provided string to a boolean, or return null if the value can't be parsed as a boolean.
</summary>
</member>
<member name="M:NuGet.Common.MSBuildStringUtility.Convert(System.String)">
<summary>
Convert the provided string to MSBuild style.
</summary>
</member>
<member name="M:NuGet.Common.MSBuildStringUtility.GetDistinctNuGetLogCodesOrDefault(System.Collections.Generic.IEnumerable{System.Collections.Generic.IEnumerable{NuGet.Common.NuGetLogCode}})">
<summary>
Return empty list of NuGetLogCode if all lists of NuGetLogCode are not the same.
</summary>
</member>
<member name="M:NuGet.Common.NetworkProtocolUtility.SetConnectionLimit">
<summary>
Set ServicePointManager.DefaultConnectionLimit
</summary>
</member>
<member name="T:NuGet.Common.FileUtility">
<summary>
File operation helpers.
</summary>
</member>
<member name="M:NuGet.Common.FileUtility.GetTempFilePath(System.String)">
<summary>
Get the full path to a new temp file
</summary>
</member>
<member name="M:NuGet.Common.FileUtility.DeleteWithLock(System.String)">
<summary>
Lock around the output path.
Delete the existing file with retries.
</summary>
</member>
<member name="M:NuGet.Common.FileUtility.ReplaceWithLock(System.Action{System.String},System.String)">
<summary>
Lock around the output path.
Delete the existing file with retries.
Move a file with retries.
</summary>
</member>
<member name="M:NuGet.Common.FileUtility.Replace(System.Action{System.String},System.String)">
<summary>
Delete the existing file with retries.
Move a file with retries.
</summary>
</member>
<member name="M:NuGet.Common.FileUtility.Replace(System.String,System.String)">
<summary>
Delete the existing file with retries.
Move a file with retries.
</summary>
</member>
<member name="M:NuGet.Common.FileUtility.Move(System.String,System.String)">
<summary>
Move a file with retries.
This will not overwrite
</summary>
</member>
<member name="M:NuGet.Common.FileUtility.Delete(System.String)">
<summary>
Delete a file with retries.
</summary>
</member>
<member name="T:NuGet.Common.INuGetPathContext">
<summary>
Common NuGet paths. These values may be overridden in NuGet.Config or by
environment variables, resolving the paths here requires NuGet.Configuration.
</summary>
</member>
<member name="P:NuGet.Common.INuGetPathContext.UserPackageFolder">
<summary>
User package folder directory.
</summary>
</member>
<member name="P:NuGet.Common.INuGetPathContext.FallbackPackageFolders">
<summary>
Fallback package folder locations.
</summary>
</member>
<member name="P:NuGet.Common.INuGetPathContext.HttpCacheFolder">
<summary>
Http file cache.
</summary>
</member>
<member name="M:NuGet.Common.NuGetEnvironment.chmod(System.String,System.Int32)">
<summary>Only to be used for creating directories under /tmp on Linux. Do not use elsewhere.</summary>
</member>
<member name="M:NuGet.Common.NuGetEnvironment.GetValueOrThrowMissingEnvVarsDotnet(System.Func{System.String},System.String,System.String)">
<summary>
Throw a helpful message if the required env vars are not set.
</summary>
</member>
<member name="M:NuGet.Common.NuGetEnvironment.GetValueOrThrowMissingEnvVar(System.Func{System.String},System.String)">
<summary>
Throw a helpful message if a required env var is not set.
</summary>
</member>
<member name="T:NuGet.Common.NuGetEnvironment.SpecialFolder">
<summary>
Since <see cref="T:System.Environment.SpecialFolder" /> is not available on .NET Core, we have to
make our own and re-implement the functionality. On .NET Framework, we can use the
built-in functionality.
</summary>
</member>
<member name="M:NuGet.Common.PathResolver.GetMatches``1(System.Collections.Generic.IEnumerable{``0},System.Func{``0,System.String},System.Collections.Generic.IEnumerable{System.String})">
<summary>
Returns a collection of files from the source that matches the wildcard.
</summary>
<param name="source">The collection of files to match.</param>
<param name="getPath">Function that returns the path to filter a package file </param>
<param name="wildcards">The wildcards to apply to match the path with.</param>
<returns></returns>
</member>
<member name="M:NuGet.Common.PathResolver.FilterPackageFiles``1(System.Collections.Generic.ICollection{``0},System.Func{``0,System.String},System.Collections.Generic.IEnumerable{System.String})">
<summary>
Removes files from the source that match any wildcard.
</summary>
</member>
<member name="M:NuGet.Common.PathResolver.IsWildcardSearch(System.String)">
<summary>
Returns true if the path contains any wildcard characters.
</summary>
</member>
<member name="M:NuGet.Common.PathUtility.GetStringComparerBasedOnOS">
<summary>
Returns OrdinalIgnoreCase Windows and Mac. Ordinal for Linux. (Do not use with package paths)
</summary>
<returns></returns>
<remarks>
This method should not be used with package paths.
Package paths are always case sensitive, using this with package paths leads to bugs like https://github.com/NuGet/Home/issues/9817.
</remarks>
</member>
<member name="M:NuGet.Common.PathUtility.GetStringComparisonBasedOnOS">
<summary>
Returns OrdinalIgnoreCase Windows and Mac. Ordinal for Linux. (Do not use with package paths)
</summary>
<returns></returns>
<remarks>
This method should not be used with package paths.
Package paths are always case sensitive, using this with package paths leads to bugs like https://github.com/NuGet/Home/issues/9817.
</remarks>
</member>
<member name="M:NuGet.Common.PathUtility.GetUniquePathsBasedOnOS(System.Collections.Generic.IEnumerable{System.String})">
<summary>
Returns distinct orderd paths based on the file system case sensitivity.
</summary>
</member>
<member name="M:NuGet.Common.PathUtility.GetPathWithForwardSlashes(System.String)">
<summary>
Replace all back slashes with forward slashes.
If the path does not contain a back slash
the original string is returned.
</summary>
</member>
<member name="M:NuGet.Common.PathUtility.GetRelativePath(System.String,System.String)">
<summary>
Returns path2 relative to path1, with Path.DirectorySeparatorChar as separator
</summary>
</member>
<member name="M:NuGet.Common.PathUtility.GetRelativePath(System.String,System.String,System.Char)">
<summary>
Returns path2 relative to path1, with given path separator
</summary>
</member>
<member name="M:NuGet.Common.PathValidator.IsValidSource(System.String)">
<summary>
Validates that a source is a valid path or url.
</summary>
<param name="source">The path to validate.</param>
<returns>True if valid, False if invalid.</returns>
</member>
<member name="M:NuGet.Common.PathValidator.IsValidLocalPath(System.String)">
<summary>
Validates that path is properly formatted as a local path.
</summary>
<remarks>
On Windows, a valid local path must starts with the drive letter.
Example: C:\, C:\path, C:\path\to\
Bad: C:\invalid\*\"\chars
</remarks>
<param name="path">The path to validate.</param>
<returns>True if valid, False if invalid.</returns>
</member>
<member name="M:NuGet.Common.PathValidator.IsValidUncPath(System.String)">
<summary>
Validates that path is properly formatted as an UNC path.
</summary>
<remarks>
Example: \\server\share, \\server\share\path, \\server\share\path\to\
Bad: \\server\invalid\*\"\chars
</remarks>
<param name="path">The path to validate.</param>
<returns>True if valid, False if invalid.</returns>
</member>
<member name="M:NuGet.Common.PathValidator.IsValidUrl(System.String)">
<summary>
Validates that url is properly formatted as an URL based on .NET <see cref="T:System.Uri">Uri</see> class.
</summary>
<param name="url">The url to validate.</param>
<returns>True if valid, False if invalid.</returns>
</member>
<member name="F:NuGet.Common.ProjectJsonPathUtilities.ProjectConfigFileName">
<summary>
project.json
</summary>
</member>
<member name="F:NuGet.Common.ProjectJsonPathUtilities.ProjectConfigFileEnding">
<summary>
.project.json
</summary>
</member>
<member name="F:NuGet.Common.ProjectJsonPathUtilities.ProjectLockFileName">
<summary>
Lock file name
</summary>
</member>
<member name="M:NuGet.Common.ProjectJsonPathUtilities.GetProjectConfigPath(System.String,System.String)">
<summary>
Finds the projectName.project.json in a directory. If no projectName.project.json exists
the default project.json path will be returned regardless of existance.
</summary>
<returns>Returns the full path to the project.json file.</returns>
</member>
<member name="M:NuGet.Common.ProjectJsonPathUtilities.GetProjectConfigWithProjectName(System.String)">
<summary>
Creates a projectName.project.json file name.
</summary>
</member>
<member name="M:NuGet.Common.ProjectJsonPathUtilities.GetProjectLockFileNameWithProjectName(System.String)">
<summary>
Creates a projectName.project.lock.json file name.
</summary>
</member>
<member name="M:NuGet.Common.ProjectJsonPathUtilities.GetLockFilePath(System.String)">
<summary>
Create the lock file path from the config file path.
If the config file includes a project name the
lock file will include the name also.
</summary>
</member>
<member name="M:NuGet.Common.ProjectJsonPathUtilities.GetProjectNameFromConfigFileName(System.String)">
<summary>
Parses a projectName.project.json file name into a project name.
If there is no project name null will be returned.
</summary>
</member>
<member name="M:NuGet.Common.ProjectJsonPathUtilities.IsProjectConfig(System.String)">
<summary>
True if the file is a project.json or projectname.project.json file.
</summary>
</member>
<member name="T:NuGet.Common.Preprocessor">
<summary>
Simple token replacement system for content files.
</summary>
</member>
<member name="M:NuGet.Common.Preprocessor.ProcessAsync(System.Func{System.Threading.Tasks.Task{System.IO.Stream}},System.Func{System.String,System.String},System.Threading.CancellationToken)">
<summary>
Asynchronously performs token replacement on a file stream.
</summary>
<param name="streamTaskFactory">A stream task factory.</param>
<param name="tokenReplacement">A token replacement function.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns a <see cref="T:System.String" />.</returns>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="streamTaskFactory" />
is either <c>null</c> or empty.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="tokenReplacement" />
is <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Common.Preprocessor.Process(System.IO.Stream,System.Func{System.String,System.String})">
<summary>
Performs token replacement on a stream and returns the result.
</summary>
<param name="stream">A stream.</param>
<param name="tokenReplacement">A token replacement funciton.</param>
<returns>The token-replaced stream content.</returns>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="stream" />
is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="tokenReplacement" />
is <c>null</c>.</exception>
</member>
<member name="F:NuGet.Common.RevocationMode.Online">
<summary>
If needed go online to check for revocation.
This translates to X509RevocationMode.Online
</summary>
</member>
<member name="F:NuGet.Common.RevocationMode.Offline">
<summary>
Only use the machine cache to check for revocation.
This translates to X509RevocationMode.Offline
</summary>
</member>
<member name="F:NuGet.Common.SignatureValidationMode.Accept">
<summary>
Relaxed signature verification mode.
Allows unsigned packages, and issues are treated as warnings.
</summary>
</member>
<member name="F:NuGet.Common.SignatureValidationMode.Require">
<summary>
Strict signature verification mode.
All packages most be signed. Any issue is an error and
allow list of trusted signers must be provided.
</summary>
</member>
<member name="T:NuGet.Common.Strings">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:NuGet.Common.Strings.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:NuGet.Common.Strings.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:NuGet.Common.Strings.Argument_Must_Be_GreaterThanOrEqualTo">
<summary>
Looks up a localized string similar to Value must be greater than or equal to {0}.
</summary>
</member>
<member name="P:NuGet.Common.Strings.ArgumentNullOrEmpty">
<summary>
Looks up a localized string similar to Argument cannot be null or empty.
</summary>
</member>
<member name="P:NuGet.Common.Strings.MissingRequiredEnvVar">
<summary>
Looks up a localized string similar to Required environment variable '{0}' is not set. Try setting '{0}' and running the operation again..
</summary>
</member>
<member name="P:NuGet.Common.Strings.MissingRequiredEnvVarsDotnet">
<summary>
Looks up a localized string similar to Required environment variable '{0}' is not set. Try setting '{1}' or '{0}' and running the operation.
</summary>
</member>
<member name="P:NuGet.Common.Strings.TimeUnits_Hour">
<summary>
Looks up a localized string similar to {0:0.##} hr.
</summary>
</member>
<member name="P:NuGet.Common.Strings.TimeUnits_Millisecond">
<summary>
Looks up a localized string similar to {0:0.##} ms.
</summary>
</member>
<member name="P:NuGet.Common.Strings.TimeUnits_Minute">
<summary>
Looks up a localized string similar to {0:0.##} min.
</summary>
</member>
<member name="P:NuGet.Common.Strings.TimeUnits_Second">
<summary>
Looks up a localized string similar to {0:0.##} sec.
</summary>
</member>
<member name="P:NuGet.Common.Strings.UnableToDetemineClientVersion">
<summary>
Looks up a localized string similar to Unable to determine the current NuGet client version..
</summary>
</member>
<member name="P:NuGet.Common.Strings.UnauthorizedLockFail">
<summary>
Looks up a localized string similar to Unable to obtain lock file access on '{0}' for operations on '{1}'. This may mean that a different user or administrator is holding this lock and that this process does not have permission to access it. If no other process is currently performing an operation on this file it may mean that an earlier NuGet process crashed and left an inaccessible lock file, in this case removing the file '{0}' will allow NuGet to continue..
</summary>
</member>
<member name="P:NuGet.Common.Strings.UnsupportedHashAlgorithm">
<summary>
Looks up a localized string similar to Hash algorithm '{0}' is unsupported. Supported algorithms include: SHA512 and SHA256..
</summary>
</member>
<member name="P:NuGet.Common.Strings.UnsupportedHashAlgorithmName">
<summary>
Looks up a localized string similar to Hash algorithm '{0}' is unsupported..
</summary>
</member>
<member name="P:NuGet.Common.Strings.UnsupportedSignatureAlgorithmName">
<summary>
Looks up a localized string similar to Signature algorithm '{0}' is unsupported..
</summary>
</member>
<member name="T:NuGet.Common.INuGetTelemetryService">
<summary> Abstraction of NuGet telemetry service. </summary>
</member>
<member name="M:NuGet.Common.INuGetTelemetryService.EmitTelemetryEvent(NuGet.Common.TelemetryEvent)">
<summary> Send a <see cref="T:NuGet.Common.TelemetryEvent" /> to telemetry. </summary>
<param name="telemetryData"> Telemetry event to send. </param>
</member>
<member name="M:NuGet.Common.INuGetTelemetryService.StartActivity(System.String)">
<summary> Log a start of telemetry activity to the event log. </summary>
<param name="activityName"> Name of telemetry activity to log. </param>
<returns> <see cref="T:System.IDisposable" /> which will log end activity marker. </returns>
</member>
<member name="T:NuGet.Common.ITelemetrySession">
<summary> Telemetry session. </summary>
</member>
<member name="M:NuGet.Common.ITelemetrySession.PostEvent(NuGet.Common.TelemetryEvent)">
<summary> Post a telemetry event to current telemetry session. </summary>
<param name="telemetryEvent"> Telemetry event. </param>
</member>
<member name="T:NuGet.Common.NuGetOperationStatus">
<summary> Define different states for NuGet operation status. </summary>
</member>
<member name="F:NuGet.Common.NuGetOperationStatus.NoOp">
<summary> No operation performed. </summary>
</member>
<member name="F:NuGet.Common.NuGetOperationStatus.Succeeded">
<summary> Operation was successful. </summary>
</member>
<member name="F:NuGet.Common.NuGetOperationStatus.Failed">
<summary> Operation failed. </summary>
</member>
<member name="F:NuGet.Common.NuGetOperationStatus.Cancelled">
<summary> Operation was cancelled. </summary>
</member>
<member name="T:NuGet.Common.TelemetryActivity">
<summary> Represents telemetry activity which spans a time interval. </summary>
<remarks> Always dispose the activity at the end of interval covered. </remarks>
</member>
<member name="P:NuGet.Common.TelemetryActivity.TelemetryEvent">
<summary> Telemetry event which represents end of telemetry activity. </summary>
</member>
<member name="P:NuGet.Common.TelemetryActivity.ParentId">
<summary> Parent activity ID. </summary>
</member>
<member name="P:NuGet.Common.TelemetryActivity.OperationId">
<summary> Operation ID. </summary>
</member>
<member name="P:NuGet.Common.TelemetryActivity.NuGetTelemetryService">
<summary> Singleton of NuGet telemetry service instance. </summary>
</member>
<member name="M:NuGet.Common.TelemetryActivity.StartIntervalMeasure">
<summary> Start interval measure.
End with <see cref="M:NuGet.Common.TelemetryActivity.EndIntervalMeasure(System.String)" />
The intervals cannot overlap. For non-overlapping intervals <see cref="M:NuGet.Common.TelemetryActivity.StartIndependentInterval(System.String)" />
</summary>
</member>
<member name="M:NuGet.Common.TelemetryActivity.EndIntervalMeasure(System.String)">
<summary> End interval measure. </summary>
<param name="propertyName"> Property name to represents the interval. </param>
</member>
<member name="M:NuGet.Common.TelemetryActivity.Dispose">
<summary> Stops tracking the activity and emits a telemetry event. </summary>
</member>
<member name="M:NuGet.Common.TelemetryActivity.EmitTelemetryEvent(NuGet.Common.TelemetryEvent)">
<summary> Emit a singular telemetry event. </summary>
<param name="TelemetryEvent"> Telemetry event. </param>
</member>
<member name="M:NuGet.Common.TelemetryActivity.Create(System.String)">
<summary> Creates a TelemetryActivity. </summary>
<param name="eventName"> Name of the event. </param>
<returns> TelemetryActivity with an empty parentId, new operationId, and a TelemetryEvent with eventName. </returns>
</member>
<member name="M:NuGet.Common.TelemetryActivity.Create(NuGet.Common.TelemetryEvent)">
<summary> Creates a TelemetryActivity. </summary>
<param name="telemetryEvent"> Telemetry event. </param>
<returns> TelemetryActivity with an empty parentId, new operationId, and given TelemetryEvent. </returns>
</member>
<member name="M:NuGet.Common.TelemetryActivity.Create(System.Guid,System.String)">
<summary> Creates a TelemetryActivity. </summary>
<param name="parentId"> OperationId of the parent event. </param>
<param name="eventName"> Name of the event. </param>
<returns> TelemetryActivity with a given parentId, new operationId, and a TelemetryEvent with eventName. </returns>
</member>
<member name="M:NuGet.Common.TelemetryActivity.Create(System.Guid,NuGet.Common.TelemetryEvent)">
<summary> Creates a TelemetryActivity. </summary>
<param name="parentId"> OperationId of the parent event. </param>
<param name="telemetryEvent"> Telemetry event. </param>
<returns> TelemetryActivity with a given parentId, new operationId, and given TelemetryEvent. </returns>
</member>
<member name="T:NuGet.Common.TelemetryEvent">
<summary> Represents a NuGet telemetry event data to pass to telemetry service. </summary>
</member>
<member name="M:NuGet.Common.TelemetryEvent.#ctor(System.String)">
<summary> Creates a new instance of <see cref="T:NuGet.Common.TelemetryEvent" />. </summary>
<param name="eventName"> Event name. </param>
</member>
<member name="M:NuGet.Common.TelemetryEvent.#ctor(System.String,System.Collections.Generic.Dictionary{System.String,System.Object})">
<summary> Creates a new instance of <see cref="T:NuGet.Common.TelemetryEvent" />. </summary>
<param name="eventName"> Event name. </param>
<param name="properties"> Properties to add to the event. </param>
</member>
<member name="P:NuGet.Common.TelemetryEvent.Name">
<summary> Name of the event. </summary>
</member>
<member name="P:NuGet.Common.TelemetryEvent.Count">
<summary> Number of properties. </summary>
</member>
<member name="P:NuGet.Common.TelemetryEvent.Item(System.String)">
<summary> Returns a property with given <paramref name="key" />. </summary>
<param name="key"> Property key. </param>
<returns> Property value. </returns>
</member>
<member name="P:NuGet.Common.TelemetryEvent.ComplexData">
<summary> Complex data properties. </summary>
</member>
<member name="M:NuGet.Common.TelemetryEvent.GetEnumerator">
<summary> Gets enumerator to enumerate properties. </summary>
<returns> Enumerator over recorded properties. </returns>
</member>
<member name="M:NuGet.Common.TelemetryEvent.AddPiiData(System.String,System.Object)">
<summary> Adds personally-identifiable information property. </summary>
<param name="key"> Property key. </param>
<param name="value"> Property value. </param>
</member>
<member name="M:NuGet.Common.TelemetryEvent.GetPiiData">
<summary> Gets personally-identifiable information properties. </summary>
<returns> List of personally-identifiable information properties. </returns>
</member>
<member name="T:NuGet.Common.TelemetryServiceUtility">
<summary> Utility for managing stopwatch timers. </summary>
</member>
<member name="M:NuGet.Common.TelemetryServiceUtility.StartOrResumeTimer">
<summary> Starts or resumes timer. </summary>
</member>
<member name="M:NuGet.Common.TelemetryServiceUtility.StopTimer">
<summary> Stops timer. </summary>
</member>
<member name="M:NuGet.Common.TelemetryServiceUtility.GetTimerElapsedTime">
<summary> Gets elapsed time. </summary>
<returns> Elapsed time. </returns>
</member>
<member name="M:NuGet.Common.TelemetryServiceUtility.GetTimerElapsedTimeInSeconds">
<summary> Gets elapsed time in seconds. </summary>
<returns> Elapsed time in seconds. </returns>
</member>
<member name="T:NuGet.Common.Tokenizer">
<summary>
This class is used to parse string into tokens.
There are two types of tokens: variables, e.g. "$variable$", or text.
The dollar sign can be escaped using $$.
A variable contains only word characters.
Examples:
- "a $b$ c" is parsed into
{text, "a "}, {variable, "b"}, {text, " c"}.
- "a $$b$$ c" is parsed into
{text, "a $b$ c"}.
- "a $b$ $c" is parsed into
{text, "a "}, {variable, "b"}, {text, " $c"}.
- "a $b$$c$" is parsed into
{text, "a "}, {variable, "b"}, {variable, "c"}.
- "a $b c$d$" is parsed into
{text, "a $b c"}, {variable, "d"} (because space is not a word character).
</summary>
</member>
<member name="M:NuGet.Common.Tokenizer.Read">
<summary>
Gets the next token.
</summary>
<returns>The parsed token. Or null if no more tokens are available.</returns>
</member>
<member name="M:NuGet.Common.UriUtility.CreateSourceUri(System.String,System.UriKind)">
<summary>
Same as "new Uri" except that it can handle UNIX style paths that start with '/'
</summary>
</member>
<member name="M:NuGet.Common.UriUtility.TryCreateSourceUri(System.String,System.UriKind)">
<summary>
Same as "Uri.TryCreate" except that it can handle UNIX style paths that start with '/'
</summary>
</member>
<member name="M:NuGet.Common.UriUtility.UrlEncodeOdataParameter(System.String)">
<summary>
Provides Uri encoding for V2 servers in the same way that NuGet.Core.dll encoded urls.
</summary>
</member>
<member name="M:NuGet.Common.UriUtility.GetLocalPath(System.String)">
<summary>
Convert a file:// URI to a local path.
</summary>
<returns>If the input can be parsed this will return Uri.LocalPath, if the input
is not a URI or fails to parse the original string will be returned.</returns>
<param name="localOrUriPath">Possible file:// URI path or local path.</param>
</member>
<member name="M:NuGet.Common.UriUtility.GetAbsolutePathFromFile(System.String,System.String)">
<summary>
Calls GetAbsolutePath with the directory of <paramref name="sourceFile" />.
</summary>
</member>
<member name="M:NuGet.Common.UriUtility.GetAbsolutePath(System.String,System.String)">
<summary>
Convert a relative local folder path to an absolute path.
For http sources and UNC shares this will return
the same path.
</summary>
<param name="rootDirectory">Directory to make the source relative to.</param>
<param name="path">Source path.</param>
<returns>The absolute source path or the original source. Noops for non-file paths.</returns>
</member>
<member name="M:NuGet.Common.UriUtility.IsNuGetOrg(System.String)">
<summary>
Determines if a package source url points to nuget.org
</summary>
<param name="source">Package source url</param>
<returns>True if the source is HTTP and has a *.nuget.org or nuget.org host otherwise false</returns>
</member>
<member name="M:NuGet.Common.XmlUtility.Load(System.String)">
<summary>
Creates a new System.Xml.Linq.XDocument from a file.
</summary>
<param name="filePath">A URI string that references the file to load into a new <see cref="T:System.Xml.Linq.XDocument" /></param>
<returns>An <see cref="T:System.Xml.Linq.XDocument" /> that contains the contents of the specified file.</returns>
</member>
<member name="M:NuGet.Shared.EqualityUtility.OrderedEquals``2(System.Collections.Generic.IEnumerable{``0},System.Collections.Generic.IEnumerable{``0},System.Func{``0,``1},System.Collections.Generic.IComparer{``1},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Compares two enumerables for equality, ordered according to the specified key and optional comparer. Handles null values gracefully.
</summary>
<typeparam name="TSource">The type of the list</typeparam>
<typeparam name="TKey">The type of the sorting key</typeparam>
<param name="self">This list</param>
<param name="other">The other list</param>
<param name="keySelector">The function to extract the key from each item in the list</param>
<param name="orderComparer">An optional comparer for comparing keys</param>
<param name="sequenceComparer">An optional comparer for sequences</param>
</member>
<member name="M:NuGet.Shared.EqualityUtility.OrderedEquals``2(System.Collections.Generic.ICollection{``0},System.Collections.Generic.ICollection{``0},System.Func{``0,``1},System.Collections.Generic.IComparer{``1},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Compares two collections for equality, ordered according to the specified key and optional comparer. Handles null values gracefully.
</summary>
<typeparam name="TSource">The type of the list</typeparam>
<typeparam name="TKey">The type of the sorting key</typeparam>
<param name="self">This list</param>
<param name="other">The other list</param>
<param name="keySelector">The function to extract the key from each item in the list</param>
<param name="orderComparer">An optional comparer for comparing keys</param>
<param name="sequenceComparer">An optional comparer for sequences</param>
</member>
<member name="M:NuGet.Shared.EqualityUtility.OrderedEquals``2(System.Collections.Generic.IList{``0},System.Collections.Generic.IList{``0},System.Func{``0,``1},System.Collections.Generic.IComparer{``1},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Compares two lists for equality, ordered according to the specified key and optional comparer. Handles null values gracefully.
</summary>
<typeparam name="TSource">The type of the list</typeparam>
<typeparam name="TKey">The type of the sorting key</typeparam>
<param name="self">This list</param>
<param name="other">The other list</param>
<param name="keySelector">The function to extract the key from each item in the list</param>
<param name="orderComparer">An optional comparer for comparing keys</param>
<param name="sequenceComparer">An optional comparer for sequences</param>
</member>
<member name="M:NuGet.Shared.EqualityUtility.SequenceEqualWithNullCheck``1(System.Collections.Generic.IEnumerable{``0},System.Collections.Generic.IEnumerable{``0},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Compares two sequence for equality, allowing either sequence to be null. If one is null, both have to be
null for equality.
</summary>
</member>
<member name="M:NuGet.Shared.EqualityUtility.SequenceEqualWithNullCheck``1(System.Collections.Generic.ICollection{``0},System.Collections.Generic.ICollection{``0},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Compares two collections for equality, allowing either collection to be null. If one is null, both have to be
null for equality.
</summary>
</member>
<member name="M:NuGet.Shared.EqualityUtility.SequenceEqualWithNullCheck``1(System.Collections.Generic.IList{``0},System.Collections.Generic.IList{``0},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Compares two lists for equality, allowing either list to be null. If one is null, both have to be
null for equality.
</summary>
</member>
<member name="M:NuGet.Shared.EqualityUtility.SetEqualsWithNullCheck``1(System.Collections.Generic.ISet{``0},System.Collections.Generic.ISet{``0},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Compares two sets for equality, allowing either sequence to be null.
If one is null, both have to be null for equality.
</summary>
</member>
<member name="M:NuGet.Shared.EqualityUtility.EqualsFalse(System.String)">
<summary>
Determines if the current string contains a value equal "false". Leading and trailing whitespace are trimmed and the comparision is case-insensitive
</summary>
<param name="value">The string to compare.</param>
<returns><c>true</c> if the current string is equal to a value of "false", otherwise <c>false></c>.</returns>
</member>
<member name="T:NuGet.Shared.HashCodeCombiner">
<summary>
Hash code creator, based on the original NuGet hash code combiner/ASP hash code combiner implementations
</summary>
</member>
<member name="M:NuGet.Shared.HashCodeCombiner.GetHashCode``2(``0,``1)">
<summary>
Create a unique hash code for the given set of items
</summary>
</member>
<member name="M:NuGet.Shared.HashCodeCombiner.GetHashCode``3(``0,``1,``2)">
<summary>
Create a unique hash code for the given set of items
</summary>
</member>
<member name="M:NuGet.Shared.Extensions.AsList``1(System.Collections.Generic.IEnumerable{``0})">
<summary>
Return the enumerable as a List of T, copying if required. Optimized for common case where it is an List of T.
Avoid mutating the return value.
</summary>
<remarks>https://aspnetwebstack.codeplex.com/SourceControl/latest#src/Common/CollectionExtensions.cs</remarks>
</member>
<member name="M:NuGet.Shared.Extensions.AsHashSet``1(System.Collections.Generic.ISet{``0},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Return the ISet as a HashSet of T, copying if required. Optimized for common case where it is a HashSet of T.
Avoid mutating the return value.
</summary>
</member>
<member name="M:NuGet.Shared.XmlUtility.Load(System.String)">
<summary>
Creates a new <see cref="T:System.Xml.Linq.XDocument" /> from a file.
</summary>
<param name="path">The complete file path to be read into a new <see cref="T:System.Xml.Linq.XDocument" />.</param>
<returns>An <see cref="T:System.Xml.Linq.XDocument" /> that contains the contents of the specified file.</returns>
</member>
<member name="M:NuGet.Shared.XmlUtility.Load(System.String,System.Xml.Linq.LoadOptions)">
<summary>
Creates a new <see cref="T:System.Xml.Linq.XDocument" /> from a file. Optionally, whitespace can be preserved.
</summary>
<param name="path">The complete file path to be read into a new <see cref="T:System.Xml.Linq.XDocument" />.</param>
<param name="options">A set of <see cref="T:System.Xml.Linq.LoadOptions" />.</param>
<returns>An <see cref="T:System.Xml.Linq.XDocument" /> that contains the contents of the specified file.</returns>
</member>
<member name="M:NuGet.Shared.XmlUtility.Load(System.IO.Stream)">
<summary>
Creates a new <see cref="T:System.Xml.Linq.XDocument" /> from a stream.
</summary>
<param name="input">The stream that contains the XML data.</param>
<returns>An <see cref="T:System.Xml.Linq.XDocument" /> that contains the contents of the specified stream.</returns>
</member>
<member name="M:NuGet.Shared.XmlUtility.Load(System.IO.Stream,System.Xml.Linq.LoadOptions)">
<summary>
Creates a new System.Xml.Linq.XDocument from a stream. Optionally, whitespace can be preserved.
</summary>
<param name="input">The stream that contains the XML data.</param>
<param name="options">A set of <see cref="T:System.Xml.Linq.LoadOptions" />.</param>
<returns>An <see cref="T:System.Xml.Linq.XDocument" /> that contains the contents of the specified stream.</returns>
</member>
<member name="M:NuGet.Shared.XmlUtility.GetEncodedXMLName(System.String)">
<summary>
Converts the name to a valid XML local name, if it is invalid.
</summary>
<param name="name">The name to be encoded.</param>
<returns>The encoded name.</returns>
</member>
<member name="M:NuGet.Shared.XmlUtility.GetXmlReaderSettings(System.Xml.Linq.LoadOptions)">
<summary>
Creates an instance of <see cref="T:System.Xml.XmlReaderSettings" /> with safe settings
<param name="options">A set of <see cref="T:System.Xml.Linq.LoadOptions" />.</param>
</summary>
</member>
<member name="T:NuGet.StringBuilderPool">
<summary>
Provides a resource pool that enables reusing instances of <see cref="T:System.Text.StringBuilder" /> instances.
</summary>
<remarks>
<para>
Renting and returning buffers with an <see cref="T:NuGet.StringBuilderPool" /> can increase performance
in situations where <see cref="T:System.Text.StringBuilder" /> instances are created and destroyed frequently,
resulting in significant memory pressure on the garbage collector.
</para>
<para>
This class is thread-safe. All members may be used by multiple threads concurrently.
</para>
</remarks>
</member>
<member name="F:NuGet.StringBuilderPool.Shared">
<summary>
Retrieves a shared <see cref="T:NuGet.StringBuilderPool" /> instance.
</summary>
</member>
<member name="M:NuGet.StringBuilderPool.Rent(System.Int32)">
<summary>
Retrieves a <see cref="T:System.Text.StringBuilder" /> that is at least the requested length.
</summary>
<param name="minimumCapacity">The minimum capacity of the <see cref="T:System.Text.StringBuilder" /> needed.</param>
<returns>
A <see cref="T:System.Text.StringBuilder" /> that is at least <paramref name="minimumCapacity" /> in length.
</returns>
<remarks>
This buffer is loaned to the caller and should be returned to the same pool via
<see cref="M:NuGet.StringBuilderPool.Return(System.Text.StringBuilder)" /> so that it may be reused in subsequent usage of <see cref="M:NuGet.StringBuilderPool.Rent(System.Int32)" />.
It is not a fatal error to not return a rented string builder, but failure to do so may lead to
decreased application performance, as the pool may need to create a new instance to replace
the one lost.
</remarks>
</member>
<member name="M:NuGet.StringBuilderPool.Return(System.Text.StringBuilder)">
<summary>
Returns to the pool an array that was previously obtained via <see cref="M:NuGet.StringBuilderPool.Rent(System.Int32)" /> on the same
<see cref="T:NuGet.StringBuilderPool" /> instance.
</summary>
<param name="builder">
The <see cref="T:System.Text.StringBuilder" /> previously obtained from <see cref="M:NuGet.StringBuilderPool.Rent(System.Int32)" /> to return to the pool.
</param>
<remarks>
Once a <see cref="T:System.Text.StringBuilder" /> has been returned to the pool, the caller gives up all ownership
of the instance and must not use it. The reference returned from a given call to <see cref="M:NuGet.StringBuilderPool.Rent(System.Int32)" />
must only be returned via <see cref="M:NuGet.StringBuilderPool.Return(System.Text.StringBuilder)" /> once. The default <see cref="T:NuGet.StringBuilderPool" />
may hold onto the returned instance in order to rent it again, or it may release the returned instance
if it's determined that the pool already has enough instances stored.
</remarks>
</member>
</members>
<Signature xmlns="http://www.w3.org/2000/09/xmldsig#"><SignedInfo><CanonicalizationMethod Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315" /><SignatureMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#rsa-sha256" /><Reference URI=""><Transforms><Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature" /><Transform Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315" /></Transforms><DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256" /><DigestValue>FeBybtRGC9+sB8iKCcIfWdn32qvznGIn82ey8k0Sv7U=</DigestValue></Reference></SignedInfo><SignatureValue>AXrpNhcYi7NVlzkAtgF6k46RSNqOMxC+5d2UTKykUNizKyMQhatoyl8t4vOm1hfm20KPakdYsdshzgNgRy5UyKfDzaMYTT3eXui4Zm+vY1SL4cHw71ISpuxkUtdUHsk27MCshdIByF+o6CBZv/kPj6ZuQZgi2fRkPkYsLJW6425imh5Kayc/5WloPeRJCk46V3HXUTyoo5ZPD1wrosjT9MnSPAFyNP79TVXfh0UasBo4PMy+yqVRt1kOExuyCMQxFM6AJ8OEU9oGlpoi48cCSLsjKgX7+oCz8PoBAEjxzIS0/uyCBVpyGcb/srttG5/cxb78sHqEYdGn9RyXAHKtEg==</SignatureValue><KeyInfo><KeyValue><RSAKeyValue><Modulus>ok2x7OvGwA7zbnfezc3HT9M4dJka+FaQ7+vCqG40Bcm1QLlYIiDX/Whts0LVijaOvtl9iMeuShnAV7mchItKAVAABpyHuTuav2NCI9FsA8jFmlWndk3uK9RInNx1h1H4ojYxdBExyoN6muwwslKsLEfauUml7h5WAsDPpufTZd4yp2Jyiy384Zdd8CJlfQxfDe+gDZEciugWKHPSOoRxdjAk0GFm0OH14MyoYM4+M3mm1oH7vmSQohS5KIL3NEVW9Mdw7csTG5f93uORLvrJ/8ehFcGyWVb7UGHJnRhdcgGIbfiZzZlsAMS/DIBzM8RHKGNUNSbbLYmN/rt7pRjL4Q==</Modulus><Exponent>AQAB</Exponent></RSAKeyValue></KeyValue><X509Data><X509Certificate>MIIF/zCCA+egAwIBAgITMwAAAsyOtZamvdHJTgAAAAACzDANBgkqhkiG9w0BAQsFADB+MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSgwJgYDVQQDEx9NaWNyb3NvZnQgQ29kZSBTaWduaW5nIFBDQSAyMDExMB4XDTIyMDUxMjIwNDYwMVoXDTIzMDUxMTIwNDYwMVowdDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEeMBwGA1UEAxMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAok2x7OvGwA7zbnfezc3HT9M4dJka+FaQ7+vCqG40Bcm1QLlYIiDX/Whts0LVijaOvtl9iMeuShnAV7mchItKAVAABpyHuTuav2NCI9FsA8jFmlWndk3uK9RInNx1h1H4ojYxdBExyoN6muwwslKsLEfauUml7h5WAsDPpufTZd4yp2Jyiy384Zdd8CJlfQxfDe+gDZEciugWKHPSOoRxdjAk0GFm0OH14MyoYM4+M3mm1oH7vmSQohS5KIL3NEVW9Mdw7csTG5f93uORLvrJ/8ehFcGyWVb7UGHJnRhdcgGIbfiZzZlsAMS/DIBzM8RHKGNUNSbbLYmN/rt7pRjL4QIDAQABo4IBfjCCAXowHwYDVR0lBBgwFgYKKwYBBAGCN0wIAQYIKwYBBQUHAwMwHQYDVR0OBBYEFIi4R40ylsyKlSKfrDNqzhx9da30MFAGA1UdEQRJMEekRTBDMSkwJwYDVQQLEyBNaWNyb3NvZnQgT3BlcmF0aW9ucyBQdWVydG8gUmljbzEWMBQGA1UEBRMNMjMwMDEyKzQ3MDUyOTAfBgNVHSMEGDAWgBRIbmTlUAXTgqoXNzcitW2oynUClTBUBgNVHR8ETTBLMEmgR6BFhkNodHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20vcGtpb3BzL2NybC9NaWNDb2RTaWdQQ0EyMDExXzIwMTEtMDctMDguY3JsMGEGCCsGAQUFBwEBBFUwUzBRBggrBgEFBQcwAoZFaHR0cDovL3d3dy5taWNyb3NvZnQuY29tL3BraW9wcy9jZXJ0cy9NaWNDb2RTaWdQQ0EyMDExXzIwMTEtMDctMDguY3J0MAwGA1UdEwEB/wQCMAAwDQYJKoZIhvcNAQELBQADggIBAHgPA7DgB0udzEyB2LvG216zuskLUQ+iX8jFnl2i7tzXPDw5xXNXn2KvxdzBsf2osDW3LCdjFOwSjVkz+SUFQQNhjSHkd5knF6pzrL9V6lz72XiEg1Vi2gUM3HiLXSMIKOgdd78ZZJEmDLwdA692MO/1vVOFpOSv0QzpyBr5iqiotwMMsZVdZqXn8u9vRSmlk+3nQXdyOPoZXTGPLHXwz41kbSc4zI12bONTlDsLR3HD2s44wuyp3c72R8f9FVi/J9DU/+NOL37Z1yonzGZEuKdrAd6CvupAnLMlrIEv93mBsNRXuDDp4p9UYYK1taxzzgyUxgFDpluMHN0Oiiq9s73u7DA2XvbX8paJz8IZPe9a1/KhsOi5Kxhb99SCXiUnv2lGxnVAz5G6wAW1bzxJYKI+Xj90RKseY3X5EMO7TnVpIZ9Iw1IdrkHp/QLY90ZCch7kdBlLCVTFhSXZCDv4BcM6DhpRzbJsb6QDVfOv9aoG9aGV3a1EacyaedzLA2gWP6cTnCdAr4OrlrN5EFoCpOWgc77F/eQc3SLR06VTLVT1uKuNVxL2xZlD9Z+qC+a3TXa0zI/x1zEZNSgpLGsdVcaN6r/td3ArGQGkDWiAL7eS75LIWZA2SD//9B56uzZ1nmEd8+KBYsPTdp922/W2kFrlj7MBtA6vWE/ZG/grOKiC</X509Certificate><X509Certificate>MIIHejCCBWKgAwIBAgIKYQ6Q0gAAAAAAAzANBgkqhkiG9w0BAQsFADCBiDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEyMDAGA1UEAxMpTWljcm9zb2Z0IFJvb3QgQ2VydGlmaWNhdGUgQXV0aG9yaXR5IDIwMTEwHhcNMTEwNzA4MjA1OTA5WhcNMjYwNzA4MjEwOTA5WjB+MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSgwJgYDVQQDEx9NaWNyb3NvZnQgQ29kZSBTaWduaW5nIFBDQSAyMDExMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAq/D6chAcLq3YbqqCEE00uvK2WCGfQhsqa+laUKq4BjgaBEm6f8MMHt03a8YS2AvwOMKZBrDIOdUBFDFC04kNeWSHfpRgJGyvnkmc6Whe0t+bU7IKLMOv2akrrnoJr9eWWcpgGgXpZnboMlImEi/nqwhQz7NEt13YxC4Ddato88tt8zpcoRb0RrrgOGSsbmQ1eKagYw8t00CT+OPeBw3VXHmlSSnnDb6gE3e+lD3v++MrWhAfTVYoonpy4BI6t0le2O3tQ5GD2Xuye4Yb2T6xjF3oiU+EGvKhL1nkkDstrjNYxbc+/jLTswM9sbKvkjh+0p2ALPVOVpEhNSXDOW5kf1O6nA+tGSOEy/S6A4aN91/w0FK/jJSHvMAhdCVfGCi2zCcoOCWYOUo2z3yxkq4cI6epZuxhH2rhKEmdX4jiJV3TIUs+UsS1Vz8kA/DRelsv1SPjcF0PUUZ3s/gA4bysAoJf28AVs70b1FVL5zmhD+kjSbwYuER8ReTBw3J64HLnJN+/RpnF78IcV9uDjexNSTCnq47f7Fufr/zdsGbiwZeBe+3W7UvnSSmnEyimp31ngOaKYnhfsi+E11ecXL93KCjx7W3DKI8sj0A3T8HhhUSJxAlMxdSlQy90lfdu+HggWCwTXWCVmj5PM4TasIgX3p5O9JawvEagbJjS4NaIjAsCAwEAAaOCAe0wggHpMBAGCSsGAQQBgjcVAQQDAgEAMB0GA1UdDgQWBBRIbmTlUAXTgqoXNzcitW2oynUClTAZBgkrBgEEAYI3FAIEDB4KAFMAdQBiAEMAQTALBgNVHQ8EBAMCAYYwDwYDVR0TAQH/BAUwAwEB/zAfBgNVHSMEGDAWgBRyLToCMZBDuRQFTuHqp8cx0SOJNDBaBgNVHR8EUzBRME+gTaBLhklodHRwOi8vY3JsLm1pY3Jvc29mdC5jb20vcGtpL2NybC9wcm9kdWN0cy9NaWNSb29DZXJBdXQyMDExXzIwMTFfMDNfMjIuY3JsMF4GCCsGAQUFBwEBBFIwUDBOBggrBgEFBQcwAoZCaHR0cDovL3d3dy5taWNyb3NvZnQuY29tL3BraS9jZXJ0cy9NaWNSb29DZXJBdXQyMDExXzIwMTFfMDNfMjIuY3J0MIGfBgNVHSAEgZcwgZQwgZEGCSsGAQQBgjcuAzCBgzA/BggrBgEFBQcCARYzaHR0cDovL3d3dy5taWNyb3NvZnQuY29tL3BraW9wcy9kb2NzL3ByaW1hcnljcHMuaHRtMEAGCCsGAQUFBwICMDQeMiAdAEwAZQBnAGEAbABfAHAAbwBsAGkAYwB5AF8AcwB0AGEAdABlAG0AZQBuAHQALiAdMA0GCSqGSIb3DQEBCwUAA4ICAQBn8oalmOBUeRou09h0ZyKbC5YR4WOSmUKWfdJ5DJDBZV8uLD74w3LRbYP+vj/oCso7v0epo/Np22O/IjWll11lhJB9i0ZQVdgMknzSGksc8zxCi1LQsP1r4z4HLimb5j0bpdS1HXeUOeLpZMlEPXh6I/MTfaaQdION9MsmAkYqwooQu6SpBQyb7Wj6aC6VoCo/KmtYSWMfCWluWpiW5IP0wI/zRive/DvQvTXvbiWu5a8n7dDd8w6vmSiXmE0OPQvyCInWH8MyGOLwxS3OW560STkKxgrCxq2u5bLZ2xWIUUVYODJxJxp/sfQn+N4sOiBpmLJZiWhub6e3dMNABQamASooPoI/E01mC8CzTfXhj38cbxV9Rad25UAqZaPDXVJihsMdYzaXht/a8/jyFqGaJ+HNpZfQ7l1jQeNbB5yHPgZ3BtEGsXUfFL5hYbXw3MYbBL7fQccOKO7eZS/sl/ahXJbYANahRr1Z85elCUtIEJmAH9AAKcWxm6U/RXceNcbSoqKfenoi+kiVH6v7RyOA9Z74v2u3S5fi63V4GuzqN5l5GEv/1rMjaHXmr/r8i+sLgOppO6/8MO0ETI7f33VtY5E90Z1WTk+/gFcioXgRMiF670EKsT/7qMykXcGhiJtXcVZOSEXAQsmbdlsKgEhr/Xmfwb1tbWrJUnMTDXpQzQ==</X509Certificate><X509Certificate>MIIF7TCCA9WgAwIBAgIQP4vItfyfspZDtWnWbELhRDANBgkqhkiG9w0BAQsFADCBiDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEyMDAGA1UEAxMpTWljcm9zb2Z0IFJvb3QgQ2VydGlmaWNhdGUgQXV0aG9yaXR5IDIwMTEwHhcNMTEwMzIyMjIwNTI4WhcNMzYwMzIyMjIxMzA0WjCBiDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEyMDAGA1UEAxMpTWljcm9zb2Z0IFJvb3QgQ2VydGlmaWNhdGUgQXV0aG9yaXR5IDIwMTEwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQCygEGqNThNE3IyaCJNuLLx/9VSvGzH9dJKjDbu0cJcfoyKrq8TKG/Ac+M6ztAlqFo6be+ouFmrEyNozQwph9FvgFyPRH9dkAFSWKxRxV8qh9zc2AodwQO5e7BW6KPeZGHCnvjzfLnsDbVU/ky2ZU+I8JxImQxCCwl8MVkXeQZ4KI2JOkwDJb5xalwL54RgpJki49KvhKSn+9GY7Qyp3pSJ4Q6g3MDOmT3qCFK7VnnkH4S6Hri0xElcTzFLh93dBWcmmYDgcRGjuKVB4qRTufcyKYMME782XgSzS0NHL2vikR7TmE/dQgfI6B0S/Jmpaz6SfsjWaTr8ZL22CZ3K/QwLopt3YEsDlKQwaRLWQi3BQUzK3Kr9j1uDRprZ/LHR47PJf0h6zSTwQY9cdNCssBAgBkm3xy0hyFfj0IbzA2j70M5xwYmZSmQBbP3sMJHPQTySx+W6hh1hhMdfgzlirrSSL0fzC/hV66AfWdC7dJse0Hbm8ukG1xDo+mTeacY1logC8Ea4PyeZb8txiSk190gWAjWP1Xl8TQLPX+uKg09FcYj5qQ1OcunCnAfPSRtOBA5jUYxe2ADBVSy2xuDCZU7JNDn1nLPEfuhhbhNfFcRf2X7tHc7uROzLLoax7Dj2cO2rXBPB2Q8Nx4CyVe0096yb5MPa50c8prWPMd/FS6/r8QIDAQABo1EwTzALBgNVHQ8EBAMCAYYwDwYDVR0TAQH/BAUwAwEB/zAdBgNVHQ4EFgQUci06AjGQQ7kUBU7h6qfHMdEjiTQwEAYJKwYBBAGCNxUBBAMCAQAwDQYJKoZIhvcNAQELBQADggIBAH9yzw+3xRXbm8BJyiZb/p4T5tPw0tuXX/JLP02zrhmu7deXoKzvqTqjwkGw5biRnhOBJAPmCf0/V0A5ISRW0RAvS0CpNoZLtFNXmvvxfomPEf4YbFGq6O0JlbXlccmh6Yd1phV/yX43VF50k8XDZ8wNT2uoFwxtCJJ+i92Bqi1wIcM9BhS7vyRep4TXPw8hIr1LAAbblxzYXtTFC1yHblCk6MM4pPvLLMWSZpuFXst6bJN8gClYW1e1QGm6CHmmZGIVnYeWRbVmIyADixxzoNOieTPgUFmG2y/lAiXqcyqfABTINseSO+lOAOzYVgm5M0kS0lQLAausR7aRKX1MtHWAUgHoyoL2n8ysnI8X6i8msKtyrAv+nlEex0NVZ09Rs1fWtuzuUrc66U7h14GIvE+OdbtLqPA1qibUZ2dJsnBMO5PcHd94kIZysjik0dySTclY6ysSXNQ7roxrsIPlAT/4CTL2kzU0Iq/dNw13CYArzUgA8YyZGUcFAenRv9FO0OYoQzeZpApKCNmacXPSqs0xE2N2oTdvkjgefRI8ZjLny23h/FKJ3crWZgWalmG+oijHHKOnNlA8OqTfSm7mhzvO6/DggTedEzxSjr25HTTGHdUKaj2YKXCMiSrRq4IQSB/c9O+lxbtVGjhjhE63bK2VVOxlIhBJF7jAHscPrFRH</X509Certificate></X509Data></KeyInfo><Object Id="ts-countersig"><X509Data><X509Certificate>MIIHFDCCBPygAwIBAgITMwAAAY16VS54dJkqtwABAAABjTANBgkqhkiG9w0BAQsFADB8MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSYwJAYDVQQDEx1NaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0EgMjAxMDAeFw0yMTEwMjgxOTI3NDVaFw0yMzAxMjYxOTI3NDVaMIHSMQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMS0wKwYDVQQLEyRNaWNyb3NvZnQgSXJlbGFuZCBPcGVyYXRpb25zIExpbWl0ZWQxJjAkBgNVBAsTHVRoYWxlcyBUU1MgRVNOOkEyNDAtNEI4Mi0xMzBFMSUwIwYDVQQDExxNaWNyb3NvZnQgVGltZS1TdGFtcCBTZXJ2aWNlMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEA2jRILZg+O6U7dLcuwBPMB+0tJUz0wHLqJ5f7KJXQsTzWToADUMYV4xVZnp9mPTWojUJ/l3O4XqegLDNduFAObcitrLyY5HDsxAfUG1/2YilcSkSP6CcMqWfsSwULGX5zlsVKHJ7tvwg26y6eLklUdFMpiq294T4uJQdXd5O7mFy0vVkaGPGxNWLbZxKNzqKtFnWQ7jMtZ05XvafkIWZrNTFv8GGpAlHtRsZ1A8KDo6IDSGVNZZXbQs+fOwMOGp/Bzod8f1YI8Gb2oN/mx2ccvdGr9la55QZeVsM7LfTaEPQxbgAcLgWDlIPcmTzcBksEzLOQsSpBzsqPaWI9ykVw5ofmrkFKMbpQT5EMki2suJoVM5xGgdZWnt/tz00xubPSKFi4B4IMFUB9mcANUq9cHaLsHbDJ+AUsVO0qnVjwzXPYJeR7C/B8X0Ul6UkIdplZmncQZSBK3yZQy+oGsuJKXFAq3BlxT6kDuhYYvO7itLrPeY0knut1rKkxom+ui6vCdthCfnAiyknyRC2lknqzz8x1mDkQ5Q6Ox9p6/lduFupSJMtgsCPN9fIvrfppMDFIvRoULsHOdLJjrRli8co5M+vZmf20oTxYuXzM0tbRurEJycB5ZMbwznsFHymOkgyx8OeFnXV3car45uejI1B1iqUDbeSNxnvczuOhcpzwackCAwEAAaOCATYwggEyMB0GA1UdDgQWBBR4zJFuh59GwpTuSju4STcflihmkzAfBgNVHSMEGDAWgBSfpxVdAF5iXYP05dJlpxtTNRnpcjBfBgNVHR8EWDBWMFSgUqBQhk5odHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20vcGtpb3BzL2NybC9NaWNyb3NvZnQlMjBUaW1lLVN0YW1wJTIwUENBJTIwMjAxMCgxKS5jcmwwbAYIKwYBBQUHAQEEYDBeMFwGCCsGAQUFBzAChlBodHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20vcGtpb3BzL2NlcnRzL01pY3Jvc29mdCUyMFRpbWUtU3RhbXAlMjBQQ0ElMjAyMDEwKDEpLmNydDAMBgNVHRMBAf8EAjAAMBMGA1UdJQQMMAoGCCsGAQUFBwMIMA0GCSqGSIb3DQEBCwUAA4ICAQA1r3Oz0lEq3VvpdFlh3YBxc4hnYkALyYPDa9FO4XgqwkBm8Lsb+lK3tbGGgpi6QJbK3iM3BK0ObBcwRaJVCxGLGtr6Jz9hRumRyF8o4n2y3YiKv4olBxNjFShSGc9E29JmVjBmLgmfjRqPc/2rD25q4ow4uA3rc9ekiaufgGhcSAdek/l+kASbzohOt/5z2+IlgT4e3auSUzt2GAKfKZB02ZDGWKKeCY3pELj1tuh6yfrOJPPInO4ZZLW3vgKavtL8e6FJZyJoDFMewJ59oEL+AK3e2M2I4IFE9n6LVS8bS9UbMUMvrAlXN5ZM2I8GdHB9TbfI17Wm/9Uf4qu588PJN7vCJj9s+KxZqXc5sGScLgqiPqIbbNTE+/AEZ/eTixc9YLgTyMqakZI59wGqjrONQSY7u0VEDkEE6ikz+FSFRKKzpySb0WTgMvWxsLvbnN8ACmISPnBHYZoGssPAL7foGGKFLdABTQC2PX19WjrfyrshHdiqSlCspqIGBTxRaHtyPMro3B/26gPfCl3MC3rC3NGq4xGnIHDZGSizUmGg8TkQAloVdU5dJ1v910gjxaxaUraGhP8IttE0RWnU5XRp/sGaNmDcMwbyHuSpaFsn3Q21OzitP4BnN5tprHangAC7joe4zmLnmRnAiUc9sRqQ2bmsMAvUpsO8nlOFmiM1Lw==</X509Certificate><X509Certificate>MIIHcTCCBVmgAwIBAgITMwAAABXF52ueAptJmQAAAAAAFTANBgkqhkiG9w0BAQsFADCBiDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEyMDAGA1UEAxMpTWljcm9zb2Z0IFJvb3QgQ2VydGlmaWNhdGUgQXV0aG9yaXR5IDIwMTAwHhcNMjEwOTMwMTgyMjI1WhcNMzAwOTMwMTgzMjI1WjB8MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSYwJAYDVQQDEx1NaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0EgMjAxMDCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAOThpkzntHIhC3miy9ckeb0O1YLT/e6cBwfSqWxOdcjKNVf2AX9sSuDivbk+F2Az/1xPx2b3lVNxWuJ+Slr+uDZnhUYjDLWNE893MsAQGOhgfWpSg0S3po5GawcU88V29YZQ3MFEyHFcUTE3oAo4bo3t1w/YJlN8OWECesSq/XJprx2rrPY2vjUmZNqYO7oaezOtgFt+jBAcnVL+tuhiJdxqD89d9P6OU8/W7IVWTe/dvI2k45GPsjksUZzpcGkNyjYtcI4xyDUoveO0hyTD4MmPfrVUj9z6BVWYbWg7mka97aSueik3rMvrg0XnRm7KMtXAhjBcTyziYrLNueKNiOSWrAFKu75xqRdbZ2De+JKRHh09/SDPc31BmkZ1zcRfNN0Sidb9pSB9fvzZnkXftnIv231fgLrbqn427DZM9ituqBJR6L8FA6PRc6ZNN3SUHDSCD/AQ8rdHGO2n6Jl8P0zbr17C89XYcz1DTsEzOUyOArxCaC4Q6oRRRuLRvWoYWmEBc8pnol7XKHYC4jMYctenIPDC+hIK12NvDMk2ZItboKaDIV1fMHSRlJTYuVD5C4lh8zYGNRiER9vcG9H9stQcxWv2XFJRXRLbJbqvUAV6bMURHXLvjflSxIUXk8A8FdsaN8cIFRg/eKtFtvUeh17aj54WcmnGrnu3tz5q4i6tAgMBAAGjggHdMIIB2TASBgkrBgEEAYI3FQEEBQIDAQABMCMGCSsGAQQBgjcVAgQWBBQqp1L+ZMSavoKRPEY1Kc8Q/y8E7jAdBgNVHQ4EFgQUn6cVXQBeYl2D9OXSZacbUzUZ6XIwXAYDVR0gBFUwUzBRBgwrBgEEAYI3TIN9AQEwQTA/BggrBgEFBQcCARYzaHR0cDovL3d3dy5taWNyb3NvZnQuY29tL3BraW9wcy9Eb2NzL1JlcG9zaXRvcnkuaHRtMBMGA1UdJQQMMAoGCCsGAQUFBwMIMBkGCSsGAQQBgjcUAgQMHgoAUwB1AGIAQwBBMAsGA1UdDwQEAwIBhjAPBgNVHRMBAf8EBTADAQH/MB8GA1UdIwQYMBaAFNX2VsuP6KJcYmjRPZSQW9fOmhjEMFYGA1UdHwRPME0wS6BJoEeGRWh0dHA6Ly9jcmwubWljcm9zb2Z0LmNvbS9wa2kvY3JsL3Byb2R1Y3RzL01pY1Jvb0NlckF1dF8yMDEwLTA2LTIzLmNybDBaBggrBgEFBQcBAQROMEwwSgYIKwYBBQUHMAKGPmh0dHA6Ly93d3cubWljcm9zb2Z0LmNvbS9wa2kvY2VydHMvTWljUm9vQ2VyQXV0XzIwMTAtMDYtMjMuY3J0MA0GCSqGSIb3DQEBCwUAA4ICAQCdVX38Kq3hLB9nATEkW+Geckv8qW/qXBS2Pk5HZHixBpOXPTEztTnXwnE2P9pkbHzQdTltuw8x5MKP+2zRoZQYIu7pZmc6U03dmLq2HnjYNi6cqYJWAAOwBb6J6Gngugnue99qb74py27YP0h1AdkY3m2CDPVtI1TkeFN1JFe53Z/zjj3G82jfZfakVqr3lbYoVSfQJL1AoL8ZthISEV09J+BAljis9/kpicO8F7BUhUKz/AyeixmJ5/ALaoHCgRlCGVJ1ijbCHcNhcy4sa3tuPywJeBTpkbKpW99Jo3QMvOyRgNI95ko+ZjtPu4b6MhrZlvSP9pEB9s7GdP32THJvEKt1MMU0sHrYUP4KWN1APMdUbZ1jdEgssU5HLcEUBHG/ZPkkvnNtyo4JvbMBV0lUZNlz138eW0QBjloZkWsNn6Qo3GcZKCS6OEuabvshVGtqRRFHqfG3rsjoiV5PndLQTHa1V1QJsWkBRH58oWFsc/4Ku+xBZj1p/cvBQUl+fpO+y/g75LcVv7TOPqUxUYS8vwLBgqJ7Fx0ViY1w/ue10CgaiQuPNtq6TPmb/wrpNPgkNWcr4A245oyZ1uEi6vAnQj0llOZ0dFtq0Z4+7X6gMTN9vMvpe784cETRkPHIqzqKOghif9lwY1NNje6CbaUFEMFxBmoQtB1VM1izoXBm8g==</X509Certificate></X509Data><CounterSignature ts-format="cms-timestamp-message" xmlns="http://schemas.microsoft.com/xmldsig/timestamp/2003">MIAGCSqGSIb3DQEHAqCAMIIW7gIBAzEPMA0GCWCGSAFlAwQCAQUAMIIBWQYLKoZIhvcNAQkQAQSgggFIBIIBRDCCAUACAQEGCisGAQQBhFkKAwEwMTANBglghkgBZQMEAgEFAAQg11WeA9RnFn3FE+kd0e0+Cc7HhRLx74XKnECC6o3rCeQCBmMSEE5OkBgTMjAyMjA5MDkyMzE3NTYuODc2WjAEgAIB9KCB2KSB1TCB0jELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEtMCsGA1UECxMkTWljcm9zb2Z0IElyZWxhbmQgT3BlcmF0aW9ucyBMaW1pdGVkMSYwJAYDVQQLEx1UaGFsZXMgVFNTIEVTTjpBMjQwLTRCODItMTMwRTElMCMGA1UEAxMcTWljcm9zb2Z0IFRpbWUtU3RhbXAgU2VydmljZaCCEWgwggcUMIIE/KADAgECAhMzAAABjXpVLnh0mSq3AAEAAAGNMA0GCSqGSIb3DQEBCwUAMHwxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpXYXNoaW5ndG9uMRAwDgYDVQQHEwdSZWRtb25kMR4wHAYDVQQKExVNaWNyb3NvZnQgQ29ycG9yYXRpb24xJjAkBgNVBAMTHU1pY3Jvc29mdCBUaW1lLVN0YW1wIFBDQSAyMDEwMB4XDTIxMTAyODE5Mjc0NVoXDTIzMDEyNjE5Mjc0NVowgdIxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpXYXNoaW5ndG9uMRAwDgYDVQQHEwdSZWRtb25kMR4wHAYDVQQKExVNaWNyb3NvZnQgQ29ycG9yYXRpb24xLTArBgNVBAsTJE1pY3Jvc29mdCBJcmVsYW5kIE9wZXJhdGlvbnMgTGltaXRlZDEmMCQGA1UECxMdVGhhbGVzIFRTUyBFU046QTI0MC00QjgyLTEzMEUxJTAjBgNVBAMTHE1pY3Jvc29mdCBUaW1lLVN0YW1wIFNlcnZpY2UwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQDaNEgtmD47pTt0ty7AE8wH7S0lTPTAcuonl/soldCxPNZOgANQxhXjFVmen2Y9NaiNQn+Xc7hep6AsM124UA5tyK2svJjkcOzEB9QbX/ZiKVxKRI/oJwypZ+xLBQsZfnOWxUocnu2/CDbrLp4uSVR0UymKrb3hPi4lB1d3k7uYXLS9WRoY8bE1YttnEo3Ooq0WdZDuMy1nTle9p+QhZms1MW/wYakCUe1GxnUDwoOjogNIZU1lldtCz587Aw4an8HOh3x/VgjwZvag3+bHZxy90av2VrnlBl5Wwzst9NoQ9DFuABwuBYOUg9yZPNwGSwTMs5CxKkHOyo9pYj3KRXDmh+auQUoxulBPkQySLay4mhUznEaB1lae3+3PTTG5s9IoWLgHggwVQH2ZwA1Sr1wdouwdsMn4BSxU7SqdWPDNc9gl5HsL8HxfRSXpSQh2mVmadxBlIErfJlDL6gay4kpcUCrcGXFPqQO6Fhi87uK0us95jSSe63WsqTGib66Lq8J22EJ+cCLKSfJELaWSerPPzHWYORDlDo7H2nr+V24W6lIky2CwI8318i+t+mkwMUi9GhQuwc50smOtGWLxyjkz69mZ/bShPFi5fMzS1tG6sQnJwHlkxvDOewUfKY6SDLHw54WddXdxqvjm56MjUHWKpQNt5I3Ge9zO46FynPBpyQIDAQABo4IBNjCCATIwHQYDVR0OBBYEFHjMkW6Hn0bClO5KO7hJNx+WKGaTMB8GA1UdIwQYMBaAFJ+nFV0AXmJdg/Tl0mWnG1M1GelyMF8GA1UdHwRYMFYwVKBSoFCGTmh0dHA6Ly93d3cubWljcm9zb2Z0LmNvbS9wa2lvcHMvY3JsL01pY3Jvc29mdCUyMFRpbWUtU3RhbXAlMjBQQ0ElMjAyMDEwKDEpLmNybDBsBggrBgEFBQcBAQRgMF4wXAYIKwYBBQUHMAKGUGh0dHA6Ly93d3cubWljcm9zb2Z0LmNvbS9wa2lvcHMvY2VydHMvTWljcm9zb2Z0JTIwVGltZS1TdGFtcCUyMFBDQSUyMDIwMTAoMSkuY3J0MAwGA1UdEwEB/wQCMAAwEwYDVR0lBAwwCgYIKwYBBQUHAwgwDQYJKoZIhvcNAQELBQADggIBADWvc7PSUSrdW+l0WWHdgHFziGdiQAvJg8Nr0U7heCrCQGbwuxv6Ure1sYaCmLpAlsreIzcErQ5sFzBFolULEYsa2vonP2FG6ZHIXyjifbLdiIq/iiUHE2MVKFIZz0Tb0mZWMGYuCZ+NGo9z/asPbmrijDi4Detz16SJq5+AaFxIB16T+X6QBJvOiE63/nPb4iWBPh7dq5JTO3YYAp8pkHTZkMZYop4JjekQuPW26HrJ+s4k88ic7hlktbe+Apq+0vx7oUlnImgMUx7Ann2gQv4Ard7YzYjggUT2fotVLxtL1RsxQy+sCVc3lkzYjwZ0cH1Nt8jXtab/1R/iq7nzw8k3u8ImP2z4rFmpdzmwZJwuCqI+ohts1MT78ARn95OLFz1guBPIypqRkjn3AaqOs41BJju7RUQOQQTqKTP4VIVEorOnJJvRZOAy9bGwu9uc3wAKYhI+cEdhmgayw8Avt+gYYoUt0AFNALY9fX1aOt/KuyEd2KpKUKymogYFPFFoe3I8yujcH/bqA98KXcwLesLc0arjEacgcNkZKLNSYaDxORACWhV1Tl0nW/3XSCPFrFpStoaE/wi20TRFadTldGn+wZo2YNwzBvIe5KloWyfdDbU7OK0/gGc3m2msdqeAALuOh7jOYueZGcCJRz2xGpDZuawwC9Smw7yeU4WaIzUvMIIHcTCCBVmgAwIBAgITMwAAABXF52ueAptJmQAAAAAAFTANBgkqhkiG9w0BAQsFADCBiDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEyMDAGA1UEAxMpTWljcm9zb2Z0IFJvb3QgQ2VydGlmaWNhdGUgQXV0aG9yaXR5IDIwMTAwHhcNMjEwOTMwMTgyMjI1WhcNMzAwOTMwMTgzMjI1WjB8MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSYwJAYDVQQDEx1NaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0EgMjAxMDCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAOThpkzntHIhC3miy9ckeb0O1YLT/e6cBwfSqWxOdcjKNVf2AX9sSuDivbk+F2Az/1xPx2b3lVNxWuJ+Slr+uDZnhUYjDLWNE893MsAQGOhgfWpSg0S3po5GawcU88V29YZQ3MFEyHFcUTE3oAo4bo3t1w/YJlN8OWECesSq/XJprx2rrPY2vjUmZNqYO7oaezOtgFt+jBAcnVL+tuhiJdxqD89d9P6OU8/W7IVWTe/dvI2k45GPsjksUZzpcGkNyjYtcI4xyDUoveO0hyTD4MmPfrVUj9z6BVWYbWg7mka97aSueik3rMvrg0XnRm7KMtXAhjBcTyziYrLNueKNiOSWrAFKu75xqRdbZ2De+JKRHh09/SDPc31BmkZ1zcRfNN0Sidb9pSB9fvzZnkXftnIv231fgLrbqn427DZM9ituqBJR6L8FA6PRc6ZNN3SUHDSCD/AQ8rdHGO2n6Jl8P0zbr17C89XYcz1DTsEzOUyOArxCaC4Q6oRRRuLRvWoYWmEBc8pnol7XKHYC4jMYctenIPDC+hIK12NvDMk2ZItboKaDIV1fMHSRlJTYuVD5C4lh8zYGNRiER9vcG9H9stQcxWv2XFJRXRLbJbqvUAV6bMURHXLvjflSxIUXk8A8FdsaN8cIFRg/eKtFtvUeh17aj54WcmnGrnu3tz5q4i6tAgMBAAGjggHdMIIB2TASBgkrBgEEAYI3FQEEBQIDAQABMCMGCSsGAQQBgjcVAgQWBBQqp1L+ZMSavoKRPEY1Kc8Q/y8E7jAdBgNVHQ4EFgQUn6cVXQBeYl2D9OXSZacbUzUZ6XIwXAYDVR0gBFUwUzBRBgwrBgEEAYI3TIN9AQEwQTA/BggrBgEFBQcCARYzaHR0cDovL3d3dy5taWNyb3NvZnQuY29tL3BraW9wcy9Eb2NzL1JlcG9zaXRvcnkuaHRtMBMGA1UdJQQMMAoGCCsGAQUFBwMIMBkGCSsGAQQBgjcUAgQMHgoAUwB1AGIAQwBBMAsGA1UdDwQEAwIBhjAPBgNVHRMBAf8EBTADAQH/MB8GA1UdIwQYMBaAFNX2VsuP6KJcYmjRPZSQW9fOmhjEMFYGA1UdHwRPME0wS6BJoEeGRWh0dHA6Ly9jcmwubWljcm9zb2Z0LmNvbS9wa2kvY3JsL3Byb2R1Y3RzL01pY1Jvb0NlckF1dF8yMDEwLTA2LTIzLmNybDBaBggrBgEFBQcBAQROMEwwSgYIKwYBBQUHMAKGPmh0dHA6Ly93d3cubWljcm9zb2Z0LmNvbS9wa2kvY2VydHMvTWljUm9vQ2VyQXV0XzIwMTAtMDYtMjMuY3J0MA0GCSqGSIb3DQEBCwUAA4ICAQCdVX38Kq3hLB9nATEkW+Geckv8qW/qXBS2Pk5HZHixBpOXPTEztTnXwnE2P9pkbHzQdTltuw8x5MKP+2zRoZQYIu7pZmc6U03dmLq2HnjYNi6cqYJWAAOwBb6J6Gngugnue99qb74py27YP0h1AdkY3m2CDPVtI1TkeFN1JFe53Z/zjj3G82jfZfakVqr3lbYoVSfQJL1AoL8ZthISEV09J+BAljis9/kpicO8F7BUhUKz/AyeixmJ5/ALaoHCgRlCGVJ1ijbCHcNhcy4sa3tuPywJeBTpkbKpW99Jo3QMvOyRgNI95ko+ZjtPu4b6MhrZlvSP9pEB9s7GdP32THJvEKt1MMU0sHrYUP4KWN1APMdUbZ1jdEgssU5HLcEUBHG/ZPkkvnNtyo4JvbMBV0lUZNlz138eW0QBjloZkWsNn6Qo3GcZKCS6OEuabvshVGtqRRFHqfG3rsjoiV5PndLQTHa1V1QJsWkBRH58oWFsc/4Ku+xBZj1p/cvBQUl+fpO+y/g75LcVv7TOPqUxUYS8vwLBgqJ7Fx0ViY1w/ue10CgaiQuPNtq6TPmb/wrpNPgkNWcr4A245oyZ1uEi6vAnQj0llOZ0dFtq0Z4+7X6gMTN9vMvpe784cETRkPHIqzqKOghif9lwY1NNje6CbaUFEMFxBmoQtB1VM1izoXBm8qGCAtcwggJAAgEBMIIBAKGB2KSB1TCB0jELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEtMCsGA1UECxMkTWljcm9zb2Z0IElyZWxhbmQgT3BlcmF0aW9ucyBMaW1pdGVkMSYwJAYDVQQLEx1UaGFsZXMgVFNTIEVTTjpBMjQwLTRCODItMTMwRTElMCMGA1UEAxMcTWljcm9zb2Z0IFRpbWUtU3RhbXAgU2VydmljZaIjCgEBMAcGBSsOAwIaAxUAgHOVkz1NE0Pg+C2ktZBmRI9hVwmggYMwgYCkfjB8MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSYwJAYDVQQDEx1NaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0EgMjAxMDANBgkqhkiG9w0BAQUFAAIFAObFyN8wIhgPMjAyMjA5MDkyMjE0NTVaGA8yMDIyMDkxMDIyMTQ1NVowdzA9BgorBgEEAYRZCgQBMS8wLTAKAgUA5sXI3wIBADAKAgEAAgIifQIB/zAHAgEAAgIR4TAKAgUA5scaXwIBADA2BgorBgEEAYRZCgQCMSgwJjAMBgorBgEEAYRZCgMCoAowCAIBAAIDB6EgoQowCAIBAAIDAYagMA0GCSqGSIb3DQEBBQUAA4GBADCMULsBxPSLaVSWcPe2Jk+a+BAse4yIGk5Cj2jPa258ZtEzTqaRFrAe5MvEXTsfUOqTGiL5c2H/qA1wUHmDQ6UCzyAx9afhBjqgYQBGZoicbs3XcgyMDbIvZlnRCqR61qbTfyBJ6uv/H5Xm1AziRb3XtVGVE8Ceosu4D0hJrvDfMYIEDTCCBAkCAQEwgZMwfDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEmMCQGA1UEAxMdTWljcm9zb2Z0IFRpbWUtU3RhbXAgUENBIDIwMTACEzMAAAGNelUueHSZKrcAAQAAAY0wDQYJYIZIAWUDBAIBBQCgggFKMBoGCSqGSIb3DQEJAzENBgsqhkiG9w0BCRABBDAvBgkqhkiG9w0BCQQxIgQgK0udL+px2tUWGLsmlUXGKII+vSG0k1xrpFRbKYGh6pwwgfoGCyqGSIb3DQEJEAIvMYHqMIHnMIHkMIG9BCCelhEz+h1eQMCfN/a50vnr1bxx8ZODBW56dDy20hjNfzCBmDCBgKR+MHwxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpXYXNoaW5ndG9uMRAwDgYDVQQHEwdSZWRtb25kMR4wHAYDVQQKExVNaWNyb3NvZnQgQ29ycG9yYXRpb24xJjAkBgNVBAMTHU1pY3Jvc29mdCBUaW1lLVN0YW1wIFBDQSAyMDEwAhMzAAABjXpVLnh0mSq3AAEAAAGNMCIEIONESmnyFqMXclP0L8XKq7xnSDcO/VZDk0bfQRZ61ZlTMA0GCSqGSIb3DQEBCwUABIICAG7nYyT98QMQYlo/4rCMXO3ZduNw+e8yhkMzXvLZczYAt7hqNYgyP9u/nILNZwo5mlMYBO7cEJau+8AcJFCuweVRmOyRS+ayK+tlf5aGbXpZog9encWezKrljIqOIiZm/XXIX/6hGFBVFtnt2qDptavJfdMsXUprNVBLCGpT+GBnsW+9d0Ix+6H2domMDC/kLhAAMWXphytO6gwvjrI8Rv7jgRXJmiZVlWc5YoOuFqjEnmgINOQNQJFVSz8psnuOjvEcMUQCDG+afgTRLERbGfIxiDq9JuwOE804AatJ4vZnaIJrPecLzp8bC8nEcmpzgnhyuMCkEKO51Oo8nbX2C4bNiyD2GuA+o4TyWMXbuLDucm5nSv2LXA1RImwpIel9wMALdXalHsykRoEQx9Fz4r0D/lpmryb9PObyPNffVBHcckg1bzCuB5GKMwcIdCKCNaCtzp4J4Ctwn9DujLNeqhWaykNjFpgNESqCbperwbVkNzSMdQ1a1OFEhw5sDMMiVKuabcqRq/brY5l8PW8ReYLmEfbUaNnYz0UpkROB82chvFUs1S3IUAUKcwBq3SQKVEDsPboOfU+wM0efKbzZi2nAmgS00+3qf9VuEinoTzFCHlRbcNxLd5QxECjK/vZvFzqhpoGcR28YNwBTyecDEwiD27HAeT9D6nOFFxRjVQNuAAAAAA==</CounterSignature></Object></Signature></doc>
md5: A8146A9728CE031CC25CF7EE8FB32389 | sha1: F69F81BE05435AC8600876EE847E06F15A7A0C71 | sha256: 25CC4A79780EE5F9A8B8D70234AF379B37FBCB1659464AA7F1A670F0A663C2E6 | sha512: 8AC71BC6C271E70D20D08FB693F1BEEB47E56F4A54BB1962AB76307F4CB943CB5FBF7BB54DF804C11B836D4ABB4641A58DD3362D89311E091619D5CB1ABC13A9
<?xml version="1.0"?>
<doc>
<assembly>
<name>NuGet.Configuration</name>
</assembly>
<members>
<member name="M:NuGet.Configuration.IClientCertificateProvider.AddOrUpdate(NuGet.Configuration.ClientCertItem)">
<summary>
Adds a new client certificate or updates an existing one in the settings.
</summary>
<param name="item">Client certificate to be added or updated</param>
</member>
<member name="M:NuGet.Configuration.IClientCertificateProvider.GetClientCertificates">
<summary>
Get a list of all the trusted signer entries under the computer trusted signers section.
</summary>
</member>
<member name="M:NuGet.Configuration.IClientCertificateProvider.Remove(System.Collections.Generic.IReadOnlyList{NuGet.Configuration.ClientCertItem})">
<summary>
Removes client certificates from the settings.
</summary>
<param name="items">Client certificates to be removed</param>
</member>
<member name="F:NuGet.Configuration.CredentialRequestType.Proxy">
<summary>
Indicates that the request credentials are to be used to access a proxy.
</summary>
</member>
<member name="F:NuGet.Configuration.CredentialRequestType.Unauthorized">
<summary>
Indicates that the remote server rejected the previous request as unauthorized. This
suggests that the server does not know who the caller is (i.e. the caller is not
authenticated).
</summary>
</member>
<member name="F:NuGet.Configuration.CredentialRequestType.Forbidden">
<summary>
Indicates that the remote server rejected the previous request as forbidden. This
suggests that the server knows who the caller is (i.e. the caller is authorized) but
is not allowed to access the request resource. A different set of credentials could
solve this failure.
</summary>
</member>
<member name="T:NuGet.Configuration.ICredentialService">
<summary>
A credentials service.
</summary>
</member>
<member name="M:NuGet.Configuration.ICredentialService.GetCredentialsAsync(System.Uri,System.Net.IWebProxy,NuGet.Configuration.CredentialRequestType,System.String,System.Threading.CancellationToken)">
<summary>
Asynchronously gets credentials.
</summary>
<param name="uri">The URI for which credentials should be retrieved.</param>
<param name="proxy">A web proxy.</param>
<param name="type">The credential request type.</param>
<param name="message">A message to display when prompting for credentials.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns a <see cref="T:System.Net.ICredentials" />.</returns>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="uri" /> is <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Configuration.ICredentialService.TryGetLastKnownGoodCredentialsFromCache(System.Uri,System.Boolean,System.Net.ICredentials@)">
<summary>
Attempts to retrieve last known good credentials for a URI from a credentials cache.
</summary>
<remarks>
When the return value is <c>true</c>, <paramref name="credentials" /> will have last known
good credentials from the credentials cache. These credentials may have become invalid
since their last use, so there is no guarantee that the credentials are currently valid.
</remarks>
<param name="uri">The URI for which cached credentials should be retrieved.</param>
<param name="isProxy"><c>true</c> for proxy credentials; otherwise, <c>false</c>.</param>
<param name="credentials">Cached credentials or <c>null</c>.</param>
<returns><c>true</c> if a result is returned from the cache; otherwise, false.</returns>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="uri" /> is <c>null</c>.</exception>
</member>
<member name="P:NuGet.Configuration.ICredentialService.HandlesDefaultCredentials">
<summary>
Gets a value indicating whether this credential service wants to handle "default credentials" specially,
instead of relying on DefaultNetworkCredentials
</summary>
</member>
<member name="P:NuGet.Configuration.PackageSourceMapping.PackageIdMaxLength">
<summary>
Max allowed length for package Id.
In case update this value please update in src\NuGet.Core\NuGet.Packaging\PackageCreation\Utility\PackageIdValidator.cs too.
</summary>
</member>
<member name="P:NuGet.Configuration.PackageSourceMapping.Patterns">
<summary>
Source name to package patterns list.
</summary>
</member>
<member name="P:NuGet.Configuration.PackageSourceMapping.IsEnabled">
<summary>
Indicate if any packageSource exist in package source mapping section
</summary>
</member>
<member name="M:NuGet.Configuration.PackageSourceMapping.GetConfiguredPackageSources(System.String)">
<summary>
Get package source names with matching prefix "packageId" from package source mapping section.
</summary>
<param name="packageId">Search packageId. Cannot be null, empty, or whitespace only. </param>
<returns>Package source names with matching prefix "packageId" from package patterns.</returns>
<exception cref="T:System.ArgumentException"> if <paramref name="packageId" /> is null, empty, or whitespace only.</exception>
</member>
<member name="M:NuGet.Configuration.PackageSourceMapping.GetPackageSourceMapping(NuGet.Configuration.ISettings)">
<summary>
Generates a <see cref="T:NuGet.Configuration.PackageSourceMapping" /> based on the settings object.
</summary>
<param name="settings">Search packageId. Cannot be null, empty, or whitespace only. </param>
<returns>A <see cref="T:NuGet.Configuration.PackageSourceMapping" /> based on the settings.</returns>
<exception cref="T:System.ArgumentNullException"> if <paramref name="settings" /> is null.</exception>
</member>
<member name="M:NuGet.Configuration.SearchTree.GetConfiguredPackageSources(System.String)">
<summary>
Get package source names with matching prefix "term" from package source mapping section.
</summary>
<param name="term">Search term. Cannot be null, empty, or whitespace only. </param>
<returns>Package source names with matching prefix "term" from package source mapping section.</returns>
<exception cref="T:System.ArgumentException"> if <paramref name="term" /> is null, empty, or whitespace only.</exception>
</member>
<member name="M:NuGet.Configuration.IPackageSourceProvider.LoadPackageSources">
<summary>
Gets an enumerable of all of the package sources
</summary>
<returns>Enumerable of all of the package sources</returns>
</member>
<member name="M:NuGet.Configuration.IPackageSourceProvider.GetPackageSourceByName(System.String)">
<summary>
Gets the source that matches a given name.
</summary>
<param name="name">Name of source to be searched for</param>
<returns>PackageSource that matches the given name. Null if none was found</returns>
<throws>ArgumentException when <paramref name="name" /> is null or empty.</throws>
</member>
<member name="M:NuGet.Configuration.IPackageSourceProvider.GetPackageSourceBySource(System.String)">
<summary>
Gets the source that matches a given source url.
</summary>
<param name="source">Url of source to be searched for</param>
<returns>PackageSource that matches the given source. Null if none was found</returns>
<throws>ArgumentException when <paramref name="source" /> is null or empty.</throws>
</member>
<member name="E:NuGet.Configuration.IPackageSourceProvider.PackageSourcesChanged">
<summary>
Event raised when the package sources have been changed.
</summary>
</member>
<member name="M:NuGet.Configuration.IPackageSourceProvider.RemovePackageSource(System.String)">
<summary>
Removes the package source that matches the given name
</summary>
<param name="name">Name of source to remove</param>
</member>
<member name="M:NuGet.Configuration.IPackageSourceProvider.EnablePackageSource(System.String)">
<summary>
Enables the package source that matches the given name
</summary>
<param name="name">Name of source to enable</param>
</member>
<member name="M:NuGet.Configuration.IPackageSourceProvider.DisablePackageSource(System.String)">
<summary>
Disables the package source that matches the given name
</summary>
<param name="name">Name of source to disable</param>
</member>
<member name="M:NuGet.Configuration.IPackageSourceProvider.UpdatePackageSource(NuGet.Configuration.PackageSource,System.Boolean,System.Boolean)">
<summary>
Updates the values of the given package source.
</summary>
<remarks>The package source is matched by name.</remarks>
<param name="source">Source with updated values</param>
<param name="updateCredentials">Describes if credentials values from <paramref name="source" /> should be updated or ignored</param>
<param name="updateEnabled">Describes if enabled value from <paramref name="source" /> should be updated or ignored</param>
</member>
<member name="M:NuGet.Configuration.IPackageSourceProvider.AddPackageSource(NuGet.Configuration.PackageSource)">
<summary>
Adds a package source to the current configuration
</summary>
<param name="source">PackageSource to add</param>
</member>
<member name="M:NuGet.Configuration.IPackageSourceProvider.SavePackageSources(System.Collections.Generic.IEnumerable{NuGet.Configuration.PackageSource})">
<summary>
Compares the given list of PackageSources with the current PackageSources in the configuration
and adds, removes or updates each source as needed.
</summary>
<param name="sources">PackageSources to be saved</param>
</member>
<member name="M:NuGet.Configuration.IPackageSourceProvider.IsPackageSourceEnabled(System.String)">
<summary>
Checks if a package source with a given name is part of the disabled sources configuration
</summary>
<param name="name">Name of the source to be queried</param>
<returns>true if the source with the given name is not part of the disabled sources</returns>
</member>
<member name="P:NuGet.Configuration.IPackageSourceProvider.ActivePackageSourceName">
<summary>
Gets the name of the active PackageSource
</summary>
</member>
<member name="P:NuGet.Configuration.IPackageSourceProvider.DefaultPushSource">
<summary>
Gets the Default push source
</summary>
</member>
<member name="M:NuGet.Configuration.IPackageSourceProvider.SaveActivePackageSource(NuGet.Configuration.PackageSource)">
<summary>
Updates the active package source with the given source.
</summary>
<param name="source">Source to be set as the active package source</param>
</member>
<member name="M:NuGet.Configuration.IPackageSourceProvider2.SavePackageSources(System.Collections.Generic.IEnumerable{NuGet.Configuration.PackageSource},NuGet.Configuration.PackageSourceUpdateOptions)">
<summary>
Compares the given list of PackageSources with the current PackageSources in the configuration and adds, removes or updates each source as needed.
</summary>
<param name="sources">PackageSources to be saved</param>
<param name="packageSourceUpdateOptions">Settings to use when updating the sources</param>
</member>
<member name="F:NuGet.Configuration.NuGetConstants.DefaultGalleryServerUrl">
<summary>
NuGet.org gallery Url used as a source display name and as a default "id" when storing nuget.org API key.
</summary>
<remarks>
Albeit this url is not actual feed we should keep it unchanged for back-compat with earlier NuGet versions.
Typical scenario leading to adding this url to config file is to run setApiKey command without a source:
nuget.exe setApiKey XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
</remarks>
</member>
<member name="F:NuGet.Configuration.PackageSource.DefaultProtocolVersion">
<summary>
The feed version for NuGet prior to v3.
</summary>
</member>
<member name="P:NuGet.Configuration.PackageSource.TrySourceAsUri">
<summary>
Returns null if Source is an invalid URI
</summary>
</member>
<member name="P:NuGet.Configuration.PackageSource.SourceUri">
<summary>
Throws if Source is an invalid URI
</summary>
</member>
<member name="P:NuGet.Configuration.PackageSource.IsOfficial">
<summary>
This does not represent just the NuGet Official Feed alone
It may also represent a Default Package Source set by Configuration Defaults
</summary>
</member>
<member name="P:NuGet.Configuration.PackageSource.ProtocolVersion">
<summary>
Gets or sets the protocol version of the source. Defaults to 2.
</summary>
</member>
<member name="P:NuGet.Configuration.PackageSource.IsHttp">
<summary>
Whether the source is using the HTTP protocol, including HTTPS.
</summary>
</member>
<member name="P:NuGet.Configuration.PackageSource.IsHttps">
<summary>
Whether the source is using the HTTPS protocol.
</summary>
</member>
<member name="P:NuGet.Configuration.PackageSource.IsLocal">
<summary>
True if the source path is file based. Unc shares are not included.
</summary>
</member>
<member name="T:NuGet.Configuration.PackageSourceCredential">
<summary>
Represents credentials required to authenticate user within package source web requests.
</summary>
</member>
<member name="P:NuGet.Configuration.PackageSourceCredential.Username">
<summary>
User name
</summary>
</member>
<member name="P:NuGet.Configuration.PackageSourceCredential.PasswordText">
<summary>
Password text as stored in config file. May be encrypted.
</summary>
</member>
<member name="P:NuGet.Configuration.PackageSourceCredential.IsPasswordClearText">
<summary>
Indicates if password is stored in clear text.
</summary>
</member>
<member name="P:NuGet.Configuration.PackageSourceCredential.ValidAuthenticationTypes">
<summary>
List of authentication types the credential is valid for, e.g. 'basic'. If empty, all authentication types
are allowed.
</summary>
</member>
<member name="P:NuGet.Configuration.PackageSourceCredential.ValidAuthenticationTypesText">
<summary>
Comma-delimited list of authentication types the credential is valid for as stored in the config file.
If null or empty, all authentication types are valid. Example: 'basic,negotiate'
</summary>
</member>
<member name="P:NuGet.Configuration.PackageSourceCredential.Password">
<summary>
Retrieves password in clear text. Decrypts on-demand.
</summary>
</member>
<member name="P:NuGet.Configuration.PackageSourceCredential.Source">
<summary>
Associated source ID
</summary>
</member>
<member name="M:NuGet.Configuration.PackageSourceCredential.IsValid">
<summary>
Verifies if object contains valid data, e.g. not empty user name and password.
</summary>
<returns>True if credentials object is valid</returns>
</member>
<member name="M:NuGet.Configuration.PackageSourceCredential.#ctor(System.String,System.String,System.String,System.Boolean,System.String)">
<summary>
Instantiates the credential instance out of raw values read from a config file.
</summary>
<param name="source">Associated source ID (needed for reporting errors)</param>
<param name="username">User name</param>
<param name="passwordText">Password as stored in config file</param>
<param name="isPasswordClearText">Hints if password provided in clear text</param>
<param name="validAuthenticationTypesText">
Comma-delimited list of authentication types the credential is valid for as stored in the config file.
If null or empty, all authentication types are valid. Example: 'basic,negotiate'
</param>
</member>
<member name="M:NuGet.Configuration.PackageSourceCredential.FromUserInput(System.String,System.String,System.String,System.Boolean,System.String)">
<summary>
Creates new instance of credential object out values provided by user.
</summary>
<param name="source">Source ID needed for reporting errors if any</param>
<param name="username">User name</param>
<param name="password">Password text in clear</param>
<param name="storePasswordInClearText">Hints if the password should be stored in clear text on disk.</param>
<param name="validAuthenticationTypesText">
Comma-delimited list of authentication types the credential is valid for as stored in the config file.
If null or empty, all authentication types are valid. Example: 'basic,negotiate'
</param>
<returns>New instance of <see cref="T:NuGet.Configuration.PackageSourceCredential" /></returns>
</member>
<member name="M:NuGet.Configuration.PackageSourceCredential.ToICredentials">
<summary>
Converts this object to an ICredentials, capturing the username, password and valid authentication types
</summary>
</member>
<member name="M:NuGet.Configuration.PackageSourceCredential.ParseAuthTypeFilterString(System.String)">
<summary>
Converts an authentication type filter string from the config file syntax to a list of valid authentication
types
</summary>
<param name="str">
Comma-delimited list of authentication types the credential is valid for as stored in the config file.
If null or empty, all authentication types are valid. Example: 'basic,negotiate'
</param>
<returns>
Enumeration of valid authentication types. If empty, all authentication types are valid.
</returns>
</member>
<member name="M:NuGet.Configuration.PackageSourceProvider.LoadPackageSources">
<summary>
Returns PackageSources specified in the config file merged with any default sources specified in the
constructor.
</summary>
</member>
<member name="M:NuGet.Configuration.PackageSourceProvider.LoadPackageSources(NuGet.Configuration.ISettings)">
<summary>
Returns PackageSources if specified in the settings object, combined with the default sources from the default configuration.
</summary>
</member>
<member name="M:NuGet.Configuration.PackageSourceProvider.OnPackageSourcesChanged">
<summary>
Fires event PackageSourcesChanged
</summary>
</member>
<member name="P:NuGet.Configuration.PackageSourceProvider.ActivePackageSourceName">
<summary>
Gets the name of the ActivePackageSource from NuGet.Config
</summary>
</member>
<member name="M:NuGet.Configuration.PackageSourceProvider.SaveActivePackageSource(NuGet.Configuration.PackageSource)">
<summary>
Saves the <paramref name="source" /> as the active source.
</summary>
<param name="source"></param>
</member>
<member name="T:NuGet.Configuration.IProxyCredentialCache">
<summary>
<see cref="T:System.Net.CredentialCache" />-like interface with Update credential semantics rather than Add/Remove
</summary>
</member>
<member name="P:NuGet.Configuration.IProxyCredentialCache.Version">
<summary>
Tracks the cache version. Changes every time proxy credential is updated.
</summary>
</member>
<member name="M:NuGet.Configuration.IProxyCredentialCache.UpdateCredential(System.Uri,System.Net.NetworkCredential)">
<summary>
Add or update proxy credential
</summary>
<param name="proxyAddress">Proxy network address</param>
<param name="credentials">New credential object</param>
</member>
<member name="T:NuGet.Configuration.WebProxy">
<summary>
Internal implementation of <see cref="T:System.Net.IWebProxy" /> mirroring default desktop one.
Introduced for XPlat coreFx support.
</summary>
</member>
<member name="T:NuGet.Configuration.Resources">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:NuGet.Configuration.Resources.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:NuGet.Configuration.Resources.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:NuGet.Configuration.Resources.Argument_Cannot_Be_Null_Empty_Or_WhiteSpaceOnly">
<summary>
Looks up a localized string similar to Argument cannot be null, empty, or whitespace only..
</summary>
</member>
<member name="P:NuGet.Configuration.Resources.Argument_Cannot_Be_Null_Or_Empty">
<summary>
Looks up a localized string similar to Value cannot be null or empty string..
</summary>
</member>
<member name="P:NuGet.Configuration.Resources.AttributeNotAllowed">
<summary>
Looks up a localized string similar to Attribute '{0}' is not allowed in element '{1}'..
</summary>
</member>
<member name="P:NuGet.Configuration.Resources.AttributeValueNotAllowed">
<summary>
Looks up a localized string similar to The attribute '{0}' has an unallowed value '{1}' in element '{2}'..
</summary>
</member>
<member name="P:NuGet.Configuration.Resources.CannotUpdateDifferentItems">
<summary>
Looks up a localized string similar to The item passed to the Update method cannot refer to a different item than the one being updated..
</summary>
</member>
<member name="P:NuGet.Configuration.Resources.CannotUpdateMachineWide">
<summary>
Looks up a localized string similar to Unable to update setting since it is in a machine-wide NuGet.Config..
</summary>
</member>
<member name="P:NuGet.Configuration.Resources.CannotUpdateNode">
<summary>
Looks up a localized string similar to Cannot update the node of a setting..
</summary>
</member>
<member name="P:NuGet.Configuration.Resources.CannotUpdateReadOnlyConfig">
<summary>
Looks up a localized string similar to Unable to update setting since it is in an uneditable config file..
</summary>
</member>
<member name="P:NuGet.Configuration.Resources.ClientCertificateDuplicateConfiguration">
<summary>
Looks up a localized string similar to There are multiple client certificate configurations associated with the same package source(s): {0}.
</summary>
</member>
<member name="P:NuGet.Configuration.Resources.CredentialsItemMustHaveUsernamePassword">
<summary>
Looks up a localized string similar to Credentials item must have username and password..
</summary>
</member>
<member name="P:NuGet.Configuration.Resources.Error_EncryptionUnsupported">
<summary>
Looks up a localized string similar to Encryption is not supported on non-Windows platforms..
</summary>
</member>
<member name="P:NuGet.Configuration.Resources.Error_InvalidAttribute">
<summary>
Looks up a localized string similar to The attribute {0}-{1} is not valid..
</summary>
</member>
<member name="P:NuGet.Configuration.Resources.Error_ItemNeedsAtLeastOnePackagePattern">
<summary>
Looks up a localized string similar to Package source '{0}' must have at least one package pattern..
</summary>
</member>
<member name="P:NuGet.Configuration.Resources.Error_ItemNeedsAtLeastOnePackagePatternWithPath">
<summary>
Looks up a localized string similar to Package source '{0}' must have at least one package pattern. Path: '{1}'.
</summary>
</member>
<member name="P:NuGet.Configuration.Resources.Error_MergeTwoDifferentSections">
<summary>
Looks up a localized string similar to Cannot merge two different sections..
</summary>
</member>
<member name="P:NuGet.Configuration.Resources.Error_MoreThanOnePassword">
<summary>
Looks up a localized string similar to A credentials item must have only one Password or ClearTextPassword entry..
</summary>
</member>
<member name="P:NuGet.Configuration.Resources.Error_MoreThanOneUsername">
<summary>
Looks up a localized string similar to A credentials item must have only one Username entry..
</summary>
</member>
<member name="P:NuGet.Configuration.Resources.Error_MoreThanOneValidAuthenticationTypes">
<summary>
Looks up a localized string similar to A credentials item must have only one ValidAuthenticationTypes entry..
</summary>
</member>
<member name="P:NuGet.Configuration.Resources.Error_StoreCertCertificateNotFound">
<summary>
Looks up a localized string similar to Certificate for the package source '{0}' was not found in '{1}.{2}' storage by '{3}' criteria with '{4}' value..
</summary>
</member>
<member name="P:NuGet.Configuration.Resources.FileCertItemPasswordAndClearTextPasswordAtSameTime">
<summary>
Looks up a localized string similar to Password and ClearTextPassword cannot be used at the same time..
</summary>
</member>
<member name="P:NuGet.Configuration.Resources.FileCertItemPasswordCannotBeDecrypted">
<summary>
Looks up a localized string similar to Client certificate configuration password for the package source '{0}' cannot be decrypted.
</summary>
</member>
<member name="P:NuGet.Configuration.Resources.FileCertItemPathFileNotExist">
<summary>
Looks up a localized string similar to A fileCert path specified a file that does not exist..
</summary>
</member>
<member name="P:NuGet.Configuration.Resources.FileCertItemPathFileNotSet">
<summary>
Looks up a localized string similar to A fileCert item path was not set..
</summary>
</member>
<member name="P:NuGet.Configuration.Resources.FileDoesNotExist">
<summary>
Looks up a localized string similar to File '{0}' does not exist..
</summary>
</member>
<member name="P:NuGet.Configuration.Resources.InvalidNullSettingsOperation">
<summary>
Looks up a localized string similar to "{0}" cannot be called on a NullSettings. This may be caused on account of insufficient permissions to read or write to "%AppData%\NuGet\NuGet.config"..
</summary>
</member>
<member name="P:NuGet.Configuration.Resources.ItemDoesNotExist">
<summary>
Looks up a localized string similar to The item does not exist in the {0} section..
</summary>
</member>
<member name="P:NuGet.Configuration.Resources.MissingRequiredAttribute">
<summary>
Looks up a localized string similar to Missing required attribute '{0}' in element '{1}'..
</summary>
</member>
<member name="P:NuGet.Configuration.Resources.MustContainAbsolutePath">
<summary>
Looks up a localized string similar to '{0}' must contain an absolute path '{1}'..
</summary>
</member>
<member name="P:NuGet.Configuration.Resources.NoAttributesAllowed">
<summary>
Looks up a localized string similar to The {0} item should not have any attributes and it was found with {1}..
</summary>
</member>
<member name="P:NuGet.Configuration.Resources.NoWritteableConfig">
<summary>
Looks up a localized string similar to There is no NuGet.Config that could be used for writing settings. Please create one at the desired location and restart the client..
</summary>
</member>
<member name="P:NuGet.Configuration.Resources.OwnersItemMustHaveAtLeastOneOwner">
<summary>
Looks up a localized string similar to Owners item must have at least one owner..
</summary>
</member>
<member name="P:NuGet.Configuration.Resources.OwnersMustOnlyHaveContent">
<summary>
Looks up a localized string similar to Owners item must only have text content and cannot be empty..
</summary>
</member>
<member name="P:NuGet.Configuration.Resources.PropertyCannotBeNullOrEmpty">
<summary>
Looks up a localized string similar to {0} cannot be null or empty..
</summary>
</member>
<member name="P:NuGet.Configuration.Resources.RepositoryMustHaveOneOwners">
<summary>
Looks up a localized string similar to The repository item with name '{0}' and service index '{1}' has more than one owners item in it..
</summary>
</member>
<member name="P:NuGet.Configuration.Resources.SectionDoesNotExist">
<summary>
Looks up a localized string similar to The section '{0}' does not exist in the settings..
</summary>
</member>
<member name="P:NuGet.Configuration.Resources.Settings_FileName_Cannot_Be_A_Path">
<summary>
Looks up a localized string similar to Parameter 'fileName' to Settings must be just a file name and not a path..
</summary>
</member>
<member name="P:NuGet.Configuration.Resources.ShowError_CannotHaveChildren">
<summary>
Looks up a localized string similar to Error parsing NuGet.Config. Element '{0}' cannot have descendant elements. Path: '{1}'..
</summary>
</member>
<member name="P:NuGet.Configuration.Resources.ShowError_ConfigHasInvalidPackageSource">
<summary>
Looks up a localized string similar to {0}: NuGet.Config has an invalid package source value '{1}'. Reason: {2}.
</summary>
</member>
<member name="P:NuGet.Configuration.Resources.ShowError_ConfigInvalidOperation">
<summary>
Looks up a localized string similar to NuGet.Config is malformed. Path: '{0}'..
</summary>
</member>
<member name="P:NuGet.Configuration.Resources.ShowError_ConfigInvalidXml">
<summary>
Looks up a localized string similar to NuGet.Config is not valid XML. Path: '{0}'..
</summary>
</member>
<member name="P:NuGet.Configuration.Resources.ShowError_ConfigRootInvalid">
<summary>
Looks up a localized string similar to NuGet.Config does not contain the expected root element: 'configuration'. Path: '{0}'..
</summary>
</member>
<member name="P:NuGet.Configuration.Resources.ShowError_ConfigUnauthorizedAccess">
<summary>
Looks up a localized string similar to Failed to read NuGet.Config due to unauthorized access. Path: '{0}'..
</summary>
</member>
<member name="P:NuGet.Configuration.Resources.TextShouldNotBeEmpty">
<summary>
Looks up a localized string similar to Text elements should not be empty..
</summary>
</member>
<member name="P:NuGet.Configuration.Resources.TrustedSignerMustHaveCertificates">
<summary>
Looks up a localized string similar to A trusted signer entry must have at least one certificate entry..
</summary>
</member>
<member name="P:NuGet.Configuration.Resources.Unknown_Config_Exception">
<summary>
Looks up a localized string similar to Unexpected failure reading NuGet.Config. Path: '{0}'..
</summary>
</member>
<member name="P:NuGet.Configuration.Resources.UnknownHashAlgorithmNotSupported">
<summary>
Looks up a localized string similar to Unknown hash algorithm is not supported..
</summary>
</member>
<member name="P:NuGet.Configuration.Resources.UnsupportedDecryptPassword">
<summary>
Looks up a localized string similar to Password decryption is not supported on .NET Core for this platform. The following feed uses an encrypted password: '{0}'. You can use a clear text password as a workaround..
</summary>
</member>
<member name="P:NuGet.Configuration.Resources.UnsupportedEncryptPassword">
<summary>
Looks up a localized string similar to Password encryption is not supported on .NET Core for this platform. The following feed try to use an encrypted password: '{0}'. You can use a clear text password as a workaround..
</summary>
</member>
<member name="P:NuGet.Configuration.Resources.UnsupportedHashAlgorithm">
<summary>
Looks up a localized string similar to Certificate entry has an unsupported hash algorithm: '{0}'..
</summary>
</member>
<member name="P:NuGet.Configuration.Resources.UserSettings_UnableToParseConfigFile">
<summary>
Looks up a localized string similar to Unable to parse config file because: {0} Path: '{1}'..
</summary>
</member>
<member name="M:NuGet.Configuration.ConfigurationDefaults.#ctor(System.String,System.String)">
<summary>
An internal constructor MAINLY INTENDED FOR TESTING THE CLASS. But, the product code is only expected to
use the static Instance property
Only catches FileNotFoundException. Will throw all exceptions including other IOExceptions and
XmlExceptions for invalid xml and so on
</summary>
<param name="directory">The directory that has the NuGetDefaults.Config</param>
<param name="configFile">Name of the NuGetDefaults.Config</param>
</member>
<member name="T:NuGet.Configuration.ISettings">
<summary>
Interface to expose NuGet Settings
</summary>
</member>
<member name="M:NuGet.Configuration.ISettings.GetSection(System.String)">
<summary>
Gets the section with a given name.
</summary>
<param name="sectionName">name to match sections</param>
<returns>null if no section with the given name was found</returns>
</member>
<member name="M:NuGet.Configuration.ISettings.AddOrUpdate(System.String,NuGet.Configuration.SettingItem)">
<summary>
Adds or updates the given <paramref name="item" /> to the settings.
If the <paramref name="item" /> has to be added this method will add it
in the user wide settings file, or walk down the hierarchy (starting from the user wide config)
until it finds a config where the given section is not cleared.
</summary>
<param name="sectionName">section where the <paramref name="item" /> has to be added. If this section does not exist, one will be created.</param>
<param name="item">item to be added to the settings.</param>
</member>
<member name="M:NuGet.Configuration.ISettings.Remove(System.String,NuGet.Configuration.SettingItem)">
<summary>
Removes the given <paramref name="item" /> from the settings.
If the <paramref name="item" /> is the last item in the section, the section will also be removed.
If the item is overriding any items from other configs it will delete all the merged items that are
not in a machine wide config.
</summary>
<param name="sectionName">Section where the <paramref name="item" /> is stored. If this section does not exist, the method will throw</param>
<param name="item">item to be removed from the settings</param>
<remarks> If the <paramref name="item" /> is in a machine wide config this method will throw</remarks>
</member>
<member name="M:NuGet.Configuration.ISettings.SaveToDisk">
<summary>
Flushes any update that has been done in memory through the ISettings API to the settings file in disk.
</summary>
</member>
<member name="E:NuGet.Configuration.ISettings.SettingsChanged">
<summary>
Event raised when the setting have been changed.
</summary>
</member>
<member name="M:NuGet.Configuration.ISettings.GetConfigFilePaths">
<summary>
Get a list of all the paths of the settings files used as part of this settings object. The paths are ordered with the closest one to user first.
</summary>
</member>
<member name="M:NuGet.Configuration.ISettings.GetConfigRoots">
<summary>
Get a list of all the roots of the settings files used as part of this settings object
</summary>
</member>
<member name="T:NuGet.Configuration.CredentialsItem">
<summary>
A CredentialsItem has a name and it can have between 2 or 3 children:
- [Required] Username (AddItem)
- [Required] Either Password or ClearTextPassword (AddItem)
- [Optional] ValidAuthenticationTypes (AddItem)
</summary>
</member>
<member name="M:NuGet.Configuration.CredentialsItem.Update(NuGet.Configuration.SettingItem)">
<remarks>
This method is internal because it updates directly the xElement behind this abstraction.
It should only be called whenever the underlaying config file is intended to be changed.
To persist changes to disk one must save the corresponding setting files
</remarks>
</member>
<member name="T:NuGet.Configuration.FileClientCertItem">
<summary>
A FileClientCertItem have 4 attributes:
- [Required] packageSource
- [Required] path
- [Optional] password
- [Optional] clearTextPassword
</summary>
</member>
<member name="T:NuGet.Configuration.PackagePatternItem">
<summary>
A PackagePatternItem has only a key and no children.
- [Required] Id
</summary>
</member>
<member name="T:NuGet.Configuration.PackageSourceMappingSourceItem">
<summary>
A PackageSourceMappingSourceItem has only a key and at least 1 <see cref="T:NuGet.Configuration.PackagePatternItem" /> child item.
- [Required] Key
</summary>
</member>
<member name="P:NuGet.Configuration.PackageSourceMappingSourceItem.Patterns">
<summary>
List of package pattern items part of this package source element.
</summary>
</member>
<member name="P:NuGet.Configuration.PackageSourceMappingSourceItem.Key">
<summary>
Each PackageSourceMappingSourceItem item needs a key.
The key should correspond a package source key.
</summary>
</member>
<member name="M:NuGet.Configuration.PackageSourceMappingSourceItem.#ctor(System.String,System.Collections.Generic.IEnumerable{NuGet.Configuration.PackagePatternItem})">
<summary>
Creates a package source mapping source item with the given name, which equals the key and non-empty list of package patters items.
</summary>
<param name="name">A non-empty name of the item which corresponds a package source name.</param>
<param name="packagePatternItems">A non empty list of package pattern items.</param>
<exception cref="T:System.ArgumentException">If <paramref name="name" /> is null or empty, or <paramref name="packagePatternItems" /> is null or empty.</exception>
</member>
<member name="T:NuGet.Configuration.StoreClientCertItem">
<summary>
A StoreClientCertItem have 4 Attributes:
- [Required] packageSource
- [Optional] storeLocation. StoreLocation.CurrentUser by default.
- [Optional] storeName. StoreName.My by default.
- [Optional] findBy. X509FindType.FindByThumbprint by default.
- [Required] findValue
</summary>
</member>
<member name="M:NuGet.Configuration.NuGetConfiguration.#ctor(System.Collections.Generic.IReadOnlyDictionary{System.String,System.String},System.Collections.Generic.IEnumerable{NuGet.Configuration.SettingSection})">
<remarks>
There should not be a NuGetConfiguration without an Origin.
This constructor should only be used for tests.
</remarks>
</member>
<member name="M:NuGet.Configuration.NuGetConfiguration.#ctor(NuGet.Configuration.SettingSection[])">
<remarks>
There should not be a NuGetConfiguration without an Origin.
This constructor should only be used for tests.
</remarks>
</member>
<member name="P:NuGet.Configuration.NuGetPathContext.FallbackPackageFolders">
<summary>
Fallback package folders. There many be zero or more of these.
</summary>
</member>
<member name="P:NuGet.Configuration.NuGetPathContext.UserPackageFolder">
<summary>
User global packages folder.
</summary>
</member>
<member name="P:NuGet.Configuration.NuGetPathContext.HttpCacheFolder">
<summary>
User level http cache.
</summary>
</member>
<member name="M:NuGet.Configuration.NuGetPathContext.Create(NuGet.Configuration.ISettings)">
<summary>
Load paths from already loaded settings.
</summary>
<param name="settings">NuGet.Config settings.</param>
</member>
<member name="M:NuGet.Configuration.NuGetPathContext.Create(System.String)">
<summary>
Load settings based on the solution or project root directory. NuGet.Config files will
be discovered based on this path. The machine wide config will also be loaded.
</summary>
<param name="settingsRoot">Root directory of the solution or project.</param>
</member>
<member name="M:NuGet.Configuration.SettingBase.#ctor">
<summary>
Default constructor
</summary>
</member>
<member name="M:NuGet.Configuration.SettingBase.IsAbstract">
<summary>
Specifies if the setting is an in-memory-only setting.
</summary>
</member>
<member name="M:NuGet.Configuration.SettingBase.IsCopy">
<summary>
Specifies if the setting is a copy of a concrete setting in a file.
</summary>
</member>
<member name="M:NuGet.Configuration.SettingBase.IsEmpty">
<summary>
Specifies if the setting has attributes or values.
</summary>
</member>
<member name="M:NuGet.Configuration.SettingBase.AsXNode">
<summary>
Gives the representation of this setting as an XNode object
</summary>
</member>
<member name="M:NuGet.Configuration.SettingBase.Clone">
<summary>
Creates a shallow copy of the setting.
Does not copy any pointer to the original data structure.
Just copies the abstraction.
</summary>
</member>
<member name="M:NuGet.Configuration.SettingBase.SetOrigin(NuGet.Configuration.SettingsFile)">
<summary>
Convenience method to add an element to an origin.
Since an origin should not be updated, any update will be ignored.
</summary>
<remarks>Each setting can override this method to include any descendants to the origin</remarks>
</member>
<member name="M:NuGet.Configuration.SettingBase.RemoveFromSettings">
<summary>
Convenience method to remove an element from it's origin and convert to abstract
</summary>
<remarks>Each setting can override this method to remove any descendants from their origin</remarks>
</member>
<member name="P:NuGet.Configuration.SettingElement.ElementName">
<summary>
Text that differentiates element tag
</summary>
</member>
<member name="P:NuGet.Configuration.SettingElement.AllowedAttributes">
<summary>
Specifies the keys for the attributes that the element can have
</summary>
<remarks>If null then all attributes are allowed</remarks>
</member>
<member name="P:NuGet.Configuration.SettingElement.RequiredAttributes">
<summary>
Specifies the keys for the attributes that the element should have
</summary>
<remarks>If null or empty then no attributes are required</remarks>
</member>
<member name="P:NuGet.Configuration.SettingElement.AllowedValues">
<summary>
Specifies which values are allowed for a specific attribute.
If an attribute is not defined every value is allowed.
Having allowed values does not imply that the attribute is required.
</summary>
</member>
<member name="P:NuGet.Configuration.SettingElement.DisallowedValues">
<summary>
Specifies values that are explicitely disallowed for a specific attribute.
If an attribute is not defined no value is disallowed.
Having disallowed values does not imply that the attribute is required.
</summary>
</member>
<member name="P:NuGet.Configuration.SettingElement.MutableAttributes">
<summary>
Key-value pairs that give more information about the element
</summary>
</member>
<member name="P:NuGet.Configuration.SettingElement.Attributes">
<summary>
Read only key-value pairs that give more information about the element
</summary>
</member>
<member name="M:NuGet.Configuration.SettingElement.IsEmpty">
<summary>
Specifies if the element is empty.
Each element defines its own definition of empty.
The default definition of empty is an element without attributes.
</summary>
</member>
<member name="M:NuGet.Configuration.SettingElement.#ctor">
<summary>
Default constructor
</summary>
</member>
<member name="M:NuGet.Configuration.SettingElement.#ctor(System.Xml.Linq.XElement,NuGet.Configuration.SettingsFile)">
<summary>
Constructor used when element is read from a file
</summary>
<param name="element">Xelement read from XML file document tree</param>
<param name="origin">Settings file that this element was read from</param>
</member>
<member name="F:NuGet.Configuration.SettingElementType.ActivePackageSource">
---- Known sections --- *
</member>
<member name="F:NuGet.Configuration.SettingElementType.Add">
---- Known items --- *
</member>
<member name="F:NuGet.Configuration.SettingElementType.PackageSourceMapping">
Package Source Mapping *
</member>
<member name="M:NuGet.Configuration.SettingItem.Update(NuGet.Configuration.SettingItem)">
<remarks>
This method is internal because it updates directly the xElement behind this abstraction.
It should only be called whenever the underlying config file is intended to be changed.
To persist changes to disk one must save the corresponding setting files
</remarks>
</member>
<member name="T:NuGet.Configuration.Settings">
<summary>
Concrete implementation of ISettings to support NuGet Settings
Wrapper for computed settings from given settings files
</summary>
</member>
<member name="F:NuGet.Configuration.Settings.DefaultSettingsFileName">
<summary>
Default file name for a settings file is 'NuGet.config'
Also, the user level setting file at '%APPDATA%\NuGet' always uses this name
</summary>
</member>
<member name="F:NuGet.Configuration.Settings.OrderedSettingsFileNames">
<summary>
NuGet config names with casing ordered by precedence.
</summary>
</member>
<member name="P:NuGet.Configuration.Settings.SettingsFiles">
<summary>
All the SettingsFiles represent by this settings object.
The ordering is important, closest to furthest from the user.
</summary>
</member>
<member name="M:NuGet.Configuration.Settings.#ctor(System.Collections.Generic.IList{NuGet.Configuration.SettingsFile})">
<summary>
Create a settings object.
The settings files need to be ordered from closest to furthest from the user.
</summary>
<param name="settingsFiles"></param>
</member>
<member name="P:NuGet.Configuration.Settings.Priority">
<summary>
Enumerates the sequence of <see cref="T:NuGet.Configuration.SettingsFile" /> instances
ordered from closer to user to furthest
</summary>
</member>
<member name="M:NuGet.Configuration.Settings.LoadDefaultSettings(System.String)">
<summary>
Load default settings based on a directory.
This includes machine wide settings.
</summary>
</member>
<member name="M:NuGet.Configuration.Settings.LoadDefaultSettings(System.String,System.String,NuGet.Configuration.IMachineWideSettings)">
<summary>
Loads user settings from the NuGet configuration files. The method walks the directory
tree in <paramref name="root" /> up to its root, and reads each NuGet.config file
it finds in the directories. It then reads the user specific settings,
which is file <paramref name="configFileName" />
in <paramref name="root" /> if <paramref name="configFileName" /> is not null,
If <paramref name="configFileName" /> is null, the user specific settings file is
%AppData%\NuGet\NuGet.config.
After that, the machine wide settings files are added.
</summary>
<remarks>
For example, if <paramref name="root" /> is c:\dir1\dir2, <paramref name="configFileName" />
is "userConfig.file", the files loaded are (in the order that they are loaded):
c:\dir1\dir2\nuget.config
c:\dir1\nuget.config
c:\nuget.config
c:\dir1\dir2\userConfig.file
machine wide settings (e.g. c:\programdata\NuGet\Config\*.config)
</remarks>
<param name="root">
The file system to walk to find configuration files.
Can be null.
</param>
<param name="configFileName">The user specified configuration file.</param>
<param name="machineWideSettings">
The machine wide settings. If it's not null, the
settings files in the machine wide settings are added after the user specific
config file.
</param>
<returns>The settings object loaded.</returns>
</member>
<member name="M:NuGet.Configuration.Settings.LoadDefaultSettings(System.String,System.String,NuGet.Configuration.IMachineWideSettings,NuGet.Configuration.SettingsLoadingContext)">
<summary>
Loads user settings from the NuGet configuration files. The method walks the directory
tree in <paramref name="root" /> up to its root, and reads each NuGet.config file
it finds in the directories. It then reads the user specific settings,
which is file <paramref name="configFileName" />
in <paramref name="root" /> if <paramref name="configFileName" /> is not null,
If <paramref name="configFileName" /> is null, the user specific settings file is
%AppData%\NuGet\NuGet.config.
After that, the machine wide settings files are added.
</summary>
<remarks>
For example, if <paramref name="root" /> is c:\dir1\dir2, <paramref name="configFileName" />
is "userConfig.file", the files loaded are (in the order that they are loaded):
c:\dir1\dir2\nuget.config
c:\dir1\nuget.config
c:\nuget.config
c:\dir1\dir2\userConfig.file
machine wide settings (e.g. c:\programdata\NuGet\Config\*.config)
</remarks>
<param name="root">
The file system to walk to find configuration files.
Can be null.
</param>
<param name="configFileName">The user specified configuration file.</param>
<param name="machineWideSettings">
The machine wide settings. If it's not null, the
settings files in the machine wide settings are added after the user specific
config file.
</param>
<param name="settingsLoadingContext">A <see cref="T:NuGet.Configuration.SettingsLoadingContext" /> object to use when loading the settings.</param>
<returns>The settings object loaded.</returns>
</member>
<member name="M:NuGet.Configuration.Settings.LoadSpecificSettings(System.String,System.String)">
<summary>
Loads Specific NuGet.Config file. The method only loads specific config file
which is file <paramref name="configFileName" />from <paramref name="root" />.
</summary>
</member>
<member name="M:NuGet.Configuration.Settings.LoadSettings(System.String,System.String,NuGet.Configuration.IMachineWideSettings,System.Boolean,System.Boolean,NuGet.Configuration.SettingsLoadingContext)">
<summary>
For internal use only
</summary>
</member>
<member name="M:NuGet.Configuration.Settings.LoadSettings(System.IO.DirectoryInfo,NuGet.Configuration.IMachineWideSettings,System.Boolean,System.Boolean,NuGet.Configuration.SettingsLoadingContext)">
<summary>
For internal use only.
Finds and loads all configuration files within <paramref name="root" />.
Does not load configuration files outside of <paramref name="root" />.
</summary>
</member>
<member name="M:NuGet.Configuration.Settings.LoadUserSpecificSettings(System.String,System.String,System.Boolean,NuGet.Configuration.SettingsLoadingContext)">
<summary>
Load the user specific settings
</summary>
<param name="root"></param>
<param name="configFileName"></param>
<param name="useTestingGlobalPath"></param>
<param name="settingsLoadingContext"></param>
<returns></returns>
</member>
<member name="M:NuGet.Configuration.Settings.LoadMachineWideSettings(System.String,System.String[])">
<summary>
Loads the machine wide settings.
</summary>
<remarks>
For example, if <paramref name="paths" /> is {"IDE", "Version", "SKU" }, then
the files loaded are (in the order that they are loaded):
%programdata%\NuGet\Config\IDE\Version\SKU\*.config
%programdata%\NuGet\Config\IDE\Version\*.config
%programdata%\NuGet\Config\IDE\*.config
%programdata%\NuGet\Config\*.config
</remarks>
<param name="root">The file system in which the settings files are read.</param>
<param name="paths">The additional paths under which to look for settings files.</param>
<returns>The list of settings read.</returns>
</member>
<member name="M:NuGet.Configuration.Settings.GetConfigFilePaths">
<summary>
Get a list of all the paths of the settings files used as part of this settings object
</summary>
</member>
<member name="M:NuGet.Configuration.Settings.GetConfigRoots">
<summary>
Get a list of all the roots of the settings files used as part of this settings object
</summary>
</member>
<member name="M:NuGet.Configuration.Settings.GetSettingsFilesFullPath(System.String)">
<remarks>
Order is most significant (e.g. applied last) to least significant (applied first)
ex:
c:\someLocation\nuget.config
c:\nuget.config
</remarks>
</member>
<member name="M:NuGet.Configuration.Settings.GetSettingsFileNameFromDir(System.String)">
<summary>
Checks for each possible casing of nuget.config in the directory. The first match is
returned. If there are no nuget.config files null is returned.
</summary>
<remarks>For windows <see cref="F:NuGet.Configuration.Settings.OrderedSettingsFileNames" /> contains a single casing since
the file system is case insensitive.</remarks>
</member>
<member name="P:NuGet.Configuration.SettingsFile.ConfigFilePath">
<summary>
Full path to the settings file
</summary>
</member>
<member name="P:NuGet.Configuration.SettingsFile.DirectoryPath">
<summary>
Folder under which the settings file is present
</summary>
</member>
<member name="P:NuGet.Configuration.SettingsFile.FileName">
<summary>
Filename of the settings file
</summary>
</member>
<member name="P:NuGet.Configuration.SettingsFile.IsDirty">
<summary>
Defines if the configuration settings have been changed but have not been saved to disk
</summary>
</member>
<member name="P:NuGet.Configuration.SettingsFile.IsMachineWide">
<summary>
Defines if the settings file is considered a machine wide settings file
</summary>
<remarks>Machine wide settings files cannot be edited.</remarks>
</member>
<member name="P:NuGet.Configuration.SettingsFile.IsReadOnly">
<summary>
Determines if the settings file is considered read-only from NuGet perspective.
</summary>
<remarks>User-wide configuration files imported from non-default locations are not considered editable.
Note that this is different from <see cref="P:NuGet.Configuration.SettingsFile.IsMachineWide" />. <see cref="P:NuGet.Configuration.SettingsFile.IsReadOnly" /> will return <see langword="true" /> for every machine-wide config. </remarks>
</member>
<member name="F:NuGet.Configuration.SettingsFile._xDocument">
<summary>
XML element for settings file
</summary>
</member>
<member name="F:NuGet.Configuration.SettingsFile._rootElement">
<summary>
Root element of configuration file.
By definition of a nuget.config, the root element has to be a 'configuration' element
</summary>
</member>
<member name="M:NuGet.Configuration.SettingsFile.#ctor(System.String)">
<summary>
Creates an instance of a non machine wide SettingsFile with the default filename.
</summary>
<param name="directoryPath">path to the directory where the file is</param>
</member>
<member name="M:NuGet.Configuration.SettingsFile.#ctor(System.String,System.String)">
<summary>
Creates an instance of a non machine wide SettingsFile.
</summary>
<param name="directoryPath">path to the directory where the file is</param>
<param name="fileName">name of config file</param>
</member>
<member name="M:NuGet.Configuration.SettingsFile.#ctor(System.String,System.String,System.Boolean,System.Boolean)">
<summary>
Creates an instance of a SettingsFile
</summary>
<remarks>It will parse the specified document,
if it doesn't exist it will create one with the default configuration.</remarks>
<param name="directoryPath">path to the directory where the file is</param>
<param name="fileName">name of config file</param>
<param name="isMachineWide">specifies if the SettingsFile is machine wide.</param>
<param name="isReadOnly">specifies if the SettingsFile is read only. If the config is machine wide, the value passed here is irrelevant. <see cref="P:NuGet.Configuration.SettingsFile.IsReadOnly" /> will return <see langword="true" /> for every machine-wide config.</param>
</member>
<member name="M:NuGet.Configuration.SettingsFile.GetSection(System.String)">
<summary>
Gets the section with a given name.
</summary>
<param name="sectionName">name to match sections</param>
<returns>null if no section with the given name was found</returns>
</member>
<member name="M:NuGet.Configuration.SettingsFile.AddOrUpdate(System.String,NuGet.Configuration.SettingItem)">
<summary>
Adds or updates the given <paramref name="item" /> to the settings.
</summary>
<param name="sectionName">section where the <paramref name="item" /> has to be added. If this section does not exist, one will be created.</param>
<param name="item">item to be added to the settings.</param>
<returns>true if the item was successfully updated or added in the settings</returns>
</member>
<member name="M:NuGet.Configuration.SettingsFile.Remove(System.String,NuGet.Configuration.SettingItem)">
<summary>
Removes the given <paramref name="item" /> from the settings.
If the <paramref name="item" /> is the last item in the section, the section will also be removed.
</summary>
<param name="sectionName">Section where the <paramref name="item" /> is stored. If this section does not exist, the method will throw</param>
<param name="item">item to be removed from the settings</param>
<remarks> If the SettingsFile is a machine wide config this method will throw</remarks>
</member>
<member name="M:NuGet.Configuration.SettingsFile.SaveToDisk">
<summary>
Flushes any in-memory updates in the SettingsFile to disk.
</summary>
</member>
<member name="M:NuGet.Configuration.SettingsFile.TryGetSection(System.String,NuGet.Configuration.SettingSection@)">
<remarks>
This method gives you a reference to the actual abstraction instead of a clone of it.
It should be used only when intended. For most purposes you should be able to use
GetSection(...) instead.
</remarks>
</member>
<member name="T:NuGet.Configuration.XPlatMachineWideSetting">
<summary>
Machine wide settings based on the default machine wide config directory.
</summary>
</member>
<member name="M:NuGet.Configuration.FileSystemUtility.chmod(System.String,System.Int32)">
<summary>Only to be used for setting nuget.config permissions on Linux/Mac. Do not use elsewhere.</summary>
</member>
<member name="T:NuGet.Configuration.IExtensionLocator">
<summary>
Provides a common facility for locating extensions
</summary>
</member>
<member name="M:NuGet.Configuration.IExtensionLocator.FindExtensions">
<summary>
Find paths to all extensions
</summary>
</member>
<member name="M:NuGet.Configuration.IExtensionLocator.FindCredentialProviders">
<summary>
Find paths to all credential providers
</summary>
</member>
<member name="M:NuGet.Configuration.SettingsUtility.GetConfigValue(NuGet.Configuration.ISettings,System.String,System.Boolean,System.Boolean)">
<summary>
Retrieves a config value for the specified key
</summary>
<param name="settings">The settings instance to retrieve </param>
<param name="key">The key to look up</param>
<param name="decrypt">Determines if the retrieved value needs to be decrypted.</param>
<param name="isPath">Determines if the retrieved value is returned as a path.</param>
<returns>Null if the key was not found, value from config otherwise.</returns>
</member>
<member name="M:NuGet.Configuration.SettingsUtility.SetConfigValue(NuGet.Configuration.ISettings,System.String,System.String,System.Boolean)">
<summary>
Sets a config value in the setting.
</summary>
<param name="settings">The settings instance to store the key-value in.</param>
<param name="key">The key to store.</param>
<param name="value">The value to store.</param>
<param name="encrypt">Determines if the value needs to be encrypted prior to storing.</param>
</member>
<member name="M:NuGet.Configuration.SettingsUtility.DeleteConfigValue(NuGet.Configuration.ISettings,System.String)">
<summary>
Deletes a config value from settings
</summary>
<param name="settings">The settings instance to delete the key from.</param>
<param name="key">The key to delete.</param>
<returns>True if the value was deleted, false otherwise.</returns>
</member>
<member name="M:NuGet.Configuration.SettingsUtility.GetFallbackPackageFolders(NuGet.Configuration.ISettings)">
<summary>
Read fallback folders from the environment variable or from nuget.config.
</summary>
</member>
<member name="M:NuGet.Configuration.SettingsUtility.GetFallbackPackageFoldersFromConfig(NuGet.Configuration.ISettings)">
<summary>
Read fallback folders only from nuget.config.
</summary>
</member>
<member name="M:NuGet.Configuration.SettingsUtility.GetHttpCacheFolder">
<summary>
Get the HTTP cache folder from either an environment variable or a default.
</summary>
</member>
<member name="M:NuGet.Configuration.SettingsUtility.GetPluginsCacheFolder">
<summary>
Get plugins cache folder
</summary>
</member>
<member name="M:NuGet.Configuration.SettingsUtility.GetDefaultPushSource(NuGet.Configuration.ISettings)">
<summary>
The DefaultPushSource can be:
- An absolute URL
- An absolute file path
- A relative file path
- The name of a registered source from a config file
</summary>
</member>
<member name="M:NuGet.Configuration.SettingsUtility.VerifyPathIsRooted(System.String,System.String)">
<summary>
Throw if a path is relative.
</summary>
</member>
<member name="M:NuGet.Shared.EqualityUtility.OrderedEquals``2(System.Collections.Generic.IEnumerable{``0},System.Collections.Generic.IEnumerable{``0},System.Func{``0,``1},System.Collections.Generic.IComparer{``1},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Compares two enumerables for equality, ordered according to the specified key and optional comparer. Handles null values gracefully.
</summary>
<typeparam name="TSource">The type of the list</typeparam>
<typeparam name="TKey">The type of the sorting key</typeparam>
<param name="self">This list</param>
<param name="other">The other list</param>
<param name="keySelector">The function to extract the key from each item in the list</param>
<param name="orderComparer">An optional comparer for comparing keys</param>
<param name="sequenceComparer">An optional comparer for sequences</param>
</member>
<member name="M:NuGet.Shared.EqualityUtility.OrderedEquals``2(System.Collections.Generic.ICollection{``0},System.Collections.Generic.ICollection{``0},System.Func{``0,``1},System.Collections.Generic.IComparer{``1},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Compares two collections for equality, ordered according to the specified key and optional comparer. Handles null values gracefully.
</summary>
<typeparam name="TSource">The type of the list</typeparam>
<typeparam name="TKey">The type of the sorting key</typeparam>
<param name="self">This list</param>
<param name="other">The other list</param>
<param name="keySelector">The function to extract the key from each item in the list</param>
<param name="orderComparer">An optional comparer for comparing keys</param>
<param name="sequenceComparer">An optional comparer for sequences</param>
</member>
<member name="M:NuGet.Shared.EqualityUtility.OrderedEquals``2(System.Collections.Generic.IList{``0},System.Collections.Generic.IList{``0},System.Func{``0,``1},System.Collections.Generic.IComparer{``1},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Compares two lists for equality, ordered according to the specified key and optional comparer. Handles null values gracefully.
</summary>
<typeparam name="TSource">The type of the list</typeparam>
<typeparam name="TKey">The type of the sorting key</typeparam>
<param name="self">This list</param>
<param name="other">The other list</param>
<param name="keySelector">The function to extract the key from each item in the list</param>
<param name="orderComparer">An optional comparer for comparing keys</param>
<param name="sequenceComparer">An optional comparer for sequences</param>
</member>
<member name="M:NuGet.Shared.EqualityUtility.SequenceEqualWithNullCheck``1(System.Collections.Generic.IEnumerable{``0},System.Collections.Generic.IEnumerable{``0},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Compares two sequence for equality, allowing either sequence to be null. If one is null, both have to be
null for equality.
</summary>
</member>
<member name="M:NuGet.Shared.EqualityUtility.SequenceEqualWithNullCheck``1(System.Collections.Generic.ICollection{``0},System.Collections.Generic.ICollection{``0},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Compares two collections for equality, allowing either collection to be null. If one is null, both have to be
null for equality.
</summary>
</member>
<member name="M:NuGet.Shared.EqualityUtility.SequenceEqualWithNullCheck``1(System.Collections.Generic.IList{``0},System.Collections.Generic.IList{``0},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Compares two lists for equality, allowing either list to be null. If one is null, both have to be
null for equality.
</summary>
</member>
<member name="M:NuGet.Shared.EqualityUtility.SetEqualsWithNullCheck``1(System.Collections.Generic.ISet{``0},System.Collections.Generic.ISet{``0},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Compares two sets for equality, allowing either sequence to be null.
If one is null, both have to be null for equality.
</summary>
</member>
<member name="M:NuGet.Shared.EqualityUtility.EqualsFalse(System.String)">
<summary>
Determines if the current string contains a value equal "false". Leading and trailing whitespace are trimmed and the comparision is case-insensitive
</summary>
<param name="value">The string to compare.</param>
<returns><c>true</c> if the current string is equal to a value of "false", otherwise <c>false></c>.</returns>
</member>
<member name="T:NuGet.Shared.HashCodeCombiner">
<summary>
Hash code creator, based on the original NuGet hash code combiner/ASP hash code combiner implementations
</summary>
</member>
<member name="M:NuGet.Shared.HashCodeCombiner.GetHashCode``2(``0,``1)">
<summary>
Create a unique hash code for the given set of items
</summary>
</member>
<member name="M:NuGet.Shared.HashCodeCombiner.GetHashCode``3(``0,``1,``2)">
<summary>
Create a unique hash code for the given set of items
</summary>
</member>
<member name="M:NuGet.Shared.Extensions.AsList``1(System.Collections.Generic.IEnumerable{``0})">
<summary>
Return the enumerable as a List of T, copying if required. Optimized for common case where it is an List of T.
Avoid mutating the return value.
</summary>
<remarks>https://aspnetwebstack.codeplex.com/SourceControl/latest#src/Common/CollectionExtensions.cs</remarks>
</member>
<member name="M:NuGet.Shared.Extensions.AsHashSet``1(System.Collections.Generic.ISet{``0},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Return the ISet as a HashSet of T, copying if required. Optimized for common case where it is a HashSet of T.
Avoid mutating the return value.
</summary>
</member>
<member name="M:NuGet.Shared.XmlUtility.Load(System.String)">
<summary>
Creates a new <see cref="T:System.Xml.Linq.XDocument" /> from a file.
</summary>
<param name="path">The complete file path to be read into a new <see cref="T:System.Xml.Linq.XDocument" />.</param>
<returns>An <see cref="T:System.Xml.Linq.XDocument" /> that contains the contents of the specified file.</returns>
</member>
<member name="M:NuGet.Shared.XmlUtility.Load(System.String,System.Xml.Linq.LoadOptions)">
<summary>
Creates a new <see cref="T:System.Xml.Linq.XDocument" /> from a file. Optionally, whitespace can be preserved.
</summary>
<param name="path">The complete file path to be read into a new <see cref="T:System.Xml.Linq.XDocument" />.</param>
<param name="options">A set of <see cref="T:System.Xml.Linq.LoadOptions" />.</param>
<returns>An <see cref="T:System.Xml.Linq.XDocument" /> that contains the contents of the specified file.</returns>
</member>
<member name="M:NuGet.Shared.XmlUtility.Load(System.IO.Stream)">
<summary>
Creates a new <see cref="T:System.Xml.Linq.XDocument" /> from a stream.
</summary>
<param name="input">The stream that contains the XML data.</param>
<returns>An <see cref="T:System.Xml.Linq.XDocument" /> that contains the contents of the specified stream.</returns>
</member>
<member name="M:NuGet.Shared.XmlUtility.Load(System.IO.Stream,System.Xml.Linq.LoadOptions)">
<summary>
Creates a new System.Xml.Linq.XDocument from a stream. Optionally, whitespace can be preserved.
</summary>
<param name="input">The stream that contains the XML data.</param>
<param name="options">A set of <see cref="T:System.Xml.Linq.LoadOptions" />.</param>
<returns>An <see cref="T:System.Xml.Linq.XDocument" /> that contains the contents of the specified stream.</returns>
</member>
<member name="M:NuGet.Shared.XmlUtility.GetEncodedXMLName(System.String)">
<summary>
Converts the name to a valid XML local name, if it is invalid.
</summary>
<param name="name">The name to be encoded.</param>
<returns>The encoded name.</returns>
</member>
<member name="M:NuGet.Shared.XmlUtility.GetXmlReaderSettings(System.Xml.Linq.LoadOptions)">
<summary>
Creates an instance of <see cref="T:System.Xml.XmlReaderSettings" /> with safe settings
<param name="options">A set of <see cref="T:System.Xml.Linq.LoadOptions" />.</param>
</summary>
</member>
<member name="T:NuGet.StringBuilderPool">
<summary>
Provides a resource pool that enables reusing instances of <see cref="T:System.Text.StringBuilder" /> instances.
</summary>
<remarks>
<para>
Renting and returning buffers with an <see cref="T:NuGet.StringBuilderPool" /> can increase performance
in situations where <see cref="T:System.Text.StringBuilder" /> instances are created and destroyed frequently,
resulting in significant memory pressure on the garbage collector.
</para>
<para>
This class is thread-safe. All members may be used by multiple threads concurrently.
</para>
</remarks>
</member>
<member name="F:NuGet.StringBuilderPool.Shared">
<summary>
Retrieves a shared <see cref="T:NuGet.StringBuilderPool" /> instance.
</summary>
</member>
<member name="M:NuGet.StringBuilderPool.Rent(System.Int32)">
<summary>
Retrieves a <see cref="T:System.Text.StringBuilder" /> that is at least the requested length.
</summary>
<param name="minimumCapacity">The minimum capacity of the <see cref="T:System.Text.StringBuilder" /> needed.</param>
<returns>
A <see cref="T:System.Text.StringBuilder" /> that is at least <paramref name="minimumCapacity" /> in length.
</returns>
<remarks>
This buffer is loaned to the caller and should be returned to the same pool via
<see cref="M:NuGet.StringBuilderPool.Return(System.Text.StringBuilder)" /> so that it may be reused in subsequent usage of <see cref="M:NuGet.StringBuilderPool.Rent(System.Int32)" />.
It is not a fatal error to not return a rented string builder, but failure to do so may lead to
decreased application performance, as the pool may need to create a new instance to replace
the one lost.
</remarks>
</member>
<member name="M:NuGet.StringBuilderPool.Return(System.Text.StringBuilder)">
<summary>
Returns to the pool an array that was previously obtained via <see cref="M:NuGet.StringBuilderPool.Rent(System.Int32)" /> on the same
<see cref="T:NuGet.StringBuilderPool" /> instance.
</summary>
<param name="builder">
The <see cref="T:System.Text.StringBuilder" /> previously obtained from <see cref="M:NuGet.StringBuilderPool.Rent(System.Int32)" /> to return to the pool.
</param>
<remarks>
Once a <see cref="T:System.Text.StringBuilder" /> has been returned to the pool, the caller gives up all ownership
of the instance and must not use it. The reference returned from a given call to <see cref="M:NuGet.StringBuilderPool.Rent(System.Int32)" />
must only be returned via <see cref="M:NuGet.StringBuilderPool.Return(System.Text.StringBuilder)" /> once. The default <see cref="T:NuGet.StringBuilderPool" />
may hold onto the returned instance in order to rent it again, or it may release the returned instance
if it's determined that the pool already has enough instances stored.
</remarks>
</member>
</members>
<Signature xmlns="http://www.w3.org/2000/09/xmldsig#"><SignedInfo><CanonicalizationMethod Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315" /><SignatureMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#rsa-sha256" /><Reference URI=""><Transforms><Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature" /><Transform Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315" /></Transforms><DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256" /><DigestValue>9xBal3ENbyl67MjL+TVXuREp8+w2xw7H4dmdsn/CZnQ=</DigestValue></Reference></SignedInfo><SignatureValue>SaIbl1uP+DIpPLGC6395nx902n4bdSHCfBUmHUdAS2iJoRNZPO33KpJbJt9nHiXbO20g3Wr/TE7WKx45euTrvkcY8flcp/2ZwvvXy8PdRBIJf9chUT8NA5LGxGGqORTPMXYhYtIl/t19tqhklzBGbm3ccpm8nDmImC55jKmD7CFQO784DOlm1NfgD+lRgGjZQvCgoKTeuw1zkKXqGGnDVsJ+cYC7KsODi28cKWyexheqMvygP5tPjFILQrPC9nreRhzPaAxY/0fQyoiW/8bBpOkFU/ynuZmsDDtx4pnQqbKfnXU47QxvuQTkuf25vwBC5GYKIAYJdfINDwH6ezvdyg==</SignatureValue><KeyInfo><KeyValue><RSAKeyValue><Modulus>ok2x7OvGwA7zbnfezc3HT9M4dJka+FaQ7+vCqG40Bcm1QLlYIiDX/Whts0LVijaOvtl9iMeuShnAV7mchItKAVAABpyHuTuav2NCI9FsA8jFmlWndk3uK9RInNx1h1H4ojYxdBExyoN6muwwslKsLEfauUml7h5WAsDPpufTZd4yp2Jyiy384Zdd8CJlfQxfDe+gDZEciugWKHPSOoRxdjAk0GFm0OH14MyoYM4+M3mm1oH7vmSQohS5KIL3NEVW9Mdw7csTG5f93uORLvrJ/8ehFcGyWVb7UGHJnRhdcgGIbfiZzZlsAMS/DIBzM8RHKGNUNSbbLYmN/rt7pRjL4Q==</Modulus><Exponent>AQAB</Exponent></RSAKeyValue></KeyValue><X509Data><X509Certificate>MIIF/zCCA+egAwIBAgITMwAAAsyOtZamvdHJTgAAAAACzDANBgkqhkiG9w0BAQsFADB+MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSgwJgYDVQQDEx9NaWNyb3NvZnQgQ29kZSBTaWduaW5nIFBDQSAyMDExMB4XDTIyMDUxMjIwNDYwMVoXDTIzMDUxMTIwNDYwMVowdDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEeMBwGA1UEAxMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAok2x7OvGwA7zbnfezc3HT9M4dJka+FaQ7+vCqG40Bcm1QLlYIiDX/Whts0LVijaOvtl9iMeuShnAV7mchItKAVAABpyHuTuav2NCI9FsA8jFmlWndk3uK9RInNx1h1H4ojYxdBExyoN6muwwslKsLEfauUml7h5WAsDPpufTZd4yp2Jyiy384Zdd8CJlfQxfDe+gDZEciugWKHPSOoRxdjAk0GFm0OH14MyoYM4+M3mm1oH7vmSQohS5KIL3NEVW9Mdw7csTG5f93uORLvrJ/8ehFcGyWVb7UGHJnRhdcgGIbfiZzZlsAMS/DIBzM8RHKGNUNSbbLYmN/rt7pRjL4QIDAQABo4IBfjCCAXowHwYDVR0lBBgwFgYKKwYBBAGCN0wIAQYIKwYBBQUHAwMwHQYDVR0OBBYEFIi4R40ylsyKlSKfrDNqzhx9da30MFAGA1UdEQRJMEekRTBDMSkwJwYDVQQLEyBNaWNyb3NvZnQgT3BlcmF0aW9ucyBQdWVydG8gUmljbzEWMBQGA1UEBRMNMjMwMDEyKzQ3MDUyOTAfBgNVHSMEGDAWgBRIbmTlUAXTgqoXNzcitW2oynUClTBUBgNVHR8ETTBLMEmgR6BFhkNodHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20vcGtpb3BzL2NybC9NaWNDb2RTaWdQQ0EyMDExXzIwMTEtMDctMDguY3JsMGEGCCsGAQUFBwEBBFUwUzBRBggrBgEFBQcwAoZFaHR0cDovL3d3dy5taWNyb3NvZnQuY29tL3BraW9wcy9jZXJ0cy9NaWNDb2RTaWdQQ0EyMDExXzIwMTEtMDctMDguY3J0MAwGA1UdEwEB/wQCMAAwDQYJKoZIhvcNAQELBQADggIBAHgPA7DgB0udzEyB2LvG216zuskLUQ+iX8jFnl2i7tzXPDw5xXNXn2KvxdzBsf2osDW3LCdjFOwSjVkz+SUFQQNhjSHkd5knF6pzrL9V6lz72XiEg1Vi2gUM3HiLXSMIKOgdd78ZZJEmDLwdA692MO/1vVOFpOSv0QzpyBr5iqiotwMMsZVdZqXn8u9vRSmlk+3nQXdyOPoZXTGPLHXwz41kbSc4zI12bONTlDsLR3HD2s44wuyp3c72R8f9FVi/J9DU/+NOL37Z1yonzGZEuKdrAd6CvupAnLMlrIEv93mBsNRXuDDp4p9UYYK1taxzzgyUxgFDpluMHN0Oiiq9s73u7DA2XvbX8paJz8IZPe9a1/KhsOi5Kxhb99SCXiUnv2lGxnVAz5G6wAW1bzxJYKI+Xj90RKseY3X5EMO7TnVpIZ9Iw1IdrkHp/QLY90ZCch7kdBlLCVTFhSXZCDv4BcM6DhpRzbJsb6QDVfOv9aoG9aGV3a1EacyaedzLA2gWP6cTnCdAr4OrlrN5EFoCpOWgc77F/eQc3SLR06VTLVT1uKuNVxL2xZlD9Z+qC+a3TXa0zI/x1zEZNSgpLGsdVcaN6r/td3ArGQGkDWiAL7eS75LIWZA2SD//9B56uzZ1nmEd8+KBYsPTdp922/W2kFrlj7MBtA6vWE/ZG/grOKiC</X509Certificate><X509Certificate>MIIHejCCBWKgAwIBAgIKYQ6Q0gAAAAAAAzANBgkqhkiG9w0BAQsFADCBiDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEyMDAGA1UEAxMpTWljcm9zb2Z0IFJvb3QgQ2VydGlmaWNhdGUgQXV0aG9yaXR5IDIwMTEwHhcNMTEwNzA4MjA1OTA5WhcNMjYwNzA4MjEwOTA5WjB+MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSgwJgYDVQQDEx9NaWNyb3NvZnQgQ29kZSBTaWduaW5nIFBDQSAyMDExMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAq/D6chAcLq3YbqqCEE00uvK2WCGfQhsqa+laUKq4BjgaBEm6f8MMHt03a8YS2AvwOMKZBrDIOdUBFDFC04kNeWSHfpRgJGyvnkmc6Whe0t+bU7IKLMOv2akrrnoJr9eWWcpgGgXpZnboMlImEi/nqwhQz7NEt13YxC4Ddato88tt8zpcoRb0RrrgOGSsbmQ1eKagYw8t00CT+OPeBw3VXHmlSSnnDb6gE3e+lD3v++MrWhAfTVYoonpy4BI6t0le2O3tQ5GD2Xuye4Yb2T6xjF3oiU+EGvKhL1nkkDstrjNYxbc+/jLTswM9sbKvkjh+0p2ALPVOVpEhNSXDOW5kf1O6nA+tGSOEy/S6A4aN91/w0FK/jJSHvMAhdCVfGCi2zCcoOCWYOUo2z3yxkq4cI6epZuxhH2rhKEmdX4jiJV3TIUs+UsS1Vz8kA/DRelsv1SPjcF0PUUZ3s/gA4bysAoJf28AVs70b1FVL5zmhD+kjSbwYuER8ReTBw3J64HLnJN+/RpnF78IcV9uDjexNSTCnq47f7Fufr/zdsGbiwZeBe+3W7UvnSSmnEyimp31ngOaKYnhfsi+E11ecXL93KCjx7W3DKI8sj0A3T8HhhUSJxAlMxdSlQy90lfdu+HggWCwTXWCVmj5PM4TasIgX3p5O9JawvEagbJjS4NaIjAsCAwEAAaOCAe0wggHpMBAGCSsGAQQBgjcVAQQDAgEAMB0GA1UdDgQWBBRIbmTlUAXTgqoXNzcitW2oynUClTAZBgkrBgEEAYI3FAIEDB4KAFMAdQBiAEMAQTALBgNVHQ8EBAMCAYYwDwYDVR0TAQH/BAUwAwEB/zAfBgNVHSMEGDAWgBRyLToCMZBDuRQFTuHqp8cx0SOJNDBaBgNVHR8EUzBRME+gTaBLhklodHRwOi8vY3JsLm1pY3Jvc29mdC5jb20vcGtpL2NybC9wcm9kdWN0cy9NaWNSb29DZXJBdXQyMDExXzIwMTFfMDNfMjIuY3JsMF4GCCsGAQUFBwEBBFIwUDBOBggrBgEFBQcwAoZCaHR0cDovL3d3dy5taWNyb3NvZnQuY29tL3BraS9jZXJ0cy9NaWNSb29DZXJBdXQyMDExXzIwMTFfMDNfMjIuY3J0MIGfBgNVHSAEgZcwgZQwgZEGCSsGAQQBgjcuAzCBgzA/BggrBgEFBQcCARYzaHR0cDovL3d3dy5taWNyb3NvZnQuY29tL3BraW9wcy9kb2NzL3ByaW1hcnljcHMuaHRtMEAGCCsGAQUFBwICMDQeMiAdAEwAZQBnAGEAbABfAHAAbwBsAGkAYwB5AF8AcwB0AGEAdABlAG0AZQBuAHQALiAdMA0GCSqGSIb3DQEBCwUAA4ICAQBn8oalmOBUeRou09h0ZyKbC5YR4WOSmUKWfdJ5DJDBZV8uLD74w3LRbYP+vj/oCso7v0epo/Np22O/IjWll11lhJB9i0ZQVdgMknzSGksc8zxCi1LQsP1r4z4HLimb5j0bpdS1HXeUOeLpZMlEPXh6I/MTfaaQdION9MsmAkYqwooQu6SpBQyb7Wj6aC6VoCo/KmtYSWMfCWluWpiW5IP0wI/zRive/DvQvTXvbiWu5a8n7dDd8w6vmSiXmE0OPQvyCInWH8MyGOLwxS3OW560STkKxgrCxq2u5bLZ2xWIUUVYODJxJxp/sfQn+N4sOiBpmLJZiWhub6e3dMNABQamASooPoI/E01mC8CzTfXhj38cbxV9Rad25UAqZaPDXVJihsMdYzaXht/a8/jyFqGaJ+HNpZfQ7l1jQeNbB5yHPgZ3BtEGsXUfFL5hYbXw3MYbBL7fQccOKO7eZS/sl/ahXJbYANahRr1Z85elCUtIEJmAH9AAKcWxm6U/RXceNcbSoqKfenoi+kiVH6v7RyOA9Z74v2u3S5fi63V4GuzqN5l5GEv/1rMjaHXmr/r8i+sLgOppO6/8MO0ETI7f33VtY5E90Z1WTk+/gFcioXgRMiF670EKsT/7qMykXcGhiJtXcVZOSEXAQsmbdlsKgEhr/Xmfwb1tbWrJUnMTDXpQzQ==</X509Certificate><X509Certificate>MIIF7TCCA9WgAwIBAgIQP4vItfyfspZDtWnWbELhRDANBgkqhkiG9w0BAQsFADCBiDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEyMDAGA1UEAxMpTWljcm9zb2Z0IFJvb3QgQ2VydGlmaWNhdGUgQXV0aG9yaXR5IDIwMTEwHhcNMTEwMzIyMjIwNTI4WhcNMzYwMzIyMjIxMzA0WjCBiDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEyMDAGA1UEAxMpTWljcm9zb2Z0IFJvb3QgQ2VydGlmaWNhdGUgQXV0aG9yaXR5IDIwMTEwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQCygEGqNThNE3IyaCJNuLLx/9VSvGzH9dJKjDbu0cJcfoyKrq8TKG/Ac+M6ztAlqFo6be+ouFmrEyNozQwph9FvgFyPRH9dkAFSWKxRxV8qh9zc2AodwQO5e7BW6KPeZGHCnvjzfLnsDbVU/ky2ZU+I8JxImQxCCwl8MVkXeQZ4KI2JOkwDJb5xalwL54RgpJki49KvhKSn+9GY7Qyp3pSJ4Q6g3MDOmT3qCFK7VnnkH4S6Hri0xElcTzFLh93dBWcmmYDgcRGjuKVB4qRTufcyKYMME782XgSzS0NHL2vikR7TmE/dQgfI6B0S/Jmpaz6SfsjWaTr8ZL22CZ3K/QwLopt3YEsDlKQwaRLWQi3BQUzK3Kr9j1uDRprZ/LHR47PJf0h6zSTwQY9cdNCssBAgBkm3xy0hyFfj0IbzA2j70M5xwYmZSmQBbP3sMJHPQTySx+W6hh1hhMdfgzlirrSSL0fzC/hV66AfWdC7dJse0Hbm8ukG1xDo+mTeacY1logC8Ea4PyeZb8txiSk190gWAjWP1Xl8TQLPX+uKg09FcYj5qQ1OcunCnAfPSRtOBA5jUYxe2ADBVSy2xuDCZU7JNDn1nLPEfuhhbhNfFcRf2X7tHc7uROzLLoax7Dj2cO2rXBPB2Q8Nx4CyVe0096yb5MPa50c8prWPMd/FS6/r8QIDAQABo1EwTzALBgNVHQ8EBAMCAYYwDwYDVR0TAQH/BAUwAwEB/zAdBgNVHQ4EFgQUci06AjGQQ7kUBU7h6qfHMdEjiTQwEAYJKwYBBAGCNxUBBAMCAQAwDQYJKoZIhvcNAQELBQADggIBAH9yzw+3xRXbm8BJyiZb/p4T5tPw0tuXX/JLP02zrhmu7deXoKzvqTqjwkGw5biRnhOBJAPmCf0/V0A5ISRW0RAvS0CpNoZLtFNXmvvxfomPEf4YbFGq6O0JlbXlccmh6Yd1phV/yX43VF50k8XDZ8wNT2uoFwxtCJJ+i92Bqi1wIcM9BhS7vyRep4TXPw8hIr1LAAbblxzYXtTFC1yHblCk6MM4pPvLLMWSZpuFXst6bJN8gClYW1e1QGm6CHmmZGIVnYeWRbVmIyADixxzoNOieTPgUFmG2y/lAiXqcyqfABTINseSO+lOAOzYVgm5M0kS0lQLAausR7aRKX1MtHWAUgHoyoL2n8ysnI8X6i8msKtyrAv+nlEex0NVZ09Rs1fWtuzuUrc66U7h14GIvE+OdbtLqPA1qibUZ2dJsnBMO5PcHd94kIZysjik0dySTclY6ysSXNQ7roxrsIPlAT/4CTL2kzU0Iq/dNw13CYArzUgA8YyZGUcFAenRv9FO0OYoQzeZpApKCNmacXPSqs0xE2N2oTdvkjgefRI8ZjLny23h/FKJ3crWZgWalmG+oijHHKOnNlA8OqTfSm7mhzvO6/DggTedEzxSjr25HTTGHdUKaj2YKXCMiSrRq4IQSB/c9O+lxbtVGjhjhE63bK2VVOxlIhBJF7jAHscPrFRH</X509Certificate></X509Data></KeyInfo><Object Id="ts-countersig"><X509Data><X509Certificate>MIIHEDCCBPigAwIBAgITMwAAAaP7mrOOe4ZDTwABAAABozANBgkqhkiG9w0BAQsFADB8MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSYwJAYDVQQDEx1NaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0EgMjAxMDAeFw0yMjAzMDIxODUxMTZaFw0yMzA1MTExODUxMTZaMIHOMQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSkwJwYDVQQLEyBNaWNyb3NvZnQgT3BlcmF0aW9ucyBQdWVydG8gUmljbzEmMCQGA1UECxMdVGhhbGVzIFRTUyBFU046QzRCRC1FMzdGLTVGRkMxJTAjBgNVBAMTHE1pY3Jvc29mdCBUaW1lLVN0YW1wIFNlcnZpY2UwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQDvvU3Ky3sqCnAqi2zbc+zbdiWz9UxM8zIYvOIEumCyOwhenVUgOSNWxQh3MOmRdnhfEImn9KNl0l3/46ebIJlGLTGxouJ3gLVkjSucobeIskIQcZ9EyEKhfjYrIgcVvnoTGFhGxSPu3EnV/3VsPv2PPzLvbqt1wiuT9hvmYm1cDlR/efiIkxp5qHMVoHbNKpQaWta2IN25fF1XuS9qk1JiQb50Kcdm1K7u9Jbdvx6FOWwWyygIQj6ccuJ5rK3Tkdxr+FG3wJraUJ7T++fDUT4YNWwAh9OhZb2yMj/P7kbN8dt9t3WmhqSUGEKGaQAYOtqxQ0yePntOrbfsW376fDPZaPGtWoH8WUNaSE9VZyXWjvfIFjIjFuuXXhVIlEflp4EFX79oC7L+qO/jnKc8ukR2SJulhBmfSwbee9TXwrMec9CJb6+kszdEG2liUyyFm18G1FSmHm61xFRTMoblRkB3rGQflcFd/OoWKJzMbNI7zPBqTnMdMS8spuNlwPfVUqbLor0yYOKPGtQAiW0wVRaBAN1axUmMznUOr818a8cOov09d/JvlxfsirQBJ4aflHgDIZcO4z/fRAJYBlJdCpHAY02E8/oxMj4Cmna1NaH+aBYv6vWA5a1b/R+CbFXvBhzDpD0zaAeNNvI/PDhHuNugbH3Fy5ItKYT6e4q1tAG0XQIDAQABo4IBNjCCATIwHQYDVR0OBBYEFFBR+7M8Jgixz00vQaNoqy5yY4uqMB8GA1UdIwQYMBaAFJ+nFV0AXmJdg/Tl0mWnG1M1GelyMF8GA1UdHwRYMFYwVKBSoFCGTmh0dHA6Ly93d3cubWljcm9zb2Z0LmNvbS9wa2lvcHMvY3JsL01pY3Jvc29mdCUyMFRpbWUtU3RhbXAlMjBQQ0ElMjAyMDEwKDEpLmNybDBsBggrBgEFBQcBAQRgMF4wXAYIKwYBBQUHMAKGUGh0dHA6Ly93d3cubWljcm9zb2Z0LmNvbS9wa2lvcHMvY2VydHMvTWljcm9zb2Z0JTIwVGltZS1TdGFtcCUyMFBDQSUyMDIwMTAoMSkuY3J0MAwGA1UdEwEB/wQCMAAwEwYDVR0lBAwwCgYIKwYBBQUHAwgwDQYJKoZIhvcNAQELBQADggIBAFry3qdpl8OorgcRrtD7LLZlyOYC5oD5EykJ44GZbKHoqbLWvaJLtDE1cZR1XXHQWxXFRzC0UZFBSJHyp2nJcpeXso9N8Hg+m/6VHxcg2QfAGaRlF4U2CzUfD3qTOsg+oPtBNZx9DIThqBOlxbn5G5+niHTUxrlsAXhK9gzYhoQxpcGlB+RC894bbsjMligIGBdvAuIssoWHb5RvVTeiZwuJnPxCLedAQh6fGUAJOxwt0TpbYNYLuTYxmklXYrGouTiVn+nubGEHQwTWClyXYh3otTeyvi+bNb1fgund07BffgDaYqAQwDhpxUmLeD/rrVtdYt+4iyy2/duqQi+C8vvhlNMJc2H5+59tkckJrw9daMomR4ZkbLAwarAPp7wlbX5x9fNw3+aAQVbJM2XCU1IwsWmoAyuwKgekANx+5f9khXnqn1/w7XZXuAfrz1eJatQgrNANSwfZZs0tL8aEQ7rGPNA0ItdCt0n2StYcsmo/WvKW2RtAbAadjcHOMbTgxHgU1qAMxfZKOFendPbhRaSay6FfnvHCVP4U9/kpVu3Z6+XbWL84h06Wbrkb+ClOhdzkMzaR3+3AS6VikV0YxmHVZwBm/Dc1usFk42YzAjXQhRu6ZCizDhnajwxXX5PhGBOUUhvcsUu+nD316kSlbSWUnCBeuHo512xSLOW4fCsB</X509Certificate><X509Certificate>MIIHcTCCBVmgAwIBAgITMwAAABXF52ueAptJmQAAAAAAFTANBgkqhkiG9w0BAQsFADCBiDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEyMDAGA1UEAxMpTWljcm9zb2Z0IFJvb3QgQ2VydGlmaWNhdGUgQXV0aG9yaXR5IDIwMTAwHhcNMjEwOTMwMTgyMjI1WhcNMzAwOTMwMTgzMjI1WjB8MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSYwJAYDVQQDEx1NaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0EgMjAxMDCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAOThpkzntHIhC3miy9ckeb0O1YLT/e6cBwfSqWxOdcjKNVf2AX9sSuDivbk+F2Az/1xPx2b3lVNxWuJ+Slr+uDZnhUYjDLWNE893MsAQGOhgfWpSg0S3po5GawcU88V29YZQ3MFEyHFcUTE3oAo4bo3t1w/YJlN8OWECesSq/XJprx2rrPY2vjUmZNqYO7oaezOtgFt+jBAcnVL+tuhiJdxqD89d9P6OU8/W7IVWTe/dvI2k45GPsjksUZzpcGkNyjYtcI4xyDUoveO0hyTD4MmPfrVUj9z6BVWYbWg7mka97aSueik3rMvrg0XnRm7KMtXAhjBcTyziYrLNueKNiOSWrAFKu75xqRdbZ2De+JKRHh09/SDPc31BmkZ1zcRfNN0Sidb9pSB9fvzZnkXftnIv231fgLrbqn427DZM9ituqBJR6L8FA6PRc6ZNN3SUHDSCD/AQ8rdHGO2n6Jl8P0zbr17C89XYcz1DTsEzOUyOArxCaC4Q6oRRRuLRvWoYWmEBc8pnol7XKHYC4jMYctenIPDC+hIK12NvDMk2ZItboKaDIV1fMHSRlJTYuVD5C4lh8zYGNRiER9vcG9H9stQcxWv2XFJRXRLbJbqvUAV6bMURHXLvjflSxIUXk8A8FdsaN8cIFRg/eKtFtvUeh17aj54WcmnGrnu3tz5q4i6tAgMBAAGjggHdMIIB2TASBgkrBgEEAYI3FQEEBQIDAQABMCMGCSsGAQQBgjcVAgQWBBQqp1L+ZMSavoKRPEY1Kc8Q/y8E7jAdBgNVHQ4EFgQUn6cVXQBeYl2D9OXSZacbUzUZ6XIwXAYDVR0gBFUwUzBRBgwrBgEEAYI3TIN9AQEwQTA/BggrBgEFBQcCARYzaHR0cDovL3d3dy5taWNyb3NvZnQuY29tL3BraW9wcy9Eb2NzL1JlcG9zaXRvcnkuaHRtMBMGA1UdJQQMMAoGCCsGAQUFBwMIMBkGCSsGAQQBgjcUAgQMHgoAUwB1AGIAQwBBMAsGA1UdDwQEAwIBhjAPBgNVHRMBAf8EBTADAQH/MB8GA1UdIwQYMBaAFNX2VsuP6KJcYmjRPZSQW9fOmhjEMFYGA1UdHwRPME0wS6BJoEeGRWh0dHA6Ly9jcmwubWljcm9zb2Z0LmNvbS9wa2kvY3JsL3Byb2R1Y3RzL01pY1Jvb0NlckF1dF8yMDEwLTA2LTIzLmNybDBaBggrBgEFBQcBAQROMEwwSgYIKwYBBQUHMAKGPmh0dHA6Ly93d3cubWljcm9zb2Z0LmNvbS9wa2kvY2VydHMvTWljUm9vQ2VyQXV0XzIwMTAtMDYtMjMuY3J0MA0GCSqGSIb3DQEBCwUAA4ICAQCdVX38Kq3hLB9nATEkW+Geckv8qW/qXBS2Pk5HZHixBpOXPTEztTnXwnE2P9pkbHzQdTltuw8x5MKP+2zRoZQYIu7pZmc6U03dmLq2HnjYNi6cqYJWAAOwBb6J6Gngugnue99qb74py27YP0h1AdkY3m2CDPVtI1TkeFN1JFe53Z/zjj3G82jfZfakVqr3lbYoVSfQJL1AoL8ZthISEV09J+BAljis9/kpicO8F7BUhUKz/AyeixmJ5/ALaoHCgRlCGVJ1ijbCHcNhcy4sa3tuPywJeBTpkbKpW99Jo3QMvOyRgNI95ko+ZjtPu4b6MhrZlvSP9pEB9s7GdP32THJvEKt1MMU0sHrYUP4KWN1APMdUbZ1jdEgssU5HLcEUBHG/ZPkkvnNtyo4JvbMBV0lUZNlz138eW0QBjloZkWsNn6Qo3GcZKCS6OEuabvshVGtqRRFHqfG3rsjoiV5PndLQTHa1V1QJsWkBRH58oWFsc/4Ku+xBZj1p/cvBQUl+fpO+y/g75LcVv7TOPqUxUYS8vwLBgqJ7Fx0ViY1w/ue10CgaiQuPNtq6TPmb/wrpNPgkNWcr4A245oyZ1uEi6vAnQj0llOZ0dFtq0Z4+7X6gMTN9vMvpe784cETRkPHIqzqKOghif9lwY1NNje6CbaUFEMFxBmoQtB1VM1izoXBm8g==</X509Certificate></X509Data><CounterSignature ts-format="cms-timestamp-message" xmlns="http://schemas.microsoft.com/xmldsig/timestamp/2003">MIAGCSqGSIb3DQEHAqCAMIIW3gIBAzEPMA0GCWCGSAFlAwQCAQUAMIIBVQYLKoZIhvcNAQkQAQSgggFEBIIBQDCCATwCAQEGCisGAQQBhFkKAwEwMTANBglghkgBZQMEAgEFAAQgkm/gWZTiZwEMaDT4DnwutlSZHfs2Tcra1uSKKpVtrG4CBmMRSclEuRgTMjAyMjA5MDkyMzE3NTUuMjkxWjAEgAIB9KCB1KSB0TCBzjELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEpMCcGA1UECxMgTWljcm9zb2Z0IE9wZXJhdGlvbnMgUHVlcnRvIFJpY28xJjAkBgNVBAsTHVRoYWxlcyBUU1MgRVNOOkM0QkQtRTM3Ri01RkZDMSUwIwYDVQQDExxNaWNyb3NvZnQgVGltZS1TdGFtcCBTZXJ2aWNloIIRXDCCBxAwggT4oAMCAQICEzMAAAGj+5qzjnuGQ08AAQAAAaMwDQYJKoZIhvcNAQELBQAwfDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEmMCQGA1UEAxMdTWljcm9zb2Z0IFRpbWUtU3RhbXAgUENBIDIwMTAwHhcNMjIwMzAyMTg1MTE2WhcNMjMwNTExMTg1MTE2WjCBzjELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEpMCcGA1UECxMgTWljcm9zb2Z0IE9wZXJhdGlvbnMgUHVlcnRvIFJpY28xJjAkBgNVBAsTHVRoYWxlcyBUU1MgRVNOOkM0QkQtRTM3Ri01RkZDMSUwIwYDVQQDExxNaWNyb3NvZnQgVGltZS1TdGFtcCBTZXJ2aWNlMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEA771Nyst7KgpwKots23Ps23Yls/VMTPMyGLziBLpgsjsIXp1VIDkjVsUIdzDpkXZ4XxCJp/SjZdJd/+OnmyCZRi0xsaLid4C1ZI0rnKG3iLJCEHGfRMhCoX42KyIHFb56ExhYRsUj7txJ1f91bD79jz8y726rdcIrk/Yb5mJtXA5Uf3n4iJMaeahzFaB2zSqUGlrWtiDduXxdV7kvapNSYkG+dCnHZtSu7vSW3b8ehTlsFssoCEI+nHLieayt05Hca/hRt8Ca2lCe0/vnw1E+GDVsAIfToWW9sjI/z+5GzfHbfbd1poaklBhChmkAGDrasUNMnj57Tq237Ft++nwz2WjxrVqB/FlDWkhPVWcl1o73yBYyIxbrl14VSJRH5aeBBV+/aAuy/qjv45ynPLpEdkibpYQZn0sG3nvU18KzHnPQiW+vpLM3RBtpYlMshZtfBtRUph5utcRUUzKG5UZAd6xkH5XBXfzqFiiczGzSO8zwak5zHTEvLKbjZcD31VKmy6K9MmDijxrUAIltMFUWgQDdWsVJjM51Dq/NfGvHDqL9PXfyb5cX7Iq0ASeGn5R4AyGXDuM/30QCWAZSXQqRwGNNhPP6MTI+App2tTWh/mgWL+r1gOWtW/0fgmxV7wYcw6Q9M2gHjTbyPzw4R7jboGx9xcuSLSmE+nuKtbQBtF0CAwEAAaOCATYwggEyMB0GA1UdDgQWBBRQUfuzPCYIsc9NL0GjaKsucmOLqjAfBgNVHSMEGDAWgBSfpxVdAF5iXYP05dJlpxtTNRnpcjBfBgNVHR8EWDBWMFSgUqBQhk5odHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20vcGtpb3BzL2NybC9NaWNyb3NvZnQlMjBUaW1lLVN0YW1wJTIwUENBJTIwMjAxMCgxKS5jcmwwbAYIKwYBBQUHAQEEYDBeMFwGCCsGAQUFBzAChlBodHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20vcGtpb3BzL2NlcnRzL01pY3Jvc29mdCUyMFRpbWUtU3RhbXAlMjBQQ0ElMjAyMDEwKDEpLmNydDAMBgNVHRMBAf8EAjAAMBMGA1UdJQQMMAoGCCsGAQUFBwMIMA0GCSqGSIb3DQEBCwUAA4ICAQBa8t6naZfDqK4HEa7Q+yy2ZcjmAuaA+RMpCeOBmWyh6Kmy1r2iS7QxNXGUdV1x0FsVxUcwtFGRQUiR8qdpyXKXl7KPTfB4Ppv+lR8XINkHwBmkZReFNgs1Hw96kzrIPqD7QTWcfQyE4agTpcW5+Rufp4h01Ma5bAF4SvYM2IaEMaXBpQfkQvPeG27IzJYoCBgXbwLiLLKFh2+Ub1U3omcLiZz8Qi3nQEIenxlACTscLdE6W2DWC7k2MZpJV2KxqLk4lZ/p7mxhB0ME1gpcl2Id6LU3sr4vmzW9X4Lp3dOwX34A2mKgEMA4acVJi3g/661bXWLfuIsstv3bqkIvgvL74ZTTCXNh+fufbZHJCa8PXWjKJkeGZGywMGqwD6e8JW1+cfXzcN/mgEFWyTNlwlNSMLFpqAMrsCoHpADcfuX/ZIV56p9f8O12V7gH689XiWrUIKzQDUsH2WbNLS/GhEO6xjzQNCLXQrdJ9krWHLJqP1ryltkbQGwGnY3BzjG04MR4FNagDMX2SjhXp3T24UWkmsuhX57xwlT+FPf5KVbt2evl21i/OIdOlm65G/gpToXc5DM2kd/twEulYpFdGMZh1WcAZvw3NbrBZONmMwI10IUbumQosw4Z2o8MV1+T4RgTlFIb3LFLvpw99epEpW0llJwgXrh6OddsUizluHwrATCCB3EwggVZoAMCAQICEzMAAAAVxedrngKbSZkAAAAAABUwDQYJKoZIhvcNAQELBQAwgYgxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpXYXNoaW5ndG9uMRAwDgYDVQQHEwdSZWRtb25kMR4wHAYDVQQKExVNaWNyb3NvZnQgQ29ycG9yYXRpb24xMjAwBgNVBAMTKU1pY3Jvc29mdCBSb290IENlcnRpZmljYXRlIEF1dGhvcml0eSAyMDEwMB4XDTIxMDkzMDE4MjIyNVoXDTMwMDkzMDE4MzIyNVowfDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEmMCQGA1UEAxMdTWljcm9zb2Z0IFRpbWUtU3RhbXAgUENBIDIwMTAwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQDk4aZM57RyIQt5osvXJHm9DtWC0/3unAcH0qlsTnXIyjVX9gF/bErg4r25PhdgM/9cT8dm95VTcVrifkpa/rg2Z4VGIwy1jRPPdzLAEBjoYH1qUoNEt6aORmsHFPPFdvWGUNzBRMhxXFExN6AKOG6N7dcP2CZTfDlhAnrEqv1yaa8dq6z2Nr41JmTamDu6GnszrYBbfowQHJ1S/rboYiXcag/PXfT+jlPP1uyFVk3v3byNpOORj7I5LFGc6XBpDco2LXCOMcg1KL3jtIckw+DJj361VI/c+gVVmG1oO5pGve2krnopN6zL64NF50ZuyjLVwIYwXE8s4mKyzbnijYjklqwBSru+cakXW2dg3viSkR4dPf0gz3N9QZpGdc3EXzTdEonW/aUgfX782Z5F37ZyL9t9X4C626p+Nuw2TPYrbqgSUei/BQOj0XOmTTd0lBw0gg/wEPK3Rxjtp+iZfD9M269ewvPV2HM9Q07BMzlMjgK8QmguEOqEUUbi0b1qGFphAXPKZ6Je1yh2AuIzGHLXpyDwwvoSCtdjbwzJNmSLW6CmgyFdXzB0kZSU2LlQ+QuJYfM2BjUYhEfb3BvR/bLUHMVr9lxSUV0S2yW6r1AFemzFER1y7435UsSFF5PAPBXbGjfHCBUYP3irRbb1Hode2o+eFnJpxq57t7c+auIurQIDAQABo4IB3TCCAdkwEgYJKwYBBAGCNxUBBAUCAwEAATAjBgkrBgEEAYI3FQIEFgQUKqdS/mTEmr6CkTxGNSnPEP8vBO4wHQYDVR0OBBYEFJ+nFV0AXmJdg/Tl0mWnG1M1GelyMFwGA1UdIARVMFMwUQYMKwYBBAGCN0yDfQEBMEEwPwYIKwYBBQUHAgEWM2h0dHA6Ly93d3cubWljcm9zb2Z0LmNvbS9wa2lvcHMvRG9jcy9SZXBvc2l0b3J5Lmh0bTATBgNVHSUEDDAKBggrBgEFBQcDCDAZBgkrBgEEAYI3FAIEDB4KAFMAdQBiAEMAQTALBgNVHQ8EBAMCAYYwDwYDVR0TAQH/BAUwAwEB/zAfBgNVHSMEGDAWgBTV9lbLj+iiXGJo0T2UkFvXzpoYxDBWBgNVHR8ETzBNMEugSaBHhkVodHRwOi8vY3JsLm1pY3Jvc29mdC5jb20vcGtpL2NybC9wcm9kdWN0cy9NaWNSb29DZXJBdXRfMjAxMC0wNi0yMy5jcmwwWgYIKwYBBQUHAQEETjBMMEoGCCsGAQUFBzAChj5odHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20vcGtpL2NlcnRzL01pY1Jvb0NlckF1dF8yMDEwLTA2LTIzLmNydDANBgkqhkiG9w0BAQsFAAOCAgEAnVV9/Cqt4SwfZwExJFvhnnJL/Klv6lwUtj5OR2R4sQaTlz0xM7U518JxNj/aZGx80HU5bbsPMeTCj/ts0aGUGCLu6WZnOlNN3Zi6th542DYunKmCVgADsAW+iehp4LoJ7nvfam++Kctu2D9IdQHZGN5tggz1bSNU5HhTdSRXud2f8449xvNo32X2pFaq95W2KFUn0CS9QKC/GbYSEhFdPSfgQJY4rPf5KYnDvBewVIVCs/wMnosZiefwC2qBwoEZQhlSdYo2wh3DYXMuLGt7bj8sCXgU6ZGyqVvfSaN0DLzskYDSPeZKPmY7T7uG+jIa2Zb0j/aRAfbOxnT99kxybxCrdTDFNLB62FD+CljdQDzHVG2dY3RILLFORy3BFARxv2T5JL5zbcqOCb2zAVdJVGTZc9d/HltEAY5aGZFrDZ+kKNxnGSgkujhLmm77IVRrakURR6nxt67I6IleT53S0Ex2tVdUCbFpAUR+fKFhbHP+CrvsQWY9af3LwUFJfn6Tvsv4O+S3Fb+0zj6lMVGEvL8CwYKiexcdFYmNcP7ntdAoGokLjzbaukz5m/8K6TT4JDVnK+ANuOaMmdbhIurwJ0I9JZTmdHRbatGePu1+oDEzfbzL6Xu/OHBE0ZDxyKs6ijoIYn/ZcGNTTY3ugm2lBRDBcQZqELQdVTNYs6FwZvKhggLPMIICOAIBATCB/KGB1KSB0TCBzjELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEpMCcGA1UECxMgTWljcm9zb2Z0IE9wZXJhdGlvbnMgUHVlcnRvIFJpY28xJjAkBgNVBAsTHVRoYWxlcyBUU1MgRVNOOkM0QkQtRTM3Ri01RkZDMSUwIwYDVQQDExxNaWNyb3NvZnQgVGltZS1TdGFtcCBTZXJ2aWNloiMKAQEwBwYFKw4DAhoDFQAeX+leQswBs9qkLBr4ZdzdKUMNE6CBgzCBgKR+MHwxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpXYXNoaW5ndG9uMRAwDgYDVQQHEwdSZWRtb25kMR4wHAYDVQQKExVNaWNyb3NvZnQgQ29ycG9yYXRpb24xJjAkBgNVBAMTHU1pY3Jvc29mdCBUaW1lLVN0YW1wIFBDQSAyMDEwMA0GCSqGSIb3DQEBBQUAAgUA5sWrWDAiGA8yMDIyMDkwOTE2MDg1NloYDzIwMjIwOTEwMTYwODU2WjB0MDoGCisGAQQBhFkKBAExLDAqMAoCBQDmxatYAgEAMAcCAQACAgXJMAcCAQACAhPnMAoCBQDmxvzYAgEAMDYGCisGAQQBhFkKBAIxKDAmMAwGCisGAQQBhFkKAwKgCjAIAgEAAgMHoSChCjAIAgEAAgMBhqAwDQYJKoZIhvcNAQEFBQADgYEAIRaRxLK88Ko9/PmzYGT2HxvBVLDli+Qvo98SgO5nGhpNVf/lVLcxg4/rId1I632K1Z6o0Gh3Q4L9SUh5NYx+m3HQk3oFXyUakA/X+EgQicvlDG1RyEqsuZ4+vf2ywRND/eeoLHrM+ICOJiQd9fY3XLWIS0ylRU3pvlWlFLpg+ZUxggQNMIIECQIBATCBkzB8MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSYwJAYDVQQDEx1NaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0EgMjAxMAITMwAAAaP7mrOOe4ZDTwABAAABozANBglghkgBZQMEAgEFAKCCAUowGgYJKoZIhvcNAQkDMQ0GCyqGSIb3DQEJEAEEMC8GCSqGSIb3DQEJBDEiBCDwt3jb9rBUebQPfDbzXCCSQcenc6GFGnxTCB14QT76qzCB+gYLKoZIhvcNAQkQAi8xgeowgecwgeQwgb0EIIz4uLAGccwyg53+yBtpjGnC8QmVERmX+lM+SXPp643+MIGYMIGApH4wfDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEmMCQGA1UEAxMdTWljcm9zb2Z0IFRpbWUtU3RhbXAgUENBIDIwMTACEzMAAAGj+5qzjnuGQ08AAQAAAaMwIgQgYq2l2MrcEMvTNko8wPVx/v094nJ/bVy8Jo+yIoyb5mAwDQYJKoZIhvcNAQELBQAEggIALqfmYcVu31Xteplr1t3nXfkP47KWITSUeOykbjOwLqdb9yXCyCMLL1lP1G28OOrlxjuQllTaq+kzZ1d046rBwumoCOr9xHE8OiQEQjiJitfsn7FUM5hNFiJsqObpdAuIoDO341Vw02VftOLJYfEA5ndJUoL+u+taVIsddcriVGnfSawtliACIm2arVufKYm+XyQX7QZeb5FXlrNhHe82MF7bdqBnqx98qnxsqgoZLywRKBdOqLt9cVk+MkngK2qgCyW4MPl62p04LQyQjUG3Gsu3t2/hlEQyWbC43/BOlzeLXTKwHST+66rcymecTXH9NGRY249pAErrfhLn4jCgyc1EVoDmis4/MwbsA1MZb/TLd1mG6qWs9hQvwipDl7pyxnlY7+isM4JbwAFS77Lydi2fMsYah6Invp1SXslGNFYuT17O6GsmEBRs7sL2vt3br3UuPJCUZSw1F3hLR4zmk7qRmC6PbRDRYs0NiuzVsBj1OQbnVESb8dP04RahXnnV2BpV/sXg1ZEgWkHFRkRDFeTuyfCb1rl/14ERJ6Rc92Byi1UGZg/71ASn+OhQIgpXPyMDU54UA93LYWq4xJCbEM++1mnrDaXSnEfEVzWZ2ngLuYKtiVCyxr1CJq8y4oNtzUj0uqEfIPrpeYM9uBO8n7+QaEtt3+3ro0iv0fVaqpAAAAAA</CounterSignature></Object></Signature></doc>
md5: F57E5C5790FDA25BBC7E0D4C91FD1399 | sha1: 6813C002065F37F93D933BF423F2C2434492DC48 | sha256: 152A0EE6635ECABFC95599CD446369459AFD3E6B26B5A0053C9832D7217779E7 | sha512: 6BB671666EF4F5716132AC4FCFC4CCB7A416FDCE867B87301FAC9E8F63F500C1B6B3904DA6D5FC53A3F17E8B56BCAA0C2A46CCEDB7C6BFCC46B744A9CF732DA4
<?xml version="1.0"?>
<doc>
<assembly>
<name>NuGet.Frameworks</name>
</assembly>
<members>
<member name="T:NuGet.Frameworks.AssetTargetFallbackFramework">
<summary>
AssetTargetFallbackFramework only fallback when zero assets are selected. These do not
auto fallback during GetNearest as FallbackFramework would.
</summary>
</member>
<member name="P:NuGet.Frameworks.AssetTargetFallbackFramework.Fallback">
<summary>
List framework to fall back to.
</summary>
</member>
<member name="P:NuGet.Frameworks.AssetTargetFallbackFramework.RootFramework">
<summary>
Root project framework.
</summary>
</member>
<member name="M:NuGet.Frameworks.AssetTargetFallbackFramework.AsFallbackFramework">
<summary>
Create a FallbackFramework from the current AssetTargetFallbackFramework.
</summary>
</member>
<member name="T:NuGet.Frameworks.FrameworkPrecedenceSorter">
<summary>
Sorts frameworks according to the framework mappings
</summary>
</member>
<member name="T:NuGet.Frameworks.NuGetFrameworkFullComparer">
<summary>
A case insensitive compare of the framework, version, and profile
</summary>
</member>
<member name="T:NuGet.Frameworks.NuGetFrameworkNameComparer">
<summary>
A case insensitive compare of the framework name only
</summary>
</member>
<member name="T:NuGet.Frameworks.NuGetFrameworkSorter">
<summary>
Sorts NuGet Frameworks in a consistent way for package readers.
The order is not particularly useful here beyond making things deterministic
since it compares completely different frameworks.
</summary>
</member>
<member name="T:NuGet.Frameworks.CompatibilityCacheKey">
<summary>
Internal cache key used to store framework compatibility.
</summary>
</member>
<member name="M:NuGet.Frameworks.CompatibilityProvider.IsCompatible(NuGet.Frameworks.NuGetFramework,NuGet.Frameworks.NuGetFramework)">
<summary>
Check if the frameworks are compatible.
</summary>
<param name="target">Project framework</param>
<param name="candidate">Other framework to check against the project framework</param>
<returns>True if framework supports other</returns>
</member>
<member name="M:NuGet.Frameworks.CompatibilityProvider.IsCompatibleCore(NuGet.Frameworks.NuGetFramework,NuGet.Frameworks.NuGetFramework)">
<summary>
Actual compatibility check without caching
</summary>
</member>
<member name="M:NuGet.Frameworks.CompatibilityProvider.GetEquivalentFrameworksClosure(NuGet.Frameworks.NuGetFramework)">
<summary>
Find all equivalent frameworks, and their equivalent frameworks.
Example:
Mappings:
A <‒> B
B <‒> C
C <‒> D
For A we need to find B, C, and D so we must retrieve equivalent frameworks for A, B, and C
also as we discover them.
</summary>
</member>
<member name="T:NuGet.Frameworks.CompatibilityTable">
<summary>
Creates a table of compatible frameworks.
</summary>
</member>
<member name="M:NuGet.Frameworks.CompatibilityTable.HasFramework(NuGet.Frameworks.NuGetFramework)">
<summary>
True if the framework is in the table.
</summary>
</member>
<member name="M:NuGet.Frameworks.CompatibilityTable.GetNearest(NuGet.Frameworks.NuGetFramework)">
<summary>
Gives the smallest set of frameworks from the table that cover everything the given framework would cover.
</summary>
</member>
<member name="M:NuGet.Frameworks.CompatibilityTable.TryGetCompatible(NuGet.Frameworks.NuGetFramework,System.Collections.Generic.IEnumerable{NuGet.Frameworks.NuGetFramework}@)">
<summary>
Returns the list of all frameworks compatible with the given framework
</summary>
</member>
<member name="P:NuGet.Frameworks.DefaultFrameworkMappings.Instance">
<summary>
Singleton instance of the default framework mappings.
</summary>
</member>
<member name="T:NuGet.Frameworks.DefaultPortableFrameworkMappings">
<summary>
Contains the standard portable framework mappings
</summary>
</member>
<member name="P:NuGet.Frameworks.DefaultPortableFrameworkMappings.Instance">
<summary>
Static instance of the portable framework mappings
</summary>
</member>
<member name="M:NuGet.Frameworks.IFrameworkCompatibilityListProvider.GetFrameworksSupporting(NuGet.Frameworks.NuGetFramework)">
<summary>
Get a list of frameworks supporting the provided framework. This list
is not meant to be exhaustive but is instead meant to be human-readable.
Ex: netstandard1.5 -> netstandardapp1.5, net462, dnxcore50, ...
</summary>
</member>
<member name="M:NuGet.Frameworks.IFrameworkCompatibilityProvider.IsCompatible(NuGet.Frameworks.NuGetFramework,NuGet.Frameworks.NuGetFramework)">
<summary>
Ex: IsCompatible(net45, net40) -> true
Ex: IsCompatible(net40, net45) -> false
</summary>
<param name="framework">Project target framework</param>
<param name="other">Library framework that is going to be installed</param>
<returns>True if framework supports other</returns>
</member>
<member name="T:NuGet.Frameworks.IFrameworkMappings">
<summary>
A raw list of framework mappings. These are indexed by the framework name provider and in most cases all
mappings are
mirrored so that the IFrameworkMappings implementation only needs to provide the minimum amount of
mappings.
</summary>
</member>
<member name="P:NuGet.Frameworks.IFrameworkMappings.IdentifierSynonyms">
<summary>
Synonym ‒> Identifier
Ex: NET Framework ‒> .NET Framework
</summary>
</member>
<member name="P:NuGet.Frameworks.IFrameworkMappings.IdentifierShortNames">
<summary>
Ex: .NET Framework ‒> net
</summary>
</member>
<member name="P:NuGet.Frameworks.IFrameworkMappings.ProfileShortNames">
<summary>
Ex: WindowsPhone ‒> wp
</summary>
</member>
<member name="P:NuGet.Frameworks.IFrameworkMappings.EquivalentFrameworks">
<summary>
Equal frameworks. Used for legacy conversions.
ex: Framework: Win8 <‒> Framework: NetCore45 Platform: Win8
</summary>
</member>
<member name="P:NuGet.Frameworks.IFrameworkMappings.EquivalentProfiles">
<summary>
Framework, EquivalentProfile1, EquivalentProfile2
Ex: Silverlight, WindowsPhone71, WindowsPhone
</summary>
</member>
<member name="P:NuGet.Frameworks.IFrameworkMappings.SubSetFrameworks">
<summary>
Frameworks which are subsets of others.
Ex: .NETCore ‒> .NET
Everything in .NETCore maps to .NET and is one way compatible. Version numbers follow the same format.
</summary>
</member>
<member name="P:NuGet.Frameworks.IFrameworkMappings.CompatibilityMappings">
<summary>
Additional framework compatibility rules beyond name and version matching.
Ex: .NETFramework supports ‒> Native
</summary>
</member>
<member name="P:NuGet.Frameworks.IFrameworkMappings.NonPackageBasedFrameworkPrecedence">
<summary>
Ordered list of framework identifiers. The first framework in the list will be preferred over other
framework identifiers. This is enable better tie breaking in scenarios where legacy frameworks are
equivalently compatible to a new framework.
Example: UAP10.0 ‒> win81, wpa81
</summary>
</member>
<member name="P:NuGet.Frameworks.IFrameworkMappings.PackageBasedFrameworkPrecedence">
<summary>
Same as <see cref="P:NuGet.Frameworks.IFrameworkMappings.NonPackageBasedFrameworkPrecedence" /> but is only referred to if all of the packages
in consideration are package based (determined by <see cref="P:NuGet.Frameworks.NuGetFramework.IsPackageBased" />).
</summary>
</member>
<member name="P:NuGet.Frameworks.IFrameworkMappings.EquivalentFrameworkPrecedence">
<summary>
Only used to choose between frameworks that are equivalent. This favors more human-readable target
frameworks identifiers.
</summary>
</member>
<member name="P:NuGet.Frameworks.IFrameworkMappings.ShortNameReplacements">
<summary>
Rewrite folder short names to the given value.
Ex: dotnet50 ‒> dotnet
</summary>
</member>
<member name="P:NuGet.Frameworks.IFrameworkMappings.FullNameReplacements">
<summary>
Rewrite full framework names to the given value.
Ex: .NETPlatform,Version=v0.0 ‒> .NETPlatform,Version=v5.0
</summary>
</member>
<member name="M:NuGet.Frameworks.IFrameworkNameProvider.TryGetIdentifier(System.String,System.String@)">
<summary>
Returns the official framework identifier for an alias or short name.
</summary>
</member>
<member name="M:NuGet.Frameworks.IFrameworkNameProvider.TryGetShortIdentifier(System.String,System.String@)">
<summary>
Gives the short name used for folders in NuGet
</summary>
</member>
<member name="M:NuGet.Frameworks.IFrameworkNameProvider.TryGetProfile(System.String,System.String,System.String@)">
<summary>
Get the official profile name from the short name.
</summary>
</member>
<member name="M:NuGet.Frameworks.IFrameworkNameProvider.TryGetShortProfile(System.String,System.String,System.String@)">
<summary>
Returns the shortened version of the profile name.
</summary>
</member>
<member name="M:NuGet.Frameworks.IFrameworkNameProvider.TryGetVersion(System.String,System.Version@)">
<summary>
Parses a version string using single digit rules if no dots exist
</summary>
</member>
<member name="M:NuGet.Frameworks.IFrameworkNameProvider.TryGetPlatformVersion(System.String,System.Version@)">
<summary>
Parses a version string. If no dots exist, all digits are treated
as semver-major, instead of inserting dots.
</summary>
</member>
<member name="M:NuGet.Frameworks.IFrameworkNameProvider.GetVersionString(System.String,System.Version)">
<summary>
Returns a shortened version. If all digits are single digits no dots will be used.
</summary>
</member>
<member name="M:NuGet.Frameworks.IFrameworkNameProvider.TryGetPortableProfileNumber(System.String,System.Int32@)">
<summary>
Tries to parse the portable profile number out of a profile.
</summary>
</member>
<member name="M:NuGet.Frameworks.IFrameworkNameProvider.TryGetPortableProfile(System.Collections.Generic.IEnumerable{NuGet.Frameworks.NuGetFramework},System.Int32@)">
<summary>
Looks up the portable profile number based on the framework list.
</summary>
</member>
<member name="M:NuGet.Frameworks.IFrameworkNameProvider.TryGetPortableFrameworks(System.Int32,System.Collections.Generic.IEnumerable{NuGet.Frameworks.NuGetFramework}@)">
<summary>
Returns the frameworks based on a portable profile number.
</summary>
</member>
<member name="M:NuGet.Frameworks.IFrameworkNameProvider.TryGetPortableFrameworks(System.Int32,System.Boolean,System.Collections.Generic.IEnumerable{NuGet.Frameworks.NuGetFramework}@)">
<summary>
Returns the frameworks based on a portable profile number.
</summary>
</member>
<member name="M:NuGet.Frameworks.IFrameworkNameProvider.TryGetPortableFrameworks(System.String,System.Boolean,System.Collections.Generic.IEnumerable{NuGet.Frameworks.NuGetFramework}@)">
<summary>
Returns the frameworks based on a profile string.
Profile can be either the number in format: Profile=7, or the shortened NuGet version: net45+win8
</summary>
</member>
<member name="M:NuGet.Frameworks.IFrameworkNameProvider.TryGetPortableFrameworks(System.String,System.Collections.Generic.IEnumerable{NuGet.Frameworks.NuGetFramework}@)">
<summary>
Parses a shortened portable framework profile list.
Ex: net45+win8
</summary>
</member>
<member name="M:NuGet.Frameworks.IFrameworkNameProvider.TryGetPortableCompatibilityMappings(System.Int32,System.Collections.Generic.IEnumerable{NuGet.Frameworks.FrameworkRange}@)">
<summary>
Returns ranges of frameworks that are known to be supported by the given portable profile number.
Ex: Profile7 -> netstandard1.1
</summary>
</member>
<member name="M:NuGet.Frameworks.IFrameworkNameProvider.TryGetEquivalentFrameworks(NuGet.Frameworks.NuGetFramework,System.Collections.Generic.IEnumerable{NuGet.Frameworks.NuGetFramework}@)">
<summary>
Returns a list of all possible substitutions where the framework name
have equivalents.
Ex: sl3 -> wp8
</summary>
</member>
<member name="M:NuGet.Frameworks.IFrameworkNameProvider.TryGetEquivalentFrameworks(NuGet.Frameworks.FrameworkRange,System.Collections.Generic.IEnumerable{NuGet.Frameworks.NuGetFramework}@)">
<summary>
Gives all substitutions for a framework range.
</summary>
</member>
<member name="M:NuGet.Frameworks.IFrameworkNameProvider.TryGetCompatibilityMappings(NuGet.Frameworks.NuGetFramework,System.Collections.Generic.IEnumerable{NuGet.Frameworks.FrameworkRange}@)">
<summary>
Returns ranges of frameworks that are known to be supported by the given framework.
Ex: net45 -> native
</summary>
</member>
<member name="M:NuGet.Frameworks.IFrameworkNameProvider.TryGetSubSetFrameworks(System.String,System.Collections.Generic.IEnumerable{System.String}@)">
<summary>
Returns all sub sets of the given framework.
Ex: .NETFramework -> .NETCore
These will have the same version, but a different framework
</summary>
</member>
<member name="M:NuGet.Frameworks.IFrameworkNameProvider.CompareFrameworks(NuGet.Frameworks.NuGetFramework,NuGet.Frameworks.NuGetFramework)">
<summary>
The ascending order of frameworks should be based on the following ordered groups:
1. Non-package-based frameworks in <see cref="P:NuGet.Frameworks.IFrameworkMappings.NonPackageBasedFrameworkPrecedence" />.
2. Other non-package-based frameworks.
3. Package-based frameworks in <see cref="P:NuGet.Frameworks.IFrameworkMappings.PackageBasedFrameworkPrecedence" />.
4. Other package-based frameworks.
For group #1 and #3, the order within the group is based on the order of the respective precedence list.
For group #2 and #4, the order is the original order in the incoming list. This should later be made
consistent between different input orderings by using the <see cref="T:NuGet.Frameworks.NuGetFrameworkSorter" />.
</summary>
<remarks>netcore50 is a special case since netcore451 is not packages based, but netcore50 is.
This sort will treat all versions of netcore as non-packages based.</remarks>
</member>
<member name="M:NuGet.Frameworks.IFrameworkNameProvider.CompareEquivalentFrameworks(NuGet.Frameworks.NuGetFramework,NuGet.Frameworks.NuGetFramework)">
<summary>
Used to pick between two equivalent frameworks. This is meant to favor the more human-readable
framework. Note that this comparison does not validate that the provided frameworks are indeed
equivalent (e.g. with
<see cref="M:NuGet.Frameworks.IFrameworkNameProvider.TryGetEquivalentFrameworks(NuGet.Frameworks.NuGetFramework,System.Collections.Generic.IEnumerable{NuGet.Frameworks.NuGetFramework}@)" />).
</summary>
</member>
<member name="M:NuGet.Frameworks.IFrameworkNameProvider.GetShortNameReplacement(NuGet.Frameworks.NuGetFramework)">
<summary>
Returns folder short names rewrites.
Ex: dotnet50 -> dotnet
</summary>
</member>
<member name="M:NuGet.Frameworks.IFrameworkNameProvider.GetFullNameReplacement(NuGet.Frameworks.NuGetFramework)">
<summary>
Returns full name rewrites.
Ex: .NETPlatform,Version=v0.0 -> .NETPlatform,Version=v5.0
</summary>
</member>
<member name="M:NuGet.Frameworks.IFrameworkNameProvider.GetNetStandardVersions">
<summary>
Returns all versions of .NETStandard in ascending order.
</summary>
</member>
<member name="M:NuGet.Frameworks.IFrameworkNameProvider.GetCompatibleCandidates">
<summary>
Returns a list of frameworks that could be compatible with .NETStandard.
</summary>
</member>
<member name="T:NuGet.Frameworks.IFrameworkSpecific">
<summary>
A group or object that is specific to a single target framework
</summary>
</member>
<member name="P:NuGet.Frameworks.IFrameworkSpecific.TargetFramework">
<summary>
Target framework
</summary>
</member>
<member name="T:NuGet.Frameworks.IFrameworkTargetable">
<summary>
Use this to expose the list of target frameworks an object can be used for.
</summary>
</member>
<member name="P:NuGet.Frameworks.IFrameworkTargetable.SupportedFrameworks">
<summary>
All frameworks supported by the parent
</summary>
</member>
<member name="P:NuGet.Frameworks.IPortableFrameworkMappings.ProfileFrameworks">
<summary>
Ex: 5 -> net4, win8
</summary>
</member>
<member name="P:NuGet.Frameworks.IPortableFrameworkMappings.ProfileOptionalFrameworks">
<summary>
Additional optional frameworks supported in a portable profile.
Ex: 5 -> MonoAndroid1+MonoTouch1
</summary>
</member>
<member name="P:NuGet.Frameworks.IPortableFrameworkMappings.CompatibilityMappings">
<summary>
Compatibility mapping for portable profiles. This is a separate compatibility from that in
<see cref="P:NuGet.Frameworks.IFrameworkMappings.CompatibilityMappings" />.
</summary>
</member>
<member name="T:NuGet.Frameworks.DualCompatibilityFramework">
<summary>
Represents a framework that behaves as 2 potentially independent frameworks.
Ex. C++/CLI can support both .NET 5.0 and native.
This type is immutable.
</summary>
</member>
<member name="P:NuGet.Frameworks.DualCompatibilityFramework.RootFramework">
<summary>
The root framework. Any compatibility checks should be performed against this framework first.
</summary>
</member>
<member name="P:NuGet.Frameworks.DualCompatibilityFramework.SecondaryFramework">
<summary>
The secondary framework. If the root framework compatibility checks fail, then the compat checks should be performed against this framework next.
</summary>
</member>
<member name="M:NuGet.Frameworks.DualCompatibilityFramework.#ctor(NuGet.Frameworks.NuGetFramework,NuGet.Frameworks.NuGetFramework)">
<summary>
Multiple compatbility
</summary>
<param name="framework">Root framework. Never <see langword="null" />. </param>
<param name="secondaryFramework">Secondary framework. Never <see langword="null" />. </param>
<exception cref="T:System.ArgumentNullException">if either <paramref name="framework" /> or <paramref name="secondaryFramework" /> are <see langword="null" />.</exception>
</member>
<member name="M:NuGet.Frameworks.DualCompatibilityFramework.AsFallbackFramework">
<summary>
Create a FallbackFramework from the current DualCompatibilityFramework.
</summary>
</member>
<member name="P:NuGet.Frameworks.FallbackFramework.Fallback">
<summary>
List framework to fall back to.
</summary>
</member>
<member name="T:NuGet.Frameworks.FrameworkConstants.CommonFrameworks">
<summary>
Interned frameworks that are commonly used in NuGet
</summary>
</member>
<member name="T:NuGet.Frameworks.FrameworkExpander">
<summary>
FrameworkExpander finds all equivalent and compatible frameworks for a NuGetFramework
</summary>
</member>
<member name="M:NuGet.Frameworks.FrameworkExpander.Expand(NuGet.Frameworks.NuGetFramework)">
<summary>
Return all possible equivalent, subset, and known compatible frameworks.
</summary>
</member>
<member name="M:NuGet.Frameworks.FrameworkExpander.ExpandInternal(NuGet.Frameworks.NuGetFramework)">
<summary>
Finds all expansions using the mapping provider
</summary>
</member>
<member name="M:NuGet.Frameworks.NuGetFrameworkExtensions.IsDesktop(NuGet.Frameworks.NuGetFramework)">
<summary>
True if the Framework is .NETFramework
</summary>
</member>
<member name="M:NuGet.Frameworks.NuGetFrameworkExtensions.GetNearest``1(System.Collections.Generic.IEnumerable{``0},NuGet.Frameworks.NuGetFramework)">
<summary>
Return the item with the target framework nearest the project framework
</summary>
</member>
<member name="F:NuGet.Frameworks.FrameworkNameProvider._identifierSynonyms">
<summary>
Contains identifier -> identifier
Ex: .NET Framework -> .NET Framework
Ex: NET Framework -> .NET Framework
This includes self mappings.
</summary>
</member>
<member name="M:NuGet.Frameworks.FrameworkNameProvider.TryConvertOrNormalize(System.String,System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.String},System.String@)">
<summary>
Converts a key using the mappings, or if the key is already converted, finds the normalized form.
</summary>
</member>
<member name="M:NuGet.Frameworks.FrameworkNameProvider.GetAllEquivalentFrameworks(NuGet.Frameworks.NuGetFramework)">
<summary>
Get all equivalent frameworks including the given framework
</summary>
</member>
<member name="M:NuGet.Frameworks.FrameworkNameProvider.AddEquivalentProfiles(System.Collections.Generic.IEnumerable{NuGet.Frameworks.FrameworkSpecificMapping})">
<summary>
2 way per framework profile equivalence
</summary>
<param name="mappings"></param>
</member>
<member name="M:NuGet.Frameworks.FrameworkNameProvider.AddEquivalentFrameworks(System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{NuGet.Frameworks.NuGetFramework,NuGet.Frameworks.NuGetFramework}})">
<summary>
2 way framework equivalence
</summary>
<param name="mappings"></param>
</member>
<member name="T:NuGet.Frameworks.FrameworkRange">
<summary>
An inclusive range of frameworks
</summary>
</member>
<member name="P:NuGet.Frameworks.FrameworkRange.Min">
<summary>
Minimum Framework
</summary>
</member>
<member name="P:NuGet.Frameworks.FrameworkRange.Max">
<summary>
Maximum Framework
</summary>
</member>
<member name="P:NuGet.Frameworks.FrameworkRange.IncludeMin">
<summary>
Minimum version inclusiveness.
</summary>
</member>
<member name="P:NuGet.Frameworks.FrameworkRange.IncludeMax">
<summary>
Maximum version inclusiveness.
</summary>
</member>
<member name="P:NuGet.Frameworks.FrameworkRange.FrameworkIdentifier">
<summary>
Framework Identifier of both the Min and Max
</summary>
</member>
<member name="M:NuGet.Frameworks.FrameworkRange.Satisfies(NuGet.Frameworks.NuGetFramework)">
<summary>
True if the framework version falls between the min and max
</summary>
</member>
<member name="T:NuGet.Frameworks.FrameworkReducer">
<summary>
Reduces a list of frameworks into the smallest set of frameworks required.
</summary>
</member>
<member name="M:NuGet.Frameworks.FrameworkReducer.#ctor">
<summary>
Creates a FrameworkReducer using the default framework mappings.
</summary>
</member>
<member name="M:NuGet.Frameworks.FrameworkReducer.#ctor(NuGet.Frameworks.IFrameworkNameProvider,NuGet.Frameworks.IFrameworkCompatibilityProvider)">
<summary>
Creates a FrameworkReducer using custom framework mappings.
</summary>
</member>
<member name="M:NuGet.Frameworks.FrameworkReducer.GetNearest(NuGet.Frameworks.NuGetFramework,System.Collections.Generic.IEnumerable{NuGet.Frameworks.NuGetFramework})">
<summary>
Returns the nearest matching framework that is compatible.
</summary>
<param name="framework">Project target framework</param>
<param name="possibleFrameworks">Possible frameworks to narrow down</param>
<returns>Nearest compatible framework. If no frameworks are compatible null is returned.</returns>
</member>
<member name="M:NuGet.Frameworks.FrameworkReducer.ReduceEquivalent(System.Collections.Generic.IEnumerable{NuGet.Frameworks.NuGetFramework})">
<summary>
Remove duplicates found in the equivalence mappings.
</summary>
</member>
<member name="M:NuGet.Frameworks.FrameworkReducer.ReduceUpwards(System.Collections.Generic.IEnumerable{NuGet.Frameworks.NuGetFramework})">
<summary>
Reduce to the highest framework
Ex: net45, net403, net40 -> net45
</summary>
</member>
<member name="M:NuGet.Frameworks.FrameworkReducer.ReduceDownwards(System.Collections.Generic.IEnumerable{NuGet.Frameworks.NuGetFramework})">
<summary>
Reduce to the lowest framework
Ex: net45, net403, net40 -> net40
</summary>
</member>
<member name="M:NuGet.Frameworks.FrameworkReducer.ExplodePortableFrameworks(System.Collections.Generic.IEnumerable{NuGet.Frameworks.NuGetFramework})">
<summary>
Create lookup of the given PCLs to their actual frameworks
</summary>
</member>
<member name="M:NuGet.Frameworks.FrameworkReducer.ExplodePortableFramework(NuGet.Frameworks.NuGetFramework,System.Boolean)">
<summary>
portable-net45+win8 -> net45, win8
</summary>
</member>
<member name="M:NuGet.Frameworks.FrameworkReducer.GetBestPCL(System.Collections.Generic.IEnumerable{NuGet.Frameworks.NuGetFramework})">
<summary>
Order PCLs when there is no other way to decide.
</summary>
</member>
<member name="M:NuGet.Frameworks.FrameworkReducer.IsBetterPCL(NuGet.Frameworks.NuGetFramework,NuGet.Frameworks.NuGetFramework)">
<summary>
Sort PCLs using these criteria
1. Lowest number of frameworks (highest surface area) wins first
2. Profile with the highest version numbers wins next
3. String compare is used as a last resort
</summary>
</member>
<member name="T:NuGet.Frameworks.FrameworkSpecificMapping">
<summary>
A keyvalue pair specific to a framework identifier
</summary>
</member>
<member name="T:NuGet.Frameworks.NuGetFramework">
<summary>
A portable implementation of the .NET FrameworkName type with added support for NuGet folder names.
</summary>
</member>
<member name="M:NuGet.Frameworks.NuGetFramework.#ctor(System.String,System.Version,System.String)">
<summary>
Creates a new NuGetFramework instance, with an optional profile (only available for netframework)
</summary>
</member>
<member name="M:NuGet.Frameworks.NuGetFramework.#ctor(System.String,System.Version,System.String,System.Version)">
<summary>
Creates a new NuGetFramework instance, with an optional platform and platformVersion (only available for net5.0+)
</summary>
</member>
<member name="P:NuGet.Frameworks.NuGetFramework.Framework">
<summary>
Target framework
</summary>
</member>
<member name="P:NuGet.Frameworks.NuGetFramework.Version">
<summary>
Target framework version
</summary>
</member>
<member name="P:NuGet.Frameworks.NuGetFramework.Platform">
<summary>
Framework Platform (net5.0+)
</summary>
</member>
<member name="P:NuGet.Frameworks.NuGetFramework.PlatformVersion">
<summary>
Framework Platform Version (net5.0+)
</summary>
</member>
<member name="P:NuGet.Frameworks.NuGetFramework.HasPlatform">
<summary>
True if the platform is non-empty
</summary>
</member>
<member name="P:NuGet.Frameworks.NuGetFramework.HasProfile">
<summary>
True if the profile is non-empty
</summary>
</member>
<member name="P:NuGet.Frameworks.NuGetFramework.Profile">
<summary>
Target framework profile
</summary>
</member>
<member name="P:NuGet.Frameworks.NuGetFramework.DotNetFrameworkName">
<summary>The TargetFrameworkMoniker identifier of the current NuGetFramework.</summary>
<remarks>Formatted to a System.Versioning.FrameworkName</remarks>
</member>
<member name="M:NuGet.Frameworks.NuGetFramework.GetDotNetFrameworkName(NuGet.Frameworks.IFrameworkNameProvider)">
<summary>The TargetFrameworkMoniker identifier of the current NuGetFramework.</summary>
<remarks>Formatted to a System.Versioning.FrameworkName</remarks>
</member>
<member name="P:NuGet.Frameworks.NuGetFramework.DotNetPlatformName">
<summary>The TargetPlatformMoniker identifier of the current NuGetFramework.</summary>
<remarks>Similar to a System.Versioning.FrameworkName, but missing the v at the beginning of the version.</remarks>
</member>
<member name="M:NuGet.Frameworks.NuGetFramework.GetShortFolderName">
<summary>
Creates the shortened version of the framework using the default mappings.
Ex: net45
</summary>
</member>
<member name="M:NuGet.Frameworks.NuGetFramework.GetFrameworkIdentifier">
<summary>
Helper that is .NET 5 Era aware to replace identifier when appropriate
</summary>
</member>
<member name="M:NuGet.Frameworks.NuGetFramework.GetShortFolderName(NuGet.Frameworks.IFrameworkNameProvider)">
<summary>
Creates the shortened version of the framework using the given mappings.
</summary>
</member>
<member name="P:NuGet.Frameworks.NuGetFramework.IsPCL">
<summary>
Portable class library check
</summary>
</member>
<member name="P:NuGet.Frameworks.NuGetFramework.IsPackageBased">
<summary>
True if the framework is packages based.
Ex: dotnet, dnxcore, netcoreapp, netstandard, uap, netcore50
</summary>
</member>
<member name="P:NuGet.Frameworks.NuGetFramework.AllFrameworkVersions">
<summary>
True if this framework matches for all versions.
Ex: net
</summary>
</member>
<member name="P:NuGet.Frameworks.NuGetFramework.IsUnsupported">
<summary>
True if this framework was invalid or unknown. This framework is only compatible with Any and Agnostic.
</summary>
</member>
<member name="P:NuGet.Frameworks.NuGetFramework.IsAgnostic">
<summary>
True if this framework is non-specific. Always compatible.
</summary>
</member>
<member name="P:NuGet.Frameworks.NuGetFramework.IsAny">
<summary>
True if this is the any framework. Always compatible.
</summary>
</member>
<member name="P:NuGet.Frameworks.NuGetFramework.IsSpecificFramework">
<summary>
True if this framework is real and not one of the special identifiers.
</summary>
</member>
<member name="P:NuGet.Frameworks.NuGetFramework.IsNet5Era">
<summary>
True if this framework is Net5 or later, until we invent something new.
</summary>
</member>
<member name="F:NuGet.Frameworks.NuGetFramework.Comparer">
<summary>
Full framework comparison of the identifier, version, profile, platform, and platform version
</summary>
</member>
<member name="F:NuGet.Frameworks.NuGetFramework.FrameworkNameComparer">
<summary>
Framework name only comparison.
</summary>
</member>
<member name="F:NuGet.Frameworks.NuGetFramework.PackagesBased">
<summary>
Frameworks that are packages based across all versions.
</summary>
</member>
<member name="F:NuGet.Frameworks.NuGetFramework.UnsupportedFramework">
<summary>
An unknown or invalid framework
</summary>
</member>
<member name="F:NuGet.Frameworks.NuGetFramework.AgnosticFramework">
<summary>
A framework with no specific target framework. This can be used for content only packages.
</summary>
</member>
<member name="F:NuGet.Frameworks.NuGetFramework.AnyFramework">
<summary>
A wildcard matching all frameworks
</summary>
</member>
<member name="M:NuGet.Frameworks.NuGetFramework.Parse(System.String)">
<summary>
Creates a NuGetFramework from a folder name using the default mappings.
</summary>
</member>
<member name="M:NuGet.Frameworks.NuGetFramework.Parse(System.String,NuGet.Frameworks.IFrameworkNameProvider)">
<summary>
Creates a NuGetFramework from a folder name using the given mappings.
</summary>
</member>
<member name="M:NuGet.Frameworks.NuGetFramework.ParseComponents(System.String,System.String)">
<summary>
Creates a NuGetFramework from individual components
</summary>
</member>
<member name="M:NuGet.Frameworks.NuGetFramework.ParseComponents(System.String,System.String,NuGet.Frameworks.IFrameworkNameProvider)">
<summary>
Creates a NuGetFramework from individual components, using the given mappings.
This method may have individual component preference, as described in the remarks.
</summary>
<remarks>
Profiles and TargetPlatforms can't mix. As such the precedence order is profile over target platforms (TPI, TPV).
.NETCoreApp,Version=v5.0 and later do not support profiles.
Target Platforms are ignored for any frameworks not supporting them.
This allows to handle the old project scenarios where the TargetPlatformIdentifier and TargetPlatformVersion may be set to Windows and v7.0 respectively.
</remarks>
</member>
<member name="M:NuGet.Frameworks.NuGetFramework.ParseFrameworkName(System.String,NuGet.Frameworks.IFrameworkNameProvider)">
<summary>
Creates a NuGetFramework from a .NET FrameworkName
</summary>
</member>
<member name="M:NuGet.Frameworks.NuGetFramework.ParseFolder(System.String)">
<summary>
Creates a NuGetFramework from a folder name using the default mappings.
</summary>
</member>
<member name="M:NuGet.Frameworks.NuGetFramework.ParseFolder(System.String,NuGet.Frameworks.IFrameworkNameProvider)">
<summary>
Creates a NuGetFramework from a folder name using the given mappings.
</summary>
</member>
<member name="M:NuGet.Frameworks.NuGetFramework.TryParseDeprecatedFramework(System.String,NuGet.Frameworks.NuGetFramework@)">
<summary>
Attempt to parse a common but deprecated framework using an exact string match
Support for these should be dropped as soon as possible.
</summary>
</member>
<member name="M:NuGet.Frameworks.NuGetFramework.TryParseCommonFramework(System.String,NuGet.Frameworks.NuGetFramework@)">
<summary>
A set of special and common frameworks that can be returned from the list of constants without parsing
Using the interned frameworks here optimizes comparisons since they can be checked by reference.
This is designed to optimize
</summary>
</member>
<member name="M:NuGet.Frameworks.NuGetFrameworkUtility.GetNearest``1(System.Collections.Generic.IEnumerable{``0},NuGet.Frameworks.NuGetFramework,System.Func{``0,NuGet.Frameworks.NuGetFramework})">
<summary>
Find the most compatible group based on target framework
</summary>
<param name="items">framework specific groups or items</param>
<param name="framework">project target framework</param>
<param name="selector">retrieves the framework from the group</param>
</member>
<member name="M:NuGet.Frameworks.NuGetFrameworkUtility.GetNearest``1(System.Collections.Generic.IEnumerable{``0},NuGet.Frameworks.NuGetFramework,NuGet.Frameworks.IFrameworkNameProvider,NuGet.Frameworks.IFrameworkCompatibilityProvider,System.Func{``0,NuGet.Frameworks.NuGetFramework})">
<summary>
Find the most compatible group based on target framework
</summary>
<param name="items">framework specific groups or items</param>
<param name="framework">project target framework</param>
<param name="selector">retrieves the framework from the group</param>
<param name="frameworkMappings">framework mappings</param>
</member>
<member name="M:NuGet.Frameworks.NuGetFrameworkUtility.GetNearest``1(System.Collections.Generic.IEnumerable{``0},NuGet.Frameworks.NuGetFramework)">
<summary>
Find the most compatible group based on target framework
</summary>
<param name="items">framework specific groups or items</param>
<param name="framework">project target framework</param>
</member>
<member name="M:NuGet.Frameworks.NuGetFrameworkUtility.GetNearest``1(System.Collections.Generic.IEnumerable{``0},NuGet.Frameworks.NuGetFramework,NuGet.Frameworks.IFrameworkNameProvider,NuGet.Frameworks.IFrameworkCompatibilityProvider)">
<summary>
Find the most compatible group based on target framework
</summary>
<param name="items">framework specific groups or items</param>
<param name="framework">project target framework</param>
</member>
<member name="M:NuGet.Frameworks.NuGetFrameworkUtility.IsCompatibleWithFallbackCheck(NuGet.Frameworks.NuGetFramework,NuGet.Frameworks.NuGetFramework)">
<summary>
Check compatibility with additional checks for the fallback framework.
</summary>
</member>
<member name="M:NuGet.Frameworks.NuGetFrameworkUtility.IsNetCore50AndUp(NuGet.Frameworks.NuGetFramework)">
<summary>
True if the framework is netcore50 or higher. This is where the framework
becomes packages based.
</summary>
</member>
<member name="M:NuGet.Frameworks.OneWayCompatibilityMappingEntry.#ctor(NuGet.Frameworks.FrameworkRange,NuGet.Frameworks.FrameworkRange)">
<summary>
Creates a one way compatibility mapping.
Ex: net -supports-> native
</summary>
<param name="targetFramework">Project framework</param>
<param name="supportedFramework">Framework that is supported by the project framework</param>
</member>
<member name="P:NuGet.Frameworks.OneWayCompatibilityMappingEntry.TargetFrameworkRange">
<summary>
Primary framework range or project target framework that supports the SuppportedFrameworkRange
</summary>
</member>
<member name="P:NuGet.Frameworks.OneWayCompatibilityMappingEntry.SupportedFrameworkRange">
<summary>
Framework range that is supported by the TargetFrameworkRange
</summary>
</member>
<member name="T:NuGet.Frameworks.Strings">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:NuGet.Frameworks.Strings.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:NuGet.Frameworks.Strings.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:NuGet.Frameworks.Strings.ArgumentCannotBeNullOrEmpty">
<summary>
Looks up a localized string similar to The argument cannot be null or empty..
</summary>
</member>
<member name="P:NuGet.Frameworks.Strings.FrameworkDoesNotSupportProfiles">
<summary>
Looks up a localized string similar to .NET 5.0 and above does not support profiles..
</summary>
</member>
<member name="P:NuGet.Frameworks.Strings.FrameworkMismatch">
<summary>
Looks up a localized string similar to Frameworks must have the same identifier, profile, and platform..
</summary>
</member>
<member name="P:NuGet.Frameworks.Strings.InvalidFrameworkIdentifier">
<summary>
Looks up a localized string similar to Invalid framework identifier '{0}'..
</summary>
</member>
<member name="P:NuGet.Frameworks.Strings.InvalidFrameworkVersion">
<summary>
Looks up a localized string similar to Invalid framework version '{0}'..
</summary>
</member>
<member name="P:NuGet.Frameworks.Strings.InvalidPlatformVersion">
<summary>
Looks up a localized string similar to Invalid platform version '{0}'..
</summary>
</member>
<member name="P:NuGet.Frameworks.Strings.InvalidPortableFrameworksDueToHyphen">
<summary>
Looks up a localized string similar to Invalid portable frameworks '{0}'. A hyphen may not be in any of the portable framework names..
</summary>
</member>
<member name="P:NuGet.Frameworks.Strings.MissingPortableFrameworks">
<summary>
Looks up a localized string similar to Invalid portable frameworks for '{0}'. A portable framework must have at least one framework in the profile..
</summary>
</member>
<member name="M:NuGet.Shared.EqualityUtility.OrderedEquals``2(System.Collections.Generic.IEnumerable{``0},System.Collections.Generic.IEnumerable{``0},System.Func{``0,``1},System.Collections.Generic.IComparer{``1},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Compares two enumerables for equality, ordered according to the specified key and optional comparer. Handles null values gracefully.
</summary>
<typeparam name="TSource">The type of the list</typeparam>
<typeparam name="TKey">The type of the sorting key</typeparam>
<param name="self">This list</param>
<param name="other">The other list</param>
<param name="keySelector">The function to extract the key from each item in the list</param>
<param name="orderComparer">An optional comparer for comparing keys</param>
<param name="sequenceComparer">An optional comparer for sequences</param>
</member>
<member name="M:NuGet.Shared.EqualityUtility.OrderedEquals``2(System.Collections.Generic.ICollection{``0},System.Collections.Generic.ICollection{``0},System.Func{``0,``1},System.Collections.Generic.IComparer{``1},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Compares two collections for equality, ordered according to the specified key and optional comparer. Handles null values gracefully.
</summary>
<typeparam name="TSource">The type of the list</typeparam>
<typeparam name="TKey">The type of the sorting key</typeparam>
<param name="self">This list</param>
<param name="other">The other list</param>
<param name="keySelector">The function to extract the key from each item in the list</param>
<param name="orderComparer">An optional comparer for comparing keys</param>
<param name="sequenceComparer">An optional comparer for sequences</param>
</member>
<member name="M:NuGet.Shared.EqualityUtility.OrderedEquals``2(System.Collections.Generic.IList{``0},System.Collections.Generic.IList{``0},System.Func{``0,``1},System.Collections.Generic.IComparer{``1},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Compares two lists for equality, ordered according to the specified key and optional comparer. Handles null values gracefully.
</summary>
<typeparam name="TSource">The type of the list</typeparam>
<typeparam name="TKey">The type of the sorting key</typeparam>
<param name="self">This list</param>
<param name="other">The other list</param>
<param name="keySelector">The function to extract the key from each item in the list</param>
<param name="orderComparer">An optional comparer for comparing keys</param>
<param name="sequenceComparer">An optional comparer for sequences</param>
</member>
<member name="M:NuGet.Shared.EqualityUtility.SequenceEqualWithNullCheck``1(System.Collections.Generic.IEnumerable{``0},System.Collections.Generic.IEnumerable{``0},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Compares two sequence for equality, allowing either sequence to be null. If one is null, both have to be
null for equality.
</summary>
</member>
<member name="M:NuGet.Shared.EqualityUtility.SequenceEqualWithNullCheck``1(System.Collections.Generic.ICollection{``0},System.Collections.Generic.ICollection{``0},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Compares two collections for equality, allowing either collection to be null. If one is null, both have to be
null for equality.
</summary>
</member>
<member name="M:NuGet.Shared.EqualityUtility.SequenceEqualWithNullCheck``1(System.Collections.Generic.IList{``0},System.Collections.Generic.IList{``0},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Compares two lists for equality, allowing either list to be null. If one is null, both have to be
null for equality.
</summary>
</member>
<member name="M:NuGet.Shared.EqualityUtility.SetEqualsWithNullCheck``1(System.Collections.Generic.ISet{``0},System.Collections.Generic.ISet{``0},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Compares two sets for equality, allowing either sequence to be null.
If one is null, both have to be null for equality.
</summary>
</member>
<member name="M:NuGet.Shared.EqualityUtility.EqualsFalse(System.String)">
<summary>
Determines if the current string contains a value equal "false". Leading and trailing whitespace are trimmed and the comparision is case-insensitive
</summary>
<param name="value">The string to compare.</param>
<returns><c>true</c> if the current string is equal to a value of "false", otherwise <c>false></c>.</returns>
</member>
<member name="T:NuGet.Shared.HashCodeCombiner">
<summary>
Hash code creator, based on the original NuGet hash code combiner/ASP hash code combiner implementations
</summary>
</member>
<member name="M:NuGet.Shared.HashCodeCombiner.GetHashCode``2(``0,``1)">
<summary>
Create a unique hash code for the given set of items
</summary>
</member>
<member name="M:NuGet.Shared.HashCodeCombiner.GetHashCode``3(``0,``1,``2)">
<summary>
Create a unique hash code for the given set of items
</summary>
</member>
<member name="M:NuGet.Shared.Extensions.AsList``1(System.Collections.Generic.IEnumerable{``0})">
<summary>
Return the enumerable as a List of T, copying if required. Optimized for common case where it is an List of T.
Avoid mutating the return value.
</summary>
<remarks>https://aspnetwebstack.codeplex.com/SourceControl/latest#src/Common/CollectionExtensions.cs</remarks>
</member>
<member name="M:NuGet.Shared.Extensions.AsHashSet``1(System.Collections.Generic.ISet{``0},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Return the ISet as a HashSet of T, copying if required. Optimized for common case where it is a HashSet of T.
Avoid mutating the return value.
</summary>
</member>
<member name="M:NuGet.Shared.XmlUtility.Load(System.String)">
<summary>
Creates a new <see cref="T:System.Xml.Linq.XDocument" /> from a file.
</summary>
<param name="path">The complete file path to be read into a new <see cref="T:System.Xml.Linq.XDocument" />.</param>
<returns>An <see cref="T:System.Xml.Linq.XDocument" /> that contains the contents of the specified file.</returns>
</member>
<member name="M:NuGet.Shared.XmlUtility.Load(System.String,System.Xml.Linq.LoadOptions)">
<summary>
Creates a new <see cref="T:System.Xml.Linq.XDocument" /> from a file. Optionally, whitespace can be preserved.
</summary>
<param name="path">The complete file path to be read into a new <see cref="T:System.Xml.Linq.XDocument" />.</param>
<param name="options">A set of <see cref="T:System.Xml.Linq.LoadOptions" />.</param>
<returns>An <see cref="T:System.Xml.Linq.XDocument" /> that contains the contents of the specified file.</returns>
</member>
<member name="M:NuGet.Shared.XmlUtility.Load(System.IO.Stream)">
<summary>
Creates a new <see cref="T:System.Xml.Linq.XDocument" /> from a stream.
</summary>
<param name="input">The stream that contains the XML data.</param>
<returns>An <see cref="T:System.Xml.Linq.XDocument" /> that contains the contents of the specified stream.</returns>
</member>
<member name="M:NuGet.Shared.XmlUtility.Load(System.IO.Stream,System.Xml.Linq.LoadOptions)">
<summary>
Creates a new System.Xml.Linq.XDocument from a stream. Optionally, whitespace can be preserved.
</summary>
<param name="input">The stream that contains the XML data.</param>
<param name="options">A set of <see cref="T:System.Xml.Linq.LoadOptions" />.</param>
<returns>An <see cref="T:System.Xml.Linq.XDocument" /> that contains the contents of the specified stream.</returns>
</member>
<member name="M:NuGet.Shared.XmlUtility.GetEncodedXMLName(System.String)">
<summary>
Converts the name to a valid XML local name, if it is invalid.
</summary>
<param name="name">The name to be encoded.</param>
<returns>The encoded name.</returns>
</member>
<member name="M:NuGet.Shared.XmlUtility.GetXmlReaderSettings(System.Xml.Linq.LoadOptions)">
<summary>
Creates an instance of <see cref="T:System.Xml.XmlReaderSettings" /> with safe settings
<param name="options">A set of <see cref="T:System.Xml.Linq.LoadOptions" />.</param>
</summary>
</member>
<member name="T:NuGet.StringBuilderPool">
<summary>
Provides a resource pool that enables reusing instances of <see cref="T:System.Text.StringBuilder" /> instances.
</summary>
<remarks>
<para>
Renting and returning buffers with an <see cref="T:NuGet.StringBuilderPool" /> can increase performance
in situations where <see cref="T:System.Text.StringBuilder" /> instances are created and destroyed frequently,
resulting in significant memory pressure on the garbage collector.
</para>
<para>
This class is thread-safe. All members may be used by multiple threads concurrently.
</para>
</remarks>
</member>
<member name="F:NuGet.StringBuilderPool.Shared">
<summary>
Retrieves a shared <see cref="T:NuGet.StringBuilderPool" /> instance.
</summary>
</member>
<member name="M:NuGet.StringBuilderPool.Rent(System.Int32)">
<summary>
Retrieves a <see cref="T:System.Text.StringBuilder" /> that is at least the requested length.
</summary>
<param name="minimumCapacity">The minimum capacity of the <see cref="T:System.Text.StringBuilder" /> needed.</param>
<returns>
A <see cref="T:System.Text.StringBuilder" /> that is at least <paramref name="minimumCapacity" /> in length.
</returns>
<remarks>
This buffer is loaned to the caller and should be returned to the same pool via
<see cref="M:NuGet.StringBuilderPool.Return(System.Text.StringBuilder)" /> so that it may be reused in subsequent usage of <see cref="M:NuGet.StringBuilderPool.Rent(System.Int32)" />.
It is not a fatal error to not return a rented string builder, but failure to do so may lead to
decreased application performance, as the pool may need to create a new instance to replace
the one lost.
</remarks>
</member>
<member name="M:NuGet.StringBuilderPool.Return(System.Text.StringBuilder)">
<summary>
Returns to the pool an array that was previously obtained via <see cref="M:NuGet.StringBuilderPool.Rent(System.Int32)" /> on the same
<see cref="T:NuGet.StringBuilderPool" /> instance.
</summary>
<param name="builder">
The <see cref="T:System.Text.StringBuilder" /> previously obtained from <see cref="M:NuGet.StringBuilderPool.Rent(System.Int32)" /> to return to the pool.
</param>
<remarks>
Once a <see cref="T:System.Text.StringBuilder" /> has been returned to the pool, the caller gives up all ownership
of the instance and must not use it. The reference returned from a given call to <see cref="M:NuGet.StringBuilderPool.Rent(System.Int32)" />
must only be returned via <see cref="M:NuGet.StringBuilderPool.Return(System.Text.StringBuilder)" /> once. The default <see cref="T:NuGet.StringBuilderPool" />
may hold onto the returned instance in order to rent it again, or it may release the returned instance
if it's determined that the pool already has enough instances stored.
</remarks>
</member>
</members>
<Signature xmlns="http://www.w3.org/2000/09/xmldsig#"><SignedInfo><CanonicalizationMethod Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315" /><SignatureMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#rsa-sha256" /><Reference URI=""><Transforms><Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature" /><Transform Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315" /></Transforms><DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256" /><DigestValue>a6dJFToTwbKcv5gx1BjiV5zlP931/0CbwbTwYJAZsbg=</DigestValue></Reference></SignedInfo><SignatureValue>SF4fHI5Wdqr3H4un6SVedXNMuW+1bYoALsd4UWOQU4HM9wIHd2z5YwP/jsM2FWfRcryaq5VROFuhS9iR0Rwcx4HRZ/9yAoyT08KqWJamiObkv6bvm/62O6T5fGUeUHtbb+pid3fQbAZrqVmLqPROrxIpp8/8dCnyFXoB5Lq/TOH2/NMCHWqdVlxB+lQ+GhA+HTb6fgIJ+Sbu3CfoUrlE5gMEz9S+nsU7peKdr5F5dOaAXrNRDzYZlEnAx9RSoXZC1xkST01rgfoLsPbmPHgzkViTWp5W8MNZYsDcbNXMEmsqH/Xiw5uenQzbBRmohygy6YLZEybUbf5LaYyNOq1PHA==</SignatureValue><KeyInfo><KeyValue><RSAKeyValue><Modulus>ok2x7OvGwA7zbnfezc3HT9M4dJka+FaQ7+vCqG40Bcm1QLlYIiDX/Whts0LVijaOvtl9iMeuShnAV7mchItKAVAABpyHuTuav2NCI9FsA8jFmlWndk3uK9RInNx1h1H4ojYxdBExyoN6muwwslKsLEfauUml7h5WAsDPpufTZd4yp2Jyiy384Zdd8CJlfQxfDe+gDZEciugWKHPSOoRxdjAk0GFm0OH14MyoYM4+M3mm1oH7vmSQohS5KIL3NEVW9Mdw7csTG5f93uORLvrJ/8ehFcGyWVb7UGHJnRhdcgGIbfiZzZlsAMS/DIBzM8RHKGNUNSbbLYmN/rt7pRjL4Q==</Modulus><Exponent>AQAB</Exponent></RSAKeyValue></KeyValue><X509Data><X509Certificate>MIIF/zCCA+egAwIBAgITMwAAAsyOtZamvdHJTgAAAAACzDANBgkqhkiG9w0BAQsFADB+MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSgwJgYDVQQDEx9NaWNyb3NvZnQgQ29kZSBTaWduaW5nIFBDQSAyMDExMB4XDTIyMDUxMjIwNDYwMVoXDTIzMDUxMTIwNDYwMVowdDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEeMBwGA1UEAxMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAok2x7OvGwA7zbnfezc3HT9M4dJka+FaQ7+vCqG40Bcm1QLlYIiDX/Whts0LVijaOvtl9iMeuShnAV7mchItKAVAABpyHuTuav2NCI9FsA8jFmlWndk3uK9RInNx1h1H4ojYxdBExyoN6muwwslKsLEfauUml7h5WAsDPpufTZd4yp2Jyiy384Zdd8CJlfQxfDe+gDZEciugWKHPSOoRxdjAk0GFm0OH14MyoYM4+M3mm1oH7vmSQohS5KIL3NEVW9Mdw7csTG5f93uORLvrJ/8ehFcGyWVb7UGHJnRhdcgGIbfiZzZlsAMS/DIBzM8RHKGNUNSbbLYmN/rt7pRjL4QIDAQABo4IBfjCCAXowHwYDVR0lBBgwFgYKKwYBBAGCN0wIAQYIKwYBBQUHAwMwHQYDVR0OBBYEFIi4R40ylsyKlSKfrDNqzhx9da30MFAGA1UdEQRJMEekRTBDMSkwJwYDVQQLEyBNaWNyb3NvZnQgT3BlcmF0aW9ucyBQdWVydG8gUmljbzEWMBQGA1UEBRMNMjMwMDEyKzQ3MDUyOTAfBgNVHSMEGDAWgBRIbmTlUAXTgqoXNzcitW2oynUClTBUBgNVHR8ETTBLMEmgR6BFhkNodHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20vcGtpb3BzL2NybC9NaWNDb2RTaWdQQ0EyMDExXzIwMTEtMDctMDguY3JsMGEGCCsGAQUFBwEBBFUwUzBRBggrBgEFBQcwAoZFaHR0cDovL3d3dy5taWNyb3NvZnQuY29tL3BraW9wcy9jZXJ0cy9NaWNDb2RTaWdQQ0EyMDExXzIwMTEtMDctMDguY3J0MAwGA1UdEwEB/wQCMAAwDQYJKoZIhvcNAQELBQADggIBAHgPA7DgB0udzEyB2LvG216zuskLUQ+iX8jFnl2i7tzXPDw5xXNXn2KvxdzBsf2osDW3LCdjFOwSjVkz+SUFQQNhjSHkd5knF6pzrL9V6lz72XiEg1Vi2gUM3HiLXSMIKOgdd78ZZJEmDLwdA692MO/1vVOFpOSv0QzpyBr5iqiotwMMsZVdZqXn8u9vRSmlk+3nQXdyOPoZXTGPLHXwz41kbSc4zI12bONTlDsLR3HD2s44wuyp3c72R8f9FVi/J9DU/+NOL37Z1yonzGZEuKdrAd6CvupAnLMlrIEv93mBsNRXuDDp4p9UYYK1taxzzgyUxgFDpluMHN0Oiiq9s73u7DA2XvbX8paJz8IZPe9a1/KhsOi5Kxhb99SCXiUnv2lGxnVAz5G6wAW1bzxJYKI+Xj90RKseY3X5EMO7TnVpIZ9Iw1IdrkHp/QLY90ZCch7kdBlLCVTFhSXZCDv4BcM6DhpRzbJsb6QDVfOv9aoG9aGV3a1EacyaedzLA2gWP6cTnCdAr4OrlrN5EFoCpOWgc77F/eQc3SLR06VTLVT1uKuNVxL2xZlD9Z+qC+a3TXa0zI/x1zEZNSgpLGsdVcaN6r/td3ArGQGkDWiAL7eS75LIWZA2SD//9B56uzZ1nmEd8+KBYsPTdp922/W2kFrlj7MBtA6vWE/ZG/grOKiC</X509Certificate><X509Certificate>MIIHejCCBWKgAwIBAgIKYQ6Q0gAAAAAAAzANBgkqhkiG9w0BAQsFADCBiDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEyMDAGA1UEAxMpTWljcm9zb2Z0IFJvb3QgQ2VydGlmaWNhdGUgQXV0aG9yaXR5IDIwMTEwHhcNMTEwNzA4MjA1OTA5WhcNMjYwNzA4MjEwOTA5WjB+MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSgwJgYDVQQDEx9NaWNyb3NvZnQgQ29kZSBTaWduaW5nIFBDQSAyMDExMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAq/D6chAcLq3YbqqCEE00uvK2WCGfQhsqa+laUKq4BjgaBEm6f8MMHt03a8YS2AvwOMKZBrDIOdUBFDFC04kNeWSHfpRgJGyvnkmc6Whe0t+bU7IKLMOv2akrrnoJr9eWWcpgGgXpZnboMlImEi/nqwhQz7NEt13YxC4Ddato88tt8zpcoRb0RrrgOGSsbmQ1eKagYw8t00CT+OPeBw3VXHmlSSnnDb6gE3e+lD3v++MrWhAfTVYoonpy4BI6t0le2O3tQ5GD2Xuye4Yb2T6xjF3oiU+EGvKhL1nkkDstrjNYxbc+/jLTswM9sbKvkjh+0p2ALPVOVpEhNSXDOW5kf1O6nA+tGSOEy/S6A4aN91/w0FK/jJSHvMAhdCVfGCi2zCcoOCWYOUo2z3yxkq4cI6epZuxhH2rhKEmdX4jiJV3TIUs+UsS1Vz8kA/DRelsv1SPjcF0PUUZ3s/gA4bysAoJf28AVs70b1FVL5zmhD+kjSbwYuER8ReTBw3J64HLnJN+/RpnF78IcV9uDjexNSTCnq47f7Fufr/zdsGbiwZeBe+3W7UvnSSmnEyimp31ngOaKYnhfsi+E11ecXL93KCjx7W3DKI8sj0A3T8HhhUSJxAlMxdSlQy90lfdu+HggWCwTXWCVmj5PM4TasIgX3p5O9JawvEagbJjS4NaIjAsCAwEAAaOCAe0wggHpMBAGCSsGAQQBgjcVAQQDAgEAMB0GA1UdDgQWBBRIbmTlUAXTgqoXNzcitW2oynUClTAZBgkrBgEEAYI3FAIEDB4KAFMAdQBiAEMAQTALBgNVHQ8EBAMCAYYwDwYDVR0TAQH/BAUwAwEB/zAfBgNVHSMEGDAWgBRyLToCMZBDuRQFTuHqp8cx0SOJNDBaBgNVHR8EUzBRME+gTaBLhklodHRwOi8vY3JsLm1pY3Jvc29mdC5jb20vcGtpL2NybC9wcm9kdWN0cy9NaWNSb29DZXJBdXQyMDExXzIwMTFfMDNfMjIuY3JsMF4GCCsGAQUFBwEBBFIwUDBOBggrBgEFBQcwAoZCaHR0cDovL3d3dy5taWNyb3NvZnQuY29tL3BraS9jZXJ0cy9NaWNSb29DZXJBdXQyMDExXzIwMTFfMDNfMjIuY3J0MIGfBgNVHSAEgZcwgZQwgZEGCSsGAQQBgjcuAzCBgzA/BggrBgEFBQcCARYzaHR0cDovL3d3dy5taWNyb3NvZnQuY29tL3BraW9wcy9kb2NzL3ByaW1hcnljcHMuaHRtMEAGCCsGAQUFBwICMDQeMiAdAEwAZQBnAGEAbABfAHAAbwBsAGkAYwB5AF8AcwB0AGEAdABlAG0AZQBuAHQALiAdMA0GCSqGSIb3DQEBCwUAA4ICAQBn8oalmOBUeRou09h0ZyKbC5YR4WOSmUKWfdJ5DJDBZV8uLD74w3LRbYP+vj/oCso7v0epo/Np22O/IjWll11lhJB9i0ZQVdgMknzSGksc8zxCi1LQsP1r4z4HLimb5j0bpdS1HXeUOeLpZMlEPXh6I/MTfaaQdION9MsmAkYqwooQu6SpBQyb7Wj6aC6VoCo/KmtYSWMfCWluWpiW5IP0wI/zRive/DvQvTXvbiWu5a8n7dDd8w6vmSiXmE0OPQvyCInWH8MyGOLwxS3OW560STkKxgrCxq2u5bLZ2xWIUUVYODJxJxp/sfQn+N4sOiBpmLJZiWhub6e3dMNABQamASooPoI/E01mC8CzTfXhj38cbxV9Rad25UAqZaPDXVJihsMdYzaXht/a8/jyFqGaJ+HNpZfQ7l1jQeNbB5yHPgZ3BtEGsXUfFL5hYbXw3MYbBL7fQccOKO7eZS/sl/ahXJbYANahRr1Z85elCUtIEJmAH9AAKcWxm6U/RXceNcbSoqKfenoi+kiVH6v7RyOA9Z74v2u3S5fi63V4GuzqN5l5GEv/1rMjaHXmr/r8i+sLgOppO6/8MO0ETI7f33VtY5E90Z1WTk+/gFcioXgRMiF670EKsT/7qMykXcGhiJtXcVZOSEXAQsmbdlsKgEhr/Xmfwb1tbWrJUnMTDXpQzQ==</X509Certificate><X509Certificate>MIIF7TCCA9WgAwIBAgIQP4vItfyfspZDtWnWbELhRDANBgkqhkiG9w0BAQsFADCBiDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEyMDAGA1UEAxMpTWljcm9zb2Z0IFJvb3QgQ2VydGlmaWNhdGUgQXV0aG9yaXR5IDIwMTEwHhcNMTEwMzIyMjIwNTI4WhcNMzYwMzIyMjIxMzA0WjCBiDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEyMDAGA1UEAxMpTWljcm9zb2Z0IFJvb3QgQ2VydGlmaWNhdGUgQXV0aG9yaXR5IDIwMTEwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQCygEGqNThNE3IyaCJNuLLx/9VSvGzH9dJKjDbu0cJcfoyKrq8TKG/Ac+M6ztAlqFo6be+ouFmrEyNozQwph9FvgFyPRH9dkAFSWKxRxV8qh9zc2AodwQO5e7BW6KPeZGHCnvjzfLnsDbVU/ky2ZU+I8JxImQxCCwl8MVkXeQZ4KI2JOkwDJb5xalwL54RgpJki49KvhKSn+9GY7Qyp3pSJ4Q6g3MDOmT3qCFK7VnnkH4S6Hri0xElcTzFLh93dBWcmmYDgcRGjuKVB4qRTufcyKYMME782XgSzS0NHL2vikR7TmE/dQgfI6B0S/Jmpaz6SfsjWaTr8ZL22CZ3K/QwLopt3YEsDlKQwaRLWQi3BQUzK3Kr9j1uDRprZ/LHR47PJf0h6zSTwQY9cdNCssBAgBkm3xy0hyFfj0IbzA2j70M5xwYmZSmQBbP3sMJHPQTySx+W6hh1hhMdfgzlirrSSL0fzC/hV66AfWdC7dJse0Hbm8ukG1xDo+mTeacY1logC8Ea4PyeZb8txiSk190gWAjWP1Xl8TQLPX+uKg09FcYj5qQ1OcunCnAfPSRtOBA5jUYxe2ADBVSy2xuDCZU7JNDn1nLPEfuhhbhNfFcRf2X7tHc7uROzLLoax7Dj2cO2rXBPB2Q8Nx4CyVe0096yb5MPa50c8prWPMd/FS6/r8QIDAQABo1EwTzALBgNVHQ8EBAMCAYYwDwYDVR0TAQH/BAUwAwEB/zAdBgNVHQ4EFgQUci06AjGQQ7kUBU7h6qfHMdEjiTQwEAYJKwYBBAGCNxUBBAMCAQAwDQYJKoZIhvcNAQELBQADggIBAH9yzw+3xRXbm8BJyiZb/p4T5tPw0tuXX/JLP02zrhmu7deXoKzvqTqjwkGw5biRnhOBJAPmCf0/V0A5ISRW0RAvS0CpNoZLtFNXmvvxfomPEf4YbFGq6O0JlbXlccmh6Yd1phV/yX43VF50k8XDZ8wNT2uoFwxtCJJ+i92Bqi1wIcM9BhS7vyRep4TXPw8hIr1LAAbblxzYXtTFC1yHblCk6MM4pPvLLMWSZpuFXst6bJN8gClYW1e1QGm6CHmmZGIVnYeWRbVmIyADixxzoNOieTPgUFmG2y/lAiXqcyqfABTINseSO+lOAOzYVgm5M0kS0lQLAausR7aRKX1MtHWAUgHoyoL2n8ysnI8X6i8msKtyrAv+nlEex0NVZ09Rs1fWtuzuUrc66U7h14GIvE+OdbtLqPA1qibUZ2dJsnBMO5PcHd94kIZysjik0dySTclY6ysSXNQ7roxrsIPlAT/4CTL2kzU0Iq/dNw13CYArzUgA8YyZGUcFAenRv9FO0OYoQzeZpApKCNmacXPSqs0xE2N2oTdvkjgefRI8ZjLny23h/FKJ3crWZgWalmG+oijHHKOnNlA8OqTfSm7mhzvO6/DggTedEzxSjr25HTTGHdUKaj2YKXCMiSrRq4IQSB/c9O+lxbtVGjhjhE63bK2VVOxlIhBJF7jAHscPrFRH</X509Certificate></X509Data></KeyInfo><Object Id="ts-countersig"><X509Data><X509Certificate>MIIHEDCCBPigAwIBAgITMwAAAaqlMZsLy7IIDgABAAABqjANBgkqhkiG9w0BAQsFADB8MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSYwJAYDVQQDEx1NaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0EgMjAxMDAeFw0yMjAzMDIxODUxMjZaFw0yMzA1MTExODUxMjZaMIHOMQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSkwJwYDVQQLEyBNaWNyb3NvZnQgT3BlcmF0aW9ucyBQdWVydG8gUmljbzEmMCQGA1UECxMdVGhhbGVzIFRTUyBFU046Rjc3Ri1FMzU2LTVCQUUxJTAjBgNVBAMTHE1pY3Jvc29mdCBUaW1lLVN0YW1wIFNlcnZpY2UwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQCgT+xyudW1h3/hQ0ofTu2Mq0LZDTL3R8x4ms7znSPTzho8iSGK7NVjjJkgqd6P5r7Lj5xUj+XNHQngblKuruid9DPNWWjTj/2m2a08GK2DfjeZ0razhnQrUQbpu+ocu069wGQ1AKy8L4bBpV4S5Q1NcIqGsTPgVcAjSOy5k2mCqo5ufIRILGLSiB5OfS8zpyOGnp2zywT/1WGIyOmuCiHLp9BGRKwLpLeTwv5ilGjqYVDBmJtD8X6WPQZBubD33MxciHwNdyy0UuLBoW1K3DOeBLxNhZVgUGiaO36yluwlYyEyxF+BNpccEBvzLmftcA2IPTjhK0+Yfus3nI+u3np8MXlKGjhGyrYlMWiVGJ8kCsQlk5DXVkV0ykpiMcdLW7D+Yq1o6l70+rf83iSsNOTWPIT0+er1ttKtA2CtjbXjggw9FA+mTQBS1fOxjpJdHgal3E6BVXXicMDkxOmgOEamKDa9kFDwSFOiRIlBgbPXOKguZgR02OOlWkf6HWhQy3MUCODj5J+WpfyD7HfP62g5jHyopOusXDYdqjeMsrWDN7og3p1+anhXcd6XYuN6WABTf0tf91UTZPvxkVVFGFmAYw2UqsbJYnRPIbMQuyvKi35jaGkNmgLLtd4dX2kzEmSBFcaLM9W/ciHl5rTOjZa41d3rcEuyV2MBoRzHVWBC9QIDAQABo4IBNjCCATIwHQYDVR0OBBYEFD+aFLxThy7YX3dFs94RrZ0FRqSeMB8GA1UdIwQYMBaAFJ+nFV0AXmJdg/Tl0mWnG1M1GelyMF8GA1UdHwRYMFYwVKBSoFCGTmh0dHA6Ly93d3cubWljcm9zb2Z0LmNvbS9wa2lvcHMvY3JsL01pY3Jvc29mdCUyMFRpbWUtU3RhbXAlMjBQQ0ElMjAyMDEwKDEpLmNybDBsBggrBgEFBQcBAQRgMF4wXAYIKwYBBQUHMAKGUGh0dHA6Ly93d3cubWljcm9zb2Z0LmNvbS9wa2lvcHMvY2VydHMvTWljcm9zb2Z0JTIwVGltZS1TdGFtcCUyMFBDQSUyMDIwMTAoMSkuY3J0MAwGA1UdEwEB/wQCMAAwEwYDVR0lBAwwCgYIKwYBBQUHAwgwDQYJKoZIhvcNAQELBQADggIBAN8MgE2QRRAaIK3MB7OMyO6l9stI2ygiOmYnhgCEfekYjK42b1ht/WDwPxS9r4RkgrTu3mt4gZcIYU8iRD3sS7oE+IweFtK5XTiz+WxHNM8MbPTbUxUvFJds2ye48+VsUp4Uh7H2lRVKe0ugdmtW4ypliKP0r3d1tVd5nCGM4W6SyFFZT9wm0yRBPnAt4V/iYIJ0mERE8qPpiOx8/yjFhWkVgVGCOINAa8IldpWKisnpIzaeq4+2/JejoW4F/yT9G8zcb+oqNGOIjZSM8/z3SIfxNqY96Vz4kCT0ZRJDJLEXnBPFZxcqoUeH2/xenOcsGOPphKbISAINmFF7MBaqmyvRb/lPGGHJWD74Sv8EWbPv+WriuBTPkE48sI9Aua5q/DM4qplBoALsGUGMh0QqKZ1XZWjv8cUmQn2mUe8OwdzgRJfI/laKH7NSn6vQJpkAFmTo7eA5zZOTZ8U4T740FbjlP8vh0xK8Kg/8CkQpdACd1D0yfDz2Kfo2xF5CpqBYVOCRnq+Xmo9tp19fabozWSqqmq7eMi4zVDpKlo1ZOCh6XWERnCTFV5CpEAIpY1J/XB0cDbj8/07u2Jn4EV1jeB7wnE9ptUAA4pzmT7Dub+Y/2xMcNFpha1tgrQxAKZwpZogCnIRa9MUihORE/gMrmy2qXoxDa/b7e0Fzaumj9V1n</X509Certificate><X509Certificate>MIIHcTCCBVmgAwIBAgITMwAAABXF52ueAptJmQAAAAAAFTANBgkqhkiG9w0BAQsFADCBiDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEyMDAGA1UEAxMpTWljcm9zb2Z0IFJvb3QgQ2VydGlmaWNhdGUgQXV0aG9yaXR5IDIwMTAwHhcNMjEwOTMwMTgyMjI1WhcNMzAwOTMwMTgzMjI1WjB8MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSYwJAYDVQQDEx1NaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0EgMjAxMDCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAOThpkzntHIhC3miy9ckeb0O1YLT/e6cBwfSqWxOdcjKNVf2AX9sSuDivbk+F2Az/1xPx2b3lVNxWuJ+Slr+uDZnhUYjDLWNE893MsAQGOhgfWpSg0S3po5GawcU88V29YZQ3MFEyHFcUTE3oAo4bo3t1w/YJlN8OWECesSq/XJprx2rrPY2vjUmZNqYO7oaezOtgFt+jBAcnVL+tuhiJdxqD89d9P6OU8/W7IVWTe/dvI2k45GPsjksUZzpcGkNyjYtcI4xyDUoveO0hyTD4MmPfrVUj9z6BVWYbWg7mka97aSueik3rMvrg0XnRm7KMtXAhjBcTyziYrLNueKNiOSWrAFKu75xqRdbZ2De+JKRHh09/SDPc31BmkZ1zcRfNN0Sidb9pSB9fvzZnkXftnIv231fgLrbqn427DZM9ituqBJR6L8FA6PRc6ZNN3SUHDSCD/AQ8rdHGO2n6Jl8P0zbr17C89XYcz1DTsEzOUyOArxCaC4Q6oRRRuLRvWoYWmEBc8pnol7XKHYC4jMYctenIPDC+hIK12NvDMk2ZItboKaDIV1fMHSRlJTYuVD5C4lh8zYGNRiER9vcG9H9stQcxWv2XFJRXRLbJbqvUAV6bMURHXLvjflSxIUXk8A8FdsaN8cIFRg/eKtFtvUeh17aj54WcmnGrnu3tz5q4i6tAgMBAAGjggHdMIIB2TASBgkrBgEEAYI3FQEEBQIDAQABMCMGCSsGAQQBgjcVAgQWBBQqp1L+ZMSavoKRPEY1Kc8Q/y8E7jAdBgNVHQ4EFgQUn6cVXQBeYl2D9OXSZacbUzUZ6XIwXAYDVR0gBFUwUzBRBgwrBgEEAYI3TIN9AQEwQTA/BggrBgEFBQcCARYzaHR0cDovL3d3dy5taWNyb3NvZnQuY29tL3BraW9wcy9Eb2NzL1JlcG9zaXRvcnkuaHRtMBMGA1UdJQQMMAoGCCsGAQUFBwMIMBkGCSsGAQQBgjcUAgQMHgoAUwB1AGIAQwBBMAsGA1UdDwQEAwIBhjAPBgNVHRMBAf8EBTADAQH/MB8GA1UdIwQYMBaAFNX2VsuP6KJcYmjRPZSQW9fOmhjEMFYGA1UdHwRPME0wS6BJoEeGRWh0dHA6Ly9jcmwubWljcm9zb2Z0LmNvbS9wa2kvY3JsL3Byb2R1Y3RzL01pY1Jvb0NlckF1dF8yMDEwLTA2LTIzLmNybDBaBggrBgEFBQcBAQROMEwwSgYIKwYBBQUHMAKGPmh0dHA6Ly93d3cubWljcm9zb2Z0LmNvbS9wa2kvY2VydHMvTWljUm9vQ2VyQXV0XzIwMTAtMDYtMjMuY3J0MA0GCSqGSIb3DQEBCwUAA4ICAQCdVX38Kq3hLB9nATEkW+Geckv8qW/qXBS2Pk5HZHixBpOXPTEztTnXwnE2P9pkbHzQdTltuw8x5MKP+2zRoZQYIu7pZmc6U03dmLq2HnjYNi6cqYJWAAOwBb6J6Gngugnue99qb74py27YP0h1AdkY3m2CDPVtI1TkeFN1JFe53Z/zjj3G82jfZfakVqr3lbYoVSfQJL1AoL8ZthISEV09J+BAljis9/kpicO8F7BUhUKz/AyeixmJ5/ALaoHCgRlCGVJ1ijbCHcNhcy4sa3tuPywJeBTpkbKpW99Jo3QMvOyRgNI95ko+ZjtPu4b6MhrZlvSP9pEB9s7GdP32THJvEKt1MMU0sHrYUP4KWN1APMdUbZ1jdEgssU5HLcEUBHG/ZPkkvnNtyo4JvbMBV0lUZNlz138eW0QBjloZkWsNn6Qo3GcZKCS6OEuabvshVGtqRRFHqfG3rsjoiV5PndLQTHa1V1QJsWkBRH58oWFsc/4Ku+xBZj1p/cvBQUl+fpO+y/g75LcVv7TOPqUxUYS8vwLBgqJ7Fx0ViY1w/ue10CgaiQuPNtq6TPmb/wrpNPgkNWcr4A245oyZ1uEi6vAnQj0llOZ0dFtq0Z4+7X6gMTN9vMvpe784cETRkPHIqzqKOghif9lwY1NNje6CbaUFEMFxBmoQtB1VM1izoXBm8g==</X509Certificate></X509Data><CounterSignature ts-format="cms-timestamp-message" xmlns="http://schemas.microsoft.com/xmldsig/timestamp/2003">MIAGCSqGSIb3DQEHAqCAMIIW3gIBAzEPMA0GCWCGSAFlAwQCAQUAMIIBVQYLKoZIhvcNAQkQAQSgggFEBIIBQDCCATwCAQEGCisGAQQBhFkKAwEwMTANBglghkgBZQMEAgEFAAQgNYnv5sXC5UoNQFHffzBmoLBBxOMQ0deUpqSMTwd+2YYCBmMRVAkc6BgTMjAyMjA5MDkyMzE3NTUuMDg2WjAEgAIB9KCB1KSB0TCBzjELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEpMCcGA1UECxMgTWljcm9zb2Z0IE9wZXJhdGlvbnMgUHVlcnRvIFJpY28xJjAkBgNVBAsTHVRoYWxlcyBUU1MgRVNOOkY3N0YtRTM1Ni01QkFFMSUwIwYDVQQDExxNaWNyb3NvZnQgVGltZS1TdGFtcCBTZXJ2aWNloIIRXDCCBxAwggT4oAMCAQICEzMAAAGqpTGbC8uyCA4AAQAAAaowDQYJKoZIhvcNAQELBQAwfDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEmMCQGA1UEAxMdTWljcm9zb2Z0IFRpbWUtU3RhbXAgUENBIDIwMTAwHhcNMjIwMzAyMTg1MTI2WhcNMjMwNTExMTg1MTI2WjCBzjELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEpMCcGA1UECxMgTWljcm9zb2Z0IE9wZXJhdGlvbnMgUHVlcnRvIFJpY28xJjAkBgNVBAsTHVRoYWxlcyBUU1MgRVNOOkY3N0YtRTM1Ni01QkFFMSUwIwYDVQQDExxNaWNyb3NvZnQgVGltZS1TdGFtcCBTZXJ2aWNlMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAoE/scrnVtYd/4UNKH07tjKtC2Q0y90fMeJrO850j084aPIkhiuzVY4yZIKnej+a+y4+cVI/lzR0J4G5Srq7onfQzzVlo04/9ptmtPBitg343mdK2s4Z0K1EG6bvqHLtOvcBkNQCsvC+GwaVeEuUNTXCKhrEz4FXAI0jsuZNpgqqObnyESCxi0ogeTn0vM6cjhp6ds8sE/9VhiMjprgohy6fQRkSsC6S3k8L+YpRo6mFQwZibQ/F+lj0GQbmw99zMXIh8DXcstFLiwaFtStwzngS8TYWVYFBomjt+spbsJWMhMsRfgTaXHBAb8y5n7XANiD044StPmH7rN5yPrt56fDF5Sho4Rsq2JTFolRifJArEJZOQ11ZFdMpKYjHHS1uw/mKtaOpe9Pq3/N4krDTk1jyE9Pnq9bbSrQNgrY2144IMPRQPpk0AUtXzsY6SXR4GpdxOgVV14nDA5MTpoDhGpig2vZBQ8EhTokSJQYGz1zioLmYEdNjjpVpH+h1oUMtzFAjg4+SflqX8g+x3z+toOYx8qKTrrFw2Hao3jLK1gze6IN6dfmp4V3Hel2LjelgAU39LX/dVE2T78ZFVRRhZgGMNlKrGyWJ0TyGzELsryot+Y2hpDZoCy7XeHV9pMxJkgRXGizPVv3Ih5ea0zo2WuNXd63BLsldjAaEcx1VgQvUCAwEAAaOCATYwggEyMB0GA1UdDgQWBBQ/mhS8U4cu2F93RbPeEa2dBUaknjAfBgNVHSMEGDAWgBSfpxVdAF5iXYP05dJlpxtTNRnpcjBfBgNVHR8EWDBWMFSgUqBQhk5odHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20vcGtpb3BzL2NybC9NaWNyb3NvZnQlMjBUaW1lLVN0YW1wJTIwUENBJTIwMjAxMCgxKS5jcmwwbAYIKwYBBQUHAQEEYDBeMFwGCCsGAQUFBzAChlBodHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20vcGtpb3BzL2NlcnRzL01pY3Jvc29mdCUyMFRpbWUtU3RhbXAlMjBQQ0ElMjAyMDEwKDEpLmNydDAMBgNVHRMBAf8EAjAAMBMGA1UdJQQMMAoGCCsGAQUFBwMIMA0GCSqGSIb3DQEBCwUAA4ICAQDfDIBNkEUQGiCtzAezjMjupfbLSNsoIjpmJ4YAhH3pGIyuNm9Ybf1g8D8Uva+EZIK07t5reIGXCGFPIkQ97Eu6BPiMHhbSuV04s/lsRzTPDGz021MVLxSXbNsnuPPlbFKeFIex9pUVSntLoHZrVuMqZYij9K93dbVXeZwhjOFukshRWU/cJtMkQT5wLeFf4mCCdJhERPKj6YjsfP8oxYVpFYFRgjiDQGvCJXaViorJ6SM2nquPtvyXo6FuBf8k/RvM3G/qKjRjiI2UjPP890iH8TamPelc+JAk9GUSQySxF5wTxWcXKqFHh9v8XpznLBjj6YSmyEgCDZhRezAWqpsr0W/5TxhhyVg++Er/BFmz7/lq4rgUz5BOPLCPQLmuavwzOKqZQaAC7BlBjIdEKimdV2Vo7/HFJkJ9plHvDsHc4ESXyP5Wih+zUp+r0CaZABZk6O3gOc2Tk2fFOE++NBW45T/L4dMSvCoP/ApEKXQAndQ9Mnw89in6NsReQqagWFTgkZ6vl5qPbadfX2m6M1kqqpqu3jIuM1Q6SpaNWTgoel1hEZwkxVeQqRACKWNSf1wdHA24/P9O7tiZ+BFdY3ge8JxPabVAAOKc5k+w7m/mP9sTHDRaYWtbYK0MQCmcKWaIApyEWvTFIoTkRP4DK5stql6MQ2v2+3tBc2rpo/VdZzCCB3EwggVZoAMCAQICEzMAAAAVxedrngKbSZkAAAAAABUwDQYJKoZIhvcNAQELBQAwgYgxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpXYXNoaW5ndG9uMRAwDgYDVQQHEwdSZWRtb25kMR4wHAYDVQQKExVNaWNyb3NvZnQgQ29ycG9yYXRpb24xMjAwBgNVBAMTKU1pY3Jvc29mdCBSb290IENlcnRpZmljYXRlIEF1dGhvcml0eSAyMDEwMB4XDTIxMDkzMDE4MjIyNVoXDTMwMDkzMDE4MzIyNVowfDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEmMCQGA1UEAxMdTWljcm9zb2Z0IFRpbWUtU3RhbXAgUENBIDIwMTAwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQDk4aZM57RyIQt5osvXJHm9DtWC0/3unAcH0qlsTnXIyjVX9gF/bErg4r25PhdgM/9cT8dm95VTcVrifkpa/rg2Z4VGIwy1jRPPdzLAEBjoYH1qUoNEt6aORmsHFPPFdvWGUNzBRMhxXFExN6AKOG6N7dcP2CZTfDlhAnrEqv1yaa8dq6z2Nr41JmTamDu6GnszrYBbfowQHJ1S/rboYiXcag/PXfT+jlPP1uyFVk3v3byNpOORj7I5LFGc6XBpDco2LXCOMcg1KL3jtIckw+DJj361VI/c+gVVmG1oO5pGve2krnopN6zL64NF50ZuyjLVwIYwXE8s4mKyzbnijYjklqwBSru+cakXW2dg3viSkR4dPf0gz3N9QZpGdc3EXzTdEonW/aUgfX782Z5F37ZyL9t9X4C626p+Nuw2TPYrbqgSUei/BQOj0XOmTTd0lBw0gg/wEPK3Rxjtp+iZfD9M269ewvPV2HM9Q07BMzlMjgK8QmguEOqEUUbi0b1qGFphAXPKZ6Je1yh2AuIzGHLXpyDwwvoSCtdjbwzJNmSLW6CmgyFdXzB0kZSU2LlQ+QuJYfM2BjUYhEfb3BvR/bLUHMVr9lxSUV0S2yW6r1AFemzFER1y7435UsSFF5PAPBXbGjfHCBUYP3irRbb1Hode2o+eFnJpxq57t7c+auIurQIDAQABo4IB3TCCAdkwEgYJKwYBBAGCNxUBBAUCAwEAATAjBgkrBgEEAYI3FQIEFgQUKqdS/mTEmr6CkTxGNSnPEP8vBO4wHQYDVR0OBBYEFJ+nFV0AXmJdg/Tl0mWnG1M1GelyMFwGA1UdIARVMFMwUQYMKwYBBAGCN0yDfQEBMEEwPwYIKwYBBQUHAgEWM2h0dHA6Ly93d3cubWljcm9zb2Z0LmNvbS9wa2lvcHMvRG9jcy9SZXBvc2l0b3J5Lmh0bTATBgNVHSUEDDAKBggrBgEFBQcDCDAZBgkrBgEEAYI3FAIEDB4KAFMAdQBiAEMAQTALBgNVHQ8EBAMCAYYwDwYDVR0TAQH/BAUwAwEB/zAfBgNVHSMEGDAWgBTV9lbLj+iiXGJo0T2UkFvXzpoYxDBWBgNVHR8ETzBNMEugSaBHhkVodHRwOi8vY3JsLm1pY3Jvc29mdC5jb20vcGtpL2NybC9wcm9kdWN0cy9NaWNSb29DZXJBdXRfMjAxMC0wNi0yMy5jcmwwWgYIKwYBBQUHAQEETjBMMEoGCCsGAQUFBzAChj5odHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20vcGtpL2NlcnRzL01pY1Jvb0NlckF1dF8yMDEwLTA2LTIzLmNydDANBgkqhkiG9w0BAQsFAAOCAgEAnVV9/Cqt4SwfZwExJFvhnnJL/Klv6lwUtj5OR2R4sQaTlz0xM7U518JxNj/aZGx80HU5bbsPMeTCj/ts0aGUGCLu6WZnOlNN3Zi6th542DYunKmCVgADsAW+iehp4LoJ7nvfam++Kctu2D9IdQHZGN5tggz1bSNU5HhTdSRXud2f8449xvNo32X2pFaq95W2KFUn0CS9QKC/GbYSEhFdPSfgQJY4rPf5KYnDvBewVIVCs/wMnosZiefwC2qBwoEZQhlSdYo2wh3DYXMuLGt7bj8sCXgU6ZGyqVvfSaN0DLzskYDSPeZKPmY7T7uG+jIa2Zb0j/aRAfbOxnT99kxybxCrdTDFNLB62FD+CljdQDzHVG2dY3RILLFORy3BFARxv2T5JL5zbcqOCb2zAVdJVGTZc9d/HltEAY5aGZFrDZ+kKNxnGSgkujhLmm77IVRrakURR6nxt67I6IleT53S0Ex2tVdUCbFpAUR+fKFhbHP+CrvsQWY9af3LwUFJfn6Tvsv4O+S3Fb+0zj6lMVGEvL8CwYKiexcdFYmNcP7ntdAoGokLjzbaukz5m/8K6TT4JDVnK+ANuOaMmdbhIurwJ0I9JZTmdHRbatGePu1+oDEzfbzL6Xu/OHBE0ZDxyKs6ijoIYn/ZcGNTTY3ugm2lBRDBcQZqELQdVTNYs6FwZvKhggLPMIICOAIBATCB/KGB1KSB0TCBzjELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEpMCcGA1UECxMgTWljcm9zb2Z0IE9wZXJhdGlvbnMgUHVlcnRvIFJpY28xJjAkBgNVBAsTHVRoYWxlcyBUU1MgRVNOOkY3N0YtRTM1Ni01QkFFMSUwIwYDVQQDExxNaWNyb3NvZnQgVGltZS1TdGFtcCBTZXJ2aWNloiMKAQEwBwYFKw4DAhoDFQDgbSbQnh4CWWNw/+O86/3+mb/rxqCBgzCBgKR+MHwxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpXYXNoaW5ndG9uMRAwDgYDVQQHEwdSZWRtb25kMR4wHAYDVQQKExVNaWNyb3NvZnQgQ29ycG9yYXRpb24xJjAkBgNVBAMTHU1pY3Jvc29mdCBUaW1lLVN0YW1wIFBDQSAyMDEwMA0GCSqGSIb3DQEBBQUAAgUA5sW1czAiGA8yMDIyMDkwOTE2NTIwM1oYDzIwMjIwOTEwMTY1MjAzWjB0MDoGCisGAQQBhFkKBAExLDAqMAoCBQDmxbVzAgEAMAcCAQACAhLSMAcCAQACAhFgMAoCBQDmxwbzAgEAMDYGCisGAQQBhFkKBAIxKDAmMAwGCisGAQQBhFkKAwKgCjAIAgEAAgMHoSChCjAIAgEAAgMBhqAwDQYJKoZIhvcNAQEFBQADgYEAOZy8XqFUQQjQeOrhhHc2iXLo2jLq6x6GWasB/CmK+xRYRrdx6mLZ1oJgthZtmgz1e0JGr6kEvKBojXbONKcAEGuS4bWwNOYIBNdMtMCMJhrqE5VdRd8Ss3EREuGBvdvXRbMtl2Q9k6qcr4UnCMKXSgX4Uv9i6M8yh0/eTuqodp4xggQNMIIECQIBATCBkzB8MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSYwJAYDVQQDEx1NaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0EgMjAxMAITMwAAAaqlMZsLy7IIDgABAAABqjANBglghkgBZQMEAgEFAKCCAUowGgYJKoZIhvcNAQkDMQ0GCyqGSIb3DQEJEAEEMC8GCSqGSIb3DQEJBDEiBCDqMjqUF3so+TL2VsBLm9Q61sTR9yqyglEpg9XXf819fTCB+gYLKoZIhvcNAQkQAi8xgeowgecwgeQwgb0EIFa1AkMcWrwR4HPdNe6AKpGFIj8kJlsBNgQjBMbxsx7AMIGYMIGApH4wfDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEmMCQGA1UEAxMdTWljcm9zb2Z0IFRpbWUtU3RhbXAgUENBIDIwMTACEzMAAAGqpTGbC8uyCA4AAQAAAaowIgQgROLoVj8oTsbKrkYqpNL4hokUV8hJdhGV13qYxR5AOY4wDQYJKoZIhvcNAQELBQAEggIAXukOMe2S06R0uMX43S3reNEEZpExxOL4LRBlCehX07hOXFOzdmtOPKzI/6yISTOS3A0FpbxsPHPiSAlzOWG4vpIPq3C1qlihD20AZaVBM3tcTUscFha4yBtzDfTvXjnyOdc1jLRKXFpC3wjLmb4HpNLQvhi4YCQ80cUvK90gqYd5u/NllrX4fwiMISBzAOlMgjucHF3PO0S9uA2pKs+ul0XbDyuBUwR/U+jJw/ge9HUoMltL7gmV0lj//B8BNNtV8i8ZjsPtZfZovvp4U8H6EfIVUb7rWbSQqAUMEHqvc7/qe76GMDCktlitBc6mWWeM6kuXbzP5pKgZnR+GvysTdcxmErEM9FIFiuTUaebuYS7A8b2PITRxe9ulA3w883o8/THeZOSCQSs7N5fN+gcWBEKmy4Sm89jMsuOvpe/zSIeqIVHp/Br/gBepsvVzs5si8L/SW02P7kFleQEQKKCTq+KhlJ7vTmc9o+6rSguRx14868tMsjFS83GptWAi3h8jyiD+57EtnCFSLWQbOOKMFQfKmBHYVrAQ19IDXzoI1vHsoI0Sve+nw+7/aA8E98l+wO7oeLLlxM7t+FnEhk+tLdDY4eQnldYgdeNffKBjRLo4lzXRb+sVnHs47HMz2HlK0xBViIyaCR9IGkFMxqk92NOSOlc6DU7I/W7X8uI3LsYAAAAA</CounterSignature></Object></Signature></doc>
md5: 9B4C62C06BF77D1F87ED656FB80F3B9C | sha1: 4FBC1332C9DD6B6C6EA48F0306968D8C2A206DC1 | sha256: 89D177D84760B70D1E7A1F9EC76B4CAAF38D76F566C10403E74404C6751DD53F | sha512: AB92DB9FC02C27AFB221933EFFAF6668102E44CAF48204262966363930C4A69027FACF2AEDC9AACCFF04B0FF1AE495FABB87721164FAC30D0B525FE808B560CD
<?xml version="1.0"?>
<doc>
<assembly>
<name>NuGet.Packaging</name>
</assembly>
<members>
<member name="T:NuGet.Client.AnyFramework">
<summary>
An internal NuGetFramework marker for ManagedCodeConventions.
Most conventions disallow the string 'any' as a txm, so to allow
it for conventions with no txm in the path we use this special type.
</summary>
</member>
<member name="T:NuGet.Client.ManagedCodeConventions">
<summary>
Defines all the package conventions used by Managed Code packages
</summary>
</member>
<member name="P:NuGet.Client.ManagedCodeConventions.ManagedCodePatterns.AnyTargettedFile">
<summary>
Pattern used to locate all files targetted at a specific runtime and/or framework
</summary>
</member>
<member name="P:NuGet.Client.ManagedCodeConventions.ManagedCodePatterns.RuntimeAssemblies">
<summary>
Pattern used to locate all files designed for loading as managed code assemblies at run-time
</summary>
</member>
<member name="P:NuGet.Client.ManagedCodeConventions.ManagedCodePatterns.CompileRefAssemblies">
<summary>
Pattern used to locate ref assemblies for compile.
</summary>
</member>
<member name="P:NuGet.Client.ManagedCodeConventions.ManagedCodePatterns.CompileLibAssemblies">
<summary>
Pattern used to locate lib assemblies for compile.
</summary>
</member>
<member name="P:NuGet.Client.ManagedCodeConventions.ManagedCodePatterns.NativeLibraries">
<summary>
Pattern used to locate all files designed for loading as native code libraries at run-time
</summary>
</member>
<member name="P:NuGet.Client.ManagedCodeConventions.ManagedCodePatterns.ResourceAssemblies">
<summary>
Pattern used to locate all files designed for loading as managed code resource assemblies at run-time
</summary>
</member>
<member name="P:NuGet.Client.ManagedCodeConventions.ManagedCodePatterns.MSBuildFiles">
<summary>
Pattern used to identify MSBuild targets and props files
</summary>
</member>
<member name="P:NuGet.Client.ManagedCodeConventions.ManagedCodePatterns.MSBuildMultiTargetingFiles">
<summary>
Pattern used to identify MSBuild global targets and props files
</summary>
</member>
<member name="P:NuGet.Client.ManagedCodeConventions.ManagedCodePatterns.ContentFiles">
<summary>
Pattern used to identify content files
</summary>
</member>
<member name="P:NuGet.Client.ManagedCodeConventions.ManagedCodePatterns.ToolsAssemblies">
<summary>
Pattern used to identify Tools assets for global tools
</summary>
</member>
<member name="P:NuGet.Client.ManagedCodeConventions.ManagedCodePatterns.EmbedAssemblies">
<summary>
Pattern used to locate embed interop types assemblies
</summary>
</member>
<member name="P:NuGet.Client.ManagedCodeConventions.ManagedCodePatterns.MSBuildTransitiveFiles">
<summary>
Pattern used to identify MSBuild transitive targets and props files
</summary>
</member>
<member name="P:NuGet.ContentModel.ContentItemCollection.HasContract">
<summary>
True if lib/contract exists
</summary>
</member>
<member name="M:NuGet.ContentModel.ContentItemCollection.PopulateItemGroups(NuGet.ContentModel.PatternSet,System.Collections.Generic.IList{NuGet.ContentModel.ContentItemGroup})">
<summary>
Populate the provided list with ContentItemGroups based on a provided pattern set.
</summary>
<param name="definition">The pattern set to match</param>
<param name="contentItemGroupList">The list that will be mutated and populated with the item groups</param>
</member>
<member name="M:NuGet.ContentModel.ContentItemCollection.IsValidAsset(System.String)">
<summary>
False if the path would not match any patterns.
</summary>
</member>
<member name="T:NuGet.ContentModel.ContentPropertyDefinition">
<summary>
Defines a property that can be used in Content Model query patterns
<seealso cref="T:NuGet.ContentModel.PatternSet" />
</summary>
</member>
<member name="P:NuGet.ContentModel.ContentPropertyDefinition.CompareTest">
<summary>
Find the nearest compatible candidate.
</summary>
</member>
<member name="T:NuGet.ContentModel.PatternSet">
<summary>
A set of patterns that can be used to query a set of file paths for items matching a provided criteria.
</summary>
</member>
<member name="P:NuGet.ContentModel.PatternSet.GroupPatterns">
<summary>
Patterns used to select a group of items that matches the criteria
</summary>
</member>
<member name="P:NuGet.ContentModel.PatternSet.GroupExpressions">
<summary>
Pattern expressions.
</summary>
</member>
<member name="P:NuGet.ContentModel.PatternSet.PathPatterns">
<summary>
Patterns used to select individual items that match the criteria
</summary>
</member>
<member name="P:NuGet.ContentModel.PatternSet.PathExpressions">
<summary>
Path expressions.
</summary>
</member>
<member name="P:NuGet.ContentModel.PatternSet.PropertyDefinitions">
<summary>
Property definitions used for matching patterns
</summary>
</member>
<member name="T:NuGet.ContentModel.PatternDefinition">
<summary>
A pattern that can be used to match file paths given a provided criteria.
</summary>
<remarks>
The pattern is defined as a sequence of literal path strings that must match exactly and property
references,
wrapped in {} characters, which are tested for compatibility with the consumer-provided criteria.
<seealso cref="T:NuGet.ContentModel.ContentPropertyDefinition" />
</remarks>
</member>
<member name="P:NuGet.ContentModel.PatternDefinition.Table">
<summary>
Replacement token table.
</summary>
</member>
<member name="T:NuGet.ContentModel.PatternTable">
<summary>
Replacement token table organized by property.
</summary>
</member>
<member name="M:NuGet.ContentModel.PatternTable.TryLookup(System.String,System.String,System.Object@)">
<summary>
Lookup a token and get the replacement if it exists.
</summary>
<param name="propertyName">Property moniker</param>
<param name="name">Token name</param>
<param name="value">Replacement value</param>
</member>
<member name="P:NuGet.ContentModel.PatternTableEntry.PropertyName">
<summary>
PropertyName moniker
</summary>
</member>
<member name="P:NuGet.ContentModel.PatternTableEntry.Name">
<summary>
Item name
</summary>
</member>
<member name="P:NuGet.ContentModel.PatternTableEntry.Value">
<summary>
Item replacement value
</summary>
</member>
<member name="T:NuGet.Packaging.Core.IPackageIdentityComparer">
<summary>
Compares the id and version of a package
</summary>
</member>
<member name="F:NuGet.Packaging.Core.PackageDependencyComparer.Default">
<summary>
Default comparer
Null ranges and the All range are treated as equal.
</summary>
</member>
<member name="P:NuGet.Packaging.Core.PackageDependencyInfoComparer.Default">
<summary>
Default comparer
</summary>
</member>
<member name="T:NuGet.Packaging.Core.PackageIdentityComparer">
<summary>
Compares the Id, Version, and Version release label. Version build metadata is ignored.
</summary>
</member>
<member name="M:NuGet.Packaging.Core.PackageIdentityComparer.#ctor">
<summary>
Default version range comparer.
</summary>
</member>
<member name="M:NuGet.Packaging.Core.PackageIdentityComparer.#ctor(NuGet.Versioning.VersionComparison)">
<summary>
Compare versions with a specific VersionComparison
</summary>
</member>
<member name="M:NuGet.Packaging.Core.PackageIdentityComparer.#ctor(NuGet.Versioning.IVersionComparer)">
<summary>
Compare versions with a specific IVersionComparer
</summary>
</member>
<member name="P:NuGet.Packaging.Core.PackageIdentityComparer.Default">
<summary>
Default comparer that compares on the id, version, and version release labels.
</summary>
</member>
<member name="M:NuGet.Packaging.Core.PackageIdentityComparer.Equals(NuGet.Packaging.Core.PackageIdentity,NuGet.Packaging.Core.PackageIdentity)">
<summary>
True if the package identities are the same when ignoring build metadata.
</summary>
</member>
<member name="M:NuGet.Packaging.Core.PackageIdentityComparer.GetHashCode(NuGet.Packaging.Core.PackageIdentity)">
<summary>
Hash code of the id and version
</summary>
</member>
<member name="M:NuGet.Packaging.Core.PackageIdentityComparer.Compare(NuGet.Packaging.Core.PackageIdentity,NuGet.Packaging.Core.PackageIdentity)">
<summary>
Compares on the Id first, then version
</summary>
</member>
<member name="T:NuGet.Packaging.Core.ContentFilesEntry">
<summary>
metadata/contentFiles/files entry from a nuspec
</summary>
</member>
<member name="P:NuGet.Packaging.Core.ContentFilesEntry.Include">
<summary>
Included files
</summary>
<remarks>Required</remarks>
</member>
<member name="P:NuGet.Packaging.Core.ContentFilesEntry.Exclude">
<summary>
Excluded files
</summary>
</member>
<member name="P:NuGet.Packaging.Core.ContentFilesEntry.BuildAction">
<summary>
Build action
</summary>
</member>
<member name="P:NuGet.Packaging.Core.ContentFilesEntry.CopyToOutput">
<summary>
If true the item will be copied to the output folder.
</summary>
</member>
<member name="P:NuGet.Packaging.Core.ContentFilesEntry.Flatten">
<summary>
If true the content items will keep the same folder structure in the output
folder.
</summary>
</member>
<member name="T:NuGet.Packaging.Core.ExtractPackageFileDelegate">
<summary>
Callback invoked to extract a package file.
</summary>
<param name="sourceFile">The path of the file in the package.</param>
<param name="targetPath">The path to write to.</param>
<param name="fileStream">The file <see cref="T:System.IO.Stream" />.</param>
<returns>The file name if the file was written; otherwise <c>null</c>.</returns>
</member>
<member name="T:NuGet.Packaging.Core.IAsyncPackageCoreReader">
<summary>
A basic asynchronous package reader that provides the identity, min client version, and file access.
</summary>
<remarks>Higher level concepts used for normal development nupkgs should go at a higher level</remarks>
</member>
<member name="M:NuGet.Packaging.Core.IAsyncPackageCoreReader.GetIdentityAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously gets the identity of the package.
</summary>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns a <see cref="T:NuGet.Packaging.Core.PackageIdentity" />.</returns>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Packaging.Core.IAsyncPackageCoreReader.GetMinClientVersionAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously gets the minimum client version needed to consume the package.
</summary>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns a <see cref="T:NuGet.Versioning.NuGetVersion" />.</returns>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Packaging.Core.IAsyncPackageCoreReader.GetPackageTypesAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously gets zero or more package types from the .nuspec.
</summary>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an
<see cref="T:System.Collections.Generic.IReadOnlyList`1" />.</returns>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Packaging.Core.IAsyncPackageCoreReader.GetStreamAsync(System.String,System.Threading.CancellationToken)">
<summary>
Asynchronously returns a file stream from the package.
</summary>
<param name="path">The file path in the package.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns a <see cref="T:System.IO.Stream" />.</returns>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Packaging.Core.IAsyncPackageCoreReader.GetFilesAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously gets all files in the package.
</summary>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an
<see cref="T:System.Collections.Generic.IEnumerable`1" />.</returns>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Packaging.Core.IAsyncPackageCoreReader.GetFilesAsync(System.String,System.Threading.CancellationToken)">
<summary>
Asynchronously gets files in a folder in the package.
</summary>
<param name="folder">A folder path in the package.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an
<see cref="T:System.Collections.Generic.IEnumerable`1" /> for files under the specified folder.</returns>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Packaging.Core.IAsyncPackageCoreReader.GetNuspecAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously gets a nuspec stream.
</summary>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns a <see cref="T:System.IO.Stream" />.</returns>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Packaging.Core.IAsyncPackageCoreReader.GetNuspecFileAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously gets a nuspec file path.
</summary>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns a <see cref="T:System.String" />
representing the nuspec file path.</returns>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Packaging.Core.IAsyncPackageCoreReader.CopyFilesAsync(System.String,System.Collections.Generic.IEnumerable{System.String},NuGet.Packaging.Core.ExtractPackageFileDelegate,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Asynchronously copies files from a package to a new location.
</summary>
<param name="destination">The destination path to copy to.</param>
<param name="packageFiles">The package files to copy.</param>
<param name="extractFile">A package file extraction delegate.</param>
<param name="logger">A logger.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns am
<see cref="T:System.Collections.Generic.IEnumerable`1" /> for the copied file paths.</returns>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="T:NuGet.Packaging.Core.INuspecCoreReader">
<summary>
A basic nuspec reader that understands ONLY the id, version, and min client version of a package.
</summary>
<remarks>Higher level concepts used for normal development nupkgs should go at a higher level</remarks>
</member>
<member name="M:NuGet.Packaging.Core.INuspecCoreReader.GetId">
<summary>
Package Id
</summary>
<returns></returns>
</member>
<member name="M:NuGet.Packaging.Core.INuspecCoreReader.GetVersion">
<summary>
Package Version
</summary>
</member>
<member name="M:NuGet.Packaging.Core.INuspecCoreReader.GetMinClientVersion">
<summary>
Minimum client version needed to consume the package.
</summary>
</member>
<member name="M:NuGet.Packaging.Core.INuspecCoreReader.GetPackageTypes">
<summary>
Gets zero or more package types from the .nuspec.
</summary>
</member>
<member name="M:NuGet.Packaging.Core.INuspecCoreReader.GetIdentity">
<summary>
Id and Version of a package.
</summary>
</member>
<member name="M:NuGet.Packaging.Core.INuspecCoreReader.GetMetadata">
<summary>
Package metadata in the nuspec
</summary>
</member>
<member name="T:NuGet.Packaging.Core.IPackageCoreReader">
<summary>
Basic package reader that provides the identity, min client version, and file access.
</summary>
<remarks>Higher level concepts used for normal development nupkgs should go at a higher level</remarks>
</member>
<member name="M:NuGet.Packaging.Core.IPackageCoreReader.GetIdentity">
<summary>
Gets the package identity.
</summary>
<returns>A package identity.</returns>
</member>
<member name="M:NuGet.Packaging.Core.IPackageCoreReader.GetMinClientVersion">
<summary>
Gets the minimum client version needed to consume the package.
</summary>
<returns>A NuGet version.</returns>
</member>
<member name="M:NuGet.Packaging.Core.IPackageCoreReader.GetPackageTypes">
<summary>
Gets zero or more package types from the .nuspec.
</summary>
<returns>A readonly list of package types.</returns>
</member>
<member name="M:NuGet.Packaging.Core.IPackageCoreReader.GetStream(System.String)">
<summary>
Gets a file stream from the package.
</summary>
<returns>A stream for a file in the package.</returns>
</member>
<member name="M:NuGet.Packaging.Core.IPackageCoreReader.GetFiles">
<summary>
Gets all files in the package.
</summary>
<returns>An enumerable of files in the package.</returns>
</member>
<member name="M:NuGet.Packaging.Core.IPackageCoreReader.GetFiles(System.String)">
<summary>
Gets files in a folder in the package.
</summary>
<param name="folder">Folder path</param>
<returns>An enumerable of files under specified folder.</returns>
</member>
<member name="M:NuGet.Packaging.Core.IPackageCoreReader.GetNuspec">
<summary>
Gets a nuspec stream.
</summary>
<returns>A stream for the nuspec.</returns>
</member>
<member name="M:NuGet.Packaging.Core.IPackageCoreReader.GetNuspecFile">
<summary>
Gets a nuspec file path.
</summary>
<returns>The nuspec file path.</returns>
</member>
<member name="M:NuGet.Packaging.Core.IPackageCoreReader.CopyFiles(System.String,System.Collections.Generic.IEnumerable{System.String},NuGet.Packaging.Core.ExtractPackageFileDelegate,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Copies files from a package to a new location.
</summary>
<param name="destination">The destination folder path.</param>
<param name="packageFiles">The package files to copy.</param>
<param name="extractFile">A package file extraction delegate.</param>
<param name="logger">A logger.</param>
<param name="token">A cancellation token.</param>
<returns>An enumerable of paths of files copied to the destination.</returns>
</member>
<member name="T:NuGet.Packaging.Core.NuspecCoreReader">
<summary>
A basic nuspec reader that understand id, version, and a flat list of dependencies.
</summary>
</member>
<member name="M:NuGet.Packaging.Core.NuspecCoreReader.#ctor(System.IO.Stream)">
<summary>
Read a nuspec from a stream.
</summary>
</member>
<member name="M:NuGet.Packaging.Core.NuspecCoreReader.#ctor(System.Xml.Linq.XDocument)">
<summary>
Reads a nuspec from XML
</summary>
</member>
<member name="M:NuGet.Packaging.Core.NuspecCoreReader.GetDependencies">
<summary>
Returns a flat list of dependencies from a nuspec
</summary>
</member>
<member name="T:NuGet.Packaging.Core.NuspecCoreReaderBase">
<summary>
A very basic Nuspec reader that understands the Id, Version, PackageType, and MinClientVersion of a package.
</summary>
</member>
<member name="M:NuGet.Packaging.Core.NuspecCoreReaderBase.#ctor(System.String)">
<summary>
Read a nuspec from a path.
</summary>
</member>
<member name="M:NuGet.Packaging.Core.NuspecCoreReaderBase.#ctor(System.IO.Stream)">
<summary>
Read a nuspec from a stream.
</summary>
</member>
<member name="M:NuGet.Packaging.Core.NuspecCoreReaderBase.#ctor(System.IO.Stream,System.Boolean)">
<summary>
Read a nuspec from a stream.
</summary>
</member>
<member name="M:NuGet.Packaging.Core.NuspecCoreReaderBase.#ctor(System.Xml.Linq.XDocument)">
<summary>
Reads a nuspec from XML
</summary>
</member>
<member name="M:NuGet.Packaging.Core.NuspecCoreReaderBase.GetId">
<summary>
Id of the package
</summary>
</member>
<member name="M:NuGet.Packaging.Core.NuspecCoreReaderBase.GetVersion">
<summary>
Version of the package
</summary>
</member>
<member name="M:NuGet.Packaging.Core.NuspecCoreReaderBase.GetMinClientVersion">
<summary>
The minimum client version this package supports.
</summary>
</member>
<member name="M:NuGet.Packaging.Core.NuspecCoreReaderBase.GetPackageTypes">
<summary>
Gets zero or more package types from the .nuspec.
</summary>
</member>
<member name="M:NuGet.Packaging.Core.NuspecCoreReaderBase.IsServiceable">
<summary>
Returns if the package is serviceable.
</summary>
</member>
<member name="M:NuGet.Packaging.Core.NuspecCoreReaderBase.GetDevelopmentDependency">
<summary>
The developmentDependency attribute
</summary>
</member>
<member name="M:NuGet.Packaging.Core.NuspecCoreReaderBase.GetMetadata">
<summary>
Nuspec Metadata
</summary>
</member>
<member name="M:NuGet.Packaging.Core.NuspecCoreReaderBase.GetMetadataValue(System.String)">
<summary>
Returns a nuspec metadata value or string.Empty.
</summary>
</member>
<member name="P:NuGet.Packaging.Core.NuspecCoreReaderBase.MetadataValues">
<summary>
Indexed metadata values of the XML elements in the nuspec.
If duplicate keys exist only the first is used.
</summary>
</member>
<member name="P:NuGet.Packaging.Core.NuspecCoreReaderBase.Xml">
<summary>
Raw XML doc
</summary>
</member>
<member name="T:NuGet.Packaging.Core.NuspecUtility">
<summary>
Until NuspecReader and Manifest are unified, this is a place to share implementations of
reading and parsing specific elements out of the .nuspec XML.
</summary>
</member>
<member name="M:NuGet.Packaging.Core.NuspecUtility.GetPackageTypes(System.Xml.Linq.XElement,System.Boolean)">
<summary>
Gets the package types from a .nuspec metadata XML element.
</summary>
<param name="metadataNode">The metadata XML element.</param>
<param name="useMetadataNamespace">
Whether or not to use the metadata element's namespace when finding the package type
nodes. If false is specified, only the local names of the package type nodes are used
for comparison. If true is specified, the package type nodes must have the same
namespace as the metadata node.
</param>
<returns>
A list of package types. If no package types are found in the metadata node, an empty
list is returned.
</returns>
</member>
<member name="M:NuGet.Packaging.Core.NuspecUtility.IsServiceable(System.Xml.Linq.XElement)">
<summary>
Gets the value of serviceable element from a .nuspec metadata XML element.
</summary>
<param name="metadataNode">The metadata XML element.</param>
<returns>
true if the serviceable element is set in the .nuspec file as true, else false.
</returns>
</member>
<member name="M:NuGet.Packaging.Core.NuspecUtility.GetFrameworkReferenceGroups(System.Xml.Linq.XElement,NuGet.Frameworks.IFrameworkNameProvider,System.Boolean)">
<summary>
Gets the FrameworkReference groups. This refers to the FrameworkReference concept added in .NET Core 3.0
</summary>
<param name="metadataNode">The metadata node</param>
<param name="frameworkProvider">A FrameworkNameProvider</param>
<param name="useMetadataNamespace">Whether or not to use the metadata element's namespace when getting the framework reference nodes.
If false is specified, only the local names of the FrameworkReference nodes are used
for comparison. If true is specified, the fremeworkreference nodes must have the same
namespace as the metadata node.</param>
<returns></returns>
</member>
<member name="T:NuGet.Packaging.Core.PackageDependency">
<summary>
Represents a package dependency Id and allowed version range.
</summary>
</member>
<member name="P:NuGet.Packaging.Core.PackageDependency.Id">
<summary>
Dependency package Id
</summary>
</member>
<member name="P:NuGet.Packaging.Core.PackageDependency.Include">
<summary>
Types to include from the dependency package.
</summary>
</member>
<member name="P:NuGet.Packaging.Core.PackageDependency.Exclude">
<summary>
Types to exclude from the dependency package.
</summary>
</member>
<member name="P:NuGet.Packaging.Core.PackageDependency.VersionRange">
<summary>
Range of versions allowed for the depenency
</summary>
</member>
<member name="M:NuGet.Packaging.Core.PackageDependency.GetHashCode">
<summary>
Hash code from the default PackageDependencyComparer
</summary>
</member>
<member name="M:NuGet.Packaging.Core.PackageDependency.ToString">
<summary>
Id and Version range string
</summary>
</member>
<member name="T:NuGet.Packaging.Core.PackageDependencyInfo">
<summary>
Represents a package identity and the dependencies of a package.
</summary>
<remarks>
This class does not support groups of dependencies, the group will need to be selected before
populating this.
</remarks>
</member>
<member name="M:NuGet.Packaging.Core.PackageDependencyInfo.#ctor(System.String,NuGet.Versioning.NuGetVersion,System.Collections.Generic.IEnumerable{NuGet.Packaging.Core.PackageDependency})">
<summary>
Represents a package identity and the dependencies of a package.
</summary>
<param name="id">package name</param>
<param name="version">package version</param>
<param name="dependencies">package dependencies</param>
</member>
<member name="P:NuGet.Packaging.Core.PackageDependencyInfo.Dependencies">
<summary>
Package dependencies
</summary>
</member>
<member name="M:NuGet.Packaging.Core.PackageDependencyInfo.GetHashCode">
<summary>
Hash code from the default PackageDependencyInfoComparer
</summary>
<returns></returns>
</member>
<member name="M:NuGet.Packaging.Core.PackageDependencyInfo.ToString">
<summary>
Example: Id : Dependency1, Dependency2
</summary>
<returns></returns>
</member>
<member name="T:NuGet.Packaging.Core.PackageIdentity">
<summary>
Represents the core identity of a nupkg.
</summary>
</member>
<member name="M:NuGet.Packaging.Core.PackageIdentity.#ctor(System.String,NuGet.Versioning.NuGetVersion)">
<summary>
Creates a new package identity.
</summary>
<param name="id">name</param>
<param name="version">version</param>
</member>
<member name="P:NuGet.Packaging.Core.PackageIdentity.Id">
<summary>
Package name
</summary>
</member>
<member name="P:NuGet.Packaging.Core.PackageIdentity.Version">
<summary>
Package Version
</summary>
<remarks>can be null</remarks>
</member>
<member name="P:NuGet.Packaging.Core.PackageIdentity.HasVersion">
<summary>
True if the version is non-null
</summary>
</member>
<member name="M:NuGet.Packaging.Core.PackageIdentity.Equals(NuGet.Packaging.Core.PackageIdentity)">
<summary>
True if the package identities are the same.
</summary>
<param name="other"></param>
<returns></returns>
</member>
<member name="M:NuGet.Packaging.Core.PackageIdentity.Equals(NuGet.Packaging.Core.PackageIdentity,NuGet.Versioning.VersionComparison)">
<summary>
True if the identity objects are equal based on the given comparison mode.
</summary>
</member>
<member name="M:NuGet.Packaging.Core.PackageIdentity.CompareTo(NuGet.Packaging.Core.PackageIdentity)">
<summary>
Sorts based on the id, then version
</summary>
</member>
<member name="M:NuGet.Packaging.Core.PackageIdentity.Equals(System.Object)">
<summary>
Compare using the default comparer.
</summary>
</member>
<member name="M:NuGet.Packaging.Core.PackageIdentity.GetHashCode">
<summary>
Creates a hash code using the default comparer.
</summary>
</member>
<member name="P:NuGet.Packaging.Core.PackageIdentity.Comparer">
<summary>
An equality comparer that checks the id, version, and version release label.
</summary>
</member>
<member name="M:NuGet.Packaging.Core.PackageIdentity.ToString">
<summary>
PackageIdentity.ToString returns packageId.packageVersion"
</summary>
</member>
<member name="T:NuGet.Packaging.Core.PackageType">
It is important that this type remains immutable due to the cloning of package specs
</member>
<member name="F:NuGet.Packaging.Core.PackagingCoreConstants.EmptyFolder">
<summary>
_._ denotes an empty folder since OPC does not allow an
actual empty folder.
</summary>
</member>
<member name="F:NuGet.Packaging.Core.PackagingCoreConstants.ForwardSlashEmptyFolder">
<summary>
/_._ can be used to check empty folders from package readers where the / is normalized.
</summary>
</member>
<member name="T:NuGet.Packaging.Rules.AnalysisResources">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:NuGet.Packaging.Rules.AnalysisResources.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:NuGet.Packaging.Rules.AnalysisResources.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:NuGet.Packaging.Rules.AnalysisResources.AssemblyDirectlyUnderLibWarning">
<summary>
Looks up a localized string similar to The assembly '{0}' is placed directly under 'lib' folder. It is recommended that assemblies be placed inside a framework-specific folder. Move it into a framework-specific folder..
</summary>
</member>
<member name="P:NuGet.Packaging.Rules.AnalysisResources.AssemblyOutsideLibWarning">
<summary>
Looks up a localized string similar to The assembly '{0}' is not inside the 'lib' folder and hence it won't be added as a reference when the package is installed into a project. Move it into the 'lib' folder if it needs to be referenced..
</summary>
</member>
<member name="P:NuGet.Packaging.Rules.AnalysisResources.BuildConventionIsViolatedWarning">
<summary>
Looks up a localized string similar to - At least one {0} file was found in '{1}', but '{2}' was not..
</summary>
</member>
<member name="P:NuGet.Packaging.Rules.AnalysisResources.DefaultSpecValueWarning">
<summary>
Looks up a localized string similar to The value "{0}" for {1} is a sample value and should be removed. Replace it with an appropriate value or remove it and rebuild your package..
</summary>
</member>
<member name="P:NuGet.Packaging.Rules.AnalysisResources.DependenciesGroupsForEachTFMBeginningToFiles">
<summary>
Looks up a localized string similar to - Add lib or ref assemblies for the.
</summary>
</member>
<member name="P:NuGet.Packaging.Rules.AnalysisResources.DependenciesGroupsForEachTFMBeginningToNuspec">
<summary>
Looks up a localized string similar to - Add a dependency group for.
</summary>
</member>
<member name="P:NuGet.Packaging.Rules.AnalysisResources.DependenciesGroupsForEachTFMEndingToFile">
<summary>
Looks up a localized string similar to target framework.
</summary>
</member>
<member name="P:NuGet.Packaging.Rules.AnalysisResources.DependenciesGroupsForEachTFMEndingToNuspec">
<summary>
Looks up a localized string similar to to the nuspec.
</summary>
</member>
<member name="P:NuGet.Packaging.Rules.AnalysisResources.DependenciesGroupsForEachTFMHasCompatMatch">
<summary>
Looks up a localized string similar to Some target frameworks declared in the dependencies group of the nuspec and the lib/ref folder have compatible matches, but not exact matches in the other location. Unless intentional, consult the list of actions below:.
</summary>
</member>
<member name="P:NuGet.Packaging.Rules.AnalysisResources.DependenciesGroupsForEachTFMHasNoExactMatch">
<summary>
Looks up a localized string similar to Some target frameworks declared in the dependencies group of the nuspec and the lib/ref folder do not have exact matches in the other location. Consult the list of actions below:.
</summary>
</member>
<member name="P:NuGet.Packaging.Rules.AnalysisResources.FilePathTooLongWarning">
<summary>
Looks up a localized string similar to The file '{0}' path, name, or both are too long. Your package might not work without long file path support. Please shorten the file path or file name..
</summary>
</member>
<member name="P:NuGet.Packaging.Rules.AnalysisResources.IconUrlDeprecationWarning">
<summary>
Looks up a localized string similar to The 'PackageIconUrl'/'iconUrl' element is deprecated. Consider using the 'PackageIcon'/'icon' element instead. Learn more at https://aka.ms/deprecateIconUrl.
</summary>
</member>
<member name="P:NuGet.Packaging.Rules.AnalysisResources.InvalidFrameworkWarning">
<summary>
Looks up a localized string similar to The folder '{0}' under 'lib' is not recognized as a valid framework name or a supported culture identifier. Rename it to a valid framework name or culture identifier..
</summary>
</member>
<member name="P:NuGet.Packaging.Rules.AnalysisResources.InvalidPlaceholderFileWarning">
<summary>
Looks up a localized string similar to The file at '{0}' uses the symbol for empty directory '_._', but it is present in a directory that contains other files. Please remove this file from directories that contain other files..
</summary>
</member>
<member name="P:NuGet.Packaging.Rules.AnalysisResources.InvalidPrereleaseDependencyWarning">
<summary>
Looks up a localized string similar to A stable release of a package should not have a prerelease dependency. Either modify the version spec of dependency "{0}" or update the version field in the nuspec..
</summary>
</member>
<member name="P:NuGet.Packaging.Rules.AnalysisResources.InvalidUndottedFrameworkInDependencyGroupsWarning">
<summary>
Looks up a localized string similar to The following dependency group(s) require(s) dots in the framework version: {0}.
</summary>
</member>
<member name="P:NuGet.Packaging.Rules.AnalysisResources.InvalidUndottedFrameworkInFilesWarning">
<summary>
Looks up a localized string similar to The following packaged file folder(s) require(s) dots in the framework version: {0}.
</summary>
</member>
<member name="P:NuGet.Packaging.Rules.AnalysisResources.InvalidUndottedFrameworkInFrameworkAssemblyGroupsWarning">
<summary>
Looks up a localized string similar to The following framework assembly group(s) require(s) dots in the framework version: {0}.
</summary>
</member>
<member name="P:NuGet.Packaging.Rules.AnalysisResources.InvalidUndottedFrameworkInReferenceGroupsWarning">
<summary>
Looks up a localized string similar to The following reference group(s) require(s) dots in the framework version: {0}.
</summary>
</member>
<member name="P:NuGet.Packaging.Rules.AnalysisResources.InvalidUndottedFrameworkWarning">
<summary>
Looks up a localized string similar to One or more target framework specifiers in your package are missing required dots in their framework version numbers. This is required as of .NET5.0. Please rename them to include dots as needed (e.g. 'net50' to 'net5.0')..
</summary>
</member>
<member name="P:NuGet.Packaging.Rules.AnalysisResources.LegacyVersionWarning">
<summary>
Looks up a localized string similar to The package version '{0}' uses SemVer 2.0.0 or components of SemVer 1.0.0 that are not supported on legacy clients. Change the package version to a SemVer 1.0.0 string. If the version contains a release label it must start with a letter. This message can be ignored if the package is not intended for older clients..
</summary>
</member>
<member name="P:NuGet.Packaging.Rules.AnalysisResources.LicenseUrlDeprecationWarning">
<summary>
Looks up a localized string similar to The 'licenseUrl' element will be deprecated. Consider using the 'license' element instead..
</summary>
</member>
<member name="P:NuGet.Packaging.Rules.AnalysisResources.Migrator_AssemblyDirectlyUnderLibWarning">
<summary>
Looks up a localized string similar to The assembly 'lib\{0}' will be ignored when the package is installed after the migration..
</summary>
</member>
<member name="P:NuGet.Packaging.Rules.AnalysisResources.Migrator_PackageHasContentFolder">
<summary>
Looks up a localized string similar to 'content' assets will not be available when the package is installed after the migration..
</summary>
</member>
<member name="P:NuGet.Packaging.Rules.AnalysisResources.Migrator_PackageHasInstallScript">
<summary>
Looks up a localized string similar to install.ps1 script will be ignored when the package is installed after the migration..
</summary>
</member>
<member name="P:NuGet.Packaging.Rules.AnalysisResources.Migrator_XdtTransformInPackage">
<summary>
Looks up a localized string similar to XDT transform file '{0}' will not be applied when the package is installed after the migration..
</summary>
</member>
<member name="P:NuGet.Packaging.Rules.AnalysisResources.MisplacedInitScriptWarning">
<summary>
Looks up a localized string similar to The file '{0}' will be ignored by NuGet because it is not directly under 'tools' folder. Place the file directly under 'tools' folder..
</summary>
</member>
<member name="P:NuGet.Packaging.Rules.AnalysisResources.MisplacedTransformFileWarning">
<summary>
Looks up a localized string similar to The transform file '{0}' is outside the 'content' folder and hence will not be transformed during installation of this package. Move it into the 'content' folder..
</summary>
</member>
<member name="P:NuGet.Packaging.Rules.AnalysisResources.NoRefOrLibFolderInPackage">
<summary>
Looks up a localized string similar to This package does not contain a lib/ or ref/ folder, and will therefore be treated as compatible for all frameworks. Since framework specific files were found under the build/ directory for {0}, consider creating the following empty files to correctly narrow the compatibility of the package:
{1}.
</summary>
</member>
<member name="P:NuGet.Packaging.Rules.AnalysisResources.PlaceholderFileInPackageWarning">
<summary>
Looks up a localized string similar to An empty folder placeholder file '{0}' is in a non-empty folder and should be removed..
</summary>
</member>
<member name="P:NuGet.Packaging.Rules.AnalysisResources.ReferencesInNuspecAndRefFilesDontMatchWarning">
<summary>
Looks up a localized string similar to References were found in the nuspec, but some reference assemblies were not found in both the nuspec and ref folder. Add the following reference assemblies:.
</summary>
</member>
<member name="P:NuGet.Packaging.Rules.AnalysisResources.ReferencesInNuspecAndRefFilesDontMatchWarningAddToNuspecListItemFormat">
<summary>
Looks up a localized string similar to - Add {0} to the {1} reference group in the nuspec.
</summary>
</member>
<member name="P:NuGet.Packaging.Rules.AnalysisResources.ReferencesInNuspecAndRefFilesDontMatchWarningAddToNuspecNoTfmListItemFormat">
<summary>
Looks up a localized string similar to - Add {0} to the references element in the nuspec.
</summary>
</member>
<member name="P:NuGet.Packaging.Rules.AnalysisResources.ReferencesInNuspecAndRefFilesDontMatchWarningAddToRefListItemFormat">
<summary>
Looks up a localized string similar to - Add {0} to the ref/{1}/ directory.
</summary>
</member>
<member name="P:NuGet.Packaging.Rules.AnalysisResources.ScriptOutsideToolsWarning">
<summary>
Looks up a localized string similar to The script file '{0}' is outside the 'tools' folder and hence will not be executed during installation of this package. Move it into the 'tools' folder..
</summary>
</member>
<member name="P:NuGet.Packaging.Rules.AnalysisResources.UnrecognizedLicenseIdentifier">
<summary>
Looks up a localized string similar to The license identifier '{0}' is not recognized by the current toolset..
</summary>
</member>
<member name="P:NuGet.Packaging.Rules.AnalysisResources.UnrecognizedScriptWarning">
<summary>
Looks up a localized string similar to The script file '{0}' is not recognized by NuGet and hence will not be executed during installation of this package. Rename it to install.ps1, uninstall.ps1 or init.ps1 and place it directly under 'tools'..
</summary>
</member>
<member name="P:NuGet.Packaging.Rules.AnalysisResources.UnspecifiedDependencyVersionWarning">
<summary>
Looks up a localized string similar to The version of dependency '{0}' is not specified. Specify the version of dependency and rebuild your package..
</summary>
</member>
<member name="P:NuGet.Packaging.Rules.AnalysisResources.WinRTObsoleteWarning">
<summary>
Looks up a localized string similar to The file at '{0}' uses the obsolete 'WinRT' as the framework folder. Replace 'WinRT' or 'WinRT45' with 'NetCore45'..
</summary>
</member>
<member name="P:NuGet.Packaging.Rules.MisplacedAssemblyOutsideLibRule.ValidFolders">
<summary>
Folders that are expected to have .dll and .winmd files
</summary>
</member>
<member name="P:NuGet.Packaging.Rules.MisplacedAssemblyUnderLibRule.ValidFolders">
<summary>
Folders that are expected to have .dll and .winmd files
</summary>
</member>
<member name="T:NuGet.Packaging.FrameworkReferenceGroup">
<summary>
A group of FrameworkReference with the same target framework.
</summary>
</member>
<member name="M:NuGet.Packaging.FrameworkReferenceGroup.#ctor(NuGet.Frameworks.NuGetFramework,System.Collections.Generic.IEnumerable{NuGet.Packaging.FrameworkReference})">
<summary>
FrameworkReference group
</summary>
<param name="targetFramework">group target framework</param>
<param name="frameworkReferences">FrameworkReferences</param>
</member>
<member name="P:NuGet.Packaging.FrameworkReferenceGroup.TargetFramework">
<summary>
Group target framework
</summary>
</member>
<member name="P:NuGet.Packaging.FrameworkReferenceGroup.FrameworkReferences">
<summary>
FrameworkReferences
</summary>
</member>
<member name="T:NuGet.Packaging.FrameworkSpecificGroup">
<summary>
A group of items/files from a nupkg with the same target framework.
</summary>
</member>
<member name="M:NuGet.Packaging.FrameworkSpecificGroup.#ctor(NuGet.Frameworks.NuGetFramework,System.Collections.Generic.IEnumerable{System.String})">
<summary>
Framework specific group
</summary>
<param name="targetFramework">group target framework</param>
<param name="items">group items</param>
</member>
<member name="P:NuGet.Packaging.FrameworkSpecificGroup.TargetFramework">
<summary>
Group target framework
</summary>
</member>
<member name="P:NuGet.Packaging.FrameworkSpecificGroup.Items">
<summary>
Item relative paths
</summary>
</member>
<member name="T:NuGet.Packaging.PackageDependencyGroup">
<summary>
Package dependencies grouped to a target framework.
</summary>
</member>
<member name="M:NuGet.Packaging.PackageDependencyGroup.#ctor(NuGet.Frameworks.NuGetFramework,System.Collections.Generic.IEnumerable{NuGet.Packaging.Core.PackageDependency})">
<summary>
Dependency group
</summary>
<param name="targetFramework">target framework</param>
<param name="packages">dependant packages</param>
</member>
<member name="P:NuGet.Packaging.PackageDependencyGroup.TargetFramework">
<summary>
Dependency group target framework
</summary>
</member>
<member name="P:NuGet.Packaging.PackageDependencyGroup.Packages">
<summary>
Package dependencies
</summary>
</member>
<member name="T:NuGet.Packaging.IAsyncPackageContentReader">
<summary>
An asynchronous package content reader.
</summary>
</member>
<member name="M:NuGet.Packaging.IAsyncPackageContentReader.GetFrameworkItemsAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously returns all framework references found in the nuspec.
</summary>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an
<see cref="T:System.Collections.Generic.IEnumerable`1" />.</returns>
<exception cref="!:OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Packaging.IAsyncPackageContentReader.GetBuildItemsAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously returns all items under the build folder.
</summary>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an
<see cref="T:System.Collections.Generic.IEnumerable`1" />.</returns>
<exception cref="!:OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Packaging.IAsyncPackageContentReader.GetToolItemsAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously returns all items under the tools folder.
</summary>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an
<see cref="T:System.Collections.Generic.IEnumerable`1" />.</returns>
<exception cref="!:OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Packaging.IAsyncPackageContentReader.GetContentItemsAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously returns all items found in the content folder.
</summary>
<remarks>
Some legacy behavior has been dropped here due to the mix of content folders and target framework
folders here.
</remarks>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an
<see cref="T:System.Collections.Generic.IEnumerable`1" />.</returns>
<exception cref="!:OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Packaging.IAsyncPackageContentReader.GetLibItemsAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously returns all lib items without any filtering.
</summary>
<remarks>Use GetReferenceItemsAsync(...) for the filtered list.</remarks>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an
<see cref="T:System.Collections.Generic.IEnumerable`1" />.</returns>
<exception cref="!:OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Packaging.IAsyncPackageContentReader.GetReferenceItemsAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously returns lib items + filtering based on the nuspec and other NuGet rules.
</summary>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an
<see cref="T:System.Collections.Generic.IEnumerable`1" />.</returns>
<exception cref="!:OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Packaging.IAsyncPackageContentReader.GetPackageDependenciesAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously returns package dependencies.
</summary>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an
<see cref="T:System.Collections.Generic.IEnumerable`1" />.</returns>
<exception cref="!:OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="T:NuGet.Packaging.INuspecReader">
<summary>
A development package nuspec reader
</summary>
</member>
<member name="M:NuGet.Packaging.INuspecReader.GetLanguage">
<summary>
The locale ID for the package, such as en-us.
</summary>
</member>
<member name="M:NuGet.Packaging.IPackageContentReader.GetFrameworkItems">
<summary>
Returns all framework references found in the nuspec.
</summary>
</member>
<member name="M:NuGet.Packaging.IPackageContentReader.GetBuildItems">
<summary>
Returns all items under the build folder.
</summary>
</member>
<member name="M:NuGet.Packaging.IPackageContentReader.GetToolItems">
<summary>
Returns all items under the tools folder.
</summary>
</member>
<member name="M:NuGet.Packaging.IPackageContentReader.GetContentItems">
<summary>
Returns all items found in the content folder.
</summary>
<remarks>
Some legacy behavior has been dropped here due to the mix of content folders and target framework
folders here.
</remarks>
</member>
<member name="M:NuGet.Packaging.IPackageContentReader.GetLibItems">
<summary>
Returns all lib items without any filtering. Use GetReferenceItems for the filtered list.
</summary>
</member>
<member name="M:NuGet.Packaging.IPackageContentReader.GetReferenceItems">
<summary>
Returns lib items + filtering based on the nuspec and other NuGet rules.
</summary>
</member>
<member name="M:NuGet.Packaging.IPackageContentReader.GetPackageDependencies">
<summary>
Returns package dependencies.
</summary>
</member>
<member name="T:NuGet.Packaging.IPackageDownloader">
<summary>
A package downloader.
</summary>
</member>
<member name="P:NuGet.Packaging.IPackageDownloader.ContentReader">
<summary>
Gets an asynchronous package content reader.
</summary>
<exception cref="T:System.ObjectDisposedException">Thrown if this object is disposed.</exception>
</member>
<member name="P:NuGet.Packaging.IPackageDownloader.CoreReader">
<summary>
Gets an asynchronous package core reader.
</summary>
<exception cref="T:System.ObjectDisposedException">Thrown if this object is disposed.</exception>
</member>
<member name="M:NuGet.Packaging.IPackageDownloader.CopyNupkgFileToAsync(System.String,System.Threading.CancellationToken)">
<summary>
Asynchronously copies a .nupkg to a target file path.
</summary>
<param name="destinationFilePath">The destination file path.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns a <see cref="T:System.Boolean" />
indicating whether or not the copy was successful.</returns>
<exception cref="T:System.ObjectDisposedException">Thrown if this object is disposed.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="destinationFilePath" />
is either <c>null</c> or empty.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Packaging.IPackageDownloader.GetPackageHashAsync(System.String,System.Threading.CancellationToken)">
<summary>
Asynchronously gets a package hash.
</summary>
<param name="hashAlgorithm">The hash algorithm.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns a <see cref="T:System.String" />
representing the package hash.</returns>
<exception cref="T:System.ObjectDisposedException">Thrown if this object is disposed.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="hashAlgorithm" />
is either <c>null</c> or empty.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Packaging.IPackageDownloader.SetExceptionHandler(System.Func{System.Exception,System.Threading.Tasks.Task{System.Boolean}})">
<summary>
Sets an exception handler for package downloads.
</summary>
<remarks>The exception handler returns a task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns a <see cref="T:System.Boolean" />
indicating whether or not the exception was handled. To handle an exception and stop its
propagation, the task should return <c>true</c>. Otherwise, the exception will be rethrown.</remarks>
<param name="handleExceptionAsync">An exception handler.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="handleExceptionAsync" />
is <c>null</c>.</exception>
</member>
<member name="M:NuGet.Packaging.IPackageDownloader.SetThrottle(System.Threading.SemaphoreSlim)">
<summary>
Sets a throttle for package downloads.
</summary>
<param name="throttle">A throttle. Can be <c>null</c>.</param>
</member>
<member name="T:NuGet.Packaging.IPackageResolver">
<summary>
Core package resolver
</summary>
</member>
<member name="M:NuGet.Packaging.IPackageResolver.Resolve(System.Collections.Generic.IEnumerable{NuGet.Packaging.Core.PackageIdentity},System.Collections.Generic.IEnumerable{NuGet.Packaging.Core.PackageDependencyInfo},System.Threading.CancellationToken)">
<summary>
Resolve a set of packages
</summary>
<param name="targets">Package or packages to install</param>
<param name="availablePackages">All relevant packages. This list must include the target packages.</param>
<returns>A set of packages meeting the package dependency requirements</returns>
</member>
<member name="M:NuGet.Packaging.IPackageResolver.Resolve(System.Collections.Generic.IEnumerable{NuGet.Packaging.Core.PackageIdentity},System.Collections.Generic.IEnumerable{NuGet.Packaging.Core.PackageDependencyInfo},System.Collections.Generic.IEnumerable{NuGet.Packaging.PackageReference},System.Threading.CancellationToken)">
<summary>
Resolve a set of packages
</summary>
<param name="targets">Package or packages to install</param>
<param name="availablePackages">
All relevant packages. This list must include the target packages and
installed packages.
</param>
<param name="installedPackages">
Packages already installed into the project. These will be favored as
dependency options.
</param>
<returns>A set of packages meeting the package dependency requirements</returns>
</member>
<member name="M:NuGet.Packaging.IPackageResolver.Resolve(System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{NuGet.Packaging.Core.PackageDependencyInfo},System.Threading.CancellationToken)">
<summary>
Resolve a set of packages
</summary>
<param name="targets">Package or packages to install</param>
<param name="availablePackages">All relevant packages. This list must include the target packages.</param>
<returns>A set of packages meeting the package dependency requirements</returns>
</member>
<member name="M:NuGet.Packaging.IPackageResolver.Resolve(System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{NuGet.Packaging.Core.PackageDependencyInfo},System.Collections.Generic.IEnumerable{NuGet.Packaging.PackageReference},System.Threading.CancellationToken)">
<summary>
Resolve a set of packages
</summary>
<param name="targets">Package or packages to install</param>
<param name="availablePackages">
All relevant packages. This list must include the target packages and
installed packages.
</param>
<param name="installedPackages">
Packages already installed into the project. These will be favored as
dependency options.
</param>
<returns>A set of packages meeting the package dependency requirements</returns>
</member>
<member name="T:NuGet.Packaging.MinClientVersionException">
<summary>
Custom exception type for a package that has a higher minClientVersion than the current client.
</summary>
</member>
<member name="P:NuGet.Packaging.FallbackPackagePathInfo.PathResolver">
<summary>
Path resolver for the root package folder containing this package.
</summary>
</member>
<member name="P:NuGet.Packaging.FallbackPackagePathInfo.Id">
<summary>
Package id.
</summary>
</member>
<member name="P:NuGet.Packaging.FallbackPackagePathInfo.Version">
<summary>
Package version.
</summary>
</member>
<member name="M:NuGet.Packaging.FallbackPackagePathResolver.#ctor(NuGet.Common.INuGetPathContext)">
<summary>
Creates a package folder path resolver that scans multiple folders to find a package.
</summary>
<param name="pathContext">NuGet paths loaded from NuGet.Config settings.</param>
</member>
<member name="M:NuGet.Packaging.FallbackPackagePathResolver.GetPackageDirectory(System.String,System.String)">
<summary>
Returns the root directory of an installed package.
</summary>
<param name="packageId">Package id.</param>
<param name="version">Package version.</param>
<returns>Returns the path if the package exists in any of the folders. Null if the package does not exist.</returns>
</member>
<member name="M:NuGet.Packaging.FallbackPackagePathResolver.GetPackageDirectory(System.String,NuGet.Versioning.NuGetVersion)">
<summary>
Returns the root directory of an installed package.
</summary>
<param name="packageId">Package id.</param>
<param name="version">Package version.</param>
<returns>Returns the path if the package exists in any of the folders. Null if the package does not exist.</returns>
</member>
<member name="M:NuGet.Packaging.FallbackPackagePathResolver.GetPackageInfo(System.String,NuGet.Versioning.NuGetVersion)">
<summary>
Returns the package info along with a path resolver specific to the folder where the package exists.
</summary>
<param name="packageId">Package id.</param>
<param name="version">Package version.</param>
<returns>Returns the package info if the package exists in any of the folders. Null if the package does not exist.</returns>
</member>
<member name="T:NuGet.Packaging.IHashFunction">
<summary>
Provides incremental hashing.
This is non-private only to facilitate unit testing.
</summary>
</member>
<member name="M:NuGet.Packaging.IHashFunction.GetHash">
<summary>
Gets the hash.
Once GetHash is called, no further hash updates are allowed.
</summary>
<returns>A base64-encoded hash.</returns>
</member>
<member name="M:NuGet.Packaging.IHashFunction.Update(System.Byte[],System.Int32,System.Int32)">
<summary>
Incrementally updates the hash.
</summary>
<param name="data">The data to be included in the hash.</param>
<param name="offset">The offset from which data should be read.</param>
<param name="count">The count of bytes to read.</param>
</member>
<member name="T:NuGet.Packaging.Licenses.LicenseExpressionToken">
<summary>
Represents a token of a parsed license expression. The tokens are either operators, parentheses or values.
</summary>
</member>
<member name="P:NuGet.Packaging.Licenses.LicenseExpressionToken.TokenType">
<summary>
The token type
</summary>
</member>
<member name="P:NuGet.Packaging.Licenses.LicenseExpressionToken.Value">
<summary>
The value of this token.
</summary>
</member>
<member name="M:NuGet.Packaging.Licenses.LicenseExpressionTokenizer.#ctor(System.String)">
<summary>
A tokenizer for a license expression.
This implementation assumes that the input has been sanitized and that there are no invalid characters.
</summary>
<param name="value">value to be tokenized</param>
<exception cref="T:System.ArgumentException">If the string is null or whitespace.</exception>
</member>
<member name="M:NuGet.Packaging.Licenses.LicenseExpressionTokenizer.HasValidCharacters">
<summary>
The valid characters for a license identifier are a-zA-Z0-9.-+
The valid characters for a license expression are the above whitespace and ().
</summary>
<returns>Whether the value has valid characters.</returns>
</member>
<member name="M:NuGet.Packaging.Licenses.LicenseExpressionTokenizer.Tokenize">
<summary>
Given a string, tokenizes by space into operators and values. The considered operators are, AND, OR, WITH, (, and ).
</summary>
<returns>tokens, <see cref="T:NuGet.Packaging.Licenses.LicenseExpressionToken" />/></returns>
</member>
<member name="M:NuGet.Packaging.Licenses.LicenseExpressionTokenizer.ParseTokenType(System.String)">
<summary>
Parses a token type given a string.
This method assumes that the brackets have been parsed out.
</summary>
<param name="token">The token</param>
<returns>A parsed token, operator or value.</returns>
<remarks>This method assumes the brackets have already been parsed.</remarks>
</member>
<member name="T:NuGet.Packaging.Licenses.LicenseExpressionType">
<summary>
Represents the expression type of a <see cref="T:NuGet.Packaging.Licenses.NuGetLicenseExpression" />.
License type means that it's a <see cref="T:NuGet.Packaging.Licenses.NuGetLicense" />. Operator means that it's a <see cref="T:NuGet.Packaging.Licenses.LicenseOperator" />
</summary>
</member>
<member name="T:NuGet.Packaging.Licenses.LicenseOperator">
<summary>
A NuGetLicenseOperator. The operator options are: WITH or Logical operator, AND and OR.
This is an abstract class so based on the NuGetLicenseOperatorType, it can be either a <see cref="T:NuGet.Packaging.Licenses.WithOperator" /> or a <see cref="T:NuGet.Packaging.Licenses.LogicalOperator" />.
</summary>
</member>
<member name="P:NuGet.Packaging.Licenses.LicenseOperator.OperatorType">
<summary>
The operator type.
LogicalOperator means it's AND or OR and <see cref="T:NuGet.Packaging.Licenses.LogicalOperator" />
NuGetLicenseWithOperator means it's the WITH operator and <see cref="T:NuGet.Packaging.Licenses.WithOperator" />
</summary>
</member>
<member name="T:NuGet.Packaging.Licenses.LicenseOperatorType">
<summary>
Represents the type of <see cref="T:NuGet.Packaging.Licenses.LicenseOperator" /> <see cref="T:NuGet.Packaging.Licenses.NuGetLicenseExpression" />.
</summary>
</member>
<member name="T:NuGet.Packaging.Licenses.LicenseTokenType">
<summary>
The valid token types in a license expression. These are ordered by priority, be aware when changing them. See <seealso cref="T:NuGet.Packaging.Licenses.LicenseTokenTypeExtensions" />
</summary>
</member>
<member name="T:NuGet.Packaging.Licenses.LogicalOperator">
<summary>
A Logical Operator NuGetLicenseExpression.
It is either an OR or an AND operator, represented by <see cref="P:NuGet.Packaging.Licenses.LogicalOperator.LogicalOperatorType" />.
This operator will always have a left and a right side, both of which are <see cref="T:NuGet.Packaging.Licenses.NuGetLicenseExpression" /> and never null.
</summary>
</member>
<member name="P:NuGet.Packaging.Licenses.LogicalOperator.LogicalOperatorType">
<summary>
Represents the logical operator type of NuGetLicenseExpression.
</summary>
</member>
<member name="T:NuGet.Packaging.Licenses.LogicalOperatorType">
<summary>
Represents the logical operator type of a <see cref="T:NuGet.Packaging.Licenses.LogicalOperator" />.
</summary>
</member>
<member name="T:NuGet.Packaging.Licenses.NuGetLicense">
<summary>
NuGet's internal representation of a license identifier.
</summary>
</member>
<member name="P:NuGet.Packaging.Licenses.NuGetLicense.Identifier">
<summary>
Identifier
</summary>
</member>
<member name="P:NuGet.Packaging.Licenses.NuGetLicense.Plus">
<summary>
Signifies whether the plus operator has been specified on this license
</summary>
</member>
<member name="P:NuGet.Packaging.Licenses.NuGetLicense.IsStandardLicense">
<summary>
Signifies whether this is a standard license known by the NuGet APIs.
Pack for example should warn for these.
</summary>
</member>
<member name="M:NuGet.Packaging.Licenses.NuGetLicense.ParseIdentifier(System.String,System.Boolean)">
<summary>
Parse a licenseIdentifier. If a licenseIdentifier is deprecated, this will throw. Non-standard licenses get parsed into a object model as well.
</summary>
<param name="licenseIdentifier">license identifier to be parsed</param>
<param name="allowUnlicensed">Whether the parser allows the UNLICENSED identifier</param>
<returns>Prased NuGetLicense object</returns>
<exception cref="T:NuGet.Packaging.Licenses.NuGetLicenseExpressionParsingException">If the identifier is deprecated, contains invalid characters or is an exception identifier.</exception>
<exception cref="T:System.ArgumentException">If it's null or empty.</exception>
<remarks>The purpose of the <paramref name="allowUnlicensed" /> switch is to allow the expression parser communicate at which operand location the unlicensed identifier is legal. </remarks>
</member>
<member name="M:NuGet.Packaging.Licenses.NuGetLicense.HasValidCharacters(System.String)">
<summary>
The valid characters for a license identifier are a-zA-Z0-9.-
This method assumes that the trailing + operator has been stripped out.
</summary>
<param name="value">The value to be validated.</param>
<returns>whether the value has valid characters</returns>
</member>
<member name="T:NuGet.Packaging.Licenses.NuGetLicenseException">
<summary>
NuGet's internal representation of a license exception identifier.
</summary>
</member>
<member name="P:NuGet.Packaging.Licenses.NuGetLicenseException.Identifier">
<summary>
The Exception's identifier
</summary>
</member>
<member name="M:NuGet.Packaging.Licenses.NuGetLicenseException.ParseIdentifier(System.String)">
<summary>
Parse an exceptionIdentifier. If the exceptionIdentifier is deprecated, this will throw. Non-standard exception do not get parsed into an object model.
</summary>
<param name="exceptionIdentifier">Exception identifier to be parsed.</param>
<returns>Parsed License Exception</returns>
<exception cref="T:NuGet.Packaging.Licenses.NuGetLicenseExpressionParsingException">If the identifier is deprecated, is a license or simply does not exist.</exception>
<exception cref="T:System.ArgumentException">If it's null or empty.</exception>
</member>
<member name="T:NuGet.Packaging.Licenses.NuGetLicenseExpression">
<summary>
Represents a parsed NuGetLicenseExpression.
This is an abstract class so based on the Type, it can be either a <see cref="T:NuGet.Packaging.Licenses.NuGetLicense" /> or a <see cref="T:NuGet.Packaging.Licenses.LicenseOperator" />.
<seealso cref="T:NuGet.Packaging.Licenses.LicenseExpressionType" />
</summary>
</member>
<member name="P:NuGet.Packaging.Licenses.NuGetLicenseExpression.Type">
<summary>
The type of the NuGetLicenseExpression.
License type means that it's a <see cref="T:NuGet.Packaging.Licenses.NuGetLicense" />.
Operator means that it's a <see cref="T:NuGet.Packaging.Licenses.LicenseOperator" />
</summary>
</member>
<member name="M:NuGet.Packaging.Licenses.NuGetLicenseExpression.Parse(System.String)">
<summary>
Parses a License Expression if valid.
The expression would be parsed correct, even if non-standard exceptions are encountered.
The non-standard Licenses/Exceptions have metadata on them with which the caller can make decisions.
</summary>
<param name="expression">The expression to be parsed.</param>
<returns>Parsed NuGet License Expression model.</returns>
<exception cref="T:NuGet.Packaging.Licenses.NuGetLicenseExpressionParsingException">If the expression is empty or null.</exception>
<exception cref="T:NuGet.Packaging.Licenses.NuGetLicenseExpressionParsingException">If the expression has invalid characters</exception>
<exception cref="T:NuGet.Packaging.Licenses.NuGetLicenseExpressionParsingException">If the expression itself is invalid. Example: MIT OR OR Apache-2.0, or the MIT or Apache-2.0, because the expressions are case sensitive.</exception>
<exception cref="T:NuGet.Packaging.Licenses.NuGetLicenseExpressionParsingException">If the expression's brackets are mismatched.</exception>
<exception cref="T:NuGet.Packaging.Licenses.NuGetLicenseExpressionParsingException">If the licenseIdentifier is deprecated.</exception>
<exception cref="T:NuGet.Packaging.Licenses.NuGetLicenseExpressionParsingException">If the exception identifier is deprecated.</exception>
</member>
<member name="M:NuGet.Packaging.Licenses.NuGetLicenseExpressionExtensions.HasOnlyStandardIdentifiers(NuGet.Packaging.Licenses.NuGetLicenseExpression)">
<summary>
Determines whether all the licenses and exceptions are not deprecated.
</summary>
<param name="expression">expression to be validated</param>
<returns>Whether this expression consists of licenses with standard identifiers</returns>
</member>
<member name="M:NuGet.Packaging.Licenses.NuGetLicenseExpressionExtensions.OnEachLeafNode(NuGet.Packaging.Licenses.NuGetLicenseExpression,System.Action{NuGet.Packaging.Licenses.NuGetLicense},System.Action{NuGet.Packaging.Licenses.NuGetLicenseException})">
<summary>
A leaf node in an expression can only be a License or an Exception. Run a func on each one.
</summary>
<param name="expression">The expression to be walked.</param>
<param name="licenseProcessor">A processor for the licenses.</param>
<param name="exceptionProcessor">A processor for the exceptions.</param>
</member>
<member name="M:NuGet.Packaging.Licenses.NuGetLicenseExpressionParser.Parse(System.String)">
<summary>
Parses a License Expression if valid.
The expression would be parsed correct, even if non-standard exceptions are encountered. The non-standard Licenses/Exceptions have metadata on them with which the caller can make decisions.
Based on the Shunting Yard algorithm. <see href="https://en.wikipedia.org/wiki/Shunting-yard_algorithm" />
This method first creates an postfix expression by separating the operators and operands.
Later the postfix expression is evaluated into an object model that represents the expression. Note that brackets are dropped in this conversion and this is not round-trippable.
The token precedence helps make sure that the expression is a valid infix one.
</summary>
<param name="expression">The expression to be parsed.</param>
<returns>Parsed NuGet License Expression model.</returns>
<exception cref="T:NuGet.Packaging.Licenses.NuGetLicenseExpressionParsingException">If the expression is empty or null.</exception>
<exception cref="T:NuGet.Packaging.Licenses.NuGetLicenseExpressionParsingException">If the expression has invalid characters</exception>
<exception cref="T:NuGet.Packaging.Licenses.NuGetLicenseExpressionParsingException">If the expression itself is invalid. Example: MIT OR OR Apache-2.0, or the MIT or Apache-2.0, because the expressions are case sensitive.</exception>
<exception cref="T:NuGet.Packaging.Licenses.NuGetLicenseExpressionParsingException">If the expression's brackets are mismatched.</exception>
<exception cref="T:NuGet.Packaging.Licenses.NuGetLicenseExpressionParsingException">If the licenseIdentifier is deprecated.</exception>
<exception cref="T:NuGet.Packaging.Licenses.NuGetLicenseExpressionParsingException">If the exception identifier is deprecated.</exception>
</member>
<member name="M:NuGet.Packaging.Licenses.NuGetLicenseExpressionParser.GetTokens(System.String)">
<summary>
Tokenizes the expression as per the license expression rules. Throws if the string contains invalid characters.
</summary>
</member>
<member name="T:NuGet.Packaging.Licenses.WithOperator">
<summary>
Represents a <see cref="T:NuGet.Packaging.Licenses.NuGetLicenseExpression" /> that's a WITH operator.
It has a License and Exception.
</summary>
</member>
<member name="P:NuGet.Packaging.Licenses.WithOperator.License">
<summary>
The license.
</summary>
</member>
<member name="P:NuGet.Packaging.Licenses.WithOperator.Exception">
<summary>
The exception.
</summary>
</member>
<member name="T:NuGet.Packaging.LocalPackageArchiveDownloader">
<summary>
A package downloader for local archive packages.
</summary>
</member>
<member name="P:NuGet.Packaging.LocalPackageArchiveDownloader.ContentReader">
<summary>
Gets an asynchronous package content reader.
</summary>
<exception cref="T:System.ObjectDisposedException">Thrown if this object is disposed.</exception>
</member>
<member name="P:NuGet.Packaging.LocalPackageArchiveDownloader.CoreReader">
<summary>
Gets an asynchronous package core reader.
</summary>
<exception cref="T:System.ObjectDisposedException">Thrown if this object is disposed.</exception>
</member>
<member name="M:NuGet.Packaging.LocalPackageArchiveDownloader.#ctor(System.String,System.String,NuGet.Packaging.Core.PackageIdentity,NuGet.Common.ILogger)">
<summary>
Initializes a new <see cref="T:NuGet.Packaging.LocalPackageArchiveDownloader" /> class.
</summary>
<param name="source">A package source.</param>
<param name="packageFilePath">A source package archive file path.</param>
<param name="packageIdentity">A package identity.</param>
<param name="logger">A logger.</param>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="packageFilePath" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="packageIdentity" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="logger" />
is either <c>null</c> or an empty string.</exception>
</member>
<member name="M:NuGet.Packaging.LocalPackageArchiveDownloader.Dispose">
<summary>
Disposes of this instance.
</summary>
</member>
<member name="M:NuGet.Packaging.LocalPackageArchiveDownloader.CopyNupkgFileToAsync(System.String,System.Threading.CancellationToken)">
<summary>
Asynchronously copies a .nupkg to a target file path.
</summary>
<param name="destinationFilePath">The destination file path.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns a <see cref="T:System.Boolean" />
indicating whether or not the copy was successful.</returns>
<exception cref="T:System.ObjectDisposedException">Thrown if this object is disposed.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="destinationFilePath" />
is either <c>null</c> or empty.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Packaging.LocalPackageArchiveDownloader.GetPackageHashAsync(System.String,System.Threading.CancellationToken)">
<summary>
Asynchronously gets a package hash.
</summary>
<param name="hashAlgorithm">The hash algorithm.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns a <see cref="T:System.String" />
representing the package hash.</returns>
<exception cref="T:System.ObjectDisposedException">Thrown if this object is disposed.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="hashAlgorithm" />
is either <c>null</c> or empty.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Packaging.LocalPackageArchiveDownloader.SetExceptionHandler(System.Func{System.Exception,System.Threading.Tasks.Task{System.Boolean}})">
<summary>
Sets an exception handler for package downloads.
</summary>
<remarks>The exception handler returns a task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns a <see cref="T:System.Boolean" />
indicating whether or not the exception was handled. To handle an exception and stop its
propagation, the task should return <c>true</c>. Otherwise, the exception will be rethrown.</remarks>
<param name="handleExceptionAsync">An exception handler.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="handleExceptionAsync" />
is <c>null</c>.</exception>
</member>
<member name="M:NuGet.Packaging.LocalPackageArchiveDownloader.SetThrottle(System.Threading.SemaphoreSlim)">
<summary>
Sets a throttle for package downloads.
</summary>
<param name="throttle">A throttle. Can be <c>null</c>.</param>
</member>
<member name="T:NuGet.Packaging.MinClientVersionUtility">
<summary>
Helpers for dealing with the NuGet client version and package minClientVersions.
</summary>
</member>
<member name="M:NuGet.Packaging.MinClientVersionUtility.VerifyMinClientVersion(NuGet.Packaging.Core.NuspecCoreReaderBase)">
<summary>
Check the package minClientVersion and throw if it is greater than the current client version.
</summary>
</member>
<member name="M:NuGet.Packaging.MinClientVersionUtility.IsMinClientVersionCompatible(NuGet.Packaging.Core.NuspecCoreReaderBase)">
<summary>
Verify minClientVersion.
</summary>
</member>
<member name="M:NuGet.Packaging.MinClientVersionUtility.IsMinClientVersionCompatible(NuGet.Versioning.NuGetVersion)">
<summary>
Verify minClientVersion.
</summary>
</member>
<member name="M:NuGet.Packaging.MinClientVersionUtility.GetNuGetClientVersion">
<summary>
Read the NuGet client version from the assembly info as a NuGetVersion.
</summary>
</member>
<member name="T:NuGet.Packaging.NuspecReader">
<summary>
Reads .nuspec files
</summary>
</member>
<member name="M:NuGet.Packaging.NuspecReader.#ctor(System.String)">
<summary>
Nuspec file reader.
</summary>
</member>
<member name="M:NuGet.Packaging.NuspecReader.#ctor(System.String,NuGet.Frameworks.IFrameworkNameProvider)">
<summary>
Nuspec file reader.
</summary>
</member>
<member name="M:NuGet.Packaging.NuspecReader.#ctor(System.IO.Stream)">
<summary>
Nuspec file reader
</summary>
<param name="stream">Nuspec file stream.</param>
</member>
<member name="M:NuGet.Packaging.NuspecReader.#ctor(System.Xml.Linq.XDocument)">
<summary>
Nuspec file reader
</summary>
<param name="xml">Nuspec file xml data.</param>
</member>
<member name="M:NuGet.Packaging.NuspecReader.#ctor(System.IO.Stream,NuGet.Frameworks.IFrameworkNameProvider,System.Boolean)">
<summary>
Nuspec file reader
</summary>
<param name="stream">Nuspec file stream.</param>
<param name="frameworkProvider">Framework mapping provider for NuGetFramework parsing.</param>
</member>
<member name="M:NuGet.Packaging.NuspecReader.#ctor(System.Xml.Linq.XDocument,NuGet.Frameworks.IFrameworkNameProvider)">
<summary>
Nuspec file reader
</summary>
<param name="xml">Nuspec file xml data.</param>
<param name="frameworkProvider">Framework mapping provider for NuGetFramework parsing.</param>
</member>
<member name="M:NuGet.Packaging.NuspecReader.GetDependencyGroups">
<summary>
Read package dependencies for all frameworks
</summary>
</member>
<member name="M:NuGet.Packaging.NuspecReader.GetDependencyGroups(System.Boolean)">
<summary>
Read package dependencies for all frameworks
</summary>
</member>
<member name="M:NuGet.Packaging.NuspecReader.GetReferenceGroups">
<summary>
Reference item groups
</summary>
</member>
<member name="M:NuGet.Packaging.NuspecReader.GetFrameworkReferenceGroups">
<summary>
Framework assembly groups
</summary>
</member>
<member name="M:NuGet.Packaging.NuspecReader.GetFrameworkAssemblyGroups">
<summary>
Framework assembly groups
</summary>
</member>
<member name="M:NuGet.Packaging.NuspecReader.GetLanguage">
<summary>
Package language
</summary>
</member>
<member name="M:NuGet.Packaging.NuspecReader.GetLicenseUrl">
<summary>
Package License Url
</summary>
</member>
<member name="M:NuGet.Packaging.NuspecReader.GetContentFiles">
<summary>
Build action groups
</summary>
</member>
<member name="M:NuGet.Packaging.NuspecReader.GetTitle">
<summary>
Package title.
</summary>
</member>
<member name="M:NuGet.Packaging.NuspecReader.GetAuthors">
<summary>
Package authors.
</summary>
</member>
<member name="M:NuGet.Packaging.NuspecReader.GetTags">
<summary>
Package tags.
</summary>
</member>
<member name="M:NuGet.Packaging.NuspecReader.GetOwners">
<summary>
Package owners.
</summary>
</member>
<member name="M:NuGet.Packaging.NuspecReader.GetDescription">
<summary>
Package description.
</summary>
</member>
<member name="M:NuGet.Packaging.NuspecReader.GetReleaseNotes">
<summary>
Package release notes.
</summary>
</member>
<member name="M:NuGet.Packaging.NuspecReader.GetSummary">
<summary>
Package summary.
</summary>
</member>
<member name="M:NuGet.Packaging.NuspecReader.GetProjectUrl">
<summary>
Package project url.
</summary>
</member>
<member name="M:NuGet.Packaging.NuspecReader.GetIconUrl">
<summary>
Package icon url.
</summary>
</member>
<member name="M:NuGet.Packaging.NuspecReader.GetCopyright">
<summary>
Copyright information.
</summary>
</member>
<member name="M:NuGet.Packaging.NuspecReader.GetRepositoryMetadata">
<summary>
Source control repository information.
</summary>
</member>
<member name="M:NuGet.Packaging.NuspecReader.GetLicenseMetadata">
<summary>
Parses the license object if specified.
The metadata can be of 2 types, Expression and File.
The method will not fail if it sees values that invalid (empty/unparseable license etc), but it will rather add validation errors/warnings.
</summary>
<remarks>This method never throws. Bad data is still parsed. </remarks>
<returns>The licensemetadata if specified</returns>
</member>
<member name="M:NuGet.Packaging.NuspecReader.GetRequireLicenseAcceptance">
<summary>
Require license acceptance when installing the package.
</summary>
</member>
<member name="M:NuGet.Packaging.NuspecReader.GetFrameworkRefGroups">
<summary>
Read package dependencies for all frameworks
</summary>
</member>
<member name="M:NuGet.Packaging.NuspecReader.GetIcon">
<summary>
Gets the icon metadata from the .nuspec
</summary>
<returns>A string containing the icon path or null if no icon entry is found</returns>
</member>
<member name="M:NuGet.Packaging.NuspecReader.GetReadme">
<summary>
Gets the readme metadata from the .nuspec
</summary>
<returns>A string containing the readme path or null if no readme entry is found</returns>
</member>
<member name="T:NuGet.Packaging.PackageArchiveReader">
<summary>
Reads a development nupkg
</summary>
</member>
<member name="P:NuGet.Packaging.PackageArchiveReader.SigningSpecifications">
<summary>
Signature specifications.
</summary>
</member>
<member name="P:NuGet.Packaging.PackageArchiveReader.ZipReadStream">
<summary>
Stream underlying the ZipArchive. Used to do signature verification on a SignedPackageArchive.
If this is null then we cannot perform signature verification.
</summary>
</member>
<member name="F:NuGet.Packaging.PackageArchiveReader._isSigned">
<summary>
True if the package is signed
</summary>
</member>
<member name="M:NuGet.Packaging.PackageArchiveReader.#ctor(NuGet.Frameworks.IFrameworkNameProvider,NuGet.Frameworks.IFrameworkCompatibilityProvider)">
<summary>
Nupkg package reader
</summary>
<param name="frameworkProvider">Framework mapping provider for NuGetFramework parsing.</param>
<param name="compatibilityProvider">Framework compatibility provider.</param>
</member>
<member name="M:NuGet.Packaging.PackageArchiveReader.#ctor(System.IO.Stream)">
<summary>
Nupkg package reader
</summary>
<param name="stream">Nupkg data stream.</param>
</member>
<member name="M:NuGet.Packaging.PackageArchiveReader.#ctor(System.IO.Stream,NuGet.Frameworks.IFrameworkNameProvider,NuGet.Frameworks.IFrameworkCompatibilityProvider)">
<summary>
Nupkg package reader
</summary>
<param name="stream">Nupkg data stream.</param>
<param name="frameworkProvider">Framework mapping provider for NuGetFramework parsing.</param>
<param name="compatibilityProvider">Framework compatibility provider.</param>
</member>
<member name="M:NuGet.Packaging.PackageArchiveReader.#ctor(System.IO.Stream,System.Boolean)">
<summary>
Nupkg package reader
</summary>
<param name="stream">Nupkg data stream.</param>
<param name="leaveStreamOpen">If true the nupkg stream will not be closed by the zip reader.</param>
</member>
<member name="M:NuGet.Packaging.PackageArchiveReader.#ctor(System.IO.Stream,System.Boolean,NuGet.Frameworks.IFrameworkNameProvider,NuGet.Frameworks.IFrameworkCompatibilityProvider)">
<summary>
Nupkg package reader
</summary>
<param name="stream">Nupkg data stream.</param>
<param name="leaveStreamOpen">leave nupkg stream open</param>
<param name="frameworkProvider">Framework mapping provider for NuGetFramework parsing.</param>
<param name="compatibilityProvider">Framework compatibility provider.</param>
</member>
<member name="M:NuGet.Packaging.PackageArchiveReader.#ctor(System.IO.Compression.ZipArchive)">
<summary>
Nupkg package reader
</summary>
<param name="zipArchive">ZipArchive containing the nupkg data.</param>
</member>
<member name="M:NuGet.Packaging.PackageArchiveReader.#ctor(System.IO.Compression.ZipArchive,NuGet.Frameworks.IFrameworkNameProvider,NuGet.Frameworks.IFrameworkCompatibilityProvider)">
<summary>
Nupkg package reader
</summary>
<param name="zipArchive">ZipArchive containing the nupkg data.</param>
<param name="frameworkProvider">Framework mapping provider for NuGetFramework parsing.</param>
<param name="compatibilityProvider">Framework compatibility provider.</param>
</member>
<member name="M:NuGet.Packaging.PackageArchiveReader.CopyNupkgAsync(System.String,System.Threading.CancellationToken)">
<summary>
Asynchronously copies a package to the specified destination file path.
</summary>
<param name="nupkgFilePath">The destination file path.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns a <see cref="T:System.String" />.</returns>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="nupkgFilePath" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="T:NuGet.Packaging.PackageArchiveReader.SizedArchiveEntryStream">
<summary>
This class literally just exists so CopyToFile gets a file size
</summary>
</member>
<member name="M:NuGet.Packaging.PackageArchiveReader.ValidatePackageEntriesAsync(System.Threading.CancellationToken)">
<summary>
Validate all files in package are not traversed outside of the expected extraction path.
Eg: file entry like ../../foo.dll can get outside of the expected extraction path.
</summary>
</member>
<member name="T:NuGet.Packaging.EmptyFrameworkFolderFile">
<summary>
Represents an empty framework folder in NuGet 2.0+ packages.
An empty framework folder is represented by a file named "_._".
</summary>
</member>
<member name="P:NuGet.Packaging.IPackageFile.Path">
<summary>
Gets the full path of the file inside the package.
</summary>
</member>
<member name="P:NuGet.Packaging.IPackageFile.EffectivePath">
<summary>
Gets the path that excludes the root folder (content/lib/tools) and framework folder (if present).
</summary>
<example>
If a package has the Path as 'content\[net40]\scripts\jQuery.js', the EffectivePath
will be 'scripts\jQuery.js'.
If it is 'tools\init.ps1', the EffectivePath will be 'init.ps1'.
</example>
</member>
<member name="P:NuGet.Packaging.IPackageFile.TargetFramework">
<summary>
FrameworkName object representing this package file's target framework. Deprecated. Must be null on net5.0 and greater.
</summary>
</member>
<member name="P:NuGet.Packaging.IPackageFile.NuGetFramework">
<summary>
NuGetFramework object representing this package file's target framework. Use this instead of TargetFramework.
</summary>
</member>
<member name="P:NuGet.Packaging.IPackageMetadata.FrameworkReferences">
<summary>
Specifies assemblies from GAC that the package depends on.
</summary>
</member>
<member name="P:NuGet.Packaging.IPackageMetadata.PackageAssemblyReferences">
<summary>
Returns sets of References specified in the manifest.
</summary>
</member>
<member name="P:NuGet.Packaging.IPackageMetadata.DependencyGroups">
<summary>
Specifies sets other packages that the package depends on.
</summary>
</member>
<member name="P:NuGet.Packaging.IPackageMetadata.ContentFiles">
<summary>
Returns sets of Content Files specified in the manifest.
</summary>
</member>
<member name="T:NuGet.Packaging.LicenseMetadata">
<summary>
Represents the Package LicenseMetadata details.
All the relevant warnings and errors should parsed into this model and ideally the readers of this metadata never throw.
</summary>
</member>
<member name="P:NuGet.Packaging.LicenseMetadata.Type">
<summary>
The LicenseType, never null
</summary>
</member>
<member name="P:NuGet.Packaging.LicenseMetadata.License">
<summary>
The license, never null, could be empty.
</summary>
</member>
<member name="P:NuGet.Packaging.LicenseMetadata.LicenseExpression">
<summary>
The license expression, could be null if the version is higher than the current supported or if the expression is not parseable.
</summary>
</member>
<member name="P:NuGet.Packaging.LicenseMetadata.WarningsAndErrors">
<summary>
Non-null when the expression parsing yielded some issues. This will be used to display the errors/warnings in the UI. Only populated when the metadata element is returned by the nuspec reader;
</summary>
</member>
<member name="P:NuGet.Packaging.LicenseMetadata.Version">
<summary>
LicenseMetadata (expression) version. Never null.
</summary>
</member>
<member name="M:NuGet.Packaging.Manifest.Save(System.IO.Stream)">
<summary>
Saves the current manifest to the specified stream.
</summary>
<param name="stream">The target stream.</param>
</member>
<member name="M:NuGet.Packaging.Manifest.Save(System.IO.Stream,System.Boolean)">
<summary>
Saves the current manifest to the specified stream.
</summary>
<param name="stream">The target stream.</param>
<param name="generateBackwardsCompatible">Write out a manifest that's consumable by legacy clients, by adding any necessary translations into legacy fields.</param>
</member>
<member name="M:NuGet.Packaging.Manifest.Save(System.IO.Stream,System.Int32)">
<summary>
Saves the current manifest to the specified stream.
</summary>
<param name="stream">The target stream.</param>
<param name="minimumManifestVersion">The minimum manifest version that this class must use when saving.</param>
</member>
<member name="M:NuGet.Packaging.Manifest.Save(System.IO.Stream,System.Int32,System.Boolean)">
<summary>
Saves the current manifest to the specified stream.
</summary>
<param name="stream">The target stream.</param>
<param name="minimumManifestVersion">The minimum manifest version that this class must use when saving.</param>
<param name="generateBackwardsCompatible">Write out a manifest that's consumable by legacy clients, by adding any necessary translations into legacy fields.</param>
</member>
<member name="T:NuGet.Packaging.ManifestMetadata">
<summary>
Manifest (user created .nuspec) file metadata model
</summary>
</member>
<member name="M:NuGet.Packaging.ManifestMetadata.#ctor(NuGet.Packaging.IPackageMetadata)">
<summary>
Constructs a ManifestMetadata instance from an IPackageMetadata instance
</summary>
</member>
<member name="M:NuGet.Packaging.ManifestMetadata.Validate">
<summary>
Checks that the metadata in the nuspec is enough to create a package
</summary>
<returns>A iterable collection with the validation error messages</returns>
<remarks>Error codes are not associated with the validation error messages returned</remarks>
</member>
<member name="F:NuGet.Packaging.ManifestSchemaUtility.SchemaVersionV1">
<summary>
Baseline schema
</summary>
</member>
<member name="F:NuGet.Packaging.ManifestSchemaUtility.SchemaVersionV2">
<summary>
Added copyrights, references and release notes
</summary>
</member>
<member name="F:NuGet.Packaging.ManifestSchemaUtility.SchemaVersionV3">
<summary>
Used if the version is a semantic version.
</summary>
</member>
<member name="F:NuGet.Packaging.ManifestSchemaUtility.SchemaVersionV4">
<summary>
Added 'targetFramework' attribute for 'dependency' elements.
Allow framework folders under 'content' and 'tools' folders.
</summary>
</member>
<member name="F:NuGet.Packaging.ManifestSchemaUtility.SchemaVersionV5">
<summary>
Added 'targetFramework' attribute for 'references' elements.
Added 'minClientVersion' attribute
</summary>
</member>
<member name="F:NuGet.Packaging.ManifestSchemaUtility.SchemaVersionV6">
<summary>
Allows XDT transformation
</summary>
</member>
<member name="F:NuGet.Packaging.PackageBuilder.MaxIconFileSize">
<summary>
Maximum Icon file size: 1 megabyte
</summary>
</member>
<member name="P:NuGet.Packaging.PackageBuilder.Properties">
<summary>
Exposes the additional properties extracted by the metadata
extractor or received from the command line.
</summary>
</member>
<member name="P:NuGet.Packaging.PackageBuilder.ContentFiles">
<summary>
ContentFiles section from the manifest for content v2
</summary>
</member>
<member name="M:NuGet.Packaging.PackageBuilder.FindFileInPackage(System.String,System.Collections.Generic.IEnumerable{NuGet.Packaging.IPackageFile},System.String@)">
<summary>Looks for the specified file within the package</summary>
<param name="filePath">The file path to search for</param>
<param name="packageFiles">The list of files to search within</param>
<param name="filePathIncorrectCase">If the file was not found, this will be a path which almost matched but had the incorrect case</param>
<returns>An <see cref="T:NuGet.Packaging.IPackageFile" /> matching the specified path or <c>null</c></returns>
</member>
<member name="M:NuGet.Packaging.PackageBuilder.ValidateIconFile(System.Collections.Generic.IEnumerable{NuGet.Packaging.IPackageFile},System.String)">
<summary>
Given a list of resolved files,
determine which file will be used as the icon file and validate its size and extension.
</summary>
<param name="files">Files resolved from the file entries in the nuspec</param>
<param name="iconPath">icon entry found in the .nuspec</param>
<exception cref="T:NuGet.Packaging.Core.PackagingException">When a validation rule is not met</exception>
</member>
<member name="M:NuGet.Packaging.PackageBuilder.ValidateReadmeFile(System.Collections.Generic.IEnumerable{NuGet.Packaging.IPackageFile},System.String)">
<summary>
Validate that the readme file is of the correct size/type and can be opened properly except for Symbol packages.
</summary>
<param name="files">Files resolved from the file entries in the nuspec</param>
<param name="readmePath">readmepath found in the .nuspec</param>
<exception cref="T:NuGet.Packaging.Core.PackagingException">When a validation rule is not met</exception>
</member>
<member name="M:NuGet.Packaging.PackageBuilder.ResolvePackagePath(System.String,System.String,System.String,System.String)">
<summary>
Determins the path of the file inside a package.
For recursive wildcard paths, we preserve the path portion beginning with the wildcard.
For non-recursive wildcard paths, we use the file name from the actual file path on disk.
</summary>
</member>
<member name="M:NuGet.Packaging.PackageBuilder.IsKnownFolder(System.String)">
<summary>
Returns true if the path uses a known folder root.
</summary>
</member>
<member name="M:NuGet.Packaging.PackageBuilder.ParseTags(System.String)">
<summary>
Tags come in this format. tag1 tag2 tag3 etc..
</summary>
</member>
<member name="M:NuGet.Packaging.PackageReferenceSet.#ctor(System.Collections.Generic.IEnumerable{System.String})">
<summary>
Creates a new Package Reference Set
</summary>
<param name="references">IEnumerable set of string references</param>
</member>
<member name="M:NuGet.Packaging.PackageReferenceSet.#ctor(System.String,System.Collections.Generic.IEnumerable{System.String})">
<summary>
Creates a new Package Reference Set
</summary>
<param name="targetFramework">The target framework to use, pass Any for AnyFramework. Does not allow null.</param>
<param name="references">IEnumerable set of string references</param>
</member>
<member name="M:NuGet.Packaging.PackageReferenceSet.#ctor(NuGet.Frameworks.NuGetFramework,System.Collections.Generic.IEnumerable{System.String})">
<summary>
Creates a new Package Reference Set
</summary>
<param name="targetFramework">The target framework to use.</param>
<param name="references">IEnumerable set of string references</param>
</member>
<member name="P:NuGet.Packaging.PhysicalPackageFile.SourcePath">
<summary>
Path on disk
</summary>
</member>
<member name="P:NuGet.Packaging.PhysicalPackageFile.TargetPath">
<summary>
Path in package
</summary>
</member>
<member name="T:NuGet.Packaging.PackageCreation.Resources.NuGetResources">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:NuGet.Packaging.PackageCreation.Resources.NuGetResources.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:NuGet.Packaging.PackageCreation.Resources.NuGetResources.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:NuGet.Packaging.PackageCreation.Resources.NuGetResources.CannotCreateEmptyPackage">
<summary>
Looks up a localized string similar to Cannot create a package that has no dependencies nor content..
</summary>
</member>
<member name="P:NuGet.Packaging.PackageCreation.Resources.NuGetResources.DependencyHasInvalidVersion">
<summary>
Looks up a localized string similar to Dependency '{0}' has an invalid version..
</summary>
</member>
<member name="P:NuGet.Packaging.PackageCreation.Resources.NuGetResources.DuplicateDependenciesDefined">
<summary>
Looks up a localized string similar to '{0}' already has a dependency defined for '{1}'..
</summary>
</member>
<member name="P:NuGet.Packaging.PackageCreation.Resources.NuGetResources.FoundDuplicateFile">
<summary>
Looks up a localized string similar to Attempted to pack multiple files into the same location(s). The following destinations were used multiple times: {0}.
</summary>
</member>
<member name="P:NuGet.Packaging.PackageCreation.Resources.NuGetResources.IconCannotOpenFile">
<summary>
Looks up a localized string similar to Cannot open the icon file '{0}': {1}..
</summary>
</member>
<member name="P:NuGet.Packaging.PackageCreation.Resources.NuGetResources.IconErrorEmpty">
<summary>
Looks up a localized string similar to The icon file is empty..
</summary>
</member>
<member name="P:NuGet.Packaging.PackageCreation.Resources.NuGetResources.IconInvalidExtension">
<summary>
Looks up a localized string similar to The 'icon' element '{0}' has an invalid file extension. Valid options are .png, .jpg or .jpeg..
</summary>
</member>
<member name="P:NuGet.Packaging.PackageCreation.Resources.NuGetResources.IconMaxFileSizeExceeded">
<summary>
Looks up a localized string similar to The icon file size must not exceed 1 megabyte..
</summary>
</member>
<member name="P:NuGet.Packaging.PackageCreation.Resources.NuGetResources.IconMissingRequiredValue">
<summary>
Looks up a localized string similar to The element 'icon' cannot be empty..
</summary>
</member>
<member name="P:NuGet.Packaging.PackageCreation.Resources.NuGetResources.IconNoFileElement">
<summary>
Looks up a localized string similar to The icon file '{0}' does not exist in the package..
</summary>
</member>
<member name="P:NuGet.Packaging.PackageCreation.Resources.NuGetResources.IconNoFileElementWithHint">
<summary>
Looks up a localized string similar to The icon file '{0}' does not exist in the package. (Did you mean '{1}'?).
</summary>
</member>
<member name="P:NuGet.Packaging.PackageCreation.Resources.NuGetResources.IncompatibleSchema">
<summary>
Looks up a localized string similar to The schema version of '{0}' is incompatible with version {1} of NuGet. Please upgrade NuGet to the latest version from http://go.microsoft.com/fwlink/?LinkId=213942..
</summary>
</member>
<member name="P:NuGet.Packaging.PackageCreation.Resources.NuGetResources.InvalidPackageId">
<summary>
Looks up a localized string similar to The package ID '{0}' contains invalid characters. Examples of valid package IDs include 'MyPackage' and 'MyPackage.Sample'..
</summary>
</member>
<member name="P:NuGet.Packaging.PackageCreation.Resources.NuGetResources.Manifest_DependenciesHasMixedElements">
<summary>
Looks up a localized string similar to <dependencies> element must not contain both <group> and <dependency> child elements..
</summary>
</member>
<member name="P:NuGet.Packaging.PackageCreation.Resources.NuGetResources.Manifest_ExcludeContainsInvalidCharacters">
<summary>
Looks up a localized string similar to Exclude path '{0}' contains invalid characters..
</summary>
</member>
<member name="P:NuGet.Packaging.PackageCreation.Resources.NuGetResources.Manifest_IdMaxLengthExceeded">
<summary>
Looks up a localized string similar to Id must not exceed 100 characters..
</summary>
</member>
<member name="P:NuGet.Packaging.PackageCreation.Resources.NuGetResources.Manifest_InvalidMinClientVersion">
<summary>
Looks up a localized string similar to The 'minClientVersion' attribute in the package manifest has invalid value. It must be a valid version string..
</summary>
</member>
<member name="P:NuGet.Packaging.PackageCreation.Resources.NuGetResources.Manifest_InvalidReference">
<summary>
Looks up a localized string similar to Invalid assembly reference '{0}'. Ensure that a file named '{0}' exists in the lib directory..
</summary>
</member>
<member name="P:NuGet.Packaging.PackageCreation.Resources.NuGetResources.Manifest_InvalidReferenceFile">
<summary>
Looks up a localized string similar to Assembly reference '{0}' contains invalid characters..
</summary>
</member>
<member name="P:NuGet.Packaging.PackageCreation.Resources.NuGetResources.Manifest_LicenseFileExtensionIsInvalid">
<summary>
Looks up a localized string similar to The license file '{0}' has an invalid extension. Valid options are .txt, .md or none..
</summary>
</member>
<member name="P:NuGet.Packaging.PackageCreation.Resources.NuGetResources.Manifest_LicenseFileIsNotInNupkg">
<summary>
Looks up a localized string similar to The license file '{0}' does not exist in the package..
</summary>
</member>
<member name="P:NuGet.Packaging.PackageCreation.Resources.NuGetResources.Manifest_LicenseFileIsNotInNupkgWithHint">
<summary>
Looks up a localized string similar to The license file '{0}' does not exist in the package. (Did you mean '{1}'?).
</summary>
</member>
<member name="P:NuGet.Packaging.PackageCreation.Resources.NuGetResources.Manifest_LicenseUrlCannotBeUsedWithLicenseMetadata">
<summary>
Looks up a localized string similar to The licenseUrl and license elements cannot be used together..
</summary>
</member>
<member name="P:NuGet.Packaging.PackageCreation.Resources.NuGetResources.Manifest_PropertyValueReadFailure">
<summary>
Looks up a localized string similar to An error occured while trying to parse the value '{0}' of property '{1}' in the manifest file..
</summary>
</member>
<member name="P:NuGet.Packaging.PackageCreation.Resources.NuGetResources.Manifest_ReferencesHasMixedElements">
<summary>
Looks up a localized string similar to <references> element must not contain both <group> and <reference> child elements..
</summary>
</member>
<member name="P:NuGet.Packaging.PackageCreation.Resources.NuGetResources.Manifest_ReferencesIsEmpty">
<summary>
Looks up a localized string similar to The element package\metadata\references\group must contain at least one <reference> child element..
</summary>
</member>
<member name="P:NuGet.Packaging.PackageCreation.Resources.NuGetResources.Manifest_RequiredElementMissing">
<summary>
Looks up a localized string similar to The required element '{0}' is missing from the manifest..
</summary>
</member>
<member name="P:NuGet.Packaging.PackageCreation.Resources.NuGetResources.Manifest_RequiredMetadataMissing">
<summary>
Looks up a localized string similar to {0} is required..
</summary>
</member>
<member name="P:NuGet.Packaging.PackageCreation.Resources.NuGetResources.Manifest_RequireLicenseAcceptanceRequiresEmit">
<summary>
Looks up a localized string similar to EmitRequireLicenseAcceptance must not be set to false if RequireLicenseAcceptance is set to true..
</summary>
</member>
<member name="P:NuGet.Packaging.PackageCreation.Resources.NuGetResources.Manifest_RequireLicenseAcceptanceRequiresLicenseUrl">
<summary>
Looks up a localized string similar to Enabling license acceptance requires a license or a licenseUrl to be specified. The licenseUrl will be deprecated, consider using the license metadata..
</summary>
</member>
<member name="P:NuGet.Packaging.PackageCreation.Resources.NuGetResources.Manifest_SourceContainsInvalidCharacters">
<summary>
Looks up a localized string similar to Source path '{0}' contains invalid characters..
</summary>
</member>
<member name="P:NuGet.Packaging.PackageCreation.Resources.NuGetResources.Manifest_TargetContainsInvalidCharacters">
<summary>
Looks up a localized string similar to Target path '{0}' contains invalid characters..
</summary>
</member>
<member name="P:NuGet.Packaging.PackageCreation.Resources.NuGetResources.Manifest_UriCannotBeEmpty">
<summary>
Looks up a localized string similar to {0} cannot be empty..
</summary>
</member>
<member name="P:NuGet.Packaging.PackageCreation.Resources.NuGetResources.PackageAuthoring_FileNotFound">
<summary>
Looks up a localized string similar to File not found: '{0}'..
</summary>
</member>
<member name="P:NuGet.Packaging.PackageCreation.Resources.NuGetResources.ReadmeCannotOpenFile">
<summary>
Looks up a localized string similar to Cannot open the readme file '{0}': {1}..
</summary>
</member>
<member name="P:NuGet.Packaging.PackageCreation.Resources.NuGetResources.ReadmeErrorEmpty">
<summary>
Looks up a localized string similar to The readme file is empty..
</summary>
</member>
<member name="P:NuGet.Packaging.PackageCreation.Resources.NuGetResources.ReadmeFileExtensionIsInvalid">
<summary>
Looks up a localized string similar to The readme file '{0}' has an invalid extension..
</summary>
</member>
<member name="P:NuGet.Packaging.PackageCreation.Resources.NuGetResources.ReadmeMissingRequiredValue">
<summary>
Looks up a localized string similar to The element 'readme' cannot be empty..
</summary>
</member>
<member name="P:NuGet.Packaging.PackageCreation.Resources.NuGetResources.ReadmeNoFileElement">
<summary>
Looks up a localized string similar to The readme file '{0}' does not exist in the package..
</summary>
</member>
<member name="P:NuGet.Packaging.PackageCreation.Resources.NuGetResources.UnknownSchemaVersion">
<summary>
Looks up a localized string similar to Unknown schema version '{0}'..
</summary>
</member>
<member name="M:NuGet.Packaging.FrameworkNameUtility.ParseFrameworkFolderName(System.String,System.Boolean,System.String@)">
<summary>
Parses the specified string into FrameworkName object.
</summary>
<param name="path">The string to be parse.</param>
<param name="strictParsing">if set to <c>true</c>, parse the first folder of path even if it is unrecognized framework.</param>
<param name="effectivePath">returns the path after the parsed target framework</param>
<returns></returns>
</member>
<member name="M:NuGet.Packaging.FrameworkNameUtility.ParseNuGetFrameworkFolderName(System.String,System.Boolean,System.String@)">
<summary>
Parses the specified string into FrameworkName object.
</summary>
<param name="path">The string to be parse.</param>
<param name="strictParsing">if set to <c>true</c>, parse the first folder of path even if it is unrecognized framework.</param>
<param name="effectivePath">returns the path after the parsed target framework</param>
<returns></returns>
</member>
<member name="F:NuGet.Packaging.PackageIdValidator.MaxPackageIdLength">
<summary>
Max allowed length for package Id.
In case update this value please update in src\NuGet.Core\NuGet.Configuration\PackageSourceMapping\PackageSourceMapping.cs too.
</summary>
</member>
<member name="P:NuGet.Packaging.PackageExtraction.PackageExtractionBehavior.XmlDocFileSaveMode">
<summary>
Gets or sets the <see cref="!:PackageExtraction.XmlDocFileSaveMode" />.
</summary>
</member>
<member name="P:NuGet.Packaging.PackageExtractionContext.SignedPackageVerifier">
<remarks>
This property should only be used to override the default verifier on tests.
It is public only so that NuGet.Commands.RestoreRequest can pass this property through
</remarks>
</member>
<member name="M:NuGet.Packaging.PackageHelper.GetSatellitePackageInfoAsync(NuGet.Packaging.Core.IAsyncPackageCoreReader,System.Threading.CancellationToken)">
<summary>
A package is deemed to be a satellite package if it has a language property set, the id of the package is
of the format [.*].[Language]
and it has at least one dependency with an id that maps to the runtime package .
</summary>
</member>
<member name="M:NuGet.Packaging.PackageHelper.GetInstalledPackageFilesAsync(NuGet.Packaging.PackageArchiveReader,NuGet.Packaging.Core.PackageIdentity,NuGet.Packaging.PackagePathResolver,NuGet.Packaging.PackageSaveMode,System.Threading.CancellationToken)">
<summary>
This returns all the installed package files (does not include satellite files)
</summary>
</member>
<member name="F:NuGet.Packaging.PackageSaveMode.Defaultv2">
<summary>
Default package save mode for v2 (packages.config)-style restore.
This includes <see cref="F:NuGet.Packaging.PackageSaveMode.Files" /> and <see cref="F:NuGet.Packaging.PackageSaveMode.Nupkg" />.
</summary>
</member>
<member name="F:NuGet.Packaging.PackageSaveMode.Defaultv3">
<summary>
Default package save mode for v3 (project.json)-style restore.
This includes <see cref="F:NuGet.Packaging.PackageSaveMode.Files" />, <see cref="F:NuGet.Packaging.PackageSaveMode.Nuspec" />, and <see cref="F:NuGet.Packaging.PackageSaveMode.Nupkg" />.
</summary>
</member>
<member name="F:NuGet.Packaging.XmlDocFileSaveMode.None">
<summary>
Treat XML doc files as regular files (legacy behavior).
</summary>
</member>
<member name="F:NuGet.Packaging.XmlDocFileSaveMode.Skip">
<summary>
Do not extract XML documentation files
</summary>
</member>
<member name="F:NuGet.Packaging.XmlDocFileSaveMode.Compress">
<summary>
Compress XML doc files in a zip archive.
</summary>
</member>
<member name="T:NuGet.Packaging.ZipArchiveExtensions">
<summary>
Nupkg reading helper methods
</summary>
</member>
<member name="M:NuGet.Packaging.PackageExtractor.InstallFromSourceAsync(System.String,NuGet.Packaging.Core.PackageIdentity,System.Func{System.IO.Stream,System.Threading.Tasks.Task},NuGet.Packaging.VersionFolderPathResolver,NuGet.Packaging.PackageExtractionContext,System.Threading.CancellationToken,System.Guid)">
<summary>
Uses a copy function to install a package to a global packages directory.
</summary>
<param name="copyToAsync">
A function which should copy the package to the provided destination stream.
</param>
<param name="packageExtractionContext">
The version folder path context, which encapsulates all of the parameters to observe
while installing the package.
</param>
<param name="token">The cancellation token.</param>
<returns>
True if the package was installed. False if the package already exists and therefore
resulted in no copy operation.
</returns>
</member>
<member name="M:NuGet.Packaging.PackageExtractor.DeleteTargetAndTempPaths(System.String,System.String)">
<summary>
Delete the target directory path and the temp nupkg path in case of a failed extraction.
</summary>
</member>
<member name="T:NuGet.Packaging.PackageFolderReader">
<summary>
Reads an unzipped nupkg folder.
</summary>
</member>
<member name="M:NuGet.Packaging.PackageFolderReader.#ctor(System.String)">
<summary>
Package folder reader
</summary>
</member>
<member name="M:NuGet.Packaging.PackageFolderReader.#ctor(System.IO.DirectoryInfo)">
<summary>
Package folder reader
</summary>
<param name="folder">root directory of an extracted nupkg</param>
</member>
<member name="M:NuGet.Packaging.PackageFolderReader.#ctor(System.String,NuGet.Frameworks.IFrameworkNameProvider,NuGet.Frameworks.IFrameworkCompatibilityProvider)">
<summary>
Package folder reader
</summary>
<param name="folderPath">root directory of an extracted nupkg</param>
<param name="frameworkProvider">framework mappings</param>
<param name="compatibilityProvider">framework compatibility provider</param>
</member>
<member name="M:NuGet.Packaging.PackageFolderReader.#ctor(System.IO.DirectoryInfo,NuGet.Frameworks.IFrameworkNameProvider,NuGet.Frameworks.IFrameworkCompatibilityProvider)">
<summary>
Package folder reader
</summary>
<param name="folder">root directory of an extracted nupkg</param>
<param name="frameworkProvider">framework mappings</param>
<param name="compatibilityProvider">framework compatibility provider</param>
</member>
<member name="M:NuGet.Packaging.PackageFolderReader.GetStream(System.String)">
<summary>
Opens a local file in read only mode.
</summary>
</member>
<member name="M:NuGet.Packaging.PackageFolderReader.IsFileInRoot(System.String)">
<summary>
True if the path does not contain /
</summary>
</member>
<member name="M:NuGet.Packaging.PackageFolderReader.IsNupkg(System.String)">
<summary>
True if the path ends with .nupkg
</summary>
</member>
<member name="M:NuGet.Packaging.PackageFolderReader.GetRelativePath(System.IO.DirectoryInfo,System.IO.FileInfo)">
<summary>
Build the relative path in the same format that ZipArchive uses
</summary>
</member>
<member name="T:NuGet.Packaging.PackagePathResolver">
<summary>
A V2 path resolver.
</summary>
</member>
<member name="M:NuGet.Packaging.PackagePathResolver.#ctor(System.String,System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:NuGet.Packaging.PackagePathResolver" /> class.
</summary>
<param name="rootDirectory">The root directory.</param>
<param name="useSideBySidePaths">A value indicating whether to use side-by-side paths.</param>
<exception cref="T:System.ArgumentException">If rootDirectory is null, empty or does not contain an absolute path. </exception>
</member>
<member name="T:NuGet.Packaging.PackageReaderBase">
<summary>
Abstract class that both the zip and folder package readers extend
This class contains the path conventions for both zip and folder readers
</summary>
</member>
<member name="M:NuGet.Packaging.PackageReaderBase.#ctor(NuGet.Frameworks.IFrameworkNameProvider)">
<summary>
Instantiates a new <see cref="T:NuGet.Packaging.PackageReaderBase" /> class.
</summary>
<param name="frameworkProvider">A framework mapping provider.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="frameworkProvider" /> is <c>null</c>.</exception>
</member>
<member name="M:NuGet.Packaging.PackageReaderBase.#ctor(NuGet.Frameworks.IFrameworkNameProvider,NuGet.Frameworks.IFrameworkCompatibilityProvider)">
<summary>
Instantiates a new <see cref="T:NuGet.Packaging.PackageReaderBase" /> class.
</summary>
<param name="frameworkProvider">A framework mapping provider.</param>
<param name="compatibilityProvider">A framework compatibility provider.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="frameworkProvider" /> is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="compatibilityProvider" /> is <c>null</c>.</exception>
</member>
<member name="P:NuGet.Packaging.PackageReaderBase.NuspecReader">
<summary>
Nuspec reader
</summary>
</member>
<member name="M:NuGet.Packaging.PackageReaderBase.GetSupportedFrameworks">
<summary>
Frameworks mentioned in the package.
</summary>
<remarks>
This method returns the target frameworks supported for packages.config projects.
For PackageReference compatibility, use <see cref="T:NuGet.Client.ManagedCodeConventions" />
</remarks>
</member>
<member name="M:NuGet.Packaging.PackageReaderBase.GetSupportedFrameworksAsync(System.Threading.CancellationToken)">
<summary>
Frameworks mentioned in the package.
</summary>
<remarks>
This method returns the target frameworks supported for packages.config projects.
For PackageReference compatibility, use <see cref="T:NuGet.Client.ManagedCodeConventions" />
</remarks>
</member>
<member name="M:NuGet.Packaging.PackageReaderBase.IsAllowedBuildFile(System.String,System.String)">
<summary>
only packageId.targets and packageId.props should be used from the build folder
</summary>
</member>
<member name="M:NuGet.Packaging.PackageReaderBase.IsReferenceAssembly(System.String)">
<summary>
True only for assemblies that should be added as references to msbuild projects
</summary>
</member>
<member name="M:NuGet.Packaging.PackageReaderBase.ValidatePackageEntry(System.String,System.String,NuGet.Packaging.Core.PackageIdentity)">
<summary>
Validate file entry in package is not traversed outside of the expected extraction path.
Eg: file entry like ../../foo.dll can get outside of the expected extraction path.
</summary>
</member>
<member name="M:NuGet.Packaging.PackageReaderBase.GetContentHash(System.Threading.CancellationToken,System.Func{System.String})">
<summary>
Get contenthash for a package.
</summary>
</member>
<member name="T:NuGet.Packaging.PackageReference">
<summary>
Represents a package element in the packages.config file
</summary>
</member>
<member name="M:NuGet.Packaging.PackageReference.#ctor(NuGet.Packaging.Core.PackageIdentity,NuGet.Frameworks.NuGetFramework)">
<summary>
Creates a new packages config entry
</summary>
</member>
<member name="M:NuGet.Packaging.PackageReference.#ctor(NuGet.Packaging.Core.PackageIdentity,NuGet.Frameworks.NuGetFramework,System.Boolean)">
<summary>
Creates a new packages config entry
</summary>
</member>
<member name="M:NuGet.Packaging.PackageReference.#ctor(NuGet.Packaging.Core.PackageIdentity,NuGet.Frameworks.NuGetFramework,System.Boolean,System.Boolean,System.Boolean)">
<summary>
Creates a new packages config entry
</summary>
</member>
<member name="M:NuGet.Packaging.PackageReference.#ctor(NuGet.Packaging.Core.PackageIdentity,NuGet.Frameworks.NuGetFramework,System.Boolean,System.Boolean,System.Boolean,NuGet.Versioning.VersionRange)">
<summary>
Creates a new packages config entry
</summary>
<param name="identity">Package id and version</param>
<param name="targetFramework">Package target framework installed to the project</param>
<param name="userInstalled">True if the user installed this package directly</param>
<param name="developmentDependency">True if the package is a development dependency</param>
<param name="requireReinstallation">True if this package needs to be reinstalled</param>
<param name="allowedVersions">Restrict package versions to the allowedVersions range</param>
</member>
<member name="P:NuGet.Packaging.PackageReference.PackageIdentity">
<summary>
Id and Version of the package
</summary>
</member>
<member name="P:NuGet.Packaging.PackageReference.AllowedVersions">
<summary>
The allowed range of versions that this package can be upgraded/downgraded to.
</summary>
<remarks>This is null if unbounded</remarks>
</member>
<member name="P:NuGet.Packaging.PackageReference.HasAllowedVersions">
<summary>
True if allowedVersions exists.
</summary>
</member>
<member name="P:NuGet.Packaging.PackageReference.TargetFramework">
<summary>
Installed target framework version of the package.
</summary>
</member>
<member name="P:NuGet.Packaging.PackageReference.IsDevelopmentDependency">
<summary>
Development dependency
</summary>
</member>
<member name="P:NuGet.Packaging.PackageReference.IsUserInstalled">
<summary>
True if the user installed or updated this package directly.
False if this package was installed as a dependency by another package.
</summary>
</member>
<member name="P:NuGet.Packaging.PackageReference.RequireReinstallation">
<summary>
Require reinstallation
</summary>
</member>
<member name="M:NuGet.Packaging.PackageReference.ToString">
<summary>
Displays the identity and target framework of the reference.
</summary>
<returns></returns>
</member>
<member name="M:NuGet.Packaging.PackagesConfig.HasAttributeValue(System.Xml.Linq.XElement,System.String,System.String,System.Xml.Linq.XElement@)">
<summary>
Determine if the package node has the attribute value as the targetValue.
</summary>
</member>
<member name="M:NuGet.Packaging.PackagesConfig.BoolAttribute(System.Xml.Linq.XElement,System.String,System.Boolean)">
<summary>
Get a boolean attribute value, or false if it does not exist
</summary>
</member>
<member name="T:NuGet.Packaging.PackagesConfigReader">
<summary>
Reads packages.config
</summary>
</member>
<member name="M:NuGet.Packaging.PackagesConfigReader.#ctor(System.Xml.Linq.XDocument)">
<summary>
Packages.config reader
</summary>
<param name="xml">Packages.config XML</param>
</member>
<member name="M:NuGet.Packaging.PackagesConfigReader.#ctor(NuGet.Frameworks.IFrameworkNameProvider,System.Xml.Linq.XDocument)">
<summary>
Packages.config reader
</summary>
<param name="frameworkMappings">Additional target framework mappings for parsing target frameworks</param>
<param name="xml">Packages.config XML</param>
</member>
<member name="M:NuGet.Packaging.PackagesConfigReader.#ctor(System.IO.Stream)">
<summary>
Packages.config reader
</summary>
<param name="stream">Stream containing packages.config</param>
</member>
<member name="M:NuGet.Packaging.PackagesConfigReader.#ctor(System.IO.Stream,System.Boolean)">
<summary>
Packages.config reader
</summary>
<param name="stream">Stream containing packages.config</param>
<param name="leaveStreamOpen">True will leave the stream open</param>
</member>
<member name="M:NuGet.Packaging.PackagesConfigReader.#ctor(NuGet.Frameworks.IFrameworkNameProvider,System.IO.Stream,System.Boolean)">
<summary>
Packages.config reader
</summary>
<param name="stream">Stream containing packages.config</param>
<param name="leaveStreamOpen">True will leave the stream open</param>
<param name="frameworkMappings">Additional target framework mappings for parsing target frameworks</param>
</member>
<member name="M:NuGet.Packaging.PackagesConfigReader.GetMinClientVersion">
<summary>
Reads the minimum client version from packages.config
</summary>
<returns>Minimum client version or the default of 2.5.0</returns>
</member>
<member name="M:NuGet.Packaging.PackagesConfigReader.GetPackages">
<summary>
Reads all package node entries in the config.
If duplicate package ids exist an exception will be thrown.
</summary>
</member>
<member name="M:NuGet.Packaging.PackagesConfigReader.GetPackages(System.Boolean)">
<summary>
Reads all package node entries in the config.
</summary>
<param name="allowDuplicatePackageIds">If True validation will be performed to ensure that
only one entry exists for each unique package id.</param>
</member>
<member name="T:NuGet.Packaging.PackagesConfigWriter">
<summary>
Writes the packages.config XML file to a stream
</summary>
</member>
<member name="M:NuGet.Packaging.PackagesConfigWriter.#ctor(System.String,System.Boolean)">
<summary>
Create a packages.config writer using file path
</summary>
<param name="fullPath">The full path to write the XML packages.config file into, or load existing packages.config from</param>
<param name="createNew">Whether to create a new packages.config file, or load an existing one</param>
</member>
<member name="M:NuGet.Packaging.PackagesConfigWriter.#ctor(System.String,System.Boolean,NuGet.Frameworks.IFrameworkNameProvider)">
<summary>
Create a packages.config writer using file path
</summary>
<param name="fullPath">The full path to write the XML packages.config file into, or load existing packages.config from</param>
<param name="createNew">Whether to create a new packages.config file, or load an existing one</param>
<param name="frameworkMappings">Framework mappings</param>
</member>
<member name="M:NuGet.Packaging.PackagesConfigWriter.#ctor(System.IO.Stream,System.Boolean)">
<summary>
Create a packages.config writer using stream
</summary>
<param name="stream">Stream to write the XML packages.config file into, or load existing packages.config from</param>
<param name="createNew">Whether to create a new packages.config file, or load an existing one</param>
</member>
<member name="M:NuGet.Packaging.PackagesConfigWriter.#ctor(System.IO.Stream,System.Boolean,NuGet.Frameworks.IFrameworkNameProvider)">
<summary>
Create a packages.config writer using stream
</summary>
<param name="stream">Stream to write the XML packages.config file into, or load existing packages.config from</param>
<param name="createNew">Whether to create a new packages.config file, or load an existing one</param>
<param name="frameworkMappings">Framework mappings</param>
</member>
<member name="M:NuGet.Packaging.PackagesConfigWriter.WriteMinClientVersion(NuGet.Versioning.NuGetVersion)">
<summary>
Write a minimum client version to packages.config
</summary>
<param name="version">Minumum version of the client required to parse and use this file.</param>
</member>
<member name="M:NuGet.Packaging.PackagesConfigWriter.AddPackageEntry(System.String,NuGet.Versioning.NuGetVersion,NuGet.Frameworks.NuGetFramework)">
<summary>
Add a package entry
</summary>
<param name="packageId">Package Id</param>
<param name="version">Package Version</param>
<param name="targetFramework">Package targetFramework that's compatible with current project</param>
</member>
<member name="M:NuGet.Packaging.PackagesConfigWriter.AddPackageEntry(NuGet.Packaging.Core.PackageIdentity,NuGet.Frameworks.NuGetFramework)">
<summary>
Adds a basic package entry to the file
</summary>
</member>
<member name="M:NuGet.Packaging.PackagesConfigWriter.AddPackageEntry(NuGet.Packaging.PackageReference)">
<summary>
Adds a package entry to the file
</summary>
<param name="entry">Package reference entry</param>
</member>
<member name="M:NuGet.Packaging.PackagesConfigWriter.UpdatePackageEntry(NuGet.Packaging.PackageReference,NuGet.Packaging.PackageReference)">
<summary>
Update a package entry to the file
</summary>
</member>
<member name="M:NuGet.Packaging.PackagesConfigWriter.UpdateOrAddPackageEntry(System.Xml.Linq.XDocument,NuGet.Packaging.PackageReference)">
<summary>
Update a package entry using the original entry as a base if it exists.
</summary>
</member>
<member name="M:NuGet.Packaging.PackagesConfigWriter.RemovePackageEntry(System.String,NuGet.Versioning.NuGetVersion,NuGet.Frameworks.NuGetFramework)">
<summary>
Remove a package entry
</summary>
<param name="packageId">Package Id</param>
<param name="version">Package version</param>
<param name="targetFramework">Package targetFramework</param>
</member>
<member name="M:NuGet.Packaging.PackagesConfigWriter.RemovePackageEntry(NuGet.Packaging.Core.PackageIdentity,NuGet.Frameworks.NuGetFramework)">
<summary>
Remove a package identity from the file
</summary>
<param name="identity">Package identity</param>
<param name="targetFramework">Package targetFramework</param>
</member>
<member name="M:NuGet.Packaging.PackagesConfigWriter.RemovePackageEntry(NuGet.Packaging.PackageReference)">
<summary>
Removes a package entry from the file
</summary>
<param name="entry">Package reference entry</param>
</member>
<member name="M:NuGet.Packaging.PackagesConfigWriter.WriteFile(System.String)">
<summary>
Write the XDocument to the packages.config and disallow further changes.
</summary>
<param name="fullPath">the full path to packages.config file</param>
</member>
<member name="M:NuGet.Packaging.PackagesConfigWriter.Dispose">
<summary>
Write the XDocument to the stream and close it to disallow further changes.
</summary>
</member>
<member name="F:NuGet.Packaging.PackagingConstants.ManifestExtension">
<summary>
Represents the ".nuspec" extension.
</summary>
</member>
<member name="T:NuGet.Packaging.Sha512HashFunction">
<summary>
A SHA-512 hash function that supports incremental hashing.
This is non-private only to facilitate unit testing.
</summary>
</member>
<member name="T:NuGet.Packaging.Signing.CentralDirectoryHeaderMetadata">
<summary>
This class is used to hold metadata about the central directory archive structure
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.CentralDirectoryHeaderMetadata.Position">
<summary>
Position in bytes of the corresponding central directory header relative to the start of the archive
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.CentralDirectoryHeaderMetadata.OffsetToLocalFileHeader">
<summary>
Offset in bytes to the corresponding file header relative to the start of the archive
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.CentralDirectoryHeaderMetadata.FileEntryTotalSize">
<summary>
Total size of corresponding file entry in bytes
This should include size of local file header + encryption header + file data + data descriptor
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.CentralDirectoryHeaderMetadata.IsPackageSignatureFile">
<summary>
Flag indicating if the entry is the package signature file
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.CentralDirectoryHeaderMetadata.HeaderSize">
<summary>
Size of central directory header, in bytes.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.CentralDirectoryHeaderMetadata.ChangeInOffset">
<summary>
Value used to identify how much the position of the OffsetToFileHeader property will change by
the presence of a signature file in bytes
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.CentralDirectoryHeaderMetadata.IndexInHeaders">
<summary>
Index in which the central directory record was read from the archive.
This index represents the order of the central directory record as it is in the file.
</summary>
</member>
<member name="T:NuGet.Packaging.Signing.Crc32">
<summary>
Helper to calculate CRC-32 for data.
Derivative of a .NET core implementation - https://source.dot.net/#System.IO.Compression.Tests/Common/System/IO/Compression/CRC.cs
This is public to allow testing.
</summary>
</member>
<member name="M:NuGet.Packaging.Signing.Crc32.CalculateCrc(System.Byte[])">
<summary>
Calculates a 32 bit cyclic redundancy code for the input data.
</summary>
<param name="data">Byte[] of the data.</param>
<returns>32 bit cyclic redundancy code for the input data in uint.</returns>
</member>
<member name="M:NuGet.Packaging.Signing.SignedPackageArchiveIOUtility.ReadAndWriteUntilPosition(System.IO.BinaryReader,System.IO.BinaryWriter,System.Int64)">
<summary>
Read bytes from a BinaryReader and write them to the BinaryWriter and stop when the provided position
is the current position of the BinaryReader's base stream. It does not read the byte in the provided position.
</summary>
<param name="reader">Read bytes from this stream.</param>
<param name="writer">Write bytes to this stream.</param>
<param name="position">Position to stop copying data.</param>
</member>
<member name="M:NuGet.Packaging.Signing.SignedPackageArchiveIOUtility.ReadAndHashUntilPosition(System.IO.BinaryReader,System.Security.Cryptography.HashAlgorithm,System.Int64)">
<summary>
Read bytes from a BinaryReader and hash them with a given HashAlgorithm and stop when the provided position
is the current position of the BinaryReader's base stream. It does not hash the byte in the provided position.
</summary>
<param name="reader">Read bytes from this stream</param>
<param name="hashAlgorithm">HashAlgorithm used to hash contents</param>
<param name="position">Position to stop copying data</param>
</member>
<member name="M:NuGet.Packaging.Signing.SignedPackageArchiveIOUtility.HashBytes(System.Security.Cryptography.HashAlgorithm,System.Byte[])">
<summary>
Hashes given byte array with a specified HashAlgorithm
</summary>
<param name="hashAlgorithm">HashAlgorithm used to hash contents</param>
<param name="bytes">Content to hash</param>
</member>
<member name="M:NuGet.Packaging.Signing.SignedPackageArchiveIOUtility.ReadAndHashUntilPosition(System.IO.BinaryReader,NuGet.Packaging.Sha512HashFunction,System.Int64)">
<summary>
Read bytes from a BinaryReader and hash them with a given HashAlgorithm wrapper and stop when the provided position
is the current position of the BinaryReader's base stream. It does not hash the byte in the provided position.
</summary>
<param name="reader">Read bytes from this stream</param>
<param name="hashFunc">HashAlgorithm wrapper used to hash contents cross platform</param>
<param name="position">Position to stop copying data</param>
</member>
<member name="M:NuGet.Packaging.Signing.SignedPackageArchiveIOUtility.HashBytes(NuGet.Packaging.Sha512HashFunction,System.Byte[])">
<summary>
Hashes given byte array with a specified HashAlgorithm wrapper which works cross platform.
</summary>
<param name="hashFunc">HashAlgorithm wrapper used to hash contents cross platform</param>
<param name="bytes">Content to hash</param>
</member>
<member name="M:NuGet.Packaging.Signing.SignedPackageArchiveIOUtility.HashBytes(NuGet.Packaging.Sha512HashFunction,System.Byte[],System.Int32)">
<summary>
Hashes given byte array with a specified HashAlgorithm wrapper which works cross platform.
</summary>
<param name="hashFunc">HashAlgorithm wrapper used to hash contents cross platform</param>
<param name="bytes">Content to hash</param>
<param name="count">The number of bytes in the input byte array to use as data.</param>
</member>
<member name="M:NuGet.Packaging.Signing.SignedPackageArchiveIOUtility.ReadSignedArchiveMetadata(System.IO.BinaryReader,System.Boolean)">
<summary>
Read ZIP's offsets and positions of offsets.
</summary>
<param name="reader">binary reader to zip archive</param>
<param name="validateSignatureEntry">boolean to skip validate signature entry</param>
<returns>metadata with offsets and positions for entries</returns>
</member>
<member name="M:NuGet.Packaging.Signing.SignedPackageArchiveIOUtility.AssertSignatureEntryMetadata(System.IO.BinaryReader,NuGet.Packaging.Signing.SignedPackageArchiveMetadata)">
<summary>
Asserts the validity of central directory header and local file header for the package signature file entry.
</summary>
<param name="reader">BinaryReader on the package.</param>
<param name="metadata">Metadata for the package signature file's central directory header.</param>
<exception cref="T:NuGet.Packaging.Signing.SignatureException">Thrown if either header is invalid.</exception>
</member>
<member name="M:NuGet.Packaging.Signing.SignedPackageArchiveIOUtility.WriteSignatureIntoZip(System.IO.MemoryStream,System.IO.BinaryReader,System.IO.BinaryWriter)">
<summary>
Writes the signature data into the zip using the writer.
The reader is used to read the exisiting zip.
</summary>
<param name="signatureStream">MemoryStream of the signature to be inserted into the zip.</param>
<param name="reader">BinaryReader to be used to read the existing zip data.</param>
<param name="writer">BinaryWriter to be used to write the signature into the zip.</param>
</member>
<member name="M:NuGet.Packaging.Signing.SignedPackageArchiveIOUtility.WriteLocalFileHeaderIntoZip(System.IO.BinaryWriter,System.Byte[],System.UInt32,System.UInt32)">
<summary>
Writes a local file header into a zip using the writer starting at the writer.BaseStream.Position.
</summary>
<param name="writer">BinaryWriter to be used to write file.</param>
<param name="fileData">Byte[] of the corresponding file to be written into the zip.</param>
<param name="crc32">CRC-32 for the file.</param>
<param name="dosDateTime">Last modified DateTime for the file data.</param>
<returns>Number of total bytes written into the zip.</returns>
</member>
<member name="M:NuGet.Packaging.Signing.SignedPackageArchiveIOUtility.WriteFileIntoZip(System.IO.BinaryWriter,System.Byte[])">
<summary>
Writes a file into a zip using the writer starting at the writer.BaseStream.Position.
</summary>
<param name="writer">BinaryWriter to be used to write file.</param>
<param name="fileData">Byte[] of the file to be written into the zip.</param>
<returns>Number of total bytes written into the zip.</returns>
</member>
<member name="M:NuGet.Packaging.Signing.SignedPackageArchiveIOUtility.WriteCentralDirectoryHeaderIntoZip(System.IO.BinaryWriter,System.Byte[],System.UInt32,System.UInt32,System.Int64)">
<summary>
Writes a central directory header into a zip using the writer starting at the writer.BaseStream.Position.
</summary>
<param name="writer">BinaryWriter to be used to write file.</param>
<param name="fileData">Byte[] of the file to be written into the zip.</param>
<param name="crc32">CRC-32 checksum for the file.</param>
<param name="dosDateTime">Last modified DateTime for the file data.</param>
<param name="fileOffset">Offset, in bytes, for the local file header of the corresponding file from the start of the archive.</param>
<returns>Number of total bytes written into the zip.</returns>
</member>
<member name="M:NuGet.Packaging.Signing.SignedPackageArchiveIOUtility.ReadAndWriteUpdatedEndOfCentralDirectoryRecordIntoZip(System.IO.BinaryReader,System.IO.BinaryWriter,System.SByte,System.Int64,System.Int64)">
<summary>
Writes the end of central directory header into a zip using the writer starting at the writer.BaseStream.Position.
The new end of central directory record will be based on the one at reader.BaseStream.Position.
</summary>
<param name="reader">BinaryReader to be used to read the existing end of central directory record.</param>
<param name="writer">BinaryWriter to be used to write the updated end of central directory record.</param>
<param name="entryCountChange">The change to central directory header counts.</param>
<param name="sizeOfSignatureCentralDirectoryRecord">Size of the central directory header for the signature file.</param>
<param name="sizeOfSignatureFileHeaderAndData">Size of the signature file and the corresponding local file header.</param>
</member>
<member name="M:NuGet.Packaging.Signing.SignedPackageArchiveIOUtility.DateTimeToDosTime(System.DateTime)">
<summary>
Converts a DateTime value into a unit in the MS-DOS date time format.
Reference - https://docs.microsoft.com/en-us/cpp/c-runtime-library/32-bit-windows-time-date-formats
Reference - https://source.dot.net/#System.IO.Compression/System/IO/Compression/ZipHelper.cs,91
</summary>
<param name="dateTime">DateTime value to be converted.</param>
<returns>uint representing the MS-DOS equivalent date time.</returns>
</member>
<member name="T:NuGet.Packaging.Signing.SignedPackageArchiveMetadata">
<summary>
This class is used to hold metadata about the signed package archive being verified.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.SignedPackageArchiveMetadata.CentralDirectoryHeaders">
<summary>
List of central directory metadata ordered by the same order the central directory headers are in the archive
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.SignedPackageArchiveMetadata.StartOfLocalFileHeaders">
<summary>
Offset, in bytes, to the first file header relative to the start of the archive. Should typically be 0.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.SignedPackageArchiveMetadata.EndOfCentralDirectory">
<summary>
Offset, in bytes, to the end of central directory headers relative to the start of the archive.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.SignedPackageArchiveMetadata.SignatureCentralDirectoryHeaderIndex">
<summary>
Index of the signature central directory header in CentralDirectoryHeaders.
If the CentralDirectoryHeaders list is ordered by IndexInHeaders this index indicates the position on the list for the signature.
</summary>
</member>
<member name="M:NuGet.Packaging.Signing.SignedPackageArchiveUtility.IsSigned(System.IO.BinaryReader)">
<summary>
Utility method to know if a zip archive is signed.
</summary>
<param name="reader">Binary reader pointing to a zip archive.</param>
<returns>true if the given archive is signed</returns>
</member>
<member name="M:NuGet.Packaging.Signing.SignedPackageArchiveUtility.OpenPackageSignatureFileStream(System.IO.BinaryReader)">
<summary>
Opens a read-only stream for the package signature file.
</summary>
<remarks>Callers should first verify that a package is signed before calling this method.</remarks>
<param name="reader">A binary reader for a signed package.</param>
<returns>A readable stream.</returns>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="reader" /> is <c>null</c>.</exception>
<exception cref="T:NuGet.Packaging.Signing.SignatureException">Thrown if a package signature file is invalid or missing.</exception>
</member>
<member name="M:NuGet.Packaging.Signing.SignedPackageArchiveUtility.RemoveRepositorySignaturesAsync(System.IO.Stream,System.IO.Stream,System.Threading.CancellationToken)">
<summary>
Removes repository primary signature (if it exists) or any repository countersignature (if it exists).
</summary>
<param name="input">A readable stream for a signed package.</param>
<param name="output">A read/write stream for receiving an updated package.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A flag indicating whether or not a signature was removed.</returns>
</member>
<member name="M:NuGet.Packaging.Signing.SignedPackageArchiveUtility.SignZip(System.IO.MemoryStream,System.IO.BinaryReader,System.IO.BinaryWriter)">
<summary>
Signs a Zip with the contents in the SignatureStream using the writer.
The reader is used to read the exisiting contents for the Zip.
</summary>
<param name="signatureStream">MemoryStream of the signature to be inserted into the zip.</param>
<param name="reader">BinaryReader to be used to read the existing zip data.</param>
<param name="writer">BinaryWriter to be used to write the signature into the zip.</param>
</member>
<member name="M:NuGet.Packaging.Signing.SignedPackageArchiveUtility.VerifySignedPackageIntegrity(System.IO.BinaryReader,System.Security.Cryptography.HashAlgorithm,System.Byte[])">
<summary>
Verifies that a signed package archive's signature is valid and it has not been tampered with.
</summary>
<param name="reader">Signed package to verify</param>
<param name="hashAlgorithm">Hash algorithm to be used to hash data.</param>
<param name="expectedHash">Hash value of the original data.</param>
<returns>True if package archive's hash matches the expected hash</returns>
</member>
<member name="P:NuGet.Packaging.Signing.AuthorSignPackageRequest.SignatureType">
<summary>
Gets the signature type.
</summary>
</member>
<member name="M:NuGet.Packaging.Signing.AuthorSignPackageRequest.#ctor(System.Security.Cryptography.X509Certificates.X509Certificate2,NuGet.Common.HashAlgorithmName)">
<summary>
Instantiates a new instance of the <see cref="T:NuGet.Packaging.Signing.AuthorSignPackageRequest" /> class.
</summary>
<param name="certificate">The signing certificate.</param>
<param name="hashAlgorithm">The signature and timestamp hash algorithm.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="certificate" />
is <c>null</c>.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="hashAlgorithm" />
is invalid.</exception>
</member>
<member name="M:NuGet.Packaging.Signing.AuthorSignPackageRequest.#ctor(System.Security.Cryptography.X509Certificates.X509Certificate2,NuGet.Common.HashAlgorithmName,NuGet.Common.HashAlgorithmName)">
<summary>
Instantiates a new instance of the <see cref="T:NuGet.Packaging.Signing.AuthorSignPackageRequest" /> class.
</summary>
<param name="certificate">The signing certificate.</param>
<param name="signatureHashAlgorithm">The signature hash algorithm.</param>
<param name="timestampHashAlgorithm">The timestamp hash algorithm.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="certificate" />
is <c>null</c>.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="signatureHashAlgorithm" />
is invalid.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="timestampHashAlgorithm" />
is invalid.</exception>
</member>
<member name="T:NuGet.Packaging.Signing.ISignatureProvider">
<summary>
Creates Signatures that can be added to packages.
</summary>
</member>
<member name="M:NuGet.Packaging.Signing.ISignatureProvider.CreatePrimarySignatureAsync(NuGet.Packaging.Signing.SignPackageRequest,NuGet.Packaging.Signing.SignatureContent,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Create a signature.
</summary>
<param name="request">Signing request with all the information needed to create signature.</param>
<param name="signatureContent">SignatureContent containing the Hash of the package and the signature version.</param>
<param name="logger">Logger</param>
<param name="token">Cancellation token.</param>
<returns>A signature for the package.</returns>
</member>
<member name="M:NuGet.Packaging.Signing.ISignatureProvider.CreateRepositoryCountersignatureAsync(NuGet.Packaging.Signing.RepositorySignPackageRequest,NuGet.Packaging.Signing.PrimarySignature,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Create a repository countersignature.
</summary>
<param name="request">Signing request with all the information needed to create signature.</param>
<param name="primarySignature">Primary signature to be countersigned.</param>
<param name="logger">Logger</param>
<param name="token">Cancellation token.</param>
<returns>A signature for the package.</returns>
</member>
<member name="P:NuGet.Packaging.Signing.RepositorySignPackageRequest.V3ServiceIndexUrl">
<summary>
Gets the repository V3 service index URL.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.RepositorySignPackageRequest.PackageOwners">
<summary>
Gets a read-only list of package owners.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.RepositorySignPackageRequest.SignatureType">
<summary>
Gets the signature type.
</summary>
</member>
<member name="M:NuGet.Packaging.Signing.RepositorySignPackageRequest.#ctor(System.Security.Cryptography.X509Certificates.X509Certificate2,NuGet.Common.HashAlgorithmName,NuGet.Common.HashAlgorithmName,System.Uri,System.Collections.Generic.IReadOnlyList{System.String})">
<summary>
Instantiates a new instance of the <see cref="T:NuGet.Packaging.Signing.RepositorySignPackageRequest" /> class.
</summary>
<param name="certificate">The signing certificate.</param>
<param name="signatureHashAlgorithm">The signature hash algorithm.</param>
<param name="timestampHashAlgorithm">The timestamp hash algorithm.</param>
<param name="v3ServiceIndexUrl">The V3 service index URL.</param>
<param name="packageOwners">A read-only list of package owners.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="certificate" />
is <c>null</c>.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="signatureHashAlgorithm" />
is invalid.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="timestampHashAlgorithm" />
is invalid.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="v3ServiceIndexUrl" />
is <c>null</c>.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="v3ServiceIndexUrl" />
is neither absolute nor HTTPS.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="packageOwners" />
is either empty or contains an invalid value.</exception>
</member>
<member name="P:NuGet.Packaging.Signing.SigningOptions.InputPackageStream">
<summary>
Readable stream for the package that will be used as an input for any signing operation.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.SigningOptions.OutputPackageStream">
<summary>
Readable and writeable stream for the output package for any signing operation.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.SigningOptions.Overwrite">
<summary>
Switch used to indicate if an existing signature should be overwritten.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.SigningOptions.SignatureProvider">
<summary>
Provider to create a Signature that can be added to the package.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.SigningOptions.Logger">
<summary>
Logger to be used to display the logs during the execution of signing actions.
</summary>
</member>
<member name="M:NuGet.Packaging.Signing.SigningOptions.#ctor(System.Lazy{System.IO.Stream},System.Lazy{System.IO.Stream},System.Boolean,NuGet.Packaging.Signing.ISignatureProvider,NuGet.Common.ILogger)">
<summary>Instantiates a new <see cref="T:NuGet.Packaging.Signing.SigningOptions" /> object.</summary>
<param name="inputPackageStream">A readable stream for the package that will be used as input for any
signing operation.</param>
<param name="outputPackageStream">A readable and writeable stream for the output package for any signing
operation.</param>
<param name="overwrite">A flag indicating if an existing signature should be overwritten.</param>
<param name="signatureProvider">A provider to create a Signature that can be added to the package.</param>
<param name="logger">A logger.</param>
<remarks>Signing operations cannot be done in place; therefore, <paramref name="inputPackageStream" />
and <paramref name="outputPackageStream" /> should be different streams.</remarks>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="inputPackageStream" /> is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="outputPackageStream" /> is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="signatureProvider" /> is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="logger" /> is <c>null</c>.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="inputPackageStream" /> and
<paramref name="outputPackageStream" /> are the same object.</exception>
</member>
<member name="M:NuGet.Packaging.Signing.SigningOptions.CreateFromFilePaths(System.String,System.String,System.Boolean,NuGet.Packaging.Signing.ISignatureProvider,NuGet.Common.ILogger)">
<summary>Creates a new <see cref="T:NuGet.Packaging.Signing.SigningOptions" /> object from file paths.</summary>
<param name="inputPackageFilePath">The file path of the package that will be used as input for any
signing operation.</param>
<param name="outputPackageFilePath">The file path of the package that will be the output for any signing
operation.</param>
<param name="overwrite">A flag indicating if an existing signature should be overwritten.</param>
<param name="signatureProvider">A provider to create a Signature that can be added to the package.</param>
<param name="logger">A logger.</param>
<remarks>Signing operations cannot be done in place; therefore, <paramref name="inputPackageFilePath" />
and <paramref name="outputPackageFilePath" /> should be different file paths.</remarks>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="inputPackageFilePath" /> is <c>null</c>,
an empty string, or equivalent to <paramref name="outputPackageFilePath" />.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="inputPackageFilePath" /> is <c>null</c>,
an empty string, or equivalent to <paramref name="outputPackageFilePath" />.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="signatureProvider" /> is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="logger" /> is <c>null</c>.</exception>
</member>
<member name="T:NuGet.Packaging.Signing.SignPackageRequest">
<summary>
Contains a request for generating package signature.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.SignPackageRequest.SignatureHashAlgorithm">
<summary>
Hash algorithm used to create the package signature.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.SignPackageRequest.TimestampHashAlgorithm">
<summary>
Hash algorithm used to timestamp the signed package.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.SignPackageRequest.Certificate">
<summary>
Certificate used to sign the package.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.SignPackageRequest.AdditionalCertificates">
<summary>
Gets a collection of additional certificates for building a chain for the signing certificate.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.SignPackageRequest.SignatureType">
<summary>
Gets the signature type.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.SignPackageRequest.PrivateKey">
<summary>
PrivateKey is only used in mssign command.
</summary>
</member>
<member name="M:NuGet.Packaging.Signing.SignPackageRequest.Dispose">
<summary>
Disposes of this instance.
</summary>
</member>
<member name="T:NuGet.Packaging.Signing.X509SignatureProvider">
<summary>
Sign a manifest hash with an X509Certificate2.
</summary>
</member>
<member name="M:NuGet.Packaging.Signing.X509SignatureProvider.CreatePrimarySignatureAsync(NuGet.Packaging.Signing.SignPackageRequest,NuGet.Packaging.Signing.SignatureContent,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Sign the package stream hash with an X509Certificate2.
</summary>
</member>
<member name="M:NuGet.Packaging.Signing.X509SignatureProvider.CreateRepositoryCountersignatureAsync(NuGet.Packaging.Signing.RepositorySignPackageRequest,NuGet.Packaging.Signing.PrimarySignature,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Countersign the primary signature with a X509Certificate2.
</summary>
</member>
<member name="T:NuGet.Packaging.Signing.IX509ChainBuildPolicy">
<summary>
Represents a wrapper around <see cref="M:System.Security.Cryptography.X509Certificates.X509Chain.Build(System.Security.Cryptography.X509Certificates.X509Certificate2)" /> to enable
custom behaviors (e.g.: retry on failure).
</summary>
</member>
<member name="M:NuGet.Packaging.Signing.KeyPairFileReader.ReadSection">
<summary>
Read a section of key value pairs from the file.
Throw for invalid formats.
</summary>
<remarks>Returns an empty set if the file has reached the end.</remarks>
</member>
<member name="M:NuGet.Packaging.Signing.KeyPairFileUtility.GetValueOrThrow(System.Collections.Generic.Dictionary{System.String,System.String},System.String)">
<summary>
Throw if the expected value does not exist.
</summary>
</member>
<member name="M:NuGet.Packaging.Signing.KeyPairFileWriter.WritePair(System.String,System.String)">
<summary>
Write key:value with EOL to the manifest stream.
</summary>
</member>
<member name="M:NuGet.Packaging.Signing.KeyPairFileWriter.WriteSectionBreak">
<summary>
Write an empty line.
</summary>
</member>
<member name="M:NuGet.Packaging.Signing.KeyPairFileWriter.WriteEOL">
<summary>
Write an end of line to the manifest writer.
</summary>
</member>
<member name="M:NuGet.Packaging.Signing.KeyPairFileWriter.FormatItem(System.String,System.String)">
<summary>
key:value
</summary>
</member>
<member name="T:NuGet.Packaging.Signing.SignatureContent">
<summary>
SignedCms.ContentInfo.Content for the primary signature.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.SignatureContent.HashAlgorithm">
<summary>
Hashing algorithm used.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.SignatureContent.HashValue">
<summary>
Base64 package stream hash.
</summary>
</member>
<member name="M:NuGet.Packaging.Signing.SignatureContent.Save(System.IO.Stream)">
<summary>
Write the content to a stream.
</summary>
</member>
<member name="M:NuGet.Packaging.Signing.SignatureContent.GetBytes">
<summary>
Write the content to byte array.
</summary>
</member>
<member name="M:NuGet.Packaging.Signing.SignatureContent.Load(System.Byte[],NuGet.Packaging.Signing.SigningSpecifications)">
<summary>
Load from a byte array.
</summary>
</member>
<member name="M:NuGet.Packaging.Signing.SignatureContent.Load(System.IO.Stream,NuGet.Packaging.Signing.SigningSpecifications)">
<summary>
Load content from a stream.
</summary>
</member>
<member name="T:NuGet.Packaging.Signing.DerEncoding.DerEncoder">
<summary>
Writes data encoded via the Distinguished Encoding Rules for Abstract
Syntax Notation 1 (ASN.1) data.
</summary>
</member>
<member name="M:NuGet.Packaging.Signing.DerEncoding.DerEncoder.SegmentedEncodeBoolean(System.Boolean)">
<summary>
Encode the segments { tag, length, value } of a boolean.
</summary>
<param name="value">The boolean to encode</param>
<returns>The encoded segments { tag, length, value }</returns>
</member>
<member name="M:NuGet.Packaging.Signing.DerEncoding.DerEncoder.SegmentedEncodeUnsignedInteger(System.UInt32)">
<summary>
Encode the segments { tag, length, value } of an unsigned integer.
</summary>
<param name="value">The value to encode.</param>
<returns>The encoded segments { tag, length, value }</returns>
</member>
<member name="M:NuGet.Packaging.Signing.DerEncoding.DerEncoder.SegmentedEncodeUnsignedInteger(System.Byte[])">
<summary>
Encode the segments { tag, length, value } of an unsigned integer.
</summary>
<param name="bigEndianBytes">The value to encode, in big integer representation.</param>
<returns>The encoded segments { tag, length, value }</returns>
</member>
<member name="M:NuGet.Packaging.Signing.DerEncoding.DerEncoder.SegmentedEncodeUnsignedInteger(System.Byte[],System.Int32,System.Int32)">
<summary>
Encode the segments { tag, length, value } of an unsigned integer represented within a bounded array.
</summary>
<param name="bigEndianBytes">The value to encode, in big integer representation.</param>
<param name="offset">The offset into bigEndianBytes to read</param>
<param name="count">The count of bytes to read, must be greater than 0</param>
<returns>The encoded segments { tag, length, value }</returns>
</member>
<member name="M:NuGet.Packaging.Signing.DerEncoding.DerEncoder.SegmentedEncodeBitString(System.Byte[][][])">
<summary>
Encode the segments { tag, length, value } of a BIT STRING which is wrapped over
other DER-encoded data.
</summary>
<param name="childSegments"></param>
<remarks>
Despite containing other DER-encoded data this does not get the constructed bit,
because it doesn't when encoding public keys in SubjectPublicKeyInfo</remarks>
<returns></returns>
</member>
<member name="M:NuGet.Packaging.Signing.DerEncoding.DerEncoder.SegmentedEncodeBitString(System.Byte[])">
<summary>
Encode the segments { tag, length, value } of a bit string where all bits are significant.
</summary>
<param name="data">The data to encode</param>
<returns>The encoded segments { tag, length, value }</returns>
</member>
<member name="M:NuGet.Packaging.Signing.DerEncoding.DerEncoder.SegmentedEncodeBitString(System.Int32,System.Byte[])">
<summary>
Encode the segments { tag, length, value } of a bit string where the least significant
<paramref name="unusedBits" /> of the last byte are padding.
</summary>
<param name="unusedBits">The number of padding bits (0-7) in the last byte</param>
<param name="data">The data to encode</param>
<returns>The encoded segments { tag, length, value }</returns>
</member>
<member name="M:NuGet.Packaging.Signing.DerEncoding.DerEncoder.SegmentedEncodeNamedBitList(System.Byte[],System.Int32)">
<summary>
Encode the segments { tag, length, value } of a bit string value based upon a NamedBitList.
((<paramref name="bigEndianBytes" />[0] >> 7) & 1) is considered the "leading" bit, proceeding
through the array for up to <paramref name="namedBitsCount" />.
</summary>
<param name="bigEndianBytes">
The data in big endian order, the most significant bit of byte 0 is the leading bit
(corresponds to the named value for "bit 0"). Any bits beyond <paramref name="namedBitsCount" />
are ignored, and any missing bits are assumed to be unset.
</param>
<param name="namedBitsCount">
The total number of named bits. Since the bits are numbered with a zero index, this should be
one higher than the largest defined bit. (namedBitsCount=10 covers bits 0-9)
</param>
<returns>
A triplet of { tag }, { length }, { data }. All trailing unset named bits are removed.
</returns>
</member>
<member name="M:NuGet.Packaging.Signing.DerEncoding.DerEncoder.SegmentedEncodeOctetString(System.Byte[])">
<summary>
Encode the segments { tag, length, value } of an octet string (byte array).
</summary>
<param name="data">The data to encode</param>
<returns>The encoded segments { tag, length, value }</returns>
</member>
<member name="M:NuGet.Packaging.Signing.DerEncoding.DerEncoder.EncodeOid(System.String)">
<summary>
Encode an object identifier (Oid).
</summary>
<returns>The encoded OID</returns>
</member>
<member name="M:NuGet.Packaging.Signing.DerEncoding.DerEncoder.SegmentedEncodeOid(System.Security.Cryptography.Oid)">
<summary>
Encode the segments { tag, length, value } of an object identifier (Oid).
</summary>
<returns>The encoded segments { tag, length, value }</returns>
</member>
<member name="M:NuGet.Packaging.Signing.DerEncoding.DerEncoder.SegmentedEncodeOid(System.String)">
<summary>
Encode the segments { tag, length, value } of an object identifier (Oid).
</summary>
<returns>The encoded segments { tag, length, value }</returns>
</member>
<member name="M:NuGet.Packaging.Signing.DerEncoding.DerEncoder.SegmentedEncodeUtf8String(System.Char[])">
<summary>
Encode a character string as a UTF8String value.
</summary>
<param name="chars">The characters to be encoded.</param>
<returns>The encoded segments { tag, length, value }</returns>
</member>
<member name="M:NuGet.Packaging.Signing.DerEncoding.DerEncoder.SegmentedEncodeUtf8String(System.Char[],System.Int32,System.Int32)">
<summary>
Encode a substring as a UTF8String value.
</summary>
<param name="chars">The characters whose substring is to be encoded.</param>
<param name="offset">The character offset into <paramref name="chars" /> at which to start.</param>
<param name="count">The total number of characters from <paramref name="chars" /> to read.</param>
<returns>The encoded segments { tag, length, value }</returns>
</member>
<member name="M:NuGet.Packaging.Signing.DerEncoding.DerEncoder.ConstructSegmentedSequence(System.Byte[][][])">
<summary>
Make a constructed SEQUENCE of the byte-triplets of the contents, but leave
the value in a segmented form (to be included in a larger SEQUENCE).
</summary>
<param name="items">Series of Tag-Length-Value triplets to build into one sequence.</param>
<returns>The encoded segments { tag, length, value }</returns>
</member>
<member name="M:NuGet.Packaging.Signing.DerEncoding.DerEncoder.ConstructSegmentedContextSpecificValue(System.Int32,System.Byte[][][])">
<summary>
Make a context-specific tagged value which is constructed of other DER encoded values.
Logically the same as a SEQUENCE, but providing context as to data interpretation (and usually
indicates an optional element adjacent to another SEQUENCE).
</summary>
<param name="contextId">The value's context ID</param>
<param name="items">Series of Tag-Length-Value triplets to build into one sequence.</param>
<returns>The encoded segments { tag, length, value }</returns>
</member>
<member name="M:NuGet.Packaging.Signing.DerEncoding.DerEncoder.ConstructSegmentedSet(System.Byte[][][])">
<summary>
Make a constructed SET of the byte-triplets of the contents, but leave
the value in a segmented form (to be included in a larger SEQUENCE).
</summary>
<param name="items">Series of Tag-Length-Value triplets to build into one set.</param>
<returns>The encoded segments { tag, length, value }</returns>
</member>
<member name="M:NuGet.Packaging.Signing.DerEncoding.DerEncoder.ConstructSegmentedPresortedSet(System.Byte[][][])">
<summary>
Make a constructed SET of the byte-triplets of the contents, but leave
the value in a segmented form (to be included in a larger SEQUENCE).
This method assumes that the data is presorted, and writes it as-is.
</summary>
<param name="items">Series of Tag-Length-Value triplets to build into one set.</param>
<returns>The encoded segments { tag, length, value }</returns>
</member>
<member name="M:NuGet.Packaging.Signing.DerEncoding.DerEncoder.IsValidPrintableString(System.Char[])">
<summary>
Test to see if the input characters contains only characters permitted by the ASN.1
PrintableString restricted character set.
</summary>
<param name="chars">The characters to test.</param>
<returns>
<c>true</c> if all of the characters in <paramref name="chars" /> are valid PrintableString characters,
<c>false</c> otherwise.
</returns>
</member>
<member name="M:NuGet.Packaging.Signing.DerEncoding.DerEncoder.IsValidPrintableString(System.Char[],System.Int32,System.Int32)">
<summary>
Test to see if the input substring contains only characters permitted by the ASN.1
PrintableString restricted character set.
</summary>
<param name="chars">The character string to test.</param>
<param name="offset">The starting character position within <paramref name="chars" />.</param>
<param name="count">The number of characters from <paramref name="chars" /> to read.</param>
<returns>
<c>true</c> if all of the indexed characters in <paramref name="chars" /> are valid PrintableString
characters, <c>false</c> otherwise.
</returns>
</member>
<member name="M:NuGet.Packaging.Signing.DerEncoding.DerEncoder.SegmentedEncodePrintableString(System.Char[])">
<summary>
Encode a character string as a PrintableString value.
</summary>
<param name="chars">The characters to be encoded.</param>
<returns>The encoded segments { tag, length, value }</returns>
</member>
<member name="M:NuGet.Packaging.Signing.DerEncoding.DerEncoder.SegmentedEncodePrintableString(System.Char[],System.Int32,System.Int32)">
<summary>
Encode a substring as a PrintableString value.
</summary>
<param name="chars">The character string whose substring is to be encoded.</param>
<param name="offset">The character offset into <paramref name="chars" /> at which to start.</param>
<param name="count">The total number of characters from <paramref name="chars" /> to read.</param>
<returns>The encoded segments { tag, length, value }</returns>
</member>
<member name="M:NuGet.Packaging.Signing.DerEncoding.DerEncoder.SegmentedEncodeIA5String(System.Char[])">
<summary>
Encode a string of characters as a IA5String value.
</summary>
<param name="chars">The characters to be encoded.</param>
<returns>The encoded segments { tag, length, value }</returns>
</member>
<member name="M:NuGet.Packaging.Signing.DerEncoding.DerEncoder.SegmentedEncodeIA5String(System.Char[],System.Int32,System.Int32)">
<summary>
Encode a substring as a IA5String value.
</summary>
<param name="chars">The characters whose substring is to be encoded.</param>
<param name="offset">The character offset into <paramref name="chars" /> at which to start.</param>
<param name="count">The total number of characters from <paramref name="chars" /> to read.</param>
<returns>The encoded segments { tag, length, value }</returns>
</member>
<member name="M:NuGet.Packaging.Signing.DerEncoding.DerEncoder.ConstructSequence(System.Byte[][][])">
<summary>
Make a constructed SEQUENCE of the byte-triplets of the contents.
Each byte[][] should be a byte[][3] of {tag (1 byte), length (1-5 bytes), payload (variable)}.
</summary>
</member>
<member name="M:NuGet.Packaging.Signing.DerEncoding.DerEncoder.ConstructSequence(System.Collections.Generic.IEnumerable{System.Byte[][]})">
<summary>
Make a constructed SEQUENCE of the byte-triplets of the contents.
Each byte[][] should be a byte[][3] of {tag (1 byte), length (1-5 bytes), payload (variable)}.
</summary>
</member>
<member name="T:NuGet.Packaging.Signing.DerEncoding.DerGeneralizedTime">
<remarks>This is public only to facilitate testing.</remarks>
</member>
<member name="T:NuGet.Packaging.Signing.DerEncoding.DerSequenceReader">
<summary>
Reads data encoded via the Distinguished Encoding Rules for Abstract
Syntax Notation 1 (ASN.1) data.
</summary>
</member>
<member name="M:NuGet.Packaging.Signing.DerEncoding.DerSequenceReader.ReadNextEncodedValue">
<summary>
Returns the next value encoded (this includes tag and length)
</summary>
</member>
<member name="T:NuGet.Packaging.Signing.DerEncoding.SR">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.DerEncoding.SR.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.DerEncoding.SR.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.DerEncoding.SR.Argument_InvalidOidValue">
<summary>
Looks up a localized string similar to The OID value was invalid..
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.DerEncoding.SR.Cryptography_Der_Invalid_Encoding">
<summary>
Looks up a localized string similar to ASN1 corrupted data..
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.DerEncoding.SR.Cryptography_Invalid_IA5String">
<summary>
Looks up a localized string similar to The string contains a character not in the 7 bit ASCII character set..
</summary>
</member>
<member name="T:NuGet.Packaging.Signing.ISignedPackage">
<summary>
A package that can read and write signatures.
</summary>
</member>
<member name="T:NuGet.Packaging.Signing.ISignedPackageReader">
<summary>
A readonly package that can provide signatures and a sign manifest from a package.
</summary>
</member>
<member name="M:NuGet.Packaging.Signing.ISignedPackageReader.GetPrimarySignatureAsync(System.Threading.CancellationToken)">
<summary>
Get package signature.
</summary>
<remarks>Returns a null if the package is unsigned.</remarks>
</member>
<member name="M:NuGet.Packaging.Signing.ISignedPackageReader.IsSignedAsync(System.Threading.CancellationToken)">
<summary>
Check if a package contains signing information.
</summary>
<returns>True if the package is signed.</returns>
</member>
<member name="M:NuGet.Packaging.Signing.ISignedPackageReader.GetArchiveHashAsync(NuGet.Common.HashAlgorithmName,System.Threading.CancellationToken)">
<summary>
Gets the hash of an archive to be embedded in the package signature.
</summary>
</member>
<member name="M:NuGet.Packaging.Signing.ISignedPackageReader.ValidateIntegrityAsync(NuGet.Packaging.Signing.SignatureContent,System.Threading.CancellationToken)">
<summary>
Checks for the integrity of a package
</summary>
<param name="signatureContent">SignatureContent with expected hash value and hash algorithm used</param>
<returns></returns>
</member>
<member name="M:NuGet.Packaging.Signing.ISignedPackageReader.GetContentHash(System.Threading.CancellationToken,System.Func{System.String})">
<summary>
Get the hash of the package content excluding signature context for signed package.
If the package is not signed it calculates it from the whole package.
</summary>
<param name="token">Cancellation token.</param>
<param name="GetUnsignedPackageHash">Function to return the hash in case the package is not signed.</param>
<remarks>The method takes an optional function to get the hash of an unsigned package instead of calculating it.</remarks>
<returns>hash of the unsigned content of the package.</returns>
</member>
<member name="M:NuGet.Packaging.Signing.ISignedPackageReader.CanVerifySignedPackages(NuGet.Packaging.Signing.SignedPackageVerifierSettings)">
<summary>
Indicates if the the ISignedPackageReader instance can verify signed packages.
</summary>
<param name="verifierSettings">Package verification settings. Include information about what is allowed.</param>
<exception cref="T:NuGet.Packaging.Signing.SignatureException">if the ISignedPackageReader does not support signed packages</exception>
</member>
<member name="T:NuGet.Packaging.Signing.ISignedPackageWriter">
<summary>
A writer that only allows editing for the package signature.
</summary>
</member>
<member name="M:NuGet.Packaging.Signing.ISignedPackageWriter.RemoveSignatureAsync(System.Threading.CancellationToken)">
<summary>
Removes a signature if it exists.
</summary>
<param name="token">CancellationToken</param>
</member>
<member name="M:NuGet.Packaging.Signing.ISignedPackageWriter.AddSignatureAsync(System.IO.Stream,System.Threading.CancellationToken)">
<summary>
Adds a signature in the package.
Throws exception if the package is already signed.
</summary>
<param name="packageSignatureProvider">A stream of the signature to be added to the package.</param>
<param name="token">Cancellation token.</param>
</member>
<member name="M:NuGet.Packaging.Signing.ISignedPackageWriter.IsZip64Async(System.Threading.CancellationToken)">
<summary>
Check if a package is Zip64.
</summary>
<param name="token">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns a <see cref="T:System.Boolean" />
indicating whether the package is signed.</returns>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="token" />
is cancelled.</exception>
</member>
<member name="T:NuGet.Packaging.Signing.SignedPackageArchive">
<summary>
A nupkg that supports both reading and writing signatures.
</summary>
</member>
<member name="F:NuGet.Packaging.Signing.SignedPackageArchive._zipWriteStream">
<summary>
Stream underlying the ZipArchive. Used to do signature verification on a SignedPackageArchive.
If this is null then we cannot perform signature verification.
</summary>
</member>
<member name="M:NuGet.Packaging.Signing.SignedPackageArchive.AddSignatureAsync(System.IO.Stream,System.Threading.CancellationToken)">
<summary>
Adds a signature to a package if it is not already signed.
</summary>
<param name="signatureStream">Stream of the signature SignedCms object to be added to the package.</param>
<param name="token">Cancellation Token.</param>
<returns></returns>
</member>
<member name="M:NuGet.Packaging.Signing.SignedPackageArchive.RemoveSignatureAsync(System.Threading.CancellationToken)">
<summary>
Remove a signature from the package, if it exists.
</summary>
<param name="token">Cancellation token.</param>
</member>
<member name="P:NuGet.Packaging.Signing.SignatureException.Results">
<summary>
Individual trust results.
</summary>
</member>
<member name="T:NuGet.Packaging.Signing.SignatureLog">
<summary>
Log message for signature verification.
</summary>
</member>
<member name="M:NuGet.Packaging.Signing.SignatureLog.AsRestoreLogMessage">
<summary>
Converts an SignatureLog into a Restore
This is needed when an SignatureLog needs to be logged and loggers do not have visibility to SignatureLog.
</summary>
<returns>RestoreLogMessage equivalent to the SignatureLog.</returns>
</member>
<member name="T:NuGet.Packaging.Signing.AlgorithmIdentifier">
<remarks>This is public only to facilitate testing.</remarks>
</member>
<member name="T:NuGet.Packaging.Signing.CommitmentTypeIndication">
<remarks>This is public only to facilitate testing.</remarks>
</member>
<member name="T:NuGet.Packaging.Signing.CommitmentTypeQualifier">
<remarks>This is public only to facilitate testing.</remarks>
</member>
<member name="T:NuGet.Packaging.Signing.EssCertId">
<remarks>This is public only to facilitate testing.</remarks>
</member>
<member name="T:NuGet.Packaging.Signing.EssCertIdV2">
<remarks>This is public only to facilitate testing.</remarks>
</member>
<member name="T:NuGet.Packaging.Signing.GeneralName">
<remarks>This is public only to facilitate testing.</remarks>
</member>
<member name="T:NuGet.Packaging.Signing.IssuerSerial">
<remarks>This is public only to facilitate testing.</remarks>
</member>
<member name="T:NuGet.Packaging.Signing.NuGetPackageOwners">
<remarks>This is public only to facilitate testing.</remarks>
</member>
<member name="T:NuGet.Packaging.Signing.NuGetV3ServiceIndexUrl">
<remarks>This is public only to facilitate testing.</remarks>
</member>
<member name="T:NuGet.Packaging.Signing.PolicyInformation">
<remarks>This is public only to facilitate testing.</remarks>
</member>
<member name="T:NuGet.Packaging.Signing.PolicyQualifierInfo">
<remarks>This is public only to facilitate testing.</remarks>
</member>
<member name="P:NuGet.Packaging.Signing.PrimarySignature.SignedCms">
<summary>
A SignedCms object holding the signature and SignerInfo.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.PrimarySignature.SignatureContent">
<summary>
Signature content.
</summary>
</member>
<member name="M:NuGet.Packaging.Signing.PrimarySignature.Save(System.IO.Stream)">
<summary>
Save the signed cms signature to a stream.
</summary>
<param name="stream"></param>
</member>
<member name="M:NuGet.Packaging.Signing.PrimarySignature.GetBytes">
<summary>
Retrieve the bytes of the signed cms signature.
</summary>
</member>
<member name="M:NuGet.Packaging.Signing.PrimarySignature.Load(System.Security.Cryptography.Pkcs.SignedCms)">
<summary>
Create a signature based on a valid signed cms
</summary>
<param name="cms">signature data</param>
</member>
<member name="M:NuGet.Packaging.Signing.PrimarySignature.Load(System.Byte[])">
<summary>
Create a signature based on a valid byte array to be decoded as a signed cms
</summary>
<param name="data">signature data</param>
</member>
<member name="M:NuGet.Packaging.Signing.PrimarySignature.Load(System.IO.Stream)">
<summary>
Create a signature based on a valid byte stream to be decoded as a signed cms
</summary>
<param name="stream">signature data</param>
</member>
<member name="T:NuGet.Packaging.Signing.Signature">
<summary>
Package signature information.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.Signature.Type">
<summary>
Indicates if this is an author or repository signature.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.Signature.Timestamps">
<summary>
Signature timestamps.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.Signature.SignerInfo">
<summary>
SignerInfo for this signature.
</summary>
</member>
<member name="M:NuGet.Packaging.Signing.Signature.TryGetValidTimestamp(NuGet.Packaging.Signing.SignedPackageVerifierSettings,NuGet.Common.HashAlgorithmName,System.Collections.Generic.List{NuGet.Packaging.Signing.SignatureLog},NuGet.Packaging.Signing.SignatureVerificationStatusFlags@,NuGet.Packaging.Signing.Timestamp@)">
<summary>
Get a valid timestamp from the unsigned attributes if present
</summary>
<param name="settings">Specify what is allowed in the validation for timestamp</param>
<param name="fingerprintAlgorithm">fingerprint algorithm for displaying timestamp's certificate information</param>
<param name="issues">List of log messages.</param>
<param name="verificationFlags">Flags that specify the status of the verification</param>
<param name="validTimestamp">TTimestamp found in the signature that passes validation with the given <see cref="!:settings" /></param>
<remarks>If <see cref="P:NuGet.Packaging.Signing.SignedPackageVerifierSettings.AllowNoTimestamp" /> is set to true this method return true with a <see cref="!:validTimestamp" /> set to null.</remarks>
<returns>true if a valid timestamp was found</returns>
</member>
<member name="M:NuGet.Packaging.Signing.Signature.Verify(NuGet.Packaging.Signing.Timestamp,NuGet.Packaging.Signing.SignatureVerifySettings,NuGet.Common.HashAlgorithmName,System.Security.Cryptography.X509Certificates.X509Certificate2Collection)">
<summary>
Verify if the signature object meets the specification trust and validity requirements.
</summary>
<param name="timestamp">Timestamp for this signature, if signature is not timestamped it can be null.</param>
<param name="allowUntrusted">Setting that tells if a signature that does not meet any soft failure requirements can still be allowed. Used to know if warnings or errors should be logged for an issue.</param>
<param name="allowUnknownRevocation">Setting that tells if unkown revocation is valid when building the chain.</param>
<param name="allowUntrustedSelfSignedCertificate">Setting that tells if an untrusted self-signed certificate should be allowed as the signing certificate.</param>
<param name="fingerprintAlgorithm">Algorithm used to calculate and display the certificate's fingerprint.</param>
<param name="certificateExtraStore">Collection of certificates to help the chain building engine as an extra store.</param>
<param name="issues">List of log messages.</param>
<remarks>This is only public for ease of testing</remarks>
<returns>Status of trust for signature.</returns>
</member>
<member name="T:NuGet.Packaging.Signing.SignaturePlacement">
<summary>
Indicates signature placement.
</summary>
</member>
<member name="F:NuGet.Packaging.Signing.SignaturePlacement.PrimarySignature">
<summary>
The primary signature.
</summary>
</member>
<member name="F:NuGet.Packaging.Signing.SignaturePlacement.Countersignature">
<summary>
A countersignature on the primary signature.
</summary>
</member>
<member name="F:NuGet.Packaging.Signing.SignaturePlacement.Any">
<summary>
A primary signature or a countersignature.
</summary>
</member>
<member name="T:NuGet.Packaging.Signing.SignatureType">
<summary>
Indicates author or repository signing.
</summary>
</member>
<member name="F:NuGet.Packaging.Signing.SignatureType.Unknown">
<summary>
Default unknown value.
</summary>
</member>
<member name="F:NuGet.Packaging.Signing.SignatureType.Author">
<summary>
Signed by the author.
</summary>
</member>
<member name="F:NuGet.Packaging.Signing.SignatureType.Repository">
<summary>
Signed by the repository.
</summary>
</member>
<member name="T:NuGet.Packaging.Signing.SignatureVerifySettings">
<summary>
Settings to customize Signature.Verify behavior.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.SignatureVerifySettings.AllowIllegal">
<summary>
Allow packages with signatures that do not conform to the specification.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.SignatureVerifySettings.AllowUntrusted">
<summary>
Specifies that a signing certificate's chain that chains to an untrusted root is allowed
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.SignatureVerifySettings.AllowUnknownRevocation">
<summary>
Specifies that a signing certificate's chain with unknown revocation is allowed.
If set to true, offline revocation is allowed.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.SignatureVerifySettings.ReportUnknownRevocation">
<summary>
Indicates if unknown revocation status should be reported.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.SignatureVerifySettings.ReportUntrustedRoot">
<summary>
Indicates if a signing certificate that chains to an untrusted root should be reported.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.SignatureVerifySettings.RevocationMode">
<summary>
Gets how the revocation verification should be performed.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.SignatureVerifySettings.Default">
<summary>
Get default settings values for relaxed verification on a signature
</summary>
</member>
<member name="T:NuGet.Packaging.Signing.SigningCertificate">
<remarks>This is public only to facilitate testing.</remarks>
</member>
<member name="T:NuGet.Packaging.Signing.SigningCertificateV2">
<remarks>This is public only to facilitate testing.</remarks>
</member>
<member name="T:NuGet.Packaging.Signing.SigningSpecifications">
<summary>
Abstract class representing which paths may be used for signing in a package.
</summary>
</member>
<member name="F:NuGet.Packaging.Signing.SigningSpecifications.V1">
<summary>
v1.0.0 signing settings.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.SigningSpecifications.Version">
<summary>
Gets the signature format version.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.SigningSpecifications.SignaturePath">
<summary>
Returns the path for the signature file.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.SigningSpecifications.AllowedHashAlgorithms">
<summary>
Returns the set of allowed hash algorithms.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.SigningSpecifications.AllowedHashAlgorithmOids">
<summary>
Returns the set of allowed hash algorithm Oids.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.SigningSpecifications.AllowedSignatureAlgorithms">
<summary>
Returns the set of allowed signature algorithms.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.SigningSpecifications.AllowedSignatureAlgorithmOids">
<summary>
Returns the set of allowed signature algorithm Oids.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.SigningSpecifications.RSAPublicKeyMinLength">
<summary>
Returns minumum length required for RSA public keys.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.SigningSpecifications.Encoding">
<summary>
Encoding used to generate the signature.
</summary>
</member>
<member name="M:NuGet.Packaging.Signing.SigningSpecifications.#ctor">
<summary>
Initialize a signing specification with a root folder.
</summary>
</member>
<member name="F:NuGet.Packaging.Signing.SigningSpecificationsV1._allowedHashAlgorithms">
<summary>
Allowed digest algorithms for signature and timestamp hashing.
</summary>
</member>
<member name="F:NuGet.Packaging.Signing.SigningSpecificationsV1._allowedHashAlgorithmOids">
<summary>
Allowed digest algorithm Oids for signature and timestamp hashing.
</summary>
</member>
<member name="F:NuGet.Packaging.Signing.SigningSpecificationsV1._allowedSignatureAlgorithms">
<summary>
Allowed signature algorithms.
</summary>
</member>
<member name="F:NuGet.Packaging.Signing.SigningSpecificationsV1._allowedSignatureAlgorithmOids">
<summary>
Allowed signature algorithm Oids.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.SigningSpecificationsV1.Version">
<summary>
Gets the signature format version.
</summary>
</member>
<member name="T:NuGet.Packaging.Signing.Accuracy">
<remarks>This is public only to facilitate testing.</remarks>
</member>
<member name="T:NuGet.Packaging.Signing.Extension">
<remarks>This is public only to facilitate testing.</remarks>
</member>
<member name="T:NuGet.Packaging.Signing.Extensions">
<remarks>This is public only to facilitate testing.</remarks>
</member>
<member name="M:NuGet.Packaging.Signing.IRfc3161TimestampRequest.GetNonce">
<summary>
Gets the nonce for this timestamp request.
</summary>
<returns>The nonce for this timestamp request as byte[], if one was present; otherwise, null</returns>
</member>
<member name="T:NuGet.Packaging.Signing.MessageImprint">
<remarks>This is public only to facilitate testing.</remarks>
</member>
<member name="T:NuGet.Packaging.Signing.Rfc3161TimestampProvider">
<summary>
A provider for RFC 3161 timestamps
https://tools.ietf.org/html/rfc3161
</summary>
</member>
<member name="M:NuGet.Packaging.Signing.Rfc3161TimestampProvider.TimestampSignatureAsync(NuGet.Packaging.Signing.PrimarySignature,NuGet.Packaging.Signing.TimestampRequest,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Timestamps data present in the TimestampRequest.
</summary>
</member>
<member name="M:NuGet.Packaging.Signing.Rfc3161TimestampProvider.GetTimestampAsync(NuGet.Packaging.Signing.TimestampRequest,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Timestamps data present in the TimestampRequest.
</summary>
</member>
<member name="M:NuGet.Packaging.Signing.Rfc3161TimestampProvider.GetNameOrOidString(System.Security.Cryptography.Oid)">
<summary>
Returns the FriendlyName of an Oid. If FriendlyName is null, then the Oid string is returned.
</summary>
</member>
<member name="M:NuGet.Packaging.Signing.Rfc3161TimestampProvider.EnsureValidNonce(System.Byte[])">
<summary>
Non-private for testing purposes only.
</summary>
</member>
<member name="T:NuGet.Packaging.Signing.Rfc3161TimestampTokenInfo">
<summary>
Represents an RFC3161 TSTInfo.
This class should be removed once we can reference it throught the .NET Core framework.
</summary>
</member>
<member name="T:NuGet.Packaging.Signing.Rfc3161TimestampUtils">
<summary>
Internally used by Rfc3161TimestampProvider.
This class should be removed once we can reference it throught the .NET Core framework.
</summary>
</member>
<member name="T:NuGet.Packaging.Signing.Rfc3161TimestampVerificationUtility">
<summary>
Provides convinience method for verification of a RFC 3161 Timestamp.
</summary>
</member>
<member name="T:NuGet.Packaging.Signing.Rfc3161TimestampWin32">
<summary>
Internally used by Rfc3161TimestampProvider.
This class should be removed once we can reference it throught the .NET Core framework.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.Timestamp.UpperLimit">
<summary>
Upper limit of Timestamp.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.Timestamp.LowerLimit">
<summary>
Lower limit of Timestamp.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.Timestamp.GeneralizedTime">
<summary>
Time timestamp was created by the Time Stamp Authority.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.Timestamp.SignedCms">
<summary>
A SignedCms object holding the timestamp and SignerInfo.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.Timestamp.SignerInfo">
<summary>
SignerInfo for this timestamp.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.Timestamp.TstInfo">
<summary>
Timestamp token info for this timestamp.
</summary>
</member>
<member name="M:NuGet.Packaging.Signing.Timestamp.#ctor">
<summary>
Default constructor. Limits are set to current time.
</summary>
</member>
<member name="M:NuGet.Packaging.Signing.Timestamp.#ctor(System.Security.Cryptography.Pkcs.SignedCms)">
<summary>
SignedCms containing a time stamp authority token reponse
</summary>
<param name="timestampCms">SignedCms from Time Stamp Authority</param>
</member>
<member name="M:NuGet.Packaging.Signing.Timestamp.Verify(NuGet.Packaging.Signing.Signature,NuGet.Packaging.Signing.SignedPackageVerifierSettings,NuGet.Common.HashAlgorithmName,System.Collections.Generic.List{NuGet.Packaging.Signing.SignatureLog})">
<summary>
Verify if the timestamp object meets the specification requirements.
</summary>
<param name="signature">Signature which this timestamp is for.</param>
<param name="allowIgnoreTimestamp">Setting that tells if a timestamp can be ignored if it doesn't meet the requirements. Used to know if warnings or errors should be logged for an issue.</param>
<param name="allowUnknownRevocation">Setting that tells if unkown revocation is valid when building the chain.</param>
<param name="issues">List of log messages.</param>
<returns>true if the timestamp meets the requierements, false otherwise.</returns>
</member>
<member name="T:NuGet.Packaging.Signing.TimestampException">
<summary>
Exceptions that are generated while creating a package timestamp.
</summary>
</member>
<member name="T:NuGet.Packaging.Signing.TimestampRequest">
<summary>
Request for timestamping a signature
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.TimestampRequest.SigningSpecifications">
<summary>
Signing Specification for this timestamp request.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.TimestampRequest.HashedMessage">
<summary>
Gets the hashed message to be timestamped.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.TimestampRequest.HashAlgorithm">
<summary>
Gets the hash algorithm used to generate <see cref="P:NuGet.Packaging.Signing.TimestampRequest.HashedMessage" />.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.TimestampRequest.Target">
<summary>
Gets the target signature for the timestamp
</summary>
</member>
<member name="T:NuGet.Packaging.Signing.TstInfo">
<remarks>This is public only to facilitate testing.</remarks>
</member>
<member name="M:NuGet.Packaging.Signing.ITrustedSignersProvider.GetTrustedSigners">
<summary>
Get a list of all the trusted signer entries under the computer trusted signers section.
</summary>
</member>
<member name="M:NuGet.Packaging.Signing.ITrustedSignersProvider.AddOrUpdateTrustedSigner(NuGet.Configuration.TrustedSignerItem)">
<summary>
Adds a new trusted signer or updates an existing one in the settings.
</summary>
<param name="trustedSigners">Trusted signers to be added or updated</param>
</member>
<member name="M:NuGet.Packaging.Signing.ITrustedSignersProvider.Remove(System.Collections.Generic.IReadOnlyList{NuGet.Configuration.TrustedSignerItem})">
<summary>
Removes trusted signers from the settings.
</summary>
<param name="trustedSigners">Trusted signers to be removed</param>
</member>
<member name="T:NuGet.Packaging.Signing.X509TrustStore">
<summary>
Represents the X.509 trust store that package signing and signed package verification will use.
</summary>
</member>
<member name="M:NuGet.Packaging.Signing.X509TrustStore.InitializeForDotNetSdk(NuGet.Common.ILogger)">
<summary>
Initializes the X.509 trust store for NuGet .NET SDK scenarios and logs details about the attempt.
If initialization has already happened, a call to this method will have no effect.
</summary>
<param name="logger">A logger.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="logger" /> is <c>null</c>.</exception>
</member>
<member name="M:NuGet.Packaging.Signing.AttributeUtility.CreateCommitmentTypeIndication(NuGet.Packaging.Signing.SignatureType)">
<summary>
Create a CommitmentTypeIndication attribute.
https://tools.ietf.org/html/rfc5126.html#section-5.11.1
</summary>
<param name="type">The signature type.</param>
</member>
<member name="M:NuGet.Packaging.Signing.AttributeUtility.GetSignatureType(System.Security.Cryptography.CryptographicAttributeObjectCollection)">
<summary>
Gets the signature type from one or more commitment-type-indication attributes.
</summary>
<param name="signedAttributes">A <see cref="T:System.Security.Cryptography.Pkcs.SignerInfo" /> signed attributes collection.</param>
<remarks>Unknown OIDs are ignored.</remarks>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="signedAttributes" /> is <c>null</c>.</exception>
<exception cref="T:NuGet.Packaging.Signing.SignatureException">Thrown if one or more attributes are invalid.</exception>
</member>
<member name="M:NuGet.Packaging.Signing.AttributeUtility.CreateNuGetV3ServiceIndexUrl(System.Uri)">
<summary>
Creates a nuget-v3-service-index-url attribute.
</summary>
<param name="v3ServiceIndexUrl">The V3 service index HTTPS URL.</param>
<returns>An attribute object.</returns>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="v3ServiceIndexUrl" /> is null.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="v3ServiceIndexUrl" /> is neither absolute
nor HTTPS.</exception>
</member>
<member name="M:NuGet.Packaging.Signing.AttributeUtility.GetNuGetV3ServiceIndexUrl(System.Security.Cryptography.CryptographicAttributeObjectCollection)">
<summary>
Gets the V3 service index HTTPS URL from the nuget-v3-service-index-url attribute.
</summary>
<param name="signedAttributes">A <see cref="T:System.Security.Cryptography.Pkcs.SignerInfo" /> signed attributes collection.</param>
<returns>The V3 service index HTTPS URL.</returns>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="signedAttributes" />
is <c>null</c>.</exception>
<exception cref="T:NuGet.Packaging.Signing.SignatureException">Thrown if either exactly one attribute is not present or if
the attribute does not contain exactly one attribute value.</exception>
</member>
<member name="M:NuGet.Packaging.Signing.AttributeUtility.CreateNuGetPackageOwners(System.Collections.Generic.IReadOnlyList{System.String})">
<summary>
Creates a nuget-package-owners attribute.
</summary>
<param name="packageOwners">A read-only list of package owners.</param>
<returns>An attribute object.</returns>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="packageOwners" /> is either <c>null</c>
or empty or if any package owner name is invalid.</exception>
</member>
<member name="M:NuGet.Packaging.Signing.AttributeUtility.GetNuGetPackageOwners(System.Security.Cryptography.CryptographicAttributeObjectCollection)">
<summary>
Gets a read-only list of package owners from an optional nuget-package-owners attribute.
</summary>
<param name="signedAttributes">A <see cref="T:System.Security.Cryptography.Pkcs.SignerInfo" /> signed attributes collection.</param>
<returns>A read-only list of package owners or <c>null</c>.</returns>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="signedAttributes" /> is <c>null</c>.</exception>
<exception cref="T:NuGet.Packaging.Signing.SignatureException">Thrown if the attribute does not contain exactly one
attribute value.</exception>
</member>
<member name="M:NuGet.Packaging.Signing.AttributeUtility.GetSignatureType(System.String)">
<summary>
Oid -> SignatureType
</summary>
<param name="oid">The commitment-type-indication value.</param>
</member>
<member name="M:NuGet.Packaging.Signing.AttributeUtility.GetSignatureTypeOid(NuGet.Packaging.Signing.SignatureType)">
<summary>
SignatureType -> Oid
</summary>
<param name="signatureType">The signature type.</param>
</member>
<member name="M:NuGet.Packaging.Signing.AttributeUtility.CreateSigningCertificateV2(System.Security.Cryptography.X509Certificates.X509Certificate2,NuGet.Common.HashAlgorithmName)">
<summary>
Create a signing-certificate-v2 from a certificate.
</summary>
<param name="certificate">The signing certificate.</param>
<param name="hashAlgorithm">The hash algorithm for the signing-certificate-v2 attribute.</param>
</member>
<member name="M:NuGet.Packaging.Signing.AttributeUtility.GetAttributeOrDefault(System.Security.Cryptography.CryptographicAttributeObjectCollection,System.String)">
<summary>
Returns the first attribute if the Oid is found.
Returns null if the attribute is not found.
</summary>
</member>
<member name="M:NuGet.Packaging.Signing.AttributeUtility.ThrowInvalidAttributeException(System.Security.Cryptography.CryptographicAttributeObject)">
<summary>
Throw a signature exception due to an invalid attribute. This is used for unusual situations
where the format is corrupt.
</summary>
</member>
<member name="M:NuGet.Packaging.Signing.AttributeUtility.ToList(System.Security.Cryptography.AsnEncodedDataCollection)">
<summary>
Enumerate AsnEncodedDataCollection
</summary>
</member>
<member name="M:NuGet.Packaging.Signing.AttributeUtility.GetCommitmentTypeIndicationRawValues(System.Security.Cryptography.CryptographicAttributeObject)">
<summary>
Attribute -> SignatureType values with no validation.
</summary>
</member>
<member name="M:NuGet.Packaging.Signing.AttributeUtility.GetAttribute(System.Security.Cryptography.CryptographicAttributeObjectCollection,System.String)">
<summary>
Gets 0 or 1 attribute with the specified OID. If more than one attribute is found, an exception is thrown.
</summary>
<param name="attributes">A collection of attributes.</param>
<param name="oid">The attribute OID to search for.</param>
<returns>Either a <see cref="T:System.Security.Cryptography.CryptographicAttributeObject" /> or <c>null</c>, if no attribute was found.</returns>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="attributes" /> is <c>null</c>.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="oid" /> is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">Thrown if multiple attribute instances with the specified OID were found.</exception>
</member>
<member name="M:NuGet.Packaging.Signing.AttributeUtility.GetAttributes(System.Security.Cryptography.CryptographicAttributeObjectCollection,System.String)">
<summary>
Gets 0 or 1 or many attributes with the specified OID.
</summary>
<param name="attributes">A collection of attributes.</param>
<param name="oid">The attribute OID to search for.</param>
<returns>Either a <see cref="T:System.Security.Cryptography.CryptographicAttributeObject" /> or <c>null</c>, if no attribute was found.</returns>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="attributes" /> is <c>null</c>.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="oid" /> is either <c>null</c> or an empty string.</exception>
</member>
<member name="M:NuGet.Packaging.Signing.CertificateChainUtility.GetCertificateChain(System.Security.Cryptography.X509Certificates.X509Certificate2,System.Security.Cryptography.X509Certificates.X509Certificate2Collection,NuGet.Common.ILogger,NuGet.Packaging.Signing.CertificateType)">
<summary>
Create a list of certificates in chain order with the leaf first and root last.
</summary>
<param name="certificate">The certificate for which a chain should be built.</param>
<param name="extraStore">A certificate store containing additional certificates necessary
for chain building.</param>
<param name="logger">A logger.</param>
<param name="certificateType">The certificate type.</param>
<returns>A certificate chain.</returns>
<remarks>This is intended to be used only during signing and timestamping operations,
not verification.</remarks>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="certificate" /> is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="extraStore" /> is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="logger" /> is <c>null</c>.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="certificateType" /> is undefined.</exception>
</member>
<member name="M:NuGet.Packaging.Signing.CertificateChainUtility.GetCertificateChain(System.Security.Cryptography.X509Certificates.X509Chain)">
<summary>
Create an ordered list of certificates. The leaf node is returned first.
</summary>
<param name="x509Chain">Certificate chain to be converted to list.</param>
<remarks>This does not check validity or trust. It returns the chain as-is.</remarks>
</member>
<member name="M:NuGet.Packaging.Signing.CertificateUtility.X509Certificate2ToString(System.Security.Cryptography.X509Certificates.X509Certificate2,NuGet.Common.HashAlgorithmName)">
<summary>
Converts a X509Certificate2 to a human friendly string of the following format -
Subject Name: CN=name
SHA1 hash: hash
Issued by: CN=issuer
Valid from: issue date time to expiry date time in local time
</summary>
<param name="cert">X509Certificate2 to be converted to string.</param>
<param name="fingerprintAlgorithm">Algorithm used to calculate certificate fingerprint</param>
<returns>string representation of the X509Certificate2.</returns>
</member>
<member name="M:NuGet.Packaging.Signing.CertificateUtility.X509Certificate2ToLogMessages(System.Security.Cryptography.X509Certificates.X509Certificate2,NuGet.Common.HashAlgorithmName,System.String)">
<summary>
Converts a X509Certificate2 to a collection of log messages for various verbosity levels -
Subject Name: CN=name
SHA1 hash: hash
Issued by: CN=issuer
Valid from: issue date time to expiry date time in local time
</summary>
<param name="cert">X509Certificate2 to be converted to string.</param>
<param name="fingerprintAlgorithm">Algorithm used to calculate certificate fingerprint</param>
<returns>string representation of the X509Certificate2.</returns>
</member>
<member name="M:NuGet.Packaging.Signing.CertificateUtility.X509Certificate2CollectionToString(System.Security.Cryptography.X509Certificates.X509Certificate2Collection,NuGet.Common.HashAlgorithmName)">
<summary>
Converts a X509Certificate2Collection to a human friendly string of the following format -
Subject Name: CN=name
SHA1 hash: hash
Issued by: CN=issuer
Valid from: issue date time to expiry date time in local time
Subject Name: CN=name
SHA1 hash: hash
Issued by: CN=issuer
Valid from: issue date time to expiry date time in local time
... N more.
</summary>
<param name="certCollection">X509Certificate2Collection to be converted to string.</param>
<param name="fingerprintAlgorithm">Algorithm used to calculate certificate fingerprint</param>
<returns>string representation of the X509Certificate2Collection.</returns>
</member>
<member name="M:NuGet.Packaging.Signing.CertificateUtility.IsSignatureAlgorithmSupported(System.Security.Cryptography.X509Certificates.X509Certificate2)">
<summary>
Determines if a certificate's signature algorithm is supported.
</summary>
<param name="certificate">Certificate to validate</param>
<returns>True if the certificate's signature algorithm is supported.</returns>
</member>
<member name="M:NuGet.Packaging.Signing.CertificateUtility.IsCertificatePublicKeyValid(System.Security.Cryptography.X509Certificates.X509Certificate2)">
<summary>
Validates the public key requirements for a certificate
</summary>
<param name="certificate">Certificate to validate</param>
<returns>True if the certificate's public key is valid within NuGet signature requirements</returns>
</member>
<member name="M:NuGet.Packaging.Signing.CertificateUtility.HasLifetimeSigningEku(System.Security.Cryptography.X509Certificates.X509Certificate2)">
<summary>
Validates if the certificate contains the lifetime signing EKU
</summary>
<param name="certificate">Certificate to validate</param>
<returns>True if the certificate has the lifetime signing EKU</returns>
</member>
<member name="M:NuGet.Packaging.Signing.CertificateUtility.HasExtendedKeyUsage(System.Security.Cryptography.X509Certificates.X509Certificate2,System.String)">
<summary>
Checks if an X509Certificate2 contains a particular Extended Key Usage (EKU).
</summary>
<param name="certificate">X509Certificate2 to be checked.</param>
<param name="ekuOid">String OID of the Extended Key Usage</param>
<returns>A bool indicating if the X509Certificate2 contains specified OID in its Extended Key Usage.</returns>
</member>
<member name="M:NuGet.Packaging.Signing.CertificateUtility.IsValidForPurposeFast(System.Security.Cryptography.X509Certificates.X509Certificate2,System.String)">
<summary>
Checks if an X509Certificate2 is valid for a particular purpose.
</summary>
<remarks>
This must not be used in evaluation of a signed package.
A more accurate test is building a chain with the specified EKU asserted in the application policy.
</remarks>
<param name="certificate">X509Certificate2 to be checked.</param>
<param name="ekuOid">String OID of the Extended Key Usage</param>
<returns>A bool indicating if the X509Certificate2 contains specified OID string in its Extended Key Usage.</returns>
</member>
<member name="M:NuGet.Packaging.Signing.CertificateUtility.GetHash(System.Security.Cryptography.X509Certificates.X509Certificate2,NuGet.Common.HashAlgorithmName)">
<summary>
Gets the certificate fingerprint with the given hashing algorithm
</summary>
<param name="certificate">X509Certificate2 to be compute fingerprint</param>
<param name="hashAlgorithm">Hash algorithm for fingerprint</param>
<returns>A byte array representing the certificate hash.</returns>
</member>
<member name="M:NuGet.Packaging.Signing.CertificateUtility.GetHashString(System.Security.Cryptography.X509Certificates.X509Certificate2,NuGet.Common.HashAlgorithmName)">
<summary>
Gets the certificate fingerprint string with the given hashing algorithm
</summary>
<param name="certificate">X509Certificate2 to be compute fingerprint</param>
<param name="hashAlgorithm">Hash algorithm for fingerprint</param>
<returns>A string representing the certificate hash.</returns>
</member>
<member name="M:NuGet.Packaging.Signing.CertificateUtility.IsSelfIssued(System.Security.Cryptography.X509Certificates.X509Certificate2)">
<summary>
Determines if a certificate is self-issued.
</summary>
<remarks>Warning: this method does not evaluate certificate trust, revocation status, or validity!
This method attempts to build a chain for the provided certificate, and although revocation status
checking is explicitly skipped, the underlying chain building engine may go online to fetch
additional information (e.g.: the issuer's certificate). This method is not a guaranteed offline
check.</remarks>
<param name="certificate">The certificate to check.</param>
<returns><c>true</c> if the certificate is self-issued; otherwise, <c>false</c>.</returns>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="certificate" /> is <c>null</c>.</exception>
</member>
<member name="T:NuGet.Packaging.Signing.IX509CertificateChain">
<summary>
Represents a certificate chain ordered from end certificate (index 0) to root certificate.
</summary>
</member>
<member name="M:NuGet.Packaging.Signing.RepositorySignatureInfoUtility.GetSignedPackageVerifierSettings(NuGet.Packaging.RepositorySignatureInfo,NuGet.Packaging.Signing.SignedPackageVerifierSettings)">
<summary>
Gets SignedPackageVerifierSettings from a given RepositorySignatureInfo.
</summary>
<param name="repoSignatureInfo">RepositorySignatureInfo to be used.</param>
<param name="fallbackSettings">SignedPackageVerifierSettings to be used if RepositorySignatureInfo is unavailable.</param>
<returns>SignedPackageVerifierSettings based on the RepositorySignatureInfo and SignedPackageVerifierSettings.</returns>
</member>
<member name="M:NuGet.Packaging.Signing.SignatureUtility.GetCertificateChain(NuGet.Packaging.Signing.PrimarySignature)">
<summary>
Gets certificates in the certificate chain for the primary signature.
</summary>
<param name="primarySignature">The primary signature.</param>
<returns>A non-empty, read-only list of X.509 certificates ordered from signing certificate to root.</returns>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="primarySignature" /> is <c>null</c>.</exception>
<remarks>
WARNING: This method does not perform revocation, trust, or certificate validity checking.
</remarks>
</member>
<member name="M:NuGet.Packaging.Signing.SignatureUtility.GetCertificateChain(NuGet.Packaging.Signing.PrimarySignature,NuGet.Packaging.Signing.RepositoryCountersignature)">
<summary>
Gets certificates in the certificate chain for the repository countersignature.
</summary>
<param name="primarySignature">The primary signature.</param>
<param name="repositoryCountersignature">The repository countersignature.</param>
<returns>A non-empty, read-only list of X.509 certificates ordered from signing certificate to root.</returns>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="primarySignature" /> is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="repositoryCountersignature" /> is <c>null</c>.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="repositoryCountersignature" /> is
unrelated to <paramref name="primarySignature" />.</exception>
<remarks>
WARNING: This method does not perform revocation, trust, or certificate validity checking.
</remarks>
</member>
<member name="M:NuGet.Packaging.Signing.SignatureUtility.GetTimestampCertificateChain(NuGet.Packaging.Signing.PrimarySignature)">
<summary>
Gets certificates in the certificate chain for a timestamp on the primary signature.
</summary>
<param name="primarySignature">The primary signature.</param>
<returns>A non-empty, read-only list of X.509 certificates ordered from signing certificate to root.</returns>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="primarySignature" /> is <c>null</c>.</exception>
<exception cref="T:NuGet.Packaging.Signing.SignatureException">Thrown if <paramref name="primarySignature" /> does not have a valid
timestamp.</exception>
<remarks>
WARNING: This method does not perform revocation, trust, or certificate validity checking.
</remarks>
</member>
<member name="M:NuGet.Packaging.Signing.SignatureUtility.GetTimestampCertificateChain(NuGet.Packaging.Signing.PrimarySignature,NuGet.Packaging.Signing.RepositoryCountersignature)">
<summary>
Gets certificates in the certificate chain for a timestamp on the repository countersignature.
</summary>
<param name="primarySignature">The primary signature.</param>
<param name="repositoryCountersignature">The repository countersignature.</param>
<returns>A non-empty, read-only list of X.509 certificates ordered from signing certificate to root.</returns>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="primarySignature" /> is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="repositoryCountersignature" /> is <c>null</c>.</exception>
<exception cref="T:NuGet.Packaging.Signing.SignatureException">Thrown if <paramref name="repositoryCountersignature" /> does not have a valid
timestamp.</exception>
<remarks>
WARNING: This method does not perform revocation, trust, or certificate validity checking.
</remarks>
</member>
<member name="T:NuGet.Packaging.Signing.SigningUtility">
<summary>
Utility methods for signing.
</summary>
</member>
<member name="M:NuGet.Packaging.Signing.SigningUtility.SignAsync(NuGet.Packaging.Signing.SigningOptions,NuGet.Packaging.Signing.SignPackageRequest,System.Threading.CancellationToken)">
<summary>
Add a signature to a package.
</summary>
</member>
<member name="T:NuGet.Packaging.Signing.X509ChainHolder">
<summary>
Creates and performs cleanup on an <see cref="T:System.Security.Cryptography.X509Certificates.X509Chain" /> instance.
</summary>
<remarks>
Certificates held by individual X509ChainElement objects should be disposed immediately after use to minimize
finalizer impact.
</remarks>
</member>
<member name="P:NuGet.Packaging.Signing.ClientPolicyContext.Policy">
<summary>
Current policy the client is on.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.ClientPolicyContext.VerifierSettings">
<summary>
Verification settings corresponding the current client policy.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.ClientPolicyContext.AllowList">
<summary>
List of signatures allowed in verification.
</summary>
</member>
<member name="T:NuGet.Packaging.Signing.IPackageSignatureVerifier">
<summary>
Loads trust providers and verifies package signatures.
</summary>
</member>
<member name="M:NuGet.Packaging.Signing.IPackageSignatureVerifier.VerifySignaturesAsync(NuGet.Packaging.Signing.ISignedPackageReader,NuGet.Packaging.Signing.SignedPackageVerifierSettings,System.Threading.CancellationToken,System.Guid)">
<summary>
Verifies package signature.
</summary>
<param name="package">Package to be verified.</param>
<param name="settings">SignedPackageVerifierSettings to be used when verifying the package.</param>
<param name="token">Cancellation Token.</param>
<param name="telemetryOperationId">Guid of the parent event.</param>
<returns>VerifySignaturesResult containing the result of the verify operation.</returns>
</member>
<member name="T:NuGet.Packaging.Signing.ISignatureVerificationProvider">
<summary>
Providers signature trust information.
</summary>
</member>
<member name="M:NuGet.Packaging.Signing.ISignatureVerificationProvider.GetTrustResultAsync(NuGet.Packaging.Signing.ISignedPackageReader,NuGet.Packaging.Signing.PrimarySignature,NuGet.Packaging.Signing.SignedPackageVerifierSettings,System.Threading.CancellationToken)">
<summary>
Check if <paramref name="signature" /> is trusted by the provider.
</summary>
</member>
<member name="M:NuGet.Packaging.Signing.PackageSignatureVerifier.IsValid(System.Collections.Generic.IEnumerable{NuGet.Packaging.Signing.PackageVerificationResult})">
<summary>
True if a provider trusts the package signature.
</summary>
</member>
<member name="T:NuGet.Packaging.Signing.PackageVerificationResult">
<summary>
Represents a signature check result and any additional information
needed to display to the user.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.PackageVerificationResult.Trust">
<summary>
Trust result
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.PackageVerificationResult.Issues">
<summary>
List of issues found in the verification process
</summary>
</member>
<member name="M:NuGet.Packaging.Signing.PackageVerificationResult.#ctor(NuGet.Packaging.Signing.SignatureVerificationStatus,System.Collections.Generic.IEnumerable{NuGet.Packaging.Signing.SignatureLog})">
<summary>
PackageVerificationResult
</summary>
</member>
<member name="F:NuGet.Packaging.Signing.SignatureVerificationBehavior.Never">
<summary>
Do not verify a signature.
</summary>
</member>
<member name="F:NuGet.Packaging.Signing.SignatureVerificationBehavior.IfExists">
<summary>
Verify a signature if and only if it exists.
</summary>
</member>
<member name="F:NuGet.Packaging.Signing.SignatureVerificationBehavior.IfExistsAndIsNecessary">
<summary>
Verify a signature if and only if it exists and is necessary
(e.g.: trust evaluation of another signature depends on it).
</summary>
</member>
<member name="F:NuGet.Packaging.Signing.SignatureVerificationBehavior.Always">
<summary>
Verify a signature always. If the signature is not present, it is an error.
</summary>
</member>
<member name="T:NuGet.Packaging.Signing.SignatureVerificationStatus">
<summary>
Represents the trust result of a signature.
</summary>
<remarks>The order of the elements on this enum is important.
It should be ordered from most severe to valid.
When a verification with multiple steps wants to be strict it should take the min
out of each step as the status for the whole verification.</remarks>
</member>
<member name="F:NuGet.Packaging.Signing.SignatureVerificationStatus.Unknown">
<summary>
Default unknown value.
</summary>
</member>
<member name="F:NuGet.Packaging.Signing.SignatureVerificationStatus.Suspect">
<summary>
Invalid package signature.
</summary>
<remarks>This could happen because the package integrity check fails or the certificate is revoked.</remarks>
</member>
<member name="F:NuGet.Packaging.Signing.SignatureVerificationStatus.Disallowed">
<summary>
The signature is disallowed based on verification settings.
</summary>
</member>
<member name="F:NuGet.Packaging.Signing.SignatureVerificationStatus.Valid">
<summary>
Signature is valid for the verification step.
</summary>
</member>
<member name="F:NuGet.Packaging.Signing.SignatureVerificationStatusFlags.NoErrors">
<summary>
There was no error found
</summary>
</member>
<member name="F:NuGet.Packaging.Signing.SignatureVerificationStatusFlags.NoSignature">
<summary>
A signature was not found
</summary>
</member>
<member name="F:NuGet.Packaging.Signing.SignatureVerificationStatusFlags.NoCertificate">
<summary>
Signer certificate was not found
</summary>
</member>
<member name="F:NuGet.Packaging.Signing.SignatureVerificationStatusFlags.MultipleSignatures">
<summary>
Multiple signatures were found
</summary>
</member>
<member name="F:NuGet.Packaging.Signing.SignatureVerificationStatusFlags.SignatureCheckFailed">
<summary>
A call to SignedCms.CheckSignature failed
</summary>
</member>
<member name="F:NuGet.Packaging.Signing.SignatureVerificationStatusFlags.SignatureAlgorithmUnsupported">
<summary>
Signature algorithm is not supported
</summary>
</member>
<member name="F:NuGet.Packaging.Signing.SignatureVerificationStatusFlags.CertificatePublicKeyInvalid">
<summary>
Public key does not conform with the requirements of the spec
</summary>
</member>
<member name="F:NuGet.Packaging.Signing.SignatureVerificationStatusFlags.HasLifetimeSigningEku">
<summary>
Signing certificate has lifetimeSigningEku
</summary>
</member>
<member name="F:NuGet.Packaging.Signing.SignatureVerificationStatusFlags.CertificateValidityInTheFuture">
<summary>
Signer certificate's validity is in the future
</summary>
</member>
<member name="F:NuGet.Packaging.Signing.SignatureVerificationStatusFlags.CertificateExpired">
<summary>
Signing certificate has expired
</summary>
</member>
<member name="F:NuGet.Packaging.Signing.SignatureVerificationStatusFlags.HashAlgorithmUnsupported">
<summary>
Hashing algorithm is not supported
</summary>
</member>
<member name="F:NuGet.Packaging.Signing.SignatureVerificationStatusFlags.MessageImprintUnsupportedAlgorithm">
<summary>
Message imprint uses a hash algorithm that is not supported
</summary>
</member>
<member name="F:NuGet.Packaging.Signing.SignatureVerificationStatusFlags.IntegrityCheckFailed">
<summary>
Integrity check of the signature failed
</summary>
</member>
<member name="F:NuGet.Packaging.Signing.SignatureVerificationStatusFlags.ChainBuildingFailure">
<summary>
Chain building failures.
Some specific chain building failures (like revocation, revocation status unavailable, certificate expired, etc.)
are not covered by this flag because they are covered specially by another status flag.
</summary>
</member>
<member name="F:NuGet.Packaging.Signing.SignatureVerificationStatusFlags.UnknownRevocation">
<summary>
Revocation information was unavailable or was offline for the signer certificate
</summary>
</member>
<member name="F:NuGet.Packaging.Signing.SignatureVerificationStatusFlags.CertificateRevoked">
<summary>
Signing certificate was revoked
</summary>
</member>
<member name="F:NuGet.Packaging.Signing.SignatureVerificationStatusFlags.UntrustedRoot">
<summary>
Signing certificate chains to a certificate untrusted by the computer performing the verification
</summary>
</member>
<member name="F:NuGet.Packaging.Signing.SignatureVerificationStatusFlags.GeneralizedTimeOutsideValidity">
<summary>
The Timestamp's generalized time was outside certificate's validity period
</summary>
</member>
<member name="F:NuGet.Packaging.Signing.SignatureVerificationStatusFlags.NoValidTimestamp">
<summary>
A valid timestamp was not found.
</summary>
</member>
<member name="F:NuGet.Packaging.Signing.SignatureVerificationStatusFlags.MultipleTimestamps">
<summary>
Multiple timestamps were found.
</summary>
</member>
<member name="F:NuGet.Packaging.Signing.SignatureVerificationStatusFlags.Suspect">
<summary>
Flags which indicate that the signed package is suspect.
</summary>
</member>
<member name="F:NuGet.Packaging.Signing.SignatureVerificationStatusFlags.Illegal">
<summary>
Flags which indicate that the signed package is illegal.
</summary>
</member>
<member name="F:NuGet.Packaging.Signing.SignatureVerificationStatusFlags.Untrusted">
<summary>
Flags which indicate that the signed package is untrusted.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.SignatureVerificationSummary.SignatureType">
<summary>
Type of the signature that was verified
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.SignatureVerificationSummary.Status">
<summary>
Status of the verification
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.SignatureVerificationSummary.Flags">
<summary>
Reasons for the status.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.SignatureVerificationSummary.Timestamp">
<summary>
Timestamp used to validate certificate.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.SignatureVerificationSummary.ExpirationTime">
<summary>
Expiration Date and Time for signature
</summary>
<remarks>This field will only be set if the certificate is expired.</remarks>
</member>
<member name="P:NuGet.Packaging.Signing.SignedPackageVerificationResult.Signature">
<summary>
Signature
</summary>
</member>
<member name="T:NuGet.Packaging.Signing.SignedPackageVerifierSettings">
<summary>
Feed settings used to verify packages.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.SignedPackageVerifierSettings.AllowUnsigned">
<summary>
Allow packages that do not contain signatures.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.SignedPackageVerifierSettings.AllowIllegal">
<summary>
Allow packages with signatures that do not conform to the specification.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.SignedPackageVerifierSettings.AllowUntrusted">
<summary>
Allow packages that have not been explicitly trusted by the consumer.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.SignedPackageVerifierSettings.AllowIgnoreTimestamp">
<summary>
Allow ignoring timestamp.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.SignedPackageVerifierSettings.AllowMultipleTimestamps">
<summary>
Allow more than one timestamp.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.SignedPackageVerifierSettings.AllowNoTimestamp">
<summary>
Allow no timestamp.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.SignedPackageVerifierSettings.AllowUnknownRevocation">
<summary>
Treat unknown revocation status as a warning instead of an error during verification.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.SignedPackageVerifierSettings.ReportUnknownRevocation">
<summary>
Report unknown revocation status.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.SignedPackageVerifierSettings.VerificationTarget">
<summary>
Gets the verification target(s).
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.SignedPackageVerifierSettings.SignaturePlacement">
<summary>
Gets the placement of verification target(s).
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.SignedPackageVerifierSettings.RepositoryCountersignatureVerificationBehavior">
<summary>
Gets the repository countersignature verification behavior.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.SignedPackageVerifierSettings.RevocationMode">
<summary>
Gets how the revocation verification should be performed.
</summary>
</member>
<member name="M:NuGet.Packaging.Signing.SignedPackageVerifierSettings.GetDefault(NuGet.Common.IEnvironmentVariableReader)">
<summary>
Default settings.
</summary>
<param name="environmentVariableReader">An <see cref="T:NuGet.Common.IEnvironmentVariableReader" /> instance or <c>null</c> for the default environment variable reader.</param>
<returns>A <see cref="T:NuGet.Packaging.Signing.SignedPackageVerifierSettings" /> instance.</returns>
</member>
<member name="M:NuGet.Packaging.Signing.SignedPackageVerifierSettings.GetAcceptModeDefaultPolicy(NuGet.Common.IEnvironmentVariableReader)">
<summary>
The accept mode policy.
</summary>
<param name="environmentVariableReader">An <see cref="T:NuGet.Common.IEnvironmentVariableReader" /> instance or <c>null</c> for the default environment variable reader.</param>
<returns>A <see cref="T:NuGet.Packaging.Signing.SignedPackageVerifierSettings" /> instance.</returns>
</member>
<member name="M:NuGet.Packaging.Signing.SignedPackageVerifierSettings.GetRequireModeDefaultPolicy(NuGet.Common.IEnvironmentVariableReader)">
<summary>
The require mode policy.
</summary>
<param name="environmentVariableReader">An <see cref="T:NuGet.Common.IEnvironmentVariableReader" /> instance or <c>null</c> for the default environment variable reader.</param>
<returns>A <see cref="T:NuGet.Packaging.Signing.SignedPackageVerifierSettings" /> instance.</returns>
</member>
<member name="M:NuGet.Packaging.Signing.SignedPackageVerifierSettings.GetVerifyCommandDefaultPolicy(NuGet.Common.IEnvironmentVariableReader)">
<summary>
Default policy for nuget.exe verify --signatures command.
</summary>
<param name="environmentVariableReader">An <see cref="T:NuGet.Common.IEnvironmentVariableReader" /> instance or <c>null</c> for the default environment variable reader.</param>
<returns>A <see cref="T:NuGet.Packaging.Signing.SignedPackageVerifierSettings" /> instance.</returns>
</member>
<member name="P:NuGet.Packaging.Signing.TrustedSignerAllowListEntry.Owners">
<summary>
List of allowed owners for a repository signature
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.TrustedSignerAllowListEntry.AllowUntrustedRoot">
<summary>
Describe if the certificate should be allowed to chain to an untrusted certificate
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.VerificationAllowListEntry.Target">
<summary>
Target type of signature to verify.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.VerificationAllowListEntry.Placement">
<summary>
Signature placement to verify.
</summary>
</member>
<member name="T:NuGet.Packaging.Signing.VerificationTarget">
<summary>
Indicates the type of signature a verification is targeting
</summary>
<remarks>This target makes no assumption about the placement of the signature.
It only refers to author or repository type of signature.
If a specific placement is needed use the <see cref="T:NuGet.Packaging.Signing.SignaturePlacement" /> enum.</remarks>
</member>
<member name="F:NuGet.Packaging.Signing.VerificationTarget.None">
<summary>
Don't target any signatures.
</summary>
</member>
<member name="F:NuGet.Packaging.Signing.VerificationTarget.Unknown">
<summary>
Target unknown primary signatures.
</summary>
</member>
<member name="F:NuGet.Packaging.Signing.VerificationTarget.Author">
<summary>
Target author signatures
</summary>
</member>
<member name="F:NuGet.Packaging.Signing.VerificationTarget.Repository">
<summary>
Target repository signatures
</summary>
</member>
<member name="F:NuGet.Packaging.Signing.VerificationTarget.All">
<summary>
Target all available signatures.
</summary>
</member>
<member name="T:NuGet.Packaging.Signing.VerifySignaturesResult">
<summary>
Collection of signature verification results.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.VerifySignaturesResult.IsValid">
<summary>
True if signature is valid.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.VerifySignaturesResult.IsSigned">
<summary>
True if the package is signed.
</summary>
</member>
<member name="P:NuGet.Packaging.Signing.VerifySignaturesResult.Results">
<summary>
Individual trust results.
</summary>
</member>
<member name="T:NuGet.Packaging.RepositorySignatureInfoProvider">
<summary>
RepositorySignatureInfoProvdier is a static cache for repository signature information for package source.
</summary>
</member>
<member name="M:NuGet.Packaging.RepositorySignatureInfoProvider.TryGetRepositorySignatureInfo(System.String,NuGet.Packaging.RepositorySignatureInfo@)">
<summary>
Try to get repository signature information for the source.
</summary>
<param name="source">Package source URL.</param>
<param name="repositorySignatureInfo">Contains the RepositorySignatureInfo when the method returns. It is null if repository signature information is unavailable.</param>
<returns>True if the repository signature information was found. Otherwise, False.</returns>
</member>
<member name="M:NuGet.Packaging.RepositorySignatureInfoProvider.AddOrUpdateRepositorySignatureInfo(System.String,NuGet.Packaging.RepositorySignatureInfo)">
<summary>
Add or update the repository signature information for the source.
</summary>
<param name="source">Package source URL.</param>
<param name="repositorySignatureInfo">RepositorySignatureInfo for the source url.</param>
</member>
<member name="T:NuGet.Packaging.Strings">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.AnAbsoluteUriIsRequired">
<summary>
Looks up a localized string similar to An absolute URI is required..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.ArgumentCannotBeNullOrEmpty">
<summary>
Looks up a localized string similar to The argument cannot be null or empty..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.AuthorPrimarySignatureFriendlyName">
<summary>
Looks up a localized string similar to author primary signature.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.CertificateChainBuildFailed">
<summary>
Looks up a localized string similar to A complete certificate chain could not be built for the signing certificate..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.CertificateChainValidationFailed">
<summary>
Looks up a localized string similar to Certificate chain validation failed..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.CertUtilityCertificateHash">
<summary>
Looks up a localized string similar to {0} hash: {1}.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.CertUtilityCertificateHashSha1">
<summary>
Looks up a localized string similar to SHA1 hash: {0}.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.CertUtilityCertificateIssuer">
<summary>
Looks up a localized string similar to Issued by: {0}.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.CertUtilityCertificateSubjectName">
<summary>
Looks up a localized string similar to Subject Name: {0}.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.CertUtilityCertificateValidity">
<summary>
Looks up a localized string similar to Valid from: {0} to {1}.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.CertUtilityMultipleCertificatesFooter">
<summary>
Looks up a localized string similar to ... {0} more..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.CertUtilityMultipleCertificatesHeader">
<summary>
Looks up a localized string similar to The following certificates meet all given criteria:.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.ChainBuilding_UsingDefaultTrustStore">
<summary>
Looks up a localized string similar to X.509 certificate chain validation will use the default trust store selected by .NET..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.ChainBuilding_UsingFallbackCertificateBundle">
<summary>
Looks up a localized string similar to X.509 certificate chain validation will use the fallback certificate bundle at '{0}'..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.ChainBuilding_UsingNoCertificateBundle">
<summary>
Looks up a localized string similar to X.509 certificate chain validation will not have any trusted roots. Chain building will fail with an untrusted status..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.ChainBuilding_UsingSystemCertificateBundle">
<summary>
Looks up a localized string similar to X.509 certificate chain validation will use the system certificate bundle at '{0}'..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.CommitmentTypeIndicationAttributeInvalid">
<summary>
Looks up a localized string similar to The commitment-type-indication attribute is invalid..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.CommitmentTypeIndicationAttributeInvalidCombination">
<summary>
Looks up a localized string similar to The commitment-type-indication attribute contains an invalid combination of values..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.ConflictingAllowUntrustedRoot">
<summary>
Looks up a localized string similar to There are two certificates with conflicting allowUntrustedRoot attributes in the computed settings. The allowUntrustedRoot attribute is going to be set to false. Certificate: {0}-{1}.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.DefaultError_EmptyAllowList">
<summary>
Looks up a localized string similar to A list of trusted signers is required but none was found..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.DefaultError_NoMatchInAllowList">
<summary>
Looks up a localized string similar to The package signature certificate fingerprint does not match any certificate fingerprint in the allow list..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.Error_InvalidTargetFramework">
<summary>
Looks up a localized string similar to Unsupported targetFramework value '{0}'..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.Error_LoadingHashFile">
<summary>
Looks up a localized string similar to Error parsing nupkg metadata file {0} : {1}.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.Error_MissingNuspecFile">
<summary>
Looks up a localized string similar to The package is missing the required nuspec file. .
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.Error_NoClientAllowList">
<summary>
Looks up a localized string similar to signatureValidationMode is set to require, so packages are allowed only if signed by trusted signers; however, no trusted signers were specified..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.Error_NoMatchingClientCertificate">
<summary>
Looks up a localized string similar to This package is signed but not by a trusted signer..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.Error_NoMatchingRepositoryCertificate">
<summary>
Looks up a localized string similar to This package was not repository signed with a certificate listed by this repository..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.Error_NoRepoAllowList">
<summary>
Looks up a localized string similar to This repository indicated that all its packages are repository signed; however, it listed no signing certificates..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.Error_NotOnePrimarySignature">
<summary>
Looks up a localized string similar to The package signature file does not contain exactly one primary signature..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.Error_NotOneRepositoryCounterSignature">
<summary>
Looks up a localized string similar to The package signature contains multiple repository countersignatures..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.Error_RepositorySettings_UnsignedPackage">
<summary>
Looks up a localized string similar to This repository indicated that all its packages are repository signed; however, this package is unsigned..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.Error_RepositorySignatureMustNotHaveARepositoryCountersignature">
<summary>
Looks up a localized string similar to A repository primary signature must not have a repository countersignature..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.Error_RequireMode_UnsignedPackage">
<summary>
Looks up a localized string similar to signatureValidationMode is set to require, so packages are allowed only if signed by trusted signers; however, this package is unsigned..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.ErrorAuthorTargetCannotBeACountersignature">
<summary>
Looks up a localized string similar to Cannot target author signatures that are countersignatures..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.ErrorByteSignatureNotFound">
<summary>
Looks up a localized string similar to Byte signature not found in package archive: 0x{0}.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.ErrorDuplicatePackages">
<summary>
Looks up a localized string similar to There are duplicate packages: {0}.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.ErrorInvalidAllowedVersions">
<summary>
Looks up a localized string similar to Invalid allowedVersions for package id '{0}': '{1}'.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.ErrorInvalidCertificateChainUnspecifiedReason">
<summary>
Looks up a localized string similar to Certificate chain validation failed for an unspecified reason..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.ErrorInvalidMinClientVersion">
<summary>
Looks up a localized string similar to Invalid minClientVersion: '{0}'.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.ErrorInvalidPackageArchive">
<summary>
Looks up a localized string similar to Invalid package archive..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.ErrorInvalidPackageVersion">
<summary>
Looks up a localized string similar to Invalid package version for package id '{0}': '{1}'.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.ErrorInvalidPackageVersionForDependency">
<summary>
Looks up a localized string similar to Invalid package version for a dependency with id '{0}' in package '{1}': '{2}'.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.ErrorManifestFileNotFound">
<summary>
Looks up a localized string similar to Manifest file not found at '{0}'.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.ErrorMultipleTimestamps">
<summary>
Looks up a localized string similar to Multiple timestamps are not accepted..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.ErrorNoTimestamp">
<summary>
Looks up a localized string similar to The signature should be timestamped to enable long-term signature validity after the certificate has expired..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.ErrorNullOrEmptyPackageId">
<summary>
Looks up a localized string similar to Null or empty package id.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.ErrorPackageNotSigned">
<summary>
Looks up a localized string similar to The package is not signed..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.ErrorPackageSignatureInvalid">
<summary>
Looks up a localized string similar to The package signature is invalid or cannot be verified on this platform..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.ErrorUnableCheckPackageEntries">
<summary>
Looks up a localized string similar to An unexpected error occurred while checking package entries..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.ErrorUnableToDeleteFile">
<summary>
Looks up a localized string similar to Unable to delete temporary file '{0}'. Error: '{1}'..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.ErrorUnsafePackageEntry">
<summary>
Looks up a localized string similar to The package '{0}' contains an entry '{1}' which is unsafe for extraction..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.ErrorZip64NotSupported">
<summary>
Looks up a localized string similar to Signed Zip64 packages are not supported..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.ExactlyOneAttributeRequired">
<summary>
Looks up a localized string similar to Exactly one {0} attribute is required..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.ExactlyOneAttributeValueRequired">
<summary>
Looks up a localized string similar to The {0} attribute must have exactly one attribute value..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.ExtractionLog_InformationPrefix">
<summary>
Looks up a localized string similar to Package '{0} {1}' from source '{2}': {3}.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.FailedFileTime">
<summary>
Looks up a localized string similar to Failed to update file time for {0}: {1}.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.FailToLoadPackagesConfig">
<summary>
Looks up a localized string similar to Fail to load packages.config as XML file. Please check it. .
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.FailToWritePackagesConfig">
<summary>
Looks up a localized string similar to Failed to write packages.config as XML file '{0}'. Error: '{1}'..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.FallbackFolderNotFound">
<summary>
Looks up a localized string similar to Unable to find fallback package folder '{0}'..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.HttpOrHttpsIsRequired">
<summary>
Looks up a localized string similar to HTTP or HTTPS is required..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.InvalidArgument">
<summary>
Looks up a localized string similar to The argument is invalid..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.InvalidArgumentCombination">
<summary>
Looks up a localized string similar to Invalid combination of arguments {0} and {1}..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.InvalidAsn1">
<summary>
Looks up a localized string similar to The ASN.1 data is invalid..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.InvalidLicenseExppressionVersion_VersionTooHigh">
<summary>
Looks up a localized string similar to The version string '{0}' is not supported by this toolset. The highest supported version is '{1}'. Either use a lower version or upgrade your toolset..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.InvalidNuspecElement">
<summary>
Looks up a localized string similar to {0} This validation error occurred in a '{1}' element..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.InvalidNuspecEntry">
<summary>
Looks up a localized string similar to The nuspec contains an invalid entry '{0}' in package '{1}' ..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.InvalidPackageFrameworkFolderName">
<summary>
Looks up a localized string similar to The framework in the folder name of '{0}' in package '{1}' could not be parsed..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.InvalidPackageNupkg">
<summary>
Looks up a localized string similar to The file is not a valid nupkg. File path: {0}.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.InvalidPackageSignatureFile">
<summary>
Looks up a localized string similar to The package contains an invalid package signature file..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.InvalidPackageSignatureFileEntry">
<summary>
Looks up a localized string similar to The package signature file entry is invalid. {0}.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.InvalidPackageSignatureFileEntryCentralDirectoryHeader">
<summary>
Looks up a localized string similar to The central directory header field '{0}' has an invalid value ({1})..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.InvalidPackageSignatureFileEntryLocalFileHeader">
<summary>
Looks up a localized string similar to The local file header field '{0}' has an invalid value ({1})..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.InvalidPackageTypeVersion">
<summary>
Looks up a localized string similar to Nuspec file contains a package type with an invalid package version '{0}'..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.InvalidPrimarySignature">
<summary>
Looks up a localized string similar to The primary signature is invalid..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.InvalidRepositoryCountersignature">
<summary>
Looks up a localized string similar to The repository countersignature is invalid..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.InvalidSignatureContent">
<summary>
Looks up a localized string similar to The package signature content is invalid..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.InvalidTimestampSignature">
<summary>
Looks up a localized string similar to The timestamp signature is invalid..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.InvalidUrl">
<summary>
Looks up a localized string similar to The URL value is invalid..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.Log_InstalledPackage">
<summary>
Looks up a localized string similar to Installed {0} {1} from {2} with content hash {3}..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.Message_Path">
<summary>
Looks up a localized string similar to Path: {0}.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.MinClientVersionAlreadyExist">
<summary>
Looks up a localized string similar to MinClientVersion already exists in packages.config.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.MissingMetadataNode">
<summary>
Looks up a localized string similar to Nuspec file does not contain the '{0}' node..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.MissingPackageTypeName">
<summary>
Looks up a localized string similar to Nuspec file contains a package type that is missing the name attribute..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.MissingTargetPlatformVersionsFromDependencyGroups">
<summary>
Looks up a localized string similar to Some dependency group TFMs are missing a platform version: {0}.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.MissingTargetPlatformVersionsFromFrameworkAssemblyGroups">
<summary>
Looks up a localized string similar to Some reference assembly group TFMs are missing a platform version: {0}.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.MissingTargetPlatformVersionsFromFrameworkAssemblyReferences">
<summary>
Looks up a localized string similar to Some framework assembly reference TFMs are missing a platform version: {0}.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.MissingTargetPlatformVersionsFromIncludedFiles">
<summary>
Looks up a localized string similar to Some included files are included under TFMs which are missing a platform version: {0}.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.MissingTargetPlatformVersionsFromReferenceGroups">
<summary>
Looks up a localized string similar to Some reference group TFMs are missing a platform version: {0}.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.MultipleAttributesDisallowed">
<summary>
Looks up a localized string similar to Multiple {0} attributes are not allowed..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.MultipleNuspecFiles">
<summary>
Looks up a localized string similar to Package contains multiple nuspec files..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.MultiplePackageSignatureFiles">
<summary>
Looks up a localized string similar to The package contains multiple package signature files..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.MustContainAbsolutePath">
<summary>
Looks up a localized string similar to '{0}' must contain an absolute path '{1}'..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.NoPackageSignatureFile">
<summary>
Looks up a localized string similar to The package does not contain a valid package signature file..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.NoRepositoryCountersignature">
<summary>
Looks up a localized string similar to Verification settings require a repository countersignature, but the package does not have a repository countersignature..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.NuGetLicense_InvalidLicenseExpressionVersion">
<summary>
Looks up a localized string similar to The license version string '{0}' is invalid..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.NuGetLicense_InvalidLicenseType">
<summary>
Looks up a localized string similar to Unrecognized license type '{0}'.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.NuGetLicense_LicenseElementMissingValue">
<summary>
Looks up a localized string similar to The license element value is empty. This is likely due to an authoring error. .
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.NuGetLicense_LicenseExpressionVersionTooHigh">
<summary>
Looks up a localized string similar to The license version string '{0}' is higher than the one supported by this toolset '{1}'..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.NuGetLicense_MissingRequiredValue">
<summary>
Looks up a localized string similar to The element 'license' cannot be empty. .
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.NuGetLicenseExpression_DeprecatedIdentifier">
<summary>
Looks up a localized string similar to The identifier '{0}' is deprecated..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.NuGetLicenseExpression_ExceptionIdentifierIsLicense">
<summary>
Looks up a localized string similar to The identifier '{0}' is a license. It cannot be used as an exception..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.NuGetLicenseExpression_IllegalUnlicensedOperator">
<summary>
Looks up a localized string similar to The 'UNLICENSED' license identifier cannot be combined with the '+' operator..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.NuGetLicenseExpression_InvalidCharacters">
<summary>
Looks up a localized string similar to The license expression '{0}' contains invalid characters..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.NuGetLicenseExpression_InvalidExceptionIdentifier">
<summary>
Looks up a localized string similar to The identifier '{0}' is not a standard exception..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.NuGetLicenseExpression_InvalidExpression">
<summary>
Looks up a localized string similar to The license expression is invalid..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.NuGetLicenseExpression_InvalidToken">
<summary>
Looks up a localized string similar to Invalid element '{0}'..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.NuGetLicenseExpression_LicenseIdentifierIsException">
<summary>
Looks up a localized string similar to The identifier '{0}' is an exception. It cannot be used as a license..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.NuGetLicenseExpression_LicenseInvalidCharacters">
<summary>
Looks up a localized string similar to The license identifier '{0}' contains invalid characters..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.NuGetLicenseExpression_MismatchedParentheses">
<summary>
Looks up a localized string similar to Mismatched parentheses in the expression..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.NuGetLicenseExpression_NonStandardIdentifier">
<summary>
Looks up a localized string similar to The license identifier(s) '{0}' is(are) not recognized by the current toolset..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.NuGetLicenseExpression_UnexpectedIdentifier">
<summary>
Looks up a localized string similar to Unexpected license identifier '{0}'. The identifier is not allowed in this context..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.NuGetLicenseExpression_UnlicensedPackageWarning">
<summary>
Looks up a localized string similar to The owner has marked this package as 'UNLICENSED'. This means that there is no license that allows this package to be used outside of the copyright owner..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.NuGetPackageOwners">
<summary>
Looks up a localized string similar to Owners: {0}.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.NuGetPackageOwnersInvalid">
<summary>
Looks up a localized string similar to The nuget-package-owners attribute is invalid..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.NuGetPackageOwnersInvalidValue">
<summary>
Looks up a localized string similar to One or more package owner values are invalid..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.NuGetV3ServiceIndexUrl">
<summary>
Looks up a localized string similar to Service index: {0}.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.NuGetV3ServiceIndexUrlInvalid">
<summary>
Looks up a localized string similar to The nuget-v3-service-index-url attribute is invalid..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.NuGetV3ServiceIndexUrlInvalidValue">
<summary>
Looks up a localized string similar to The nuget-v3-service-index-url attribute value is invalid..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.PackageEntryAlreadyExist">
<summary>
Looks up a localized string similar to Package entry already exists in packages.config. Id: {0}.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.PackageEntryNotExist">
<summary>
Looks up a localized string similar to Package entry does not exists in packages.config. Id: {0}, Version: {1}.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.PackageMinVersionNotSatisfied">
<summary>
Looks up a localized string similar to The '{0}' package requires NuGet client version '{1}' or above, but the current NuGet version is '{2}'. To upgrade NuGet, please go to https://docs.nuget.org/consume/installing-nuget.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.PackageSignatureVerificationLog">
<summary>
Looks up a localized string similar to PackageSignatureVerificationLog: PackageIdentity: {0} Source: {1} PackageSignatureValidity: {2}.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.PackagesNodeNotExist">
<summary>
Looks up a localized string similar to Packages node does not exists in packages.config at {0}..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.PackageStreamShouldBeSeekable">
<summary>
Looks up a localized string similar to Package stream should be seekable.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.PrimarySignatureFriendlyName">
<summary>
Looks up a localized string similar to primary signature.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.PrimarySignatureHasNoTimestamp">
<summary>
Looks up a localized string similar to The primary signature does not have a timestamp..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.PropertyCannotBeNull">
<summary>
Looks up a localized string similar to '{0}' cannot be null..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.RangeOutOfBoundsForArray">
<summary>
Looks up a localized string similar to Arguments {0} and {1} were out of bounds for the array..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.RepositoryCountersignatureFriendlyName">
<summary>
Looks up a localized string similar to repository countersignature.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.RepositoryCountersignatureHasNoCertificate">
<summary>
Looks up a localized string similar to The repository countersignature does not have a signing certificate..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.RepositoryCountersignatureHasNoTimestamp">
<summary>
Looks up a localized string similar to The repository countersignature does not have a timestamp..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.RepositoryPrimarySignatureFriendlyName">
<summary>
Looks up a localized string similar to repository primary signature.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.SignatureContainsInvalidAttribute">
<summary>
Looks up a localized string similar to Package signature contains an invalid attribute: {0}.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.SignatureDebug_HashOidFound">
<summary>
Looks up a localized string similar to Signature hash OID found: {0}.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.SignatureFailureInvalidHashAlgorithmOid">
<summary>
Looks up a localized string similar to The package hash uses an unsupported hash algorithm..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.SignatureFriendlyName">
<summary>
Looks up a localized string similar to signature.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.SignatureHashAlgorithm">
<summary>
Looks up a localized string similar to Signature Hash Algorithm: {0}.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.SignaturePackageIntegrityFailure">
<summary>
Looks up a localized string similar to The package integrity check failed. The package has changed since it was signed. Try clearing the local http-cache and run nuget operation again..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.SignatureType">
<summary>
Looks up a localized string similar to Signature type: {0}.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.SignedPackageAlreadySigned">
<summary>
Looks up a localized string similar to The package already contains a signature. Please remove the existing signature before adding a new signature..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.SignedPackageArchiveIOExtraRead">
<summary>
Looks up a localized string similar to Package stream read position cannot be longer than the length of the stream..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.SignedPackageArchiveIOInvalidRead">
<summary>
Looks up a localized string similar to Package stream read position cannot be before the current position in the stream..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.SignedPackageNotSignedOnRemove">
<summary>
Looks up a localized string similar to The package is not signed. Unable to remove signature from an unsigned package..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.SignedPackageNotSignedOnVerify">
<summary>
Looks up a localized string similar to The package is not signed. Unable to verify signature from an unsigned package..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.SignedPackagePackageAlreadyCountersigned">
<summary>
Looks up a localized string similar to The package already contains a repository countersignature. Please remove the existing signature before adding a new repository countersignature..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.SignedPackageUnableToAccessSignature">
<summary>
Looks up a localized string similar to The package was not opened correctly to perform signature operations. Please use a Stream-based constructor to have access to signature attributes of the package..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.SignError_TimestampCertificateFailsPublicKeyLengthRequirement">
<summary>
Looks up a localized string similar to The timestamp certificate does not meet a minimum public key length requirement..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.SignError_TimestampGeneralizedTimeInvalid">
<summary>
Looks up a localized string similar to The timestamp's generalized time is outside the timestamping certificate's validity period..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.SignError_TimestampIntegrityCheckFailed">
<summary>
Looks up a localized string similar to The timestamp integrity check failed..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.SignError_TimestampNoCertificate">
<summary>
Looks up a localized string similar to The timestamp does not have a signing certificate..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.SignError_TimestampNotYetValid">
<summary>
Looks up a localized string similar to The timestamp signing certificate is not yet valid..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.SignError_TimestampSignatureValidationFailed">
<summary>
Looks up a localized string similar to The timestamp signature validation failed..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.SignFailureCertificateInvalidProviderType">
<summary>
Looks up a localized string similar to The following certificate cannot be used for package signing as the private key provider is unsupported:.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.SigningCannotBeDoneInPlace">
<summary>
Looks up a localized string similar to {0} and {1} should be different. Package signing cannot be done in place..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.SigningCertificateAttributeMustNotBePresent">
<summary>
Looks up a localized string similar to The signing-certificate attribute is not allowed..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.SigningCertificateCertificateNotFound">
<summary>
Looks up a localized string similar to A certificate referenced by the signing-certificate attribute could not be found..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.SigningCertificateInvalid">
<summary>
Looks up a localized string similar to The signing-certificate attribute is invalid..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.SigningCertificateV1OrV2AttributeMustBePresent">
<summary>
Looks up a localized string similar to Either the signing-certificate or signing-certificate-v2 attribute must be present..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.SigningCertificateV2CertificateNotFound">
<summary>
Looks up a localized string similar to A certificate referenced by the signing-certificate-v2 attribute could not be found..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.SigningCertificateV2Invalid">
<summary>
Looks up a localized string similar to The signing-certificate-v2 attribute is invalid..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.SigningCertificateV2UnsupportedHashAlgorithm">
<summary>
Looks up a localized string similar to The signing-certificate-v2 attribute uses an unsupported hash algorithm..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.SigningError_CertificateFailsPublicKeyLengthRequirement">
<summary>
Looks up a localized string similar to The signing certificate does not meet a minimum public key length requirement..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.SigningError_CertificateHasLifetimeSigningEKU">
<summary>
Looks up a localized string similar to The lifetime signing EKU in the signing certificate is not supported..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.SigningError_CertificateHasUnsupportedSignatureAlgorithm">
<summary>
Looks up a localized string similar to The signing certificate has an unsupported signature algorithm..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.SigningError_NotYetValid">
<summary>
Looks up a localized string similar to The signing certificate is not yet valid..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.SigningWouldRequireZip64">
<summary>
Looks up a localized string similar to The package cannot be signed as it would require the Zip64 format..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.StreamMustBeReadable">
<summary>
Looks up a localized string similar to The stream must be readable..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.StreamMustBeSeekable">
<summary>
Looks up a localized string similar to The stream must be seekable..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.StringCannotBeNullOrEmpty">
<summary>
Looks up a localized string similar to String argument '{0}' cannot be null or empty.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.TimestampCertificateUnsupportedSignatureAlgorithm">
<summary>
Looks up a localized string similar to The timestamp certificate has an unsupported signature algorithm ({0}). The following algorithms are supported: {1}..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.TimestampFailureInvalidHttpScheme">
<summary>
Looks up a localized string similar to The timestamper URL '{0}' has an invalid URI scheme. The supported schemes are '{1}' and '{2}'..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.TimestampFailureNonceMismatch">
<summary>
Looks up a localized string similar to The timestamp response is invalid. Nonces did not match..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.TimestampServiceRespondedError">
<summary>
Looks up a localized string similar to The timestamp service responded with HTTP status code '{0}' ('{1}')..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.TimestampSignatureUnsupportedDigestAlgorithm">
<summary>
Looks up a localized string similar to The timestamp signature has an unsupported digest algorithm ({0}). The following algorithms are supported: {1}..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.TimestampValue">
<summary>
Looks up a localized string similar to Timestamp: {0}.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.UnableToAddEntry">
<summary>
Looks up a localized string similar to An error occurred while updating packages.config. The file was closed before the entry could be added..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.UnableToParseClientVersion">
<summary>
Looks up a localized string similar to Unable to parse the current NuGet client version..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.UnableToReadPackageHashInformation">
<summary>
Looks up a localized string similar to Package hash information could not be read from the package signature..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.UnexpectedPackageSignatureVerificationError">
<summary>
Looks up a localized string similar to An unexpected error occurred while verifying a package signature..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.UnrecognizedEnumValue">
<summary>
Looks up a localized string similar to The enum value '{0}' is unrecognized..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.UnrelatedSignatures">
<summary>
Looks up a localized string similar to The primary signature and repository countersignature are unrelated..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.UnsupportedAsn1">
<summary>
Looks up a localized string similar to The ASN.1 data is unsupported..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.UnsupportedSignatureFormatVersion">
<summary>
Looks up a localized string similar to The package signature format version is not supported. Updating your client may solve this problem..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.VerificationCertDisplay">
<summary>
Looks up a localized string similar to Verifying the {0} with certificate: {1}.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.VerificationTimestamperCertDisplay">
<summary>
Looks up a localized string similar to Verifying {0}'s timestamp with timestamping service certificate: {1}.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.Verify_ErrorNoCertificate">
<summary>
Looks up a localized string similar to The {0} does not have a signing certificate..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.VerifyCertTrustOfflineWhileRevocationModeOffline">
<summary>
Looks up a localized string similar to The revocation function was unable to check revocation because the certificate is not available in the cached certificate revocation list and NUGET_CERT_REVOCATION_MODE environment variable has been set to offline. For more information, visit https://aka.ms/certificateRevocationMode..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.VerifyCertTrustOfflineWhileRevocationModeOnline">
<summary>
Looks up a localized string similar to The revocation function was unable to check revocation because the revocation server could not be reached. For more information, visit https://aka.ms/certificateRevocationMode..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.VerifyChainBuildingIssue">
<summary>
Looks up a localized string similar to The {0} found a chain building issue: {1}.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.VerifyChainBuildingIssue_UntrustedRoot">
<summary>
Looks up a localized string similar to The {0}'s signing certificate is not trusted by the trust provider..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.VerifyError_CertificateFailsPublicKeyLengthRequirement">
<summary>
Looks up a localized string similar to The {0}'s certificate does not meet a minimum public key length requirement..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.VerifyError_CertificateHasLifetimeSigningEKU">
<summary>
Looks up a localized string similar to The lifetime signing EKU in the {0}'s certificate is not supported..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.VerifyError_CertificateHasUnsupportedSignatureAlgorithm">
<summary>
Looks up a localized string similar to The {0}'s certificate has an unsupported signature algorithm..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.VerifyError_CertificateNotYetValid">
<summary>
Looks up a localized string similar to The {0}'s certificate is not yet valid..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.VerifyError_InvalidCertificateChain">
<summary>
Looks up a localized string similar to The {0}'s certificate chain validation failed with error(s): {1}.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.VerifyError_SignatureNotTimeValid">
<summary>
Looks up a localized string similar to The {0} validity period has expired..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.VerifyError_SignatureVerificationFailed">
<summary>
Looks up a localized string similar to The {0} validation failed..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.VerifyError_TimestampCertificateFailsPublicKeyLengthRequirement">
<summary>
Looks up a localized string similar to The {0}'s timestamp certificate does not meet a minimum public key length requirement..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.VerifyError_TimestampGeneralizedTimeInvalid">
<summary>
Looks up a localized string similar to The {0}'s timestamp's generalized time is outside the timestamping certificate's validity period..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.VerifyError_TimestampIntegrityCheckFailed">
<summary>
Looks up a localized string similar to The {0}'s timestamp integrity check failed..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.VerifyError_TimestampInvalid">
<summary>
Looks up a localized string similar to The {0} contains an invalid timestamp..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.VerifyError_TimestampMessageImprintUnsupportedHashAlgorithm">
<summary>
Looks up a localized string similar to The {0} timestamp's message imprint uses an unsupported hash algorithm..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.VerifyError_TimestampNoCertificate">
<summary>
Looks up a localized string similar to The {0}'s timestamp does not have a signing certificate..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.VerifyError_TimestampNotYetValid">
<summary>
Looks up a localized string similar to The {0}'s timestamp signing certificate is not yet valid..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.VerifyError_TimestampSignatureUnsupportedDigestAlgorithm">
<summary>
Looks up a localized string similar to The {0}'s timestamp signature has an unsupported digest algorithm..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.VerifyError_TimestampSignatureValidationFailed">
<summary>
Looks up a localized string similar to The {0}'s timestamp signature validation failed..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.VerifyError_TimestampUnsupportedSignatureAlgorithm">
<summary>
Looks up a localized string similar to The {0}'s timestamp certificate has an unsupported signature algorithm..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.VerifyError_TimestampVerifyChainBuildingIssue">
<summary>
Looks up a localized string similar to The {0}'s timestamp found a chain building issue: {1}.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.VerifyTimestampChainBuildingIssue_UntrustedRoot">
<summary>
Looks up a localized string similar to The {0}'s timestamping certificate is not trusted by the trust provider..
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.ZipFileLastWriteTimeStampModifiedMessage">
<summary>
Looks up a localized string similar to '{0}' changed from '{1}' to '{2}'.
</summary>
</member>
<member name="P:NuGet.Packaging.Strings.ZipFileTimeStampModifiedWarning">
<summary>
Looks up a localized string similar to The zip format supports a limited date range. The following files are outside the supported range:.
</summary>
</member>
<member name="M:NuGet.Packaging.TopologicalSortUtility.SortPackagesByDependencyOrder``1(System.Collections.Generic.IEnumerable{``0},System.StringComparer,System.Func{``0,System.String},System.Func{``0,System.String[]})">
<summary>
Order dependencies by children first.
</summary>
<param name="items">Items to sort.</param>
<param name="comparer">Comparer for Ids.</param>
<param name="getId">Retrieve the id of the item.</param>
<param name="getDependencies">Retrieve dependency ids.</param>
<returns></returns>
</member>
<member name="M:NuGet.Packaging.TopologicalSortUtility.SortPackagesByDependencyOrder(System.Collections.Generic.IEnumerable{NuGet.Packaging.Core.PackageDependencyInfo})">
<summary>
Order dependencies by children first.
</summary>
</member>
<member name="M:NuGet.Packaging.TopologicalSortUtility.SortPackagesByDependencyOrder(System.Collections.Generic.List{NuGet.Packaging.TopologicalSortUtility.ItemDependencyInfo},System.StringComparer)">
<summary>
Order dependencies by children first.
</summary>
</member>
<member name="T:NuGet.Packaging.VersionFolderPathResolver">
<summary>
A V3 path resolver.
</summary>
</member>
<member name="P:NuGet.Packaging.VersionFolderPathResolver.RootPath">
<summary>
Gets the packages directory root folder.
</summary>
</member>
<member name="P:NuGet.Packaging.VersionFolderPathResolver.IsLowerCase">
<summary>
Gets a flag indicating whether or not package ID's and versions are made lowercase.
</summary>
</member>
<member name="M:NuGet.Packaging.VersionFolderPathResolver.#ctor(System.String)">
<summary>
Initializes a new <see cref="T:NuGet.Packaging.VersionFolderPathResolver" /> class.
</summary>
<param name="rootPath">The packages directory root folder.</param>
</member>
<member name="M:NuGet.Packaging.VersionFolderPathResolver.#ctor(System.String,System.Boolean)">
<summary>
Initializes a new <see cref="T:NuGet.Packaging.VersionFolderPathResolver" /> class.
</summary>
<param name="rootPath">The packages directory root folder.</param>
<param name="isLowercase"><c>true</c> if package ID's and versions are made lowercase;
otherwise <c>false</c>.</param>
</member>
<member name="M:NuGet.Packaging.VersionFolderPathResolver.GetInstallPath(System.String,NuGet.Versioning.NuGetVersion)">
<summary>
Gets the package install path.
</summary>
<param name="packageId">The package ID.</param>
<param name="version">The package version.</param>
<returns>The package install path.</returns>
</member>
<member name="M:NuGet.Packaging.VersionFolderPathResolver.GetVersionListPath(System.String)">
<summary>
Gets the package version list path.
</summary>
<param name="packageId">The package ID.</param>
<returns>The package version list path.</returns>
</member>
<member name="M:NuGet.Packaging.VersionFolderPathResolver.GetPackageFilePath(System.String,NuGet.Versioning.NuGetVersion)">
<summary>
Gets the package file path.
</summary>
<param name="packageId">The package ID.</param>
<param name="version">The package version.</param>
<returns>The package file path.</returns>
</member>
<member name="M:NuGet.Packaging.VersionFolderPathResolver.GetManifestFilePath(System.String,NuGet.Versioning.NuGetVersion)">
<summary>
Gets the manifest file path.
</summary>
<param name="packageId">The package ID.</param>
<param name="version">The package version.</param>
<returns>The manifest file path.</returns>
</member>
<member name="M:NuGet.Packaging.VersionFolderPathResolver.GetHashPath(System.String,NuGet.Versioning.NuGetVersion)">
<summary>
Gets the hash file path.
</summary>
<param name="packageId">The package ID.</param>
<param name="version">The package version.</param>
<returns>The hash file path.</returns>
</member>
<member name="M:NuGet.Packaging.VersionFolderPathResolver.GetHashFileName(System.String,NuGet.Versioning.NuGetVersion)">
<summary>
Gets the hash file name.
</summary>
<param name="packageId">The package ID.</param>
<param name="version">The package version.</param>
<returns>The hash file name.</returns>
</member>
<member name="M:NuGet.Packaging.VersionFolderPathResolver.GetNupkgMetadataPath(System.String,NuGet.Versioning.NuGetVersion)">
<summary>
Gets the new hash file path which represents the original hash of the package.
</summary>
<param name="packageId">The package ID.</param>
<param name="version">The package version.</param>
<returns>The hash file path.</returns>
</member>
<member name="M:NuGet.Packaging.VersionFolderPathResolver.GetVersionListDirectory(System.String)">
<summary>
Gets the version list directory.
</summary>
<param name="packageId">The package ID.</param>
<returns>The version list directory.</returns>
</member>
<member name="M:NuGet.Packaging.VersionFolderPathResolver.GetPackageDirectory(System.String,NuGet.Versioning.NuGetVersion)">
<summary>
Gets the package directory.
</summary>
<param name="packageId">The package ID.</param>
<param name="version">The package version.</param>
<returns>The package directory.</returns>
</member>
<member name="M:NuGet.Packaging.VersionFolderPathResolver.GetPackageFileName(System.String,NuGet.Versioning.NuGetVersion)">
<summary>
Gets the package file name.
</summary>
<param name="packageId">The package ID.</param>
<param name="version">The package version.</param>
<returns>The package file name.</returns>
</member>
<member name="M:NuGet.Packaging.VersionFolderPathResolver.GetPackageDownloadMarkerFileName(System.String)">
<summary>
Gets the package download marker file name.
</summary>
<param name="packageId">The package ID.</param>
<returns>The package download marker file name.</returns>
</member>
<member name="M:NuGet.Packaging.VersionFolderPathResolver.GetManifestFileName(System.String,NuGet.Versioning.NuGetVersion)">
<summary>
Gets the manifest file name.
</summary>
<param name="packageId">The package ID.</param>
<param name="version">The package version.</param>
<returns>The manifest file name.</returns>
</member>
<member name="T:NuGet.RuntimeModel.IObjectWriter">
<summary>
Provides functionality for writing an object graph.
The output format is defined by implementors.
</summary>
</member>
<member name="M:NuGet.RuntimeModel.IObjectWriter.WriteObjectStart">
<summary>
Writes the start of the root object or an object in an array.
This new object becomes the scope for all other method calls until either WriteObjectStart
is called again to start a new nested object or WriteObjectEnd is called.
Every call to WriteObjectStart must be balanced by a corresponding call to WriteObjectEnd.
</summary>
<exception cref="T:System.ObjectDisposedException">Thrown if this object is disposed.</exception>
</member>
<member name="M:NuGet.RuntimeModel.IObjectWriter.WriteObjectStart(System.String)">
<summary>
Writes the start of a nested object.
This new object becomes the scope for all other method calls until either WriteObjectStart
is called again to start a new nested object or WriteObjectEnd is called.
Every call to WriteObjectStart must be balanced by a corresponding call to WriteObjectEnd.
</summary>
<param name="name">The name of the object.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="name" /> is <c>null</c>.</exception>
<exception cref="T:System.ObjectDisposedException">Thrown if this object is disposed.</exception>
</member>
<member name="M:NuGet.RuntimeModel.IObjectWriter.WriteObjectEnd">
<summary>
Writes the end of a nested object.
The parent object for this object becomes the scope for subsequent method calls.
If this object is the root object, no further writing is allowed.
Every call to WriteObjectStart must be balanced by a corresponding call to WriteObjectEnd.
</summary>
<exception cref="T:System.ObjectDisposedException">Thrown if this object is disposed.</exception>
</member>
<member name="M:NuGet.RuntimeModel.IObjectWriter.WriteNameValue(System.String,System.Int32)">
<summary>
Writes a name-value pair.
</summary>
<param name="name">The name of the datum.</param>
<param name="value">The datum.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="name" /> is <c>null</c>.</exception>
<exception cref="T:System.ObjectDisposedException">Thrown if this object is disposed.</exception>
</member>
<member name="M:NuGet.RuntimeModel.IObjectWriter.WriteNameValue(System.String,System.Boolean)">
<summary>
Writes a name-value pair.
</summary>
<param name="name">The name of the datum.</param>
<param name="value">The datum.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="name" /> is <c>null</c>.</exception>
<exception cref="T:System.ObjectDisposedException">Thrown if this object is disposed.</exception>
</member>
<member name="M:NuGet.RuntimeModel.IObjectWriter.WriteNameValue(System.String,System.String)">
<summary>
Writes a name-value pair.
</summary>
<param name="name">The name of the datum.</param>
<param name="value">The datum.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="name" /> is <c>null</c>.</exception>
<exception cref="T:System.ObjectDisposedException">Thrown if this object is disposed.</exception>
</member>
<member name="M:NuGet.RuntimeModel.IObjectWriter.WriteNameArray(System.String,System.Collections.Generic.IEnumerable{System.String})">
<summary>
Writes a name-collection pair.
</summary>
<param name="name">The name of the data.</param>
<param name="values">The data.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="name" /> is <c>null</c>.</exception>
<exception cref="T:System.ObjectDisposedException">Thrown if this object is disposed.</exception>
</member>
<member name="M:NuGet.RuntimeModel.IObjectWriter.WriteArrayStart(System.String)">
<summary>
Writes the start of an array.
The new object becomes the scope of all other methods until WriteArrayStart is called to start a new object in the array, or WriteArrayEnd is called.
Every call to WriteArrayStart needs to be balanced with a corresponding call to WriteArrayEnd and not WriteObjectEnd.
</summary>
<param name="name">The array name</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="name" /> is <c>null</c>.</exception>
<exception cref="T:System.ObjectDisposedException">Thrown if this object is disposed.</exception>
</member>
<member name="M:NuGet.RuntimeModel.IObjectWriter.WriteArrayEnd">
<summary>
Writes the end of an array.
The parent object for this array becomes the scope for subsequent method calls.
If this object is the root object, no further writing is allowed.
Every call to WriteArrayStart needs to be balanced with a corresponding call to WriteArrayEnd and not WriteObjectEnd.
</summary>
<exception cref="T:System.ObjectDisposedException">Thrown if this object is disposed.</exception>
</member>
<member name="T:NuGet.RuntimeModel.JsonObjectWriter">
<summary>
Generates JSON from an object graph.
This is non-private only to facilitate unit testing.
</summary>
</member>
<member name="P:NuGet.RuntimeModel.RuntimeDependencySet.Id">
<summary>
Package Id
</summary>
</member>
<member name="P:NuGet.RuntimeModel.RuntimeDependencySet.Dependencies">
<summary>
Package dependencies
</summary>
</member>
<member name="P:NuGet.RuntimeModel.RuntimeDescription.RuntimeDependencySets">
<summary>
RID specific package dependencies.
</summary>
</member>
<member name="M:NuGet.RuntimeModel.RuntimeDescription.Merge(NuGet.RuntimeModel.RuntimeDescription,NuGet.RuntimeModel.RuntimeDescription)">
<summary>
Merges the content of the other runtime description in to this runtime description
</summary>
<param name="other">The other description to merge in to this description</param>
</member>
<member name="M:NuGet.RuntimeModel.RuntimeGraph.Merge(NuGet.RuntimeModel.RuntimeGraph,NuGet.RuntimeModel.RuntimeGraph)">
<summary>
Merges the content of the other runtime graph in to this runtime graph
</summary>
<param name="other">The other graph to merge in to this graph</param>
</member>
<member name="M:NuGet.RuntimeModel.RuntimeGraph.ExpandRuntime(System.String)">
<summary>
Find all compatible RIDs including the current RID.
</summary>
</member>
<member name="M:NuGet.RuntimeModel.RuntimeGraph.ExpandRuntimeInternal(System.String)">
<summary>
Expand runtimes in a BFS walk. This ensures that nearest RIDs are returned first.
Ordering is important for finding the nearest runtime dependency.
</summary>
</member>
<member name="M:NuGet.RuntimeModel.RuntimeGraph.AreCompatible(System.String,System.String)">
<summary>
Determines if two runtime identifiers are compatible, based on the import graph
</summary>
<param name="criteria">The criteria being tested</param>
<param name="provided">The value the criteria is being tested against</param>
<returns>
true if an asset for the runtime in <paramref name="provided" /> can be installed in a project
targetting <paramref name="criteria" />, false otherwise
</returns>
</member>
<member name="M:NuGet.RuntimeModel.RuntimeGraph.FindRuntimeDependenciesInternal(NuGet.RuntimeModel.RuntimeGraph.RuntimeDependencyKey)">
<summary>
Find all possible dependencies for package id.
</summary>
</member>
<member name="T:NuGet.RuntimeModel.RuntimeGraph.Cache`1">
<summary>
Helper for renting hashsets and lists.
</summary>
</member>
<member name="T:NuGet.RuntimeModel.RuntimeGraph.RuntimeDependencyKey">
<summary>
RID + package id
</summary>
</member>
<member name="T:NuGet.RuntimeModel.RuntimeGraph.RuntimeCompatKey">
<summary>
RID -> RID compatibility key
</summary>
</member>
<member name="T:NuGet.RuntimeModel.RuntimePackageDependency">
<summary>
A package dependency for a specific RID.
</summary>
</member>
<member name="P:NuGet.RuntimeModel.RuntimePackageDependency.Id">
<summary>
Dependency package id.
</summary>
</member>
<member name="P:NuGet.RuntimeModel.RuntimePackageDependency.VersionRange">
<summary>
Dependency version constraint.
</summary>
</member>
<member name="M:NuGet.Shared.EqualityUtility.OrderedEquals``2(System.Collections.Generic.IEnumerable{``0},System.Collections.Generic.IEnumerable{``0},System.Func{``0,``1},System.Collections.Generic.IComparer{``1},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Compares two enumerables for equality, ordered according to the specified key and optional comparer. Handles null values gracefully.
</summary>
<typeparam name="TSource">The type of the list</typeparam>
<typeparam name="TKey">The type of the sorting key</typeparam>
<param name="self">This list</param>
<param name="other">The other list</param>
<param name="keySelector">The function to extract the key from each item in the list</param>
<param name="orderComparer">An optional comparer for comparing keys</param>
<param name="sequenceComparer">An optional comparer for sequences</param>
</member>
<member name="M:NuGet.Shared.EqualityUtility.OrderedEquals``2(System.Collections.Generic.ICollection{``0},System.Collections.Generic.ICollection{``0},System.Func{``0,``1},System.Collections.Generic.IComparer{``1},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Compares two collections for equality, ordered according to the specified key and optional comparer. Handles null values gracefully.
</summary>
<typeparam name="TSource">The type of the list</typeparam>
<typeparam name="TKey">The type of the sorting key</typeparam>
<param name="self">This list</param>
<param name="other">The other list</param>
<param name="keySelector">The function to extract the key from each item in the list</param>
<param name="orderComparer">An optional comparer for comparing keys</param>
<param name="sequenceComparer">An optional comparer for sequences</param>
</member>
<member name="M:NuGet.Shared.EqualityUtility.OrderedEquals``2(System.Collections.Generic.IList{``0},System.Collections.Generic.IList{``0},System.Func{``0,``1},System.Collections.Generic.IComparer{``1},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Compares two lists for equality, ordered according to the specified key and optional comparer. Handles null values gracefully.
</summary>
<typeparam name="TSource">The type of the list</typeparam>
<typeparam name="TKey">The type of the sorting key</typeparam>
<param name="self">This list</param>
<param name="other">The other list</param>
<param name="keySelector">The function to extract the key from each item in the list</param>
<param name="orderComparer">An optional comparer for comparing keys</param>
<param name="sequenceComparer">An optional comparer for sequences</param>
</member>
<member name="M:NuGet.Shared.EqualityUtility.SequenceEqualWithNullCheck``1(System.Collections.Generic.IEnumerable{``0},System.Collections.Generic.IEnumerable{``0},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Compares two sequence for equality, allowing either sequence to be null. If one is null, both have to be
null for equality.
</summary>
</member>
<member name="M:NuGet.Shared.EqualityUtility.SequenceEqualWithNullCheck``1(System.Collections.Generic.ICollection{``0},System.Collections.Generic.ICollection{``0},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Compares two collections for equality, allowing either collection to be null. If one is null, both have to be
null for equality.
</summary>
</member>
<member name="M:NuGet.Shared.EqualityUtility.SequenceEqualWithNullCheck``1(System.Collections.Generic.IList{``0},System.Collections.Generic.IList{``0},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Compares two lists for equality, allowing either list to be null. If one is null, both have to be
null for equality.
</summary>
</member>
<member name="M:NuGet.Shared.EqualityUtility.SetEqualsWithNullCheck``1(System.Collections.Generic.ISet{``0},System.Collections.Generic.ISet{``0},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Compares two sets for equality, allowing either sequence to be null.
If one is null, both have to be null for equality.
</summary>
</member>
<member name="M:NuGet.Shared.EqualityUtility.EqualsFalse(System.String)">
<summary>
Determines if the current string contains a value equal "false". Leading and trailing whitespace are trimmed and the comparision is case-insensitive
</summary>
<param name="value">The string to compare.</param>
<returns><c>true</c> if the current string is equal to a value of "false", otherwise <c>false></c>.</returns>
</member>
<member name="T:NuGet.Shared.HashCodeCombiner">
<summary>
Hash code creator, based on the original NuGet hash code combiner/ASP hash code combiner implementations
</summary>
</member>
<member name="M:NuGet.Shared.HashCodeCombiner.GetHashCode``2(``0,``1)">
<summary>
Create a unique hash code for the given set of items
</summary>
</member>
<member name="M:NuGet.Shared.HashCodeCombiner.GetHashCode``3(``0,``1,``2)">
<summary>
Create a unique hash code for the given set of items
</summary>
</member>
<member name="M:NuGet.Shared.Extensions.AsList``1(System.Collections.Generic.IEnumerable{``0})">
<summary>
Return the enumerable as a List of T, copying if required. Optimized for common case where it is an List of T.
Avoid mutating the return value.
</summary>
<remarks>https://aspnetwebstack.codeplex.com/SourceControl/latest#src/Common/CollectionExtensions.cs</remarks>
</member>
<member name="M:NuGet.Shared.Extensions.AsHashSet``1(System.Collections.Generic.ISet{``0},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Return the ISet as a HashSet of T, copying if required. Optimized for common case where it is a HashSet of T.
Avoid mutating the return value.
</summary>
</member>
<member name="M:NuGet.Shared.XmlUtility.Load(System.String)">
<summary>
Creates a new <see cref="T:System.Xml.Linq.XDocument" /> from a file.
</summary>
<param name="path">The complete file path to be read into a new <see cref="T:System.Xml.Linq.XDocument" />.</param>
<returns>An <see cref="T:System.Xml.Linq.XDocument" /> that contains the contents of the specified file.</returns>
</member>
<member name="M:NuGet.Shared.XmlUtility.Load(System.String,System.Xml.Linq.LoadOptions)">
<summary>
Creates a new <see cref="T:System.Xml.Linq.XDocument" /> from a file. Optionally, whitespace can be preserved.
</summary>
<param name="path">The complete file path to be read into a new <see cref="T:System.Xml.Linq.XDocument" />.</param>
<param name="options">A set of <see cref="T:System.Xml.Linq.LoadOptions" />.</param>
<returns>An <see cref="T:System.Xml.Linq.XDocument" /> that contains the contents of the specified file.</returns>
</member>
<member name="M:NuGet.Shared.XmlUtility.Load(System.IO.Stream)">
<summary>
Creates a new <see cref="T:System.Xml.Linq.XDocument" /> from a stream.
</summary>
<param name="input">The stream that contains the XML data.</param>
<returns>An <see cref="T:System.Xml.Linq.XDocument" /> that contains the contents of the specified stream.</returns>
</member>
<member name="M:NuGet.Shared.XmlUtility.Load(System.IO.Stream,System.Xml.Linq.LoadOptions)">
<summary>
Creates a new System.Xml.Linq.XDocument from a stream. Optionally, whitespace can be preserved.
</summary>
<param name="input">The stream that contains the XML data.</param>
<param name="options">A set of <see cref="T:System.Xml.Linq.LoadOptions" />.</param>
<returns>An <see cref="T:System.Xml.Linq.XDocument" /> that contains the contents of the specified stream.</returns>
</member>
<member name="M:NuGet.Shared.XmlUtility.GetEncodedXMLName(System.String)">
<summary>
Converts the name to a valid XML local name, if it is invalid.
</summary>
<param name="name">The name to be encoded.</param>
<returns>The encoded name.</returns>
</member>
<member name="M:NuGet.Shared.XmlUtility.GetXmlReaderSettings(System.Xml.Linq.LoadOptions)">
<summary>
Creates an instance of <see cref="T:System.Xml.XmlReaderSettings" /> with safe settings
<param name="options">A set of <see cref="T:System.Xml.Linq.LoadOptions" />.</param>
</summary>
</member>
<member name="T:NuGet.StringBuilderPool">
<summary>
Provides a resource pool that enables reusing instances of <see cref="T:System.Text.StringBuilder" /> instances.
</summary>
<remarks>
<para>
Renting and returning buffers with an <see cref="T:NuGet.StringBuilderPool" /> can increase performance
in situations where <see cref="T:System.Text.StringBuilder" /> instances are created and destroyed frequently,
resulting in significant memory pressure on the garbage collector.
</para>
<para>
This class is thread-safe. All members may be used by multiple threads concurrently.
</para>
</remarks>
</member>
<member name="F:NuGet.StringBuilderPool.Shared">
<summary>
Retrieves a shared <see cref="T:NuGet.StringBuilderPool" /> instance.
</summary>
</member>
<member name="M:NuGet.StringBuilderPool.Rent(System.Int32)">
<summary>
Retrieves a <see cref="T:System.Text.StringBuilder" /> that is at least the requested length.
</summary>
<param name="minimumCapacity">The minimum capacity of the <see cref="T:System.Text.StringBuilder" /> needed.</param>
<returns>
A <see cref="T:System.Text.StringBuilder" /> that is at least <paramref name="minimumCapacity" /> in length.
</returns>
<remarks>
This buffer is loaned to the caller and should be returned to the same pool via
<see cref="M:NuGet.StringBuilderPool.Return(System.Text.StringBuilder)" /> so that it may be reused in subsequent usage of <see cref="M:NuGet.StringBuilderPool.Rent(System.Int32)" />.
It is not a fatal error to not return a rented string builder, but failure to do so may lead to
decreased application performance, as the pool may need to create a new instance to replace
the one lost.
</remarks>
</member>
<member name="M:NuGet.StringBuilderPool.Return(System.Text.StringBuilder)">
<summary>
Returns to the pool an array that was previously obtained via <see cref="M:NuGet.StringBuilderPool.Rent(System.Int32)" /> on the same
<see cref="T:NuGet.StringBuilderPool" /> instance.
</summary>
<param name="builder">
The <see cref="T:System.Text.StringBuilder" /> previously obtained from <see cref="M:NuGet.StringBuilderPool.Rent(System.Int32)" /> to return to the pool.
</param>
<remarks>
Once a <see cref="T:System.Text.StringBuilder" /> has been returned to the pool, the caller gives up all ownership
of the instance and must not use it. The reference returned from a given call to <see cref="M:NuGet.StringBuilderPool.Rent(System.Int32)" />
must only be returned via <see cref="M:NuGet.StringBuilderPool.Return(System.Text.StringBuilder)" /> once. The default <see cref="T:NuGet.StringBuilderPool" />
may hold onto the returned instance in order to rent it again, or it may release the returned instance
if it's determined that the pool already has enough instances stored.
</remarks>
</member>
</members>
<Signature xmlns="http://www.w3.org/2000/09/xmldsig#"><SignedInfo><CanonicalizationMethod Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315" /><SignatureMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#rsa-sha256" /><Reference URI=""><Transforms><Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature" /><Transform Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315" /></Transforms><DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256" /><DigestValue>TeB+Ew02eG13D/vTGPp0owo2hDKXdvlSHN/XIKzlYC8=</DigestValue></Reference></SignedInfo><SignatureValue>ZEQqLIj0zitR8DKtgns68KEq73OESB+QtVmWKVo+51Nj2yF9dDw3L4aJwPnnqejW66gR0e9//3NkPoLIvY93lqRqkWDHNx84GsmNYwVOHQ4yl4domXrEm6WG5hzCl+w2qKXi0eIlLWT5tR9SqTEnuU0fJx7uCSZQOdSMmRMAbfo3OPYVOOfhD6djSiymV4AdYHVSN1JNoZs5B4CpqRB7NBfU6b8Rf607Vsq5X4dt8fDdWEav2olW5viwM3QoWCPy0kF2EjTiW1n7xT7RQfqXNHu9D770oolVRPzX4alb4sXnd241p0yH0GWVPWxuHF0m9V9hFhkXjo4CDJXa97XoVA==</SignatureValue><KeyInfo><KeyValue><RSAKeyValue><Modulus>ok2x7OvGwA7zbnfezc3HT9M4dJka+FaQ7+vCqG40Bcm1QLlYIiDX/Whts0LVijaOvtl9iMeuShnAV7mchItKAVAABpyHuTuav2NCI9FsA8jFmlWndk3uK9RInNx1h1H4ojYxdBExyoN6muwwslKsLEfauUml7h5WAsDPpufTZd4yp2Jyiy384Zdd8CJlfQxfDe+gDZEciugWKHPSOoRxdjAk0GFm0OH14MyoYM4+M3mm1oH7vmSQohS5KIL3NEVW9Mdw7csTG5f93uORLvrJ/8ehFcGyWVb7UGHJnRhdcgGIbfiZzZlsAMS/DIBzM8RHKGNUNSbbLYmN/rt7pRjL4Q==</Modulus><Exponent>AQAB</Exponent></RSAKeyValue></KeyValue><X509Data><X509Certificate>MIIF/zCCA+egAwIBAgITMwAAAsyOtZamvdHJTgAAAAACzDANBgkqhkiG9w0BAQsFADB+MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSgwJgYDVQQDEx9NaWNyb3NvZnQgQ29kZSBTaWduaW5nIFBDQSAyMDExMB4XDTIyMDUxMjIwNDYwMVoXDTIzMDUxMTIwNDYwMVowdDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEeMBwGA1UEAxMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAok2x7OvGwA7zbnfezc3HT9M4dJka+FaQ7+vCqG40Bcm1QLlYIiDX/Whts0LVijaOvtl9iMeuShnAV7mchItKAVAABpyHuTuav2NCI9FsA8jFmlWndk3uK9RInNx1h1H4ojYxdBExyoN6muwwslKsLEfauUml7h5WAsDPpufTZd4yp2Jyiy384Zdd8CJlfQxfDe+gDZEciugWKHPSOoRxdjAk0GFm0OH14MyoYM4+M3mm1oH7vmSQohS5KIL3NEVW9Mdw7csTG5f93uORLvrJ/8ehFcGyWVb7UGHJnRhdcgGIbfiZzZlsAMS/DIBzM8RHKGNUNSbbLYmN/rt7pRjL4QIDAQABo4IBfjCCAXowHwYDVR0lBBgwFgYKKwYBBAGCN0wIAQYIKwYBBQUHAwMwHQYDVR0OBBYEFIi4R40ylsyKlSKfrDNqzhx9da30MFAGA1UdEQRJMEekRTBDMSkwJwYDVQQLEyBNaWNyb3NvZnQgT3BlcmF0aW9ucyBQdWVydG8gUmljbzEWMBQGA1UEBRMNMjMwMDEyKzQ3MDUyOTAfBgNVHSMEGDAWgBRIbmTlUAXTgqoXNzcitW2oynUClTBUBgNVHR8ETTBLMEmgR6BFhkNodHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20vcGtpb3BzL2NybC9NaWNDb2RTaWdQQ0EyMDExXzIwMTEtMDctMDguY3JsMGEGCCsGAQUFBwEBBFUwUzBRBggrBgEFBQcwAoZFaHR0cDovL3d3dy5taWNyb3NvZnQuY29tL3BraW9wcy9jZXJ0cy9NaWNDb2RTaWdQQ0EyMDExXzIwMTEtMDctMDguY3J0MAwGA1UdEwEB/wQCMAAwDQYJKoZIhvcNAQELBQADggIBAHgPA7DgB0udzEyB2LvG216zuskLUQ+iX8jFnl2i7tzXPDw5xXNXn2KvxdzBsf2osDW3LCdjFOwSjVkz+SUFQQNhjSHkd5knF6pzrL9V6lz72XiEg1Vi2gUM3HiLXSMIKOgdd78ZZJEmDLwdA692MO/1vVOFpOSv0QzpyBr5iqiotwMMsZVdZqXn8u9vRSmlk+3nQXdyOPoZXTGPLHXwz41kbSc4zI12bONTlDsLR3HD2s44wuyp3c72R8f9FVi/J9DU/+NOL37Z1yonzGZEuKdrAd6CvupAnLMlrIEv93mBsNRXuDDp4p9UYYK1taxzzgyUxgFDpluMHN0Oiiq9s73u7DA2XvbX8paJz8IZPe9a1/KhsOi5Kxhb99SCXiUnv2lGxnVAz5G6wAW1bzxJYKI+Xj90RKseY3X5EMO7TnVpIZ9Iw1IdrkHp/QLY90ZCch7kdBlLCVTFhSXZCDv4BcM6DhpRzbJsb6QDVfOv9aoG9aGV3a1EacyaedzLA2gWP6cTnCdAr4OrlrN5EFoCpOWgc77F/eQc3SLR06VTLVT1uKuNVxL2xZlD9Z+qC+a3TXa0zI/x1zEZNSgpLGsdVcaN6r/td3ArGQGkDWiAL7eS75LIWZA2SD//9B56uzZ1nmEd8+KBYsPTdp922/W2kFrlj7MBtA6vWE/ZG/grOKiC</X509Certificate><X509Certificate>MIIHejCCBWKgAwIBAgIKYQ6Q0gAAAAAAAzANBgkqhkiG9w0BAQsFADCBiDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEyMDAGA1UEAxMpTWljcm9zb2Z0IFJvb3QgQ2VydGlmaWNhdGUgQXV0aG9yaXR5IDIwMTEwHhcNMTEwNzA4MjA1OTA5WhcNMjYwNzA4MjEwOTA5WjB+MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSgwJgYDVQQDEx9NaWNyb3NvZnQgQ29kZSBTaWduaW5nIFBDQSAyMDExMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAq/D6chAcLq3YbqqCEE00uvK2WCGfQhsqa+laUKq4BjgaBEm6f8MMHt03a8YS2AvwOMKZBrDIOdUBFDFC04kNeWSHfpRgJGyvnkmc6Whe0t+bU7IKLMOv2akrrnoJr9eWWcpgGgXpZnboMlImEi/nqwhQz7NEt13YxC4Ddato88tt8zpcoRb0RrrgOGSsbmQ1eKagYw8t00CT+OPeBw3VXHmlSSnnDb6gE3e+lD3v++MrWhAfTVYoonpy4BI6t0le2O3tQ5GD2Xuye4Yb2T6xjF3oiU+EGvKhL1nkkDstrjNYxbc+/jLTswM9sbKvkjh+0p2ALPVOVpEhNSXDOW5kf1O6nA+tGSOEy/S6A4aN91/w0FK/jJSHvMAhdCVfGCi2zCcoOCWYOUo2z3yxkq4cI6epZuxhH2rhKEmdX4jiJV3TIUs+UsS1Vz8kA/DRelsv1SPjcF0PUUZ3s/gA4bysAoJf28AVs70b1FVL5zmhD+kjSbwYuER8ReTBw3J64HLnJN+/RpnF78IcV9uDjexNSTCnq47f7Fufr/zdsGbiwZeBe+3W7UvnSSmnEyimp31ngOaKYnhfsi+E11ecXL93KCjx7W3DKI8sj0A3T8HhhUSJxAlMxdSlQy90lfdu+HggWCwTXWCVmj5PM4TasIgX3p5O9JawvEagbJjS4NaIjAsCAwEAAaOCAe0wggHpMBAGCSsGAQQBgjcVAQQDAgEAMB0GA1UdDgQWBBRIbmTlUAXTgqoXNzcitW2oynUClTAZBgkrBgEEAYI3FAIEDB4KAFMAdQBiAEMAQTALBgNVHQ8EBAMCAYYwDwYDVR0TAQH/BAUwAwEB/zAfBgNVHSMEGDAWgBRyLToCMZBDuRQFTuHqp8cx0SOJNDBaBgNVHR8EUzBRME+gTaBLhklodHRwOi8vY3JsLm1pY3Jvc29mdC5jb20vcGtpL2NybC9wcm9kdWN0cy9NaWNSb29DZXJBdXQyMDExXzIwMTFfMDNfMjIuY3JsMF4GCCsGAQUFBwEBBFIwUDBOBggrBgEFBQcwAoZCaHR0cDovL3d3dy5taWNyb3NvZnQuY29tL3BraS9jZXJ0cy9NaWNSb29DZXJBdXQyMDExXzIwMTFfMDNfMjIuY3J0MIGfBgNVHSAEgZcwgZQwgZEGCSsGAQQBgjcuAzCBgzA/BggrBgEFBQcCARYzaHR0cDovL3d3dy5taWNyb3NvZnQuY29tL3BraW9wcy9kb2NzL3ByaW1hcnljcHMuaHRtMEAGCCsGAQUFBwICMDQeMiAdAEwAZQBnAGEAbABfAHAAbwBsAGkAYwB5AF8AcwB0AGEAdABlAG0AZQBuAHQALiAdMA0GCSqGSIb3DQEBCwUAA4ICAQBn8oalmOBUeRou09h0ZyKbC5YR4WOSmUKWfdJ5DJDBZV8uLD74w3LRbYP+vj/oCso7v0epo/Np22O/IjWll11lhJB9i0ZQVdgMknzSGksc8zxCi1LQsP1r4z4HLimb5j0bpdS1HXeUOeLpZMlEPXh6I/MTfaaQdION9MsmAkYqwooQu6SpBQyb7Wj6aC6VoCo/KmtYSWMfCWluWpiW5IP0wI/zRive/DvQvTXvbiWu5a8n7dDd8w6vmSiXmE0OPQvyCInWH8MyGOLwxS3OW560STkKxgrCxq2u5bLZ2xWIUUVYODJxJxp/sfQn+N4sOiBpmLJZiWhub6e3dMNABQamASooPoI/E01mC8CzTfXhj38cbxV9Rad25UAqZaPDXVJihsMdYzaXht/a8/jyFqGaJ+HNpZfQ7l1jQeNbB5yHPgZ3BtEGsXUfFL5hYbXw3MYbBL7fQccOKO7eZS/sl/ahXJbYANahRr1Z85elCUtIEJmAH9AAKcWxm6U/RXceNcbSoqKfenoi+kiVH6v7RyOA9Z74v2u3S5fi63V4GuzqN5l5GEv/1rMjaHXmr/r8i+sLgOppO6/8MO0ETI7f33VtY5E90Z1WTk+/gFcioXgRMiF670EKsT/7qMykXcGhiJtXcVZOSEXAQsmbdlsKgEhr/Xmfwb1tbWrJUnMTDXpQzQ==</X509Certificate><X509Certificate>MIIF7TCCA9WgAwIBAgIQP4vItfyfspZDtWnWbELhRDANBgkqhkiG9w0BAQsFADCBiDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEyMDAGA1UEAxMpTWljcm9zb2Z0IFJvb3QgQ2VydGlmaWNhdGUgQXV0aG9yaXR5IDIwMTEwHhcNMTEwMzIyMjIwNTI4WhcNMzYwMzIyMjIxMzA0WjCBiDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEyMDAGA1UEAxMpTWljcm9zb2Z0IFJvb3QgQ2VydGlmaWNhdGUgQXV0aG9yaXR5IDIwMTEwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQCygEGqNThNE3IyaCJNuLLx/9VSvGzH9dJKjDbu0cJcfoyKrq8TKG/Ac+M6ztAlqFo6be+ouFmrEyNozQwph9FvgFyPRH9dkAFSWKxRxV8qh9zc2AodwQO5e7BW6KPeZGHCnvjzfLnsDbVU/ky2ZU+I8JxImQxCCwl8MVkXeQZ4KI2JOkwDJb5xalwL54RgpJki49KvhKSn+9GY7Qyp3pSJ4Q6g3MDOmT3qCFK7VnnkH4S6Hri0xElcTzFLh93dBWcmmYDgcRGjuKVB4qRTufcyKYMME782XgSzS0NHL2vikR7TmE/dQgfI6B0S/Jmpaz6SfsjWaTr8ZL22CZ3K/QwLopt3YEsDlKQwaRLWQi3BQUzK3Kr9j1uDRprZ/LHR47PJf0h6zSTwQY9cdNCssBAgBkm3xy0hyFfj0IbzA2j70M5xwYmZSmQBbP3sMJHPQTySx+W6hh1hhMdfgzlirrSSL0fzC/hV66AfWdC7dJse0Hbm8ukG1xDo+mTeacY1logC8Ea4PyeZb8txiSk190gWAjWP1Xl8TQLPX+uKg09FcYj5qQ1OcunCnAfPSRtOBA5jUYxe2ADBVSy2xuDCZU7JNDn1nLPEfuhhbhNfFcRf2X7tHc7uROzLLoax7Dj2cO2rXBPB2Q8Nx4CyVe0096yb5MPa50c8prWPMd/FS6/r8QIDAQABo1EwTzALBgNVHQ8EBAMCAYYwDwYDVR0TAQH/BAUwAwEB/zAdBgNVHQ4EFgQUci06AjGQQ7kUBU7h6qfHMdEjiTQwEAYJKwYBBAGCNxUBBAMCAQAwDQYJKoZIhvcNAQELBQADggIBAH9yzw+3xRXbm8BJyiZb/p4T5tPw0tuXX/JLP02zrhmu7deXoKzvqTqjwkGw5biRnhOBJAPmCf0/V0A5ISRW0RAvS0CpNoZLtFNXmvvxfomPEf4YbFGq6O0JlbXlccmh6Yd1phV/yX43VF50k8XDZ8wNT2uoFwxtCJJ+i92Bqi1wIcM9BhS7vyRep4TXPw8hIr1LAAbblxzYXtTFC1yHblCk6MM4pPvLLMWSZpuFXst6bJN8gClYW1e1QGm6CHmmZGIVnYeWRbVmIyADixxzoNOieTPgUFmG2y/lAiXqcyqfABTINseSO+lOAOzYVgm5M0kS0lQLAausR7aRKX1MtHWAUgHoyoL2n8ysnI8X6i8msKtyrAv+nlEex0NVZ09Rs1fWtuzuUrc66U7h14GIvE+OdbtLqPA1qibUZ2dJsnBMO5PcHd94kIZysjik0dySTclY6ysSXNQ7roxrsIPlAT/4CTL2kzU0Iq/dNw13CYArzUgA8YyZGUcFAenRv9FO0OYoQzeZpApKCNmacXPSqs0xE2N2oTdvkjgefRI8ZjLny23h/FKJ3crWZgWalmG+oijHHKOnNlA8OqTfSm7mhzvO6/DggTedEzxSjr25HTTGHdUKaj2YKXCMiSrRq4IQSB/c9O+lxbtVGjhjhE63bK2VVOxlIhBJF7jAHscPrFRH</X509Certificate></X509Data></KeyInfo><Object Id="ts-countersig"><X509Data><X509Certificate>MIIHEDCCBPigAwIBAgITMwAAAahV8GGpzDAYXAABAAABqDANBgkqhkiG9w0BAQsFADB8MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSYwJAYDVQQDEx1NaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0EgMjAxMDAeFw0yMjAzMDIxODUxMjNaFw0yMzA1MTExODUxMjNaMIHOMQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSkwJwYDVQQLEyBNaWNyb3NvZnQgT3BlcmF0aW9ucyBQdWVydG8gUmljbzEmMCQGA1UECxMdVGhhbGVzIFRTUyBFU046Nzg4MC1FMzkwLTgwMTQxJTAjBgNVBAMTHE1pY3Jvc29mdCBUaW1lLVN0YW1wIFNlcnZpY2UwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQCj2m3KwC4l1/KY8l6XDDfPSk73JpQIg8OKVPh3o2YYm1HqPx1Mvj/VcVoQl+6IHnijyeu+/i3lXT3RuYU7xg4ErqN8PgHJs3F2dkAhlIFEXi1Cm5q69OmwdMYb7WcKHpYcbT5IyRbG0xrUrflexOFQoz3WKkGf4jdAK115oGxH1cgsEvodrqKAYTOVHGz6ILa+VaYHc21DOP61rqZhVYzwdWrJ9/sL+2gQivI/UFCa6GOMtaZmUn9ErhjFmO3JtnL623Zu15XZY6kXR1vgkAAeBKojqoLpn0fmkqaOU++ShtPp7AZI5RkrFNQYteaeKz/PKWZ0qKe9xnpvRljthkS8D9eWBJyrHM8YRmPmfDRGtEMDDIlZZLHT1OyeaivYMQEIzic6iEic4SMEFrRC6oCaB8JKk8Xpt4K2Owewzs0E50KSlqC9B1kfSqiL2gu4vV5T7/rnvPY/Xu35geJ4dYbpcxCc1+kTFPUxyTJWzujqz9zTRCiVvI4qQp8vB9X7r0rhX7ge7fviivYNnNjSruRM0rNZyjarZeCjt1M8ly1r00QzuA+T1UDnWtLao0vwFqFK8SguWT5ZCxPmD7EuRvhP1QoAmoIT8gWbBzSu8B5Un/9uroS5yqel0QCK6IhGJf+cltJkoY75wET69BiJUptCq6ksAo0eXJFk9bCmhG/MNwIDAQABo4IBNjCCATIwHQYDVR0OBBYEFDbH2+Pi+FLrZTYfzMYxpI9JCyLVMB8GA1UdIwQYMBaAFJ+nFV0AXmJdg/Tl0mWnG1M1GelyMF8GA1UdHwRYMFYwVKBSoFCGTmh0dHA6Ly93d3cubWljcm9zb2Z0LmNvbS9wa2lvcHMvY3JsL01pY3Jvc29mdCUyMFRpbWUtU3RhbXAlMjBQQ0ElMjAyMDEwKDEpLmNybDBsBggrBgEFBQcBAQRgMF4wXAYIKwYBBQUHMAKGUGh0dHA6Ly93d3cubWljcm9zb2Z0LmNvbS9wa2lvcHMvY2VydHMvTWljcm9zb2Z0JTIwVGltZS1TdGFtcCUyMFBDQSUyMDIwMTAoMSkuY3J0MAwGA1UdEwEB/wQCMAAwEwYDVR0lBAwwCgYIKwYBBQUHAwgwDQYJKoZIhvcNAQELBQADggIBAHE7gktkaqpn9pj6+jlMnYZlMfpur6RD7M1oqCV257EW58utpxfWF0yrkjVh9UBX8nP9jd2ExKeIRPGLYWCoAzPx1IVERF91k8BrHmLrg3ksVkSVgqKwBxdZMEMyCoK1HNxvrlcAJhvxCNRC0RMQOH7cdBIa3+fWiZuzp4J9JU0koilHrhgPjMuqAov1fBE8c/nm5b0ADWpbSYBn6abll2E+I4rEChE76CYwb+cfgQNKBBbu4BmnjA5GY5zub3X+h3ip3iC7PWb8CFpIGEItmXqM28YJRuWMBMaIsXpMa0Uw2cDKJCGMV5nHLHENMV5ofiN76O4VfWTCk2vT2s+Z3uHHPDncNU/utuJgdFmlvRwBNYaIwegm37p3bVf48MZnSodeaZSV5zdcjOzi/duB6gIiYrB2p6ThCeFJvW94RVFxNrhCS/WmLiIJLFWCKtT9va0eF+5c97hCR+gjpKBOvlHGrjeiWBYITfSPCUQVgIR1+BkB5Z4LHX7Viy4g2TMp5YEQmc5GCNuDfXMfg9+u2MHJajWOgmbgIM8MtdrkWBUGrGB2CtYac8k7biPwNgfHBvhzOl9Y39nfbgEcB+voS5D7bd/+TQZS16TpeYmckZQYu4g15FjWt47hnywCdyEg8jYe8rvh+MkGMkbPzFawpFlCbPRIryyrDSdgfyIza0rW</X509Certificate><X509Certificate>MIIHcTCCBVmgAwIBAgITMwAAABXF52ueAptJmQAAAAAAFTANBgkqhkiG9w0BAQsFADCBiDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEyMDAGA1UEAxMpTWljcm9zb2Z0IFJvb3QgQ2VydGlmaWNhdGUgQXV0aG9yaXR5IDIwMTAwHhcNMjEwOTMwMTgyMjI1WhcNMzAwOTMwMTgzMjI1WjB8MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSYwJAYDVQQDEx1NaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0EgMjAxMDCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAOThpkzntHIhC3miy9ckeb0O1YLT/e6cBwfSqWxOdcjKNVf2AX9sSuDivbk+F2Az/1xPx2b3lVNxWuJ+Slr+uDZnhUYjDLWNE893MsAQGOhgfWpSg0S3po5GawcU88V29YZQ3MFEyHFcUTE3oAo4bo3t1w/YJlN8OWECesSq/XJprx2rrPY2vjUmZNqYO7oaezOtgFt+jBAcnVL+tuhiJdxqD89d9P6OU8/W7IVWTe/dvI2k45GPsjksUZzpcGkNyjYtcI4xyDUoveO0hyTD4MmPfrVUj9z6BVWYbWg7mka97aSueik3rMvrg0XnRm7KMtXAhjBcTyziYrLNueKNiOSWrAFKu75xqRdbZ2De+JKRHh09/SDPc31BmkZ1zcRfNN0Sidb9pSB9fvzZnkXftnIv231fgLrbqn427DZM9ituqBJR6L8FA6PRc6ZNN3SUHDSCD/AQ8rdHGO2n6Jl8P0zbr17C89XYcz1DTsEzOUyOArxCaC4Q6oRRRuLRvWoYWmEBc8pnol7XKHYC4jMYctenIPDC+hIK12NvDMk2ZItboKaDIV1fMHSRlJTYuVD5C4lh8zYGNRiER9vcG9H9stQcxWv2XFJRXRLbJbqvUAV6bMURHXLvjflSxIUXk8A8FdsaN8cIFRg/eKtFtvUeh17aj54WcmnGrnu3tz5q4i6tAgMBAAGjggHdMIIB2TASBgkrBgEEAYI3FQEEBQIDAQABMCMGCSsGAQQBgjcVAgQWBBQqp1L+ZMSavoKRPEY1Kc8Q/y8E7jAdBgNVHQ4EFgQUn6cVXQBeYl2D9OXSZacbUzUZ6XIwXAYDVR0gBFUwUzBRBgwrBgEEAYI3TIN9AQEwQTA/BggrBgEFBQcCARYzaHR0cDovL3d3dy5taWNyb3NvZnQuY29tL3BraW9wcy9Eb2NzL1JlcG9zaXRvcnkuaHRtMBMGA1UdJQQMMAoGCCsGAQUFBwMIMBkGCSsGAQQBgjcUAgQMHgoAUwB1AGIAQwBBMAsGA1UdDwQEAwIBhjAPBgNVHRMBAf8EBTADAQH/MB8GA1UdIwQYMBaAFNX2VsuP6KJcYmjRPZSQW9fOmhjEMFYGA1UdHwRPME0wS6BJoEeGRWh0dHA6Ly9jcmwubWljcm9zb2Z0LmNvbS9wa2kvY3JsL3Byb2R1Y3RzL01pY1Jvb0NlckF1dF8yMDEwLTA2LTIzLmNybDBaBggrBgEFBQcBAQROMEwwSgYIKwYBBQUHMAKGPmh0dHA6Ly93d3cubWljcm9zb2Z0LmNvbS9wa2kvY2VydHMvTWljUm9vQ2VyQXV0XzIwMTAtMDYtMjMuY3J0MA0GCSqGSIb3DQEBCwUAA4ICAQCdVX38Kq3hLB9nATEkW+Geckv8qW/qXBS2Pk5HZHixBpOXPTEztTnXwnE2P9pkbHzQdTltuw8x5MKP+2zRoZQYIu7pZmc6U03dmLq2HnjYNi6cqYJWAAOwBb6J6Gngugnue99qb74py27YP0h1AdkY3m2CDPVtI1TkeFN1JFe53Z/zjj3G82jfZfakVqr3lbYoVSfQJL1AoL8ZthISEV09J+BAljis9/kpicO8F7BUhUKz/AyeixmJ5/ALaoHCgRlCGVJ1ijbCHcNhcy4sa3tuPywJeBTpkbKpW99Jo3QMvOyRgNI95ko+ZjtPu4b6MhrZlvSP9pEB9s7GdP32THJvEKt1MMU0sHrYUP4KWN1APMdUbZ1jdEgssU5HLcEUBHG/ZPkkvnNtyo4JvbMBV0lUZNlz138eW0QBjloZkWsNn6Qo3GcZKCS6OEuabvshVGtqRRFHqfG3rsjoiV5PndLQTHa1V1QJsWkBRH58oWFsc/4Ku+xBZj1p/cvBQUl+fpO+y/g75LcVv7TOPqUxUYS8vwLBgqJ7Fx0ViY1w/ue10CgaiQuPNtq6TPmb/wrpNPgkNWcr4A245oyZ1uEi6vAnQj0llOZ0dFtq0Z4+7X6gMTN9vMvpe784cETRkPHIqzqKOghif9lwY1NNje6CbaUFEMFxBmoQtB1VM1izoXBm8g==</X509Certificate></X509Data><CounterSignature ts-format="cms-timestamp-message" xmlns="http://schemas.microsoft.com/xmldsig/timestamp/2003">MIAGCSqGSIb3DQEHAqCAMIIW4QIBAzEPMA0GCWCGSAFlAwQCAQUAMIIBVQYLKoZIhvcNAQkQAQSgggFEBIIBQDCCATwCAQEGCisGAQQBhFkKAwEwMTANBglghkgBZQMEAgEFAAQg6FdqT2ByEEfrNvksNmiHjAsPqCKYKd0FaYAL7d8vRBECBmMRUBtVVxgTMjAyMjA5MDkyMzE4MjYuNjM1WjAEgAIB9KCB1KSB0TCBzjELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEpMCcGA1UECxMgTWljcm9zb2Z0IE9wZXJhdGlvbnMgUHVlcnRvIFJpY28xJjAkBgNVBAsTHVRoYWxlcyBUU1MgRVNOOjc4ODAtRTM5MC04MDE0MSUwIwYDVQQDExxNaWNyb3NvZnQgVGltZS1TdGFtcCBTZXJ2aWNloIIRXzCCBxAwggT4oAMCAQICEzMAAAGoVfBhqcwwGFwAAQAAAagwDQYJKoZIhvcNAQELBQAwfDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEmMCQGA1UEAxMdTWljcm9zb2Z0IFRpbWUtU3RhbXAgUENBIDIwMTAwHhcNMjIwMzAyMTg1MTIzWhcNMjMwNTExMTg1MTIzWjCBzjELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEpMCcGA1UECxMgTWljcm9zb2Z0IE9wZXJhdGlvbnMgUHVlcnRvIFJpY28xJjAkBgNVBAsTHVRoYWxlcyBUU1MgRVNOOjc4ODAtRTM5MC04MDE0MSUwIwYDVQQDExxNaWNyb3NvZnQgVGltZS1TdGFtcCBTZXJ2aWNlMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAo9ptysAuJdfymPJelww3z0pO9yaUCIPDilT4d6NmGJtR6j8dTL4/1XFaEJfuiB54o8nrvv4t5V090bmFO8YOBK6jfD4BybNxdnZAIZSBRF4tQpuauvTpsHTGG+1nCh6WHG0+SMkWxtMa1K35XsThUKM91ipBn+I3QCtdeaBsR9XILBL6Ha6igGEzlRxs+iC2vlWmB3NtQzj+ta6mYVWM8HVqyff7C/toEIryP1BQmuhjjLWmZlJ/RK4YxZjtybZy+tt2bteV2WOpF0db4JAAHgSqI6qC6Z9H5pKmjlPvkobT6ewGSOUZKxTUGLXmnis/zylmdKinvcZ6b0ZY7YZEvA/XlgScqxzPGEZj5nw0RrRDAwyJWWSx09Tsnmor2DEBCM4nOohInOEjBBa0QuqAmgfCSpPF6beCtjsHsM7NBOdCkpagvQdZH0qoi9oLuL1eU+/657z2P17t+YHieHWG6XMQnNfpExT1MckyVs7o6s/c00QolbyOKkKfLwfV+69K4V+4Hu374or2DZzY0q7kTNKzWco2q2Xgo7dTPJcta9NEM7gPk9VA51rS2qNL8BahSvEoLlk+WQsT5g+xLkb4T9UKAJqCE/IFmwc0rvAeVJ//bq6EucqnpdEAiuiIRiX/nJbSZKGO+cBE+vQYiVKbQqupLAKNHlyRZPWwpoRvzDcCAwEAAaOCATYwggEyMB0GA1UdDgQWBBQ2x9vj4vhS62U2H8zGMaSPSQsi1TAfBgNVHSMEGDAWgBSfpxVdAF5iXYP05dJlpxtTNRnpcjBfBgNVHR8EWDBWMFSgUqBQhk5odHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20vcGtpb3BzL2NybC9NaWNyb3NvZnQlMjBUaW1lLVN0YW1wJTIwUENBJTIwMjAxMCgxKS5jcmwwbAYIKwYBBQUHAQEEYDBeMFwGCCsGAQUFBzAChlBodHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20vcGtpb3BzL2NlcnRzL01pY3Jvc29mdCUyMFRpbWUtU3RhbXAlMjBQQ0ElMjAyMDEwKDEpLmNydDAMBgNVHRMBAf8EAjAAMBMGA1UdJQQMMAoGCCsGAQUFBwMIMA0GCSqGSIb3DQEBCwUAA4ICAQBxO4JLZGqqZ/aY+vo5TJ2GZTH6bq+kQ+zNaKglduexFufLracX1hdMq5I1YfVAV/Jz/Y3dhMSniETxi2FgqAMz8dSFRERfdZPAax5i64N5LFZElYKisAcXWTBDMgqCtRzcb65XACYb8QjUQtETEDh+3HQSGt/n1ombs6eCfSVNJKIpR64YD4zLqgKL9XwRPHP55uW9AA1qW0mAZ+mm5ZdhPiOKxAoRO+gmMG/nH4EDSgQW7uAZp4wORmOc7m91/od4qd4guz1m/AhaSBhCLZl6jNvGCUbljATGiLF6TGtFMNnAyiQhjFeZxyxxDTFeaH4je+juFX1kwpNr09rPmd7hxzw53DVP7rbiYHRZpb0cATWGiMHoJt+6d21X+PDGZ0qHXmmUlec3XIzs4v3bgeoCImKwdqek4QnhSb1veEVRcTa4Qkv1pi4iCSxVgirU/b2tHhfuXPe4QkfoI6SgTr5Rxq43olgWCE30jwlEFYCEdfgZAeWeCx1+1YsuINkzKeWBEJnORgjbg31zH4PfrtjByWo1joJm4CDPDLXa5FgVBqxgdgrWGnPJO24j8DYHxwb4czpfWN/Z324BHAfr6EuQ+23f/k0GUtek6XmJnJGUGLuINeRY1reO4Z8sAnchIPI2HvK74fjJBjJGz8xWsKRZQmz0SK8sqw0nYH8iM2tK1jCCB3EwggVZoAMCAQICEzMAAAAVxedrngKbSZkAAAAAABUwDQYJKoZIhvcNAQELBQAwgYgxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpXYXNoaW5ndG9uMRAwDgYDVQQHEwdSZWRtb25kMR4wHAYDVQQKExVNaWNyb3NvZnQgQ29ycG9yYXRpb24xMjAwBgNVBAMTKU1pY3Jvc29mdCBSb290IENlcnRpZmljYXRlIEF1dGhvcml0eSAyMDEwMB4XDTIxMDkzMDE4MjIyNVoXDTMwMDkzMDE4MzIyNVowfDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEmMCQGA1UEAxMdTWljcm9zb2Z0IFRpbWUtU3RhbXAgUENBIDIwMTAwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQDk4aZM57RyIQt5osvXJHm9DtWC0/3unAcH0qlsTnXIyjVX9gF/bErg4r25PhdgM/9cT8dm95VTcVrifkpa/rg2Z4VGIwy1jRPPdzLAEBjoYH1qUoNEt6aORmsHFPPFdvWGUNzBRMhxXFExN6AKOG6N7dcP2CZTfDlhAnrEqv1yaa8dq6z2Nr41JmTamDu6GnszrYBbfowQHJ1S/rboYiXcag/PXfT+jlPP1uyFVk3v3byNpOORj7I5LFGc6XBpDco2LXCOMcg1KL3jtIckw+DJj361VI/c+gVVmG1oO5pGve2krnopN6zL64NF50ZuyjLVwIYwXE8s4mKyzbnijYjklqwBSru+cakXW2dg3viSkR4dPf0gz3N9QZpGdc3EXzTdEonW/aUgfX782Z5F37ZyL9t9X4C626p+Nuw2TPYrbqgSUei/BQOj0XOmTTd0lBw0gg/wEPK3Rxjtp+iZfD9M269ewvPV2HM9Q07BMzlMjgK8QmguEOqEUUbi0b1qGFphAXPKZ6Je1yh2AuIzGHLXpyDwwvoSCtdjbwzJNmSLW6CmgyFdXzB0kZSU2LlQ+QuJYfM2BjUYhEfb3BvR/bLUHMVr9lxSUV0S2yW6r1AFemzFER1y7435UsSFF5PAPBXbGjfHCBUYP3irRbb1Hode2o+eFnJpxq57t7c+auIurQIDAQABo4IB3TCCAdkwEgYJKwYBBAGCNxUBBAUCAwEAATAjBgkrBgEEAYI3FQIEFgQUKqdS/mTEmr6CkTxGNSnPEP8vBO4wHQYDVR0OBBYEFJ+nFV0AXmJdg/Tl0mWnG1M1GelyMFwGA1UdIARVMFMwUQYMKwYBBAGCN0yDfQEBMEEwPwYIKwYBBQUHAgEWM2h0dHA6Ly93d3cubWljcm9zb2Z0LmNvbS9wa2lvcHMvRG9jcy9SZXBvc2l0b3J5Lmh0bTATBgNVHSUEDDAKBggrBgEFBQcDCDAZBgkrBgEEAYI3FAIEDB4KAFMAdQBiAEMAQTALBgNVHQ8EBAMCAYYwDwYDVR0TAQH/BAUwAwEB/zAfBgNVHSMEGDAWgBTV9lbLj+iiXGJo0T2UkFvXzpoYxDBWBgNVHR8ETzBNMEugSaBHhkVodHRwOi8vY3JsLm1pY3Jvc29mdC5jb20vcGtpL2NybC9wcm9kdWN0cy9NaWNSb29DZXJBdXRfMjAxMC0wNi0yMy5jcmwwWgYIKwYBBQUHAQEETjBMMEoGCCsGAQUFBzAChj5odHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20vcGtpL2NlcnRzL01pY1Jvb0NlckF1dF8yMDEwLTA2LTIzLmNydDANBgkqhkiG9w0BAQsFAAOCAgEAnVV9/Cqt4SwfZwExJFvhnnJL/Klv6lwUtj5OR2R4sQaTlz0xM7U518JxNj/aZGx80HU5bbsPMeTCj/ts0aGUGCLu6WZnOlNN3Zi6th542DYunKmCVgADsAW+iehp4LoJ7nvfam++Kctu2D9IdQHZGN5tggz1bSNU5HhTdSRXud2f8449xvNo32X2pFaq95W2KFUn0CS9QKC/GbYSEhFdPSfgQJY4rPf5KYnDvBewVIVCs/wMnosZiefwC2qBwoEZQhlSdYo2wh3DYXMuLGt7bj8sCXgU6ZGyqVvfSaN0DLzskYDSPeZKPmY7T7uG+jIa2Zb0j/aRAfbOxnT99kxybxCrdTDFNLB62FD+CljdQDzHVG2dY3RILLFORy3BFARxv2T5JL5zbcqOCb2zAVdJVGTZc9d/HltEAY5aGZFrDZ+kKNxnGSgkujhLmm77IVRrakURR6nxt67I6IleT53S0Ex2tVdUCbFpAUR+fKFhbHP+CrvsQWY9af3LwUFJfn6Tvsv4O+S3Fb+0zj6lMVGEvL8CwYKiexcdFYmNcP7ntdAoGokLjzbaukz5m/8K6TT4JDVnK+ANuOaMmdbhIurwJ0I9JZTmdHRbatGePu1+oDEzfbzL6Xu/OHBE0ZDxyKs6ijoIYn/ZcGNTTY3ugm2lBRDBcQZqELQdVTNYs6FwZvKhggLSMIICOwIBATCB/KGB1KSB0TCBzjELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEpMCcGA1UECxMgTWljcm9zb2Z0IE9wZXJhdGlvbnMgUHVlcnRvIFJpY28xJjAkBgNVBAsTHVRoYWxlcyBUU1MgRVNOOjc4ODAtRTM5MC04MDE0MSUwIwYDVQQDExxNaWNyb3NvZnQgVGltZS1TdGFtcCBTZXJ2aWNloiMKAQEwBwYFKw4DAhoDFQBsuvzEn0EHisvhiDnxfUtnmJB3LKCBgzCBgKR+MHwxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpXYXNoaW5ndG9uMRAwDgYDVQQHEwdSZWRtb25kMR4wHAYDVQQKExVNaWNyb3NvZnQgQ29ycG9yYXRpb24xJjAkBgNVBAMTHU1pY3Jvc29mdCBUaW1lLVN0YW1wIFBDQSAyMDEwMA0GCSqGSIb3DQEBBQUAAgUA5sWxgDAiGA8yMDIyMDkwOTE2MzUxMloYDzIwMjIwOTEwMTYzNTEyWjB3MD0GCisGAQQBhFkKBAExLzAtMAoCBQDmxbGAAgEAMAoCAQACAiHpAgH/MAcCAQACAhLNMAoCBQDmxwMAAgEAMDYGCisGAQQBhFkKBAIxKDAmMAwGCisGAQQBhFkKAwKgCjAIAgEAAgMHoSChCjAIAgEAAgMBhqAwDQYJKoZIhvcNAQEFBQADgYEAJrrx5tBaPI2PAtodN75oLlKBS4C03MvuysSNnEJOMmQkaVBHsYQIpi95/poVyygTYnfZeqmErOs0cK4Vxfvxop3joLddkhLa9hylVXKGmMWGL5s++M4WZkrD0sMt4rDznti/41cF9QwCGlPa06+ewwZrvFulc3ovA2rVVfH/ZA4xggQNMIIECQIBATCBkzB8MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSYwJAYDVQQDEx1NaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0EgMjAxMAITMwAAAahV8GGpzDAYXAABAAABqDANBglghkgBZQMEAgEFAKCCAUowGgYJKoZIhvcNAQkDMQ0GCyqGSIb3DQEJEAEEMC8GCSqGSIb3DQEJBDEiBCBpfEYBsSnM8bOmpTGSIMpAQlyN9TO9VeD4qoG4gd+64jCB+gYLKoZIhvcNAQkQAi8xgeowgecwgeQwgb0EIHT+yx0AywfCc3CF8UFc+UWdG9aEepJf1gtTEEOXXGWmMIGYMIGApH4wfDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEmMCQGA1UEAxMdTWljcm9zb2Z0IFRpbWUtU3RhbXAgUENBIDIwMTACEzMAAAGoVfBhqcwwGFwAAQAAAagwIgQgqth8fw0kAso4ZqqqaTO7NH4dFH4mj2B2Zd2pJEdoJNQwDQYJKoZIhvcNAQELBQAEggIAD/gti/dbfXzSwRnw1+naGcZcMeMIW1hHay2jZ//ho2LxWz0XEf+T4PCDX+eZNLGKpN4cnTLU0oy/02cfSPchUA2rmfyWm8JrFJeVV9athVMVtvYCrhh31CvjdsT02Jp8vHoCvn5vGbvAtdTjKFWhNrOIjSAf5Uk7rmLII4uxSeQMLs2i82oYd2S9wSZ29gtHoAe/H5rlXS4iit3cdskKWWlvTog5OuNpXM55Xtpeb/uAL0XSgRJ9qgtbxcNiuNL7+OLDKPhs08VGlO6Au6oWivZlVGa7Ss9D4L1sdLkX/o7llaLZqEDsOdWkU7M9/CxihZWmpXwrNokPbfqNobRN1EFpZty8z0YNCerLMlw9t01fz94zquCf5UGCY1BaANUvdw9kpbVBW/sKIkAF4CQ7nLjCPQ3pVKOloidNGJuRFJdk4+Z5t7DOKCFNqtc/P5d/MpmTQaIFkDiPXW73iLa/hAb4B0RS2CjHVUBZJKjmeeMzUgi1X4l3uFlvQr9n3/wpqm+AQdpx7p9B/VoTR4qdhD+kBLoybjLCfStPftevj4Dh3VBxUyMqzD1RFc3u47T57gI7etRLRLnA+sJTAjfEZgAygw4HX6HaLTznUA5QBTrPUyspgFzcJecTqzuL/TfJ/gS5ftwNQS7xlMb79FfvDmIVVzRbkkMgMMrNM+Y48OMAAAAA</CounterSignature></Object></Signature></doc>
md5: 6ACC8B26EBC774EA1C0153C7B6328013 | sha1: 94AEA69762AC39FDD85FAA9124CD8F12C2BBAF4B | sha256: 99CE0F9D62E7E57EBDBD21FE678093DA7300BCAE141C25421350C753A85E3F95 | sha512: 9F5226E6A2DB741A4578E85B76E903FC8E4891E80B2B93ECBAC81EE97FBFC4D40741F0E18507FA21AE864A3793CBD4EE7D9290443DB2F1E8871E8FFF80867996
<?xml version="1.0"?>
<doc>
<assembly>
<name>NuGet.Protocol</name>
</assembly>
<members>
<member name="T:NuGet.Protocol.CachingSourceProvider">
<summary>
A caching source repository provider intended to be used as a singleton.
</summary>
</member>
<member name="M:NuGet.Protocol.CachingSourceProvider.GetRepositories">
<summary>
Retrieve repositories that have been cached.
</summary>
</member>
<member name="M:NuGet.Protocol.CachingSourceProvider.CreateRepository(System.String)">
<summary>
Create a repository and add it to the cache.
</summary>
</member>
<member name="M:NuGet.Protocol.CachingSourceProvider.CreateRepository(NuGet.Configuration.PackageSource)">
<summary>
Create a repository and add it to the cache.
</summary>
</member>
<member name="M:NuGet.Protocol.JsonExtensions.ToJson(System.Object,Newtonsoft.Json.Formatting)">
<summary>
Serialize object to the JSON.
</summary>
<param name="obj">The object.</param>
</member>
<member name="M:NuGet.Protocol.JsonExtensions.FromJson``1(System.String)">
<summary>
Deserialize object from the JSON.
</summary>
<typeparam name="T">Type of object</typeparam>
<param name="json">JSON representation of object</param>
</member>
<member name="M:NuGet.Protocol.JsonExtensions.FromJson``1(System.String,Newtonsoft.Json.JsonSerializerSettings)">
<summary>
Deserialize object from the JSON.
</summary>
<typeparam name="T">Type of object</typeparam>
<param name="json">JSON representation of object</param>
<param name="settings">The settings.</param>
</member>
<member name="M:NuGet.Protocol.JsonExtensions.FromJson(System.String,System.Type)">
<summary>
Deserialize object from the JSON.
</summary>
<param name="json">JSON representation of object</param>
<param name="type">The object type.</param>
</member>
<member name="M:NuGet.Protocol.JsonExtensions.ToJToken(System.Object)">
<summary>
Serialize object to JToken.
</summary>
<param name="obj">The object.</param>
</member>
<member name="M:NuGet.Protocol.JsonExtensions.FromJToken``1(Newtonsoft.Json.Linq.JToken)">
<summary>
Deserialize object directly from JToken.
</summary>
<typeparam name="T">Type of object.</typeparam>
<param name="jtoken">The JToken to be deserialized.</param>
</member>
<member name="M:NuGet.Protocol.JsonExtensions.FromJToken(Newtonsoft.Json.Linq.JToken,System.Type)">
<summary>
Deserialize object directly from JToken.
</summary>
<param name="jtoken">The JToken to be deserialized.</param>
<param name="type">The object type.</param>
</member>
<member name="M:NuGet.Protocol.JsonExtensions.GetJObjectProperty``1(Newtonsoft.Json.Linq.JObject,System.String)">
<summary>
Extract the property directly from JObject.
</summary>
<typeparam name="T">Type of property to return.</typeparam>
<param name="jobject">The JObject to be deserialized.</param>
<param name="propertyName">The property name.</param>
</member>
<member name="T:NuGet.Protocol.SemanticVersionConverter">
<summary>
A SemanticVersion JSON converter.
</summary>
</member>
<member name="M:NuGet.Protocol.SemanticVersionConverter.CanConvert(System.Type)">
<summary>
Gets a flag indicating whether or not a type is convertible.
</summary>
<param name="objectType">An object type to check.</param>
<returns><c>true</c> if <paramref name="objectType" /> is convertible; otherwise <c>false</c>.</returns>
</member>
<member name="M:NuGet.Protocol.SemanticVersionConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Reads the JSON representation of the object.
</summary>
<param name="reader">A JSON reader.</param>
<param name="objectType">The type of the object.</param>
<param name="existingValue">The existing value of the object.</param>
<param name="serializer">A serializer.</param>
<returns>A <see cref="T:NuGet.Versioning.SemanticVersion" /> object.</returns>
</member>
<member name="M:NuGet.Protocol.SemanticVersionConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Writes the JSON representation of the object.
</summary>
<param name="writer">A JSON writer.</param>
<param name="value">A value to serialize.</param>
<param name="serializer">A serializer.</param>
</member>
<member name="T:NuGet.Protocol.VersionRangeConverter">
<summary>
A VersionRange JSON converter.
</summary>
</member>
<member name="M:NuGet.Protocol.VersionRangeConverter.CanConvert(System.Type)">
<summary>
Gets a flag indicating whether or not a type is convertible.
</summary>
<param name="objectType">An object type to check.</param>
<returns><c>true</c> if <paramref name="objectType" /> is convertible; otherwise <c>false</c>.</returns>
</member>
<member name="M:NuGet.Protocol.VersionRangeConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Reads the JSON representation of the object.
</summary>
<param name="reader">A JSON reader.</param>
<param name="objectType">The type of the object.</param>
<param name="existingValue">The existing value of the object.</param>
<param name="serializer">A serializer.</param>
<returns>A <see cref="T:NuGet.Versioning.VersionRange" /> object.</returns>
</member>
<member name="M:NuGet.Protocol.VersionRangeConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
<summary>
Writes the JSON representation of the object.
</summary>
<param name="writer">A JSON writer.</param>
<param name="value">A value to serialize.</param>
<param name="serializer">A serializer.</param>
</member>
<member name="M:NuGet.Protocol.ResolverMetadataClient.GetDependencies(NuGet.Protocol.HttpSource,System.Uri,System.String,NuGet.Versioning.VersionRange,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Retrieve the <see cref="T:NuGet.Protocol.Core.Types.RemoteSourceDependencyInfo" /> for a registration.
</summary>
<returns>Returns an empty sequence if the package does not exist.</returns>
</member>
<member name="M:NuGet.Protocol.ResolverMetadataClient.ProcessPackageVersion(Newtonsoft.Json.Linq.JObject,NuGet.Versioning.NuGetVersion)">
<summary>
Process an individual package version entry
</summary>
<param name="packageObj"></param>
<param name="version"></param>
<returns>Returns the RemoteSourceDependencyInfo object corresponding to this package version</returns>
</member>
<member name="M:NuGet.Protocol.ResolverMetadataClient.GetRegistrationInfo(NuGet.Protocol.HttpSource,System.Uri,System.String,NuGet.Versioning.VersionRange,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Frameworks.NuGetFramework,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Retrieve a registration blob
</summary>
<returns>Returns Null if the package does not exist</returns>
</member>
<member name="M:NuGet.Protocol.ResolverMetadataClient.GetFramework(Newtonsoft.Json.Linq.JObject)">
<summary>
Retrieve the target framework from a dependency group obj
</summary>
</member>
<member name="T:NuGet.Protocol.Core.Types.DownloadResourceResult">
<summary>
The result of <see cref="T:NuGet.Protocol.Core.Types.DownloadResource" />.
</summary>
</member>
<member name="M:NuGet.Protocol.Core.Types.DownloadResourceResult.#ctor(NuGet.Protocol.Core.Types.DownloadResourceResultStatus)">
<summary>
Initializes a new <see cref="T:NuGet.Protocol.Core.Types.DownloadResourceResult" /> class.
</summary>
<param name="status">A download resource result status.</param>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="status" />
is either <see cref="F:NuGet.Protocol.Core.Types.DownloadResourceResultStatus.Available" /> or
<see cref="F:NuGet.Protocol.Core.Types.DownloadResourceResultStatus.AvailableWithoutStream" />.</exception>
</member>
<member name="M:NuGet.Protocol.Core.Types.DownloadResourceResult.#ctor(System.IO.Stream,System.String)">
<summary>
Initializes a new <see cref="T:NuGet.Protocol.Core.Types.DownloadResourceResult" /> class.
</summary>
<param name="stream">A package stream.</param>
<param name="source">A package source.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="stream" /> is <c>null</c>.</exception>
</member>
<member name="M:NuGet.Protocol.Core.Types.DownloadResourceResult.#ctor(System.IO.Stream,NuGet.Packaging.PackageReaderBase,System.String)">
<summary>
Initializes a new <see cref="T:NuGet.Protocol.Core.Types.DownloadResourceResult" /> class.
</summary>
<param name="stream">A package stream.</param>
<param name="packageReader">A package reader.</param>
<param name="source">A package source.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="stream" /> is <c>null</c>.</exception>
</member>
<member name="M:NuGet.Protocol.Core.Types.DownloadResourceResult.#ctor(NuGet.Packaging.PackageReaderBase,System.String)">
<summary>
Initializes a new <see cref="T:NuGet.Protocol.Core.Types.DownloadResourceResult" /> class.
</summary>
<param name="packageReader">A package reader.</param>
<param name="source">A package source.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="packageReader" /> is <c>null</c>.</exception>
</member>
<member name="P:NuGet.Protocol.Core.Types.DownloadResourceResult.PackageStream">
<summary>
Gets the package <see cref="P:NuGet.Protocol.Core.Types.DownloadResourceResult.PackageStream" />.
</summary>
<remarks>The value may be <c>null</c>.</remarks>
</member>
<member name="P:NuGet.Protocol.Core.Types.DownloadResourceResult.PackageSource">
<summary>
Gets the source containing this package, if not from cache
</summary>
<remarks>The value may be <c>null</c>.</remarks>
</member>
<member name="P:NuGet.Protocol.Core.Types.DownloadResourceResult.PackageReader">
<summary>
Gets the <see cref="T:NuGet.Packaging.PackageReaderBase" /> for the package.
</summary>
<remarks>The value may be <c>null</c>.</remarks>
</member>
<member name="M:NuGet.Protocol.Core.Types.DownloadResourceResult.Dispose">
<summary>
Disposes of this instance.
</summary>
</member>
<member name="T:NuGet.Protocol.Core.Types.NuGetProtocolException">
<summary>
Base protocol exception type containing a message and optional inner exception.
</summary>
</member>
<member name="P:NuGet.Protocol.Core.Types.FindPackageByIdDependencyInfo.PackageIdentity">
<summary>
Original package identity from the package.
This contains the exact casing for the id and version.
</summary>
</member>
<member name="P:NuGet.Protocol.Core.Types.FindPackageByIdDependencyInfo.DependencyGroups">
<summary>
Gets the package dependency groups.
</summary>
</member>
<member name="P:NuGet.Protocol.Core.Types.FindPackageByIdDependencyInfo.FrameworkReferenceGroups">
<summary>
Gets the framework reference groups.
</summary>
</member>
<member name="M:NuGet.Protocol.Core.Types.FindPackageByIdDependencyInfo.#ctor(NuGet.Packaging.Core.PackageIdentity,System.Collections.Generic.IEnumerable{NuGet.Packaging.PackageDependencyGroup},System.Collections.Generic.IEnumerable{NuGet.Packaging.FrameworkSpecificGroup})">
<summary>
DependencyInfo
</summary>
<param name="packageIdentity">original package identity</param>
<param name="dependencyGroups">package dependency groups</param>
<param name="frameworkReferenceGroups">Sequence of <see cref="T:NuGet.Packaging.FrameworkSpecificGroup" />s.</param>
</member>
<member name="P:NuGet.Protocol.Core.Types.HttpSourceCacheContext.RootTempFolder">
<summary>
A suggested root folder to drop temporary files under, it will get cleared by the
disposal of the <see cref="P:NuGet.Protocol.Core.Types.HttpSourceCacheContext.SourceCacheContext" /> that was used to create this instance.
</summary>
</member>
<member name="P:NuGet.Protocol.Core.Types.HttpSourceCacheContext.SourceCacheContext">
<summary>
Inner cache context.
</summary>
</member>
<member name="T:NuGet.Protocol.Core.Types.INuGetResource">
<summary>
Represents a resource provided by a server endpoint (V2 or V3).
</summary>
</member>
<member name="T:NuGet.Protocol.Core.Types.INuGetResourceProvider">
<summary>
INuGetResourceProviders are imported by SourceRepository. They exist as singletons which span all sources,
and are responsible
for determining if they should be used for the given source when TryCreate is called.
The provider determines the caching. Resources may be cached per source, but they are normally created new
each time
to allow for caching within the context they were created in.
Providers may retrieve other resources from the source repository and pass them to the resources they
create in order
to build on them.
</summary>
</member>
<member name="M:NuGet.Protocol.Core.Types.INuGetResourceProvider.TryCreate(NuGet.Protocol.Core.Types.SourceRepository,System.Threading.CancellationToken)">
<summary>
Attempts to create a resource for this source.
</summary>
<remarks>
The provider may return true but null for the resource if the
provider determines that it should not exist.
</remarks>
<param name="source">Source repository</param>
<returns>True if this provider handles the input source.</returns>
</member>
<member name="P:NuGet.Protocol.Core.Types.INuGetResourceProvider.ResourceType">
<summary>
Resource type provided
</summary>
</member>
<member name="P:NuGet.Protocol.Core.Types.INuGetResourceProvider.Name">
<summary>
Name of the provider. This is used for ordering.
</summary>
</member>
<member name="P:NuGet.Protocol.Core.Types.INuGetResourceProvider.Before">
<summary>
Names of providers this should be ordered BEFORE
Gives this instance a higher priority.
</summary>
<remarks>If provider: default is named here, this provider will be called BEFORE default</remarks>
</member>
<member name="P:NuGet.Protocol.Core.Types.INuGetResourceProvider.After">
<summary>
Names of providers this should be ordered AFTER.
Gives this instance a lower priority.
</summary>
<remarks>If provider: default is named here, this provider will be called AFTER default</remarks>
</member>
<member name="T:NuGet.Protocol.Core.Types.ISourceRepositoryProvider">
<summary>
SourceRepositoryProvider composes resource providers into source repositories.
</summary>
</member>
<member name="M:NuGet.Protocol.Core.Types.ISourceRepositoryProvider.GetRepositories">
<summary>
Retrieve repositories
</summary>
</member>
<member name="M:NuGet.Protocol.Core.Types.ISourceRepositoryProvider.CreateRepository(NuGet.Configuration.PackageSource)">
<summary>
Create a repository for one time use.
</summary>
</member>
<member name="M:NuGet.Protocol.Core.Types.ISourceRepositoryProvider.CreateRepository(NuGet.Configuration.PackageSource,NuGet.Protocol.FeedType)">
<summary>
Create a repository for one time use.
</summary>
</member>
<member name="P:NuGet.Protocol.Core.Types.ISourceRepositoryProvider.PackageSourceProvider">
<summary>
Gets the package source provider
</summary>
</member>
<member name="T:NuGet.Protocol.Core.Types.IPackageSearchMetadata">
<summary>
Package metadata only containing select fields relevant to search results processing and presenting.
Immutable.
</summary>
</member>
<member name="M:NuGet.Protocol.Core.Types.IPackageSearchMetadata.GetDeprecationMetadataAsync">
<summary>
Gets the deprecation metadata for the package.
</summary>
<remarks>
Deprecation metadata is only available through remote feeds, not local feeds. Some servers do not return deprecation information via
<see cref="T:NuGet.Protocol.Core.Types.PackageSearchResource" /> results, only through <see cref="T:NuGet.Protocol.Core.Types.PackageMetadataResource" /> or <see cref="T:NuGet.Protocol.Core.Types.FindPackageByIdResource" />.
</remarks>
</member>
<member name="M:NuGet.Protocol.Core.Types.IPackageSearchMetadata.GetVersionsAsync">
<summary>
Lists the available versions of the package on the source.
</summary>
</member>
<member name="P:NuGet.Protocol.Core.Types.IPackageSearchMetadata.Vulnerabilities">
<summary>
Gets the vulnerability metadata for the package.
</summary>
<remarks>
Vulnerability metadata is only available through remote feeds, not local feeds. Some servers do not return vulnerability information via
<see cref="T:NuGet.Protocol.Core.Types.PackageSearchResource" /> results, only through <see cref="T:NuGet.Protocol.Core.Types.PackageMetadataResource" /> or <see cref="T:NuGet.Protocol.Core.Types.FindPackageByIdResource" />.
</remarks>
</member>
<member name="T:NuGet.Protocol.Core.Types.PackageSearchMetadataBuilder">
<summary>
Helper class allowing creation/alteration of immutable package metadata objects.
</summary>
</member>
<member name="T:NuGet.Protocol.Core.Types.PackageSearchMetadataExtensions">
<summary>
Shortcut methods to create altered metadata objects with new versions.
</summary>
</member>
<member name="P:NuGet.Protocol.Core.Types.VersionInfo.PackageSearchMetadata">
<summary>
In V2, when finding the list of versions that a package ID has, we also get all of the metadata
associated with each version. It would be wasteful to throw this away, so we store what we have
here. For V3, the metadata property is null. Callers that receive this type need to be able to
fetch this package metadata some other way if this property is null.
</summary>
</member>
<member name="T:NuGet.Protocol.Core.Types.NuGetResourceProviderPositions">
<summary>
Positions to base providers on
</summary>
</member>
<member name="F:NuGet.Protocol.Core.Types.NuGetResourceProviderPositions.First">
<summary>
The first provider called
</summary>
</member>
<member name="F:NuGet.Protocol.Core.Types.NuGetResourceProviderPositions.Last">
<summary>
The last provider called
</summary>
</member>
<member name="M:NuGet.Protocol.Core.Types.NuGetTestMode.InvokeTestFunctionAgainstTestMode``1(System.Func{``0},System.Boolean)">
<summary>
Intended for internal use only: utility method for testing purposes.
</summary>
</member>
<member name="M:NuGet.Protocol.Core.Types.PackageProgressEventArgs.#ctor(NuGet.Packaging.Core.PackageIdentity,NuGet.Configuration.PackageSource,System.Double)">
<summary>
The status of a package action.
</summary>
<param name="identity">package identity</param>
<param name="source">repository source or null</param>
<param name="complete">0.0 - 1.0</param>
</member>
<member name="P:NuGet.Protocol.Core.Types.PackageProgressEventArgs.Complete">
<summary>
Completion - 0.0 - 1.0
</summary>
</member>
<member name="P:NuGet.Protocol.Core.Types.PackageProgressEventArgs.IsComplete">
<summary>
True at 100% completion
</summary>
</member>
<member name="T:NuGet.Protocol.Core.Types.ProviderComparer">
<summary>
An imperfect sort for provider before/after
</summary>
</member>
<member name="T:NuGet.Protocol.Core.Types.PluginResourceProvider">
<summary>
A plugin resource provider.
</summary>
<remarks>This is unsealed only to facilitate testing.</remarks>
</member>
<member name="M:NuGet.Protocol.Core.Types.PluginResourceProvider.TryCreate(NuGet.Protocol.Core.Types.SourceRepository,System.Threading.CancellationToken)">
<summary>
Asynchronously attempts to create a resource for the specified source repository.
</summary>
<param name="source">A source repository.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns a Tuple<bool, INuGetResource></returns>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="source" /> is <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="T:NuGet.Protocol.Core.Types.PluginFindPackageByIdResource">
<summary>
A <see cref="T:NuGet.Protocol.Core.Types.FindPackageByIdResource" /> for plugins.
</summary>
</member>
<member name="M:NuGet.Protocol.Core.Types.PluginFindPackageByIdResource.#ctor(NuGet.Protocol.Plugins.IPlugin,NuGet.Protocol.Plugins.IPluginMulticlientUtilities,NuGet.Configuration.PackageSource)">
<summary>
Instantiates a new <see cref="T:NuGet.Protocol.Core.Types.PluginFindPackageByIdResource" /> class.
</summary>
<param name="plugin">A plugin.</param>
<param name="utilities">A plugin multiclient utilities.</param>
<param name="packageSource">A package source.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="plugin" />
is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="utilities" />
is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="packageSource" />
is <c>null</c>.</exception>
</member>
<member name="M:NuGet.Protocol.Core.Types.PluginFindPackageByIdResource.CopyNupkgToStreamAsync(System.String,NuGet.Versioning.NuGetVersion,System.IO.Stream,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Asynchronously copies a .nupkg to a stream.
</summary>
<param name="id">A package ID.</param>
<param name="version">A package version.</param>
<param name="destination">A destination stream.</param>
<param name="cacheContext">A source cache context.</param>
<param name="logger">A logger.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an
<see cref="T:System.Boolean" /> indicating whether or not the .nupkg file was copied.</returns>
<exception cref="T:System.NotSupportedException">Thrown always.</exception>
</member>
<member name="M:NuGet.Protocol.Core.Types.PluginFindPackageByIdResource.GetPackageDownloaderAsync(NuGet.Packaging.Core.PackageIdentity,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Asynchronously gets a package downloader for a package identity.
</summary>
<param name="packageIdentity">A package identity.</param>
<param name="cacheContext">A source cache context.</param>
<param name="logger">A logger.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an <see cref="T:NuGet.Packaging.IPackageDownloader" />.</returns>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="packageIdentity" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="cacheContext" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="logger" /> <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.Core.Types.PluginFindPackageByIdResource.GetAllVersionsAsync(System.String,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Asynchronously gets all package versions for a package ID.
</summary>
<param name="id">A package ID.</param>
<param name="cacheContext">A source cache context.</param>
<param name="logger">A logger.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an
<see cref="T:System.Collections.Generic.IEnumerable`1" />.</returns>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="id" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="cacheContext" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="logger" /> <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.Core.Types.PluginFindPackageByIdResource.GetDependencyInfoAsync(System.String,NuGet.Versioning.NuGetVersion,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Asynchronously gets dependency information for a specific package.
</summary>
<param name="id">A package id.</param>
<param name="version">A package version.</param>
<param name="cacheContext">A source cache context.</param>
<param name="logger">A logger.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an
<see cref="T:System.Collections.Generic.IEnumerable`1" />.</returns>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="id" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="version" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="cacheContext" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="logger" /> <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.Core.Types.PluginFindPackageByIdResource.DoesPackageExistAsync(System.String,NuGet.Versioning.NuGetVersion,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Asynchronously check if exact package (id/version) exists at this source.
</summary>
<param name="id">A package id.</param>
<param name="version">A package version.</param>
<param name="cacheContext">A source cache context.</param>
<param name="logger">A logger.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an
<see cref="T:System.Collections.Generic.IEnumerable`1" />.</returns>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="id" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="version" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="cacheContext" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="logger" /> <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="T:NuGet.Protocol.Core.Types.RemoteSourceDependencyInfo">
<summary>
A collection of package dependency groups with the content (nupkg url).
</summary>
</member>
<member name="M:NuGet.Protocol.Core.Types.RemoteSourceDependencyInfo.#ctor(NuGet.Packaging.Core.PackageIdentity,System.Boolean,System.Collections.Generic.IEnumerable{NuGet.Packaging.PackageDependencyGroup},System.String)">
<summary>
DependencyInfo
</summary>
<param name="identity">package identity</param>
<param name="dependencyGroups">package dependency groups</param>
<param name="contentUri">The content uri for the dependency.</param>
</member>
<member name="P:NuGet.Protocol.Core.Types.RemoteSourceDependencyInfo.Identity">
<summary>
Package identity
</summary>
</member>
<member name="P:NuGet.Protocol.Core.Types.RemoteSourceDependencyInfo.Listed">
<summary>
IsListed
</summary>
</member>
<member name="P:NuGet.Protocol.Core.Types.RemoteSourceDependencyInfo.DependencyGroups">
<summary>
Package dependency groups
</summary>
</member>
<member name="P:NuGet.Protocol.Core.Types.RemoteSourceDependencyInfo.ContentUri">
<summary>
The content url of this resource.
</summary>
</member>
<member name="M:NuGet.Protocol.Core.Types.Repository.CreateProvider(System.Collections.Generic.IEnumerable{NuGet.Protocol.Core.Types.INuGetResourceProvider})">
<summary>
Create the default source repository provider
</summary>
</member>
<member name="M:NuGet.Protocol.Core.Types.Repository.CreateProvider(System.Collections.Generic.IEnumerable{NuGet.Protocol.Core.Types.INuGetResourceProvider},System.String)">
<summary>
Find sources from nuget.config based on the root path
</summary>
<param name="rootPath">lowest folder path</param>
</member>
<member name="M:NuGet.Protocol.Core.Types.Repository.CreateSource(System.Collections.Generic.IEnumerable{System.Lazy{NuGet.Protocol.Core.Types.INuGetResourceProvider}},System.String)">
<summary>
Create a SourceRepository
</summary>
</member>
<member name="M:NuGet.Protocol.Core.Types.Repository.CreateSource(System.Collections.Generic.IEnumerable{System.Lazy{NuGet.Protocol.Core.Types.INuGetResourceProvider}},System.String,NuGet.Protocol.FeedType)">
<summary>
Create a SourceRepository
</summary>
</member>
<member name="M:NuGet.Protocol.Core.Types.Repository.CreateSource(System.Collections.Generic.IEnumerable{System.Lazy{NuGet.Protocol.Core.Types.INuGetResourceProvider}},NuGet.Configuration.PackageSource)">
<summary>
Create a SourceRepository
</summary>
</member>
<member name="M:NuGet.Protocol.Core.Types.Repository.CreateSource(System.Collections.Generic.IEnumerable{System.Lazy{NuGet.Protocol.Core.Types.INuGetResourceProvider}},NuGet.Configuration.PackageSource,NuGet.Protocol.FeedType)">
<summary>
Create a SourceRepository
</summary>
</member>
<member name="M:NuGet.Protocol.Core.Types.ResourceProvider.#ctor(System.Type,System.String,System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String})">
<summary>
</summary>
<param name="resourceType">Type this resource provider creates</param>
<param name="name">name used for ordering</param>
<param name="before">providers that this provider should have precendence over</param>
<param name="after">providers that this provider should be called after</param>
</member>
<member name="T:NuGet.Protocol.Core.Types.DependencyInfoResource">
<summary>
Provides methods for resolving a package and its dependencies. This might change based on the new
dependency resolver.
</summary>
</member>
<member name="M:NuGet.Protocol.Core.Types.DependencyInfoResource.ResolvePackage(NuGet.Packaging.Core.PackageIdentity,NuGet.Frameworks.NuGetFramework,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Retrieve dependency info for a single package.
</summary>
<param name="package">package id and version</param>
<param name="projectFramework">project target framework. This is used for finding the dependency group</param>
<param name="token">cancellation token</param>
<returns>
Returns dependency info for the given package if it exists. If the package is not found null is
returned.
</returns>
</member>
<member name="M:NuGet.Protocol.Core.Types.DependencyInfoResource.ResolvePackages(System.String,NuGet.Frameworks.NuGetFramework,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Retrieve the available packages and their dependencies.
</summary>
<remarks>Includes prerelease packages</remarks>
<param name="packageId">package Id to search</param>
<param name="projectFramework">project target framework. This is used for finding the dependency group</param>
<param name="token">cancellation token</param>
<returns>available packages and their dependencies</returns>
</member>
<member name="M:NuGet.Protocol.Core.Types.DependencyInfoResource.ResolvePackages(System.String,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Retrieve the available packages and their dependencies.
</summary>
<remarks>Includes prerelease packages</remarks>
<param name="packageId">package Id to search</param>
<param name="token">cancellation token</param>
<returns>available packages and their dependencies</returns>
</member>
<member name="T:NuGet.Protocol.Core.Types.DownloadResource">
<summary>
Finds the download url of a nupkg
</summary>
</member>
<member name="M:NuGet.Protocol.Core.Types.DownloadResource.GetDownloadResourceResultAsync(NuGet.Packaging.Core.PackageIdentity,NuGet.Protocol.Core.Types.PackageDownloadContext,System.String,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Downloads a package .nupkg with the provided identity. If the package is not available
on the source but the source itself is not down or unavailable, the
<see cref="P:NuGet.Protocol.Core.Types.DownloadResourceResult.Status" /> will be <see cref="F:NuGet.Protocol.Core.Types.DownloadResourceResultStatus.NotFound" />.
If the operation was cancelled, the <see cref="P:NuGet.Protocol.Core.Types.DownloadResourceResult.Status" /> will be
<see cref="F:NuGet.Protocol.Core.Types.DownloadResourceResultStatus.Cancelled" />.
</summary>
</member>
<member name="T:NuGet.Protocol.Core.Types.FindPackageByIdResource">
<summary>
A resource capable of fetching packages, package versions and package dependency information.
</summary>
</member>
<member name="M:NuGet.Protocol.Core.Types.FindPackageByIdResource.GetAllVersionsAsync(System.String,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Asynchronously gets all package versions for a package ID.
</summary>
<param name="id">A package ID.</param>
<param name="cacheContext">A source cache context.</param>
<param name="logger">A logger.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an
<see cref="T:System.Collections.Generic.IEnumerable`1" />.</returns>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="id" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="cacheContext" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="logger" /> <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.Core.Types.FindPackageByIdResource.GetDependencyInfoAsync(System.String,NuGet.Versioning.NuGetVersion,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Asynchronously gets dependency information for a specific package.
</summary>
<param name="id">A package id.</param>
<param name="version">A package version.</param>
<param name="cacheContext">A source cache context.</param>
<param name="logger">A logger.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an
<see cref="T:System.Collections.Generic.IEnumerable`1" />.</returns>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="id" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="version" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="cacheContext" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="logger" /> <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.Core.Types.FindPackageByIdResource.CopyNupkgToStreamAsync(System.String,NuGet.Versioning.NuGetVersion,System.IO.Stream,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Asynchronously copies a .nupkg to a stream.
</summary>
<param name="id">A package ID.</param>
<param name="version">A package version.</param>
<param name="destination">A destination stream.</param>
<param name="cacheContext">A source cache context.</param>
<param name="logger">A logger.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an
<see cref="T:System.Boolean" /> indicating whether or not the .nupkg file was copied.</returns>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="id" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="version" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="destination" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="cacheContext" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="logger" /> <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.Core.Types.FindPackageByIdResource.GetPackageDownloaderAsync(NuGet.Packaging.Core.PackageIdentity,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Asynchronously gets a package downloader for a package identity.
</summary>
<param name="packageIdentity">A package identity.</param>
<param name="cacheContext">A source cache context.</param>
<param name="logger">A logger.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an <see cref="T:NuGet.Packaging.IPackageDownloader" />.</returns>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="packageIdentity" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="cacheContext" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="logger" /> <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.Core.Types.FindPackageByIdResource.DoesPackageExistAsync(System.String,NuGet.Versioning.NuGetVersion,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Asynchronously check if exact package (id/version) exists at this source.
</summary>
<param name="id">A package id.</param>
<param name="version">A package version.</param>
<param name="cacheContext">A source cache context.</param>
<param name="logger">A logger.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an
<see cref="T:System.Collections.Generic.IEnumerable`1" />.</returns>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="id" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="version" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="cacheContext" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="logger" /> <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.Core.Types.FindPackageByIdResource.GetDependencyInfo(NuGet.Packaging.NuspecReader)">
<summary>
Read dependency info from a nuspec.
</summary>
<remarks>This also verifies minClientVersion.</remarks>
</member>
<member name="T:NuGet.Protocol.Core.Types.HttpHandlerResource">
<summary>
An HttpClient configured for the package source
</summary>
</member>
<member name="P:NuGet.Protocol.Core.Types.HttpHandlerResource.ClientHandler">
<summary>
HttpClientHandler used for credential support.
</summary>
</member>
<member name="P:NuGet.Protocol.Core.Types.HttpHandlerResource.MessageHandler">
<summary>
Message handler containing the ClientHandler.
</summary>
</member>
<member name="T:NuGet.Protocol.Core.Types.LegacyFeedCapabilityResource">
<summary>
A resource for detecting the capabilities of a V2 feed.
</summary>
</member>
<member name="T:NuGet.Protocol.Core.Types.MetadataResource">
<summary>
Basic metadata
</summary>
</member>
<member name="M:NuGet.Protocol.Core.Types.MetadataResource.GetVersions(System.String,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Get all versions of a package
</summary>
</member>
<member name="M:NuGet.Protocol.Core.Types.MetadataResource.GetVersions(System.String,System.Boolean,System.Boolean,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Get all versions of a package
</summary>
</member>
<member name="M:NuGet.Protocol.Core.Types.MetadataResource.Exists(NuGet.Packaging.Core.PackageIdentity,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
True if the package exists in the source
Includes unlisted.
</summary>
</member>
<member name="M:NuGet.Protocol.Core.Types.MetadataResource.Exists(NuGet.Packaging.Core.PackageIdentity,System.Boolean,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
True if the package exists in the source
</summary>
</member>
<member name="M:NuGet.Protocol.Core.Types.PackageMetadataResource.GetMetadataAsync(System.String,System.Boolean,System.Boolean,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Returns all versions of a package
</summary>
</member>
<member name="M:NuGet.Protocol.Core.Types.PackageMetadataResource.GetMetadataAsync(NuGet.Packaging.Core.PackageIdentity,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Return package metadata for the input PackageIdentity
</summary>
</member>
<member name="M:NuGet.Protocol.Core.Types.PackageSearchResource.SearchAsync(System.String,NuGet.Protocol.Core.Types.SearchFilter,System.Int32,System.Int32,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Retrieves search results
</summary>
</member>
<member name="T:NuGet.Protocol.Core.Types.PackageUpdateResource">
<summary>
Contains logics to push or delete packages in Http server or file system
</summary>
</member>
<member name="F:NuGet.Protocol.Core.Types.PackageUpdateResource.TempApiKeyServiceEndpoint">
<summary>
Create temporary verification api key endpoint: "create-verification-key/[package id]/[package version]"
</summary>
</member>
<member name="M:NuGet.Protocol.Core.Types.PackageUpdateResource.PushPackagePath(System.String,System.String,System.String,System.String,System.Func{System.String,System.String},System.Boolean,System.Boolean,NuGet.Protocol.Core.Types.SymbolPackageUpdateResourceV3,System.TimeSpan,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Push nupkgs, and if successful, push any corresponding symbols.
</summary>
<exception cref="T:System.ArgumentException">Thrown when any resolved file path does not exist.</exception>
</member>
<member name="M:NuGet.Protocol.Core.Types.PackageUpdateResource.GetSymbolsPath(System.String,System.Boolean)">
<summary>
Get the symbols package from the original package. Removes the .nupkg and adds .snupkg or .symbols.nupkg.
</summary>
</member>
<member name="M:NuGet.Protocol.Core.Types.PackageUpdateResource.PushPackageToServer(System.String,System.String,System.String,System.Boolean,System.Boolean,System.TimeSpan,System.Boolean,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Pushes a package to the Http server.
</summary>
<returns>Indicator of whether to show PushCommandPackagePushed message.</returns>
</member>
<member name="M:NuGet.Protocol.Core.Types.PackageUpdateResource.EnsureSuccessStatusCode(System.Net.Http.HttpResponseMessage,System.Nullable{System.Net.HttpStatusCode},NuGet.Common.ILogger)">
<summary>
Ensures a Success HTTP Status Code is returned unless a specified exclusion occurred. If CodeNotToThrow is provided and the response contains
this code, do not EnsureSuccess and instead return the exception code gracefully.
</summary>
<param name="response"></param>
<param name="codeNotToThrow"></param>
<param name="logger"></param>
<returns>Response StatusCode</returns>
</member>
<member name="M:NuGet.Protocol.Core.Types.PackageUpdateResource.DetectAndLogSkippedErrorOccurrence(System.Nullable{System.Net.HttpStatusCode},System.String,System.String,System.String,NuGet.Common.ILogger)">
<summary>
Gently log any specified Skipped status code without throwing.
</summary>
<param name="skippedErrorStatusCode">If provided, it indicates that this StatusCode occurred but was flagged as to be Skipped.</param>
<param name="source"></param>
<param name="packageIdentity"></param>
<param name="reasonMessage"></param>
<param name="logger"></param>
<returns>Indication of whether the log occurred.</returns>
</member>
<member name="M:NuGet.Protocol.Core.Types.PackageUpdateResource.AdvertiseAvailableOptionToIgnore(System.Net.HttpStatusCode,NuGet.Common.ILogger)">
<summary>
If we provide such option, output a help message that explains that the error that occurred can be ignored by using it.
</summary>
<param name="errorCodeThatOccurred">Error to check for a relevant option to advertise to the user. </param>
<param name="logger"></param>
</member>
<member name="T:NuGet.Protocol.Core.Types.PluginResource">
<summary>
Represents a plugin resource.
</summary>
</member>
<member name="M:NuGet.Protocol.Core.Types.PluginResource.#ctor(System.Collections.Generic.IEnumerable{NuGet.Protocol.Plugins.PluginCreationResult},NuGet.Configuration.PackageSource,NuGet.Configuration.ICredentialService)">
<summary>
Instantiates a new <see cref="T:NuGet.Protocol.Core.Types.PluginResource" /> class.
</summary>
<param name="pluginCreationResults">Plugin creation results.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="pluginCreationResults" />
is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="packageSource" />
is <c>null</c>.</exception>
</member>
<member name="M:NuGet.Protocol.Core.Types.PluginResource.GetPluginAsync(NuGet.Protocol.Plugins.OperationClaim,System.Threading.CancellationToken)">
<summary>
Gets the first plugin satisfying the required operation claims for the current package source.
</summary>
<param name="requiredClaim">The required operation claim.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns a <see cref="T:NuGet.Protocol.Core.Types.PluginResource.GetPluginResult" />.</returns>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="T:NuGet.Protocol.Core.Types.SymbolPackageUpdateResourceV3">
<summary>
Contains logics to push symbol packages in Http server or file system
</summary>
</member>
<member name="T:NuGet.Protocol.Core.Types.SearchFilter">
<summary>
A search filter context that represents the UI settings
</summary>
</member>
<member name="M:NuGet.Protocol.Core.Types.SearchFilter.#ctor(System.Boolean)">
<summary>
Initializes an instance of a <see cref="T:NuGet.Protocol.Core.Types.SearchFilter" /> and validates required parameters.
</summary>
<param name="includePrerelease">Whether or not to allow prerelease results.</param>
</member>
<member name="M:NuGet.Protocol.Core.Types.SearchFilter.#ctor(System.Boolean,System.Nullable{NuGet.Protocol.Core.Types.SearchFilterType})">
<summary>
Initializes an instance of a <see cref="T:NuGet.Protocol.Core.Types.SearchFilter" /> and validates required parameters.
</summary>
<param name="includePrerelease">Whether or not to allow prerelease results.</param>
<param name="filter">The filter to apply to the results.</param>
</member>
<member name="P:NuGet.Protocol.Core.Types.SearchFilter.SupportedFrameworks">
<summary>
Filter to only the list of packages compatible with these frameworks.
</summary>
</member>
<member name="P:NuGet.Protocol.Core.Types.SearchFilter.IncludePrerelease">
<summary>
Include prerelease packages in search
</summary>
</member>
<member name="P:NuGet.Protocol.Core.Types.SearchFilter.IncludeDelisted">
<summary>
Include unlisted packages in search
</summary>
</member>
<member name="P:NuGet.Protocol.Core.Types.SearchFilter.PackageTypes">
<summary>
Restrict the search to certain package types.
</summary>
</member>
<member name="P:NuGet.Protocol.Core.Types.SearchFilter.Filter">
<summary>
The optional filter type. Absense of this value indicates that all versions should be returned.
</summary>
</member>
<member name="P:NuGet.Protocol.Core.Types.SearchFilter.OrderBy">
<summary>
The optional order by. Absense of this value indicates that search results should be ordered by relevance.
</summary>
</member>
<member name="T:NuGet.Protocol.Core.Types.SearchFilterType">
<summary>
The type of filter to apply to the search.
</summary>
<remarks>
Here are some examples to clarify what these filters mean. Suppose the very latest version is prerelease.
Version | Prerelease | IsLatestVersion | IsAbsoluteLatestVersion
------------|------------|-----------------|------------------------
8.0.1-beta1 | true | false | false
8.0.3 | false | false | false
9.0.1 | false | true | false
9.0.2-beta1 | true | false | true
Suppose the very latest version is not prerelease. Notice the latest version is also the absolute latest
version. In other words, a prerelease package cannot be a latest version but a non-prerelease package can be
both the latest version and the absolute latest version.
Version | Prerelease | IsLatestVersion | IsAbsoluteLatestVersion
------------|------------|-----------------|------------------------
8.0.1-beta1 | true | false | false
8.0.3 | false | false | false
9.0.1 | false | true | true
Suppose there are only prerelease versions. Notice there are no package that has IsLatestVersion as true.
Version | Prerelease | IsLatestVersion | IsAbsoluteLatestVersion
------------|------------|-----------------|------------------------
8.0.1-beta1 | true | false | false
9.0.2-beta1 | true | false | true
</remarks>
</member>
<member name="F:NuGet.Protocol.Core.Types.SearchFilterType.IsLatestVersion">
<summary>
Only select the latest stable version of a package per package ID. Given the server supports
<see cref="F:NuGet.Protocol.Core.Types.SearchFilterType.IsAbsoluteLatestVersion" />, a package that is <see cref="F:NuGet.Protocol.Core.Types.SearchFilterType.IsLatestVersion" /> should never be
prerelease. Also, it does not make sense to look for a <see cref="F:NuGet.Protocol.Core.Types.SearchFilterType.IsLatestVersion" /> package when also
including prerelease.
</summary>
</member>
<member name="F:NuGet.Protocol.Core.Types.SearchFilterType.IsAbsoluteLatestVersion">
<summary>
Only select the absolute latest version of a package per package ID. It does not make sense to look for a
<see cref="F:NuGet.Protocol.Core.Types.SearchFilterType.IsAbsoluteLatestVersion" /> when excluding prerelease.
</summary>
</member>
<member name="F:NuGet.Protocol.Core.Types.SearchOrderBy.Id">
<summary>
Order the resulting packages by package ID.
</summary>
</member>
<member name="T:NuGet.Protocol.Core.Types.SourceCacheContext">
<summary>
Cache control settings for the V3 disk cache.
</summary>
</member>
<member name="F:NuGet.Protocol.Core.Types.SourceCacheContext._generatedTempFolder">
<summary>
Path of temp folder if requested by GeneratedTempFolder
</summary>
</member>
<member name="F:NuGet.Protocol.Core.Types.SourceCacheContext.DefaultMaxAge">
<summary>
Default amount of time to cache version lists.
</summary>
</member>
<member name="P:NuGet.Protocol.Core.Types.SourceCacheContext.NoCache">
<summary>
If set, the global disk cache will not be written to or read from. Instead, a temporary directory will be
used.
</summary>
</member>
<member name="P:NuGet.Protocol.Core.Types.SourceCacheContext.DirectDownload">
<summary>
If set, the global disk cache will not be written to.
</summary>
</member>
<member name="P:NuGet.Protocol.Core.Types.SourceCacheContext.MaxAge">
<summary>
Package version lists or packages from the server older than this date will be fetched from the server.
</summary>
<remarks>This will be ignored if <see cref="P:NuGet.Protocol.Core.Types.SourceCacheContext.NoCache" /> is true.</remarks>
<remarks>If the value is null the default expiration will be used.</remarks>
</member>
<member name="P:NuGet.Protocol.Core.Types.SourceCacheContext.RefreshMemoryCache">
<summary>
Force the in-memory cache to reload. This avoids allowing other calls to populate
the memory cache again from cached files on disk using a different source context.
This should only be used for retries.
</summary>
</member>
<member name="P:NuGet.Protocol.Core.Types.SourceCacheContext.SessionId">
<summary>
X-NUGET-SESSION
This should be unique for each package operation.
</summary>
</member>
<member name="P:NuGet.Protocol.Core.Types.SourceCacheContext.MaxAgeTimeSpan">
<summary>
Package version lists from the server older than this time span
will be fetched from the server.
</summary>
</member>
<member name="M:NuGet.Protocol.Core.Types.SourceCacheContext.Clone">
<summary>
Clones the current SourceCacheContext.
</summary>
</member>
<member name="M:NuGet.Protocol.Core.Types.SourceCacheContext.WithRefreshCacheTrue">
<summary>
Clones the current cache context and does the following:
1. Sets MaxAge to Now
2. RefreshMemoryCache to true
</summary>
</member>
<member name="P:NuGet.Protocol.Core.Types.SourcePackageDependencyInfo.Listed">
<summary>
True if the package is listed and shown in search.
</summary>
<remarks>This property only applies to online sources.</remarks>
</member>
<member name="P:NuGet.Protocol.Core.Types.SourcePackageDependencyInfo.Source">
<summary>
Source repository the dependency information was retrieved from.
</summary>
</member>
<member name="P:NuGet.Protocol.Core.Types.SourcePackageDependencyInfo.DownloadUri">
<summary>
The HTTP, UNC, or local file URI to the package nupkg.
</summary>
<remarks>Optional</remarks>
</member>
<member name="P:NuGet.Protocol.Core.Types.SourcePackageDependencyInfo.PackageHash">
<summary>
Package hash
</summary>
<remarks>Optional</remarks>
</member>
<member name="T:NuGet.Protocol.Core.Types.SourceRepository">
<summary>
Represents a Server endpoint. Exposes methods to get a specific resource such as Search, Metrics service
and so on for the given server endpoint.
</summary>
</member>
<member name="P:NuGet.Protocol.Core.Types.SourceRepository.FeedTypeOverride">
<summary>
Pre-determined feed type.
</summary>
</member>
<member name="M:NuGet.Protocol.Core.Types.SourceRepository.#ctor(NuGet.Configuration.PackageSource,System.Collections.Generic.IEnumerable{NuGet.Protocol.Core.Types.INuGetResourceProvider})">
<summary>
Source Repository
</summary>
<param name="source">source url</param>
<param name="providers">Resource providers</param>
</member>
<member name="M:NuGet.Protocol.Core.Types.SourceRepository.#ctor(NuGet.Configuration.PackageSource,System.Collections.Generic.IEnumerable{System.Lazy{NuGet.Protocol.Core.Types.INuGetResourceProvider}})">
<summary>
Source Repository
</summary>
<param name="source">source url</param>
<param name="providers">Resource providers</param>
</member>
<member name="M:NuGet.Protocol.Core.Types.SourceRepository.#ctor(NuGet.Configuration.PackageSource,System.Collections.Generic.IEnumerable{System.Lazy{NuGet.Protocol.Core.Types.INuGetResourceProvider}},NuGet.Protocol.FeedType)">
<summary>
Source Repository
</summary>
<param name="source">source url</param>
<param name="providers">Resource providers</param>
<param name="feedTypeOverride">Restrict the source to this feed type.</param>
</member>
<member name="M:NuGet.Protocol.Core.Types.SourceRepository.#ctor">
<summary>
Internal default constructor
</summary>
</member>
<member name="P:NuGet.Protocol.Core.Types.SourceRepository.PackageSource">
<summary>
Package source
</summary>
</member>
<member name="M:NuGet.Protocol.Core.Types.SourceRepository.GetFeedType(System.Threading.CancellationToken)">
<summary>
Find the FeedType of the source. If overridden FeedTypeOverride is returned.
</summary>
</member>
<member name="M:NuGet.Protocol.Core.Types.SourceRepository.GetResource``1">
<summary>
Returns a resource from the SourceRepository if it exists.
</summary>
<typeparam name="T">Expected resource type</typeparam>
<returns>Null if the resource does not exist</returns>
</member>
<member name="M:NuGet.Protocol.Core.Types.SourceRepository.GetResource``1(System.Threading.CancellationToken)">
<summary>
Returns a resource from the SourceRepository if it exists.
</summary>
<typeparam name="T">Expected resource type</typeparam>
<returns>Null if the resource does not exist</returns>
</member>
<member name="M:NuGet.Protocol.Core.Types.SourceRepository.GetResourceAsync``1">
<summary>
Returns a resource from the SourceRepository if it exists.
</summary>
<typeparam name="T">Expected resource type</typeparam>
<returns>Null if the resource does not exist</returns>
</member>
<member name="M:NuGet.Protocol.Core.Types.SourceRepository.GetResourceAsync``1(System.Threading.CancellationToken)">
<summary>
Returns a resource from the SourceRepository if it exists.
</summary>
<typeparam name="T">Expected resource type</typeparam>
<returns>Null if the resource does not exist</returns>
</member>
<member name="M:NuGet.Protocol.Core.Types.SourceRepository.Init(System.Collections.Generic.IEnumerable{System.Lazy{NuGet.Protocol.Core.Types.INuGetResourceProvider}})">
<summary>
Initialize provider cache
</summary>
<param name="providers"></param>
<returns></returns>
</member>
<member name="M:NuGet.Protocol.Core.Types.SourceRepository.GetFeedType(NuGet.Configuration.PackageSource)">
<summary>
Get the feed type from the package source.
</summary>
</member>
<member name="T:NuGet.Protocol.Core.Types.SourceRepositoryProvider">
<summary>
SourceRepositoryProvider is the high level source for repository objects representing package sources.
</summary>
</member>
<member name="M:NuGet.Protocol.Core.Types.SourceRepositoryProvider.#ctor(NuGet.Configuration.IPackageSourceProvider,System.Collections.Generic.IEnumerable{System.Lazy{NuGet.Protocol.Core.Types.INuGetResourceProvider}})">
<summary>
Non-MEF constructor
</summary>
</member>
<member name="M:NuGet.Protocol.Core.Types.SourceRepositoryProvider.GetRepositories">
<summary>
Retrieve repositories
</summary>
<returns></returns>
</member>
<member name="M:NuGet.Protocol.Core.Types.SourceRepositoryProvider.CreateRepository(NuGet.Configuration.PackageSource)">
<summary>
Create a repository for one time use.
</summary>
</member>
<member name="M:NuGet.Protocol.Core.Types.SourceRepositoryProvider.CreateRepository(NuGet.Configuration.PackageSource,NuGet.Protocol.FeedType)">
<summary>
Create a repository for one time use.
</summary>
</member>
<member name="M:NuGet.Protocol.Core.Types.UserAgent.SetUserAgent(System.Net.Http.HttpClient)">
<summary>
Set user agent string on HttpClient to the static string.
</summary>
<param name="client">Http client</param>
</member>
<member name="T:NuGet.Protocol.EnhancedHttpRetryHelper">
<summary>
Represents a helper class for determining if enhanced retry is enabled and what settings to use.
</summary>
</member>
<member name="F:NuGet.Protocol.EnhancedHttpRetryHelper.DefaultDelayMilliseconds">
<summary>
The default delay in milliseconds between retries.
</summary>
</member>
<member name="F:NuGet.Protocol.EnhancedHttpRetryHelper.DefaultEnabled">
<summary>
The default value indicating whether or not enhanced HTTP retry is enabled.
</summary>
</member>
<member name="F:NuGet.Protocol.EnhancedHttpRetryHelper.DefaultRetryCount">
<summary>
The default number of times to retry.
</summary>
</member>
<member name="F:NuGet.Protocol.EnhancedHttpRetryHelper.DelayInMillisecondsEnvironmentVariableName">
<summary>
The environment variable used to change the delay value.
</summary>
</member>
<member name="F:NuGet.Protocol.EnhancedHttpRetryHelper.IsEnabledEnvironmentVariableName">
<summary>
The environment variable used to enable or disable the enhanced HTTP retry.
</summary>
</member>
<member name="F:NuGet.Protocol.EnhancedHttpRetryHelper.RetryCountEnvironmentVariableName">
<summary>
The environment variable used to change the retry value.
</summary>
</member>
<member name="M:NuGet.Protocol.EnhancedHttpRetryHelper.#ctor(NuGet.Common.IEnvironmentVariableReader)">
<summary>
Initializes a new instance of the <see cref="T:NuGet.Protocol.EnhancedHttpRetryHelper" /> class.
</summary>
<param name="environmentVariableReader">A <see cref="T:NuGet.Common.IEnvironmentVariableReader" /> to use when reading environment variables.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="environmentVariableReader" /> is <c>null</c>.</exception>
</member>
<member name="P:NuGet.Protocol.EnhancedHttpRetryHelper.IsEnabled">
<summary>
Gets a value indicating whether or not enhanced HTTP retry should be enabled. The default value is <c>true</c>.
</summary>
</member>
<member name="P:NuGet.Protocol.EnhancedHttpRetryHelper.RetryCount">
<summary>
Gets a value indicating the maximum number of times to retry. The default value is 6.
</summary>
</member>
<member name="P:NuGet.Protocol.EnhancedHttpRetryHelper.DelayInMilliseconds">
<summary>
Gets a value indicating the delay in milliseconds to wait before retrying a connection. The default value is 1000.
</summary>
</member>
<member name="M:NuGet.Protocol.EnhancedHttpRetryHelper.GetBoolFromEnvironmentVariable(System.String,System.Boolean,NuGet.Common.IEnvironmentVariableReader)">
<summary>
Gets a <see cref="T:System.Boolean" /> value from the specified environment variable.
</summary>
<param name="variableName">The name of the environment variable to get the value.</param>
<param name="defaultValue">The default value to return if the environment variable is not defined or is not a valid <see cref="T:System.Boolean" />.</param>
<param name="environmentVariableReader">An <see cref="T:NuGet.Common.IEnvironmentVariableReader" /> to use when reading the environment variable.</param>
<returns>The value of the specified as a <see cref="T:System.Boolean" /> if the specified environment variable is defined and is a valid value for <see cref="T:System.Boolean" />.</returns>
</member>
<member name="M:NuGet.Protocol.EnhancedHttpRetryHelper.GetIntFromEnvironmentVariable(System.String,System.Int32,NuGet.Common.IEnvironmentVariableReader)">
<summary>
Gets an <see cref="T:System.Int32" /> value from the specified environment variable.
</summary>
<param name="variableName">The name of the environment variable to get the value.</param>
<param name="defaultValue">The default value to return if the environment variable is not defined or is not a valid <see cref="T:System.Int32" />.</param>
<param name="environmentVariableReader">An <see cref="T:NuGet.Common.IEnvironmentVariableReader" /> to use when reading the environment variable.</param>
<returns>The value of the specified as a <see cref="T:System.Int32" /> if the specified environment variable is defined and is a valid value for <see cref="T:System.Int32" />.</returns>
</member>
<member name="T:NuGet.Protocol.InvalidCacheProtocolException">
<summary>
Failure due to an invalid cache.
</summary>
</member>
<member name="T:NuGet.Protocol.PackageNotFoundProtocolException">
<summary>
Thrown when a package cannot be found on a feed.
</summary>
</member>
<member name="P:NuGet.Protocol.PackageNotFoundProtocolException.PackageIdentity">
<summary>
Package that was not found.
</summary>
</member>
<member name="M:NuGet.Protocol.VisualStudio.FactoryExtensionsVS.GetVisualStudio(NuGet.Protocol.Core.Types.Repository.ProviderFactory)">
<summary>
Core V2 + Core V3 + VS
</summary>
</member>
<member name="F:NuGet.Protocol.FeedType.Undefined">
<summary>
Undetermined type
</summary>
</member>
<member name="F:NuGet.Protocol.FeedType.HttpV2">
<summary>
V2 OData protocol, ex: https://www.nuget.org/api/v2/
</summary>
</member>
<member name="F:NuGet.Protocol.FeedType.HttpV3">
<summary>
V3 Json protocol, ex: https://api.nuget.org/v3/index.json
</summary>
</member>
<member name="F:NuGet.Protocol.FeedType.FileSystemV2">
<summary>
Flat folder of nupkgs
</summary>
</member>
<member name="F:NuGet.Protocol.FeedType.FileSystemV3">
<summary>
Version folder structure used for project.json
</summary>
</member>
<member name="F:NuGet.Protocol.FeedType.FileSystemUnzipped">
<summary>
Unzipped folder of nupkgs used by project templates
</summary>
</member>
<member name="F:NuGet.Protocol.FeedType.FileSystemPackagesConfig">
<summary>
Packages.config packages folder format
</summary>
</member>
<member name="F:NuGet.Protocol.FeedType.FileSystemUnknown">
<summary>
Undetermined folder type. Occurs when the folder is empty
or does not exist yet.
</summary>
</member>
<member name="T:NuGet.Protocol.FeedTypePackageSource">
<summary>
PackageSource that can carry a feed type used to override the source repository and provide a
hint for the expected type.
</summary>
</member>
<member name="P:NuGet.Protocol.FeedTypePackageSource.FeedType">
<summary>
Feed type, ex: HttpV2, FileSystemV3
</summary>
</member>
<member name="T:NuGet.Protocol.FeedTypeResource">
<summary>
Resource wrapper for FeedType.
</summary>
</member>
<member name="T:NuGet.Protocol.AmbientAuthenticationState">
<summary>
Represents source authentication status per active operation
</summary>
</member>
<member name="T:NuGet.Protocol.DownloadTimeoutStreamContent">
<summary>
A wrapper around <see cref="T:System.Net.Http.StreamContent" /> that applies a <see cref="T:NuGet.Protocol.DownloadTimeoutStream" />
to the contained stream. When the <see cref="T:System.Net.Http.HttpResponseMessage" /> is disposed, this
content is disposed which in turn disposes the <see cref="T:NuGet.Protocol.DownloadTimeoutStream" />, which
disposes the actual network stream.
</summary>
</member>
<member name="T:NuGet.Protocol.HttpHandlerResourceV3">
<summary>
Resource wrapper for an HttpClient
</summary>
</member>
<member name="P:NuGet.Protocol.HttpHandlerResourceV3.CredentialsSuccessfullyUsed">
<summary>
Gets or sets a delegate that is to be invoked when authenticated feed credentials are successfully
used.
</summary>
</member>
<member name="M:NuGet.Protocol.HttpRequestMessageExtensions.Clone(System.Net.Http.HttpRequestMessage)">
<summary>
Clones an <see cref="T:System.Net.Http.HttpRequestMessage" /> request.
</summary>
</member>
<member name="M:NuGet.Protocol.HttpRequestMessageExtensions.GetOrCreateConfiguration(System.Net.Http.HttpRequestMessage)">
<summary>
Retrieves the HTTP request configuration instance attached to the given message as custom property.
</summary>
<param name="request">The HTTP request message.</param>
<returns>Configuration instance if exists, or a default instance otherwise.</returns>
</member>
<member name="M:NuGet.Protocol.HttpRequestMessageExtensions.SetConfiguration(System.Net.Http.HttpRequestMessage,NuGet.Protocol.HttpRequestMessageConfiguration)">
<summary>
Attaches an HTTP request configuration instance to the given message as custom property.
If the configuration has already been set on the request message, the old configuration
is replaced.
</summary>
<param name="request">The HTTP request message.</param>
<param name="configuration">An HTTP request message configuration instance.</param>
</member>
<member name="T:NuGet.Protocol.HttpRequestMessageFactory">
<summary>
Factory class containing methods facilitating creation of <see cref="T:System.Net.Http.HttpRequestMessage" />
with additional custom parameters.
</summary>
</member>
<member name="M:NuGet.Protocol.HttpRequestMessageFactory.Create(System.Net.Http.HttpMethod,System.String,NuGet.Common.ILogger)">
<summary>
Creates an instance of <see cref="T:System.Net.Http.HttpRequestMessage" />.
</summary>
<param name="method">Desired HTTP verb</param>
<param name="requestUri">Request URI</param>
<param name="log">Logger instance to be attached</param>
<returns>Instance of <see cref="T:System.Net.Http.HttpRequestMessage" /></returns>
</member>
<member name="M:NuGet.Protocol.HttpRequestMessageFactory.Create(System.Net.Http.HttpMethod,System.Uri,NuGet.Common.ILogger)">
<summary>
Creates an instance of <see cref="T:System.Net.Http.HttpRequestMessage" />.
</summary>
<param name="method">Desired HTTP verb</param>
<param name="requestUri">Request URI</param>
<param name="log">Logger instance to be attached</param>
<returns>Instance of <see cref="T:System.Net.Http.HttpRequestMessage" /></returns>
</member>
<member name="M:NuGet.Protocol.HttpRequestMessageFactory.Create(System.Net.Http.HttpMethod,System.String,NuGet.Protocol.HttpRequestMessageConfiguration)">
<summary>
Creates an instance of <see cref="T:System.Net.Http.HttpRequestMessage" />.
</summary>
<param name="method">Desired HTTP verb</param>
<param name="requestUri">Request URI</param>
<param name="configuration">The request configuration</param>
<returns>Instance of <see cref="T:System.Net.Http.HttpRequestMessage" /></returns>
</member>
<member name="M:NuGet.Protocol.HttpRequestMessageFactory.Create(System.Net.Http.HttpMethod,System.Uri,NuGet.Protocol.HttpRequestMessageConfiguration)">
<summary>
Creates an instance of <see cref="T:System.Net.Http.HttpRequestMessage" />.
</summary>
<param name="method">Desired HTTP verb</param>
<param name="requestUri">Request URI</param>
<param name="configuration">The request configuration</param>
<returns>Instance of <see cref="T:System.Net.Http.HttpRequestMessage" /></returns>
</member>
<member name="T:NuGet.Protocol.HttpRetryHandler">
<summary>
The <see cref="T:NuGet.Protocol.HttpRetryHandler" /> is for retrying and HTTP request if it times out, has any exception,
or returns a status code of 500 or greater.
</summary>
</member>
<member name="M:NuGet.Protocol.HttpRetryHandler.SendAsync(NuGet.Protocol.HttpRetryHandlerRequest,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Make an HTTP request while retrying after failed attempts or timeouts.
</summary>
<remarks>
This method accepts a factory to create instances of the <see cref="T:System.Net.Http.HttpRequestMessage" /> because
requests cannot always be used. For example, suppose the request is a POST and contains content
of a stream that can only be consumed once.
</remarks>
</member>
<member name="M:NuGet.Protocol.HttpRetryHandler.SendAsync(NuGet.Protocol.HttpRetryHandlerRequest,System.String,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Make an HTTP request while retrying after failed attempts or timeouts.
</summary>
<remarks>
This method accepts a factory to create instances of the <see cref="T:System.Net.Http.HttpRequestMessage" /> because
requests cannot always be used. For example, suppose the request is a POST and contains content
of a stream that can only be consumed once.
</remarks>
</member>
<member name="T:NuGet.Protocol.HttpRetryHandlerRequest">
<summary>
A request to be handled by <see cref="T:NuGet.Protocol.HttpRetryHandler" />. This type should contain all
of the knowledge necessary to make a request, while handling transient transport errors.
</summary>
</member>
<member name="P:NuGet.Protocol.HttpRetryHandlerRequest.HttpClient">
<summary>The HTTP client to use for each request attempt.</summary>
</member>
<member name="P:NuGet.Protocol.HttpRetryHandlerRequest.RequestFactory">
<summary>
The factory that generates each request message. This factory is invoked for each attempt.
</summary>
</member>
<member name="P:NuGet.Protocol.HttpRetryHandlerRequest.CompletionOption">
<summary>The HTTP completion option to use for the next attempt.</summary>
</member>
<member name="P:NuGet.Protocol.HttpRetryHandlerRequest.MaxTries">
<summary>The maximum number of times to try the request. This value includes the initial attempt.</summary>
</member>
<member name="P:NuGet.Protocol.HttpRetryHandlerRequest.RequestTimeout">
<summary>How long to wait on the request to come back with a response.</summary>
</member>
<member name="P:NuGet.Protocol.HttpRetryHandlerRequest.RetryDelay">
<summary>How long to wait before trying again after a failed request.</summary>
<summary>This API is intended only for testing purposes and should not be used in product code.</summary>
</member>
<member name="P:NuGet.Protocol.HttpRetryHandlerRequest.DownloadTimeout">
<summary>The timeout to apply to <see cref="T:NuGet.Protocol.DownloadTimeoutStream" /> instances.</summary>
</member>
<member name="P:NuGet.Protocol.HttpRetryHandlerRequest.AddHeaders">
<summary>
Additional headers to add to the request.
</summary>
</member>
<member name="P:NuGet.Protocol.HttpRetryHandlerRequest.IsRetry">
<summary>Boolean representing whether the first attempt of this request is already a retry.</summary>
</member>
<member name="P:NuGet.Protocol.HttpRetryHandlerRequest.IsLastAttempt">
<summary>Boolean representing whether this retry request is the last for the URL.</summary>
</member>
<member name="P:NuGet.Protocol.HttpSource.RetryHandler">
<summary>The retry handler to use for all HTTP requests.</summary>
<summary>This API is intended only for testing purposes and should not be used in product code.</summary>
</member>
<member name="M:NuGet.Protocol.HttpSource.GetAsync``1(NuGet.Protocol.HttpSourceCachedRequest,System.Func{NuGet.Protocol.HttpSourceResult,System.Threading.Tasks.Task{``0}},NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Caching Get request.
</summary>
</member>
<member name="T:NuGet.Protocol.HttpSourceCachedRequest">
<summary>
A cached HTTP request handled by <see cref="T:NuGet.Protocol.HttpSource" />.
</summary>
</member>
<member name="P:NuGet.Protocol.HttpSourceCachedRequest.Uri">
<summary>
The URI to request with <code>GET</code>.
</summary>
</member>
<member name="P:NuGet.Protocol.HttpSourceCachedRequest.CacheKey">
<summary>
The cache key to use when fetching and storing the response from the HTTP cache. This
cache key is scoped to the NuGet source. That is to say that each NuGet source has its
own independent HTTP cache.
</summary>
</member>
<member name="P:NuGet.Protocol.HttpSourceCachedRequest.CacheContext">
<summary>
The cache context.
</summary>
</member>
<member name="P:NuGet.Protocol.HttpSourceCachedRequest.AcceptHeaderValues">
<summary>
The header values to apply when building the <see cref="T:System.Net.Http.HttpRequestMessage" />.
</summary>
</member>
<member name="P:NuGet.Protocol.HttpSourceCachedRequest.IgnoreNotFounds">
<summary>
When processing the <see cref="T:System.Net.Http.HttpResponseMessage" />, this flag allows
<code>404 Not Found</code> to be interpreted as a null response. This value defaults
to <code>false</code>.
</summary>
</member>
<member name="P:NuGet.Protocol.HttpSourceCachedRequest.MaxTries">
<summary>The maximum number of times to try the request. This value includes the initial attempt.</summary>
</member>
<member name="P:NuGet.Protocol.HttpSourceCachedRequest.EnsureValidContents">
<summary>
A method used to validate the response stream. This method should not
dispose the stream and should throw an exception when the content is invalid.
</summary>
</member>
<member name="P:NuGet.Protocol.HttpSourceCachedRequest.RequestTimeout">
<summary>
The timeout to use when fetching the <see cref="T:System.Net.Http.HttpResponseMessage" />. Since
<see cref="T:NuGet.Protocol.HttpSource" /> only uses <see cref="F:System.Net.Http.HttpCompletionOption.ResponseHeadersRead" />,
this means that we wait this amount of time for only the HTTP headers to be returned.
Downloading the response body is not included in this timeout.
</summary>
</member>
<member name="P:NuGet.Protocol.HttpSourceCachedRequest.DownloadTimeout">
<summary>The timeout to apply to <see cref="T:NuGet.Protocol.DownloadTimeoutStream" /> instances.</summary>
</member>
<member name="P:NuGet.Protocol.HttpSourceCachedRequest.IsRetry">
<summary>Boolean representing whether the first attempt of this request is already a retry.</summary>
</member>
<member name="P:NuGet.Protocol.HttpSourceCachedRequest.IsLastAttempt">
<summary>Boolean representing whether this retry request is the last for the URL.</summary>
</member>
<member name="T:NuGet.Protocol.HttpSourceCredentials">
<summary>
A mutable CredentialCache wrapper. This allows the underlying ICredentials to
be changed to work around HttpClientHandler not allowing Credentials to change.
This class intentionally inherits from CredentialCache to support authentication on redirects.
According to System.Net implementation any other ICredentials implementation is dropped for security reasons.
</summary>
</member>
<member name="F:NuGet.Protocol.HttpSourceCredentials._credentials">
<summary>
Credentials can be changed by other threads, for this reason volatile
is added below so that the value is not cached anywhere.
</summary>
</member>
<member name="P:NuGet.Protocol.HttpSourceCredentials.Credentials">
<summary>
The latest credentials to be used.
</summary>
</member>
<member name="P:NuGet.Protocol.HttpSourceCredentials.Version">
<summary>
The latest version ID of the <see cref="P:NuGet.Protocol.HttpSourceCredentials.Credentials" />.
</summary>
</member>
<member name="M:NuGet.Protocol.HttpSourceCredentials.#ctor(System.Net.ICredentials)">
<summary>
Initializes a new instance of the <see cref="T:NuGet.Protocol.HttpSourceCredentials" /> class
</summary>
<param name="credentials">
Optional initial credentials. May be null.
</param>
</member>
<member name="M:NuGet.Protocol.HttpSourceCredentials.System#Net#ICredentials#GetCredential(System.Uri,System.String)">
<summary>
Used by the HttpClientHandler to retrieve the current credentials.
</summary>
</member>
<member name="T:NuGet.Protocol.HttpSourceRequest">
<summary>
A non-cached HTTP request handled by <see cref="T:NuGet.Protocol.HttpSource" />.
</summary>
</member>
<member name="P:NuGet.Protocol.HttpSourceRequest.RequestFactory">
<summary>
A factory that can be called repeatedly to build the HTTP request message.
</summary>
</member>
<member name="P:NuGet.Protocol.HttpSourceRequest.IgnoreNotFounds">
<summary>
When processing the <see cref="T:System.Net.Http.HttpResponseMessage" />, this flag allows
<code>404 Not Found</code> to be interpreted as a null response. This value defaults
to <code>false</code>.
</summary>
</member>
<member name="P:NuGet.Protocol.HttpSourceRequest.RequestTimeout">
<summary>
The timeout to use when fetching the <see cref="T:System.Net.Http.HttpResponseMessage" />. Since
<see cref="T:NuGet.Protocol.HttpSource" /> only uses <see cref="F:System.Net.Http.HttpCompletionOption.ResponseHeadersRead" />,
this means that we wait this amount of time for only the HTTP headers to be returned.
Downloading the response body is not included in this timeout.
</summary>
</member>
<member name="P:NuGet.Protocol.HttpSourceRequest.MaxTries">
<summary>The maximum number of times to try the request. This value includes the initial attempt.</summary>
</member>
<member name="P:NuGet.Protocol.HttpSourceRequest.DownloadTimeout">
<summary>The timeout to apply to <see cref="T:NuGet.Protocol.DownloadTimeoutStream" /> instances.</summary>
</member>
<member name="P:NuGet.Protocol.HttpSourceRequest.IsRetry">
<summary>Boolean representing whether the first attempt of this request is already a retry.</summary>
</member>
<member name="P:NuGet.Protocol.HttpSourceRequest.IsLastAttempt">
<summary>Boolean representing whether this retry request is the last for the URL.</summary>
</member>
<member name="T:NuGet.Protocol.HttpSourceResource">
<summary>
Holds a shared <see cref="P:NuGet.Protocol.HttpSourceResource.HttpSource" />.
This is expected to be shared across the app and should not be disposed of.
</summary>
</member>
<member name="P:NuGet.Protocol.HttpSourceResourceProvider.Throttle">
<summary>
The throttle to apply to all <see cref="T:NuGet.Protocol.HttpSource" /> HTTP requests.
</summary>
</member>
<member name="T:NuGet.Protocol.IThrottle">
<summary>
An interface used for throttling operations. For example, suppose the application needs to
limit the concurrency of HTTP operations. Before executing each HTTP operation, the
<see cref="M:NuGet.Protocol.IThrottle.WaitAsync" /> would be executed. After the HTTP operation has been completed, the
application should call <see cref="M:NuGet.Protocol.IThrottle.Release" />. The implementation of <see cref="M:NuGet.Protocol.IThrottle.WaitAsync" />
should only allow the application to continue if there is an appropriate number of concurrent
callers. The primary implementation of this interface simply wraps a <see cref="T:System.Threading.SemaphoreSlim" />.
</summary>
</member>
<member name="M:NuGet.Protocol.IThrottle.WaitAsync">
<summary>
Waits until an appropriate level of concurrency has been reached before allowing the
caller to continue.
</summary>
</member>
<member name="M:NuGet.Protocol.IThrottle.Release">
<summary>
Signals that the throttled operation has been completed and other threads can being
their own throttled operation.
</summary>
</member>
<member name="T:NuGet.Protocol.NullThrottle">
<summary>
An throttle implementation that allows any level of concurrency. That is, the
<see cref="M:NuGet.Protocol.NullThrottle.WaitAsync" /> and <see cref="M:NuGet.Protocol.NullThrottle.Release" /> methods do nothing.
</summary>
</member>
<member name="T:NuGet.Protocol.ProxyAuthenticationHandler">
<summary>
A message handler responsible for retrying request for authenticated proxies
with missing credentials.
</summary>
</member>
<member name="P:NuGet.Protocol.SemaphoreSlimThrottle.CurrentCount">
<summary>
The number of remaining threads that can enter the semaphore.
</summary>
</member>
<member name="M:NuGet.Protocol.DependencyInfoResourceV2Feed.CreateDependencyInfo(NuGet.Protocol.V2FeedPackageInfo,NuGet.Frameworks.NuGetFramework)">
<summary>
Convert a V2 feed package into a V3 PackageDependencyInfo
</summary>
</member>
<member name="T:NuGet.Protocol.LegacyFeedCapabilityResourceV2Feed">
<summary>
A resource for detecting a V2 feed's capabilities based on the metadata document.
</summary>
</member>
<member name="T:NuGet.Protocol.LegacyFeedCapabilityResourceV2Feed.DataServiceMetadataExtractor">
<summary>
This implementation is copied from NuGet 2.x.
</summary>
</member>
<member name="P:NuGet.Protocol.ODataServiceDocumentResourceV2Provider.MaxCacheDuration">
<summary>
Maximum amount of time to store index.json
</summary>
</member>
<member name="T:NuGet.Protocol.V2FeedPackageInfo">
<summary>
Represents a V2 package entry from the OData feed. This object primarily just holds the strings parsed from XML, all parsing
and converting should be done after based on the scenario.
</summary>
</member>
<member name="P:NuGet.Protocol.V2FeedPackageInfo.DownloadCountAsInt">
<summary>
Parse DownloadCount into an integer
</summary>
</member>
<member name="P:NuGet.Protocol.V2FeedPackageInfo.IsListed">
<summary>
Checks the published date
</summary>
</member>
<member name="P:NuGet.Protocol.V2FeedPackageInfo.DependencySets">
<summary>
Parses Dependencies into actual groups
</summary>
</member>
<member name="T:NuGet.Protocol.V2FeedPage">
<summary>
A page of items from a V2 feed as well as a link to get the next page.
</summary>
</member>
<member name="T:NuGet.Protocol.V2FeedParser">
<summary>
A light weight XML parser for NuGet V2 Feeds
</summary>
</member>
<member name="M:NuGet.Protocol.V2FeedParser.#ctor(NuGet.Protocol.HttpSource,System.String)">
<summary>
Creates a V2 parser
</summary>
<param name="httpSource">HttpSource and message handler containing auth/proxy support</param>
<param name="baseAddress">base address for all services from this OData service</param>
</member>
<member name="M:NuGet.Protocol.V2FeedParser.#ctor(NuGet.Protocol.HttpSource,System.String,System.String)">
<summary>
Creates a V2 parser
</summary>
<param name="httpSource">HttpSource and message handler containing auth/proxy support</param>
<param name="baseAddress">base address for all services from this OData service</param>
<param name="source">PackageSource useful for reporting meaningful errors that relate back to the configuration</param>
</member>
<member name="M:NuGet.Protocol.V2FeedParser.GetPackage(NuGet.Packaging.Core.PackageIdentity,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Get an exact package
</summary>
</member>
<member name="M:NuGet.Protocol.V2FeedParser.FindPackagesByIdAsync(System.String,System.Boolean,System.Boolean,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Retrieves all packages with the given Id from a V2 feed.
</summary>
</member>
<member name="M:NuGet.Protocol.V2FeedParser.FindPackagesByIdAsync(System.String,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Retrieves all packages with the given Id from a V2 feed.
</summary>
</member>
<member name="M:NuGet.Protocol.V2FeedParser.ParsePage(System.Xml.Linq.XDocument,System.String,NuGet.Protocol.MetadataReferenceCache)">
<summary>
Finds all entries on the page and parses them
</summary>
</member>
<member name="M:NuGet.Protocol.V2FeedParser.ParsePackage(System.String,System.Xml.Linq.XElement,NuGet.Protocol.MetadataReferenceCache)">
<summary>
Parse an entry into a V2FeedPackageInfo
</summary>
</member>
<member name="M:NuGet.Protocol.V2FeedParser.GetString(System.Xml.Linq.XElement,System.Xml.Linq.XName)">
<summary>
Retrieve an XML <see cref="T:System.String" /> value safely
</summary>
</member>
<member name="M:NuGet.Protocol.V2FeedParser.GetDate(System.Xml.Linq.XElement,System.Xml.Linq.XName)">
<summary>
Retrieve an XML <see cref="T:System.DateTimeOffset" /> value safely
</summary>
</member>
<member name="T:NuGet.Protocol.V2FeedQueryBuilder">
<summary>
Build the path part of a V2 feed URL. These values are appended to the V2 base URL.
</summary>
</member>
<member name="T:NuGet.Protocol.LocalPackageArchiveDownloader">
<summary>
A package downloader for local archive packages.
</summary>
</member>
<member name="P:NuGet.Protocol.LocalPackageArchiveDownloader.ContentReader">
<summary>
Gets an asynchronous package content reader.
</summary>
<exception cref="T:System.ObjectDisposedException">Thrown if this object is disposed.</exception>
</member>
<member name="P:NuGet.Protocol.LocalPackageArchiveDownloader.CoreReader">
<summary>
Gets an asynchronous package core reader.
</summary>
<exception cref="T:System.ObjectDisposedException">Thrown if this object is disposed.</exception>
</member>
<member name="M:NuGet.Protocol.LocalPackageArchiveDownloader.#ctor(System.String,System.String,NuGet.Packaging.Core.PackageIdentity,NuGet.Common.ILogger)">
<summary>
Initializes a new <see cref="T:NuGet.Protocol.LocalPackageArchiveDownloader" /> class.
</summary>
<param name="source">A package source.</param>
<param name="packageFilePath">A source package archive file path.</param>
<param name="packageIdentity">A package identity.</param>
<param name="logger">A logger.</param>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="packageFilePath" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="packageIdentity" />
is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="logger" />
is <c>null</c>.</exception>
</member>
<member name="M:NuGet.Protocol.LocalPackageArchiveDownloader.Dispose">
<summary>
Disposes of this instance.
</summary>
</member>
<member name="M:NuGet.Protocol.LocalPackageArchiveDownloader.CopyNupkgFileToAsync(System.String,System.Threading.CancellationToken)">
<summary>
Asynchronously copies a .nupkg to a target file path.
</summary>
<param name="destinationFilePath">The destination file path.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns a <see cref="T:System.Boolean" />
indicating whether or not the copy was successful.</returns>
<exception cref="T:System.ObjectDisposedException">Thrown if this object is disposed.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="destinationFilePath" />
is either <c>null</c> or empty.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.LocalPackageArchiveDownloader.GetPackageHashAsync(System.String,System.Threading.CancellationToken)">
<summary>
Asynchronously gets a package hash.
</summary>
<param name="hashAlgorithm">The hash algorithm.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns a <see cref="T:System.String" />
representing the package hash.</returns>
<exception cref="T:System.ObjectDisposedException">Thrown if this object is disposed.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="hashAlgorithm" />
is either <c>null</c> or empty.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.LocalPackageArchiveDownloader.SetExceptionHandler(System.Func{System.Exception,System.Threading.Tasks.Task{System.Boolean}})">
<summary>
Sets an exception handler for package downloads.
</summary>
<remarks>The exception handler returns a task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns a <see cref="T:System.Boolean" />
indicating whether or not the exception was handled. To handle an exception and stop its
propagation, the task should return <c>true</c>. Otherwise, the exception will be rethrown.</remarks>
<param name="handleExceptionAsync">An exception handler.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="handleExceptionAsync" />
is <c>null</c>.</exception>
</member>
<member name="M:NuGet.Protocol.LocalPackageArchiveDownloader.SetThrottle(System.Threading.SemaphoreSlim)">
<summary>
Sets a throttle for package downloads.
</summary>
<param name="throttle">A throttle. Can be <c>null</c>.</param>
</member>
<member name="T:NuGet.Protocol.FindLocalPackagesResourcePackagesConfig">
<summary>
Packages.config packages folder reader
</summary>
</member>
<member name="T:NuGet.Protocol.FindLocalPackagesResourcePackagesConfigProvider">
<summary>
Reads packages.config packages folders. The expected format is root/id.version/id.version.nupkg
This resource cannot handle packages folders in the format root/id (exclude version)
</summary>
</member>
<member name="T:NuGet.Protocol.FindLocalPackagesResourceUnzipped">
<summary>
Unzipped package repository reader used for project templates.
</summary>
</member>
<member name="M:NuGet.Protocol.FindLocalPackagesResourceUnzipped.GetIndex(System.Lazy{System.Collections.Generic.IReadOnlyList{NuGet.Protocol.LocalPackageInfo}})">
<summary>
Id + Version -> Package
</summary>
</member>
<member name="M:NuGet.Protocol.FindLocalPackagesResourceUnzipped.GetPathIndex(System.Lazy{System.Collections.Generic.IReadOnlyList{NuGet.Protocol.LocalPackageInfo}})">
<summary>
Uri -> Package
</summary>
</member>
<member name="T:NuGet.Protocol.FindLocalPackagesResourceV3">
<summary>
Retrieve packages from a local folder or UNC share that uses the V3 folder structure.
</summary>
</member>
<member name="M:NuGet.Protocol.LocalDependencyInfoResource.ResolvePackage(NuGet.Packaging.Core.PackageIdentity,NuGet.Frameworks.NuGetFramework,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Retrieve dependency info for a single package.
</summary>
<param name="package">package id and version</param>
<param name="projectFramework">project target framework. This is used for finding the dependency group</param>
<param name="token">cancellation token</param>
</member>
<member name="M:NuGet.Protocol.LocalDependencyInfoResource.ResolvePackages(System.String,NuGet.Frameworks.NuGetFramework,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Retrieve dependency info for a single package.
</summary>
<param name="packageId">package id</param>
<param name="projectFramework">project target framework. This is used for finding the dependency group</param>
<param name="token">cancellation token</param>
</member>
<member name="M:NuGet.Protocol.LocalDependencyInfoResource.CreateDependencyInfo(NuGet.Protocol.LocalPackageInfo,NuGet.Frameworks.NuGetFramework)">
<summary>
Convert a package into a PackageDependencyInfo
</summary>
</member>
<member name="M:NuGet.Protocol.LocalPackageInfo.#ctor(NuGet.Packaging.Core.PackageIdentity,System.String,System.DateTime,System.Lazy{NuGet.Packaging.NuspecReader},System.Func{NuGet.Packaging.PackageReaderBase})">
<summary>
Local nuget package.
</summary>
<param name="identity">Package id and version.</param>
<param name="path">Path to the nupkg.</param>
<param name="lastWriteTimeUtc">Last nupkg write time for publish date.</param>
<param name="nuspec">Nuspec XML.</param>
<param name="getPackageReader">Method to retrieve the package as a reader.</param>
</member>
<member name="M:NuGet.Protocol.LocalPackageInfo.#ctor(NuGet.Packaging.Core.PackageIdentity,System.String,System.DateTime,System.Lazy{NuGet.Packaging.NuspecReader},System.Boolean)">
<summary>
Local nuget package.
</summary>
<param name="identity">Package id and version.</param>
<param name="path">Path to the nupkg.</param>
<param name="lastWriteTimeUtc">Last nupkg write time for publish date.</param>
<param name="nuspec">Nuspec XML.</param>
<param name="useFolder">Read content from folder next to nupkg.</param>
</member>
<member name="P:NuGet.Protocol.LocalPackageInfo.Identity">
<summary>
Package id and version.
</summary>
</member>
<member name="P:NuGet.Protocol.LocalPackageInfo.Path">
<summary>
Nupkg or folder path.
</summary>
</member>
<member name="P:NuGet.Protocol.LocalPackageInfo.LastWriteTimeUtc">
<summary>
Last file write time. This is used for the publish date.
</summary>
</member>
<member name="M:NuGet.Protocol.LocalPackageInfo.GetReader">
<summary>
Package reader.
</summary>
<remarks>This creates a new instance each time. Callers need to dispose of it.</remarks>
</member>
<member name="P:NuGet.Protocol.LocalPackageInfo.Nuspec">
<summary>
Nuspec reader.
</summary>
</member>
<member name="M:NuGet.Protocol.LocalPackageSearchResource.ContainsAnyTerm(System.String[],NuGet.Protocol.LocalPackageInfo)">
<summary>
Search Id, Tags, and Description to match the legacy local search behavior.
</summary>
</member>
<member name="M:NuGet.Protocol.LocalPackageSearchResource.CollapseToHighestVersion(System.Collections.Generic.IEnumerable{NuGet.Protocol.LocalPackageInfo})">
<summary>
Returns a distinct set of elements using the comparer specified. This implementation will pick the last occurrence
of each element instead of picking the first. This method assumes that similar items occur in order.
</summary>
</member>
<member name="T:NuGet.Protocol.LocalV2FindPackageByIdResource">
<summary>
A resource capable of fetching packages, package versions and package dependency information.
</summary>
</member>
<member name="M:NuGet.Protocol.LocalV2FindPackageByIdResource.#ctor(NuGet.Configuration.PackageSource)">
<summary>
Initializes a new <see cref="T:NuGet.Protocol.LocalV2FindPackageByIdResource" /> class.
</summary>
<param name="packageSource">A package source.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="packageSource" />
is <c>null</c>.</exception>
</member>
<member name="M:NuGet.Protocol.LocalV2FindPackageByIdResource.GetAllVersionsAsync(System.String,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Asynchronously gets all package versions for a package ID.
</summary>
<param name="id">A package ID.</param>
<param name="cacheContext">A source cache context.</param>
<param name="logger">A logger.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an
<see cref="T:System.Collections.Generic.IEnumerable`1" />.</returns>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="id" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="cacheContext" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="logger" /> <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.LocalV2FindPackageByIdResource.CopyNupkgToStreamAsync(System.String,NuGet.Versioning.NuGetVersion,System.IO.Stream,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Asynchronously copies a .nupkg to a stream.
</summary>
<param name="id">A package ID.</param>
<param name="version">A package version.</param>
<param name="destination">A destination stream.</param>
<param name="cacheContext">A source cache context.</param>
<param name="logger">A logger.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an
<see cref="T:System.Boolean" /> indicating whether or not the .nupkg file was copied.</returns>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="id" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="version" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="destination" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="cacheContext" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="logger" /> <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.LocalV2FindPackageByIdResource.GetDependencyInfoAsync(System.String,NuGet.Versioning.NuGetVersion,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Asynchronously gets dependency information for a specific package.
</summary>
<param name="id">A package id.</param>
<param name="version">A package version.</param>
<param name="cacheContext">A source cache context.</param>
<param name="logger">A logger.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an
<see cref="T:System.Collections.Generic.IEnumerable`1" />.</returns>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="id" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="version" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="cacheContext" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="logger" /> <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.LocalV2FindPackageByIdResource.GetPackageDownloaderAsync(NuGet.Packaging.Core.PackageIdentity,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Asynchronously gets a package downloader for a package identity.
</summary>
<param name="packageIdentity">A package identity.</param>
<param name="cacheContext">A source cache context.</param>
<param name="logger">A logger.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an <see cref="T:NuGet.Packaging.IPackageDownloader" />.</returns>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="packageIdentity" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="cacheContext" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="logger" /> <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.LocalV2FindPackageByIdResource.DoesPackageExistAsync(System.String,NuGet.Versioning.NuGetVersion,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Asynchronously check if exact package (id/version) exists at this source.
</summary>
<param name="id">A package id.</param>
<param name="version">A package version.</param>
<param name="cacheContext">A source cache context.</param>
<param name="logger">A logger.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an
<see cref="T:System.Collections.Generic.IEnumerable`1" />.</returns>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="id" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="version" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="cacheContext" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="logger" /> <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="T:NuGet.Protocol.LocalV2FindPackageByIdResourceProvider">
<summary>
A v2-style package repository that has nupkgs at the root.
</summary>
</member>
<member name="T:NuGet.Protocol.LocalV3FindPackageByIdResource">
<summary>
A resource capable of fetching packages, package versions and package dependency information.
</summary>
</member>
<member name="P:NuGet.Protocol.LocalV3FindPackageByIdResource.PackageFileCache">
<summary>
Nuspec files read from disk.
This is exposed to allow sharing the cache with other components
that are reading the same files.
</summary>
</member>
<member name="M:NuGet.Protocol.LocalV3FindPackageByIdResource.#ctor(NuGet.Configuration.PackageSource)">
<summary>
Initializes a new <see cref="T:NuGet.Protocol.LocalV3FindPackageByIdResource" /> class.
</summary>
<param name="packageSource">A package source.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="packageSource" />
is <c>null</c>.</exception>
</member>
<member name="M:NuGet.Protocol.LocalV3FindPackageByIdResource.GetAllVersionsAsync(System.String,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Asynchronously gets all package versions for a package ID.
</summary>
<param name="id">A package ID.</param>
<param name="cacheContext">A source cache context.</param>
<param name="logger">A logger.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an
<see cref="T:System.Collections.Generic.IEnumerable`1" />.</returns>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="id" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="cacheContext" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="logger" /> <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.LocalV3FindPackageByIdResource.CopyNupkgToStreamAsync(System.String,NuGet.Versioning.NuGetVersion,System.IO.Stream,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Asynchronously copies a .nupkg to a stream.
</summary>
<param name="id">A package ID.</param>
<param name="version">A package version.</param>
<param name="destination">A destination stream.</param>
<param name="cacheContext">A source cache context.</param>
<param name="logger">A logger.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an
<see cref="T:System.Boolean" /> indicating whether or not the .nupkg file was copied.</returns>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="id" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="version" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="destination" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="cacheContext" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="logger" /> <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.LocalV3FindPackageByIdResource.GetDependencyInfoAsync(System.String,NuGet.Versioning.NuGetVersion,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Asynchronously gets dependency information for a specific package.
</summary>
<param name="id">A package id.</param>
<param name="version">A package version.</param>
<param name="cacheContext">A source cache context.</param>
<param name="logger">A logger.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an
<see cref="T:System.Collections.Generic.IEnumerable`1" />.</returns>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="id" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="version" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="cacheContext" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="logger" /> <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.LocalV3FindPackageByIdResource.GetPackageDownloaderAsync(NuGet.Packaging.Core.PackageIdentity,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Asynchronously gets a package downloader for a package identity.
</summary>
<param name="packageIdentity">A package identity.</param>
<param name="cacheContext">A source cache context.</param>
<param name="logger">A logger.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an <see cref="T:NuGet.Packaging.IPackageDownloader" />.</returns>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="packageIdentity" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="cacheContext" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="logger" /> <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.LocalV3FindPackageByIdResource.DoesPackageExistAsync(System.String,NuGet.Versioning.NuGetVersion,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Asynchronously check if exact package (id/version) exists at this source.
</summary>
<param name="id">A package id.</param>
<param name="version">A package version.</param>
<param name="cacheContext">A source cache context.</param>
<param name="logger">A logger.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an
<see cref="T:System.Collections.Generic.IEnumerable`1" />.</returns>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="id" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="version" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="cacheContext" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="logger" /> <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="T:NuGet.Protocol.LocalV3FindPackageByIdResourceProvider">
<summary>
A v3-style package repository that has expanded packages.
</summary>
</member>
<member name="P:NuGet.Protocol.LocalPackageSearchMetadata.DownloadCount">
<remarks>
Local package sources never provide a download count.
</remarks>
</member>
<member name="P:NuGet.Protocol.LocalPackageSearchMetadata.ReadmeUrl">
<remarks>
There is no readme url for local packages. Later releases may display the readme file in a VS window.
</remarks>
</member>
<member name="P:NuGet.Protocol.LocalPackageSearchMetadata.ReportAbuseUrl">
<remarks>
There is no report abuse url for local packages.
</remarks>
</member>
<member name="P:NuGet.Protocol.LocalPackageSearchMetadata.PackageReader">
<summary>
Gets a function that provides <c>PackageReaderBase</c>-like objects, for reading package content
</summary>
<remarks>
This property depends from the reader contained in the <c>LocalPackageInfo</c> specified at object creation time
</remarks>
</member>
<member name="M:NuGet.Protocol.LocalPackageSearchMetadata.GetVersionsAsync">
<inheritdoc cref="M:NuGet.Protocol.Core.Types.IPackageSearchMetadata.GetVersionsAsync" />
</member>
<member name="M:NuGet.Protocol.LocalPackageSearchMetadata.Convert(System.String)">
<summary>
Convert a string to a URI safely. This will return null if there are errors.
</summary>
</member>
<member name="P:NuGet.Protocol.LocalPackageSearchMetadata.PrefixReserved">
<remarks>
The prefix reservation is not applicable to local packages
</remarks>
</member>
<member name="M:NuGet.Protocol.LocalPackageSearchMetadata.GetDeprecationMetadataAsync">
<inheritdoc cref="M:NuGet.Protocol.Core.Types.IPackageSearchMetadata.GetDeprecationMetadataAsync" />
</member>
<member name="P:NuGet.Protocol.LocalPackageSearchMetadata.Vulnerabilities">
<inheritdoc cref="P:NuGet.Protocol.Core.Types.IPackageSearchMetadata.Vulnerabilities" />
</member>
<member name="M:NuGet.Protocol.LocalPackageSearchMetadata.GetIconUri">
<summary>
Points to an Icon, either Embedded Icon or IconUrl
</summary>
</member>
<member name="M:NuGet.Protocol.PackageSearchMetadata.GetVersionsAsync">
<inheritdoc cref="M:NuGet.Protocol.Core.Types.IPackageSearchMetadata.GetVersionsAsync" />
</member>
<member name="M:NuGet.Protocol.PackageSearchMetadata.GetDeprecationMetadataAsync">
<inheritdoc cref="M:NuGet.Protocol.Core.Types.IPackageSearchMetadata.GetDeprecationMetadataAsync" />
</member>
<member name="P:NuGet.Protocol.PackageSearchMetadata.Vulnerabilities">
<inheritdoc cref="P:NuGet.Protocol.Core.Types.IPackageSearchMetadata.Vulnerabilities" />
</member>
<member name="T:NuGet.Protocol.PackageSearchMetadataRegistration">
<summary>
Subclass of <see cref="T:NuGet.Protocol.PackageSearchMetadata" /> containing the information in the registration blobs that are not present in the V2 feed or search.
Returned by <see cref="T:NuGet.Protocol.PackageMetadataResourceV3" />.
</summary>
</member>
<member name="P:NuGet.Protocol.PackageSearchMetadataRegistration.CatalogUri">
<summary>
The <see cref="T:System.Uri" /> of this package in the catalog.
</summary>
</member>
<member name="M:NuGet.Protocol.PackageSearchMetadataV2Feed.GetVersionsAsync">
<inheritdoc cref="M:NuGet.Protocol.Core.Types.IPackageSearchMetadata.GetVersionsAsync" />
</member>
<member name="M:NuGet.Protocol.PackageSearchMetadataV2Feed.GetDeprecationMetadataAsync">
<inheritdoc cref="M:NuGet.Protocol.Core.Types.IPackageSearchMetadata.GetDeprecationMetadataAsync" />
</member>
<member name="P:NuGet.Protocol.PackageSearchMetadataV2Feed.Vulnerabilities">
<inheritdoc cref="P:NuGet.Protocol.Core.Types.IPackageSearchMetadata.Vulnerabilities" />
</member>
<member name="T:NuGet.Protocol.Model.RegistrationIndex">
<summary>
Source: https://docs.microsoft.com/en-us/nuget/api/registration-base-url-resource#registration-index
</summary>
</member>
<member name="T:NuGet.Protocol.Model.RegistrationLeafItem">
<summary>
Source: https://docs.microsoft.com/en-us/nuget/api/registration-base-url-resource#registration-leaf-object-in-a-page
</summary>
</member>
<member name="T:NuGet.Protocol.Model.RegistrationPage">
<summary>
This model is used for both the registration page item (found in a registration index) and for a registration
page fetched on its own.
Source: https://docs.microsoft.com/en-us/nuget/api/registration-base-url-resource#registration-page
Source: https://docs.microsoft.com/en-us/nuget/api/registration-base-url-resource#registration-page-object
</summary>
</member>
<member name="P:NuGet.Protocol.Model.RegistrationPage.Items">
<summary>
This property can be null when this model is used as an item in <see cref="P:NuGet.Protocol.Model.RegistrationIndex.Items" /> when
the server decided not to inline the leaf items. In this case, the <see cref="P:NuGet.Protocol.Model.RegistrationPage.Url" /> property can be used
fetch another <see cref="T:NuGet.Protocol.Model.RegistrationPage" /> instance with the <see cref="P:NuGet.Protocol.Model.RegistrationPage.Items" /> property filled in.
</summary>
</member>
<member name="T:NuGet.Protocol.ServiceIndexEntry">
<summary>
index.json entry for v3
</summary>
</member>
<member name="P:NuGet.Protocol.ServiceIndexEntry.Uri">
<summary>
Service Uri
</summary>
</member>
<member name="P:NuGet.Protocol.ServiceIndexEntry.Type">
<summary>
Service Type
</summary>
</member>
<member name="P:NuGet.Protocol.ServiceIndexEntry.ClientVersion">
<summary>
Client version
</summary>
</member>
<member name="T:NuGet.Protocol.LocalPackageFileCache">
<summary>
Allow .nuspec files on disk to be cached across v3 folder readers.
Allow the list of files in a package to be cached across all projects.
</summary>
<remarks>It is expected that the caller has already verified the that folder and paths are valid.</remarks>
</member>
<member name="M:NuGet.Protocol.LocalPackageFileCache.GetOrAddNuspec(System.String,System.String)">
<summary>
Read a nuspec file from disk. The nuspec is expected to exist.
</summary>
</member>
<member name="M:NuGet.Protocol.LocalPackageFileCache.GetOrAddFiles(System.String)">
<summary>
Read a the package files from disk.
</summary>
</member>
<member name="M:NuGet.Protocol.LocalPackageFileCache.GetOrAddSha512(System.String)">
<summary>
Read the .metadata.json file from disk.
</summary>
<remarks>Throws if the file is not found or corrupted.</remarks>
</member>
<member name="M:NuGet.Protocol.LocalPackageFileCache.Sha512Exists(System.String)">
<summary>
True if the path exists on disk. This also uses
the SHA512 cache for already read files.
</summary>
</member>
<member name="M:NuGet.Protocol.LocalPackageFileCache.UpdateLastAccessTime(System.String)">
<summary>
Update the last access time of the metadata package file. This also uses
the metadata file cache for already accessed files.
</summary>
<param name="nupkgMetadataPath">metadata file path to update</param>
</member>
<member name="M:NuGet.Protocol.LocalPackageFileCache.GetOrAddRuntimeGraph(System.String)">
<summary>
Read runtime.json from a package.
Returns null if runtime.json does not exist.
</summary>
</member>
<member name="M:NuGet.Protocol.LocalPackageFileCache.GetFiles(System.String)">
<summary>
Read files from a package folder.
</summary>
</member>
<member name="M:NuGet.Protocol.LocalPackageFileCache.IsAllowedLibraryFile(System.String)">
<summary>
True if the file should be added to the lock file library
Fale if it is an OPC file or empty directory
</summary>
</member>
<member name="M:NuGet.Protocol.LocalPackageFileCache.GetNuspec(System.String,System.String)">
<summary>
Search for a nuspec using the given path, or by the expanded folder path.
The manifest path here is a shortcut to use the already constructed well
known location, if this doesn't exist the folder reader will find the nuspec
if it exists.
</summary>
</member>
<member name="M:NuGet.Protocol.LocalPackageFileCache.GetRuntimeGraph(System.String)">
<summary>
Return runtime.json from a package.
</summary>
</member>
<member name="T:NuGet.Protocol.Plugins.AutomaticProgressReporter">
<summary>
An automatic progress reporter.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.AutomaticProgressReporter.Dispose">
<summary>
Disposes of this instance.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.AutomaticProgressReporter.Create(NuGet.Protocol.Plugins.IConnection,NuGet.Protocol.Plugins.Message,System.TimeSpan,System.Threading.CancellationToken)">
<summary>
Creates a new <see cref="T:NuGet.Protocol.Plugins.AutomaticProgressReporter" /> class.
</summary>
<remarks>This class does not take ownership of and dispose of <paramref name="connection" />.</remarks>
<param name="connection">A connection.</param>
<param name="request">A request.</param>
<param name="interval">A progress interval.</param>
<param name="cancellationToken">A cancellation token.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="connection" />
is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="request" />
is <c>null</c>.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">Thrown if <paramref name="interval" />
is either less than <see cref="F:NuGet.Protocol.Plugins.ProtocolConstants.MinTimeout" /> or greater than
<see cref="F:NuGet.Protocol.Plugins.ProtocolConstants.MaxTimeout" />.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.Connection">
<summary>
Represents a bidirectional channel between a NuGet client and a plugin.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.Connection.State">
<summary>
The connection state.
</summary>
</member>
<member name="E:NuGet.Protocol.Plugins.Connection.Faulted">
<summary>
Occurs when an unrecoverable fault has been caught.
</summary>
</member>
<member name="E:NuGet.Protocol.Plugins.Connection.MessageReceived">
<summary>
Occurs when a message has been received.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.Connection.MessageDispatcher">
<summary>
Gets the message dispatcher.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.Connection.Options">
<summary>
Gets the connection options
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.Connection.ProtocolVersion">
<summary>
Gets the negotiated protocol version, or <c>null</c> if not yet connected.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.Connection.#ctor(NuGet.Protocol.Plugins.IMessageDispatcher,NuGet.Protocol.Plugins.ISender,NuGet.Protocol.Plugins.IReceiver,NuGet.Protocol.Plugins.ConnectionOptions)">
<summary>
Instantiates a new instance of the <see cref="T:NuGet.Protocol.Plugins.Connection" /> class.
</summary>
<param name="dispatcher">A message dispatcher.</param>
<param name="sender">A sender.</param>
<param name="receiver">A receiver.</param>
<param name="options">Connection options.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="dispatcher" /> is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="sender" /> is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="receiver" /> is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="options" /> is <c>null</c>.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.Connection.#ctor(NuGet.Protocol.Plugins.IMessageDispatcher,NuGet.Protocol.Plugins.ISender,NuGet.Protocol.Plugins.IReceiver,NuGet.Protocol.Plugins.ConnectionOptions,NuGet.Protocol.Plugins.IPluginLogger)">
<summary>
Instantiates a new instance of the <see cref="T:NuGet.Protocol.Plugins.Connection" /> class.
</summary>
<param name="dispatcher">A message dispatcher.</param>
<param name="sender">A sender.</param>
<param name="receiver">A receiver.</param>
<param name="options">Connection options.</param>
<param name="logger">A plugin logger.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="dispatcher" /> is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="sender" /> is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="receiver" /> is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="options" /> is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="logger" /> is <c>null</c>.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.Connection.Dispose">
<summary>
Disposes of this instance.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.Connection.Close">
<summary>
Closes the connection.
</summary>
<remarks>This does not call <see cref="M:System.IDisposable.Dispose" />.</remarks>
</member>
<member name="M:NuGet.Protocol.Plugins.Connection.ConnectAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously connects and handshakes with a remote target.
</summary>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.</returns>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
<exception cref="T:System.InvalidOperationException">Thrown if the method has been called already.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.Connection.SendAsync(NuGet.Protocol.Plugins.Message,System.Threading.CancellationToken)">
<summary>
Asynchronously sends a message to the remote target.
</summary>
<param name="message">The message to be sent.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.</returns>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="message" /> is <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
<exception cref="T:System.InvalidOperationException">Thrown if not connected.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.Connection.SendRequestAndReceiveResponseAsync``2(NuGet.Protocol.Plugins.MessageMethod,``0,System.Threading.CancellationToken)">
<summary>
Asynchronously sends a message to the remote target and receives the target's response.
</summary>
<typeparam name="TOutbound">The outbound payload type.</typeparam>
<typeparam name="TInbound">The inbound payload type.</typeparam>
<param name="method">The outbound message method.</param>
<param name="payload">The outbound message payload.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns a <typeparamref name="TInbound" />
from the target.</returns>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
<exception cref="T:System.InvalidOperationException">Thrown if not connected.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.ConnectionOptions">
<summary>
Plugin connection options.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.ConnectionOptions.HandshakeTimeout">
<summary>
Gets the plugin handshake timeout.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.ConnectionOptions.MinimumProtocolVersion">
<summary>
Gets the minimum plugin protocol version.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.ConnectionOptions.ProtocolVersion">
<summary>
Gets the plugin protocol version.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.ConnectionOptions.RequestTimeout">
<summary>
Gets the plugin request timeout.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.ConnectionOptions.#ctor(NuGet.Versioning.SemanticVersion,NuGet.Versioning.SemanticVersion,System.TimeSpan,System.TimeSpan)">
<summary>
Instantiates a new <see cref="T:NuGet.Protocol.Plugins.ConnectionOptions" /> class.
</summary>
<param name="protocolVersion">The plugin protocol version.</param>
<param name="minimumProtocolVersion">The minimum plugin protocol version.</param>
<param name="handshakeTimeout">The plugin handshake timeout.</param>
<param name="requestTimeout">The plugin request timeout.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="protocolVersion" />
is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="minimumProtocolVersion" />
is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="protocolVersion" />
is <c>null</c>.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">Thrown if <paramref name="protocolVersion" />
is less than <paramref name="minimumProtocolVersion" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">Thrown if <paramref name="handshakeTimeout" />
is either less than <see cref="F:NuGet.Protocol.Plugins.ProtocolConstants.MinTimeout" /> or greater than
<see cref="F:NuGet.Protocol.Plugins.ProtocolConstants.MaxTimeout" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">Thrown if <paramref name="requestTimeout" />
is either less than <see cref="F:NuGet.Protocol.Plugins.ProtocolConstants.MinTimeout" /> or greater than
<see cref="F:NuGet.Protocol.Plugins.ProtocolConstants.MaxTimeout" />.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.ConnectionOptions.SetRequestTimeout(System.TimeSpan)">
<summary>
Sets a new request timeout.
</summary>
<param name="requestTimeout">The new request timeout.</param>
<exception cref="T:System.ArgumentOutOfRangeException">Thrown if <paramref name="requestTimeout" />
is either less than <see cref="F:NuGet.Protocol.Plugins.ProtocolConstants.MinTimeout" /> or greater than
<see cref="F:NuGet.Protocol.Plugins.ProtocolConstants.MaxTimeout" />.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.ConnectionOptions.CreateDefault(NuGet.Common.IEnvironmentVariableReader)">
<summary>
Instantiates a <see cref="T:NuGet.Protocol.Plugins.ConnectionOptions" /> class with default values.
</summary>
<param name="reader">An environment variable reader.</param>
<returns>A <see cref="T:NuGet.Protocol.Plugins.ConnectionOptions" />.</returns>
</member>
<member name="T:NuGet.Protocol.Plugins.ConnectionState">
<summary>
Connection states.
</summary>
<remarks>Member order is significant.
For example, any connection state before <see cref="F:NuGet.Protocol.Plugins.ConnectionState.Connecting" />
implies no connection.</remarks>
</member>
<member name="T:NuGet.Protocol.Plugins.EmbeddedSignatureVerifier">
<summary>
Base class for embedded signature verifiers.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.EmbeddedSignatureVerifier.IsValid(System.String)">
<summary>
Checks if a file has a valid embedded signature.
</summary>
<param name="filePath">The path of a file to be checked.</param>
<returns><c>true</c> if the file has a valid signature; otherwise, <c>false</c>.</returns>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="filePath" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.PlatformNotSupportedException">Thrown if the current platform is unsupported.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.EmbeddedSignatureVerifier.Create">
<summary>
Creates an embedded signature verifier for the current platform.
</summary>
<returns>An embedded signature verifier.</returns>
</member>
<member name="T:NuGet.Protocol.Plugins.FallbackEmbeddedSignatureVerifier">
<summary>
A fallback embedded signature verifier for unsupported platforms.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.FallbackEmbeddedSignatureVerifier.IsValid(System.String)">
<summary>
Checks if a file has a valid embedded signature.
</summary>
<param name="filePath">The path of a file to be checked.</param>
<returns><c>true</c> if the file has a valid signature; otherwise, <c>false</c>.</returns>
<exception cref="T:System.PlatformNotSupportedException">Thrown always.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.FaultedPluginEventArgs">
<summary>
Faulted plugin event arguments.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.FaultedPluginEventArgs.Exception">
<summary>
Gets the exception.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.FaultedPluginEventArgs.Plugin">
<summary>
Gets the plugin.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.FaultedPluginEventArgs.#ctor(NuGet.Protocol.Plugins.IPlugin,System.Exception)">
<summary>
Instantiates a new <see cref="T:NuGet.Protocol.Plugins.FaultedPluginEventArgs" /> class.
</summary>
<param name="plugin">A plugin.</param>
<param name="exception">An exception.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="plugin" /> is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="exception" /> is <c>null</c>.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.IConnection">
<summary>
Represents a bidirectional channel between a NuGet client and a plugin.
</summary>
</member>
<member name="E:NuGet.Protocol.Plugins.IConnection.Faulted">
<summary>
Occurs when an unrecoverable fault has been caught.
</summary>
</member>
<member name="E:NuGet.Protocol.Plugins.IConnection.MessageReceived">
<summary>
Occurs when a message has been received.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.IConnection.MessageDispatcher">
<summary>
Gets the message dispatcher.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.IConnection.Options">
<summary>
Gets the connection options
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.IConnection.ProtocolVersion">
<summary>
Gets the negotiated protocol version, or <c>null</c> if not yet connected.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.IConnection.Close">
<summary>
Closes the connection.
</summary>
<remarks>This does not call <see cref="M:System.IDisposable.Dispose" />.</remarks>
</member>
<member name="M:NuGet.Protocol.Plugins.IConnection.SendAsync(NuGet.Protocol.Plugins.Message,System.Threading.CancellationToken)">
<summary>
Asynchronously sends a message to the remote target.
</summary>
<param name="message">The message to be sent.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.</returns>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="message" /> is <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
<exception cref="T:System.InvalidOperationException">Thrown if not connected.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.IConnection.SendRequestAndReceiveResponseAsync``2(NuGet.Protocol.Plugins.MessageMethod,``0,System.Threading.CancellationToken)">
<summary>
Asynchronously sends a message to the remote target and receives the target's response.
</summary>
<typeparam name="TOutbound">The outbound payload type.</typeparam>
<typeparam name="TInbound">The inbound payload type.</typeparam>
<param name="method">The outbound message method.</param>
<param name="payload">The outbound message payload.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns a <typeparamref name="TInbound" />
from the target.</returns>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
<exception cref="T:System.InvalidOperationException">Thrown if not connected.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.IIdGenerator">
<summary>
A unique identifier generator.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.IIdGenerator.GenerateUniqueId">
<summary>
Generates a new unique identifier.
</summary>
<returns>A unique identifier.</returns>
</member>
<member name="T:NuGet.Protocol.Plugins.IMessageDispatcher">
<summary>
A message dispatcher that maintains state for outstanding requests
and routes messages to configured request handlers.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.IMessageDispatcher.RequestHandlers">
<summary>
Gets the request handlers for use by the dispatcher.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.IMessageDispatcher.Close">
<summary>
Closes the dispatcher.
</summary>
<remarks>This does not call <see cref="M:System.IDisposable.Dispose" />.</remarks>
</member>
<member name="M:NuGet.Protocol.Plugins.IMessageDispatcher.CreateMessage(NuGet.Protocol.Plugins.MessageType,NuGet.Protocol.Plugins.MessageMethod)">
<summary>
Creates a message.
</summary>
<param name="type">The message type.</param>
<param name="method">The message method.</param>
<returns>A message.</returns>
</member>
<member name="M:NuGet.Protocol.Plugins.IMessageDispatcher.CreateMessage``1(NuGet.Protocol.Plugins.MessageType,NuGet.Protocol.Plugins.MessageMethod,``0)">
<summary>
Creates a message.
</summary>
<typeparam name="TPayload">The message payload.</typeparam>
<param name="type">The message type.</param>
<param name="method">The message method.</param>
<param name="payload">The message payload.</param>
<returns>A message.</returns>
</member>
<member name="M:NuGet.Protocol.Plugins.IMessageDispatcher.DispatchCancelAsync(NuGet.Protocol.Plugins.Message,System.Threading.CancellationToken)">
<summary>
Asynchronously dispatches a cancellation request for the specified request.
</summary>
<param name="request">The request.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.</returns>
</member>
<member name="M:NuGet.Protocol.Plugins.IMessageDispatcher.DispatchFaultAsync(NuGet.Protocol.Plugins.Message,NuGet.Protocol.Plugins.Fault,System.Threading.CancellationToken)">
<summary>
Asynchronously dispatches a fault notification for the specified request.
</summary>
<param name="request">The cancel request.</param>
<param name="fault">The fault payload.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.</returns>
</member>
<member name="M:NuGet.Protocol.Plugins.IMessageDispatcher.DispatchProgressAsync(NuGet.Protocol.Plugins.Message,NuGet.Protocol.Plugins.Progress,System.Threading.CancellationToken)">
<summary>
Asynchronously dispatches a progress notification for the specified request.
</summary>
<param name="request">The request.</param>
<param name="progress">The progress payload.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.</returns>
</member>
<member name="M:NuGet.Protocol.Plugins.IMessageDispatcher.DispatchRequestAsync``2(NuGet.Protocol.Plugins.MessageMethod,``0,System.Threading.CancellationToken)">
<summary>
Asynchronously dispatches a request.
</summary>
<typeparam name="TOutbound">The request payload type.</typeparam>
<typeparam name="TInbound">The expected response payload type.</typeparam>
<param name="method">The request method.</param>
<param name="payload">The request payload.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns a <typeparamref name="TInbound" />
from the target.</returns>
</member>
<member name="M:NuGet.Protocol.Plugins.IMessageDispatcher.DispatchResponseAsync``1(NuGet.Protocol.Plugins.Message,``0,System.Threading.CancellationToken)">
<summary>
Asynchronously dispatches a response.
</summary>
<typeparam name="TOutbound">The request payload type.</typeparam>
<param name="request">The associated request.</param>
<param name="responsePayload">The response payload.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.</returns>
</member>
<member name="M:NuGet.Protocol.Plugins.IMessageDispatcher.SetConnection(NuGet.Protocol.Plugins.IConnection)">
<summary>
Sets the connection to be used for dispatching messages.
</summary>
<param name="connection">A connection instance. Can be <c>null</c>.</param>
</member>
<member name="T:NuGet.Protocol.Plugins.InboundRequestContext">
<summary>
Context for an inbound request.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.InboundRequestContext.RequestId">
<summary>
Gets the request ID.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.InboundRequestContext.#ctor(NuGet.Protocol.Plugins.IConnection,System.String,System.Threading.CancellationToken)">
<summary>
Initializes a new <see cref="T:NuGet.Protocol.Plugins.InboundRequestContext" /> class.
</summary>
<param name="connection">A connection.</param>
<param name="requestId">A request ID.</param>
<param name="cancellationToken">A cancellation token.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="connection" />
is <c>null</c>.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="requestId" />
is either <c>null</c> or an empty string.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.InboundRequestContext.#ctor(NuGet.Protocol.Plugins.IConnection,System.String,System.Threading.CancellationToken,NuGet.Protocol.Plugins.InboundRequestProcessingHandler,NuGet.Protocol.Plugins.IPluginLogger)">
<summary>
Initializes a new <see cref="T:NuGet.Protocol.Plugins.InboundRequestContext" /> class.
</summary>
<param name="connection">A connection.</param>
<param name="requestId">A request ID.</param>
<param name="cancellationToken">A cancellation token.</param>
<param name="logger">A plugin logger.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="connection" />
is <c>null</c>.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="requestId" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="inboundRequestProcessingHandler" />
is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="logger" />
is <c>null</c>.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.InboundRequestContext.Dispose">
<summary>
Disposes of this instance.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.InboundRequestContext.BeginFaultAsync(NuGet.Protocol.Plugins.Message,System.Exception)">
<summary>
Asynchronously starts processing a fault response for the inbound request.
</summary>
<param name="request">The request.</param>
<param name="exception">An exception.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="request" />
is either <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="exception" />
is <c>null</c>.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.InboundRequestContext.BeginResponseAsync(NuGet.Protocol.Plugins.Message,NuGet.Protocol.Plugins.IRequestHandler,NuGet.Protocol.Plugins.IResponseHandler)">
<summary>
Asynchronously starts processing a response for the inbound request.
</summary>
<param name="request">The request.</param>
<param name="requestHandler">A request handler.</param>
<param name="responseHandler">A response handler.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="request" />
is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="requestHandler" />
is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="responseHandler" />
is <c>null</c>.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.InboundRequestContext.Cancel">
<summary>
Cancels an inbound request.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.InboundRequestProcessingHandler.#ctor(System.Collections.Generic.IEnumerable{NuGet.Protocol.Plugins.MessageMethod})">
<summary>
Requests from the processing methods provided in this set are handled on a dedicated thread.
</summary>
<param name="fastProcessingMethods"></param>
</member>
<member name="M:NuGet.Protocol.Plugins.InboundRequestProcessingHandler.Handle(NuGet.Protocol.Plugins.MessageMethod,System.Func{System.Threading.Tasks.Task},System.Threading.CancellationToken)">
<summary>
Methods that are in the fast processing method list will be handled on a separate thread. Everything else will be queued on the threadpool.
</summary>
<param name="messageMethod"></param>
<param name="task"></param>
<param name="cancellationToken"></param>
</member>
<member name="T:NuGet.Protocol.Plugins.IPlugin">
<summary>
Represents a plugin.
</summary>
</member>
<member name="E:NuGet.Protocol.Plugins.IPlugin.BeforeClose">
<summary>
Occurs before the plugin closes.
</summary>
</member>
<member name="E:NuGet.Protocol.Plugins.IPlugin.Closed">
<summary>
Occurs when the plugin has closed.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.IPlugin.Connection">
<summary>
Gets the connection for the plugin.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.IPlugin.FilePath">
<summary>
Gets the file path for the plugin.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.IPlugin.Id">
<summary>
Gets the unique identifier for the plugin.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.IPlugin.Name">
<summary>
Gets the name of the plugin.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.IPlugin.Close">
<summary>
Closes the plugin.
</summary>
<remarks>This does not call <see cref="M:System.IDisposable.Dispose" />.</remarks>
</member>
<member name="T:NuGet.Protocol.Plugins.IPluginDiscoverer">
<summary>
A plugin discoverer.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.IPluginDiscoverer.DiscoverAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously discovers plugins.
</summary>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an
<see cref="T:System.Collections.Generic.IEnumerable`1" />.</returns>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.IPluginFactory">
<summary>
A plugin factory.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.IPluginFactory.GetOrCreateAsync(System.String,System.Collections.Generic.IEnumerable{System.String},NuGet.Protocol.Plugins.IRequestHandlers,NuGet.Protocol.Plugins.ConnectionOptions,System.Threading.CancellationToken)">
<summary>
Asynchronously gets an existing plugin instance or creates a new instance and connects to it.
</summary>
<param name="filePath">The file path of the plugin.</param>
<param name="arguments">Command-line arguments to be supplied to the plugin.</param>
<param name="requestHandlers">Request handlers.</param>
<param name="options">Connection options.</param>
<param name="sessionCancellationToken">A cancellation token for the plugin's lifetime.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns a <see cref="T:NuGet.Protocol.Plugins.Plugin" />
instance.</returns>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="filePath" />
is either <c>null</c> or empty.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="arguments" />
is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="requestHandlers" />
is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="options" />
is <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="sessionCancellationToken" />
is cancelled.</exception>
<exception cref="T:System.ObjectDisposedException">Thrown if this object is disposed.</exception>
<remarks>This is intended to be called by NuGet client tools.</remarks>
</member>
<member name="M:NuGet.Protocol.Plugins.IPluginManager.CreatePluginsAsync(NuGet.Protocol.Core.Types.SourceRepository,System.Threading.CancellationToken)">
<summary>
Create plugins appropriate for the given source
</summary>
<param name="source"></param>
<param name="cancellationToken"></param>
<exception cref="T:System.ArgumentNullException">Throw if <paramref name="source" /> is null </exception>
<returns>PluginCreationResults</returns>
</member>
<member name="M:NuGet.Protocol.Plugins.IPluginManager.FindAvailablePluginsAsync(System.Threading.CancellationToken)">
<summary>
Find all available plugins on the machine
</summary>
<param name="cancellationToken"></param>
<returns>PluginDiscoveryResults</returns>
</member>
<member name="M:NuGet.Protocol.Plugins.IPluginManager.TryGetSourceAgnosticPluginAsync(NuGet.Protocol.Plugins.PluginDiscoveryResult,NuGet.Protocol.Plugins.OperationClaim,System.Threading.CancellationToken)">
<summary>
Creates a plugin from the given pluginDiscoveryResult.
This plugin's operations will be source agnostic ones
</summary>
<param name="pluginDiscoveryResult"></param>
<param name="cancellationToken"></param>
<returns>A PluginCreationResult</returns>
</member>
<member name="T:NuGet.Protocol.Plugins.IPluginMulticlientUtilities">
<summary>
Plugin multiclient utilities.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.IPluginMulticlientUtilities.DoOncePerPluginLifetimeAsync(System.String,System.Func{System.Threading.Tasks.Task},System.Threading.CancellationToken)">
<summary>
Asynchronously executes a task once per plugin lifetime per key.
</summary>
<param name="key">A key that identifies the task.</param>
<param name="taskFunc">A function that returns a task.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.</returns>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="key" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="taskFunc" />
is either <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.IPluginProcess">
<summary>
Represents a plugin process.
</summary>
</member>
<member name="E:NuGet.Protocol.Plugins.IPluginProcess.LineRead">
<summary>
Occurs when a line of output has been received.
</summary>
</member>
<member name="E:NuGet.Protocol.Plugins.IPluginProcess.Exited">
<summary>
Occurs when a process exits.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.IPluginProcess.ExitCode">
<summary>
Gets the exit code if the process has exited; otherwise, <c>null</c>.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.IPluginProcess.Id">
<summary>
Gets the process ID if the process was started; otherwise, <c>null</c>.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.IPluginProcess.BeginReadLine">
<summary>
Asynchronously starts reading the standard output stream.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.IPluginProcess.CancelRead">
<summary>
Cancels asynchronous reading of the standard output stream.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.IPluginProcess.Kill">
<summary>
Stops the associated process.
</summary>
</member>
<member name="T:NuGet.Protocol.Plugins.IReceiver">
<summary>
Represents a unidirectional communications channel from a target.
</summary>
</member>
<member name="E:NuGet.Protocol.Plugins.IReceiver.Faulted">
<summary>
Occurs when an unrecoverable fault has been caught.
</summary>
</member>
<member name="E:NuGet.Protocol.Plugins.IReceiver.MessageReceived">
<summary>
Occurs when a message has been received.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.IReceiver.Close">
<summary>
Closes the connection.
</summary>
<remarks>This does not call <see cref="M:System.IDisposable.Dispose" />.</remarks>
</member>
<member name="M:NuGet.Protocol.Plugins.IReceiver.Connect">
<summary>
Connects.
</summary>
<exception cref="T:System.ObjectDisposedException">Thrown if this object is disposed.</exception>
<exception cref="T:System.InvalidOperationException">Thrown if this object is closed.</exception>
<exception cref="T:System.InvalidOperationException">Thrown if this method has already been called.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.IRequestHandler">
<summary>
Represents a request handler.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.IRequestHandler.CancellationToken">
<summary>
Gets the <see cref="P:NuGet.Protocol.Plugins.IRequestHandler.CancellationToken" /> for a request.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.IRequestHandler.HandleResponseAsync(NuGet.Protocol.Plugins.IConnection,NuGet.Protocol.Plugins.Message,NuGet.Protocol.Plugins.IResponseHandler,System.Threading.CancellationToken)">
<summary>
Asynchronously handles responding to a request.
</summary>
<param name="connection">The connection.</param>
<param name="request">A request message.</param>
<param name="responseHandler">A response handler.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.</returns>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="connection" />
is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="request" /> is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="responseHandler" />
is <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.IRequestHandlers">
<summary>
A set of <see cref="T:NuGet.Protocol.Plugins.IRequestHandler" />.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.IRequestHandlers.AddOrUpdate(NuGet.Protocol.Plugins.MessageMethod,System.Func{NuGet.Protocol.Plugins.IRequestHandler},System.Func{NuGet.Protocol.Plugins.IRequestHandler,NuGet.Protocol.Plugins.IRequestHandler})">
<summary>
Atomically add or update a request handler for the specified message method.
</summary>
<param name="method">A message method.</param>
<param name="addHandlerFunc">An add request handler function.</param>
<param name="updateHandlerFunc">An update request handler function.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="addHandlerFunc" />
is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="updateHandlerFunc" />
is <c>null</c>.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.IRequestHandlers.TryAdd(NuGet.Protocol.Plugins.MessageMethod,NuGet.Protocol.Plugins.IRequestHandler)">
<summary>
Attempts to add a request handler for the specified message method.
</summary>
<param name="method">A message method.</param>
<param name="handler">A request handler.</param>
<returns><c>true</c> if added; otherwise, <c>false</c>.</returns>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="handler" /> is <c>null</c>.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.IRequestHandlers.TryGet(NuGet.Protocol.Plugins.MessageMethod,NuGet.Protocol.Plugins.IRequestHandler@)">
<summary>
Attempts to get a request handler for the specified message method.
</summary>
<param name="method">A message method.</param>
<param name="handler">A request handler.</param>
<returns><c>true</c> if the request handler exists; otherwise, <c>false</c>.</returns>
</member>
<member name="M:NuGet.Protocol.Plugins.IRequestHandlers.TryRemove(NuGet.Protocol.Plugins.MessageMethod)">
<summary>
Attempts to remove a request handler for the specified message method.
</summary>
<param name="method">A message method.</param>
<returns><c>true</c> if a request handler was removed; otherwise, <c>false</c>.</returns>
</member>
<member name="T:NuGet.Protocol.Plugins.IResponseHandler">
<summary>
A response handler.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.IResponseHandler.SendResponseAsync``1(NuGet.Protocol.Plugins.Message,``0,System.Threading.CancellationToken)">
<summary>
Asynchronously handles responding to a request.
</summary>
<typeparam name="TPayload">The response payload type.</typeparam>
<param name="request">The request message.</param>
<param name="payload">The response payload.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.</returns>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="request" /> is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="payload" /> is <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.ISender">
<summary>
Represents a unidirectional communications to a target.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.ISender.Close">
<summary>
Closes the connection.
</summary>
<remarks>This does not call <see cref="M:System.IDisposable.Dispose" />.</remarks>
</member>
<member name="M:NuGet.Protocol.Plugins.ISender.Connect">
<summary>
Connects.
</summary>
<exception cref="T:System.ObjectDisposedException">Thrown if this object is disposed.</exception>
<exception cref="T:System.InvalidOperationException">Thrown if this object is closed.</exception>
<exception cref="T:System.InvalidOperationException">Thrown if this method has already been called.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.ISender.SendAsync(NuGet.Protocol.Plugins.Message,System.Threading.CancellationToken)">
<summary>
Asynchronously sends a message to the target.
</summary>
<param name="message">The message to send.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.</returns>
<exception cref="T:System.ObjectDisposedException">Thrown if this object is disposed.</exception>
<exception cref="T:System.InvalidOperationException">Thrown if <see cref="M:NuGet.Protocol.Plugins.ISender.Connect" /> has not been called.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="message" /> is <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.JsonSerializationUtilities">
<summary>
JSON serialization/deserialization utilities.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.JsonSerializationUtilities.Serializer">
<summary>
Gets the JSON serializer.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.JsonSerializationUtilities.Deserialize``1(System.String)">
<summary>
Deserializes an object from the provided JSON.
</summary>
<typeparam name="T">The deserialization type.</typeparam>
<param name="json">JSON to deserialize.</param>
<returns>An instance of <typeparamref name="T" />.</returns>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="json" />
is either <c>null</c> or an empty string.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.JsonSerializationUtilities.FromObject(System.Object)">
<summary>
Serializes an object.
</summary>
<param name="value">An object to serialize.</param>
<returns>A <see cref="T:Newtonsoft.Json.Linq.JObject" />.</returns>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="value" /> is <c>null</c>.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.JsonSerializationUtilities.Serialize(Newtonsoft.Json.JsonWriter,System.Object)">
<summary>
Serializes an object to the provided writer.
</summary>
<param name="writer">A JSON writer.</param>
<param name="value">The value to serialize.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="value" /> is <c>null</c>.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.JsonSerializationUtilities.ToObject``1(Newtonsoft.Json.Linq.JObject)">
<summary>
Deserializes an object.
</summary>
<typeparam name="T">The deserialization type.</typeparam>
<param name="jObject">A JSON object.</param>
<returns>An instance of <typeparamref name="T" />.</returns>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="jObject" /> is <c>null</c>.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.LineReadEventArgs">
<summary>
Line read event arguments.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.LineReadEventArgs.Line">
<summary>
The output line read.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.LineReadEventArgs.#ctor(System.String)">
<summary>
Instantiates a new <see cref="T:NuGet.Protocol.Plugins.LineReadEventArgs" /> class.
</summary>
<param name="line">The output line read.</param>
</member>
<member name="T:NuGet.Protocol.Plugins.MessageDispatcher">
<summary>
A message dispatcher that maintains state for outstanding requests
and routes messages to configured request handlers.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.MessageDispatcher.RequestHandlers">
<summary>
Gets the request handlers for use by the dispatcher.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.MessageDispatcher.#ctor(NuGet.Protocol.Plugins.IRequestHandlers,NuGet.Protocol.Plugins.IIdGenerator)">
<summary>
Instantiates a new <see cref="T:NuGet.Protocol.Plugins.MessageDispatcher" /> class.
</summary>
<param name="requestHandlers">Request handlers.</param>
<param name="idGenerator">A unique identifier generator.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="requestHandlers" />
is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="idGenerator" />
is <c>null</c>.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.MessageDispatcher.#ctor(NuGet.Protocol.Plugins.IRequestHandlers,NuGet.Protocol.Plugins.IIdGenerator,NuGet.Protocol.Plugins.InboundRequestProcessingHandler,NuGet.Protocol.Plugins.IPluginLogger)">
<summary>
Instantiates a new <see cref="T:NuGet.Protocol.Plugins.MessageDispatcher" /> class.
</summary>
<param name="requestHandlers">Request handlers.</param>
<param name="idGenerator">A unique identifier generator.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="requestHandlers" />
is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="idGenerator" />
is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="inboundRequestProcessingHandler" />
is <c>null</c>.</exception>
/// <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="logger" />
is <c>null</c>.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.MessageDispatcher.Dispose">
<summary>
Disposes of this instance.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.MessageDispatcher.Close">
<summary>
Closes the dispatcher.
</summary>
<remarks>This does not call <see cref="M:System.IDisposable.Dispose" />.</remarks>
</member>
<member name="M:NuGet.Protocol.Plugins.MessageDispatcher.CreateMessage(NuGet.Protocol.Plugins.MessageType,NuGet.Protocol.Plugins.MessageMethod)">
<summary>
Creates a message.
</summary>
<param name="type">The message type.</param>
<param name="method">The message method.</param>
<returns>A message.</returns>
</member>
<member name="M:NuGet.Protocol.Plugins.MessageDispatcher.CreateMessage``1(NuGet.Protocol.Plugins.MessageType,NuGet.Protocol.Plugins.MessageMethod,``0)">
<summary>
Creates a message.
</summary>
<typeparam name="TPayload">The message payload.</typeparam>
<param name="type">The message type.</param>
<param name="method">The message method.</param>
<param name="payload">The message payload.</param>
<returns>A message.</returns>
<exception cref="T:System.ArgumentNullException">Throws if <paramref name="payload" /> is <c>null</c>.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.MessageDispatcher.DispatchCancelAsync(NuGet.Protocol.Plugins.Message,System.Threading.CancellationToken)">
<summary>
Asynchronously dispatches a cancellation request for the specified request.
</summary>
<param name="request">The request.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.</returns>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="request" /> is <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.MessageDispatcher.DispatchFaultAsync(NuGet.Protocol.Plugins.Message,NuGet.Protocol.Plugins.Fault,System.Threading.CancellationToken)">
<summary>
Asynchronously dispatches a fault notification for the specified request.
</summary>
<param name="request">The cancel request.</param>
<param name="fault">The fault payload.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.</returns>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="fault" /> is <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.MessageDispatcher.DispatchProgressAsync(NuGet.Protocol.Plugins.Message,NuGet.Protocol.Plugins.Progress,System.Threading.CancellationToken)">
<summary>
Asynchronously dispatches a progress notification for the specified request.
</summary>
<param name="request">The request.</param>
<param name="progress">The progress payload.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.</returns>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="request" /> is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="progress" /> is <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.MessageDispatcher.DispatchRequestAsync``2(NuGet.Protocol.Plugins.MessageMethod,``0,System.Threading.CancellationToken)">
<summary>
Asynchronously dispatches a request.
</summary>
<typeparam name="TOutbound">The request payload type.</typeparam>
<typeparam name="TInbound">The expected response payload type.</typeparam>
<param name="method">The request method.</param>
<param name="payload">The request payload.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns a <typeparamref name="TInbound" />
from the target.</returns>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.MessageDispatcher.DispatchResponseAsync``1(NuGet.Protocol.Plugins.Message,``0,System.Threading.CancellationToken)">
<summary>
Asynchronously dispatches a response.
</summary>
<typeparam name="TOutbound">The request payload type.</typeparam>
<param name="request">The associated request.</param>
<param name="responsePayload">The response payload.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.</returns>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="request" /> is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="responsePayload" /> is <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.MessageDispatcher.SetConnection(NuGet.Protocol.Plugins.IConnection)">
<summary>
Sets the connection to be used for dispatching messages.
</summary>
<param name="connection">A connection instance. Can be <c>null</c>.</param>
</member>
<member name="T:NuGet.Protocol.Plugins.MessageEventArgs">
<summary>
Message event arguments.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.MessageEventArgs.Message">
<summary>
Gets the message.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.MessageEventArgs.#ctor(NuGet.Protocol.Plugins.Message)">
<summary>
Instantiates a new <see cref="T:NuGet.Protocol.Plugins.MessageEventArgs" /> class.
</summary>
<param name="message">A message.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="message" /> is <c>null</c>.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.MessageMethod">
<summary>
Message methods.
</summary>
</member>
<member name="F:NuGet.Protocol.Plugins.MessageMethod.None">
<summary>
None
</summary>
</member>
<member name="F:NuGet.Protocol.Plugins.MessageMethod.Close">
<summary>
Close
</summary>
</member>
<member name="F:NuGet.Protocol.Plugins.MessageMethod.CopyFilesInPackage">
<summary>
Copy files in a package
</summary>
</member>
<member name="F:NuGet.Protocol.Plugins.MessageMethod.CopyNupkgFile">
<summary>
Copy a .nupkg file
</summary>
</member>
<member name="F:NuGet.Protocol.Plugins.MessageMethod.GetCredentials">
<summary>
Get credentials
</summary>
</member>
<member name="F:NuGet.Protocol.Plugins.MessageMethod.GetFilesInPackage">
<summary>
Get files in a package
</summary>
</member>
<member name="F:NuGet.Protocol.Plugins.MessageMethod.GetOperationClaims">
<summary>
Get operation claims
</summary>
</member>
<member name="F:NuGet.Protocol.Plugins.MessageMethod.GetPackageHash">
<summary>
Get package hash
</summary>
</member>
<member name="F:NuGet.Protocol.Plugins.MessageMethod.GetPackageVersions">
<summary>
Get package versions
</summary>
</member>
<member name="F:NuGet.Protocol.Plugins.MessageMethod.GetServiceIndex">
<summary>
Get service index
</summary>
</member>
<member name="F:NuGet.Protocol.Plugins.MessageMethod.Handshake">
<summary>
Handshake
</summary>
</member>
<member name="F:NuGet.Protocol.Plugins.MessageMethod.Initialize">
<summary>
Initialize
</summary>
</member>
<member name="F:NuGet.Protocol.Plugins.MessageMethod.Log">
<summary>
Log
</summary>
</member>
<member name="F:NuGet.Protocol.Plugins.MessageMethod.MonitorNuGetProcessExit">
<summary>
Monitor NuGet process exit
</summary>
</member>
<member name="F:NuGet.Protocol.Plugins.MessageMethod.PrefetchPackage">
<summary>
Prefetch a package
</summary>
</member>
<member name="F:NuGet.Protocol.Plugins.MessageMethod.SetCredentials">
<summary>
Set credentials
</summary>
</member>
<member name="F:NuGet.Protocol.Plugins.MessageMethod.SetLogLevel">
<summary>
Set log level
</summary>
</member>
<member name="F:NuGet.Protocol.Plugins.MessageMethod.GetAuthenticationCredentials">
<summary>
Get authentication credentials, for authentication operation
</summary>
</member>
<member name="T:NuGet.Protocol.Plugins.MessageResponseCode">
<summary>
Message response codes.
</summary>
</member>
<member name="F:NuGet.Protocol.Plugins.MessageResponseCode.Success">
<summary>
The response is success.
</summary>
</member>
<member name="F:NuGet.Protocol.Plugins.MessageResponseCode.Error">
<summary>
The response is error.
</summary>
</member>
<member name="F:NuGet.Protocol.Plugins.MessageResponseCode.NotFound">
<summary>
The response is not found.
</summary>
</member>
<member name="T:NuGet.Protocol.Plugins.CopyFilesInPackageRequest">
<summary>
A request to copy files in a package to a specified destination.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.CopyFilesInPackageRequest.DestinationFolderPath">
<summary>
Gets the destination folder path.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.CopyFilesInPackageRequest.FilesInPackage">
<summary>
Gets the files in the package to be copied.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.CopyFilesInPackageRequest.PackageId">
<summary>
Gets the package ID.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.CopyFilesInPackageRequest.PackageSourceRepository">
<summary>
Gets the package source repository location.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.CopyFilesInPackageRequest.PackageVersion">
<summary>
Gets the package version.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.CopyFilesInPackageRequest.#ctor(System.String,System.String,System.String,System.Collections.Generic.IEnumerable{System.String},System.String)">
<summary>
Initializes a new <see cref="T:NuGet.Protocol.Plugins.CopyFilesInPackageRequest" /> class.
</summary>
<param name="packageSourceRepository">The package source repository location.</param>
<param name="packageId">The package ID.</param>
<param name="packageVersion">The package version.</param>
<param name="filesInPackage">The files in the package to be copied.</param>
<param name="destinationFolderPath">The destination folder path.</param>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="packageSourceRepository" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="packageId" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="packageVersion" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="filesInPackage" />
is either <c>null</c> or empty.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="destinationFolderPath" />
is either <c>null</c> or an empty string.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.CopyFilesInPackageResponse">
<summary>
A response to a copy package files request.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.CopyFilesInPackageResponse.CopiedFiles">
<summary>
Gets the paths of files copies.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.CopyFilesInPackageResponse.ResponseCode">
<summary>
Gets the response code.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.CopyFilesInPackageResponse.#ctor(NuGet.Protocol.Plugins.MessageResponseCode,System.Collections.Generic.IEnumerable{System.String})">
<summary>
Initializes a new <see cref="T:NuGet.Protocol.Plugins.CopyFilesInPackageResponse" /> class.
</summary>
<param name="responseCode">The response code.</param>
<param name="copiedFiles">The paths of files copies.</param>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="responseCode" />
is an undefined <see cref="T:NuGet.Protocol.Plugins.MessageResponseCode" /> value.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="responseCode" />
is <see cref="F:NuGet.Protocol.Plugins.MessageResponseCode.Success" /> and <paramref name="copiedFiles" />
is either <c>null</c> or empty.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.CopyNupkgFileRequest">
<summary>
A request to copy a .nupkg file.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.CopyNupkgFileRequest.DestinationFilePath">
<summary>
Gets the destination file path for the .nupkg file.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.CopyNupkgFileRequest.PackageId">
<summary>
Gets the package ID.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.CopyNupkgFileRequest.PackageSourceRepository">
<summary>
Gets the package source repository location.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.CopyNupkgFileRequest.PackageVersion">
<summary>
Gets the package version.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.CopyNupkgFileRequest.#ctor(System.String,System.String,System.String,System.String)">
<summary>
Initializes a new <see cref="T:NuGet.Protocol.Plugins.CopyNupkgFileRequest" /> class.
</summary>
<param name="packageSourceRepository">The package source repository location.</param>
<param name="packageId">The package ID.</param>
<param name="packageVersion">The package version.</param>
<param name="destinationFilePath">The destination file path for the .nupkg file.</param>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="packageSourceRepository" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="packageId" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="packageVersion" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="destinationFilePath" />
is either <c>null</c> or an empty string.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.CopyNupkgFileResponse">
<summary>
A response to a copy .nupkg file request.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.CopyNupkgFileResponse.ResponseCode">
<summary>
Gets the response code.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.CopyNupkgFileResponse.#ctor(NuGet.Protocol.Plugins.MessageResponseCode)">
<summary>
Initializes a new <see cref="T:NuGet.Protocol.Plugins.CopyNupkgFileResponse" /> class.
</summary>
<param name="responseCode">The response code.</param>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="responseCode" />
is an undefined <see cref="T:NuGet.Protocol.Plugins.MessageResponseCode" /> value.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.Fault">
<summary>
A notification indicating the sender has experienced an unrecoverable fault.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.Fault.Message">
<summary>
Gets the fault message.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.Fault.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:NuGet.Protocol.Plugins.Fault" /> class.
</summary>
<param name="message">The fault message.</param>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="message" />
is either <c>null</c> or an empty string.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.GetAuthenticationCredentialsRequest">
<summary>
A get authentication credentials request
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.GetAuthenticationCredentialsRequest.Uri">
<summary>
Uri
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.GetAuthenticationCredentialsRequest.IsRetry">
<summary>
isRetry
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.GetAuthenticationCredentialsRequest.IsNonInteractive">
<summary>
IsNonInteractive - tells the plugin whether it can block the operation to ask for user input. Be it a device flow request or a pop-up.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.GetAuthenticationCredentialsRequest.CanShowDialog">
<summary>
CanShowDialog - tells the plugin whether it can show a dialog if the plugin is run in interactive mode. This being false normally means that the auth method should be device flow.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.GetAuthenticationCredentialsRequest.#ctor(System.Uri,System.Boolean,System.Boolean,System.Boolean)">
<summary>
Create a GetAuthenticationCredentialsRequest
</summary>
<param name="uri"></param>
<param name="isRetry"></param>
<param name="isNonInteractive"></param>
<exception cref="T:System.ArgumentNullException"> if <paramref name="uri" /> is null</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.GetAuthenticationCredentialsResponse">
<summary>
A get authentication credentials response
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.GetAuthenticationCredentialsResponse.Username">
<summary>
Username
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.GetAuthenticationCredentialsResponse.Password">
<summary>
password token
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.GetAuthenticationCredentialsResponse.Message">
<summary>
message - optional, can be used as a way to communicate to NuGet why the authentication failed.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.GetAuthenticationCredentialsResponse.AuthenticationTypes">
<summary>
Gets or sets the list of authentication types this credential is applicable to. Useful values include
<c>basic</c>, <c>digest</c>, <c>negotiate</c>, and <c>ntlm</c>
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.GetAuthenticationCredentialsResponse.ResponseCode">
<summary>
ResponseCode - status of the credentials
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.GetAuthenticationCredentialsResponse.#ctor(System.String,System.String,System.String,System.Collections.Generic.IList{System.String},NuGet.Protocol.Plugins.MessageResponseCode)">
<summary>
Create a response object
</summary>
<param name="username"></param>
<param name="password"></param>
<param name="message"></param>
<param name="authenticationTypes"></param>
<param name="responseCode"></param>
<exception cref="T:System.ArgumentException">If MessageResponseCode is not defined on this runtime</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.GetAuthenticationCredentialsResponse.IsValid">
<summary>
Gets a value indicating whether the provider returnd a valid response.
</summary>
<remarks>
Either Username or Password (or both) must be set, and AuthTypes must either be null or contain at least
one element
</remarks>
</member>
<member name="T:NuGet.Protocol.Plugins.GetCredentialsRequest">
<summary>
A request to get credentials.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.GetCredentialsRequest.PackageSourceRepository">
<summary>
Gets the package source repository location.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.GetCredentialsRequest.StatusCode">
<summary>
Gets the HTTP status code that necessitates credentials.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.GetCredentialsRequest.#ctor(System.String,System.Net.HttpStatusCode)">
<summary>
Initializes a new <see cref="T:NuGet.Protocol.Plugins.GetCredentialsRequest" /> class.
</summary>
<param name="packageSourceRepository">The package source repository location.</param>
<param name="statusCode">The HTTP status code.</param>
</member>
<member name="T:NuGet.Protocol.Plugins.GetCredentialsResponse">
<summary>
A response to a get credentials request.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.GetCredentialsResponse.Password">
<summary>
Gets the password.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.GetCredentialsResponse.ResponseCode">
<summary>
Gets the response code.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.GetCredentialsResponse.Username">
<summary>
Gets the username.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.GetCredentialsResponse.#ctor(NuGet.Protocol.Plugins.MessageResponseCode,System.String,System.String,System.Collections.Generic.IReadOnlyList{System.String})">
<summary>
Initializes a new instance of the <see cref="T:NuGet.Protocol.Plugins.GetCredentialsResponse" /> class.
</summary>
<param name="responseCode">The plugin's response code.</param>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="responseCode" />
is an undefined <see cref="T:NuGet.Protocol.Plugins.MessageResponseCode" /> value.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.GetFilesInPackageRequest">
<summary>
A get files in package request.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.GetFilesInPackageRequest.PackageId">
<summary>
Gets the package ID.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.GetFilesInPackageRequest.PackageSourceRepository">
<summary>
Gets the package source repository location.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.GetFilesInPackageRequest.PackageVersion">
<summary>
Gets the package version.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.GetFilesInPackageRequest.#ctor(System.String,System.String,System.String)">
<summary>
Initializes a new <see cref="T:NuGet.Protocol.Plugins.GetFilesInPackageRequest" /> class.
</summary>
<param name="packageSourceRepository">The package source repository location.</param>
<param name="packageId">The package ID.</param>
<param name="packageVersion">The package version.</param>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="packageSourceRepository" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="packageId" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="packageVersion" />
is either <c>null</c> or an empty string.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.GetFilesInPackageResponse">
<summary>
A response to a get files in package request.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.GetFilesInPackageResponse.Files">
<summary>
Gets the paths of files in the package.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.GetFilesInPackageResponse.ResponseCode">
<summary>
Gets the response code.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.GetFilesInPackageResponse.#ctor(NuGet.Protocol.Plugins.MessageResponseCode,System.Collections.Generic.IEnumerable{System.String})">
<summary>
Initializes a new <see cref="T:NuGet.Protocol.Plugins.GetFilesInPackageResponse" /> class.
</summary>
<param name="responseCode">The response code.</param>
<param name="files">The paths of files in the package.</param>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="responseCode" />
is an undefined <see cref="T:NuGet.Protocol.Plugins.MessageResponseCode" /> value.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="responseCode" />
is <see cref="F:NuGet.Protocol.Plugins.MessageResponseCode.Success" /> and <paramref name="files" />
is either <c>null</c> or empty.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.GetOperationClaimsRequest">
<summary>
A query to a plugin about which operations it supports for a specific package source.
In version 1.0.0, the fields are required. That's not the case for version 2.0.0
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.GetOperationClaimsRequest.PackageSourceRepository">
<summary>
Gets the package source repository location for the <see cref="P:NuGet.Protocol.Plugins.GetOperationClaimsRequest.ServiceIndex" />.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.GetOperationClaimsRequest.ServiceIndex">
<summary>
Gets the service index (index.json) for the <see cref="P:NuGet.Protocol.Plugins.GetOperationClaimsRequest.PackageSourceRepository" />.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.GetOperationClaimsRequest.#ctor(System.String,Newtonsoft.Json.Linq.JObject)">
<summary>
Initializes a new instance of the <see cref="T:NuGet.Protocol.Plugins.GetOperationClaimsRequest" /> class.
</summary>
<param name="packageSourceRepository">The package source location.</param>
<param name="serviceIndex">The service index (index.json).</param>
<remarks>Both packageSourceRepository and service index can be null. If they are, the operation claims request is considered as source agnostic</remarks>
</member>
<member name="T:NuGet.Protocol.Plugins.GetOperationClaimsResponse">
<summary>
A plugin's response as to which operations it supports for a specific package source.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.GetOperationClaimsResponse.Claims">
<summary>
Gets the plugin's operation claims.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.GetOperationClaimsResponse.#ctor(System.Collections.Generic.IEnumerable{NuGet.Protocol.Plugins.OperationClaim})">
<summary>
Initializes a new instance of the <see cref="T:NuGet.Protocol.Plugins.GetOperationClaimsResponse" /> class.
</summary>
<param name="claims">The operation claims.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="claims" /> is <c>null</c>.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="claims" /> contains
undefined <see cref="T:NuGet.Protocol.Plugins.OperationClaim" /> values.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.GetPackageHashRequest">
<summary>
A request to get a package hash.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.GetPackageHashRequest.HashAlgorithm">
<summary>
Gets the hash algorithm.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.GetPackageHashRequest.PackageId">
<summary>
Gets the package ID.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.GetPackageHashRequest.PackageSourceRepository">
<summary>
Gets the package source repository location.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.GetPackageHashRequest.PackageVersion">
<summary>
Gets the package version.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.GetPackageHashRequest.#ctor(System.String,System.String,System.String,System.String)">
<summary>
Initializes a new <see cref="T:NuGet.Protocol.Plugins.GetPackageHashRequest" /> class.
</summary>
<param name="packageSourceRepository">The package source repository location.</param>
<param name="packageId">The package ID.</param>
<param name="packageVersion">The package version.</param>
<param name="hashAlgorithm">The hash algorithm.</param>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="packageSourceRepository" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="packageId" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="packageVersion" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="hashAlgorithm" />
is either <c>null</c> or an empty string.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.GetPackageHashResponse">
<summary>
A response to a get package hash request.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.GetPackageHashResponse.Hash">
<summary>
Gets the package hash.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.GetPackageHashResponse.ResponseCode">
<summary>
Gets the response code.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.GetPackageHashResponse.#ctor(NuGet.Protocol.Plugins.MessageResponseCode,System.String)">
<summary>
Initializes a new <see cref="T:NuGet.Protocol.Plugins.GetPackageHashResponse" /> class.
</summary>
<param name="responseCode">The response code.</param>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="responseCode" />
is an undefined <see cref="T:NuGet.Protocol.Plugins.MessageResponseCode" /> value.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="responseCode" />
is <see cref="F:NuGet.Protocol.Plugins.MessageResponseCode.Success" /> and <paramref name="hash" />
is either <c>null</c> or empty.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.GetPackageVersionsRequest">
<summary>
A request for package versions.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.GetPackageVersionsRequest.PackageId">
<summary>
Gets the package ID.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.GetPackageVersionsRequest.PackageSourceRepository">
<summary>
Gets the package source repository location.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.GetPackageVersionsRequest.#ctor(System.String,System.String)">
<summary>
Initializes a new <see cref="T:NuGet.Protocol.Plugins.GetPackageVersionsRequest" /> class.
</summary>
<param name="packageSourceRepository">The package source repository location.</param>
<param name="packageId">The package ID.</param>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="packageSourceRepository" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="packageId" />
is either <c>null</c> or an empty string.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.GetPackageVersionsResponse">
<summary>
A response to a get package versions request.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.GetPackageVersionsResponse.ResponseCode">
<summary>
Gets the response code.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.GetPackageVersionsResponse.Versions">
<summary>
Gets the package versions.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.GetPackageVersionsResponse.#ctor(NuGet.Protocol.Plugins.MessageResponseCode,System.Collections.Generic.IEnumerable{System.String})">
<summary>
Initializes a new <see cref="T:NuGet.Protocol.Plugins.GetPackageVersionsResponse" /> class.
</summary>
<param name="responseCode">The response code.</param>
<param name="versions">The package versions.</param>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="responseCode" />
is an undefined <see cref="T:NuGet.Protocol.Plugins.MessageResponseCode" /> value.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="responseCode" />
is <see cref="F:NuGet.Protocol.Plugins.MessageResponseCode.Success" /> and <paramref name="versions" />
is either <c>null</c> or empty.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.GetServiceIndexRequest">
<summary>
A request to get the service index for a package source repository.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.GetServiceIndexRequest.PackageSourceRepository">
<summary>
Gets the package source repository location.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.GetServiceIndexRequest.#ctor(System.String)">
<summary>
Initializes a new <see cref="T:NuGet.Protocol.Plugins.GetServiceIndexRequest" /> class.
</summary>
<param name="packageSourceRepository">The package source repository location.</param>
</member>
<member name="T:NuGet.Protocol.Plugins.GetServiceIndexResponse">
<summary>
A response to a get service index request.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.GetServiceIndexResponse.ResponseCode">
<summary>
Gets the response code.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.GetServiceIndexResponse.ServiceIndex">
<summary>
Gets the service index (index.json) for the package source repository.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.GetServiceIndexResponse.#ctor(NuGet.Protocol.Plugins.MessageResponseCode,Newtonsoft.Json.Linq.JObject)">
<summary>
Initializes a new instance of the <see cref="T:NuGet.Protocol.Plugins.GetServiceIndexResponse" /> class.
</summary>
<param name="responseCode">The response code.</param>
<param name="serviceIndex">The service index (index.json) for the package source repository.</param>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="responseCode" />
is an undefined <see cref="T:NuGet.Protocol.Plugins.MessageResponseCode" /> value.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="responseCode" />
is <see cref="F:NuGet.Protocol.Plugins.MessageResponseCode.Success" /> and <paramref name="serviceIndex" />
is <c>null</c>.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.HandshakeRequest">
<summary>
A handshake request.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.HandshakeRequest.ProtocolVersion">
<summary>
Gets the requestor's plugin protocol version.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.HandshakeRequest.MinimumProtocolVersion">
<summary>
Gets the requestor's minimum plugin protocol version.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.HandshakeRequest.#ctor(NuGet.Versioning.SemanticVersion,NuGet.Versioning.SemanticVersion)">
<summary>
Initializes a new instance of the <see cref="T:NuGet.Protocol.Plugins.HandshakeRequest" /> class.
</summary>
<param name="protocolVersion">The requestor's plugin protocol version.</param>
<param name="minimumProtocolVersion">The requestor's minimum plugin protocol version.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="protocolVersion" />
is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="minimumProtocolVersion" />
is <c>null</c>.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">Thrown if <paramref name="protocolVersion" />
is less than <paramref name="minimumProtocolVersion" />.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.HandshakeResponse">
<summary>
A handshake response.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.HandshakeResponse.ResponseCode">
<summary>
Gets the handshake responder's handshake response code.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.HandshakeResponse.ProtocolVersion">
<summary>
Gets the handshake responder's plugin protocol version if the handshake was successful;
otherwise, <c>null</c>.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.HandshakeResponse.#ctor(NuGet.Protocol.Plugins.MessageResponseCode,NuGet.Versioning.SemanticVersion)">
<summary>
Initializes a new instance of the <see cref="T:NuGet.Protocol.Plugins.HandshakeResponse" /> class.
</summary>
<param name="responseCode">The handshake responder's handshake response code.</param>
<param name="protocolVersion">The handshake responder's plugin protocol version
if the handshake was successful; otherwise, <c>null</c>.</param>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="responseCode" />
is an undefined <see cref="T:NuGet.Protocol.Plugins.MessageResponseCode" /> value.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="responseCode" />
is <see cref="F:NuGet.Protocol.Plugins.MessageResponseCode.Success" /> and <paramref name="protocolVersion" />
is <c>null</c>.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="responseCode" />
is not <see cref="F:NuGet.Protocol.Plugins.MessageResponseCode.Success" /> and <paramref name="protocolVersion" />
is not <c>null</c>.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.InitializeRequest">
<summary>
An initialization request to a plugin.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.InitializeRequest.ClientVersion">
<summary>
Gets the requestor's NuGet client version.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.InitializeRequest.Culture">
<summary>
Gets the requestor's current culture.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.InitializeRequest.RequestTimeout">
<summary>
Gets the default request timeout for all subsequent requests.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.InitializeRequest.#ctor(System.String,System.String,System.TimeSpan)">
<summary>
Initializes a new instance of the <see cref="T:NuGet.Protocol.Plugins.InitializeRequest" /> class.
</summary>
<param name="clientVersion">The requestor's NuGet client version.</param>
<param name="culture">The requestor's current culture.</param>
<param name="requestTimeout">The default request timeout.</param>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="clientVersion" /> is either <c>null</c>
or an empty string.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="culture" /> is either <c>null</c>
or an empty string.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">Thrown if <paramref name="requestTimeout" />
is either less than <see cref="F:NuGet.Protocol.Plugins.ProtocolConstants.MinTimeout" /> or greater than
<see cref="F:NuGet.Protocol.Plugins.ProtocolConstants.MaxTimeout" />.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.InitializeResponse">
<summary>
An initialization response from a plugin.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.InitializeResponse.ResponseCode">
<summary>
Gets the plugin's initialization response code.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.InitializeResponse.#ctor(NuGet.Protocol.Plugins.MessageResponseCode)">
<summary>
Initializes a new instance of the <see cref="T:NuGet.Protocol.Plugins.InitializeResponse" /> class.
</summary>
<param name="responseCode">The plugin's initialization response code.</param>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="responseCode" />
is an undefined <see cref="T:NuGet.Protocol.Plugins.MessageResponseCode" /> value.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.LogRequest">
<summary>
A logging request.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.LogRequest.LogLevel">
<summary>
Gets the logging level for the message.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.LogRequest.Message">
<summary>
Gets the message.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.LogRequest.#ctor(NuGet.Common.LogLevel,System.String)">
<summary>
Initializes a new instance of the <see cref="T:NuGet.Protocol.Plugins.LogRequest" /> class.
</summary>
<param name="logLevel">The logging level for the message.</param>
<param name="message">The message to be logged.</param>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="logLevel" /> is an undefined
<see cref="P:NuGet.Protocol.Plugins.LogRequest.LogLevel" /> value.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="message" /> is either <c>null</c>
or an empty string.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.LogResponse">
<summary>
A logging response.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.LogResponse.ResponseCode">
<summary>
Gets the logging response code.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.LogResponse.#ctor(NuGet.Protocol.Plugins.MessageResponseCode)">
<summary>
Initializes a new instance of the <see cref="T:NuGet.Protocol.Plugins.LogResponse" /> class.
</summary>
<param name="responseCode">The logging response code.</param>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="responseCode" />
is an undefined <see cref="T:NuGet.Protocol.Plugins.MessageResponseCode" /> value.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.Message">
<summary>
Represents a message between a NuGet client and a plugin.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.Message.RequestId">
<summary>
Gets the request ID.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.Message.Type">
<summary>
Gets the message type.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.Message.Method">
<summary>
Gets the message method.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.Message.Payload">
<summary>
Gets the optional message payload.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.Message.#ctor(System.String,NuGet.Protocol.Plugins.MessageType,NuGet.Protocol.Plugins.MessageMethod,Newtonsoft.Json.Linq.JObject)">
<summary>
Initializes a new instance of the <see cref="T:NuGet.Protocol.Plugins.Message" /> class.
</summary>
<param name="requestId">The request ID.</param>
<param name="type">The message type.</param>
<param name="method">The message method.</param>
<param name="payload">An optional message payload.</param>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="requestId" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="type" />
is an undefined <see cref="T:NuGet.Protocol.Plugins.MessageType" /> value.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="method" />
is an undefined <see cref="T:NuGet.Protocol.Plugins.MessageMethod" /> value.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.MonitorNuGetProcessExitRequest">
<summary>
A request to monitor a NuGet process exit.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.MonitorNuGetProcessExitRequest.ProcessId">
<summary>
Gets the process ID.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.MonitorNuGetProcessExitRequest.#ctor(System.Int32)">
<summary>
Initializes a new <see cref="T:NuGet.Protocol.Plugins.MonitorNuGetProcessExitRequest" /> class.
</summary>
<param name="processId">The process ID.</param>
</member>
<member name="T:NuGet.Protocol.Plugins.MonitorNuGetProcessExitResponse">
<summary>
A response to a monitor NuGet process exit request.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.MonitorNuGetProcessExitResponse.ResponseCode">
<summary>
Gets the response code.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.MonitorNuGetProcessExitResponse.#ctor(NuGet.Protocol.Plugins.MessageResponseCode)">
<summary>
Initializes a new instance of the <see cref="T:NuGet.Protocol.Plugins.MonitorNuGetProcessExitResponse" /> class.
</summary>
<param name="responseCode">The plugin's response code.</param>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="responseCode" />
is an undefined <see cref="T:NuGet.Protocol.Plugins.MessageResponseCode" /> value.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.PrefetchPackageRequest">
<summary>
A request to a plugin to prefetch a package.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.PrefetchPackageRequest.PackageId">
<summary>
Gets the package ID.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.PrefetchPackageRequest.PackageSourceRepository">
<summary>
Gets the package source repository location.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.PrefetchPackageRequest.PackageVersion">
<summary>
Gets the package version.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.PrefetchPackageRequest.#ctor(System.String,System.String,System.String)">
<summary>
Initializes a new <see cref="T:NuGet.Protocol.Plugins.PrefetchPackageRequest" /> class.
</summary>
<param name="packageSourceRepository">The package source repository location.</param>
<param name="packageId">The package ID.</param>
<param name="packageVersion">The package version.</param>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="packageSourceRepository" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="packageId" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="packageVersion" />
is either <c>null</c> or an empty string.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.PrefetchPackageResponse">
<summary>
A plugin's response to a package prefetch request.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.PrefetchPackageResponse.ResponseCode">
<summary>
Gets the plugin's response code.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.PrefetchPackageResponse.#ctor(NuGet.Protocol.Plugins.MessageResponseCode)">
<summary>
Initializes a new instance of the <see cref="T:NuGet.Protocol.Plugins.PrefetchPackageResponse" /> class.
</summary>
<param name="responseCode">The plugin's response code.</param>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="responseCode" />
is an undefined <see cref="T:NuGet.Protocol.Plugins.MessageResponseCode" /> value.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.Progress">
<summary>
A progress notification.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.Progress.Percentage">
<summary>
Gets the progress percentage.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.Progress.#ctor(System.Nullable{System.Double})">
<summary>
Initializes a new instance of the <see cref="T:NuGet.Protocol.Plugins.Progress" /> class.
</summary>
<param name="percentage">The progress percentage.</param>
</member>
<member name="T:NuGet.Protocol.Plugins.SetCredentialsRequest">
<summary>
A request to set credentials for a package source with any last known good credentials.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.SetCredentialsRequest.PackageSourceRepository">
<summary>
Gets the package source repository location.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.SetCredentialsRequest.Password">
<summary>
Gets the package source repository password.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.SetCredentialsRequest.ProxyPassword">
<summary>
Gets the proxy password.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.SetCredentialsRequest.ProxyUsername">
<summary>
Gets the proxy username.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.SetCredentialsRequest.Username">
<summary>
Gets the package source repository username.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.SetCredentialsRequest.#ctor(System.String,System.String,System.String,System.String,System.String)">
<summary>
Initializes a new <see cref="T:NuGet.Protocol.Plugins.SetCredentialsRequest" /> class.
</summary>
<param name="packageSourceRepository">The package source repository location.</param>
<param name="proxyUsername">The proxy username.</param>
<param name="proxyPassword">The proxy password.</param>
<param name="username">The package source repository username.</param>
<param name="password">The package source repository password.</param>
</member>
<member name="T:NuGet.Protocol.Plugins.SetCredentialsResponse">
<summary>
A plugin's response to a set credentials request.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.SetCredentialsResponse.ResponseCode">
<summary>
Gets the plugin's response code.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.SetCredentialsResponse.#ctor(NuGet.Protocol.Plugins.MessageResponseCode)">
<summary>
Initializes a new instance of the <see cref="T:NuGet.Protocol.Plugins.SetCredentialsResponse" /> class.
</summary>
<param name="responseCode">The plugin's response code.</param>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="responseCode" />
is an undefined <see cref="T:NuGet.Protocol.Plugins.MessageResponseCode" /> value.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.SetLogLevelRequest">
<summary>
A request to set the log level.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.SetLogLevelRequest.LogLevel">
<summary>
Gets the log level.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.SetLogLevelRequest.#ctor(NuGet.Common.LogLevel)">
<summary>
Initializes a new <see cref="T:NuGet.Protocol.Plugins.SetLogLevelRequest" /> class.
</summary>
<param name="logLevel">The log level.</param>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="logLevel" /> is an undefined
<see cref="P:NuGet.Protocol.Plugins.SetLogLevelRequest.LogLevel" /> value.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.SetLogLevelResponse">
<summary>
A response to a log level set request.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.SetLogLevelResponse.ResponseCode">
<summary>
Gets the response code.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.SetLogLevelResponse.#ctor(NuGet.Protocol.Plugins.MessageResponseCode)">
<summary>
Initializes a new <see cref="T:NuGet.Protocol.Plugins.SetLogLevelResponse" /> class.
</summary>
<param name="responseCode">The response code.</param>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="responseCode" />
is an undefined <see cref="T:NuGet.Protocol.Plugins.MessageResponseCode" /> value.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.MessageType">
<summary>
Message types.
</summary>
</member>
<member name="F:NuGet.Protocol.Plugins.MessageType.Cancel">
<summary>
A cancellation request for an existing request.
</summary>
</member>
<member name="F:NuGet.Protocol.Plugins.MessageType.Fault">
<summary>
A fault notification, either standalone or for an existing request.
</summary>
</member>
<member name="F:NuGet.Protocol.Plugins.MessageType.Progress">
<summary>
A progress notification for an existing request.
</summary>
</member>
<member name="F:NuGet.Protocol.Plugins.MessageType.Request">
<summary>
A request.
</summary>
</member>
<member name="F:NuGet.Protocol.Plugins.MessageType.Response">
<summary>
A response for an existing request.
</summary>
</member>
<member name="T:NuGet.Protocol.Plugins.MessageUtilities">
<summary>
Helper methods for messages.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.MessageUtilities.Create(System.String,NuGet.Protocol.Plugins.MessageType,NuGet.Protocol.Plugins.MessageMethod)">
<summary>
Instantiates a new <see cref="T:NuGet.Protocol.Plugins.Message" /> class.
</summary>
<param name="requestId">The message request ID.</param>
<param name="type">The message type.</param>
<param name="method">The message method.</param>
<returns>a <see cref="T:NuGet.Protocol.Plugins.Message" /> instance.</returns>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="requestId" />
is either <c>null</c> or an empty string.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.MessageUtilities.Create``1(System.String,NuGet.Protocol.Plugins.MessageType,NuGet.Protocol.Plugins.MessageMethod,``0)">
<summary>
Instantiates a new <see cref="T:NuGet.Protocol.Plugins.Message" /> class.
</summary>
<typeparam name="TPayload">The message payload type.</typeparam>
<param name="requestId">The message request ID.</param>
<param name="type">The message type.</param>
<param name="method">The message method.</param>
<param name="payload">The message payload.</param>
<returns>a <see cref="T:NuGet.Protocol.Plugins.Message" /> instance.</returns>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="requestId" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="payload" /> is <c>null</c>.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.MessageUtilities.DeserializePayload``1(NuGet.Protocol.Plugins.Message)">
<summary>
Deserializes a message payload.
</summary>
<typeparam name="TPayload">The message payload type.</typeparam>
<param name="message">The message.</param>
<returns>The deserialized message payload of type <typeparamref name="TPayload" />
or <c>null</c> if no payload exists.</returns>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="message" /> is <c>null</c>.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.NoOpDisposePlugin">
<summary>
A plugin wrapper that no-ops IDisposable.
</summary>
</member>
<member name="E:NuGet.Protocol.Plugins.NoOpDisposePlugin.BeforeClose">
<summary>
Occurs before the plugin closes.
</summary>
</member>
<member name="E:NuGet.Protocol.Plugins.NoOpDisposePlugin.Closed">
<summary>
Occurs when the plugin has closed.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.NoOpDisposePlugin.Connection">
<summary>
Gets the connection for the plugin.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.NoOpDisposePlugin.FilePath">
<summary>
Gets the file path for the plugin.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.NoOpDisposePlugin.Id">
<summary>
Gets the unique identifier for the plugin.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.NoOpDisposePlugin.Name">
<summary>
Gets the name of the plugin.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.NoOpDisposePlugin.#ctor(NuGet.Protocol.Plugins.IPlugin)">
<summary>
Instantiates a new <see cref="T:NuGet.Protocol.Plugins.NoOpDisposePlugin" /> class.
</summary>
<param name="plugin">A plugin</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="plugin" /> is <c>null</c>.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.NoOpDisposePlugin.Dispose">
<summary>
Does nothing.
</summary>
<remarks>Plugin disposal is implemented elsewhere.</remarks>
</member>
<member name="M:NuGet.Protocol.Plugins.NoOpDisposePlugin.Close">
<summary>
Closes the plugin.
</summary>
<remarks>This does not call <see cref="M:System.IDisposable.Dispose" />.</remarks>
</member>
<member name="T:NuGet.Protocol.Plugins.OperationClaim">
<summary>
Plugin operation claims.
</summary>
</member>
<member name="F:NuGet.Protocol.Plugins.OperationClaim.DownloadPackage">
<summary>
The download package operation claim.
</summary>
</member>
<member name="F:NuGet.Protocol.Plugins.OperationClaim.Authentication">
<summary>
The authentication operation claim
</summary>
</member>
<member name="T:NuGet.Protocol.Plugins.OutboundRequestContext">
<summary>
Context for an outbound request.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.OutboundRequestContext.CancellationToken">
<summary>
Gets the <see cref="P:NuGet.Protocol.Plugins.OutboundRequestContext.CancellationToken" />.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.OutboundRequestContext.RequestId">
<summary>
Gets the request ID.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.OutboundRequestContext.Dispose">
<summary>
Disposes of this instance.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.OutboundRequestContext.HandleCancelResponse">
<summary>
Handles a cancellation response for the outbound request.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.OutboundRequestContext.HandleProgress(NuGet.Protocol.Plugins.Message)">
<summary>
Handles progress notifications for the outbound request.
</summary>
<param name="progress">A progress notification.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="progress" /> is <c>null</c>.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.OutboundRequestContext.HandleResponse(NuGet.Protocol.Plugins.Message)">
<summary>
Handles a response for the outbound request.
</summary>
<param name="response">A response.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="response" /> is <c>null</c>.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.OutboundRequestContext.HandleFault(NuGet.Protocol.Plugins.Message)">
<summary>
Handles a fault response for the outbound request.
</summary>
<param name="fault">A fault response.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="fault" /> is <c>null</c>.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.OutboundRequestContext`1">
<summary>
Context for an outbound request.
</summary>
<typeparam name="TResult">The response payload type.</typeparam>
</member>
<member name="P:NuGet.Protocol.Plugins.OutboundRequestContext`1.CompletionTask">
<summary>
Gets the completion task.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.OutboundRequestContext`1.#ctor(NuGet.Protocol.Plugins.IConnection,NuGet.Protocol.Plugins.Message,System.Nullable{System.TimeSpan},System.Boolean,System.Threading.CancellationToken)">
<summary>
Initializes a new <see cref="T:NuGet.Protocol.Plugins.OutboundRequestContext`1" /> class.
</summary>
<param name="connection">A connection.</param>
<param name="request">A request.</param>
<param name="timeout">An optional request timeout.</param>
<param name="isKeepAlive">A flag indicating whether or not the request supports progress notifications
to reset the request timeout.</param>
<param name="cancellationToken">A cancellation token.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="connection" />
is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="request" />
is <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.OutboundRequestContext`1.#ctor(NuGet.Protocol.Plugins.IConnection,NuGet.Protocol.Plugins.Message,System.Nullable{System.TimeSpan},System.Boolean,System.Threading.CancellationToken,NuGet.Protocol.Plugins.IPluginLogger)">
<summary>
Initializes a new <see cref="T:NuGet.Protocol.Plugins.OutboundRequestContext`1" /> class.
</summary>
<param name="connection">A connection.</param>
<param name="request">A request.</param>
<param name="timeout">An optional request timeout.</param>
<param name="isKeepAlive">A flag indicating whether or not the request supports progress notifications
to reset the request timeout.</param>
<param name="cancellationToken">A cancellation token.</param>
<param name="logger">A plugin logger.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="connection" />
is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="request" />
is <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="logger" />
is <c>null</c>.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.OutboundRequestContext`1.HandleCancelResponse">
<summary>
Handles a cancellation response for the outbound request.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.OutboundRequestContext`1.HandleProgress(NuGet.Protocol.Plugins.Message)">
<summary>
Handles progress notifications for the outbound request.
</summary>
<param name="progress">A progress notification.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="progress" /> is <c>null</c>.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.OutboundRequestContext`1.HandleResponse(NuGet.Protocol.Plugins.Message)">
<summary>
Handles a response for the outbound request.
</summary>
<param name="response">A response.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="response" /> is <c>null</c>.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.OutboundRequestContext`1.HandleFault(NuGet.Protocol.Plugins.Message)">
<summary>
Handles a fault response for the outbound request.
</summary>
<param name="fault">A fault response.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="fault" /> is <c>null</c>.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.Plugin">
<summary>
Represents a plugin.
</summary>
</member>
<member name="E:NuGet.Protocol.Plugins.Plugin.BeforeClose">
<summary>
Occurs before the plugin closes.
</summary>
</member>
<member name="E:NuGet.Protocol.Plugins.Plugin.Closed">
<summary>
Occurs when the plugin has closed.
</summary>
</member>
<member name="E:NuGet.Protocol.Plugins.Plugin.Exited">
<summary>
Occurs when a plugin process has exited.
</summary>
</member>
<member name="E:NuGet.Protocol.Plugins.Plugin.Faulted">
<summary>
Occurs when a plugin or plugin connection has faulted.
</summary>
</member>
<member name="E:NuGet.Protocol.Plugins.Plugin.Idle">
<summary>
Occurs when a plugin has been idle for the configured idle timeout period.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.Plugin.Connection">
<summary>
Gets the connection for the plugin
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.Plugin.FilePath">
<summary>
Gets the file path for the plugin.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.Plugin.Id">
<summary>
Gets the unique identifier for the plugin.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.Plugin.Name">
<summary>
Gets the name of the plugin.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.Plugin.#ctor(System.String,NuGet.Protocol.Plugins.IConnection,NuGet.Protocol.Plugins.IPluginProcess,System.Boolean,System.TimeSpan)">
<summary>
Instantiates a new <see cref="T:NuGet.Protocol.Plugins.Plugin" /> class.
</summary>
<param name="filePath">The plugin file path.</param>
<param name="connection">The plugin connection.</param>
<param name="process">The plugin process.</param>
<param name="isOwnProcess"><c>true</c> if <paramref name="process" /> is the current process;
otherwise, <c>false</c>.</param>
<param name="idleTimeout">The plugin idle timeout. Can be <see cref="F:System.Threading.Timeout.InfiniteTimeSpan" />.</param>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="filePath" /> is either <c>null</c>
or an empty string.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="connection" /> is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="process" /> is <c>null</c>.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">Thrown if <paramref name="idleTimeout" /> is smaller than
<see cref="F:System.Threading.Timeout.InfiniteTimeSpan" />.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.Plugin.Dispose">
<summary>
Disposes of this instance.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.Plugin.Close">
<summary>
Closes the plugin.
</summary>
<remarks>This does not call <see cref="M:System.IDisposable.Dispose" />.</remarks>
</member>
<member name="T:NuGet.Protocol.Plugins.PluginCacheEntry">
<summary>
This class represents a plugin operations cache entry.
It contains expiry logic, read/write/update logic.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginCacheEntry.#ctor(System.String,System.String,System.String)">
<summary>
Create a plugin cache entry.
</summary>
<param name="rootCacheFolder">The root cache folder, normally /localappdata/nuget/plugins-cache</param>
<param name="pluginFilePath">The full plugin file path, which will be used to create a key for the folder created in the root folder itself </param>
<param name="requestKey">A unique request key for the operation claims. Ideally the packageSourceRepository value of the PluginRequestKey. Example https://protected.package.feed/index.json, or Source-Agnostic</param>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginCacheEntry.LoadFromFile">
<summary>
Loads and processes the contet from the generated file if it exists.
Even after this method is invoked, the operation claims might be null.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginCacheEntry.UpdateCacheFileAsync">
<summary>
Updates the cache file with the current value in the operation claims if the operationn claims is not null.
</summary>
<returns>Task</returns>
</member>
<member name="T:NuGet.Protocol.Plugins.PluginConstants">
<summary>
Plugin constants.
</summary>
</member>
<member name="F:NuGet.Protocol.Plugins.PluginConstants.CloseTimeout">
<summary>
Default close timeout for plugins.
</summary>
</member>
<member name="F:NuGet.Protocol.Plugins.PluginConstants.IdleTimeout">
<summary>
Default idle timeout for plugins.
</summary>
</member>
<member name="F:NuGet.Protocol.Plugins.PluginConstants.PluginArguments">
<summary>
Default command-line arguments for plugins.
</summary>
</member>
<member name="F:NuGet.Protocol.Plugins.PluginConstants.ProgressInterval">
<summary>
The progress notification interval.
</summary>
<remarks>This value must be less than half of <see cref="F:NuGet.Protocol.Plugins.PluginConstants.RequestTimeout" />.</remarks>
</member>
<member name="F:NuGet.Protocol.Plugins.PluginConstants.RequestTimeout">
<summary>
The default request timeout set by an initialize request after handshaking.
</summary>
</member>
<member name="T:NuGet.Protocol.Plugins.PluginCreationResult">
<summary>
A plugin's creation result.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.PluginCreationResult.Claims">
<summary>
Gets the plugin's operation claims.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.PluginCreationResult.Message">
<summary>
Gets a message if <see cref="P:NuGet.Protocol.Plugins.PluginCreationResult.Plugin" /> is <c>null</c>; otherwise, <c>null</c>.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.PluginCreationResult.Exception">
<summary>
Gets the exception caught. May be <c>null</c>.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.PluginCreationResult.Plugin">
<summary>
Gets a plugin.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.PluginCreationResult.PluginMulticlientUtilities">
<summary>
Gets a plugin multiclient utilities.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginCreationResult.#ctor(NuGet.Protocol.Plugins.IPlugin,NuGet.Protocol.Plugins.IPluginMulticlientUtilities,System.Collections.Generic.IReadOnlyList{NuGet.Protocol.Plugins.OperationClaim})">
<summary>
Instantiates a new <see cref="T:NuGet.Protocol.Plugins.PluginCreationResult" /> class.
</summary>
<param name="plugin">A plugin.</param>
<param name="utilities">A plugin multiclient utilities.</param>
<param name="claims">The plugin's operation claims.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="plugin" /> is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="utilities" /> is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="claims" /> is <c>null</c>.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginCreationResult.#ctor(System.String)">
<summary>
Instantiates a new <see cref="T:NuGet.Protocol.Plugins.PluginCreationResult" /> class.
</summary>
<param name="message">A message why a plugin could not be created.</param>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="message" />
is either <c>null</c> or an empty string.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginCreationResult.#ctor(System.String,System.Exception)">
<summary>
Instantiates a new <see cref="T:NuGet.Protocol.Plugins.PluginCreationResult" /> class.
</summary>
<param name="message">A message why a plugin could not be created.</param>
<param name="exception">An exception.</param>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="message" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="exception" /> is <c>null</c>.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.PluginDiscoverer">
<summary>
Discovers plugins and their operation claims.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginDiscoverer.#ctor(System.String,NuGet.Protocol.Plugins.EmbeddedSignatureVerifier)">
<summary>
Instantiates a new <see cref="T:NuGet.Protocol.Plugins.PluginDiscoverer" /> class.
</summary>
<param name="rawPluginPaths">The raw semicolon-delimited list of supposed plugin file paths.</param>
<param name="verifier">An embedded signature verifier.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="verifier" /> is <c>null</c>.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginDiscoverer.Dispose">
<summary>
Disposes of this instance.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginDiscoverer.DiscoverAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously discovers plugins.
</summary>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns a
<see cref="T:System.Collections.Generic.IEnumerable`1" /> from the target.</returns>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.PluginDiscoveryResult">
<summary>
A plugin discovery result.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.PluginDiscoveryResult.PluginFile">
<summary>
Gets the plugin file.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.PluginDiscoveryResult.Message">
<summary>
Gets a message if <see cref="P:NuGet.Protocol.Plugins.PluginFile.State" /> is not <see cref="F:NuGet.Protocol.Plugins.PluginFileState.Valid" />;
otherwise, <c>null</c>.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginDiscoveryResult.#ctor(NuGet.Protocol.Plugins.PluginFile)">
<summary>
Instantiates a new <see cref="T:NuGet.Protocol.Plugins.PluginDiscoveryResult" /> class.
</summary>
<param name="pluginFile">A plugin file.</param>
<see cref="F:NuGet.Protocol.Plugins.PluginFileState.Valid" />; otherwise, <c>null</c>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="pluginFile" />
is <c>null</c>.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginDiscoveryUtility.GetNuGetPluginsDirectoryRelativeToNuGetAssembly(System.String)">
<summary>
Given a NuGet assembly path, returns the NuGet plugins directory
</summary>
<param name="nugetAssemblyPath">The path to a NuGet assembly in CommonExtensions\NuGet, needs to be a valid path. file:// not supported</param>
<returns>The NuGet plugins directory in CommonExtensions\NuGet\Plugins, null if the <paramref name="nugetAssemblyPath" /> is null</returns>
</member>
<member name="T:NuGet.Protocol.Plugins.PluginEventArgs">
<summary>
Plugin event arguments.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.PluginEventArgs.Plugin">
<summary>
Gets the plugin.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginEventArgs.#ctor(NuGet.Protocol.Plugins.IPlugin)">
<summary>
Instantiates a new <see cref="T:NuGet.Protocol.Plugins.PluginEventArgs" /> class.
</summary>
<param name="plugin">A plugin.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="plugin" /> is <c>null</c>.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.PluginException">
<summary>
A plugin exception.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginException.#ctor(System.String)">
<summary>
Instantiates a new <see cref="T:NuGet.Protocol.Plugins.PluginException" /> class.
</summary>
<param name="message">The exception message.</param>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginException.#ctor(System.String,System.Exception)">
<summary>
Instantiates a new <see cref="T:NuGet.Protocol.Plugins.PluginException" /> class.
</summary>
<param name="message">The exception message.</param>
<param name="innerException">The inner exception.</param>
</member>
<member name="T:NuGet.Protocol.Plugins.PluginFactory">
<summary>
A plugin factory.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginFactory.#ctor(System.TimeSpan)">
<summary>
Instantiates a new <see cref="T:NuGet.Protocol.Plugins.PluginFactory" /> class.
</summary>
<param name="pluginIdleTimeout">The plugin idle timeout.</param>
<exception cref="T:System.ArgumentOutOfRangeException">Thrown if <paramref name="pluginIdleTimeout" />
is less than <see cref="F:System.Threading.Timeout.InfiniteTimeSpan" />.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginFactory.Dispose">
<summary>
Disposes of this instance.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginFactory.GetOrCreateAsync(System.String,System.Collections.Generic.IEnumerable{System.String},NuGet.Protocol.Plugins.IRequestHandlers,NuGet.Protocol.Plugins.ConnectionOptions,System.Threading.CancellationToken)">
<summary>
Asynchronously gets an existing plugin instance or creates a new instance and connects to it.
</summary>
<param name="filePath">The file path of the plugin.</param>
<param name="arguments">Command-line arguments to be supplied to the plugin.</param>
<param name="requestHandlers">Request handlers.</param>
<param name="options">Connection options.</param>
<param name="sessionCancellationToken">A cancellation token for the plugin's lifetime.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns a <see cref="T:NuGet.Protocol.Plugins.Plugin" />
instance.</returns>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="filePath" />
is either <c>null</c> or empty.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="arguments" />
is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="requestHandlers" />
is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="options" />
is <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="sessionCancellationToken" />
is cancelled.</exception>
<exception cref="T:System.ObjectDisposedException">Thrown if this object is disposed.</exception>
<exception cref="T:NuGet.Protocol.Plugins.ProtocolException">Thrown if a plugin protocol error occurs.</exception>
<exception cref="T:NuGet.Protocol.Plugins.PluginException">Thrown for a plugin failure during creation.</exception>
<remarks>This is intended to be called by NuGet client tools.</remarks>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginFactory.CreateFromCurrentProcessAsync(NuGet.Protocol.Plugins.IRequestHandlers,NuGet.Protocol.Plugins.ConnectionOptions,System.Threading.CancellationToken)">
<summary>
Asynchronously creates a plugin instance and connects to it.
</summary>
<param name="requestHandlers">Request handlers.</param>
<param name="options">Connection options.</param>
<param name="sessionCancellationToken">A cancellation token for the plugin's lifetime.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns a <see cref="T:NuGet.Protocol.Plugins.Plugin" />
instance.</returns>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="requestHandlers" />
is either <c>null</c> or empty.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="options" />
is either <c>null</c> or empty.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="sessionCancellationToken" />
is cancelled.</exception>
<remarks>This is intended to be called by a plugin.</remarks>
</member>
<member name="T:NuGet.Protocol.Plugins.PluginFile">
<summary>
Represents a plugin file.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.PluginFile.Path">
<summary>
Gets the plugin's file path.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.PluginFile.State">
<summary>
Gets the plugin file state.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginFile.#ctor(System.String,System.Lazy{NuGet.Protocol.Plugins.PluginFileState})">
<summary>
Instantiates a new <see cref="T:NuGet.Protocol.Plugins.PluginFile" /> class.
</summary>
<param name="filePath">The plugin's file path.</param>
<param name="state">A lazy that evaluates the plugin file state.</param>
</member>
<member name="T:NuGet.Protocol.Plugins.PluginFileState">
<summary>
State of a plugin file path.
</summary>
</member>
<member name="F:NuGet.Protocol.Plugins.PluginFileState.Valid">
<summary>
The file exists and has a valid embedded signature.
</summary>
</member>
<member name="F:NuGet.Protocol.Plugins.PluginFileState.NotFound">
<summary>
The file was not found.
</summary>
</member>
<member name="F:NuGet.Protocol.Plugins.PluginFileState.InvalidFilePath">
<summary>
The file path was invalid (e.g.: not rooted).
</summary>
</member>
<member name="F:NuGet.Protocol.Plugins.PluginFileState.InvalidEmbeddedSignature">
<summary>
The file exists but it has either no embedded signature or an invalid embedded signature.
</summary>
</member>
<member name="T:NuGet.Protocol.Plugins.PluginManager">
<summary>
A plugin manager. This manages all the live plugins and their operation claims.
Invoked in by both the credential provider and the PluginResourceProvider
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.PluginManager.EnvironmentVariableReader">
<summary>
Gets an environment variable reader.
</summary>
<remarks>This is non-private only to facilitate testing.</remarks>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginManager.Dispose">
<summary>
Disposes of this instance.
This should not be called in production code as this is a singleton instance.
The pattern is implemented because the plugin manager transitively owns objects
that need to implement IDisposable because they potentially have managed and unmanaged resources.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginManager.FindAvailablePluginsAsync(System.Threading.CancellationToken)">
<summary>
Find all available plugins on the machine
</summary>
<param name="cancellationToken"></param>
<returns>PluginDiscoveryResults</returns>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginManager.CreatePluginsAsync(NuGet.Protocol.Core.Types.SourceRepository,System.Threading.CancellationToken)">
<summary>
Create plugins appropriate for the given source
</summary>
<param name="source"></param>
<param name="cancellationToken"></param>
<exception cref="T:System.ArgumentNullException">Throw if <paramref name="source" /> is null </exception>
<returns>PluginCreationResults</returns>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginManager.TryGetSourceAgnosticPluginAsync(NuGet.Protocol.Plugins.PluginDiscoveryResult,NuGet.Protocol.Plugins.OperationClaim,System.Threading.CancellationToken)">
<summary>
Creates a plugin from the given pluginDiscoveryResult.
This plugin's operations will be source agnostic ones (Authentication)
</summary>
<param name="pluginDiscoveryResult">plugin discovery result</param>
<param name="requestedOperationClaim">The requested operation claim</param>
<param name="cancellationToken">cancellation token</param>
<returns>A plugin creation result, null if the requested plugin cannot handle the given operation claim</returns>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginManager.TryCreatePluginAsync(NuGet.Protocol.Plugins.PluginDiscoveryResult,NuGet.Protocol.Plugins.OperationClaim,NuGet.Protocol.Plugins.PluginManager.PluginRequestKey,System.String,Newtonsoft.Json.Linq.JObject,System.Threading.CancellationToken)">
<summary>
Creates a plugin from the discovered plugin.
We firstly check the cache for the operation claims for the given request key.
If there is a valid cache entry, and it does contain the requested operation claim, then we start the plugin, and if need be update the cache value itself.
If there is a valid cache entry, and it does NOT contain the requested operation claim, then we return a null.
If there is no valid cache entry or an invalid one, we start the plugin as normally, return an active plugin even if the requested claim is not available, and write a cache entry.
</summary>
<param name="result">plugin discovery result</param>
<param name="requestedOperationClaim">The requested operation claim</param>
<param name="requestKey">plugin request key</param>
<param name="packageSourceRepository">package source repository</param>
<param name="serviceIndex">service index</param>
<param name="cancellationToken">cancellation token</param>
<returns>A plugin creation result, null if the requested plugin cannot handle the given operation claim</returns>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginManager.GetCurrentCultureName">
<summary>
Gets the current culture.
An invariant culture's name will be "". Since InitializeRequest has a null or empty check, this can be a problem.
Because the InitializeRequest message is part of a protocol, and the reason why we set the culture is allow the plugins to localize their messages,
we can safely default to en.
</summary>
<returns>CurrentCulture or an en default if the current culture is invariant</returns>
</member>
<member name="T:NuGet.Protocol.Plugins.PluginMulticlientUtilities">
<summary>
Plugin multiclient utilities.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginMulticlientUtilities.#ctor">
<summary>
Initializes a new <see cref="T:NuGet.Protocol.Plugins.PluginMulticlientUtilities" /> class.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginMulticlientUtilities.DoOncePerPluginLifetimeAsync(System.String,System.Func{System.Threading.Tasks.Task},System.Threading.CancellationToken)">
<summary>
Asynchronously executes a task once per plugin lifetime per key.
</summary>
<param name="key">A key that identifies the task.</param>
<param name="taskFunc">A function that returns a task.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.</returns>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="key" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="taskFunc" />
is either <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.PluginPackageDownloader">
<summary>
A package downloader that delegates to a plugin.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.PluginPackageDownloader.ContentReader">
<summary>
Gets an asynchronous package content reader.
</summary>
<exception cref="T:System.ObjectDisposedException">Thrown if this object is disposed.</exception>
</member>
<member name="P:NuGet.Protocol.Plugins.PluginPackageDownloader.CoreReader">
<summary>
Gets an asynchronous package core reader.
</summary>
<exception cref="T:System.ObjectDisposedException">Thrown if this object is disposed.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginPackageDownloader.#ctor(NuGet.Protocol.Plugins.IPlugin,NuGet.Packaging.Core.PackageIdentity,NuGet.Protocol.Plugins.PluginPackageReader,System.String)">
<summary>
Initializes a new <see cref="T:NuGet.Protocol.Plugins.PluginPackageDownloader" /> class.
</summary>
<param name="plugin">A plugin.</param>
<param name="packageIdentity">A package identity.</param>
<param name="packageReader">A plugin package reader.</param>
<param name="packageSourceRepository">A package source repository location.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="plugin" />
is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="packageIdentity" />
is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="packageReader" />
is <c>null</c>.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="packageSourceRepository" />
is either <c>null</c> or an empty string.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginPackageDownloader.Dispose">
<summary>
Disposes of this instance.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginPackageDownloader.CopyNupkgFileToAsync(System.String,System.Threading.CancellationToken)">
<summary>
Asynchronously copies a .nupkg to a target file path.
</summary>
<param name="destinationFilePath">The destination file path.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns a <see cref="T:System.Boolean" />
indicating whether or not the copy was successful.</returns>
<exception cref="T:System.ObjectDisposedException">Thrown if this object is disposed.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="destinationFilePath" />
is either <c>null</c> or empty.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginPackageDownloader.GetPackageHashAsync(System.String,System.Threading.CancellationToken)">
<summary>
Asynchronously gets a package hash.
</summary>
<param name="hashAlgorithm">The hash algorithm.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns a <see cref="T:System.String" />
representing the package hash.</returns>
<exception cref="T:System.ObjectDisposedException">Thrown if this object is disposed.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="hashAlgorithm" />
is either <c>null</c> or empty.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginPackageDownloader.SetExceptionHandler(System.Func{System.Exception,System.Threading.Tasks.Task{System.Boolean}})">
<summary>
Sets an exception handler for package downloads.
</summary>
<remarks>The exception handler returns a task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns a <see cref="T:System.Boolean" />
indicating whether or not the exception was handled. To handle an exception and stop its
propagation, the task should return <c>true</c>. Otherwise, the exception will be rethrown.</remarks>
<param name="handleExceptionAsync">An exception handler.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="handleExceptionAsync" />
is <c>null</c>.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginPackageDownloader.SetThrottle(System.Threading.SemaphoreSlim)">
<summary>
Sets a throttle for package downloads.
</summary>
<param name="throttle">A throttle. Can be <c>null</c>.</param>
</member>
<member name="T:NuGet.Protocol.Plugins.PluginPackageReader">
<summary>
A package reader that delegates package read operations to a plugin.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginPackageReader.#ctor(NuGet.Protocol.Plugins.IPlugin,NuGet.Packaging.Core.PackageIdentity,System.String)">
<summary>
Initializes a new <see cref="T:NuGet.Protocol.Plugins.PluginPackageReader" /> class.
</summary>
<param name="plugin">A plugin.</param>
<param name="packageIdentity">A package identity.</param>
<param name="packageSourceRepository">A package source repository location.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="plugin" /> is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="packageIdentity" />
is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="packageSourceRepository" />
is either <c>null</c> or an empty string.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginPackageReader.GetStream(System.String)">
<summary>
Gets a stream for a file in the package.
</summary>
<param name="path">The file path in the package.</param>
<returns>A stream.</returns>
<exception cref="T:System.NotSupportedException">Thrown always.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginPackageReader.GetStreamAsync(System.String,System.Threading.CancellationToken)">
<summary>
Asynchronously gets a stream for a file in the package.
</summary>
<param name="path">The file path in the package.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns a <see cref="T:System.IO.Stream" />.</returns>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="path" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginPackageReader.GetFiles">
<summary>
Gets files in the package.
</summary>
<returns>An enumerable of files in the package.</returns>
<exception cref="T:System.NotSupportedException">Thrown always.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginPackageReader.GetFilesAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously gets files in the package.
</summary>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an
<see cref="T:System.Collections.Generic.IEnumerable`1" />.</returns>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginPackageReader.GetFiles(System.String)">
<summary>
Gets files in the package.
</summary>
<param name="folder">A folder in the package.</param>
<returns>An enumerable of files in the package.</returns>
<exception cref="T:System.NotSupportedException">Thrown always.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginPackageReader.GetFilesAsync(System.String,System.Threading.CancellationToken)">
<summary>
Asynchronously gets files in the package under the specified folder.
</summary>
<param name="folder">A folder in the package.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an
<see cref="T:System.Collections.Generic.IEnumerable`1" />.</returns>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="folder" /> is <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginPackageReader.CopyFiles(System.String,System.Collections.Generic.IEnumerable{System.String},NuGet.Packaging.Core.ExtractPackageFileDelegate,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Copies specified files in the package to the destination location.
</summary>
<param name="destination">A directory path to copy files to.</param>
<param name="packageFiles">An enumerable of files in the package to copy.</param>
<param name="extractFile">A package file extraction delegate.</param>
<param name="logger">A logger.</param>
<param name="token">A cancellation token.</param>
<returns>An enumerable of file paths in the destination location.</returns>
<exception cref="T:System.NotSupportedException">Thrown always.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginPackageReader.CopyFilesAsync(System.String,System.Collections.Generic.IEnumerable{System.String},NuGet.Packaging.Core.ExtractPackageFileDelegate,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Asynchronously copies specified files in the package to the destination location.
</summary>
<param name="destination">A directory path to copy files to.</param>
<param name="packageFiles">An enumerable of files in the package to copy.</param>
<param name="extractFile">A package file extraction delegate.</param>
<param name="logger">A logger.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an
<see cref="T:System.Collections.Generic.IEnumerable`1" />.</returns>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="destination" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="packageFiles" />
is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="logger" /> is <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginPackageReader.GetIdentity">
<summary>
Gets the package identity.
</summary>
<returns>A package identity.</returns>
<exception cref="T:System.NotSupportedException">Thrown always.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginPackageReader.GetIdentityAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously gets the package identity.
</summary>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an
<see cref="T:NuGet.Packaging.Core.PackageIdentity" />.</returns>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginPackageReader.GetMinClientVersion">
<summary>
Gets the minimum client version in the .nuspec.
</summary>
<returns>A NuGet version.</returns>
<exception cref="T:System.NotSupportedException">Thrown always.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginPackageReader.GetMinClientVersionAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously gets the minimum client version in the .nuspec.
</summary>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an
<see cref="T:NuGet.Versioning.NuGetVersion" />.</returns>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginPackageReader.GetPackageTypes">
<summary>
Gets the package types.
</summary>
<returns>A read-only list of package types.</returns>
<exception cref="T:System.NotSupportedException">Thrown always.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginPackageReader.GetPackageTypesAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously gets the package types.
</summary>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an
<see cref="T:System.Collections.Generic.IReadOnlyList`1" />.</returns>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginPackageReader.GetNuspec">
<summary>
Gets a stream for the .nuspec file.
</summary>
<returns>A stream.</returns>
<exception cref="T:System.NotSupportedException">Thrown always.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginPackageReader.GetNuspecAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously gets a stream for the .nuspec file.
</summary>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns a <see cref="T:System.IO.Stream" />.</returns>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginPackageReader.GetNuspecFile">
<summary>
Gets the .nuspec file path in the package.
</summary>
<returns>The .nuspec file path in the package.</returns>
<exception cref="T:System.NotSupportedException">Thrown always.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginPackageReader.GetNuspecFileAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously gets the .nuspec file path in the package.
</summary>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns a <see cref="T:System.String" />.</returns>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="P:NuGet.Protocol.Plugins.PluginPackageReader.NuspecReader">
<summary>
Gets the .nuspec reader.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginPackageReader.GetNuspecReaderAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously gets the .nuspec reader.
</summary>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns a <see cref="P:NuGet.Protocol.Plugins.PluginPackageReader.NuspecReader" />.</returns>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginPackageReader.GetSupportedFrameworks">
<summary>
Gets supported frameworks.
</summary>
<returns>An enumerable of NuGet frameworks.</returns>
<exception cref="T:System.NotSupportedException">Thrown always.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginPackageReader.GetSupportedFrameworksAsync(System.Threading.CancellationToken)">
<inheritdoc cref="M:NuGet.Packaging.PackageReaderBase.GetSupportedFrameworksAsync(System.Threading.CancellationToken)" />
</member>
<member name="M:NuGet.Protocol.Plugins.PluginPackageReader.GetFrameworkItems">
<summary>
Gets framework items.
</summary>
<returns>An enumerable of framework specific groups.</returns>
<exception cref="T:System.NotSupportedException">Thrown always.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginPackageReader.GetFrameworkItemsAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously gets framework items.
</summary>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an
<see cref="T:System.Collections.Generic.IEnumerable`1" />.</returns>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginPackageReader.IsServiceable">
<summary>
Gets a flag indicating whether or not the package is serviceable.
</summary>
<returns>A flag indicating whether or not the package is serviceable.</returns>
<exception cref="T:System.NotSupportedException">Thrown always.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginPackageReader.IsServiceableAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously gets a flag indicating whether or not the package is serviceable.
</summary>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns a <see cref="T:System.Boolean" />.</returns>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginPackageReader.GetBuildItems">
<summary>
Gets build items.
</summary>
<returns>An enumerable of framework specific groups.</returns>
<exception cref="T:System.NotSupportedException">Thrown always.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginPackageReader.GetBuildItemsAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously gets build items.
</summary>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an
<see cref="T:System.Collections.Generic.IEnumerable`1" />.</returns>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginPackageReader.GetToolItems">
<summary>
Gets tool items.
</summary>
<returns>An enumerable of framework specific groups.</returns>
<exception cref="T:System.NotSupportedException">Thrown always.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginPackageReader.GetToolItemsAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously gets tool items.
</summary>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an
<see cref="T:System.Collections.Generic.IEnumerable`1" />.</returns>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginPackageReader.GetContentItems">
<summary>
Gets content items.
</summary>
<returns>An enumerable of framework specific groups.</returns>
<exception cref="T:System.NotSupportedException">Thrown always.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginPackageReader.GetContentItemsAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously gets content items.
</summary>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an
<see cref="T:System.Collections.Generic.IEnumerable`1" />.</returns>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginPackageReader.GetItems(System.String)">
<summary>
Gets items in the specified folder in the package.
</summary>
<param name="folderName">A folder in the package.</param>
<returns>An enumerable of framework specific groups.</returns>
<exception cref="T:System.NotSupportedException">Thrown always.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginPackageReader.GetItemsAsync(System.String,System.Threading.CancellationToken)">
<summary>
Asynchronously gets items in the specified folder in the package.
</summary>
<param name="folderName">A folder in the package.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an
<see cref="T:System.Collections.Generic.IEnumerable`1" />.</returns>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="folderName" /> is <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginPackageReader.GetPackageDependencies">
<summary>
Gets package dependencies.
</summary>
<returns>An enumerable of package dependency groups.</returns>
<exception cref="T:System.NotSupportedException">Thrown always.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginPackageReader.GetPackageDependenciesAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously gets package dependencies.
</summary>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an
<see cref="T:System.Collections.Generic.IEnumerable`1" />.</returns>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginPackageReader.GetLibItems">
<summary>
Gets lib items.
</summary>
<returns>An enumerable of framework specific groups.</returns>
<exception cref="T:System.NotSupportedException">Thrown always.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginPackageReader.GetLibItemsAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously gets lib items.
</summary>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an
<see cref="T:System.Collections.Generic.IEnumerable`1" />.</returns>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginPackageReader.GetReferenceItems">
<summary>
Gets reference items.
</summary>
<returns>An enumerable of framework specific groups.</returns>
<exception cref="T:System.NotSupportedException">Thrown always.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginPackageReader.GetReferenceItemsAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously gets reference items.
</summary>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an
<see cref="T:System.Collections.Generic.IEnumerable`1" />.</returns>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginPackageReader.GetDevelopmentDependency">
<summary>
Gets a flag indicating whether or not the package is a development dependency.
</summary>
<returns>A flag indicating whether or not the package is a development dependency</returns>
<exception cref="T:System.NotSupportedException">Thrown always.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginPackageReader.GetDevelopmentDependencyAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously gets a flag indicating whether or not the package is a development dependency.
</summary>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns a <see cref="T:System.Boolean" />.</returns>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginPackageReader.CopyNupkgAsync(System.String,System.Threading.CancellationToken)">
<summary>
Asynchronously copies a package to the specified destination file path.
</summary>
<param name="nupkgFilePath">The destination file path.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns a <see cref="T:System.String" />.</returns>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="nupkgFilePath" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.PluginProcess">
<summary>
Represents a plugin process.
</summary>
</member>
<member name="E:NuGet.Protocol.Plugins.PluginProcess.Exited">
<summary>
Occurs when a process exits.
</summary>
</member>
<member name="E:NuGet.Protocol.Plugins.PluginProcess.LineRead">
<summary>
Occurs when a line of output has been received.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.PluginProcess.Id">
<summary>
Gets the process ID if the process was started; otherwise, <c>null</c>.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginProcess.#ctor">
<summary>
Instantiates a new <see cref="T:NuGet.Protocol.Plugins.PluginProcess" /> class from the current process.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginProcess.#ctor(System.Diagnostics.ProcessStartInfo)">
<summary>
Instantiates a new <see cref="T:NuGet.Protocol.Plugins.PluginProcess" /> class.
</summary>
<param name="startInfo">A plugin process.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="startInfo" /> is <c>null</c>.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginProcess.Dispose">
<summary>
Disposes of this instance.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginProcess.BeginReadLine">
<summary>
Asynchronously starts reading the standard output stream.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginProcess.CancelRead">
<summary>
Cancels asynchronous reading of the standard output stream.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.PluginProcess.Kill">
<summary>
Stops the associated process.
</summary>
</member>
<member name="T:NuGet.Protocol.Plugins.ProtocolConstants">
<summary>
Plugin protocol constants.
</summary>
</member>
<member name="F:NuGet.Protocol.Plugins.ProtocolConstants.CurrentVersion">
<summary>
The current protocol version.
</summary>
</member>
<member name="F:NuGet.Protocol.Plugins.ProtocolConstants.Version100">
<summary>
The minimum supported protocol version.
</summary>
</member>
<member name="F:NuGet.Protocol.Plugins.ProtocolConstants.HandshakeTimeout">
<summary>
The default handshake timeout.
</summary>
</member>
<member name="F:NuGet.Protocol.Plugins.ProtocolConstants.MaxTimeout">
<summary>
The maximum timeout value.
</summary>
<remarks>This is set by CancellationTokenSource's constructor.</remarks>
</member>
<member name="F:NuGet.Protocol.Plugins.ProtocolConstants.MinTimeout">
<summary>
The minimum timeout value.
</summary>
</member>
<member name="F:NuGet.Protocol.Plugins.ProtocolConstants.RequestTimeout">
<summary>
The default request timeout.
</summary>
</member>
<member name="T:NuGet.Protocol.Plugins.ProtocolErrorEventArgs">
<summary>
Protocol error event arguments.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.ProtocolErrorEventArgs.Exception">
<summary>
Gets the exception.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.ProtocolErrorEventArgs.Message">
<summary>
Gets the message.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.ProtocolErrorEventArgs.#ctor(System.Exception)">
<summary>
Instantiates a new <see cref="T:NuGet.Protocol.Plugins.ProtocolErrorEventArgs" /> class.
</summary>
<param name="exception">An exception.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="exception" /> is <c>null</c>.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.ProtocolErrorEventArgs.#ctor(System.Exception,NuGet.Protocol.Plugins.Message)">
<summary>
Instantiates a new <see cref="T:NuGet.Protocol.Plugins.ProtocolErrorEventArgs" /> class.
</summary>
<param name="exception">An exception.</param>
<param name="message">A message.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="exception" /> is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="message" /> is <c>null</c>.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.ProtocolException">
<summary>
A plugin protocol exception.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.ProtocolException.#ctor(System.String)">
<summary>
Instantiates a new <see cref="T:NuGet.Protocol.Plugins.ProtocolException" /> class.
</summary>
<param name="message">The exception message.</param>
</member>
<member name="M:NuGet.Protocol.Plugins.ProtocolException.#ctor(System.String,System.Exception)">
<summary>
Instantiates a new <see cref="T:NuGet.Protocol.Plugins.ProtocolException" /> class.
</summary>
<param name="message">The exception message.</param>
<param name="innerException">The inner exception.</param>
</member>
<member name="T:NuGet.Protocol.Plugins.Receiver">
<summary>
Represents a unidirectional communications channel from a target.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.Receiver.IsClosed">
<summary>
Gets a flag indicating whether or not this instance is closed.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.Receiver.IsDisposed">
<summary>
Gets or sets a flag indicating whether or not this instance is disposed.
</summary>
</member>
<member name="E:NuGet.Protocol.Plugins.Receiver.Faulted">
<summary>
Occurs when an unrecoverable fault has been caught.
</summary>
</member>
<member name="E:NuGet.Protocol.Plugins.Receiver.MessageReceived">
<summary>
Occurs when a message has been received.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.Receiver.Close">
<summary>
Closes the connection.
</summary>
<remarks>This does not call <see cref="M:System.IDisposable.Dispose" />.</remarks>
</member>
<member name="M:NuGet.Protocol.Plugins.Receiver.Connect">
<summary>
Connects.
</summary>
<exception cref="T:System.ObjectDisposedException">Thrown if this object is disposed.</exception>
<exception cref="T:System.InvalidOperationException">Thrown if this object is closed.</exception>
<exception cref="T:System.InvalidOperationException">Thrown if this method has already been called.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.Receiver.Dispose">
<summary>
Disposes of this instance.
</summary>
</member>
<member name="T:NuGet.Protocol.Plugins.RequestHandlers">
<summary>
A set of <see cref="T:NuGet.Protocol.Plugins.IRequestHandler" />.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.RequestHandlers.#ctor">
<summary>
Instantiates a new <see cref="T:NuGet.Protocol.Plugins.RequestHandlers" /> class.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.RequestHandlers.AddOrUpdate(NuGet.Protocol.Plugins.MessageMethod,System.Func{NuGet.Protocol.Plugins.IRequestHandler},System.Func{NuGet.Protocol.Plugins.IRequestHandler,NuGet.Protocol.Plugins.IRequestHandler})">
<summary>
Atomically add or update a request handler for the specified message method.
</summary>
<param name="method">A message method.</param>
<param name="addHandlerFunc">An add request handler function.</param>
<param name="updateHandlerFunc">An update request handler function.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="addHandlerFunc" />
is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="updateHandlerFunc" />
is <c>null</c>.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.RequestHandlers.TryAdd(NuGet.Protocol.Plugins.MessageMethod,NuGet.Protocol.Plugins.IRequestHandler)">
<summary>
Attempts to add a request handler for the specified message method.
</summary>
<param name="method">A message method.</param>
<param name="handler">A request handler.</param>
<returns><c>true</c> if added; otherwise, <c>false</c>.</returns>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="handler" /> is <c>null</c>.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.RequestHandlers.TryGet(NuGet.Protocol.Plugins.MessageMethod,NuGet.Protocol.Plugins.IRequestHandler@)">
<summary>
Attempts to get a request handler for the specified message method.
</summary>
<param name="method">A message method.</param>
<param name="handler">An existing request handler.</param>
<returns><c>true</c> if the request handler exists; otherwise, <c>false</c>.</returns>
</member>
<member name="M:NuGet.Protocol.Plugins.RequestHandlers.TryRemove(NuGet.Protocol.Plugins.MessageMethod)">
<summary>
Attempts to remove a request handler for the specified message method.
</summary>
<param name="method">A message method.</param>
<returns><c>true</c> if a request handler was removed; otherwise, <c>false</c>.</returns>
</member>
<member name="T:NuGet.Protocol.Plugins.CloseRequestHandler">
<summary>
A request handler for closing a plugin.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.CloseRequestHandler.#ctor(NuGet.Protocol.Plugins.IPlugin)">
<summary>
Initializes a new <see cref="T:NuGet.Protocol.Plugins.CloseRequestHandler" /> class.
</summary>
<param name="plugin">A plugin.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="plugin" /> is <c>null</c>.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.CloseRequestHandler.HandleResponseAsync(NuGet.Protocol.Plugins.IConnection,NuGet.Protocol.Plugins.Message,NuGet.Protocol.Plugins.IResponseHandler,System.Threading.CancellationToken)">
<summary>
Asynchronously handles responding to a request.
</summary>
<param name="connection">The connection.</param>
<param name="request">A request message.</param>
<param name="responseHandler">A response handler.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.</returns>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="connection" />
is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="request" /> is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="responseHandler" />
is <c>null</c>.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.GetCredentialsRequestHandler">
<summary>
A request handler for get credentials requests.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.GetCredentialsRequestHandler.CancellationToken">
<summary>
Gets the <see cref="P:NuGet.Protocol.Plugins.GetCredentialsRequestHandler.CancellationToken" /> for a request.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.GetCredentialsRequestHandler.#ctor(NuGet.Protocol.Plugins.IPlugin,System.Net.IWebProxy,NuGet.Configuration.ICredentialService)">
<summary>
Initializes a new <see cref="T:NuGet.Protocol.Plugins.GetCredentialsRequestHandler" /> class.
</summary>
<param name="plugin">A plugin.</param>
<param name="proxy">A web proxy.</param>
<param name="credentialService">An optional credential service.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="plugin" />
is <c>null</c>.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.GetCredentialsRequestHandler.Dispose">
<summary>
Disposes of this instance.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.GetCredentialsRequestHandler.AddOrUpdateSourceRepository(NuGet.Protocol.Core.Types.SourceRepository)">
<summary>
Adds or updates a source repository in a source repository cache.
</summary>
<param name="sourceRepository">A source repository.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="sourceRepository" />
is <c>null</c>.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.GetCredentialsRequestHandler.HandleResponseAsync(NuGet.Protocol.Plugins.IConnection,NuGet.Protocol.Plugins.Message,NuGet.Protocol.Plugins.IResponseHandler,System.Threading.CancellationToken)">
<summary>
Asynchronously handles responding to a request.
</summary>
<param name="connection">The connection.</param>
<param name="request">A request message.</param>
<param name="responseHandler">A response handler.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.</returns>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="connection" />
is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="request" /> is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="responseHandler" />
is <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.GetServiceIndexRequestHandler">
<summary>
A request handler for get service index requests.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.GetServiceIndexRequestHandler.CancellationToken">
<summary>
Gets the <see cref="P:NuGet.Protocol.Plugins.GetServiceIndexRequestHandler.CancellationToken" /> for a request.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.GetServiceIndexRequestHandler.#ctor(NuGet.Protocol.Plugins.IPlugin)">
<summary>
Initializes a new <see cref="T:NuGet.Protocol.Plugins.GetServiceIndexRequestHandler" /> class.
</summary>
<param name="plugin">A plugin.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="plugin" /> is <c>null</c>.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.GetServiceIndexRequestHandler.Dispose">
<summary>
Disposes of this instance.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.GetServiceIndexRequestHandler.AddOrUpdateSourceRepository(NuGet.Protocol.Core.Types.SourceRepository)">
<summary>
Adds or updates a source repository in a source repository cache.
</summary>
<param name="sourceRepository">A source repository.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="sourceRepository" />
is <c>null</c>.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.GetServiceIndexRequestHandler.HandleResponseAsync(NuGet.Protocol.Plugins.IConnection,NuGet.Protocol.Plugins.Message,NuGet.Protocol.Plugins.IResponseHandler,System.Threading.CancellationToken)">
<summary>
Asynchronously handles responding to a request.
</summary>
<param name="connection">The connection.</param>
<param name="request">A request message.</param>
<param name="responseHandler">A response handler.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.</returns>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="connection" />
is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="request" /> is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="responseHandler" />
is <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.LogRequestHandler">
<summary>
A request handler for logging.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.LogRequestHandler.CancellationToken">
<summary>
Gets the <see cref="P:NuGet.Protocol.Plugins.LogRequestHandler.CancellationToken" /> for a request.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.LogRequestHandler.#ctor(NuGet.Common.ILogger)">
<summary>
Instantiates a new instance of the <see cref="T:NuGet.Protocol.Plugins.LogRequestHandler" /> class.
</summary>
<param name="logger">A logger.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="logger" /> is <c>null</c>.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.LogRequestHandler.HandleResponseAsync(NuGet.Protocol.Plugins.IConnection,NuGet.Protocol.Plugins.Message,NuGet.Protocol.Plugins.IResponseHandler,System.Threading.CancellationToken)">
<summary>
Asynchronously handles responding to a request.
</summary>
<param name="connection">The connection.</param>
<param name="request">A request message.</param>
<param name="responseHandler">A response handler.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.</returns>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="connection" />
is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="request" /> is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="responseHandler" />
is <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.LogRequestHandler.SetLogger(NuGet.Common.ILogger)">
<summary>
Sets the logger.
</summary>
<param name="logger">A logger.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="logger" /> is <c>null</c>.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.LogRequestHandler.GetLogLevel(NuGet.Common.ILogger)">
<summary>
Gets the log level of a logger.
</summary>
<param name="logger">A logger.</param>
<returns>A log level.</returns>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="logger" /> is <c>null</c>.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.MonitorNuGetProcessExitRequestHandler">
<summary>
A request handler for monitoring the exit of a NuGet process.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.MonitorNuGetProcessExitRequestHandler.#ctor(NuGet.Protocol.Plugins.IPlugin)">
<summary>
Initializes a new <see cref="T:NuGet.Protocol.Plugins.MonitorNuGetProcessExitRequestHandler" /> class.
</summary>
<param name="plugin">A plugin.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="plugin" /> is <c>null</c>.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.MonitorNuGetProcessExitRequestHandler.HandleResponseAsync(NuGet.Protocol.Plugins.IConnection,NuGet.Protocol.Plugins.Message,NuGet.Protocol.Plugins.IResponseHandler,System.Threading.CancellationToken)">
<summary>
Asynchronously handles responding to a request.
</summary>
<param name="connection">The connection.</param>
<param name="request">A request message.</param>
<param name="responseHandler">A response handler.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.</returns>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="connection" />
is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="request" /> is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="responseHandler" />
is <c>null</c>.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.SymmetricHandshake">
<summary>
A helper class that performs a symmetric handshake.
</summary>
</member>
<member name="P:NuGet.Protocol.Plugins.SymmetricHandshake.CancellationToken">
<summary>
Gets the <see cref="P:NuGet.Protocol.Plugins.SymmetricHandshake.CancellationToken" /> for a request.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.SymmetricHandshake.#ctor(NuGet.Protocol.Plugins.IConnection,System.TimeSpan,NuGet.Versioning.SemanticVersion,NuGet.Versioning.SemanticVersion)">
<summary>
Initializes a new instance of the <see cref="T:NuGet.Protocol.Plugins.SymmetricHandshake" /> class.
</summary>
<param name="connection">A connection.</param>
<param name="handshakeTimeout">The handshake timeout.</param>
<param name="protocolVersion">The handshaker's protocol version.</param>
<param name="minimumProtocolVersion">The handshaker's minimum protocol version.</param>
</member>
<member name="M:NuGet.Protocol.Plugins.SymmetricHandshake.Dispose">
<summary>
Disposes of this instance.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.SymmetricHandshake.HandshakeAsync(System.Threading.CancellationToken)">
<summary>
Asynchronously handles handshaking.
</summary>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns a <see cref="T:NuGet.Versioning.SemanticVersion" />
if the handshake was successful; otherwise, <c>null</c>.</returns>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.SymmetricHandshake.HandleResponseAsync(NuGet.Protocol.Plugins.IConnection,NuGet.Protocol.Plugins.Message,NuGet.Protocol.Plugins.IResponseHandler,System.Threading.CancellationToken)">
<summary>
Asynchronously handles responding to a request.
</summary>
<param name="connection">The connection.</param>
<param name="request">A request message.</param>
<param name="responseHandler">A response handler.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.</returns>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="connection" />
is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="request" /> is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="responseHandler" />
is <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.RequestIdGenerator">
<summary>
A unique identifier generator.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.RequestIdGenerator.GenerateUniqueId">
<summary>
Generates a new unique identifier.
</summary>
<returns>A unique identifier.</returns>
</member>
<member name="T:NuGet.Protocol.Plugins.Sender">
<summary>
Represents a unidirectional communications channel to a target.
</summary>
<remarks>
Any public static members of this type are thread safe.
Any instance members are not guaranteed to be thread safe.
</remarks>
</member>
<member name="M:NuGet.Protocol.Plugins.Sender.#ctor(System.IO.TextWriter)">
<summary>
Instantiates a new <see cref="T:NuGet.Protocol.Plugins.Sender" /> class.
</summary>
<param name="writer">A text writer.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="writer" /> is <c>null</c>.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.Sender.Dispose">
<summary>
Disposes of this instance.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.Sender.Close">
<summary>
Closes the connection.
</summary>
<remarks>This does not call <see cref="M:System.IDisposable.Dispose" />.</remarks>
</member>
<member name="M:NuGet.Protocol.Plugins.Sender.Connect">
<summary>
Connects.
</summary>
<exception cref="T:System.ObjectDisposedException">Thrown if this object is disposed.</exception>
<exception cref="T:System.InvalidOperationException">Thrown if this object is closed.</exception>
<exception cref="T:System.InvalidOperationException">Thrown if this method has already been called.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.Sender.SendAsync(NuGet.Protocol.Plugins.Message,System.Threading.CancellationToken)">
<summary>
Asynchronously sends a message to the target.
</summary>
<param name="message">The message to send.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.</returns>
<exception cref="T:System.ObjectDisposedException">Thrown if this object is disposed.</exception>
<exception cref="T:System.InvalidOperationException">Thrown if <see cref="M:NuGet.Protocol.Plugins.Sender.Connect" /> has not been called.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="message" /> is <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.StandardInputReceiver">
<summary>
Represents a unidirectional communications channel from a target.
</summary>
<remarks>
Any public static members of this type are thread safe.
Any instance members are not guaranteed to be thread safe.
</remarks>
</member>
<member name="M:NuGet.Protocol.Plugins.StandardInputReceiver.#ctor(System.IO.TextReader)">
<summary>
Instantiates a new <see cref="T:NuGet.Protocol.Plugins.StandardInputReceiver" /> class.
</summary>
<param name="reader">A text reader.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="reader" /> is <c>null</c>.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.StandardInputReceiver.Connect">
<summary>
Connects.
</summary>
<exception cref="T:System.ObjectDisposedException">Thrown if this object is disposed.</exception>
<exception cref="T:System.InvalidOperationException">Thrown if this object is closed.</exception>
<exception cref="T:System.InvalidOperationException">Thrown if this method has already been called.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.StandardOutputReceiver">
<summary>
Represents a unidirectional communications channel from a target.
</summary>
<remarks>
Any public static members of this type are thread safe.
Any instance members are not guaranteed to be thread safe.
</remarks>
</member>
<member name="M:NuGet.Protocol.Plugins.StandardOutputReceiver.#ctor(NuGet.Protocol.Plugins.IPluginProcess)">
<summary>
Instantiates a new <see cref="T:NuGet.Protocol.Plugins.StandardOutputReceiver" /> class.
</summary>
<param name="process">A plugin process.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="process" /> is <c>null</c>.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.StandardOutputReceiver.Dispose(System.Boolean)">
<summary>
Disposes of this instance.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.StandardOutputReceiver.Close">
<summary>
Closes the connection.
</summary>
<remarks>This does not call <see cref="M:System.IDisposable.Dispose" />.</remarks>
</member>
<member name="M:NuGet.Protocol.Plugins.StandardOutputReceiver.Connect">
<summary>
Connects.
</summary>
<exception cref="T:System.ObjectDisposedException">Thrown if this object is disposed.</exception>
<exception cref="T:System.InvalidOperationException">Thrown if this object is closed.</exception>
<exception cref="T:System.InvalidOperationException">Thrown if this method has already been called.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.TimeoutUtilities">
<summary>
Timeout utilities.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.TimeoutUtilities.GetTimeout(System.String,System.TimeSpan)">
<summary>
Attempts to parse a legal timeout and returns a default timeout as a fallback.
</summary>
<param name="timeoutInSeconds">The requested timeout in seconds.</param>
<param name="fallbackTimeout">A fallback timeout.</param>
<returns>A <see cref="T:System.TimeSpan" /> object that represents a timeout interval.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">Thrown if <paramref name="fallbackTimeout" /> is an invalid
timeout.</exception>
</member>
<member name="M:NuGet.Protocol.Plugins.TimeoutUtilities.IsValid(System.TimeSpan)">
<summary>
Determines if a timeout is valid.
</summary>
<param name="timeout">A timeout.</param>
<returns><c>true</c> if the timeout is valid; otherwise, <c>false</c>.</returns>
</member>
<member name="T:NuGet.Protocol.Plugins.UnixAndMonoPlatformsEmbeddedSignatureVerifier">
<summary>
Embedded Signature Verifier for the MacOS, Linux and Mono platforms.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.UnixAndMonoPlatformsEmbeddedSignatureVerifier.IsValid(System.String)">
<summary>
Checks if a file has a valid embedded signature.
</summary>
<param name="filePath">The path of a file to be checked.</param>
<returns><c>true</c> if the file has a valid signature; otherwise, <c>false</c>.</returns>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="filePath" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.PlatformNotSupportedException">Thrown if the current platform is unsupported.</exception>
</member>
<member name="T:NuGet.Protocol.Plugins.WindowsEmbeddedSignatureVerifier">
<summary>
Windows Authenticode signature verifier.
</summary>
</member>
<member name="M:NuGet.Protocol.Plugins.WindowsEmbeddedSignatureVerifier.IsValid(System.String)">
<summary>
Checks if a file has a valid Authenticode signature.
</summary>
<param name="filePath">The path of a file to be checked.</param>
<returns><c>true</c> if the file has a valid signature; otherwise, <c>false</c>.</returns>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="filePath" />
is either <c>null</c> or an empty string.</exception>
</member>
<member name="T:NuGet.Protocol.DependencyInfoResourceV3Provider">
<summary>
Retrieves all dependency info for the package resolver.
</summary>
</member>
<member name="T:NuGet.Protocol.DownloadResourcePluginProvider">
<summary>
A download resource provider for plugins.
</summary>
</member>
<member name="M:NuGet.Protocol.DownloadResourcePluginProvider.#ctor">
<summary>
Instanatiates a new <see cref="T:NuGet.Protocol.DownloadResourcePluginProvider" /> class.
</summary>
</member>
<member name="M:NuGet.Protocol.DownloadResourcePluginProvider.TryCreate(NuGet.Protocol.Core.Types.SourceRepository,System.Threading.CancellationToken)">
<summary>
Attempts to create a resource for the specified source repository.
</summary>
<param name="source">A source repository.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns a Tuple<bool, INuGetResource></returns>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="source" /> is <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="T:NuGet.Protocol.ServiceIndexResourceV3Provider">
<summary>
Retrieves and caches service index.json files
ServiceIndexResourceV3 stores the json, all work is done in the provider
</summary>
</member>
<member name="P:NuGet.Protocol.ServiceIndexResourceV3Provider.MaxCacheDuration">
<summary>
Maximum amount of time to store index.json
</summary>
</member>
<member name="M:NuGet.Protocol.ServiceIndexResourceV3Provider.GetServiceIndexResourceV3(NuGet.Protocol.Core.Types.SourceRepository,System.DateTime,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Read the source's end point to get the index json.
Retries are logged to any provided <paramref name="log" /> as LogMinimal.
</summary>
<param name="source"></param>
<param name="utcNow"></param>
<param name="log"></param>
<param name="token"></param>
<exception cref="T:System.OperationCanceledException">Logged to any provided <paramref name="log" /> as LogMinimal prior to throwing.</exception>
<exception cref="T:NuGet.Protocol.Core.Types.FatalProtocolException">Encapsulates all other exceptions.</exception>
<returns></returns>
</member>
<member name="T:NuGet.Protocol.RemotePackageArchiveDownloader">
<summary>
A remote package downloader.
</summary>
</member>
<member name="P:NuGet.Protocol.RemotePackageArchiveDownloader.ContentReader">
<summary>
Gets an asynchronous package content reader.
</summary>
<exception cref="T:System.ObjectDisposedException">Thrown if this object is disposed.</exception>
</member>
<member name="P:NuGet.Protocol.RemotePackageArchiveDownloader.CoreReader">
<summary>
Gets an asynchronous package core reader.
</summary>
<exception cref="T:System.ObjectDisposedException">Thrown if this object is disposed.</exception>
</member>
<member name="M:NuGet.Protocol.RemotePackageArchiveDownloader.#ctor(System.String,NuGet.Protocol.Core.Types.FindPackageByIdResource,NuGet.Packaging.Core.PackageIdentity,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger)">
<summary>
Initializes a new <see cref="T:NuGet.Protocol.RemotePackageArchiveDownloader" /> class.
</summary>
<param name="source">A package source.</param>
<param name="resource">A <see cref="T:NuGet.Protocol.Core.Types.FindPackageByIdResource" /> resource.</param>
<param name="packageIdentity">A package identity.</param>
<param name="cacheContext">A source cache context.</param>
<param name="logger">A logger.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="resource" /> is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="packageIdentity" />
is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="cacheContext" />
is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="logger" /> is <c>null</c>.</exception>
</member>
<member name="M:NuGet.Protocol.RemotePackageArchiveDownloader.Dispose">
<summary>
Disposes this instance.
</summary>
</member>
<member name="M:NuGet.Protocol.RemotePackageArchiveDownloader.CopyNupkgFileToAsync(System.String,System.Threading.CancellationToken)">
<summary>
Asynchronously copies a .nupkg to a target file path.
</summary>
<param name="destinationFilePath">The destination file path.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns a <see cref="T:System.Boolean" />
indicating whether or not the copy was successful.</returns>
<exception cref="T:System.ObjectDisposedException">Thrown if this object is disposed.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="destinationFilePath" />
is either <c>null</c> or empty.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.RemotePackageArchiveDownloader.GetPackageHashAsync(System.String,System.Threading.CancellationToken)">
<summary>
Asynchronously gets a package hash.
</summary>
<param name="hashAlgorithm">The hash algorithm.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns a <see cref="T:System.String" />
representing the package hash.</returns>
<exception cref="T:System.ObjectDisposedException">Thrown if this object is disposed.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="hashAlgorithm" />
is either <c>null</c> or empty.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.RemotePackageArchiveDownloader.SetExceptionHandler(System.Func{System.Exception,System.Threading.Tasks.Task{System.Boolean}})">
<summary>
Sets an exception handler for package downloads.
</summary>
<remarks>The exception handler returns a task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns a <see cref="T:System.Boolean" />
indicating whether or not the exception was handled. To handle an exception and stop its
propagation, the task should return <c>true</c>. Otherwise, the exception will be rethrown.</remarks>
<param name="handleExceptionAsync">An exception handler.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="handleExceptionAsync" />
is <c>null</c>.</exception>
</member>
<member name="M:NuGet.Protocol.RemotePackageArchiveDownloader.SetThrottle(System.Threading.SemaphoreSlim)">
<summary>
Sets a throttle for package downloads.
</summary>
<param name="throttle">A throttle. Can be <c>null</c>.</param>
</member>
<member name="T:NuGet.Protocol.HttpFileSystemBasedFindPackageByIdResource">
<summary>
A <see cref="T:NuGet.Protocol.Core.Types.FindPackageByIdResource" /> for a Http-based file system where files are laid out in the
format
/root/
PackageA/
Version0/
PackageA.nuspec
PackageA.Version0.nupkg
and are accessible via HTTP Gets.
</summary>
</member>
<member name="M:NuGet.Protocol.HttpFileSystemBasedFindPackageByIdResource.#ctor(System.Collections.Generic.IReadOnlyList{System.Uri},NuGet.Protocol.HttpSource)">
<summary>
Initializes a new <see cref="T:NuGet.Protocol.HttpFileSystemBasedFindPackageByIdResource" /> class.
</summary>
<param name="baseUris">Base URI's.</param>
<param name="httpSource">An HTTP source.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="baseUris" /> is <c>null</c>.</exception>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="baseUris" /> is empty.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="httpSource" /> is <c>null</c>.</exception>
</member>
<member name="M:NuGet.Protocol.HttpFileSystemBasedFindPackageByIdResource.GetAllVersionsAsync(System.String,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Asynchronously gets all package versions for a package ID.
</summary>
<param name="id">A package ID.</param>
<param name="cacheContext">A source cache context.</param>
<param name="logger">A logger.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an
<see cref="T:System.Collections.Generic.IEnumerable`1" />.</returns>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="id" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="cacheContext" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="logger" /> <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.HttpFileSystemBasedFindPackageByIdResource.GetDependencyInfoAsync(System.String,NuGet.Versioning.NuGetVersion,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Asynchronously gets dependency information for a specific package.
</summary>
<param name="id">A package id.</param>
<param name="version">A package version.</param>
<param name="cacheContext">A source cache context.</param>
<param name="logger">A logger.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an
<see cref="T:System.Collections.Generic.IEnumerable`1" />.</returns>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="id" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="version" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="cacheContext" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="logger" /> <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.HttpFileSystemBasedFindPackageByIdResource.CopyNupkgToStreamAsync(System.String,NuGet.Versioning.NuGetVersion,System.IO.Stream,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Asynchronously copies a .nupkg to a stream.
</summary>
<param name="id">A package ID.</param>
<param name="version">A package version.</param>
<param name="destination">A destination stream.</param>
<param name="cacheContext">A source cache context.</param>
<param name="logger">A logger.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an
<see cref="T:System.Boolean" /> indicating whether or not the .nupkg file was copied.</returns>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="id" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="version" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="destination" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="cacheContext" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="logger" /> <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.HttpFileSystemBasedFindPackageByIdResource.GetPackageDownloaderAsync(NuGet.Packaging.Core.PackageIdentity,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Asynchronously gets a package downloader for a package identity.
</summary>
<param name="packageIdentity">A package identity.</param>
<param name="cacheContext">A source cache context.</param>
<param name="logger">A logger.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an <see cref="T:NuGet.Packaging.IPackageDownloader" />.</returns>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="packageIdentity" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="cacheContext" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="logger" /> <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.HttpFileSystemBasedFindPackageByIdResource.DoesPackageExistAsync(System.String,NuGet.Versioning.NuGetVersion,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Asynchronously check if exact package (id/version) exists at this source.
</summary>
<param name="id">A package id.</param>
<param name="version">A package version.</param>
<param name="cacheContext">A source cache context.</param>
<param name="logger">A logger.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an
<see cref="T:System.Collections.Generic.IEnumerable`1" />.</returns>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="id" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="version" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="cacheContext" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="logger" /> <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.PackageUtilities.OpenNuspecFromNupkg(System.String,System.IO.Stream,NuGet.Common.ILogger)">
<summary>
Create a <see cref="T:NuGet.Packaging.NuspecReader" /> from a nupkg stream.
</summary>
</member>
<member name="T:NuGet.Protocol.PluginFindPackageByIdResourceProvider">
<summary>
A FindPackageByIdResource provider for plugins.
</summary>
</member>
<member name="M:NuGet.Protocol.PluginFindPackageByIdResourceProvider.#ctor">
<summary>
Instantiates a new <see cref="T:NuGet.Protocol.PluginFindPackageByIdResourceProvider" /> class.
</summary>
</member>
<member name="M:NuGet.Protocol.PluginFindPackageByIdResourceProvider.TryCreate(NuGet.Protocol.Core.Types.SourceRepository,System.Threading.CancellationToken)">
<summary>
Asynchronously attempts to create a resource for the specified source repository.
</summary>
<param name="source">A source repository.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns a Tuple<bool, INuGetResource></returns>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="source" /> is <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="T:NuGet.Protocol.RemoteV2FindPackageByIdResource">
<summary>
A resource capable of fetching packages, package versions and package dependency information.
</summary>
</member>
<member name="M:NuGet.Protocol.RemoteV2FindPackageByIdResource.#ctor(NuGet.Configuration.PackageSource,NuGet.Protocol.HttpSource)">
<summary>
Initializes a new <see cref="T:NuGet.Protocol.RemoteV2FindPackageByIdResource" /> class.
</summary>
<param name="packageSource">A package source.</param>
<param name="httpSource">An HTTP source.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="packageSource" />
is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="httpSource" />
is <c>null</c>.</exception>
</member>
<member name="P:NuGet.Protocol.RemoteV2FindPackageByIdResource.PackageSource">
<summary>
Gets the package source.
</summary>
</member>
<member name="M:NuGet.Protocol.RemoteV2FindPackageByIdResource.GetAllVersionsAsync(System.String,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Asynchronously gets all package versions for a package ID.
</summary>
<param name="id">A package ID.</param>
<param name="cacheContext">A source cache context.</param>
<param name="logger">A logger.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an
<see cref="T:System.Collections.Generic.IEnumerable`1" />.</returns>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="id" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="cacheContext" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="logger" /> <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.RemoteV2FindPackageByIdResource.GetDependencyInfoAsync(System.String,NuGet.Versioning.NuGetVersion,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Asynchronously gets dependency information for a specific package.
</summary>
<param name="id">A package id.</param>
<param name="version">A package version.</param>
<param name="cacheContext">A source cache context.</param>
<param name="logger">A logger.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an
<see cref="T:System.Collections.Generic.IEnumerable`1" />.</returns>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="id" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="version" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="cacheContext" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="logger" /> <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.RemoteV2FindPackageByIdResource.CopyNupkgToStreamAsync(System.String,NuGet.Versioning.NuGetVersion,System.IO.Stream,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Asynchronously copies a .nupkg to a stream.
</summary>
<param name="id">A package ID.</param>
<param name="version">A package version.</param>
<param name="destination">A destination stream.</param>
<param name="cacheContext">A source cache context.</param>
<param name="logger">A logger.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an
<see cref="T:System.Boolean" /> indicating whether or not the .nupkg file was copied.</returns>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="id" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="version" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="destination" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="cacheContext" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="logger" /> <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.RemoteV2FindPackageByIdResource.GetPackageDownloaderAsync(NuGet.Packaging.Core.PackageIdentity,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Asynchronously gets a package downloader for a package identity.
</summary>
<param name="packageIdentity">A package identity.</param>
<param name="cacheContext">A source cache context.</param>
<param name="logger">A logger.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an <see cref="T:NuGet.Packaging.IPackageDownloader" />.</returns>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="packageIdentity" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="cacheContext" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="logger" /> <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.RemoteV2FindPackageByIdResource.DoesPackageExistAsync(System.String,NuGet.Versioning.NuGetVersion,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Asynchronously check if exact package (id/version) exists at this source.
</summary>
<param name="id">A package id.</param>
<param name="version">A package version.</param>
<param name="cacheContext">A source cache context.</param>
<param name="logger">A logger.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an
<see cref="T:System.Collections.Generic.IEnumerable`1" />.</returns>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="id" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="version" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="cacheContext" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="logger" /> <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="T:NuGet.Protocol.RemoteV2FindPackageByIdResourceProvider">
<summary>
A <see cref="T:NuGet.Protocol.Core.Types.ResourceProvider" /> for <see cref="T:NuGet.Protocol.Core.Types.FindPackageByIdResource" /> over v2 NuGet feeds.
</summary>
</member>
<member name="T:NuGet.Protocol.RemoteV3FindPackageByIdResource">
<summary>
A resource capable of fetching packages, package versions and package dependency information.
</summary>
</member>
<member name="M:NuGet.Protocol.RemoteV3FindPackageByIdResource.#ctor(NuGet.Protocol.Core.Types.SourceRepository,NuGet.Protocol.HttpSource)">
<summary>
Initializes a new <see cref="T:NuGet.Protocol.RemoteV3FindPackageByIdResource" /> class.
</summary>
<param name="sourceRepository">A source repository.</param>
<param name="httpSource">An HTTP source.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="sourceRepository" />
is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="httpSource" />
is <c>null</c>.</exception>
</member>
<member name="P:NuGet.Protocol.RemoteV3FindPackageByIdResource.SourceRepository">
<summary>
Gets the source repository.
</summary>
</member>
<member name="M:NuGet.Protocol.RemoteV3FindPackageByIdResource.GetAllVersionsAsync(System.String,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Asynchronously gets all package versions for a package ID.
</summary>
<param name="id">A package ID.</param>
<param name="cacheContext">A source cache context.</param>
<param name="logger">A logger.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an
<see cref="T:System.Collections.Generic.IEnumerable`1" />.</returns>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="id" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="cacheContext" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="logger" /> <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.RemoteV3FindPackageByIdResource.GetDependencyInfoAsync(System.String,NuGet.Versioning.NuGetVersion,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Asynchronously gets dependency information for a specific package.
</summary>
<param name="id">A package id.</param>
<param name="version">A package version.</param>
<param name="cacheContext">A source cache context.</param>
<param name="logger">A logger.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an
<see cref="T:System.Collections.Generic.IEnumerable`1" />.</returns>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="id" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="version" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="cacheContext" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="logger" /> <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.RemoteV3FindPackageByIdResource.CopyNupkgToStreamAsync(System.String,NuGet.Versioning.NuGetVersion,System.IO.Stream,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Asynchronously copies a .nupkg to a stream.
</summary>
<param name="id">A package ID.</param>
<param name="version">A package version.</param>
<param name="destination">A destination stream.</param>
<param name="cacheContext">A source cache context.</param>
<param name="logger">A logger.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an
<see cref="T:System.Boolean" /> indicating whether or not the .nupkg file was copied.</returns>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="id" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="version" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="destination" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="cacheContext" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="logger" /> <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.RemoteV3FindPackageByIdResource.GetPackageDownloaderAsync(NuGet.Packaging.Core.PackageIdentity,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Asynchronously gets a package downloader for a package identity.
</summary>
<param name="packageIdentity">A package identity.</param>
<param name="cacheContext">A source cache context.</param>
<param name="logger">A logger.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an <see cref="T:NuGet.Packaging.IPackageDownloader" />.</returns>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="packageIdentity" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="cacheContext" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="logger" /> <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="M:NuGet.Protocol.RemoteV3FindPackageByIdResource.DoesPackageExistAsync(System.String,NuGet.Versioning.NuGetVersion,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Asynchronously check if exact package (id/version) exists at this source.
</summary>
<param name="id">A package id.</param>
<param name="version">A package version.</param>
<param name="cacheContext">A source cache context.</param>
<param name="logger">A logger.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns an
<see cref="T:System.Collections.Generic.IEnumerable`1" />.</returns>
<exception cref="T:System.ArgumentException">Thrown if <paramref name="id" />
is either <c>null</c> or an empty string.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="version" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="cacheContext" /> <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="logger" /> <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="T:NuGet.Protocol.DependencyInfoResourceV3">
<summary>
Retrieves all packages and dependencies from a V3 source.
</summary>
</member>
<member name="M:NuGet.Protocol.DependencyInfoResourceV3.#ctor(NuGet.Protocol.HttpSource,NuGet.Protocol.RegistrationResourceV3,NuGet.Protocol.Core.Types.SourceRepository)">
<summary>
Dependency info resource
</summary>
<param name="client">Http client</param>
<param name="regResource">Registration blob resource</param>
</member>
<member name="M:NuGet.Protocol.DependencyInfoResourceV3.ResolvePackage(NuGet.Packaging.Core.PackageIdentity,NuGet.Frameworks.NuGetFramework,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Retrieve dependency info for a single package.
</summary>
<param name="package">package id and version</param>
<param name="projectFramework">project target framework. This is used for finding the dependency group</param>
<param name="token">cancellation token</param>
<returns>
Returns dependency info for the given package if it exists. If the package is not found null is
returned.
</returns>
</member>
<member name="M:NuGet.Protocol.DependencyInfoResourceV3.ResolvePackages(System.String,NuGet.Frameworks.NuGetFramework,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Retrieve the available packages and their dependencies.
</summary>
<remarks>Includes prerelease packages</remarks>
<param name="packageId">package Id to search</param>
<param name="projectFramework">project target framework. This is used for finding the dependency group</param>
<param name="token">cancellation token</param>
<returns>available packages and their dependencies</returns>
</member>
<member name="M:NuGet.Protocol.DependencyInfoResourceV3.ResolvePackages(System.String,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Retrieve the available packages and their dependencies.
</summary>
<remarks>Includes prerelease packages</remarks>
<param name="packageId">package Id to search</param>
<param name="token">cancellation token</param>
<returns>available packages and their dependencies</returns>
</member>
<member name="M:NuGet.Protocol.DependencyInfoResourceV3.GetPackagesFromRegistration(NuGet.Protocol.RegistrationInfo,System.Threading.CancellationToken)">
<summary>
Retrieve dependency info from a registration blob
</summary>
</member>
<member name="T:NuGet.Protocol.DownloadResourcePlugin">
<summary>
A download resource for plugins.
</summary>
</member>
<member name="M:NuGet.Protocol.DownloadResourcePlugin.#ctor(NuGet.Protocol.Plugins.IPlugin,NuGet.Protocol.Plugins.IPluginMulticlientUtilities,NuGet.Configuration.PackageSource)">
<summary>
Instantiates a new <see cref="T:NuGet.Protocol.DownloadResourcePlugin" /> class.
</summary>
<param name="plugin">A plugin.</param>
<param name="utilities">A plugin multiclient utilities.</param>
<param name="packageSource">A package source.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="plugin" />
is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="utilities" />
is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="packageSource" />
is <c>null</c>.</exception>
</member>
<member name="M:NuGet.Protocol.DownloadResourcePlugin.GetDownloadResourceResultAsync(NuGet.Packaging.Core.PackageIdentity,NuGet.Protocol.Core.Types.PackageDownloadContext,System.String,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Asynchronously downloads a package.
</summary>
<param name="identity">The package identity.</param>
<param name="downloadContext">A package download context.</param>
<param name="globalPackagesFolder">The path to the global packages folder.</param>
<param name="logger">A logger.</param>
<param name="cancellationToken">A cancellation token.</param>
<returns>A task that represents the asynchronous operation.
The task result (<see cref="P:System.Threading.Tasks.Task`1.Result" />) returns
a <see cref="T:NuGet.Protocol.Core.Types.DownloadResourceResult" />.</returns>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="identity" /> is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="downloadContext" />
is <c>null</c>.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="logger" /> is <c>null</c>.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if <paramref name="cancellationToken" />
is cancelled.</exception>
</member>
<member name="T:NuGet.Protocol.DownloadResourceV3">
<summary>
Provides the download metatdata for a given package from a V3 server endpoint.
</summary>
</member>
<member name="M:NuGet.Protocol.DownloadResourceV3.#ctor(NuGet.Protocol.HttpSource,NuGet.Protocol.RegistrationResourceV3)">
<summary>
Download packages using the download url found in the registration resource.
</summary>
</member>
<member name="M:NuGet.Protocol.DownloadResourceV3.#ctor(System.String,NuGet.Protocol.HttpSource,NuGet.Protocol.RegistrationResourceV3)">
<summary>
Download packages using the download url found in the registration resource.
</summary>
</member>
<member name="M:NuGet.Protocol.DownloadResourceV3.#ctor(NuGet.Protocol.HttpSource,System.String)">
<summary>
Download packages using the package base address container resource.
</summary>
</member>
<member name="M:NuGet.Protocol.DownloadResourceV3.#ctor(System.String,NuGet.Protocol.HttpSource,System.String)">
<summary>
Download packages using the package base address container resource.
</summary>
</member>
<member name="M:NuGet.Protocol.DownloadResourceV3.GetDownloadUrl(NuGet.Packaging.Core.PackageIdentity,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Get the download url of the package.
1. If the identity is a SourcePackageDependencyInfo the SourcePackageDependencyInfo.DownloadUri is used.
2. A url will be constructed for the flat container location if the source has that resource.
3. The download url will be found in the registration blob as a fallback.
</summary>
</member>
<member name="T:NuGet.Protocol.MetadataResourceV3">
<summary>
Returns the full package metadata
</summary>
</member>
<member name="M:NuGet.Protocol.MetadataResourceV3.GetLatestVersions(System.Collections.Generic.IEnumerable{System.String},System.Boolean,System.Boolean,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Find the latest version of the package
</summary>
<param name="includePrerelease">include versions with prerelease labels</param>
<param name="includeUnlisted">not implemented yet</param>
</member>
<member name="M:NuGet.Protocol.PackageDetailsUriResourceV3.GetUri(System.String,NuGet.Versioning.NuGetVersion)">
<summary>
Gets a URL for viewing package details outside of Visual Studio. The URL will not be verified to exist.
</summary>
<param name="id">The package id (any casing).</param>
<param name="version">The package version.</param>
<returns>The first URL from the resource, with the URI template applied.</returns>
</member>
<member name="M:NuGet.Protocol.PackageMetadataResourceV3.GetMetadataAsync(System.String,System.Boolean,System.Boolean,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<param name="packageId">PackageId for package we're looking.</param>
<param name="includePrerelease">Whether to include PreRelease versions into result.</param>
<param name="includeUnlisted">Whether to include Unlisted versions into result.</param>
<param name="sourceCacheContext">SourceCacheContext for cache.</param>
<param name="log">Logger Instance.</param>
<param name="token">Cancellation token.</param>
<returns>List of package metadata.</returns>
</member>
<member name="M:NuGet.Protocol.PackageMetadataResourceV3.GetMetadataAsync(NuGet.Packaging.Core.PackageIdentity,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Returns the registration metadata for the id and version
</summary>
<param name="package"></param>
<param name="sourceCacheContext"></param>
<param name="log"></param>
<param name="token"></param>
<returns>Package meta data.</returns>
<remarks>The inlined entries are potentially going away soon</remarks>
</member>
<member name="M:NuGet.Protocol.PackageMetadataResourceV3.DeserializeStreamDataAsync``1(System.IO.Stream,System.Threading.CancellationToken)">
<summary>
Deserialize stream from RegistrationIndex/RegistrationPage and return list of RegistrationPages or RegistrationPage.
</summary>
<typeparam name="T">Generic type</typeparam>
<param name="stream">Stream data to read.</param>
<param name="token">Cancellation token.</param>
<returns></returns>
</member>
<member name="M:NuGet.Protocol.PackageMetadataResourceV3.LoadRegistrationIndexAsync(NuGet.Protocol.HttpSource,System.Uri,System.String,NuGet.Protocol.Core.Types.SourceCacheContext,System.Func{NuGet.Protocol.HttpSourceResult,System.Threading.Tasks.Task{NuGet.Protocol.Model.RegistrationIndex}},NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Query RegistrationIndex from nuget server for Package Manager UI. This implementation optimized for performance so instead of keeping giant JObject in memory we use strong types.
</summary>
<param name="httpSource">Httpsource instance</param>
<param name="registrationUri">Package registration url</param>
<param name="packageId">PackageId for package we're looking.</param>
<param name="cacheContext">CacheContext for cache.</param>
<param name="processAsync">Func expression used for HttpSource.cs</param>
<param name="log">Logger Instance.</param>
<param name="token">Cancellation token.</param>
<returns></returns>
</member>
<member name="M:NuGet.Protocol.PackageMetadataResourceV3.GetRegistratioIndexPageAsync(NuGet.Protocol.HttpSource,System.String,System.String,NuGet.Versioning.NuGetVersion,NuGet.Versioning.NuGetVersion,NuGet.Protocol.Core.Types.HttpSourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Process RegistrationIndex
</summary>
<param name="httpSource">Httpsource instance.</param>
<param name="rangeUri">Paged registration index url address.</param>
<param name="packageId">PackageId for package we're checking.</param>
<param name="lower">Lower bound of nuget package.</param>
<param name="upper">Upper bound of nuget package.</param>
<param name="httpSourceCacheContext">SourceCacheContext for cache.</param>
<param name="log">Logger Instance.</param>
<param name="token">Cancellation token.</param>
<returns></returns>
</member>
<member name="M:NuGet.Protocol.PackageMetadataResourceV3.ProcessRegistrationPage(NuGet.Protocol.Model.RegistrationPage,System.Collections.Generic.List{NuGet.Protocol.PackageSearchMetadataRegistration},NuGet.Versioning.VersionRange,System.Boolean,System.Boolean,NuGet.Protocol.MetadataReferenceCache)">
<summary>
Process RegistrationPage
</summary>
<param name="registrationPage">Nuget registration page.</param>
<param name="results">Used to return nuget result.</param>
<param name="range">Nuget version range.</param>
<param name="includePrerelease">Whether to include PreRelease versions into result.</param>
<param name="includeUnlisted">Whether to include Unlisted versions into result.</param>
</member>
<member name="M:NuGet.Protocol.PackageSearchResourceV3.SearchAsync(System.String,NuGet.Protocol.Core.Types.SearchFilter,System.Int32,System.Int32,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Query nuget package list from nuget server. This implementation optimized for performance so doesn't iterate whole result
returned nuget server, so as soon as find "take" number of result packages then stop processing and return the result.
</summary>
<param name="searchTerm">The term we're searching for.</param>
<param name="filter">Filter for whether to include prerelease, delisted, supportedframework flags in query.</param>
<param name="skip">Skip how many items from beginning of list.</param>
<param name="take">Return how many items.</param>
<param name="log">Logger instance.</param>
<param name="cancellationToken">Cancellation token.</param>
<returns>List of package meta data.</returns>
</member>
<member name="M:NuGet.Protocol.PackageSearchResourceV3.Search(System.String,NuGet.Protocol.Core.Types.SearchFilter,System.Int32,System.Int32,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Query nuget package list from nuget server. This implementation optimized for performance so doesn't iterate whole result
returned nuget server, so as soon as find "take" number of result packages then stop processing and return the result.
</summary>
<param name="searchTerm">The term we're searching for.</param>
<param name="filters">Filter for whether to include prerelease, delisted, supportedframework flags in query.</param>
<param name="skip">Skip how many items from beginning of list.</param>
<param name="take">Return how many items.</param>
<param name="log">Logger instance.</param>
<param name="cancellationToken">Cancellation token.</param>
<returns>List of package meta data.</returns>
</member>
<member name="T:NuGet.Protocol.RegistrationResourceV3">
<summary>
Registration blob reader
</summary>
</member>
<member name="P:NuGet.Protocol.RegistrationResourceV3.BaseUri">
<summary>
Gets the <see cref="T:System.Uri" /> for the source backing this resource.
</summary>
</member>
<member name="M:NuGet.Protocol.RegistrationResourceV3.GetUri(System.String)">
<summary>
Constructs the URI of a registration index blob
</summary>
</member>
<member name="M:NuGet.Protocol.RegistrationResourceV3.GetUri(System.String,NuGet.Versioning.NuGetVersion)">
<summary>
Constructs the URI of a registration blob with a specific version
</summary>
</member>
<member name="M:NuGet.Protocol.RegistrationResourceV3.GetUri(NuGet.Packaging.Core.PackageIdentity)">
<summary>
Constructs the URI of a registration blob with a specific version
</summary>
</member>
<member name="M:NuGet.Protocol.RegistrationResourceV3.GetPackageMetadata(NuGet.Packaging.Core.PackageIdentity,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Returns the registration blob for the id and version
</summary>
<remarks>The inlined entries are potentially going away soon</remarks>
</member>
<member name="M:NuGet.Protocol.RegistrationResourceV3.GetPackageMetadata(System.String,System.Boolean,System.Boolean,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Returns inlined catalog entry items for each registration blob
</summary>
<remarks>The inlined entries are potentially going away soon</remarks>
</member>
<member name="M:NuGet.Protocol.RegistrationResourceV3.GetPackageMetadata(System.String,NuGet.Versioning.VersionRange,System.Boolean,System.Boolean,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Returns inlined catalog entry items for each registration blob
</summary>
<remarks>The inlined entries are potentially going away soon</remarks>
</member>
<member name="M:NuGet.Protocol.RegistrationResourceV3.GetPackageEntries(System.String,System.Boolean,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Returns all index entries of type Package within the given range and filters
</summary>
</member>
<member name="M:NuGet.Protocol.ReportAbuseResourceV3.GetReportAbuseUrl(System.String,NuGet.Versioning.NuGetVersion)">
<summary>
Gets a URL for reporting package abuse. The URL will not be verified to exist.
</summary>
<param name="id">The package id (natural casing)</param>
<param name="version">The package version</param>
<returns>The first URL from the resource, with the URI template applied.</returns>
</member>
<member name="T:NuGet.Protocol.ServiceIndexResourceV3">
<summary>
Stores/caches a service index json file.
</summary>
</member>
<member name="P:NuGet.Protocol.ServiceIndexResourceV3.RequestTime">
<summary>
Time the index was requested
</summary>
</member>
<member name="P:NuGet.Protocol.ServiceIndexResourceV3.Entries">
<summary>
All service index entries.
</summary>
</member>
<member name="M:NuGet.Protocol.ServiceIndexResourceV3.GetServiceEntries(System.String[])">
<summary>
Get the list of service entries that best match the current clientVersion and type.
</summary>
</member>
<member name="M:NuGet.Protocol.ServiceIndexResourceV3.GetServiceEntries(NuGet.Versioning.NuGetVersion,System.String[])">
<summary>
Get the list of service entries that best match the clientVersion and type.
</summary>
</member>
<member name="M:NuGet.Protocol.ServiceIndexResourceV3.GetServiceEntryUri(System.String[])">
<summary>
Get the best match service URI.
</summary>
</member>
<member name="M:NuGet.Protocol.ServiceIndexResourceV3.GetServiceEntryUris(System.String[])">
<summary>
Get the list of service URIs that best match the current clientVersion and type.
</summary>
</member>
<member name="M:NuGet.Protocol.ServiceIndexResourceV3.GetServiceEntryUris(NuGet.Versioning.NuGetVersion,System.String[])">
<summary>
Get the list of service URIs that best match the clientVersion and type.
</summary>
</member>
<member name="M:NuGet.Protocol.ServiceIndexResourceV3.GetValues(Newtonsoft.Json.Linq.JToken)">
<summary>
Read string values from an array or string.
Returns an empty enumerable if the value is null.
</summary>
</member>
<member name="T:NuGet.Protocol.Strings">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.AddPackage_ExistingPackageInvalid">
<summary>
Looks up a localized string similar to Package '{0}' already exists at feed '{1}' and is invalid..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.AddPackage_PackageAlreadyExists">
<summary>
Looks up a localized string similar to Package '{0}' already exists at feed '{1}'..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.AddPackage_SuccessfullyAdded">
<summary>
Looks up a localized string similar to Successfully added package '{0}' to feed '{1}'..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Argument_Cannot_Be_Null_Or_Empty">
<summary>
Looks up a localized string similar to Argument can not be null or empty..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.ArgumentCannotBeNullOrEmpty">
<summary>
Looks up a localized string similar to Argument cannot be null or empty..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.DefaultSymbolServer">
<summary>
Looks up a localized string similar to the symbol server.
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.DeleteCommandCanceled">
<summary>
Looks up a localized string similar to Delete canceled.
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.DeleteCommandConfirm">
<summary>
Looks up a localized string similar to {0} {1} will be deleted from the {2}. Would you like to continue?.
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.DeleteCommandDeletedPackage">
<summary>
Looks up a localized string similar to {0} {1} was deleted successfully..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.DeleteCommandDeletingPackage">
<summary>
Looks up a localized string similar to Deleting {0} {1} from the {2}..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.DeletePackage_NotFound">
<summary>
Looks up a localized string similar to Not Found..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Error_DownloadTimeout">
<summary>
Looks up a localized string similar to The download of '{0}' timed out because no data was received for {1}ms..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Http_CredentialsForForbidden">
<summary>
Looks up a localized string similar to The server responded with HTTP '403 Forbidden' when accessing the source '{0}'. This suggests that the server has authenticated your identity but has not permitted you to access the requested resource. Provide credentials that have permissions to view this resource..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Http_CredentialsForProxy">
<summary>
Looks up a localized string similar to The server responded with HTTP '407 Proxy Authentication Required' when accessing the proxy '{0}'. This suggests that the server needs credentials to authenticate your identity to use a proxy. Provide credentials to access this resource..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Http_CredentialsForUnauthorized">
<summary>
Looks up a localized string similar to The server responded with HTTP '401 Unauthorized' when accessing the source '{0}'. This suggests that the server needs credentials to authenticate your identity. Provide credentials to access this resource..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Http_RequestLog">
<summary>
Looks up a localized string similar to {0} {1}.
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Http_ResponseLog">
<summary>
Looks up a localized string similar to {0} {1} {2}ms.
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Http_Timeout">
<summary>
Looks up a localized string similar to The HTTP request to '{0} {1}' has timed out after {2}ms..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.InvalidVersionFolder">
<summary>
Looks up a localized string similar to The folder '{0}' contains an invalid version..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.LiveFeed">
<summary>
Looks up a localized string similar to the NuGet gallery.
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.LoadFileFromNupkg_FileNotFound">
<summary>
Looks up a localized string similar to The file '{0}' does not exist in the package..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.LoadFileFromNupkg_FileTooLarge">
<summary>
Looks up a localized string similar to Cannot load the file '{0}' because it is larger than {1} MB..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.LoadFileFromNupkg_UnknownProblemLoadingTheFile">
<summary>
Looks up a localized string similar to Unknown problem loading the file '{0}'..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Log_CanceledNupkgDownload">
<summary>
Looks up a localized string similar to Downloading a package from '{0}' was canceled..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Log_ErrorDownloading">
<summary>
Looks up a localized string similar to Error downloading '{0}' from '{1}'..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Log_FailedToDownloadPackage">
<summary>
Looks up a localized string similar to Failed to download package '{0}' from '{1}'..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Log_FailedToFetchV2Feed">
<summary>
Looks up a localized string similar to The V2 feed at '{0}' returned an unexpected status code '{1} {2}'..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Log_FailedToFetchV2FeedHttp">
<summary>
Looks up a localized string similar to Failed to fetch results from V2 feed at '{0}' with following message : {1}.
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Log_FailedToGetNuspecStream">
<summary>
Looks up a localized string similar to Unable to load nuspec from package '{0}'..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Log_FailedToParseRepoSignInfor">
<summary>
Looks up a localized string similar to Unable to parse {0} information from {1}. .
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Log_FailedToReadRepositorySignature">
<summary>
Looks up a localized string similar to Unable to get repository signature information for source {0}..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Log_FailedToReadServiceIndex">
<summary>
Looks up a localized string similar to Unable to load the service index for source {0}..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Log_FailedToRetrievePackage">
<summary>
Looks up a localized string similar to Failed to retrieve information about '{0}' from remote source '{1}'..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Log_FailedToVerifyRootDirectory">
<summary>
Looks up a localized string similar to Failed to verify the root directory of local source '{0}'..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Log_FailedToVerifyValidFile">
<summary>
Looks up a localized string similar to Failed to validate the file '{0}'..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Log_FileIsCorrupt">
<summary>
Looks up a localized string similar to The file '{0}' is corrupt..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Log_InvalidCacheEntry">
<summary>
Looks up a localized string similar to An invalid cache entry was found for URL '{0}' and will be replaced..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Log_InvalidNupkgFromUrl">
<summary>
Looks up a localized string similar to The nupkg at '{0}' is not valid..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Log_LocalSourceNotExist">
<summary>
Looks up a localized string similar to The local source '{0}' doesn't exist..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Log_RetryingFindPackagesById">
<summary>
Looks up a localized string similar to Retrying '{0}' for source '{1}'..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Log_RetryingHttp">
<summary>
Looks up a localized string similar to An error was encountered when fetching '{0} {1}'. The request will now be retried..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Log_RetryingRepositorySignature">
<summary>
Looks up a localized string similar to Retrying repository signature request for source '{0}'..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Log_RetryingServiceIndex">
<summary>
Looks up a localized string similar to Retrying service index request for source '{0}'..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.NoApiKeyFound">
<summary>
Looks up a localized string similar to No API Key was provided and no API Key could be found for {0}. To save an API Key for a source use the 'setApiKey' command..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.NuGetLicense_LicenseExpressionVersionTooHigh">
<summary>
Looks up a localized string similar to The license version string '{0}' is higher than the one supported by this toolset '{1}'..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.NuGetLicenseExpression_NonStandardIdentifier">
<summary>
Looks up a localized string similar to The license identifier(s) {0} is(are) not recognized by the current toolset..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.NupkgPath_Invalid">
<summary>
Looks up a localized string similar to '{0}' is not a valid nupkg file..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.NupkgPath_InvalidEx">
<summary>
Looks up a localized string similar to '{0}' is not a valid nupkg file. Error: '{1}'..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.OneOrMoreUrisMustBeSpecified">
<summary>
Looks up a localized string similar to One or more URIs must be specified..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.PackageNotFound">
<summary>
Looks up a localized string similar to Unable to find package '{0}'..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.PackageServerEndpoint_NotSupported">
<summary>
Looks up a localized string similar to ERROR: This version of nuget.exe does not support updating packages to package source '{0}'..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Path_Invalid">
<summary>
Looks up a localized string similar to '{0}' is not a valid path..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Path_Invalid_NotFileNotUnc">
<summary>
Looks up a localized string similar to '{0}' should be a local path or a UNC share path..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Plugin_ConnectionAlreadyStarted">
<summary>
Looks up a localized string similar to A connection has already been started..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Plugin_ConnectionIsClosed">
<summary>
Looks up a localized string similar to The plugin connection is closed..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Plugin_DownloadNotSupportedSinceUnsignedNotAllowed">
<summary>
Looks up a localized string similar to Downloading a package from a plugin is not supported since unsigned packages are not allowed and package download plugins do not support signed package verification..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Plugin_Exception">
<summary>
Looks up a localized string similar to Plugin '{0}' failed with the exception: {1}.
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Plugin_FailedOnCreation">
<summary>
Looks up a localized string similar to Plugin '{0}' failed within {1:N3} seconds with exit code {2}..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Plugin_FailedOperationForPackage">
<summary>
Looks up a localized string similar to Plugin '{0}' failed a {1} operation for package {2}.{3}..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Plugin_FailureQueryingPackageVersions">
<summary>
Looks up a localized string similar to A failure occurred while attempting to query package versions for package '{0}' using the plugin at '{1}'..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Plugin_Fault">
<summary>
Looks up a localized string similar to Terminating plugin '{0}' due to an unrecoverable fault: {1}.
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Plugin_FileNotFound">
<summary>
Looks up a localized string similar to A plugin was not found at path '{0}'..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Plugin_HandshakeFailed">
<summary>
Looks up a localized string similar to The plugin handshake failed..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Plugin_HandshakeRequestHandlerAlreadyExists">
<summary>
Looks up a localized string similar to A handshake request handler already exists..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Plugin_IdleTimeoutMustBeGreaterThanOrEqualToInfiniteTimeSpan">
<summary>
Looks up a localized string similar to The idle timeout must be greater than or equal to System.Threading.Timeout.InfiniteTimeSpan..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Plugin_InitializationFailed">
<summary>
Looks up a localized string similar to Plugin initialization failed..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Plugin_InvalidEmbeddedSignature">
<summary>
Looks up a localized string similar to The plugin at '{0}' did not have a valid embedded signature..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Plugin_InvalidMessageType">
<summary>
Looks up a localized string similar to The message type '{0}' is invalid at this time..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Plugin_InvalidPluginFilePath">
<summary>
Looks up a localized string similar to The plugin file path '{0}' is invalid..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Plugin_NotConnected">
<summary>
Looks up a localized string similar to A plugin is not connected..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Plugin_PackageDownloadFailed">
<summary>
Looks up a localized string similar to Plugin '{0}' failed to download package '{1}'..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Plugin_ProblemStartingPlugin">
<summary>
Looks up a localized string similar to Problem starting the plugin '{0}'. {1}.
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Plugin_ProtocolException">
<summary>
Looks up a localized string similar to A plugin protocol exception occurred..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Plugin_ProtocolVersionNotSupportedOnError">
<summary>
Looks up a localized string similar to A protocol version is not supported on error..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Plugin_ProtocolVersionOutOfRange">
<summary>
Looks up a localized string similar to '{0}' must be greater than or equal to '{1}'..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Plugin_RequestContextDoesNotExist">
<summary>
Looks up a localized string similar to Request context does not exist for request ID '{0}'..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Plugin_RequestHandlerDoesNotExist">
<summary>
Looks up a localized string similar to A request handler does not exist for the message method '{0}'..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Plugin_TimeoutOutOfRange">
<summary>
Looks up a localized string similar to Timeout must be greater than TimeSpan.Zero and less than or equal to TimeSpan.FromMilliseconds(int.MaxValue)..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Plugin_UnrecognizedEnumValue">
<summary>
Looks up a localized string similar to The enum value '{0}' is unrecognized..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Plugin_UnrecognizedOperationClaims">
<summary>
Looks up a localized string similar to The operation claims are unrecognized: {0}..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Protocol_BadSource">
<summary>
Looks up a localized string similar to Failed to retrieve metadata from source '{0}'..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Protocol_duplicateUri">
<summary>
Looks up a localized string similar to '{0}' is a duplicate url which has already been downloaded and will lead to a cyclic dependency. Please correct from server..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Protocol_InvalidJsonObject">
<summary>
Looks up a localized string similar to The content at '{0}' is not a valid JSON object..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Protocol_InvalidXml">
<summary>
Looks up a localized string similar to The content at '{0}' is not valid XML..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Protocol_MalformedMetadataError">
<summary>
Looks up a localized string similar to Metadata could not be loaded from the source '{0}'..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Protocol_MissingSearchService">
<summary>
Looks up a localized string similar to The source does not have a Search service!.
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Protocol_MissingVersion">
<summary>
Looks up a localized string similar to The source does not have the 'version' property..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Protocol_PackageMetadataError">
<summary>
Looks up a localized string similar to An error occurred while retrieving package metadata for '{0}' from source '{1}'..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Protocol_Search_LocalSourceNotFound">
<summary>
Looks up a localized string similar to The path '{0}' for the selected source could not be resolved..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Protocol_UnsupportedVersion">
<summary>
Looks up a localized string similar to The source version is not supported: '{0}'..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.PushCommandPackagePushed">
<summary>
Looks up a localized string similar to Your package was pushed..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.PushCommandPushingPackage">
<summary>
Looks up a localized string similar to Pushing {0} to {1}....
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.PushCommandSkipDuplicateAdvertiseDotnetExe">
<summary>
Looks up a localized string similar to To skip already published packages, use the option --skip-duplicate.
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.PushCommandSkipDuplicateAdvertiseNuGetExe">
<summary>
Looks up a localized string similar to To skip already published packages, use the option -SkipDuplicate.
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.PushCommandSkipDuplicateNotImplemented">
<summary>
Looks up a localized string similar to The option to skip duplicates is not currently supported for this type of push..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.RepositoryContentUrlMustBeHttps">
<summary>
Looks up a localized string similar to Repository content URL for repository signatures must be HTTPS..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.RepositorySignaturesResourceMustBeHttps">
<summary>
Looks up a localized string similar to Repository Signatures resouce must be served over HTTPS. Source: {0}.
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.StringCannotBeNullOrEmpty">
<summary>
Looks up a localized string similar to String argument '{0}' cannot be null or empty.
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.UnableToFindFile">
<summary>
Looks up a localized string similar to File does not exist ({0})..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.UnableToParseFolderV3Version">
<summary>
Looks up a localized string similar to Unable to parse a valid version from a v3 folder: '{0}'..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Warning_HttpServerUsage">
<summary>
Looks up a localized string similar to You are running the '{0}' operation with an 'HTTP' source, '{1}'. Non-HTTPS access will be removed in a future version. Consider migrating to 'HTTPS' sources..
</summary>
</member>
<member name="P:NuGet.Protocol.Strings.Warning_SymbolServerNotConfigured">
<summary>
Looks up a localized string similar to Found symbols package '{0}', but no API key was specified for the symbol server. To save an API Key, run 'NuGet.exe setApiKey [your API key from http://www.NuGet.org]'..
</summary>
</member>
<member name="M:NuGet.Protocol.CachingUtility.ComputeHash(System.String,System.Boolean)">
<summary>
Given a string, it hashes said string and if <paramref name="addIdentifiableCharacters" /> is true appends identifiable characters to make the root of the cache more human readable
</summary>
<param name="value"></param>
<param name="addIdentifiableCharacters">whether to addIdentifiableCharacters. The default is true</param>
<returns>hash</returns>
</member>
<member name="T:NuGet.Protocol.DedicatedAsynchronousProcessingThread">
<summary>
This class represents a dedicated asynchronous task processing thread.
Uses a queue to execute all the tasks added through the invocation of <see cref="M:NuGet.Protocol.DedicatedAsynchronousProcessingThread.Enqueue(System.Func{System.Threading.Tasks.Task})" />.
The tasks queued here cannot be awaited (think Task.Run, rather than Task.WhenAny/WhenAll).
This implementation is internal on purpose as this is specifically tailed to the plugin V2 use-case.
</summary>
</member>
<member name="M:NuGet.Protocol.DedicatedAsynchronousProcessingThread.#ctor(System.TimeSpan)">
<summary>
DedicatedAsync processing thread.
</summary>
<param name="pollingDelay">The await delay when there are no tasks in the queue.</param>
</member>
<member name="M:NuGet.Protocol.DedicatedAsynchronousProcessingThread.Enqueue(System.Func{System.Threading.Tasks.Task})">
<summary>
Queueus a task for execution.
</summary>
<param name="task">Task to be executed.</param>
</member>
<member name="M:NuGet.Protocol.FeedTypeUtility.GetFeedType(NuGet.Configuration.PackageSource)">
<summary>
Determine the type of a nuget source. This works for both offline and online sources.
</summary>
</member>
<member name="M:NuGet.Protocol.FindPackagesByIdNupkgDownloader.GetNuspecReaderFromNupkgAsync(NuGet.Packaging.Core.PackageIdentity,System.String,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Gets a <see cref="T:NuGet.Packaging.NuspecReader" /> from a .nupkg. If the URL cannot be fetched or there is a problem
processing the .nuspec, an exception is throw. This method uses HTTP caching to avoid downloading the
package over and over (unless <see cref="P:NuGet.Protocol.Core.Types.SourceCacheContext.DirectDownload" /> is specified).
</summary>
<param name="identity">The package identity.</param>
<param name="url">The URL of the .nupkg.</param>
<param name="cacheContext">The cache context.</param>
<param name="token">The cancellation token.</param>
<returns>The .nuspec reader.</returns>
</member>
<member name="M:NuGet.Protocol.FindPackagesByIdNupkgDownloader.CopyNupkgToStreamAsync(NuGet.Packaging.Core.PackageIdentity,System.String,System.IO.Stream,NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Copies a .nupkg stream to the <paramref name="destination" /> stream. If the .nupkg cannot be found or if
there is a network problem, no stream copy occurs.
</summary>
<param name="identity">The package identity.</param>
<param name="url">The URL of the .nupkg.</param>
<param name="destination">The destination stream. The .nupkg will be copied to this stream.</param>
<param name="cacheContext">The cache context.</param>
<param name="token">The cancellation token.</param>
<returns>Returns true if the stream was copied, false otherwise.</returns>
</member>
<member name="M:NuGet.Protocol.FindPackagesByIdNupkgDownloader.ProcessNupkgStreamAsync(NuGet.Packaging.Core.PackageIdentity,System.String,System.Func{System.IO.Stream,System.Threading.Tasks.Task},NuGet.Protocol.Core.Types.SourceCacheContext,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Manages the different ways of getting a .nupkg stream when using the global HTTP cache. When a stream is
found, the <paramref name="processStreamAsync" /> method is invoked on said stream. This deals with the
complexity of <see cref="P:NuGet.Protocol.Core.Types.SourceCacheContext.DirectDownload" />.
</summary>
<param name="identity">The package identity.</param>
<param name="url">The URL of the .nupkg to fetch.</param>
<param name="processStreamAsync">The method to process the stream.</param>
<param name="cacheContext">The cache context.</param>
<param name="token">The cancellation token.</param>
<returns>
Returns true if the stream was processed, false if the stream could not fetched (either from the HTTP cache
or from the network).
</returns>
</member>
<member name="M:NuGet.Protocol.GetDownloadResultUtility.CleanUpDirectDownloads(NuGet.Protocol.Core.Types.PackageDownloadContext)">
<summary>
Allow explicit clean-up of direct download files. This is important because although direct downloads are
opened with the <see cref="F:System.IO.FileOptions.DeleteOnClose" /> option, some systems (e.g. Linux) do not perform
the delete if the process dies. Additionally, if the system dies before the process dies (e.g. loss of
power), the direct download files will be left over.
</summary>
<param name="downloadContext">The download context.</param>
</member>
<member name="F:NuGet.Protocol.JsonUtility.DefaultLoadSettings">
<summary>
JsonLoadSettings with line info and comments ignored.
</summary>
</member>
<member name="M:NuGet.Protocol.JsonUtility.LoadJson(System.IO.TextReader)">
<summary>
Load json from a file to a JObject using the default load settings.
</summary>
</member>
<member name="M:NuGet.Protocol.JsonUtility.LoadJson(Newtonsoft.Json.JsonReader)">
<summary>
Load json from a file to a JObject using the default load settings.
</summary>
</member>
<member name="M:NuGet.Protocol.LocalFolderUtility.GetPackage(System.Uri,NuGet.Common.ILogger)">
<summary>
Retrieve a nupkg using the path.
</summary>
<param name="path">Nupkg path in uri form.</param>
</member>
<member name="M:NuGet.Protocol.LocalFolderUtility.GetPackagesV2(System.String,NuGet.Common.ILogger)">
<summary>
Retrieve all packages from a folder and one level deep.
</summary>
<param name="root">Nupkg folder directory path.</param>
</member>
<member name="M:NuGet.Protocol.LocalFolderUtility.GetPackagesV2(System.String,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Retrieve all packages from a folder and one level deep.
</summary>
<param name="root">Folder path</param>
<param name="log">Logger</param>
<param name="cancellationToken">Cancellation token</param>
</member>
<member name="M:NuGet.Protocol.LocalFolderUtility.GetPackagesV2(System.String,System.String,NuGet.Common.ILogger)">
<summary>
Retrieve all packages of an id from a v2 folder.
</summary>
<param name="root">Nupkg folder directory path.</param>
<param name="id">Package id.</param>
</member>
<member name="M:NuGet.Protocol.LocalFolderUtility.GetPackagesV2(System.String,System.String,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Retrieve all packages of an id from a v2 folder.
</summary>
<param name="root">Nupkg folder directory path.</param>
<param name="id">Package id.</param>
<param name="cancellationToken">Cancellation token</param>
</member>
<member name="M:NuGet.Protocol.LocalFolderUtility.GetPackageV2(System.String,System.String,NuGet.Versioning.NuGetVersion,NuGet.Common.ILogger)">
<summary>
Retrieve all packages of an id from a v2 folder.
</summary>
<param name="root">Nupkg folder directory path.</param>
<param name="id">Package id.</param>
<param name="version">Package version.</param>
</member>
<member name="M:NuGet.Protocol.LocalFolderUtility.GetPackageV2(System.String,System.String,NuGet.Versioning.NuGetVersion,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Retrieve all packages of an id from a v2 folder.
</summary>
<param name="root">Nupkg folder directory path.</param>
<param name="id">Package id.</param>
<param name="version">Package version.</param>
<param name="cancellationToken">Cancellation token</param>
</member>
<member name="M:NuGet.Protocol.LocalFolderUtility.GetPackageV2(System.String,NuGet.Packaging.Core.PackageIdentity,NuGet.Common.ILogger)">
<summary>
Retrieve all packages of an id from a v2 folder.
</summary>
<param name="root">Nupkg folder directory path.</param>
<param name="identity">Package id and version.</param>
</member>
<member name="M:NuGet.Protocol.LocalFolderUtility.GetPackageV2(System.String,NuGet.Packaging.Core.PackageIdentity,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Retrieve all packages of an id from a v2 folder.
</summary>
<param name="root">Nupkg folder directory path.</param>
<param name="identity">Package id and version.</param>
/// <param name="cancellationToken">Cancellation token</param>
</member>
<member name="M:NuGet.Protocol.LocalFolderUtility.GetPackagesConfigFolderPackages(System.String,NuGet.Common.ILogger)">
<summary>
Retrieve a package with an id and version from a packages.config packages folder.
</summary>
<param name="root">Nupkg folder directory path.</param>
</member>
<member name="M:NuGet.Protocol.LocalFolderUtility.GetPackagesConfigFolderPackages(System.String,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Retrieve a package with an id and version from a packages.config packages folder.
</summary>
<param name="root">Nupkg folder directory path.</param>
<param name="cancellationToken">Cancellation token</param>
</member>
<member name="M:NuGet.Protocol.LocalFolderUtility.GetPackagesConfigFolderPackages(System.String,System.String,NuGet.Common.ILogger)">
<summary>
Retrieve a package with an id and version from a packages.config packages folder.
</summary>
<param name="root">Nupkg folder directory path.</param>
</member>
<member name="M:NuGet.Protocol.LocalFolderUtility.GetPackagesConfigFolderPackage(System.String,NuGet.Packaging.Core.PackageIdentity,NuGet.Common.ILogger)">
<summary>
Retrieve a package with an id and version from a packages.config packages folder.
</summary>
<param name="root">Nupkg folder directory path.</param>
<param name="identity">Package id and version.</param>
</member>
<member name="M:NuGet.Protocol.LocalFolderUtility.GetPackagesConfigFolderSearchPattern(System.String)">
<summary>
Returns either id.* or * depending on the OS.
</summary>
<param name="id"></param>
<returns></returns>
</member>
<member name="M:NuGet.Protocol.LocalFolderUtility.GetPackagesConfigFolderPackage(System.String,System.String,NuGet.Versioning.NuGetVersion,NuGet.Common.ILogger)">
<summary>
Retrieve a package with an id and version from a packages.config packages folder.
</summary>
<param name="root">Nupkg folder directory path.</param>
</member>
<member name="M:NuGet.Protocol.LocalFolderUtility.GetPackagesConfigFolderPackage(System.IO.DirectoryInfo,NuGet.Common.ILogger)">
<summary>
Return the package nupkg from a packages.config folder sub directory.
</summary>
<param name="dir">Package directory in the format id.version</param>
</member>
<member name="M:NuGet.Protocol.LocalFolderUtility.IsPossiblePackageMatch(System.IO.FileInfo,NuGet.Packaging.Core.PackageIdentity)">
<summary>
True if the file name matches the identity. This is could be incorrect if
the package name ends with numbers. The result should be checked against the nuspec.
</summary>
</member>
<member name="M:NuGet.Protocol.LocalFolderUtility.IsPossiblePackageMatch(System.IO.FileInfo,System.String)">
<summary>
True if the file name matches the id and is followed by a version. This is could be incorrect if
the package name ends with numbers. The result should be checked against the nuspec.
</summary>
</member>
<member name="M:NuGet.Protocol.LocalFolderUtility.GetIdentityFromNupkgPath(System.IO.FileInfo,System.String)">
<summary>
An imperfect attempt at finding the identity of a package from the file name.
This can fail if the package name ends with something such as .1
</summary>
</member>
<member name="M:NuGet.Protocol.LocalFolderUtility.GetVersionFromFileName(System.String,System.String,System.String)">
<summary>
An imperfect attempt at finding the version of a package from the file name.
This can fail if the package name ends with something such as .1
</summary>
</member>
<member name="M:NuGet.Protocol.LocalFolderUtility.GetVersionFromIdVersionString(System.String,System.String)">
<summary>
Parse a possible version from a string in the format Id.Version
Returns null if the version is invalid or the id did not match.
</summary>
<param name="idVersionString">Id.Version</param>
<param name="id">Expected id</param>
</member>
<member name="M:NuGet.Protocol.LocalFolderUtility.GetPackageV3(System.String,System.String,NuGet.Versioning.NuGetVersion,NuGet.Common.ILogger)">
<summary>
Retrieve a single package from a v3 version folder.
</summary>
</member>
<member name="M:NuGet.Protocol.LocalFolderUtility.GetPackageV3(System.String,NuGet.Packaging.Core.PackageIdentity,NuGet.Common.ILogger)">
<summary>
Retrieve a package from a v3 feed.
</summary>
</member>
<member name="M:NuGet.Protocol.LocalFolderUtility.GetNupkgsFromFlatFolder(System.String,NuGet.Common.ILogger)">
<summary>
Discover all nupkgs from a v2 local folder.
</summary>
<param name="root">Folder root.</param>
</member>
<member name="M:NuGet.Protocol.LocalFolderUtility.GetNupkgsFromFlatFolder(System.String,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Discover all nupkgs from a v2 local folder.
</summary>
<param name="root">Folder root.</param>
<param name="cancellationToken">Cancellation token</param>
</member>
<member name="M:NuGet.Protocol.LocalFolderUtility.GetAndVerifyRootDirectory(System.String)">
<summary>
Verify that a path could be a valid directory. Throw a FatalProtocolException otherwise.
</summary>
</member>
<member name="M:NuGet.Protocol.LocalFolderUtility.GetAndVerifyFileInfo(System.Uri)">
<summary>
Verify that a path could be a valid file. Throw a FatalProtocolException otherwise.
</summary>
</member>
<member name="M:NuGet.Protocol.LocalFolderUtility.GetNupkgsFromFlatFolderChunked(System.IO.DirectoryInfo,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Retrieve files in chunks, this helps maintain the legacy behavior of searching for
certain non-normalized file names.
</summary>
</member>
<member name="M:NuGet.Protocol.LocalFolderUtility.GetNupkgsFromFlatFolder(System.String,System.String,NuGet.Common.ILogger)">
<summary>
Discover nupkgs from a v2 local folder.
</summary>
<param name="root">Folder root.</param>
<param name="id">Package id file name prefix.</param>
</member>
<member name="M:NuGet.Protocol.LocalFolderUtility.GetNupkgsFromFlatFolder(System.String,System.String,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Discover nupkgs from a v2 local folder.
</summary>
<param name="root">Folder root.</param>
<param name="cancellationToken">Cancellation token</param>
</member>
<member name="M:NuGet.Protocol.LocalFolderUtility.GetPackagesV3(System.String,NuGet.Common.ILogger)">
<summary>
Discover all nupkgs from a v3 folder.
</summary>
<param name="root">Folder root.</param>
</member>
<member name="M:NuGet.Protocol.LocalFolderUtility.GetPackagesV3(System.String,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Discover all nupkgs from a v3 folder.
</summary>
<param name="root">Folder root.</param>
<param name="cancellationToken">Cancellation token</param>
</member>
<member name="M:NuGet.Protocol.LocalFolderUtility.GetPackagesV3(System.String,System.String,NuGet.Common.ILogger)">
<summary>
Discover nupkgs from a v3 local folder.
</summary>
<param name="root">Folder root.</param>
<param name="id">Package id or package id prefix.</param>
</member>
<member name="M:NuGet.Protocol.LocalFolderUtility.GetPackagesV3(System.String,System.String,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Discover nupkgs from a v3 local folder.
</summary>
<param name="root">Folder root.</param>
<param name="id">Package id or package id prefix.</param>
<param name="cancellationToken">Cancellation token</param>
</member>
<member name="M:NuGet.Protocol.LocalFolderUtility.ResolvePackageFromPath(System.String,System.Boolean)">
<summary>
Resolves a package path into a list of paths.
If the path contains wildcards then the path is expanded to all matching entries.
</summary>
<param name="packagePath">Package path</param>
<returns>A list of package paths that match the input path.</returns>
</member>
<member name="M:NuGet.Protocol.LocalFolderUtility.EnsurePackageExtension(System.String,System.Boolean)">
<summary>
Ensure any wildcards in packagePath end with *.nupkg or *.snupkg.
</summary>
<param name="packagePath"></param>
<param name="isSnupkg"></param>
<returns>The absolute path, or the normalized wildcard path.</returns>
</member>
<member name="M:NuGet.Protocol.LocalFolderUtility.EnsurePackageFileExists(System.String,System.Collections.Generic.IEnumerable{System.String})">
<summary>
If there isn't at least one Path specified, throw that no file paths were resolved for this Package.
</summary>
<param name="packagePath">The package path the user originally provided.</param>
<param name="matchingPackagePaths">A list of matching package paths that were previously resolved.</param>
</member>
<member name="M:NuGet.Protocol.LocalFolderUtility.GetDistinctPackages(System.Collections.Generic.IEnumerable{NuGet.Protocol.LocalPackageInfo})">
<summary>
Remove duplicate packages which can occur in directories.
In V2 packages may exist under multiple sub folders.
Non-normalized versions also lead to duplicates: ex: 1.0, 1.0.0.0
</summary>
</member>
<member name="M:NuGet.Protocol.LocalFolderUtility.GetDirectoriesSafe(System.IO.DirectoryInfo,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Retrieve directories and log exceptions that occur.
</summary>
</member>
<member name="M:NuGet.Protocol.LocalFolderUtility.GetFilesSafe(System.IO.DirectoryInfo,System.String,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Retrieve files and log exceptions that occur.
</summary>
</member>
<member name="M:NuGet.Protocol.LocalFolderUtility.GetPackagesFromNupkgs(System.Collections.Generic.IEnumerable{System.IO.FileInfo},System.Threading.CancellationToken)">
<summary>
Path -> LocalPackageInfo
</summary>
</member>
<member name="M:NuGet.Protocol.LocalFolderUtility.GetPackageFromNupkg(System.IO.FileInfo)">
<summary>
Path -> LocalPackageInfo
</summary>
</member>
<member name="M:NuGet.Protocol.LocalFolderUtility.GetNupkgsFromDirectory(System.IO.DirectoryInfo,NuGet.Common.ILogger,System.Threading.CancellationToken)">
<summary>
Find all nupkgs in the top level of a directory.
</summary>
</member>
<member name="T:NuGet.Protocol.MetadataReferenceCache">
<summary>
Cache strings, dates, and versions to reduce memory.
</summary>
</member>
<member name="M:NuGet.Protocol.MetadataReferenceCache.GetString(System.String)">
<summary>
Checks if <paramref name="s" /> already exists in the cache.
If so, returns the cached instance.
If not, caches <paramref name="s" /> and returns it.
</summary>
</member>
<member name="M:NuGet.Protocol.MetadataReferenceCache.GetVersion(System.String)">
<summary>
Parses <paramref name="s" /> into a <see cref="T:NuGet.Versioning.NuGetVersion" />.
</summary>
</member>
<member name="F:NuGet.Protocol.MetadataReferenceCache.CachableTypesMap">
<summary>
Mapping of input parameter type to caching method.
</summary>
</member>
<member name="P:NuGet.Protocol.MetadataReferenceCache.CachableTypes">
<summary>
<see cref="T:System.Collections.Generic.IEnumerable`1" /> containing all types that can be cached.
</summary>
</member>
<member name="P:NuGet.Protocol.MetadataReferenceCache.CachableMethodTypes">
<summary>
<see cref="T:System.Collections.Generic.IEnumerable`1" /> containing string type methods can be cached.
</summary>
</member>
<member name="M:NuGet.Protocol.MetadataReferenceCache.GetObject``1(``0)">
<summary>
Iterates through the properties of <paramref name="input" /> that are either <see cref="T:System.String" />s, <see cref="T:System.DateTimeOffset" />s, or <see cref="T:NuGet.Versioning.NuGetVersion" />s and checks them against the cache.
</summary>
</member>
<member name="M:NuGet.Protocol.StreamExtensions.AsSeekableStreamAsync(System.IO.Stream,System.Threading.CancellationToken)">
<summary>
Read a stream into a memory stream if CanSeek is false.
This method is used to ensure that network streams
can be read by non-async reads without blocking.
Closes the original stream by default.
</summary>
</member>
<member name="M:NuGet.Protocol.StreamExtensions.AsSeekableStreamAsync(System.IO.Stream,System.Boolean,System.Threading.CancellationToken)">
<summary>
Read a stream into a memory stream if CanSeek is false.
This method is used to ensure that network streams
can be read by non-async reads without blocking.
</summary>
</member>
<member name="M:NuGet.Protocol.TimeoutUtility.StartWithTimeout``1(System.Func{System.Threading.CancellationToken,System.Threading.Tasks.Task{``0}},System.TimeSpan,System.String,System.Threading.CancellationToken)">
<summary>
Starts a task with a timeout. If the timeout occurs, a <see cref="T:System.TimeoutException" />
with no message will be thrown.
</summary>
</member>
<member name="M:NuGet.Protocol.TimeoutUtility.StartWithTimeout(System.Func{System.Threading.CancellationToken,System.Threading.Tasks.Task},System.TimeSpan,System.String,System.Threading.CancellationToken)">
<summary>
Starts a task with a timeout. If the timeout occurs, a <see cref="T:System.TimeoutException" />
with no message will be thrown.
</summary>
</member>
<member name="T:NuGet.Repositories.LocalPackageInfo">
<summary>
Represents a package installed to the user global folder, or a fallback folder.
Components of the package are cached and across all restores.
</summary>
</member>
<member name="P:NuGet.Repositories.LocalPackageInfo.Nuspec">
<summary>
Caches the nuspec reader.
If the nuspec does not exist this will throw a friendly exception.
</summary>
</member>
<member name="P:NuGet.Repositories.LocalPackageInfo.Files">
<summary>
Package files with OPC files filtered out.
Cached to avoid reading the same files multiple times.
</summary>
</member>
<member name="P:NuGet.Repositories.LocalPackageInfo.Sha512">
<summary>
SHA512 of the package.
</summary>
</member>
<member name="P:NuGet.Repositories.LocalPackageInfo.RuntimeGraph">
<summary>
runtime.json
</summary>
<remarks>Returns null if runtime.json does not exist in the package.</remarks>
</member>
<member name="T:NuGet.Repositories.NuGetv3LocalRepository">
<summary>
Caches package info from the global packages folder in memory.
Packages not yet in the cache will be retrieved from disk.
</summary>
</member>
<member name="M:NuGet.Repositories.NuGetv3LocalRepository.Exists(System.String,NuGet.Versioning.NuGetVersion)">
<summary>
True if the package exists.
</summary>
</member>
<member name="M:NuGet.Repositories.NuGetv3LocalRepository.ClearCacheForIds(System.Collections.Generic.IEnumerable{System.String})">
<summary>
Remove cached results for the given ids. This is needed
after installing a new package.
</summary>
</member>
<member name="M:NuGet.Repositories.NuGetv3LocalRepositoryUtility.GetPackage(System.Collections.Generic.IReadOnlyList{NuGet.Repositories.NuGetv3LocalRepository},System.String,NuGet.Versioning.NuGetVersion)">
<summary>
Take the first match on id and version.
</summary>
</member>
<member name="M:NuGet.Shared.EqualityUtility.OrderedEquals``2(System.Collections.Generic.IEnumerable{``0},System.Collections.Generic.IEnumerable{``0},System.Func{``0,``1},System.Collections.Generic.IComparer{``1},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Compares two enumerables for equality, ordered according to the specified key and optional comparer. Handles null values gracefully.
</summary>
<typeparam name="TSource">The type of the list</typeparam>
<typeparam name="TKey">The type of the sorting key</typeparam>
<param name="self">This list</param>
<param name="other">The other list</param>
<param name="keySelector">The function to extract the key from each item in the list</param>
<param name="orderComparer">An optional comparer for comparing keys</param>
<param name="sequenceComparer">An optional comparer for sequences</param>
</member>
<member name="M:NuGet.Shared.EqualityUtility.OrderedEquals``2(System.Collections.Generic.ICollection{``0},System.Collections.Generic.ICollection{``0},System.Func{``0,``1},System.Collections.Generic.IComparer{``1},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Compares two collections for equality, ordered according to the specified key and optional comparer. Handles null values gracefully.
</summary>
<typeparam name="TSource">The type of the list</typeparam>
<typeparam name="TKey">The type of the sorting key</typeparam>
<param name="self">This list</param>
<param name="other">The other list</param>
<param name="keySelector">The function to extract the key from each item in the list</param>
<param name="orderComparer">An optional comparer for comparing keys</param>
<param name="sequenceComparer">An optional comparer for sequences</param>
</member>
<member name="M:NuGet.Shared.EqualityUtility.OrderedEquals``2(System.Collections.Generic.IList{``0},System.Collections.Generic.IList{``0},System.Func{``0,``1},System.Collections.Generic.IComparer{``1},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Compares two lists for equality, ordered according to the specified key and optional comparer. Handles null values gracefully.
</summary>
<typeparam name="TSource">The type of the list</typeparam>
<typeparam name="TKey">The type of the sorting key</typeparam>
<param name="self">This list</param>
<param name="other">The other list</param>
<param name="keySelector">The function to extract the key from each item in the list</param>
<param name="orderComparer">An optional comparer for comparing keys</param>
<param name="sequenceComparer">An optional comparer for sequences</param>
</member>
<member name="M:NuGet.Shared.EqualityUtility.SequenceEqualWithNullCheck``1(System.Collections.Generic.IEnumerable{``0},System.Collections.Generic.IEnumerable{``0},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Compares two sequence for equality, allowing either sequence to be null. If one is null, both have to be
null for equality.
</summary>
</member>
<member name="M:NuGet.Shared.EqualityUtility.SequenceEqualWithNullCheck``1(System.Collections.Generic.ICollection{``0},System.Collections.Generic.ICollection{``0},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Compares two collections for equality, allowing either collection to be null. If one is null, both have to be
null for equality.
</summary>
</member>
<member name="M:NuGet.Shared.EqualityUtility.SequenceEqualWithNullCheck``1(System.Collections.Generic.IList{``0},System.Collections.Generic.IList{``0},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Compares two lists for equality, allowing either list to be null. If one is null, both have to be
null for equality.
</summary>
</member>
<member name="M:NuGet.Shared.EqualityUtility.SetEqualsWithNullCheck``1(System.Collections.Generic.ISet{``0},System.Collections.Generic.ISet{``0},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Compares two sets for equality, allowing either sequence to be null.
If one is null, both have to be null for equality.
</summary>
</member>
<member name="M:NuGet.Shared.EqualityUtility.EqualsFalse(System.String)">
<summary>
Determines if the current string contains a value equal "false". Leading and trailing whitespace are trimmed and the comparision is case-insensitive
</summary>
<param name="value">The string to compare.</param>
<returns><c>true</c> if the current string is equal to a value of "false", otherwise <c>false></c>.</returns>
</member>
<member name="T:NuGet.Shared.HashCodeCombiner">
<summary>
Hash code creator, based on the original NuGet hash code combiner/ASP hash code combiner implementations
</summary>
</member>
<member name="M:NuGet.Shared.HashCodeCombiner.GetHashCode``2(``0,``1)">
<summary>
Create a unique hash code for the given set of items
</summary>
</member>
<member name="M:NuGet.Shared.HashCodeCombiner.GetHashCode``3(``0,``1,``2)">
<summary>
Create a unique hash code for the given set of items
</summary>
</member>
<member name="M:NuGet.Shared.Extensions.AsList``1(System.Collections.Generic.IEnumerable{``0})">
<summary>
Return the enumerable as a List of T, copying if required. Optimized for common case where it is an List of T.
Avoid mutating the return value.
</summary>
<remarks>https://aspnetwebstack.codeplex.com/SourceControl/latest#src/Common/CollectionExtensions.cs</remarks>
</member>
<member name="M:NuGet.Shared.Extensions.AsHashSet``1(System.Collections.Generic.ISet{``0},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Return the ISet as a HashSet of T, copying if required. Optimized for common case where it is a HashSet of T.
Avoid mutating the return value.
</summary>
</member>
<member name="M:NuGet.Shared.XmlUtility.Load(System.String)">
<summary>
Creates a new <see cref="T:System.Xml.Linq.XDocument" /> from a file.
</summary>
<param name="path">The complete file path to be read into a new <see cref="T:System.Xml.Linq.XDocument" />.</param>
<returns>An <see cref="T:System.Xml.Linq.XDocument" /> that contains the contents of the specified file.</returns>
</member>
<member name="M:NuGet.Shared.XmlUtility.Load(System.String,System.Xml.Linq.LoadOptions)">
<summary>
Creates a new <see cref="T:System.Xml.Linq.XDocument" /> from a file. Optionally, whitespace can be preserved.
</summary>
<param name="path">The complete file path to be read into a new <see cref="T:System.Xml.Linq.XDocument" />.</param>
<param name="options">A set of <see cref="T:System.Xml.Linq.LoadOptions" />.</param>
<returns>An <see cref="T:System.Xml.Linq.XDocument" /> that contains the contents of the specified file.</returns>
</member>
<member name="M:NuGet.Shared.XmlUtility.Load(System.IO.Stream)">
<summary>
Creates a new <see cref="T:System.Xml.Linq.XDocument" /> from a stream.
</summary>
<param name="input">The stream that contains the XML data.</param>
<returns>An <see cref="T:System.Xml.Linq.XDocument" /> that contains the contents of the specified stream.</returns>
</member>
<member name="M:NuGet.Shared.XmlUtility.Load(System.IO.Stream,System.Xml.Linq.LoadOptions)">
<summary>
Creates a new System.Xml.Linq.XDocument from a stream. Optionally, whitespace can be preserved.
</summary>
<param name="input">The stream that contains the XML data.</param>
<param name="options">A set of <see cref="T:System.Xml.Linq.LoadOptions" />.</param>
<returns>An <see cref="T:System.Xml.Linq.XDocument" /> that contains the contents of the specified stream.</returns>
</member>
<member name="M:NuGet.Shared.XmlUtility.GetEncodedXMLName(System.String)">
<summary>
Converts the name to a valid XML local name, if it is invalid.
</summary>
<param name="name">The name to be encoded.</param>
<returns>The encoded name.</returns>
</member>
<member name="M:NuGet.Shared.XmlUtility.GetXmlReaderSettings(System.Xml.Linq.LoadOptions)">
<summary>
Creates an instance of <see cref="T:System.Xml.XmlReaderSettings" /> with safe settings
<param name="options">A set of <see cref="T:System.Xml.Linq.LoadOptions" />.</param>
</summary>
</member>
<member name="T:NuGet.StringBuilderPool">
<summary>
Provides a resource pool that enables reusing instances of <see cref="T:System.Text.StringBuilder" /> instances.
</summary>
<remarks>
<para>
Renting and returning buffers with an <see cref="T:NuGet.StringBuilderPool" /> can increase performance
in situations where <see cref="T:System.Text.StringBuilder" /> instances are created and destroyed frequently,
resulting in significant memory pressure on the garbage collector.
</para>
<para>
This class is thread-safe. All members may be used by multiple threads concurrently.
</para>
</remarks>
</member>
<member name="F:NuGet.StringBuilderPool.Shared">
<summary>
Retrieves a shared <see cref="T:NuGet.StringBuilderPool" /> instance.
</summary>
</member>
<member name="M:NuGet.StringBuilderPool.Rent(System.Int32)">
<summary>
Retrieves a <see cref="T:System.Text.StringBuilder" /> that is at least the requested length.
</summary>
<param name="minimumCapacity">The minimum capacity of the <see cref="T:System.Text.StringBuilder" /> needed.</param>
<returns>
A <see cref="T:System.Text.StringBuilder" /> that is at least <paramref name="minimumCapacity" /> in length.
</returns>
<remarks>
This buffer is loaned to the caller and should be returned to the same pool via
<see cref="M:NuGet.StringBuilderPool.Return(System.Text.StringBuilder)" /> so that it may be reused in subsequent usage of <see cref="M:NuGet.StringBuilderPool.Rent(System.Int32)" />.
It is not a fatal error to not return a rented string builder, but failure to do so may lead to
decreased application performance, as the pool may need to create a new instance to replace
the one lost.
</remarks>
</member>
<member name="M:NuGet.StringBuilderPool.Return(System.Text.StringBuilder)">
<summary>
Returns to the pool an array that was previously obtained via <see cref="M:NuGet.StringBuilderPool.Rent(System.Int32)" /> on the same
<see cref="T:NuGet.StringBuilderPool" /> instance.
</summary>
<param name="builder">
The <see cref="T:System.Text.StringBuilder" /> previously obtained from <see cref="M:NuGet.StringBuilderPool.Rent(System.Int32)" /> to return to the pool.
</param>
<remarks>
Once a <see cref="T:System.Text.StringBuilder" /> has been returned to the pool, the caller gives up all ownership
of the instance and must not use it. The reference returned from a given call to <see cref="M:NuGet.StringBuilderPool.Rent(System.Int32)" />
must only be returned via <see cref="M:NuGet.StringBuilderPool.Return(System.Text.StringBuilder)" /> once. The default <see cref="T:NuGet.StringBuilderPool" />
may hold onto the returned instance in order to rent it again, or it may release the returned instance
if it's determined that the pool already has enough instances stored.
</remarks>
</member>
</members>
<Signature xmlns="http://www.w3.org/2000/09/xmldsig#"><SignedInfo><CanonicalizationMethod Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315" /><SignatureMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#rsa-sha256" /><Reference URI=""><Transforms><Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature" /><Transform Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315" /></Transforms><DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256" /><DigestValue>08siC4oL8uWXeYdM5UxgIvzai2doB1zswO6pRmg3j+E=</DigestValue></Reference></SignedInfo><SignatureValue>PUZFpLuwBqPpT5EyaxP4i5pST997paLPEO71EJWPalidU7PmX3b37Ltzp5zxnkEI5rxFy2pynXuxqivs/wxdj6+/6BHiEABZm6RB3LZ3icun1jZE1e/YnkTc7lFicgN0AGlqqakf05At4fihGHV4ZWn8LXX0dBD7UOkhAFHCedN5dS3eETUXcx9NYLXh2DnzPYA07f6rJ0XJm0ONk5NK5jddzynrBuVPOxscfoF8H68JXKOL4SwPX5ABIgynBc3tilY98amikUUgwaHWD8p6V0EKetqxe4qExbvXSRBPQGgYWmtDmgkk1mMqD8o2GlIT1Clm965bLsXJ6mcR69TN3g==</SignatureValue><KeyInfo><KeyValue><RSAKeyValue><Modulus>ok2x7OvGwA7zbnfezc3HT9M4dJka+FaQ7+vCqG40Bcm1QLlYIiDX/Whts0LVijaOvtl9iMeuShnAV7mchItKAVAABpyHuTuav2NCI9FsA8jFmlWndk3uK9RInNx1h1H4ojYxdBExyoN6muwwslKsLEfauUml7h5WAsDPpufTZd4yp2Jyiy384Zdd8CJlfQxfDe+gDZEciugWKHPSOoRxdjAk0GFm0OH14MyoYM4+M3mm1oH7vmSQohS5KIL3NEVW9Mdw7csTG5f93uORLvrJ/8ehFcGyWVb7UGHJnRhdcgGIbfiZzZlsAMS/DIBzM8RHKGNUNSbbLYmN/rt7pRjL4Q==</Modulus><Exponent>AQAB</Exponent></RSAKeyValue></KeyValue><X509Data><X509Certificate>MIIF/zCCA+egAwIBAgITMwAAAsyOtZamvdHJTgAAAAACzDANBgkqhkiG9w0BAQsFADB+MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSgwJgYDVQQDEx9NaWNyb3NvZnQgQ29kZSBTaWduaW5nIFBDQSAyMDExMB4XDTIyMDUxMjIwNDYwMVoXDTIzMDUxMTIwNDYwMVowdDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEeMBwGA1UEAxMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAok2x7OvGwA7zbnfezc3HT9M4dJka+FaQ7+vCqG40Bcm1QLlYIiDX/Whts0LVijaOvtl9iMeuShnAV7mchItKAVAABpyHuTuav2NCI9FsA8jFmlWndk3uK9RInNx1h1H4ojYxdBExyoN6muwwslKsLEfauUml7h5WAsDPpufTZd4yp2Jyiy384Zdd8CJlfQxfDe+gDZEciugWKHPSOoRxdjAk0GFm0OH14MyoYM4+M3mm1oH7vmSQohS5KIL3NEVW9Mdw7csTG5f93uORLvrJ/8ehFcGyWVb7UGHJnRhdcgGIbfiZzZlsAMS/DIBzM8RHKGNUNSbbLYmN/rt7pRjL4QIDAQABo4IBfjCCAXowHwYDVR0lBBgwFgYKKwYBBAGCN0wIAQYIKwYBBQUHAwMwHQYDVR0OBBYEFIi4R40ylsyKlSKfrDNqzhx9da30MFAGA1UdEQRJMEekRTBDMSkwJwYDVQQLEyBNaWNyb3NvZnQgT3BlcmF0aW9ucyBQdWVydG8gUmljbzEWMBQGA1UEBRMNMjMwMDEyKzQ3MDUyOTAfBgNVHSMEGDAWgBRIbmTlUAXTgqoXNzcitW2oynUClTBUBgNVHR8ETTBLMEmgR6BFhkNodHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20vcGtpb3BzL2NybC9NaWNDb2RTaWdQQ0EyMDExXzIwMTEtMDctMDguY3JsMGEGCCsGAQUFBwEBBFUwUzBRBggrBgEFBQcwAoZFaHR0cDovL3d3dy5taWNyb3NvZnQuY29tL3BraW9wcy9jZXJ0cy9NaWNDb2RTaWdQQ0EyMDExXzIwMTEtMDctMDguY3J0MAwGA1UdEwEB/wQCMAAwDQYJKoZIhvcNAQELBQADggIBAHgPA7DgB0udzEyB2LvG216zuskLUQ+iX8jFnl2i7tzXPDw5xXNXn2KvxdzBsf2osDW3LCdjFOwSjVkz+SUFQQNhjSHkd5knF6pzrL9V6lz72XiEg1Vi2gUM3HiLXSMIKOgdd78ZZJEmDLwdA692MO/1vVOFpOSv0QzpyBr5iqiotwMMsZVdZqXn8u9vRSmlk+3nQXdyOPoZXTGPLHXwz41kbSc4zI12bONTlDsLR3HD2s44wuyp3c72R8f9FVi/J9DU/+NOL37Z1yonzGZEuKdrAd6CvupAnLMlrIEv93mBsNRXuDDp4p9UYYK1taxzzgyUxgFDpluMHN0Oiiq9s73u7DA2XvbX8paJz8IZPe9a1/KhsOi5Kxhb99SCXiUnv2lGxnVAz5G6wAW1bzxJYKI+Xj90RKseY3X5EMO7TnVpIZ9Iw1IdrkHp/QLY90ZCch7kdBlLCVTFhSXZCDv4BcM6DhpRzbJsb6QDVfOv9aoG9aGV3a1EacyaedzLA2gWP6cTnCdAr4OrlrN5EFoCpOWgc77F/eQc3SLR06VTLVT1uKuNVxL2xZlD9Z+qC+a3TXa0zI/x1zEZNSgpLGsdVcaN6r/td3ArGQGkDWiAL7eS75LIWZA2SD//9B56uzZ1nmEd8+KBYsPTdp922/W2kFrlj7MBtA6vWE/ZG/grOKiC</X509Certificate><X509Certificate>MIIHejCCBWKgAwIBAgIKYQ6Q0gAAAAAAAzANBgkqhkiG9w0BAQsFADCBiDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEyMDAGA1UEAxMpTWljcm9zb2Z0IFJvb3QgQ2VydGlmaWNhdGUgQXV0aG9yaXR5IDIwMTEwHhcNMTEwNzA4MjA1OTA5WhcNMjYwNzA4MjEwOTA5WjB+MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSgwJgYDVQQDEx9NaWNyb3NvZnQgQ29kZSBTaWduaW5nIFBDQSAyMDExMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAq/D6chAcLq3YbqqCEE00uvK2WCGfQhsqa+laUKq4BjgaBEm6f8MMHt03a8YS2AvwOMKZBrDIOdUBFDFC04kNeWSHfpRgJGyvnkmc6Whe0t+bU7IKLMOv2akrrnoJr9eWWcpgGgXpZnboMlImEi/nqwhQz7NEt13YxC4Ddato88tt8zpcoRb0RrrgOGSsbmQ1eKagYw8t00CT+OPeBw3VXHmlSSnnDb6gE3e+lD3v++MrWhAfTVYoonpy4BI6t0le2O3tQ5GD2Xuye4Yb2T6xjF3oiU+EGvKhL1nkkDstrjNYxbc+/jLTswM9sbKvkjh+0p2ALPVOVpEhNSXDOW5kf1O6nA+tGSOEy/S6A4aN91/w0FK/jJSHvMAhdCVfGCi2zCcoOCWYOUo2z3yxkq4cI6epZuxhH2rhKEmdX4jiJV3TIUs+UsS1Vz8kA/DRelsv1SPjcF0PUUZ3s/gA4bysAoJf28AVs70b1FVL5zmhD+kjSbwYuER8ReTBw3J64HLnJN+/RpnF78IcV9uDjexNSTCnq47f7Fufr/zdsGbiwZeBe+3W7UvnSSmnEyimp31ngOaKYnhfsi+E11ecXL93KCjx7W3DKI8sj0A3T8HhhUSJxAlMxdSlQy90lfdu+HggWCwTXWCVmj5PM4TasIgX3p5O9JawvEagbJjS4NaIjAsCAwEAAaOCAe0wggHpMBAGCSsGAQQBgjcVAQQDAgEAMB0GA1UdDgQWBBRIbmTlUAXTgqoXNzcitW2oynUClTAZBgkrBgEEAYI3FAIEDB4KAFMAdQBiAEMAQTALBgNVHQ8EBAMCAYYwDwYDVR0TAQH/BAUwAwEB/zAfBgNVHSMEGDAWgBRyLToCMZBDuRQFTuHqp8cx0SOJNDBaBgNVHR8EUzBRME+gTaBLhklodHRwOi8vY3JsLm1pY3Jvc29mdC5jb20vcGtpL2NybC9wcm9kdWN0cy9NaWNSb29DZXJBdXQyMDExXzIwMTFfMDNfMjIuY3JsMF4GCCsGAQUFBwEBBFIwUDBOBggrBgEFBQcwAoZCaHR0cDovL3d3dy5taWNyb3NvZnQuY29tL3BraS9jZXJ0cy9NaWNSb29DZXJBdXQyMDExXzIwMTFfMDNfMjIuY3J0MIGfBgNVHSAEgZcwgZQwgZEGCSsGAQQBgjcuAzCBgzA/BggrBgEFBQcCARYzaHR0cDovL3d3dy5taWNyb3NvZnQuY29tL3BraW9wcy9kb2NzL3ByaW1hcnljcHMuaHRtMEAGCCsGAQUFBwICMDQeMiAdAEwAZQBnAGEAbABfAHAAbwBsAGkAYwB5AF8AcwB0AGEAdABlAG0AZQBuAHQALiAdMA0GCSqGSIb3DQEBCwUAA4ICAQBn8oalmOBUeRou09h0ZyKbC5YR4WOSmUKWfdJ5DJDBZV8uLD74w3LRbYP+vj/oCso7v0epo/Np22O/IjWll11lhJB9i0ZQVdgMknzSGksc8zxCi1LQsP1r4z4HLimb5j0bpdS1HXeUOeLpZMlEPXh6I/MTfaaQdION9MsmAkYqwooQu6SpBQyb7Wj6aC6VoCo/KmtYSWMfCWluWpiW5IP0wI/zRive/DvQvTXvbiWu5a8n7dDd8w6vmSiXmE0OPQvyCInWH8MyGOLwxS3OW560STkKxgrCxq2u5bLZ2xWIUUVYODJxJxp/sfQn+N4sOiBpmLJZiWhub6e3dMNABQamASooPoI/E01mC8CzTfXhj38cbxV9Rad25UAqZaPDXVJihsMdYzaXht/a8/jyFqGaJ+HNpZfQ7l1jQeNbB5yHPgZ3BtEGsXUfFL5hYbXw3MYbBL7fQccOKO7eZS/sl/ahXJbYANahRr1Z85elCUtIEJmAH9AAKcWxm6U/RXceNcbSoqKfenoi+kiVH6v7RyOA9Z74v2u3S5fi63V4GuzqN5l5GEv/1rMjaHXmr/r8i+sLgOppO6/8MO0ETI7f33VtY5E90Z1WTk+/gFcioXgRMiF670EKsT/7qMykXcGhiJtXcVZOSEXAQsmbdlsKgEhr/Xmfwb1tbWrJUnMTDXpQzQ==</X509Certificate><X509Certificate>MIIF7TCCA9WgAwIBAgIQP4vItfyfspZDtWnWbELhRDANBgkqhkiG9w0BAQsFADCBiDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEyMDAGA1UEAxMpTWljcm9zb2Z0IFJvb3QgQ2VydGlmaWNhdGUgQXV0aG9yaXR5IDIwMTEwHhcNMTEwMzIyMjIwNTI4WhcNMzYwMzIyMjIxMzA0WjCBiDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEyMDAGA1UEAxMpTWljcm9zb2Z0IFJvb3QgQ2VydGlmaWNhdGUgQXV0aG9yaXR5IDIwMTEwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQCygEGqNThNE3IyaCJNuLLx/9VSvGzH9dJKjDbu0cJcfoyKrq8TKG/Ac+M6ztAlqFo6be+ouFmrEyNozQwph9FvgFyPRH9dkAFSWKxRxV8qh9zc2AodwQO5e7BW6KPeZGHCnvjzfLnsDbVU/ky2ZU+I8JxImQxCCwl8MVkXeQZ4KI2JOkwDJb5xalwL54RgpJki49KvhKSn+9GY7Qyp3pSJ4Q6g3MDOmT3qCFK7VnnkH4S6Hri0xElcTzFLh93dBWcmmYDgcRGjuKVB4qRTufcyKYMME782XgSzS0NHL2vikR7TmE/dQgfI6B0S/Jmpaz6SfsjWaTr8ZL22CZ3K/QwLopt3YEsDlKQwaRLWQi3BQUzK3Kr9j1uDRprZ/LHR47PJf0h6zSTwQY9cdNCssBAgBkm3xy0hyFfj0IbzA2j70M5xwYmZSmQBbP3sMJHPQTySx+W6hh1hhMdfgzlirrSSL0fzC/hV66AfWdC7dJse0Hbm8ukG1xDo+mTeacY1logC8Ea4PyeZb8txiSk190gWAjWP1Xl8TQLPX+uKg09FcYj5qQ1OcunCnAfPSRtOBA5jUYxe2ADBVSy2xuDCZU7JNDn1nLPEfuhhbhNfFcRf2X7tHc7uROzLLoax7Dj2cO2rXBPB2Q8Nx4CyVe0096yb5MPa50c8prWPMd/FS6/r8QIDAQABo1EwTzALBgNVHQ8EBAMCAYYwDwYDVR0TAQH/BAUwAwEB/zAdBgNVHQ4EFgQUci06AjGQQ7kUBU7h6qfHMdEjiTQwEAYJKwYBBAGCNxUBBAMCAQAwDQYJKoZIhvcNAQELBQADggIBAH9yzw+3xRXbm8BJyiZb/p4T5tPw0tuXX/JLP02zrhmu7deXoKzvqTqjwkGw5biRnhOBJAPmCf0/V0A5ISRW0RAvS0CpNoZLtFNXmvvxfomPEf4YbFGq6O0JlbXlccmh6Yd1phV/yX43VF50k8XDZ8wNT2uoFwxtCJJ+i92Bqi1wIcM9BhS7vyRep4TXPw8hIr1LAAbblxzYXtTFC1yHblCk6MM4pPvLLMWSZpuFXst6bJN8gClYW1e1QGm6CHmmZGIVnYeWRbVmIyADixxzoNOieTPgUFmG2y/lAiXqcyqfABTINseSO+lOAOzYVgm5M0kS0lQLAausR7aRKX1MtHWAUgHoyoL2n8ysnI8X6i8msKtyrAv+nlEex0NVZ09Rs1fWtuzuUrc66U7h14GIvE+OdbtLqPA1qibUZ2dJsnBMO5PcHd94kIZysjik0dySTclY6ysSXNQ7roxrsIPlAT/4CTL2kzU0Iq/dNw13CYArzUgA8YyZGUcFAenRv9FO0OYoQzeZpApKCNmacXPSqs0xE2N2oTdvkjgefRI8ZjLny23h/FKJ3crWZgWalmG+oijHHKOnNlA8OqTfSm7mhzvO6/DggTedEzxSjr25HTTGHdUKaj2YKXCMiSrRq4IQSB/c9O+lxbtVGjhjhE63bK2VVOxlIhBJF7jAHscPrFRH</X509Certificate></X509Data></KeyInfo><Object Id="ts-countersig"><X509Data><X509Certificate>MIIHEDCCBPigAwIBAgITMwAAAasJCe+rY9ToqQABAAABqzANBgkqhkiG9w0BAQsFADB8MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSYwJAYDVQQDEx1NaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0EgMjAxMDAeFw0yMjAzMDIxODUxMjhaFw0yMzA1MTExODUxMjhaMIHOMQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSkwJwYDVQQLEyBNaWNyb3NvZnQgT3BlcmF0aW9ucyBQdWVydG8gUmljbzEmMCQGA1UECxMdVGhhbGVzIFRTUyBFU046ODk3QS1FMzU2LTE3MDExJTAjBgNVBAMTHE1pY3Jvc29mdCBUaW1lLVN0YW1wIFNlcnZpY2UwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQDJnUtaOXXoQElLLHC6ssdsJv1oqzVH6pBgcpgyLWMxJ6CrZIa3e8DbCbOIPgbjN7gV/NVpztu9JZKwtHtZpg6kLeNtE5m/JcLI0CjOphGjUCH1w66J61Td2sNZcfWwH+1WRAN5BxapemADt5I0Oj37QOIlR19yVb/fJ7Y5G7asyniTGjVnfHQWgA90QpYjKGo0wxm8mDSk78QYViC8ifFmHSfzQQ6aj80JfqcZumWVUngUACDrm2Y1NL36RAsRwubyNRK66mqRvtKAYYTjfoJZVZJTwFmb9or9JoIwk4+2DSl+8i9sdk767x1auRjzWuXzW6ct/beXL4omKjH9UWVWXHHa/trwKZOYm+WuDvEogID0lMGBqDsG2RtaJx4o9AEzy5IClH4Gj8xX3eSWUm0Zdl4N+O/y41kC0fiowMgAhW9Om6ls7x7UCUzQ/GNI+WNkgZ0gqldszR0lbbOPmlH5FIbCkvhgF0t4+V1IGAO0jDaIO+jZ7LOZdNZxF+7Bw3WMpGIc7kCha0+9F1U2Xl9ubUgX8t1WnM2HdSUiP/cDhqmxVOdjcq5bANaopsTobLnbOz8aPozt0Y1f5AvgBDqFWlw3Zop7HNz7ZQQlYf7IGJ6PQFMpm5UkZnntYMJZ5WSdLohyiPathxYGVjNdMjxuYFbdKa15yRYtVsZpoPgR/wIDAQABo4IBNjCCATIwHQYDVR0OBBYEFBRbzvKNXjXEgiEGTL6hn3TS/qaqMB8GA1UdIwQYMBaAFJ+nFV0AXmJdg/Tl0mWnG1M1GelyMF8GA1UdHwRYMFYwVKBSoFCGTmh0dHA6Ly93d3cubWljcm9zb2Z0LmNvbS9wa2lvcHMvY3JsL01pY3Jvc29mdCUyMFRpbWUtU3RhbXAlMjBQQ0ElMjAyMDEwKDEpLmNybDBsBggrBgEFBQcBAQRgMF4wXAYIKwYBBQUHMAKGUGh0dHA6Ly93d3cubWljcm9zb2Z0LmNvbS9wa2lvcHMvY2VydHMvTWljcm9zb2Z0JTIwVGltZS1TdGFtcCUyMFBDQSUyMDIwMTAoMSkuY3J0MAwGA1UdEwEB/wQCMAAwEwYDVR0lBAwwCgYIKwYBBQUHAwgwDQYJKoZIhvcNAQELBQADggIBAMpLlIE3NSjLMzILB24YI4BBr/3QhxX9G8vfQuOUke+9P7nQjTXqpU+tdBIc9d8RhVOh3Ivky1D1J4b1J0rs+8ZIlka7uUY2WZkqJxFb/J6Wt89UL3lH54LcotCXeqpUspKBFSerQ7kdSsPcVPcr7YWVoULP8psjsIfpsbdAvcG3iyfdnq9r3PZctdqRcWwjQyfpkO7+dtIQL63lqmdNhjiYcNEeHNYj9/YjQcxzqM/g7DtLGI8IWs/R672DBMzg9TCXSz1n1BbGf/4k3d48xMpJNNlo52TcyHthDX5kPym5Rlx3knvCWKopkxcZeZHjHy1BC4wIdJoUNbywiWdtAcAuDuexIO8jv2LgZ6PuEa1dAg9oKeATtdChVtkkPzIb0Viux24Eugc7e9K5CHklLaO6UZBzKq54bmyE3F3XZMuhrWbJsDN4b6l7krTHlNVuTTdxwPMqYzy3f26Jnxsfeh7sPDq37XEL5O7YXTbuCYQMilF1D+3SjAiX6znaZYNI9bRNGohPqQ00kFZj8xnswi+NrJcjyVV6buMcRNIaQAq9rmtCx7/ywekVeQuAjuDLP6X2pf/xdzvoSWXuYsXr8yjZF128TzmtUfkiK1v6x2TOkSAy0ycUxhQzNYUA8mnxrvUv2u7ppL4pYARzcWX5NCGBO0UViXBu6ImPhRncdXLN</X509Certificate><X509Certificate>MIIHcTCCBVmgAwIBAgITMwAAABXF52ueAptJmQAAAAAAFTANBgkqhkiG9w0BAQsFADCBiDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEyMDAGA1UEAxMpTWljcm9zb2Z0IFJvb3QgQ2VydGlmaWNhdGUgQXV0aG9yaXR5IDIwMTAwHhcNMjEwOTMwMTgyMjI1WhcNMzAwOTMwMTgzMjI1WjB8MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSYwJAYDVQQDEx1NaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0EgMjAxMDCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAOThpkzntHIhC3miy9ckeb0O1YLT/e6cBwfSqWxOdcjKNVf2AX9sSuDivbk+F2Az/1xPx2b3lVNxWuJ+Slr+uDZnhUYjDLWNE893MsAQGOhgfWpSg0S3po5GawcU88V29YZQ3MFEyHFcUTE3oAo4bo3t1w/YJlN8OWECesSq/XJprx2rrPY2vjUmZNqYO7oaezOtgFt+jBAcnVL+tuhiJdxqD89d9P6OU8/W7IVWTe/dvI2k45GPsjksUZzpcGkNyjYtcI4xyDUoveO0hyTD4MmPfrVUj9z6BVWYbWg7mka97aSueik3rMvrg0XnRm7KMtXAhjBcTyziYrLNueKNiOSWrAFKu75xqRdbZ2De+JKRHh09/SDPc31BmkZ1zcRfNN0Sidb9pSB9fvzZnkXftnIv231fgLrbqn427DZM9ituqBJR6L8FA6PRc6ZNN3SUHDSCD/AQ8rdHGO2n6Jl8P0zbr17C89XYcz1DTsEzOUyOArxCaC4Q6oRRRuLRvWoYWmEBc8pnol7XKHYC4jMYctenIPDC+hIK12NvDMk2ZItboKaDIV1fMHSRlJTYuVD5C4lh8zYGNRiER9vcG9H9stQcxWv2XFJRXRLbJbqvUAV6bMURHXLvjflSxIUXk8A8FdsaN8cIFRg/eKtFtvUeh17aj54WcmnGrnu3tz5q4i6tAgMBAAGjggHdMIIB2TASBgkrBgEEAYI3FQEEBQIDAQABMCMGCSsGAQQBgjcVAgQWBBQqp1L+ZMSavoKRPEY1Kc8Q/y8E7jAdBgNVHQ4EFgQUn6cVXQBeYl2D9OXSZacbUzUZ6XIwXAYDVR0gBFUwUzBRBgwrBgEEAYI3TIN9AQEwQTA/BggrBgEFBQcCARYzaHR0cDovL3d3dy5taWNyb3NvZnQuY29tL3BraW9wcy9Eb2NzL1JlcG9zaXRvcnkuaHRtMBMGA1UdJQQMMAoGCCsGAQUFBwMIMBkGCSsGAQQBgjcUAgQMHgoAUwB1AGIAQwBBMAsGA1UdDwQEAwIBhjAPBgNVHRMBAf8EBTADAQH/MB8GA1UdIwQYMBaAFNX2VsuP6KJcYmjRPZSQW9fOmhjEMFYGA1UdHwRPME0wS6BJoEeGRWh0dHA6Ly9jcmwubWljcm9zb2Z0LmNvbS9wa2kvY3JsL3Byb2R1Y3RzL01pY1Jvb0NlckF1dF8yMDEwLTA2LTIzLmNybDBaBggrBgEFBQcBAQROMEwwSgYIKwYBBQUHMAKGPmh0dHA6Ly93d3cubWljcm9zb2Z0LmNvbS9wa2kvY2VydHMvTWljUm9vQ2VyQXV0XzIwMTAtMDYtMjMuY3J0MA0GCSqGSIb3DQEBCwUAA4ICAQCdVX38Kq3hLB9nATEkW+Geckv8qW/qXBS2Pk5HZHixBpOXPTEztTnXwnE2P9pkbHzQdTltuw8x5MKP+2zRoZQYIu7pZmc6U03dmLq2HnjYNi6cqYJWAAOwBb6J6Gngugnue99qb74py27YP0h1AdkY3m2CDPVtI1TkeFN1JFe53Z/zjj3G82jfZfakVqr3lbYoVSfQJL1AoL8ZthISEV09J+BAljis9/kpicO8F7BUhUKz/AyeixmJ5/ALaoHCgRlCGVJ1ijbCHcNhcy4sa3tuPywJeBTpkbKpW99Jo3QMvOyRgNI95ko+ZjtPu4b6MhrZlvSP9pEB9s7GdP32THJvEKt1MMU0sHrYUP4KWN1APMdUbZ1jdEgssU5HLcEUBHG/ZPkkvnNtyo4JvbMBV0lUZNlz138eW0QBjloZkWsNn6Qo3GcZKCS6OEuabvshVGtqRRFHqfG3rsjoiV5PndLQTHa1V1QJsWkBRH58oWFsc/4Ku+xBZj1p/cvBQUl+fpO+y/g75LcVv7TOPqUxUYS8vwLBgqJ7Fx0ViY1w/ue10CgaiQuPNtq6TPmb/wrpNPgkNWcr4A245oyZ1uEi6vAnQj0llOZ0dFtq0Z4+7X6gMTN9vMvpe784cETRkPHIqzqKOghif9lwY1NNje6CbaUFEMFxBmoQtB1VM1izoXBm8g==</X509Certificate></X509Data><CounterSignature ts-format="cms-timestamp-message" xmlns="http://schemas.microsoft.com/xmldsig/timestamp/2003">MIAGCSqGSIb3DQEHAqCAMIIW4AIBAzEPMA0GCWCGSAFlAwQCAQUAMIIBVAYLKoZIhvcNAQkQAQSgggFDBIIBPzCCATsCAQEGCisGAQQBhFkKAwEwMTANBglghkgBZQMEAgEFAAQgBFFw9nc2yHihttPM1XLi9Ih5YlF8fx5SelprSyXL6AYCBmMRVltCYRgSMjAyMjA5MDkyMzE3NTUuNDZaMASAAgH0oIHUpIHRMIHOMQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSkwJwYDVQQLEyBNaWNyb3NvZnQgT3BlcmF0aW9ucyBQdWVydG8gUmljbzEmMCQGA1UECxMdVGhhbGVzIFRTUyBFU046ODk3QS1FMzU2LTE3MDExJTAjBgNVBAMTHE1pY3Jvc29mdCBUaW1lLVN0YW1wIFNlcnZpY2WgghFfMIIHEDCCBPigAwIBAgITMwAAAasJCe+rY9ToqQABAAABqzANBgkqhkiG9w0BAQsFADB8MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSYwJAYDVQQDEx1NaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0EgMjAxMDAeFw0yMjAzMDIxODUxMjhaFw0yMzA1MTExODUxMjhaMIHOMQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSkwJwYDVQQLEyBNaWNyb3NvZnQgT3BlcmF0aW9ucyBQdWVydG8gUmljbzEmMCQGA1UECxMdVGhhbGVzIFRTUyBFU046ODk3QS1FMzU2LTE3MDExJTAjBgNVBAMTHE1pY3Jvc29mdCBUaW1lLVN0YW1wIFNlcnZpY2UwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQDJnUtaOXXoQElLLHC6ssdsJv1oqzVH6pBgcpgyLWMxJ6CrZIa3e8DbCbOIPgbjN7gV/NVpztu9JZKwtHtZpg6kLeNtE5m/JcLI0CjOphGjUCH1w66J61Td2sNZcfWwH+1WRAN5BxapemADt5I0Oj37QOIlR19yVb/fJ7Y5G7asyniTGjVnfHQWgA90QpYjKGo0wxm8mDSk78QYViC8ifFmHSfzQQ6aj80JfqcZumWVUngUACDrm2Y1NL36RAsRwubyNRK66mqRvtKAYYTjfoJZVZJTwFmb9or9JoIwk4+2DSl+8i9sdk767x1auRjzWuXzW6ct/beXL4omKjH9UWVWXHHa/trwKZOYm+WuDvEogID0lMGBqDsG2RtaJx4o9AEzy5IClH4Gj8xX3eSWUm0Zdl4N+O/y41kC0fiowMgAhW9Om6ls7x7UCUzQ/GNI+WNkgZ0gqldszR0lbbOPmlH5FIbCkvhgF0t4+V1IGAO0jDaIO+jZ7LOZdNZxF+7Bw3WMpGIc7kCha0+9F1U2Xl9ubUgX8t1WnM2HdSUiP/cDhqmxVOdjcq5bANaopsTobLnbOz8aPozt0Y1f5AvgBDqFWlw3Zop7HNz7ZQQlYf7IGJ6PQFMpm5UkZnntYMJZ5WSdLohyiPathxYGVjNdMjxuYFbdKa15yRYtVsZpoPgR/wIDAQABo4IBNjCCATIwHQYDVR0OBBYEFBRbzvKNXjXEgiEGTL6hn3TS/qaqMB8GA1UdIwQYMBaAFJ+nFV0AXmJdg/Tl0mWnG1M1GelyMF8GA1UdHwRYMFYwVKBSoFCGTmh0dHA6Ly93d3cubWljcm9zb2Z0LmNvbS9wa2lvcHMvY3JsL01pY3Jvc29mdCUyMFRpbWUtU3RhbXAlMjBQQ0ElMjAyMDEwKDEpLmNybDBsBggrBgEFBQcBAQRgMF4wXAYIKwYBBQUHMAKGUGh0dHA6Ly93d3cubWljcm9zb2Z0LmNvbS9wa2lvcHMvY2VydHMvTWljcm9zb2Z0JTIwVGltZS1TdGFtcCUyMFBDQSUyMDIwMTAoMSkuY3J0MAwGA1UdEwEB/wQCMAAwEwYDVR0lBAwwCgYIKwYBBQUHAwgwDQYJKoZIhvcNAQELBQADggIBAMpLlIE3NSjLMzILB24YI4BBr/3QhxX9G8vfQuOUke+9P7nQjTXqpU+tdBIc9d8RhVOh3Ivky1D1J4b1J0rs+8ZIlka7uUY2WZkqJxFb/J6Wt89UL3lH54LcotCXeqpUspKBFSerQ7kdSsPcVPcr7YWVoULP8psjsIfpsbdAvcG3iyfdnq9r3PZctdqRcWwjQyfpkO7+dtIQL63lqmdNhjiYcNEeHNYj9/YjQcxzqM/g7DtLGI8IWs/R672DBMzg9TCXSz1n1BbGf/4k3d48xMpJNNlo52TcyHthDX5kPym5Rlx3knvCWKopkxcZeZHjHy1BC4wIdJoUNbywiWdtAcAuDuexIO8jv2LgZ6PuEa1dAg9oKeATtdChVtkkPzIb0Viux24Eugc7e9K5CHklLaO6UZBzKq54bmyE3F3XZMuhrWbJsDN4b6l7krTHlNVuTTdxwPMqYzy3f26Jnxsfeh7sPDq37XEL5O7YXTbuCYQMilF1D+3SjAiX6znaZYNI9bRNGohPqQ00kFZj8xnswi+NrJcjyVV6buMcRNIaQAq9rmtCx7/ywekVeQuAjuDLP6X2pf/xdzvoSWXuYsXr8yjZF128TzmtUfkiK1v6x2TOkSAy0ycUxhQzNYUA8mnxrvUv2u7ppL4pYARzcWX5NCGBO0UViXBu6ImPhRncdXLNMIIHcTCCBVmgAwIBAgITMwAAABXF52ueAptJmQAAAAAAFTANBgkqhkiG9w0BAQsFADCBiDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEyMDAGA1UEAxMpTWljcm9zb2Z0IFJvb3QgQ2VydGlmaWNhdGUgQXV0aG9yaXR5IDIwMTAwHhcNMjEwOTMwMTgyMjI1WhcNMzAwOTMwMTgzMjI1WjB8MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSYwJAYDVQQDEx1NaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0EgMjAxMDCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAOThpkzntHIhC3miy9ckeb0O1YLT/e6cBwfSqWxOdcjKNVf2AX9sSuDivbk+F2Az/1xPx2b3lVNxWuJ+Slr+uDZnhUYjDLWNE893MsAQGOhgfWpSg0S3po5GawcU88V29YZQ3MFEyHFcUTE3oAo4bo3t1w/YJlN8OWECesSq/XJprx2rrPY2vjUmZNqYO7oaezOtgFt+jBAcnVL+tuhiJdxqD89d9P6OU8/W7IVWTe/dvI2k45GPsjksUZzpcGkNyjYtcI4xyDUoveO0hyTD4MmPfrVUj9z6BVWYbWg7mka97aSueik3rMvrg0XnRm7KMtXAhjBcTyziYrLNueKNiOSWrAFKu75xqRdbZ2De+JKRHh09/SDPc31BmkZ1zcRfNN0Sidb9pSB9fvzZnkXftnIv231fgLrbqn427DZM9ituqBJR6L8FA6PRc6ZNN3SUHDSCD/AQ8rdHGO2n6Jl8P0zbr17C89XYcz1DTsEzOUyOArxCaC4Q6oRRRuLRvWoYWmEBc8pnol7XKHYC4jMYctenIPDC+hIK12NvDMk2ZItboKaDIV1fMHSRlJTYuVD5C4lh8zYGNRiER9vcG9H9stQcxWv2XFJRXRLbJbqvUAV6bMURHXLvjflSxIUXk8A8FdsaN8cIFRg/eKtFtvUeh17aj54WcmnGrnu3tz5q4i6tAgMBAAGjggHdMIIB2TASBgkrBgEEAYI3FQEEBQIDAQABMCMGCSsGAQQBgjcVAgQWBBQqp1L+ZMSavoKRPEY1Kc8Q/y8E7jAdBgNVHQ4EFgQUn6cVXQBeYl2D9OXSZacbUzUZ6XIwXAYDVR0gBFUwUzBRBgwrBgEEAYI3TIN9AQEwQTA/BggrBgEFBQcCARYzaHR0cDovL3d3dy5taWNyb3NvZnQuY29tL3BraW9wcy9Eb2NzL1JlcG9zaXRvcnkuaHRtMBMGA1UdJQQMMAoGCCsGAQUFBwMIMBkGCSsGAQQBgjcUAgQMHgoAUwB1AGIAQwBBMAsGA1UdDwQEAwIBhjAPBgNVHRMBAf8EBTADAQH/MB8GA1UdIwQYMBaAFNX2VsuP6KJcYmjRPZSQW9fOmhjEMFYGA1UdHwRPME0wS6BJoEeGRWh0dHA6Ly9jcmwubWljcm9zb2Z0LmNvbS9wa2kvY3JsL3Byb2R1Y3RzL01pY1Jvb0NlckF1dF8yMDEwLTA2LTIzLmNybDBaBggrBgEFBQcBAQROMEwwSgYIKwYBBQUHMAKGPmh0dHA6Ly93d3cubWljcm9zb2Z0LmNvbS9wa2kvY2VydHMvTWljUm9vQ2VyQXV0XzIwMTAtMDYtMjMuY3J0MA0GCSqGSIb3DQEBCwUAA4ICAQCdVX38Kq3hLB9nATEkW+Geckv8qW/qXBS2Pk5HZHixBpOXPTEztTnXwnE2P9pkbHzQdTltuw8x5MKP+2zRoZQYIu7pZmc6U03dmLq2HnjYNi6cqYJWAAOwBb6J6Gngugnue99qb74py27YP0h1AdkY3m2CDPVtI1TkeFN1JFe53Z/zjj3G82jfZfakVqr3lbYoVSfQJL1AoL8ZthISEV09J+BAljis9/kpicO8F7BUhUKz/AyeixmJ5/ALaoHCgRlCGVJ1ijbCHcNhcy4sa3tuPywJeBTpkbKpW99Jo3QMvOyRgNI95ko+ZjtPu4b6MhrZlvSP9pEB9s7GdP32THJvEKt1MMU0sHrYUP4KWN1APMdUbZ1jdEgssU5HLcEUBHG/ZPkkvnNtyo4JvbMBV0lUZNlz138eW0QBjloZkWsNn6Qo3GcZKCS6OEuabvshVGtqRRFHqfG3rsjoiV5PndLQTHa1V1QJsWkBRH58oWFsc/4Ku+xBZj1p/cvBQUl+fpO+y/g75LcVv7TOPqUxUYS8vwLBgqJ7Fx0ViY1w/ue10CgaiQuPNtq6TPmb/wrpNPgkNWcr4A245oyZ1uEi6vAnQj0llOZ0dFtq0Z4+7X6gMTN9vMvpe784cETRkPHIqzqKOghif9lwY1NNje6CbaUFEMFxBmoQtB1VM1izoXBm8qGCAtIwggI7AgEBMIH8oYHUpIHRMIHOMQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSkwJwYDVQQLEyBNaWNyb3NvZnQgT3BlcmF0aW9ucyBQdWVydG8gUmljbzEmMCQGA1UECxMdVGhhbGVzIFRTUyBFU046ODk3QS1FMzU2LTE3MDExJTAjBgNVBAMTHE1pY3Jvc29mdCBUaW1lLVN0YW1wIFNlcnZpY2WiIwoBATAHBgUrDgMCGgMVAFuoev9uFgqO1mc+ghFQHi87XJg+oIGDMIGApH4wfDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEmMCQGA1UEAxMdTWljcm9zb2Z0IFRpbWUtU3RhbXAgUENBIDIwMTAwDQYJKoZIhvcNAQEFBQACBQDmxbfcMCIYDzIwMjIwOTA5MTcwMjIwWhgPMjAyMjA5MTAxNzAyMjBaMHcwPQYKKwYBBAGEWQoEATEvMC0wCgIFAObFt9wCAQAwCgIBAAICA8ECAf8wBwIBAAICEYwwCgIFAObHCVwCAQAwNgYKKwYBBAGEWQoEAjEoMCYwDAYKKwYBBAGEWQoDAqAKMAgCAQACAwehIKEKMAgCAQACAwGGoDANBgkqhkiG9w0BAQUFAAOBgQB47CUUUypnx1XOln4r1nbxV/5i3AUuC9Dogye7UTgzoOWxG89RmF3i3lfXD6CjzZFc061T6WaaYftySPY7ygICHi7sZT6JRd06hIfsh3hzW2Huz4CQ9W85aXERTMsV2T14o/1SiAFMlWDSNxApLy6dRA6lLrpywPzExjTA8nslaDGCBA0wggQJAgEBMIGTMHwxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpXYXNoaW5ndG9uMRAwDgYDVQQHEwdSZWRtb25kMR4wHAYDVQQKExVNaWNyb3NvZnQgQ29ycG9yYXRpb24xJjAkBgNVBAMTHU1pY3Jvc29mdCBUaW1lLVN0YW1wIFBDQSAyMDEwAhMzAAABqwkJ76tj1OipAAEAAAGrMA0GCWCGSAFlAwQCAQUAoIIBSjAaBgkqhkiG9w0BCQMxDQYLKoZIhvcNAQkQAQQwLwYJKoZIhvcNAQkEMSIEIM/bQu3+zmZPpP+PeOd5TIljVWwUgmAoBO+6Aob2s9tDMIH6BgsqhkiG9w0BCRACLzGB6jCB5zCB5DCBvQQgDhyv+rCFYBFUlQ9wK75OjskCr0cRRysq2lM2zdfwClcwgZgwgYCkfjB8MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSYwJAYDVQQDEx1NaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0EgMjAxMAITMwAAAasJCe+rY9ToqQABAAABqzAiBCDhDTFAgCOybBAz4qykEaq/rhKM/E8sUC12vFZy3acyWjANBgkqhkiG9w0BAQsFAASCAgA4AkFQ1//HcxrKdOXPH3N+sVn6j8rngif1krOYgZ6+ija5zZQYw4nM0yGzbrX0+lkgw5QqljsPcOPYGTvZBDwGwSvArpETxaPCzLMTnes01KTk0P2KTAR/U8O4AT54Bi7J481lODPUtgzXUnNJJA1O5WDWRGRqamBIDHBMRrRr74A2fQj+ccIIfVOZNbJIYKWk6/jCGWYOYErICCcVWkHstpr9dGMIMaiDFhv3c8wsAbSD4xXhFJcYyaP7HWcInPBoVnDf3KhpRE68QtZV3nmImlKICTpv1QlqdJ3eNazW2JsudaML47ELMhKOquanOHvYv7hlX0sbg6Cr7o/DrpSL/Y8OnoYn+1GjzPDaDfSsLOeKcFXePOOHWNCSVYxaSDy1heGaJVe7TU85MkAAs/65NdtdXGxBMBSzhEc48ppPMEqQZBOj36XS+/bzqGZAUuUMwmlO2kHTd9lAyl4N8wpSPoNImzKeFcuzn5ZfsBJtiZq5RB7dCfuqxkuX17o56XWh0DyhckW8r9tArFV3+imfCANNcw552ALxSDXudC4pl3zOVpVH5TdZuUS2GN1f0nmgfu3L+MI/GqxaI7kU5nFSHz2yfUhzRTTBq4HRTuKvJ4kcxW+xNUtDZVva76+Y0OmxKzQl9RnP8xqgPzf+D7nV+9gVso3yiP4OdblhLkUGIQAAAAA=</CounterSignature></Object></Signature></doc>
md5: 5E9864A37A5BEF9DA0E956A5B197FC31 | sha1: 839DB4532AA784FEFB61B6520FAE59BF1D62E0AF | sha256: 0EF404EE2EDF9A5A6D7D35F986F0F5562F6BF9E94AB8D1D9EF8506DC1625A4D4 | sha512: 31AD82BB0DF58C843F5CFD06938390C69E26D22DF02A5BFC1A28517B0CD1272846E18441BA722AC583562EE0CA89E832F17F513393CB456C45808FCB0EF78560
<?xml version="1.0"?>
<doc>
<assembly>
<name>NuGet.Resolver</name>
</assembly>
<members>
<member name="T:NuGet.Resolver.CombinationSolver`1">
<summary>
This class is responsible for finding the best combination of compatible items. The caller
supplies a collection of groups, a sorting function (to determine priority within a group), and
a function to determine whether two items are incompatible. The solution (if found) will contain
exactly 1 item from each group.
</summary>
<remarks>Created by Aaron Marten</remarks>
<typeparam name="T">The type of item to evaluate.</typeparam>
</member>
<member name="F:NuGet.Resolver.CombinationSolver`1._initialDomains">
<summary>
The initial domains are the full/initial candidate sets we start with when
attempting to discover a solution. They need to be stored and referred to
as the algorithm executes to re-initialize the current/working domains.
</summary>
</member>
<member name="F:NuGet.Resolver.CombinationSolver`1._currentDomains">
<summary>
The current domains are initialized with the initial domains. As we progress
through the algorithm, we may remove elements from the current domain as we
discover that an item cannot be part of the solution. If we need to backtrack,
we may reset the current domain to the corresponding initial domain.
</summary>
</member>
<member name="F:NuGet.Resolver.CombinationSolver`1._conflictSet">
<summary>
The subset of past indexes where a conflict was found. Used to calculate the biggest and safest
(i.e. not missing a better solution) jump we can make in MoveBackward.
</summary>
</member>
<member name="F:NuGet.Resolver.CombinationSolver`1._pastForwardChecking">
<summary>
For each position, maintain a stack of past indexes that forward checked (and found/removed conflicts)
from the position.
</summary>
</member>
<member name="F:NuGet.Resolver.CombinationSolver`1._futureForwardChecking">
<summary>
For each position, maintain a stack of forward/future indexes where conflicts were found.
</summary>
</member>
<member name="F:NuGet.Resolver.CombinationSolver`1._reductions">
<summary>
For each position, maintain a Stack of sets of items that were 'reduced' from the domain. This allows us
to restore the items back into the domain on future iterations in case we need to back up, etc...
</summary>
</member>
<member name="M:NuGet.Resolver.CombinationSolver`1.FindSolution(System.Collections.Generic.IEnumerable{System.Collections.Generic.IEnumerable{`0}},System.Collections.Generic.IComparer{`0},System.Func{`0,`0,System.Boolean},System.Action{System.Collections.Generic.IEnumerable{`0}})">
<summary>
Entry point for the combination evalutation phase of the algorithm. The algorithm
combines forward checking [FC] (i.e. trying to eliminate future possible combinations to evaluate)
with Conflict-directed Back Jumping.
Based off the FC-CBJ algorithm described in Prosser's Hybrid
Algorithms for the Constraint Satisfaction Problem:
http://archive.nyu.edu/bitstream/2451/14410/1/IS-90-10.pdf
</summary>
<param name="groupedItems">The candidate enlistment items grouped by product.</param>
<param name="itemSorter">
Function supplied by the caller to sort items in preferred/priority order. 'Higher
priority' items should come *first* in the sort.
</param>
<param name="shouldRejectPairFunc">
Function supplied by the caller to determine whether two items are
compatible or not.
</param>
<param name="diagnosticOutput">
Used to provide partial solutions to be used for diagnostic messages.
</param>
<returns>The 'best' solution (if one exists). Null otherwise.</returns>
</member>
<member name="M:NuGet.Resolver.CombinationSolver`1.MoveForward(System.Int32,System.Boolean@)">
<summary>
Attempts to populate the element at position i with a consistent possibility
and move forward to the next element in the sequence.
</summary>
<param name="i">The position in the solution to attempt to populate.</param>
<param name="consistent">
Upon completion, set to true if the function was able to find a candidate to
populate position i with. False otherwise.
</param>
<returns>
The next position to evaluate if consistent is true. If false, return value is the value to move
back to.
</returns>
</member>
<member name="M:NuGet.Resolver.CombinationSolver`1.MoveBackward(System.Int32,System.Boolean@)">
<summary>
Attempts to move back in the algorithm from position i.
</summary>
<param name="i">The position to unset / move back from.</param>
<param name="consistent">
True if backwards move was successful and algorithm can move forward again. False
if the algorithm should continue to move backwards.
</param>
<returns>The position that the call was able to safely move back to.</returns>
</member>
<member name="M:NuGet.Resolver.CombinationSolver`1.CheckForward(System.Int32,System.Int32)">
<summary>
Performs forward checking between the already selected element at position i
and potential candidates at position j.
</summary>
<param name="i">The position of the current element.</param>
<param name="j">The position of the future domain to check against.</param>
<returns>
True if there are still remaining possibilities in the future domain. False if all possibilities
have been eliminated.
</returns>
</member>
<member name="M:NuGet.Resolver.CombinationSolver`1.UndoReductions(System.Int32)">
<summary>
Undo reductions that were previously performed from position i.
</summary>
<param name="i">The position to undo reductions from.</param>
</member>
<member name="M:NuGet.Resolver.CombinationSolver`1.UpdateCurrentDomain(System.Int32)">
<summary>
Reinitialize the current domain to its initial value and apply any reductions against it.
</summary>
<param name="i">The position of the domain to update.</param>
</member>
<member name="T:NuGet.Resolver.CompareWrapper`1">
<summary>
Simple helper class to provide an IComparer instance based on a comparison function
</summary>
<typeparam name="T">The type to compare.</typeparam>
</member>
<member name="T:NuGet.Resolver.NuGetResolverConstraintException">
<summary>
Constraint exception. Thrown when a solution cannot be found.
</summary>
</member>
<member name="T:NuGet.Resolver.NuGetResolverInputException">
<summary>
Input validation exception
</summary>
</member>
<member name="T:NuGet.Resolver.PackageResolver">
<summary>
A core package dependency resolver.
</summary>
<remarks>Not thread safe</remarks>
</member>
<member name="M:NuGet.Resolver.PackageResolver.Resolve(NuGet.Resolver.PackageResolverContext,System.Threading.CancellationToken)">
<summary>
Resolve a package closure
</summary>
</member>
<member name="M:NuGet.Resolver.PackageResolver.RemoveImpossiblePackages(System.Collections.Generic.IEnumerable{NuGet.Protocol.Core.Types.SourcePackageDependencyInfo},System.Collections.Generic.ISet{System.String})">
<summary>
Remove packages that can't possibly form part of a solution
</summary>
</member>
<member name="M:NuGet.Resolver.PackageResolverContext.#ctor(NuGet.Resolver.DependencyBehavior,System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{NuGet.Packaging.PackageReference},System.Collections.Generic.IEnumerable{NuGet.Packaging.Core.PackageIdentity},System.Collections.Generic.IEnumerable{NuGet.Protocol.Core.Types.SourcePackageDependencyInfo},System.Collections.Generic.IEnumerable{NuGet.Configuration.PackageSource},NuGet.Common.ILogger)">
<summary>
Resolver context
</summary>
<param name="dependencyBehavior">behavior for non-target packages</param>
<param name="targetIds">packages to install or update</param>
<param name="requiredPackageIds">packages required in the solution</param>
<param name="packagesConfig">existing packages</param>
<param name="preferredVersions">preferred package versions or the installed version of a package</param>
<param name="availablePackages">all packages from the gather stage</param>
</member>
<member name="P:NuGet.Resolver.PackageResolverContext.TargetIds">
<summary>
New packages to install or update. These will prefer the highest version.
</summary>
</member>
<member name="P:NuGet.Resolver.PackageResolverContext.RequiredPackageIds">
<summary>
Existing packages that are required, and the target ids that are required.
These packages are required for the solution.
</summary>
</member>
<member name="P:NuGet.Resolver.PackageResolverContext.PackagesConfig">
<summary>
The existing state of the project from packages.config
</summary>
</member>
<member name="P:NuGet.Resolver.PackageResolverContext.PreferredVersions">
<summary>
Preferred versions of each package. If the package does not exist here
it will use the dependency behavior, or if it is a target the highest
version will be used.
</summary>
</member>
<member name="P:NuGet.Resolver.PackageResolverContext.AvailablePackages">
<summary>
All packages available to use in the solution.
</summary>
</member>
<member name="P:NuGet.Resolver.PackageResolverContext.DependencyBehavior">
<summary>
Dependency behavior
</summary>
</member>
<member name="P:NuGet.Resolver.PackageResolverContext.PackageSources">
<summary>
Package Sources
</summary>
</member>
<member name="P:NuGet.Resolver.PackageResolverContext.Log">
<summary>
Logging adapter
</summary>
</member>
<member name="M:NuGet.Resolver.ResolverInputSort.TreeFlatten(System.Collections.Generic.List{System.Collections.Generic.List{NuGet.Resolver.ResolverPackage}},NuGet.Resolver.PackageResolverContext)">
<summary>
Order package trees into a flattened list
Package Id (Parent count)
Iteration 1: A(0) -> B(1) -> D(2)
C(0) -> D(2)
[Select A]
Iteration 2: B(0) -> D(2)
C(0) -> D(2)
[Select B]
Iteration 2: C(0) -> D(1)
[Select C]
Result: A, B, C, D
</summary>
</member>
<member name="M:NuGet.Resolver.ResolverInputSort.GetTreeFlattenPriority(System.String,NuGet.Resolver.PackageResolverContext)">
<summary>
Packages occuring first are more likely to get their preferred version, for this
reason installed packages should go first, then targets.
</summary>
</member>
<member name="P:NuGet.Resolver.ResolverPackage.Absent">
<summary>
An absent package represents that the package is not needed in the solution.
</summary>
</member>
<member name="M:NuGet.Resolver.ResolverPackage.FindDependencyRange(System.String)">
<summary>
Find the version range for the given package. The package may not exist.
</summary>
</member>
<member name="M:NuGet.Resolver.ResolverUtility.GetDiagnosticMessage(System.Collections.Generic.IEnumerable{NuGet.Resolver.ResolverPackage},System.Collections.Generic.IEnumerable{NuGet.Packaging.Core.PackageDependencyInfo},System.Collections.Generic.IEnumerable{NuGet.Packaging.PackageReference},System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{NuGet.Configuration.PackageSource})">
<summary>
Create an error message to describe the primary issue in an invalid solution.
</summary>
<param name="solution">A partial solution from the resolver</param>
<param name="availablePackages">all packages that were available for the solution</param>
<param name="packagesConfig">packages already installed in the project</param>
<param name="newPackageIds">new packages that are not already installed</param>
<returns>A user friendly diagnostic message</returns>
</member>
<member name="M:NuGet.Resolver.ResolverUtility.FormatDependencyConstraint(NuGet.Resolver.ResolverPackage,System.String)">
<summary>
Ex: PackageA (> 1.0.0)
</summary>
</member>
<member name="M:NuGet.Resolver.ResolverUtility.GetBrokenDependenciesWithInstalledPackages(NuGet.Resolver.ResolverPackage,System.Collections.Generic.IEnumerable{NuGet.Resolver.ResolverPackage},System.Collections.Generic.IEnumerable{NuGet.Packaging.Core.PackageDependencyInfo},System.Collections.Generic.HashSet{System.String})">
<summary>
This will try and get broken dependencies for target or it's dependencies WRT installed packages as well as all available packages to install
</summary>
<param name="package">target package</param>
<param name="solution">last best known solution</param>
<param name="availablePackages">all available packages from all sources</param>
<returns>list of broken dependencies</returns>
</member>
<member name="M:NuGet.Resolver.ResolverUtility.GetLowestDistanceFromTarget(System.String,System.Collections.Generic.HashSet{System.String},System.Collections.Generic.IEnumerable{NuGet.Resolver.ResolverPackage})">
<summary>
Find distance of a dependency from a target package.
A -> B -> C
C is 2 away from A
</summary>
<param name="packageId">package id</param>
<param name="targets">required targets</param>
<param name="packages">packages in the solution, only 1 package per id should exist</param>
<returns>number of levels from a target</returns>
</member>
<member name="M:NuGet.Resolver.ResolverUtility.TopologicalSort(System.Collections.Generic.IEnumerable{NuGet.Resolver.ResolverPackage})">
<summary>
Sort packages in order of dependencies
</summary>
</member>
<member name="M:NuGet.Resolver.ResolverUtility.ShouldRejectPackagePair(NuGet.Resolver.ResolverPackage,NuGet.Resolver.ResolverPackage)">
<summary>
Check if two packages can exist in the same solution.
This is used by the resolver.
</summary>
</member>
<member name="M:NuGet.Resolver.ResolverUtility.FindFirstCircularDependency(System.Collections.Generic.IEnumerable{NuGet.Resolver.ResolverPackage})">
<summary>
Returns the first circular dependency found for a package. Please sort solution topologically first to improve performance.
</summary>
</member>
<member name="T:NuGet.Resolver.ResolverUtility.QueueNode">
<summary>
Simple QueueNode class to hold package n it's parent nodes list together
</summary>
</member>
<member name="P:NuGet.Resolver.ResolverUtility.QueueNode.Package">
<summary>
Package node
</summary>
</member>
<member name="P:NuGet.Resolver.ResolverUtility.QueueNode.ParentPackages">
<summary>
Complete Parent list for the given package
</summary>
</member>
<member name="T:NuGet.Resolver.Strings">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:NuGet.Resolver.Strings.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:NuGet.Resolver.Strings.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:NuGet.Resolver.Strings.CircularDependencyDetected">
<summary>
Looks up a localized string similar to Circular dependency detected '{0}'..
</summary>
</member>
<member name="P:NuGet.Resolver.Strings.DependencyConstraint">
<summary>
Looks up a localized string similar to constraint.
</summary>
</member>
<member name="P:NuGet.Resolver.Strings.DuplicateDependencyIdsError">
<summary>
Looks up a localized string similar to The package '{0}' version '{1}' declared a duplicate dependency '{2}'. This might mean the package is corrupt or the server metadata for the package is corrupt..
</summary>
</member>
<member name="P:NuGet.Resolver.Strings.FatalError">
<summary>
Looks up a localized string similar to A fatal error occured while resolving dependencies..
</summary>
</member>
<member name="P:NuGet.Resolver.Strings.InvalidPackageConfig">
<summary>
Looks up a localized string similar to One or more unresolved package dependency constraints detected in the existing packages.config file. All dependency constraints must be resolved to add or update packages. If these packages are being updated this message may be ignored, if not the following error(s) may be blocking the current package operation: {0}.
</summary>
</member>
<member name="P:NuGet.Resolver.Strings.MissingDependencyInfo">
<summary>
Looks up a localized string similar to Unable to find package '{0}'. Existing packages must be restored before performing an install or update..
</summary>
</member>
<member name="P:NuGet.Resolver.Strings.NoSolution">
<summary>
Looks up a localized string similar to Unable to resolve dependencies..
</summary>
</member>
<member name="P:NuGet.Resolver.Strings.PackagesConfigConstraint">
<summary>
Looks up a localized string similar to '{0}' has an additional constraint {1} defined in {2}..
</summary>
</member>
<member name="P:NuGet.Resolver.Strings.ResolverTotalTime">
<summary>
Looks up a localized string similar to Resolving dependency information took {0}.
</summary>
</member>
<member name="P:NuGet.Resolver.Strings.UnableToFindCompatibleVersion">
<summary>
Looks up a localized string similar to Unable to find a version of '{0}' that is compatible with {1}..
</summary>
</member>
<member name="P:NuGet.Resolver.Strings.UnableToResolveDependencyForEmptySource">
<summary>
Looks up a localized string similar to Unable to resolve dependency '{0}'..
</summary>
</member>
<member name="P:NuGet.Resolver.Strings.UnableToResolveDependencyForMultipleSources">
<summary>
Looks up a localized string similar to Unable to resolve dependency '{0}'. Source(s) used: {1}..
</summary>
</member>
<member name="P:NuGet.Resolver.Strings.VersionIsNotCompatible">
<summary>
Looks up a localized string similar to Unable to resolve dependencies. '{0}' is not compatible with {1}..
</summary>
</member>
<member name="M:NuGet.Shared.EqualityUtility.OrderedEquals``2(System.Collections.Generic.IEnumerable{``0},System.Collections.Generic.IEnumerable{``0},System.Func{``0,``1},System.Collections.Generic.IComparer{``1},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Compares two enumerables for equality, ordered according to the specified key and optional comparer. Handles null values gracefully.
</summary>
<typeparam name="TSource">The type of the list</typeparam>
<typeparam name="TKey">The type of the sorting key</typeparam>
<param name="self">This list</param>
<param name="other">The other list</param>
<param name="keySelector">The function to extract the key from each item in the list</param>
<param name="orderComparer">An optional comparer for comparing keys</param>
<param name="sequenceComparer">An optional comparer for sequences</param>
</member>
<member name="M:NuGet.Shared.EqualityUtility.OrderedEquals``2(System.Collections.Generic.ICollection{``0},System.Collections.Generic.ICollection{``0},System.Func{``0,``1},System.Collections.Generic.IComparer{``1},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Compares two collections for equality, ordered according to the specified key and optional comparer. Handles null values gracefully.
</summary>
<typeparam name="TSource">The type of the list</typeparam>
<typeparam name="TKey">The type of the sorting key</typeparam>
<param name="self">This list</param>
<param name="other">The other list</param>
<param name="keySelector">The function to extract the key from each item in the list</param>
<param name="orderComparer">An optional comparer for comparing keys</param>
<param name="sequenceComparer">An optional comparer for sequences</param>
</member>
<member name="M:NuGet.Shared.EqualityUtility.OrderedEquals``2(System.Collections.Generic.IList{``0},System.Collections.Generic.IList{``0},System.Func{``0,``1},System.Collections.Generic.IComparer{``1},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Compares two lists for equality, ordered according to the specified key and optional comparer. Handles null values gracefully.
</summary>
<typeparam name="TSource">The type of the list</typeparam>
<typeparam name="TKey">The type of the sorting key</typeparam>
<param name="self">This list</param>
<param name="other">The other list</param>
<param name="keySelector">The function to extract the key from each item in the list</param>
<param name="orderComparer">An optional comparer for comparing keys</param>
<param name="sequenceComparer">An optional comparer for sequences</param>
</member>
<member name="M:NuGet.Shared.EqualityUtility.SequenceEqualWithNullCheck``1(System.Collections.Generic.IEnumerable{``0},System.Collections.Generic.IEnumerable{``0},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Compares two sequence for equality, allowing either sequence to be null. If one is null, both have to be
null for equality.
</summary>
</member>
<member name="M:NuGet.Shared.EqualityUtility.SequenceEqualWithNullCheck``1(System.Collections.Generic.ICollection{``0},System.Collections.Generic.ICollection{``0},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Compares two collections for equality, allowing either collection to be null. If one is null, both have to be
null for equality.
</summary>
</member>
<member name="M:NuGet.Shared.EqualityUtility.SequenceEqualWithNullCheck``1(System.Collections.Generic.IList{``0},System.Collections.Generic.IList{``0},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Compares two lists for equality, allowing either list to be null. If one is null, both have to be
null for equality.
</summary>
</member>
<member name="M:NuGet.Shared.EqualityUtility.SetEqualsWithNullCheck``1(System.Collections.Generic.ISet{``0},System.Collections.Generic.ISet{``0},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Compares two sets for equality, allowing either sequence to be null.
If one is null, both have to be null for equality.
</summary>
</member>
<member name="M:NuGet.Shared.EqualityUtility.EqualsFalse(System.String)">
<summary>
Determines if the current string contains a value equal "false". Leading and trailing whitespace are trimmed and the comparision is case-insensitive
</summary>
<param name="value">The string to compare.</param>
<returns><c>true</c> if the current string is equal to a value of "false", otherwise <c>false></c>.</returns>
</member>
<member name="T:NuGet.Shared.HashCodeCombiner">
<summary>
Hash code creator, based on the original NuGet hash code combiner/ASP hash code combiner implementations
</summary>
</member>
<member name="M:NuGet.Shared.HashCodeCombiner.GetHashCode``2(``0,``1)">
<summary>
Create a unique hash code for the given set of items
</summary>
</member>
<member name="M:NuGet.Shared.HashCodeCombiner.GetHashCode``3(``0,``1,``2)">
<summary>
Create a unique hash code for the given set of items
</summary>
</member>
<member name="M:NuGet.Shared.Extensions.AsList``1(System.Collections.Generic.IEnumerable{``0})">
<summary>
Return the enumerable as a List of T, copying if required. Optimized for common case where it is an List of T.
Avoid mutating the return value.
</summary>
<remarks>https://aspnetwebstack.codeplex.com/SourceControl/latest#src/Common/CollectionExtensions.cs</remarks>
</member>
<member name="M:NuGet.Shared.Extensions.AsHashSet``1(System.Collections.Generic.ISet{``0},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Return the ISet as a HashSet of T, copying if required. Optimized for common case where it is a HashSet of T.
Avoid mutating the return value.
</summary>
</member>
<member name="M:NuGet.Shared.XmlUtility.Load(System.String)">
<summary>
Creates a new <see cref="T:System.Xml.Linq.XDocument" /> from a file.
</summary>
<param name="path">The complete file path to be read into a new <see cref="T:System.Xml.Linq.XDocument" />.</param>
<returns>An <see cref="T:System.Xml.Linq.XDocument" /> that contains the contents of the specified file.</returns>
</member>
<member name="M:NuGet.Shared.XmlUtility.Load(System.String,System.Xml.Linq.LoadOptions)">
<summary>
Creates a new <see cref="T:System.Xml.Linq.XDocument" /> from a file. Optionally, whitespace can be preserved.
</summary>
<param name="path">The complete file path to be read into a new <see cref="T:System.Xml.Linq.XDocument" />.</param>
<param name="options">A set of <see cref="T:System.Xml.Linq.LoadOptions" />.</param>
<returns>An <see cref="T:System.Xml.Linq.XDocument" /> that contains the contents of the specified file.</returns>
</member>
<member name="M:NuGet.Shared.XmlUtility.Load(System.IO.Stream)">
<summary>
Creates a new <see cref="T:System.Xml.Linq.XDocument" /> from a stream.
</summary>
<param name="input">The stream that contains the XML data.</param>
<returns>An <see cref="T:System.Xml.Linq.XDocument" /> that contains the contents of the specified stream.</returns>
</member>
<member name="M:NuGet.Shared.XmlUtility.Load(System.IO.Stream,System.Xml.Linq.LoadOptions)">
<summary>
Creates a new System.Xml.Linq.XDocument from a stream. Optionally, whitespace can be preserved.
</summary>
<param name="input">The stream that contains the XML data.</param>
<param name="options">A set of <see cref="T:System.Xml.Linq.LoadOptions" />.</param>
<returns>An <see cref="T:System.Xml.Linq.XDocument" /> that contains the contents of the specified stream.</returns>
</member>
<member name="M:NuGet.Shared.XmlUtility.GetEncodedXMLName(System.String)">
<summary>
Converts the name to a valid XML local name, if it is invalid.
</summary>
<param name="name">The name to be encoded.</param>
<returns>The encoded name.</returns>
</member>
<member name="M:NuGet.Shared.XmlUtility.GetXmlReaderSettings(System.Xml.Linq.LoadOptions)">
<summary>
Creates an instance of <see cref="T:System.Xml.XmlReaderSettings" /> with safe settings
<param name="options">A set of <see cref="T:System.Xml.Linq.LoadOptions" />.</param>
</summary>
</member>
<member name="T:NuGet.StringBuilderPool">
<summary>
Provides a resource pool that enables reusing instances of <see cref="T:System.Text.StringBuilder" /> instances.
</summary>
<remarks>
<para>
Renting and returning buffers with an <see cref="T:NuGet.StringBuilderPool" /> can increase performance
in situations where <see cref="T:System.Text.StringBuilder" /> instances are created and destroyed frequently,
resulting in significant memory pressure on the garbage collector.
</para>
<para>
This class is thread-safe. All members may be used by multiple threads concurrently.
</para>
</remarks>
</member>
<member name="F:NuGet.StringBuilderPool.Shared">
<summary>
Retrieves a shared <see cref="T:NuGet.StringBuilderPool" /> instance.
</summary>
</member>
<member name="M:NuGet.StringBuilderPool.Rent(System.Int32)">
<summary>
Retrieves a <see cref="T:System.Text.StringBuilder" /> that is at least the requested length.
</summary>
<param name="minimumCapacity">The minimum capacity of the <see cref="T:System.Text.StringBuilder" /> needed.</param>
<returns>
A <see cref="T:System.Text.StringBuilder" /> that is at least <paramref name="minimumCapacity" /> in length.
</returns>
<remarks>
This buffer is loaned to the caller and should be returned to the same pool via
<see cref="M:NuGet.StringBuilderPool.Return(System.Text.StringBuilder)" /> so that it may be reused in subsequent usage of <see cref="M:NuGet.StringBuilderPool.Rent(System.Int32)" />.
It is not a fatal error to not return a rented string builder, but failure to do so may lead to
decreased application performance, as the pool may need to create a new instance to replace
the one lost.
</remarks>
</member>
<member name="M:NuGet.StringBuilderPool.Return(System.Text.StringBuilder)">
<summary>
Returns to the pool an array that was previously obtained via <see cref="M:NuGet.StringBuilderPool.Rent(System.Int32)" /> on the same
<see cref="T:NuGet.StringBuilderPool" /> instance.
</summary>
<param name="builder">
The <see cref="T:System.Text.StringBuilder" /> previously obtained from <see cref="M:NuGet.StringBuilderPool.Rent(System.Int32)" /> to return to the pool.
</param>
<remarks>
Once a <see cref="T:System.Text.StringBuilder" /> has been returned to the pool, the caller gives up all ownership
of the instance and must not use it. The reference returned from a given call to <see cref="M:NuGet.StringBuilderPool.Rent(System.Int32)" />
must only be returned via <see cref="M:NuGet.StringBuilderPool.Return(System.Text.StringBuilder)" /> once. The default <see cref="T:NuGet.StringBuilderPool" />
may hold onto the returned instance in order to rent it again, or it may release the returned instance
if it's determined that the pool already has enough instances stored.
</remarks>
</member>
</members>
<Signature xmlns="http://www.w3.org/2000/09/xmldsig#"><SignedInfo><CanonicalizationMethod Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315" /><SignatureMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#rsa-sha256" /><Reference URI=""><Transforms><Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature" /><Transform Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315" /></Transforms><DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256" /><DigestValue>grDS7jlqjbjTYLA0CdroNLACCQ9Y/fY4hN2QNfXT+AY=</DigestValue></Reference></SignedInfo><SignatureValue>LIXCFgVJIJ6d0gMxyqjcqawv3Un7q+21Hju/J6wqY8gstypSTyA74+ZMtc/NXodbZCIKdxSg91QClWA3R9ZAmHgdWXzFo2L0/shAKq18XkM7Vla7s9mjn1P6QFHHKeOYVUklRu0KfK1k2vqsSPzlT/sgZJXIz5nvAZ66zesDKfeblIaGuZupPXvxCHLYFA9f0uiZnwkjbMzapVuMrjj3OhntIN3gm7i8IJDKRQ70S14mVrnbo9yr6pNsnzxyRBNuzbxI9CFt6dz6bMHQk3OgBaXe5pu9GgqBQvvKt190aHYtFwIljCwr+VnqlnqKQLQ5fWVqj8sbBoh4MOouQQzs9w==</SignatureValue><KeyInfo><KeyValue><RSAKeyValue><Modulus>ok2x7OvGwA7zbnfezc3HT9M4dJka+FaQ7+vCqG40Bcm1QLlYIiDX/Whts0LVijaOvtl9iMeuShnAV7mchItKAVAABpyHuTuav2NCI9FsA8jFmlWndk3uK9RInNx1h1H4ojYxdBExyoN6muwwslKsLEfauUml7h5WAsDPpufTZd4yp2Jyiy384Zdd8CJlfQxfDe+gDZEciugWKHPSOoRxdjAk0GFm0OH14MyoYM4+M3mm1oH7vmSQohS5KIL3NEVW9Mdw7csTG5f93uORLvrJ/8ehFcGyWVb7UGHJnRhdcgGIbfiZzZlsAMS/DIBzM8RHKGNUNSbbLYmN/rt7pRjL4Q==</Modulus><Exponent>AQAB</Exponent></RSAKeyValue></KeyValue><X509Data><X509Certificate>MIIF/zCCA+egAwIBAgITMwAAAsyOtZamvdHJTgAAAAACzDANBgkqhkiG9w0BAQsFADB+MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSgwJgYDVQQDEx9NaWNyb3NvZnQgQ29kZSBTaWduaW5nIFBDQSAyMDExMB4XDTIyMDUxMjIwNDYwMVoXDTIzMDUxMTIwNDYwMVowdDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEeMBwGA1UEAxMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAok2x7OvGwA7zbnfezc3HT9M4dJka+FaQ7+vCqG40Bcm1QLlYIiDX/Whts0LVijaOvtl9iMeuShnAV7mchItKAVAABpyHuTuav2NCI9FsA8jFmlWndk3uK9RInNx1h1H4ojYxdBExyoN6muwwslKsLEfauUml7h5WAsDPpufTZd4yp2Jyiy384Zdd8CJlfQxfDe+gDZEciugWKHPSOoRxdjAk0GFm0OH14MyoYM4+M3mm1oH7vmSQohS5KIL3NEVW9Mdw7csTG5f93uORLvrJ/8ehFcGyWVb7UGHJnRhdcgGIbfiZzZlsAMS/DIBzM8RHKGNUNSbbLYmN/rt7pRjL4QIDAQABo4IBfjCCAXowHwYDVR0lBBgwFgYKKwYBBAGCN0wIAQYIKwYBBQUHAwMwHQYDVR0OBBYEFIi4R40ylsyKlSKfrDNqzhx9da30MFAGA1UdEQRJMEekRTBDMSkwJwYDVQQLEyBNaWNyb3NvZnQgT3BlcmF0aW9ucyBQdWVydG8gUmljbzEWMBQGA1UEBRMNMjMwMDEyKzQ3MDUyOTAfBgNVHSMEGDAWgBRIbmTlUAXTgqoXNzcitW2oynUClTBUBgNVHR8ETTBLMEmgR6BFhkNodHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20vcGtpb3BzL2NybC9NaWNDb2RTaWdQQ0EyMDExXzIwMTEtMDctMDguY3JsMGEGCCsGAQUFBwEBBFUwUzBRBggrBgEFBQcwAoZFaHR0cDovL3d3dy5taWNyb3NvZnQuY29tL3BraW9wcy9jZXJ0cy9NaWNDb2RTaWdQQ0EyMDExXzIwMTEtMDctMDguY3J0MAwGA1UdEwEB/wQCMAAwDQYJKoZIhvcNAQELBQADggIBAHgPA7DgB0udzEyB2LvG216zuskLUQ+iX8jFnl2i7tzXPDw5xXNXn2KvxdzBsf2osDW3LCdjFOwSjVkz+SUFQQNhjSHkd5knF6pzrL9V6lz72XiEg1Vi2gUM3HiLXSMIKOgdd78ZZJEmDLwdA692MO/1vVOFpOSv0QzpyBr5iqiotwMMsZVdZqXn8u9vRSmlk+3nQXdyOPoZXTGPLHXwz41kbSc4zI12bONTlDsLR3HD2s44wuyp3c72R8f9FVi/J9DU/+NOL37Z1yonzGZEuKdrAd6CvupAnLMlrIEv93mBsNRXuDDp4p9UYYK1taxzzgyUxgFDpluMHN0Oiiq9s73u7DA2XvbX8paJz8IZPe9a1/KhsOi5Kxhb99SCXiUnv2lGxnVAz5G6wAW1bzxJYKI+Xj90RKseY3X5EMO7TnVpIZ9Iw1IdrkHp/QLY90ZCch7kdBlLCVTFhSXZCDv4BcM6DhpRzbJsb6QDVfOv9aoG9aGV3a1EacyaedzLA2gWP6cTnCdAr4OrlrN5EFoCpOWgc77F/eQc3SLR06VTLVT1uKuNVxL2xZlD9Z+qC+a3TXa0zI/x1zEZNSgpLGsdVcaN6r/td3ArGQGkDWiAL7eS75LIWZA2SD//9B56uzZ1nmEd8+KBYsPTdp922/W2kFrlj7MBtA6vWE/ZG/grOKiC</X509Certificate><X509Certificate>MIIHejCCBWKgAwIBAgIKYQ6Q0gAAAAAAAzANBgkqhkiG9w0BAQsFADCBiDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEyMDAGA1UEAxMpTWljcm9zb2Z0IFJvb3QgQ2VydGlmaWNhdGUgQXV0aG9yaXR5IDIwMTEwHhcNMTEwNzA4MjA1OTA5WhcNMjYwNzA4MjEwOTA5WjB+MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSgwJgYDVQQDEx9NaWNyb3NvZnQgQ29kZSBTaWduaW5nIFBDQSAyMDExMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAq/D6chAcLq3YbqqCEE00uvK2WCGfQhsqa+laUKq4BjgaBEm6f8MMHt03a8YS2AvwOMKZBrDIOdUBFDFC04kNeWSHfpRgJGyvnkmc6Whe0t+bU7IKLMOv2akrrnoJr9eWWcpgGgXpZnboMlImEi/nqwhQz7NEt13YxC4Ddato88tt8zpcoRb0RrrgOGSsbmQ1eKagYw8t00CT+OPeBw3VXHmlSSnnDb6gE3e+lD3v++MrWhAfTVYoonpy4BI6t0le2O3tQ5GD2Xuye4Yb2T6xjF3oiU+EGvKhL1nkkDstrjNYxbc+/jLTswM9sbKvkjh+0p2ALPVOVpEhNSXDOW5kf1O6nA+tGSOEy/S6A4aN91/w0FK/jJSHvMAhdCVfGCi2zCcoOCWYOUo2z3yxkq4cI6epZuxhH2rhKEmdX4jiJV3TIUs+UsS1Vz8kA/DRelsv1SPjcF0PUUZ3s/gA4bysAoJf28AVs70b1FVL5zmhD+kjSbwYuER8ReTBw3J64HLnJN+/RpnF78IcV9uDjexNSTCnq47f7Fufr/zdsGbiwZeBe+3W7UvnSSmnEyimp31ngOaKYnhfsi+E11ecXL93KCjx7W3DKI8sj0A3T8HhhUSJxAlMxdSlQy90lfdu+HggWCwTXWCVmj5PM4TasIgX3p5O9JawvEagbJjS4NaIjAsCAwEAAaOCAe0wggHpMBAGCSsGAQQBgjcVAQQDAgEAMB0GA1UdDgQWBBRIbmTlUAXTgqoXNzcitW2oynUClTAZBgkrBgEEAYI3FAIEDB4KAFMAdQBiAEMAQTALBgNVHQ8EBAMCAYYwDwYDVR0TAQH/BAUwAwEB/zAfBgNVHSMEGDAWgBRyLToCMZBDuRQFTuHqp8cx0SOJNDBaBgNVHR8EUzBRME+gTaBLhklodHRwOi8vY3JsLm1pY3Jvc29mdC5jb20vcGtpL2NybC9wcm9kdWN0cy9NaWNSb29DZXJBdXQyMDExXzIwMTFfMDNfMjIuY3JsMF4GCCsGAQUFBwEBBFIwUDBOBggrBgEFBQcwAoZCaHR0cDovL3d3dy5taWNyb3NvZnQuY29tL3BraS9jZXJ0cy9NaWNSb29DZXJBdXQyMDExXzIwMTFfMDNfMjIuY3J0MIGfBgNVHSAEgZcwgZQwgZEGCSsGAQQBgjcuAzCBgzA/BggrBgEFBQcCARYzaHR0cDovL3d3dy5taWNyb3NvZnQuY29tL3BraW9wcy9kb2NzL3ByaW1hcnljcHMuaHRtMEAGCCsGAQUFBwICMDQeMiAdAEwAZQBnAGEAbABfAHAAbwBsAGkAYwB5AF8AcwB0AGEAdABlAG0AZQBuAHQALiAdMA0GCSqGSIb3DQEBCwUAA4ICAQBn8oalmOBUeRou09h0ZyKbC5YR4WOSmUKWfdJ5DJDBZV8uLD74w3LRbYP+vj/oCso7v0epo/Np22O/IjWll11lhJB9i0ZQVdgMknzSGksc8zxCi1LQsP1r4z4HLimb5j0bpdS1HXeUOeLpZMlEPXh6I/MTfaaQdION9MsmAkYqwooQu6SpBQyb7Wj6aC6VoCo/KmtYSWMfCWluWpiW5IP0wI/zRive/DvQvTXvbiWu5a8n7dDd8w6vmSiXmE0OPQvyCInWH8MyGOLwxS3OW560STkKxgrCxq2u5bLZ2xWIUUVYODJxJxp/sfQn+N4sOiBpmLJZiWhub6e3dMNABQamASooPoI/E01mC8CzTfXhj38cbxV9Rad25UAqZaPDXVJihsMdYzaXht/a8/jyFqGaJ+HNpZfQ7l1jQeNbB5yHPgZ3BtEGsXUfFL5hYbXw3MYbBL7fQccOKO7eZS/sl/ahXJbYANahRr1Z85elCUtIEJmAH9AAKcWxm6U/RXceNcbSoqKfenoi+kiVH6v7RyOA9Z74v2u3S5fi63V4GuzqN5l5GEv/1rMjaHXmr/r8i+sLgOppO6/8MO0ETI7f33VtY5E90Z1WTk+/gFcioXgRMiF670EKsT/7qMykXcGhiJtXcVZOSEXAQsmbdlsKgEhr/Xmfwb1tbWrJUnMTDXpQzQ==</X509Certificate><X509Certificate>MIIF7TCCA9WgAwIBAgIQP4vItfyfspZDtWnWbELhRDANBgkqhkiG9w0BAQsFADCBiDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEyMDAGA1UEAxMpTWljcm9zb2Z0IFJvb3QgQ2VydGlmaWNhdGUgQXV0aG9yaXR5IDIwMTEwHhcNMTEwMzIyMjIwNTI4WhcNMzYwMzIyMjIxMzA0WjCBiDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEyMDAGA1UEAxMpTWljcm9zb2Z0IFJvb3QgQ2VydGlmaWNhdGUgQXV0aG9yaXR5IDIwMTEwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQCygEGqNThNE3IyaCJNuLLx/9VSvGzH9dJKjDbu0cJcfoyKrq8TKG/Ac+M6ztAlqFo6be+ouFmrEyNozQwph9FvgFyPRH9dkAFSWKxRxV8qh9zc2AodwQO5e7BW6KPeZGHCnvjzfLnsDbVU/ky2ZU+I8JxImQxCCwl8MVkXeQZ4KI2JOkwDJb5xalwL54RgpJki49KvhKSn+9GY7Qyp3pSJ4Q6g3MDOmT3qCFK7VnnkH4S6Hri0xElcTzFLh93dBWcmmYDgcRGjuKVB4qRTufcyKYMME782XgSzS0NHL2vikR7TmE/dQgfI6B0S/Jmpaz6SfsjWaTr8ZL22CZ3K/QwLopt3YEsDlKQwaRLWQi3BQUzK3Kr9j1uDRprZ/LHR47PJf0h6zSTwQY9cdNCssBAgBkm3xy0hyFfj0IbzA2j70M5xwYmZSmQBbP3sMJHPQTySx+W6hh1hhMdfgzlirrSSL0fzC/hV66AfWdC7dJse0Hbm8ukG1xDo+mTeacY1logC8Ea4PyeZb8txiSk190gWAjWP1Xl8TQLPX+uKg09FcYj5qQ1OcunCnAfPSRtOBA5jUYxe2ADBVSy2xuDCZU7JNDn1nLPEfuhhbhNfFcRf2X7tHc7uROzLLoax7Dj2cO2rXBPB2Q8Nx4CyVe0096yb5MPa50c8prWPMd/FS6/r8QIDAQABo1EwTzALBgNVHQ8EBAMCAYYwDwYDVR0TAQH/BAUwAwEB/zAdBgNVHQ4EFgQUci06AjGQQ7kUBU7h6qfHMdEjiTQwEAYJKwYBBAGCNxUBBAMCAQAwDQYJKoZIhvcNAQELBQADggIBAH9yzw+3xRXbm8BJyiZb/p4T5tPw0tuXX/JLP02zrhmu7deXoKzvqTqjwkGw5biRnhOBJAPmCf0/V0A5ISRW0RAvS0CpNoZLtFNXmvvxfomPEf4YbFGq6O0JlbXlccmh6Yd1phV/yX43VF50k8XDZ8wNT2uoFwxtCJJ+i92Bqi1wIcM9BhS7vyRep4TXPw8hIr1LAAbblxzYXtTFC1yHblCk6MM4pPvLLMWSZpuFXst6bJN8gClYW1e1QGm6CHmmZGIVnYeWRbVmIyADixxzoNOieTPgUFmG2y/lAiXqcyqfABTINseSO+lOAOzYVgm5M0kS0lQLAausR7aRKX1MtHWAUgHoyoL2n8ysnI8X6i8msKtyrAv+nlEex0NVZ09Rs1fWtuzuUrc66U7h14GIvE+OdbtLqPA1qibUZ2dJsnBMO5PcHd94kIZysjik0dySTclY6ysSXNQ7roxrsIPlAT/4CTL2kzU0Iq/dNw13CYArzUgA8YyZGUcFAenRv9FO0OYoQzeZpApKCNmacXPSqs0xE2N2oTdvkjgefRI8ZjLny23h/FKJ3crWZgWalmG+oijHHKOnNlA8OqTfSm7mhzvO6/DggTedEzxSjr25HTTGHdUKaj2YKXCMiSrRq4IQSB/c9O+lxbtVGjhjhE63bK2VVOxlIhBJF7jAHscPrFRH</X509Certificate></X509Data></KeyInfo><Object Id="ts-countersig"><X509Data><X509Certificate>MIIHEDCCBPigAwIBAgITMwAAAa6qC1yzNKWVGgABAAABrjANBgkqhkiG9w0BAQsFADB8MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSYwJAYDVQQDEx1NaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0EgMjAxMDAeFw0yMjAzMDIxODUxMzdaFw0yMzA1MTExODUxMzdaMIHOMQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSkwJwYDVQQLEyBNaWNyb3NvZnQgT3BlcmF0aW9ucyBQdWVydG8gUmljbzEmMCQGA1UECxMdVGhhbGVzIFRTUyBFU046Rjg3QS1FMzc0LUQ3QjkxJTAjBgNVBAMTHE1pY3Jvc29mdCBUaW1lLVN0YW1wIFNlcnZpY2UwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQCTjBrxITUMCx2nLc5z6WPCYOaiPELIKdJoZdhts7VT6J6uILDjHubvaeX9ezyDNSl41GijZd3Y53KtvS4qpqp2ijkYIDxzRJO0PrWpeSMnPkvJP0d9YAhreKr0FagS0DYr8TrpFH2qRuNS03Sx3jOLsCJ5PkKxkB9iuMIzbYlKYqxdj3QnG5F8gCxKck9ka8MyZs3Jm3QrHGNDd0R8azHlkN5O7DbeNTQWTk/uKQppMPFJICokiVzMyrN/DMVKsfzpUvNHSw0x3fmXotUtf6mwrUxszZtG4+qn5JVDNyRQBdSS18ML6oGUXQ0FOttuMLRp8GpU2jiNEdHl/nK3D6VxgduxCIGFPtJaNmh+/Uja7D1hHHQSAndMn4RVNp4lSXqRs5F3rSb2xcVt4je7HIy38P0ulFxe8LRM3TjV1YiOT9lDO+/T+hCGfoPNRNjFl/F4y1cryLL88nJCeBRYvodcjxPr83JD8cxzrIi2mn7nLMjIwGgDPFsGvtNgboxDspXy0spNIr/SL0iPWZCVv4C70ONlNPlNN+WYVIQqmyhFhDCK9smtq2Ka1DBCnF3+Efey1TwX7CZ25DVLm6VAOCtYu4o0NaZFJbfmEP9+JrRMu3kooFaVc56n6zVXqwrxxuSMH3hVYTzWwMCupQRENvZzGI0V4+EC8r5ikZqjiTP8NQIDAQABo4IBNjCCATIwHQYDVR0OBBYEFNMwb9+/KGCKwamtdP787WQ6YVHuMB8GA1UdIwQYMBaAFJ+nFV0AXmJdg/Tl0mWnG1M1GelyMF8GA1UdHwRYMFYwVKBSoFCGTmh0dHA6Ly93d3cubWljcm9zb2Z0LmNvbS9wa2lvcHMvY3JsL01pY3Jvc29mdCUyMFRpbWUtU3RhbXAlMjBQQ0ElMjAyMDEwKDEpLmNybDBsBggrBgEFBQcBAQRgMF4wXAYIKwYBBQUHMAKGUGh0dHA6Ly93d3cubWljcm9zb2Z0LmNvbS9wa2lvcHMvY2VydHMvTWljcm9zb2Z0JTIwVGltZS1TdGFtcCUyMFBDQSUyMDIwMTAoMSkuY3J0MAwGA1UdEwEB/wQCMAAwEwYDVR0lBAwwCgYIKwYBBQUHAwgwDQYJKoZIhvcNAQELBQADggIBAF2/kfD9VQBEDjytMwMQAyFz+HCUJmq7Y1RSzBJC2Id/TxbVW7fOEb9ENRkk2JoT/H/zjr55guXo8NzXNVUYu+K1hlCE79fFqq/HgbwEneHgwMRWwPJJzjpv2ckpDAw2HW+u9/GkNMr6n+wFnIYD57QnP54TWqUiZo81JHuxL4wfHotAZ2NMZfgEHEsSRv1Z7JvSMDnq/BNZolS2Hz5/XyA3Wmr9W6vYvoJ2X9YUu2qRqcW4rQia9Shg+IyMgAZMR4XqDzoYbUJtbs5xO25SsR/KVO1tgPnqoILDZDN1QdJ680WQapuEpgUjYTj88t6Hzpi3ESv2paDgK+p3oYvIuZYZk4NS5DgMQoS8B75bogmPSvtryKbePIqCv4frc+UYFXW/kvMcJ+9vJTfCj5JAdkWuYonK77YAOecElHYehRcV8Xkvm7IAWsp+2cmn06QzOwUDgWMGqHbLlX+V4Bq8hsfOJOEefJj8Ad0NPQkQBrN+TTrek6z16nMpTbumc/MU0A3GiaeeKSsjqFuYiAxY6S53l0xI7VghQoAKOM26fQjSE6feyj53N4GVWjLxKVPEqe1WcDfXJEdlgysjow4ISHH7hSUyznZDrjCxrFj3Z2OonbVnNm1A0GtkG85jUmchbYRKa8ENhpoGhmxirmFValI/2LdtRw9DwXgyOTGpfEnM</X509Certificate><X509Certificate>MIIHcTCCBVmgAwIBAgITMwAAABXF52ueAptJmQAAAAAAFTANBgkqhkiG9w0BAQsFADCBiDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEyMDAGA1UEAxMpTWljcm9zb2Z0IFJvb3QgQ2VydGlmaWNhdGUgQXV0aG9yaXR5IDIwMTAwHhcNMjEwOTMwMTgyMjI1WhcNMzAwOTMwMTgzMjI1WjB8MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSYwJAYDVQQDEx1NaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0EgMjAxMDCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAOThpkzntHIhC3miy9ckeb0O1YLT/e6cBwfSqWxOdcjKNVf2AX9sSuDivbk+F2Az/1xPx2b3lVNxWuJ+Slr+uDZnhUYjDLWNE893MsAQGOhgfWpSg0S3po5GawcU88V29YZQ3MFEyHFcUTE3oAo4bo3t1w/YJlN8OWECesSq/XJprx2rrPY2vjUmZNqYO7oaezOtgFt+jBAcnVL+tuhiJdxqD89d9P6OU8/W7IVWTe/dvI2k45GPsjksUZzpcGkNyjYtcI4xyDUoveO0hyTD4MmPfrVUj9z6BVWYbWg7mka97aSueik3rMvrg0XnRm7KMtXAhjBcTyziYrLNueKNiOSWrAFKu75xqRdbZ2De+JKRHh09/SDPc31BmkZ1zcRfNN0Sidb9pSB9fvzZnkXftnIv231fgLrbqn427DZM9ituqBJR6L8FA6PRc6ZNN3SUHDSCD/AQ8rdHGO2n6Jl8P0zbr17C89XYcz1DTsEzOUyOArxCaC4Q6oRRRuLRvWoYWmEBc8pnol7XKHYC4jMYctenIPDC+hIK12NvDMk2ZItboKaDIV1fMHSRlJTYuVD5C4lh8zYGNRiER9vcG9H9stQcxWv2XFJRXRLbJbqvUAV6bMURHXLvjflSxIUXk8A8FdsaN8cIFRg/eKtFtvUeh17aj54WcmnGrnu3tz5q4i6tAgMBAAGjggHdMIIB2TASBgkrBgEEAYI3FQEEBQIDAQABMCMGCSsGAQQBgjcVAgQWBBQqp1L+ZMSavoKRPEY1Kc8Q/y8E7jAdBgNVHQ4EFgQUn6cVXQBeYl2D9OXSZacbUzUZ6XIwXAYDVR0gBFUwUzBRBgwrBgEEAYI3TIN9AQEwQTA/BggrBgEFBQcCARYzaHR0cDovL3d3dy5taWNyb3NvZnQuY29tL3BraW9wcy9Eb2NzL1JlcG9zaXRvcnkuaHRtMBMGA1UdJQQMMAoGCCsGAQUFBwMIMBkGCSsGAQQBgjcUAgQMHgoAUwB1AGIAQwBBMAsGA1UdDwQEAwIBhjAPBgNVHRMBAf8EBTADAQH/MB8GA1UdIwQYMBaAFNX2VsuP6KJcYmjRPZSQW9fOmhjEMFYGA1UdHwRPME0wS6BJoEeGRWh0dHA6Ly9jcmwubWljcm9zb2Z0LmNvbS9wa2kvY3JsL3Byb2R1Y3RzL01pY1Jvb0NlckF1dF8yMDEwLTA2LTIzLmNybDBaBggrBgEFBQcBAQROMEwwSgYIKwYBBQUHMAKGPmh0dHA6Ly93d3cubWljcm9zb2Z0LmNvbS9wa2kvY2VydHMvTWljUm9vQ2VyQXV0XzIwMTAtMDYtMjMuY3J0MA0GCSqGSIb3DQEBCwUAA4ICAQCdVX38Kq3hLB9nATEkW+Geckv8qW/qXBS2Pk5HZHixBpOXPTEztTnXwnE2P9pkbHzQdTltuw8x5MKP+2zRoZQYIu7pZmc6U03dmLq2HnjYNi6cqYJWAAOwBb6J6Gngugnue99qb74py27YP0h1AdkY3m2CDPVtI1TkeFN1JFe53Z/zjj3G82jfZfakVqr3lbYoVSfQJL1AoL8ZthISEV09J+BAljis9/kpicO8F7BUhUKz/AyeixmJ5/ALaoHCgRlCGVJ1ijbCHcNhcy4sa3tuPywJeBTpkbKpW99Jo3QMvOyRgNI95ko+ZjtPu4b6MhrZlvSP9pEB9s7GdP32THJvEKt1MMU0sHrYUP4KWN1APMdUbZ1jdEgssU5HLcEUBHG/ZPkkvnNtyo4JvbMBV0lUZNlz138eW0QBjloZkWsNn6Qo3GcZKCS6OEuabvshVGtqRRFHqfG3rsjoiV5PndLQTHa1V1QJsWkBRH58oWFsc/4Ku+xBZj1p/cvBQUl+fpO+y/g75LcVv7TOPqUxUYS8vwLBgqJ7Fx0ViY1w/ue10CgaiQuPNtq6TPmb/wrpNPgkNWcr4A245oyZ1uEi6vAnQj0llOZ0dFtq0Z4+7X6gMTN9vMvpe784cETRkPHIqzqKOghif9lwY1NNje6CbaUFEMFxBmoQtB1VM1izoXBm8g==</X509Certificate></X509Data><CounterSignature ts-format="cms-timestamp-message" xmlns="http://schemas.microsoft.com/xmldsig/timestamp/2003">MIAGCSqGSIb3DQEHAqCAMIIW4QIBAzEPMA0GCWCGSAFlAwQCAQUAMIIBVQYLKoZIhvcNAQkQAQSgggFEBIIBQDCCATwCAQEGCisGAQQBhFkKAwEwMTANBglghkgBZQMEAgEFAAQgKRwbyqbm4Bb3tvPxeFXUPsnV4S+KZyKNMSBq3jVQdnQCBmMRWQ/5jxgTMjAyMjA5MDkyMzE3NTQuOTM1WjAEgAIB9KCB1KSB0TCBzjELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEpMCcGA1UECxMgTWljcm9zb2Z0IE9wZXJhdGlvbnMgUHVlcnRvIFJpY28xJjAkBgNVBAsTHVRoYWxlcyBUU1MgRVNOOkY4N0EtRTM3NC1EN0I5MSUwIwYDVQQDExxNaWNyb3NvZnQgVGltZS1TdGFtcCBTZXJ2aWNloIIRXzCCBxAwggT4oAMCAQICEzMAAAGuqgtcszSllRoAAQAAAa4wDQYJKoZIhvcNAQELBQAwfDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEmMCQGA1UEAxMdTWljcm9zb2Z0IFRpbWUtU3RhbXAgUENBIDIwMTAwHhcNMjIwMzAyMTg1MTM3WhcNMjMwNTExMTg1MTM3WjCBzjELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEpMCcGA1UECxMgTWljcm9zb2Z0IE9wZXJhdGlvbnMgUHVlcnRvIFJpY28xJjAkBgNVBAsTHVRoYWxlcyBUU1MgRVNOOkY4N0EtRTM3NC1EN0I5MSUwIwYDVQQDExxNaWNyb3NvZnQgVGltZS1TdGFtcCBTZXJ2aWNlMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAk4wa8SE1DAsdpy3Oc+ljwmDmojxCyCnSaGXYbbO1U+ieriCw4x7m72nl/Xs8gzUpeNRoo2Xd2Odyrb0uKqaqdoo5GCA8c0STtD61qXkjJz5LyT9HfWAIa3iq9BWoEtA2K/E66RR9qkbjUtN0sd4zi7AieT5CsZAfYrjCM22JSmKsXY90JxuRfIAsSnJPZGvDMmbNyZt0KxxjQ3dEfGsx5ZDeTuw23jU0Fk5P7ikKaTDxSSAqJIlczMqzfwzFSrH86VLzR0sNMd35l6LVLX+psK1MbM2bRuPqp+SVQzckUAXUktfDC+qBlF0NBTrbbjC0afBqVNo4jRHR5f5ytw+lcYHbsQiBhT7SWjZofv1I2uw9YRx0EgJ3TJ+EVTaeJUl6kbORd60m9sXFbeI3uxyMt/D9LpRcXvC0TN041dWIjk/ZQzvv0/oQhn6DzUTYxZfxeMtXK8iy/PJyQngUWL6HXI8T6/NyQ/HMc6yItpp+5yzIyMBoAzxbBr7TYG6MQ7KV8tLKTSK/0i9Ij1mQlb+Au9DjZTT5TTflmFSEKpsoRYQwivbJratimtQwQpxd/hH3stU8F+wmduQ1S5ulQDgrWLuKNDWmRSW35hD/fia0TLt5KKBWlXOep+s1V6sK8cbkjB94VWE81sDArqUERDb2cxiNFePhAvK+YpGao4kz/DUCAwEAAaOCATYwggEyMB0GA1UdDgQWBBTTMG/fvyhgisGprXT+/O1kOmFR7jAfBgNVHSMEGDAWgBSfpxVdAF5iXYP05dJlpxtTNRnpcjBfBgNVHR8EWDBWMFSgUqBQhk5odHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20vcGtpb3BzL2NybC9NaWNyb3NvZnQlMjBUaW1lLVN0YW1wJTIwUENBJTIwMjAxMCgxKS5jcmwwbAYIKwYBBQUHAQEEYDBeMFwGCCsGAQUFBzAChlBodHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20vcGtpb3BzL2NlcnRzL01pY3Jvc29mdCUyMFRpbWUtU3RhbXAlMjBQQ0ElMjAyMDEwKDEpLmNydDAMBgNVHRMBAf8EAjAAMBMGA1UdJQQMMAoGCCsGAQUFBwMIMA0GCSqGSIb3DQEBCwUAA4ICAQBdv5Hw/VUARA48rTMDEAMhc/hwlCZqu2NUUswSQtiHf08W1Vu3zhG/RDUZJNiaE/x/846+eYLl6PDc1zVVGLvitYZQhO/Xxaqvx4G8BJ3h4MDEVsDySc46b9nJKQwMNh1vrvfxpDTK+p/sBZyGA+e0Jz+eE1qlImaPNSR7sS+MHx6LQGdjTGX4BBxLEkb9Weyb0jA56vwTWaJUth8+f18gN1pq/Vur2L6Cdl/WFLtqkanFuK0ImvUoYPiMjIAGTEeF6g86GG1CbW7OcTtuUrEfylTtbYD56qCCw2QzdUHSevNFkGqbhKYFI2E4/PLeh86YtxEr9qWg4Cvqd6GLyLmWGZODUuQ4DEKEvAe+W6IJj0r7a8im3jyKgr+H63PlGBV1v5LzHCfvbyU3wo+SQHZFrmKJyu+2ADnnBJR2HoUXFfF5L5uyAFrKftnJp9OkMzsFA4FjBqh2y5V/leAavIbHziThHnyY/AHdDT0JEAazfk063pOs9epzKU27pnPzFNANxomnnikrI6hbmIgMWOkud5dMSO1YIUKACjjNun0I0hOn3so+dzeBlVoy8SlTxKntVnA31yRHZYMrI6MOCEhx+4UlMs52Q64wsaxY92djqJ21ZzZtQNBrZBvOY1JnIW2ESmvBDYaaBoZsYq5hVWpSP9i3bUcPQ8F4MjkxqXxJzDCCB3EwggVZoAMCAQICEzMAAAAVxedrngKbSZkAAAAAABUwDQYJKoZIhvcNAQELBQAwgYgxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpXYXNoaW5ndG9uMRAwDgYDVQQHEwdSZWRtb25kMR4wHAYDVQQKExVNaWNyb3NvZnQgQ29ycG9yYXRpb24xMjAwBgNVBAMTKU1pY3Jvc29mdCBSb290IENlcnRpZmljYXRlIEF1dGhvcml0eSAyMDEwMB4XDTIxMDkzMDE4MjIyNVoXDTMwMDkzMDE4MzIyNVowfDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEmMCQGA1UEAxMdTWljcm9zb2Z0IFRpbWUtU3RhbXAgUENBIDIwMTAwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQDk4aZM57RyIQt5osvXJHm9DtWC0/3unAcH0qlsTnXIyjVX9gF/bErg4r25PhdgM/9cT8dm95VTcVrifkpa/rg2Z4VGIwy1jRPPdzLAEBjoYH1qUoNEt6aORmsHFPPFdvWGUNzBRMhxXFExN6AKOG6N7dcP2CZTfDlhAnrEqv1yaa8dq6z2Nr41JmTamDu6GnszrYBbfowQHJ1S/rboYiXcag/PXfT+jlPP1uyFVk3v3byNpOORj7I5LFGc6XBpDco2LXCOMcg1KL3jtIckw+DJj361VI/c+gVVmG1oO5pGve2krnopN6zL64NF50ZuyjLVwIYwXE8s4mKyzbnijYjklqwBSru+cakXW2dg3viSkR4dPf0gz3N9QZpGdc3EXzTdEonW/aUgfX782Z5F37ZyL9t9X4C626p+Nuw2TPYrbqgSUei/BQOj0XOmTTd0lBw0gg/wEPK3Rxjtp+iZfD9M269ewvPV2HM9Q07BMzlMjgK8QmguEOqEUUbi0b1qGFphAXPKZ6Je1yh2AuIzGHLXpyDwwvoSCtdjbwzJNmSLW6CmgyFdXzB0kZSU2LlQ+QuJYfM2BjUYhEfb3BvR/bLUHMVr9lxSUV0S2yW6r1AFemzFER1y7435UsSFF5PAPBXbGjfHCBUYP3irRbb1Hode2o+eFnJpxq57t7c+auIurQIDAQABo4IB3TCCAdkwEgYJKwYBBAGCNxUBBAUCAwEAATAjBgkrBgEEAYI3FQIEFgQUKqdS/mTEmr6CkTxGNSnPEP8vBO4wHQYDVR0OBBYEFJ+nFV0AXmJdg/Tl0mWnG1M1GelyMFwGA1UdIARVMFMwUQYMKwYBBAGCN0yDfQEBMEEwPwYIKwYBBQUHAgEWM2h0dHA6Ly93d3cubWljcm9zb2Z0LmNvbS9wa2lvcHMvRG9jcy9SZXBvc2l0b3J5Lmh0bTATBgNVHSUEDDAKBggrBgEFBQcDCDAZBgkrBgEEAYI3FAIEDB4KAFMAdQBiAEMAQTALBgNVHQ8EBAMCAYYwDwYDVR0TAQH/BAUwAwEB/zAfBgNVHSMEGDAWgBTV9lbLj+iiXGJo0T2UkFvXzpoYxDBWBgNVHR8ETzBNMEugSaBHhkVodHRwOi8vY3JsLm1pY3Jvc29mdC5jb20vcGtpL2NybC9wcm9kdWN0cy9NaWNSb29DZXJBdXRfMjAxMC0wNi0yMy5jcmwwWgYIKwYBBQUHAQEETjBMMEoGCCsGAQUFBzAChj5odHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20vcGtpL2NlcnRzL01pY1Jvb0NlckF1dF8yMDEwLTA2LTIzLmNydDANBgkqhkiG9w0BAQsFAAOCAgEAnVV9/Cqt4SwfZwExJFvhnnJL/Klv6lwUtj5OR2R4sQaTlz0xM7U518JxNj/aZGx80HU5bbsPMeTCj/ts0aGUGCLu6WZnOlNN3Zi6th542DYunKmCVgADsAW+iehp4LoJ7nvfam++Kctu2D9IdQHZGN5tggz1bSNU5HhTdSRXud2f8449xvNo32X2pFaq95W2KFUn0CS9QKC/GbYSEhFdPSfgQJY4rPf5KYnDvBewVIVCs/wMnosZiefwC2qBwoEZQhlSdYo2wh3DYXMuLGt7bj8sCXgU6ZGyqVvfSaN0DLzskYDSPeZKPmY7T7uG+jIa2Zb0j/aRAfbOxnT99kxybxCrdTDFNLB62FD+CljdQDzHVG2dY3RILLFORy3BFARxv2T5JL5zbcqOCb2zAVdJVGTZc9d/HltEAY5aGZFrDZ+kKNxnGSgkujhLmm77IVRrakURR6nxt67I6IleT53S0Ex2tVdUCbFpAUR+fKFhbHP+CrvsQWY9af3LwUFJfn6Tvsv4O+S3Fb+0zj6lMVGEvL8CwYKiexcdFYmNcP7ntdAoGokLjzbaukz5m/8K6TT4JDVnK+ANuOaMmdbhIurwJ0I9JZTmdHRbatGePu1+oDEzfbzL6Xu/OHBE0ZDxyKs6ijoIYn/ZcGNTTY3ugm2lBRDBcQZqELQdVTNYs6FwZvKhggLSMIICOwIBATCB/KGB1KSB0TCBzjELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEpMCcGA1UECxMgTWljcm9zb2Z0IE9wZXJhdGlvbnMgUHVlcnRvIFJpY28xJjAkBgNVBAsTHVRoYWxlcyBUU1MgRVNOOkY4N0EtRTM3NC1EN0I5MSUwIwYDVQQDExxNaWNyb3NvZnQgVGltZS1TdGFtcCBTZXJ2aWNloiMKAQEwBwYFKw4DAhoDFQC8mrCT/GfJyBXkZ3LlvgjAT9Na46CBgzCBgKR+MHwxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpXYXNoaW5ndG9uMRAwDgYDVQQHEwdSZWRtb25kMR4wHAYDVQQKExVNaWNyb3NvZnQgQ29ycG9yYXRpb24xJjAkBgNVBAMTHU1pY3Jvc29mdCBUaW1lLVN0YW1wIFBDQSAyMDEwMA0GCSqGSIb3DQEBBQUAAgUA5sW6ozAiGA8yMDIyMDkwOTE3MTQxMVoYDzIwMjIwOTEwMTcxNDExWjB3MD0GCisGAQQBhFkKBAExLzAtMAoCBQDmxbqjAgEAMAoCAQACAgG7AgH/MAcCAQACAhEfMAoCBQDmxwwjAgEAMDYGCisGAQQBhFkKBAIxKDAmMAwGCisGAQQBhFkKAwKgCjAIAgEAAgMHoSChCjAIAgEAAgMBhqAwDQYJKoZIhvcNAQEFBQADgYEAIM21ibTx4gjQLYcXEnxHdxsJykTAu8HUO/bVC2686orV94NQrnYawlEC7ZfbKHUyGF8GpRDzYHcXEsh5nFH8bS4/O3g4KwEaQhb2KXMr/0tx3l7fO9KC+Dn/a3cFVt4EZPS1ZVGxmxQTiLkxqkNyYr5C6DMua4/z4x7A0RTAZEMxggQNMIIECQIBATCBkzB8MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSYwJAYDVQQDEx1NaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0EgMjAxMAITMwAAAa6qC1yzNKWVGgABAAABrjANBglghkgBZQMEAgEFAKCCAUowGgYJKoZIhvcNAQkDMQ0GCyqGSIb3DQEJEAEEMC8GCSqGSIb3DQEJBDEiBCCFoVZYWFtP6fuOBOKq4YM3ExDbJmBxdRcM2WvGKiPhBTCB+gYLKoZIhvcNAQkQAi8xgeowgecwgeQwgb0EIEkoHT64jMNaoe6fT2apNTy46Dq17DTK7W5DSJT8Um9oMIGYMIGApH4wfDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEmMCQGA1UEAxMdTWljcm9zb2Z0IFRpbWUtU3RhbXAgUENBIDIwMTACEzMAAAGuqgtcszSllRoAAQAAAa4wIgQgtcvxC4vF/99J/vzy+njnoNKWdqkqUm6vsKnowpm8zOAwDQYJKoZIhvcNAQELBQAEggIAPApnbswWiYPBK70hQn6fVaDG5ouoHn+DMCuL525QU6q8Moa9Dq8iXsS6V1Dl+l7YmWStihI4ZLXmqbzaOlxBS5qKZbYY/9gng0RWKt8rdR1b561h3ejEz/siXPgXEy5ERMsZqEB/xmg5OwrEt6S5o/J5l4BQChUZnK33uW9OczPx30Rjtkg4JK5dGKGeU6kcjYZCB46oCba/UJxYBQ9fkiKR5q6mtd8xu64ok6u6CA30sIQqEVnZysD0TW6FXA+T20qSRbY5teWf/uETHUkkny3M9fDSUuNKxrM++n6xjKpl5bh2RmVKGxvgsjSLbDe8nRoDsdgcOUeBSTYsttbcTlXuKvxHOkfdDAjoDu1476z8gleVW6A5LcbVxF3kQZXgGdq+mLo79Tn7+H2ACnhvLNa7Cf89VrdkBEZ/Gw066NQNeG0zwjgb2Phv5fMDTQu9EROMDg0A56En1DkCt+4eh2Cs9f9n6HGABHsr7HdpXjPXN5IGKKkwhxDvD2Iq/zSYscZQv6z1CsncUmFO53LfrDYF1La+mQvjeET2izV66iNTFrR7oU+yGITSP45fbRoOThgcm+jkmqiziFkyuUuEYp1nYBCpJEO6IN4aQP9kEPXFe2JUIyJpZ/YDFwKLwtKK4MuGXNAfn8uTSjoA0TjJTCGrXhWikbevEA9gXLCdDG4AAAAA</CounterSignature></Object></Signature></doc>
md5: EE32945E7ADD9CD2598516BFCCA3E0E7 | sha1: AE47BF31DE116E3D22F46438C179F612C9118068 | sha256: 0308C50E0E3561A1899ED420F46D8380E0DF8F170EADDCD9833A6480D3BAD9B9 | sha512: 54246FD1D26516D3E6800F079138B7E8F26234E83A6C29474EF721CA3292D0ECB4508A9BF73274B10A9ABA44D0E679CBE87CB095C0656261F5328EA05279657A
<?xml version="1.0"?>
<doc>
<assembly>
<name>NuGet.Versioning</name>
</assembly>
<members>
<member name="T:NuGet.Versioning.FloatRange">
<summary>
The floating subset of a version range.
</summary>
</member>
<member name="M:NuGet.Versioning.FloatRange.#ctor(NuGet.Versioning.NuGetVersionFloatBehavior)">
<summary>
Create a floating range.
</summary>
<param name="floatBehavior">Section to float.</param>
</member>
<member name="M:NuGet.Versioning.FloatRange.#ctor(NuGet.Versioning.NuGetVersionFloatBehavior,NuGet.Versioning.NuGetVersion)">
<summary>
Create a floating range.
</summary>
<param name="floatBehavior">Section to float.</param>
<param name="minVersion">Min version of the range.</param>
</member>
<member name="M:NuGet.Versioning.FloatRange.#ctor(NuGet.Versioning.NuGetVersionFloatBehavior,NuGet.Versioning.NuGetVersion,System.String)">
<summary>
FloatRange
</summary>
<param name="floatBehavior">Section to float.</param>
<param name="minVersion">Min version of the range.</param>
<param name="releasePrefix">The original release label. Invalid labels are allowed here.</param>
</member>
<member name="P:NuGet.Versioning.FloatRange.HasMinVersion">
<summary>
True if a min range exists.
</summary>
</member>
<member name="P:NuGet.Versioning.FloatRange.MinVersion">
<summary>
The minimum version of the float range. This is null for cases such as *
</summary>
</member>
<member name="P:NuGet.Versioning.FloatRange.FloatBehavior">
<summary>
Defined float behavior
</summary>
</member>
<member name="P:NuGet.Versioning.FloatRange.OriginalReleasePrefix">
<summary>
The original release label. Invalid labels are allowed here.
</summary>
</member>
<member name="M:NuGet.Versioning.FloatRange.Satisfies(NuGet.Versioning.NuGetVersion)">
<summary>
True if the given version falls into the floating range.
</summary>
</member>
<member name="M:NuGet.Versioning.FloatRange.Parse(System.String)">
<summary>
Parse a floating version into a FloatRange
</summary>
</member>
<member name="M:NuGet.Versioning.FloatRange.TryParse(System.String,NuGet.Versioning.FloatRange@)">
<summary>
Parse a floating version into a FloatRange
</summary>
</member>
<member name="M:NuGet.Versioning.FloatRange.ToString">
<summary>
Create a floating version string in the format: 1.0.0-alpha-*
</summary>
</member>
<member name="M:NuGet.Versioning.FloatRange.Equals(NuGet.Versioning.FloatRange)">
<summary>
Equals
</summary>
</member>
<member name="M:NuGet.Versioning.FloatRange.Equals(System.Object)">
<summary>
Override Object.Equals
</summary>
<param name="obj"></param>
<returns></returns>
</member>
<member name="M:NuGet.Versioning.FloatRange.GetHashCode">
<summary>
Hash code
</summary>
</member>
<member name="T:NuGet.Versioning.INuGetVersionable">
<summary>
An item that exposes a NuGetVersion
</summary>
</member>
<member name="P:NuGet.Versioning.INuGetVersionable.Version">
<summary>
NuGet semantic version
</summary>
</member>
<member name="T:NuGet.Versioning.IVersionComparer">
<summary>
IVersionComparer represents a version comparer capable of sorting and determining the equality of
SemanticVersion objects.
</summary>
</member>
<member name="T:NuGet.Versioning.IVersionRangeComparer">
<summary>
Version range comparer
</summary>
</member>
<member name="T:NuGet.Versioning.NuGetVersion">
<summary>
A hybrid implementation of SemVer that supports semantic versioning as described at http://semver.org while
not strictly enforcing it to
allow older 4-digit versioning schemes to continue working.
</summary>
</member>
<member name="M:NuGet.Versioning.NuGetVersion.#ctor(System.String)">
<summary>
Creates a NuGetVersion using NuGetVersion.Parse(string)
</summary>
<param name="version">Version string</param>
</member>
<member name="M:NuGet.Versioning.NuGetVersion.#ctor(NuGet.Versioning.NuGetVersion)">
<summary>
Creates a NuGetVersion from an existing NuGetVersion
</summary>
</member>
<member name="M:NuGet.Versioning.NuGetVersion.#ctor(System.Version,System.String,System.String)">
<summary>
Creates a NuGetVersion from a .NET Version
</summary>
<param name="version">Version numbers</param>
<param name="releaseLabel">Prerelease label</param>
<param name="metadata">Build metadata</param>
</member>
<member name="M:NuGet.Versioning.NuGetVersion.#ctor(System.Int32,System.Int32,System.Int32)">
<summary>
Creates a NuGetVersion X.Y.Z
</summary>
<param name="major">X.y.z</param>
<param name="minor">x.Y.z</param>
<param name="patch">x.y.Z</param>
</member>
<member name="M:NuGet.Versioning.NuGetVersion.#ctor(System.Int32,System.Int32,System.Int32,System.String)">
<summary>
Creates a NuGetVersion X.Y.Z-alpha
</summary>
<param name="major">X.y.z</param>
<param name="minor">x.Y.z</param>
<param name="patch">x.y.Z</param>
<param name="releaseLabel">Prerelease label</param>
</member>
<member name="M:NuGet.Versioning.NuGetVersion.#ctor(System.Int32,System.Int32,System.Int32,System.String,System.String)">
<summary>
Creates a NuGetVersion X.Y.Z-alpha#build01
</summary>
<param name="major">X.y.z</param>
<param name="minor">x.Y.z</param>
<param name="patch">x.y.Z</param>
<param name="releaseLabel">Prerelease label</param>
<param name="metadata">Build metadata</param>
</member>
<member name="M:NuGet.Versioning.NuGetVersion.#ctor(System.Int32,System.Int32,System.Int32,System.Collections.Generic.IEnumerable{System.String},System.String)">
<summary>
Creates a NuGetVersion X.Y.Z-alpha.1.2#build01
</summary>
<param name="major">X.y.z</param>
<param name="minor">x.Y.z</param>
<param name="patch">x.y.Z</param>
<param name="releaseLabels">Prerelease labels</param>
<param name="metadata">Build metadata</param>
</member>
<member name="M:NuGet.Versioning.NuGetVersion.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)">
<summary>
Creates a NuGetVersion W.X.Y.Z
</summary>
<param name="major">W.x.y.z</param>
<param name="minor">w.X.y.z</param>
<param name="patch">w.x.Y.z</param>
<param name="revision">w.x.y.Z</param>
</member>
<member name="M:NuGet.Versioning.NuGetVersion.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.String,System.String)">
<summary>
Creates a NuGetVersion W.X.Y.Z-alpha#build01
</summary>
<param name="major">W.x.y.z</param>
<param name="minor">w.X.y.z</param>
<param name="patch">w.x.Y.z</param>
<param name="revision">w.x.y.Z</param>
<param name="releaseLabel">Prerelease label</param>
<param name="metadata">Build metadata</param>
</member>
<member name="M:NuGet.Versioning.NuGetVersion.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Collections.Generic.IEnumerable{System.String},System.String)">
<summary>
Creates a NuGetVersion W.X.Y.Z-alpha.1#build01
</summary>
<param name="major">W.x.y.z</param>
<param name="minor">w.X.y.z</param>
<param name="patch">w.x.Y.z</param>
<param name="revision">w.x.y.Z</param>
<param name="releaseLabels">Prerelease labels</param>
<param name="metadata">Build metadata</param>
</member>
<member name="M:NuGet.Versioning.NuGetVersion.#ctor(System.Version,System.Collections.Generic.IEnumerable{System.String},System.String,System.String)">
<summary>
Creates a NuGetVersion from a .NET Version with additional release labels, build metadata, and a
non-normalized version string.
</summary>
<param name="version">Version numbers</param>
<param name="releaseLabels">prerelease labels</param>
<param name="metadata">Build metadata</param>
<param name="originalVersion">Non-normalized original version string</param>
</member>
<member name="M:NuGet.Versioning.NuGetVersion.ToString">
<summary>
Returns the version string.
</summary>
<remarks>This method includes legacy behavior. Use ToNormalizedString() instead.</remarks>
<remarks>Versions with SemVer 2.0.0 components are automatically normalized.</remarks>
</member>
<member name="P:NuGet.Versioning.NuGetVersion.Version">
<summary>
A System.Version representation of the version without metadata or release labels.
</summary>
</member>
<member name="P:NuGet.Versioning.NuGetVersion.IsLegacyVersion">
<summary>
True if the NuGetVersion is using legacy behavior.
</summary>
</member>
<member name="P:NuGet.Versioning.NuGetVersion.Revision">
<summary>
Revision version R (x.y.z.R)
</summary>
</member>
<member name="P:NuGet.Versioning.NuGetVersion.IsSemVer2">
<summary>
Returns true if version is a SemVer 2.0.0 version
</summary>
</member>
<member name="P:NuGet.Versioning.NuGetVersion.OriginalVersion">
<summary>
Returns the original, non-normalized version string.
</summary>
</member>
<member name="M:NuGet.Versioning.NuGetVersion.Parse(System.String)">
<summary>
Creates a NuGetVersion from a string representing the semantic version.
</summary>
</member>
<member name="M:NuGet.Versioning.NuGetVersion.TryParse(System.String,NuGet.Versioning.NuGetVersion@)">
<summary>
Parses a version string using loose semantic versioning rules that allows 2-4 version components followed
by an optional special version.
</summary>
</member>
<member name="M:NuGet.Versioning.NuGetVersion.TryParseStrict(System.String,NuGet.Versioning.NuGetVersion@)">
<summary>
Parses a version string using strict SemVer rules.
</summary>
</member>
<member name="M:NuGet.Versioning.NuGetVersion.GetLegacyString(System.Version,System.Collections.Generic.IEnumerable{System.String},System.String)">
<summary>
Creates a legacy version string using System.Version
</summary>
</member>
<member name="T:NuGet.Versioning.NuGetVersionFloatBehavior">
<summary>
Specifies the floating behavior type.
</summary>
</member>
<member name="F:NuGet.Versioning.NuGetVersionFloatBehavior.None">
<summary>
Lowest version, no float
</summary>
</member>
<member name="F:NuGet.Versioning.NuGetVersionFloatBehavior.Prerelease">
<summary>
Highest matching pre-release label
</summary>
</member>
<member name="F:NuGet.Versioning.NuGetVersionFloatBehavior.Revision">
<summary>
x.y.z.*
</summary>
</member>
<member name="F:NuGet.Versioning.NuGetVersionFloatBehavior.Patch">
<summary>
x.y.*
</summary>
</member>
<member name="F:NuGet.Versioning.NuGetVersionFloatBehavior.Minor">
<summary>
x.*
</summary>
</member>
<member name="F:NuGet.Versioning.NuGetVersionFloatBehavior.Major">
<summary>
*
</summary>
</member>
<member name="F:NuGet.Versioning.NuGetVersionFloatBehavior.AbsoluteLatest">
<summary>
Float major and pre-release, *-*
</summary>
</member>
<member name="F:NuGet.Versioning.NuGetVersionFloatBehavior.PrereleaseRevision">
<summary>
Float revision and pre-release x.y.z.*-*
</summary>
</member>
<member name="F:NuGet.Versioning.NuGetVersionFloatBehavior.PrereleasePatch">
<summary>
Float patch and pre-release x.y.*-*
</summary>
</member>
<member name="F:NuGet.Versioning.NuGetVersionFloatBehavior.PrereleaseMinor">
<summary>
Float minor and pre-release x.*-*
</summary>
</member>
<member name="F:NuGet.Versioning.NuGetVersionFloatBehavior.PrereleaseMajor">
<summary>
Float major and prerelease, but only with partial prerelease *-rc.*.
*-* is captured by <see cref="F:NuGet.Versioning.NuGetVersionFloatBehavior.AbsoluteLatest" />
</summary>
</member>
<member name="T:NuGet.Versioning.Resources">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:NuGet.Versioning.Resources.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:NuGet.Versioning.Resources.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:NuGet.Versioning.Resources.Argument_Cannot_Be_Null_Or_Empty">
<summary>
Looks up a localized string similar to Value cannot be null or an empty string..
</summary>
</member>
<member name="P:NuGet.Versioning.Resources.Invalidvalue">
<summary>
Looks up a localized string similar to '{0}' is not a valid version string..
</summary>
</member>
<member name="T:NuGet.Versioning.SemanticVersion">
<summary>
A strict SemVer implementation
</summary>
<summary>
A base version operations
</summary>
</member>
<member name="M:NuGet.Versioning.SemanticVersion.#ctor(NuGet.Versioning.SemanticVersion)">
<summary>
Creates a SemanticVersion from an existing SemanticVersion
</summary>
<param name="version">Version to clone.</param>
</member>
<member name="M:NuGet.Versioning.SemanticVersion.#ctor(System.Int32,System.Int32,System.Int32)">
<summary>
Creates a SemanticVersion X.Y.Z
</summary>
<param name="major">X.y.z</param>
<param name="minor">x.Y.z</param>
<param name="patch">x.y.Z</param>
</member>
<member name="M:NuGet.Versioning.SemanticVersion.#ctor(System.Int32,System.Int32,System.Int32,System.String)">
<summary>
Creates a NuGetVersion X.Y.Z-alpha
</summary>
<param name="major">X.y.z</param>
<param name="minor">x.Y.z</param>
<param name="patch">x.y.Z</param>
<param name="releaseLabel">Prerelease label</param>
</member>
<member name="M:NuGet.Versioning.SemanticVersion.#ctor(System.Int32,System.Int32,System.Int32,System.String,System.String)">
<summary>
Creates a NuGetVersion X.Y.Z-alpha#build01
</summary>
<param name="major">X.y.z</param>
<param name="minor">x.Y.z</param>
<param name="patch">x.y.Z</param>
<param name="releaseLabel">Prerelease label</param>
<param name="metadata">Build metadata</param>
</member>
<member name="M:NuGet.Versioning.SemanticVersion.#ctor(System.Int32,System.Int32,System.Int32,System.Collections.Generic.IEnumerable{System.String},System.String)">
<summary>
Creates a NuGetVersion X.Y.Z-alpha.1.2#build01
</summary>
<param name="major">X.y.z</param>
<param name="minor">x.Y.z</param>
<param name="patch">x.y.Z</param>
<param name="releaseLabels">Release labels that have been split by the dot separator</param>
<param name="metadata">Build metadata</param>
</member>
<member name="M:NuGet.Versioning.SemanticVersion.#ctor(System.Version,System.String,System.String)">
<summary>
Internal constructor.
</summary>
<param name="version">Version</param>
<param name="releaseLabel">Full release label</param>
<param name="metadata">Build metadata</param>
</member>
<member name="M:NuGet.Versioning.SemanticVersion.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.String,System.String)">
<summary>
Internal constructor.
</summary>
<param name="major">X.y.z</param>
<param name="minor">x.Y.z</param>
<param name="patch">x.y.Z</param>
<param name="revision">x.y.z.R</param>
<param name="releaseLabel">Prerelease label</param>
<param name="metadata">Build metadata</param>
</member>
<member name="M:NuGet.Versioning.SemanticVersion.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Collections.Generic.IEnumerable{System.String},System.String)">
<summary>
Internal constructor.
</summary>
<param name="major"></param>
<param name="minor"></param>
<param name="patch"></param>
<param name="revision"></param>
<param name="releaseLabels"></param>
<param name="metadata"></param>
</member>
<member name="M:NuGet.Versioning.SemanticVersion.#ctor(System.Version,System.Collections.Generic.IEnumerable{System.String},System.String)">
<summary>
Internal constructor.
</summary>
<param name="version">Version</param>
<param name="releaseLabels">Release labels</param>
<param name="metadata">Build metadata</param>
</member>
<member name="P:NuGet.Versioning.SemanticVersion.Major">
<summary>
Major version X (X.y.z)
</summary>
</member>
<member name="P:NuGet.Versioning.SemanticVersion.Minor">
<summary>
Minor version Y (x.Y.z)
</summary>
</member>
<member name="P:NuGet.Versioning.SemanticVersion.Patch">
<summary>
Patch version Z (x.y.Z)
</summary>
</member>
<member name="P:NuGet.Versioning.SemanticVersion.ReleaseLabels">
<summary>
A collection of pre-release labels attached to the version.
</summary>
</member>
<member name="P:NuGet.Versioning.SemanticVersion.Release">
<summary>
The full pre-release label for the version.
</summary>
</member>
<member name="P:NuGet.Versioning.SemanticVersion.IsPrerelease">
<summary>
True if pre-release labels exist for the version.
</summary>
</member>
<member name="P:NuGet.Versioning.SemanticVersion.HasMetadata">
<summary>
True if metadata exists for the version.
</summary>
</member>
<member name="P:NuGet.Versioning.SemanticVersion.Metadata">
<summary>
Build metadata attached to the version.
</summary>
</member>
<member name="M:NuGet.Versioning.SemanticVersion.ToNormalizedString">
<summary>
Gives a normalized representation of the version.
This string is unique to the identity of the version and does not contain metadata.
</summary>
</member>
<member name="M:NuGet.Versioning.SemanticVersion.ToFullString">
<summary>
Gives a full representation of the version include metadata.
This string is not unique to the identity of the version. Other versions
that differ on metadata will have a different full string representation.
</summary>
</member>
<member name="M:NuGet.Versioning.SemanticVersion.ToString">
<summary>
Get the normalized string.
</summary>
</member>
<member name="M:NuGet.Versioning.SemanticVersion.ToString(System.String,System.IFormatProvider)">
<summary>
Custom string format.
</summary>
</member>
<member name="M:NuGet.Versioning.SemanticVersion.TryFormatter(System.String,System.IFormatProvider,System.String@)">
<summary>
Internal string formatter.
</summary>
</member>
<member name="M:NuGet.Versioning.SemanticVersion.GetHashCode">
<summary>
Hash code
</summary>
</member>
<member name="M:NuGet.Versioning.SemanticVersion.CompareTo(System.Object)">
<summary>
Object compare.
</summary>
</member>
<member name="M:NuGet.Versioning.SemanticVersion.CompareTo(NuGet.Versioning.SemanticVersion)">
<summary>
Compare to another SemanticVersion.
</summary>
</member>
<member name="M:NuGet.Versioning.SemanticVersion.Equals(System.Object)">
<summary>
Equals
</summary>
</member>
<member name="M:NuGet.Versioning.SemanticVersion.Equals(NuGet.Versioning.SemanticVersion)">
<summary>
Equals
</summary>
</member>
<member name="M:NuGet.Versioning.SemanticVersion.Equals(NuGet.Versioning.SemanticVersion,NuGet.Versioning.VersionComparison)">
<summary>
True if the VersionBase objects are equal based on the given comparison mode.
</summary>
</member>
<member name="M:NuGet.Versioning.SemanticVersion.CompareTo(NuGet.Versioning.SemanticVersion,NuGet.Versioning.VersionComparison)">
<summary>
Compares NuGetVersion objects using the given comparison mode.
</summary>
</member>
<member name="M:NuGet.Versioning.SemanticVersion.op_Equality(NuGet.Versioning.SemanticVersion,NuGet.Versioning.SemanticVersion)">
<summary>
Equals
</summary>
</member>
<member name="M:NuGet.Versioning.SemanticVersion.op_Inequality(NuGet.Versioning.SemanticVersion,NuGet.Versioning.SemanticVersion)">
<summary>
Not equal
</summary>
</member>
<member name="M:NuGet.Versioning.SemanticVersion.op_LessThan(NuGet.Versioning.SemanticVersion,NuGet.Versioning.SemanticVersion)">
<summary>
Less than
</summary>
</member>
<member name="M:NuGet.Versioning.SemanticVersion.op_LessThanOrEqual(NuGet.Versioning.SemanticVersion,NuGet.Versioning.SemanticVersion)">
<summary>
Less than or equal
</summary>
</member>
<member name="M:NuGet.Versioning.SemanticVersion.op_GreaterThan(NuGet.Versioning.SemanticVersion,NuGet.Versioning.SemanticVersion)">
<summary>
Greater than
</summary>
</member>
<member name="M:NuGet.Versioning.SemanticVersion.op_GreaterThanOrEqual(NuGet.Versioning.SemanticVersion,NuGet.Versioning.SemanticVersion)">
<summary>
Greater than or equal
</summary>
</member>
<member name="M:NuGet.Versioning.SemanticVersion.Parse(System.String)">
<summary>
Parses a SemVer string using strict SemVer rules.
</summary>
</member>
<member name="M:NuGet.Versioning.SemanticVersion.TryParse(System.String,NuGet.Versioning.SemanticVersion@)">
<summary>
Parse a version string
</summary>
<returns>false if the version is not a strict semver</returns>
</member>
<member name="M:NuGet.Versioning.SemanticVersion.ParseSections(System.String,System.String@,System.String[]@,System.String@)">
<summary>
Parse the version string into version/release/build
The goal of this code is to take the most direct and optimized path
to parsing and validating a semver. Regex would be much cleaner, but
due to the number of versions created in NuGet Regex is too slow.
</summary>
</member>
<member name="T:NuGet.Versioning.SemanticVersionConverter">
<summary>
Provides a type converter to convert <see cref="T:NuGet.Versioning.SemanticVersion" /> objects to and from various other representations.
</summary>
</member>
<member name="M:NuGet.Versioning.SemanticVersionConverter.CanConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Type)">
<summary>
Gets a value indicating whether this converter can convert an object in the given source type to a
<see cref="T:NuGet.Versioning.SemanticVersion" /> using the specified context.
</summary>
<param name="context">An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that provides a format context.</param>
<param name="sourceType">A <see cref="T:System.Type" /> that represents the type you wish to convert from.</param>
<returns><c>true</c> if this object can perform the conversion; otherwise, <c>false</c>.</returns>
</member>
<member name="M:NuGet.Versioning.SemanticVersionConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object)">
<summary>
Converts the given object to the type of this converter, using the specified context and culture information.
</summary>
<param name="context">An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that provides a format context.</param>
<param name="culture">The <see cref="T:System.Globalization.CultureInfo" /> to use as the current culture.</param>
<param name="value">The <see cref="T:System.Object" /> to convert.</param>
<returns>An <see cref="T:System.Object" /> that represents the converted value.</returns>
<exception cref="T:System.ArgumentException"><c>value</c> is not a valid value for the target type.</exception>
<exception cref="T:System.NotSupportedException">The conversion cannot be performed.</exception>
</member>
<member name="M:NuGet.Versioning.SemanticVersionConverter.CanConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Type)">
<summary>
Gets a value indicating whether this converter can convert an object to the given destination type using the context.
</summary>
<param name="context">An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that provides a format context.</param>
<param name="destinationType">A <see cref="T:System.Type" /> that represents the type you wish to convert to.</param>
<returns><c>true</c> if this object can perform the conversion; otherwise, <c>false</c>.</returns>
</member>
<member name="M:NuGet.Versioning.SemanticVersionConverter.ConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object,System.Type)">
<summary>
Converts the given value object to a <see cref="T:NuGet.Versioning.SemanticVersion" /> object using the arguments.
</summary>
<param name="context">An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that provides a format context.</param>
<param name="culture">The <see cref="T:System.Globalization.CultureInfo" /> to use as the current culture.</param>
<param name="value">The <see cref="T:System.Object" /> to convert.</param>
<param name="destinationType">The <see cref="T:System.Type" /> to convert the value to.</param>
<returns>An <see cref="T:System.Object" /> that represents the converted value.</returns>
<exception cref="T:System.NotSupportedException">The conversion cannot be performed.</exception>
</member>
<member name="T:NuGet.Versioning.VersionComparer">
<summary>
An IVersionComparer for NuGetVersion and NuGetVersion types.
</summary>
</member>
<member name="M:NuGet.Versioning.VersionComparer.#ctor">
<summary>
Creates a VersionComparer using the default mode.
</summary>
</member>
<member name="M:NuGet.Versioning.VersionComparer.#ctor(NuGet.Versioning.VersionComparison)">
<summary>
Creates a VersionComparer that respects the given comparison mode.
</summary>
<param name="versionComparison">comparison mode</param>
</member>
<member name="M:NuGet.Versioning.VersionComparer.Equals(NuGet.Versioning.SemanticVersion,NuGet.Versioning.SemanticVersion)">
<summary>
Determines if both versions are equal.
</summary>
</member>
<member name="M:NuGet.Versioning.VersionComparer.Compare(NuGet.Versioning.SemanticVersion,NuGet.Versioning.SemanticVersion,NuGet.Versioning.VersionComparison)">
<summary>
Compares the given versions using the VersionComparison mode.
</summary>
</member>
<member name="M:NuGet.Versioning.VersionComparer.GetHashCode(NuGet.Versioning.SemanticVersion)">
<summary>
Gives a hash code based on the normalized version string.
</summary>
</member>
<member name="M:NuGet.Versioning.VersionComparer.Compare(NuGet.Versioning.SemanticVersion,NuGet.Versioning.SemanticVersion)">
<summary>
Compare versions.
</summary>
</member>
<member name="M:NuGet.Versioning.VersionComparer.CompareLegacyVersion(NuGet.Versioning.NuGetVersion,NuGet.Versioning.NuGetVersion)">
<summary>
Compares the 4th digit of the version number.
</summary>
</member>
<member name="F:NuGet.Versioning.VersionComparer.Default">
<summary>
A default comparer that compares metadata as strings.
</summary>
</member>
<member name="F:NuGet.Versioning.VersionComparer.Version">
<summary>
A comparer that uses only the version numbers.
</summary>
</member>
<member name="F:NuGet.Versioning.VersionComparer.VersionRelease">
<summary>
Compares versions without comparing the metadata.
</summary>
</member>
<member name="F:NuGet.Versioning.VersionComparer.VersionReleaseMetadata">
<summary>
A version comparer that follows SemVer 2.0.0 rules.
</summary>
</member>
<member name="M:NuGet.Versioning.VersionComparer.CompareReleaseLabels(System.String[],System.String[])">
<summary>
Compares sets of release labels.
</summary>
</member>
<member name="M:NuGet.Versioning.VersionComparer.CompareRelease(System.String,System.String)">
<summary>
Release labels are compared as numbers if they are numeric, otherwise they will be compared
as strings.
</summary>
</member>
<member name="M:NuGet.Versioning.VersionComparer.GetReleaseLabelsOrNull(NuGet.Versioning.SemanticVersion)">
<summary>
Returns an array of release labels from the version, or null.
</summary>
</member>
<member name="M:NuGet.Versioning.VersionComparer.AreReleaseLabelsEqual(NuGet.Versioning.SemanticVersion,NuGet.Versioning.SemanticVersion)">
<summary>
Compare release labels
</summary>
</member>
<member name="M:NuGet.Versioning.VersionComparer.GetRevisionOrZero(NuGet.Versioning.SemanticVersion)">
<summary>
Returns the fourth version number or zero.
</summary>
</member>
<member name="T:NuGet.Versioning.VersionComparison">
<summary>
Version comparison modes.
</summary>
</member>
<member name="F:NuGet.Versioning.VersionComparison.Default">
<summary>
Semantic version 2.0.1-rc comparison with additional compares for extra NuGetVersion fields.
</summary>
</member>
<member name="F:NuGet.Versioning.VersionComparison.Version">
<summary>
Compares only the version numbers.
</summary>
</member>
<member name="F:NuGet.Versioning.VersionComparison.VersionRelease">
<summary>
Include Version number and Release labels in the compare.
</summary>
</member>
<member name="F:NuGet.Versioning.VersionComparison.VersionReleaseMetadata">
<summary>
Include all metadata during the compare.
</summary>
</member>
<member name="T:NuGet.Versioning.VersionExtensions">
<summary>
Version extension methods.
</summary>
</member>
<member name="M:NuGet.Versioning.VersionExtensions.FindBestMatch``1(System.Collections.Generic.IEnumerable{``0},NuGet.Versioning.VersionRange,System.Func{``0,NuGet.Versioning.NuGetVersion})">
<summary>
Find the version that best matches the VersionRange and the floating behavior.
</summary>
</member>
<member name="M:NuGet.Versioning.VersionExtensions.FindBestMatch(System.Collections.Generic.IEnumerable{NuGet.Versioning.INuGetVersionable},NuGet.Versioning.VersionRange)">
<summary>
Find the version that best matches the VersionRange and the floating behavior.
</summary>
</member>
<member name="T:NuGet.Versioning.VersionFormatter">
<summary>
Custom formatter for NuGet versions.
</summary>
</member>
<member name="F:NuGet.Versioning.VersionFormatter.Instance">
<summary>
A static instance of the VersionFormatter class.
</summary>
</member>
<member name="M:NuGet.Versioning.VersionFormatter.Format(System.String,System.Object,System.IFormatProvider)">
<summary>
Format a version string.
</summary>
</member>
<member name="M:NuGet.Versioning.VersionFormatter.GetFormat(System.Type)">
<summary>
Get version format type.
</summary>
</member>
<member name="M:NuGet.Versioning.VersionFormatter.AppendFull(System.Text.StringBuilder,NuGet.Versioning.SemanticVersion)">
<summary>
Appends the full version string including metadata. This is primarily for display purposes.
</summary>
</member>
<member name="M:NuGet.Versioning.VersionFormatter.AppendNormalized(System.Text.StringBuilder,NuGet.Versioning.SemanticVersion)">
<summary>
Appends a normalized version string. This string is unique for each version 'identity'
and does not include leading zeros or metadata.
</summary>
</member>
<member name="T:NuGet.Versioning.VersionRange">
<summary>
Represents a range of versions and a preferred order.
</summary>
<summary>
Static factory methods for creating version range objects.
</summary>
</member>
<member name="M:NuGet.Versioning.VersionRange.#ctor(NuGet.Versioning.NuGetVersion)">
<summary>
Creates a range that is greater than or equal to the minVersion.
</summary>
<param name="minVersion">Lower bound of the version range.</param>
</member>
<member name="M:NuGet.Versioning.VersionRange.#ctor(NuGet.Versioning.NuGetVersion,NuGet.Versioning.FloatRange)">
<summary>
Creates a range that is greater than or equal to the minVersion with the given float behavior.
</summary>
<param name="minVersion">Lower bound of the version range.</param>
<param name="floatRange">Floating behavior.</param>
</member>
<member name="M:NuGet.Versioning.VersionRange.#ctor(NuGet.Versioning.VersionRange,NuGet.Versioning.FloatRange)">
<summary>
Clones a version range and applies a new float range.
</summary>
</member>
<member name="M:NuGet.Versioning.VersionRange.#ctor(NuGet.Versioning.NuGetVersion,System.Boolean,NuGet.Versioning.NuGetVersion,System.Boolean,NuGet.Versioning.FloatRange,System.String)">
<summary>
Creates a VersionRange with the given min and max.
</summary>
<param name="minVersion">Lower bound of the version range.</param>
<param name="includeMinVersion">True if minVersion satisfies the condition.</param>
<param name="maxVersion">Upper bound of the version range.</param>
<param name="includeMaxVersion">True if maxVersion satisfies the condition.</param>
<param name="floatRange">The floating range subset used to find the best version match.</param>
<param name="originalString">The original string being parsed to this object.</param>
</member>
<member name="P:NuGet.Versioning.VersionRange.IsFloating">
<summary>
True if the range has a floating version above the min version.
</summary>
</member>
<member name="P:NuGet.Versioning.VersionRange.Float">
<summary>
Optional floating range used to determine the best version match.
</summary>
</member>
<member name="P:NuGet.Versioning.VersionRange.OriginalString">
<summary>
Original string being parsed to this object.
</summary>
</member>
<member name="M:NuGet.Versioning.VersionRange.ToString">
<summary>
Normalized range string.
</summary>
</member>
<member name="M:NuGet.Versioning.VersionRange.ToNormalizedString">
<summary>
Normalized range string.
</summary>
</member>
<member name="M:NuGet.Versioning.VersionRange.ToLegacyString">
<summary>
A legacy version range compatible with NuGet 2.8.3
</summary>
</member>
<member name="M:NuGet.Versioning.VersionRange.ToLegacyShortString">
<summary>
A short legacy version range compatible with NuGet 2.8.3.
Ex: 1.0.0
</summary>
</member>
<member name="M:NuGet.Versioning.VersionRange.ToString(System.String,System.IFormatProvider)">
<summary>
Format the version range with an IFormatProvider
</summary>
</member>
<member name="M:NuGet.Versioning.VersionRange.TryFormatter(System.String,System.IFormatProvider,System.String@)">
<summary>
Format the range
</summary>
</member>
<member name="M:NuGet.Versioning.VersionRange.PrettyPrint">
<summary>
Format the version range in Pretty Print format.
</summary>
</member>
<member name="M:NuGet.Versioning.VersionRange.FindBestMatch(System.Collections.Generic.IEnumerable{NuGet.Versioning.NuGetVersion})">
<summary>
Return the version that best matches the range.
</summary>
</member>
<member name="M:NuGet.Versioning.VersionRange.IsBetter(NuGet.Versioning.NuGetVersion,NuGet.Versioning.NuGetVersion)">
<summary>
Determines if a given version is better suited to the range than a current version.
</summary>
</member>
<member name="M:NuGet.Versioning.VersionRange.ToNonSnapshotRange">
<summary>
Removes the floating snapshot part of the minimum version if it exists.
Ex: 1.0.0-* -> 1.0.0
</summary>
</member>
<member name="M:NuGet.Versioning.VersionRange.GetNonSnapshotVersion(NuGet.Versioning.NuGetVersion)">
<summary>
Remove the snapshot version section of a version
</summary>
</member>
<member name="M:NuGet.Versioning.VersionRange.ToShortString">
<summary>
ToLegacyShortString that also includes floating ranges
</summary>
</member>
<member name="M:NuGet.Versioning.VersionRange.Equals(NuGet.Versioning.VersionRange)">
<summary>
Equals implementation for VersionRange.
</summary>
</member>
<member name="M:NuGet.Versioning.VersionRange.Equals(System.Object)">
<summary>
Compare the obj as VersionRange.
</summary>
</member>
<member name="M:NuGet.Versioning.VersionRange.GetHashCode">
<summary>
Returns the VersionRangeBase hashcode
</summary>
</member>
<member name="F:NuGet.Versioning.VersionRange.All">
<summary>
A range that accepts all versions, prerelease and stable.
</summary>
</member>
<member name="F:NuGet.Versioning.VersionRange.AllFloating">
<summary>
A range that accepts all versions, prerelease and stable, and floats to the highest.
</summary>
</member>
<member name="F:NuGet.Versioning.VersionRange.AllStable">
<summary>
A range that accepts all stable versions
</summary>
</member>
<member name="F:NuGet.Versioning.VersionRange.AllStableFloating">
<summary>
A range that accepts all versions, prerelease and stable, and floats to the highest.
</summary>
</member>
<member name="F:NuGet.Versioning.VersionRange.None">
<summary>
A range that rejects all versions
</summary>
</member>
<member name="M:NuGet.Versioning.VersionRange.Parse(System.String)">
<summary>
The version string is either a simple version or an arithmetic range
e.g.
1.0 --> 1.0 ≤ x
(,1.0] --> x ≤ 1.0
(,1.0) --> x < 1.0
[1.0] --> x == 1.0
(1.0,) --> 1.0 < x
(1.0, 2.0) --> 1.0 < x < 2.0
[1.0, 2.0] --> 1.0 ≤ x ≤ 2.0
</summary>
</member>
<member name="M:NuGet.Versioning.VersionRange.Parse(System.String,System.Boolean)">
<summary>
Direct parse
</summary>
</member>
<member name="M:NuGet.Versioning.VersionRange.TryParse(System.String,NuGet.Versioning.VersionRange@)">
<summary>
Parses a VersionRange from its string representation.
</summary>
</member>
<member name="M:NuGet.Versioning.VersionRange.TryParse(System.String,System.Boolean,NuGet.Versioning.VersionRange@)">
<summary>
Parses a VersionRange from its string representation.
</summary>
</member>
<member name="M:NuGet.Versioning.VersionRange.Combine(System.Collections.Generic.IEnumerable{NuGet.Versioning.NuGetVersion})">
<summary>
Returns the smallest range that includes all given versions.
</summary>
</member>
<member name="M:NuGet.Versioning.VersionRange.Combine(System.Collections.Generic.IEnumerable{NuGet.Versioning.NuGetVersion},NuGet.Versioning.IVersionComparer)">
<summary>
Returns the smallest range that includes all given versions.
</summary>
</member>
<member name="M:NuGet.Versioning.VersionRange.Combine(System.Collections.Generic.IEnumerable{NuGet.Versioning.VersionRange})">
<summary>
Returns the smallest range that includes all given ranges.
</summary>
</member>
<member name="M:NuGet.Versioning.VersionRange.Combine(System.Collections.Generic.IEnumerable{NuGet.Versioning.VersionRange},NuGet.Versioning.IVersionComparer)">
<summary>
Returns the smallest range that includes all given ranges.
</summary>
</member>
<member name="M:NuGet.Versioning.VersionRange.CommonSubSet(System.Collections.Generic.IEnumerable{NuGet.Versioning.VersionRange})">
<summary>
Returns the greatest common range that satisfies all given ranges.
</summary>
</member>
<member name="M:NuGet.Versioning.VersionRange.CommonSubSet(System.Collections.Generic.IEnumerable{NuGet.Versioning.VersionRange},NuGet.Versioning.IVersionComparer)">
<summary>
Returns the greatest common range that satisfies all given ranges.
</summary>
</member>
<member name="M:NuGet.Versioning.VersionRange.HasValidRange(NuGet.Versioning.VersionRange)">
<summary>
Verify the range has an actual width.
Ex: no version can satisfy (3.0.0, 3.0.0)
</summary>
</member>
<member name="T:NuGet.Versioning.VersionRangeBase">
<summary>
A base version range that handles ranges only and not any of the preferred version logic.
</summary>
</member>
<member name="M:NuGet.Versioning.VersionRangeBase.#ctor(NuGet.Versioning.NuGetVersion,System.Boolean,NuGet.Versioning.NuGetVersion,System.Boolean)">
<summary>
Creates a VersionRange with the given min and max.
</summary>
<param name="minVersion">Lower bound of the version range.</param>
<param name="includeMinVersion">True if minVersion satisfies the condition.</param>
<param name="maxVersion">Upper bound of the version range.</param>
<param name="includeMaxVersion">True if maxVersion satisfies the condition.</param>
</member>
<member name="P:NuGet.Versioning.VersionRangeBase.HasLowerBound">
<summary>
True if MinVersion exists;
</summary>
</member>
<member name="P:NuGet.Versioning.VersionRangeBase.HasUpperBound">
<summary>
True if MaxVersion exists.
</summary>
</member>
<member name="P:NuGet.Versioning.VersionRangeBase.HasLowerAndUpperBounds">
<summary>
True if both MinVersion and MaxVersion exist.
</summary>
</member>
<member name="P:NuGet.Versioning.VersionRangeBase.IsMinInclusive">
<summary>
True if MinVersion exists and is included in the range.
</summary>
</member>
<member name="P:NuGet.Versioning.VersionRangeBase.IsMaxInclusive">
<summary>
True if MaxVersion exists and is included in the range.
</summary>
</member>
<member name="P:NuGet.Versioning.VersionRangeBase.MaxVersion">
<summary>
Maximum version allowed by this range.
</summary>
</member>
<member name="P:NuGet.Versioning.VersionRangeBase.MinVersion">
<summary>
Minimum version allowed by this range.
</summary>
</member>
<member name="M:NuGet.Versioning.VersionRangeBase.Satisfies(NuGet.Versioning.NuGetVersion)">
<summary>
Determines if an NuGetVersion meets the requirements.
</summary>
<param name="version">SemVer to compare</param>
<returns>True if the given version meets the version requirements.</returns>
</member>
<member name="M:NuGet.Versioning.VersionRangeBase.Satisfies(NuGet.Versioning.NuGetVersion,NuGet.Versioning.VersionComparison)">
<summary>
Determines if an NuGetVersion meets the requirements using the given mode.
</summary>
<param name="version">SemVer to compare</param>
<param name="versionComparison">VersionComparison mode used to determine the version range.</param>
<returns>True if the given version meets the version requirements.</returns>
</member>
<member name="M:NuGet.Versioning.VersionRangeBase.Satisfies(NuGet.Versioning.NuGetVersion,NuGet.Versioning.IVersionComparer)">
<summary>
Determines if an NuGetVersion meets the requirements using the version comparer.
</summary>
<param name="version">SemVer to compare.</param>
<param name="comparer">Version comparer used to determine if the version criteria is met.</param>
<returns>True if the given version meets the version requirements.</returns>
</member>
<member name="M:NuGet.Versioning.VersionRangeBase.Equals(System.Object)">
<summary>
Compares the object as a VersionRange with the default comparer
</summary>
</member>
<member name="M:NuGet.Versioning.VersionRangeBase.GetHashCode">
<summary>
Returns the hash code using the default comparer.
</summary>
</member>
<member name="M:NuGet.Versioning.VersionRangeBase.Equals(NuGet.Versioning.VersionRangeBase)">
<summary>
Default compare
</summary>
</member>
<member name="M:NuGet.Versioning.VersionRangeBase.Equals(NuGet.Versioning.VersionRangeBase,NuGet.Versioning.IVersionRangeComparer)">
<summary>
Use the VersionRangeComparer for equality checks
</summary>
</member>
<member name="M:NuGet.Versioning.VersionRangeBase.Equals(NuGet.Versioning.VersionRangeBase,NuGet.Versioning.VersionComparison)">
<summary>
Use a specific VersionComparison for comparison
</summary>
</member>
<member name="M:NuGet.Versioning.VersionRangeBase.Equals(NuGet.Versioning.VersionRangeBase,NuGet.Versioning.IVersionComparer)">
<summary>
Use a specific IVersionComparer for comparison
</summary>
</member>
<member name="M:NuGet.Versioning.VersionRangeBase.IsSubSetOrEqualTo(NuGet.Versioning.VersionRangeBase)">
<summary>
SubSet check
</summary>
</member>
<member name="M:NuGet.Versioning.VersionRangeBase.IsSubSetOrEqualTo(NuGet.Versioning.VersionRangeBase,NuGet.Versioning.IVersionComparer)">
<summary>
SubSet check
</summary>
</member>
<member name="P:NuGet.Versioning.VersionRangeBase.HasPrereleaseBounds">
<summary>
Infer if the range should allow prerelease versions based on if the lower or upper bounds
contain prerelease labels.
</summary>
</member>
<member name="T:NuGet.Versioning.VersionRangeComparer">
<summary>
A version range comparer capable of using different VersionComparers to check if ranges are equivalent.
</summary>
</member>
<member name="M:NuGet.Versioning.VersionRangeComparer.#ctor">
<summary>
Default version range comparer.
</summary>
</member>
<member name="M:NuGet.Versioning.VersionRangeComparer.#ctor(NuGet.Versioning.VersionComparison)">
<summary>
Compare versions with a specific VersionComparison
</summary>
</member>
<member name="M:NuGet.Versioning.VersionRangeComparer.#ctor(NuGet.Versioning.IVersionComparer)">
<summary>
Compare versions with a specific IVersionComparer
</summary>
</member>
<member name="P:NuGet.Versioning.VersionRangeComparer.Default">
<summary>
Default Version comparer
</summary>
</member>
<member name="P:NuGet.Versioning.VersionRangeComparer.VersionRelease">
<summary>
Compare versions using the Version and Release
</summary>
</member>
<member name="M:NuGet.Versioning.VersionRangeComparer.Equals(NuGet.Versioning.VersionRangeBase,NuGet.Versioning.VersionRangeBase)">
<summary>
Checks if two version ranges are equivalent. This follows the rules of the version comparer
when checking the bounds.
</summary>
</member>
<member name="M:NuGet.Versioning.VersionRangeComparer.GetHashCode(NuGet.Versioning.VersionRangeBase)">
<summary>
Creates a hash code based on all properties of the range. This follows the rules of the
version comparer when comparing the version bounds.
</summary>
</member>
<member name="T:NuGet.Versioning.VersionRangeFormatter">
<summary>
Custom formatter for NuGet <see cref="T:NuGet.Versioning.VersionRange" />.
</summary>
</member>
<member name="F:NuGet.Versioning.VersionRangeFormatter.Instance">
<summary>
A static instance of the <see cref="T:NuGet.Versioning.VersionRangeFormatter" /> class.
</summary>
</member>
<member name="M:NuGet.Versioning.VersionRangeFormatter.Format(System.String,System.Object,System.IFormatProvider)">
<summary>
Format a version range string.
</summary>
</member>
<member name="M:NuGet.Versioning.VersionRangeFormatter.GetFormat(System.Type)">
<summary>
Format type.
</summary>
</member>
<member name="M:NuGet.Versioning.VersionRangeFormatter.GetNormalizedString(NuGet.Versioning.VersionRange)">
<summary>
Builds a normalized string with no short hand
</summary>
</member>
<member name="M:NuGet.Versioning.VersionRangeFormatter.GetToString(NuGet.Versioning.VersionRange)">
<summary>
Builds a string to represent the VersionRange. This string can include short hand notations.
</summary>
</member>
<member name="M:NuGet.Versioning.VersionRangeFormatter.GetLegacyShortString(NuGet.Versioning.VersionRangeBase)">
<summary>
Creates a legacy short string that is compatible with NuGet 2.8.3
</summary>
</member>
<member name="M:NuGet.Versioning.VersionRangeFormatter.GetLegacyString(NuGet.Versioning.VersionRangeBase)">
<summary>
Creates a legacy string that is compatible with NuGet 2.8.3
</summary>
</member>
<member name="M:NuGet.Versioning.VersionRangeFormatter.PrettyPrint(NuGet.Versioning.VersionRange,System.Boolean)">
<summary>
A pretty print representation of the VersionRange.
</summary>
</member>
<member name="M:NuGet.Shared.EqualityUtility.OrderedEquals``2(System.Collections.Generic.IEnumerable{``0},System.Collections.Generic.IEnumerable{``0},System.Func{``0,``1},System.Collections.Generic.IComparer{``1},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Compares two enumerables for equality, ordered according to the specified key and optional comparer. Handles null values gracefully.
</summary>
<typeparam name="TSource">The type of the list</typeparam>
<typeparam name="TKey">The type of the sorting key</typeparam>
<param name="self">This list</param>
<param name="other">The other list</param>
<param name="keySelector">The function to extract the key from each item in the list</param>
<param name="orderComparer">An optional comparer for comparing keys</param>
<param name="sequenceComparer">An optional comparer for sequences</param>
</member>
<member name="M:NuGet.Shared.EqualityUtility.OrderedEquals``2(System.Collections.Generic.ICollection{``0},System.Collections.Generic.ICollection{``0},System.Func{``0,``1},System.Collections.Generic.IComparer{``1},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Compares two collections for equality, ordered according to the specified key and optional comparer. Handles null values gracefully.
</summary>
<typeparam name="TSource">The type of the list</typeparam>
<typeparam name="TKey">The type of the sorting key</typeparam>
<param name="self">This list</param>
<param name="other">The other list</param>
<param name="keySelector">The function to extract the key from each item in the list</param>
<param name="orderComparer">An optional comparer for comparing keys</param>
<param name="sequenceComparer">An optional comparer for sequences</param>
</member>
<member name="M:NuGet.Shared.EqualityUtility.OrderedEquals``2(System.Collections.Generic.IList{``0},System.Collections.Generic.IList{``0},System.Func{``0,``1},System.Collections.Generic.IComparer{``1},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Compares two lists for equality, ordered according to the specified key and optional comparer. Handles null values gracefully.
</summary>
<typeparam name="TSource">The type of the list</typeparam>
<typeparam name="TKey">The type of the sorting key</typeparam>
<param name="self">This list</param>
<param name="other">The other list</param>
<param name="keySelector">The function to extract the key from each item in the list</param>
<param name="orderComparer">An optional comparer for comparing keys</param>
<param name="sequenceComparer">An optional comparer for sequences</param>
</member>
<member name="M:NuGet.Shared.EqualityUtility.SequenceEqualWithNullCheck``1(System.Collections.Generic.IEnumerable{``0},System.Collections.Generic.IEnumerable{``0},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Compares two sequence for equality, allowing either sequence to be null. If one is null, both have to be
null for equality.
</summary>
</member>
<member name="M:NuGet.Shared.EqualityUtility.SequenceEqualWithNullCheck``1(System.Collections.Generic.ICollection{``0},System.Collections.Generic.ICollection{``0},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Compares two collections for equality, allowing either collection to be null. If one is null, both have to be
null for equality.
</summary>
</member>
<member name="M:NuGet.Shared.EqualityUtility.SequenceEqualWithNullCheck``1(System.Collections.Generic.IList{``0},System.Collections.Generic.IList{``0},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Compares two lists for equality, allowing either list to be null. If one is null, both have to be
null for equality.
</summary>
</member>
<member name="M:NuGet.Shared.EqualityUtility.SetEqualsWithNullCheck``1(System.Collections.Generic.ISet{``0},System.Collections.Generic.ISet{``0},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Compares two sets for equality, allowing either sequence to be null.
If one is null, both have to be null for equality.
</summary>
</member>
<member name="M:NuGet.Shared.EqualityUtility.EqualsFalse(System.String)">
<summary>
Determines if the current string contains a value equal "false". Leading and trailing whitespace are trimmed and the comparision is case-insensitive
</summary>
<param name="value">The string to compare.</param>
<returns><c>true</c> if the current string is equal to a value of "false", otherwise <c>false></c>.</returns>
</member>
<member name="T:NuGet.Shared.HashCodeCombiner">
<summary>
Hash code creator, based on the original NuGet hash code combiner/ASP hash code combiner implementations
</summary>
</member>
<member name="M:NuGet.Shared.HashCodeCombiner.GetHashCode``2(``0,``1)">
<summary>
Create a unique hash code for the given set of items
</summary>
</member>
<member name="M:NuGet.Shared.HashCodeCombiner.GetHashCode``3(``0,``1,``2)">
<summary>
Create a unique hash code for the given set of items
</summary>
</member>
<member name="M:NuGet.Shared.Extensions.AsList``1(System.Collections.Generic.IEnumerable{``0})">
<summary>
Return the enumerable as a List of T, copying if required. Optimized for common case where it is an List of T.
Avoid mutating the return value.
</summary>
<remarks>https://aspnetwebstack.codeplex.com/SourceControl/latest#src/Common/CollectionExtensions.cs</remarks>
</member>
<member name="M:NuGet.Shared.Extensions.AsHashSet``1(System.Collections.Generic.ISet{``0},System.Collections.Generic.IEqualityComparer{``0})">
<summary>
Return the ISet as a HashSet of T, copying if required. Optimized for common case where it is a HashSet of T.
Avoid mutating the return value.
</summary>
</member>
<member name="M:NuGet.Shared.XmlUtility.Load(System.String)">
<summary>
Creates a new <see cref="T:System.Xml.Linq.XDocument" /> from a file.
</summary>
<param name="path">The complete file path to be read into a new <see cref="T:System.Xml.Linq.XDocument" />.</param>
<returns>An <see cref="T:System.Xml.Linq.XDocument" /> that contains the contents of the specified file.</returns>
</member>
<member name="M:NuGet.Shared.XmlUtility.Load(System.String,System.Xml.Linq.LoadOptions)">
<summary>
Creates a new <see cref="T:System.Xml.Linq.XDocument" /> from a file. Optionally, whitespace can be preserved.
</summary>
<param name="path">The complete file path to be read into a new <see cref="T:System.Xml.Linq.XDocument" />.</param>
<param name="options">A set of <see cref="T:System.Xml.Linq.LoadOptions" />.</param>
<returns>An <see cref="T:System.Xml.Linq.XDocument" /> that contains the contents of the specified file.</returns>
</member>
<member name="M:NuGet.Shared.XmlUtility.Load(System.IO.Stream)">
<summary>
Creates a new <see cref="T:System.Xml.Linq.XDocument" /> from a stream.
</summary>
<param name="input">The stream that contains the XML data.</param>
<returns>An <see cref="T:System.Xml.Linq.XDocument" /> that contains the contents of the specified stream.</returns>
</member>
<member name="M:NuGet.Shared.XmlUtility.Load(System.IO.Stream,System.Xml.Linq.LoadOptions)">
<summary>
Creates a new System.Xml.Linq.XDocument from a stream. Optionally, whitespace can be preserved.
</summary>
<param name="input">The stream that contains the XML data.</param>
<param name="options">A set of <see cref="T:System.Xml.Linq.LoadOptions" />.</param>
<returns>An <see cref="T:System.Xml.Linq.XDocument" /> that contains the contents of the specified stream.</returns>
</member>
<member name="M:NuGet.Shared.XmlUtility.GetEncodedXMLName(System.String)">
<summary>
Converts the name to a valid XML local name, if it is invalid.
</summary>
<param name="name">The name to be encoded.</param>
<returns>The encoded name.</returns>
</member>
<member name="M:NuGet.Shared.XmlUtility.GetXmlReaderSettings(System.Xml.Linq.LoadOptions)">
<summary>
Creates an instance of <see cref="T:System.Xml.XmlReaderSettings" /> with safe settings
<param name="options">A set of <see cref="T:System.Xml.Linq.LoadOptions" />.</param>
</summary>
</member>
<member name="T:NuGet.StringBuilderPool">
<summary>
Provides a resource pool that enables reusing instances of <see cref="T:System.Text.StringBuilder" /> instances.
</summary>
<remarks>
<para>
Renting and returning buffers with an <see cref="T:NuGet.StringBuilderPool" /> can increase performance
in situations where <see cref="T:System.Text.StringBuilder" /> instances are created and destroyed frequently,
resulting in significant memory pressure on the garbage collector.
</para>
<para>
This class is thread-safe. All members may be used by multiple threads concurrently.
</para>
</remarks>
</member>
<member name="F:NuGet.StringBuilderPool.Shared">
<summary>
Retrieves a shared <see cref="T:NuGet.StringBuilderPool" /> instance.
</summary>
</member>
<member name="M:NuGet.StringBuilderPool.Rent(System.Int32)">
<summary>
Retrieves a <see cref="T:System.Text.StringBuilder" /> that is at least the requested length.
</summary>
<param name="minimumCapacity">The minimum capacity of the <see cref="T:System.Text.StringBuilder" /> needed.</param>
<returns>
A <see cref="T:System.Text.StringBuilder" /> that is at least <paramref name="minimumCapacity" /> in length.
</returns>
<remarks>
This buffer is loaned to the caller and should be returned to the same pool via
<see cref="M:NuGet.StringBuilderPool.Return(System.Text.StringBuilder)" /> so that it may be reused in subsequent usage of <see cref="M:NuGet.StringBuilderPool.Rent(System.Int32)" />.
It is not a fatal error to not return a rented string builder, but failure to do so may lead to
decreased application performance, as the pool may need to create a new instance to replace
the one lost.
</remarks>
</member>
<member name="M:NuGet.StringBuilderPool.Return(System.Text.StringBuilder)">
<summary>
Returns to the pool an array that was previously obtained via <see cref="M:NuGet.StringBuilderPool.Rent(System.Int32)" /> on the same
<see cref="T:NuGet.StringBuilderPool" /> instance.
</summary>
<param name="builder">
The <see cref="T:System.Text.StringBuilder" /> previously obtained from <see cref="M:NuGet.StringBuilderPool.Rent(System.Int32)" /> to return to the pool.
</param>
<remarks>
Once a <see cref="T:System.Text.StringBuilder" /> has been returned to the pool, the caller gives up all ownership
of the instance and must not use it. The reference returned from a given call to <see cref="M:NuGet.StringBuilderPool.Rent(System.Int32)" />
must only be returned via <see cref="M:NuGet.StringBuilderPool.Return(System.Text.StringBuilder)" /> once. The default <see cref="T:NuGet.StringBuilderPool" />
may hold onto the returned instance in order to rent it again, or it may release the returned instance
if it's determined that the pool already has enough instances stored.
</remarks>
</member>
</members>
<Signature xmlns="http://www.w3.org/2000/09/xmldsig#"><SignedInfo><CanonicalizationMethod Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315" /><SignatureMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#rsa-sha256" /><Reference URI=""><Transforms><Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature" /><Transform Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315" /></Transforms><DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256" /><DigestValue>fQfWWZz2K1mljzxjO89GreBlGrUXKvDGrG0EaVzB7bY=</DigestValue></Reference></SignedInfo><SignatureValue>CIK9XxyoAba2/2epng4U19kCZAVG1Sa3fz0MTFdnkYm5DMh3fhlJxRBnH8WY4bV5iGpJcjbZmMmgfpnHfQJ4hpeSZejikV4xO9YWm/2qPDPmbnN83YsPSp1pEAmgpbxDNsHIqRSKfjMHHNG6oa45o7d/yeuqxojb6vt48CIBKLo7ofDpFD9qSR/iberIDJQzCt4IvqIpxhAjigxInQ2k2kfEaZU+Ovn8oYwhOgElmzBgAW/k34xMjvBAap37ORCJD9l5e7MrrkNxup8Po0fEWwTayESK3bVOjdNQNQ1zhI7e1vY+HdLAqxqTfhv18WsbU/hgyh6EGaSYqBG6SX+1LQ==</SignatureValue><KeyInfo><KeyValue><RSAKeyValue><Modulus>ok2x7OvGwA7zbnfezc3HT9M4dJka+FaQ7+vCqG40Bcm1QLlYIiDX/Whts0LVijaOvtl9iMeuShnAV7mchItKAVAABpyHuTuav2NCI9FsA8jFmlWndk3uK9RInNx1h1H4ojYxdBExyoN6muwwslKsLEfauUml7h5WAsDPpufTZd4yp2Jyiy384Zdd8CJlfQxfDe+gDZEciugWKHPSOoRxdjAk0GFm0OH14MyoYM4+M3mm1oH7vmSQohS5KIL3NEVW9Mdw7csTG5f93uORLvrJ/8ehFcGyWVb7UGHJnRhdcgGIbfiZzZlsAMS/DIBzM8RHKGNUNSbbLYmN/rt7pRjL4Q==</Modulus><Exponent>AQAB</Exponent></RSAKeyValue></KeyValue><X509Data><X509Certificate>MIIF/zCCA+egAwIBAgITMwAAAsyOtZamvdHJTgAAAAACzDANBgkqhkiG9w0BAQsFADB+MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSgwJgYDVQQDEx9NaWNyb3NvZnQgQ29kZSBTaWduaW5nIFBDQSAyMDExMB4XDTIyMDUxMjIwNDYwMVoXDTIzMDUxMTIwNDYwMVowdDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEeMBwGA1UEAxMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAok2x7OvGwA7zbnfezc3HT9M4dJka+FaQ7+vCqG40Bcm1QLlYIiDX/Whts0LVijaOvtl9iMeuShnAV7mchItKAVAABpyHuTuav2NCI9FsA8jFmlWndk3uK9RInNx1h1H4ojYxdBExyoN6muwwslKsLEfauUml7h5WAsDPpufTZd4yp2Jyiy384Zdd8CJlfQxfDe+gDZEciugWKHPSOoRxdjAk0GFm0OH14MyoYM4+M3mm1oH7vmSQohS5KIL3NEVW9Mdw7csTG5f93uORLvrJ/8ehFcGyWVb7UGHJnRhdcgGIbfiZzZlsAMS/DIBzM8RHKGNUNSbbLYmN/rt7pRjL4QIDAQABo4IBfjCCAXowHwYDVR0lBBgwFgYKKwYBBAGCN0wIAQYIKwYBBQUHAwMwHQYDVR0OBBYEFIi4R40ylsyKlSKfrDNqzhx9da30MFAGA1UdEQRJMEekRTBDMSkwJwYDVQQLEyBNaWNyb3NvZnQgT3BlcmF0aW9ucyBQdWVydG8gUmljbzEWMBQGA1UEBRMNMjMwMDEyKzQ3MDUyOTAfBgNVHSMEGDAWgBRIbmTlUAXTgqoXNzcitW2oynUClTBUBgNVHR8ETTBLMEmgR6BFhkNodHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20vcGtpb3BzL2NybC9NaWNDb2RTaWdQQ0EyMDExXzIwMTEtMDctMDguY3JsMGEGCCsGAQUFBwEBBFUwUzBRBggrBgEFBQcwAoZFaHR0cDovL3d3dy5taWNyb3NvZnQuY29tL3BraW9wcy9jZXJ0cy9NaWNDb2RTaWdQQ0EyMDExXzIwMTEtMDctMDguY3J0MAwGA1UdEwEB/wQCMAAwDQYJKoZIhvcNAQELBQADggIBAHgPA7DgB0udzEyB2LvG216zuskLUQ+iX8jFnl2i7tzXPDw5xXNXn2KvxdzBsf2osDW3LCdjFOwSjVkz+SUFQQNhjSHkd5knF6pzrL9V6lz72XiEg1Vi2gUM3HiLXSMIKOgdd78ZZJEmDLwdA692MO/1vVOFpOSv0QzpyBr5iqiotwMMsZVdZqXn8u9vRSmlk+3nQXdyOPoZXTGPLHXwz41kbSc4zI12bONTlDsLR3HD2s44wuyp3c72R8f9FVi/J9DU/+NOL37Z1yonzGZEuKdrAd6CvupAnLMlrIEv93mBsNRXuDDp4p9UYYK1taxzzgyUxgFDpluMHN0Oiiq9s73u7DA2XvbX8paJz8IZPe9a1/KhsOi5Kxhb99SCXiUnv2lGxnVAz5G6wAW1bzxJYKI+Xj90RKseY3X5EMO7TnVpIZ9Iw1IdrkHp/QLY90ZCch7kdBlLCVTFhSXZCDv4BcM6DhpRzbJsb6QDVfOv9aoG9aGV3a1EacyaedzLA2gWP6cTnCdAr4OrlrN5EFoCpOWgc77F/eQc3SLR06VTLVT1uKuNVxL2xZlD9Z+qC+a3TXa0zI/x1zEZNSgpLGsdVcaN6r/td3ArGQGkDWiAL7eS75LIWZA2SD//9B56uzZ1nmEd8+KBYsPTdp922/W2kFrlj7MBtA6vWE/ZG/grOKiC</X509Certificate><X509Certificate>MIIHejCCBWKgAwIBAgIKYQ6Q0gAAAAAAAzANBgkqhkiG9w0BAQsFADCBiDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEyMDAGA1UEAxMpTWljcm9zb2Z0IFJvb3QgQ2VydGlmaWNhdGUgQXV0aG9yaXR5IDIwMTEwHhcNMTEwNzA4MjA1OTA5WhcNMjYwNzA4MjEwOTA5WjB+MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSgwJgYDVQQDEx9NaWNyb3NvZnQgQ29kZSBTaWduaW5nIFBDQSAyMDExMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAq/D6chAcLq3YbqqCEE00uvK2WCGfQhsqa+laUKq4BjgaBEm6f8MMHt03a8YS2AvwOMKZBrDIOdUBFDFC04kNeWSHfpRgJGyvnkmc6Whe0t+bU7IKLMOv2akrrnoJr9eWWcpgGgXpZnboMlImEi/nqwhQz7NEt13YxC4Ddato88tt8zpcoRb0RrrgOGSsbmQ1eKagYw8t00CT+OPeBw3VXHmlSSnnDb6gE3e+lD3v++MrWhAfTVYoonpy4BI6t0le2O3tQ5GD2Xuye4Yb2T6xjF3oiU+EGvKhL1nkkDstrjNYxbc+/jLTswM9sbKvkjh+0p2ALPVOVpEhNSXDOW5kf1O6nA+tGSOEy/S6A4aN91/w0FK/jJSHvMAhdCVfGCi2zCcoOCWYOUo2z3yxkq4cI6epZuxhH2rhKEmdX4jiJV3TIUs+UsS1Vz8kA/DRelsv1SPjcF0PUUZ3s/gA4bysAoJf28AVs70b1FVL5zmhD+kjSbwYuER8ReTBw3J64HLnJN+/RpnF78IcV9uDjexNSTCnq47f7Fufr/zdsGbiwZeBe+3W7UvnSSmnEyimp31ngOaKYnhfsi+E11ecXL93KCjx7W3DKI8sj0A3T8HhhUSJxAlMxdSlQy90lfdu+HggWCwTXWCVmj5PM4TasIgX3p5O9JawvEagbJjS4NaIjAsCAwEAAaOCAe0wggHpMBAGCSsGAQQBgjcVAQQDAgEAMB0GA1UdDgQWBBRIbmTlUAXTgqoXNzcitW2oynUClTAZBgkrBgEEAYI3FAIEDB4KAFMAdQBiAEMAQTALBgNVHQ8EBAMCAYYwDwYDVR0TAQH/BAUwAwEB/zAfBgNVHSMEGDAWgBRyLToCMZBDuRQFTuHqp8cx0SOJNDBaBgNVHR8EUzBRME+gTaBLhklodHRwOi8vY3JsLm1pY3Jvc29mdC5jb20vcGtpL2NybC9wcm9kdWN0cy9NaWNSb29DZXJBdXQyMDExXzIwMTFfMDNfMjIuY3JsMF4GCCsGAQUFBwEBBFIwUDBOBggrBgEFBQcwAoZCaHR0cDovL3d3dy5taWNyb3NvZnQuY29tL3BraS9jZXJ0cy9NaWNSb29DZXJBdXQyMDExXzIwMTFfMDNfMjIuY3J0MIGfBgNVHSAEgZcwgZQwgZEGCSsGAQQBgjcuAzCBgzA/BggrBgEFBQcCARYzaHR0cDovL3d3dy5taWNyb3NvZnQuY29tL3BraW9wcy9kb2NzL3ByaW1hcnljcHMuaHRtMEAGCCsGAQUFBwICMDQeMiAdAEwAZQBnAGEAbABfAHAAbwBsAGkAYwB5AF8AcwB0AGEAdABlAG0AZQBuAHQALiAdMA0GCSqGSIb3DQEBCwUAA4ICAQBn8oalmOBUeRou09h0ZyKbC5YR4WOSmUKWfdJ5DJDBZV8uLD74w3LRbYP+vj/oCso7v0epo/Np22O/IjWll11lhJB9i0ZQVdgMknzSGksc8zxCi1LQsP1r4z4HLimb5j0bpdS1HXeUOeLpZMlEPXh6I/MTfaaQdION9MsmAkYqwooQu6SpBQyb7Wj6aC6VoCo/KmtYSWMfCWluWpiW5IP0wI/zRive/DvQvTXvbiWu5a8n7dDd8w6vmSiXmE0OPQvyCInWH8MyGOLwxS3OW560STkKxgrCxq2u5bLZ2xWIUUVYODJxJxp/sfQn+N4sOiBpmLJZiWhub6e3dMNABQamASooPoI/E01mC8CzTfXhj38cbxV9Rad25UAqZaPDXVJihsMdYzaXht/a8/jyFqGaJ+HNpZfQ7l1jQeNbB5yHPgZ3BtEGsXUfFL5hYbXw3MYbBL7fQccOKO7eZS/sl/ahXJbYANahRr1Z85elCUtIEJmAH9AAKcWxm6U/RXceNcbSoqKfenoi+kiVH6v7RyOA9Z74v2u3S5fi63V4GuzqN5l5GEv/1rMjaHXmr/r8i+sLgOppO6/8MO0ETI7f33VtY5E90Z1WTk+/gFcioXgRMiF670EKsT/7qMykXcGhiJtXcVZOSEXAQsmbdlsKgEhr/Xmfwb1tbWrJUnMTDXpQzQ==</X509Certificate><X509Certificate>MIIF7TCCA9WgAwIBAgIQP4vItfyfspZDtWnWbELhRDANBgkqhkiG9w0BAQsFADCBiDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEyMDAGA1UEAxMpTWljcm9zb2Z0IFJvb3QgQ2VydGlmaWNhdGUgQXV0aG9yaXR5IDIwMTEwHhcNMTEwMzIyMjIwNTI4WhcNMzYwMzIyMjIxMzA0WjCBiDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEyMDAGA1UEAxMpTWljcm9zb2Z0IFJvb3QgQ2VydGlmaWNhdGUgQXV0aG9yaXR5IDIwMTEwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQCygEGqNThNE3IyaCJNuLLx/9VSvGzH9dJKjDbu0cJcfoyKrq8TKG/Ac+M6ztAlqFo6be+ouFmrEyNozQwph9FvgFyPRH9dkAFSWKxRxV8qh9zc2AodwQO5e7BW6KPeZGHCnvjzfLnsDbVU/ky2ZU+I8JxImQxCCwl8MVkXeQZ4KI2JOkwDJb5xalwL54RgpJki49KvhKSn+9GY7Qyp3pSJ4Q6g3MDOmT3qCFK7VnnkH4S6Hri0xElcTzFLh93dBWcmmYDgcRGjuKVB4qRTufcyKYMME782XgSzS0NHL2vikR7TmE/dQgfI6B0S/Jmpaz6SfsjWaTr8ZL22CZ3K/QwLopt3YEsDlKQwaRLWQi3BQUzK3Kr9j1uDRprZ/LHR47PJf0h6zSTwQY9cdNCssBAgBkm3xy0hyFfj0IbzA2j70M5xwYmZSmQBbP3sMJHPQTySx+W6hh1hhMdfgzlirrSSL0fzC/hV66AfWdC7dJse0Hbm8ukG1xDo+mTeacY1logC8Ea4PyeZb8txiSk190gWAjWP1Xl8TQLPX+uKg09FcYj5qQ1OcunCnAfPSRtOBA5jUYxe2ADBVSy2xuDCZU7JNDn1nLPEfuhhbhNfFcRf2X7tHc7uROzLLoax7Dj2cO2rXBPB2Q8Nx4CyVe0096yb5MPa50c8prWPMd/FS6/r8QIDAQABo1EwTzALBgNVHQ8EBAMCAYYwDwYDVR0TAQH/BAUwAwEB/zAdBgNVHQ4EFgQUci06AjGQQ7kUBU7h6qfHMdEjiTQwEAYJKwYBBAGCNxUBBAMCAQAwDQYJKoZIhvcNAQELBQADggIBAH9yzw+3xRXbm8BJyiZb/p4T5tPw0tuXX/JLP02zrhmu7deXoKzvqTqjwkGw5biRnhOBJAPmCf0/V0A5ISRW0RAvS0CpNoZLtFNXmvvxfomPEf4YbFGq6O0JlbXlccmh6Yd1phV/yX43VF50k8XDZ8wNT2uoFwxtCJJ+i92Bqi1wIcM9BhS7vyRep4TXPw8hIr1LAAbblxzYXtTFC1yHblCk6MM4pPvLLMWSZpuFXst6bJN8gClYW1e1QGm6CHmmZGIVnYeWRbVmIyADixxzoNOieTPgUFmG2y/lAiXqcyqfABTINseSO+lOAOzYVgm5M0kS0lQLAausR7aRKX1MtHWAUgHoyoL2n8ysnI8X6i8msKtyrAv+nlEex0NVZ09Rs1fWtuzuUrc66U7h14GIvE+OdbtLqPA1qibUZ2dJsnBMO5PcHd94kIZysjik0dySTclY6ysSXNQ7roxrsIPlAT/4CTL2kzU0Iq/dNw13CYArzUgA8YyZGUcFAenRv9FO0OYoQzeZpApKCNmacXPSqs0xE2N2oTdvkjgefRI8ZjLny23h/FKJ3crWZgWalmG+oijHHKOnNlA8OqTfSm7mhzvO6/DggTedEzxSjr25HTTGHdUKaj2YKXCMiSrRq4IQSB/c9O+lxbtVGjhjhE63bK2VVOxlIhBJF7jAHscPrFRH</X509Certificate></X509Data></KeyInfo><Object Id="ts-countersig"><X509Data><X509Certificate>MIIHEDCCBPigAwIBAgITMwAAAa38301Y410y6QABAAABrTANBgkqhkiG9w0BAQsFADB8MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSYwJAYDVQQDEx1NaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0EgMjAxMDAeFw0yMjAzMDIxODUxMzZaFw0yMzA1MTExODUxMzZaMIHOMQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSkwJwYDVQQLEyBNaWNyb3NvZnQgT3BlcmF0aW9ucyBQdWVydG8gUmljbzEmMCQGA1UECxMdVGhhbGVzIFRTUyBFU046MzJCRC1FM0Q1LTNCMUQxJTAjBgNVBAMTHE1pY3Jvc29mdCBUaW1lLVN0YW1wIFNlcnZpY2UwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQDonlMqpU0q1S4b2O0zvL4Avk+Tf8vzF3kd6DcBNKyyNRIP4DOYPTYT/iqqiXP+7jy+E7KAC2/kVX+q6GDZZckK2JqrlI8LKtutjA+S/Zfa1NaZc9rTD3oT/GnXVZTSI2CAYdDQuAsjBOrcVaaUK+3hXf21tF/bZ2ctWg1vs6GiQdhWPIWqJKuXETjRFuLqFbE017CApG2DgGH3yCBmpDBV1bwd9DXLLog5+rg5PN1107NLZ0q/Bccz6A/EoDzyHFmljxIwkC6+SNAcX3VJYsDTxyDxIJaqLKwpUY1xu63GVm1njg4AE4tIug1LL9Vp9CzluLLyuP1rnP7/XZZriK2pr/cIW4AspFLmGcvDMU87EKlNkcXJvIfPQlwOY39ZO5N2Ymi1CdNNzI7U7TV85YG/pNQOXi9extwuBI8OQKFYjPlARkL8bk8aRXmhqEBanjhhrRCtKpNMHVF/af+ALvV7JXuQ+X78qQXbHFwbJVAXE+vgmKtJEPbJrE8oVeAyvcG/WZ+zmxDn09AEMqaSOo8MwYx4QBhcqymIyG4JTGhIsY0b+13TYnNlbmCsku9QNIbOnW2w8f1e4Q23b9rK7WdlUztMthPuEKjESrQAb+AIII2Cs+U2BrkOFW2z2PHwTvV6r2txp8dWQzkN5xlRSh8Gqxg3DXQd6nrL7SWyBiYCYwIDAQABo4IBNjCCATIwHQYDVR0OBBYEFH1QdB0EvKohWm5qhKjlfS6yxsFZMB8GA1UdIwQYMBaAFJ+nFV0AXmJdg/Tl0mWnG1M1GelyMF8GA1UdHwRYMFYwVKBSoFCGTmh0dHA6Ly93d3cubWljcm9zb2Z0LmNvbS9wa2lvcHMvY3JsL01pY3Jvc29mdCUyMFRpbWUtU3RhbXAlMjBQQ0ElMjAyMDEwKDEpLmNybDBsBggrBgEFBQcBAQRgMF4wXAYIKwYBBQUHMAKGUGh0dHA6Ly93d3cubWljcm9zb2Z0LmNvbS9wa2lvcHMvY2VydHMvTWljcm9zb2Z0JTIwVGltZS1TdGFtcCUyMFBDQSUyMDIwMTAoMSkuY3J0MAwGA1UdEwEB/wQCMAAwEwYDVR0lBAwwCgYIKwYBBQUHAwgwDQYJKoZIhvcNAQELBQADggIBAIvQHUW7Mf4DknQV53cEXo0LrrUKnHt5N24LNbJT42UsehQ16dSGc4zsk9SaP93lFgwRSXYvh3rtTaMg3Rp/by+q8ZctS+vCuDJ3ywZvsm8ozfsWtXjWuPuHDqDrsRNirfI7ZmWyIcdo72OxfamP5Wp0eT0m1CsgpYTUIcbJzVKfyUkPqO5wLkCfsLAsDwq12BOwvk7yg42unullNCuEYgVxRlNc+jLdyvcJTA/0BlOPvyBmQ5hPv2f5NCXyY2csQgJXJoXt64HYQ8wLBsSWKuD25RmUwXa/MJEMKT9o4IMjDGsDDOQ4IML12g266gkPIJLDYQmc06n0tnW4CxdJux38JVDK3J84v23U0kVsyF4OULB9beV2miB/k2dbmQbcFyfBDl6+kvtgOqvEUFWNdCpwR+mKRhPToVz37iLvPNprhRHYeBF2z3QEVEdSDEiMYPPJIUgQv2AcEIQqY05LKuSd2fo8h1meDJ11+UeNpgEefOIkWHO2oGL7qLQxKnA9FPZSI4Ft9T6n6mUNbbmGU4hnChPUHGBr2RSp1XZKivFdDPXvpBeQqgzqzDGEVdviPxYckLCR8Svxudw9DuW73SIdoA5xB0QBYoXWY9vWe1tKWhj6LRl9KAea/cKjYzN6277hHuhSd9tzD2NcffzdYNduk/0qJKgAyQUyqsgWDeMz</X509Certificate><X509Certificate>MIIHcTCCBVmgAwIBAgITMwAAABXF52ueAptJmQAAAAAAFTANBgkqhkiG9w0BAQsFADCBiDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEyMDAGA1UEAxMpTWljcm9zb2Z0IFJvb3QgQ2VydGlmaWNhdGUgQXV0aG9yaXR5IDIwMTAwHhcNMjEwOTMwMTgyMjI1WhcNMzAwOTMwMTgzMjI1WjB8MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSYwJAYDVQQDEx1NaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0EgMjAxMDCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAOThpkzntHIhC3miy9ckeb0O1YLT/e6cBwfSqWxOdcjKNVf2AX9sSuDivbk+F2Az/1xPx2b3lVNxWuJ+Slr+uDZnhUYjDLWNE893MsAQGOhgfWpSg0S3po5GawcU88V29YZQ3MFEyHFcUTE3oAo4bo3t1w/YJlN8OWECesSq/XJprx2rrPY2vjUmZNqYO7oaezOtgFt+jBAcnVL+tuhiJdxqD89d9P6OU8/W7IVWTe/dvI2k45GPsjksUZzpcGkNyjYtcI4xyDUoveO0hyTD4MmPfrVUj9z6BVWYbWg7mka97aSueik3rMvrg0XnRm7KMtXAhjBcTyziYrLNueKNiOSWrAFKu75xqRdbZ2De+JKRHh09/SDPc31BmkZ1zcRfNN0Sidb9pSB9fvzZnkXftnIv231fgLrbqn427DZM9ituqBJR6L8FA6PRc6ZNN3SUHDSCD/AQ8rdHGO2n6Jl8P0zbr17C89XYcz1DTsEzOUyOArxCaC4Q6oRRRuLRvWoYWmEBc8pnol7XKHYC4jMYctenIPDC+hIK12NvDMk2ZItboKaDIV1fMHSRlJTYuVD5C4lh8zYGNRiER9vcG9H9stQcxWv2XFJRXRLbJbqvUAV6bMURHXLvjflSxIUXk8A8FdsaN8cIFRg/eKtFtvUeh17aj54WcmnGrnu3tz5q4i6tAgMBAAGjggHdMIIB2TASBgkrBgEEAYI3FQEEBQIDAQABMCMGCSsGAQQBgjcVAgQWBBQqp1L+ZMSavoKRPEY1Kc8Q/y8E7jAdBgNVHQ4EFgQUn6cVXQBeYl2D9OXSZacbUzUZ6XIwXAYDVR0gBFUwUzBRBgwrBgEEAYI3TIN9AQEwQTA/BggrBgEFBQcCARYzaHR0cDovL3d3dy5taWNyb3NvZnQuY29tL3BraW9wcy9Eb2NzL1JlcG9zaXRvcnkuaHRtMBMGA1UdJQQMMAoGCCsGAQUFBwMIMBkGCSsGAQQBgjcUAgQMHgoAUwB1AGIAQwBBMAsGA1UdDwQEAwIBhjAPBgNVHRMBAf8EBTADAQH/MB8GA1UdIwQYMBaAFNX2VsuP6KJcYmjRPZSQW9fOmhjEMFYGA1UdHwRPME0wS6BJoEeGRWh0dHA6Ly9jcmwubWljcm9zb2Z0LmNvbS9wa2kvY3JsL3Byb2R1Y3RzL01pY1Jvb0NlckF1dF8yMDEwLTA2LTIzLmNybDBaBggrBgEFBQcBAQROMEwwSgYIKwYBBQUHMAKGPmh0dHA6Ly93d3cubWljcm9zb2Z0LmNvbS9wa2kvY2VydHMvTWljUm9vQ2VyQXV0XzIwMTAtMDYtMjMuY3J0MA0GCSqGSIb3DQEBCwUAA4ICAQCdVX38Kq3hLB9nATEkW+Geckv8qW/qXBS2Pk5HZHixBpOXPTEztTnXwnE2P9pkbHzQdTltuw8x5MKP+2zRoZQYIu7pZmc6U03dmLq2HnjYNi6cqYJWAAOwBb6J6Gngugnue99qb74py27YP0h1AdkY3m2CDPVtI1TkeFN1JFe53Z/zjj3G82jfZfakVqr3lbYoVSfQJL1AoL8ZthISEV09J+BAljis9/kpicO8F7BUhUKz/AyeixmJ5/ALaoHCgRlCGVJ1ijbCHcNhcy4sa3tuPywJeBTpkbKpW99Jo3QMvOyRgNI95ko+ZjtPu4b6MhrZlvSP9pEB9s7GdP32THJvEKt1MMU0sHrYUP4KWN1APMdUbZ1jdEgssU5HLcEUBHG/ZPkkvnNtyo4JvbMBV0lUZNlz138eW0QBjloZkWsNn6Qo3GcZKCS6OEuabvshVGtqRRFHqfG3rsjoiV5PndLQTHa1V1QJsWkBRH58oWFsc/4Ku+xBZj1p/cvBQUl+fpO+y/g75LcVv7TOPqUxUYS8vwLBgqJ7Fx0ViY1w/ue10CgaiQuPNtq6TPmb/wrpNPgkNWcr4A245oyZ1uEi6vAnQj0llOZ0dFtq0Z4+7X6gMTN9vMvpe784cETRkPHIqzqKOghif9lwY1NNje6CbaUFEMFxBmoQtB1VM1izoXBm8g==</X509Certificate></X509Data><CounterSignature ts-format="cms-timestamp-message" xmlns="http://schemas.microsoft.com/xmldsig/timestamp/2003">MIAGCSqGSIb3DQEHAqCAMIIW4QIBAzEPMA0GCWCGSAFlAwQCAQUAMIIBVQYLKoZIhvcNAQkQAQSgggFEBIIBQDCCATwCAQEGCisGAQQBhFkKAwEwMTANBglghkgBZQMEAgEFAAQgRwkACsZcQCNRXfuDqc5+YhvKtzmxXT8ghxggfYQkwwsCBmMRWG0CXBgTMjAyMjA5MDkyMzE3NTUuNDcxWjAEgAIB9KCB1KSB0TCBzjELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEpMCcGA1UECxMgTWljcm9zb2Z0IE9wZXJhdGlvbnMgUHVlcnRvIFJpY28xJjAkBgNVBAsTHVRoYWxlcyBUU1MgRVNOOjMyQkQtRTNENS0zQjFEMSUwIwYDVQQDExxNaWNyb3NvZnQgVGltZS1TdGFtcCBTZXJ2aWNloIIRXzCCBxAwggT4oAMCAQICEzMAAAGt/N9NWONdMukAAQAAAa0wDQYJKoZIhvcNAQELBQAwfDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEmMCQGA1UEAxMdTWljcm9zb2Z0IFRpbWUtU3RhbXAgUENBIDIwMTAwHhcNMjIwMzAyMTg1MTM2WhcNMjMwNTExMTg1MTM2WjCBzjELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEpMCcGA1UECxMgTWljcm9zb2Z0IE9wZXJhdGlvbnMgUHVlcnRvIFJpY28xJjAkBgNVBAsTHVRoYWxlcyBUU1MgRVNOOjMyQkQtRTNENS0zQjFEMSUwIwYDVQQDExxNaWNyb3NvZnQgVGltZS1TdGFtcCBTZXJ2aWNlMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEA6J5TKqVNKtUuG9jtM7y+AL5Pk3/L8xd5Heg3ATSssjUSD+AzmD02E/4qqolz/u48vhOygAtv5FV/quhg2WXJCtiaq5SPCyrbrYwPkv2X2tTWmXPa0w96E/xp11WU0iNggGHQ0LgLIwTq3FWmlCvt4V39tbRf22dnLVoNb7OhokHYVjyFqiSrlxE40Rbi6hWxNNewgKRtg4Bh98ggZqQwVdW8HfQ1yy6IOfq4OTzdddOzS2dKvwXHM+gPxKA88hxZpY8SMJAuvkjQHF91SWLA08cg8SCWqiysKVGNcbutxlZtZ44OABOLSLoNSy/VafQs5biy8rj9a5z+/12Wa4itqa/3CFuALKRS5hnLwzFPOxCpTZHFybyHz0JcDmN/WTuTdmJotQnTTcyO1O01fOWBv6TUDl4vXsbcLgSPDkChWIz5QEZC/G5PGkV5oahAWp44Ya0QrSqTTB1Rf2n/gC71eyV7kPl+/KkF2xxcGyVQFxPr4JirSRD2yaxPKFXgMr3Bv1mfs5sQ59PQBDKmkjqPDMGMeEAYXKspiMhuCUxoSLGNG/td02JzZW5grJLvUDSGzp1tsPH9XuENt2/ayu1nZVM7TLYT7hCoxEq0AG/gCCCNgrPlNga5DhVts9jx8E71eq9rcafHVkM5DecZUUofBqsYNw10Hep6y+0lsgYmAmMCAwEAAaOCATYwggEyMB0GA1UdDgQWBBR9UHQdBLyqIVpuaoSo5X0ussbBWTAfBgNVHSMEGDAWgBSfpxVdAF5iXYP05dJlpxtTNRnpcjBfBgNVHR8EWDBWMFSgUqBQhk5odHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20vcGtpb3BzL2NybC9NaWNyb3NvZnQlMjBUaW1lLVN0YW1wJTIwUENBJTIwMjAxMCgxKS5jcmwwbAYIKwYBBQUHAQEEYDBeMFwGCCsGAQUFBzAChlBodHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20vcGtpb3BzL2NlcnRzL01pY3Jvc29mdCUyMFRpbWUtU3RhbXAlMjBQQ0ElMjAyMDEwKDEpLmNydDAMBgNVHRMBAf8EAjAAMBMGA1UdJQQMMAoGCCsGAQUFBwMIMA0GCSqGSIb3DQEBCwUAA4ICAQCL0B1FuzH+A5J0Fed3BF6NC661Cpx7eTduCzWyU+NlLHoUNenUhnOM7JPUmj/d5RYMEUl2L4d67U2jIN0af28vqvGXLUvrwrgyd8sGb7JvKM37FrV41rj7hw6g67ETYq3yO2ZlsiHHaO9jsX2pj+VqdHk9JtQrIKWE1CHGyc1Sn8lJD6jucC5An7CwLA8KtdgTsL5O8oONrp7pZTQrhGIFcUZTXPoy3cr3CUwP9AZTj78gZkOYT79n+TQl8mNnLEICVyaF7euB2EPMCwbElirg9uUZlMF2vzCRDCk/aOCDIwxrAwzkOCDC9doNuuoJDyCSw2EJnNOp9LZ1uAsXSbsd/CVQytyfOL9t1NJFbMheDlCwfW3ldpogf5NnW5kG3BcnwQ5evpL7YDqrxFBVjXQqcEfpikYT06Fc9+4i7zzaa4UR2HgRds90BFRHUgxIjGDzySFIEL9gHBCEKmNOSyrkndn6PIdZngyddflHjaYBHnziJFhztqBi+6i0MSpwPRT2UiOBbfU+p+plDW25hlOIZwoT1Bxga9kUqdV2SorxXQz176QXkKoM6swxhFXb4j8WHJCwkfEr8bncPQ7lu90iHaAOcQdEAWKF1mPb1ntbSloY+i0ZfSgHmv3Co2Mzetu+4R7oUnfbcw9jXH383WDXbpP9KiSoAMkFMqrIFg3jMzCCB3EwggVZoAMCAQICEzMAAAAVxedrngKbSZkAAAAAABUwDQYJKoZIhvcNAQELBQAwgYgxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpXYXNoaW5ndG9uMRAwDgYDVQQHEwdSZWRtb25kMR4wHAYDVQQKExVNaWNyb3NvZnQgQ29ycG9yYXRpb24xMjAwBgNVBAMTKU1pY3Jvc29mdCBSb290IENlcnRpZmljYXRlIEF1dGhvcml0eSAyMDEwMB4XDTIxMDkzMDE4MjIyNVoXDTMwMDkzMDE4MzIyNVowfDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEmMCQGA1UEAxMdTWljcm9zb2Z0IFRpbWUtU3RhbXAgUENBIDIwMTAwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQDk4aZM57RyIQt5osvXJHm9DtWC0/3unAcH0qlsTnXIyjVX9gF/bErg4r25PhdgM/9cT8dm95VTcVrifkpa/rg2Z4VGIwy1jRPPdzLAEBjoYH1qUoNEt6aORmsHFPPFdvWGUNzBRMhxXFExN6AKOG6N7dcP2CZTfDlhAnrEqv1yaa8dq6z2Nr41JmTamDu6GnszrYBbfowQHJ1S/rboYiXcag/PXfT+jlPP1uyFVk3v3byNpOORj7I5LFGc6XBpDco2LXCOMcg1KL3jtIckw+DJj361VI/c+gVVmG1oO5pGve2krnopN6zL64NF50ZuyjLVwIYwXE8s4mKyzbnijYjklqwBSru+cakXW2dg3viSkR4dPf0gz3N9QZpGdc3EXzTdEonW/aUgfX782Z5F37ZyL9t9X4C626p+Nuw2TPYrbqgSUei/BQOj0XOmTTd0lBw0gg/wEPK3Rxjtp+iZfD9M269ewvPV2HM9Q07BMzlMjgK8QmguEOqEUUbi0b1qGFphAXPKZ6Je1yh2AuIzGHLXpyDwwvoSCtdjbwzJNmSLW6CmgyFdXzB0kZSU2LlQ+QuJYfM2BjUYhEfb3BvR/bLUHMVr9lxSUV0S2yW6r1AFemzFER1y7435UsSFF5PAPBXbGjfHCBUYP3irRbb1Hode2o+eFnJpxq57t7c+auIurQIDAQABo4IB3TCCAdkwEgYJKwYBBAGCNxUBBAUCAwEAATAjBgkrBgEEAYI3FQIEFgQUKqdS/mTEmr6CkTxGNSnPEP8vBO4wHQYDVR0OBBYEFJ+nFV0AXmJdg/Tl0mWnG1M1GelyMFwGA1UdIARVMFMwUQYMKwYBBAGCN0yDfQEBMEEwPwYIKwYBBQUHAgEWM2h0dHA6Ly93d3cubWljcm9zb2Z0LmNvbS9wa2lvcHMvRG9jcy9SZXBvc2l0b3J5Lmh0bTATBgNVHSUEDDAKBggrBgEFBQcDCDAZBgkrBgEEAYI3FAIEDB4KAFMAdQBiAEMAQTALBgNVHQ8EBAMCAYYwDwYDVR0TAQH/BAUwAwEB/zAfBgNVHSMEGDAWgBTV9lbLj+iiXGJo0T2UkFvXzpoYxDBWBgNVHR8ETzBNMEugSaBHhkVodHRwOi8vY3JsLm1pY3Jvc29mdC5jb20vcGtpL2NybC9wcm9kdWN0cy9NaWNSb29DZXJBdXRfMjAxMC0wNi0yMy5jcmwwWgYIKwYBBQUHAQEETjBMMEoGCCsGAQUFBzAChj5odHRwOi8vd3d3Lm1pY3Jvc29mdC5jb20vcGtpL2NlcnRzL01pY1Jvb0NlckF1dF8yMDEwLTA2LTIzLmNydDANBgkqhkiG9w0BAQsFAAOCAgEAnVV9/Cqt4SwfZwExJFvhnnJL/Klv6lwUtj5OR2R4sQaTlz0xM7U518JxNj/aZGx80HU5bbsPMeTCj/ts0aGUGCLu6WZnOlNN3Zi6th542DYunKmCVgADsAW+iehp4LoJ7nvfam++Kctu2D9IdQHZGN5tggz1bSNU5HhTdSRXud2f8449xvNo32X2pFaq95W2KFUn0CS9QKC/GbYSEhFdPSfgQJY4rPf5KYnDvBewVIVCs/wMnosZiefwC2qBwoEZQhlSdYo2wh3DYXMuLGt7bj8sCXgU6ZGyqVvfSaN0DLzskYDSPeZKPmY7T7uG+jIa2Zb0j/aRAfbOxnT99kxybxCrdTDFNLB62FD+CljdQDzHVG2dY3RILLFORy3BFARxv2T5JL5zbcqOCb2zAVdJVGTZc9d/HltEAY5aGZFrDZ+kKNxnGSgkujhLmm77IVRrakURR6nxt67I6IleT53S0Ex2tVdUCbFpAUR+fKFhbHP+CrvsQWY9af3LwUFJfn6Tvsv4O+S3Fb+0zj6lMVGEvL8CwYKiexcdFYmNcP7ntdAoGokLjzbaukz5m/8K6TT4JDVnK+ANuOaMmdbhIurwJ0I9JZTmdHRbatGePu1+oDEzfbzL6Xu/OHBE0ZDxyKs6ijoIYn/ZcGNTTY3ugm2lBRDBcQZqELQdVTNYs6FwZvKhggLSMIICOwIBATCB/KGB1KSB0TCBzjELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEpMCcGA1UECxMgTWljcm9zb2Z0IE9wZXJhdGlvbnMgUHVlcnRvIFJpY28xJjAkBgNVBAsTHVRoYWxlcyBUU1MgRVNOOjMyQkQtRTNENS0zQjFEMSUwIwYDVQQDExxNaWNyb3NvZnQgVGltZS1TdGFtcCBTZXJ2aWNloiMKAQEwBwYFKw4DAhoDFQBAktGtRVHhlsEOBY+O42pVy1TOkKCBgzCBgKR+MHwxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpXYXNoaW5ndG9uMRAwDgYDVQQHEwdSZWRtb25kMR4wHAYDVQQKExVNaWNyb3NvZnQgQ29ycG9yYXRpb24xJjAkBgNVBAMTHU1pY3Jvc29mdCBUaW1lLVN0YW1wIFBDQSAyMDEwMA0GCSqGSIb3DQEBBQUAAgUA5sW5xDAiGA8yMDIyMDkwOTE3MTAyOFoYDzIwMjIwOTEwMTcxMDI4WjB3MD0GCisGAQQBhFkKBAExLzAtMAoCBQDmxbnEAgEAMAoCAQACAiKNAgH/MAcCAQACAhH3MAoCBQDmxwtEAgEAMDYGCisGAQQBhFkKBAIxKDAmMAwGCisGAQQBhFkKAwKgCjAIAgEAAgMHoSChCjAIAgEAAgMBhqAwDQYJKoZIhvcNAQEFBQADgYEARbcUM4tpTQHkr3OFuY3H21TBYCxZRagWBkhm0ohHcNuHhKnJiw+qoREI3U6b4KWoDkMNiIou4r8I767gu0phjrFly599i8OYwTOvyWiDcnTlvA6gTnt/RcUcyTEIkwBRGMdLFzjonQ6fKYbzm0oboTY1NELoi3ldBkMJQxqPEnMxggQNMIIECQIBATCBkzB8MQswCQYDVQQGEwJVUzETMBEGA1UECBMKV2FzaGluZ3RvbjEQMA4GA1UEBxMHUmVkbW9uZDEeMBwGA1UEChMVTWljcm9zb2Z0IENvcnBvcmF0aW9uMSYwJAYDVQQDEx1NaWNyb3NvZnQgVGltZS1TdGFtcCBQQ0EgMjAxMAITMwAAAa38301Y410y6QABAAABrTANBglghkgBZQMEAgEFAKCCAUowGgYJKoZIhvcNAQkDMQ0GCyqGSIb3DQEJEAEEMC8GCSqGSIb3DQEJBDEiBCASLbGeGhlv5xRkmj3/iy/fxaUZwsBZCUnvmYmLLhwnSTCB+gYLKoZIhvcNAQkQAi8xgeowgecwgeQwgb0EIJ/qfD0JHl7X4621yfXD33YqafxgxNj8NY8gd4xsy1CCMIGYMIGApH4wfDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCldhc2hpbmd0b24xEDAOBgNVBAcTB1JlZG1vbmQxHjAcBgNVBAoTFU1pY3Jvc29mdCBDb3Jwb3JhdGlvbjEmMCQGA1UEAxMdTWljcm9zb2Z0IFRpbWUtU3RhbXAgUENBIDIwMTACEzMAAAGt/N9NWONdMukAAQAAAa0wIgQgk5dKoojzFFmSKD2i4Mj/7R8r3aOiLzQsuT1/1Wnpur4wDQYJKoZIhvcNAQELBQAEggIAhKjkf3EeVE9pEh1k3ZhvbfmS47h/+sNSxdxtVjb78/kFi3vnKOsDCj7JShQ24+UB4P+gNAO+mCe50R7kLQJf7m1hhUAzBRjocR8HJ5QP0cXL5m+/GE5vv0FoStt3l38KVLD+XkchH/hEveayH1oxhwxwwZTHuRRwN2AgavYmKhC7HIFgDqhGhPkh5TZlipUr9D3i/NktC2xjLjowMEhk2Ogc0etr5mYqq1KFl9PkXyDb71brn3l2cO0MTNATgTdbSCsL6bdBUxgvHV1zOxkkcOaIFEu/HN+eK5XqcqRrq1y//94ATAUCtKLVg05YbUpxy1PuqEs+yC+2Y5NzBhpmpckSZI+8HMCnQqwWIBlgPMyRHvekn5Pk9w3J9qW2mBf7ScAyBX8ISe5qC9noUg8FJtki9i+cdyAaVU5ZtQUmmL9rW0s1MGGR9kTof0rUo00ck5+BDhod70Tu6di/dCKI+1NRZocBRTLSK/ir8kt+w2S21OiOsn2XhsDouhgqAIrWMX7QGhDo+yHa5NdPJGqTjPnrQT4UUNpmSbAubbPSl+sG45O65sGTLsQY2qT59ZYFTUH0+buqhlz4md3il8hPLq9aUbMHBDYcE/PB5+rQirIxuHhkoThb04DkQ1v/Z0yy+BRRC7XZK0x8wmMMgFu2oBUpIpX2xHxiqlcLptRoY6IAAAAA</CounterSignature></Object></Signature></doc>
md5: 98D74E9743BFE0F982D151582C4A4F98 | sha1: 9633F9EC761FD6D03446C80A99161E75EDC1FAA7 | sha256: D3A023C0207B32B02ACEC3E5573B8EB3C17A2C5C5BF591BB2335109524DC01B6 | sha512: AD5609902F2C3A1EF0B410F85DDDEDA9BE8AC5A8B825CA4EC8E797B49F03B2658353B3D34CC7B12E2D3D58BA30EA6F7E9B784667D5C39AE442CBB1D77FBD12F9
<?xml version="1.0" encoding="utf-8"?>
<doc>
<assembly>
<name>System.Security.Cryptography.Pkcs</name>
</assembly>
<members>
<member name="T:System.Security.Cryptography.CryptographicAttributeObject">
<summary>Contains a type and a collection of values associated with that type.</summary>
</member>
<member name="M:System.Security.Cryptography.CryptographicAttributeObject.#ctor(System.Security.Cryptography.Oid)">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.CryptographicAttributeObject" /> class using an attribute represented by the specified <see cref="T:System.Security.Cryptography.Oid" /> object.</summary>
<param name="oid">The attribute to store in this <see cref="T:System.Security.Cryptography.CryptographicAttributeObject" /> object.</param>
</member>
<member name="M:System.Security.Cryptography.CryptographicAttributeObject.#ctor(System.Security.Cryptography.Oid,System.Security.Cryptography.AsnEncodedDataCollection)">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.CryptographicAttributeObject" /> class using an attribute represented by the specified <see cref="T:System.Security.Cryptography.Oid" /> object and the set of values associated with that attribute represented by the specified <see cref="T:System.Security.Cryptography.AsnEncodedDataCollection" /> collection.</summary>
<param name="oid">The attribute to store in this <see cref="T:System.Security.Cryptography.CryptographicAttributeObject" /> object.</param>
<param name="values">The set of values associated with the attribute represented by the <paramref name="oid" /> parameter.</param>
<exception cref="T:System.InvalidOperationException">The collection contains duplicate items.</exception>
</member>
<member name="P:System.Security.Cryptography.CryptographicAttributeObject.Oid">
<summary>Gets the <see cref="T:System.Security.Cryptography.Oid" /> object that specifies the object identifier for the attribute.</summary>
<returns>The object identifier for the attribute.</returns>
</member>
<member name="P:System.Security.Cryptography.CryptographicAttributeObject.Values">
<summary>Gets the <see cref="T:System.Security.Cryptography.AsnEncodedDataCollection" /> collection that contains the set of values that are associated with the attribute.</summary>
<returns>The set of values that is associated with the attribute.</returns>
</member>
<member name="T:System.Security.Cryptography.CryptographicAttributeObjectCollection">
<summary>Contains a set of <see cref="T:System.Security.Cryptography.CryptographicAttributeObject" /> objects.</summary>
</member>
<member name="M:System.Security.Cryptography.CryptographicAttributeObjectCollection.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.CryptographicAttributeObjectCollection" /> class.</summary>
</member>
<member name="M:System.Security.Cryptography.CryptographicAttributeObjectCollection.#ctor(System.Security.Cryptography.CryptographicAttributeObject)">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.CryptographicAttributeObjectCollection" /> class, adding a specified <see cref="T:System.Security.Cryptography.CryptographicAttributeObject" /> to the collection.</summary>
<param name="attribute">A <see cref="T:System.Security.Cryptography.CryptographicAttributeObject" /> object that is added to the collection.</param>
</member>
<member name="M:System.Security.Cryptography.CryptographicAttributeObjectCollection.Add(System.Security.Cryptography.AsnEncodedData)">
<summary>Adds the specified <see cref="T:System.Security.Cryptography.AsnEncodedData" /> object to the collection.</summary>
<param name="asnEncodedData">The <see cref="T:System.Security.Cryptography.AsnEncodedData" /> object to add to the collection.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="asnEncodedData" /> is <see langword="null" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">A cryptographic operation could not be completed.</exception>
<returns>
<see langword="true" /> if the method returns the zero-based index of the added item; otherwise, <see langword="false" />.</returns>
</member>
<member name="M:System.Security.Cryptography.CryptographicAttributeObjectCollection.Add(System.Security.Cryptography.CryptographicAttributeObject)">
<summary>Adds the specified <see cref="T:System.Security.Cryptography.CryptographicAttributeObject" /> object to the collection.</summary>
<param name="attribute">The <see cref="T:System.Security.Cryptography.CryptographicAttributeObject" /> object to add to the collection.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="asnEncodedData" /> is <see langword="null" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">A cryptographic operation could not be completed.</exception>
<exception cref="T:System.InvalidOperationException">The specified item already exists in the collection.</exception>
<returns>
<see langword="true" /> if the method returns the zero-based index of the added item; otherwise, <see langword="false" />.</returns>
</member>
<member name="M:System.Security.Cryptography.CryptographicAttributeObjectCollection.CopyTo(System.Security.Cryptography.CryptographicAttributeObject[],System.Int32)">
<summary>Copies the <see cref="T:System.Security.Cryptography.CryptographicAttributeObjectCollection" /> collection to an array of <see cref="T:System.Security.Cryptography.CryptographicAttributeObject" /> objects.</summary>
<param name="array">An array of <see cref="T:System.Security.Cryptography.CryptographicAttributeObject" /> objects that the collection is copied to.</param>
<param name="index">The zero-based index in <paramref name="array" /> to which the collection is to be copied.</param>
<exception cref="T:System.ArgumentException">One of the arguments provided to a method was not valid.</exception>
<exception cref="T:System.ArgumentNullException">
<see langword="null" /> was passed to a method that does not accept it as a valid argument.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The value of an argument was outside the allowable range of values as defined by the called method.</exception>
</member>
<member name="M:System.Security.Cryptography.CryptographicAttributeObjectCollection.GetEnumerator">
<summary>Gets a <see cref="T:System.Security.Cryptography.CryptographicAttributeObjectEnumerator" /> object for the collection.</summary>
<returns>
<see langword="true" /> if the method returns a <see cref="T:System.Security.Cryptography.CryptographicAttributeObjectEnumerator" /> object that can be used to enumerate the collection; otherwise, <see langword="false" />.</returns>
</member>
<member name="M:System.Security.Cryptography.CryptographicAttributeObjectCollection.Remove(System.Security.Cryptography.CryptographicAttributeObject)">
<summary>Removes the specified <see cref="T:System.Security.Cryptography.CryptographicAttributeObject" /> object from the collection.</summary>
<param name="attribute">The <see cref="T:System.Security.Cryptography.CryptographicAttributeObject" /> object to remove from the collection.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="attribute" /> is <see langword="null" />.</exception>
</member>
<member name="M:System.Security.Cryptography.CryptographicAttributeObjectCollection.System#Collections#ICollection#CopyTo(System.Array,System.Int32)">
<summary>Copies the elements of this <see cref="T:System.Security.Cryptography.CryptographicAttributeObjectCollection" /> collection to an <see cref="T:System.Array" /> array, starting at a particular index.</summary>
<param name="array">The one-dimensional <see cref="T:System.Array" /> array that is the destination of the elements copied from this <see cref="T:System.Security.Cryptography.CryptographicAttributeObjectCollection" />. The <see cref="T:System.Array" /> array must have zero-based indexing.</param>
<param name="index">The zero-based index in <paramref name="array" /> at which copying begins.</param>
</member>
<member name="M:System.Security.Cryptography.CryptographicAttributeObjectCollection.System#Collections#IEnumerable#GetEnumerator">
<summary>Returns an enumerator that iterates through the <see cref="T:System.Security.Cryptography.CryptographicAttributeObjectCollection" /> collection.</summary>
<returns>An <see cref="T:System.Collections.IEnumerator" /> object that can be used to iterate through the <see cref="T:System.Security.Cryptography.CryptographicAttributeObjectCollection" /> collection.</returns>
</member>
<member name="P:System.Security.Cryptography.CryptographicAttributeObjectCollection.Count">
<summary>Gets the number of items in the collection.</summary>
<returns>The number of items in the collection.</returns>
</member>
<member name="P:System.Security.Cryptography.CryptographicAttributeObjectCollection.IsSynchronized">
<summary>Gets a value that indicates whether access to the collection is synchronized, or thread safe.</summary>
<returns>
<see langword="true" /> if access to the collection is thread safe; otherwise <see langword="false" />.</returns>
</member>
<member name="P:System.Security.Cryptography.CryptographicAttributeObjectCollection.Item(System.Int32)">
<summary>Gets the <see cref="T:System.Security.Cryptography.CryptographicAttributeObject" /> object at the specified index in the collection.</summary>
<param name="index">An <see cref="T:System.Int32" /> value that represents the zero-based index of the <see cref="T:System.Security.Cryptography.CryptographicAttributeObject" /> object to retrieve.</param>
<returns>The <see cref="T:System.Security.Cryptography.CryptographicAttributeObject" /> object at the specified index.</returns>
</member>
<member name="P:System.Security.Cryptography.CryptographicAttributeObjectCollection.SyncRoot">
<summary>Gets an <see cref="T:System.Object" /> object used to synchronize access to the collection.</summary>
<returns>An <see cref="T:System.Object" /> object used to synchronize access to the <see cref="T:System.Security.Cryptography.CryptographicAttributeObjectCollection" /> collection.</returns>
</member>
<member name="T:System.Security.Cryptography.CryptographicAttributeObjectEnumerator">
<summary>Provides enumeration functionality for the <see cref="T:System.Security.Cryptography.CryptographicAttributeObjectCollection" /> collection. This class cannot be inherited.</summary>
</member>
<member name="M:System.Security.Cryptography.CryptographicAttributeObjectEnumerator.MoveNext">
<summary>Advances the enumeration to the next <see cref="T:System.Security.Cryptography.CryptographicAttributeObject" /> object in the <see cref="T:System.Security.Cryptography.CryptographicAttributeObjectCollection" /> collection.</summary>
<returns>
<see langword="true" /> if the enumeration successfully moved to the next <see cref="T:System.Security.Cryptography.CryptographicAttributeObject" /> object; <see langword="false" /> if the enumerator is at the end of the enumeration.</returns>
</member>
<member name="M:System.Security.Cryptography.CryptographicAttributeObjectEnumerator.Reset">
<summary>Resets the enumeration to the first <see cref="T:System.Security.Cryptography.CryptographicAttributeObject" /> object in the <see cref="T:System.Security.Cryptography.CryptographicAttributeObjectCollection" /> collection.</summary>
</member>
<member name="P:System.Security.Cryptography.CryptographicAttributeObjectEnumerator.Current">
<summary>Gets the current <see cref="T:System.Security.Cryptography.CryptographicAttributeObject" /> object from the <see cref="T:System.Security.Cryptography.CryptographicAttributeObjectCollection" /> collection.</summary>
<returns>A <see cref="T:System.Security.Cryptography.CryptographicAttributeObject" /> object that represents the current cryptographic attribute in the <see cref="T:System.Security.Cryptography.CryptographicAttributeObjectCollection" /> collection.</returns>
</member>
<member name="P:System.Security.Cryptography.CryptographicAttributeObjectEnumerator.System#Collections#IEnumerator#Current">
<summary>Gets the current <see cref="T:System.Security.Cryptography.CryptographicAttributeObject" /> object from the <see cref="T:System.Security.Cryptography.CryptographicAttributeObjectCollection" /> collection.</summary>
<returns>A <see cref="T:System.Security.Cryptography.CryptographicAttributeObject" /> object that represents the current cryptographic attribute in the <see cref="T:System.Security.Cryptography.CryptographicAttributeObjectCollection" /> collection.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.AlgorithmIdentifier">
<summary>The <see cref="T:System.Security.Cryptography.Pkcs.AlgorithmIdentifier" /> class defines the algorithm used for a cryptographic operation.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.AlgorithmIdentifier.#ctor">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.AlgorithmIdentifier.#ctor" /> constructor creates an instance of the <see cref="T:System.Security.Cryptography.Pkcs.AlgorithmIdentifier" /> class by using a set of default parameters.</summary>
<exception cref="T:System.Security.Cryptography.CryptographicException">A cryptographic operation could not be completed.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.AlgorithmIdentifier.#ctor(System.Security.Cryptography.Oid)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.AlgorithmIdentifier.#ctor(System.Security.Cryptography.Oid)" /> constructor creates an instance of the <see cref="T:System.Security.Cryptography.Pkcs.AlgorithmIdentifier" /> class with the specified algorithm identifier.</summary>
<param name="oid">An object identifier for the algorithm.</param>
<exception cref="T:System.Security.Cryptography.CryptographicException">A cryptographic operation could not be completed.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.AlgorithmIdentifier.#ctor(System.Security.Cryptography.Oid,System.Int32)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.AlgorithmIdentifier.#ctor(System.Security.Cryptography.Oid,System.Int32)" /> constructor creates an instance of the <see cref="T:System.Security.Cryptography.Pkcs.AlgorithmIdentifier" /> class with the specified algorithm identifier and key length.</summary>
<param name="oid">An object identifier for the algorithm.</param>
<param name="keyLength">The length, in bits, of the key.</param>
<exception cref="T:System.Security.Cryptography.CryptographicException">A cryptographic operation could not be completed.</exception>
</member>
<member name="P:System.Security.Cryptography.Pkcs.AlgorithmIdentifier.KeyLength">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.AlgorithmIdentifier.KeyLength" /> property sets or retrieves the key length, in bits. This property is not used for algorithms that use a fixed key length.</summary>
<returns>An int value that represents the key length, in bits.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.AlgorithmIdentifier.Oid">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.AlgorithmIdentifier.Oid" /> property sets or retrieves the <see cref="T:System.Security.Cryptography.Oid" /> object that specifies the object identifier for the algorithm.</summary>
<returns>An <see cref="T:System.Security.Cryptography.Oid" /> object that represents the algorithm.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.AlgorithmIdentifier.Parameters">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.AlgorithmIdentifier.Parameters" /> property sets or retrieves any parameters required by the algorithm.</summary>
<returns>An array of byte values that specifies any parameters required by the algorithm.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.CmsRecipient">
<summary>The <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" /> class defines the recipient of a CMS/PKCS #7 message.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.CmsRecipient.#ctor(System.Security.Cryptography.Pkcs.SubjectIdentifierType,System.Security.Cryptography.X509Certificates.X509Certificate2)">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" /> class with a specified certificate and recipient identifier type, using the default encryption mode for the public key algorithm.</summary>
<param name="recipientIdentifierType">The scheme to use for identifying which recipient certificate was used.</param>
<param name="certificate">The certificate to use when encrypting for this recipient.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="certificate" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The <paramref name="recipientIdentifierType" /> value is not supported.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.CmsRecipient.#ctor(System.Security.Cryptography.Pkcs.SubjectIdentifierType,System.Security.Cryptography.X509Certificates.X509Certificate2,System.Security.Cryptography.RSAEncryptionPadding)">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" /> class with a specified RSA certificate, RSA encryption padding, and subject identifier.</summary>
<param name="recipientIdentifierType">The scheme to use for identifying which recipient certificate was used.</param>
<param name="certificate">The certificate to use when encrypting for this recipient.</param>
<param name="rsaEncryptionPadding">The RSA padding mode to use when encrypting for this recipient.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="certificate" /> or <paramref name="rsaEncryptionPadding" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The <paramref name="certificate" /> parameter public key is not recognized as an RSA public key.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.CmsRecipient.#ctor(System.Security.Cryptography.X509Certificates.X509Certificate2)">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" /> class with a specified certificate, using the default encryption mode for the public key algorithm and an <see cref="F:System.Security.Cryptography.Pkcs.SubjectIdentifierType.IssuerAndSerialNumber" /> subject identifier.</summary>
<param name="certificate">The certificate to use when encrypting for this recipient.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="certificate" /> parameter is <see langword="null" />.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.CmsRecipient.#ctor(System.Security.Cryptography.X509Certificates.X509Certificate2,System.Security.Cryptography.RSAEncryptionPadding)">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" /> class with a specified RSA certificate and RSA encryption padding, using an <see cref="F:System.Security.Cryptography.Pkcs.SubjectIdentifierType.IssuerAndSerialNumber" /> subject identifier.</summary>
<param name="certificate">The certificate to use when encrypting for this recipient.</param>
<param name="rsaEncryptionPadding">The RSA padding mode to use when encrypting for this recipient.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="certificate" /> or <paramref name="rsaEncryptionPadding" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The <paramref name="certificate" /> parameter public key is not recognized as an RSA public key.
-or-
The <paramref name="recipientIdentifierType" /> value is not supported.</exception>
</member>
<member name="P:System.Security.Cryptography.Pkcs.CmsRecipient.Certificate">
<summary>Gets the certificate to use when encrypting for this recipient.</summary>
<returns>The certificate to use when encrypting for this recipient.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.CmsRecipient.RecipientIdentifierType">
<summary>Gets the scheme to use for identifying which recipient certificate was used.</summary>
<returns>The scheme to use for identifying which recipient certificate was used.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.CmsRecipient.RSAEncryptionPadding">
<summary>Gets the RSA encryption padding to use when encrypting for this recipient.</summary>
<returns>The RSA encryption padding to use when encrypting for this recipient.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection">
<summary>The <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> class represents a set of <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" /> objects. <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> implements the <see cref="T:System.Collections.ICollection" /> interface.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.CmsRecipientCollection.#ctor">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.CmsRecipientCollection.#ctor" /> constructor creates an instance of the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> class.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.CmsRecipientCollection.#ctor(System.Security.Cryptography.Pkcs.CmsRecipient)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.CmsRecipientCollection.#ctor(System.Security.Cryptography.Pkcs.CmsRecipient)" /> constructor creates an instance of the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> class and adds the specified recipient.</summary>
<param name="recipient">An instance of the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" /> class that represents the specified CMS/PKCS #7 recipient.</param>
</member>
<member name="M:System.Security.Cryptography.Pkcs.CmsRecipientCollection.#ctor(System.Security.Cryptography.Pkcs.SubjectIdentifierType,System.Security.Cryptography.X509Certificates.X509Certificate2Collection)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.CmsRecipientCollection.#ctor(System.Security.Cryptography.Pkcs.SubjectIdentifierType,System.Security.Cryptography.X509Certificates.X509Certificate2Collection)" /> constructor creates an instance of the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> class and adds recipients based on the specified subject identifier and set of certificates that identify the recipients.</summary>
<param name="recipientIdentifierType">A member of the <see cref="T:System.Security.Cryptography.Pkcs.SubjectIdentifierType" /> enumeration that specifies the type of subject identifier.</param>
<param name="certificates">An <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2Collection" /> collection that contains the certificates that identify the recipients.</param>
</member>
<member name="M:System.Security.Cryptography.Pkcs.CmsRecipientCollection.Add(System.Security.Cryptography.Pkcs.CmsRecipient)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.CmsRecipientCollection.Add(System.Security.Cryptography.Pkcs.CmsRecipient)" /> method adds a recipient to the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> collection.</summary>
<param name="recipient">A <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" /> object that represents the recipient to add to the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> collection.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="recipient" /> is <see langword="null" />.</exception>
<returns>If the method succeeds, the method returns an <see cref="T:System.Int32" /> value that represents the zero-based position where the recipient is to be inserted.
If the method fails, it throws an exception.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.CmsRecipientCollection.CopyTo(System.Array,System.Int32)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.CmsRecipientCollection.CopyTo(System.Array,System.Int32)" /> method copies the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> collection to an array.</summary>
<param name="array">An <see cref="T:System.Array" /> object to which the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> collection is to be copied.</param>
<param name="index">The zero-based index in <paramref name="array" /> where the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> collection is copied.</param>
<exception cref="T:System.ArgumentException">
<paramref name="array" /> is not large enough to hold the specified elements.
-or-
<paramref name="array" /> does not contain the proper number of dimensions.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="array" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="index" /> is outside the range of elements in <paramref name="array" />.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.CmsRecipientCollection.CopyTo(System.Security.Cryptography.Pkcs.CmsRecipient[],System.Int32)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.CmsRecipientCollection.CopyTo(System.Security.Cryptography.Pkcs.CmsRecipient[],System.Int32)" /> method copies the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> collection to a <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" /> array.</summary>
<param name="array">An array of <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" /> objects where the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> collection is to be copied.</param>
<param name="index">The zero-based index for the array of <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" /> objects in <paramref name="array" /> to which the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> collection is copied.</param>
<exception cref="T:System.ArgumentException">
<paramref name="array" /> is not large enough to hold the specified elements.
-or-
<paramref name="array" /> does not contain the proper number of dimensions.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="array" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="index" /> is outside the range of elements in <paramref name="array" />.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.CmsRecipientCollection.GetEnumerator">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.CmsRecipientCollection.GetEnumerator" /> method returns a <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientEnumerator" /> object for the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> collection.</summary>
<returns>A <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientEnumerator" /> object that can be used to enumerate the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> collection.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.CmsRecipientCollection.Remove(System.Security.Cryptography.Pkcs.CmsRecipient)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.CmsRecipientCollection.Remove(System.Security.Cryptography.Pkcs.CmsRecipient)" /> method removes a recipient from the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> collection.</summary>
<param name="recipient">A <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" /> object that represents the recipient to remove from the collection.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="recipient" /> is <see langword="null" />.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.CmsRecipientCollection.System#Collections#IEnumerable#GetEnumerator">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.CmsRecipientCollection.System#Collections#IEnumerable#GetEnumerator" /> method returns a <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientEnumerator" /> object for the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> collection.</summary>
<returns>A <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientEnumerator" /> object that can be used to enumerate the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> collection.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.CmsRecipientCollection.Count">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.CmsRecipientCollection.Count" /> property retrieves the number of items in the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> collection.</summary>
<returns>An <see cref="T:System.Int32" /> value that represents the number of items in the collection.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.CmsRecipientCollection.IsSynchronized">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.CmsRecipientCollection.IsSynchronized" /> property retrieves whether access to the collection is synchronized, or thread safe. This property always returns <see langword="false" />, which means that the collection is not thread safe.</summary>
<returns>A <see cref="T:System.Boolean" /> value of <see langword="false" />, which means that the collection is not thread safe.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.CmsRecipientCollection.Item(System.Int32)">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.CmsRecipientCollection.Item(System.Int32)" /> property retrieves the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" /> object at the specified index in the collection.</summary>
<param name="index">An <see cref="T:System.Int32" /> value that represents the index in the collection. The index is zero based.</param>
<exception cref="T:System.ArgumentOutOfRangeException">The value of an argument was outside the allowable range of values as defined by the called method.</exception>
<returns>A <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" /> object at the specified index.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.CmsRecipientCollection.SyncRoot">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.CmsRecipientCollection.SyncRoot" /> property retrieves an <see cref="T:System.Object" /> object used to synchronize access to the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> collection.</summary>
<returns>An <see cref="T:System.Object" /> object that is used to synchronize access to the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> collection.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.CmsRecipientEnumerator">
<summary>The <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientEnumerator" /> class provides enumeration functionality for the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> collection. <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientEnumerator" /> implements the <see cref="T:System.Collections.IEnumerator" /> interface.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.CmsRecipientEnumerator.MoveNext">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.CmsRecipientEnumerator.MoveNext" /> method advances the enumeration to the next <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" /> object in the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> collection.</summary>
<returns>
<see langword="true" /> if the enumeration successfully moved to the next <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" /> object; <see langword="false" /> if the enumeration moved past the last item in the enumeration.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.CmsRecipientEnumerator.Reset">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.CmsRecipientEnumerator.Reset" /> method resets the enumeration to the first <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" /> object in the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> collection.</summary>
</member>
<member name="P:System.Security.Cryptography.Pkcs.CmsRecipientEnumerator.Current">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.CmsRecipientEnumerator.Current" /> property retrieves the current <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" /> object from the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> collection.</summary>
<returns>A <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" /> object that represents the current recipient in the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> collection.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.CmsRecipientEnumerator.System#Collections#IEnumerator#Current">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.CmsRecipientEnumerator.System#Collections#IEnumerator#Current" /> property retrieves the current <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" /> object from the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> collection.</summary>
<returns>A <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" /> object that represents the current recipient in the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> collection.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.CmsSigner">
<summary>Represents a potential signer for a CMS/PKCS#7 signed message.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.CmsSigner.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.CmsSigner" /> class with default values.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.CmsSigner.#ctor(System.Security.Cryptography.CspParameters)">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.CmsSigner" /> class from a persisted key.</summary>
<param name="parameters">The CSP parameters to describe which signing key to use.</param>
<exception cref="T:System.PlatformNotSupportedException">.NET Core only: This member is not supported.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.CmsSigner.#ctor(System.Security.Cryptography.Pkcs.SubjectIdentifierType)">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.CmsSigner" /> class with a specified subject identifier type.</summary>
<param name="signerIdentifierType">The scheme to use for identifying which signing certificate was used.</param>
</member>
<member name="M:System.Security.Cryptography.Pkcs.CmsSigner.#ctor(System.Security.Cryptography.Pkcs.SubjectIdentifierType,System.Security.Cryptography.X509Certificates.X509Certificate2)">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.CmsSigner" /> class with a specified signer certificate and subject identifier type.</summary>
<param name="signerIdentifierType">The scheme to use for identifying which signing certificate was used.</param>
<param name="certificate">The certificate whose private key will be used to sign a message.</param>
</member>
<member name="M:System.Security.Cryptography.Pkcs.CmsSigner.#ctor(System.Security.Cryptography.Pkcs.SubjectIdentifierType,System.Security.Cryptography.X509Certificates.X509Certificate2,System.Security.Cryptography.AsymmetricAlgorithm)">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.CmsSigner" /> class with a specified signer certificate, subject identifier type, and private key object.</summary>
<param name="signerIdentifierType">One of the enumeration values that specifies the scheme to use for identifying which signing certificate was used.</param>
<param name="certificate">The certificate whose private key will be used to sign a message.</param>
<param name="privateKey">The private key object to use when signing the message.</param>
</member>
<member name="M:System.Security.Cryptography.Pkcs.CmsSigner.#ctor(System.Security.Cryptography.X509Certificates.X509Certificate2)">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.CmsSigner" /> class with a specified signer certificate.</summary>
<param name="certificate">The certificate whose private key will be used to sign a message.</param>
</member>
<member name="P:System.Security.Cryptography.Pkcs.CmsSigner.Certificate">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.CmsSigner.Certificate" /> property sets or retrieves the <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2" /> object that represents the signing certificate.</summary>
<returns>An <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2" /> object that represents the signing certificate.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.CmsSigner.Certificates">
<summary>Gets a collection of certificates which are considered with <see cref="F:System.Security.Cryptography.X509Certificates.X509IncludeOption.WholeChain" /> and <see cref="F:System.Security.Cryptography.X509Certificates.X509IncludeOption.ExcludeRoot" />.</summary>
<returns>A collection of certificates which are considered with <see cref="F:System.Security.Cryptography.X509Certificates.X509IncludeOption.WholeChain" /> and <see cref="F:System.Security.Cryptography.X509Certificates.X509IncludeOption.ExcludeRoot" />.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.CmsSigner.DigestAlgorithm">
<summary>Gets or sets the algorithm identifier for the hash algorithm to use with the signature.</summary>
<returns>The algorithm identifier for the hash algorithm to use with the signature.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.CmsSigner.IncludeOption">
<summary>Gets or sets the option indicating how much of a the signer certificate's certificate chain should be embedded in the signed message.</summary>
<exception cref="T:System.ArgumentException">One of the arguments provided to a method was not valid.</exception>
<returns>One of the enumeration values that indicates how much of a the signer certificate's certificate chain should be embedded in the signed message.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.CmsSigner.PrivateKey">
<summary>Gets or sets the private key object to use during signing.</summary>
<returns>The private key to use during signing, or <see langword="null" /> to use the private key associated with the <see cref="P:System.Security.Cryptography.Pkcs.CmsSigner.Certificate" /> property.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.CmsSigner.SignedAttributes">
<summary>Gets a collections of attributes to associate with this signature that are also protected by the signature.</summary>
<returns>A collections of attributes to associate with this signature that are also protected by the signature.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.CmsSigner.SignerIdentifierType">
<summary>Gets the scheme to use for identifying which signing certificate was used.</summary>
<exception cref="T:System.ArgumentException">One of the arguments provided to a method was not valid.</exception>
<returns>The scheme to use for identifying which recipient certificate was used.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.CmsSigner.UnsignedAttributes">
<summary>Gets a collections of attributes to associate with this signature that are not protected by the signature.</summary>
<returns>A collections of attributes to associate with this signature that are not protected by the signature.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.ContentInfo">
<summary>The <see cref="T:System.Security.Cryptography.Pkcs.ContentInfo" /> class represents the CMS/PKCS #7 ContentInfo data structure as defined in the CMS/PKCS #7 standards document. This data structure is the basis for all CMS/PKCS #7 messages.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.ContentInfo.#ctor(System.Byte[])">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.ContentInfo.#ctor(System.Byte[])" /> constructor creates an instance of the <see cref="T:System.Security.Cryptography.Pkcs.ContentInfo" /> class by using an array of byte values as the data and a default <paramref name="object identifier" /> (OID) that represents the content type.</summary>
<param name="content">An array of byte values that represents the data from which to create the <see cref="T:System.Security.Cryptography.Pkcs.ContentInfo" /> object.</param>
<exception cref="T:System.ArgumentNullException">A null reference was passed to a method that does not accept it as a valid argument.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.ContentInfo.#ctor(System.Security.Cryptography.Oid,System.Byte[])">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.ContentInfo.#ctor(System.Security.Cryptography.Oid,System.Byte[])" /> constructor creates an instance of the <see cref="T:System.Security.Cryptography.Pkcs.ContentInfo" /> class by using the specified content type and an array of byte values as the data.</summary>
<param name="contentType">An <see cref="T:System.Security.Cryptography.Oid" /> object that contains an <c>object identifier</c> (OID) that specifies the content type of the content. This can be data, digestedData, encryptedData, envelopedData, hashedData, signedAndEnvelopedData, or signedData. For more information, see Remarks.</param>
<param name="content">An array of byte values that represents the data from which to create the <see cref="T:System.Security.Cryptography.Pkcs.ContentInfo" /> object.</param>
<exception cref="T:System.ArgumentNullException">A null reference was passed to a method that does not accept it as a valid argument.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.ContentInfo.GetContentType(System.Byte[])">
<summary>Retrieves the outer content type of an encoded CMS ContentInfo message.</summary>
<param name="encodedMessage">An array of byte values that represents the encoded CMS ContentInfo message from which to retrieve the outer content type.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="encodedMessage" /> is <see langword="null" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">
<paramref name="encodedMessage" /> cannot be decoded as a valid CMS ContentInfo value.</exception>
<returns>The outer content type of the specified encoded CMS ContentInfo message.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.ContentInfo.GetContentType(System.ReadOnlySpan{System.Byte})">
<summary>Retrieves the outer content type of an encoded CMS ContentInfo message.</summary>
<param name="encodedMessage">A read-only span of byte values that represents the encoded CMS ContentInfo message from which to retrieve the outer content type.</param>
<exception cref="T:System.Security.Cryptography.CryptographicException">
<paramref name="encodedMessage" /> cannot be decoded as a valid CMS ContentInfo value.</exception>
<returns>The outer content type of the specified encoded CMS ContentInfo message.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.ContentInfo.Content">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.ContentInfo.Content" /> property retrieves the content of the CMS/PKCS #7 message.</summary>
<returns>An array of byte values that represents the content data.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.ContentInfo.ContentType">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.ContentInfo.ContentType" /> property retrieves the <see cref="T:System.Security.Cryptography.Oid" /> object that contains the <paramref name="object identifier" /> (OID) of the content type of the inner content of the CMS/PKCS #7 message.</summary>
<returns>An <see cref="T:System.Security.Cryptography.Oid" /> object that contains the OID value that represents the content type.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.EnvelopedCms">
<summary>Represents a CMS/PKCS#7 structure for enveloped data.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.EnvelopedCms.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.EnvelopedCms" /> class with default values.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.EnvelopedCms.#ctor(System.Security.Cryptography.Pkcs.ContentInfo)">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.EnvelopedCms" /> class with specified content information.</summary>
<param name="contentInfo">The message content to encrypt.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="contentInfo" /> parameter is <see langword="null" />.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.EnvelopedCms.#ctor(System.Security.Cryptography.Pkcs.ContentInfo,System.Security.Cryptography.Pkcs.AlgorithmIdentifier)">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.EnvelopedCms" /> class with a specified symmetric encryption algorithm and content information.</summary>
<param name="contentInfo">The message content to encrypt.</param>
<param name="encryptionAlgorithm">The identifier for the symmetric encryption algorithm to use when encrypting the message content.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="contentInfo" /> or <paramref name="encryptionAlgorithm" /> parameter is <see langword="null" />.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.EnvelopedCms.Decode(System.Byte[])">
<summary>Decodes an array of bytes as a CMS/PKCS#7 EnvelopedData message.</summary>
<param name="encodedMessage">The byte array containing the sequence of bytes to decode.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="encodedMessage" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The <paramref name="encodedMessage" /> parameter was not successfully decoded.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.EnvelopedCms.Decode(System.ReadOnlySpan{System.Byte})">
<summary>Decodes the provided data as a CMS/PKCS#7 EnvelopedData message.</summary>
<param name="encodedMessage">The data to decode.</param>
<exception cref="T:System.Security.Cryptography.CryptographicException">The <paramref name="encodedMessage" /> parameter was not successfully decoded.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.EnvelopedCms.Decrypt">
<summary>Decrypts the contents of the decoded enveloped CMS/PKCS#7 message via any available recipient by searching certificate stores for a matching certificate and key.</summary>
<exception cref="T:System.Security.Cryptography.CryptographicException">A cryptographic operation could not be completed.</exception>
<exception cref="T:System.InvalidOperationException">A method call was invalid for the object's current state.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.EnvelopedCms.Decrypt(System.Security.Cryptography.Pkcs.RecipientInfo)">
<summary>Decrypts the contents of the decoded enveloped CMS/PKCS#7 message via a specified recipient info by searching certificate stores for a matching certificate and key.</summary>
<param name="recipientInfo">The recipient info to use for decryption.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="recipientInfo" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">A cryptographic operation could not be completed.</exception>
<exception cref="T:System.InvalidOperationException">A method call was invalid for the object's current state.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.EnvelopedCms.Decrypt(System.Security.Cryptography.Pkcs.RecipientInfo,System.Security.Cryptography.AsymmetricAlgorithm)">
<summary>Decrypts the contents of the decoded enveloped CMS/PKCS#7 message via a specified recipient info with a specified private key.</summary>
<param name="recipientInfo">The recipient info to use for decryption.</param>
<param name="privateKey">The private key to use to decrypt the recipient-specific information.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="recipientInfo" /> or <paramref name="privateKey" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">A cryptographic operation could not be completed.</exception>
<exception cref="T:System.InvalidOperationException">A method call was invalid for the object's current state.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.EnvelopedCms.Decrypt(System.Security.Cryptography.Pkcs.RecipientInfo,System.Security.Cryptography.X509Certificates.X509Certificate2Collection)">
<summary>Decrypts the contents of the decoded enveloped CMS/PKCS#7 message via a specified recipient info by searching certificate stores and a provided collection for a matching certificate and key.</summary>
<param name="recipientInfo">The recipient info to use for decryption.</param>
<param name="extraStore">A collection of certificates to use in addition to the certificate stores for finding a recipient certificate and private key.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="recipientInfo" /> or <paramref name="extraStore" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">A cryptographic operation could not be completed.</exception>
<exception cref="T:System.InvalidOperationException">A method call was invalid for the object's current state.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.EnvelopedCms.Decrypt(System.Security.Cryptography.X509Certificates.X509Certificate2Collection)">
<summary>Decrypts the contents of the decoded enveloped CMS/PKCS#7 message via any available recipient info by searching certificate stores and a provided collection for a matching certificate and key.</summary>
<param name="extraStore">A collection of certificates to use in addition to the certificate stores for finding a recipient certificate and private key.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="extraStore" /> parameter was <see langword="null" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">A cryptographic operation could not be completed.</exception>
<exception cref="T:System.InvalidOperationException">A method call was invalid for the object's current state.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.EnvelopedCms.Encode">
<summary>Encodes the contents of the enveloped CMS/PKCS#7 message and returns it as a byte array.</summary>
<exception cref="T:System.InvalidOperationException">A method call was invalid for the object's current state.</exception>
<returns>A byte array representing the encoded form of the CMS/PKCS#7 message.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.EnvelopedCms.Encrypt(System.Security.Cryptography.Pkcs.CmsRecipient)">
<summary>Encrypts the contents of the CMS/PKCS#7 message for a single specified recipient.</summary>
<param name="recipient">The recipient information describing the single recipient of this message.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="recipient" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">A cryptographic operation could not be completed.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.EnvelopedCms.Encrypt(System.Security.Cryptography.Pkcs.CmsRecipientCollection)">
<summary>Encrypts the contents of the CMS/PKCS#7 message for one or more recipients.</summary>
<param name="recipients">A collection describing the recipients for the message.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="recipients" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">A cryptographic operation could not be completed.</exception>
</member>
<member name="P:System.Security.Cryptography.Pkcs.EnvelopedCms.Certificates">
<summary>Gets the collection of certificates associated with the enveloped CMS/PKCS#7 message.</summary>
<returns>The collection of certificates associated with the enveloped CMS/PKCS#7 message.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.EnvelopedCms.ContentEncryptionAlgorithm">
<summary>Gets the identifier of the symmetric encryption algorithm associated with this message.</summary>
<returns>The identifier of the symmetric encryption algorithm associated with this message.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.EnvelopedCms.ContentInfo">
<summary>Gets the content information for the enveloped CMS/PKCS#7 message.</summary>
<returns>The content information for the enveloped CMS/PKCS#7 message.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.EnvelopedCms.RecipientInfos">
<summary>Gets a collection that represents the recipients list for a decoded message. The default value is an empty collection.</summary>
<returns>A collection that represents the recipients list for a decoded message. The default value is an empty collection.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.EnvelopedCms.UnprotectedAttributes">
<summary>Gets the collection of unprotected (unencrypted) attributes associated with the enveloped CMS/PKCS#7 message.</summary>
<returns>The collection of unprotected (unencrypted) attributes associated with the enveloped CMS/PKCS#7 message.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.EnvelopedCms.Version">
<summary>Gets the version of the decoded enveloped CMS/PKCS#7 message.</summary>
<returns>The version of the decoded enveloped CMS/PKCS#7 message.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.KeyAgreeRecipientInfo">
<summary>The <see cref="T:System.Security.Cryptography.Pkcs.KeyAgreeRecipientInfo" /> class defines key agreement recipient information. Key agreement algorithms typically use the Diffie-Hellman key agreement algorithm, in which the two parties that establish a shared cryptographic key both take part in its generation and, by definition, agree on that key. This is in contrast to key transport algorithms, in which one party generates the key unilaterally and sends, or transports it, to the other party.</summary>
</member>
<member name="P:System.Security.Cryptography.Pkcs.KeyAgreeRecipientInfo.Date">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.KeyAgreeRecipientInfo.Date" /> property retrieves the date and time of the start of the key agreement protocol by the originator.</summary>
<exception cref="T:System.InvalidOperationException">The recipient identifier type is not a subject key identifier.</exception>
<returns>The date and time of the start of the key agreement protocol by the originator.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.KeyAgreeRecipientInfo.EncryptedKey">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.KeyAgreeRecipientInfo.EncryptedKey" /> property retrieves the encrypted recipient keying material.</summary>
<returns>An array of byte values that contain the encrypted recipient keying material.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.KeyAgreeRecipientInfo.KeyEncryptionAlgorithm">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.KeyAgreeRecipientInfo.KeyEncryptionAlgorithm" /> property retrieves the algorithm used to perform the key agreement.</summary>
<returns>The value of the algorithm used to perform the key agreement.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.KeyAgreeRecipientInfo.OriginatorIdentifierOrKey">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.KeyAgreeRecipientInfo.OriginatorIdentifierOrKey" /> property retrieves information about the originator of the key agreement for key agreement algorithms that warrant it.</summary>
<returns>An object that contains information about the originator of the key agreement.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.KeyAgreeRecipientInfo.OtherKeyAttribute">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.KeyAgreeRecipientInfo.OtherKeyAttribute" /> property retrieves attributes of the keying material.</summary>
<exception cref="T:System.InvalidOperationException">The recipient identifier type is not a subject key identifier.</exception>
<returns>The attributes of the keying material.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.KeyAgreeRecipientInfo.RecipientIdentifier">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.KeyAgreeRecipientInfo.RecipientIdentifier" /> property retrieves the identifier of the recipient.</summary>
<returns>The identifier of the recipient.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.KeyAgreeRecipientInfo.Version">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.KeyAgreeRecipientInfo.Version" /> property retrieves the version of the key agreement recipient. This is automatically set for objects in this class, and the value implies that the recipient is taking part in a key agreement algorithm.</summary>
<returns>The version of the <see cref="T:System.Security.Cryptography.Pkcs.KeyAgreeRecipientInfo" /> object.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.KeyTransRecipientInfo">
<summary>The <see cref="T:System.Security.Cryptography.Pkcs.KeyTransRecipientInfo" /> class defines key transport recipient information. Key transport algorithms typically use the RSA algorithm, in which an originator establishes a shared cryptographic key with a recipient by generating that key and then transporting it to the recipient. This is in contrast to key agreement algorithms, in which the two parties that will be using a cryptographic key both take part in its generation, thereby mutually agreeing to that key.</summary>
</member>
<member name="P:System.Security.Cryptography.Pkcs.KeyTransRecipientInfo.EncryptedKey">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.KeyTransRecipientInfo.EncryptedKey" /> property retrieves the encrypted key for this key transport recipient.</summary>
<returns>An array of byte values that represents the encrypted key.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.KeyTransRecipientInfo.KeyEncryptionAlgorithm">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.KeyTransRecipientInfo.KeyEncryptionAlgorithm" /> property retrieves the key encryption algorithm used to encrypt the content encryption key.</summary>
<returns>An <see cref="T:System.Security.Cryptography.Pkcs.AlgorithmIdentifier" /> object that stores the key encryption algorithm identifier.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.KeyTransRecipientInfo.RecipientIdentifier">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.KeyTransRecipientInfo.RecipientIdentifier" /> property retrieves the subject identifier associated with the encrypted content.</summary>
<returns>A <see cref="T:System.Security.Cryptography.Pkcs.SubjectIdentifier" /> object that stores the identifier of the recipient taking part in the key transport.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.KeyTransRecipientInfo.Version">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.KeyTransRecipientInfo.Version" /> property retrieves the version of the key transport recipient. The version of the key transport recipient is automatically set for objects in this class, and the value implies that the recipient is taking part in a key transport algorithm.</summary>
<returns>An int value that represents the version of the key transport <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfo" /> object.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.Pkcs12Builder">
<summary>Enables the creation of PKCS#12 PFX data values. This class cannot be inherited.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12Builder.#ctor">
<summary>Initializes a new value of the <see cref="T:System.Security.Cryptography.Pkcs.Pkcs12Builder" /> class.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12Builder.AddSafeContentsEncrypted(System.Security.Cryptography.Pkcs.Pkcs12SafeContents,System.Byte[],System.Security.Cryptography.PbeParameters)">
<summary>Add contents to the PFX in an bundle encrypted with a byte-based password from a byte array.</summary>
<param name="safeContents">The contents to add to the PFX.</param>
<param name="passwordBytes">The byte array to use as a password when encrypting the contents.</param>
<param name="pbeParameters">The password-based encryption (PBE) parameters to use when encrypting the contents.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="safeContents" /> or <paramref name="pbeParameters" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">The <paramref name="safeContents" /> parameter value is already encrypted.</exception>
<exception cref="T:System.InvalidOperationException">The PFX is already sealed (<see cref="P:System.Security.Cryptography.Pkcs.Pkcs12Builder.IsSealed" /> is <see langword="true" />).</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">
<paramref name="pbeParameters" /> indicates that <see cref="F:System.Security.Cryptography.PbeEncryptionAlgorithm.TripleDes3KeyPkcs12" /> should be used, which requires <see cref="T:System.Char" />-based passwords.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12Builder.AddSafeContentsEncrypted(System.Security.Cryptography.Pkcs.Pkcs12SafeContents,System.ReadOnlySpan{System.Byte},System.Security.Cryptography.PbeParameters)">
<summary>Add contents to the PFX in an bundle encrypted with a byte-based password from a span.</summary>
<param name="safeContents">The contents to add to the PFX.</param>
<param name="passwordBytes">The byte span to use as a password when encrypting the contents.</param>
<param name="pbeParameters">The password-based encryption (PBE) parameters to use when encrypting the contents.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="safeContents" /> or <paramref name="pbeParameters" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">The <paramref name="safeContents" /> parameter value is already encrypted.</exception>
<exception cref="T:System.InvalidOperationException">The PFX is already sealed (<see cref="P:System.Security.Cryptography.Pkcs.Pkcs12Builder.IsSealed" /> is <see langword="true" />).</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">
<paramref name="pbeParameters" /> indicates that <see cref="F:System.Security.Cryptography.PbeEncryptionAlgorithm.TripleDes3KeyPkcs12" /> should be used, which requires <see cref="T:System.Char" />-based passwords.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12Builder.AddSafeContentsEncrypted(System.Security.Cryptography.Pkcs.Pkcs12SafeContents,System.ReadOnlySpan{System.Char},System.Security.Cryptography.PbeParameters)">
<summary>Add contents to the PFX in an bundle encrypted with a char-based password from a span.</summary>
<param name="safeContents">The contents to add to the PFX.</param>
<param name="password">The span to use as a password when encrypting the contents.</param>
<param name="pbeParameters">The password-based encryption (PBE) parameters to use when encrypting the contents.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="safeContents" /> or <paramref name="pbeParameters" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">The <paramref name="safeContents" /> parameter value is already encrypted.</exception>
<exception cref="T:System.InvalidOperationException">The PFX is already sealed (<see cref="P:System.Security.Cryptography.Pkcs.Pkcs12Builder.IsSealed" /> is <see langword="true" />).</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12Builder.AddSafeContentsEncrypted(System.Security.Cryptography.Pkcs.Pkcs12SafeContents,System.String,System.Security.Cryptography.PbeParameters)">
<summary>Add contents to the PFX in an bundle encrypted with a char-based password from a string.</summary>
<param name="safeContents">The contents to add to the PFX.</param>
<param name="password">The string to use as a password when encrypting the contents.</param>
<param name="pbeParameters">The password-based encryption (PBE) parameters to use when encrypting the contents.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="safeContents" /> or <paramref name="pbeParameters" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">The <paramref name="safeContents" /> parameter value is already encrypted.</exception>
<exception cref="T:System.InvalidOperationException">The PFX is already sealed (<see cref="P:System.Security.Cryptography.Pkcs.Pkcs12Builder.IsSealed" /> is <see langword="true" />).</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12Builder.AddSafeContentsUnencrypted(System.Security.Cryptography.Pkcs.Pkcs12SafeContents)">
<summary>Add contents to the PFX without encrypting them.</summary>
<param name="safeContents">The contents to add to the PFX.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="safeContents" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The PFX is already sealed (<see cref="P:System.Security.Cryptography.Pkcs.Pkcs12Builder.IsSealed" /> is <see langword="true" />).</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12Builder.Encode">
<summary>Encodes the contents of a sealed PFX and returns it as a byte array.</summary>
<exception cref="T:System.InvalidOperationException">The PFX is not sealed (<see cref="P:System.Security.Cryptography.Pkcs.Pkcs12Builder.IsSealed" /> is <see langword="false" />).</exception>
<returns>A byte array representing the encoded form of the PFX.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12Builder.SealWithMac(System.ReadOnlySpan{System.Char},System.Security.Cryptography.HashAlgorithmName,System.Int32)">
<summary>Seals the PFX against further changes by applying a password-based Message Authentication Code (MAC) over the contents with a password from a span.</summary>
<param name="password">The password to use as a key for computing the MAC.</param>
<param name="hashAlgorithm">The hash algorithm to use when computing the MAC.</param>
<param name="iterationCount">The iteration count for the Key Derivation Function (KDF) used in computing the MAC.</param>
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="iterationCount" /> parameter is less than or equal to 0.</exception>
<exception cref="T:System.InvalidOperationException">The PFX is already sealed (<see cref="P:System.Security.Cryptography.Pkcs.Pkcs12Builder.IsSealed" /> is <see langword="true" />).</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12Builder.SealWithMac(System.String,System.Security.Cryptography.HashAlgorithmName,System.Int32)">
<summary>Seals the PFX against further changes by applying a password-based Message Authentication Code (MAC) over the contents with a password from a string.</summary>
<param name="password">The password to use as a key for computing the MAC.</param>
<param name="hashAlgorithm">The hash algorithm to use when computing the MAC.</param>
<param name="iterationCount">The iteration count for the Key Derivation Function (KDF) used in computing the MAC.</param>
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="iterationCount" /> parameter is less than or equal to 0.</exception>
<exception cref="T:System.InvalidOperationException">The PFX is already sealed (<see cref="P:System.Security.Cryptography.Pkcs.Pkcs12Builder.IsSealed" /> is <see langword="true" />).</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12Builder.SealWithoutIntegrity">
<summary>Seals the PFX from further changes without applying tamper-protection.</summary>
<exception cref="T:System.InvalidOperationException">The PFX is already sealed (<see cref="P:System.Security.Cryptography.Pkcs.Pkcs12Builder.IsSealed" /> is <see langword="true" />).</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12Builder.TryEncode(System.Span{System.Byte},System.Int32@)">
<summary>Attempts to encode the contents of a sealed PFX into a provided buffer.</summary>
<param name="destination">The byte span to receive the PKCS#12 PFX data.</param>
<param name="bytesWritten">When this method returns, contains a value that indicates the number of bytes written to <paramref name="destination" />. This parameter is treated as uninitialized.</param>
<exception cref="T:System.InvalidOperationException">The PFX is not sealed (<see cref="P:System.Security.Cryptography.Pkcs.Pkcs12Builder.IsSealed" /> is <see langword="false" />).</exception>
<returns>
<see langword="true" /> if <paramref name="destination" /> is big enough to receive the output; otherwise, <see langword="false" />.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Pkcs12Builder.IsSealed">
<summary>Gets a value that indicates whether the PFX data has been sealed.</summary>
<returns>A value that indicates whether the PFX data has been sealed.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.Pkcs12CertBag">
<summary>Represents the PKCS#12 CertBag. This class cannot be inherited.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12CertBag.#ctor(System.Security.Cryptography.Oid,System.ReadOnlyMemory{System.Byte})">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.Pkcs12CertBag" /> class using the specified certificate type and encoding.</summary>
<param name="certificateType">The Object Identifier (OID) for the certificate type.</param>
<param name="encodedCertificate">The encoded certificate value.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="certificateType" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The <paramref name="encodedCertificate" /> parameter does not represent a single ASN.1 BER-encoded value.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12CertBag.GetCertificate">
<summary>Gets the contents of the CertBag interpreted as an X.509 public key certificate.</summary>
<exception cref="T:System.InvalidOperationException">The content type is not the X.509 public key certificate content type.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The contents were not valid for the X.509 certificate content type.</exception>
<returns>A certificate decoded from the contents of the CertBag.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12CertBag.GetCertificateType">
<summary>Gets the Object Identifier (OID) which identifies the content type of the encoded certificte value.</summary>
<returns>The Object Identifier (OID) which identifies the content type of the encoded certificate value.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Pkcs12CertBag.EncodedCertificate">
<summary>Gets the uninterpreted certificate contents of the CertSafeBag.</summary>
<returns>The uninterpreted certificate contents of the CertSafeBag.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Pkcs12CertBag.IsX509Certificate">
<summary>Gets a value indicating whether the content type of the encoded certificate value is the X.509 public key certificate content type.</summary>
<returns>
<see langword="true" /> if the content type is the X.509 public key certificate content type (1.2.840.113549.1.9.22.1); otherwise, <see langword="false" />.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.Pkcs12ConfidentialityMode">
<summary>Represents the kind of encryption associated with a PKCS#12 SafeContents value.</summary>
</member>
<member name="F:System.Security.Cryptography.Pkcs.Pkcs12ConfidentialityMode.None">
<summary>The SafeContents value is not encrypted.</summary>
</member>
<member name="F:System.Security.Cryptography.Pkcs.Pkcs12ConfidentialityMode.Password">
<summary>The SafeContents value is encrypted with a password.</summary>
</member>
<member name="F:System.Security.Cryptography.Pkcs.Pkcs12ConfidentialityMode.PublicKey">
<summary>The SafeContents value is encrypted using public key cryptography.</summary>
</member>
<member name="F:System.Security.Cryptography.Pkcs.Pkcs12ConfidentialityMode.Unknown">
<summary>The kind of encryption applied to the SafeContents is unknown or could not be determined.</summary>
</member>
<member name="T:System.Security.Cryptography.Pkcs.Pkcs12Info">
<summary>Represents the data from PKCS#12 PFX contents. This class cannot be inherited.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12Info.Decode(System.ReadOnlyMemory{System.Byte},System.Int32@,System.Boolean)">
<summary>Reads the provided data as a PKCS#12 PFX and returns an object view of the contents.</summary>
<param name="encodedBytes">The data to interpret as a PKCS#12 PFX.</param>
<param name="bytesConsumed">When this method returns, contains a value that indicates the number of bytes from <paramref name="encodedBytes" /> which were read by this method. This parameter is treated as uninitialized.</param>
<param name="skipCopy">
<see langword="true" /> to store <paramref name="encodedBytes" /> without making a defensive copy; otherwise, <see langword="false" />. The default is <see langword="false" />.</param>
<exception cref="T:System.Security.Cryptography.CryptographicException">The contents of the <paramref name="encodedBytes" /> parameter were not successfully decoded as a PKCS#12 PFX.</exception>
<returns>An object view of the PKCS#12 PFX decoded from the input.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12Info.VerifyMac(System.ReadOnlySpan{System.Char})">
<summary>Attempts to verify the integrity of the <see cref="P:System.Security.Cryptography.Pkcs.Pkcs12Info.AuthenticatedSafe" /> contents with a password represented by a <c>System.ReadOnlySpan{System.Char}</c>.</summary>
<param name="password">The password to use to attempt to verify integrity.</param>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.Security.Cryptography.Pkcs.Pkcs12Info.IntegrityMode" /> value is not <see cref="F:System.Security.Cryptography.Pkcs.Pkcs12IntegrityMode.Password" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The hash algorithm option specified by the PKCS#12 PFX contents could not be identified or is not supported by this platform.</exception>
<returns>
<see langword="true" /> if the password successfully verifies the integrity of the <see cref="P:System.Security.Cryptography.Pkcs.Pkcs12Info.AuthenticatedSafe" /> contents; <see langword="false" /> if the password is not correct or the contents have been altered.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12Info.VerifyMac(System.String)">
<summary>Attempts to verify the integrity of the <see cref="P:System.Security.Cryptography.Pkcs.Pkcs12Info.AuthenticatedSafe" /> contents with a password represented by a <see cref="T:System.String" />.</summary>
<param name="password">The password to use to attempt to verify integrity.</param>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.Security.Cryptography.Pkcs.Pkcs12Info.IntegrityMode" /> value is not <see cref="F:System.Security.Cryptography.Pkcs.Pkcs12IntegrityMode.Password" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The hash algorithm option specified by the PKCS#12 PFX contents could not be identified or is not supported by this platform.</exception>
<returns>
<see langword="true" /> if the password successfully verifies the integrity of the <see cref="P:System.Security.Cryptography.Pkcs.Pkcs12Info.AuthenticatedSafe" /> contents; <see langword="false" /> if the password is not correct or the contents have been altered.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Pkcs12Info.AuthenticatedSafe">
<summary>Gets a read-only collection of the SafeContents values present in the PFX AuthenticatedSafe.</summary>
<returns>A read-only collection of the SafeContents values present in the PFX AuthenticatedSafe.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Pkcs12Info.IntegrityMode">
<summary>Gets a value that indicates the type of tamper protection provided for the <see cref="P:System.Security.Cryptography.Pkcs.Pkcs12Info.AuthenticatedSafe" /> contents.</summary>
<returns>One of the enumeration members that indicates the type of tamper protection provided for the <see cref="P:System.Security.Cryptography.Pkcs.Pkcs12Info.AuthenticatedSafe" /> contents.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.Pkcs12IntegrityMode">
<summary>Represents the type of anti-tampering applied to a PKCS#12 PFX value.</summary>
</member>
<member name="F:System.Security.Cryptography.Pkcs.Pkcs12IntegrityMode.None">
<summary>The PKCS#12 PFX value is not protected from tampering.</summary>
</member>
<member name="F:System.Security.Cryptography.Pkcs.Pkcs12IntegrityMode.Password">
<summary>The PKCS#12 PFX value is protected from tampering with a Message Authentication Code (MAC) keyed with a password.</summary>
</member>
<member name="F:System.Security.Cryptography.Pkcs.Pkcs12IntegrityMode.PublicKey">
<summary>The PKCS#12 PFX value is protected from tampering with a digital signature using public key cryptography.</summary>
</member>
<member name="F:System.Security.Cryptography.Pkcs.Pkcs12IntegrityMode.Unknown">
<summary>The type of anti-tampering applied to the PKCS#12 PFX is unknown or could not be determined.</summary>
</member>
<member name="T:System.Security.Cryptography.Pkcs.Pkcs12KeyBag">
<summary>Represents the KeyBag from PKCS#12, a container whose contents are a PKCS#8 PrivateKeyInfo. This class cannot be inherited.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12KeyBag.#ctor(System.ReadOnlyMemory{System.Byte},System.Boolean)">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.Pkcs12KeyBag" /> from an existing encoded PKCS#8 PrivateKeyInfo value.</summary>
<param name="pkcs8PrivateKey">A BER-encoded PKCS#8 PrivateKeyInfo value.</param>
<param name="skipCopy">
<see langword="true" /> to store <paramref name="pkcs8PrivateKey" /> without making a defensive copy; otherwise, <see langword="false" />. The default is <see langword="false" />.</param>
<exception cref="T:System.Security.Cryptography.CryptographicException">The <paramref name="pkcs8privateKey" /> parameter does not represent a single ASN.1 BER-encoded value.</exception>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Pkcs12KeyBag.Pkcs8PrivateKey">
<summary>Gets a memory value containing the PKCS#8 PrivateKeyInfo value transported by this bag.</summary>
<returns>A memory value containing the PKCS#8 PrivateKeyInfo value transported by this bag.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.Pkcs12SafeBag">
<summary>Defines the core behavior of a SafeBag value from the PKCS#12 specification and provides a base for derived classes.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12SafeBag.#ctor(System.String,System.ReadOnlyMemory{System.Byte},System.Boolean)">
<summary>Called from constructors in derived classes to initialize the <see cref="T:System.Security.Cryptography.Pkcs.Pkcs12SafeBag" /> class.</summary>
<param name="bagIdValue">The Object Identifier (OID), in dotted decimal form, indicating the data type of this SafeBag.</param>
<param name="encodedBagValue">The ASN.1 BER encoded value of the SafeBag contents.</param>
<param name="skipCopy">
<see langword="true" /> to store <paramref name="encodedBagValue" /> without making a defensive copy; otherwise, <see langword="false" />. The default is <see langword="false" />.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="bagIdValue" /> parameter is <see langword="null" /> or the empty string.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The <paramref name="encodedBagValue" /> parameter does not represent a single ASN.1 BER-encoded value.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12SafeBag.Encode">
<summary>Encodes the SafeBag value and returns it as a byte array.</summary>
<exception cref="T:System.Security.Cryptography.CryptographicException">The object identifier value passed to the constructor was invalid.</exception>
<returns>A byte array representing the encoded form of the SafeBag.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12SafeBag.GetBagId">
<summary>Gets the Object Identifier (OID) identifying the content type of this SafeBag.</summary>
<returns>The Object Identifier (OID) identifying the content type of this SafeBag.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12SafeBag.TryEncode(System.Span{System.Byte},System.Int32@)">
<summary>Attempts to encode the SafeBag value into a provided buffer.</summary>
<param name="destination">The byte span to receive the encoded SafeBag value.</param>
<param name="bytesWritten">When this method returns, contains a value that indicates the number of bytes written to <paramref name="destination" />. This parameter is treated as uninitialized.</param>
<exception cref="T:System.Security.Cryptography.CryptographicException">The object identifier value passed to the constructor was invalid.</exception>
<returns>
<see langword="true" /> if <paramref name="destination" /> is big enough to receive the output; otherwise, <see langword="false" />.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Pkcs12SafeBag.Attributes">
<summary>Gets the modifiable collection of attributes to encode with the SafeBag value.</summary>
<returns>The modifiable collection of attributes to encode with the SafeBag value.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Pkcs12SafeBag.EncodedBagValue">
<summary>Gets the ASN.1 BER encoding of the contents of this SafeBag.</summary>
<returns>The ASN.1 BER encoding of the contents of this SafeBag.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.Pkcs12SafeContents">
<summary>Represents a PKCS#12 SafeContents value. This class cannot be inherited.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12SafeContents.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.Pkcs12SafeContents" /> class.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12SafeContents.AddCertificate(System.Security.Cryptography.X509Certificates.X509Certificate2)">
<summary>Adds a certificate to the SafeContents via a new <see cref="T:System.Security.Cryptography.Pkcs.Pkcs12CertBag" /> and returns the newly created bag instance.</summary>
<param name="certificate">The certificate to add.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="certificate" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">This instance is read-only.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The <paramref name="certificate" /> parameter is in an invalid state.</exception>
<returns>The bag instance which was added to the SafeContents.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12SafeContents.AddKeyUnencrypted(System.Security.Cryptography.AsymmetricAlgorithm)">
<summary>Adds an asymmetric private key to the SafeContents via a new <see cref="T:System.Security.Cryptography.Pkcs.Pkcs12KeyBag" /> and returns the newly created bag instance.</summary>
<param name="key">The asymmetric private key to add.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="key" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">This instance is read-only.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The key export failed.</exception>
<returns>The bag instance which was added to the SafeContents.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12SafeContents.AddNestedContents(System.Security.Cryptography.Pkcs.Pkcs12SafeContents)">
<summary>Adds a nested SafeContents to the SafeContents via a new <see cref="T:System.Security.Cryptography.Pkcs.Pkcs12SafeContentsBag" /> and returns the newly created bag instance.</summary>
<param name="safeContents">The nested contents to add to the SafeContents.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="safeContents" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">The <paramref name="safeContents" /> parameter is encrypted.</exception>
<exception cref="T:System.InvalidOperationException">This instance is read-only.</exception>
<returns>The bag instance which was added to the SafeContents.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12SafeContents.AddSafeBag(System.Security.Cryptography.Pkcs.Pkcs12SafeBag)">
<summary>Adds a SafeBag to the SafeContents.</summary>
<param name="safeBag">The SafeBag value to add.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="safeBag" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">This instance is read-only.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12SafeContents.AddSecret(System.Security.Cryptography.Oid,System.ReadOnlyMemory{System.Byte})">
<summary>Adds an ASN.1 BER-encoded value with a specified type identifier to the SafeContents via a new <see cref="T:System.Security.Cryptography.Pkcs.Pkcs12SecretBag" /> and returns the newly created bag instance.</summary>
<param name="secretType">The Object Identifier (OID) which identifies the data type of the secret value.</param>
<param name="secretValue">The BER-encoded value representing the secret to add.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="secretType" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">This instance is read-only.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The <paramref name="secretValue" /> parameter does not represent a single ASN.1 BER-encoded value.</exception>
<returns>The bag instance which was added to the SafeContents.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12SafeContents.AddShroudedKey(System.Security.Cryptography.AsymmetricAlgorithm,System.Byte[],System.Security.Cryptography.PbeParameters)">
<summary>Adds an encrypted asymmetric private key to the SafeContents via a new <see cref="T:System.Security.Cryptography.Pkcs.Pkcs12ShroudedKeyBag" /> from a byte-based password in an array and returns the newly created bag instance.</summary>
<param name="key">The asymmetric private key to add.</param>
<param name="passwordBytes">The bytes to use as a password when encrypting the key material.</param>
<param name="pbeParameters">The password-based encryption (PBE) parameters to use when encrypting the key material.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="key" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">This instance is read-only.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The key export failed.</exception>
<returns>The bag instance which was added to the SafeContents.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12SafeContents.AddShroudedKey(System.Security.Cryptography.AsymmetricAlgorithm,System.ReadOnlySpan{System.Byte},System.Security.Cryptography.PbeParameters)">
<summary>Adds an encrypted asymmetric private key to the SafeContents via a new <see cref="T:System.Security.Cryptography.Pkcs.Pkcs12ShroudedKeyBag" /> from a byte-based password in a span and returns the newly created bag instance.</summary>
<param name="key">The asymmetric private key to add.</param>
<param name="passwordBytes">The bytes to use as a password when encrypting the key material.</param>
<param name="pbeParameters">The password-based encryption (PBE) parameters to use when encrypting the key material.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="key" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">This instance is read-only.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The key export failed.</exception>
<returns>The bag instance which was added to the SafeContents.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12SafeContents.AddShroudedKey(System.Security.Cryptography.AsymmetricAlgorithm,System.ReadOnlySpan{System.Char},System.Security.Cryptography.PbeParameters)">
<summary>Adds an encrypted asymmetric private key to the SafeContents via a new <see cref="T:System.Security.Cryptography.Pkcs.Pkcs12ShroudedKeyBag" /> from a character-based password in a span and returns the newly created bag instance.</summary>
<param name="key">The asymmetric private key to add.</param>
<param name="password">The password to use when encrypting the key material.</param>
<param name="pbeParameters">The password-based encryption (PBE) parameters to use when encrypting the key material.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="key" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">This instance is read-only.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The key export failed.</exception>
<returns>The bag instance which was added to the SafeContents.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12SafeContents.AddShroudedKey(System.Security.Cryptography.AsymmetricAlgorithm,System.String,System.Security.Cryptography.PbeParameters)">
<summary>Adds an encrypted asymmetric private key to the SafeContents via a new <see cref="T:System.Security.Cryptography.Pkcs.Pkcs12ShroudedKeyBag" /> from a character-based password in a string and returns the newly created bag instance.</summary>
<param name="key">The asymmetric private key to add.</param>
<param name="password">The password to use when encrypting the key material.</param>
<param name="pbeParameters">The password-based encryption (PBE) parameters to use when encrypting the key material.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="key" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">This instance is read-only.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The key export failed.</exception>
<returns>The bag instance which was added to the SafeContents.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12SafeContents.Decrypt(System.Byte[])">
<summary>Decrypts the contents of this SafeContents value using a byte-based password from an array.</summary>
<param name="passwordBytes">The bytes to use as a password for decrypting the encrypted contents.</param>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.Security.Cryptography.Pkcs.Pkcs12SafeContents.ConfidentialityMode" /> property is not <see cref="F:System.Security.Cryptography.Pkcs.Pkcs12ConfidentialityMode.Password" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The password is incorrect.
-or-
The contents were not successfully decrypted.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12SafeContents.Decrypt(System.ReadOnlySpan{System.Byte})">
<summary>Decrypts the contents of this SafeContents value using a byte-based password from a span.</summary>
<param name="passwordBytes">The bytes to use as a password for decrypting the encrypted contents.</param>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.Security.Cryptography.Pkcs.Pkcs12SafeContents.ConfidentialityMode" /> property is not <see cref="F:System.Security.Cryptography.Pkcs.Pkcs12ConfidentialityMode.Password" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The password is incorrect.
-or-
The contents were not successfully decrypted.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12SafeContents.Decrypt(System.ReadOnlySpan{System.Char})">
<summary>Decrypts the contents of this SafeContents value using a character-based password from a span.</summary>
<param name="password">The password to use for decrypting the encrypted contents.</param>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.Security.Cryptography.Pkcs.Pkcs12SafeContents.ConfidentialityMode" /> property is not <see cref="F:System.Security.Cryptography.Pkcs.Pkcs12ConfidentialityMode.Password" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The password is incorrect.
-or-
The contents were not successfully decrypted.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12SafeContents.Decrypt(System.String)">
<summary>Decrypts the contents of this SafeContents value using a character-based password from a string.</summary>
<param name="password">The password to use for decrypting the encrypted contents.</param>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.Security.Cryptography.Pkcs.Pkcs12SafeContents.ConfidentialityMode" /> property is not <see cref="F:System.Security.Cryptography.Pkcs.Pkcs12ConfidentialityMode.Password" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The password is incorrect.
-or-
The contents were not successfully decrypted.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12SafeContents.GetBags">
<summary>Gets an enumerable representation of the SafeBag values contained within the SafeContents.</summary>
<exception cref="T:System.InvalidOperationException">The contents are encrypted.</exception>
<returns>An enumerable representation of the SafeBag values contained within the SafeContents.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Pkcs12SafeContents.ConfidentialityMode">
<summary>Gets a value that indicates the type of encryption applied to the contents.</summary>
<returns>One of the enumeration values that indicates the type of encryption applied to the contents. The default value is <see cref="F:System.Security.Cryptography.Pkcs.Pkcs12ConfidentialityMode.None" />.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Pkcs12SafeContents.IsReadOnly">
<summary>Gets a value that indicates whether this instance in a read-only state.</summary>
<returns>
<see langword="true" /> if this value is in a read-only state; otherwise, <see langword="false" />. The default value is <see langword="false" />.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.Pkcs12SafeContentsBag">
<summary>Represents the SafeContentsBag from PKCS#12, a container whose contents are a PKCS#12 SafeContents value. This class cannot be inherited.</summary>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Pkcs12SafeContentsBag.SafeContents">
<summary>Gets the SafeContents value contained within this bag.</summary>
<returns>The SafeContents value contained within this bag.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.Pkcs12SecretBag">
<summary>Represents the SecretBag from PKCS#12, a container whose contents are arbitrary data with a type identifier. This class cannot be inherited.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12SecretBag.GetSecretType">
<summary>Gets the Object Identifier (OID) which identifies the data type of the secret value.</summary>
<returns>The Object Identifier (OID) which identifies the data type of the secret value.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Pkcs12SecretBag.SecretValue">
<summary>Gets a memory value containing the BER-encoded contents of the bag.</summary>
<returns>A memory value containing the BER-encoded contents of the bag.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.Pkcs12ShroudedKeyBag">
<summary>Represents the ShroudedKeyBag from PKCS#12, a container whose contents are a PKCS#8 EncryptedPrivateKeyInfo. This class cannot be inherited.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12ShroudedKeyBag.#ctor(System.ReadOnlyMemory{System.Byte},System.Boolean)">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.Pkcs12ShroudedKeyBag" /> from an existing encoded PKCS#8 EncryptedPrivateKeyInfo value.</summary>
<param name="encryptedPkcs8PrivateKey">A BER-encoded PKCS#8 EncryptedPrivateKeyInfo value.</param>
<param name="skipCopy">
<see langword="true" /> to store <paramref name="encryptedPkcs8PrivateKey" /> without making a defensive copy; otherwise, <see langword="false" />. The default is <see langword="false" />.</param>
<exception cref="T:System.Security.Cryptography.CryptographicException">The <paramref name="encryptedPkcs8privateKey" /> parameter does not represent a single ASN.1 BER-encoded value.</exception>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Pkcs12ShroudedKeyBag.EncryptedPkcs8PrivateKey">
<summary>Gets a memory value containing the PKCS#8 EncryptedPrivateKeyInfo value transported by this bag.</summary>
<returns>A memory value containing the PKCS#8 EncryptedPrivateKeyInfo value transported by this bag.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.Pkcs8PrivateKeyInfo">
<summary>Enables the inspection of and creation of PKCS#8 PrivateKeyInfo and EncryptedPrivateKeyInfo values. This class cannot be inherited.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs8PrivateKeyInfo.#ctor(System.Security.Cryptography.Oid,System.Nullable{System.ReadOnlyMemory{System.Byte}},System.ReadOnlyMemory{System.Byte},System.Boolean)">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.Pkcs8PrivateKeyInfo" /> class.</summary>
<param name="algorithmId">The Object Identifier (OID) identifying the asymmetric algorithm this key is for.</param>
<param name="algorithmParameters">The BER-encoded algorithm parameters associated with this key, or <see langword="null" /> to omit algorithm parameters when encoding.</param>
<param name="privateKey">The algorithm-specific encoded private key.</param>
<param name="skipCopies">
<see langword="true" /> to store <paramref name="algorithmParameters" /> and <paramref name="privateKey" /> without making a defensive copy; otherwise, <see langword="false" />. The default is <see langword="false" />.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="algorithmId" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The <paramref name="algorithmParameters" /> parameter is not <see langword="null" />, empty, or a single BER-encoded value.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs8PrivateKeyInfo.Create(System.Security.Cryptography.AsymmetricAlgorithm)">
<summary>Exports a specified key as a PKCS#8 PrivateKeyInfo and returns its decoded interpretation.</summary>
<param name="privateKey">The private key to represent in a PKCS#8 PrivateKeyInfo.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="privateKey" /> parameter is <see langword="null" />.</exception>
<returns>The decoded interpretation of the exported PKCS#8 PrivateKeyInfo.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs8PrivateKeyInfo.Decode(System.ReadOnlyMemory{System.Byte},System.Int32@,System.Boolean)">
<summary>Reads the provided data as a PKCS#8 PrivateKeyInfo and returns an object view of the contents.</summary>
<param name="source">The data to interpret as a PKCS#8 PrivateKeyInfo value.</param>
<param name="bytesRead">When this method returns, contains a value that indicates the number of bytes read from <paramref name="source" />. This parameter is treated as uninitialized.</param>
<param name="skipCopy">
<see langword="true" /> to store <paramref name="source" /> without making a defensive copy; otherwise, <see langword="false" />. The default is <see langword="false" />.</param>
<exception cref="T:System.Security.Cryptography.CryptographicException">The contents of the <paramref name="source" /> parameter were not successfully decoded as a PKCS#8 PrivateKeyInfo.</exception>
<returns>An object view of the contents decoded as a PKCS#8 PrivateKeyInfo.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs8PrivateKeyInfo.DecryptAndDecode(System.ReadOnlySpan{System.Byte},System.ReadOnlyMemory{System.Byte},System.Int32@)">
<summary>Decrypts the provided data using the provided byte-based password and decodes the output into an object view of the PKCS#8 PrivateKeyInfo.</summary>
<param name="passwordBytes">The bytes to use as a password when decrypting the key material.</param>
<param name="source">The data to read as a PKCS#8 EncryptedPrivateKeyInfo structure in the ASN.1-BER encoding.</param>
<param name="bytesRead">When this method returns, contains a value that indicates the number of bytes read from <paramref name="source" />. This parameter is treated as uninitialized.</param>
<exception cref="T:System.Security.Cryptography.CryptographicException">The password is incorrect.
-or-
The contents of <paramref name="source" /> indicate the Key Derivation Function (KDF) to apply is the legacy PKCS#12 KDF, which requires <see cref="T:System.Char" />-based passwords.
-or-
The contents of <paramref name="source" /> do not represent an ASN.1-BER-encoded PKCS#8 EncryptedPrivateKeyInfo structure.</exception>
<returns>An object view of the contents decrypted decoded as a PKCS#8 PrivateKeyInfo.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs8PrivateKeyInfo.DecryptAndDecode(System.ReadOnlySpan{System.Char},System.ReadOnlyMemory{System.Byte},System.Int32@)">
<summary>Decrypts the provided data using the provided character-based password and decodes the output into an object view of the PKCS#8 PrivateKeyInfo.</summary>
<param name="password">The password to use when decrypting the key material.</param>
<param name="source">The bytes of a PKCS#8 EncryptedPrivateKeyInfo structure in the ASN.1-BER encoding.</param>
<param name="bytesRead">When this method returns, contains a value that indicates the number of bytes read from <paramref name="source" />. This parameter is treated as uninitialized.</param>
<returns>An object view of the contents decrypted decoded as a PKCS#8 PrivateKeyInfo.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs8PrivateKeyInfo.Encode">
<summary>Encodes the property data of this instance as a PKCS#8 PrivateKeyInfo and returns the encoding as a byte array.</summary>
<returns>A byte array representing the encoded form of the PKCS#8 PrivateKeyInfo.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs8PrivateKeyInfo.Encrypt(System.ReadOnlySpan{System.Byte},System.Security.Cryptography.PbeParameters)">
<summary>Produces a PKCS#8 EncryptedPrivateKeyInfo from the property contents of this object after encrypting with the specified byte-based password and encryption parameters.</summary>
<param name="passwordBytes">The bytes to use as a password when encrypting the key material.</param>
<param name="pbeParameters">The password-based encryption (PBE) parameters to use when encrypting the key material.</param>
<exception cref="T:System.Security.Cryptography.CryptographicException">
<paramref name="pbeParameters" /> indicates that <see cref="F:System.Security.Cryptography.PbeEncryptionAlgorithm.TripleDes3KeyPkcs12" /> should be used, which requires <see cref="T:System.Char" />-based passwords.</exception>
<returns>A byte array containing the encoded form of the PKCS#8 EncryptedPrivateKeyInfo.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs8PrivateKeyInfo.Encrypt(System.ReadOnlySpan{System.Char},System.Security.Cryptography.PbeParameters)">
<summary>Produces a PKCS#8 EncryptedPrivateKeyInfo from the property contents of this object after encrypting with the specified character-based password and encryption parameters.</summary>
<param name="password">The password to use when encrypting the key material.</param>
<param name="pbeParameters">The password-based encryption (PBE) parameters to use when encrypting the key material.</param>
<returns>A byte array containing the encoded form of the PKCS#8 EncryptedPrivateKeyInfo.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs8PrivateKeyInfo.TryEncode(System.Span{System.Byte},System.Int32@)">
<summary>Attempts to encode the property data of this instance as a PKCS#8 PrivateKeyInfo, writing the results into a provided buffer.</summary>
<param name="destination">The byte span to receive the PKCS#8 PrivateKeyInfo data.</param>
<param name="bytesWritten">When this method returns, contains a value that indicates the number of bytes written to <paramref name="destination" />. This parameter is treated as uninitialized.</param>
<returns>
<see langword="true" /> if <paramref name="destination" /> is big enough to receive the output; otherwise, <see langword="false" />.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs8PrivateKeyInfo.TryEncrypt(System.ReadOnlySpan{System.Byte},System.Security.Cryptography.PbeParameters,System.Span{System.Byte},System.Int32@)">
<summary>Attempts to produce a PKCS#8 EncryptedPrivateKeyInfo from the property contents of this object after encrypting with the specified byte-based password and encryption parameters, writing the results into a provided buffer.</summary>
<param name="passwordBytes">The bytes to use as a password when encrypting the key material.</param>
<param name="pbeParameters">The password-based encryption (PBE) parameters to use when encrypting the key material.</param>
<param name="destination">The byte span to receive the PKCS#8 EncryptedPrivateKeyInfo data.</param>
<param name="bytesWritten">When this method returns, contains a value that indicates the number of bytes written to <paramref name="destination" />. This parameter is treated as uninitialized.</param>
<returns>
<see langword="true" /> if <paramref name="destination" /> is big enough to receive the output; otherwise, <see langword="false" />.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs8PrivateKeyInfo.TryEncrypt(System.ReadOnlySpan{System.Char},System.Security.Cryptography.PbeParameters,System.Span{System.Byte},System.Int32@)">
<summary>Attempts to produce a PKCS#8 EncryptedPrivateKeyInfo from the property contents of this object after encrypting with the specified character-based password and encryption parameters, writing the result into a provided buffer.</summary>
<param name="password">The password to use when encrypting the key material.</param>
<param name="pbeParameters">The password-based encryption (PBE) parameters to use when encrypting the key material.</param>
<param name="destination">The byte span to receive the PKCS#8 EncryptedPrivateKeyInfo data.</param>
<param name="bytesWritten">When this method returns, contains a value that indicates the number of bytes written to <paramref name="destination" />. This parameter is treated as uninitialized.</param>
<returns>
<see langword="true" /> if <paramref name="destination" /> is big enough to receive the output; otherwise, <see langword="false" />.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Pkcs8PrivateKeyInfo.AlgorithmId">
<summary>Gets the Object Identifier (OID) value identifying the algorithm this key is for.</summary>
<returns>The Object Identifier (OID) value identifying the algorithm this key is for.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Pkcs8PrivateKeyInfo.AlgorithmParameters">
<summary>Gets a memory value containing the BER-encoded algorithm parameters associated with this key.</summary>
<returns>A memory value containing the BER-encoded algorithm parameters associated with this key, or <see langword="null" /> if no parameters were present.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Pkcs8PrivateKeyInfo.Attributes">
<summary>Gets the modifiable collection of attributes for this private key.</summary>
<returns>The modifiable collection of attributes to encode with the private key.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Pkcs8PrivateKeyInfo.PrivateKeyBytes">
<summary>Gets a memory value that represents the algorithm-specific encoded private key.</summary>
<returns>A memory value that represents the algorithm-specific encoded private key.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.Pkcs9AttributeObject">
<summary>Represents an attribute used for CMS/PKCS #7 and PKCS #9 operations.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs9AttributeObject.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.Pkcs9AttributeObject" /> class.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs9AttributeObject.#ctor(System.Security.Cryptography.AsnEncodedData)">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.Pkcs9AttributeObject" /> class using a specified <see cref="T:System.Security.Cryptography.AsnEncodedData" /> object as its attribute type and value.</summary>
<param name="asnEncodedData">An object that contains the PKCS #9 attribute type and value to use.</param>
<exception cref="T:System.ArgumentException">The length of the <paramref name="Value" /> member of the <paramref name="Oid" /> member of <paramref name="asnEncodedData" /> is zero.</exception>
<exception cref="T:System.ArgumentNullException">The <paramref name="Oid" /> member of <paramref name="asnEncodedData" /> is <see langword="null" />.
-or-
The <paramref name="Value" /> member of the <paramref name="Oid" /> member of <paramref name="asnEncodedData" /> is <see langword="null" />.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs9AttributeObject.#ctor(System.Security.Cryptography.Oid,System.Byte[])">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.Pkcs9AttributeObject" /> class using a specified <see cref="T:System.Security.Cryptography.Oid" /> object as the attribute type and a specified ASN.1 encoded data as the attribute value.</summary>
<param name="oid">An object that represents the PKCS #9 attribute type.</param>
<param name="encodedData">An array of byte values that represents the PKCS #9 attribute value.</param>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs9AttributeObject.#ctor(System.String,System.Byte[])">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.Pkcs9AttributeObject" /> class using a specified string representation of an object identifier (OID) as the attribute type and a specified ASN.1 encoded data as the attribute value.</summary>
<param name="oid">The string representation of an OID that represents the PKCS #9 attribute type.</param>
<param name="encodedData">An array of byte values that contains the PKCS #9 attribute value.</param>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs9AttributeObject.CopyFrom(System.Security.Cryptography.AsnEncodedData)">
<summary>Copies a PKCS #9 attribute type and value for this <see cref="T:System.Security.Cryptography.Pkcs.Pkcs9AttributeObject" /> from the specified <see cref="T:System.Security.Cryptography.AsnEncodedData" /> object.</summary>
<param name="asnEncodedData">An object that contains the PKCS #9 attribute type and value to use.</param>
<exception cref="T:System.ArgumentException">
<paramref name="asnEncodeData" /> does not represent a compatible attribute type.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="asnEncodedData" /> is <see langword="null" />.</exception>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Pkcs9AttributeObject.Oid">
<summary>Gets an <see cref="T:System.Security.Cryptography.Oid" /> object that represents the type of attribute associated with this <see cref="T:System.Security.Cryptography.Pkcs.Pkcs9AttributeObject" /> object.</summary>
<returns>An object that represents the type of attribute associated with this <see cref="T:System.Security.Cryptography.Pkcs.Pkcs9AttributeObject" /> object.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.Pkcs9ContentType">
<summary>The <see cref="T:System.Security.Cryptography.Pkcs.Pkcs9ContentType" /> class defines the type of the content of a CMS/PKCS #7 message.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs9ContentType.#ctor">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.Pkcs9ContentType.#ctor" /> constructor creates an instance of the <see cref="T:System.Security.Cryptography.Pkcs.Pkcs9ContentType" /> class.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs9ContentType.CopyFrom(System.Security.Cryptography.AsnEncodedData)">
<summary>Copies information from an <see cref="T:System.Security.Cryptography.AsnEncodedData" /> object.</summary>
<param name="asnEncodedData">The <see cref="T:System.Security.Cryptography.AsnEncodedData" /> object from which to copy information.</param>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Pkcs9ContentType.ContentType">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.Pkcs9ContentType.ContentType" /> property gets an <see cref="T:System.Security.Cryptography.Oid" /> object that contains the content type.</summary>
<returns>An <see cref="T:System.Security.Cryptography.Oid" /> object that contains the content type.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.Pkcs9DocumentDescription">
<summary>The <see cref="T:System.Security.Cryptography.Pkcs.Pkcs9DocumentDescription" /> class defines the description of the content of a CMS/PKCS #7 message.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs9DocumentDescription.#ctor">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.Pkcs9DocumentDescription.#ctor" /> constructor creates an instance of the <see cref="T:System.Security.Cryptography.Pkcs.Pkcs9DocumentDescription" /> class.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs9DocumentDescription.#ctor(System.Byte[])">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.Pkcs9DocumentDescription.#ctor(System.Byte[])" /> constructor creates an instance of the <see cref="T:System.Security.Cryptography.Pkcs.Pkcs9DocumentDescription" /> class by using the specified array of byte values as the encoded description of the content of a CMS/PKCS #7 message.</summary>
<param name="encodedDocumentDescription">An array of byte values that specifies the encoded description of the CMS/PKCS #7 message.</param>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs9DocumentDescription.#ctor(System.String)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.Pkcs9DocumentDescription.#ctor(System.String)" /> constructor creates an instance of the <see cref="T:System.Security.Cryptography.Pkcs.Pkcs9DocumentDescription" /> class by using the specified description of the content of a CMS/PKCS #7 message.</summary>
<param name="documentDescription">An instance of the <see cref="T:System.String" /> class that specifies the description for the CMS/PKCS #7 message.</param>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs9DocumentDescription.CopyFrom(System.Security.Cryptography.AsnEncodedData)">
<summary>Copies information from an <see cref="T:System.Security.Cryptography.AsnEncodedData" /> object.</summary>
<param name="asnEncodedData">The <see cref="T:System.Security.Cryptography.AsnEncodedData" /> object from which to copy information.</param>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Pkcs9DocumentDescription.DocumentDescription">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.Pkcs9DocumentDescription.DocumentDescription" /> property retrieves the document description.</summary>
<returns>A <see cref="T:System.String" /> object that contains the document description.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.Pkcs9DocumentName">
<summary>The <see cref="T:System.Security.Cryptography.Pkcs.Pkcs9DocumentName" /> class defines the name of a CMS/PKCS #7 message.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs9DocumentName.#ctor">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.Pkcs9DocumentName.#ctor" /> constructor creates an instance of the <see cref="T:System.Security.Cryptography.Pkcs.Pkcs9DocumentName" /> class.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs9DocumentName.#ctor(System.Byte[])">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.Pkcs9DocumentName.#ctor(System.Byte[])" /> constructor creates an instance of the <see cref="T:System.Security.Cryptography.Pkcs.Pkcs9DocumentName" /> class by using the specified array of byte values as the encoded name of the content of a CMS/PKCS #7 message.</summary>
<param name="encodedDocumentName">An array of byte values that specifies the encoded name of the CMS/PKCS #7 message.</param>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs9DocumentName.#ctor(System.String)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.Pkcs9DocumentName.#ctor(System.String)" /> constructor creates an instance of the <see cref="T:System.Security.Cryptography.Pkcs.Pkcs9DocumentName" /> class by using the specified name for the CMS/PKCS #7 message.</summary>
<param name="documentName">A <see cref="T:System.String" /> object that specifies the name for the CMS/PKCS #7 message.</param>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs9DocumentName.CopyFrom(System.Security.Cryptography.AsnEncodedData)">
<summary>Copies information from an <see cref="T:System.Security.Cryptography.AsnEncodedData" /> object.</summary>
<param name="asnEncodedData">The <see cref="T:System.Security.Cryptography.AsnEncodedData" /> object from which to copy information.</param>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Pkcs9DocumentName.DocumentName">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.Pkcs9DocumentName.DocumentName" /> property retrieves the document name.</summary>
<returns>A <see cref="T:System.String" /> object that contains the document name.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.Pkcs9LocalKeyId">
<summary>Represents the LocalKeyId attribute from PKCS#9.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs9LocalKeyId.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.Pkcs9LocalKeyId" /> class with an empty key identifier value.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs9LocalKeyId.#ctor(System.Byte[])">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.Pkcs9LocalKeyId" /> class with a key identifier specified by a byte array.</summary>
<param name="keyId">A byte array containing the key identifier.</param>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs9LocalKeyId.#ctor(System.ReadOnlySpan{System.Byte})">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.Pkcs9LocalKeyId" /> class with a key identifier specified by a byte span.</summary>
<param name="keyId">A byte array containing the key identifier.</param>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Pkcs9LocalKeyId.KeyId">
<summary>Gets a memory value containing the key identifier from this attribute.</summary>
<returns>A memory value containing the key identifier from this attribute.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.Pkcs9MessageDigest">
<summary>The <see cref="T:System.Security.Cryptography.Pkcs.Pkcs9MessageDigest" /> class defines the message digest of a CMS/PKCS #7 message.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs9MessageDigest.#ctor">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.Pkcs9MessageDigest.#ctor" /> constructor creates an instance of the <see cref="T:System.Security.Cryptography.Pkcs.Pkcs9MessageDigest" /> class.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs9MessageDigest.CopyFrom(System.Security.Cryptography.AsnEncodedData)">
<summary>Copies information from an <see cref="T:System.Security.Cryptography.AsnEncodedData" /> object.</summary>
<param name="asnEncodedData">The <see cref="T:System.Security.Cryptography.AsnEncodedData" /> object from which to copy information.</param>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Pkcs9MessageDigest.MessageDigest">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.Pkcs9MessageDigest.MessageDigest" /> property retrieves the message digest.</summary>
<returns>An array of byte values that contains the message digest.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.Pkcs9SigningTime">
<summary>The <see cref="T:System.Security.Cryptography.Pkcs.Pkcs9SigningTime" /> class defines the signing date and time of a signature. A <see cref="T:System.Security.Cryptography.Pkcs.Pkcs9SigningTime" /> object can be used as an authenticated attribute of a <see cref="T:System.Security.Cryptography.Pkcs.CmsSigner" /> object when an authenticated date and time are to accompany a digital signature.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs9SigningTime.#ctor">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.Pkcs9SigningTime.#ctor" /> constructor creates an instance of the <see cref="T:System.Security.Cryptography.Pkcs.Pkcs9SigningTime" /> class.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs9SigningTime.#ctor(System.Byte[])">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.Pkcs9SigningTime.#ctor(System.Byte[])" /> constructor creates an instance of the <see cref="T:System.Security.Cryptography.Pkcs.Pkcs9SigningTime" /> class by using the specified array of byte values as the encoded signing date and time of the content of a CMS/PKCS #7 message.</summary>
<param name="encodedSigningTime">An array of byte values that specifies the encoded signing date and time of the CMS/PKCS #7 message.</param>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs9SigningTime.#ctor(System.DateTime)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.Pkcs9SigningTime.#ctor(System.DateTime)" /> constructor creates an instance of the <see cref="T:System.Security.Cryptography.Pkcs.Pkcs9SigningTime" /> class by using the specified signing date and time.</summary>
<param name="signingTime">A <see cref="T:System.DateTime" /> structure that represents the signing date and time of the signature.</param>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs9SigningTime.CopyFrom(System.Security.Cryptography.AsnEncodedData)">
<summary>Copies information from a <see cref="T:System.Security.Cryptography.AsnEncodedData" /> object.</summary>
<param name="asnEncodedData">The <see cref="T:System.Security.Cryptography.AsnEncodedData" /> object from which to copy information.</param>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Pkcs9SigningTime.SigningTime">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.Pkcs9SigningTime.SigningTime" /> property retrieves a <see cref="T:System.DateTime" /> structure that represents the date and time that the message was signed.</summary>
<returns>A <see cref="T:System.DateTime" /> structure that contains the date and time the document was signed.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.PublicKeyInfo">
<summary>The <see cref="T:System.Security.Cryptography.Pkcs.PublicKeyInfo" /> class represents information associated with a public key.</summary>
</member>
<member name="P:System.Security.Cryptography.Pkcs.PublicKeyInfo.Algorithm">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.PublicKeyInfo.Algorithm" /> property retrieves the algorithm identifier associated with the public key.</summary>
<returns>An <see cref="T:System.Security.Cryptography.Pkcs.AlgorithmIdentifier" /> object that represents the algorithm.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.PublicKeyInfo.KeyValue">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.PublicKeyInfo.KeyValue" /> property retrieves the value of the encoded public component of the public key pair.</summary>
<returns>An array of byte values that represents the encoded public component of the public key pair.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.RecipientInfo">
<summary>The <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfo" /> class represents information about a CMS/PKCS #7 message recipient. The <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfo" /> class is an abstract class inherited by the <see cref="T:System.Security.Cryptography.Pkcs.KeyAgreeRecipientInfo" /> and <see cref="T:System.Security.Cryptography.Pkcs.KeyTransRecipientInfo" /> classes.</summary>
</member>
<member name="P:System.Security.Cryptography.Pkcs.RecipientInfo.EncryptedKey">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.RecipientInfo.EncryptedKey" /> abstract property retrieves the encrypted recipient keying material.</summary>
<returns>An array of byte values that contain the encrypted recipient keying material.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.RecipientInfo.KeyEncryptionAlgorithm">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.RecipientInfo.KeyEncryptionAlgorithm" /> abstract property retrieves the algorithm used to perform the key establishment.</summary>
<returns>An <see cref="T:System.Security.Cryptography.Pkcs.AlgorithmIdentifier" /> object that contains the value of the algorithm used to establish the key between the originator and recipient of the CMS/PKCS #7 message.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.RecipientInfo.RecipientIdentifier">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.RecipientInfo.RecipientIdentifier" /> abstract property retrieves the identifier of the recipient.</summary>
<returns>A <see cref="T:System.Security.Cryptography.Pkcs.SubjectIdentifier" /> object that contains the identifier of the recipient.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.RecipientInfo.Type">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.RecipientInfo.Type" /> property retrieves the type of the recipient. The type of the recipient determines which of two major protocols is used to establish a key between the originator and the recipient of a CMS/PKCS #7 message.</summary>
<returns>A value of the <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoType" /> enumeration that defines the type of the recipient.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.RecipientInfo.Version">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.RecipientInfo.Version" /> abstract property retrieves the version of the recipient information. Derived classes automatically set this property for their objects, and the value indicates whether it is using PKCS #7 or Cryptographic Message Syntax (CMS) to protect messages. The version also implies whether the <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfo" /> object establishes a cryptographic key by a key agreement algorithm or a key transport algorithm.</summary>
<returns>An <see cref="T:System.Int32" /> value that represents the version of the <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfo" /> object.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.RecipientInfoCollection">
<summary>The <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoCollection" /> class represents a collection of <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfo" /> objects. <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoCollection" /> implements the <see cref="T:System.Collections.ICollection" /> interface.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.RecipientInfoCollection.CopyTo(System.Array,System.Int32)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.RecipientInfoCollection.CopyTo(System.Array,System.Int32)" /> method copies the <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoCollection" /> collection to an array.</summary>
<param name="array">An <see cref="T:System.Array" /> object to which the <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoCollection" /> collection is to be copied.</param>
<param name="index">The zero-based index in <paramref name="array" /> where the <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoCollection" /> collection is copied.</param>
<exception cref="T:System.ArgumentException">One of the arguments provided to a method was not valid.</exception>
<exception cref="T:System.ArgumentNullException">A null reference was passed to a method that does not accept it as a valid argument.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The value of an argument was outside the allowable range of values as defined by the called method.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.RecipientInfoCollection.CopyTo(System.Security.Cryptography.Pkcs.RecipientInfo[],System.Int32)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.RecipientInfoCollection.CopyTo(System.Security.Cryptography.Pkcs.RecipientInfo[],System.Int32)" /> method copies the <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoCollection" /> collection to a <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfo" /> array.</summary>
<param name="array">An array of <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfo" /> objects where the <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoCollection" /> collection is to be copied.</param>
<param name="index">The zero-based index in <paramref name="array" /> where the <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoCollection" /> collection is copied.</param>
<exception cref="T:System.ArgumentException">One of the arguments provided to a method was not valid.</exception>
<exception cref="T:System.ArgumentNullException">A null reference was passed to a method that does not accept it as a valid argument.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The value of an argument was outside the allowable range of values as defined by the called method.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.RecipientInfoCollection.GetEnumerator">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.RecipientInfoCollection.GetEnumerator" /> method returns a <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoEnumerator" /> object for the <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoCollection" /> collection.</summary>
<returns>A <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoEnumerator" /> object that can be used to enumerate the <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoCollection" /> collection.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.RecipientInfoCollection.System#Collections#IEnumerable#GetEnumerator">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.RecipientInfoCollection.System#Collections#IEnumerable#GetEnumerator" /> method returns a <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoEnumerator" /> object for the <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoCollection" /> collection.</summary>
<returns>A <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoEnumerator" /> object that can be used to enumerate the <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoCollection" /> collection.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.RecipientInfoCollection.Count">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.RecipientInfoCollection.Count" /> property retrieves the number of items in the <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoCollection" /> collection.</summary>
<returns>An int value that represents the number of items in the collection.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.RecipientInfoCollection.IsSynchronized">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.RecipientInfoCollection.IsSynchronized" /> property retrieves whether access to the collection is synchronized, or thread safe. This property always returns <see langword="false" />, which means the collection is not thread safe.</summary>
<returns>A <see cref="T:System.Boolean" /> value of <see langword="false" />, which means the collection is not thread safe.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.RecipientInfoCollection.Item(System.Int32)">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.RecipientInfoCollection.Item(System.Int32)" /> property retrieves the <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfo" /> object at the specified index in the collection.</summary>
<param name="index">An int value that represents the index in the collection. The index is zero based.</param>
<exception cref="T:System.ArgumentOutOfRangeException">The value of an argument was outside the allowable range of values as defined by the called method.</exception>
<returns>A <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfo" /> object at the specified index.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.RecipientInfoCollection.SyncRoot">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.RecipientInfoCollection.SyncRoot" /> property retrieves an <see cref="T:System.Object" /> object used to synchronize access to the <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoCollection" /> collection.</summary>
<returns>An <see cref="T:System.Object" /> object used to synchronize access to the <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoCollection" /> collection.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.RecipientInfoEnumerator">
<summary>The <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoEnumerator" /> class provides enumeration functionality for the <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoCollection" /> collection. <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoEnumerator" /> implements the <see cref="T:System.Collections.IEnumerator" /> interface.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.RecipientInfoEnumerator.MoveNext">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.RecipientInfoEnumerator.MoveNext" /> method advances the enumeration to the next <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfo" /> object in the <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoCollection" /> collection.</summary>
<returns>This method returns a bool that specifies whether the enumeration successfully advanced. If the enumeration successfully moved to the next <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfo" /> object, the method returns <see langword="true" />. If the enumeration moved past the last item in the enumeration, it returns <see langword="false" />.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.RecipientInfoEnumerator.Reset">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.RecipientInfoEnumerator.Reset" /> method resets the enumeration to the first <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfo" /> object in the <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoCollection" /> collection.</summary>
</member>
<member name="P:System.Security.Cryptography.Pkcs.RecipientInfoEnumerator.Current">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.RecipientInfoEnumerator.Current" /> property retrieves the current <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfo" /> object from the <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoCollection" /> collection.</summary>
<returns>A <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfo" /> object that represents the current recipient information structure in the <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoCollection" /> collection.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.RecipientInfoEnumerator.System#Collections#IEnumerator#Current">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.RecipientInfoEnumerator.System#Collections#IEnumerator#Current" /> property retrieves the current <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfo" /> object from the <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoCollection" /> collection.</summary>
<returns>A <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfo" /> object that represents the current recipient information structure in the <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoCollection" /> collection.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.RecipientInfoType">
<summary>The <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoType" /> enumeration defines the types of recipient information.</summary>
</member>
<member name="F:System.Security.Cryptography.Pkcs.RecipientInfoType.KeyAgreement">
<summary>Key agreement recipient information.</summary>
</member>
<member name="F:System.Security.Cryptography.Pkcs.RecipientInfoType.KeyTransport">
<summary>Key transport recipient information.</summary>
</member>
<member name="F:System.Security.Cryptography.Pkcs.RecipientInfoType.Unknown">
<summary>The recipient information type is unknown.</summary>
</member>
<member name="T:System.Security.Cryptography.Pkcs.Rfc3161TimestampRequest">
<summary>Represents a time-stamping request from IETF RFC 3161.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Rfc3161TimestampRequest.CreateFromData(System.ReadOnlySpan{System.Byte},System.Security.Cryptography.HashAlgorithmName,System.Security.Cryptography.Oid,System.Nullable{System.ReadOnlyMemory{System.Byte}},System.Boolean,System.Security.Cryptography.X509Certificates.X509ExtensionCollection)">
<summary>Creates a timestamp request by hashing the provided data with a specified algorithm.</summary>
<param name="data">The data to timestamp, which will be hashed by this method.</param>
<param name="hashAlgorithm">The hash algorithm to use with this timestamp request.</param>
<param name="requestedPolicyId">The Object Identifier (OID) for a timestamp policy the Timestamp Authority (TSA) should use, or <see langword="null" /> to express no preference.</param>
<param name="nonce">An optional nonce (number used once) to uniquely identify this request to pair it with the response. The value is interpreted as an unsigned big-endian integer and may be normalized to the encoding format.</param>
<param name="requestSignerCertificates">
<see langword="true" /> to indicate the Timestamp Authority (TSA) must include the signing certificate in the issued timestamp token; otherwise, <see langword="false" />.</param>
<param name="extensions">An optional collection of extensions to include in the request.</param>
<exception cref="T:System.ArgumentException">
<paramref name="hashAlgorithm" />.<see cref="P:System.Security.Cryptography.HashAlgorithmName.Name" /> is <see langword="null" /> or <see cref="F:System.String.Empty" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">
<paramref name="hashAlgorithm" /> is not a known hash algorithm.</exception>
<returns>An <see cref="T:System.Security.Cryptography.Pkcs.Rfc3161TimestampRequest" /> representing the chosen values.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Rfc3161TimestampRequest.CreateFromHash(System.ReadOnlyMemory{System.Byte},System.Security.Cryptography.HashAlgorithmName,System.Security.Cryptography.Oid,System.Nullable{System.ReadOnlyMemory{System.Byte}},System.Boolean,System.Security.Cryptography.X509Certificates.X509ExtensionCollection)">
<summary>Create a timestamp request using a pre-computed hash value and the name of the hash algorithm.</summary>
<param name="hash">The pre-computed hash value to be timestamped.</param>
<param name="hashAlgorithm">The hash algorithm used to produce <paramref name="hash" />.</param>
<param name="requestedPolicyId">The Object Identifier (OID) for the timestamp policy that the Timestamp Authority (TSA) should use, or <see langword="null" /> to express no preference.</param>
<param name="nonce">An optional value used to uniquely match a request to a response, or <see langword="null" /> to not include a nonce in the request.</param>
<param name="requestSignerCertificates">
<see langword="true" /> to indicate the Timestamp Authority (TSA) must include the signing certificate in the issued timestamp token; otherwise, <see langword="false" />.</param>
<param name="extensions">An optional collection of extensions to include in the request.</param>
<exception cref="T:System.Security.Cryptography.CryptographicException">
<paramref name="hashAlgorithm" /> is not a known hash algorithm.</exception>
<returns>An <see cref="T:System.Security.Cryptography.Pkcs.Rfc3161TimestampRequest" /> representing the chosen values.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Rfc3161TimestampRequest.CreateFromHash(System.ReadOnlyMemory{System.Byte},System.Security.Cryptography.Oid,System.Security.Cryptography.Oid,System.Nullable{System.ReadOnlyMemory{System.Byte}},System.Boolean,System.Security.Cryptography.X509Certificates.X509ExtensionCollection)">
<summary>Create a timestamp request using a pre-computed hash value and the Object Identifier for the hash algorithm.</summary>
<param name="hash">The pre-computed hash value to be timestamped.</param>
<param name="hashAlgorithmId">The Object Identifier (OID) for the hash algorithm that produced <paramref name="hash" />.</param>
<param name="requestedPolicyId">The Object Identifier (OID) for a timestamp policy the Timestamp Authority (TSA) should use, or <see langword="null" /> to express no preference.</param>
<param name="nonce">An optional nonce (number used once) to uniquely identify this request to pair it with the response. The value is interpreted as an unsigned big-endian integer and may be normalized to the encoding format.</param>
<param name="requestSignerCertificates">
<see langword="true" /> to indicate the Timestamp Authority (TSA) must include the signing certificate in the issued timestamp token; otherwise, <see langword="false" />.</param>
<param name="extensions">An optional collection of extensions to include in the request.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="hashAlgorithmId" /> is <see langword="null" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">
<paramref name="hashAlgorithmId" />.<see cref="P:System.Security.Cryptography.Oid.Value" /> is not a valid OID.</exception>
<returns>An <see cref="T:System.Security.Cryptography.Pkcs.Rfc3161TimestampRequest" /> representing the chosen values.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Rfc3161TimestampRequest.CreateFromSignerInfo(System.Security.Cryptography.Pkcs.SignerInfo,System.Security.Cryptography.HashAlgorithmName,System.Security.Cryptography.Oid,System.Nullable{System.ReadOnlyMemory{System.Byte}},System.Boolean,System.Security.Cryptography.X509Certificates.X509ExtensionCollection)">
<summary>Creates a timestamp request by hashing the signature of the provided signer with a specified algorithm.</summary>
<param name="signerInfo">The CMS signer information to build a timestamp request for.</param>
<param name="hashAlgorithm">The hash algorithm to use with this timestamp request.</param>
<param name="requestedPolicyId">The Object Identifier (OID) for the timestamp policy that the Timestamp Authority (TSA) should use, or <see langword="null" /> to express no preference.</param>
<param name="nonce">An optional nonce (number used once) to uniquely identify this request to pair it with the response. The value is interpreted as an unsigned big-endian integer and may be normalized to the encoding format.</param>
<param name="requestSignerCertificates">
<see langword="true" /> to indicate the Timestamp Authority (TSA) must include the signing certificate in the issued timestamp token; otherwise, <see langword="false" />.</param>
<param name="extensions">An optional collection of extensions to include in the request.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="signerInfo" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="hashAlgorithm" />.<see cref="P:System.Security.Cryptography.HashAlgorithmName.Name" /> is <see langword="null" /> or <see cref="F:System.String.Empty" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">
<paramref name="hashAlgorithm" /> is not a known hash algorithm.</exception>
<returns>An <see cref="T:System.Security.Cryptography.Pkcs.Rfc3161TimestampRequest" /> representing the chosen values.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Rfc3161TimestampRequest.Encode">
<summary>Encodes the timestamp request and returns it as a byte array.</summary>
<returns>A byte array containing the DER-encoded timestamp request.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Rfc3161TimestampRequest.GetExtensions">
<summary>Gets a collection with a copy of the extensions present on this request.</summary>
<returns>A collection with a copy of the extensions present on this request.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Rfc3161TimestampRequest.GetMessageHash">
<summary>Gets the data hash for this timestamp request.</summary>
<returns>The data hash for this timestamp request as a read-only memory value.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Rfc3161TimestampRequest.GetNonce">
<summary>Gets the nonce for this timestamp request.</summary>
<returns>The nonce for this timestamp request as a read-only memory value, if one was present; otherwise, <see langword="null" />.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Rfc3161TimestampRequest.ProcessResponse(System.ReadOnlyMemory{System.Byte},System.Int32@)">
<summary>Combines an encoded timestamp response with this request to produce a <see cref="T:System.Security.Cryptography.Pkcs.Rfc3161TimestampToken" />.</summary>
<param name="responseBytes">The DER encoded timestamp response.</param>
<param name="bytesConsumed">When this method returns, the number of bytes that were read from <paramref name="responseBytes" />. This parameter is treated as uninitialized.</param>
<returns>The timestamp token from the response that corresponds to this request.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Rfc3161TimestampRequest.TryDecode(System.ReadOnlyMemory{System.Byte},System.Security.Cryptography.Pkcs.Rfc3161TimestampRequest@,System.Int32@)">
<summary>Attemps to interpret the contents of <paramref name="encodedBytes" /> as a DER-encoded Timestamp Request.</summary>
<param name="encodedBytes">The buffer containing a DER-encoded timestamp request.</param>
<param name="request">When this method returns, the successfully decoded timestamp request if decoding succeeded, or <see langword="null" /> if decoding failed. This parameter is treated as uninitialized.</param>
<param name="bytesConsumed">When this method returns, the number of bytes that were read from <paramref name="encodedBytes" />. This parameter is treated as uninitialized.</param>
<returns>
<see langword="true" /> if <paramref name="encodedBytes" /> was successfully interpreted as a Timestamp Request; otherwise, <see langword="false" />.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Rfc3161TimestampRequest.TryEncode(System.Span{System.Byte},System.Int32@)">
<summary>Attempts to encode the instance as an IETF RFC 3161 <c>TimeStampReq</c>, writing the bytes into the provided buffer.</summary>
<param name="destination">The buffer to receive the encoded request.</param>
<param name="bytesWritten">When this method returns, the total number of bytes written into <paramref name="destination" />. This parameter is treated as uninitialized.</param>
<returns>
<see langword="true" />if <paramref name="destination" /> is long enough to receive the encoded request; otherwise, <see langword="false" />.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Rfc3161TimestampRequest.HasExtensions">
<summary>Indicates whether or not the request has extensions.</summary>
<returns>
<see langword="true" /> if the request has any extensions; otherwise, <see langword="false" />.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Rfc3161TimestampRequest.HashAlgorithmId">
<summary>Gets the Object Identifier (OID) for the hash algorithm associated with the request.</summary>
<returns>The Object Identifier (OID) for the hash algorithm associated with the request.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Rfc3161TimestampRequest.RequestedPolicyId">
<summary>Gets the policy ID for the request, or <see langword="null" /> when no policy ID was requested.</summary>
<returns>The policy ID for the request, or <see langword="null" /> when no policy ID was requested.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Rfc3161TimestampRequest.RequestSignerCertificate">
<summary>Gets a value indicating whether or not the request indicated that the timestamp authority certificate is required to be in the response.</summary>
<returns>
<see langword="true" /> if the response must include the timestamp authority certificate; otherwise, <see langword="false" />.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Rfc3161TimestampRequest.Version">
<summary>Gets the data format version number for this request.</summary>
<returns>The data format version number for this request.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.Rfc3161TimestampToken">
<summary>Represents a time-stamp token from IETF RFC 3161.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Rfc3161TimestampToken.AsSignedCms">
<summary>Gets a Signed Cryptographic Message Syntax (CMS) representation of the RFC3161 time-stamp token.</summary>
<returns>The <see cref="T:System.Security.Cryptography.Pkcs.SignedCms" /> representation of the <see cref="T:System.Security.Cryptography.Pkcs.Rfc3161TimestampToken" />.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Rfc3161TimestampToken.TryDecode(System.ReadOnlyMemory{System.Byte},System.Security.Cryptography.Pkcs.Rfc3161TimestampToken@,System.Int32@)">
<summary>Attemps to interpret the contents of <paramref name="encodedBytes" /> as a DER-encoded time-stamp token.</summary>
<param name="encodedBytes">The buffer containing a DER-encoded time-stamp token.</param>
<param name="token">When this method returns, the successfully decoded time-stamp token if decoding succeeded, or <see langword="null" /> if decoding failed. This parameter is treated as uninitialized.</param>
<param name="bytesConsumed">When this method returns, the number of bytes that were read from <paramref name="encodedBytes" />. This parameter is treated as uninitialized.</param>
<returns>
<see langword="true" /> if <paramref name="encodedBytes" /> was successfully interpreted as a time-stamp token; otherwise, <see langword="false" />.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Rfc3161TimestampToken.VerifySignatureForData(System.ReadOnlySpan{System.Byte},System.Security.Cryptography.X509Certificates.X509Certificate2@,System.Security.Cryptography.X509Certificates.X509Certificate2Collection)">
<summary>Verifies that the current token is a valid time-stamp token for the provided data.</summary>
<param name="data">The data to verify against this time-stamp token.</param>
<param name="signerCertificate">When this method returns, the certificate from the Timestamp Authority (TSA) which signed this token, or <see langword="null" /> if a signer certificate cannot be determined. This parameter is treated as uninitialized.</param>
<param name="extraCandidates">An optional collection of certificates to consider as the Timestamp Authority (TSA) certificates, in addition to any certificates that may be included within the token.</param>
<returns>
<see langword="true" /> if the Timestamp Authority (TSA) certificate was found, the certificate public key validates the token signature, and the token matches the hash for the provided data; otherwise, <see langword="false" />.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Rfc3161TimestampToken.VerifySignatureForHash(System.ReadOnlySpan{System.Byte},System.Security.Cryptography.HashAlgorithmName,System.Security.Cryptography.X509Certificates.X509Certificate2@,System.Security.Cryptography.X509Certificates.X509Certificate2Collection)">
<summary>Verifies that the current token is a valid time-stamp token for the provided data hash and algorithm identifier.</summary>
<param name="hash">The cryptographic hash to verify against this time-stamp token.</param>
<param name="hashAlgorithm">The algorithm which produced <paramref name="hash" />.</param>
<param name="signerCertificate">When this method returns, the certificate from the Timestamp Authority (TSA) which signed this token, or <see langword="null" /> if a signer certificate cannot be determined. This parameter is treated as uninitialized.</param>
<param name="extraCandidates">An optional collection of certificates to consider as the Timestamp Authority (TSA) certificates, in addition to any certificates that may be included within the token.</param>
<returns>
<see langword="true" /> if the Timestamp Authority (TSA) certificate was found, the certificate public key validates the token signature, and the token matches the hash for the provided data hash and algorithm; otherwise, <see langword="false" />.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Rfc3161TimestampToken.VerifySignatureForHash(System.ReadOnlySpan{System.Byte},System.Security.Cryptography.Oid,System.Security.Cryptography.X509Certificates.X509Certificate2@,System.Security.Cryptography.X509Certificates.X509Certificate2Collection)">
<summary>Verifies that the current token is a valid time-stamp token for the provided data hash and algorithm identifier.</summary>
<param name="hash">The cryptographic hash to verify against this time-stamp token.</param>
<param name="hashAlgorithmId" />
<param name="signerCertificate">When this method returns, the certificate from the Timestamp Authority (TSA) which signed this token, or <see langword="null" /> if a signer certificate cannot be determined. This parameter is treated as uninitialized.</param>
<param name="extraCandidates">An optional collection of certificates to consider as the Timestamp Authority (TSA) certificates, in addition to any certificates that may be included within the token.</param>
<returns>
<see langword="true" /> if the Timestamp Authority (TSA) certificate was found, the certificate public key validates the token signature, and the token matches the hash for the provided data hash and algorithm; otherwise, <see langword="false" />.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Rfc3161TimestampToken.VerifySignatureForSignerInfo(System.Security.Cryptography.Pkcs.SignerInfo,System.Security.Cryptography.X509Certificates.X509Certificate2@,System.Security.Cryptography.X509Certificates.X509Certificate2Collection)">
<summary>Verifies that the current token is a valid time-stamp token for the provided <see cref="T:System.Security.Cryptography.Pkcs.SignerInfo" />.</summary>
<param name="signerInfo">The CMS signer information to verify the timestamp was built for.</param>
<param name="signerCertificate">When this method returns, the certificate from the Timestamp Authority (TSA) that signed this token, or <see langword="null" /> if a signer certificate cannot be determined. This parameter is treated as uninitialized.</param>
<param name="extraCandidates">An optional collection of certificates to consider as the Timestamp Authority (TSA) certificates, in addition to any certificates that may be included within the token.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="signerInfo" /> is <see langword="null" />.</exception>
<returns>
<see langword="true" /> if the Timestamp Authority (TSA) certificate was found, the certificate public key validates the token signature, and the token matches the signature for <paramref name="signerInfo" />; otherwise, <see langword="false" />.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Rfc3161TimestampToken.TokenInfo">
<summary>Gets the details of this time-stamp token as a <see cref="T:System.Security.Cryptography.Pkcs.Rfc3161TimestampTokenInfo" />.</summary>
<returns>The details of this time-stamp token as a <see cref="T:System.Security.Cryptography.Pkcs.Rfc3161TimestampTokenInfo" />.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.Rfc3161TimestampTokenInfo" />
<member name="M:System.Security.Cryptography.Pkcs.Rfc3161TimestampTokenInfo.#ctor(System.Security.Cryptography.Oid,System.Security.Cryptography.Oid,System.ReadOnlyMemory{System.Byte},System.ReadOnlyMemory{System.Byte},System.DateTimeOffset,System.Nullable{System.Int64},System.Boolean,System.Nullable{System.ReadOnlyMemory{System.Byte}},System.Nullable{System.ReadOnlyMemory{System.Byte}},System.Security.Cryptography.X509Certificates.X509ExtensionCollection)">
<param name="policyId" />
<param name="hashAlgorithmId" />
<param name="messageHash" />
<param name="serialNumber" />
<param name="timestamp" />
<param name="accuracyInMicroseconds" />
<param name="isOrdering" />
<param name="nonce" />
<param name="timestampAuthorityName" />
<param name="extensions" />
</member>
<member name="M:System.Security.Cryptography.Pkcs.Rfc3161TimestampTokenInfo.Encode" />
<member name="M:System.Security.Cryptography.Pkcs.Rfc3161TimestampTokenInfo.GetExtensions" />
<member name="M:System.Security.Cryptography.Pkcs.Rfc3161TimestampTokenInfo.GetMessageHash" />
<member name="M:System.Security.Cryptography.Pkcs.Rfc3161TimestampTokenInfo.GetNonce" />
<member name="M:System.Security.Cryptography.Pkcs.Rfc3161TimestampTokenInfo.GetSerialNumber" />
<member name="M:System.Security.Cryptography.Pkcs.Rfc3161TimestampTokenInfo.GetTimestampAuthorityName" />
<member name="M:System.Security.Cryptography.Pkcs.Rfc3161TimestampTokenInfo.TryDecode(System.ReadOnlyMemory{System.Byte},System.Security.Cryptography.Pkcs.Rfc3161TimestampTokenInfo@,System.Int32@)">
<param name="encodedBytes" />
<param name="timestampTokenInfo" />
<param name="bytesConsumed" />
</member>
<member name="M:System.Security.Cryptography.Pkcs.Rfc3161TimestampTokenInfo.TryEncode(System.Span{System.Byte},System.Int32@)">
<param name="destination" />
<param name="bytesWritten" />
</member>
<member name="P:System.Security.Cryptography.Pkcs.Rfc3161TimestampTokenInfo.AccuracyInMicroseconds" />
<member name="P:System.Security.Cryptography.Pkcs.Rfc3161TimestampTokenInfo.HasExtensions" />
<member name="P:System.Security.Cryptography.Pkcs.Rfc3161TimestampTokenInfo.HashAlgorithmId" />
<member name="P:System.Security.Cryptography.Pkcs.Rfc3161TimestampTokenInfo.IsOrdering" />
<member name="P:System.Security.Cryptography.Pkcs.Rfc3161TimestampTokenInfo.PolicyId" />
<member name="P:System.Security.Cryptography.Pkcs.Rfc3161TimestampTokenInfo.Timestamp" />
<member name="P:System.Security.Cryptography.Pkcs.Rfc3161TimestampTokenInfo.Version" />
<member name="T:System.Security.Cryptography.Pkcs.SignedCms">
<summary>The <see cref="T:System.Security.Cryptography.Pkcs.SignedCms" /> class enables signing and verifying of CMS/PKCS #7 messages.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignedCms.#ctor">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.SignedCms.#ctor" /> constructor creates an instance of the <see cref="T:System.Security.Cryptography.Pkcs.SignedCms" /> class.</summary>
<exception cref="T:System.ArgumentNullException">A null reference was passed to a method that does not accept it as a valid argument.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignedCms.#ctor(System.Security.Cryptography.Pkcs.ContentInfo)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.SignedCms.#ctor(System.Security.Cryptography.Pkcs.ContentInfo)" /> constructor creates an instance of the <see cref="T:System.Security.Cryptography.Pkcs.SignedCms" /> class by using the specified content information as the inner content.</summary>
<param name="contentInfo">A <see cref="T:System.Security.Cryptography.Pkcs.ContentInfo" /> object that specifies the content information as the inner content of the <see cref="T:System.Security.Cryptography.Pkcs.SignedCms" /> message.</param>
<exception cref="T:System.ArgumentNullException">A null reference was passed to a method that does not accept it as a valid argument.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignedCms.#ctor(System.Security.Cryptography.Pkcs.ContentInfo,System.Boolean)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.SignedCms.#ctor(System.Security.Cryptography.Pkcs.ContentInfo,System.Boolean)" /> constructor creates an instance of the <see cref="T:System.Security.Cryptography.Pkcs.SignedCms" /> class by using the specified content information as the inner content and by using the detached state.</summary>
<param name="contentInfo">A <see cref="T:System.Security.Cryptography.Pkcs.ContentInfo" /> object that specifies the content information as the inner content of the <see cref="T:System.Security.Cryptography.Pkcs.SignedCms" /> message.</param>
<param name="detached">A <see cref="T:System.Boolean" /> value that specifies whether the <see cref="T:System.Security.Cryptography.Pkcs.SignedCms" /> object is for a detached signature. If <paramref name="detached" /> is <see langword="true" />, the signature is detached. If <paramref name="detached" /> is <see langword="false" />, the signature is not detached.</param>
<exception cref="T:System.ArgumentNullException">A null reference was passed to a method that does not accept it as a valid argument.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignedCms.#ctor(System.Security.Cryptography.Pkcs.SubjectIdentifierType)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.SignedCms.#ctor(System.Security.Cryptography.Pkcs.SubjectIdentifierType)" /> constructor creates an instance of the <see cref="T:System.Security.Cryptography.Pkcs.SignedCms" /> class by using the specified subject identifier type as the default subject identifier type for signers.</summary>
<param name="signerIdentifierType">A <see cref="T:System.Security.Cryptography.Pkcs.SubjectIdentifierType" /> member that specifies the default subject identifier type for signers.</param>
<exception cref="T:System.ArgumentNullException">A null reference was passed to a method that does not accept it as a valid argument.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignedCms.#ctor(System.Security.Cryptography.Pkcs.SubjectIdentifierType,System.Security.Cryptography.Pkcs.ContentInfo)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.SignedCms.#ctor(System.Security.Cryptography.Pkcs.SubjectIdentifierType,System.Security.Cryptography.Pkcs.ContentInfo)" /> constructor creates an instance of the <see cref="T:System.Security.Cryptography.Pkcs.SignedCms" /> class by using the specified subject identifier type as the default subject identifier type for signers and content information as the inner content.</summary>
<param name="signerIdentifierType">A <see cref="T:System.Security.Cryptography.Pkcs.SubjectIdentifierType" /> member that specifies the default subject identifier type for signers.</param>
<param name="contentInfo">A <see cref="T:System.Security.Cryptography.Pkcs.ContentInfo" /> object that specifies the content information as the inner content of the <see cref="T:System.Security.Cryptography.Pkcs.SignedCms" /> message.</param>
<exception cref="T:System.ArgumentNullException">A null reference was passed to a method that does not accept it as a valid argument.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignedCms.#ctor(System.Security.Cryptography.Pkcs.SubjectIdentifierType,System.Security.Cryptography.Pkcs.ContentInfo,System.Boolean)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.SignedCms.#ctor(System.Security.Cryptography.Pkcs.SubjectIdentifierType,System.Security.Cryptography.Pkcs.ContentInfo,System.Boolean)" /> constructor creates an instance of the <see cref="T:System.Security.Cryptography.Pkcs.SignedCms" /> class by using the specified subject identifier type as the default subject identifier type for signers, the content information as the inner content, and by using the detached state.</summary>
<param name="signerIdentifierType">A <see cref="T:System.Security.Cryptography.Pkcs.SubjectIdentifierType" /> member that specifies the default subject identifier type for signers.</param>
<param name="contentInfo">A <see cref="T:System.Security.Cryptography.Pkcs.ContentInfo" /> object that specifies the content information as the inner content of the <see cref="T:System.Security.Cryptography.Pkcs.SignedCms" /> message.</param>
<param name="detached">A <see cref="T:System.Boolean" /> value that specifies whether the <see cref="T:System.Security.Cryptography.Pkcs.SignedCms" /> object is for a detached signature. If <paramref name="detached" /> is <see langword="true" />, the signature is detached. If detached is <see langword="false" />, the signature is not detached.</param>
<exception cref="T:System.ArgumentNullException">A null reference was passed to a method that does not accept it as a valid argument.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignedCms.AddCertificate(System.Security.Cryptography.X509Certificates.X509Certificate2)">
<summary>Adds a certificate to the collection of certificates for the encoded CMS/PKCS #7 message.</summary>
<param name="certificate">The certificate to add to the collection.</param>
<exception cref="T:System.Security.Cryptography.CryptographicException">The certificate already exists in the collection.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignedCms.CheckHash">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.SignedCms.CheckHash" /> method verifies the data integrity of the CMS/PKCS #7 message. <see cref="M:System.Security.Cryptography.Pkcs.SignedCms.CheckHash" /> is a specialized method used in specific security infrastructure applications that only wish to check the hash of the CMS message, rather than perform a full digital signature verification. <see cref="M:System.Security.Cryptography.Pkcs.SignedCms.CheckHash" /> does not authenticate the author nor sender of the message because this method does not involve verifying a digital signature. For general-purpose checking of the integrity and authenticity of a CMS/PKCS #7 message, use the <see cref="M:System.Security.Cryptography.Pkcs.SignedCms.CheckSignature(System.Boolean)" /> or <see cref="M:System.Security.Cryptography.Pkcs.SignedCms.CheckSignature(System.Security.Cryptography.X509Certificates.X509Certificate2Collection,System.Boolean)" /> methods.</summary>
<exception cref="T:System.InvalidOperationException">A method call was invalid for the object's current state.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignedCms.CheckSignature(System.Boolean)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.SignedCms.CheckSignature(System.Boolean)" /> method verifies the digital signatures on the signed CMS/PKCS #7 message and, optionally, validates the signers' certificates.</summary>
<param name="verifySignatureOnly">A <see cref="T:System.Boolean" /> value that specifies whether only the digital signatures are verified without the signers' certificates being validated.
If <paramref name="verifySignatureOnly" /> is <see langword="true" />, only the digital signatures are verified. If it is <see langword="false" />, the digital signatures are verified, the signers' certificates are validated, and the purposes of the certificates are validated. The purposes of a certificate are considered valid if the certificate has no key usage or if the key usage supports digital signatures or nonrepudiation.</param>
<exception cref="T:System.ArgumentNullException">A null reference was passed to a method that does not accept it as a valid argument.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">A cryptographic operation could not be completed.</exception>
<exception cref="T:System.InvalidOperationException">A method call was invalid for the object's current state.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignedCms.CheckSignature(System.Security.Cryptography.X509Certificates.X509Certificate2Collection,System.Boolean)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.SignedCms.CheckSignature(System.Security.Cryptography.X509Certificates.X509Certificate2Collection,System.Boolean)" /> method verifies the digital signatures on the signed CMS/PKCS #7 message by using the specified collection of certificates and, optionally, validates the signers' certificates.</summary>
<param name="extraStore">An <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2Collection" /> object that can be used to validate the certificate chain. If no additional certificates are to be used to validate the certificate chain, use <see cref="M:System.Security.Cryptography.Pkcs.SignedCms.CheckSignature(System.Boolean)" /> instead of <see cref="M:System.Security.Cryptography.Pkcs.SignedCms.CheckSignature(System.Security.Cryptography.X509Certificates.X509Certificate2Collection,System.Boolean)" />.</param>
<param name="verifySignatureOnly">A <see cref="T:System.Boolean" /> value that specifies whether only the digital signatures are verified without the signers' certificates being validated.
If <paramref name="verifySignatureOnly" /> is <see langword="true" />, only the digital signatures are verified. If it is <see langword="false" />, the digital signatures are verified, the signers' certificates are validated, and the purposes of the certificates are validated. The purposes of a certificate are considered valid if the certificate has no key usage or if the key usage supports digital signatures or nonrepudiation.</param>
<exception cref="T:System.ArgumentNullException">A null reference was passed to a method that does not accept it as a valid argument.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">A cryptographic operation could not be completed.</exception>
<exception cref="T:System.InvalidOperationException">A method call was invalid for the object's current state.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignedCms.ComputeSignature">
<summary>Creates a signature and adds the signature to the CMS/PKCS #7 message.</summary>
<exception cref="T:System.InvalidOperationException">.NET Framework (all versions) and .NET Core 3.0 and later: The recipient certificate is not specified.</exception>
<exception cref="T:System.PlatformNotSupportedException">.NET Core version 2.2 and earlier: No signer certificate was provided.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignedCms.ComputeSignature(System.Security.Cryptography.Pkcs.CmsSigner)">
<summary>Creates a signature using the specified signer and adds the signature to the CMS/PKCS #7 message.</summary>
<param name="signer">A <see cref="T:System.Security.Cryptography.Pkcs.CmsSigner" /> object that represents the signer.</param>
<exception cref="T:System.ArgumentNullException">A null reference was passed to a method that does not accept it as a valid argument.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">A cryptographic operation could not be completed.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignedCms.ComputeSignature(System.Security.Cryptography.Pkcs.CmsSigner,System.Boolean)">
<summary>Creates a signature using the specified signer and adds the signature to the CMS/PKCS #7 message.</summary>
<param name="signer">A <see cref="T:System.Security.Cryptography.Pkcs.CmsSigner" /> object that represents the signer.</param>
<param name="silent">.NET Core only: <see langword="true" /> to request opening keys with PIN prompts disabled, where supported; otherwise, <see langword="false" />. In .NET Framework, this parameter is not used and a PIN prompt is always shown, if required.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="signer" /> is <see langword="null" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">A cryptographic operation could not be completed.</exception>
<exception cref="T:System.InvalidOperationException">.NET Framework only: A signing certificate is not specified.</exception>
<exception cref="T:System.PlatformNotSupportedException">.NET Core only: A signing certificate is not specified.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignedCms.Decode(System.Byte[])">
<summary>Decodes an encoded <see cref="T:System.Security.Cryptography.Pkcs.SignedCms" /> message.</summary>
<param name="encodedMessage">An array of byte values that represents the encoded CMS/PKCS#7 message to be decoded.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="encodedMessage" /> is <see langword="null" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">
<paramref name="encodedMessage" /> could not be decoded successfully.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignedCms.Decode(System.ReadOnlySpan{System.Byte})">
<param name="encodedMessage">A read-only span of byte values that represents the encoded CMS/PKCS#7 message to be decoded.</param>
<exception cref="T:System.Security.Cryptography.CryptographicException">
<paramref name="encodedMessage" /> could not be decoded successfully.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignedCms.Encode">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.SignedCms.Encode" /> method encodes the information in the object into a CMS/PKCS #7 message.</summary>
<exception cref="T:System.Security.Cryptography.CryptographicException">A cryptographic operation could not be completed.</exception>
<exception cref="T:System.InvalidOperationException">A method call was invalid for the object's current state.</exception>
<returns>An array of byte values that represents the encoded message. The encoded message can be decoded by the <see cref="M:System.Security.Cryptography.Pkcs.SignedCms.Decode(System.Byte[])" /> method.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignedCms.RemoveCertificate(System.Security.Cryptography.X509Certificates.X509Certificate2)">
<summary>Removes the specified certificate from the collection of certificates for the encoded CMS/PKCS #7 message.</summary>
<param name="certificate">The certificate to remove from the collection.</param>
<exception cref="T:System.Security.Cryptography.CryptographicException">The certificate was not found.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignedCms.RemoveSignature(System.Int32)">
<summary>Removes the signature at the specified index of the <see cref="P:System.Security.Cryptography.Pkcs.SignedCms.SignerInfos" /> collection.</summary>
<param name="index">The zero-based index of the signature to remove.</param>
<exception cref="T:System.InvalidOperationException">A CMS/PKCS #7 message is not signed, and <paramref name="index" /> is invalid.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="index" /> is less than zero.
-or-
<paramref name="index" /> is greater than the signature count minus 1.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The signature could not be removed.
-or-
An internal cryptographic error occurred.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignedCms.RemoveSignature(System.Security.Cryptography.Pkcs.SignerInfo)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.SignedCms.RemoveSignature(System.Security.Cryptography.Pkcs.SignerInfo)" /> method removes the signature for the specified <see cref="T:System.Security.Cryptography.Pkcs.SignerInfo" /> object.</summary>
<param name="signerInfo">A <see cref="T:System.Security.Cryptography.Pkcs.SignerInfo" /> object that represents the countersignature being removed.</param>
<exception cref="T:System.ArgumentNullException">A null reference was passed to a method that does not accept it as a valid argument.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The value of an argument was outside the allowable range of values as defined by the called method.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">A cryptographic operation could not be completed.</exception>
</member>
<member name="P:System.Security.Cryptography.Pkcs.SignedCms.Certificates">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.SignedCms.Certificates" /> property retrieves the certificates associated with the encoded CMS/PKCS #7 message.</summary>
<returns>An <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2Collection" /> collection that represents the set of certificates for the encoded CMS/PKCS #7 message.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.SignedCms.ContentInfo">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.SignedCms.ContentInfo" /> property retrieves the inner contents of the encoded CMS/PKCS #7 message.</summary>
<returns>A <see cref="T:System.Security.Cryptography.Pkcs.ContentInfo" /> object that represents the contents of the encoded CMS/PKCS #7 message.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.SignedCms.Detached">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.SignedCms.Detached" /> property retrieves whether the <see cref="T:System.Security.Cryptography.Pkcs.SignedCms" /> object is for a detached signature.</summary>
<returns>A <see cref="T:System.Boolean" /> value that specifies whether the <see cref="T:System.Security.Cryptography.Pkcs.SignedCms" /> object is for a detached signature. If this property is <see langword="true" />, the signature is detached. If this property is <see langword="false" />, the signature is not detached.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.SignedCms.SignerInfos">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.SignedCms.SignerInfos" /> property retrieves the <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" /> collection associated with the CMS/PKCS #7 message.</summary>
<returns>A <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" /> object that represents the signer information for the CMS/PKCS #7 message.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.SignedCms.Version">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.SignedCms.Version" /> property retrieves the version of the CMS/PKCS #7 message.</summary>
<returns>An int value that represents the CMS/PKCS #7 message version.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.SignerInfo">
<summary>The <see cref="T:System.Security.Cryptography.Pkcs.SignerInfo" /> class represents a signer associated with a <see cref="T:System.Security.Cryptography.Pkcs.SignedCms" /> object that represents a CMS/PKCS #7 message.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignerInfo.AddUnsignedAttribute(System.Security.Cryptography.AsnEncodedData)">
<summary>Adds the specified attribute to the current document.</summary>
<param name="asnEncodedData">The ASN.1 encoded attribute to add to the document.</param>
<exception cref="T:System.Security.Cryptography.CryptographicException">Cannot find the original signer.
-or-
ASN1 corrupted data.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignerInfo.CheckHash">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.SignerInfo.CheckHash" /> method verifies the data integrity of the CMS/PKCS #7 message signer information. <see cref="M:System.Security.Cryptography.Pkcs.SignerInfo.CheckHash" /> is a specialized method used in specific security infrastructure applications in which the subject uses the HashOnly member of the <see cref="T:System.Security.Cryptography.Pkcs.SubjectIdentifierType" /> enumeration when setting up a <see cref="T:System.Security.Cryptography.Pkcs.CmsSigner" /> object. <see cref="M:System.Security.Cryptography.Pkcs.SignerInfo.CheckHash" /> does not authenticate the signer information because this method does not involve verifying a digital signature. For general-purpose checking of the integrity and authenticity of CMS/PKCS #7 message signer information and countersignatures, use the <see cref="M:System.Security.Cryptography.Pkcs.SignerInfo.CheckSignature(System.Boolean)" /> or <see cref="M:System.Security.Cryptography.Pkcs.SignerInfo.CheckSignature(System.Security.Cryptography.X509Certificates.X509Certificate2Collection,System.Boolean)" /> methods.</summary>
<exception cref="T:System.Security.Cryptography.CryptographicException">A cryptographic operation could not be completed.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignerInfo.CheckSignature(System.Boolean)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.SignerInfo.CheckSignature(System.Boolean)" /> method verifies the digital signature of the message and, optionally, validates the certificate.</summary>
<param name="verifySignatureOnly">A bool value that specifies whether only the digital signature is verified. If <paramref name="verifySignatureOnly" /> is <see langword="true" />, only the signature is verified. If <paramref name="verifySignatureOnly" /> is <see langword="false" />, the digital signature is verified, the certificate chain is validated, and the purposes of the certificates are validated. The purposes of the certificate are considered valid if the certificate has no key usage or if the key usage supports digital signature or nonrepudiation.</param>
<exception cref="T:System.ArgumentNullException">A null reference was passed to a method that does not accept it as a valid argument.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">A cryptographic operation could not be completed.</exception>
<exception cref="T:System.InvalidOperationException">A method call was invalid for the object's current state.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignerInfo.CheckSignature(System.Security.Cryptography.X509Certificates.X509Certificate2Collection,System.Boolean)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.SignerInfo.CheckSignature(System.Security.Cryptography.X509Certificates.X509Certificate2Collection,System.Boolean)" /> method verifies the digital signature of the message by using the specified collection of certificates and, optionally, validates the certificate.</summary>
<param name="extraStore">An <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2Collection" /> object that can be used to validate the chain. If no additional certificates are to be used to validate the chain, use <see cref="M:System.Security.Cryptography.Pkcs.SignerInfo.CheckSignature(System.Boolean)" /> instead of <see cref="M:System.Security.Cryptography.Pkcs.SignerInfo.CheckSignature(System.Security.Cryptography.X509Certificates.X509Certificate2Collection,System.Boolean)" />.</param>
<param name="verifySignatureOnly">A bool value that specifies whether only the digital signature is verified. If <paramref name="verifySignatureOnly" /> is <see langword="true" />, only the signature is verified. If <paramref name="verifySignatureOnly" /> is <see langword="false" />, the digital signature is verified, the certificate chain is validated, and the purposes of the certificates are validated. The purposes of the certificate are considered valid if the certificate has no key usage or if the key usage supports digital signature or nonrepudiation.</param>
<exception cref="T:System.ArgumentNullException">A null reference was passed to a method that does not accept it as a valid argument.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">A cryptographic operation could not be completed.</exception>
<exception cref="T:System.InvalidOperationException">A method call was invalid for the object's current state.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignerInfo.ComputeCounterSignature">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.SignerInfo.ComputeCounterSignature" /> method prompts the user to select a signing certificate, creates a countersignature, and adds the signature to the CMS/PKCS #7 message. Countersignatures are restricted to one level.</summary>
<exception cref="T:System.ArgumentNullException">A null reference was passed to a method that does not accept it as a valid argument.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">A cryptographic operation could not be completed.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignerInfo.ComputeCounterSignature(System.Security.Cryptography.Pkcs.CmsSigner)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.SignerInfo.ComputeCounterSignature(System.Security.Cryptography.Pkcs.CmsSigner)" /> method creates a countersignature by using the specified signer and adds the signature to the CMS/PKCS #7 message. Countersignatures are restricted to one level.</summary>
<param name="signer">A <see cref="T:System.Security.Cryptography.Pkcs.CmsSigner" /> object that represents the counter signer.</param>
<exception cref="T:System.ArgumentNullException">A null reference was passed to a method that does not accept it as a valid argument.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">A cryptographic operation could not be completed.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignerInfo.GetSignature">
<summary>Retrieves the signature for the current <see cref="T:System.Security.Cryptography.Pkcs.SignerInfo" /> object.</summary>
<returns>The signature for the current <see cref="T:System.Security.Cryptography.Pkcs.SignerInfo" /> object.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignerInfo.RemoveCounterSignature(System.Int32)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.SignerInfo.RemoveCounterSignature(System.Int32)" /> method removes the countersignature at the specified index of the <see cref="P:System.Security.Cryptography.Pkcs.SignerInfo.CounterSignerInfos" /> collection.</summary>
<param name="index">The zero-based index of the countersignature to remove.</param>
<exception cref="T:System.Security.Cryptography.CryptographicException">A cryptographic operation could not be completed.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignerInfo.RemoveCounterSignature(System.Security.Cryptography.Pkcs.SignerInfo)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.SignerInfo.RemoveCounterSignature(System.Security.Cryptography.Pkcs.SignerInfo)" /> method removes the countersignature for the specified <see cref="T:System.Security.Cryptography.Pkcs.SignerInfo" /> object.</summary>
<param name="counterSignerInfo">A <see cref="T:System.Security.Cryptography.Pkcs.SignerInfo" /> object that represents the countersignature being removed.</param>
<exception cref="T:System.ArgumentNullException">A null reference was passed to a method that does not accept it as a valid argument.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The value of an argument was outside the allowable range of values as defined by the called method.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">A cryptographic operation could not be completed.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignerInfo.RemoveUnsignedAttribute(System.Security.Cryptography.AsnEncodedData)">
<summary>Removes the specified attribute from the current document.</summary>
<param name="asnEncodedData">The ASN.1 encoded attribute to remove from the document.</param>
<exception cref="T:System.Security.Cryptography.CryptographicException">Cannot find the original signer.
-or-
Attribute not found.
-or-
ASN1 corrupted data.</exception>
</member>
<member name="P:System.Security.Cryptography.Pkcs.SignerInfo.Certificate">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.SignerInfo.Certificate" /> property retrieves the signing certificate associated with the signer information.</summary>
<returns>An <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2" /> object that represents the signing certificate.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.SignerInfo.CounterSignerInfos">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.SignerInfo.CounterSignerInfos" /> property retrieves the set of counter signers associated with the signer information.</summary>
<returns>A <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" /> collection that represents the counter signers for the signer information. If there are no counter signers, the property is an empty collection.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.SignerInfo.DigestAlgorithm">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.SignerInfo.DigestAlgorithm" /> property retrieves the <see cref="T:System.Security.Cryptography.Oid" /> object that represents the hash algorithm used in the computation of the signatures.</summary>
<returns>An <see cref="T:System.Security.Cryptography.Oid" /> object that represents the hash algorithm used with the signature.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.SignerInfo.SignatureAlgorithm">
<summary>Gets the identifier for the signature algorithm used by the current <see cref="T:System.Security.Cryptography.Pkcs.SignerInfo" /> object.</summary>
<returns>The identifier for the signature algorithm used by the current <see cref="T:System.Security.Cryptography.Pkcs.SignerInfo" /> object.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.SignerInfo.SignedAttributes">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.SignerInfo.SignedAttributes" /> property retrieves the <see cref="T:System.Security.Cryptography.CryptographicAttributeObjectCollection" /> collection of signed attributes that is associated with the signer information. Signed attributes are signed along with the rest of the message content.</summary>
<returns>A <see cref="T:System.Security.Cryptography.CryptographicAttributeObjectCollection" /> collection that represents the signed attributes. If there are no signed attributes, the property is an empty collection.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.SignerInfo.SignerIdentifier">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.SignerInfo.SignerIdentifier" /> property retrieves the certificate identifier of the signer associated with the signer information.</summary>
<returns>A <see cref="T:System.Security.Cryptography.Pkcs.SubjectIdentifier" /> object that uniquely identifies the certificate associated with the signer information.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.SignerInfo.UnsignedAttributes">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.SignerInfo.UnsignedAttributes" /> property retrieves the <see cref="T:System.Security.Cryptography.CryptographicAttributeObjectCollection" /> collection of unsigned attributes that is associated with the <see cref="T:System.Security.Cryptography.Pkcs.SignerInfo" /> content. Unsigned attributes can be modified without invalidating the signature.</summary>
<returns>A <see cref="T:System.Security.Cryptography.CryptographicAttributeObjectCollection" /> collection that represents the unsigned attributes. If there are no unsigned attributes, the property is an empty collection.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.SignerInfo.Version">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.SignerInfo.Version" /> property retrieves the signer information version.</summary>
<returns>An int value that specifies the signer information version.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.SignerInfoCollection">
<summary>The <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" /> class represents a collection of <see cref="T:System.Security.Cryptography.Pkcs.SignerInfo" /> objects. <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" /> implements the <see cref="T:System.Collections.ICollection" /> interface.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignerInfoCollection.CopyTo(System.Array,System.Int32)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.SignerInfoCollection.CopyTo(System.Array,System.Int32)" /> method copies the <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" /> collection to an array.</summary>
<param name="array">An <see cref="T:System.Array" /> object to which the <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" /> collection is to be copied.</param>
<param name="index">The zero-based index in <paramref name="array" /> where the <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" /> collection is copied.</param>
<exception cref="T:System.ArgumentException">One of the arguments provided to a method was not valid.</exception>
<exception cref="T:System.ArgumentNullException">A null reference was passed to a method that does not accept it as a valid argument.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The value of an argument was outside the allowable range of values as defined by the called method.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignerInfoCollection.CopyTo(System.Security.Cryptography.Pkcs.SignerInfo[],System.Int32)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.SignerInfoCollection.CopyTo(System.Security.Cryptography.Pkcs.SignerInfo[],System.Int32)" /> method copies the <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" /> collection to a <see cref="T:System.Security.Cryptography.Pkcs.SignerInfo" /> array.</summary>
<param name="array">An array of <see cref="T:System.Security.Cryptography.Pkcs.SignerInfo" /> objects where the <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" /> collection is to be copied.</param>
<param name="index">The zero-based index in <paramref name="array" /> where the <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" /> collection is copied.</param>
<exception cref="T:System.ArgumentException">One of the arguments provided to a method was not valid.</exception>
<exception cref="T:System.ArgumentNullException">A null reference was passed to a method that does not accept it as a valid argument.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The value of an argument was outside the allowable range of values as defined by the called method.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignerInfoCollection.GetEnumerator">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.SignerInfoCollection.GetEnumerator" /> method returns a <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoEnumerator" /> object for the <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" /> collection.</summary>
<returns>A <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoEnumerator" /> object that can be used to enumerate the <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" /> collection.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignerInfoCollection.System#Collections#IEnumerable#GetEnumerator">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.SignerInfoCollection.System#Collections#IEnumerable#GetEnumerator" /> method returns a <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoEnumerator" /> object for the <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" /> collection.</summary>
<returns>A <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoEnumerator" /> object that can be used to enumerate the <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" /> collection.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.SignerInfoCollection.Count">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.SignerInfoCollection.Count" /> property retrieves the number of items in the <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" /> collection.</summary>
<returns>An int value that represents the number of items in the collection.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.SignerInfoCollection.IsSynchronized">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.SignerInfoCollection.IsSynchronized" /> property retrieves whether access to the collection is synchronized, or thread safe. This property always returns <see langword="false" />, which means the collection is not thread safe.</summary>
<returns>A <see cref="T:System.Boolean" /> value of <see langword="false" />, which means the collection is not thread safe.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.SignerInfoCollection.Item(System.Int32)">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.SignerInfoCollection.Item(System.Int32)" /> property retrieves the <see cref="T:System.Security.Cryptography.Pkcs.SignerInfo" /> object at the specified index in the collection.</summary>
<param name="index">An int value that represents the index in the collection. The index is zero based.</param>
<exception cref="T:System.ArgumentOutOfRangeException">The value of an argument was outside the allowable range of values as defined by the called method.</exception>
<returns>A <see cref="T:System.Security.Cryptography.Pkcs.SignerInfo" /> object at the specified index.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.SignerInfoCollection.SyncRoot">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.SignerInfoCollection.SyncRoot" /> property retrieves an <see cref="T:System.Object" /> object is used to synchronize access to the <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" /> collection.</summary>
<returns>An <see cref="T:System.Object" /> object is used to synchronize access to the <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" /> collection.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.SignerInfoEnumerator">
<summary>The <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoEnumerator" /> class provides enumeration functionality for the <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" /> collection. <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoEnumerator" /> implements the <see cref="T:System.Collections.IEnumerator" /> interface.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignerInfoEnumerator.MoveNext">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.SignerInfoEnumerator.MoveNext" /> method advances the enumeration to the next <see cref="T:System.Security.Cryptography.Pkcs.SignerInfo" /> object in the <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" /> collection.</summary>
<returns>This method returns a bool value that specifies whether the enumeration successfully advanced. If the enumeration successfully moved to the next <see cref="T:System.Security.Cryptography.Pkcs.SignerInfo" /> object, the method returns <see langword="true" />. If the enumeration moved past the last item in the enumeration, it returns <see langword="false" />.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignerInfoEnumerator.Reset">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.SignerInfoEnumerator.Reset" /> method resets the enumeration to the first <see cref="T:System.Security.Cryptography.Pkcs.SignerInfo" /> object in the <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" /> collection.</summary>
</member>
<member name="P:System.Security.Cryptography.Pkcs.SignerInfoEnumerator.Current">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.SignerInfoEnumerator.Current" /> property retrieves the current <see cref="T:System.Security.Cryptography.Pkcs.SignerInfo" /> object from the <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" /> collection.</summary>
<returns>A <see cref="T:System.Security.Cryptography.Pkcs.SignerInfo" /> object that represents the current signer information structure in the <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" /> collection.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.SignerInfoEnumerator.System#Collections#IEnumerator#Current">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.SignerInfoEnumerator.System#Collections#IEnumerator#Current" /> property retrieves the current <see cref="T:System.Security.Cryptography.Pkcs.SignerInfo" /> object from the <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" /> collection.</summary>
<returns>A <see cref="T:System.Security.Cryptography.Pkcs.SignerInfo" /> object that represents the current signer information structure in the <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" /> collection.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.SubjectIdentifier">
<summary>The <see cref="T:System.Security.Cryptography.Pkcs.SubjectIdentifier" /> class defines the type of the identifier of a subject, such as a <see cref="T:System.Security.Cryptography.Pkcs.CmsSigner" /> or a <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" />. The subject can be identified by the certificate issuer and serial number or the subject key.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SubjectIdentifier.MatchesCertificate(System.Security.Cryptography.X509Certificates.X509Certificate2)">
<summary>Verifies if the specified certificate's subject identifier matches current subject identifier instance.</summary>
<param name="certificate">The certificate to match with the current subject identifier instance.</param>
<exception cref="T:System.Security.Cryptography.CryptographicException">Invalid subject identifier type.</exception>
<returns>
<see langword="true" /> if the specified certificate's identifier matches the current subject identifier instance; otherwise, <see langword="false" />.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.SubjectIdentifier.Type">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.SubjectIdentifier.Type" /> property retrieves the type of subject identifier. The subject can be identified by the certificate issuer and serial number or the subject key.</summary>
<returns>A member of the <see cref="T:System.Security.Cryptography.Pkcs.SubjectIdentifierType" /> enumeration that identifies the type of subject.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.SubjectIdentifier.Value">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.SubjectIdentifier.Value" /> property retrieves the value of the subject identifier. Use the <see cref="P:System.Security.Cryptography.Pkcs.SubjectIdentifier.Type" /> property to determine the type of subject identifier, and use the <see cref="P:System.Security.Cryptography.Pkcs.SubjectIdentifier.Value" /> property to retrieve the corresponding value.</summary>
<returns>An <see cref="T:System.Object" /> object that represents the value of the subject identifier. This <see cref="T:System.Object" /> can be one of the following objects as determined by the <see cref="P:System.Security.Cryptography.Pkcs.SubjectIdentifier.Type" /> property.
<list type="table"><listheader><term><see cref="P:System.Security.Cryptography.Pkcs.SubjectIdentifier.Type" /> property</term><description> Object</description></listheader><item><term> IssuerAndSerialNumber</term><description><see cref="T:System.Security.Cryptography.Xml.X509IssuerSerial" /></description></item><item><term> SubjectKeyIdentifier</term><description><see cref="T:System.String" /></description></item></list></returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.SubjectIdentifierOrKey">
<summary>The <see cref="T:System.Security.Cryptography.Pkcs.SubjectIdentifierOrKey" /> class defines the type of the identifier of a subject, such as a <see cref="T:System.Security.Cryptography.Pkcs.CmsSigner" /> or a <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" />. The subject can be identified by the certificate issuer and serial number, the hash of the subject key, or the subject key.</summary>
</member>
<member name="P:System.Security.Cryptography.Pkcs.SubjectIdentifierOrKey.Type">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.SubjectIdentifierOrKey.Type" /> property retrieves the type of subject identifier or key. The subject can be identified by the certificate issuer and serial number, the hash of the subject key, or the subject key.</summary>
<returns>A member of the <see cref="T:System.Security.Cryptography.Pkcs.SubjectIdentifierOrKeyType" /> enumeration that specifies the type of subject identifier.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.SubjectIdentifierOrKey.Value">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.SubjectIdentifierOrKey.Value" /> property retrieves the value of the subject identifier or key. Use the <see cref="P:System.Security.Cryptography.Pkcs.SubjectIdentifierOrKey.Type" /> property to determine the type of subject identifier or key, and use the <see cref="P:System.Security.Cryptography.Pkcs.SubjectIdentifierOrKey.Value" /> property to retrieve the corresponding value.</summary>
<returns>An <see cref="T:System.Object" /> object that represents the value of the subject identifier or key. This <see cref="T:System.Object" /> can be one of the following objects as determined by the <see cref="P:System.Security.Cryptography.Pkcs.SubjectIdentifierOrKey.Type" /> property.
<list type="table"><listheader><term><see cref="P:System.Security.Cryptography.Pkcs.SubjectIdentifierOrKey.Type" /> property</term><description> Object</description></listheader><item><term> IssuerAndSerialNumber</term><description><see cref="T:System.Security.Cryptography.Xml.X509IssuerSerial" /></description></item><item><term> SubjectKeyIdentifier</term><description><see cref="T:System.String" /></description></item><item><term> PublicKeyInfo</term><description><see cref="T:System.Security.Cryptography.Pkcs.PublicKeyInfo" /></description></item></list></returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.SubjectIdentifierOrKeyType">
<summary>The <see cref="T:System.Security.Cryptography.Pkcs.SubjectIdentifierOrKeyType" /> enumeration defines how a subject is identified.</summary>
</member>
<member name="F:System.Security.Cryptography.Pkcs.SubjectIdentifierOrKeyType.IssuerAndSerialNumber">
<summary>The subject is identified by the certificate issuer and serial number.</summary>
</member>
<member name="F:System.Security.Cryptography.Pkcs.SubjectIdentifierOrKeyType.PublicKeyInfo">
<summary>The subject is identified by the public key.</summary>
</member>
<member name="F:System.Security.Cryptography.Pkcs.SubjectIdentifierOrKeyType.SubjectKeyIdentifier">
<summary>The subject is identified by the hash of the subject key.</summary>
</member>
<member name="F:System.Security.Cryptography.Pkcs.SubjectIdentifierOrKeyType.Unknown">
<summary>The type is unknown.</summary>
</member>
<member name="T:System.Security.Cryptography.Pkcs.SubjectIdentifierType">
<summary>The <see cref="T:System.Security.Cryptography.Pkcs.SubjectIdentifierType" /> enumeration defines the type of subject identifier.</summary>
</member>
<member name="F:System.Security.Cryptography.Pkcs.SubjectIdentifierType.IssuerAndSerialNumber">
<summary>The subject is identified by the certificate issuer and serial number.</summary>
</member>
<member name="F:System.Security.Cryptography.Pkcs.SubjectIdentifierType.NoSignature">
<summary>The subject is identified as taking part in an integrity check operation that uses only a hashing algorithm.</summary>
</member>
<member name="F:System.Security.Cryptography.Pkcs.SubjectIdentifierType.SubjectKeyIdentifier">
<summary>The subject is identified by the hash of the subject's public key. The hash algorithm used is determined by the signature algorithm suite in the subject's certificate.</summary>
</member>
<member name="F:System.Security.Cryptography.Pkcs.SubjectIdentifierType.Unknown">
<summary>The type of subject identifier is unknown.</summary>
</member>
<member name="T:System.Security.Cryptography.Xml.X509IssuerSerial">
<summary>Represents the <<see langword="X509IssuerSerial" />> element of an XML digital signature.</summary>
</member>
<member name="P:System.Security.Cryptography.Xml.X509IssuerSerial.IssuerName">
<summary>Gets or sets an X.509 certificate issuer's distinguished name.</summary>
<returns>An X.509 certificate issuer's distinguished name.</returns>
</member>
<member name="P:System.Security.Cryptography.Xml.X509IssuerSerial.SerialNumber">
<summary>Gets or sets an X.509 certificate issuer's serial number.</summary>
<returns>An X.509 certificate issuer's serial number.</returns>
</member>
</members>
</doc>
md5: D3AD09FBF202167B7E6B5F0E1296380B | sha1: 2C099DB9745C21754B03A4C9AF55213A1A4444F5 | sha256: 81A0385CF1FED22F3153789D4AE1FEE75719F23E72CD543EDBA1AF48926FBF24 | sha512: 0B660A4ACB24D382BBD7058E2A3D21CDD741E7ED0A9D60672B0B667A75E145E229A594D302C78AECB5A729830092BA0117187665F8043A6590F8829D86991395
Cake.Bakery is from the Cake Build Project, and we maintain the package.
md5: BD2D2B1819DFB5CEE6C196E3DFE812B8 | sha1: A3B5572E2F961B39E65CC5A52A5F3395419B2023 | sha256: 491E8493BC9338C1D4843292E5344E975C3DE0780D51E1497F0C1D3F1D681D7F | sha512: 048CD7EE1FF0E6E269CBBF838891CB0247742F89404C072FACB8AFADCAB9DA0C420BDF0EF4A27C32DE95E9A9A3D78C97A14BB68B4C50704B982713F6E9E171EA
md5: 00AFB1A37E7A63A7CBEA25450F938135 | sha1: D9CA223396F5BFBCE803663B8B5AC3AEFAAC776C | sha256: A4E03DF29991AFF5C5D8C46E67EFCF10B1106F2399BD3874995FBA882E2A680D | sha512: 9A3974F605976DA6382DE2B2335CA3C03A8CCB746CC3DFB225B2ACDC7E58FAA73CF9318B9A8712073B990DCC684592095FEA99F965D1C802ED026B9BDFD43A48
md5: 05121F0EC7F37F9447761523BA9FE120 | sha1: 8949EE458B73B4726871EC47F36CA965F7138DEC | sha256: 784F2F17A8098B990CF9168380A1F68E5E8D1C3A55EA6AFADDCE508F497AD454 | sha512: 02CF02BF05B398E5FDA25CFF46BFABE8BE8740F5397C04010A43315FD8D9ACFEB6E30D80895B47B3FEF73DC99132E2A5DC06A377DAE932028E2BD4E4D0CC777D
md5: AF03AF833BDD544BDF3DBDF5049BD7F4 | sha1: 5DFA3D2C0D1FEDCEAC499F1BD731A75C02841532 | sha256: 21AEBC6B5124A4C128992B84FE26635931F40323561BC9D3EFF4F2AE9C7DED97 | sha512: 3F63F5163DC3525F9920FA04B534908D87EE64FCAA0DAD72F89B66C3B72903F160F4D7FF428218F533A334B84147EDA4F0BE5C04D5464889DB7D08B362513D2E
md5: 337067355424D42F516CD3F2C1A96CFF | sha1: A268204FCE79F4CC9C27465A7B35E62D4938D71D | sha256: AE609DA7D2DCD03F0089DE1BFA71B61515EEFABC360EA3754BB228DFCA7C502F | sha512: 3436F499E9B1612BF2FBE893CAF33A542B91F9BC5B096D4C7AEB7FDAAEABA71E3BDCE607AE18F1E149C847E998B75778082D484051C9798E6760571A8CC484DD
md5: E1F8F271E0CF9BB8701B2AF99C769773 | sha1: CD647A3DDC61D6565D0F745E1824FF3EF45696ED | sha256: 0B70F2E60EEB16BEE7B6AC7CA94A237A059F69878FB7221349BE05FB6B61667B | sha512: BA4316A61B540F895FD9581463E6951E240DF9CCAFB6394FC739D68F82B3124D14BC603C8CC5D829F2153C61D531B524EF8ECB78A24036BA3D13AB0BCD2DAFF6
md5: 1D0F1229B9C1CD7C24A46E652ABDAA45 | sha1: B67493197C4492A2233DBDA7CAE527E7C54BFBDD | sha256: ADBDF9F561E95B541229C048FFDE938558121A202AE3999255065D0335A86F15 | sha512: 4A0B26422DE9B7FCF72E482150194D5FB41D25B5CFF4CA94657EB3D3DE76B053138DF4FA4C1026764387C4B4EBDB1DDBBD72EEED54505DE6CBC70A5F0697E836
md5: C6C67AD06B6A710A476A872E60E8A6E4 | sha1: 993F0BD96594F379891D7F3295A4FC4EB00CEF17 | sha256: E66DD1C4ED1A9E42E7C0F36AC6E29244AB0468965525B19D0E2D1BB65CCE8260 | sha512: 89B3901F81088E372A5A5F8355CB9F03D110F6AF87EF60D95623AC59F36B33D1ED1857454E717B0B2715C5995D37D3C9B2CBB9F09559A487E4133801FA751051
md5: 1F147966D928C83770FA1FD878C2E8CB | sha1: E268AE2FA3888AEC2F604F9AB73E5AA4370DD019 | sha256: 00439950C7DB297724EBA0E688C246DF6E4405023F747FC666281FBD5492CBE7 | sha512: 66511CE9462B894D1BD584190B044D0FD0E4EAFFB015D2F1A98AE0F4ED7888485C7470597E16E9E17BFB8EF9CDA7113A41727E1DF184CB92F63876AE87D1C649
md5: F07BA967AD03C1A10E38214732D7B070 | sha1: DEF5DBB33C25568E52D1E0CD461AA25718971ED5 | sha256: 39A6CC83BCCD7F5C51130AE05606DFD850EED4B22FDD3828A7455F69633F00A1 | sha512: 2B12B41ACCA210DEBF49160B4530B4D2372DF70B56FCE31174C3B981C954194984D2AC125FE2C145D9FFB7E7E2497A7980EE85F69C84B30B86572D4B5DE95EED
md5: 01F7154837DD7ADE1FE662F60BCE1D78 | sha1: F2A9C2AE4947DD33AAF9E541231DE9407B4C8875 | sha256: E4F0E9E4AA3A76B9679E1AACD405108E86F54687F6A2CF87B2EF9766BF0B1B02 | sha512: A79A775FA16C08CFB0107FC37A1507E021DE97F8B656BDEF9E089378B51D1A539B18C4B662E4FC0A727CA1E58C5B5548745D7B9DA2402F2B297573B9C391F3D5
md5: 6DFFCB06FCD693BB53BC936B713DCD7D | sha1: 4624153006012D9A057A6E62D509CBF8155314C4 | sha256: 3CED24815D2F5E8ECA1DB4397EF1F0DA3901348D560C3FCD49AA25759E15EA5D | sha512: 3C070AAEE39514097A2256AF92BEA47C916F54AA7E313D92A2A76E9A854D08603F817F39AEF741E682A79A322E0B26814D4C6A6496E9C725701586DB33F48E33
md5: F99006E932ECD51895B060C99E79E9E4 | sha1: 2842201AD806EE3359F9148720002D315AD979C0 | sha256: B962CDC66A84E8F45AAF24B80364BE87D7CC21B833FD71D328288E5926BE7247 | sha512: F26ECC0E260696C0D05E9A6D7CD2B4E5AF933F1EEC116C9DD239A20B61963953A6573E864DDEFD0F4552B41ED35C092F7D54A2D18DA706A550587FFFAD31CB42
md5: 0E92C23AB082AE85D899CB156EB95181 | sha1: DBDADB33A03ACC12C06D247FC0A2D24293D258FE | sha256: DCD6223FBBBCA170271F02E8A55B76F5C0E57351B972EE92BC7336D1D3A2EC60 | sha512: 4198DB992B312F1BCAC29854DE216B2F41E22CD29CC5541CE3034BAD684C6414ABD1CD43AE6D72CE753B851749D919C60B333BA5AFAFFD0A366869EAADD3A8DF
<?xml version="1.0" encoding="utf-8"?>
<doc>
<assembly>
<name>System.Security.Cryptography.Pkcs</name>
</assembly>
<members>
<member name="T:System.Security.Cryptography.CryptographicAttributeObject">
<summary>Contains a type and a collection of values associated with that type.</summary>
</member>
<member name="M:System.Security.Cryptography.CryptographicAttributeObject.#ctor(System.Security.Cryptography.Oid)">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.CryptographicAttributeObject" /> class using an attribute represented by the specified <see cref="T:System.Security.Cryptography.Oid" /> object.</summary>
<param name="oid">The attribute to store in this <see cref="T:System.Security.Cryptography.CryptographicAttributeObject" /> object.</param>
</member>
<member name="M:System.Security.Cryptography.CryptographicAttributeObject.#ctor(System.Security.Cryptography.Oid,System.Security.Cryptography.AsnEncodedDataCollection)">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.CryptographicAttributeObject" /> class using an attribute represented by the specified <see cref="T:System.Security.Cryptography.Oid" /> object and the set of values associated with that attribute represented by the specified <see cref="T:System.Security.Cryptography.AsnEncodedDataCollection" /> collection.</summary>
<param name="oid">The attribute to store in this <see cref="T:System.Security.Cryptography.CryptographicAttributeObject" /> object.</param>
<param name="values">The set of values associated with the attribute represented by the <paramref name="oid" /> parameter.</param>
<exception cref="T:System.InvalidOperationException">The collection contains duplicate items.</exception>
</member>
<member name="P:System.Security.Cryptography.CryptographicAttributeObject.Oid">
<summary>Gets the <see cref="T:System.Security.Cryptography.Oid" /> object that specifies the object identifier for the attribute.</summary>
<returns>The object identifier for the attribute.</returns>
</member>
<member name="P:System.Security.Cryptography.CryptographicAttributeObject.Values">
<summary>Gets the <see cref="T:System.Security.Cryptography.AsnEncodedDataCollection" /> collection that contains the set of values that are associated with the attribute.</summary>
<returns>The set of values that is associated with the attribute.</returns>
</member>
<member name="T:System.Security.Cryptography.CryptographicAttributeObjectCollection">
<summary>Contains a set of <see cref="T:System.Security.Cryptography.CryptographicAttributeObject" /> objects.</summary>
</member>
<member name="M:System.Security.Cryptography.CryptographicAttributeObjectCollection.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.CryptographicAttributeObjectCollection" /> class.</summary>
</member>
<member name="M:System.Security.Cryptography.CryptographicAttributeObjectCollection.#ctor(System.Security.Cryptography.CryptographicAttributeObject)">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.CryptographicAttributeObjectCollection" /> class, adding a specified <see cref="T:System.Security.Cryptography.CryptographicAttributeObject" /> to the collection.</summary>
<param name="attribute">A <see cref="T:System.Security.Cryptography.CryptographicAttributeObject" /> object that is added to the collection.</param>
</member>
<member name="M:System.Security.Cryptography.CryptographicAttributeObjectCollection.Add(System.Security.Cryptography.AsnEncodedData)">
<summary>Adds the specified <see cref="T:System.Security.Cryptography.AsnEncodedData" /> object to the collection.</summary>
<param name="asnEncodedData">The <see cref="T:System.Security.Cryptography.AsnEncodedData" /> object to add to the collection.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="asnEncodedData" /> is <see langword="null" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">A cryptographic operation could not be completed.</exception>
<returns>
<see langword="true" /> if the method returns the zero-based index of the added item; otherwise, <see langword="false" />.</returns>
</member>
<member name="M:System.Security.Cryptography.CryptographicAttributeObjectCollection.Add(System.Security.Cryptography.CryptographicAttributeObject)">
<summary>Adds the specified <see cref="T:System.Security.Cryptography.CryptographicAttributeObject" /> object to the collection.</summary>
<param name="attribute">The <see cref="T:System.Security.Cryptography.CryptographicAttributeObject" /> object to add to the collection.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="asnEncodedData" /> is <see langword="null" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">A cryptographic operation could not be completed.</exception>
<exception cref="T:System.InvalidOperationException">The specified item already exists in the collection.</exception>
<returns>
<see langword="true" /> if the method returns the zero-based index of the added item; otherwise, <see langword="false" />.</returns>
</member>
<member name="M:System.Security.Cryptography.CryptographicAttributeObjectCollection.CopyTo(System.Security.Cryptography.CryptographicAttributeObject[],System.Int32)">
<summary>Copies the <see cref="T:System.Security.Cryptography.CryptographicAttributeObjectCollection" /> collection to an array of <see cref="T:System.Security.Cryptography.CryptographicAttributeObject" /> objects.</summary>
<param name="array">An array of <see cref="T:System.Security.Cryptography.CryptographicAttributeObject" /> objects that the collection is copied to.</param>
<param name="index">The zero-based index in <paramref name="array" /> to which the collection is to be copied.</param>
<exception cref="T:System.ArgumentException">One of the arguments provided to a method was not valid.</exception>
<exception cref="T:System.ArgumentNullException">
<see langword="null" /> was passed to a method that does not accept it as a valid argument.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The value of an argument was outside the allowable range of values as defined by the called method.</exception>
</member>
<member name="M:System.Security.Cryptography.CryptographicAttributeObjectCollection.GetEnumerator">
<summary>Gets a <see cref="T:System.Security.Cryptography.CryptographicAttributeObjectEnumerator" /> object for the collection.</summary>
<returns>
<see langword="true" /> if the method returns a <see cref="T:System.Security.Cryptography.CryptographicAttributeObjectEnumerator" /> object that can be used to enumerate the collection; otherwise, <see langword="false" />.</returns>
</member>
<member name="M:System.Security.Cryptography.CryptographicAttributeObjectCollection.Remove(System.Security.Cryptography.CryptographicAttributeObject)">
<summary>Removes the specified <see cref="T:System.Security.Cryptography.CryptographicAttributeObject" /> object from the collection.</summary>
<param name="attribute">The <see cref="T:System.Security.Cryptography.CryptographicAttributeObject" /> object to remove from the collection.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="attribute" /> is <see langword="null" />.</exception>
</member>
<member name="M:System.Security.Cryptography.CryptographicAttributeObjectCollection.System#Collections#ICollection#CopyTo(System.Array,System.Int32)">
<summary>Copies the elements of this <see cref="T:System.Security.Cryptography.CryptographicAttributeObjectCollection" /> collection to an <see cref="T:System.Array" /> array, starting at a particular index.</summary>
<param name="array">The one-dimensional <see cref="T:System.Array" /> array that is the destination of the elements copied from this <see cref="T:System.Security.Cryptography.CryptographicAttributeObjectCollection" />. The <see cref="T:System.Array" /> array must have zero-based indexing.</param>
<param name="index">The zero-based index in <paramref name="array" /> at which copying begins.</param>
</member>
<member name="M:System.Security.Cryptography.CryptographicAttributeObjectCollection.System#Collections#IEnumerable#GetEnumerator">
<summary>Returns an enumerator that iterates through the <see cref="T:System.Security.Cryptography.CryptographicAttributeObjectCollection" /> collection.</summary>
<returns>An <see cref="T:System.Collections.IEnumerator" /> object that can be used to iterate through the <see cref="T:System.Security.Cryptography.CryptographicAttributeObjectCollection" /> collection.</returns>
</member>
<member name="P:System.Security.Cryptography.CryptographicAttributeObjectCollection.Count">
<summary>Gets the number of items in the collection.</summary>
<returns>The number of items in the collection.</returns>
</member>
<member name="P:System.Security.Cryptography.CryptographicAttributeObjectCollection.IsSynchronized">
<summary>Gets a value that indicates whether access to the collection is synchronized, or thread safe.</summary>
<returns>
<see langword="true" /> if access to the collection is thread safe; otherwise <see langword="false" />.</returns>
</member>
<member name="P:System.Security.Cryptography.CryptographicAttributeObjectCollection.Item(System.Int32)">
<summary>Gets the <see cref="T:System.Security.Cryptography.CryptographicAttributeObject" /> object at the specified index in the collection.</summary>
<param name="index">An <see cref="T:System.Int32" /> value that represents the zero-based index of the <see cref="T:System.Security.Cryptography.CryptographicAttributeObject" /> object to retrieve.</param>
<returns>The <see cref="T:System.Security.Cryptography.CryptographicAttributeObject" /> object at the specified index.</returns>
</member>
<member name="P:System.Security.Cryptography.CryptographicAttributeObjectCollection.SyncRoot">
<summary>Gets an <see cref="T:System.Object" /> object used to synchronize access to the collection.</summary>
<returns>An <see cref="T:System.Object" /> object used to synchronize access to the <see cref="T:System.Security.Cryptography.CryptographicAttributeObjectCollection" /> collection.</returns>
</member>
<member name="T:System.Security.Cryptography.CryptographicAttributeObjectEnumerator">
<summary>Provides enumeration functionality for the <see cref="T:System.Security.Cryptography.CryptographicAttributeObjectCollection" /> collection. This class cannot be inherited.</summary>
</member>
<member name="M:System.Security.Cryptography.CryptographicAttributeObjectEnumerator.MoveNext">
<summary>Advances the enumeration to the next <see cref="T:System.Security.Cryptography.CryptographicAttributeObject" /> object in the <see cref="T:System.Security.Cryptography.CryptographicAttributeObjectCollection" /> collection.</summary>
<returns>
<see langword="true" /> if the enumeration successfully moved to the next <see cref="T:System.Security.Cryptography.CryptographicAttributeObject" /> object; <see langword="false" /> if the enumerator is at the end of the enumeration.</returns>
</member>
<member name="M:System.Security.Cryptography.CryptographicAttributeObjectEnumerator.Reset">
<summary>Resets the enumeration to the first <see cref="T:System.Security.Cryptography.CryptographicAttributeObject" /> object in the <see cref="T:System.Security.Cryptography.CryptographicAttributeObjectCollection" /> collection.</summary>
</member>
<member name="P:System.Security.Cryptography.CryptographicAttributeObjectEnumerator.Current">
<summary>Gets the current <see cref="T:System.Security.Cryptography.CryptographicAttributeObject" /> object from the <see cref="T:System.Security.Cryptography.CryptographicAttributeObjectCollection" /> collection.</summary>
<returns>A <see cref="T:System.Security.Cryptography.CryptographicAttributeObject" /> object that represents the current cryptographic attribute in the <see cref="T:System.Security.Cryptography.CryptographicAttributeObjectCollection" /> collection.</returns>
</member>
<member name="P:System.Security.Cryptography.CryptographicAttributeObjectEnumerator.System#Collections#IEnumerator#Current">
<summary>Gets the current <see cref="T:System.Security.Cryptography.CryptographicAttributeObject" /> object from the <see cref="T:System.Security.Cryptography.CryptographicAttributeObjectCollection" /> collection.</summary>
<returns>A <see cref="T:System.Security.Cryptography.CryptographicAttributeObject" /> object that represents the current cryptographic attribute in the <see cref="T:System.Security.Cryptography.CryptographicAttributeObjectCollection" /> collection.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.AlgorithmIdentifier">
<summary>The <see cref="T:System.Security.Cryptography.Pkcs.AlgorithmIdentifier" /> class defines the algorithm used for a cryptographic operation.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.AlgorithmIdentifier.#ctor">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.AlgorithmIdentifier.#ctor" /> constructor creates an instance of the <see cref="T:System.Security.Cryptography.Pkcs.AlgorithmIdentifier" /> class by using a set of default parameters.</summary>
<exception cref="T:System.Security.Cryptography.CryptographicException">A cryptographic operation could not be completed.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.AlgorithmIdentifier.#ctor(System.Security.Cryptography.Oid)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.AlgorithmIdentifier.#ctor(System.Security.Cryptography.Oid)" /> constructor creates an instance of the <see cref="T:System.Security.Cryptography.Pkcs.AlgorithmIdentifier" /> class with the specified algorithm identifier.</summary>
<param name="oid">An object identifier for the algorithm.</param>
<exception cref="T:System.Security.Cryptography.CryptographicException">A cryptographic operation could not be completed.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.AlgorithmIdentifier.#ctor(System.Security.Cryptography.Oid,System.Int32)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.AlgorithmIdentifier.#ctor(System.Security.Cryptography.Oid,System.Int32)" /> constructor creates an instance of the <see cref="T:System.Security.Cryptography.Pkcs.AlgorithmIdentifier" /> class with the specified algorithm identifier and key length.</summary>
<param name="oid">An object identifier for the algorithm.</param>
<param name="keyLength">The length, in bits, of the key.</param>
<exception cref="T:System.Security.Cryptography.CryptographicException">A cryptographic operation could not be completed.</exception>
</member>
<member name="P:System.Security.Cryptography.Pkcs.AlgorithmIdentifier.KeyLength">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.AlgorithmIdentifier.KeyLength" /> property sets or retrieves the key length, in bits. This property is not used for algorithms that use a fixed key length.</summary>
<returns>An int value that represents the key length, in bits.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.AlgorithmIdentifier.Oid">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.AlgorithmIdentifier.Oid" /> property sets or retrieves the <see cref="T:System.Security.Cryptography.Oid" /> object that specifies the object identifier for the algorithm.</summary>
<returns>An <see cref="T:System.Security.Cryptography.Oid" /> object that represents the algorithm.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.AlgorithmIdentifier.Parameters">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.AlgorithmIdentifier.Parameters" /> property sets or retrieves any parameters required by the algorithm.</summary>
<returns>An array of byte values that specifies any parameters required by the algorithm.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.CmsRecipient">
<summary>The <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" /> class defines the recipient of a CMS/PKCS #7 message.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.CmsRecipient.#ctor(System.Security.Cryptography.Pkcs.SubjectIdentifierType,System.Security.Cryptography.X509Certificates.X509Certificate2)">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" /> class with a specified certificate and recipient identifier type, using the default encryption mode for the public key algorithm.</summary>
<param name="recipientIdentifierType">The scheme to use for identifying which recipient certificate was used.</param>
<param name="certificate">The certificate to use when encrypting for this recipient.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="certificate" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The <paramref name="recipientIdentifierType" /> value is not supported.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.CmsRecipient.#ctor(System.Security.Cryptography.Pkcs.SubjectIdentifierType,System.Security.Cryptography.X509Certificates.X509Certificate2,System.Security.Cryptography.RSAEncryptionPadding)">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" /> class with a specified RSA certificate, RSA encryption padding, and subject identifier.</summary>
<param name="recipientIdentifierType">The scheme to use for identifying which recipient certificate was used.</param>
<param name="certificate">The certificate to use when encrypting for this recipient.</param>
<param name="rsaEncryptionPadding">The RSA padding mode to use when encrypting for this recipient.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="certificate" /> or <paramref name="rsaEncryptionPadding" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The <paramref name="certificate" /> parameter public key is not recognized as an RSA public key.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.CmsRecipient.#ctor(System.Security.Cryptography.X509Certificates.X509Certificate2)">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" /> class with a specified certificate, using the default encryption mode for the public key algorithm and an <see cref="F:System.Security.Cryptography.Pkcs.SubjectIdentifierType.IssuerAndSerialNumber" /> subject identifier.</summary>
<param name="certificate">The certificate to use when encrypting for this recipient.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="certificate" /> parameter is <see langword="null" />.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.CmsRecipient.#ctor(System.Security.Cryptography.X509Certificates.X509Certificate2,System.Security.Cryptography.RSAEncryptionPadding)">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" /> class with a specified RSA certificate and RSA encryption padding, using an <see cref="F:System.Security.Cryptography.Pkcs.SubjectIdentifierType.IssuerAndSerialNumber" /> subject identifier.</summary>
<param name="certificate">The certificate to use when encrypting for this recipient.</param>
<param name="rsaEncryptionPadding">The RSA padding mode to use when encrypting for this recipient.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="certificate" /> or <paramref name="rsaEncryptionPadding" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The <paramref name="certificate" /> parameter public key is not recognized as an RSA public key.
-or-
The <paramref name="recipientIdentifierType" /> value is not supported.</exception>
</member>
<member name="P:System.Security.Cryptography.Pkcs.CmsRecipient.Certificate">
<summary>Gets the certificate to use when encrypting for this recipient.</summary>
<returns>The certificate to use when encrypting for this recipient.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.CmsRecipient.RecipientIdentifierType">
<summary>Gets the scheme to use for identifying which recipient certificate was used.</summary>
<returns>The scheme to use for identifying which recipient certificate was used.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.CmsRecipient.RSAEncryptionPadding">
<summary>Gets the RSA encryption padding to use when encrypting for this recipient.</summary>
<returns>The RSA encryption padding to use when encrypting for this recipient.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection">
<summary>The <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> class represents a set of <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" /> objects. <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> implements the <see cref="T:System.Collections.ICollection" /> interface.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.CmsRecipientCollection.#ctor">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.CmsRecipientCollection.#ctor" /> constructor creates an instance of the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> class.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.CmsRecipientCollection.#ctor(System.Security.Cryptography.Pkcs.CmsRecipient)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.CmsRecipientCollection.#ctor(System.Security.Cryptography.Pkcs.CmsRecipient)" /> constructor creates an instance of the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> class and adds the specified recipient.</summary>
<param name="recipient">An instance of the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" /> class that represents the specified CMS/PKCS #7 recipient.</param>
</member>
<member name="M:System.Security.Cryptography.Pkcs.CmsRecipientCollection.#ctor(System.Security.Cryptography.Pkcs.SubjectIdentifierType,System.Security.Cryptography.X509Certificates.X509Certificate2Collection)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.CmsRecipientCollection.#ctor(System.Security.Cryptography.Pkcs.SubjectIdentifierType,System.Security.Cryptography.X509Certificates.X509Certificate2Collection)" /> constructor creates an instance of the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> class and adds recipients based on the specified subject identifier and set of certificates that identify the recipients.</summary>
<param name="recipientIdentifierType">A member of the <see cref="T:System.Security.Cryptography.Pkcs.SubjectIdentifierType" /> enumeration that specifies the type of subject identifier.</param>
<param name="certificates">An <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2Collection" /> collection that contains the certificates that identify the recipients.</param>
</member>
<member name="M:System.Security.Cryptography.Pkcs.CmsRecipientCollection.Add(System.Security.Cryptography.Pkcs.CmsRecipient)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.CmsRecipientCollection.Add(System.Security.Cryptography.Pkcs.CmsRecipient)" /> method adds a recipient to the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> collection.</summary>
<param name="recipient">A <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" /> object that represents the recipient to add to the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> collection.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="recipient" /> is <see langword="null" />.</exception>
<returns>If the method succeeds, the method returns an <see cref="T:System.Int32" /> value that represents the zero-based position where the recipient is to be inserted.
If the method fails, it throws an exception.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.CmsRecipientCollection.CopyTo(System.Array,System.Int32)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.CmsRecipientCollection.CopyTo(System.Array,System.Int32)" /> method copies the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> collection to an array.</summary>
<param name="array">An <see cref="T:System.Array" /> object to which the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> collection is to be copied.</param>
<param name="index">The zero-based index in <paramref name="array" /> where the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> collection is copied.</param>
<exception cref="T:System.ArgumentException">
<paramref name="array" /> is not large enough to hold the specified elements.
-or-
<paramref name="array" /> does not contain the proper number of dimensions.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="array" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="index" /> is outside the range of elements in <paramref name="array" />.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.CmsRecipientCollection.CopyTo(System.Security.Cryptography.Pkcs.CmsRecipient[],System.Int32)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.CmsRecipientCollection.CopyTo(System.Security.Cryptography.Pkcs.CmsRecipient[],System.Int32)" /> method copies the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> collection to a <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" /> array.</summary>
<param name="array">An array of <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" /> objects where the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> collection is to be copied.</param>
<param name="index">The zero-based index for the array of <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" /> objects in <paramref name="array" /> to which the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> collection is copied.</param>
<exception cref="T:System.ArgumentException">
<paramref name="array" /> is not large enough to hold the specified elements.
-or-
<paramref name="array" /> does not contain the proper number of dimensions.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="array" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="index" /> is outside the range of elements in <paramref name="array" />.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.CmsRecipientCollection.GetEnumerator">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.CmsRecipientCollection.GetEnumerator" /> method returns a <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientEnumerator" /> object for the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> collection.</summary>
<returns>A <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientEnumerator" /> object that can be used to enumerate the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> collection.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.CmsRecipientCollection.Remove(System.Security.Cryptography.Pkcs.CmsRecipient)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.CmsRecipientCollection.Remove(System.Security.Cryptography.Pkcs.CmsRecipient)" /> method removes a recipient from the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> collection.</summary>
<param name="recipient">A <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" /> object that represents the recipient to remove from the collection.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="recipient" /> is <see langword="null" />.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.CmsRecipientCollection.System#Collections#IEnumerable#GetEnumerator">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.CmsRecipientCollection.System#Collections#IEnumerable#GetEnumerator" /> method returns a <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientEnumerator" /> object for the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> collection.</summary>
<returns>A <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientEnumerator" /> object that can be used to enumerate the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> collection.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.CmsRecipientCollection.Count">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.CmsRecipientCollection.Count" /> property retrieves the number of items in the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> collection.</summary>
<returns>An <see cref="T:System.Int32" /> value that represents the number of items in the collection.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.CmsRecipientCollection.IsSynchronized">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.CmsRecipientCollection.IsSynchronized" /> property retrieves whether access to the collection is synchronized, or thread safe. This property always returns <see langword="false" />, which means that the collection is not thread safe.</summary>
<returns>A <see cref="T:System.Boolean" /> value of <see langword="false" />, which means that the collection is not thread safe.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.CmsRecipientCollection.Item(System.Int32)">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.CmsRecipientCollection.Item(System.Int32)" /> property retrieves the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" /> object at the specified index in the collection.</summary>
<param name="index">An <see cref="T:System.Int32" /> value that represents the index in the collection. The index is zero based.</param>
<exception cref="T:System.ArgumentOutOfRangeException">The value of an argument was outside the allowable range of values as defined by the called method.</exception>
<returns>A <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" /> object at the specified index.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.CmsRecipientCollection.SyncRoot">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.CmsRecipientCollection.SyncRoot" /> property retrieves an <see cref="T:System.Object" /> object used to synchronize access to the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> collection.</summary>
<returns>An <see cref="T:System.Object" /> object that is used to synchronize access to the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> collection.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.CmsRecipientEnumerator">
<summary>The <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientEnumerator" /> class provides enumeration functionality for the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> collection. <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientEnumerator" /> implements the <see cref="T:System.Collections.IEnumerator" /> interface.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.CmsRecipientEnumerator.MoveNext">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.CmsRecipientEnumerator.MoveNext" /> method advances the enumeration to the next <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" /> object in the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> collection.</summary>
<returns>
<see langword="true" /> if the enumeration successfully moved to the next <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" /> object; <see langword="false" /> if the enumeration moved past the last item in the enumeration.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.CmsRecipientEnumerator.Reset">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.CmsRecipientEnumerator.Reset" /> method resets the enumeration to the first <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" /> object in the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> collection.</summary>
</member>
<member name="P:System.Security.Cryptography.Pkcs.CmsRecipientEnumerator.Current">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.CmsRecipientEnumerator.Current" /> property retrieves the current <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" /> object from the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> collection.</summary>
<returns>A <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" /> object that represents the current recipient in the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> collection.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.CmsRecipientEnumerator.System#Collections#IEnumerator#Current">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.CmsRecipientEnumerator.System#Collections#IEnumerator#Current" /> property retrieves the current <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" /> object from the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> collection.</summary>
<returns>A <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" /> object that represents the current recipient in the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> collection.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.CmsSigner">
<summary>Represents a potential signer for a CMS/PKCS#7 signed message.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.CmsSigner.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.CmsSigner" /> class with default values.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.CmsSigner.#ctor(System.Security.Cryptography.CspParameters)">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.CmsSigner" /> class from a persisted key.</summary>
<param name="parameters">The CSP parameters to describe which signing key to use.</param>
<exception cref="T:System.PlatformNotSupportedException">.NET Core only: This member is not supported.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.CmsSigner.#ctor(System.Security.Cryptography.Pkcs.SubjectIdentifierType)">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.CmsSigner" /> class with a specified subject identifier type.</summary>
<param name="signerIdentifierType">The scheme to use for identifying which signing certificate was used.</param>
</member>
<member name="M:System.Security.Cryptography.Pkcs.CmsSigner.#ctor(System.Security.Cryptography.Pkcs.SubjectIdentifierType,System.Security.Cryptography.X509Certificates.X509Certificate2)">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.CmsSigner" /> class with a specified signer certificate and subject identifier type.</summary>
<param name="signerIdentifierType">The scheme to use for identifying which signing certificate was used.</param>
<param name="certificate">The certificate whose private key will be used to sign a message.</param>
</member>
<member name="M:System.Security.Cryptography.Pkcs.CmsSigner.#ctor(System.Security.Cryptography.Pkcs.SubjectIdentifierType,System.Security.Cryptography.X509Certificates.X509Certificate2,System.Security.Cryptography.AsymmetricAlgorithm)">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.CmsSigner" /> class with a specified signer certificate, subject identifier type, and private key object.</summary>
<param name="signerIdentifierType">One of the enumeration values that specifies the scheme to use for identifying which signing certificate was used.</param>
<param name="certificate">The certificate whose private key will be used to sign a message.</param>
<param name="privateKey">The private key object to use when signing the message.</param>
</member>
<member name="M:System.Security.Cryptography.Pkcs.CmsSigner.#ctor(System.Security.Cryptography.X509Certificates.X509Certificate2)">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.CmsSigner" /> class with a specified signer certificate.</summary>
<param name="certificate">The certificate whose private key will be used to sign a message.</param>
</member>
<member name="P:System.Security.Cryptography.Pkcs.CmsSigner.Certificate">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.CmsSigner.Certificate" /> property sets or retrieves the <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2" /> object that represents the signing certificate.</summary>
<returns>An <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2" /> object that represents the signing certificate.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.CmsSigner.Certificates">
<summary>Gets a collection of certificates which are considered with <see cref="F:System.Security.Cryptography.X509Certificates.X509IncludeOption.WholeChain" /> and <see cref="F:System.Security.Cryptography.X509Certificates.X509IncludeOption.ExcludeRoot" />.</summary>
<returns>A collection of certificates which are considered with <see cref="F:System.Security.Cryptography.X509Certificates.X509IncludeOption.WholeChain" /> and <see cref="F:System.Security.Cryptography.X509Certificates.X509IncludeOption.ExcludeRoot" />.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.CmsSigner.DigestAlgorithm">
<summary>Gets or sets the algorithm identifier for the hash algorithm to use with the signature.</summary>
<returns>The algorithm identifier for the hash algorithm to use with the signature.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.CmsSigner.IncludeOption">
<summary>Gets or sets the option indicating how much of a the signer certificate's certificate chain should be embedded in the signed message.</summary>
<exception cref="T:System.ArgumentException">One of the arguments provided to a method was not valid.</exception>
<returns>One of the enumeration values that indicates how much of a the signer certificate's certificate chain should be embedded in the signed message.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.CmsSigner.PrivateKey">
<summary>Gets or sets the private key object to use during signing.</summary>
<returns>The private key to use during signing, or <see langword="null" /> to use the private key associated with the <see cref="P:System.Security.Cryptography.Pkcs.CmsSigner.Certificate" /> property.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.CmsSigner.SignedAttributes">
<summary>Gets a collections of attributes to associate with this signature that are also protected by the signature.</summary>
<returns>A collections of attributes to associate with this signature that are also protected by the signature.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.CmsSigner.SignerIdentifierType">
<summary>Gets the scheme to use for identifying which signing certificate was used.</summary>
<exception cref="T:System.ArgumentException">One of the arguments provided to a method was not valid.</exception>
<returns>The scheme to use for identifying which recipient certificate was used.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.CmsSigner.UnsignedAttributes">
<summary>Gets a collections of attributes to associate with this signature that are not protected by the signature.</summary>
<returns>A collections of attributes to associate with this signature that are not protected by the signature.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.ContentInfo">
<summary>The <see cref="T:System.Security.Cryptography.Pkcs.ContentInfo" /> class represents the CMS/PKCS #7 ContentInfo data structure as defined in the CMS/PKCS #7 standards document. This data structure is the basis for all CMS/PKCS #7 messages.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.ContentInfo.#ctor(System.Byte[])">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.ContentInfo.#ctor(System.Byte[])" /> constructor creates an instance of the <see cref="T:System.Security.Cryptography.Pkcs.ContentInfo" /> class by using an array of byte values as the data and a default <paramref name="object identifier" /> (OID) that represents the content type.</summary>
<param name="content">An array of byte values that represents the data from which to create the <see cref="T:System.Security.Cryptography.Pkcs.ContentInfo" /> object.</param>
<exception cref="T:System.ArgumentNullException">A null reference was passed to a method that does not accept it as a valid argument.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.ContentInfo.#ctor(System.Security.Cryptography.Oid,System.Byte[])">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.ContentInfo.#ctor(System.Security.Cryptography.Oid,System.Byte[])" /> constructor creates an instance of the <see cref="T:System.Security.Cryptography.Pkcs.ContentInfo" /> class by using the specified content type and an array of byte values as the data.</summary>
<param name="contentType">An <see cref="T:System.Security.Cryptography.Oid" /> object that contains an <c>object identifier</c> (OID) that specifies the content type of the content. This can be data, digestedData, encryptedData, envelopedData, hashedData, signedAndEnvelopedData, or signedData. For more information, see Remarks.</param>
<param name="content">An array of byte values that represents the data from which to create the <see cref="T:System.Security.Cryptography.Pkcs.ContentInfo" /> object.</param>
<exception cref="T:System.ArgumentNullException">A null reference was passed to a method that does not accept it as a valid argument.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.ContentInfo.GetContentType(System.Byte[])">
<summary>Retrieves the outer content type of an encoded CMS ContentInfo message.</summary>
<param name="encodedMessage">An array of byte values that represents the encoded CMS ContentInfo message from which to retrieve the outer content type.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="encodedMessage" /> is <see langword="null" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">
<paramref name="encodedMessage" /> cannot be decoded as a valid CMS ContentInfo value.</exception>
<returns>The outer content type of the specified encoded CMS ContentInfo message.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.ContentInfo.GetContentType(System.ReadOnlySpan{System.Byte})">
<summary>Retrieves the outer content type of an encoded CMS ContentInfo message.</summary>
<param name="encodedMessage">A read-only span of byte values that represents the encoded CMS ContentInfo message from which to retrieve the outer content type.</param>
<exception cref="T:System.Security.Cryptography.CryptographicException">
<paramref name="encodedMessage" /> cannot be decoded as a valid CMS ContentInfo value.</exception>
<returns>The outer content type of the specified encoded CMS ContentInfo message.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.ContentInfo.Content">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.ContentInfo.Content" /> property retrieves the content of the CMS/PKCS #7 message.</summary>
<returns>An array of byte values that represents the content data.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.ContentInfo.ContentType">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.ContentInfo.ContentType" /> property retrieves the <see cref="T:System.Security.Cryptography.Oid" /> object that contains the <paramref name="object identifier" /> (OID) of the content type of the inner content of the CMS/PKCS #7 message.</summary>
<returns>An <see cref="T:System.Security.Cryptography.Oid" /> object that contains the OID value that represents the content type.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.EnvelopedCms">
<summary>Represents a CMS/PKCS#7 structure for enveloped data.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.EnvelopedCms.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.EnvelopedCms" /> class with default values.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.EnvelopedCms.#ctor(System.Security.Cryptography.Pkcs.ContentInfo)">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.EnvelopedCms" /> class with specified content information.</summary>
<param name="contentInfo">The message content to encrypt.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="contentInfo" /> parameter is <see langword="null" />.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.EnvelopedCms.#ctor(System.Security.Cryptography.Pkcs.ContentInfo,System.Security.Cryptography.Pkcs.AlgorithmIdentifier)">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.EnvelopedCms" /> class with a specified symmetric encryption algorithm and content information.</summary>
<param name="contentInfo">The message content to encrypt.</param>
<param name="encryptionAlgorithm">The identifier for the symmetric encryption algorithm to use when encrypting the message content.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="contentInfo" /> or <paramref name="encryptionAlgorithm" /> parameter is <see langword="null" />.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.EnvelopedCms.Decode(System.Byte[])">
<summary>Decodes an array of bytes as a CMS/PKCS#7 EnvelopedData message.</summary>
<param name="encodedMessage">The byte array containing the sequence of bytes to decode.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="encodedMessage" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The <paramref name="encodedMessage" /> parameter was not successfully decoded.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.EnvelopedCms.Decode(System.ReadOnlySpan{System.Byte})">
<summary>Decodes the provided data as a CMS/PKCS#7 EnvelopedData message.</summary>
<param name="encodedMessage">The data to decode.</param>
<exception cref="T:System.Security.Cryptography.CryptographicException">The <paramref name="encodedMessage" /> parameter was not successfully decoded.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.EnvelopedCms.Decrypt">
<summary>Decrypts the contents of the decoded enveloped CMS/PKCS#7 message via any available recipient by searching certificate stores for a matching certificate and key.</summary>
<exception cref="T:System.Security.Cryptography.CryptographicException">A cryptographic operation could not be completed.</exception>
<exception cref="T:System.InvalidOperationException">A method call was invalid for the object's current state.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.EnvelopedCms.Decrypt(System.Security.Cryptography.Pkcs.RecipientInfo)">
<summary>Decrypts the contents of the decoded enveloped CMS/PKCS#7 message via a specified recipient info by searching certificate stores for a matching certificate and key.</summary>
<param name="recipientInfo">The recipient info to use for decryption.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="recipientInfo" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">A cryptographic operation could not be completed.</exception>
<exception cref="T:System.InvalidOperationException">A method call was invalid for the object's current state.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.EnvelopedCms.Decrypt(System.Security.Cryptography.Pkcs.RecipientInfo,System.Security.Cryptography.AsymmetricAlgorithm)">
<summary>Decrypts the contents of the decoded enveloped CMS/PKCS#7 message via a specified recipient info with a specified private key.</summary>
<param name="recipientInfo">The recipient info to use for decryption.</param>
<param name="privateKey">The private key to use to decrypt the recipient-specific information.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="recipientInfo" /> or <paramref name="privateKey" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">A cryptographic operation could not be completed.</exception>
<exception cref="T:System.InvalidOperationException">A method call was invalid for the object's current state.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.EnvelopedCms.Decrypt(System.Security.Cryptography.Pkcs.RecipientInfo,System.Security.Cryptography.X509Certificates.X509Certificate2Collection)">
<summary>Decrypts the contents of the decoded enveloped CMS/PKCS#7 message via a specified recipient info by searching certificate stores and a provided collection for a matching certificate and key.</summary>
<param name="recipientInfo">The recipient info to use for decryption.</param>
<param name="extraStore">A collection of certificates to use in addition to the certificate stores for finding a recipient certificate and private key.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="recipientInfo" /> or <paramref name="extraStore" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">A cryptographic operation could not be completed.</exception>
<exception cref="T:System.InvalidOperationException">A method call was invalid for the object's current state.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.EnvelopedCms.Decrypt(System.Security.Cryptography.X509Certificates.X509Certificate2Collection)">
<summary>Decrypts the contents of the decoded enveloped CMS/PKCS#7 message via any available recipient info by searching certificate stores and a provided collection for a matching certificate and key.</summary>
<param name="extraStore">A collection of certificates to use in addition to the certificate stores for finding a recipient certificate and private key.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="extraStore" /> parameter was <see langword="null" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">A cryptographic operation could not be completed.</exception>
<exception cref="T:System.InvalidOperationException">A method call was invalid for the object's current state.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.EnvelopedCms.Encode">
<summary>Encodes the contents of the enveloped CMS/PKCS#7 message and returns it as a byte array.</summary>
<exception cref="T:System.InvalidOperationException">A method call was invalid for the object's current state.</exception>
<returns>A byte array representing the encoded form of the CMS/PKCS#7 message.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.EnvelopedCms.Encrypt(System.Security.Cryptography.Pkcs.CmsRecipient)">
<summary>Encrypts the contents of the CMS/PKCS#7 message for a single specified recipient.</summary>
<param name="recipient">The recipient information describing the single recipient of this message.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="recipient" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">A cryptographic operation could not be completed.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.EnvelopedCms.Encrypt(System.Security.Cryptography.Pkcs.CmsRecipientCollection)">
<summary>Encrypts the contents of the CMS/PKCS#7 message for one or more recipients.</summary>
<param name="recipients">A collection describing the recipients for the message.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="recipients" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">A cryptographic operation could not be completed.</exception>
</member>
<member name="P:System.Security.Cryptography.Pkcs.EnvelopedCms.Certificates">
<summary>Gets the collection of certificates associated with the enveloped CMS/PKCS#7 message.</summary>
<returns>The collection of certificates associated with the enveloped CMS/PKCS#7 message.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.EnvelopedCms.ContentEncryptionAlgorithm">
<summary>Gets the identifier of the symmetric encryption algorithm associated with this message.</summary>
<returns>The identifier of the symmetric encryption algorithm associated with this message.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.EnvelopedCms.ContentInfo">
<summary>Gets the content information for the enveloped CMS/PKCS#7 message.</summary>
<returns>The content information for the enveloped CMS/PKCS#7 message.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.EnvelopedCms.RecipientInfos">
<summary>Gets a collection that represents the recipients list for a decoded message. The default value is an empty collection.</summary>
<returns>A collection that represents the recipients list for a decoded message. The default value is an empty collection.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.EnvelopedCms.UnprotectedAttributes">
<summary>Gets the collection of unprotected (unencrypted) attributes associated with the enveloped CMS/PKCS#7 message.</summary>
<returns>The collection of unprotected (unencrypted) attributes associated with the enveloped CMS/PKCS#7 message.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.EnvelopedCms.Version">
<summary>Gets the version of the decoded enveloped CMS/PKCS#7 message.</summary>
<returns>The version of the decoded enveloped CMS/PKCS#7 message.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.KeyAgreeRecipientInfo">
<summary>The <see cref="T:System.Security.Cryptography.Pkcs.KeyAgreeRecipientInfo" /> class defines key agreement recipient information. Key agreement algorithms typically use the Diffie-Hellman key agreement algorithm, in which the two parties that establish a shared cryptographic key both take part in its generation and, by definition, agree on that key. This is in contrast to key transport algorithms, in which one party generates the key unilaterally and sends, or transports it, to the other party.</summary>
</member>
<member name="P:System.Security.Cryptography.Pkcs.KeyAgreeRecipientInfo.Date">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.KeyAgreeRecipientInfo.Date" /> property retrieves the date and time of the start of the key agreement protocol by the originator.</summary>
<exception cref="T:System.InvalidOperationException">The recipient identifier type is not a subject key identifier.</exception>
<returns>The date and time of the start of the key agreement protocol by the originator.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.KeyAgreeRecipientInfo.EncryptedKey">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.KeyAgreeRecipientInfo.EncryptedKey" /> property retrieves the encrypted recipient keying material.</summary>
<returns>An array of byte values that contain the encrypted recipient keying material.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.KeyAgreeRecipientInfo.KeyEncryptionAlgorithm">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.KeyAgreeRecipientInfo.KeyEncryptionAlgorithm" /> property retrieves the algorithm used to perform the key agreement.</summary>
<returns>The value of the algorithm used to perform the key agreement.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.KeyAgreeRecipientInfo.OriginatorIdentifierOrKey">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.KeyAgreeRecipientInfo.OriginatorIdentifierOrKey" /> property retrieves information about the originator of the key agreement for key agreement algorithms that warrant it.</summary>
<returns>An object that contains information about the originator of the key agreement.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.KeyAgreeRecipientInfo.OtherKeyAttribute">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.KeyAgreeRecipientInfo.OtherKeyAttribute" /> property retrieves attributes of the keying material.</summary>
<exception cref="T:System.InvalidOperationException">The recipient identifier type is not a subject key identifier.</exception>
<returns>The attributes of the keying material.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.KeyAgreeRecipientInfo.RecipientIdentifier">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.KeyAgreeRecipientInfo.RecipientIdentifier" /> property retrieves the identifier of the recipient.</summary>
<returns>The identifier of the recipient.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.KeyAgreeRecipientInfo.Version">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.KeyAgreeRecipientInfo.Version" /> property retrieves the version of the key agreement recipient. This is automatically set for objects in this class, and the value implies that the recipient is taking part in a key agreement algorithm.</summary>
<returns>The version of the <see cref="T:System.Security.Cryptography.Pkcs.KeyAgreeRecipientInfo" /> object.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.KeyTransRecipientInfo">
<summary>The <see cref="T:System.Security.Cryptography.Pkcs.KeyTransRecipientInfo" /> class defines key transport recipient information. Key transport algorithms typically use the RSA algorithm, in which an originator establishes a shared cryptographic key with a recipient by generating that key and then transporting it to the recipient. This is in contrast to key agreement algorithms, in which the two parties that will be using a cryptographic key both take part in its generation, thereby mutually agreeing to that key.</summary>
</member>
<member name="P:System.Security.Cryptography.Pkcs.KeyTransRecipientInfo.EncryptedKey">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.KeyTransRecipientInfo.EncryptedKey" /> property retrieves the encrypted key for this key transport recipient.</summary>
<returns>An array of byte values that represents the encrypted key.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.KeyTransRecipientInfo.KeyEncryptionAlgorithm">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.KeyTransRecipientInfo.KeyEncryptionAlgorithm" /> property retrieves the key encryption algorithm used to encrypt the content encryption key.</summary>
<returns>An <see cref="T:System.Security.Cryptography.Pkcs.AlgorithmIdentifier" /> object that stores the key encryption algorithm identifier.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.KeyTransRecipientInfo.RecipientIdentifier">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.KeyTransRecipientInfo.RecipientIdentifier" /> property retrieves the subject identifier associated with the encrypted content.</summary>
<returns>A <see cref="T:System.Security.Cryptography.Pkcs.SubjectIdentifier" /> object that stores the identifier of the recipient taking part in the key transport.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.KeyTransRecipientInfo.Version">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.KeyTransRecipientInfo.Version" /> property retrieves the version of the key transport recipient. The version of the key transport recipient is automatically set for objects in this class, and the value implies that the recipient is taking part in a key transport algorithm.</summary>
<returns>An int value that represents the version of the key transport <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfo" /> object.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.Pkcs12Builder">
<summary>Enables the creation of PKCS#12 PFX data values. This class cannot be inherited.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12Builder.#ctor">
<summary>Initializes a new value of the <see cref="T:System.Security.Cryptography.Pkcs.Pkcs12Builder" /> class.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12Builder.AddSafeContentsEncrypted(System.Security.Cryptography.Pkcs.Pkcs12SafeContents,System.Byte[],System.Security.Cryptography.PbeParameters)">
<summary>Add contents to the PFX in an bundle encrypted with a byte-based password from a byte array.</summary>
<param name="safeContents">The contents to add to the PFX.</param>
<param name="passwordBytes">The byte array to use as a password when encrypting the contents.</param>
<param name="pbeParameters">The password-based encryption (PBE) parameters to use when encrypting the contents.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="safeContents" /> or <paramref name="pbeParameters" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">The <paramref name="safeContents" /> parameter value is already encrypted.</exception>
<exception cref="T:System.InvalidOperationException">The PFX is already sealed (<see cref="P:System.Security.Cryptography.Pkcs.Pkcs12Builder.IsSealed" /> is <see langword="true" />).</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">
<paramref name="pbeParameters" /> indicates that <see cref="F:System.Security.Cryptography.PbeEncryptionAlgorithm.TripleDes3KeyPkcs12" /> should be used, which requires <see cref="T:System.Char" />-based passwords.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12Builder.AddSafeContentsEncrypted(System.Security.Cryptography.Pkcs.Pkcs12SafeContents,System.ReadOnlySpan{System.Byte},System.Security.Cryptography.PbeParameters)">
<summary>Add contents to the PFX in an bundle encrypted with a byte-based password from a span.</summary>
<param name="safeContents">The contents to add to the PFX.</param>
<param name="passwordBytes">The byte span to use as a password when encrypting the contents.</param>
<param name="pbeParameters">The password-based encryption (PBE) parameters to use when encrypting the contents.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="safeContents" /> or <paramref name="pbeParameters" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">The <paramref name="safeContents" /> parameter value is already encrypted.</exception>
<exception cref="T:System.InvalidOperationException">The PFX is already sealed (<see cref="P:System.Security.Cryptography.Pkcs.Pkcs12Builder.IsSealed" /> is <see langword="true" />).</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">
<paramref name="pbeParameters" /> indicates that <see cref="F:System.Security.Cryptography.PbeEncryptionAlgorithm.TripleDes3KeyPkcs12" /> should be used, which requires <see cref="T:System.Char" />-based passwords.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12Builder.AddSafeContentsEncrypted(System.Security.Cryptography.Pkcs.Pkcs12SafeContents,System.ReadOnlySpan{System.Char},System.Security.Cryptography.PbeParameters)">
<summary>Add contents to the PFX in an bundle encrypted with a char-based password from a span.</summary>
<param name="safeContents">The contents to add to the PFX.</param>
<param name="password">The span to use as a password when encrypting the contents.</param>
<param name="pbeParameters">The password-based encryption (PBE) parameters to use when encrypting the contents.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="safeContents" /> or <paramref name="pbeParameters" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">The <paramref name="safeContents" /> parameter value is already encrypted.</exception>
<exception cref="T:System.InvalidOperationException">The PFX is already sealed (<see cref="P:System.Security.Cryptography.Pkcs.Pkcs12Builder.IsSealed" /> is <see langword="true" />).</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12Builder.AddSafeContentsEncrypted(System.Security.Cryptography.Pkcs.Pkcs12SafeContents,System.String,System.Security.Cryptography.PbeParameters)">
<summary>Add contents to the PFX in an bundle encrypted with a char-based password from a string.</summary>
<param name="safeContents">The contents to add to the PFX.</param>
<param name="password">The string to use as a password when encrypting the contents.</param>
<param name="pbeParameters">The password-based encryption (PBE) parameters to use when encrypting the contents.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="safeContents" /> or <paramref name="pbeParameters" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">The <paramref name="safeContents" /> parameter value is already encrypted.</exception>
<exception cref="T:System.InvalidOperationException">The PFX is already sealed (<see cref="P:System.Security.Cryptography.Pkcs.Pkcs12Builder.IsSealed" /> is <see langword="true" />).</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12Builder.AddSafeContentsUnencrypted(System.Security.Cryptography.Pkcs.Pkcs12SafeContents)">
<summary>Add contents to the PFX without encrypting them.</summary>
<param name="safeContents">The contents to add to the PFX.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="safeContents" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The PFX is already sealed (<see cref="P:System.Security.Cryptography.Pkcs.Pkcs12Builder.IsSealed" /> is <see langword="true" />).</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12Builder.Encode">
<summary>Encodes the contents of a sealed PFX and returns it as a byte array.</summary>
<exception cref="T:System.InvalidOperationException">The PFX is not sealed (<see cref="P:System.Security.Cryptography.Pkcs.Pkcs12Builder.IsSealed" /> is <see langword="false" />).</exception>
<returns>A byte array representing the encoded form of the PFX.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12Builder.SealWithMac(System.ReadOnlySpan{System.Char},System.Security.Cryptography.HashAlgorithmName,System.Int32)">
<summary>Seals the PFX against further changes by applying a password-based Message Authentication Code (MAC) over the contents with a password from a span.</summary>
<param name="password">The password to use as a key for computing the MAC.</param>
<param name="hashAlgorithm">The hash algorithm to use when computing the MAC.</param>
<param name="iterationCount">The iteration count for the Key Derivation Function (KDF) used in computing the MAC.</param>
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="iterationCount" /> parameter is less than or equal to 0.</exception>
<exception cref="T:System.InvalidOperationException">The PFX is already sealed (<see cref="P:System.Security.Cryptography.Pkcs.Pkcs12Builder.IsSealed" /> is <see langword="true" />).</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12Builder.SealWithMac(System.String,System.Security.Cryptography.HashAlgorithmName,System.Int32)">
<summary>Seals the PFX against further changes by applying a password-based Message Authentication Code (MAC) over the contents with a password from a string.</summary>
<param name="password">The password to use as a key for computing the MAC.</param>
<param name="hashAlgorithm">The hash algorithm to use when computing the MAC.</param>
<param name="iterationCount">The iteration count for the Key Derivation Function (KDF) used in computing the MAC.</param>
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="iterationCount" /> parameter is less than or equal to 0.</exception>
<exception cref="T:System.InvalidOperationException">The PFX is already sealed (<see cref="P:System.Security.Cryptography.Pkcs.Pkcs12Builder.IsSealed" /> is <see langword="true" />).</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12Builder.SealWithoutIntegrity">
<summary>Seals the PFX from further changes without applying tamper-protection.</summary>
<exception cref="T:System.InvalidOperationException">The PFX is already sealed (<see cref="P:System.Security.Cryptography.Pkcs.Pkcs12Builder.IsSealed" /> is <see langword="true" />).</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12Builder.TryEncode(System.Span{System.Byte},System.Int32@)">
<summary>Attempts to encode the contents of a sealed PFX into a provided buffer.</summary>
<param name="destination">The byte span to receive the PKCS#12 PFX data.</param>
<param name="bytesWritten">When this method returns, contains a value that indicates the number of bytes written to <paramref name="destination" />. This parameter is treated as uninitialized.</param>
<exception cref="T:System.InvalidOperationException">The PFX is not sealed (<see cref="P:System.Security.Cryptography.Pkcs.Pkcs12Builder.IsSealed" /> is <see langword="false" />).</exception>
<returns>
<see langword="true" /> if <paramref name="destination" /> is big enough to receive the output; otherwise, <see langword="false" />.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Pkcs12Builder.IsSealed">
<summary>Gets a value that indicates whether the PFX data has been sealed.</summary>
<returns>A value that indicates whether the PFX data has been sealed.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.Pkcs12CertBag">
<summary>Represents the PKCS#12 CertBag. This class cannot be inherited.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12CertBag.#ctor(System.Security.Cryptography.Oid,System.ReadOnlyMemory{System.Byte})">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.Pkcs12CertBag" /> class using the specified certificate type and encoding.</summary>
<param name="certificateType">The Object Identifier (OID) for the certificate type.</param>
<param name="encodedCertificate">The encoded certificate value.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="certificateType" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The <paramref name="encodedCertificate" /> parameter does not represent a single ASN.1 BER-encoded value.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12CertBag.GetCertificate">
<summary>Gets the contents of the CertBag interpreted as an X.509 public key certificate.</summary>
<exception cref="T:System.InvalidOperationException">The content type is not the X.509 public key certificate content type.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The contents were not valid for the X.509 certificate content type.</exception>
<returns>A certificate decoded from the contents of the CertBag.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12CertBag.GetCertificateType">
<summary>Gets the Object Identifier (OID) which identifies the content type of the encoded certificte value.</summary>
<returns>The Object Identifier (OID) which identifies the content type of the encoded certificate value.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Pkcs12CertBag.EncodedCertificate">
<summary>Gets the uninterpreted certificate contents of the CertSafeBag.</summary>
<returns>The uninterpreted certificate contents of the CertSafeBag.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Pkcs12CertBag.IsX509Certificate">
<summary>Gets a value indicating whether the content type of the encoded certificate value is the X.509 public key certificate content type.</summary>
<returns>
<see langword="true" /> if the content type is the X.509 public key certificate content type (1.2.840.113549.1.9.22.1); otherwise, <see langword="false" />.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.Pkcs12ConfidentialityMode">
<summary>Represents the kind of encryption associated with a PKCS#12 SafeContents value.</summary>
</member>
<member name="F:System.Security.Cryptography.Pkcs.Pkcs12ConfidentialityMode.None">
<summary>The SafeContents value is not encrypted.</summary>
</member>
<member name="F:System.Security.Cryptography.Pkcs.Pkcs12ConfidentialityMode.Password">
<summary>The SafeContents value is encrypted with a password.</summary>
</member>
<member name="F:System.Security.Cryptography.Pkcs.Pkcs12ConfidentialityMode.PublicKey">
<summary>The SafeContents value is encrypted using public key cryptography.</summary>
</member>
<member name="F:System.Security.Cryptography.Pkcs.Pkcs12ConfidentialityMode.Unknown">
<summary>The kind of encryption applied to the SafeContents is unknown or could not be determined.</summary>
</member>
<member name="T:System.Security.Cryptography.Pkcs.Pkcs12Info">
<summary>Represents the data from PKCS#12 PFX contents. This class cannot be inherited.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12Info.Decode(System.ReadOnlyMemory{System.Byte},System.Int32@,System.Boolean)">
<summary>Reads the provided data as a PKCS#12 PFX and returns an object view of the contents.</summary>
<param name="encodedBytes">The data to interpret as a PKCS#12 PFX.</param>
<param name="bytesConsumed">When this method returns, contains a value that indicates the number of bytes from <paramref name="encodedBytes" /> which were read by this method. This parameter is treated as uninitialized.</param>
<param name="skipCopy">
<see langword="true" /> to store <paramref name="encodedBytes" /> without making a defensive copy; otherwise, <see langword="false" />. The default is <see langword="false" />.</param>
<exception cref="T:System.Security.Cryptography.CryptographicException">The contents of the <paramref name="encodedBytes" /> parameter were not successfully decoded as a PKCS#12 PFX.</exception>
<returns>An object view of the PKCS#12 PFX decoded from the input.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12Info.VerifyMac(System.ReadOnlySpan{System.Char})">
<summary>Attempts to verify the integrity of the <see cref="P:System.Security.Cryptography.Pkcs.Pkcs12Info.AuthenticatedSafe" /> contents with a password represented by a <c>System.ReadOnlySpan{System.Char}</c>.</summary>
<param name="password">The password to use to attempt to verify integrity.</param>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.Security.Cryptography.Pkcs.Pkcs12Info.IntegrityMode" /> value is not <see cref="F:System.Security.Cryptography.Pkcs.Pkcs12IntegrityMode.Password" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The hash algorithm option specified by the PKCS#12 PFX contents could not be identified or is not supported by this platform.</exception>
<returns>
<see langword="true" /> if the password successfully verifies the integrity of the <see cref="P:System.Security.Cryptography.Pkcs.Pkcs12Info.AuthenticatedSafe" /> contents; <see langword="false" /> if the password is not correct or the contents have been altered.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12Info.VerifyMac(System.String)">
<summary>Attempts to verify the integrity of the <see cref="P:System.Security.Cryptography.Pkcs.Pkcs12Info.AuthenticatedSafe" /> contents with a password represented by a <see cref="T:System.String" />.</summary>
<param name="password">The password to use to attempt to verify integrity.</param>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.Security.Cryptography.Pkcs.Pkcs12Info.IntegrityMode" /> value is not <see cref="F:System.Security.Cryptography.Pkcs.Pkcs12IntegrityMode.Password" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The hash algorithm option specified by the PKCS#12 PFX contents could not be identified or is not supported by this platform.</exception>
<returns>
<see langword="true" /> if the password successfully verifies the integrity of the <see cref="P:System.Security.Cryptography.Pkcs.Pkcs12Info.AuthenticatedSafe" /> contents; <see langword="false" /> if the password is not correct or the contents have been altered.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Pkcs12Info.AuthenticatedSafe">
<summary>Gets a read-only collection of the SafeContents values present in the PFX AuthenticatedSafe.</summary>
<returns>A read-only collection of the SafeContents values present in the PFX AuthenticatedSafe.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Pkcs12Info.IntegrityMode">
<summary>Gets a value that indicates the type of tamper protection provided for the <see cref="P:System.Security.Cryptography.Pkcs.Pkcs12Info.AuthenticatedSafe" /> contents.</summary>
<returns>One of the enumeration members that indicates the type of tamper protection provided for the <see cref="P:System.Security.Cryptography.Pkcs.Pkcs12Info.AuthenticatedSafe" /> contents.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.Pkcs12IntegrityMode">
<summary>Represents the type of anti-tampering applied to a PKCS#12 PFX value.</summary>
</member>
<member name="F:System.Security.Cryptography.Pkcs.Pkcs12IntegrityMode.None">
<summary>The PKCS#12 PFX value is not protected from tampering.</summary>
</member>
<member name="F:System.Security.Cryptography.Pkcs.Pkcs12IntegrityMode.Password">
<summary>The PKCS#12 PFX value is protected from tampering with a Message Authentication Code (MAC) keyed with a password.</summary>
</member>
<member name="F:System.Security.Cryptography.Pkcs.Pkcs12IntegrityMode.PublicKey">
<summary>The PKCS#12 PFX value is protected from tampering with a digital signature using public key cryptography.</summary>
</member>
<member name="F:System.Security.Cryptography.Pkcs.Pkcs12IntegrityMode.Unknown">
<summary>The type of anti-tampering applied to the PKCS#12 PFX is unknown or could not be determined.</summary>
</member>
<member name="T:System.Security.Cryptography.Pkcs.Pkcs12KeyBag">
<summary>Represents the KeyBag from PKCS#12, a container whose contents are a PKCS#8 PrivateKeyInfo. This class cannot be inherited.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12KeyBag.#ctor(System.ReadOnlyMemory{System.Byte},System.Boolean)">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.Pkcs12KeyBag" /> from an existing encoded PKCS#8 PrivateKeyInfo value.</summary>
<param name="pkcs8PrivateKey">A BER-encoded PKCS#8 PrivateKeyInfo value.</param>
<param name="skipCopy">
<see langword="true" /> to store <paramref name="pkcs8PrivateKey" /> without making a defensive copy; otherwise, <see langword="false" />. The default is <see langword="false" />.</param>
<exception cref="T:System.Security.Cryptography.CryptographicException">The <paramref name="pkcs8privateKey" /> parameter does not represent a single ASN.1 BER-encoded value.</exception>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Pkcs12KeyBag.Pkcs8PrivateKey">
<summary>Gets a memory value containing the PKCS#8 PrivateKeyInfo value transported by this bag.</summary>
<returns>A memory value containing the PKCS#8 PrivateKeyInfo value transported by this bag.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.Pkcs12SafeBag">
<summary>Defines the core behavior of a SafeBag value from the PKCS#12 specification and provides a base for derived classes.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12SafeBag.#ctor(System.String,System.ReadOnlyMemory{System.Byte},System.Boolean)">
<summary>Called from constructors in derived classes to initialize the <see cref="T:System.Security.Cryptography.Pkcs.Pkcs12SafeBag" /> class.</summary>
<param name="bagIdValue">The Object Identifier (OID), in dotted decimal form, indicating the data type of this SafeBag.</param>
<param name="encodedBagValue">The ASN.1 BER encoded value of the SafeBag contents.</param>
<param name="skipCopy">
<see langword="true" /> to store <paramref name="encodedBagValue" /> without making a defensive copy; otherwise, <see langword="false" />. The default is <see langword="false" />.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="bagIdValue" /> parameter is <see langword="null" /> or the empty string.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The <paramref name="encodedBagValue" /> parameter does not represent a single ASN.1 BER-encoded value.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12SafeBag.Encode">
<summary>Encodes the SafeBag value and returns it as a byte array.</summary>
<exception cref="T:System.Security.Cryptography.CryptographicException">The object identifier value passed to the constructor was invalid.</exception>
<returns>A byte array representing the encoded form of the SafeBag.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12SafeBag.GetBagId">
<summary>Gets the Object Identifier (OID) identifying the content type of this SafeBag.</summary>
<returns>The Object Identifier (OID) identifying the content type of this SafeBag.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12SafeBag.TryEncode(System.Span{System.Byte},System.Int32@)">
<summary>Attempts to encode the SafeBag value into a provided buffer.</summary>
<param name="destination">The byte span to receive the encoded SafeBag value.</param>
<param name="bytesWritten">When this method returns, contains a value that indicates the number of bytes written to <paramref name="destination" />. This parameter is treated as uninitialized.</param>
<exception cref="T:System.Security.Cryptography.CryptographicException">The object identifier value passed to the constructor was invalid.</exception>
<returns>
<see langword="true" /> if <paramref name="destination" /> is big enough to receive the output; otherwise, <see langword="false" />.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Pkcs12SafeBag.Attributes">
<summary>Gets the modifiable collection of attributes to encode with the SafeBag value.</summary>
<returns>The modifiable collection of attributes to encode with the SafeBag value.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Pkcs12SafeBag.EncodedBagValue">
<summary>Gets the ASN.1 BER encoding of the contents of this SafeBag.</summary>
<returns>The ASN.1 BER encoding of the contents of this SafeBag.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.Pkcs12SafeContents">
<summary>Represents a PKCS#12 SafeContents value. This class cannot be inherited.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12SafeContents.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.Pkcs12SafeContents" /> class.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12SafeContents.AddCertificate(System.Security.Cryptography.X509Certificates.X509Certificate2)">
<summary>Adds a certificate to the SafeContents via a new <see cref="T:System.Security.Cryptography.Pkcs.Pkcs12CertBag" /> and returns the newly created bag instance.</summary>
<param name="certificate">The certificate to add.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="certificate" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">This instance is read-only.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The <paramref name="certificate" /> parameter is in an invalid state.</exception>
<returns>The bag instance which was added to the SafeContents.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12SafeContents.AddKeyUnencrypted(System.Security.Cryptography.AsymmetricAlgorithm)">
<summary>Adds an asymmetric private key to the SafeContents via a new <see cref="T:System.Security.Cryptography.Pkcs.Pkcs12KeyBag" /> and returns the newly created bag instance.</summary>
<param name="key">The asymmetric private key to add.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="key" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">This instance is read-only.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The key export failed.</exception>
<returns>The bag instance which was added to the SafeContents.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12SafeContents.AddNestedContents(System.Security.Cryptography.Pkcs.Pkcs12SafeContents)">
<summary>Adds a nested SafeContents to the SafeContents via a new <see cref="T:System.Security.Cryptography.Pkcs.Pkcs12SafeContentsBag" /> and returns the newly created bag instance.</summary>
<param name="safeContents">The nested contents to add to the SafeContents.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="safeContents" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">The <paramref name="safeContents" /> parameter is encrypted.</exception>
<exception cref="T:System.InvalidOperationException">This instance is read-only.</exception>
<returns>The bag instance which was added to the SafeContents.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12SafeContents.AddSafeBag(System.Security.Cryptography.Pkcs.Pkcs12SafeBag)">
<summary>Adds a SafeBag to the SafeContents.</summary>
<param name="safeBag">The SafeBag value to add.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="safeBag" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">This instance is read-only.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12SafeContents.AddSecret(System.Security.Cryptography.Oid,System.ReadOnlyMemory{System.Byte})">
<summary>Adds an ASN.1 BER-encoded value with a specified type identifier to the SafeContents via a new <see cref="T:System.Security.Cryptography.Pkcs.Pkcs12SecretBag" /> and returns the newly created bag instance.</summary>
<param name="secretType">The Object Identifier (OID) which identifies the data type of the secret value.</param>
<param name="secretValue">The BER-encoded value representing the secret to add.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="secretType" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">This instance is read-only.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The <paramref name="secretValue" /> parameter does not represent a single ASN.1 BER-encoded value.</exception>
<returns>The bag instance which was added to the SafeContents.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12SafeContents.AddShroudedKey(System.Security.Cryptography.AsymmetricAlgorithm,System.Byte[],System.Security.Cryptography.PbeParameters)">
<summary>Adds an encrypted asymmetric private key to the SafeContents via a new <see cref="T:System.Security.Cryptography.Pkcs.Pkcs12ShroudedKeyBag" /> from a byte-based password in an array and returns the newly created bag instance.</summary>
<param name="key">The asymmetric private key to add.</param>
<param name="passwordBytes">The bytes to use as a password when encrypting the key material.</param>
<param name="pbeParameters">The password-based encryption (PBE) parameters to use when encrypting the key material.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="key" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">This instance is read-only.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The key export failed.</exception>
<returns>The bag instance which was added to the SafeContents.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12SafeContents.AddShroudedKey(System.Security.Cryptography.AsymmetricAlgorithm,System.ReadOnlySpan{System.Byte},System.Security.Cryptography.PbeParameters)">
<summary>Adds an encrypted asymmetric private key to the SafeContents via a new <see cref="T:System.Security.Cryptography.Pkcs.Pkcs12ShroudedKeyBag" /> from a byte-based password in a span and returns the newly created bag instance.</summary>
<param name="key">The asymmetric private key to add.</param>
<param name="passwordBytes">The bytes to use as a password when encrypting the key material.</param>
<param name="pbeParameters">The password-based encryption (PBE) parameters to use when encrypting the key material.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="key" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">This instance is read-only.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The key export failed.</exception>
<returns>The bag instance which was added to the SafeContents.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12SafeContents.AddShroudedKey(System.Security.Cryptography.AsymmetricAlgorithm,System.ReadOnlySpan{System.Char},System.Security.Cryptography.PbeParameters)">
<summary>Adds an encrypted asymmetric private key to the SafeContents via a new <see cref="T:System.Security.Cryptography.Pkcs.Pkcs12ShroudedKeyBag" /> from a character-based password in a span and returns the newly created bag instance.</summary>
<param name="key">The asymmetric private key to add.</param>
<param name="password">The password to use when encrypting the key material.</param>
<param name="pbeParameters">The password-based encryption (PBE) parameters to use when encrypting the key material.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="key" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">This instance is read-only.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The key export failed.</exception>
<returns>The bag instance which was added to the SafeContents.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12SafeContents.AddShroudedKey(System.Security.Cryptography.AsymmetricAlgorithm,System.String,System.Security.Cryptography.PbeParameters)">
<summary>Adds an encrypted asymmetric private key to the SafeContents via a new <see cref="T:System.Security.Cryptography.Pkcs.Pkcs12ShroudedKeyBag" /> from a character-based password in a string and returns the newly created bag instance.</summary>
<param name="key">The asymmetric private key to add.</param>
<param name="password">The password to use when encrypting the key material.</param>
<param name="pbeParameters">The password-based encryption (PBE) parameters to use when encrypting the key material.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="key" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">This instance is read-only.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The key export failed.</exception>
<returns>The bag instance which was added to the SafeContents.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12SafeContents.Decrypt(System.Byte[])">
<summary>Decrypts the contents of this SafeContents value using a byte-based password from an array.</summary>
<param name="passwordBytes">The bytes to use as a password for decrypting the encrypted contents.</param>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.Security.Cryptography.Pkcs.Pkcs12SafeContents.ConfidentialityMode" /> property is not <see cref="F:System.Security.Cryptography.Pkcs.Pkcs12ConfidentialityMode.Password" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The password is incorrect.
-or-
The contents were not successfully decrypted.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12SafeContents.Decrypt(System.ReadOnlySpan{System.Byte})">
<summary>Decrypts the contents of this SafeContents value using a byte-based password from a span.</summary>
<param name="passwordBytes">The bytes to use as a password for decrypting the encrypted contents.</param>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.Security.Cryptography.Pkcs.Pkcs12SafeContents.ConfidentialityMode" /> property is not <see cref="F:System.Security.Cryptography.Pkcs.Pkcs12ConfidentialityMode.Password" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The password is incorrect.
-or-
The contents were not successfully decrypted.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12SafeContents.Decrypt(System.ReadOnlySpan{System.Char})">
<summary>Decrypts the contents of this SafeContents value using a character-based password from a span.</summary>
<param name="password">The password to use for decrypting the encrypted contents.</param>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.Security.Cryptography.Pkcs.Pkcs12SafeContents.ConfidentialityMode" /> property is not <see cref="F:System.Security.Cryptography.Pkcs.Pkcs12ConfidentialityMode.Password" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The password is incorrect.
-or-
The contents were not successfully decrypted.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12SafeContents.Decrypt(System.String)">
<summary>Decrypts the contents of this SafeContents value using a character-based password from a string.</summary>
<param name="password">The password to use for decrypting the encrypted contents.</param>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.Security.Cryptography.Pkcs.Pkcs12SafeContents.ConfidentialityMode" /> property is not <see cref="F:System.Security.Cryptography.Pkcs.Pkcs12ConfidentialityMode.Password" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The password is incorrect.
-or-
The contents were not successfully decrypted.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12SafeContents.GetBags">
<summary>Gets an enumerable representation of the SafeBag values contained within the SafeContents.</summary>
<exception cref="T:System.InvalidOperationException">The contents are encrypted.</exception>
<returns>An enumerable representation of the SafeBag values contained within the SafeContents.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Pkcs12SafeContents.ConfidentialityMode">
<summary>Gets a value that indicates the type of encryption applied to the contents.</summary>
<returns>One of the enumeration values that indicates the type of encryption applied to the contents. The default value is <see cref="F:System.Security.Cryptography.Pkcs.Pkcs12ConfidentialityMode.None" />.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Pkcs12SafeContents.IsReadOnly">
<summary>Gets a value that indicates whether this instance in a read-only state.</summary>
<returns>
<see langword="true" /> if this value is in a read-only state; otherwise, <see langword="false" />. The default value is <see langword="false" />.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.Pkcs12SafeContentsBag">
<summary>Represents the SafeContentsBag from PKCS#12, a container whose contents are a PKCS#12 SafeContents value. This class cannot be inherited.</summary>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Pkcs12SafeContentsBag.SafeContents">
<summary>Gets the SafeContents value contained within this bag.</summary>
<returns>The SafeContents value contained within this bag.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.Pkcs12SecretBag">
<summary>Represents the SecretBag from PKCS#12, a container whose contents are arbitrary data with a type identifier. This class cannot be inherited.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12SecretBag.GetSecretType">
<summary>Gets the Object Identifier (OID) which identifies the data type of the secret value.</summary>
<returns>The Object Identifier (OID) which identifies the data type of the secret value.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Pkcs12SecretBag.SecretValue">
<summary>Gets a memory value containing the BER-encoded contents of the bag.</summary>
<returns>A memory value containing the BER-encoded contents of the bag.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.Pkcs12ShroudedKeyBag">
<summary>Represents the ShroudedKeyBag from PKCS#12, a container whose contents are a PKCS#8 EncryptedPrivateKeyInfo. This class cannot be inherited.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs12ShroudedKeyBag.#ctor(System.ReadOnlyMemory{System.Byte},System.Boolean)">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.Pkcs12ShroudedKeyBag" /> from an existing encoded PKCS#8 EncryptedPrivateKeyInfo value.</summary>
<param name="encryptedPkcs8PrivateKey">A BER-encoded PKCS#8 EncryptedPrivateKeyInfo value.</param>
<param name="skipCopy">
<see langword="true" /> to store <paramref name="encryptedPkcs8PrivateKey" /> without making a defensive copy; otherwise, <see langword="false" />. The default is <see langword="false" />.</param>
<exception cref="T:System.Security.Cryptography.CryptographicException">The <paramref name="encryptedPkcs8privateKey" /> parameter does not represent a single ASN.1 BER-encoded value.</exception>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Pkcs12ShroudedKeyBag.EncryptedPkcs8PrivateKey">
<summary>Gets a memory value containing the PKCS#8 EncryptedPrivateKeyInfo value transported by this bag.</summary>
<returns>A memory value containing the PKCS#8 EncryptedPrivateKeyInfo value transported by this bag.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.Pkcs8PrivateKeyInfo">
<summary>Enables the inspection of and creation of PKCS#8 PrivateKeyInfo and EncryptedPrivateKeyInfo values. This class cannot be inherited.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs8PrivateKeyInfo.#ctor(System.Security.Cryptography.Oid,System.Nullable{System.ReadOnlyMemory{System.Byte}},System.ReadOnlyMemory{System.Byte},System.Boolean)">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.Pkcs8PrivateKeyInfo" /> class.</summary>
<param name="algorithmId">The Object Identifier (OID) identifying the asymmetric algorithm this key is for.</param>
<param name="algorithmParameters">The BER-encoded algorithm parameters associated with this key, or <see langword="null" /> to omit algorithm parameters when encoding.</param>
<param name="privateKey">The algorithm-specific encoded private key.</param>
<param name="skipCopies">
<see langword="true" /> to store <paramref name="algorithmParameters" /> and <paramref name="privateKey" /> without making a defensive copy; otherwise, <see langword="false" />. The default is <see langword="false" />.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="algorithmId" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The <paramref name="algorithmParameters" /> parameter is not <see langword="null" />, empty, or a single BER-encoded value.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs8PrivateKeyInfo.Create(System.Security.Cryptography.AsymmetricAlgorithm)">
<summary>Exports a specified key as a PKCS#8 PrivateKeyInfo and returns its decoded interpretation.</summary>
<param name="privateKey">The private key to represent in a PKCS#8 PrivateKeyInfo.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="privateKey" /> parameter is <see langword="null" />.</exception>
<returns>The decoded interpretation of the exported PKCS#8 PrivateKeyInfo.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs8PrivateKeyInfo.Decode(System.ReadOnlyMemory{System.Byte},System.Int32@,System.Boolean)">
<summary>Reads the provided data as a PKCS#8 PrivateKeyInfo and returns an object view of the contents.</summary>
<param name="source">The data to interpret as a PKCS#8 PrivateKeyInfo value.</param>
<param name="bytesRead">When this method returns, contains a value that indicates the number of bytes read from <paramref name="source" />. This parameter is treated as uninitialized.</param>
<param name="skipCopy">
<see langword="true" /> to store <paramref name="source" /> without making a defensive copy; otherwise, <see langword="false" />. The default is <see langword="false" />.</param>
<exception cref="T:System.Security.Cryptography.CryptographicException">The contents of the <paramref name="source" /> parameter were not successfully decoded as a PKCS#8 PrivateKeyInfo.</exception>
<returns>An object view of the contents decoded as a PKCS#8 PrivateKeyInfo.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs8PrivateKeyInfo.DecryptAndDecode(System.ReadOnlySpan{System.Byte},System.ReadOnlyMemory{System.Byte},System.Int32@)">
<summary>Decrypts the provided data using the provided byte-based password and decodes the output into an object view of the PKCS#8 PrivateKeyInfo.</summary>
<param name="passwordBytes">The bytes to use as a password when decrypting the key material.</param>
<param name="source">The data to read as a PKCS#8 EncryptedPrivateKeyInfo structure in the ASN.1-BER encoding.</param>
<param name="bytesRead">When this method returns, contains a value that indicates the number of bytes read from <paramref name="source" />. This parameter is treated as uninitialized.</param>
<exception cref="T:System.Security.Cryptography.CryptographicException">The password is incorrect.
-or-
The contents of <paramref name="source" /> indicate the Key Derivation Function (KDF) to apply is the legacy PKCS#12 KDF, which requires <see cref="T:System.Char" />-based passwords.
-or-
The contents of <paramref name="source" /> do not represent an ASN.1-BER-encoded PKCS#8 EncryptedPrivateKeyInfo structure.</exception>
<returns>An object view of the contents decrypted decoded as a PKCS#8 PrivateKeyInfo.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs8PrivateKeyInfo.DecryptAndDecode(System.ReadOnlySpan{System.Char},System.ReadOnlyMemory{System.Byte},System.Int32@)">
<summary>Decrypts the provided data using the provided character-based password and decodes the output into an object view of the PKCS#8 PrivateKeyInfo.</summary>
<param name="password">The password to use when decrypting the key material.</param>
<param name="source">The bytes of a PKCS#8 EncryptedPrivateKeyInfo structure in the ASN.1-BER encoding.</param>
<param name="bytesRead">When this method returns, contains a value that indicates the number of bytes read from <paramref name="source" />. This parameter is treated as uninitialized.</param>
<returns>An object view of the contents decrypted decoded as a PKCS#8 PrivateKeyInfo.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs8PrivateKeyInfo.Encode">
<summary>Encodes the property data of this instance as a PKCS#8 PrivateKeyInfo and returns the encoding as a byte array.</summary>
<returns>A byte array representing the encoded form of the PKCS#8 PrivateKeyInfo.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs8PrivateKeyInfo.Encrypt(System.ReadOnlySpan{System.Byte},System.Security.Cryptography.PbeParameters)">
<summary>Produces a PKCS#8 EncryptedPrivateKeyInfo from the property contents of this object after encrypting with the specified byte-based password and encryption parameters.</summary>
<param name="passwordBytes">The bytes to use as a password when encrypting the key material.</param>
<param name="pbeParameters">The password-based encryption (PBE) parameters to use when encrypting the key material.</param>
<exception cref="T:System.Security.Cryptography.CryptographicException">
<paramref name="pbeParameters" /> indicates that <see cref="F:System.Security.Cryptography.PbeEncryptionAlgorithm.TripleDes3KeyPkcs12" /> should be used, which requires <see cref="T:System.Char" />-based passwords.</exception>
<returns>A byte array containing the encoded form of the PKCS#8 EncryptedPrivateKeyInfo.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs8PrivateKeyInfo.Encrypt(System.ReadOnlySpan{System.Char},System.Security.Cryptography.PbeParameters)">
<summary>Produces a PKCS#8 EncryptedPrivateKeyInfo from the property contents of this object after encrypting with the specified character-based password and encryption parameters.</summary>
<param name="password">The password to use when encrypting the key material.</param>
<param name="pbeParameters">The password-based encryption (PBE) parameters to use when encrypting the key material.</param>
<returns>A byte array containing the encoded form of the PKCS#8 EncryptedPrivateKeyInfo.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs8PrivateKeyInfo.TryEncode(System.Span{System.Byte},System.Int32@)">
<summary>Attempts to encode the property data of this instance as a PKCS#8 PrivateKeyInfo, writing the results into a provided buffer.</summary>
<param name="destination">The byte span to receive the PKCS#8 PrivateKeyInfo data.</param>
<param name="bytesWritten">When this method returns, contains a value that indicates the number of bytes written to <paramref name="destination" />. This parameter is treated as uninitialized.</param>
<returns>
<see langword="true" /> if <paramref name="destination" /> is big enough to receive the output; otherwise, <see langword="false" />.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs8PrivateKeyInfo.TryEncrypt(System.ReadOnlySpan{System.Byte},System.Security.Cryptography.PbeParameters,System.Span{System.Byte},System.Int32@)">
<summary>Attempts to produce a PKCS#8 EncryptedPrivateKeyInfo from the property contents of this object after encrypting with the specified byte-based password and encryption parameters, writing the results into a provided buffer.</summary>
<param name="passwordBytes">The bytes to use as a password when encrypting the key material.</param>
<param name="pbeParameters">The password-based encryption (PBE) parameters to use when encrypting the key material.</param>
<param name="destination">The byte span to receive the PKCS#8 EncryptedPrivateKeyInfo data.</param>
<param name="bytesWritten">When this method returns, contains a value that indicates the number of bytes written to <paramref name="destination" />. This parameter is treated as uninitialized.</param>
<returns>
<see langword="true" /> if <paramref name="destination" /> is big enough to receive the output; otherwise, <see langword="false" />.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs8PrivateKeyInfo.TryEncrypt(System.ReadOnlySpan{System.Char},System.Security.Cryptography.PbeParameters,System.Span{System.Byte},System.Int32@)">
<summary>Attempts to produce a PKCS#8 EncryptedPrivateKeyInfo from the property contents of this object after encrypting with the specified character-based password and encryption parameters, writing the result into a provided buffer.</summary>
<param name="password">The password to use when encrypting the key material.</param>
<param name="pbeParameters">The password-based encryption (PBE) parameters to use when encrypting the key material.</param>
<param name="destination">The byte span to receive the PKCS#8 EncryptedPrivateKeyInfo data.</param>
<param name="bytesWritten">When this method returns, contains a value that indicates the number of bytes written to <paramref name="destination" />. This parameter is treated as uninitialized.</param>
<returns>
<see langword="true" /> if <paramref name="destination" /> is big enough to receive the output; otherwise, <see langword="false" />.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Pkcs8PrivateKeyInfo.AlgorithmId">
<summary>Gets the Object Identifier (OID) value identifying the algorithm this key is for.</summary>
<returns>The Object Identifier (OID) value identifying the algorithm this key is for.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Pkcs8PrivateKeyInfo.AlgorithmParameters">
<summary>Gets a memory value containing the BER-encoded algorithm parameters associated with this key.</summary>
<returns>A memory value containing the BER-encoded algorithm parameters associated with this key, or <see langword="null" /> if no parameters were present.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Pkcs8PrivateKeyInfo.Attributes">
<summary>Gets the modifiable collection of attributes for this private key.</summary>
<returns>The modifiable collection of attributes to encode with the private key.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Pkcs8PrivateKeyInfo.PrivateKeyBytes">
<summary>Gets a memory value that represents the algorithm-specific encoded private key.</summary>
<returns>A memory value that represents the algorithm-specific encoded private key.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.Pkcs9AttributeObject">
<summary>Represents an attribute used for CMS/PKCS #7 and PKCS #9 operations.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs9AttributeObject.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.Pkcs9AttributeObject" /> class.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs9AttributeObject.#ctor(System.Security.Cryptography.AsnEncodedData)">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.Pkcs9AttributeObject" /> class using a specified <see cref="T:System.Security.Cryptography.AsnEncodedData" /> object as its attribute type and value.</summary>
<param name="asnEncodedData">An object that contains the PKCS #9 attribute type and value to use.</param>
<exception cref="T:System.ArgumentException">The length of the <paramref name="Value" /> member of the <paramref name="Oid" /> member of <paramref name="asnEncodedData" /> is zero.</exception>
<exception cref="T:System.ArgumentNullException">The <paramref name="Oid" /> member of <paramref name="asnEncodedData" /> is <see langword="null" />.
-or-
The <paramref name="Value" /> member of the <paramref name="Oid" /> member of <paramref name="asnEncodedData" /> is <see langword="null" />.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs9AttributeObject.#ctor(System.Security.Cryptography.Oid,System.Byte[])">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.Pkcs9AttributeObject" /> class using a specified <see cref="T:System.Security.Cryptography.Oid" /> object as the attribute type and a specified ASN.1 encoded data as the attribute value.</summary>
<param name="oid">An object that represents the PKCS #9 attribute type.</param>
<param name="encodedData">An array of byte values that represents the PKCS #9 attribute value.</param>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs9AttributeObject.#ctor(System.String,System.Byte[])">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.Pkcs9AttributeObject" /> class using a specified string representation of an object identifier (OID) as the attribute type and a specified ASN.1 encoded data as the attribute value.</summary>
<param name="oid">The string representation of an OID that represents the PKCS #9 attribute type.</param>
<param name="encodedData">An array of byte values that contains the PKCS #9 attribute value.</param>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs9AttributeObject.CopyFrom(System.Security.Cryptography.AsnEncodedData)">
<summary>Copies a PKCS #9 attribute type and value for this <see cref="T:System.Security.Cryptography.Pkcs.Pkcs9AttributeObject" /> from the specified <see cref="T:System.Security.Cryptography.AsnEncodedData" /> object.</summary>
<param name="asnEncodedData">An object that contains the PKCS #9 attribute type and value to use.</param>
<exception cref="T:System.ArgumentException">
<paramref name="asnEncodeData" /> does not represent a compatible attribute type.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="asnEncodedData" /> is <see langword="null" />.</exception>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Pkcs9AttributeObject.Oid">
<summary>Gets an <see cref="T:System.Security.Cryptography.Oid" /> object that represents the type of attribute associated with this <see cref="T:System.Security.Cryptography.Pkcs.Pkcs9AttributeObject" /> object.</summary>
<returns>An object that represents the type of attribute associated with this <see cref="T:System.Security.Cryptography.Pkcs.Pkcs9AttributeObject" /> object.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.Pkcs9ContentType">
<summary>The <see cref="T:System.Security.Cryptography.Pkcs.Pkcs9ContentType" /> class defines the type of the content of a CMS/PKCS #7 message.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs9ContentType.#ctor">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.Pkcs9ContentType.#ctor" /> constructor creates an instance of the <see cref="T:System.Security.Cryptography.Pkcs.Pkcs9ContentType" /> class.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs9ContentType.CopyFrom(System.Security.Cryptography.AsnEncodedData)">
<summary>Copies information from an <see cref="T:System.Security.Cryptography.AsnEncodedData" /> object.</summary>
<param name="asnEncodedData">The <see cref="T:System.Security.Cryptography.AsnEncodedData" /> object from which to copy information.</param>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Pkcs9ContentType.ContentType">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.Pkcs9ContentType.ContentType" /> property gets an <see cref="T:System.Security.Cryptography.Oid" /> object that contains the content type.</summary>
<returns>An <see cref="T:System.Security.Cryptography.Oid" /> object that contains the content type.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.Pkcs9DocumentDescription">
<summary>The <see cref="T:System.Security.Cryptography.Pkcs.Pkcs9DocumentDescription" /> class defines the description of the content of a CMS/PKCS #7 message.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs9DocumentDescription.#ctor">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.Pkcs9DocumentDescription.#ctor" /> constructor creates an instance of the <see cref="T:System.Security.Cryptography.Pkcs.Pkcs9DocumentDescription" /> class.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs9DocumentDescription.#ctor(System.Byte[])">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.Pkcs9DocumentDescription.#ctor(System.Byte[])" /> constructor creates an instance of the <see cref="T:System.Security.Cryptography.Pkcs.Pkcs9DocumentDescription" /> class by using the specified array of byte values as the encoded description of the content of a CMS/PKCS #7 message.</summary>
<param name="encodedDocumentDescription">An array of byte values that specifies the encoded description of the CMS/PKCS #7 message.</param>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs9DocumentDescription.#ctor(System.String)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.Pkcs9DocumentDescription.#ctor(System.String)" /> constructor creates an instance of the <see cref="T:System.Security.Cryptography.Pkcs.Pkcs9DocumentDescription" /> class by using the specified description of the content of a CMS/PKCS #7 message.</summary>
<param name="documentDescription">An instance of the <see cref="T:System.String" /> class that specifies the description for the CMS/PKCS #7 message.</param>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs9DocumentDescription.CopyFrom(System.Security.Cryptography.AsnEncodedData)">
<summary>Copies information from an <see cref="T:System.Security.Cryptography.AsnEncodedData" /> object.</summary>
<param name="asnEncodedData">The <see cref="T:System.Security.Cryptography.AsnEncodedData" /> object from which to copy information.</param>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Pkcs9DocumentDescription.DocumentDescription">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.Pkcs9DocumentDescription.DocumentDescription" /> property retrieves the document description.</summary>
<returns>A <see cref="T:System.String" /> object that contains the document description.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.Pkcs9DocumentName">
<summary>The <see cref="T:System.Security.Cryptography.Pkcs.Pkcs9DocumentName" /> class defines the name of a CMS/PKCS #7 message.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs9DocumentName.#ctor">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.Pkcs9DocumentName.#ctor" /> constructor creates an instance of the <see cref="T:System.Security.Cryptography.Pkcs.Pkcs9DocumentName" /> class.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs9DocumentName.#ctor(System.Byte[])">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.Pkcs9DocumentName.#ctor(System.Byte[])" /> constructor creates an instance of the <see cref="T:System.Security.Cryptography.Pkcs.Pkcs9DocumentName" /> class by using the specified array of byte values as the encoded name of the content of a CMS/PKCS #7 message.</summary>
<param name="encodedDocumentName">An array of byte values that specifies the encoded name of the CMS/PKCS #7 message.</param>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs9DocumentName.#ctor(System.String)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.Pkcs9DocumentName.#ctor(System.String)" /> constructor creates an instance of the <see cref="T:System.Security.Cryptography.Pkcs.Pkcs9DocumentName" /> class by using the specified name for the CMS/PKCS #7 message.</summary>
<param name="documentName">A <see cref="T:System.String" /> object that specifies the name for the CMS/PKCS #7 message.</param>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs9DocumentName.CopyFrom(System.Security.Cryptography.AsnEncodedData)">
<summary>Copies information from an <see cref="T:System.Security.Cryptography.AsnEncodedData" /> object.</summary>
<param name="asnEncodedData">The <see cref="T:System.Security.Cryptography.AsnEncodedData" /> object from which to copy information.</param>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Pkcs9DocumentName.DocumentName">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.Pkcs9DocumentName.DocumentName" /> property retrieves the document name.</summary>
<returns>A <see cref="T:System.String" /> object that contains the document name.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.Pkcs9LocalKeyId">
<summary>Represents the LocalKeyId attribute from PKCS#9.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs9LocalKeyId.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.Pkcs9LocalKeyId" /> class with an empty key identifier value.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs9LocalKeyId.#ctor(System.Byte[])">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.Pkcs9LocalKeyId" /> class with a key identifier specified by a byte array.</summary>
<param name="keyId">A byte array containing the key identifier.</param>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs9LocalKeyId.#ctor(System.ReadOnlySpan{System.Byte})">
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.Pkcs9LocalKeyId" /> class with a key identifier specified by a byte span.</summary>
<param name="keyId">A byte array containing the key identifier.</param>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Pkcs9LocalKeyId.KeyId">
<summary>Gets a memory value containing the key identifier from this attribute.</summary>
<returns>A memory value containing the key identifier from this attribute.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.Pkcs9MessageDigest">
<summary>The <see cref="T:System.Security.Cryptography.Pkcs.Pkcs9MessageDigest" /> class defines the message digest of a CMS/PKCS #7 message.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs9MessageDigest.#ctor">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.Pkcs9MessageDigest.#ctor" /> constructor creates an instance of the <see cref="T:System.Security.Cryptography.Pkcs.Pkcs9MessageDigest" /> class.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs9MessageDigest.CopyFrom(System.Security.Cryptography.AsnEncodedData)">
<summary>Copies information from an <see cref="T:System.Security.Cryptography.AsnEncodedData" /> object.</summary>
<param name="asnEncodedData">The <see cref="T:System.Security.Cryptography.AsnEncodedData" /> object from which to copy information.</param>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Pkcs9MessageDigest.MessageDigest">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.Pkcs9MessageDigest.MessageDigest" /> property retrieves the message digest.</summary>
<returns>An array of byte values that contains the message digest.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.Pkcs9SigningTime">
<summary>The <see cref="T:System.Security.Cryptography.Pkcs.Pkcs9SigningTime" /> class defines the signing date and time of a signature. A <see cref="T:System.Security.Cryptography.Pkcs.Pkcs9SigningTime" /> object can be used as an authenticated attribute of a <see cref="T:System.Security.Cryptography.Pkcs.CmsSigner" /> object when an authenticated date and time are to accompany a digital signature.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs9SigningTime.#ctor">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.Pkcs9SigningTime.#ctor" /> constructor creates an instance of the <see cref="T:System.Security.Cryptography.Pkcs.Pkcs9SigningTime" /> class.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs9SigningTime.#ctor(System.Byte[])">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.Pkcs9SigningTime.#ctor(System.Byte[])" /> constructor creates an instance of the <see cref="T:System.Security.Cryptography.Pkcs.Pkcs9SigningTime" /> class by using the specified array of byte values as the encoded signing date and time of the content of a CMS/PKCS #7 message.</summary>
<param name="encodedSigningTime">An array of byte values that specifies the encoded signing date and time of the CMS/PKCS #7 message.</param>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs9SigningTime.#ctor(System.DateTime)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.Pkcs9SigningTime.#ctor(System.DateTime)" /> constructor creates an instance of the <see cref="T:System.Security.Cryptography.Pkcs.Pkcs9SigningTime" /> class by using the specified signing date and time.</summary>
<param name="signingTime">A <see cref="T:System.DateTime" /> structure that represents the signing date and time of the signature.</param>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Pkcs9SigningTime.CopyFrom(System.Security.Cryptography.AsnEncodedData)">
<summary>Copies information from a <see cref="T:System.Security.Cryptography.AsnEncodedData" /> object.</summary>
<param name="asnEncodedData">The <see cref="T:System.Security.Cryptography.AsnEncodedData" /> object from which to copy information.</param>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Pkcs9SigningTime.SigningTime">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.Pkcs9SigningTime.SigningTime" /> property retrieves a <see cref="T:System.DateTime" /> structure that represents the date and time that the message was signed.</summary>
<returns>A <see cref="T:System.DateTime" /> structure that contains the date and time the document was signed.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.PublicKeyInfo">
<summary>The <see cref="T:System.Security.Cryptography.Pkcs.PublicKeyInfo" /> class represents information associated with a public key.</summary>
</member>
<member name="P:System.Security.Cryptography.Pkcs.PublicKeyInfo.Algorithm">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.PublicKeyInfo.Algorithm" /> property retrieves the algorithm identifier associated with the public key.</summary>
<returns>An <see cref="T:System.Security.Cryptography.Pkcs.AlgorithmIdentifier" /> object that represents the algorithm.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.PublicKeyInfo.KeyValue">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.PublicKeyInfo.KeyValue" /> property retrieves the value of the encoded public component of the public key pair.</summary>
<returns>An array of byte values that represents the encoded public component of the public key pair.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.RecipientInfo">
<summary>The <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfo" /> class represents information about a CMS/PKCS #7 message recipient. The <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfo" /> class is an abstract class inherited by the <see cref="T:System.Security.Cryptography.Pkcs.KeyAgreeRecipientInfo" /> and <see cref="T:System.Security.Cryptography.Pkcs.KeyTransRecipientInfo" /> classes.</summary>
</member>
<member name="P:System.Security.Cryptography.Pkcs.RecipientInfo.EncryptedKey">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.RecipientInfo.EncryptedKey" /> abstract property retrieves the encrypted recipient keying material.</summary>
<returns>An array of byte values that contain the encrypted recipient keying material.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.RecipientInfo.KeyEncryptionAlgorithm">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.RecipientInfo.KeyEncryptionAlgorithm" /> abstract property retrieves the algorithm used to perform the key establishment.</summary>
<returns>An <see cref="T:System.Security.Cryptography.Pkcs.AlgorithmIdentifier" /> object that contains the value of the algorithm used to establish the key between the originator and recipient of the CMS/PKCS #7 message.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.RecipientInfo.RecipientIdentifier">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.RecipientInfo.RecipientIdentifier" /> abstract property retrieves the identifier of the recipient.</summary>
<returns>A <see cref="T:System.Security.Cryptography.Pkcs.SubjectIdentifier" /> object that contains the identifier of the recipient.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.RecipientInfo.Type">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.RecipientInfo.Type" /> property retrieves the type of the recipient. The type of the recipient determines which of two major protocols is used to establish a key between the originator and the recipient of a CMS/PKCS #7 message.</summary>
<returns>A value of the <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoType" /> enumeration that defines the type of the recipient.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.RecipientInfo.Version">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.RecipientInfo.Version" /> abstract property retrieves the version of the recipient information. Derived classes automatically set this property for their objects, and the value indicates whether it is using PKCS #7 or Cryptographic Message Syntax (CMS) to protect messages. The version also implies whether the <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfo" /> object establishes a cryptographic key by a key agreement algorithm or a key transport algorithm.</summary>
<returns>An <see cref="T:System.Int32" /> value that represents the version of the <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfo" /> object.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.RecipientInfoCollection">
<summary>The <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoCollection" /> class represents a collection of <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfo" /> objects. <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoCollection" /> implements the <see cref="T:System.Collections.ICollection" /> interface.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.RecipientInfoCollection.CopyTo(System.Array,System.Int32)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.RecipientInfoCollection.CopyTo(System.Array,System.Int32)" /> method copies the <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoCollection" /> collection to an array.</summary>
<param name="array">An <see cref="T:System.Array" /> object to which the <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoCollection" /> collection is to be copied.</param>
<param name="index">The zero-based index in <paramref name="array" /> where the <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoCollection" /> collection is copied.</param>
<exception cref="T:System.ArgumentException">One of the arguments provided to a method was not valid.</exception>
<exception cref="T:System.ArgumentNullException">A null reference was passed to a method that does not accept it as a valid argument.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The value of an argument was outside the allowable range of values as defined by the called method.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.RecipientInfoCollection.CopyTo(System.Security.Cryptography.Pkcs.RecipientInfo[],System.Int32)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.RecipientInfoCollection.CopyTo(System.Security.Cryptography.Pkcs.RecipientInfo[],System.Int32)" /> method copies the <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoCollection" /> collection to a <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfo" /> array.</summary>
<param name="array">An array of <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfo" /> objects where the <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoCollection" /> collection is to be copied.</param>
<param name="index">The zero-based index in <paramref name="array" /> where the <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoCollection" /> collection is copied.</param>
<exception cref="T:System.ArgumentException">One of the arguments provided to a method was not valid.</exception>
<exception cref="T:System.ArgumentNullException">A null reference was passed to a method that does not accept it as a valid argument.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The value of an argument was outside the allowable range of values as defined by the called method.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.RecipientInfoCollection.GetEnumerator">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.RecipientInfoCollection.GetEnumerator" /> method returns a <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoEnumerator" /> object for the <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoCollection" /> collection.</summary>
<returns>A <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoEnumerator" /> object that can be used to enumerate the <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoCollection" /> collection.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.RecipientInfoCollection.System#Collections#IEnumerable#GetEnumerator">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.RecipientInfoCollection.System#Collections#IEnumerable#GetEnumerator" /> method returns a <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoEnumerator" /> object for the <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoCollection" /> collection.</summary>
<returns>A <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoEnumerator" /> object that can be used to enumerate the <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoCollection" /> collection.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.RecipientInfoCollection.Count">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.RecipientInfoCollection.Count" /> property retrieves the number of items in the <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoCollection" /> collection.</summary>
<returns>An int value that represents the number of items in the collection.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.RecipientInfoCollection.IsSynchronized">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.RecipientInfoCollection.IsSynchronized" /> property retrieves whether access to the collection is synchronized, or thread safe. This property always returns <see langword="false" />, which means the collection is not thread safe.</summary>
<returns>A <see cref="T:System.Boolean" /> value of <see langword="false" />, which means the collection is not thread safe.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.RecipientInfoCollection.Item(System.Int32)">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.RecipientInfoCollection.Item(System.Int32)" /> property retrieves the <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfo" /> object at the specified index in the collection.</summary>
<param name="index">An int value that represents the index in the collection. The index is zero based.</param>
<exception cref="T:System.ArgumentOutOfRangeException">The value of an argument was outside the allowable range of values as defined by the called method.</exception>
<returns>A <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfo" /> object at the specified index.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.RecipientInfoCollection.SyncRoot">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.RecipientInfoCollection.SyncRoot" /> property retrieves an <see cref="T:System.Object" /> object used to synchronize access to the <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoCollection" /> collection.</summary>
<returns>An <see cref="T:System.Object" /> object used to synchronize access to the <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoCollection" /> collection.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.RecipientInfoEnumerator">
<summary>The <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoEnumerator" /> class provides enumeration functionality for the <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoCollection" /> collection. <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoEnumerator" /> implements the <see cref="T:System.Collections.IEnumerator" /> interface.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.RecipientInfoEnumerator.MoveNext">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.RecipientInfoEnumerator.MoveNext" /> method advances the enumeration to the next <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfo" /> object in the <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoCollection" /> collection.</summary>
<returns>This method returns a bool that specifies whether the enumeration successfully advanced. If the enumeration successfully moved to the next <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfo" /> object, the method returns <see langword="true" />. If the enumeration moved past the last item in the enumeration, it returns <see langword="false" />.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.RecipientInfoEnumerator.Reset">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.RecipientInfoEnumerator.Reset" /> method resets the enumeration to the first <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfo" /> object in the <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoCollection" /> collection.</summary>
</member>
<member name="P:System.Security.Cryptography.Pkcs.RecipientInfoEnumerator.Current">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.RecipientInfoEnumerator.Current" /> property retrieves the current <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfo" /> object from the <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoCollection" /> collection.</summary>
<returns>A <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfo" /> object that represents the current recipient information structure in the <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoCollection" /> collection.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.RecipientInfoEnumerator.System#Collections#IEnumerator#Current">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.RecipientInfoEnumerator.System#Collections#IEnumerator#Current" /> property retrieves the current <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfo" /> object from the <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoCollection" /> collection.</summary>
<returns>A <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfo" /> object that represents the current recipient information structure in the <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoCollection" /> collection.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.RecipientInfoType">
<summary>The <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoType" /> enumeration defines the types of recipient information.</summary>
</member>
<member name="F:System.Security.Cryptography.Pkcs.RecipientInfoType.KeyAgreement">
<summary>Key agreement recipient information.</summary>
</member>
<member name="F:System.Security.Cryptography.Pkcs.RecipientInfoType.KeyTransport">
<summary>Key transport recipient information.</summary>
</member>
<member name="F:System.Security.Cryptography.Pkcs.RecipientInfoType.Unknown">
<summary>The recipient information type is unknown.</summary>
</member>
<member name="T:System.Security.Cryptography.Pkcs.Rfc3161TimestampRequest">
<summary>Represents a time-stamping request from IETF RFC 3161.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Rfc3161TimestampRequest.CreateFromData(System.ReadOnlySpan{System.Byte},System.Security.Cryptography.HashAlgorithmName,System.Security.Cryptography.Oid,System.Nullable{System.ReadOnlyMemory{System.Byte}},System.Boolean,System.Security.Cryptography.X509Certificates.X509ExtensionCollection)">
<summary>Creates a timestamp request by hashing the provided data with a specified algorithm.</summary>
<param name="data">The data to timestamp, which will be hashed by this method.</param>
<param name="hashAlgorithm">The hash algorithm to use with this timestamp request.</param>
<param name="requestedPolicyId">The Object Identifier (OID) for a timestamp policy the Timestamp Authority (TSA) should use, or <see langword="null" /> to express no preference.</param>
<param name="nonce">An optional nonce (number used once) to uniquely identify this request to pair it with the response. The value is interpreted as an unsigned big-endian integer and may be normalized to the encoding format.</param>
<param name="requestSignerCertificates">
<see langword="true" /> to indicate the Timestamp Authority (TSA) must include the signing certificate in the issued timestamp token; otherwise, <see langword="false" />.</param>
<param name="extensions">An optional collection of extensions to include in the request.</param>
<exception cref="T:System.ArgumentException">
<paramref name="hashAlgorithm" />.<see cref="P:System.Security.Cryptography.HashAlgorithmName.Name" /> is <see langword="null" /> or <see cref="F:System.String.Empty" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">
<paramref name="hashAlgorithm" /> is not a known hash algorithm.</exception>
<returns>An <see cref="T:System.Security.Cryptography.Pkcs.Rfc3161TimestampRequest" /> representing the chosen values.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Rfc3161TimestampRequest.CreateFromHash(System.ReadOnlyMemory{System.Byte},System.Security.Cryptography.HashAlgorithmName,System.Security.Cryptography.Oid,System.Nullable{System.ReadOnlyMemory{System.Byte}},System.Boolean,System.Security.Cryptography.X509Certificates.X509ExtensionCollection)">
<summary>Create a timestamp request using a pre-computed hash value and the name of the hash algorithm.</summary>
<param name="hash">The pre-computed hash value to be timestamped.</param>
<param name="hashAlgorithm">The hash algorithm used to produce <paramref name="hash" />.</param>
<param name="requestedPolicyId">The Object Identifier (OID) for the timestamp policy that the Timestamp Authority (TSA) should use, or <see langword="null" /> to express no preference.</param>
<param name="nonce">An optional value used to uniquely match a request to a response, or <see langword="null" /> to not include a nonce in the request.</param>
<param name="requestSignerCertificates">
<see langword="true" /> to indicate the Timestamp Authority (TSA) must include the signing certificate in the issued timestamp token; otherwise, <see langword="false" />.</param>
<param name="extensions">An optional collection of extensions to include in the request.</param>
<exception cref="T:System.Security.Cryptography.CryptographicException">
<paramref name="hashAlgorithm" /> is not a known hash algorithm.</exception>
<returns>An <see cref="T:System.Security.Cryptography.Pkcs.Rfc3161TimestampRequest" /> representing the chosen values.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Rfc3161TimestampRequest.CreateFromHash(System.ReadOnlyMemory{System.Byte},System.Security.Cryptography.Oid,System.Security.Cryptography.Oid,System.Nullable{System.ReadOnlyMemory{System.Byte}},System.Boolean,System.Security.Cryptography.X509Certificates.X509ExtensionCollection)">
<summary>Create a timestamp request using a pre-computed hash value and the Object Identifier for the hash algorithm.</summary>
<param name="hash">The pre-computed hash value to be timestamped.</param>
<param name="hashAlgorithmId">The Object Identifier (OID) for the hash algorithm that produced <paramref name="hash" />.</param>
<param name="requestedPolicyId">The Object Identifier (OID) for a timestamp policy the Timestamp Authority (TSA) should use, or <see langword="null" /> to express no preference.</param>
<param name="nonce">An optional nonce (number used once) to uniquely identify this request to pair it with the response. The value is interpreted as an unsigned big-endian integer and may be normalized to the encoding format.</param>
<param name="requestSignerCertificates">
<see langword="true" /> to indicate the Timestamp Authority (TSA) must include the signing certificate in the issued timestamp token; otherwise, <see langword="false" />.</param>
<param name="extensions">An optional collection of extensions to include in the request.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="hashAlgorithmId" /> is <see langword="null" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">
<paramref name="hashAlgorithmId" />.<see cref="P:System.Security.Cryptography.Oid.Value" /> is not a valid OID.</exception>
<returns>An <see cref="T:System.Security.Cryptography.Pkcs.Rfc3161TimestampRequest" /> representing the chosen values.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Rfc3161TimestampRequest.CreateFromSignerInfo(System.Security.Cryptography.Pkcs.SignerInfo,System.Security.Cryptography.HashAlgorithmName,System.Security.Cryptography.Oid,System.Nullable{System.ReadOnlyMemory{System.Byte}},System.Boolean,System.Security.Cryptography.X509Certificates.X509ExtensionCollection)">
<summary>Creates a timestamp request by hashing the signature of the provided signer with a specified algorithm.</summary>
<param name="signerInfo">The CMS signer information to build a timestamp request for.</param>
<param name="hashAlgorithm">The hash algorithm to use with this timestamp request.</param>
<param name="requestedPolicyId">The Object Identifier (OID) for the timestamp policy that the Timestamp Authority (TSA) should use, or <see langword="null" /> to express no preference.</param>
<param name="nonce">An optional nonce (number used once) to uniquely identify this request to pair it with the response. The value is interpreted as an unsigned big-endian integer and may be normalized to the encoding format.</param>
<param name="requestSignerCertificates">
<see langword="true" /> to indicate the Timestamp Authority (TSA) must include the signing certificate in the issued timestamp token; otherwise, <see langword="false" />.</param>
<param name="extensions">An optional collection of extensions to include in the request.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="signerInfo" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="hashAlgorithm" />.<see cref="P:System.Security.Cryptography.HashAlgorithmName.Name" /> is <see langword="null" /> or <see cref="F:System.String.Empty" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">
<paramref name="hashAlgorithm" /> is not a known hash algorithm.</exception>
<returns>An <see cref="T:System.Security.Cryptography.Pkcs.Rfc3161TimestampRequest" /> representing the chosen values.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Rfc3161TimestampRequest.Encode">
<summary>Encodes the timestamp request and returns it as a byte array.</summary>
<returns>A byte array containing the DER-encoded timestamp request.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Rfc3161TimestampRequest.GetExtensions">
<summary>Gets a collection with a copy of the extensions present on this request.</summary>
<returns>A collection with a copy of the extensions present on this request.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Rfc3161TimestampRequest.GetMessageHash">
<summary>Gets the data hash for this timestamp request.</summary>
<returns>The data hash for this timestamp request as a read-only memory value.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Rfc3161TimestampRequest.GetNonce">
<summary>Gets the nonce for this timestamp request.</summary>
<returns>The nonce for this timestamp request as a read-only memory value, if one was present; otherwise, <see langword="null" />.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Rfc3161TimestampRequest.ProcessResponse(System.ReadOnlyMemory{System.Byte},System.Int32@)">
<summary>Combines an encoded timestamp response with this request to produce a <see cref="T:System.Security.Cryptography.Pkcs.Rfc3161TimestampToken" />.</summary>
<param name="responseBytes">The DER encoded timestamp response.</param>
<param name="bytesConsumed">When this method returns, the number of bytes that were read from <paramref name="responseBytes" />. This parameter is treated as uninitialized.</param>
<returns>The timestamp token from the response that corresponds to this request.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Rfc3161TimestampRequest.TryDecode(System.ReadOnlyMemory{System.Byte},System.Security.Cryptography.Pkcs.Rfc3161TimestampRequest@,System.Int32@)">
<summary>Attemps to interpret the contents of <paramref name="encodedBytes" /> as a DER-encoded Timestamp Request.</summary>
<param name="encodedBytes">The buffer containing a DER-encoded timestamp request.</param>
<param name="request">When this method returns, the successfully decoded timestamp request if decoding succeeded, or <see langword="null" /> if decoding failed. This parameter is treated as uninitialized.</param>
<param name="bytesConsumed">When this method returns, the number of bytes that were read from <paramref name="encodedBytes" />. This parameter is treated as uninitialized.</param>
<returns>
<see langword="true" /> if <paramref name="encodedBytes" /> was successfully interpreted as a Timestamp Request; otherwise, <see langword="false" />.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Rfc3161TimestampRequest.TryEncode(System.Span{System.Byte},System.Int32@)">
<summary>Attempts to encode the instance as an IETF RFC 3161 <c>TimeStampReq</c>, writing the bytes into the provided buffer.</summary>
<param name="destination">The buffer to receive the encoded request.</param>
<param name="bytesWritten">When this method returns, the total number of bytes written into <paramref name="destination" />. This parameter is treated as uninitialized.</param>
<returns>
<see langword="true" />if <paramref name="destination" /> is long enough to receive the encoded request; otherwise, <see langword="false" />.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Rfc3161TimestampRequest.HasExtensions">
<summary>Indicates whether or not the request has extensions.</summary>
<returns>
<see langword="true" /> if the request has any extensions; otherwise, <see langword="false" />.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Rfc3161TimestampRequest.HashAlgorithmId">
<summary>Gets the Object Identifier (OID) for the hash algorithm associated with the request.</summary>
<returns>The Object Identifier (OID) for the hash algorithm associated with the request.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Rfc3161TimestampRequest.RequestedPolicyId">
<summary>Gets the policy ID for the request, or <see langword="null" /> when no policy ID was requested.</summary>
<returns>The policy ID for the request, or <see langword="null" /> when no policy ID was requested.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Rfc3161TimestampRequest.RequestSignerCertificate">
<summary>Gets a value indicating whether or not the request indicated that the timestamp authority certificate is required to be in the response.</summary>
<returns>
<see langword="true" /> if the response must include the timestamp authority certificate; otherwise, <see langword="false" />.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Rfc3161TimestampRequest.Version">
<summary>Gets the data format version number for this request.</summary>
<returns>The data format version number for this request.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.Rfc3161TimestampToken">
<summary>Represents a time-stamp token from IETF RFC 3161.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Rfc3161TimestampToken.AsSignedCms">
<summary>Gets a Signed Cryptographic Message Syntax (CMS) representation of the RFC3161 time-stamp token.</summary>
<returns>The <see cref="T:System.Security.Cryptography.Pkcs.SignedCms" /> representation of the <see cref="T:System.Security.Cryptography.Pkcs.Rfc3161TimestampToken" />.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Rfc3161TimestampToken.TryDecode(System.ReadOnlyMemory{System.Byte},System.Security.Cryptography.Pkcs.Rfc3161TimestampToken@,System.Int32@)">
<summary>Attemps to interpret the contents of <paramref name="encodedBytes" /> as a DER-encoded time-stamp token.</summary>
<param name="encodedBytes">The buffer containing a DER-encoded time-stamp token.</param>
<param name="token">When this method returns, the successfully decoded time-stamp token if decoding succeeded, or <see langword="null" /> if decoding failed. This parameter is treated as uninitialized.</param>
<param name="bytesConsumed">When this method returns, the number of bytes that were read from <paramref name="encodedBytes" />. This parameter is treated as uninitialized.</param>
<returns>
<see langword="true" /> if <paramref name="encodedBytes" /> was successfully interpreted as a time-stamp token; otherwise, <see langword="false" />.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Rfc3161TimestampToken.VerifySignatureForData(System.ReadOnlySpan{System.Byte},System.Security.Cryptography.X509Certificates.X509Certificate2@,System.Security.Cryptography.X509Certificates.X509Certificate2Collection)">
<summary>Verifies that the current token is a valid time-stamp token for the provided data.</summary>
<param name="data">The data to verify against this time-stamp token.</param>
<param name="signerCertificate">When this method returns, the certificate from the Timestamp Authority (TSA) which signed this token, or <see langword="null" /> if a signer certificate cannot be determined. This parameter is treated as uninitialized.</param>
<param name="extraCandidates">An optional collection of certificates to consider as the Timestamp Authority (TSA) certificates, in addition to any certificates that may be included within the token.</param>
<returns>
<see langword="true" /> if the Timestamp Authority (TSA) certificate was found, the certificate public key validates the token signature, and the token matches the hash for the provided data; otherwise, <see langword="false" />.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Rfc3161TimestampToken.VerifySignatureForHash(System.ReadOnlySpan{System.Byte},System.Security.Cryptography.HashAlgorithmName,System.Security.Cryptography.X509Certificates.X509Certificate2@,System.Security.Cryptography.X509Certificates.X509Certificate2Collection)">
<summary>Verifies that the current token is a valid time-stamp token for the provided data hash and algorithm identifier.</summary>
<param name="hash">The cryptographic hash to verify against this time-stamp token.</param>
<param name="hashAlgorithm">The algorithm which produced <paramref name="hash" />.</param>
<param name="signerCertificate">When this method returns, the certificate from the Timestamp Authority (TSA) which signed this token, or <see langword="null" /> if a signer certificate cannot be determined. This parameter is treated as uninitialized.</param>
<param name="extraCandidates">An optional collection of certificates to consider as the Timestamp Authority (TSA) certificates, in addition to any certificates that may be included within the token.</param>
<returns>
<see langword="true" /> if the Timestamp Authority (TSA) certificate was found, the certificate public key validates the token signature, and the token matches the hash for the provided data hash and algorithm; otherwise, <see langword="false" />.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Rfc3161TimestampToken.VerifySignatureForHash(System.ReadOnlySpan{System.Byte},System.Security.Cryptography.Oid,System.Security.Cryptography.X509Certificates.X509Certificate2@,System.Security.Cryptography.X509Certificates.X509Certificate2Collection)">
<summary>Verifies that the current token is a valid time-stamp token for the provided data hash and algorithm identifier.</summary>
<param name="hash">The cryptographic hash to verify against this time-stamp token.</param>
<param name="hashAlgorithmId" />
<param name="signerCertificate">When this method returns, the certificate from the Timestamp Authority (TSA) which signed this token, or <see langword="null" /> if a signer certificate cannot be determined. This parameter is treated as uninitialized.</param>
<param name="extraCandidates">An optional collection of certificates to consider as the Timestamp Authority (TSA) certificates, in addition to any certificates that may be included within the token.</param>
<returns>
<see langword="true" /> if the Timestamp Authority (TSA) certificate was found, the certificate public key validates the token signature, and the token matches the hash for the provided data hash and algorithm; otherwise, <see langword="false" />.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.Rfc3161TimestampToken.VerifySignatureForSignerInfo(System.Security.Cryptography.Pkcs.SignerInfo,System.Security.Cryptography.X509Certificates.X509Certificate2@,System.Security.Cryptography.X509Certificates.X509Certificate2Collection)">
<summary>Verifies that the current token is a valid time-stamp token for the provided <see cref="T:System.Security.Cryptography.Pkcs.SignerInfo" />.</summary>
<param name="signerInfo">The CMS signer information to verify the timestamp was built for.</param>
<param name="signerCertificate">When this method returns, the certificate from the Timestamp Authority (TSA) that signed this token, or <see langword="null" /> if a signer certificate cannot be determined. This parameter is treated as uninitialized.</param>
<param name="extraCandidates">An optional collection of certificates to consider as the Timestamp Authority (TSA) certificates, in addition to any certificates that may be included within the token.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="signerInfo" /> is <see langword="null" />.</exception>
<returns>
<see langword="true" /> if the Timestamp Authority (TSA) certificate was found, the certificate public key validates the token signature, and the token matches the signature for <paramref name="signerInfo" />; otherwise, <see langword="false" />.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.Rfc3161TimestampToken.TokenInfo">
<summary>Gets the details of this time-stamp token as a <see cref="T:System.Security.Cryptography.Pkcs.Rfc3161TimestampTokenInfo" />.</summary>
<returns>The details of this time-stamp token as a <see cref="T:System.Security.Cryptography.Pkcs.Rfc3161TimestampTokenInfo" />.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.Rfc3161TimestampTokenInfo" />
<member name="M:System.Security.Cryptography.Pkcs.Rfc3161TimestampTokenInfo.#ctor(System.Security.Cryptography.Oid,System.Security.Cryptography.Oid,System.ReadOnlyMemory{System.Byte},System.ReadOnlyMemory{System.Byte},System.DateTimeOffset,System.Nullable{System.Int64},System.Boolean,System.Nullable{System.ReadOnlyMemory{System.Byte}},System.Nullable{System.ReadOnlyMemory{System.Byte}},System.Security.Cryptography.X509Certificates.X509ExtensionCollection)">
<param name="policyId" />
<param name="hashAlgorithmId" />
<param name="messageHash" />
<param name="serialNumber" />
<param name="timestamp" />
<param name="accuracyInMicroseconds" />
<param name="isOrdering" />
<param name="nonce" />
<param name="timestampAuthorityName" />
<param name="extensions" />
</member>
<member name="M:System.Security.Cryptography.Pkcs.Rfc3161TimestampTokenInfo.Encode" />
<member name="M:System.Security.Cryptography.Pkcs.Rfc3161TimestampTokenInfo.GetExtensions" />
<member name="M:System.Security.Cryptography.Pkcs.Rfc3161TimestampTokenInfo.GetMessageHash" />
<member name="M:System.Security.Cryptography.Pkcs.Rfc3161TimestampTokenInfo.GetNonce" />
<member name="M:System.Security.Cryptography.Pkcs.Rfc3161TimestampTokenInfo.GetSerialNumber" />
<member name="M:System.Security.Cryptography.Pkcs.Rfc3161TimestampTokenInfo.GetTimestampAuthorityName" />
<member name="M:System.Security.Cryptography.Pkcs.Rfc3161TimestampTokenInfo.TryDecode(System.ReadOnlyMemory{System.Byte},System.Security.Cryptography.Pkcs.Rfc3161TimestampTokenInfo@,System.Int32@)">
<param name="encodedBytes" />
<param name="timestampTokenInfo" />
<param name="bytesConsumed" />
</member>
<member name="M:System.Security.Cryptography.Pkcs.Rfc3161TimestampTokenInfo.TryEncode(System.Span{System.Byte},System.Int32@)">
<param name="destination" />
<param name="bytesWritten" />
</member>
<member name="P:System.Security.Cryptography.Pkcs.Rfc3161TimestampTokenInfo.AccuracyInMicroseconds" />
<member name="P:System.Security.Cryptography.Pkcs.Rfc3161TimestampTokenInfo.HasExtensions" />
<member name="P:System.Security.Cryptography.Pkcs.Rfc3161TimestampTokenInfo.HashAlgorithmId" />
<member name="P:System.Security.Cryptography.Pkcs.Rfc3161TimestampTokenInfo.IsOrdering" />
<member name="P:System.Security.Cryptography.Pkcs.Rfc3161TimestampTokenInfo.PolicyId" />
<member name="P:System.Security.Cryptography.Pkcs.Rfc3161TimestampTokenInfo.Timestamp" />
<member name="P:System.Security.Cryptography.Pkcs.Rfc3161TimestampTokenInfo.Version" />
<member name="T:System.Security.Cryptography.Pkcs.SignedCms">
<summary>The <see cref="T:System.Security.Cryptography.Pkcs.SignedCms" /> class enables signing and verifying of CMS/PKCS #7 messages.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignedCms.#ctor">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.SignedCms.#ctor" /> constructor creates an instance of the <see cref="T:System.Security.Cryptography.Pkcs.SignedCms" /> class.</summary>
<exception cref="T:System.ArgumentNullException">A null reference was passed to a method that does not accept it as a valid argument.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignedCms.#ctor(System.Security.Cryptography.Pkcs.ContentInfo)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.SignedCms.#ctor(System.Security.Cryptography.Pkcs.ContentInfo)" /> constructor creates an instance of the <see cref="T:System.Security.Cryptography.Pkcs.SignedCms" /> class by using the specified content information as the inner content.</summary>
<param name="contentInfo">A <see cref="T:System.Security.Cryptography.Pkcs.ContentInfo" /> object that specifies the content information as the inner content of the <see cref="T:System.Security.Cryptography.Pkcs.SignedCms" /> message.</param>
<exception cref="T:System.ArgumentNullException">A null reference was passed to a method that does not accept it as a valid argument.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignedCms.#ctor(System.Security.Cryptography.Pkcs.ContentInfo,System.Boolean)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.SignedCms.#ctor(System.Security.Cryptography.Pkcs.ContentInfo,System.Boolean)" /> constructor creates an instance of the <see cref="T:System.Security.Cryptography.Pkcs.SignedCms" /> class by using the specified content information as the inner content and by using the detached state.</summary>
<param name="contentInfo">A <see cref="T:System.Security.Cryptography.Pkcs.ContentInfo" /> object that specifies the content information as the inner content of the <see cref="T:System.Security.Cryptography.Pkcs.SignedCms" /> message.</param>
<param name="detached">A <see cref="T:System.Boolean" /> value that specifies whether the <see cref="T:System.Security.Cryptography.Pkcs.SignedCms" /> object is for a detached signature. If <paramref name="detached" /> is <see langword="true" />, the signature is detached. If <paramref name="detached" /> is <see langword="false" />, the signature is not detached.</param>
<exception cref="T:System.ArgumentNullException">A null reference was passed to a method that does not accept it as a valid argument.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignedCms.#ctor(System.Security.Cryptography.Pkcs.SubjectIdentifierType)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.SignedCms.#ctor(System.Security.Cryptography.Pkcs.SubjectIdentifierType)" /> constructor creates an instance of the <see cref="T:System.Security.Cryptography.Pkcs.SignedCms" /> class by using the specified subject identifier type as the default subject identifier type for signers.</summary>
<param name="signerIdentifierType">A <see cref="T:System.Security.Cryptography.Pkcs.SubjectIdentifierType" /> member that specifies the default subject identifier type for signers.</param>
<exception cref="T:System.ArgumentNullException">A null reference was passed to a method that does not accept it as a valid argument.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignedCms.#ctor(System.Security.Cryptography.Pkcs.SubjectIdentifierType,System.Security.Cryptography.Pkcs.ContentInfo)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.SignedCms.#ctor(System.Security.Cryptography.Pkcs.SubjectIdentifierType,System.Security.Cryptography.Pkcs.ContentInfo)" /> constructor creates an instance of the <see cref="T:System.Security.Cryptography.Pkcs.SignedCms" /> class by using the specified subject identifier type as the default subject identifier type for signers and content information as the inner content.</summary>
<param name="signerIdentifierType">A <see cref="T:System.Security.Cryptography.Pkcs.SubjectIdentifierType" /> member that specifies the default subject identifier type for signers.</param>
<param name="contentInfo">A <see cref="T:System.Security.Cryptography.Pkcs.ContentInfo" /> object that specifies the content information as the inner content of the <see cref="T:System.Security.Cryptography.Pkcs.SignedCms" /> message.</param>
<exception cref="T:System.ArgumentNullException">A null reference was passed to a method that does not accept it as a valid argument.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignedCms.#ctor(System.Security.Cryptography.Pkcs.SubjectIdentifierType,System.Security.Cryptography.Pkcs.ContentInfo,System.Boolean)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.SignedCms.#ctor(System.Security.Cryptography.Pkcs.SubjectIdentifierType,System.Security.Cryptography.Pkcs.ContentInfo,System.Boolean)" /> constructor creates an instance of the <see cref="T:System.Security.Cryptography.Pkcs.SignedCms" /> class by using the specified subject identifier type as the default subject identifier type for signers, the content information as the inner content, and by using the detached state.</summary>
<param name="signerIdentifierType">A <see cref="T:System.Security.Cryptography.Pkcs.SubjectIdentifierType" /> member that specifies the default subject identifier type for signers.</param>
<param name="contentInfo">A <see cref="T:System.Security.Cryptography.Pkcs.ContentInfo" /> object that specifies the content information as the inner content of the <see cref="T:System.Security.Cryptography.Pkcs.SignedCms" /> message.</param>
<param name="detached">A <see cref="T:System.Boolean" /> value that specifies whether the <see cref="T:System.Security.Cryptography.Pkcs.SignedCms" /> object is for a detached signature. If <paramref name="detached" /> is <see langword="true" />, the signature is detached. If detached is <see langword="false" />, the signature is not detached.</param>
<exception cref="T:System.ArgumentNullException">A null reference was passed to a method that does not accept it as a valid argument.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignedCms.AddCertificate(System.Security.Cryptography.X509Certificates.X509Certificate2)">
<summary>Adds a certificate to the collection of certificates for the encoded CMS/PKCS #7 message.</summary>
<param name="certificate">The certificate to add to the collection.</param>
<exception cref="T:System.Security.Cryptography.CryptographicException">The certificate already exists in the collection.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignedCms.CheckHash">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.SignedCms.CheckHash" /> method verifies the data integrity of the CMS/PKCS #7 message. <see cref="M:System.Security.Cryptography.Pkcs.SignedCms.CheckHash" /> is a specialized method used in specific security infrastructure applications that only wish to check the hash of the CMS message, rather than perform a full digital signature verification. <see cref="M:System.Security.Cryptography.Pkcs.SignedCms.CheckHash" /> does not authenticate the author nor sender of the message because this method does not involve verifying a digital signature. For general-purpose checking of the integrity and authenticity of a CMS/PKCS #7 message, use the <see cref="M:System.Security.Cryptography.Pkcs.SignedCms.CheckSignature(System.Boolean)" /> or <see cref="M:System.Security.Cryptography.Pkcs.SignedCms.CheckSignature(System.Security.Cryptography.X509Certificates.X509Certificate2Collection,System.Boolean)" /> methods.</summary>
<exception cref="T:System.InvalidOperationException">A method call was invalid for the object's current state.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignedCms.CheckSignature(System.Boolean)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.SignedCms.CheckSignature(System.Boolean)" /> method verifies the digital signatures on the signed CMS/PKCS #7 message and, optionally, validates the signers' certificates.</summary>
<param name="verifySignatureOnly">A <see cref="T:System.Boolean" /> value that specifies whether only the digital signatures are verified without the signers' certificates being validated.
If <paramref name="verifySignatureOnly" /> is <see langword="true" />, only the digital signatures are verified. If it is <see langword="false" />, the digital signatures are verified, the signers' certificates are validated, and the purposes of the certificates are validated. The purposes of a certificate are considered valid if the certificate has no key usage or if the key usage supports digital signatures or nonrepudiation.</param>
<exception cref="T:System.ArgumentNullException">A null reference was passed to a method that does not accept it as a valid argument.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">A cryptographic operation could not be completed.</exception>
<exception cref="T:System.InvalidOperationException">A method call was invalid for the object's current state.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignedCms.CheckSignature(System.Security.Cryptography.X509Certificates.X509Certificate2Collection,System.Boolean)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.SignedCms.CheckSignature(System.Security.Cryptography.X509Certificates.X509Certificate2Collection,System.Boolean)" /> method verifies the digital signatures on the signed CMS/PKCS #7 message by using the specified collection of certificates and, optionally, validates the signers' certificates.</summary>
<param name="extraStore">An <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2Collection" /> object that can be used to validate the certificate chain. If no additional certificates are to be used to validate the certificate chain, use <see cref="M:System.Security.Cryptography.Pkcs.SignedCms.CheckSignature(System.Boolean)" /> instead of <see cref="M:System.Security.Cryptography.Pkcs.SignedCms.CheckSignature(System.Security.Cryptography.X509Certificates.X509Certificate2Collection,System.Boolean)" />.</param>
<param name="verifySignatureOnly">A <see cref="T:System.Boolean" /> value that specifies whether only the digital signatures are verified without the signers' certificates being validated.
If <paramref name="verifySignatureOnly" /> is <see langword="true" />, only the digital signatures are verified. If it is <see langword="false" />, the digital signatures are verified, the signers' certificates are validated, and the purposes of the certificates are validated. The purposes of a certificate are considered valid if the certificate has no key usage or if the key usage supports digital signatures or nonrepudiation.</param>
<exception cref="T:System.ArgumentNullException">A null reference was passed to a method that does not accept it as a valid argument.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">A cryptographic operation could not be completed.</exception>
<exception cref="T:System.InvalidOperationException">A method call was invalid for the object's current state.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignedCms.ComputeSignature">
<summary>Creates a signature and adds the signature to the CMS/PKCS #7 message.</summary>
<exception cref="T:System.InvalidOperationException">.NET Framework (all versions) and .NET Core 3.0 and later: The recipient certificate is not specified.</exception>
<exception cref="T:System.PlatformNotSupportedException">.NET Core version 2.2 and earlier: No signer certificate was provided.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignedCms.ComputeSignature(System.Security.Cryptography.Pkcs.CmsSigner)">
<summary>Creates a signature using the specified signer and adds the signature to the CMS/PKCS #7 message.</summary>
<param name="signer">A <see cref="T:System.Security.Cryptography.Pkcs.CmsSigner" /> object that represents the signer.</param>
<exception cref="T:System.ArgumentNullException">A null reference was passed to a method that does not accept it as a valid argument.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">A cryptographic operation could not be completed.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignedCms.ComputeSignature(System.Security.Cryptography.Pkcs.CmsSigner,System.Boolean)">
<summary>Creates a signature using the specified signer and adds the signature to the CMS/PKCS #7 message.</summary>
<param name="signer">A <see cref="T:System.Security.Cryptography.Pkcs.CmsSigner" /> object that represents the signer.</param>
<param name="silent">.NET Core only: <see langword="true" /> to request opening keys with PIN prompts disabled, where supported; otherwise, <see langword="false" />. In .NET Framework, this parameter is not used and a PIN prompt is always shown, if required.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="signer" /> is <see langword="null" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">A cryptographic operation could not be completed.</exception>
<exception cref="T:System.InvalidOperationException">.NET Framework only: A signing certificate is not specified.</exception>
<exception cref="T:System.PlatformNotSupportedException">.NET Core only: A signing certificate is not specified.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignedCms.Decode(System.Byte[])">
<summary>Decodes an encoded <see cref="T:System.Security.Cryptography.Pkcs.SignedCms" /> message.</summary>
<param name="encodedMessage">An array of byte values that represents the encoded CMS/PKCS#7 message to be decoded.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="encodedMessage" /> is <see langword="null" />.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">
<paramref name="encodedMessage" /> could not be decoded successfully.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignedCms.Decode(System.ReadOnlySpan{System.Byte})">
<param name="encodedMessage">A read-only span of byte values that represents the encoded CMS/PKCS#7 message to be decoded.</param>
<exception cref="T:System.Security.Cryptography.CryptographicException">
<paramref name="encodedMessage" /> could not be decoded successfully.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignedCms.Encode">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.SignedCms.Encode" /> method encodes the information in the object into a CMS/PKCS #7 message.</summary>
<exception cref="T:System.Security.Cryptography.CryptographicException">A cryptographic operation could not be completed.</exception>
<exception cref="T:System.InvalidOperationException">A method call was invalid for the object's current state.</exception>
<returns>An array of byte values that represents the encoded message. The encoded message can be decoded by the <see cref="M:System.Security.Cryptography.Pkcs.SignedCms.Decode(System.Byte[])" /> method.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignedCms.RemoveCertificate(System.Security.Cryptography.X509Certificates.X509Certificate2)">
<summary>Removes the specified certificate from the collection of certificates for the encoded CMS/PKCS #7 message.</summary>
<param name="certificate">The certificate to remove from the collection.</param>
<exception cref="T:System.Security.Cryptography.CryptographicException">The certificate was not found.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignedCms.RemoveSignature(System.Int32)">
<summary>Removes the signature at the specified index of the <see cref="P:System.Security.Cryptography.Pkcs.SignedCms.SignerInfos" /> collection.</summary>
<param name="index">The zero-based index of the signature to remove.</param>
<exception cref="T:System.InvalidOperationException">A CMS/PKCS #7 message is not signed, and <paramref name="index" /> is invalid.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="index" /> is less than zero.
-or-
<paramref name="index" /> is greater than the signature count minus 1.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">The signature could not be removed.
-or-
An internal cryptographic error occurred.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignedCms.RemoveSignature(System.Security.Cryptography.Pkcs.SignerInfo)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.SignedCms.RemoveSignature(System.Security.Cryptography.Pkcs.SignerInfo)" /> method removes the signature for the specified <see cref="T:System.Security.Cryptography.Pkcs.SignerInfo" /> object.</summary>
<param name="signerInfo">A <see cref="T:System.Security.Cryptography.Pkcs.SignerInfo" /> object that represents the countersignature being removed.</param>
<exception cref="T:System.ArgumentNullException">A null reference was passed to a method that does not accept it as a valid argument.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The value of an argument was outside the allowable range of values as defined by the called method.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">A cryptographic operation could not be completed.</exception>
</member>
<member name="P:System.Security.Cryptography.Pkcs.SignedCms.Certificates">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.SignedCms.Certificates" /> property retrieves the certificates associated with the encoded CMS/PKCS #7 message.</summary>
<returns>An <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2Collection" /> collection that represents the set of certificates for the encoded CMS/PKCS #7 message.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.SignedCms.ContentInfo">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.SignedCms.ContentInfo" /> property retrieves the inner contents of the encoded CMS/PKCS #7 message.</summary>
<returns>A <see cref="T:System.Security.Cryptography.Pkcs.ContentInfo" /> object that represents the contents of the encoded CMS/PKCS #7 message.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.SignedCms.Detached">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.SignedCms.Detached" /> property retrieves whether the <see cref="T:System.Security.Cryptography.Pkcs.SignedCms" /> object is for a detached signature.</summary>
<returns>A <see cref="T:System.Boolean" /> value that specifies whether the <see cref="T:System.Security.Cryptography.Pkcs.SignedCms" /> object is for a detached signature. If this property is <see langword="true" />, the signature is detached. If this property is <see langword="false" />, the signature is not detached.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.SignedCms.SignerInfos">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.SignedCms.SignerInfos" /> property retrieves the <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" /> collection associated with the CMS/PKCS #7 message.</summary>
<returns>A <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" /> object that represents the signer information for the CMS/PKCS #7 message.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.SignedCms.Version">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.SignedCms.Version" /> property retrieves the version of the CMS/PKCS #7 message.</summary>
<returns>An int value that represents the CMS/PKCS #7 message version.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.SignerInfo">
<summary>The <see cref="T:System.Security.Cryptography.Pkcs.SignerInfo" /> class represents a signer associated with a <see cref="T:System.Security.Cryptography.Pkcs.SignedCms" /> object that represents a CMS/PKCS #7 message.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignerInfo.AddUnsignedAttribute(System.Security.Cryptography.AsnEncodedData)">
<summary>Adds the specified attribute to the current document.</summary>
<param name="asnEncodedData">The ASN.1 encoded attribute to add to the document.</param>
<exception cref="T:System.Security.Cryptography.CryptographicException">Cannot find the original signer.
-or-
ASN1 corrupted data.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignerInfo.CheckHash">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.SignerInfo.CheckHash" /> method verifies the data integrity of the CMS/PKCS #7 message signer information. <see cref="M:System.Security.Cryptography.Pkcs.SignerInfo.CheckHash" /> is a specialized method used in specific security infrastructure applications in which the subject uses the HashOnly member of the <see cref="T:System.Security.Cryptography.Pkcs.SubjectIdentifierType" /> enumeration when setting up a <see cref="T:System.Security.Cryptography.Pkcs.CmsSigner" /> object. <see cref="M:System.Security.Cryptography.Pkcs.SignerInfo.CheckHash" /> does not authenticate the signer information because this method does not involve verifying a digital signature. For general-purpose checking of the integrity and authenticity of CMS/PKCS #7 message signer information and countersignatures, use the <see cref="M:System.Security.Cryptography.Pkcs.SignerInfo.CheckSignature(System.Boolean)" /> or <see cref="M:System.Security.Cryptography.Pkcs.SignerInfo.CheckSignature(System.Security.Cryptography.X509Certificates.X509Certificate2Collection,System.Boolean)" /> methods.</summary>
<exception cref="T:System.Security.Cryptography.CryptographicException">A cryptographic operation could not be completed.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignerInfo.CheckSignature(System.Boolean)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.SignerInfo.CheckSignature(System.Boolean)" /> method verifies the digital signature of the message and, optionally, validates the certificate.</summary>
<param name="verifySignatureOnly">A bool value that specifies whether only the digital signature is verified. If <paramref name="verifySignatureOnly" /> is <see langword="true" />, only the signature is verified. If <paramref name="verifySignatureOnly" /> is <see langword="false" />, the digital signature is verified, the certificate chain is validated, and the purposes of the certificates are validated. The purposes of the certificate are considered valid if the certificate has no key usage or if the key usage supports digital signature or nonrepudiation.</param>
<exception cref="T:System.ArgumentNullException">A null reference was passed to a method that does not accept it as a valid argument.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">A cryptographic operation could not be completed.</exception>
<exception cref="T:System.InvalidOperationException">A method call was invalid for the object's current state.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignerInfo.CheckSignature(System.Security.Cryptography.X509Certificates.X509Certificate2Collection,System.Boolean)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.SignerInfo.CheckSignature(System.Security.Cryptography.X509Certificates.X509Certificate2Collection,System.Boolean)" /> method verifies the digital signature of the message by using the specified collection of certificates and, optionally, validates the certificate.</summary>
<param name="extraStore">An <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2Collection" /> object that can be used to validate the chain. If no additional certificates are to be used to validate the chain, use <see cref="M:System.Security.Cryptography.Pkcs.SignerInfo.CheckSignature(System.Boolean)" /> instead of <see cref="M:System.Security.Cryptography.Pkcs.SignerInfo.CheckSignature(System.Security.Cryptography.X509Certificates.X509Certificate2Collection,System.Boolean)" />.</param>
<param name="verifySignatureOnly">A bool value that specifies whether only the digital signature is verified. If <paramref name="verifySignatureOnly" /> is <see langword="true" />, only the signature is verified. If <paramref name="verifySignatureOnly" /> is <see langword="false" />, the digital signature is verified, the certificate chain is validated, and the purposes of the certificates are validated. The purposes of the certificate are considered valid if the certificate has no key usage or if the key usage supports digital signature or nonrepudiation.</param>
<exception cref="T:System.ArgumentNullException">A null reference was passed to a method that does not accept it as a valid argument.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">A cryptographic operation could not be completed.</exception>
<exception cref="T:System.InvalidOperationException">A method call was invalid for the object's current state.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignerInfo.ComputeCounterSignature">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.SignerInfo.ComputeCounterSignature" /> method prompts the user to select a signing certificate, creates a countersignature, and adds the signature to the CMS/PKCS #7 message. Countersignatures are restricted to one level.</summary>
<exception cref="T:System.ArgumentNullException">A null reference was passed to a method that does not accept it as a valid argument.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">A cryptographic operation could not be completed.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignerInfo.ComputeCounterSignature(System.Security.Cryptography.Pkcs.CmsSigner)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.SignerInfo.ComputeCounterSignature(System.Security.Cryptography.Pkcs.CmsSigner)" /> method creates a countersignature by using the specified signer and adds the signature to the CMS/PKCS #7 message. Countersignatures are restricted to one level.</summary>
<param name="signer">A <see cref="T:System.Security.Cryptography.Pkcs.CmsSigner" /> object that represents the counter signer.</param>
<exception cref="T:System.ArgumentNullException">A null reference was passed to a method that does not accept it as a valid argument.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">A cryptographic operation could not be completed.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignerInfo.GetSignature">
<summary>Retrieves the signature for the current <see cref="T:System.Security.Cryptography.Pkcs.SignerInfo" /> object.</summary>
<returns>The signature for the current <see cref="T:System.Security.Cryptography.Pkcs.SignerInfo" /> object.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignerInfo.RemoveCounterSignature(System.Int32)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.SignerInfo.RemoveCounterSignature(System.Int32)" /> method removes the countersignature at the specified index of the <see cref="P:System.Security.Cryptography.Pkcs.SignerInfo.CounterSignerInfos" /> collection.</summary>
<param name="index">The zero-based index of the countersignature to remove.</param>
<exception cref="T:System.Security.Cryptography.CryptographicException">A cryptographic operation could not be completed.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignerInfo.RemoveCounterSignature(System.Security.Cryptography.Pkcs.SignerInfo)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.SignerInfo.RemoveCounterSignature(System.Security.Cryptography.Pkcs.SignerInfo)" /> method removes the countersignature for the specified <see cref="T:System.Security.Cryptography.Pkcs.SignerInfo" /> object.</summary>
<param name="counterSignerInfo">A <see cref="T:System.Security.Cryptography.Pkcs.SignerInfo" /> object that represents the countersignature being removed.</param>
<exception cref="T:System.ArgumentNullException">A null reference was passed to a method that does not accept it as a valid argument.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The value of an argument was outside the allowable range of values as defined by the called method.</exception>
<exception cref="T:System.Security.Cryptography.CryptographicException">A cryptographic operation could not be completed.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignerInfo.RemoveUnsignedAttribute(System.Security.Cryptography.AsnEncodedData)">
<summary>Removes the specified attribute from the current document.</summary>
<param name="asnEncodedData">The ASN.1 encoded attribute to remove from the document.</param>
<exception cref="T:System.Security.Cryptography.CryptographicException">Cannot find the original signer.
-or-
Attribute not found.
-or-
ASN1 corrupted data.</exception>
</member>
<member name="P:System.Security.Cryptography.Pkcs.SignerInfo.Certificate">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.SignerInfo.Certificate" /> property retrieves the signing certificate associated with the signer information.</summary>
<returns>An <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2" /> object that represents the signing certificate.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.SignerInfo.CounterSignerInfos">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.SignerInfo.CounterSignerInfos" /> property retrieves the set of counter signers associated with the signer information.</summary>
<returns>A <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" /> collection that represents the counter signers for the signer information. If there are no counter signers, the property is an empty collection.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.SignerInfo.DigestAlgorithm">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.SignerInfo.DigestAlgorithm" /> property retrieves the <see cref="T:System.Security.Cryptography.Oid" /> object that represents the hash algorithm used in the computation of the signatures.</summary>
<returns>An <see cref="T:System.Security.Cryptography.Oid" /> object that represents the hash algorithm used with the signature.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.SignerInfo.SignatureAlgorithm">
<summary>Gets the identifier for the signature algorithm used by the current <see cref="T:System.Security.Cryptography.Pkcs.SignerInfo" /> object.</summary>
<returns>The identifier for the signature algorithm used by the current <see cref="T:System.Security.Cryptography.Pkcs.SignerInfo" /> object.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.SignerInfo.SignedAttributes">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.SignerInfo.SignedAttributes" /> property retrieves the <see cref="T:System.Security.Cryptography.CryptographicAttributeObjectCollection" /> collection of signed attributes that is associated with the signer information. Signed attributes are signed along with the rest of the message content.</summary>
<returns>A <see cref="T:System.Security.Cryptography.CryptographicAttributeObjectCollection" /> collection that represents the signed attributes. If there are no signed attributes, the property is an empty collection.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.SignerInfo.SignerIdentifier">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.SignerInfo.SignerIdentifier" /> property retrieves the certificate identifier of the signer associated with the signer information.</summary>
<returns>A <see cref="T:System.Security.Cryptography.Pkcs.SubjectIdentifier" /> object that uniquely identifies the certificate associated with the signer information.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.SignerInfo.UnsignedAttributes">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.SignerInfo.UnsignedAttributes" /> property retrieves the <see cref="T:System.Security.Cryptography.CryptographicAttributeObjectCollection" /> collection of unsigned attributes that is associated with the <see cref="T:System.Security.Cryptography.Pkcs.SignerInfo" /> content. Unsigned attributes can be modified without invalidating the signature.</summary>
<returns>A <see cref="T:System.Security.Cryptography.CryptographicAttributeObjectCollection" /> collection that represents the unsigned attributes. If there are no unsigned attributes, the property is an empty collection.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.SignerInfo.Version">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.SignerInfo.Version" /> property retrieves the signer information version.</summary>
<returns>An int value that specifies the signer information version.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.SignerInfoCollection">
<summary>The <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" /> class represents a collection of <see cref="T:System.Security.Cryptography.Pkcs.SignerInfo" /> objects. <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" /> implements the <see cref="T:System.Collections.ICollection" /> interface.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignerInfoCollection.CopyTo(System.Array,System.Int32)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.SignerInfoCollection.CopyTo(System.Array,System.Int32)" /> method copies the <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" /> collection to an array.</summary>
<param name="array">An <see cref="T:System.Array" /> object to which the <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" /> collection is to be copied.</param>
<param name="index">The zero-based index in <paramref name="array" /> where the <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" /> collection is copied.</param>
<exception cref="T:System.ArgumentException">One of the arguments provided to a method was not valid.</exception>
<exception cref="T:System.ArgumentNullException">A null reference was passed to a method that does not accept it as a valid argument.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The value of an argument was outside the allowable range of values as defined by the called method.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignerInfoCollection.CopyTo(System.Security.Cryptography.Pkcs.SignerInfo[],System.Int32)">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.SignerInfoCollection.CopyTo(System.Security.Cryptography.Pkcs.SignerInfo[],System.Int32)" /> method copies the <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" /> collection to a <see cref="T:System.Security.Cryptography.Pkcs.SignerInfo" /> array.</summary>
<param name="array">An array of <see cref="T:System.Security.Cryptography.Pkcs.SignerInfo" /> objects where the <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" /> collection is to be copied.</param>
<param name="index">The zero-based index in <paramref name="array" /> where the <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" /> collection is copied.</param>
<exception cref="T:System.ArgumentException">One of the arguments provided to a method was not valid.</exception>
<exception cref="T:System.ArgumentNullException">A null reference was passed to a method that does not accept it as a valid argument.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The value of an argument was outside the allowable range of values as defined by the called method.</exception>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignerInfoCollection.GetEnumerator">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.SignerInfoCollection.GetEnumerator" /> method returns a <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoEnumerator" /> object for the <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" /> collection.</summary>
<returns>A <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoEnumerator" /> object that can be used to enumerate the <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" /> collection.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignerInfoCollection.System#Collections#IEnumerable#GetEnumerator">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.SignerInfoCollection.System#Collections#IEnumerable#GetEnumerator" /> method returns a <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoEnumerator" /> object for the <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" /> collection.</summary>
<returns>A <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoEnumerator" /> object that can be used to enumerate the <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" /> collection.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.SignerInfoCollection.Count">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.SignerInfoCollection.Count" /> property retrieves the number of items in the <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" /> collection.</summary>
<returns>An int value that represents the number of items in the collection.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.SignerInfoCollection.IsSynchronized">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.SignerInfoCollection.IsSynchronized" /> property retrieves whether access to the collection is synchronized, or thread safe. This property always returns <see langword="false" />, which means the collection is not thread safe.</summary>
<returns>A <see cref="T:System.Boolean" /> value of <see langword="false" />, which means the collection is not thread safe.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.SignerInfoCollection.Item(System.Int32)">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.SignerInfoCollection.Item(System.Int32)" /> property retrieves the <see cref="T:System.Security.Cryptography.Pkcs.SignerInfo" /> object at the specified index in the collection.</summary>
<param name="index">An int value that represents the index in the collection. The index is zero based.</param>
<exception cref="T:System.ArgumentOutOfRangeException">The value of an argument was outside the allowable range of values as defined by the called method.</exception>
<returns>A <see cref="T:System.Security.Cryptography.Pkcs.SignerInfo" /> object at the specified index.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.SignerInfoCollection.SyncRoot">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.SignerInfoCollection.SyncRoot" /> property retrieves an <see cref="T:System.Object" /> object is used to synchronize access to the <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" /> collection.</summary>
<returns>An <see cref="T:System.Object" /> object is used to synchronize access to the <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" /> collection.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.SignerInfoEnumerator">
<summary>The <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoEnumerator" /> class provides enumeration functionality for the <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" /> collection. <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoEnumerator" /> implements the <see cref="T:System.Collections.IEnumerator" /> interface.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignerInfoEnumerator.MoveNext">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.SignerInfoEnumerator.MoveNext" /> method advances the enumeration to the next <see cref="T:System.Security.Cryptography.Pkcs.SignerInfo" /> object in the <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" /> collection.</summary>
<returns>This method returns a bool value that specifies whether the enumeration successfully advanced. If the enumeration successfully moved to the next <see cref="T:System.Security.Cryptography.Pkcs.SignerInfo" /> object, the method returns <see langword="true" />. If the enumeration moved past the last item in the enumeration, it returns <see langword="false" />.</returns>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SignerInfoEnumerator.Reset">
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.SignerInfoEnumerator.Reset" /> method resets the enumeration to the first <see cref="T:System.Security.Cryptography.Pkcs.SignerInfo" /> object in the <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" /> collection.</summary>
</member>
<member name="P:System.Security.Cryptography.Pkcs.SignerInfoEnumerator.Current">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.SignerInfoEnumerator.Current" /> property retrieves the current <see cref="T:System.Security.Cryptography.Pkcs.SignerInfo" /> object from the <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" /> collection.</summary>
<returns>A <see cref="T:System.Security.Cryptography.Pkcs.SignerInfo" /> object that represents the current signer information structure in the <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" /> collection.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.SignerInfoEnumerator.System#Collections#IEnumerator#Current">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.SignerInfoEnumerator.System#Collections#IEnumerator#Current" /> property retrieves the current <see cref="T:System.Security.Cryptography.Pkcs.SignerInfo" /> object from the <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" /> collection.</summary>
<returns>A <see cref="T:System.Security.Cryptography.Pkcs.SignerInfo" /> object that represents the current signer information structure in the <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" /> collection.</returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.SubjectIdentifier">
<summary>The <see cref="T:System.Security.Cryptography.Pkcs.SubjectIdentifier" /> class defines the type of the identifier of a subject, such as a <see cref="T:System.Security.Cryptography.Pkcs.CmsSigner" /> or a <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" />. The subject can be identified by the certificate issuer and serial number or the subject key.</summary>
</member>
<member name="M:System.Security.Cryptography.Pkcs.SubjectIdentifier.MatchesCertificate(System.Security.Cryptography.X509Certificates.X509Certificate2)">
<summary>Verifies if the specified certificate's subject identifier matches current subject identifier instance.</summary>
<param name="certificate">The certificate to match with the current subject identifier instance.</param>
<exception cref="T:System.Security.Cryptography.CryptographicException">Invalid subject identifier type.</exception>
<returns>
<see langword="true" /> if the specified certificate's identifier matches the current subject identifier instance; otherwise, <see langword="false" />.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.SubjectIdentifier.Type">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.SubjectIdentifier.Type" /> property retrieves the type of subject identifier. The subject can be identified by the certificate issuer and serial number or the subject key.</summary>
<returns>A member of the <see cref="T:System.Security.Cryptography.Pkcs.SubjectIdentifierType" /> enumeration that identifies the type of subject.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.SubjectIdentifier.Value">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.SubjectIdentifier.Value" /> property retrieves the value of the subject identifier. Use the <see cref="P:System.Security.Cryptography.Pkcs.SubjectIdentifier.Type" /> property to determine the type of subject identifier, and use the <see cref="P:System.Security.Cryptography.Pkcs.SubjectIdentifier.Value" /> property to retrieve the corresponding value.</summary>
<returns>An <see cref="T:System.Object" /> object that represents the value of the subject identifier. This <see cref="T:System.Object" /> can be one of the following objects as determined by the <see cref="P:System.Security.Cryptography.Pkcs.SubjectIdentifier.Type" /> property.
<list type="table"><listheader><term><see cref="P:System.Security.Cryptography.Pkcs.SubjectIdentifier.Type" /> property</term><description> Object</description></listheader><item><term> IssuerAndSerialNumber</term><description><see cref="T:System.Security.Cryptography.Xml.X509IssuerSerial" /></description></item><item><term> SubjectKeyIdentifier</term><description><see cref="T:System.String" /></description></item></list></returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.SubjectIdentifierOrKey">
<summary>The <see cref="T:System.Security.Cryptography.Pkcs.SubjectIdentifierOrKey" /> class defines the type of the identifier of a subject, such as a <see cref="T:System.Security.Cryptography.Pkcs.CmsSigner" /> or a <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" />. The subject can be identified by the certificate issuer and serial number, the hash of the subject key, or the subject key.</summary>
</member>
<member name="P:System.Security.Cryptography.Pkcs.SubjectIdentifierOrKey.Type">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.SubjectIdentifierOrKey.Type" /> property retrieves the type of subject identifier or key. The subject can be identified by the certificate issuer and serial number, the hash of the subject key, or the subject key.</summary>
<returns>A member of the <see cref="T:System.Security.Cryptography.Pkcs.SubjectIdentifierOrKeyType" /> enumeration that specifies the type of subject identifier.</returns>
</member>
<member name="P:System.Security.Cryptography.Pkcs.SubjectIdentifierOrKey.Value">
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.SubjectIdentifierOrKey.Value" /> property retrieves the value of the subject identifier or key. Use the <see cref="P:System.Security.Cryptography.Pkcs.SubjectIdentifierOrKey.Type" /> property to determine the type of subject identifier or key, and use the <see cref="P:System.Security.Cryptography.Pkcs.SubjectIdentifierOrKey.Value" /> property to retrieve the corresponding value.</summary>
<returns>An <see cref="T:System.Object" /> object that represents the value of the subject identifier or key. This <see cref="T:System.Object" /> can be one of the following objects as determined by the <see cref="P:System.Security.Cryptography.Pkcs.SubjectIdentifierOrKey.Type" /> property.
<list type="table"><listheader><term><see cref="P:System.Security.Cryptography.Pkcs.SubjectIdentifierOrKey.Type" /> property</term><description> Object</description></listheader><item><term> IssuerAndSerialNumber</term><description><see cref="T:System.Security.Cryptography.Xml.X509IssuerSerial" /></description></item><item><term> SubjectKeyIdentifier</term><description><see cref="T:System.String" /></description></item><item><term> PublicKeyInfo</term><description><see cref="T:System.Security.Cryptography.Pkcs.PublicKeyInfo" /></description></item></list></returns>
</member>
<member name="T:System.Security.Cryptography.Pkcs.SubjectIdentifierOrKeyType">
<summary>The <see cref="T:System.Security.Cryptography.Pkcs.SubjectIdentifierOrKeyType" /> enumeration defines how a subject is identified.</summary>
</member>
<member name="F:System.Security.Cryptography.Pkcs.SubjectIdentifierOrKeyType.IssuerAndSerialNumber">
<summary>The subject is identified by the certificate issuer and serial number.</summary>
</member>
<member name="F:System.Security.Cryptography.Pkcs.SubjectIdentifierOrKeyType.PublicKeyInfo">
<summary>The subject is identified by the public key.</summary>
</member>
<member name="F:System.Security.Cryptography.Pkcs.SubjectIdentifierOrKeyType.SubjectKeyIdentifier">
<summary>The subject is identified by the hash of the subject key.</summary>
</member>
<member name="F:System.Security.Cryptography.Pkcs.SubjectIdentifierOrKeyType.Unknown">
<summary>The type is unknown.</summary>
</member>
<member name="T:System.Security.Cryptography.Pkcs.SubjectIdentifierType">
<summary>The <see cref="T:System.Security.Cryptography.Pkcs.SubjectIdentifierType" /> enumeration defines the type of subject identifier.</summary>
</member>
<member name="F:System.Security.Cryptography.Pkcs.SubjectIdentifierType.IssuerAndSerialNumber">
<summary>The subject is identified by the certificate issuer and serial number.</summary>
</member>
<member name="F:System.Security.Cryptography.Pkcs.SubjectIdentifierType.NoSignature">
<summary>The subject is identified as taking part in an integrity check operation that uses only a hashing algorithm.</summary>
</member>
<member name="F:System.Security.Cryptography.Pkcs.SubjectIdentifierType.SubjectKeyIdentifier">
<summary>The subject is identified by the hash of the subject's public key. The hash algorithm used is determined by the signature algorithm suite in the subject's certificate.</summary>
</member>
<member name="F:System.Security.Cryptography.Pkcs.SubjectIdentifierType.Unknown">
<summary>The type of subject identifier is unknown.</summary>
</member>
<member name="T:System.Security.Cryptography.Xml.X509IssuerSerial">
<summary>Represents the <<see langword="X509IssuerSerial" />> element of an XML digital signature.</summary>
</member>
<member name="P:System.Security.Cryptography.Xml.X509IssuerSerial.IssuerName">
<summary>Gets or sets an X.509 certificate issuer's distinguished name.</summary>
<returns>An X.509 certificate issuer's distinguished name.</returns>
</member>
<member name="P:System.Security.Cryptography.Xml.X509IssuerSerial.SerialNumber">
<summary>Gets or sets an X.509 certificate issuer's serial number.</summary>
<returns>An X.509 certificate issuer's serial number.</returns>
</member>
</members>
</doc>
md5: 91B5141F40E650DF9F24959E002E6C66 | sha1: AC8675F91A4879042ED660C1D800058185552A57 | sha256: 1C73A1B016CFC8D497106EEC08AF07616F2F4C07E4DDC807C9F120CEACD0A53A | sha512: 6E1F88FC7C1ED560C4CA6168FAE9275583C7D664AF1A70F2A0A97A717D4B7E1D40A33F06B2782BB4ADB47AFC8B30B136DC28C0487A9DAEE183D8156DE5E5161B
Log in or click on link to see number of positives.
- System.Security.Cryptography.ProtectedData.dll (1c73a1b016cf) - ## / 71
- System.Security.Cryptography.ProtectedData.dll (81a0385cf1fe) - ## / 71
- Microsoft.CodeAnalysis.dll (11e97ff5fb88) - ## / 62
- Microsoft.CodeAnalysis.resources.dll (491e8493bc93) - ## / 66
- Microsoft.CodeAnalysis.resources.dll (a4e03df29991) - ## / 66
- Microsoft.CodeAnalysis.resources.dll (784f2f17a809) - ## / 66
- Microsoft.CodeAnalysis.resources.dll (21aebc6b5124) - ## / 67
- Microsoft.CodeAnalysis.resources.dll (ae609da7d2dc) - ## / 70
- Microsoft.CodeAnalysis.resources.dll (0b70f2e60eeb) - ## / 69
- Microsoft.CodeAnalysis.resources.dll (adbdf9f561e9) - ## / 66
- Microsoft.CodeAnalysis.resources.dll (e66dd1c4ed1a) - ## / 70
- Microsoft.CodeAnalysis.resources.dll (00439950c7db) - ## / 68
- Microsoft.CodeAnalysis.resources.dll (39a6cc83bccd) - ## / 71
- Microsoft.CodeAnalysis.resources.dll (e4f0e9e4aa3a) - ## / 68
- Microsoft.CodeAnalysis.resources.dll (3ced24815d2f) - ## / 71
- Microsoft.CodeAnalysis.resources.dll (b962cdc66a84) - ## / 70
- Newtonsoft.Json.dll (72cf291d4bab) - ## / 71
- Mono.Cecil.dll (769a59793d4b) - ## / 70
- Mono.Cecil.Mdb.dll (61637f9940e5) - ## / 71
- Mono.Cecil.Pdb.dll (a5249a04ad8f) - ## / 71
- Mono.Cecil.Rocks.dll (273292babd45) - ## / 71
- System.Security.Cryptography.Pkcs.dll (d3a023c0207b) - ## / 70
- System.Security.Cryptography.Pkcs.dll (dcd6223fbbbc) - ## / 70
- NuGet.Common.dll (7f4819f271c8) - ## / 67
- NuGet.Configuration.dll (25cc4a79780e) - ## / 71
- NuGet.Frameworks.dll (152a0ee6635e) - ## / 70
- NuGet.Packaging.dll (89d177d84760) - ## / 71
- NuGet.Protocol.dll (99ce0f9d62e7) - ## / 67
- NuGet.Resolver.dll (0ef404ee2edf) - ## / 71
- NuGet.Versioning.dll (0308c50e0e35) - ## / 71
- cake-bakery.portable.0.13.0.nupkg (009c86953c2e) - ## / 64
- Basic.Reference.Assemblies.Net60.dll (bcaa3fc9040d) - ## / 71
- Cake.Bakery.dll (0f41319f900f) - ## / 72
- Cake.Bakery.exe (2cb0886e68a3) - ## / 71
- Cake.Common.dll (b29998f8d87a) - ## / 71
- Cake.Core.dll (03c3772c71f4) - ## / 71
- Cake.NuGet.dll (931baedac5c3) - ## / 46
- Cake.Scripting.Abstractions.dll (9a405a45bff0) - ## / 71
- Cake.Scripting.dll (3afd8d5be4fc) - ## / 71
- Cake.Scripting.Transport.dll (bd39ed8f19f3) - ## / 71
- Microsoft.Extensions.DependencyInjection.Abstractions.dll (087813b2f935) - ## / 69
- Microsoft.Extensions.DependencyInjection.dll (f8fe8bedbede) - ## / 69
- Microsoft.Extensions.Logging.Abstractions.dll (b4bf70c7e2aa) - ## / 69
- Microsoft.Extensions.Logging.dll (6833a9076b9a) - ## / 68
- Microsoft.Extensions.Options.dll (792765a31e12) - ## / 70
- Microsoft.Extensions.Primitives.dll (8578454489a4) - ## / 66
In cases where actual malware is found, the packages are subject to removal. Software sometimes has false positives. Moderators do not necessarily validate the safety of the underlying software, only that a package retrieves software from the official distribution point and/or validate embedded software against official distribution point (where distribution rights allow redistribution).
Chocolatey Pro provides runtime protection from possible malware.
Add to Builder | Version | Downloads | Last Updated | Status |
---|---|---|---|---|
Cake-Bakery.Portable 0.16.0 | 70 | Sunday, November 19, 2023 | Approved | |
Cake-Bakery.Portable 0.15.0 | 29 | Monday, November 13, 2023 | Approved | |
Cake-Bakery.Portable 0.14.0 | 65 | Sunday, July 9, 2023 | Approved | |
Cake-Bakery.Portable 0.13.0 | 142 | Wednesday, November 9, 2022 | Approved | |
Cake-Bakery.Portable 0.12.0 | 53 | Friday, October 14, 2022 | Approved | |
Cake-Bakery.Portable 0.11.0 | 117 | Friday, April 15, 2022 | Approved | |
Cake-Bakery.Portable 0.10.0 | 60 | Tuesday, March 29, 2022 | Approved | |
Cake-Bakery.Portable 0.9.2 | 92 | Sunday, December 12, 2021 | Approved | |
Cake-Bakery.Portable 0.9.1 | 62 | Saturday, December 11, 2021 | Approved | |
Cake-Bakery.Portable 0.9.0 | 85 | Wednesday, December 1, 2021 | Approved | |
Cake-Bakery.Portable 0.9.0-beta0002 | 50 | Saturday, November 27, 2021 | Approved | |
Cake-Bakery.Portable 0.9.0-beta0001 | 53 | Friday, November 26, 2021 | Approved | |
Cake-Bakery.Portable 0.8.1 | 69 | Thursday, November 25, 2021 | Approved | |
Cake-Bakery.Portable 0.8.0 | 75 | Wednesday, November 24, 2021 | Approved | |
Cake-Bakery.Portable 0.7.2 | 72 | Sunday, November 14, 2021 | Approved | |
Cake-Bakery.Portable 0.7.1 | 47 | Saturday, November 13, 2021 | Approved | |
Cake-Bakery.Portable 0.7.0 | 68 | Thursday, November 11, 2021 | Approved | |
Cake-Bakery.Portable 0.6.5 | 74 | Thursday, October 14, 2021 | Approved | |
Cake-Bakery.Portable 0.6.4 | 124 | Friday, April 30, 2021 | Approved | |
Cake-Bakery.Portable 0.6.2 | 94 | Monday, March 8, 2021 | Approved | |
Cake-Bakery.Portable 0.6.1 | 73 | Sunday, March 7, 2021 | Approved | |
Cake-Bakery.Portable 0.6.0 | 64 | Saturday, March 6, 2021 | Approved | |
Cake-Bakery.Portable 0.5.1 | 134 | Thursday, November 19, 2020 | Approved | |
Cake-Bakery.Portable 0.5.0 | 96 | Thursday, November 19, 2020 | Approved | |
Cake-Bakery.Portable 0.4.1 | 438 | Sunday, March 17, 2019 | Approved | |
Cake-Bakery.Portable 0.4.0 | 149 | Saturday, March 16, 2019 | Approved |
Copyright (c) .NET Foundation and contributors
This package has no dependencies.
Ground Rules:
- This discussion is only about Cake-Bakery.Portable and the Cake-Bakery.Portable package. If you have feedback for Chocolatey, please contact the Google Group.
- This discussion will carry over multiple versions. If you have a comment about a particular version, please note that in your comments.
- The maintainers of this Chocolatey Package will be notified about new comments that are posted to this Disqus thread, however, it is NOT a guarantee that you will get a response. If you do not hear back from the maintainers after posting a message below, please follow up by using the link on the left side of this page or follow this link to contact maintainers. If you still hear nothing back, please follow the package triage process.
- Tell us what you love about the package or Cake-Bakery.Portable, or tell us what needs improvement.
- Share your experiences with the package, or extra configuration or gotchas that you've found.
- If you use a url, the comment will be flagged for moderation until you've been whitelisted. Disqus moderated comments are approved on a weekly schedule if not sooner. It could take between 1-5 days for your comment to show up.