-
Notifications
You must be signed in to change notification settings - Fork 25
/
BaseRequestExtensions.xml
287 lines (287 loc) · 16.3 KB
/
BaseRequestExtensions.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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
<Type Name="BaseRequestExtensions" FullName="Microsoft.Identity.Web.BaseRequestExtensions">
<TypeSignature Language="C#" Value="public static class BaseRequestExtensions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit BaseRequestExtensions extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Identity.Web.BaseRequestExtensions" />
<TypeSignature Language="VB.NET" Value="Public Module BaseRequestExtensions" />
<TypeSignature Language="F#" Value="type BaseRequestExtensions = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Web.MicrosoftGraph</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>
<AssemblyVersion>2.18.1.0</AssemblyVersion>
<AssemblyVersion>2.18.2.0</AssemblyVersion>
<AssemblyVersion>2.19.0.0</AssemblyVersion>
<AssemblyVersion>2.19.1.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Web.MicrosoftGraphBeta</AssemblyName>
<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>
<AssemblyVersion>2.18.1.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Extension methods for Graph requests
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="WithAppOnly<T>">
<MemberSignature Language="C#" Value="public static T WithAppOnly<T> (this T baseRequest, bool appOnly = true, string? tenant = default) where T : Microsoft.Graph.IBaseRequest;" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig !!T WithAppOnly<(class Microsoft.Graph.IBaseRequest) T>(!!T baseRequest, bool appOnly, string tenant) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Web.BaseRequestExtensions.WithAppOnly``1(``0,System.Boolean,System.String)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function WithAppOnly(Of T As IBaseRequest) (baseRequest As T, Optional appOnly As Boolean = true, Optional tenant As String = Nothing) As T" />
<MemberSignature Language="F#" Value="static member WithAppOnly : 'T * bool * string -> 'T (requires 'T :> Microsoft.Graph.IBaseRequest)" Usage="Microsoft.Identity.Web.BaseRequestExtensions.WithAppOnly (baseRequest, appOnly, tenant)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Web.MicrosoftGraph</AssemblyName>
<AssemblyVersion>2.19.1.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Web.MicrosoftGraphBeta</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>T</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T">
<Constraints>
<InterfaceName>Microsoft.Graph.IBaseRequest</InterfaceName>
</Constraints>
</TypeParameter>
</TypeParameters>
<Parameters>
<Parameter Name="baseRequest" Type="T" RefType="this" />
<Parameter Name="appOnly" Type="System.Boolean" />
<Parameter Name="tenant" Type="System.String" />
</Parameters>
<Docs>
<typeparam name="T">Type of the request.</typeparam>
<param name="baseRequest">Request.</param>
<param name="appOnly">Should the permissions be app only or not.</param>
<param name="tenant">Tenant ID or domain for which we want to make the call..</param>
<summary>
Applied to a request, expresses to use app only permissions for Graph.
</summary>
<returns />
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="WithAuthenticationOptions<T>">
<MemberSignature Language="C#" Value="public static T WithAuthenticationOptions<T> (this T baseRequest, Action<Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions> overrideAuthenticationOptions) where T : Microsoft.Graph.IBaseRequest;" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig !!T WithAuthenticationOptions<(class Microsoft.Graph.IBaseRequest) T>(!!T baseRequest, class System.Action`1<class Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions> overrideAuthenticationOptions) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Web.BaseRequestExtensions.WithAuthenticationOptions``1(``0,System.Action{Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions})" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function WithAuthenticationOptions(Of T As IBaseRequest) (baseRequest As T, overrideAuthenticationOptions As Action(Of AuthorizationHeaderProviderOptions)) As T" />
<MemberSignature Language="F#" Value="static member WithAuthenticationOptions : 'T * Action<Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions> -> 'T (requires 'T :> Microsoft.Graph.IBaseRequest)" Usage="Microsoft.Identity.Web.BaseRequestExtensions.WithAuthenticationOptions (baseRequest, overrideAuthenticationOptions)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Web.MicrosoftGraph</AssemblyName>
<AssemblyVersion>2.19.1.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Web.MicrosoftGraphBeta</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>T</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T">
<Constraints>
<InterfaceName>Microsoft.Graph.IBaseRequest</InterfaceName>
</Constraints>
</TypeParameter>
</TypeParameters>
<Parameters>
<Parameter Name="baseRequest" Type="T" RefType="this" />
<Parameter Name="overrideAuthenticationOptions" Type="System.Action<Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions>" />
</Parameters>
<Docs>
<typeparam name="T">Request</typeparam>
<param name="baseRequest">Request.</param>
<param name="overrideAuthenticationOptions">Delegate to override
the authentication options</param>
<summary>
Overrides authentication options for a given request.
</summary>
<returns>Base request</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="WithAuthenticationScheme<T>">
<MemberSignature Language="C#" Value="public static T WithAuthenticationScheme<T> (this T baseRequest, string authenticationScheme) where T : Microsoft.Graph.IBaseRequest;" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig !!T WithAuthenticationScheme<(class Microsoft.Graph.IBaseRequest) T>(!!T baseRequest, string authenticationScheme) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Web.BaseRequestExtensions.WithAuthenticationScheme``1(``0,System.String)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function WithAuthenticationScheme(Of T As IBaseRequest) (baseRequest As T, authenticationScheme As String) As T" />
<MemberSignature Language="F#" Value="static member WithAuthenticationScheme : 'T * string -> 'T (requires 'T :> Microsoft.Graph.IBaseRequest)" Usage="Microsoft.Identity.Web.BaseRequestExtensions.WithAuthenticationScheme (baseRequest, authenticationScheme)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Web.MicrosoftGraph</AssemblyName>
<AssemblyVersion>2.19.1.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Web.MicrosoftGraphBeta</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>T</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T">
<Constraints>
<InterfaceName>Microsoft.Graph.IBaseRequest</InterfaceName>
</Constraints>
</TypeParameter>
</TypeParameters>
<Parameters>
<Parameter Name="baseRequest" Type="T" RefType="this" />
<Parameter Name="authenticationScheme" Type="System.String" />
</Parameters>
<Docs>
<typeparam name="T">To be added.</typeparam>
<param name="baseRequest">The <see cref="T:Microsoft.Graph.IBaseRequest" />.</param>
<param name="authenticationScheme">Authentication scheme used to authenticate this request.</param>
<summary>
Sets the authentication scheme that will be used by <see cref="T:Microsoft.Graph.IAuthenticationProvider" /> to authenticate this request.
This only works with the default authentication handler and default set of Microsoft Graph authentication providers.
If you use a custom authentication handler or authentication provider, you have to handle its retrieval in your implementation.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="WithScopes<T>">
<MemberSignature Language="C#" Value="public static T WithScopes<T> (this T baseRequest, params string[] scopes) where T : Microsoft.Graph.IBaseRequest;" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig !!T WithScopes<(class Microsoft.Graph.IBaseRequest) T>(!!T baseRequest, string[] scopes) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Web.BaseRequestExtensions.WithScopes``1(``0,System.String[])" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function WithScopes(Of T As IBaseRequest) (baseRequest As T, ParamArray scopes As String()) As T" />
<MemberSignature Language="F#" Value="static member WithScopes : 'T * string[] -> 'T (requires 'T :> Microsoft.Graph.IBaseRequest)" Usage="Microsoft.Identity.Web.BaseRequestExtensions.WithScopes (baseRequest, scopes)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Web.MicrosoftGraph</AssemblyName>
<AssemblyVersion>2.19.1.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Web.MicrosoftGraphBeta</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>T</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T">
<Constraints>
<InterfaceName>Microsoft.Graph.IBaseRequest</InterfaceName>
</Constraints>
</TypeParameter>
</TypeParameters>
<Parameters>
<Parameter Name="baseRequest" Type="T" RefType="this" />
<Parameter Name="scopes" Type="System.String[]" />
</Parameters>
<Docs>
<typeparam name="T">To be added.</typeparam>
<param name="baseRequest">The <see cref="T:Microsoft.Graph.IBaseRequest" />.</param>
<param name="scopes">Microsoft Graph scopes used to authenticate this request.</param>
<summary>
Sets Microsoft Graph's scopes that will be used by <see cref="T:Microsoft.Graph.IAuthenticationProvider" /> to authenticate this request
and can be used to perform incremental scope consent.
This only works with the default authentication handler and default set of Microsoft Graph authentication providers.
If you use a custom authentication handler or authentication provider, you have to handle its retrieval in your implementation.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="WithUser<T>">
<MemberSignature Language="C#" Value="public static T WithUser<T> (this T baseRequest, System.Security.Claims.ClaimsPrincipal user) where T : Microsoft.Graph.IBaseRequest;" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig !!T WithUser<(class Microsoft.Graph.IBaseRequest) T>(!!T baseRequest, class System.Security.Claims.ClaimsPrincipal user) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Web.BaseRequestExtensions.WithUser``1(``0,System.Security.Claims.ClaimsPrincipal)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function WithUser(Of T As IBaseRequest) (baseRequest As T, user As ClaimsPrincipal) As T" />
<MemberSignature Language="F#" Value="static member WithUser : 'T * System.Security.Claims.ClaimsPrincipal -> 'T (requires 'T :> Microsoft.Graph.IBaseRequest)" Usage="Microsoft.Identity.Web.BaseRequestExtensions.WithUser (baseRequest, user)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Web.MicrosoftGraph</AssemblyName>
<AssemblyVersion>2.19.1.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Web.MicrosoftGraphBeta</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>T</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T">
<Constraints>
<InterfaceName>Microsoft.Graph.IBaseRequest</InterfaceName>
</Constraints>
</TypeParameter>
</TypeParameters>
<Parameters>
<Parameter Name="baseRequest" Type="T" RefType="this" />
<Parameter Name="user" Type="System.Security.Claims.ClaimsPrincipal" />
</Parameters>
<Docs>
<typeparam name="T">Request</typeparam>
<param name="baseRequest">Request.</param>
<param name="user">Delegate to override
the authentication options</param>
<summary>
Overrides authentication options for a given request.
</summary>
<returns>Base request</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>