-
Notifications
You must be signed in to change notification settings - Fork 256
/
OAuthTokenProvider.xml
187 lines (187 loc) · 11.9 KB
/
OAuthTokenProvider.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
<Type Name="OAuthTokenProvider" FullName="Microsoft.ServiceBus.OAuthTokenProvider">
<TypeSignature Language="C#" Value="public class OAuthTokenProvider : Microsoft.ServiceBus.TokenProvider" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit OAuthTokenProvider extends Microsoft.ServiceBus.TokenProvider" />
<TypeSignature Language="DocId" Value="T:Microsoft.ServiceBus.OAuthTokenProvider" />
<TypeSignature Language="VB.NET" Value="Public Class OAuthTokenProvider
Inherits TokenProvider" />
<TypeSignature Language="F#" Value="type OAuthTokenProvider = class
 inherit TokenProvider" />
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.ServiceBus.TokenProvider</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Provides authentication token for the service bus.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="BuildKey">
<MemberSignature Language="C#" Value="protected override Microsoft.ServiceBus.TokenProvider.Key BuildKey (string appliesTo, string action);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance class Microsoft.ServiceBus.TokenProvider/Key BuildKey(string appliesTo, string action) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.OAuthTokenProvider.BuildKey(System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Function BuildKey (appliesTo As String, action As String) As TokenProvider.Key" />
<MemberSignature Language="F#" Value="override this.BuildKey : string * string -> Microsoft.ServiceBus.TokenProvider.Key" Usage="oAuthTokenProvider.BuildKey (appliesTo, action)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ServiceBus.TokenProvider+Key</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="appliesTo" Type="System.String" />
<Parameter Name="action" Type="System.String" />
</Parameters>
<Docs>
<param name="appliesTo">The provider in which the key will be applied.</param>
<param name="action">The action.</param>
<summary>Builds a key for the provider.</summary>
<returns>A Key.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="NormalizeAppliesTo">
<MemberSignature Language="C#" Value="protected override string NormalizeAppliesTo (string appliesTo);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance string NormalizeAppliesTo(string appliesTo) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.OAuthTokenProvider.NormalizeAppliesTo(System.String)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Function NormalizeAppliesTo (appliesTo As String) As String" />
<MemberSignature Language="F#" Value="override this.NormalizeAppliesTo : string -> string" Usage="oAuthTokenProvider.NormalizeAppliesTo appliesTo" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="appliesTo" Type="System.String" />
</Parameters>
<Docs>
<param name="appliesTo">The token provider where the normalization will be applied.</param>
<summary>Applies normalization into the token provider.</summary>
<returns>The normalized token provider.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnBeginGetToken">
<MemberSignature Language="C#" Value="protected override IAsyncResult OnBeginGetToken (string appliesTo, string action, TimeSpan timeout, AsyncCallback callback, object state);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance class System.IAsyncResult OnBeginGetToken(string appliesTo, string action, valuetype System.TimeSpan timeout, class System.AsyncCallback callback, object state) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.OAuthTokenProvider.OnBeginGetToken(System.String,System.String,System.TimeSpan,System.AsyncCallback,System.Object)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Function OnBeginGetToken (appliesTo As String, action As String, timeout As TimeSpan, callback As AsyncCallback, state As Object) As IAsyncResult" />
<MemberSignature Language="F#" Value="override this.OnBeginGetToken : string * string * TimeSpan * AsyncCallback * obj -> IAsyncResult" Usage="oAuthTokenProvider.OnBeginGetToken (appliesTo, action, timeout, callback, state)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IAsyncResult</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="appliesTo" Type="System.String" />
<Parameter Name="action" Type="System.String" />
<Parameter Name="timeout" Type="System.TimeSpan" />
<Parameter Name="callback" Type="System.AsyncCallback" />
<Parameter Name="state" Type="System.Object" />
</Parameters>
<Docs>
<param name="appliesTo">The provider in which the token will be applied.</param>
<param name="action">The action.</param>
<param name="timeout">The duration.</param>
<param name="callback">The callback.</param>
<param name="state">The state of the operation.</param>
<summary>Retrieves a token when the provider begins.</summary>
<returns>The asynchronous result of the operation.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnBeginGetWebToken">
<MemberSignature Language="C#" Value="protected override IAsyncResult OnBeginGetWebToken (string appliesTo, string action, TimeSpan timeout, AsyncCallback callback, object state);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance class System.IAsyncResult OnBeginGetWebToken(string appliesTo, string action, valuetype System.TimeSpan timeout, class System.AsyncCallback callback, object state) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.OAuthTokenProvider.OnBeginGetWebToken(System.String,System.String,System.TimeSpan,System.AsyncCallback,System.Object)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Function OnBeginGetWebToken (appliesTo As String, action As String, timeout As TimeSpan, callback As AsyncCallback, state As Object) As IAsyncResult" />
<MemberSignature Language="F#" Value="override this.OnBeginGetWebToken : string * string * TimeSpan * AsyncCallback * obj -> IAsyncResult" Usage="oAuthTokenProvider.OnBeginGetWebToken (appliesTo, action, timeout, callback, state)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IAsyncResult</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="appliesTo" Type="System.String" />
<Parameter Name="action" Type="System.String" />
<Parameter Name="timeout" Type="System.TimeSpan" />
<Parameter Name="callback" Type="System.AsyncCallback" />
<Parameter Name="state" Type="System.Object" />
</Parameters>
<Docs>
<param name="appliesTo">The provider in which the web token will be applied.</param>
<param name="action">The action.</param>
<param name="timeout">The duration.</param>
<param name="callback">The callback.</param>
<param name="state">The state of the operation.</param>
<summary>Retrieves a web token when the provider begins.</summary>
<returns>The asynchronous result of the operation.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnEndGetToken">
<MemberSignature Language="C#" Value="protected override System.IdentityModel.Tokens.SecurityToken OnEndGetToken (IAsyncResult result, out DateTime cacheUntil);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance class System.IdentityModel.Tokens.SecurityToken OnEndGetToken(class System.IAsyncResult result, [out] valuetype System.DateTime& cacheUntil) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.OAuthTokenProvider.OnEndGetToken(System.IAsyncResult,System.DateTime@)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Function OnEndGetToken (result As IAsyncResult, ByRef cacheUntil As DateTime) As SecurityToken" />
<MemberSignature Language="F#" Value="override this.OnEndGetToken : IAsyncResult * DateTime -> System.IdentityModel.Tokens.SecurityToken" Usage="oAuthTokenProvider.OnEndGetToken (result, cacheUntil)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IdentityModel.Tokens.SecurityToken</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="result" Type="System.IAsyncResult" />
<Parameter Name="cacheUntil" Type="System.DateTime" RefType="out" />
</Parameters>
<Docs>
<param name="result">The result of the operation.</param>
<param name="cacheUntil">The duration for the provider to store data.</param>
<summary>Retrieves a token when the provider ends.</summary>
<returns>The retrieved token.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnEndGetWebToken">
<MemberSignature Language="C#" Value="protected override string OnEndGetWebToken (IAsyncResult result, out DateTime cacheUntil);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance string OnEndGetWebToken(class System.IAsyncResult result, [out] valuetype System.DateTime& cacheUntil) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.OAuthTokenProvider.OnEndGetWebToken(System.IAsyncResult,System.DateTime@)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Function OnEndGetWebToken (result As IAsyncResult, ByRef cacheUntil As DateTime) As String" />
<MemberSignature Language="F#" Value="override this.OnEndGetWebToken : IAsyncResult * DateTime -> string" Usage="oAuthTokenProvider.OnEndGetWebToken (result, cacheUntil)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="result" Type="System.IAsyncResult" />
<Parameter Name="cacheUntil" Type="System.DateTime" RefType="out" />
</Parameters>
<Docs>
<param name="result">The result of the operation.</param>
<param name="cacheUntil">The duration for the provider to store data.</param>
<summary>Retrieves a web token when the provider ends.</summary>
<returns>The retrieved token.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>