/
MsalDistributedTokenCacheAdapterOptions.xml
189 lines (189 loc) · 10.6 KB
/
MsalDistributedTokenCacheAdapterOptions.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
<Type Name="MsalDistributedTokenCacheAdapterOptions" FullName="Microsoft.Identity.Web.TokenCacheProviders.Distributed.MsalDistributedTokenCacheAdapterOptions">
<TypeSignature Language="C#" Value="public class MsalDistributedTokenCacheAdapterOptions : Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit MsalDistributedTokenCacheAdapterOptions extends Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions" />
<TypeSignature Language="DocId" Value="T:Microsoft.Identity.Web.TokenCacheProviders.Distributed.MsalDistributedTokenCacheAdapterOptions" />
<TypeSignature Language="VB.NET" Value="Public Class MsalDistributedTokenCacheAdapterOptions
Inherits DistributedCacheEntryOptions" />
<TypeSignature Language="F#" Value="type MsalDistributedTokenCacheAdapterOptions = class
 inherit DistributedCacheEntryOptions" />
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Web.TokenCache</AssemblyName>
<AssemblyVersion>2.6.1.0</AssemblyVersion>
<AssemblyVersion>2.7.0.0</AssemblyVersion>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
<AssemblyVersion>2.9.0.0</AssemblyVersion>
<AssemblyVersion>2.10.0.0</AssemblyVersion>
<AssemblyVersion>2.11.0.0</AssemblyVersion>
<AssemblyVersion>2.11.1.0</AssemblyVersion>
<AssemblyVersion>2.12.4.0</AssemblyVersion>
<AssemblyVersion>2.13.0.0</AssemblyVersion>
<AssemblyVersion>2.13.1.0</AssemblyVersion>
<AssemblyVersion>2.13.2.0</AssemblyVersion>
<AssemblyVersion>2.13.3.0</AssemblyVersion>
<AssemblyVersion>2.13.4.0</AssemblyVersion>
<AssemblyVersion>2.14.0.0</AssemblyVersion>
<AssemblyVersion>2.15.1.0</AssemblyVersion>
<AssemblyVersion>2.15.2.0</AssemblyVersion>
<AssemblyVersion>2.15.3.0</AssemblyVersion>
<AssemblyVersion>2.15.5.0</AssemblyVersion>
<AssemblyVersion>2.16.0.0</AssemblyVersion>
<AssemblyVersion>2.16.1.0</AssemblyVersion>
<AssemblyVersion>2.17.0.0</AssemblyVersion>
<AssemblyVersion>2.17.1.0</AssemblyVersion>
<AssemblyVersion>2.17.2.0</AssemblyVersion>
<AssemblyVersion>2.17.3.0</AssemblyVersion>
<AssemblyVersion>2.17.4.0</AssemblyVersion>
<AssemblyVersion>2.17.5.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Options for the MSAL token cache serialization adapter,
which delegates the serialization to the <see cref="T:Microsoft.Extensions.Caching.Distributed.IDistributedCache" /> implementations
available with .NET Core.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public MsalDistributedTokenCacheAdapterOptions ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Web.TokenCacheProviders.Distributed.MsalDistributedTokenCacheAdapterOptions.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Web.TokenCache</AssemblyName>
<AssemblyVersion>2.17.5.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DisableL1Cache">
<MemberSignature Language="C#" Value="public bool DisableL1Cache { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool DisableL1Cache" />
<MemberSignature Language="DocId" Value="P:Microsoft.Identity.Web.TokenCacheProviders.Distributed.MsalDistributedTokenCacheAdapterOptions.DisableL1Cache" />
<MemberSignature Language="VB.NET" Value="Public Property DisableL1Cache As Boolean" />
<MemberSignature Language="F#" Value="member this.DisableL1Cache : bool with get, set" Usage="Microsoft.Identity.Web.TokenCacheProviders.Distributed.MsalDistributedTokenCacheAdapterOptions.DisableL1Cache" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Web.TokenCache</AssemblyName>
<AssemblyVersion>2.17.5.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Disable the in-memory (L1) cache.
Useful in scenarios where multiple apps share the same
distributed (L2) cache.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<c>false.</c>
</Docs>
</Member>
<Member MemberName="EnableAsyncL2Write">
<MemberSignature Language="C#" Value="public bool EnableAsyncL2Write { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool EnableAsyncL2Write" />
<MemberSignature Language="DocId" Value="P:Microsoft.Identity.Web.TokenCacheProviders.Distributed.MsalDistributedTokenCacheAdapterOptions.EnableAsyncL2Write" />
<MemberSignature Language="VB.NET" Value="Public Property EnableAsyncL2Write As Boolean" />
<MemberSignature Language="F#" Value="member this.EnableAsyncL2Write : bool with get, set" Usage="Microsoft.Identity.Web.TokenCacheProviders.Distributed.MsalDistributedTokenCacheAdapterOptions.EnableAsyncL2Write" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Web.TokenCache</AssemblyName>
<AssemblyVersion>2.17.5.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Enable writing to the distributed (L2) cache to be async (i.e. fire-and-forget).
This improves performance as the MSAL.NET will not have to wait
for the write to complete.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<c>false.</c>
</Docs>
</Member>
<Member MemberName="Encrypt">
<MemberSignature Language="C#" Value="public bool Encrypt { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool Encrypt" />
<MemberSignature Language="DocId" Value="P:Microsoft.Identity.Web.TokenCacheProviders.Distributed.MsalDistributedTokenCacheAdapterOptions.Encrypt" />
<MemberSignature Language="VB.NET" Value="Public Property Encrypt As Boolean" />
<MemberSignature Language="F#" Value="member this.Encrypt : bool with get, set" Usage="Microsoft.Identity.Web.TokenCacheProviders.Distributed.MsalDistributedTokenCacheAdapterOptions.Encrypt" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Web.TokenCache</AssemblyName>
<AssemblyVersion>2.17.5.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Should the token cache be encrypted.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<c>false.</c>
</Docs>
</Member>
<Member MemberName="L1CacheOptions">
<MemberSignature Language="C#" Value="public Microsoft.Extensions.Caching.Memory.MemoryCacheOptions L1CacheOptions { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Extensions.Caching.Memory.MemoryCacheOptions L1CacheOptions" />
<MemberSignature Language="DocId" Value="P:Microsoft.Identity.Web.TokenCacheProviders.Distributed.MsalDistributedTokenCacheAdapterOptions.L1CacheOptions" />
<MemberSignature Language="VB.NET" Value="Public Property L1CacheOptions As MemoryCacheOptions" />
<MemberSignature Language="F#" Value="member this.L1CacheOptions : Microsoft.Extensions.Caching.Memory.MemoryCacheOptions with get, set" Usage="Microsoft.Identity.Web.TokenCacheProviders.Distributed.MsalDistributedTokenCacheAdapterOptions.L1CacheOptions" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Web.TokenCache</AssemblyName>
<AssemblyVersion>2.17.5.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Extensions.Caching.Memory.MemoryCacheOptions</ReturnType>
</ReturnValue>
<Docs>
<summary>
Options of the in-memory (L1) cache.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnL2CacheFailure">
<MemberSignature Language="C#" Value="public Func<Exception,bool>? OnL2CacheFailure { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Func`2<class System.Exception, bool> OnL2CacheFailure" />
<MemberSignature Language="DocId" Value="P:Microsoft.Identity.Web.TokenCacheProviders.Distributed.MsalDistributedTokenCacheAdapterOptions.OnL2CacheFailure" />
<MemberSignature Language="VB.NET" Value="Public Property OnL2CacheFailure As Func(Of Exception, Boolean)" />
<MemberSignature Language="F#" Value="member this.OnL2CacheFailure : Func<Exception, bool> with get, set" Usage="Microsoft.Identity.Web.TokenCacheProviders.Distributed.MsalDistributedTokenCacheAdapterOptions.OnL2CacheFailure" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Web.TokenCache</AssemblyName>
<AssemblyVersion>2.17.5.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Func<System.Exception,System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary>
Callback offered to the app to be notified when the L2 cache fails.
This way the app is given the possibility to act on the L2 cache,
for instance, in the case of Redis exception, to reconnect. This is left to the application as it's
the only one that knows about the real implementation of the L2 cache.
The handler should return <c>true</c> if the cache should try the operation again, and
<c>false</c> otherwise. When <c>true</c> is passed and the retry fails, an exception
will be thrown.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>