Microsoft.Extensions.Configuration.Json.xml 8.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132
  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="T:Microsoft.Extensions.Configuration.Json.JsonConfigurationProvider">
  63. <summary>
  64. A JSON file based <see cref="T:Microsoft.Extensions.Configuration.FileConfigurationProvider"/>.
  65. </summary>
  66. </member>
  67. <member name="M:Microsoft.Extensions.Configuration.Json.JsonConfigurationProvider.#ctor(Microsoft.Extensions.Configuration.Json.JsonConfigurationSource)">
  68. <summary>
  69. Initializes a new instance with the specified source.
  70. </summary>
  71. <param name="source">The source settings.</param>
  72. </member>
  73. <member name="M:Microsoft.Extensions.Configuration.Json.JsonConfigurationProvider.Load(System.IO.Stream)">
  74. <summary>
  75. Loads the JSON data from a stream.
  76. </summary>
  77. <param name="stream">The stream to read.</param>
  78. </member>
  79. <member name="T:Microsoft.Extensions.Configuration.Json.JsonConfigurationSource">
  80. <summary>
  81. Represents a JSON file as an <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSource"/>.
  82. </summary>
  83. </member>
  84. <member name="M:Microsoft.Extensions.Configuration.Json.JsonConfigurationSource.Build(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
  85. <summary>
  86. Builds the <see cref="T:Microsoft.Extensions.Configuration.Json.JsonConfigurationProvider"/> for this source.
  87. </summary>
  88. <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>
  89. <returns>A <see cref="T:Microsoft.Extensions.Configuration.Json.JsonConfigurationProvider"/></returns>
  90. </member>
  91. <member name="P:Microsoft.Extensions.Configuration.Json.Resources.Error_InvalidFilePath">
  92. <summary>
  93. File path must be a non-empty string.
  94. </summary>
  95. </member>
  96. <member name="M:Microsoft.Extensions.Configuration.Json.Resources.FormatError_InvalidFilePath">
  97. <summary>
  98. File path must be a non-empty string.
  99. </summary>
  100. </member>
  101. <member name="P:Microsoft.Extensions.Configuration.Json.Resources.Error_JSONParseError">
  102. <summary>
  103. Could not parse the JSON file. Error on line number '{0}': '{1}'.
  104. </summary>
  105. </member>
  106. <member name="M:Microsoft.Extensions.Configuration.Json.Resources.FormatError_JSONParseError(System.Object,System.Object)">
  107. <summary>
  108. Could not parse the JSON file. Error on line number '{0}': '{1}'.
  109. </summary>
  110. </member>
  111. <member name="P:Microsoft.Extensions.Configuration.Json.Resources.Error_KeyIsDuplicated">
  112. <summary>
  113. A duplicate key '{0}' was found.
  114. </summary>
  115. </member>
  116. <member name="M:Microsoft.Extensions.Configuration.Json.Resources.FormatError_KeyIsDuplicated(System.Object)">
  117. <summary>
  118. A duplicate key '{0}' was found.
  119. </summary>
  120. </member>
  121. <member name="P:Microsoft.Extensions.Configuration.Json.Resources.Error_UnsupportedJSONToken">
  122. <summary>
  123. Unsupported JSON token '{0}' was found. Path '{1}', line {2} position {3}.
  124. </summary>
  125. </member>
  126. <member name="M:Microsoft.Extensions.Configuration.Json.Resources.FormatError_UnsupportedJSONToken(System.Object,System.Object,System.Object,System.Object)">
  127. <summary>
  128. Unsupported JSON token '{0}' was found. Path '{1}', line {2} position {3}.
  129. </summary>
  130. </member>
  131. </members>
  132. </doc>