Skip to content

Commit 2d53342

Browse files
2 parents f86a003 + 654c36b commit 2d53342

650 files changed

Lines changed: 113546 additions & 1199 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

dotnet/xml/FrameworksIndex/msal-dotnet-latest.xml

Lines changed: 3 additions & 183 deletions
Large diffs are not rendered by default.

dotnet/xml/FrameworksIndex/msal-model-dotnet-latest.xml

Lines changed: 981 additions & 0 deletions
Large diffs are not rendered by default.

dotnet/xml/FrameworksIndex/msal-web-dotnet-latest.xml

Lines changed: 3883 additions & 0 deletions
Large diffs are not rendered by default.

dotnet/xml/Microsoft.Identity.Abstractions/AcquireTokenOptions.xml

Lines changed: 494 additions & 0 deletions
Large diffs are not rendered by default.
Lines changed: 232 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,232 @@
1+
<Type Name="AcquireTokenResult" FullName="Microsoft.Identity.Abstractions.AcquireTokenResult">
2+
<TypeSignature Language="C#" Value="public class AcquireTokenResult" />
3+
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit AcquireTokenResult extends System.Object" />
4+
<TypeSignature Language="DocId" Value="T:Microsoft.Identity.Abstractions.AcquireTokenResult" />
5+
<TypeSignature Language="VB.NET" Value="Public Class AcquireTokenResult" />
6+
<TypeSignature Language="F#" Value="type AcquireTokenResult = class" />
7+
<AssemblyInfo>
8+
<AssemblyName>Microsoft.Identity.Abstractions</AssemblyName>
9+
<AssemblyVersion>9.2.0.0</AssemblyVersion>
10+
</AssemblyInfo>
11+
<Base>
12+
<BaseTypeName>System.Object</BaseTypeName>
13+
</Base>
14+
<Interfaces />
15+
<Attributes>
16+
<Attribute>
17+
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
18+
<AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.Nullable(0)&gt;]</AttributeName>
19+
</Attribute>
20+
</Attributes>
21+
<Docs>
22+
<summary>
23+
Result of a token acquisition.
24+
</summary>
25+
<remarks>To be added.</remarks>
26+
</Docs>
27+
<Members>
28+
<Member MemberName=".ctor">
29+
<MemberSignature Language="C#" Value="public AcquireTokenResult (string accessToken, DateTimeOffset expiresOn, string tenantId, string idToken, System.Collections.Generic.IEnumerable&lt;string&gt; scopes, Guid correlationId, string tokenType);" />
30+
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string accessToken, valuetype System.DateTimeOffset expiresOn, string tenantId, string idToken, class System.Collections.Generic.IEnumerable`1&lt;string&gt; scopes, valuetype System.Guid correlationId, string tokenType) cil managed" />
31+
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Abstractions.AcquireTokenResult.#ctor(System.String,System.DateTimeOffset,System.String,System.String,System.Collections.Generic.IEnumerable{System.String},System.Guid,System.String)" />
32+
<MemberSignature Language="VB.NET" Value="Public Sub New (accessToken As String, expiresOn As DateTimeOffset, tenantId As String, idToken As String, scopes As IEnumerable(Of String), correlationId As Guid, tokenType As String)" />
33+
<MemberSignature Language="F#" Value="new Microsoft.Identity.Abstractions.AcquireTokenResult : string * DateTimeOffset * string * string * seq&lt;string&gt; * Guid * string -&gt; Microsoft.Identity.Abstractions.AcquireTokenResult" Usage="new Microsoft.Identity.Abstractions.AcquireTokenResult (accessToken, expiresOn, tenantId, idToken, scopes, correlationId, tokenType)" />
34+
<MemberType>Constructor</MemberType>
35+
<AssemblyInfo>
36+
<AssemblyName>Microsoft.Identity.Abstractions</AssemblyName>
37+
<AssemblyVersion>9.2.0.0</AssemblyVersion>
38+
</AssemblyInfo>
39+
<Parameters>
40+
<Parameter Name="accessToken" Type="System.String" />
41+
<Parameter Name="expiresOn" Type="System.DateTimeOffset" />
42+
<Parameter Name="tenantId" Type="System.String" />
43+
<Parameter Name="idToken" Type="System.String" />
44+
<Parameter Name="scopes" Type="System.Collections.Generic.IEnumerable&lt;System.String&gt;" />
45+
<Parameter Name="correlationId" Type="System.Guid" />
46+
<Parameter Name="tokenType" Type="System.String" />
47+
</Parameters>
48+
<Docs>
49+
<param name="accessToken">Access token.</param>
50+
<param name="expiresOn">Expiration date/time.</param>
51+
<param name="tenantId">Tenant for which the token was acquired.</param>
52+
<param name="idToken">ID Token, in the case of a token for a user.</param>
53+
<param name="scopes">Scopes granted by the IdP.</param>
54+
<param name="correlationId">Correlation ID of the token acquisition.</param>
55+
<param name="tokenType">Token type of the access token (Bearer or Pop).</param>
56+
<summary>
57+
Constructor.
58+
</summary>
59+
<remarks>To be added.</remarks>
60+
</Docs>
61+
</Member>
62+
<Member MemberName="AccessToken">
63+
<MemberSignature Language="C#" Value="public string? AccessToken { get; set; }" />
64+
<MemberSignature Language="ILAsm" Value=".property instance string AccessToken" />
65+
<MemberSignature Language="DocId" Value="P:Microsoft.Identity.Abstractions.AcquireTokenResult.AccessToken" />
66+
<MemberSignature Language="VB.NET" Value="Public Property AccessToken As String" />
67+
<MemberSignature Language="F#" Value="member this.AccessToken : string with get, set" Usage="Microsoft.Identity.Abstractions.AcquireTokenResult.AccessToken" />
68+
<MemberType>Property</MemberType>
69+
<AssemblyInfo>
70+
<AssemblyName>Microsoft.Identity.Abstractions</AssemblyName>
71+
<AssemblyVersion>9.2.0.0</AssemblyVersion>
72+
</AssemblyInfo>
73+
<ReturnValue>
74+
<ReturnType>System.String</ReturnType>
75+
</ReturnValue>
76+
<Docs>
77+
<summary>
78+
Access Token that can be used to build an authorization header
79+
to access protected web APIs.
80+
</summary>
81+
<value>To be added.</value>
82+
<remarks>To be added.</remarks>
83+
<altmember cref="T:Microsoft.Identity.Abstractions.IAuthorizationHeaderProvider" />
84+
</Docs>
85+
</Member>
86+
<Member MemberName="CorrelationId">
87+
<MemberSignature Language="C#" Value="public Guid CorrelationId { get; set; }" />
88+
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Guid CorrelationId" />
89+
<MemberSignature Language="DocId" Value="P:Microsoft.Identity.Abstractions.AcquireTokenResult.CorrelationId" />
90+
<MemberSignature Language="VB.NET" Value="Public Property CorrelationId As Guid" />
91+
<MemberSignature Language="F#" Value="member this.CorrelationId : Guid with get, set" Usage="Microsoft.Identity.Abstractions.AcquireTokenResult.CorrelationId" />
92+
<MemberType>Property</MemberType>
93+
<AssemblyInfo>
94+
<AssemblyName>Microsoft.Identity.Abstractions</AssemblyName>
95+
<AssemblyVersion>9.2.0.0</AssemblyVersion>
96+
</AssemblyInfo>
97+
<ReturnValue>
98+
<ReturnType>System.Guid</ReturnType>
99+
</ReturnValue>
100+
<Docs>
101+
<summary>
102+
Gets the correlation id used for the request. If provided in <see cref="P:Microsoft.Identity.Abstractions.AcquireTokenOptions.CorrelationId" />, this
103+
will be the same, otherwise a new one will be created by the token acquirer.
104+
</summary>
105+
<value>To be added.</value>
106+
<remarks>To be added.</remarks>
107+
</Docs>
108+
</Member>
109+
<Member MemberName="ExpiresOn">
110+
<MemberSignature Language="C#" Value="public DateTimeOffset ExpiresOn { get; set; }" />
111+
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.DateTimeOffset ExpiresOn" />
112+
<MemberSignature Language="DocId" Value="P:Microsoft.Identity.Abstractions.AcquireTokenResult.ExpiresOn" />
113+
<MemberSignature Language="VB.NET" Value="Public Property ExpiresOn As DateTimeOffset" />
114+
<MemberSignature Language="F#" Value="member this.ExpiresOn : DateTimeOffset with get, set" Usage="Microsoft.Identity.Abstractions.AcquireTokenResult.ExpiresOn" />
115+
<MemberType>Property</MemberType>
116+
<AssemblyInfo>
117+
<AssemblyName>Microsoft.Identity.Abstractions</AssemblyName>
118+
<AssemblyVersion>9.2.0.0</AssemblyVersion>
119+
</AssemblyInfo>
120+
<ReturnValue>
121+
<ReturnType>System.DateTimeOffset</ReturnType>
122+
</ReturnValue>
123+
<Docs>
124+
<summary>
125+
Gets the point in time in which the Access Token returned in the <see cref="P:Microsoft.Identity.Abstractions.AcquireTokenResult.AccessToken" />
126+
property ceases to be valid. This value is calculated based on current UTC time
127+
measured locally and the value expiresIn received from the service.
128+
</summary>
129+
<value>To be added.</value>
130+
<remarks>To be added.</remarks>
131+
</Docs>
132+
</Member>
133+
<Member MemberName="IdToken">
134+
<MemberSignature Language="C#" Value="public string? IdToken { get; set; }" />
135+
<MemberSignature Language="ILAsm" Value=".property instance string IdToken" />
136+
<MemberSignature Language="DocId" Value="P:Microsoft.Identity.Abstractions.AcquireTokenResult.IdToken" />
137+
<MemberSignature Language="VB.NET" Value="Public Property IdToken As String" />
138+
<MemberSignature Language="F#" Value="member this.IdToken : string with get, set" Usage="Microsoft.Identity.Abstractions.AcquireTokenResult.IdToken" />
139+
<MemberType>Property</MemberType>
140+
<AssemblyInfo>
141+
<AssemblyName>Microsoft.Identity.Abstractions</AssemblyName>
142+
<AssemblyVersion>9.2.0.0</AssemblyVersion>
143+
</AssemblyInfo>
144+
<ReturnValue>
145+
<ReturnType>System.String</ReturnType>
146+
</ReturnValue>
147+
<Docs>
148+
<summary>
149+
Gets the Id Token if returned by the service or null if no Id Token is returned.
150+
</summary>
151+
<value>To be added.</value>
152+
<remarks>To be added.</remarks>
153+
</Docs>
154+
</Member>
155+
<Member MemberName="Scopes">
156+
<MemberSignature Language="C#" Value="public System.Collections.Generic.IEnumerable&lt;string&gt;? Scopes { get; set; }" />
157+
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IEnumerable`1&lt;string&gt; Scopes" />
158+
<MemberSignature Language="DocId" Value="P:Microsoft.Identity.Abstractions.AcquireTokenResult.Scopes" />
159+
<MemberSignature Language="VB.NET" Value="Public Property Scopes As IEnumerable(Of String)" />
160+
<MemberSignature Language="F#" Value="member this.Scopes : seq&lt;string&gt; with get, set" Usage="Microsoft.Identity.Abstractions.AcquireTokenResult.Scopes" />
161+
<MemberType>Property</MemberType>
162+
<AssemblyInfo>
163+
<AssemblyName>Microsoft.Identity.Abstractions</AssemblyName>
164+
<AssemblyVersion>9.2.0.0</AssemblyVersion>
165+
</AssemblyInfo>
166+
<Attributes>
167+
<Attribute>
168+
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(new System.Byte[] { 2, 1 })]</AttributeName>
169+
<AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.Nullable(new System.Byte[] { 2, 1 })&gt;]</AttributeName>
170+
</Attribute>
171+
</Attributes>
172+
<ReturnValue>
173+
<ReturnType>System.Collections.Generic.IEnumerable&lt;System.String&gt;</ReturnType>
174+
</ReturnValue>
175+
<Docs>
176+
<summary>
177+
Gets the scope values effectively granted by the IdP. They can be different
178+
form the scopes requested.
179+
</summary>
180+
<value>To be added.</value>
181+
<remarks>To be added.</remarks>
182+
</Docs>
183+
</Member>
184+
<Member MemberName="TenantId">
185+
<MemberSignature Language="C#" Value="public string? TenantId { get; set; }" />
186+
<MemberSignature Language="ILAsm" Value=".property instance string TenantId" />
187+
<MemberSignature Language="DocId" Value="P:Microsoft.Identity.Abstractions.AcquireTokenResult.TenantId" />
188+
<MemberSignature Language="VB.NET" Value="Public Property TenantId As String" />
189+
<MemberSignature Language="F#" Value="member this.TenantId : string with get, set" Usage="Microsoft.Identity.Abstractions.AcquireTokenResult.TenantId" />
190+
<MemberType>Property</MemberType>
191+
<AssemblyInfo>
192+
<AssemblyName>Microsoft.Identity.Abstractions</AssemblyName>
193+
<AssemblyVersion>9.2.0.0</AssemblyVersion>
194+
</AssemblyInfo>
195+
<ReturnValue>
196+
<ReturnType>System.String</ReturnType>
197+
</ReturnValue>
198+
<Docs>
199+
<summary>
200+
(Microsoft Identity specific) In the case of Azure AD, Azure AD B2C, or Microsoft Entra External IDs,
201+
gets an identifier for the tenant for which the token was acquired.
202+
This property will be null if tenant information is not returned by the service or the service
203+
is not Azure AD.
204+
</summary>
205+
<value>To be added.</value>
206+
<remarks>To be added.</remarks>
207+
</Docs>
208+
</Member>
209+
<Member MemberName="TokenType">
210+
<MemberSignature Language="C#" Value="public string? TokenType { get; set; }" />
211+
<MemberSignature Language="ILAsm" Value=".property instance string TokenType" />
212+
<MemberSignature Language="DocId" Value="P:Microsoft.Identity.Abstractions.AcquireTokenResult.TokenType" />
213+
<MemberSignature Language="VB.NET" Value="Public Property TokenType As String" />
214+
<MemberSignature Language="F#" Value="member this.TokenType : string with get, set" Usage="Microsoft.Identity.Abstractions.AcquireTokenResult.TokenType" />
215+
<MemberType>Property</MemberType>
216+
<AssemblyInfo>
217+
<AssemblyName>Microsoft.Identity.Abstractions</AssemblyName>
218+
<AssemblyVersion>9.2.0.0</AssemblyVersion>
219+
</AssemblyInfo>
220+
<ReturnValue>
221+
<ReturnType>System.String</ReturnType>
222+
</ReturnValue>
223+
<Docs>
224+
<summary>
225+
Gets the protocol (Bearer or Pop).
226+
</summary>
227+
<value>To be added.</value>
228+
<remarks>To be added.</remarks>
229+
</Docs>
230+
</Member>
231+
</Members>
232+
</Type>

0 commit comments

Comments
 (0)