You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

384 lines
22 KiB

4 years ago
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.Owin.Security.Twitter</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Microsoft.Owin.Security.Twitter.Messages.AccessToken">
  8. <summary>
  9. Twitter access token
  10. </summary>
  11. </member>
  12. <member name="T:Microsoft.Owin.Security.Twitter.Messages.RequestToken">
  13. <summary>
  14. Twitter request token
  15. </summary>
  16. </member>
  17. <member name="P:Microsoft.Owin.Security.Twitter.Messages.RequestToken.Token">
  18. <summary>
  19. Gets or sets the Twitter token
  20. </summary>
  21. </member>
  22. <member name="P:Microsoft.Owin.Security.Twitter.Messages.RequestToken.TokenSecret">
  23. <summary>
  24. Gets or sets the Twitter token secret
  25. </summary>
  26. </member>
  27. <member name="P:Microsoft.Owin.Security.Twitter.Messages.RequestToken.Properties">
  28. <summary>
  29. Gets or sets a property bag for common authentication properties
  30. </summary>
  31. </member>
  32. <member name="P:Microsoft.Owin.Security.Twitter.Messages.AccessToken.UserId">
  33. <summary>
  34. Gets or sets the Twitter User ID
  35. </summary>
  36. </member>
  37. <member name="P:Microsoft.Owin.Security.Twitter.Messages.AccessToken.ScreenName">
  38. <summary>
  39. Gets or sets the Twitter screen name
  40. </summary>
  41. </member>
  42. <member name="T:Microsoft.Owin.Security.Twitter.Messages.RequestTokenSerializer">
  43. <summary>
  44. Serializes and deserializes Twitter request and access tokens so that they can be used by other application components.
  45. </summary>
  46. </member>
  47. <member name="M:Microsoft.Owin.Security.Twitter.Messages.RequestTokenSerializer.Serialize(Microsoft.Owin.Security.Twitter.Messages.RequestToken)">
  48. <summary>
  49. Serialize a request token
  50. </summary>
  51. <param name="model">The token to serialize</param>
  52. <returns>A byte array containing the serialized token</returns>
  53. </member>
  54. <member name="M:Microsoft.Owin.Security.Twitter.Messages.RequestTokenSerializer.Deserialize(System.Byte[])">
  55. <summary>
  56. Deserializes a request token
  57. </summary>
  58. <param name="data">A byte array containing the serialized token</param>
  59. <returns>The Twitter request token</returns>
  60. </member>
  61. <member name="M:Microsoft.Owin.Security.Twitter.Messages.RequestTokenSerializer.Write(System.IO.BinaryWriter,Microsoft.Owin.Security.Twitter.Messages.RequestToken)">
  62. <summary>
  63. Writes a Twitter request token as a series of bytes. Used by the <see cref="M:Microsoft.Owin.Security.Twitter.Messages.RequestTokenSerializer.Serialize(Microsoft.Owin.Security.Twitter.Messages.RequestToken)"/> method.
  64. </summary>
  65. <param name="writer">The writer to use in writing the token</param>
  66. <param name="token">The token to write</param>
  67. </member>
  68. <member name="M:Microsoft.Owin.Security.Twitter.Messages.RequestTokenSerializer.Read(System.IO.BinaryReader)">
  69. <summary>
  70. Reads a Twitter request token from a series of bytes. Used by the <see cref="M:Microsoft.Owin.Security.Twitter.Messages.RequestTokenSerializer.Deserialize(System.Byte[])"/> method.
  71. </summary>
  72. <param name="reader">The reader to use in reading the token bytes</param>
  73. <returns>The token</returns>
  74. </member>
  75. <member name="T:Microsoft.Owin.Security.Twitter.Messages.Serializers">
  76. <summary>
  77. Provides access to a request token serializer
  78. </summary>
  79. </member>
  80. <member name="P:Microsoft.Owin.Security.Twitter.Messages.Serializers.RequestToken">
  81. <summary>
  82. Gets or sets a statically-avaliable serializer object. The value for this property will be <see cref="T:Microsoft.Owin.Security.Twitter.Messages.RequestTokenSerializer"/> by default.
  83. </summary>
  84. </member>
  85. <member name="T:Microsoft.Owin.Security.Twitter.ITwitterAuthenticationProvider">
  86. <summary>
  87. Specifies callback methods which the <see cref="T:Microsoft.Owin.Security.Twitter.TwitterAuthenticationMiddleware"></see> invokes to enable developer control over the authentication process. /&gt;
  88. </summary>
  89. </member>
  90. <member name="M:Microsoft.Owin.Security.Twitter.ITwitterAuthenticationProvider.Authenticated(Microsoft.Owin.Security.Twitter.TwitterAuthenticatedContext)">
  91. <summary>
  92. Invoked whenever Twitter succesfully authenticates a user
  93. </summary>
  94. <param name="context">Contains information about the login session as well as the user <see cref="T:System.Security.Claims.ClaimsIdentity"/>.</param>
  95. <returns>A <see cref="T:System.Threading.Tasks.Task"/> representing the completed operation.</returns>
  96. </member>
  97. <member name="M:Microsoft.Owin.Security.Twitter.ITwitterAuthenticationProvider.ReturnEndpoint(Microsoft.Owin.Security.Twitter.TwitterReturnEndpointContext)">
  98. <summary>
  99. 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.
  100. </summary>
  101. <param name="context"></param>
  102. <returns>A <see cref="T:System.Threading.Tasks.Task"/> representing the completed operation.</returns>
  103. </member>
  104. <member name="M:Microsoft.Owin.Security.Twitter.ITwitterAuthenticationProvider.ApplyRedirect(Microsoft.Owin.Security.Twitter.TwitterApplyRedirectContext)">
  105. <summary>
  106. Called when a Challenge causes a redirect to authorize endpoint in the Twitter middleware
  107. </summary>
  108. <param name="context">Contains redirect URI and <see cref="T:Microsoft.Owin.Security.AuthenticationProperties"/> of the challenge </param>
  109. </member>
  110. <member name="T:Microsoft.Owin.Security.Twitter.TwitterApplyRedirectContext">
  111. <summary>
  112. Context passed when a Challenge causes a redirect to authorize endpoint in the Twitter middleware
  113. </summary>
  114. </member>
  115. <member name="M:Microsoft.Owin.Security.Twitter.TwitterApplyRedirectContext.#ctor(Microsoft.Owin.IOwinContext,Microsoft.Owin.Security.Twitter.TwitterAuthenticationOptions,Microsoft.Owin.Security.AuthenticationProperties,System.String)">
  116. <summary>
  117. Creates a new context object.
  118. </summary>
  119. <param name="context">The OWIN request context</param>
  120. <param name="options">The Facebook middleware options</param>
  121. <param name="properties">The authenticaiton properties of the challenge</param>
  122. <param name="redirectUri">The initial redirect URI</param>
  123. </member>
  124. <member name="P:Microsoft.Owin.Security.Twitter.TwitterApplyRedirectContext.RedirectUri">
  125. <summary>
  126. Gets the URI used for the redirect operation.
  127. </summary>
  128. </member>
  129. <member name="P:Microsoft.Owin.Security.Twitter.TwitterApplyRedirectContext.Properties">
  130. <summary>
  131. Gets the authenticaiton properties of the challenge
  132. </summary>
  133. </member>
  134. <member name="T:Microsoft.Owin.Security.Twitter.TwitterAuthenticatedContext">
  135. <summary>
  136. Contains information about the login session as well as the user <see cref="T:System.Security.Claims.ClaimsIdentity"/>.
  137. </summary>
  138. </member>
  139. <member name="M:Microsoft.Owin.Security.Twitter.TwitterAuthenticatedContext.#ctor(Microsoft.Owin.IOwinContext,System.String,System.String,System.String,System.String)">
  140. <summary>
  141. Initializes a <see cref="T:Microsoft.Owin.Security.Twitter.TwitterAuthenticatedContext"/>
  142. </summary>
  143. <param name="context">The OWIN environment</param>
  144. <param name="userId">Twitter user ID</param>
  145. <param name="screenName">Twitter screen name</param>
  146. <param name="accessToken">Twitter access token</param>
  147. <param name="accessTokenSecret">Twitter access token secret</param>
  148. </member>
  149. <member name="P:Microsoft.Owin.Security.Twitter.TwitterAuthenticatedContext.UserId">
  150. <summary>
  151. Gets the Twitter user ID
  152. </summary>
  153. </member>
  154. <member name="P:Microsoft.Owin.Security.Twitter.TwitterAuthenticatedContext.ScreenName">
  155. <summary>
  156. Gets the Twitter screen name
  157. </summary>
  158. </member>
  159. <member name="P:Microsoft.Owin.Security.Twitter.TwitterAuthenticatedContext.AccessToken">
  160. <summary>
  161. Gets the Twitter access token
  162. </summary>
  163. </member>
  164. <member name="P:Microsoft.Owin.Security.Twitter.TwitterAuthenticatedContext.AccessTokenSecret">
  165. <summary>
  166. Gets the Twitter access token secret
  167. </summary>
  168. </member>
  169. <member name="P:Microsoft.Owin.Security.Twitter.TwitterAuthenticatedContext.Identity">
  170. <summary>
  171. Gets the <see cref="T:System.Security.Claims.ClaimsIdentity"/> representing the user
  172. </summary>
  173. </member>
  174. <member name="P:Microsoft.Owin.Security.Twitter.TwitterAuthenticatedContext.Properties">
  175. <summary>
  176. Gets or sets a property bag for common authentication properties
  177. </summary>
  178. </member>
  179. <member name="T:Microsoft.Owin.Security.Twitter.TwitterAuthenticationProvider">
  180. <summary>
  181. Default <see cref="T:Microsoft.Owin.Security.Twitter.ITwitterAuthenticationProvider"/> implementation.
  182. </summary>
  183. </member>
  184. <member name="M:Microsoft.Owin.Security.Twitter.TwitterAuthenticationProvider.#ctor">
  185. <summary>
  186. Initializes a <see cref="T:Microsoft.Owin.Security.Twitter.TwitterAuthenticationProvider"/>
  187. </summary>
  188. </member>
  189. <member name="M:Microsoft.Owin.Security.Twitter.TwitterAuthenticationProvider.Authenticated(Microsoft.Owin.Security.Twitter.TwitterAuthenticatedContext)">
  190. <summary>
  191. Invoked whenever Twitter succesfully authenticates a user
  192. </summary>
  193. <param name="context">Contains information about the login session as well as the user <see cref="T:System.Security.Claims.ClaimsIdentity"/>.</param>
  194. <returns>A <see cref="T:System.Threading.Tasks.Task"/> representing the completed operation.</returns>
  195. </member>
  196. <member name="M:Microsoft.Owin.Security.Twitter.TwitterAuthenticationProvider.ReturnEndpoint(Microsoft.Owin.Security.Twitter.TwitterReturnEndpointContext)">
  197. <summary>
  198. 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.
  199. </summary>
  200. <param name="context"></param>
  201. <returns>A <see cref="T:System.Threading.Tasks.Task"/> representing the completed operation.</returns>
  202. </member>
  203. <member name="M:Microsoft.Owin.Security.Twitter.TwitterAuthenticationProvider.ApplyRedirect(Microsoft.Owin.Security.Twitter.TwitterApplyRedirectContext)">
  204. <summary>
  205. Called when a Challenge causes a redirect to authorize endpoint in the Twitter middleware
  206. </summary>
  207. <param name="context">Contains redirect URI and <see cref="T:Microsoft.Owin.Security.AuthenticationProperties"/> of the challenge </param>
  208. </member>
  209. <member name="P:Microsoft.Owin.Security.Twitter.TwitterAuthenticationProvider.OnAuthenticated">
  210. <summary>
  211. Gets or sets the function that is invoked when the Authenticated method is invoked.
  212. </summary>
  213. </member>
  214. <member name="P:Microsoft.Owin.Security.Twitter.TwitterAuthenticationProvider.OnReturnEndpoint">
  215. <summary>
  216. Gets or sets the function that is invoked when the ReturnEndpoint method is invoked.
  217. </summary>
  218. </member>
  219. <member name="P:Microsoft.Owin.Security.Twitter.TwitterAuthenticationProvider.OnApplyRedirect">
  220. <summary>
  221. Gets or sets the delegate that is invoked when the ApplyRedirect method is invoked.
  222. </summary>
  223. </member>
  224. <member name="T:Microsoft.Owin.Security.Twitter.TwitterReturnEndpointContext">
  225. <summary>
  226. Provides context information to middleware providers.
  227. </summary>
  228. </member>
  229. <member name="M:Microsoft.Owin.Security.Twitter.TwitterReturnEndpointContext.#ctor(Microsoft.Owin.IOwinContext,Microsoft.Owin.Security.AuthenticationTicket)">
  230. <summary>
  231. Initializes a new <see cref="T:Microsoft.Owin.Security.Twitter.TwitterReturnEndpointContext"/>.
  232. </summary>
  233. <param name="context">OWIN environment</param>
  234. <param name="ticket">The authentication ticket</param>
  235. </member>
  236. <member name="T:Microsoft.Owin.Security.Twitter.Resources">
  237. <summary>
  238. A strongly-typed resource class, for looking up localized strings, etc.
  239. </summary>
  240. </member>
  241. <member name="P:Microsoft.Owin.Security.Twitter.Resources.ResourceManager">
  242. <summary>
  243. Returns the cached ResourceManager instance used by this class.
  244. </summary>
  245. </member>
  246. <member name="P:Microsoft.Owin.Security.Twitter.Resources.Culture">
  247. <summary>
  248. Overrides the current thread's CurrentUICulture property for all
  249. resource lookups using this strongly typed resource class.
  250. </summary>
  251. </member>
  252. <member name="P:Microsoft.Owin.Security.Twitter.Resources.Exception_OptionMustBeProvided">
  253. <summary>
  254. Looks up a localized string similar to The &apos;{0}&apos; option must be provided..
  255. </summary>
  256. </member>
  257. <member name="P:Microsoft.Owin.Security.Twitter.Resources.Exception_ValidatorHandlerMismatch">
  258. <summary>
  259. Looks up a localized string similar to An ICertificateValidator cannot be specified at the same time as an HttpMessageHandler unless it is a WebRequestHandler..
  260. </summary>
  261. </member>
  262. <member name="T:Owin.TwitterAuthenticationExtensions">
  263. <summary>
  264. Extension methods for using <see cref="T:Microsoft.Owin.Security.Twitter.TwitterAuthenticationMiddleware"/>
  265. </summary>
  266. </member>
  267. <member name="M:Owin.TwitterAuthenticationExtensions.UseTwitterAuthentication(Owin.IAppBuilder,Microsoft.Owin.Security.Twitter.TwitterAuthenticationOptions)">
  268. <summary>
  269. Authenticate users using Twitter
  270. </summary>
  271. <param name="app">The <see cref="T:Owin.IAppBuilder"/> passed to the configuration method</param>
  272. <param name="options">Middleware configuration options</param>
  273. <returns>The updated <see cref="T:Owin.IAppBuilder"/></returns>
  274. </member>
  275. <member name="M:Owin.TwitterAuthenticationExtensions.UseTwitterAuthentication(Owin.IAppBuilder,System.String,System.String)">
  276. <summary>
  277. Authenticate users using Twitter
  278. </summary>
  279. <param name="app">The <see cref="T:Owin.IAppBuilder"/> passed to the configuration method</param>
  280. <param name="consumerKey">The Twitter-issued consumer key</param>
  281. <param name="consumerSecret">The Twitter-issued consumer secret</param>
  282. <returns>The updated <see cref="T:Owin.IAppBuilder"/></returns>
  283. </member>
  284. <member name="T:Microsoft.Owin.Security.Twitter.TwitterAuthenticationMiddleware">
  285. <summary>
  286. OWIN middleware for authenticating users using Twitter
  287. </summary>
  288. </member>
  289. <member name="M:Microsoft.Owin.Security.Twitter.TwitterAuthenticationMiddleware.#ctor(Microsoft.Owin.OwinMiddleware,Owin.IAppBuilder,Microsoft.Owin.Security.Twitter.TwitterAuthenticationOptions)">
  290. <summary>
  291. Initializes a <see cref="T:Microsoft.Owin.Security.Twitter.TwitterAuthenticationMiddleware"/>
  292. </summary>
  293. <param name="next">The next middleware in the OWIN pipeline to invoke</param>
  294. <param name="app">The OWIN application</param>
  295. <param name="options">Configuration options for the middleware</param>
  296. </member>
  297. <member name="M:Microsoft.Owin.Security.Twitter.TwitterAuthenticationMiddleware.CreateHandler">
  298. <summary>
  299. Provides the <see cref="T:Microsoft.Owin.Security.Infrastructure.AuthenticationHandler"/> object for processing authentication-related requests.
  300. </summary>
  301. <returns>An <see cref="T:Microsoft.Owin.Security.Infrastructure.AuthenticationHandler"/> configured with the <see cref="T:Microsoft.Owin.Security.Twitter.TwitterAuthenticationOptions"/> supplied to the constructor.</returns>
  302. </member>
  303. <member name="T:Microsoft.Owin.Security.Twitter.TwitterAuthenticationOptions">
  304. <summary>
  305. Options for the Twitter authentication middleware.
  306. </summary>
  307. </member>
  308. <member name="M:Microsoft.Owin.Security.Twitter.TwitterAuthenticationOptions.#ctor">
  309. <summary>
  310. Initializes a new instance of the <see cref="T:Microsoft.Owin.Security.Twitter.TwitterAuthenticationOptions"/> class.
  311. </summary>
  312. </member>
  313. <member name="P:Microsoft.Owin.Security.Twitter.TwitterAuthenticationOptions.ConsumerKey">
  314. <summary>
  315. Gets or sets the consumer key used to communicate with Twitter.
  316. </summary>
  317. <value>The consumer key used to communicate with Twitter.</value>
  318. </member>
  319. <member name="P:Microsoft.Owin.Security.Twitter.TwitterAuthenticationOptions.ConsumerSecret">
  320. <summary>
  321. Gets or sets the consumer secret used to sign requests to Twitter.
  322. </summary>
  323. <value>The consumer secret used to sign requests to Twitter.</value>
  324. </member>
  325. <member name="P:Microsoft.Owin.Security.Twitter.TwitterAuthenticationOptions.BackchannelTimeout">
  326. <summary>
  327. Gets or sets timeout value in milliseconds for back channel communications with Twitter.
  328. </summary>
  329. <value>
  330. The back channel timeout.
  331. </value>
  332. </member>
  333. <member name="P:Microsoft.Owin.Security.Twitter.TwitterAuthenticationOptions.BackchannelCertificateValidator">
  334. <summary>
  335. Gets or sets the a pinned certificate validator to use to validate the endpoints used
  336. in back channel communications belong to Twitter.
  337. </summary>
  338. <value>
  339. The pinned certificate validator.
  340. </value>
  341. <remarks>If this property is null then the default certificate checks are performed,
  342. validating the subject name and if the signing chain is a trusted party.</remarks>
  343. </member>
  344. <member name="P:Microsoft.Owin.Security.Twitter.TwitterAuthenticationOptions.BackchannelHttpHandler">
  345. <summary>
  346. The HttpMessageHandler used to communicate with Twitter.
  347. This cannot be set at the same time as BackchannelCertificateValidator unless the value
  348. can be downcast to a WebRequestHandler.
  349. </summary>
  350. </member>
  351. <member name="P:Microsoft.Owin.Security.Twitter.TwitterAuthenticationOptions.Caption">
  352. <summary>
  353. Get or sets the text that the user can display on a sign in user interface.
  354. </summary>
  355. </member>
  356. <member name="P:Microsoft.Owin.Security.Twitter.TwitterAuthenticationOptions.CallbackPath">
  357. <summary>
  358. The request path within the application's base path where the user-agent will be returned.
  359. The middleware will process this request when it arrives.
  360. Default value is "/signin-twitter".
  361. </summary>
  362. </member>
  363. <member name="P:Microsoft.Owin.Security.Twitter.TwitterAuthenticationOptions.SignInAsAuthenticationType">
  364. <summary>
  365. 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"/>.
  366. </summary>
  367. </member>
  368. <member name="P:Microsoft.Owin.Security.Twitter.TwitterAuthenticationOptions.StateDataFormat">
  369. <summary>
  370. Gets or sets the type used to secure data handled by the middleware.
  371. </summary>
  372. </member>
  373. <member name="P:Microsoft.Owin.Security.Twitter.TwitterAuthenticationOptions.Provider">
  374. <summary>
  375. Gets or sets the <see cref="T:Microsoft.Owin.Security.Twitter.ITwitterAuthenticationProvider"/> used to handle authentication events.
  376. </summary>
  377. </member>
  378. <member name="P:Microsoft.Owin.Security.Twitter.TwitterAuthenticationOptions.CookieManager">
  379. <summary>
  380. An abstraction for reading and setting cookies during the authentication process.
  381. </summary>
  382. </member>
  383. </members>
  384. </doc>