Microsoft.IdentityModel.Logging.xml 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.IdentityModel.Logging</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Microsoft.IdentityModel.Logging.IdentityModelEventSource">
  8. <summary>
  9. Event source based logger to log different events.
  10. </summary>
  11. </member>
  12. <member name="P:Microsoft.IdentityModel.Logging.IdentityModelEventSource.Logger">
  13. <summary>
  14. Static logger that is exposed externally. An external application or framework can hook up a listener to this event source to log data in a custom way.
  15. </summary>
  16. </member>
  17. <member name="P:Microsoft.IdentityModel.Logging.IdentityModelEventSource.ShowPII">
  18. <summary>
  19. Flag which indicates whether or not PII is shown in logs. False by default.
  20. </summary>
  21. </member>
  22. <member name="P:Microsoft.IdentityModel.Logging.IdentityModelEventSource.HiddenPIIString">
  23. <summary>
  24. String that is used in place of any arguments to log messages if the 'ShowPII' flag is set to false.
  25. </summary>
  26. </member>
  27. <member name="P:Microsoft.IdentityModel.Logging.IdentityModelEventSource.HeaderWritten">
  28. <summary>
  29. Indicates whether or the log message header (contains library version, date/time, and PII debugging information) has been written.
  30. </summary>
  31. </member>
  32. <member name="F:Microsoft.IdentityModel.Logging.IdentityModelEventSource._versionLogMessage">
  33. <summary>
  34. The log message that indicates the current library version.
  35. </summary>
  36. </member>
  37. <member name="F:Microsoft.IdentityModel.Logging.IdentityModelEventSource._dateLogMessage">
  38. <summary>
  39. The log message that indicates the date.
  40. </summary>
  41. </member>
  42. <member name="F:Microsoft.IdentityModel.Logging.IdentityModelEventSource._piiOffLogMessage">
  43. <summary>
  44. The log message that is shown when PII is off.
  45. </summary>
  46. </member>
  47. <member name="F:Microsoft.IdentityModel.Logging.IdentityModelEventSource._piiOnLogMessage">
  48. <summary>
  49. The log message that is shown when PII is off.
  50. </summary>
  51. </member>
  52. <member name="M:Microsoft.IdentityModel.Logging.IdentityModelEventSource.WriteAlways(System.String)">
  53. <summary>
  54. Writes an event log by using the provided string argument and current UTC time.
  55. No level filtering is done on the event.
  56. </summary>
  57. <param name="message">The log message.</param>
  58. <remarks>No level filtering.</remarks>
  59. </member>
  60. <member name="M:Microsoft.IdentityModel.Logging.IdentityModelEventSource.WriteAlways(System.String,System.Object[])">
  61. <summary>
  62. Writes an event log by using the provided string argument, current UTC time and the provided arguments list.
  63. </summary>
  64. <param name="message">The log message.</param>
  65. <param name="args">An object array that contains zero or more objects to format.</param>
  66. </member>
  67. <member name="M:Microsoft.IdentityModel.Logging.IdentityModelEventSource.WriteVerbose(System.String)">
  68. <summary>
  69. Writes a verbose event log by using the provided string argument and current UTC time.
  70. </summary>
  71. <param name="message">The log message.</param>
  72. </member>
  73. <member name="M:Microsoft.IdentityModel.Logging.IdentityModelEventSource.WriteVerbose(System.String,System.Object[])">
  74. <summary>
  75. Writes a verbose event log by using the provided string argument, current UTC time and the provided arguments list.
  76. </summary>
  77. <param name="message">The log message.</param>
  78. <param name="args">An object array that contains zero or more objects to format.</param>
  79. </member>
  80. <member name="M:Microsoft.IdentityModel.Logging.IdentityModelEventSource.WriteInformation(System.String)">
  81. <summary>
  82. Writes an information event log by using the provided string argument and current UTC time.
  83. </summary>
  84. <param name="message">The log message.</param>
  85. </member>
  86. <member name="M:Microsoft.IdentityModel.Logging.IdentityModelEventSource.WriteInformation(System.String,System.Object[])">
  87. <summary>
  88. Writes an information event log by using the provided string argument, current UTC time and the provided arguments list.
  89. </summary>
  90. <param name="message">The log message.</param>
  91. <param name="args">An object array that contains zero or more objects to format.</param>
  92. </member>
  93. <member name="M:Microsoft.IdentityModel.Logging.IdentityModelEventSource.WriteWarning(System.String)">
  94. <summary>
  95. Writes a warning event log by using the provided string argument and current UTC time.
  96. </summary>
  97. <param name="message">The log message.</param>
  98. </member>
  99. <member name="M:Microsoft.IdentityModel.Logging.IdentityModelEventSource.WriteWarning(System.String,System.Object[])">
  100. <summary>
  101. Writes a warning event log by using the provided string argument, current UTC time and the provided arguments list.
  102. </summary>
  103. <param name="message">The log message.</param>
  104. <param name="args">An object array that contains zero or more objects to format.</param>
  105. </member>
  106. <member name="M:Microsoft.IdentityModel.Logging.IdentityModelEventSource.WriteError(System.String)">
  107. <summary>
  108. Writes an error event log by using the provided string argument and current UTC time.
  109. </summary>
  110. <param name="message">The log message.</param>
  111. </member>
  112. <member name="M:Microsoft.IdentityModel.Logging.IdentityModelEventSource.WriteError(System.String,System.Object[])">
  113. <summary>
  114. Writes an error event log by using the provided string argument, current UTC time and the provided arguments list.
  115. </summary>
  116. <param name="message">The log message.</param>
  117. <param name="args">An object array that contains zero or more objects to format.</param>
  118. </member>
  119. <member name="M:Microsoft.IdentityModel.Logging.IdentityModelEventSource.WriteCritical(System.String)">
  120. <summary>
  121. Writes a critical event log by using the provided string argument and current UTC time.
  122. </summary>
  123. <param name="message">The log message.</param>
  124. </member>
  125. <member name="M:Microsoft.IdentityModel.Logging.IdentityModelEventSource.WriteCritical(System.String,System.Object[])">
  126. <summary>
  127. Writes a critical event log by using the provided string argument, current UTC time and the provided arguments list.
  128. </summary>
  129. <param name="message">The log message.</param>
  130. <param name="args">An object array that contains zero or more objects to format.</param>
  131. </member>
  132. <member name="M:Microsoft.IdentityModel.Logging.IdentityModelEventSource.Write(System.Diagnostics.Tracing.EventLevel,System.Exception,System.String)">
  133. <summary>
  134. Writes an exception log by using the provided event identifer, exception argument, string argument and current UTC time.
  135. </summary>
  136. <param name="level"><see cref="T:System.Diagnostics.Tracing.EventLevel"/></param>
  137. <param name="innerException"><see cref="T:System.Exception"/></param>
  138. <param name="message">The log message.</param>
  139. </member>
  140. <member name="M:Microsoft.IdentityModel.Logging.IdentityModelEventSource.Write(System.Diagnostics.Tracing.EventLevel,System.Exception,System.String,System.Object[])">
  141. <summary>
  142. Writes an exception log by using the provided event identifer, exception argument, string argument, arguments list and current UTC time.
  143. </summary>
  144. <param name="level"><see cref="T:System.Diagnostics.Tracing.EventLevel"/></param>
  145. <param name="innerException"><see cref="T:System.Exception"/></param>
  146. <param name="message">The log message.</param>
  147. <param name="args">An object array that contains zero or more objects to format.</param>
  148. </member>
  149. <member name="P:Microsoft.IdentityModel.Logging.IdentityModelEventSource.LogLevel">
  150. <summary>
  151. Minimum log level to log events. Default is Warning.
  152. </summary>
  153. </member>
  154. <member name="T:Microsoft.IdentityModel.Logging.LogHelper">
  155. <summary>
  156. Helper class for logging.
  157. </summary>
  158. </member>
  159. <member name="M:Microsoft.IdentityModel.Logging.LogHelper.LogArgumentNullException(System.String)">
  160. <summary>
  161. Logs an exception using the event source logger and returns new <see cref="T:System.ArgumentNullException"/> exception.
  162. </summary>
  163. <param name="argument">argument that is null or empty.</param>
  164. <remarks>EventLevel is set to Error.</remarks>
  165. </member>
  166. <member name="M:Microsoft.IdentityModel.Logging.LogHelper.LogException``1(System.String)">
  167. <summary>
  168. Logs an exception using the event source logger and returns new typed exception.
  169. </summary>
  170. <param name="message">message to log.</param>
  171. <remarks>EventLevel is set to Error.</remarks>
  172. </member>
  173. <member name="M:Microsoft.IdentityModel.Logging.LogHelper.LogArgumentException``1(System.String,System.String)">
  174. <summary>
  175. Logs an argument exception using the event source logger and returns new typed exception.
  176. </summary>
  177. <param name="argumentName">Identifies the argument whose value generated the ArgumentException.</param>
  178. <param name="message">message to log.</param>
  179. <remarks>EventLevel is set to Error.</remarks>
  180. </member>
  181. <member name="M:Microsoft.IdentityModel.Logging.LogHelper.LogException``1(System.String,System.Object[])">
  182. <summary>
  183. Logs an exception using the event source logger and returns new typed exception.
  184. </summary>
  185. <param name="format">Format string of the log message.</param>
  186. <param name="args">An object array that contains zero or more objects to format.</param>
  187. <remarks>EventLevel is set to Error.</remarks>
  188. </member>
  189. <member name="M:Microsoft.IdentityModel.Logging.LogHelper.LogArgumentException``1(System.String,System.String,System.Object[])">
  190. <summary>
  191. Logs an argument exception using the event source logger and returns new typed exception.
  192. </summary>
  193. <param name="argumentName">Identifies the argument whose value generated the ArgumentException.</param>
  194. <param name="format">Format string of the log message.</param>
  195. <param name="args">An object array that contains zero or more objects to format.</param>
  196. <remarks>EventLevel is set to Error.</remarks>
  197. </member>
  198. <member name="M:Microsoft.IdentityModel.Logging.LogHelper.LogException``1(System.Exception,System.String)">
  199. <summary>
  200. Logs an exception using the event source logger and returns new typed exception.
  201. </summary>
  202. <param name="innerException">the inner <see cref="T:System.Exception"/> to be added to the outer exception.</param>
  203. <param name="message">message to log.</param>
  204. <remarks>EventLevel is set to Error.</remarks>
  205. </member>
  206. <member name="M:Microsoft.IdentityModel.Logging.LogHelper.LogArgumentException``1(System.String,System.Exception,System.String)">
  207. <summary>
  208. Logs an argument exception using the event source logger and returns new typed exception.
  209. </summary>
  210. <param name="argumentName">Identifies the argument whose value generated the ArgumentException.</param>
  211. <param name="innerException">the inner <see cref="T:System.Exception"/> to be added to the outer exception.</param>
  212. <param name="message">message to log.</param>
  213. <remarks>EventLevel is set to Error.</remarks>
  214. </member>
  215. <member name="M:Microsoft.IdentityModel.Logging.LogHelper.LogException``1(System.Exception,System.String,System.Object[])">
  216. <summary>
  217. Logs an exception using the event source logger and returns new typed exception.
  218. </summary>
  219. <param name="innerException">the inner <see cref="T:System.Exception"/> to be added to the outer exception.</param>
  220. <param name="format">Format string of the log message.</param>
  221. <param name="args">An object array that contains zero or more objects to format.</param>
  222. <remarks>EventLevel is set to Error.</remarks>
  223. </member>
  224. <member name="M:Microsoft.IdentityModel.Logging.LogHelper.LogArgumentException``1(System.String,System.Exception,System.String,System.Object[])">
  225. <summary>
  226. Logs an argument exception using the event source logger and returns new typed exception.
  227. </summary>
  228. <param name="argumentName">Identifies the argument whose value generated the ArgumentException.</param>
  229. <param name="innerException">the inner <see cref="T:System.Exception"/> to be added to the outer exception.</param>
  230. <param name="format">Format string of the log message.</param>
  231. <param name="args">An object array that contains zero or more objects to format.</param>
  232. <remarks>EventLevel is set to Error.</remarks>
  233. </member>
  234. <member name="M:Microsoft.IdentityModel.Logging.LogHelper.LogException``1(System.Diagnostics.Tracing.EventLevel,System.String)">
  235. <summary>
  236. Logs an exception using the event source logger and returns new typed exception.
  237. </summary>
  238. <param name="eventLevel">Identifies the level of an event to be logged.</param>
  239. <param name="message">message to log.</param>
  240. </member>
  241. <member name="M:Microsoft.IdentityModel.Logging.LogHelper.LogArgumentException``1(System.Diagnostics.Tracing.EventLevel,System.String,System.String)">
  242. <summary>
  243. Logs an argument exception using the event source logger and returns new typed exception.
  244. </summary>
  245. <param name="eventLevel">Identifies the level of an event to be logged.</param>
  246. <param name="argumentName">Identifies the argument whose value generated the ArgumentException.</param>
  247. <param name="message">message to log.</param>
  248. </member>
  249. <member name="M:Microsoft.IdentityModel.Logging.LogHelper.LogException``1(System.Diagnostics.Tracing.EventLevel,System.String,System.Object[])">
  250. <summary>
  251. Logs an exception using the event source logger and returns new typed exception.
  252. </summary>
  253. <param name="eventLevel">Identifies the level of an event to be logged.</param>
  254. <param name="format">Format string of the log message.</param>
  255. <param name="args">An object array that contains zero or more objects to format.</param>
  256. </member>
  257. <member name="M:Microsoft.IdentityModel.Logging.LogHelper.LogArgumentException``1(System.Diagnostics.Tracing.EventLevel,System.String,System.String,System.Object[])">
  258. <summary>
  259. Logs an argument exception using the event source logger and returns new typed exception.
  260. </summary>
  261. <param name="eventLevel">Identifies the level of an event to be logged.</param>
  262. <param name="argumentName">Identifies the argument whose value generated the ArgumentException.</param>
  263. <param name="format">Format string of the log message.</param>
  264. <param name="args">An object array that contains zero or more objects to format.</param>
  265. </member>
  266. <member name="M:Microsoft.IdentityModel.Logging.LogHelper.LogException``1(System.Diagnostics.Tracing.EventLevel,System.Exception,System.String)">
  267. <summary>
  268. Logs an exception using the event source logger and returns new typed exception.
  269. </summary>
  270. <param name="eventLevel">Identifies the level of an event to be logged.</param>
  271. <param name="innerException">the inner <see cref="T:System.Exception"/> to be added to the outer exception.</param>
  272. <param name="message">message to log.</param>
  273. </member>
  274. <member name="M:Microsoft.IdentityModel.Logging.LogHelper.LogArgumentException``1(System.Diagnostics.Tracing.EventLevel,System.String,System.Exception,System.String)">
  275. <summary>
  276. Logs an argument exception using the event source logger and returns new typed exception.
  277. </summary>
  278. <param name="eventLevel">Identifies the level of an event to be logged.</param>
  279. <param name="argumentName">Identifies the argument whose value generated the ArgumentException.</param>
  280. <param name="innerException">the inner <see cref="T:System.Exception"/> to be added to the outer exception.</param>
  281. <param name="message">message to log.</param>
  282. </member>
  283. <member name="M:Microsoft.IdentityModel.Logging.LogHelper.LogException``1(System.Diagnostics.Tracing.EventLevel,System.Exception,System.String,System.Object[])">
  284. <summary>
  285. Logs an exception using the event source logger and returns new typed exception.
  286. </summary>
  287. <param name="eventLevel">Identifies the level of an event to be logged.</param>
  288. <param name="innerException">the inner <see cref="T:System.Exception"/> to be added to the outer exception.</param>
  289. <param name="format">Format string of the log message.</param>
  290. <param name="args">An object array that contains zero or more objects to format.</param>
  291. </member>
  292. <member name="M:Microsoft.IdentityModel.Logging.LogHelper.LogArgumentException``1(System.Diagnostics.Tracing.EventLevel,System.String,System.Exception,System.String,System.Object[])">
  293. <summary>
  294. Logs an argument exception using the event source logger and returns new typed exception.
  295. </summary>
  296. <param name="eventLevel">Identifies the level of an event to be logged.</param>
  297. <param name="argumentName">Identifies the argument whose value generated the ArgumentException.</param>
  298. <param name="innerException">the inner <see cref="T:System.Exception"/> to be added to the outer exception.</param>
  299. <param name="format">Format string of the log message.</param>
  300. <param name="args">An object array that contains zero or more objects to format.</param>
  301. </member>
  302. <member name="M:Microsoft.IdentityModel.Logging.LogHelper.LogExceptionMessage(System.Exception)">
  303. <summary>
  304. Logs an exception using the event source logger.
  305. </summary>
  306. <param name="exception">The exception to log.</param>
  307. </member>
  308. <member name="M:Microsoft.IdentityModel.Logging.LogHelper.LogExceptionMessage(System.Diagnostics.Tracing.EventLevel,System.Exception)">
  309. <summary>
  310. Logs an exception using the event source logger.
  311. </summary>
  312. <param name="eventLevel">Identifies the level of an event to be logged.</param>
  313. <param name="exception">The exception to log.</param>
  314. </member>
  315. <member name="M:Microsoft.IdentityModel.Logging.LogHelper.LogInformation(System.String,System.Object[])">
  316. <summary>
  317. Logs an information event.
  318. </summary>
  319. <param name="message">The log message.</param>
  320. <param name="args">An object array that contains zero or more objects to format.</param>
  321. </member>
  322. <member name="M:Microsoft.IdentityModel.Logging.LogHelper.LogVerbose(System.String,System.Object[])">
  323. <summary>
  324. Logs a verbose event.
  325. </summary>
  326. <param name="message">The log message.</param>
  327. <param name="args">An object array that contains zero or more objects to format.</param>
  328. </member>
  329. <member name="M:Microsoft.IdentityModel.Logging.LogHelper.LogWarning(System.String,System.Object[])">
  330. <summary>
  331. Logs a warning event.
  332. </summary>
  333. <param name="message">The log message.</param>
  334. <param name="args">An object array that contains zero or more objects to format.</param>
  335. </member>
  336. <member name="M:Microsoft.IdentityModel.Logging.LogHelper.LogExceptionImpl``1(System.Diagnostics.Tracing.EventLevel,System.String,System.Exception,System.String,System.Object[])">
  337. <summary>
  338. Logs an exception using the event source logger and returns new typed exception.
  339. </summary>
  340. <param name="eventLevel">Identifies the level of an event to be logged.</param>
  341. <param name="argumentName">Identifies the argument whose value generated the ArgumentException.</param>
  342. <param name="innerException">the inner <see cref="T:System.Exception"/> to be added to the outer exception.</param>
  343. <param name="format">Format string of the log message.</param>
  344. <param name="args">An object array that contains zero or more objects to format.</param>
  345. </member>
  346. <member name="M:Microsoft.IdentityModel.Logging.LogHelper.FormatInvariant(System.String,System.Object[])">
  347. <summary>
  348. Formats the string using InvariantCulture
  349. </summary>
  350. <param name="format">Format string.</param>
  351. <param name="args">Format arguments.</param>
  352. <returns>Formatted string.</returns>
  353. </member>
  354. <member name="T:Microsoft.IdentityModel.Logging.LogMessages">
  355. <summary>
  356. Log messages and codes for Microsoft.IdentityModel.Logging
  357. </summary>
  358. </member>
  359. <member name="T:Microsoft.IdentityModel.Logging.TextWriterEventListener">
  360. <summary>
  361. Event listener that writes logs to a file or a fileStream provided by user.
  362. </summary>
  363. </member>
  364. <member name="F:Microsoft.IdentityModel.Logging.TextWriterEventListener.DefaultLogFileName">
  365. <summary>
  366. Name of the default log file, excluding its path.
  367. </summary>
  368. </member>
  369. <member name="M:Microsoft.IdentityModel.Logging.TextWriterEventListener.#ctor">
  370. <summary>
  371. Initializes a new instance of <see cref="T:Microsoft.IdentityModel.Logging.TextWriterEventListener"/> that writes logs to text file.
  372. </summary>
  373. </member>
  374. <member name="M:Microsoft.IdentityModel.Logging.TextWriterEventListener.#ctor(System.String)">
  375. <summary>
  376. Initializes a new instance of <see cref="T:Microsoft.IdentityModel.Logging.TextWriterEventListener"/> that writes logs to text file.
  377. </summary>
  378. <param name="filePath">location of the file where log messages will be written.</param>
  379. </member>
  380. <member name="M:Microsoft.IdentityModel.Logging.TextWriterEventListener.#ctor(System.IO.StreamWriter)">
  381. <summary>
  382. Initializes a new instance of <see cref="T:Microsoft.IdentityModel.Logging.TextWriterEventListener"/> that writes logs to text file.
  383. </summary>
  384. <param name="streamWriter">StreamWriter where logs will be written.</param>
  385. </member>
  386. <member name="M:Microsoft.IdentityModel.Logging.TextWriterEventListener.OnEventWritten(System.Diagnostics.Tracing.EventWrittenEventArgs)">
  387. <summary>
  388. Called whenever an event has been written by an event source for which the event listener has enabled events.
  389. </summary>
  390. <param name="eventData"><see cref="T:System.Diagnostics.Tracing.EventWrittenEventArgs"/></param>
  391. </member>
  392. <member name="M:Microsoft.IdentityModel.Logging.TextWriterEventListener.Dispose">
  393. <summary>
  394. Releases all resources used by the current instance of the <see cref="T:Microsoft.IdentityModel.Logging.TextWriterEventListener"/> class.
  395. </summary>
  396. </member>
  397. </members>
  398. </doc>