-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
ConsoleLoggerOptions.xml
288 lines (288 loc) · 18.2 KB
/
ConsoleLoggerOptions.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
<Type Name="ConsoleLoggerOptions" FullName="Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions">
<TypeSignature Language="C#" Value="public class ConsoleLoggerOptions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ConsoleLoggerOptions extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions" />
<TypeSignature Language="VB.NET" Value="Public Class ConsoleLoggerOptions" />
<TypeSignature Language="F#" Value="type ConsoleLoggerOptions = class" />
<TypeSignature Language="C++ CLI" Value="public ref class ConsoleLoggerOptions" />
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Logging.Console</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(0)>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.NullableContext(2)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.NullableContext(2)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Options for a <see cref="T:Microsoft.Extensions.Logging.Console.ConsoleLogger" />.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ConsoleLoggerOptions ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 ConsoleLoggerOptions();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Logging.Console</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DisableColors">
<MemberSignature Language="C#" Value="public bool DisableColors { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool DisableColors" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions.DisableColors" />
<MemberSignature Language="VB.NET" Value="Public Property DisableColors As Boolean" />
<MemberSignature Language="F#" Value="member this.DisableColors : bool with get, set" Usage="Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions.DisableColors" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool DisableColors { bool get(); void set(bool value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Logging.Console</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Obsolete("ConsoleLoggerOptions.DisableColors has been deprecated. Use SimpleConsoleFormatterOptions.ColorBehavior instead.")]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("ConsoleLoggerOptions.DisableColors has been deprecated. Use SimpleConsoleFormatterOptions.ColorBehavior instead.")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Disables colors when <see langword="true" />.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Format">
<MemberSignature Language="C#" Value="public Microsoft.Extensions.Logging.Console.ConsoleLoggerFormat Format { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Extensions.Logging.Console.ConsoleLoggerFormat Format" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions.Format" />
<MemberSignature Language="VB.NET" Value="Public Property Format As ConsoleLoggerFormat" />
<MemberSignature Language="F#" Value="member this.Format : Microsoft.Extensions.Logging.Console.ConsoleLoggerFormat with get, set" Usage="Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions.Format" />
<MemberSignature Language="C++ CLI" Value="public:
 property Microsoft::Extensions::Logging::Console::ConsoleLoggerFormat Format { Microsoft::Extensions::Logging::Console::ConsoleLoggerFormat get(); void set(Microsoft::Extensions::Logging::Console::ConsoleLoggerFormat value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Logging.Console</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Obsolete("ConsoleLoggerOptions.Format has been deprecated. Use ConsoleLoggerOptions.FormatterName instead.")]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("ConsoleLoggerOptions.Format has been deprecated. Use ConsoleLoggerOptions.FormatterName instead.")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Extensions.Logging.Console.ConsoleLoggerFormat</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the log message format.</summary>
<value>The default is <see cref="F:Microsoft.Extensions.Logging.Console.ConsoleLoggerFormat.Default" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="FormatterName">
<MemberSignature Language="C#" Value="public string? FormatterName { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string FormatterName" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions.FormatterName" />
<MemberSignature Language="VB.NET" Value="Public Property FormatterName As String" />
<MemberSignature Language="F#" Value="member this.FormatterName : string with get, set" Usage="Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions.FormatterName" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ FormatterName { System::String ^ get(); void set(System::String ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Logging.Console</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>The name of the log message formatter to use.</summary>
<value>A string that represents the formatter name. The default is "simple".</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IncludeScopes">
<MemberSignature Language="C#" Value="public bool IncludeScopes { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IncludeScopes" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions.IncludeScopes" />
<MemberSignature Language="VB.NET" Value="Public Property IncludeScopes As Boolean" />
<MemberSignature Language="F#" Value="member this.IncludeScopes : bool with get, set" Usage="Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions.IncludeScopes" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool IncludeScopes { bool get(); void set(bool value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Logging.Console</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Obsolete("ConsoleLoggerOptions.IncludeScopes has been deprecated. Use ConsoleFormatterOptions.IncludeScopes instead.")]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("ConsoleLoggerOptions.IncludeScopes has been deprecated. Use ConsoleFormatterOptions.IncludeScopes instead.")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Includes scopes when <see langword="true" />.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="LogToStandardErrorThreshold">
<MemberSignature Language="C#" Value="public Microsoft.Extensions.Logging.LogLevel LogToStandardErrorThreshold { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Extensions.Logging.LogLevel LogToStandardErrorThreshold" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions.LogToStandardErrorThreshold" />
<MemberSignature Language="VB.NET" Value="Public Property LogToStandardErrorThreshold As LogLevel" />
<MemberSignature Language="F#" Value="member this.LogToStandardErrorThreshold : Microsoft.Extensions.Logging.LogLevel with get, set" Usage="Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions.LogToStandardErrorThreshold" />
<MemberSignature Language="C++ CLI" Value="public:
 property Microsoft::Extensions::Logging::LogLevel LogToStandardErrorThreshold { Microsoft::Extensions::Logging::LogLevel get(); void set(Microsoft::Extensions::Logging::LogLevel value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Logging.Console</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Extensions.Logging.LogLevel</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets value indicating the minimum level of messages that would get written to <c>Console.Error</c>.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MaxQueueLength">
<MemberSignature Language="C#" Value="public int MaxQueueLength { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 MaxQueueLength" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions.MaxQueueLength" />
<MemberSignature Language="VB.NET" Value="Public Property MaxQueueLength As Integer" />
<MemberSignature Language="F#" Value="member this.MaxQueueLength : int with get, set" Usage="Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions.MaxQueueLength" />
<MemberSignature Language="C++ CLI" Value="public:
 property int MaxQueueLength { int get(); void set(int value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Logging.Console</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the maximum number of enqueued messages.</summary>
<value>The default is 2500.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="QueueFullMode">
<MemberSignature Language="C#" Value="public Microsoft.Extensions.Logging.Console.ConsoleLoggerQueueFullMode QueueFullMode { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Extensions.Logging.Console.ConsoleLoggerQueueFullMode QueueFullMode" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions.QueueFullMode" />
<MemberSignature Language="VB.NET" Value="Public Property QueueFullMode As ConsoleLoggerQueueFullMode" />
<MemberSignature Language="F#" Value="member this.QueueFullMode : Microsoft.Extensions.Logging.Console.ConsoleLoggerQueueFullMode with get, set" Usage="Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions.QueueFullMode" />
<MemberSignature Language="C++ CLI" Value="public:
 property Microsoft::Extensions::Logging::Console::ConsoleLoggerQueueFullMode QueueFullMode { Microsoft::Extensions::Logging::Console::ConsoleLoggerQueueFullMode get(); void set(Microsoft::Extensions::Logging::Console::ConsoleLoggerQueueFullMode value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Logging.Console</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Extensions.Logging.Console.ConsoleLoggerQueueFullMode</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the desired console logger behavior when the queue becomes full.</summary>
<value>The default is <c>Wait</c>.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TimestampFormat">
<MemberSignature Language="C#" Value="public string? TimestampFormat { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string TimestampFormat" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions.TimestampFormat" />
<MemberSignature Language="VB.NET" Value="Public Property TimestampFormat As String" />
<MemberSignature Language="F#" Value="member this.TimestampFormat : string with get, set" Usage="Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions.TimestampFormat" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ TimestampFormat { System::String ^ get(); void set(System::String ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Logging.Console</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Obsolete("ConsoleLoggerOptions.TimestampFormat has been deprecated. Use ConsoleFormatterOptions.TimestampFormat instead.")]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("ConsoleLoggerOptions.TimestampFormat has been deprecated. Use ConsoleFormatterOptions.TimestampFormat instead.")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the format string used to format timestamps in logging messages.</summary>
<value>The default is <see langword="null" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="UseUtcTimestamp">
<MemberSignature Language="C#" Value="public bool UseUtcTimestamp { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool UseUtcTimestamp" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions.UseUtcTimestamp" />
<MemberSignature Language="VB.NET" Value="Public Property UseUtcTimestamp As Boolean" />
<MemberSignature Language="F#" Value="member this.UseUtcTimestamp : bool with get, set" Usage="Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions.UseUtcTimestamp" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool UseUtcTimestamp { bool get(); void set(bool value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Logging.Console</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Obsolete("ConsoleLoggerOptions.UseUtcTimestamp has been deprecated. Use ConsoleFormatterOptions.UseUtcTimestamp instead.")]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("ConsoleLoggerOptions.UseUtcTimestamp has been deprecated. Use ConsoleFormatterOptions.UseUtcTimestamp instead.")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value that indicates whether or not the UTC time zone should be used to for timestamps in logging messages.</summary>
<value>
<see langword="true" /> to use the UTC time zone; <see langword="false" /> otherwise. The default is <see langword="false" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>