Microsoft.AspNetCore.Mvc.ApiExplorer.xml 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.AspNetCore.Mvc.ApiExplorer</name>
  5. </assembly>
  6. <members>
  7. <member name="M:Microsoft.Extensions.Internal.PropertyHelper.#ctor(System.Reflection.PropertyInfo)">
  8. <summary>
  9. Initializes a fast <see cref="T:Microsoft.Extensions.Internal.PropertyHelper"/>.
  10. This constructor does not cache the helper. For caching, use <see cref="M:Microsoft.Extensions.Internal.PropertyHelper.GetProperties(System.Type)"/>.
  11. </summary>
  12. </member>
  13. <member name="P:Microsoft.Extensions.Internal.PropertyHelper.Property">
  14. <summary>
  15. Gets the backing <see cref="T:System.Reflection.PropertyInfo"/>.
  16. </summary>
  17. </member>
  18. <member name="P:Microsoft.Extensions.Internal.PropertyHelper.Name">
  19. <summary>
  20. Gets (or sets in derived types) the property name.
  21. </summary>
  22. </member>
  23. <member name="P:Microsoft.Extensions.Internal.PropertyHelper.ValueGetter">
  24. <summary>
  25. Gets the property value getter.
  26. </summary>
  27. </member>
  28. <member name="P:Microsoft.Extensions.Internal.PropertyHelper.ValueSetter">
  29. <summary>
  30. Gets the property value setter.
  31. </summary>
  32. </member>
  33. <member name="M:Microsoft.Extensions.Internal.PropertyHelper.GetValue(System.Object)">
  34. <summary>
  35. Returns the property value for the specified <paramref name="instance"/>.
  36. </summary>
  37. <param name="instance">The object whose property value will be returned.</param>
  38. <returns>The property value.</returns>
  39. </member>
  40. <member name="M:Microsoft.Extensions.Internal.PropertyHelper.SetValue(System.Object,System.Object)">
  41. <summary>
  42. Sets the property value for the specified <paramref name="instance" />.
  43. </summary>
  44. <param name="instance">The object whose property value will be set.</param>
  45. <param name="value">The property value.</param>
  46. </member>
  47. <member name="M:Microsoft.Extensions.Internal.PropertyHelper.GetProperties(System.Reflection.TypeInfo)">
  48. <summary>
  49. Creates and caches fast property helpers that expose getters for every public get property on the
  50. underlying type.
  51. </summary>
  52. <param name="typeInfo">The type info to extract property accessors for.</param>
  53. <returns>A cached array of all public properties of the specified type.
  54. </returns>
  55. </member>
  56. <member name="M:Microsoft.Extensions.Internal.PropertyHelper.GetProperties(System.Type)">
  57. <summary>
  58. Creates and caches fast property helpers that expose getters for every public get property on the
  59. specified type.
  60. </summary>
  61. <param name="type">The type to extract property accessors for.</param>
  62. <returns>A cached array of all public properties of the specified type.
  63. </returns>
  64. </member>
  65. <member name="M:Microsoft.Extensions.Internal.PropertyHelper.GetVisibleProperties(System.Reflection.TypeInfo)">
  66. <summary>
  67. <para>
  68. Creates and caches fast property helpers that expose getters for every non-hidden get property
  69. on the specified type.
  70. </para>
  71. <para>
  72. <see cref="M:GetVisibleProperties"/> excludes properties defined on base types that have been
  73. hidden by definitions using the <c>new</c> keyword.
  74. </para>
  75. </summary>
  76. <param name="typeInfo">The type info to extract property accessors for.</param>
  77. <returns>
  78. A cached array of all public properties of the specified type.
  79. </returns>
  80. </member>
  81. <member name="M:Microsoft.Extensions.Internal.PropertyHelper.GetVisibleProperties(System.Type)">
  82. <summary>
  83. <para>
  84. Creates and caches fast property helpers that expose getters for every non-hidden get property
  85. on the specified type.
  86. </para>
  87. <para>
  88. <see cref="M:GetVisibleProperties"/> excludes properties defined on base types that have been
  89. hidden by definitions using the <c>new</c> keyword.
  90. </para>
  91. </summary>
  92. <param name="type">The type to extract property accessors for.</param>
  93. <returns>
  94. A cached array of all public properties of the specified type.
  95. </returns>
  96. </member>
  97. <member name="M:Microsoft.Extensions.Internal.PropertyHelper.MakeFastPropertyGetter(System.Reflection.PropertyInfo)">
  98. <summary>
  99. Creates a single fast property getter. The result is not cached.
  100. </summary>
  101. <param name="propertyInfo">propertyInfo to extract the getter for.</param>
  102. <returns>a fast getter.</returns>
  103. <remarks>
  104. This method is more memory efficient than a dynamically compiled lambda, and about the
  105. same speed.
  106. </remarks>
  107. </member>
  108. <member name="M:Microsoft.Extensions.Internal.PropertyHelper.MakeNullSafeFastPropertyGetter(System.Reflection.PropertyInfo)">
  109. <summary>
  110. Creates a single fast property getter which is safe for a null input object. The result is not cached.
  111. </summary>
  112. <param name="propertyInfo">propertyInfo to extract the getter for.</param>
  113. <returns>a fast getter.</returns>
  114. <remarks>
  115. This method is more memory efficient than a dynamically compiled lambda, and about the
  116. same speed.
  117. </remarks>
  118. </member>
  119. <member name="M:Microsoft.Extensions.Internal.PropertyHelper.MakeFastPropertySetter(System.Reflection.PropertyInfo)">
  120. <summary>
  121. Creates a single fast property setter for reference types. The result is not cached.
  122. </summary>
  123. <param name="propertyInfo">propertyInfo to extract the setter for.</param>
  124. <returns>a fast getter.</returns>
  125. <remarks>
  126. This method is more memory efficient than a dynamically compiled lambda, and about the
  127. same speed. This only works for reference types.
  128. </remarks>
  129. </member>
  130. <member name="M:Microsoft.Extensions.Internal.PropertyHelper.ObjectToDictionary(System.Object)">
  131. <summary>
  132. Given an object, adds each instance property with a public get method as a key and its
  133. associated value to a dictionary.
  134. If the object is already an <see cref="T:System.Collections.Generic.IDictionary`2"/> instance, then a copy
  135. is returned.
  136. </summary>
  137. <remarks>
  138. The implementation of PropertyHelper will cache the property accessors per-type. This is
  139. faster when the same type is used multiple times with ObjectToDictionary.
  140. </remarks>
  141. </member>
  142. <member name="T:Microsoft.Extensions.Internal.ClosedGenericMatcher">
  143. <summary>
  144. Helper related to generic interface definitions and implementing classes.
  145. </summary>
  146. </member>
  147. <member name="M:Microsoft.Extensions.Internal.ClosedGenericMatcher.ExtractGenericInterface(System.Type,System.Type)">
  148. <summary>
  149. Determine whether <paramref name="queryType"/> is or implements a closed generic <see cref="T:System.Type"/>
  150. created from <paramref name="interfaceType"/>.
  151. </summary>
  152. <param name="queryType">The <see cref="T:System.Type"/> of interest.</param>
  153. <param name="interfaceType">The open generic <see cref="T:System.Type"/> to match. Usually an interface.</param>
  154. <returns>
  155. The closed generic <see cref="T:System.Type"/> created from <paramref name="interfaceType"/> that
  156. <paramref name="queryType"/> is or implements. <c>null</c> if the two <see cref="T:System.Type"/>s have no such
  157. relationship.
  158. </returns>
  159. <remarks>
  160. This method will return <paramref name="queryType"/> if <paramref name="interfaceType"/> is
  161. <c>typeof(KeyValuePair{,})</c>, and <paramref name="queryType"/> is
  162. <c>typeof(KeyValuePair{string, object})</c>.
  163. </remarks>
  164. </member>
  165. <member name="T:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionExtensions">
  166. <summary>
  167. Extension methods for <see cref="T:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescription"/>.
  168. </summary>
  169. </member>
  170. <member name="M:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionExtensions.GetProperty``1(Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescription)">
  171. <summary>
  172. Gets the value of a property from the <see cref="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescription.Properties"/> collection
  173. using the provided value of <typeparamref name="T"/> as the key.
  174. </summary>
  175. <typeparam name="T">The type of the property.</typeparam>
  176. <param name="apiDescription">The <see cref="T:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescription"/>.</param>
  177. <returns>The property or the default value of <typeparamref name="T"/>.</returns>
  178. </member>
  179. <member name="M:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionExtensions.SetProperty``1(Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescription,``0)">
  180. <summary>
  181. Sets the value of an property in the <see cref="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescription.Properties"/> collection using
  182. the provided value of <typeparamref name="T"/> as the key.
  183. </summary>
  184. <typeparam name="T">The type of the property.</typeparam>
  185. <param name="apiDescription">The <see cref="T:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescription"/>.</param>
  186. <param name="value">The value of the property.</param>
  187. </member>
  188. <member name="T:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionGroup">
  189. <summary>
  190. Represents a group of related apis.
  191. </summary>
  192. </member>
  193. <member name="M:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionGroup.#ctor(System.String,System.Collections.Generic.IReadOnlyList{Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescription})">
  194. <summary>
  195. Creates a new <see cref="T:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionGroup"/>.
  196. </summary>
  197. <param name="groupName">The group name.</param>
  198. <param name="items">A collection of <see cref="T:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescription"/> items for this group.</param>
  199. </member>
  200. <member name="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionGroup.GroupName">
  201. <summary>
  202. The group name.
  203. </summary>
  204. </member>
  205. <member name="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionGroup.Items">
  206. <summary>
  207. A collection of <see cref="T:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescription"/> items for this group.
  208. </summary>
  209. </member>
  210. <member name="T:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionGroupCollection">
  211. <summary>
  212. A cached collection of <see cref="T:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionGroup" />.
  213. </summary>
  214. </member>
  215. <member name="M:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionGroupCollection.#ctor(System.Collections.Generic.IReadOnlyList{Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionGroup},System.Int32)">
  216. <summary>
  217. Initializes a new instance of the <see cref="T:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionGroupCollection"/>.
  218. </summary>
  219. <param name="items">The list of <see cref="T:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionGroup"/>.</param>
  220. <param name="version">The unique version of discovered groups.</param>
  221. </member>
  222. <member name="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionGroupCollection.Items">
  223. <summary>
  224. Returns the list of <see cref="T:System.Collections.Generic.IReadOnlyList`1"/>.
  225. </summary>
  226. </member>
  227. <member name="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionGroupCollection.Version">
  228. <summary>
  229. Returns the unique version of the current items.
  230. </summary>
  231. </member>
  232. <member name="T:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionGroupCollectionProvider">
  233. <inheritdoc />
  234. </member>
  235. <member name="M:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionGroupCollectionProvider.#ctor(Microsoft.AspNetCore.Mvc.Infrastructure.IActionDescriptorCollectionProvider,System.Collections.Generic.IEnumerable{Microsoft.AspNetCore.Mvc.ApiExplorer.IApiDescriptionProvider})">
  236. <summary>
  237. Creates a new instance of <see cref="T:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionGroupCollectionProvider"/>.
  238. </summary>
  239. <param name="actionDescriptorCollectionProvider">
  240. The <see cref="T:Microsoft.AspNetCore.Mvc.Infrastructure.IActionDescriptorCollectionProvider"/>.
  241. </param>
  242. <param name="apiDescriptionProviders">
  243. The <see cref="T:System.Collections.Generic.IEnumerable`1"/>.
  244. </param>
  245. </member>
  246. <member name="P:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionGroupCollectionProvider.ApiDescriptionGroups">
  247. <inheritdoc />
  248. </member>
  249. <member name="T:Microsoft.AspNetCore.Mvc.ApiExplorer.DefaultApiDescriptionProvider">
  250. <summary>
  251. Implements a provider of <see cref="T:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescription"/> for actions represented
  252. by <see cref="T:Microsoft.AspNetCore.Mvc.Controllers.ControllerActionDescriptor"/>.
  253. </summary>
  254. </member>
  255. <member name="M:Microsoft.AspNetCore.Mvc.ApiExplorer.DefaultApiDescriptionProvider.#ctor(Microsoft.Extensions.Options.IOptions{Microsoft.AspNetCore.Mvc.MvcOptions},Microsoft.AspNetCore.Routing.IInlineConstraintResolver,Microsoft.AspNetCore.Mvc.ModelBinding.IModelMetadataProvider)">
  256. <summary>
  257. Creates a new instance of <see cref="T:Microsoft.AspNetCore.Mvc.ApiExplorer.DefaultApiDescriptionProvider"/>.
  258. </summary>
  259. <param name="optionsAccessor">The accessor for <see cref="T:Microsoft.AspNetCore.Mvc.MvcOptions"/>.</param>
  260. <param name="constraintResolver">The <see cref="T:Microsoft.AspNetCore.Routing.IInlineConstraintResolver"/> used for resolving inline
  261. constraints.</param>
  262. <param name="modelMetadataProvider">The <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.IModelMetadataProvider"/>.</param>
  263. </member>
  264. <member name="M:Microsoft.AspNetCore.Mvc.ApiExplorer.DefaultApiDescriptionProvider.#ctor(Microsoft.Extensions.Options.IOptions{Microsoft.AspNetCore.Mvc.MvcOptions},Microsoft.AspNetCore.Routing.IInlineConstraintResolver,Microsoft.AspNetCore.Mvc.ModelBinding.IModelMetadataProvider,Microsoft.AspNetCore.Mvc.Infrastructure.IActionResultTypeMapper)">
  265. <summary>
  266. Creates a new instance of <see cref="T:Microsoft.AspNetCore.Mvc.ApiExplorer.DefaultApiDescriptionProvider"/>.
  267. </summary>
  268. <param name="optionsAccessor">The accessor for <see cref="T:Microsoft.AspNetCore.Mvc.MvcOptions"/>.</param>
  269. <param name="constraintResolver">The <see cref="T:Microsoft.AspNetCore.Routing.IInlineConstraintResolver"/> used for resolving inline
  270. constraints.</param>
  271. <param name="modelMetadataProvider">The <see cref="T:Microsoft.AspNetCore.Mvc.ModelBinding.IModelMetadataProvider"/>.</param>
  272. <param name="mapper"> The <see cref="T:Microsoft.AspNetCore.Mvc.Infrastructure.IActionResultTypeMapper"/>.</param>
  273. </member>
  274. <member name="P:Microsoft.AspNetCore.Mvc.ApiExplorer.DefaultApiDescriptionProvider.Order">
  275. <inheritdoc />
  276. </member>
  277. <member name="M:Microsoft.AspNetCore.Mvc.ApiExplorer.DefaultApiDescriptionProvider.OnProvidersExecuting(Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionProviderContext)">
  278. <inheritdoc />
  279. </member>
  280. <member name="T:Microsoft.AspNetCore.Mvc.ApiExplorer.IApiDescriptionGroupCollectionProvider">
  281. <summary>
  282. Provides access to a collection of <see cref="T:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionGroup"/>.
  283. </summary>
  284. </member>
  285. <member name="P:Microsoft.AspNetCore.Mvc.ApiExplorer.IApiDescriptionGroupCollectionProvider.ApiDescriptionGroups">
  286. <summary>
  287. Gets a collection of <see cref="T:Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescriptionGroup"/>.
  288. </summary>
  289. </member>
  290. </members>
  291. </doc>