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