-
Notifications
You must be signed in to change notification settings - Fork 25
/
ILongRunningWebApi.xml
115 lines (115 loc) 路 8.73 KB
/
ILongRunningWebApi.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
<Type Name="ILongRunningWebApi" FullName="Microsoft.Identity.Client.ILongRunningWebApi">
<TypeSignature Language="C#" Value="public interface ILongRunningWebApi" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract beforefieldinit ILongRunningWebApi" />
<TypeSignature Language="DocId" Value="T:Microsoft.Identity.Client.ILongRunningWebApi" />
<TypeSignature Language="VB.NET" Value="Public Interface ILongRunningWebApi" />
<TypeSignature Language="F#" Value="type ILongRunningWebApi = interface" />
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.48.1.0</AssemblyVersion>
<AssemblyVersion>4.49.1.0</AssemblyVersion>
<AssemblyVersion>4.51.0.0</AssemblyVersion>
<AssemblyVersion>4.52.0.0</AssemblyVersion>
<AssemblyVersion>4.53.0.0</AssemblyVersion>
<AssemblyVersion>4.54.0.0</AssemblyVersion>
<AssemblyVersion>4.54.1.0</AssemblyVersion>
<AssemblyVersion>4.55.0.0</AssemblyVersion>
<AssemblyVersion>4.56.0.0</AssemblyVersion>
<AssemblyVersion>4.57.0.0</AssemblyVersion>
<AssemblyVersion>4.58.0.0</AssemblyVersion>
<AssemblyVersion>4.58.1.0</AssemblyVersion>
<AssemblyVersion>4.59.0.0</AssemblyVersion>
<AssemblyVersion>4.60.0.0</AssemblyVersion>
<AssemblyVersion>4.60.1.0</AssemblyVersion>
<AssemblyVersion>4.60.2.0</AssemblyVersion>
<AssemblyVersion>4.60.3.0</AssemblyVersion>
<AssemblyVersion>4.61.0.0</AssemblyVersion>
<AssemblyVersion>4.61.1.0</AssemblyVersion>
<AssemblyVersion>4.61.3.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Docs>
<summary>
Methods for long-running or background processes in web APIs.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="AcquireTokenInLongRunningProcess">
<MemberSignature Language="C#" Value="public Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder AcquireTokenInLongRunningProcess (System.Collections.Generic.IEnumerable<string> scopes, string longRunningProcessSessionKey);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder AcquireTokenInLongRunningProcess(class System.Collections.Generic.IEnumerable`1<string> scopes, string longRunningProcessSessionKey) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.ILongRunningWebApi.AcquireTokenInLongRunningProcess(System.Collections.Generic.IEnumerable{System.String},System.String)" />
<MemberSignature Language="VB.NET" Value="Public Function AcquireTokenInLongRunningProcess (scopes As IEnumerable(Of String), longRunningProcessSessionKey As String) As AcquireTokenOnBehalfOfParameterBuilder" />
<MemberSignature Language="F#" Value="abstract member AcquireTokenInLongRunningProcess : seq<string> * string -> Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder" Usage="iLongRunningWebApi.AcquireTokenInLongRunningProcess (scopes, longRunningProcessSessionKey)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.61.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="scopes" Type="System.Collections.Generic.IEnumerable<System.String>" />
<Parameter Name="longRunningProcessSessionKey" Type="System.String" />
</Parameters>
<Docs>
<param name="scopes">Scopes requested to access a protected API.</param>
<param name="longRunningProcessSessionKey">Key by which to look up the token in the cache.</param>
<summary>
Retrieves an access token from the cache using the provided cache key that can be used to
access another downstream protected web API on behalf of a user using the OAuth 2.0 On-Behalf-Of flow.
See <see href="https://aka.ms/msal-net-long-running-obo">Long-running OBO in MSAL.NET</see>.
Use <seealso cref="M:Microsoft.Identity.Client.Extensibility.ConfidentialClientApplicationExtensions.StopLongRunningProcessInWebApiAsync(Microsoft.Identity.Client.ILongRunningWebApi,System.String,System.Threading.CancellationToken)" /> to stop the long running process
and remove the associated tokens from the cache.
</summary>
<returns>A builder enabling you to add other parameters before executing the token request.</returns>
<remarks>
This method should be called during the long-running session to retrieve the token from the cache.
</remarks>
<exception cref="T:Microsoft.Identity.Client.MsalClientException"> The token cache does not contain a token
with an OBO cache key that matches the <paramref name="longRunningProcessSessionKey" />.</exception>
</Docs>
</Member>
<Member MemberName="InitiateLongRunningProcessInWebApi">
<MemberSignature Language="C#" Value="public Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder InitiateLongRunningProcessInWebApi (System.Collections.Generic.IEnumerable<string> scopes, string userToken, ref string longRunningProcessSessionKey);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder InitiateLongRunningProcessInWebApi(class System.Collections.Generic.IEnumerable`1<string> scopes, string userToken, string& longRunningProcessSessionKey) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.ILongRunningWebApi.InitiateLongRunningProcessInWebApi(System.Collections.Generic.IEnumerable{System.String},System.String,System.String@)" />
<MemberSignature Language="VB.NET" Value="Public Function InitiateLongRunningProcessInWebApi (scopes As IEnumerable(Of String), userToken As String, ByRef longRunningProcessSessionKey As String) As AcquireTokenOnBehalfOfParameterBuilder" />
<MemberSignature Language="F#" Value="abstract member InitiateLongRunningProcessInWebApi : seq<string> * string * string -> Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder" Usage="iLongRunningWebApi.InitiateLongRunningProcessInWebApi (scopes, userToken, longRunningProcessSessionKey)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.61.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="scopes" Type="System.Collections.Generic.IEnumerable<System.String>" />
<Parameter Name="userToken" Type="System.String" />
<Parameter Name="longRunningProcessSessionKey" Type="System.String" RefType="ref" />
</Parameters>
<Docs>
<param name="scopes">Scopes requested to access a protected API.</param>
<param name="userToken">A JSON Web Token which was used to call this web API and contains the credential information
about the user on behalf of whom to get a token.</param>
<param name="longRunningProcessSessionKey">Key by which to look up the token in the cache.
If null, it will be set to the assertion hash of the <paramref name="userToken">userToken</paramref> by default.</param>
<summary>
Acquires an access token for this web API from the authority configured in the application,
in order to access another downstream protected web API on behalf of a user using the OAuth 2.0 On-Behalf-Of flow.
See <see href="https://aka.ms/msal-net-long-running-obo">Long-running OBO in MSAL.NET</see>.
Pass an access token (not an ID token) which was used to call this confidential client application in the
<paramref name="userToken">userToken</paramref> parameter.
Use <seealso cref="M:Microsoft.Identity.Client.Extensibility.ConfidentialClientApplicationExtensions.StopLongRunningProcessInWebApiAsync(Microsoft.Identity.Client.ILongRunningWebApi,System.String,System.Threading.CancellationToken)" /> to stop the long running process
and remove the associated tokens from the cache.
</summary>
<returns>A builder enabling you to add other parameters before executing the token request.</returns>
<remarks>
This method should be called once when the long-running session is started.
</remarks>
</Docs>
</Member>
</Members>
</Type>