-
Notifications
You must be signed in to change notification settings - Fork 28
/
LogCallback.xml
61 lines (61 loc) · 3.65 KB
/
LogCallback.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
<Type Name="LogCallback" FullName="Microsoft.Identity.Client.LogCallback">
<TypeSignature Language="C#" Value="public delegate void LogCallback(LogLevel level, string message, bool containsPii);" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed LogCallback extends System.MulticastDelegate" />
<TypeSignature Language="DocId" Value="T:Microsoft.Identity.Client.LogCallback" />
<TypeSignature Language="VB.NET" Value="Public Delegate Sub LogCallback(level As LogLevel, message As String, containsPii As Boolean)" />
<TypeSignature Language="F#" Value="type LogCallback = delegate of LogLevel * string * bool -> unit" />
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.48.1.0</AssemblyVersion>
<AssemblyVersion>4.49.1.0</AssemblyVersion>
<AssemblyVersion>4.51.0.0</AssemblyVersion>
<AssemblyVersion>4.52.0.0</AssemblyVersion>
<AssemblyVersion>4.53.0.0</AssemblyVersion>
<AssemblyVersion>4.54.0.0</AssemblyVersion>
<AssemblyVersion>4.54.1.0</AssemblyVersion>
<AssemblyVersion>4.55.0.0</AssemblyVersion>
<AssemblyVersion>4.56.0.0</AssemblyVersion>
<AssemblyVersion>4.57.0.0</AssemblyVersion>
<AssemblyVersion>4.58.0.0</AssemblyVersion>
<AssemblyVersion>4.58.1.0</AssemblyVersion>
<AssemblyVersion>4.59.0.0</AssemblyVersion>
<AssemblyVersion>4.60.0.0</AssemblyVersion>
<AssemblyVersion>4.60.1.0</AssemblyVersion>
<AssemblyVersion>4.60.2.0</AssemblyVersion>
<AssemblyVersion>4.60.3.0</AssemblyVersion>
<AssemblyVersion>4.61.0.0</AssemblyVersion>
<AssemblyVersion>4.61.1.0</AssemblyVersion>
<AssemblyVersion>4.61.3.0</AssemblyVersion>
<AssemblyVersion>4.62.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>
</Base>
<Parameters>
<Parameter Name="level" Type="Microsoft.Identity.Client.LogLevel" />
<Parameter Name="message" Type="System.String" />
<Parameter Name="containsPii" Type="System.Boolean" />
</Parameters>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Docs>
<param name="level">Log level of the log message to process</param>
<param name="message">Pre-formatted log message</param>
<param name="containsPii">Indicates if the log message contains Organizational Identifiable Information (OII)
or Personally Identifiable Information (PII) nor not.
If <see cref="P:Microsoft.Identity.Client.Logger.PiiLoggingEnabled" /> is set to <c>false</c> then this value is always false.
Otherwise it will be <c>true</c> when the message contains PII.</param>
<summary>
Callback delegate that allows application developers to consume logs, and handle them in a custom manner. This
callback is set using <see cref="M:Microsoft.Identity.Client.BaseAbstractApplicationBuilder`1.WithLogging(Microsoft.Identity.Client.LogCallback,System.Nullable{Microsoft.Identity.Client.LogLevel},System.Nullable{System.Boolean},System.Nullable{System.Boolean})" />.
If <c>PiiLoggingEnabled</c> is set to <c>true</c>, when registering the callback this method will receive the messages twice:
once with the <c>containsPii</c> parameter equals <c>false</c> and the message without PII,
and a second time with the <c>containsPii</c> parameter equals to <c>true</c> and the message might contain PII.
In some cases (when the message does not contain PII), the message will be the same.
For details see https://aka.ms/msal-net-logging
</summary>
<remarks>To be added.</remarks>
<altmember cref="T:Microsoft.Identity.Client.Logger" />
</Docs>
</Type>