Microsoft.IdentityModel.Abstractions.xml 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.IdentityModel.Abstractions</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Microsoft.IdentityModel.Abstractions.EventLogLevel">
  8. <summary>
  9. Defines Event Log Levels.
  10. </summary>
  11. </member>
  12. <member name="F:Microsoft.IdentityModel.Abstractions.EventLogLevel.LogAlways">
  13. <summary>
  14. No level filtering is done on this log level. Log messages of all levels will be logged.
  15. </summary>
  16. </member>
  17. <member name="F:Microsoft.IdentityModel.Abstractions.EventLogLevel.Critical">
  18. <summary>
  19. Logs that describe an unrecoverable application or system crash, or a catastrophic failure that requires
  20. immediate attention.
  21. </summary>
  22. </member>
  23. <member name="F:Microsoft.IdentityModel.Abstractions.EventLogLevel.Error">
  24. <summary>
  25. Logs that highlight when the current flow of execution is stopped due to a failure. These should indicate a
  26. failure in the current activity, not an application-wide failure.
  27. </summary>
  28. </member>
  29. <member name="F:Microsoft.IdentityModel.Abstractions.EventLogLevel.Warning">
  30. <summary>
  31. Logs that highlight an abnormal or unexpected event in the application flow, but do not otherwise cause the
  32. application execution to stop.
  33. </summary>
  34. </member>
  35. <member name="F:Microsoft.IdentityModel.Abstractions.EventLogLevel.Informational">
  36. <summary>
  37. Logs that track the general flow of the application. These logs should have long-term value.
  38. </summary>
  39. </member>
  40. <member name="F:Microsoft.IdentityModel.Abstractions.EventLogLevel.Verbose">
  41. <summary>
  42. Logs that are used for interactive investigation during development. These logs should primarily contain
  43. information useful for debugging and have no long-term value.
  44. </summary>
  45. </member>
  46. <member name="T:Microsoft.IdentityModel.Abstractions.IIdentityLogger">
  47. <summary>
  48. Interface that needs to be implemented by classes providing logging in Microsoft identity libraries.
  49. </summary>
  50. </member>
  51. <member name="M:Microsoft.IdentityModel.Abstractions.IIdentityLogger.IsEnabled(Microsoft.IdentityModel.Abstractions.EventLogLevel)">
  52. <summary>
  53. Checks to see if logging is enabled at given <paramref name="eventLogLevel"/>.
  54. </summary>
  55. <param name="eventLogLevel">Log level of a message.</param>
  56. </member>
  57. <member name="M:Microsoft.IdentityModel.Abstractions.IIdentityLogger.Log(Microsoft.IdentityModel.Abstractions.LogEntry)">
  58. <summary>
  59. Writes a log entry.
  60. </summary>
  61. <param name="entry">Defines a structured message to be logged at the provided <see cref="P:Microsoft.IdentityModel.Abstractions.LogEntry.EventLogLevel"/>.</param>
  62. </member>
  63. <member name="T:Microsoft.IdentityModel.Abstractions.ITelemetryClient">
  64. <summary>
  65. Interface for Telemetry tracking.
  66. </summary>
  67. </member>
  68. <member name="P:Microsoft.IdentityModel.Abstractions.ITelemetryClient.ClientId">
  69. <summary>
  70. Gets or sets the application or client ID that telemetry is being sent for.
  71. </summary>
  72. </member>
  73. <member name="M:Microsoft.IdentityModel.Abstractions.ITelemetryClient.Initialize">
  74. <summary>
  75. Perform any necessary bootstrapping for the telemetry client.
  76. </summary>
  77. <remarks>
  78. The expectation is that this should only be called once for the lifetime of the object however the
  79. implementation should be idempotent.
  80. </remarks>
  81. </member>
  82. <member name="M:Microsoft.IdentityModel.Abstractions.ITelemetryClient.IsEnabled">
  83. <summary>
  84. Checks to see if telemetry is enabled all up.
  85. </summary>
  86. <returns>
  87. Returns <see langword="true"/> if telemetry should be sent; <see langword="false"/> otherwise.
  88. </returns>
  89. <remarks>
  90. This check should be used to gate any resource intensive operations to generate telemetry as well.
  91. </remarks>
  92. </member>
  93. <member name="M:Microsoft.IdentityModel.Abstractions.ITelemetryClient.IsEnabled(System.String)">
  94. <summary>
  95. Checks to see if telemetry is enabled for the named event.
  96. </summary>
  97. <param name="eventName">Name of the event to check.</param>
  98. <returns>
  99. Returns <see langword="true"/> if telemetry should be sent for <paramref name="eventName"/>;
  100. <see langword="false"/> otherwise.
  101. </returns>
  102. <remarks>
  103. This check should be used to gate any resource intensive operations to generate telemetry as well.
  104. </remarks>
  105. </member>
  106. <member name="M:Microsoft.IdentityModel.Abstractions.ITelemetryClient.TrackEvent(Microsoft.IdentityModel.Abstractions.TelemetryEventDetails)">
  107. <summary>
  108. Tracks an instance of a named event.
  109. </summary>
  110. <param name="eventDetails">Details of the event to track.</param>
  111. </member>
  112. <member name="M:Microsoft.IdentityModel.Abstractions.ITelemetryClient.TrackEvent(System.String,System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.Int64},System.Collections.Generic.IDictionary{System.String,System.Boolean},System.Collections.Generic.IDictionary{System.String,System.DateTime},System.Collections.Generic.IDictionary{System.String,System.Double},System.Collections.Generic.IDictionary{System.String,System.Guid})">
  113. <summary>
  114. Tracks an instance of a named event.
  115. </summary>
  116. <param name="eventName">Name of the event to track. Should be unique per scenario.</param>
  117. <param name="stringProperties">Key value pair of strings to long with the event.</param>
  118. <param name="longProperties">Key value pair of longs to long with the event.</param>
  119. <param name="boolProperties">Key value pair of bools to long with the event.</param>
  120. <param name="dateTimeProperties">Key value pair of DateTimes to long with the event.</param>
  121. <param name="doubleProperties">Key value pair of doubles to long with the event.</param>
  122. <param name="guidProperties">Key value pair of Guids to long with the event.</param>
  123. </member>
  124. <member name="T:Microsoft.IdentityModel.Abstractions.LogEntry">
  125. <summary>
  126. Defines the structure of a log entry.
  127. </summary>
  128. </member>
  129. <member name="P:Microsoft.IdentityModel.Abstractions.LogEntry.EventLogLevel">
  130. <summary>
  131. Defines the <see cref="P:Microsoft.IdentityModel.Abstractions.LogEntry.EventLogLevel"/>.
  132. </summary>
  133. </member>
  134. <member name="P:Microsoft.IdentityModel.Abstractions.LogEntry.Message">
  135. <summary>
  136. Message to be logged.
  137. </summary>
  138. </member>
  139. <member name="P:Microsoft.IdentityModel.Abstractions.LogEntry.CorrelationId">
  140. <summary>
  141. A unique identifier for a request that can help with diagnostics across components.
  142. </summary>
  143. <remarks>
  144. Also referred to as ActivityId in Microsoft.IdentityModel.Tokens.CallContext.
  145. </remarks>
  146. </member>
  147. <member name="T:Microsoft.IdentityModel.Abstractions.NullIdentityModelLogger">
  148. <summary>
  149. A minimalistic <see cref="T:Microsoft.IdentityModel.Abstractions.IIdentityLogger"/> implementation that is disabled by default and doesn't log.
  150. </summary>
  151. </member>
  152. <member name="P:Microsoft.IdentityModel.Abstractions.NullIdentityModelLogger.Instance">
  153. <summary>
  154. Default instance of <see cref="T:Microsoft.IdentityModel.Abstractions.NullIdentityModelLogger"/>.
  155. </summary>
  156. </member>
  157. <member name="M:Microsoft.IdentityModel.Abstractions.NullIdentityModelLogger.IsEnabled(Microsoft.IdentityModel.Abstractions.EventLogLevel)">
  158. <inheritdoc/>
  159. </member>
  160. <member name="M:Microsoft.IdentityModel.Abstractions.NullIdentityModelLogger.Log(Microsoft.IdentityModel.Abstractions.LogEntry)">
  161. <inheritdoc/>
  162. </member>
  163. <member name="T:Microsoft.IdentityModel.Abstractions.NullTelemetryClient">
  164. <summary>
  165. The default implementation of the <see cref="T:Microsoft.IdentityModel.Abstractions.ITelemetryClient"/> interface which swallows all telemetry signals.
  166. </summary>
  167. </member>
  168. <member name="P:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.ClientId">
  169. <inheritdoc />
  170. </member>
  171. <member name="P:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.Instance">
  172. <summary>
  173. Singleton instance of <see cref="T:Microsoft.IdentityModel.Abstractions.NullTelemetryClient"/>.
  174. </summary>
  175. </member>
  176. <member name="M:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.#ctor">
  177. <summary>
  178. Initializes an instance of <see cref="T:Microsoft.IdentityModel.Abstractions.NullTelemetryClient"/>.
  179. </summary>
  180. <remarks>
  181. Private constructor to prevent the default constructor being exposed.
  182. </remarks>
  183. </member>
  184. <member name="M:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.IsEnabled">
  185. <inheritdoc />
  186. </member>
  187. <member name="M:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.IsEnabled(System.String)">
  188. <inheritdoc/>
  189. </member>
  190. <member name="M:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.Initialize">
  191. <inheritdoc/>
  192. </member>
  193. <member name="M:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.TrackEvent(Microsoft.IdentityModel.Abstractions.TelemetryEventDetails)">
  194. <inheritdoc/>
  195. </member>
  196. <member name="M:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.TrackEvent(System.String,System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.Int64},System.Collections.Generic.IDictionary{System.String,System.Boolean},System.Collections.Generic.IDictionary{System.String,System.DateTime},System.Collections.Generic.IDictionary{System.String,System.Double},System.Collections.Generic.IDictionary{System.String,System.Guid})">
  197. <inheritdoc/>
  198. </member>
  199. <member name="T:Microsoft.IdentityModel.Abstractions.ObservabilityConstants">
  200. <summary>
  201. Common class containing observability constants to be used as well known metric keys.
  202. </summary>
  203. </member>
  204. <member name="F:Microsoft.IdentityModel.Abstractions.ObservabilityConstants.Succeeded">
  205. <summary>
  206. String used for the name of the property indicating if the call was successful.
  207. </summary>
  208. </member>
  209. <member name="F:Microsoft.IdentityModel.Abstractions.ObservabilityConstants.Duration">
  210. <summary>
  211. String used for the name of the property indicating the call in Duration (ms).
  212. </summary>
  213. </member>
  214. <member name="F:Microsoft.IdentityModel.Abstractions.ObservabilityConstants.ActivityId">
  215. <summary>
  216. String used for the name of the property indicating the call's Activity Id/Correlation Id.
  217. </summary>
  218. </member>
  219. <member name="F:Microsoft.IdentityModel.Abstractions.ObservabilityConstants.ClientId">
  220. <summary>
  221. String used for the name of the property indicating the caller's ClientId.
  222. </summary>
  223. </member>
  224. <member name="T:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails">
  225. <summary>
  226. Details of the telemetry event.
  227. </summary>
  228. <remarks>
  229. This implementation is not meant to be thread-safe. This implementation would either need to be overridden or
  230. usage should not be concurrently operated on.
  231. </remarks>
  232. </member>
  233. <member name="P:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.PropertyValues">
  234. <summary>
  235. The underlying properties making up the <see cref="T:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails"/>.
  236. </summary>
  237. </member>
  238. <member name="P:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.Name">
  239. <summary>
  240. Name of the telemetry event, should be unique between events.
  241. </summary>
  242. </member>
  243. <member name="P:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.Properties">
  244. <summary>
  245. Properties which describe the event.
  246. </summary>
  247. </member>
  248. <member name="M:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.SetProperty(System.String,System.String)">
  249. <summary>
  250. Sets a property on the event details.
  251. </summary>
  252. <param name="key">Property key.</param>
  253. <param name="value">Property value.</param>
  254. <exception cref="T:System.ArgumentNullException">'key' is null.</exception>
  255. </member>
  256. <member name="M:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.SetProperty(System.String,System.Int64)">
  257. <summary>
  258. Sets a property on the event details.
  259. </summary>
  260. <param name="key">Property key.</param>
  261. <param name="value">Property value.</param>
  262. <exception cref="T:System.ArgumentNullException">'key' is null.</exception>
  263. </member>
  264. <member name="M:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.SetProperty(System.String,System.Boolean)">
  265. <summary>
  266. Sets a property on the event details.
  267. </summary>
  268. <param name="key">Property key.</param>
  269. <param name="value">Property value.</param>
  270. <exception cref="T:System.ArgumentNullException">'key' is null.</exception>
  271. </member>
  272. <member name="M:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.SetProperty(System.String,System.DateTime)">
  273. <summary>
  274. Sets a property on the event details.
  275. </summary>
  276. <param name="key">Property key.</param>
  277. <param name="value">Property value.</param>
  278. <exception cref="T:System.ArgumentNullException">'key' is null.</exception>
  279. </member>
  280. <member name="M:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.SetProperty(System.String,System.Double)">
  281. <summary>
  282. Sets a property on the event details.
  283. </summary>
  284. <param name="key">Property key.</param>
  285. <param name="value">Property value.</param>
  286. <exception cref="T:System.ArgumentNullException">'key' is null.</exception>
  287. </member>
  288. <member name="M:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.SetProperty(System.String,System.Guid)">
  289. <summary>
  290. Sets a property on the event details.
  291. </summary>
  292. <param name="key">Property key.</param>
  293. <param name="value">Property value.</param>
  294. <exception cref="T:System.ArgumentNullException">'key' is null.</exception>
  295. </member>
  296. </members>
  297. </doc>