/
DownstreamWebApiOptions.xml
227 lines (227 loc) Β· 11.8 KB
/
DownstreamWebApiOptions.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
<Type Name="DownstreamWebApiOptions" FullName="Microsoft.Identity.Web.DownstreamWebApiOptions">
<TypeSignature Language="C#" Value="public class DownstreamWebApiOptions : Microsoft.Identity.Web.MicrosoftIdentityAuthenticationBaseOptions, ICloneable" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit DownstreamWebApiOptions extends Microsoft.Identity.Web.MicrosoftIdentityAuthenticationBaseOptions implements class System.ICloneable" />
<TypeSignature Language="DocId" Value="T:Microsoft.Identity.Web.DownstreamWebApiOptions" />
<TypeSignature Language="VB.NET" Value="Public Class DownstreamWebApiOptions
Inherits MicrosoftIdentityAuthenticationBaseOptions
Implements ICloneable" />
<TypeSignature Language="F#" Value="type DownstreamWebApiOptions = class
 inherit MicrosoftIdentityAuthenticationBaseOptions
 interface ICloneable" />
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Web</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>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.Identity.Web.MicrosoftIdentityAuthenticationBaseOptions</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.ICloneable</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>
Options passed-in to call downstream web APIs. To call Microsoft Graph, see rather
<c>MicrosoftGraphOptions</c> in the <c>Microsoft.Identity.Web.MicrosoftGraph</c> assembly.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DownstreamWebApiOptions ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Web.DownstreamWebApiOptions.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Web</AssemblyName>
<AssemblyVersion>2.18.1.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="BaseUrl">
<MemberSignature Language="C#" Value="public string BaseUrl { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string BaseUrl" />
<MemberSignature Language="DocId" Value="P:Microsoft.Identity.Web.DownstreamWebApiOptions.BaseUrl" />
<MemberSignature Language="VB.NET" Value="Public Property BaseUrl As String" />
<MemberSignature Language="F#" Value="member this.BaseUrl : string with get, set" Usage="Microsoft.Identity.Web.DownstreamWebApiOptions.BaseUrl" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Web</AssemblyName>
<AssemblyVersion>2.18.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Base URL for the called downstream web API. For instance <c>"https://graph.microsoft.com/beta/".</c>.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Clone">
<MemberSignature Language="C#" Value="public Microsoft.Identity.Web.DownstreamWebApiOptions Clone ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.Identity.Web.DownstreamWebApiOptions Clone() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Web.DownstreamWebApiOptions.Clone" />
<MemberSignature Language="VB.NET" Value="Public Function Clone () As DownstreamWebApiOptions" />
<MemberSignature Language="F#" Value="member this.Clone : unit -> Microsoft.Identity.Web.DownstreamWebApiOptions" Usage="downstreamWebApiOptions.Clone " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Web</AssemblyName>
<AssemblyVersion>2.18.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Identity.Web.DownstreamWebApiOptions</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Clone the options (to be able to override them).
</summary>
<returns>A clone of the options.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CustomizeHttpRequestMessage">
<MemberSignature Language="C#" Value="public Action<System.Net.Http.HttpRequestMessage>? CustomizeHttpRequestMessage { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Action`1<class System.Net.Http.HttpRequestMessage> CustomizeHttpRequestMessage" />
<MemberSignature Language="DocId" Value="P:Microsoft.Identity.Web.DownstreamWebApiOptions.CustomizeHttpRequestMessage" />
<MemberSignature Language="VB.NET" Value="Public Property CustomizeHttpRequestMessage As Action(Of HttpRequestMessage)" />
<MemberSignature Language="F#" Value="member this.CustomizeHttpRequestMessage : Action<System.Net.Http.HttpRequestMessage> with get, set" Usage="Microsoft.Identity.Web.DownstreamWebApiOptions.CustomizeHttpRequestMessage" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Web</AssemblyName>
<AssemblyVersion>2.18.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Action<System.Net.Http.HttpRequestMessage></ReturnType>
</ReturnValue>
<Docs>
<summary>
Provides an opportunity to customize the HttpRequestMessage. For example,
to customize the headers. This is called after the message was formed, including
the Authorization header, and just before the message is sent.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetApiUrl">
<MemberSignature Language="C#" Value="public string GetApiUrl ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance string GetApiUrl() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Web.DownstreamWebApiOptions.GetApiUrl" />
<MemberSignature Language="VB.NET" Value="Public Function GetApiUrl () As String" />
<MemberSignature Language="F#" Value="member this.GetApiUrl : unit -> string" Usage="downstreamWebApiOptions.GetApiUrl " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Web</AssemblyName>
<AssemblyVersion>2.18.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Return the downstream web API URL.
</summary>
<returns>URL of the downstream web API.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="HttpMethod">
<MemberSignature Language="C#" Value="public System.Net.Http.HttpMethod HttpMethod { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Net.Http.HttpMethod HttpMethod" />
<MemberSignature Language="DocId" Value="P:Microsoft.Identity.Web.DownstreamWebApiOptions.HttpMethod" />
<MemberSignature Language="VB.NET" Value="Public Property HttpMethod As HttpMethod" />
<MemberSignature Language="F#" Value="member this.HttpMethod : System.Net.Http.HttpMethod with get, set" Usage="Microsoft.Identity.Web.DownstreamWebApiOptions.HttpMethod" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Web</AssemblyName>
<AssemblyVersion>2.18.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Net.Http.HttpMethod</ReturnType>
</ReturnValue>
<Docs>
<summary>
HTTP method used to call this downstream web API (by default Get).
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RelativePath">
<MemberSignature Language="C#" Value="public string RelativePath { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string RelativePath" />
<MemberSignature Language="DocId" Value="P:Microsoft.Identity.Web.DownstreamWebApiOptions.RelativePath" />
<MemberSignature Language="VB.NET" Value="Public Property RelativePath As String" />
<MemberSignature Language="F#" Value="member this.RelativePath : string with get, set" Usage="Microsoft.Identity.Web.DownstreamWebApiOptions.RelativePath" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Web</AssemblyName>
<AssemblyVersion>2.18.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Path relative to the <see cref="P:Microsoft.Identity.Web.DownstreamWebApiOptions.BaseUrl" /> (for instance "me").
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="System.ICloneable.Clone">
<MemberSignature Language="C#" Value="object ICloneable.Clone ();" />
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance object System.ICloneable.Clone() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Web.DownstreamWebApiOptions.System#ICloneable#Clone" />
<MemberSignature Language="VB.NET" Value="Function Clone () As Object Implements ICloneable.Clone" />
<MemberSignature Language="F#" Value="abstract member System.ICloneable.Clone : unit -> obj
override this.System.ICloneable.Clone : unit -> obj" Usage="downstreamWebApiOptions.System.ICloneable.Clone " />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.ICloneable.Clone</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Web</AssemblyName>
<AssemblyVersion>2.18.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Clone the options (to be able to override them).
</summary>
<returns>A clone of the options.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>