思念食品API

Microsoft.Owin.Security.MicrosoftAccount.XML 20KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.Owin.Security.MicrosoftAccount</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Owin.MicrosoftAccountAuthenticationExtensions">
  8. <summary>
  9. Extension methods for using <see cref="T:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationMiddleware"/>
  10. </summary>
  11. </member>
  12. <member name="M:Owin.MicrosoftAccountAuthenticationExtensions.UseMicrosoftAccountAuthentication(Owin.IAppBuilder,Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationOptions)">
  13. <summary>
  14. Authenticate users using Microsoft Account
  15. </summary>
  16. <param name="app">The <see cref="T:Owin.IAppBuilder"/> passed to the configuration method</param>
  17. <param name="options">Middleware configuration options</param>
  18. <returns>The updated <see cref="T:Owin.IAppBuilder"/></returns>
  19. </member>
  20. <member name="M:Owin.MicrosoftAccountAuthenticationExtensions.UseMicrosoftAccountAuthentication(Owin.IAppBuilder,System.String,System.String)">
  21. <summary>
  22. Authenticate users using Microsoft Account
  23. </summary>
  24. <param name="app">The <see cref="T:Owin.IAppBuilder"/> passed to the configuration method</param>
  25. <param name="clientId">The application client ID assigned by the Microsoft authentication service</param>
  26. <param name="clientSecret">The application client secret assigned by the Microsoft authentication service</param>
  27. <returns></returns>
  28. </member>
  29. <member name="T:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationMiddleware">
  30. <summary>
  31. OWIN middleware for authenticating users using the Microsoft Account service
  32. </summary>
  33. </member>
  34. <member name="M:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationMiddleware.#ctor(Microsoft.Owin.OwinMiddleware,Owin.IAppBuilder,Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationOptions)">
  35. <summary>
  36. Initializes a <see cref="T:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationMiddleware"/>
  37. </summary>
  38. <param name="next">The next middleware in the OWIN pipeline to invoke</param>
  39. <param name="app">The OWIN application</param>
  40. <param name="options">Configuration options for the middleware</param>
  41. </member>
  42. <member name="M:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationMiddleware.CreateHandler">
  43. <summary>
  44. Provides the <see cref="T:Microsoft.Owin.Security.Infrastructure.AuthenticationHandler"/> object for processing authentication-related requests.
  45. </summary>
  46. <returns>An <see cref="T:Microsoft.Owin.Security.Infrastructure.AuthenticationHandler"/> configured with the <see cref="T:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationOptions"/> supplied to the constructor.</returns>
  47. </member>
  48. <member name="T:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationOptions">
  49. <summary>
  50. Configuration options for <see cref="T:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationMiddleware"/>
  51. </summary>
  52. </member>
  53. <member name="M:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationOptions.#ctor">
  54. <summary>
  55. Initializes a new <see cref="T:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationOptions"/>.
  56. </summary>
  57. </member>
  58. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationOptions.BackchannelCertificateValidator">
  59. <summary>
  60. Gets or sets the a pinned certificate validator to use to validate the endpoints used
  61. in back channel communications belong to Microsoft Account.
  62. </summary>
  63. <value>
  64. The pinned certificate validator.
  65. </value>
  66. <remarks>If this property is null then the default certificate checks are performed,
  67. validating the subject name and if the signing chain is a trusted party.</remarks>
  68. </member>
  69. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationOptions.Caption">
  70. <summary>
  71. Get or sets the text that the user can display on a sign in user interface.
  72. </summary>
  73. <remarks>
  74. The default value is 'Microsoft'
  75. </remarks>
  76. </member>
  77. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationOptions.ClientId">
  78. <summary>
  79. The application client ID assigned by the Microsoft authentication service.
  80. </summary>
  81. </member>
  82. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationOptions.ClientSecret">
  83. <summary>
  84. The application client secret assigned by the Microsoft authentication service.
  85. </summary>
  86. </member>
  87. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationOptions.BackchannelTimeout">
  88. <summary>
  89. Gets or sets timeout value in milliseconds for back channel communications with Microsoft.
  90. </summary>
  91. <value>
  92. The back channel timeout.
  93. </value>
  94. </member>
  95. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationOptions.BackchannelHttpHandler">
  96. <summary>
  97. The HttpMessageHandler used to communicate with Microsoft.
  98. This cannot be set at the same time as BackchannelCertificateValidator unless the value
  99. can be downcast to a WebRequestHandler.
  100. </summary>
  101. </member>
  102. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationOptions.Scope">
  103. <summary>
  104. A list of permissions to request.
  105. </summary>
  106. </member>
  107. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationOptions.CallbackPath">
  108. <summary>
  109. The request path within the application's base path where the user-agent will be returned.
  110. The middleware will process this request when it arrives.
  111. Default value is "/signin-microsoft".
  112. </summary>
  113. </member>
  114. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationOptions.SignInAsAuthenticationType">
  115. <summary>
  116. Gets or sets the name of another authentication middleware which will be responsible for actually issuing a user <see cref="T:System.Security.Claims.ClaimsIdentity"/>.
  117. </summary>
  118. </member>
  119. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationOptions.Provider">
  120. <summary>
  121. Gets or sets the <see cref="T:Microsoft.Owin.Security.MicrosoftAccount.IMicrosoftAccountAuthenticationProvider"/> used to handle authentication events.
  122. </summary>
  123. </member>
  124. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationOptions.StateDataFormat">
  125. <summary>
  126. Gets or sets the type used to secure data handled by the middleware.
  127. </summary>
  128. </member>
  129. <member name="T:Microsoft.Owin.Security.MicrosoftAccount.IMicrosoftAccountAuthenticationProvider">
  130. <summary>
  131. Specifies callback methods which the <see cref="T:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationMiddleware"></see> invokes to enable developer control over the authentication process. /&gt;
  132. </summary>
  133. </member>
  134. <member name="M:Microsoft.Owin.Security.MicrosoftAccount.IMicrosoftAccountAuthenticationProvider.Authenticated(Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticatedContext)">
  135. <summary>
  136. Invoked whenever Microsoft succesfully authenticates a user
  137. </summary>
  138. <param name="context">Contains information about the login session as well as the user <see cref="T:System.Security.Claims.ClaimsIdentity"/>.</param>
  139. <returns>A <see cref="T:System.Threading.Tasks.Task"/> representing the completed operation.</returns>
  140. </member>
  141. <member name="M:Microsoft.Owin.Security.MicrosoftAccount.IMicrosoftAccountAuthenticationProvider.ReturnEndpoint(Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountReturnEndpointContext)">
  142. <summary>
  143. Invoked prior to the <see cref="T:System.Security.Claims.ClaimsIdentity"/> being saved in a local cookie and the browser being redirected to the originally requested URL.
  144. </summary>
  145. <param name="context"></param>
  146. <returns>A <see cref="T:System.Threading.Tasks.Task"/> representing the completed operation.</returns>
  147. </member>
  148. <member name="M:Microsoft.Owin.Security.MicrosoftAccount.IMicrosoftAccountAuthenticationProvider.ApplyRedirect(Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountApplyRedirectContext)">
  149. <summary>
  150. Called when a Challenge causes a redirect to authorize endpoint in the Microsoft middleware
  151. </summary>
  152. <param name="context">Contains redirect URI and <see cref="T:Microsoft.Owin.Security.AuthenticationProperties"/> of the challenge </param>
  153. </member>
  154. <member name="T:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticatedContext">
  155. <summary>
  156. Contains information about the login session as well as the user <see cref="T:System.Security.Claims.ClaimsIdentity"/>.
  157. </summary>
  158. </member>
  159. <member name="M:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticatedContext.#ctor(Microsoft.Owin.IOwinContext,Newtonsoft.Json.Linq.JObject,System.String,System.String,System.String)">
  160. <summary>
  161. Initializes a <see cref="T:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticatedContext"/>
  162. </summary>
  163. <param name="context">The OWIN environment</param>
  164. <param name="user">The JSON-serialized user</param>
  165. <param name="accessToken">The access token provided by the Microsoft authentication service</param>
  166. <param name="refreshToken">The refresh token provided by Microsoft authentication service</param>
  167. <param name="expires">Seconds until expiration</param>
  168. </member>
  169. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticatedContext.User">
  170. <summary>
  171. Gets the JSON-serialized user
  172. </summary>
  173. </member>
  174. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticatedContext.AccessToken">
  175. <summary>
  176. Gets the access token provided by the Microsoft authenication service
  177. </summary>
  178. </member>
  179. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticatedContext.RefreshToken">
  180. <summary>
  181. Gets the refresh token provided by Microsoft authentication service
  182. </summary>
  183. <remarks>
  184. Refresh token is only available when wl.offline_access is request.
  185. Otherwise, it is null.
  186. </remarks>
  187. </member>
  188. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticatedContext.ExpiresIn">
  189. <summary>
  190. Gets the Microsoft access token expiration time
  191. </summary>
  192. </member>
  193. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticatedContext.Id">
  194. <summary>
  195. Gets the Microsoft Account user ID
  196. </summary>
  197. </member>
  198. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticatedContext.Name">
  199. <summary>
  200. Gets the user name
  201. </summary>
  202. </member>
  203. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticatedContext.FirstName">
  204. <summary>
  205. Gets the user first name
  206. </summary>
  207. </member>
  208. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticatedContext.LastName">
  209. <summary>
  210. Gets the user last name
  211. </summary>
  212. </member>
  213. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticatedContext.Email">
  214. <summary>
  215. Gets the user email address
  216. </summary>
  217. </member>
  218. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticatedContext.Identity">
  219. <summary>
  220. Gets the <see cref="T:System.Security.Claims.ClaimsIdentity"/> representing the user
  221. </summary>
  222. </member>
  223. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticatedContext.Properties">
  224. <summary>
  225. Gets or sets a property bag for common authentication properties
  226. </summary>
  227. </member>
  228. <member name="T:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationProvider">
  229. <summary>
  230. Default <see cref="T:Microsoft.Owin.Security.MicrosoftAccount.IMicrosoftAccountAuthenticationProvider"/> implementation.
  231. </summary>
  232. </member>
  233. <member name="M:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationProvider.#ctor">
  234. <summary>
  235. Initializes a new <see cref="T:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationProvider"/>
  236. </summary>
  237. </member>
  238. <member name="M:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationProvider.Authenticated(Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticatedContext)">
  239. <summary>
  240. Invoked whenever Microsoft succesfully authenticates a user
  241. </summary>
  242. <param name="context">Contains information about the login session as well as the user <see cref="T:System.Security.Claims.ClaimsIdentity"/>.</param>
  243. <returns>A <see cref="T:System.Threading.Tasks.Task"/> representing the completed operation.</returns>
  244. </member>
  245. <member name="M:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationProvider.ReturnEndpoint(Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountReturnEndpointContext)">
  246. <summary>
  247. Invoked prior to the <see cref="T:System.Security.Claims.ClaimsIdentity"/> being saved in a local cookie and the browser being redirected to the originally requested URL.
  248. </summary>
  249. <param name="context">Contains information about the login session as well as the user <see cref="T:System.Security.Claims.ClaimsIdentity"/></param>
  250. <returns>A <see cref="T:System.Threading.Tasks.Task"/> representing the completed operation.</returns>
  251. </member>
  252. <member name="M:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationProvider.ApplyRedirect(Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountApplyRedirectContext)">
  253. <summary>
  254. Called when a Challenge causes a redirect to authorize endpoint in the Microsoft account middleware
  255. </summary>
  256. <param name="context">Contains redirect URI and <see cref="T:Microsoft.Owin.Security.AuthenticationProperties"/> of the challenge </param>
  257. </member>
  258. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationProvider.OnAuthenticated">
  259. <summary>
  260. Gets or sets the function that is invoked when the Authenticated method is invoked.
  261. </summary>
  262. </member>
  263. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationProvider.OnReturnEndpoint">
  264. <summary>
  265. Gets or sets the function that is invoked when the ReturnEndpoint method is invoked.
  266. </summary>
  267. </member>
  268. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationProvider.OnApplyRedirect">
  269. <summary>
  270. Gets or sets the delegate that is invoked when the ApplyRedirect method is invoked.
  271. </summary>
  272. </member>
  273. <member name="T:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountReturnEndpointContext">
  274. <summary>
  275. Provides context information to middleware providers.
  276. </summary>
  277. </member>
  278. <member name="M:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountReturnEndpointContext.#ctor(Microsoft.Owin.IOwinContext,Microsoft.Owin.Security.AuthenticationTicket)">
  279. <summary>
  280. Initializes a new <see cref="T:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountReturnEndpointContext"/>.
  281. </summary>
  282. <param name="context">OWIN environment</param>
  283. <param name="ticket">The authentication ticket</param>
  284. </member>
  285. <member name="T:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountApplyRedirectContext">
  286. <summary>
  287. Context passed when a Challenge causes a redirect to authorize endpoint in the Microsoft account middleware
  288. </summary>
  289. </member>
  290. <member name="M:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountApplyRedirectContext.#ctor(Microsoft.Owin.IOwinContext,Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationOptions,Microsoft.Owin.Security.AuthenticationProperties,System.String)">
  291. <summary>
  292. Creates a new context object.
  293. </summary>
  294. <param name="context">The OWIN request context</param>
  295. <param name="options">The Microsoft account middleware options</param>
  296. <param name="properties">The authenticaiton properties of the challenge</param>
  297. <param name="redirectUri">The initial redirect URI</param>
  298. </member>
  299. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountApplyRedirectContext.RedirectUri">
  300. <summary>
  301. Gets the URI used for the redirect operation.
  302. </summary>
  303. </member>
  304. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountApplyRedirectContext.Properties">
  305. <summary>
  306. Gets the authenticaiton properties of the challenge
  307. </summary>
  308. </member>
  309. <member name="T:Microsoft.Owin.Security.MicrosoftAccount.Resources">
  310. <summary>
  311. A strongly-typed resource class, for looking up localized strings, etc.
  312. </summary>
  313. </member>
  314. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.Resources.ResourceManager">
  315. <summary>
  316. Returns the cached ResourceManager instance used by this class.
  317. </summary>
  318. </member>
  319. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.Resources.Culture">
  320. <summary>
  321. Overrides the current thread's CurrentUICulture property for all
  322. resource lookups using this strongly typed resource class.
  323. </summary>
  324. </member>
  325. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.Resources.Exception_MissingId">
  326. <summary>
  327. Looks up a localized string similar to The user does not have an id..
  328. </summary>
  329. </member>
  330. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.Resources.Exception_OptionMustBeProvided">
  331. <summary>
  332. Looks up a localized string similar to The &apos;{0}&apos; option must be provided..
  333. </summary>
  334. </member>
  335. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.Resources.Exception_ValidatorHandlerMismatch">
  336. <summary>
  337. Looks up a localized string similar to An ICertificateValidator cannot be specified at the same time as an HttpMessageHandler unless it is a WebRequestHandler..
  338. </summary>
  339. </member>
  340. </members>
  341. </doc>