Microsoft.IdentityModel.Logging.xml 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533
  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.IdentityModelTelemetryUtil">
  155. <summary>
  156. Provides a way to add and remove telemetry data.
  157. </summary>
  158. </member>
  159. <member name="P:Microsoft.IdentityModel.Logging.IdentityModelTelemetryUtil.ClientSku">
  160. <summary>
  161. Get the string that represents the client SKU.
  162. </summary>
  163. </member>
  164. <member name="P:Microsoft.IdentityModel.Logging.IdentityModelTelemetryUtil.ClientVer">
  165. <summary>
  166. Get the string that represents the client version.
  167. </summary>
  168. </member>
  169. <member name="M:Microsoft.IdentityModel.Logging.IdentityModelTelemetryUtil.AddTelemetryData(System.String,System.String)">
  170. <summary>
  171. Adds a key and its value to the collection of telemetry data.
  172. </summary>
  173. <param name="key"> The name of the telemetry.</param>
  174. <param name="value"> The value of the telemetry.</param>
  175. <returns> true if the key is successfully added; otherwise, false.</returns>
  176. </member>
  177. <member name="M:Microsoft.IdentityModel.Logging.IdentityModelTelemetryUtil.RemoveTelemetryData(System.String)">
  178. <summary>
  179. Removes a key and its value from the collection of telemetry data.
  180. </summary>
  181. <param name="key"> The name of the telemetry.</param>
  182. <returns> true if the key is successfully removed; otherwise, false.</returns>
  183. </member>
  184. <member name="T:Microsoft.IdentityModel.Logging.LoggerContext">
  185. <summary>
  186. A context class that can be used to store work per request to aid with debugging.
  187. </summary>
  188. </member>
  189. <member name="M:Microsoft.IdentityModel.Logging.LoggerContext.#ctor">
  190. <summary>
  191. Instantiates a new <see cref="T:Microsoft.IdentityModel.Logging.LoggerContext"/> with the default activityId.
  192. </summary>
  193. </member>
  194. <member name="M:Microsoft.IdentityModel.Logging.LoggerContext.#ctor(System.Guid)">
  195. <summary>
  196. Instantiates a new <see cref="T:Microsoft.IdentityModel.Logging.LoggerContext"/> with an activityId.
  197. </summary>
  198. <param name="activityId"></param>
  199. </member>
  200. <member name="P:Microsoft.IdentityModel.Logging.LoggerContext.ActivityId">
  201. <summary>
  202. Gets or set a <see cref="T:System.Guid"/> that will be used in the call to EventSource.SetCurrentThreadActivityId before logging.
  203. </summary>
  204. </member>
  205. <member name="P:Microsoft.IdentityModel.Logging.LoggerContext.CaptureLogs">
  206. <summary>
  207. Gets or sets a boolean controlling if logs are written into the context.
  208. Useful when debugging.
  209. </summary>
  210. </member>
  211. <member name="P:Microsoft.IdentityModel.Logging.LoggerContext.DebugId">
  212. <summary>
  213. Gets or sets a string that helps with setting breakpoints when debugging.
  214. </summary>
  215. </member>
  216. <member name="P:Microsoft.IdentityModel.Logging.LoggerContext.Logs">
  217. <summary>
  218. The collection of logs associated with a request. Use <see cref="P:Microsoft.IdentityModel.Logging.LoggerContext.CaptureLogs"/> to control capture.
  219. </summary>
  220. </member>
  221. <member name="P:Microsoft.IdentityModel.Logging.LoggerContext.PropertyBag">
  222. <summary>
  223. Gets or sets an <see cref="T:System.Collections.Generic.IDictionary`2"/> that enables custom extensibility scenarios.
  224. </summary>
  225. </member>
  226. <member name="T:Microsoft.IdentityModel.Logging.LogHelper">
  227. <summary>
  228. Helper class for logging.
  229. </summary>
  230. </member>
  231. <member name="P:Microsoft.IdentityModel.Logging.LogHelper.Logger">
  232. <summary>
  233. Gets or sets a logger to which logs will be written to.
  234. </summary>
  235. </member>
  236. <member name="F:Microsoft.IdentityModel.Logging.LogHelper._isHeaderWritten">
  237. <summary>
  238. Indicates whether the log message header (contains library version, date/time, and PII debugging information) has been written.
  239. </summary>
  240. </member>
  241. <member name="F:Microsoft.IdentityModel.Logging.LogHelper._piiOffLogMessage">
  242. <summary>
  243. The log message that is shown when PII is off.
  244. </summary>
  245. </member>
  246. <member name="F:Microsoft.IdentityModel.Logging.LogHelper._piiOnLogMessage">
  247. <summary>
  248. The log message that is shown when PII is on.
  249. </summary>
  250. </member>
  251. <member name="M:Microsoft.IdentityModel.Logging.LogHelper.LogArgumentNullException(System.String)">
  252. <summary>
  253. Logs an exception using the event source logger and returns new <see cref="T:System.ArgumentNullException"/> exception.
  254. </summary>
  255. <param name="argument">argument that is null or empty.</param>
  256. <remarks>EventLevel is set to Error.</remarks>
  257. </member>
  258. <member name="M:Microsoft.IdentityModel.Logging.LogHelper.LogException``1(System.String)">
  259. <summary>
  260. Logs an exception using the event source logger and returns new typed exception.
  261. </summary>
  262. <param name="message">message to log.</param>
  263. <remarks>EventLevel is set to Error.</remarks>
  264. </member>
  265. <member name="M:Microsoft.IdentityModel.Logging.LogHelper.LogArgumentException``1(System.String,System.String)">
  266. <summary>
  267. Logs an argument exception using the event source logger and returns new typed exception.
  268. </summary>
  269. <param name="argumentName">Identifies the argument whose value generated the ArgumentException.</param>
  270. <param name="message">message to log.</param>
  271. <remarks>EventLevel is set to Error.</remarks>
  272. </member>
  273. <member name="M:Microsoft.IdentityModel.Logging.LogHelper.LogException``1(System.String,System.Object[])">
  274. <summary>
  275. Logs an exception using the event source logger and returns new typed exception.
  276. </summary>
  277. <param name="format">Format string of the log message.</param>
  278. <param name="args">An object array that contains zero or more objects to format.</param>
  279. <remarks>EventLevel is set to Error.</remarks>
  280. </member>
  281. <member name="M:Microsoft.IdentityModel.Logging.LogHelper.LogArgumentException``1(System.String,System.String,System.Object[])">
  282. <summary>
  283. Logs an argument exception using the event source logger and returns new typed exception.
  284. </summary>
  285. <param name="argumentName">Identifies the argument whose value generated the ArgumentException.</param>
  286. <param name="format">Format string of the log message.</param>
  287. <param name="args">An object array that contains zero or more objects to format.</param>
  288. <remarks>EventLevel is set to Error.</remarks>
  289. </member>
  290. <member name="M:Microsoft.IdentityModel.Logging.LogHelper.LogException``1(System.Exception,System.String)">
  291. <summary>
  292. Logs an exception using the event source logger and returns new typed exception.
  293. </summary>
  294. <param name="innerException">the inner <see cref="T:System.Exception"/> to be added to the outer exception.</param>
  295. <param name="message">message to log.</param>
  296. <remarks>EventLevel is set to Error.</remarks>
  297. </member>
  298. <member name="M:Microsoft.IdentityModel.Logging.LogHelper.LogArgumentException``1(System.String,System.Exception,System.String)">
  299. <summary>
  300. Logs an argument exception using the event source logger and returns new typed exception.
  301. </summary>
  302. <param name="argumentName">Identifies the argument whose value generated the ArgumentException.</param>
  303. <param name="innerException">the inner <see cref="T:System.Exception"/> to be added to the outer exception.</param>
  304. <param name="message">message to log.</param>
  305. <remarks>EventLevel is set to Error.</remarks>
  306. </member>
  307. <member name="M:Microsoft.IdentityModel.Logging.LogHelper.LogException``1(System.Exception,System.String,System.Object[])">
  308. <summary>
  309. Logs an exception using the event source logger and returns new typed exception.
  310. </summary>
  311. <param name="innerException">the inner <see cref="T:System.Exception"/> to be added to the outer exception.</param>
  312. <param name="format">Format string of the log message.</param>
  313. <param name="args">An object array that contains zero or more objects to format.</param>
  314. <remarks>EventLevel is set to Error.</remarks>
  315. </member>
  316. <member name="M:Microsoft.IdentityModel.Logging.LogHelper.LogArgumentException``1(System.String,System.Exception,System.String,System.Object[])">
  317. <summary>
  318. Logs an argument exception using the event source logger and returns new typed exception.
  319. </summary>
  320. <param name="argumentName">Identifies the argument whose value generated the ArgumentException.</param>
  321. <param name="innerException">the inner <see cref="T:System.Exception"/> to be added to the outer exception.</param>
  322. <param name="format">Format string of the log message.</param>
  323. <param name="args">An object array that contains zero or more objects to format.</param>
  324. <remarks>EventLevel is set to Error.</remarks>
  325. </member>
  326. <member name="M:Microsoft.IdentityModel.Logging.LogHelper.LogException``1(System.Diagnostics.Tracing.EventLevel,System.String)">
  327. <summary>
  328. Logs an exception using the event source logger and returns new typed exception.
  329. </summary>
  330. <param name="eventLevel">Identifies the level of an event to be logged.</param>
  331. <param name="message">message to log.</param>
  332. </member>
  333. <member name="M:Microsoft.IdentityModel.Logging.LogHelper.LogArgumentException``1(System.Diagnostics.Tracing.EventLevel,System.String,System.String)">
  334. <summary>
  335. Logs an argument exception using the event source logger and returns new typed exception.
  336. </summary>
  337. <param name="eventLevel">Identifies the level of an event to be logged.</param>
  338. <param name="argumentName">Identifies the argument whose value generated the ArgumentException.</param>
  339. <param name="message">message to log.</param>
  340. </member>
  341. <member name="M:Microsoft.IdentityModel.Logging.LogHelper.LogException``1(System.Diagnostics.Tracing.EventLevel,System.String,System.Object[])">
  342. <summary>
  343. Logs an exception using the event source logger and returns new typed exception.
  344. </summary>
  345. <param name="eventLevel">Identifies the level of an event to be logged.</param>
  346. <param name="format">Format string of the log message.</param>
  347. <param name="args">An object array that contains zero or more objects to format.</param>
  348. </member>
  349. <member name="M:Microsoft.IdentityModel.Logging.LogHelper.LogArgumentException``1(System.Diagnostics.Tracing.EventLevel,System.String,System.String,System.Object[])">
  350. <summary>
  351. Logs an argument exception using the event source logger and returns new typed exception.
  352. </summary>
  353. <param name="eventLevel">Identifies the level of an event to be logged.</param>
  354. <param name="argumentName">Identifies the argument whose value generated the ArgumentException.</param>
  355. <param name="format">Format string of the log message.</param>
  356. <param name="args">An object array that contains zero or more objects to format.</param>
  357. </member>
  358. <member name="M:Microsoft.IdentityModel.Logging.LogHelper.LogException``1(System.Diagnostics.Tracing.EventLevel,System.Exception,System.String)">
  359. <summary>
  360. Logs an exception using the event source logger and returns new typed exception.
  361. </summary>
  362. <param name="eventLevel">Identifies the level of an event to be logged.</param>
  363. <param name="innerException">the inner <see cref="T:System.Exception"/> to be added to the outer exception.</param>
  364. <param name="message">message to log.</param>
  365. </member>
  366. <member name="M:Microsoft.IdentityModel.Logging.LogHelper.LogArgumentException``1(System.Diagnostics.Tracing.EventLevel,System.String,System.Exception,System.String)">
  367. <summary>
  368. Logs an argument exception using the event source logger and returns new typed exception.
  369. </summary>
  370. <param name="eventLevel">Identifies the level of an event to be logged.</param>
  371. <param name="argumentName">Identifies the argument whose value generated the ArgumentException.</param>
  372. <param name="innerException">the inner <see cref="T:System.Exception"/> to be added to the outer exception.</param>
  373. <param name="message">message to log.</param>
  374. </member>
  375. <member name="M:Microsoft.IdentityModel.Logging.LogHelper.LogException``1(System.Diagnostics.Tracing.EventLevel,System.Exception,System.String,System.Object[])">
  376. <summary>
  377. Logs an exception using the event source logger and returns new typed exception.
  378. </summary>
  379. <param name="eventLevel">Identifies the level of an event to be logged.</param>
  380. <param name="innerException">the inner <see cref="T:System.Exception"/> to be added to the outer exception.</param>
  381. <param name="format">Format string of the log message.</param>
  382. <param name="args">An object array that contains zero or more objects to format.</param>
  383. </member>
  384. <member name="M:Microsoft.IdentityModel.Logging.LogHelper.LogArgumentException``1(System.Diagnostics.Tracing.EventLevel,System.String,System.Exception,System.String,System.Object[])">
  385. <summary>
  386. Logs an argument exception using the event source logger and returns new typed exception.
  387. </summary>
  388. <param name="eventLevel">Identifies the level of an event to be logged.</param>
  389. <param name="argumentName">Identifies the argument whose value generated the ArgumentException.</param>
  390. <param name="innerException">the inner <see cref="T:System.Exception"/> to be added to the outer exception.</param>
  391. <param name="format">Format string of the log message.</param>
  392. <param name="args">An object array that contains zero or more objects to format.</param>
  393. </member>
  394. <member name="M:Microsoft.IdentityModel.Logging.LogHelper.LogExceptionMessage(System.Exception)">
  395. <summary>
  396. Logs an exception using the event source logger.
  397. </summary>
  398. <param name="exception">The exception to log.</param>
  399. </member>
  400. <member name="M:Microsoft.IdentityModel.Logging.LogHelper.LogExceptionMessage(System.Diagnostics.Tracing.EventLevel,System.Exception)">
  401. <summary>
  402. Logs an exception using the event source logger.
  403. </summary>
  404. <param name="eventLevel">Identifies the level of an event to be logged.</param>
  405. <param name="exception">The exception to log.</param>
  406. </member>
  407. <member name="M:Microsoft.IdentityModel.Logging.LogHelper.LogInformation(System.String,System.Object[])">
  408. <summary>
  409. Logs an information event.
  410. </summary>
  411. <param name="message">The log message.</param>
  412. <param name="args">An object array that contains zero or more objects to format.</param>
  413. </member>
  414. <member name="M:Microsoft.IdentityModel.Logging.LogHelper.LogVerbose(System.String,System.Object[])">
  415. <summary>
  416. Logs a verbose event.
  417. </summary>
  418. <param name="message">The log message.</param>
  419. <param name="args">An object array that contains zero or more objects to format.</param>
  420. </member>
  421. <member name="M:Microsoft.IdentityModel.Logging.LogHelper.LogWarning(System.String,System.Object[])">
  422. <summary>
  423. Logs a warning event.
  424. </summary>
  425. <param name="message">The log message.</param>
  426. <param name="args">An object array that contains zero or more objects to format.</param>
  427. </member>
  428. <member name="M:Microsoft.IdentityModel.Logging.LogHelper.LogExceptionImpl``1(System.Diagnostics.Tracing.EventLevel,System.String,System.Exception,System.String,System.Object[])">
  429. <summary>
  430. Logs an exception using the event source logger and returns new typed exception.
  431. </summary>
  432. <param name="eventLevel">Identifies the level of an event to be logged.</param>
  433. <param name="argumentName">Identifies the argument whose value generated the ArgumentException.</param>
  434. <param name="innerException">the inner <see cref="T:System.Exception"/> to be added to the outer exception.</param>
  435. <param name="format">Format string of the log message.</param>
  436. <param name="args">An object array that contains zero or more objects to format.</param>
  437. </member>
  438. <member name="M:Microsoft.IdentityModel.Logging.LogHelper.FormatInvariant(System.String,System.Object[])">
  439. <summary>
  440. Formats the string using InvariantCulture
  441. </summary>
  442. <param name="format">Format string.</param>
  443. <param name="args">Format arguments.</param>
  444. <returns>Formatted string.</returns>
  445. </member>
  446. <member name="M:Microsoft.IdentityModel.Logging.LogHelper.MarkAsNonPII(System.Object)">
  447. <summary>
  448. Marks a log message argument (<paramref name="arg"/>) as NonPII.
  449. </summary>
  450. <param name="arg">A log message argument to be marked as NonPII.</param>
  451. <returns>An argument marked as NonPII.</returns>
  452. <remarks>
  453. Marking an argument as NonPII in <see cref="M:Microsoft.IdentityModel.Logging.LogHelper.FormatInvariant(System.String,System.Object[])"/> calls will result in logging
  454. that argument in cleartext, regardless of the <see cref="P:Microsoft.IdentityModel.Logging.IdentityModelEventSource.ShowPII"/> flag value.
  455. </remarks>
  456. </member>
  457. <member name="M:Microsoft.IdentityModel.Logging.LogHelper.WriteEntry(Microsoft.IdentityModel.Abstractions.EventLogLevel,System.Exception,System.String,System.Object[])">
  458. <summary>
  459. Creates a <see cref="T:Microsoft.IdentityModel.Abstractions.LogEntry"/> by using the provided event level, exception argument, string argument and arguments list.
  460. </summary>
  461. <param name="eventLogLevel"><see cref="T:Microsoft.IdentityModel.Abstractions.EventLogLevel"/></param>
  462. <param name="innerException"><see cref="T:System.Exception"/></param>
  463. <param name="message">The log message.</param>
  464. <param name="args">An object array that contains zero or more objects to format.</param>
  465. </member>
  466. <member name="T:Microsoft.IdentityModel.Logging.LogMessages">
  467. <summary>
  468. Log messages and codes for Microsoft.IdentityModel.Logging
  469. </summary>
  470. </member>
  471. <member name="T:Microsoft.IdentityModel.Logging.NonPII">
  472. <summary>
  473. An internal structure that is used to mark an argument as NonPII.
  474. Arguments wrapped with a NonPII structure will be considered as NonPII in the message logging process.
  475. </summary>
  476. </member>
  477. <member name="P:Microsoft.IdentityModel.Logging.NonPII.Argument">
  478. <summary>
  479. Argument wrapped with a <see cref="T:Microsoft.IdentityModel.Logging.NonPII"/> structure is considered as NonPII in the message logging process.
  480. </summary>
  481. </member>
  482. <member name="M:Microsoft.IdentityModel.Logging.NonPII.#ctor(System.Object)">
  483. <summary>
  484. Creates an instance of <see cref="T:Microsoft.IdentityModel.Logging.NonPII"/> that wraps the <paramref name="argument"/>.
  485. </summary>
  486. <param name="argument">An argument that is considered as NonPII.</param>
  487. </member>
  488. <member name="M:Microsoft.IdentityModel.Logging.NonPII.ToString">
  489. <summary>
  490. Returns a string that represents the <see cref="P:Microsoft.IdentityModel.Logging.NonPII.Argument"/>.
  491. </summary>
  492. <returns><c>Null</c> if the <see cref="P:Microsoft.IdentityModel.Logging.NonPII.Argument"/> is <c>null</c>, otherwise calls <see cref="M:System.ValueType.ToString"/> method of the <see cref="P:Microsoft.IdentityModel.Logging.NonPII.Argument"/>.</returns>
  493. </member>
  494. <member name="T:Microsoft.IdentityModel.Logging.TextWriterEventListener">
  495. <summary>
  496. Event listener that writes logs to a file or a fileStream provided by user.
  497. </summary>
  498. </member>
  499. <member name="F:Microsoft.IdentityModel.Logging.TextWriterEventListener.DefaultLogFileName">
  500. <summary>
  501. Name of the default log file, excluding its path.
  502. </summary>
  503. </member>
  504. <member name="M:Microsoft.IdentityModel.Logging.TextWriterEventListener.#ctor">
  505. <summary>
  506. Initializes a new instance of <see cref="T:Microsoft.IdentityModel.Logging.TextWriterEventListener"/> that writes logs to text file.
  507. </summary>
  508. </member>
  509. <member name="M:Microsoft.IdentityModel.Logging.TextWriterEventListener.#ctor(System.String)">
  510. <summary>
  511. Initializes a new instance of <see cref="T:Microsoft.IdentityModel.Logging.TextWriterEventListener"/> that writes logs to text file.
  512. </summary>
  513. <param name="filePath">location of the file where log messages will be written.</param>
  514. </member>
  515. <member name="M:Microsoft.IdentityModel.Logging.TextWriterEventListener.#ctor(System.IO.StreamWriter)">
  516. <summary>
  517. Initializes a new instance of <see cref="T:Microsoft.IdentityModel.Logging.TextWriterEventListener"/> that writes logs to text file.
  518. </summary>
  519. <param name="streamWriter">StreamWriter where logs will be written.</param>
  520. </member>
  521. <member name="M:Microsoft.IdentityModel.Logging.TextWriterEventListener.OnEventWritten(System.Diagnostics.Tracing.EventWrittenEventArgs)">
  522. <summary>
  523. Called whenever an event has been written by an event source for which the event listener has enabled events.
  524. </summary>
  525. <param name="eventData"><see cref="T:System.Diagnostics.Tracing.EventWrittenEventArgs"/></param>
  526. </member>
  527. <member name="M:Microsoft.IdentityModel.Logging.TextWriterEventListener.Dispose">
  528. <summary>
  529. Releases all resources used by the current instance of the <see cref="T:Microsoft.IdentityModel.Logging.TextWriterEventListener"/> class.
  530. </summary>
  531. </member>
  532. </members>
  533. </doc>