Microsoft.Extensions.Caching.Abstractions.xml 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.Extensions.Caching.Abstractions</name>
  5. </assembly>
  6. <members>
  7. <member name="M:Microsoft.Extensions.Caching.Memory.CacheEntryExtensions.SetPriority(Microsoft.Extensions.Caching.Memory.ICacheEntry,Microsoft.Extensions.Caching.Memory.CacheItemPriority)">
  8. <summary>
  9. Sets the priority for keeping the cache entry in the cache during a memory pressure tokened cleanup.
  10. </summary>
  11. <param name="entry">The entry to set the priority for.</param>
  12. <param name="priority">The <see cref="T:Microsoft.Extensions.Caching.Memory.CacheItemPriority"/> to set on the entry.</param>
  13. <returns>The <see cref="T:Microsoft.Extensions.Caching.Memory.ICacheEntry"/> for chaining.</returns>
  14. </member>
  15. <member name="M:Microsoft.Extensions.Caching.Memory.CacheEntryExtensions.AddExpirationToken(Microsoft.Extensions.Caching.Memory.ICacheEntry,Microsoft.Extensions.Primitives.IChangeToken)">
  16. <summary>
  17. Expire the cache entry if the given <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> expires.
  18. </summary>
  19. <param name="entry">The <see cref="T:Microsoft.Extensions.Caching.Memory.ICacheEntry"/>.</param>
  20. <param name="expirationToken">The <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> that causes the cache entry to expire.</param>
  21. <returns>The <see cref="T:Microsoft.Extensions.Caching.Memory.ICacheEntry"/> for chaining.</returns>
  22. </member>
  23. <member name="M:Microsoft.Extensions.Caching.Memory.CacheEntryExtensions.SetAbsoluteExpiration(Microsoft.Extensions.Caching.Memory.ICacheEntry,System.TimeSpan)">
  24. <summary>
  25. Sets an absolute expiration time, relative to now.
  26. </summary>
  27. <param name="entry">The <see cref="T:Microsoft.Extensions.Caching.Memory.ICacheEntry"/>.</param>
  28. <param name="relative">The <see cref="T:System.TimeSpan"/> representing the expiration time relative to now.</param>
  29. <returns>The <see cref="T:Microsoft.Extensions.Caching.Memory.ICacheEntry"/> for chaining.</returns>
  30. </member>
  31. <member name="M:Microsoft.Extensions.Caching.Memory.CacheEntryExtensions.SetAbsoluteExpiration(Microsoft.Extensions.Caching.Memory.ICacheEntry,System.DateTimeOffset)">
  32. <summary>
  33. Sets an absolute expiration date for the cache entry.
  34. </summary>
  35. <param name="entry">The <see cref="T:Microsoft.Extensions.Caching.Memory.ICacheEntry"/>.</param>
  36. <param name="absolute">A <see cref="T:System.DateTimeOffset"/> representing the expiration time in absolute terms.</param>
  37. <returns>The <see cref="T:Microsoft.Extensions.Caching.Memory.ICacheEntry"/> for chaining.</returns>
  38. </member>
  39. <member name="M:Microsoft.Extensions.Caching.Memory.CacheEntryExtensions.SetSlidingExpiration(Microsoft.Extensions.Caching.Memory.ICacheEntry,System.TimeSpan)">
  40. <summary>
  41. Sets how long the cache entry can be inactive (e.g. not accessed) before it will be removed.
  42. This will not extend the entry lifetime beyond the absolute expiration (if set).
  43. </summary>
  44. <param name="entry">The <see cref="T:Microsoft.Extensions.Caching.Memory.ICacheEntry"/>.</param>
  45. <param name="offset">A <see cref="T:System.TimeSpan"/> representing a sliding expiration.</param>
  46. <returns>The <see cref="T:Microsoft.Extensions.Caching.Memory.ICacheEntry"/> for chaining.</returns>
  47. </member>
  48. <member name="M:Microsoft.Extensions.Caching.Memory.CacheEntryExtensions.RegisterPostEvictionCallback(Microsoft.Extensions.Caching.Memory.ICacheEntry,Microsoft.Extensions.Caching.Memory.PostEvictionDelegate)">
  49. <summary>
  50. The given callback will be fired after the cache entry is evicted from the cache.
  51. </summary>
  52. <param name="entry">The <see cref="T:Microsoft.Extensions.Caching.Memory.ICacheEntry"/>.</param>
  53. <param name="callback">The callback to run after the entry is evicted.</param>
  54. <returns>The <see cref="T:Microsoft.Extensions.Caching.Memory.ICacheEntry"/> for chaining.</returns>
  55. </member>
  56. <member name="M:Microsoft.Extensions.Caching.Memory.CacheEntryExtensions.RegisterPostEvictionCallback(Microsoft.Extensions.Caching.Memory.ICacheEntry,Microsoft.Extensions.Caching.Memory.PostEvictionDelegate,System.Object)">
  57. <summary>
  58. The given callback will be fired after the cache entry is evicted from the cache.
  59. </summary>
  60. <param name="entry">The <see cref="T:Microsoft.Extensions.Caching.Memory.ICacheEntry"/>.</param>
  61. <param name="callback">The callback to run after the entry is evicted.</param>
  62. <param name="state">The state to pass to the post-eviction callback.</param>
  63. <returns>The <see cref="T:Microsoft.Extensions.Caching.Memory.ICacheEntry"/> for chaining.</returns>
  64. </member>
  65. <member name="M:Microsoft.Extensions.Caching.Memory.CacheEntryExtensions.SetValue(Microsoft.Extensions.Caching.Memory.ICacheEntry,System.Object)">
  66. <summary>
  67. Sets the value of the cache entry.
  68. </summary>
  69. <param name="entry">The <see cref="T:Microsoft.Extensions.Caching.Memory.ICacheEntry"/>.</param>
  70. <param name="value">The value to set on the <paramref name="entry"/>.</param>
  71. <returns>The <see cref="T:Microsoft.Extensions.Caching.Memory.ICacheEntry"/> for chaining.</returns>
  72. </member>
  73. <member name="M:Microsoft.Extensions.Caching.Memory.CacheEntryExtensions.SetSize(Microsoft.Extensions.Caching.Memory.ICacheEntry,System.Int64)">
  74. <summary>
  75. Sets the size of the cache entry value.
  76. </summary>
  77. <param name="entry">The <see cref="T:Microsoft.Extensions.Caching.Memory.ICacheEntry"/>.</param>
  78. <param name="size">The size to set on the <paramref name="entry"/>.</param>
  79. <returns>The <see cref="T:Microsoft.Extensions.Caching.Memory.ICacheEntry"/> for chaining.</returns>
  80. </member>
  81. <member name="M:Microsoft.Extensions.Caching.Memory.CacheEntryExtensions.SetOptions(Microsoft.Extensions.Caching.Memory.ICacheEntry,Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions)">
  82. <summary>
  83. Applies the values of an existing <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions"/> to the entry.
  84. </summary>
  85. <param name="entry">The <see cref="T:Microsoft.Extensions.Caching.Memory.ICacheEntry"/>.</param>
  86. <param name="options">Set the values of these options on the <paramref name="entry"/>.</param>
  87. <returns>The <see cref="T:Microsoft.Extensions.Caching.Memory.ICacheEntry"/> for chaining.</returns>
  88. </member>
  89. <member name="T:Microsoft.Extensions.Caching.Memory.CacheItemPriority">
  90. <summary>
  91. Specifies how items are prioritized for preservation during a memory pressure triggered cleanup.
  92. </summary>
  93. </member>
  94. <member name="F:Microsoft.Extensions.Caching.Memory.EvictionReason.Removed">
  95. <summary>
  96. Manually
  97. </summary>
  98. </member>
  99. <member name="F:Microsoft.Extensions.Caching.Memory.EvictionReason.Replaced">
  100. <summary>
  101. Overwritten
  102. </summary>
  103. </member>
  104. <member name="F:Microsoft.Extensions.Caching.Memory.EvictionReason.Expired">
  105. <summary>
  106. Timed out
  107. </summary>
  108. </member>
  109. <member name="F:Microsoft.Extensions.Caching.Memory.EvictionReason.TokenExpired">
  110. <summary>
  111. Event
  112. </summary>
  113. </member>
  114. <member name="F:Microsoft.Extensions.Caching.Memory.EvictionReason.Capacity">
  115. <summary>
  116. Overflow
  117. </summary>
  118. </member>
  119. <member name="T:Microsoft.Extensions.Caching.Memory.ICacheEntry">
  120. <summary>
  121. Represents an entry in the <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> implementation.
  122. </summary>
  123. </member>
  124. <member name="P:Microsoft.Extensions.Caching.Memory.ICacheEntry.Key">
  125. <summary>
  126. Gets the key of the cache entry.
  127. </summary>
  128. </member>
  129. <member name="P:Microsoft.Extensions.Caching.Memory.ICacheEntry.Value">
  130. <summary>
  131. Gets or set the value of the cache entry.
  132. </summary>
  133. </member>
  134. <member name="P:Microsoft.Extensions.Caching.Memory.ICacheEntry.AbsoluteExpiration">
  135. <summary>
  136. Gets or sets an absolute expiration date for the cache entry.
  137. </summary>
  138. </member>
  139. <member name="P:Microsoft.Extensions.Caching.Memory.ICacheEntry.AbsoluteExpirationRelativeToNow">
  140. <summary>
  141. Gets or sets an absolute expiration time, relative to now.
  142. </summary>
  143. </member>
  144. <member name="P:Microsoft.Extensions.Caching.Memory.ICacheEntry.SlidingExpiration">
  145. <summary>
  146. Gets or sets how long a cache entry can be inactive (e.g. not accessed) before it will be removed.
  147. This will not extend the entry lifetime beyond the absolute expiration (if set).
  148. </summary>
  149. </member>
  150. <member name="P:Microsoft.Extensions.Caching.Memory.ICacheEntry.ExpirationTokens">
  151. <summary>
  152. Gets the <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> instances which cause the cache entry to expire.
  153. </summary>
  154. </member>
  155. <member name="P:Microsoft.Extensions.Caching.Memory.ICacheEntry.PostEvictionCallbacks">
  156. <summary>
  157. Gets or sets the callbacks will be fired after the cache entry is evicted from the cache.
  158. </summary>
  159. </member>
  160. <member name="P:Microsoft.Extensions.Caching.Memory.ICacheEntry.Priority">
  161. <summary>
  162. Gets or sets the priority for keeping the cache entry in the cache during a
  163. cleanup. The default is <see cref="F:Microsoft.Extensions.Caching.Memory.CacheItemPriority.Normal"/>.
  164. </summary>
  165. </member>
  166. <member name="P:Microsoft.Extensions.Caching.Memory.ICacheEntry.Size">
  167. <summary>
  168. Gets or set the size of the cache entry value.
  169. </summary>
  170. </member>
  171. <member name="T:Microsoft.Extensions.Caching.Memory.IMemoryCache">
  172. <summary>
  173. Represents a local in-memory cache whose values are not serialized.
  174. </summary>
  175. </member>
  176. <member name="M:Microsoft.Extensions.Caching.Memory.IMemoryCache.TryGetValue(System.Object,System.Object@)">
  177. <summary>
  178. Gets the item associated with this key if present.
  179. </summary>
  180. <param name="key">An object identifying the requested entry.</param>
  181. <param name="value">The located value or null.</param>
  182. <returns>True if the key was found.</returns>
  183. </member>
  184. <member name="M:Microsoft.Extensions.Caching.Memory.IMemoryCache.CreateEntry(System.Object)">
  185. <summary>
  186. Create or overwrite an entry in the cache.
  187. </summary>
  188. <param name="key">An object identifying the entry.</param>
  189. <returns>The newly created <see cref="T:Microsoft.Extensions.Caching.Memory.ICacheEntry"/> instance.</returns>
  190. </member>
  191. <member name="M:Microsoft.Extensions.Caching.Memory.IMemoryCache.Remove(System.Object)">
  192. <summary>
  193. Removes the object associated with the given key.
  194. </summary>
  195. <param name="key">An object identifying the entry.</param>
  196. </member>
  197. <member name="M:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryExtensions.SetPriority(Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions,Microsoft.Extensions.Caching.Memory.CacheItemPriority)">
  198. <summary>
  199. Sets the priority for keeping the cache entry in the cache during a memory pressure tokened cleanup.
  200. </summary>
  201. <param name="options">The option on which to set the priority.</param>
  202. <param name="priority">The <see cref="T:Microsoft.Extensions.Caching.Memory.CacheItemPriority"/> to set on the option.</param>
  203. <returns>The <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions"/> so that additional calls can be chained.</returns>
  204. </member>
  205. <member name="M:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryExtensions.SetSize(Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions,System.Int64)">
  206. <summary>
  207. Sets the size of the cache entry value.
  208. </summary>
  209. <param name="options">The options to set the entry size on.</param>
  210. <param name="size">The size to set on the <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions"/>.</param>
  211. <returns>The <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions"/> so that additional calls can be chained.</returns>
  212. </member>
  213. <member name="M:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryExtensions.AddExpirationToken(Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions,Microsoft.Extensions.Primitives.IChangeToken)">
  214. <summary>
  215. Expire the cache entry if the given <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> expires.
  216. </summary>
  217. <param name="options">The <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions"/>.</param>
  218. <param name="expirationToken">The <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> that causes the cache entry to expire.</param>
  219. <returns>The <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions"/> so that additional calls can be chained.</returns>
  220. </member>
  221. <member name="M:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryExtensions.SetAbsoluteExpiration(Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions,System.TimeSpan)">
  222. <summary>
  223. Sets an absolute expiration time, relative to now.
  224. </summary>
  225. <param name="options">The <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions"/>.</param>
  226. <param name="relative">The expiration time, relative to now.</param>
  227. <returns>The <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions"/> so that additional calls can be chained.</returns>
  228. </member>
  229. <member name="M:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryExtensions.SetAbsoluteExpiration(Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions,System.DateTimeOffset)">
  230. <summary>
  231. Sets an absolute expiration date for the cache entry.
  232. </summary>
  233. <param name="options">The <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions"/>.</param>
  234. <param name="absolute">The expiration time, in absolute terms.</param>
  235. <returns>The <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions"/> so that additional calls can be chained.</returns>
  236. </member>
  237. <member name="M:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryExtensions.SetSlidingExpiration(Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions,System.TimeSpan)">
  238. <summary>
  239. Sets how long the cache entry can be inactive (e.g. not accessed) before it will be removed.
  240. This will not extend the entry lifetime beyond the absolute expiration (if set).
  241. </summary>
  242. <param name="options">The <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions"/>.</param>
  243. <param name="offset">The sliding expiration time.</param>
  244. <returns>The <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions"/> so that additional calls can be chained.</returns>
  245. </member>
  246. <member name="M:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryExtensions.RegisterPostEvictionCallback(Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions,Microsoft.Extensions.Caching.Memory.PostEvictionDelegate)">
  247. <summary>
  248. The given callback will be fired after the cache entry is evicted from the cache.
  249. </summary>
  250. <param name="options">The <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions"/>.</param>
  251. <param name="callback">The callback to register for calling after an entry is evicted.</param>
  252. <returns>The <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions"/> so that additional calls can be chained.</returns>
  253. </member>
  254. <member name="M:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryExtensions.RegisterPostEvictionCallback(Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions,Microsoft.Extensions.Caching.Memory.PostEvictionDelegate,System.Object)">
  255. <summary>
  256. The given callback will be fired after the cache entry is evicted from the cache.
  257. </summary>
  258. <param name="options">The <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions"/>.</param>
  259. <param name="callback">The callback to register for calling after an entry is evicted.</param>
  260. <param name="state">The state to pass to the callback.</param>
  261. <returns>The <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions"/> so that additional calls can be chained.</returns>
  262. </member>
  263. <member name="T:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions">
  264. <summary>
  265. Represents the cache options applied to an entry of the <see cref="T:Microsoft.Extensions.Caching.Memory.IMemoryCache"/> instance.
  266. </summary>
  267. </member>
  268. <member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions.AbsoluteExpiration">
  269. <summary>
  270. Gets or sets an absolute expiration date for the cache entry.
  271. </summary>
  272. </member>
  273. <member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions.AbsoluteExpirationRelativeToNow">
  274. <summary>
  275. Gets or sets an absolute expiration time, relative to now.
  276. </summary>
  277. </member>
  278. <member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions.SlidingExpiration">
  279. <summary>
  280. Gets or sets how long a cache entry can be inactive (e.g. not accessed) before it will be removed.
  281. This will not extend the entry lifetime beyond the absolute expiration (if set).
  282. </summary>
  283. </member>
  284. <member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions.ExpirationTokens">
  285. <summary>
  286. Gets the <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> instances which cause the cache entry to expire.
  287. </summary>
  288. </member>
  289. <member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions.PostEvictionCallbacks">
  290. <summary>
  291. Gets or sets the callbacks will be fired after the cache entry is evicted from the cache.
  292. </summary>
  293. </member>
  294. <member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions.Priority">
  295. <summary>
  296. Gets or sets the priority for keeping the cache entry in the cache during a
  297. memory pressure triggered cleanup. The default is <see cref="F:Microsoft.Extensions.Caching.Memory.CacheItemPriority.Normal"/>.
  298. </summary>
  299. </member>
  300. <member name="P:Microsoft.Extensions.Caching.Memory.MemoryCacheEntryOptions.Size">
  301. <summary>
  302. Gets or sets the size of the cache entry value.
  303. </summary>
  304. </member>
  305. <member name="T:Microsoft.Extensions.Caching.Memory.PostEvictionDelegate">
  306. <summary>
  307. Signature of the callback which gets called when a cache entry expires.
  308. </summary>
  309. <param name="key">The key of the entry being evicted.</param>
  310. <param name="value">The value of the entry being evicted.</param>
  311. <param name="reason">The <see cref="T:Microsoft.Extensions.Caching.Memory.EvictionReason"/>.</param>
  312. <param name="state">The information that was passed when registering the callback.</param>
  313. </member>
  314. <member name="M:Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryExtensions.SetAbsoluteExpiration(Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions,System.TimeSpan)">
  315. <summary>
  316. Sets an absolute expiration time, relative to now.
  317. </summary>
  318. <param name="options">The options to be operated on.</param>
  319. <param name="relative">The expiration time, relative to now.</param>
  320. </member>
  321. <member name="M:Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryExtensions.SetAbsoluteExpiration(Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions,System.DateTimeOffset)">
  322. <summary>
  323. Sets an absolute expiration date for the cache entry.
  324. </summary>
  325. <param name="options">The options to be operated on.</param>
  326. <param name="absolute">The expiration time, in absolute terms.</param>
  327. </member>
  328. <member name="M:Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryExtensions.SetSlidingExpiration(Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions,System.TimeSpan)">
  329. <summary>
  330. Sets how long the cache entry can be inactive (e.g. not accessed) before it will be removed.
  331. This will not extend the entry lifetime beyond the absolute expiration (if set).
  332. </summary>
  333. <param name="options">The options to be operated on.</param>
  334. <param name="offset">The sliding expiration time.</param>
  335. </member>
  336. <member name="T:Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions">
  337. <summary>
  338. Provides the cache options for an entry in <see cref="T:Microsoft.Extensions.Caching.Distributed.IDistributedCache"/>.
  339. </summary>
  340. </member>
  341. <member name="P:Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions.AbsoluteExpiration">
  342. <summary>
  343. Gets or sets an absolute expiration date for the cache entry.
  344. </summary>
  345. </member>
  346. <member name="P:Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions.AbsoluteExpirationRelativeToNow">
  347. <summary>
  348. Gets or sets an absolute expiration time, relative to now.
  349. </summary>
  350. </member>
  351. <member name="P:Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions.SlidingExpiration">
  352. <summary>
  353. Gets or sets how long a cache entry can be inactive (e.g. not accessed) before it will be removed.
  354. This will not extend the entry lifetime beyond the absolute expiration (if set).
  355. </summary>
  356. </member>
  357. <member name="T:Microsoft.Extensions.Caching.Distributed.DistributedCacheExtensions">
  358. <summary>
  359. Extension methods for setting data in an <see cref="T:Microsoft.Extensions.Caching.Distributed.IDistributedCache" />.
  360. </summary>
  361. </member>
  362. <member name="M:Microsoft.Extensions.Caching.Distributed.DistributedCacheExtensions.Set(Microsoft.Extensions.Caching.Distributed.IDistributedCache,System.String,System.Byte[])">
  363. <summary>
  364. Sets a sequence of bytes in the specified cache with the specified key.
  365. </summary>
  366. <param name="cache">The cache in which to store the data.</param>
  367. <param name="key">The key to store the data in.</param>
  368. <param name="value">The data to store in the cache.</param>
  369. <exception cref="T:System.ArgumentNullException">Thrown when <paramref name="key"/> or <paramref name="value"/> is null.</exception>
  370. </member>
  371. <member name="M:Microsoft.Extensions.Caching.Distributed.DistributedCacheExtensions.SetAsync(Microsoft.Extensions.Caching.Distributed.IDistributedCache,System.String,System.Byte[],System.Threading.CancellationToken)">
  372. <summary>
  373. Asynchronously sets a sequence of bytes in the specified cache with the specified key.
  374. </summary>
  375. <param name="cache">The cache in which to store the data.</param>
  376. <param name="key">The key to store the data in.</param>
  377. <param name="value">The data to store in the cache.</param>
  378. <param name="token">Optional. A <see cref="T:System.Threading.CancellationToken" /> to cancel the operation.</param>
  379. <returns>A task that represents the asynchronous set operation.</returns>
  380. <exception cref="T:System.ArgumentNullException">Thrown when <paramref name="key"/> or <paramref name="value"/> is null.</exception>
  381. </member>
  382. <member name="M:Microsoft.Extensions.Caching.Distributed.DistributedCacheExtensions.SetString(Microsoft.Extensions.Caching.Distributed.IDistributedCache,System.String,System.String)">
  383. <summary>
  384. Sets a string in the specified cache with the specified key.
  385. </summary>
  386. <param name="cache">The cache in which to store the data.</param>
  387. <param name="key">The key to store the data in.</param>
  388. <param name="value">The data to store in the cache.</param>
  389. <exception cref="T:System.ArgumentNullException">Thrown when <paramref name="key"/> or <paramref name="value"/> is null.</exception>
  390. </member>
  391. <member name="M:Microsoft.Extensions.Caching.Distributed.DistributedCacheExtensions.SetString(Microsoft.Extensions.Caching.Distributed.IDistributedCache,System.String,System.String,Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions)">
  392. <summary>
  393. Sets a string in the specified cache with the specified key.
  394. </summary>
  395. <param name="cache">The cache in which to store the data.</param>
  396. <param name="key">The key to store the data in.</param>
  397. <param name="value">The data to store in the cache.</param>
  398. <param name="options">The cache options for the entry.</param>
  399. <exception cref="T:System.ArgumentNullException">Thrown when <paramref name="key"/> or <paramref name="value"/> is null.</exception>
  400. </member>
  401. <member name="M:Microsoft.Extensions.Caching.Distributed.DistributedCacheExtensions.SetStringAsync(Microsoft.Extensions.Caching.Distributed.IDistributedCache,System.String,System.String,System.Threading.CancellationToken)">
  402. <summary>
  403. Asynchronously sets a string in the specified cache with the specified key.
  404. </summary>
  405. <param name="cache">The cache in which to store the data.</param>
  406. <param name="key">The key to store the data in.</param>
  407. <param name="value">The data to store in the cache.</param>
  408. <param name="token">Optional. A <see cref="T:System.Threading.CancellationToken" /> to cancel the operation.</param>
  409. <returns>A task that represents the asynchronous set operation.</returns>
  410. <exception cref="T:System.ArgumentNullException">Thrown when <paramref name="key"/> or <paramref name="value"/> is null.</exception>
  411. </member>
  412. <member name="M:Microsoft.Extensions.Caching.Distributed.DistributedCacheExtensions.SetStringAsync(Microsoft.Extensions.Caching.Distributed.IDistributedCache,System.String,System.String,Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions,System.Threading.CancellationToken)">
  413. <summary>
  414. Asynchronously sets a string in the specified cache with the specified key.
  415. </summary>
  416. <param name="cache">The cache in which to store the data.</param>
  417. <param name="key">The key to store the data in.</param>
  418. <param name="value">The data to store in the cache.</param>
  419. <param name="options">The cache options for the entry.</param>
  420. <param name="token">Optional. A <see cref="T:System.Threading.CancellationToken" /> to cancel the operation.</param>
  421. <returns>A task that represents the asynchronous set operation.</returns>
  422. <exception cref="T:System.ArgumentNullException">Thrown when <paramref name="key"/> or <paramref name="value"/> is null.</exception>
  423. </member>
  424. <member name="M:Microsoft.Extensions.Caching.Distributed.DistributedCacheExtensions.GetString(Microsoft.Extensions.Caching.Distributed.IDistributedCache,System.String)">
  425. <summary>
  426. Gets a string from the specified cache with the specified key.
  427. </summary>
  428. <param name="cache">The cache in which to store the data.</param>
  429. <param name="key">The key to get the stored data for.</param>
  430. <returns>The string value from the stored cache key.</returns>
  431. </member>
  432. <member name="M:Microsoft.Extensions.Caching.Distributed.DistributedCacheExtensions.GetStringAsync(Microsoft.Extensions.Caching.Distributed.IDistributedCache,System.String,System.Threading.CancellationToken)">
  433. <summary>
  434. Asynchronously gets a string from the specified cache with the specified key.
  435. </summary>
  436. <param name="cache">The cache in which to store the data.</param>
  437. <param name="key">The key to get the stored data for.</param>
  438. <param name="token">Optional. A <see cref="T:System.Threading.CancellationToken" /> to cancel the operation.</param>
  439. <returns>A task that gets the string value from the stored cache key.</returns>
  440. </member>
  441. <member name="T:Microsoft.Extensions.Caching.Distributed.IDistributedCache">
  442. <summary>
  443. Represents a distributed cache of serialized values.
  444. </summary>
  445. </member>
  446. <member name="M:Microsoft.Extensions.Caching.Distributed.IDistributedCache.Get(System.String)">
  447. <summary>
  448. Gets a value with the given key.
  449. </summary>
  450. <param name="key">A string identifying the requested value.</param>
  451. <returns>The located value or null.</returns>
  452. </member>
  453. <member name="M:Microsoft.Extensions.Caching.Distributed.IDistributedCache.GetAsync(System.String,System.Threading.CancellationToken)">
  454. <summary>
  455. Gets a value with the given key.
  456. </summary>
  457. <param name="key">A string identifying the requested value.</param>
  458. <param name="token">Optional. The <see cref="T:System.Threading.CancellationToken"/> used to propagate notifications that the operation should be canceled.</param>
  459. <returns>The <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation, containing the located value or null.</returns>
  460. </member>
  461. <member name="M:Microsoft.Extensions.Caching.Distributed.IDistributedCache.Set(System.String,System.Byte[],Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions)">
  462. <summary>
  463. Sets a value with the given key.
  464. </summary>
  465. <param name="key">A string identifying the requested value.</param>
  466. <param name="value">The value to set in the cache.</param>
  467. <param name="options">The cache options for the value.</param>
  468. </member>
  469. <member name="M:Microsoft.Extensions.Caching.Distributed.IDistributedCache.SetAsync(System.String,System.Byte[],Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions,System.Threading.CancellationToken)">
  470. <summary>
  471. Sets the value with the given key.
  472. </summary>
  473. <param name="key">A string identifying the requested value.</param>
  474. <param name="value">The value to set in the cache.</param>
  475. <param name="options">The cache options for the value.</param>
  476. <param name="token">Optional. The <see cref="T:System.Threading.CancellationToken"/> used to propagate notifications that the operation should be canceled.</param>
  477. <returns>The <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
  478. </member>
  479. <member name="M:Microsoft.Extensions.Caching.Distributed.IDistributedCache.Refresh(System.String)">
  480. <summary>
  481. Refreshes a value in the cache based on its key, resetting its sliding expiration timeout (if any).
  482. </summary>
  483. <param name="key">A string identifying the requested calue.</param>
  484. </member>
  485. <member name="M:Microsoft.Extensions.Caching.Distributed.IDistributedCache.RefreshAsync(System.String,System.Threading.CancellationToken)">
  486. <summary>
  487. Refreshes a value in the cache based on its key, resetting its sliding expiration timeout (if any).
  488. </summary>
  489. <param name="key">A string identifying the requested value.</param>
  490. <param name="token">Optional. The <see cref="T:System.Threading.CancellationToken"/> used to propagate notifications that the operation should be canceled.</param>
  491. <returns>The <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
  492. </member>
  493. <member name="M:Microsoft.Extensions.Caching.Distributed.IDistributedCache.Remove(System.String)">
  494. <summary>
  495. Removes the value with the given key.
  496. </summary>
  497. <param name="key">A string identifying the requested value.</param>
  498. </member>
  499. <member name="M:Microsoft.Extensions.Caching.Distributed.IDistributedCache.RemoveAsync(System.String,System.Threading.CancellationToken)">
  500. <summary>
  501. Removes the value with the given key.
  502. </summary>
  503. <param name="key">A string identifying the requested value.</param>
  504. <param name="token">Optional. The <see cref="T:System.Threading.CancellationToken"/> used to propagate notifications that the operation should be canceled.</param>
  505. <returns>The <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
  506. </member>
  507. <member name="T:Microsoft.Extensions.Internal.ISystemClock">
  508. <summary>
  509. Abstracts the system clock to facilitate testing.
  510. </summary>
  511. </member>
  512. <member name="P:Microsoft.Extensions.Internal.ISystemClock.UtcNow">
  513. <summary>
  514. Retrieves the current system time in UTC.
  515. </summary>
  516. </member>
  517. <member name="T:Microsoft.Extensions.Internal.SystemClock">
  518. <summary>
  519. Provides access to the normal system clock.
  520. </summary>
  521. </member>
  522. <member name="P:Microsoft.Extensions.Internal.SystemClock.UtcNow">
  523. <summary>
  524. Retrieves the current system time in UTC.
  525. </summary>
  526. </member>
  527. </members>
  528. </doc>