Microsoft.Extensions.Configuration.Json.xml 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.Extensions.Configuration.Json</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Microsoft.Extensions.Configuration.JsonConfigurationExtensions">
  8. <summary>
  9. Extension methods for adding <see cref="T:Microsoft.Extensions.Configuration.Json.JsonConfigurationProvider"/>.
  10. </summary>
  11. </member>
  12. <member name="M:Microsoft.Extensions.Configuration.JsonConfigurationExtensions.AddJsonFile(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.String)">
  13. <summary>
  14. Adds the JSON configuration provider at <paramref name="path"/> to <paramref name="builder"/>.
  15. </summary>
  16. <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
  17. <param name="path">Path relative to the base path stored in
  18. <see cref="P:Microsoft.Extensions.Configuration.IConfigurationBuilder.Properties"/> of <paramref name="builder"/>.</param>
  19. <returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
  20. </member>
  21. <member name="M:Microsoft.Extensions.Configuration.JsonConfigurationExtensions.AddJsonFile(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.String,System.Boolean)">
  22. <summary>
  23. Adds the JSON configuration provider at <paramref name="path"/> to <paramref name="builder"/>.
  24. </summary>
  25. <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
  26. <param name="path">Path relative to the base path stored in
  27. <see cref="P:Microsoft.Extensions.Configuration.IConfigurationBuilder.Properties"/> of <paramref name="builder"/>.</param>
  28. <param name="optional">Whether the file is optional.</param>
  29. <returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
  30. </member>
  31. <member name="M:Microsoft.Extensions.Configuration.JsonConfigurationExtensions.AddJsonFile(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.String,System.Boolean,System.Boolean)">
  32. <summary>
  33. Adds the JSON configuration provider at <paramref name="path"/> to <paramref name="builder"/>.
  34. </summary>
  35. <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
  36. <param name="path">Path relative to the base path stored in
  37. <see cref="P:Microsoft.Extensions.Configuration.IConfigurationBuilder.Properties"/> of <paramref name="builder"/>.</param>
  38. <param name="optional">Whether the file is optional.</param>
  39. <param name="reloadOnChange">Whether the configuration should be reloaded if the file changes.</param>
  40. <returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
  41. </member>
  42. <member name="M:Microsoft.Extensions.Configuration.JsonConfigurationExtensions.AddJsonFile(Microsoft.Extensions.Configuration.IConfigurationBuilder,Microsoft.Extensions.FileProviders.IFileProvider,System.String,System.Boolean,System.Boolean)">
  43. <summary>
  44. Adds a JSON configuration source to <paramref name="builder"/>.
  45. </summary>
  46. <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
  47. <param name="provider">The <see cref="T:Microsoft.Extensions.FileProviders.IFileProvider"/> to use to access the file.</param>
  48. <param name="path">Path relative to the base path stored in
  49. <see cref="P:Microsoft.Extensions.Configuration.IConfigurationBuilder.Properties"/> of <paramref name="builder"/>.</param>
  50. <param name="optional">Whether the file is optional.</param>
  51. <param name="reloadOnChange">Whether the configuration should be reloaded if the file changes.</param>
  52. <returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
  53. </member>
  54. <member name="M:Microsoft.Extensions.Configuration.JsonConfigurationExtensions.AddJsonFile(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Action{Microsoft.Extensions.Configuration.Json.JsonConfigurationSource})">
  55. <summary>
  56. Adds a JSON configuration source to <paramref name="builder"/>.
  57. </summary>
  58. <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
  59. <param name="configureSource">Configures the source.</param>
  60. <returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
  61. </member>
  62. <member name="M:Microsoft.Extensions.Configuration.JsonConfigurationExtensions.AddJsonStream(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.IO.Stream)">
  63. <summary>
  64. Adds a JSON configuration source to <paramref name="builder"/>.
  65. </summary>
  66. <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
  67. <param name="stream">The <see cref="T:System.IO.Stream"/> to read the json configuration data from.</param>
  68. <returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
  69. </member>
  70. <member name="T:Microsoft.Extensions.Configuration.Json.JsonConfigurationProvider">
  71. <summary>
  72. A JSON file based <see cref="T:Microsoft.Extensions.Configuration.FileConfigurationProvider"/>.
  73. </summary>
  74. </member>
  75. <member name="M:Microsoft.Extensions.Configuration.Json.JsonConfigurationProvider.#ctor(Microsoft.Extensions.Configuration.Json.JsonConfigurationSource)">
  76. <summary>
  77. Initializes a new instance with the specified source.
  78. </summary>
  79. <param name="source">The source settings.</param>
  80. </member>
  81. <member name="M:Microsoft.Extensions.Configuration.Json.JsonConfigurationProvider.Load(System.IO.Stream)">
  82. <summary>
  83. Loads the JSON data from a stream.
  84. </summary>
  85. <param name="stream">The stream to read.</param>
  86. </member>
  87. <member name="T:Microsoft.Extensions.Configuration.Json.JsonConfigurationSource">
  88. <summary>
  89. Represents a JSON file as an <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSource"/>.
  90. </summary>
  91. </member>
  92. <member name="M:Microsoft.Extensions.Configuration.Json.JsonConfigurationSource.Build(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
  93. <summary>
  94. Builds the <see cref="T:Microsoft.Extensions.Configuration.Json.JsonConfigurationProvider"/> for this source.
  95. </summary>
  96. <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>
  97. <returns>A <see cref="T:Microsoft.Extensions.Configuration.Json.JsonConfigurationProvider"/></returns>
  98. </member>
  99. <member name="T:Microsoft.Extensions.Configuration.Json.JsonStreamConfigurationProvider">
  100. <summary>
  101. Loads configuration key/values from a json stream into a provider.
  102. </summary>
  103. </member>
  104. <member name="M:Microsoft.Extensions.Configuration.Json.JsonStreamConfigurationProvider.#ctor(Microsoft.Extensions.Configuration.Json.JsonStreamConfigurationSource)">
  105. <summary>
  106. Constructor.
  107. </summary>
  108. <param name="source">The <see cref="T:Microsoft.Extensions.Configuration.Json.JsonStreamConfigurationSource"/>.</param>
  109. </member>
  110. <member name="M:Microsoft.Extensions.Configuration.Json.JsonStreamConfigurationProvider.Load(System.IO.Stream)">
  111. <summary>
  112. Loads json configuration key/values from a stream into a provider.
  113. </summary>
  114. <param name="stream">The json <see cref="T:System.IO.Stream"/> to load configuration data from.</param>
  115. </member>
  116. <member name="T:Microsoft.Extensions.Configuration.Json.JsonStreamConfigurationSource">
  117. <summary>
  118. Represents a JSON file as an <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSource"/>.
  119. </summary>
  120. </member>
  121. <member name="M:Microsoft.Extensions.Configuration.Json.JsonStreamConfigurationSource.Build(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
  122. <summary>
  123. Builds the <see cref="T:Microsoft.Extensions.Configuration.Json.JsonStreamConfigurationProvider"/> for this source.
  124. </summary>
  125. <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>
  126. <returns>An <see cref="T:Microsoft.Extensions.Configuration.Json.JsonStreamConfigurationProvider"/></returns>
  127. </member>
  128. <member name="M:System.ThrowHelper.ThrowIfNull(System.Object,System.String)">
  129. <summary>Throws an <see cref="T:System.ArgumentNullException"/> if <paramref name="argument"/> is null.</summary>
  130. <param name="argument">The reference type argument to validate as non-null.</param>
  131. <param name="paramName">The name of the parameter with which <paramref name="argument"/> corresponds.</param>
  132. </member>
  133. <member name="M:System.ThrowHelper.IfNullOrWhitespace(System.String,System.String)">
  134. <summary>
  135. Throws either an <see cref="T:System.ArgumentNullException"/> or an <see cref="T:System.ArgumentException"/>
  136. if the specified string is <see langword="null"/> or whitespace respectively.
  137. </summary>
  138. <param name="argument">String to be checked for <see langword="null"/> or whitespace.</param>
  139. <param name="paramName">The name of the parameter being checked.</param>
  140. <returns>The original value of <paramref name="argument"/>.</returns>
  141. </member>
  142. <member name="P:System.SR.Error_InvalidFilePath">
  143. <summary>File path must be a non-empty string.</summary>
  144. </member>
  145. <member name="P:System.SR.Error_InvalidTopLevelJSONElement">
  146. <summary>Top-level JSON element must be an object. Instead, '{0}' was found.</summary>
  147. </member>
  148. <member name="P:System.SR.Error_JSONParseError">
  149. <summary>Could not parse the JSON file.</summary>
  150. </member>
  151. <member name="P:System.SR.Error_KeyIsDuplicated">
  152. <summary>A duplicate key '{0}' was found.</summary>
  153. </member>
  154. <member name="P:System.SR.Error_UnsupportedJSONToken">
  155. <summary>Unsupported JSON token '{0}' was found.</summary>
  156. </member>
  157. </members>
  158. </doc>