netFramework/Microsoft.IdentityModel.Abstractions.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
<?xml version="1.0"?>
<doc>
    <assembly>
        <name>Microsoft.IdentityModel.Abstractions</name>
    </assembly>
    <members>
        <member name="T:Microsoft.IdentityModel.Abstractions.EventLogLevel">
            <summary>
            Defines Event Log Levels.
            </summary>
        </member>
        <member name="F:Microsoft.IdentityModel.Abstractions.EventLogLevel.LogAlways">
            <summary>
            No level filtering is done on this log level. Log messages of all levels will be logged.
            </summary>
        </member>
        <member name="F:Microsoft.IdentityModel.Abstractions.EventLogLevel.Critical">
            <summary>
            Logs that describe an unrecoverable application or system crash, or a catastrophic failure that requires
            immediate attention.
            </summary>
        </member>
        <member name="F:Microsoft.IdentityModel.Abstractions.EventLogLevel.Error">
            <summary>
            Logs that highlight when the current flow of execution is stopped due to a failure. These should indicate a
            failure in the current activity, not an application-wide failure.
            </summary>
        </member>
        <member name="F:Microsoft.IdentityModel.Abstractions.EventLogLevel.Warning">
            <summary>
            Logs that highlight an abnormal or unexpected event in the application flow, but do not otherwise cause the
            application execution to stop.
            </summary>
        </member>
        <member name="F:Microsoft.IdentityModel.Abstractions.EventLogLevel.Informational">
            <summary>
            Logs that track the general flow of the application. These logs should have long-term value.
            </summary>
        </member>
        <member name="F:Microsoft.IdentityModel.Abstractions.EventLogLevel.Verbose">
            <summary>
            Logs that are used for interactive investigation during development. These logs should primarily contain
            information useful for debugging and have no long-term value.
            </summary>
        </member>
        <member name="T:Microsoft.IdentityModel.Abstractions.IIdentityLogger">
            <summary>
            Interface that needs to be implemented by classes providing logging in Microsoft identity libraries.
            </summary>
        </member>
        <member name="M:Microsoft.IdentityModel.Abstractions.IIdentityLogger.IsEnabled(Microsoft.IdentityModel.Abstractions.EventLogLevel)">
            <summary>
            Checks to see if logging is enabled at given <paramref name="eventLogLevel"/>.
            </summary>
            <param name="eventLogLevel">Log level of a message.</param>
        </member>
        <member name="M:Microsoft.IdentityModel.Abstractions.IIdentityLogger.Log(Microsoft.IdentityModel.Abstractions.LogEntry)">
            <summary>
            Writes a log entry.
            </summary>
            <param name="entry">Defines a structured message to be logged at the provided <see cref="P:Microsoft.IdentityModel.Abstractions.LogEntry.EventLogLevel"/>.</param>
        </member>
        <member name="T:Microsoft.IdentityModel.Abstractions.ITelemetryClient">
            <summary>
            Interface for Telemetry tracking.
            </summary>
        </member>
        <member name="P:Microsoft.IdentityModel.Abstractions.ITelemetryClient.ClientId">
            <summary>
            Gets or sets the application or client ID that telemetry is being sent for.
            </summary>
        </member>
        <member name="M:Microsoft.IdentityModel.Abstractions.ITelemetryClient.Initialize">
            <summary>
            Perform any necessary bootstrapping for the telemetry client.
            </summary>
            <remarks>
            The expectation is that this should only be called once for the lifetime of the object however the
            implementation should be idempotent.
            </remarks>
        </member>
        <member name="M:Microsoft.IdentityModel.Abstractions.ITelemetryClient.IsEnabled">
            <summary>
            Checks to see if telemetry is enabled all up.
            </summary>
            <returns>
            Returns <see langword="true"/> if telemetry should be sent; <see langword="false"/> otherwise.
            </returns>
            <remarks>
            This check should be used to gate any resource intensive operations to generate telemetry as well.
            </remarks>
        </member>
        <member name="M:Microsoft.IdentityModel.Abstractions.ITelemetryClient.IsEnabled(System.String)">
            <summary>
            Checks to see if telemetry is enabled for the named event.
            </summary>
            <param name="eventName">Name of the event to check.</param>
            <returns>
            Returns <see langword="true"/> if telemetry should be sent for <paramref name="eventName"/>;
            <see langword="false"/> otherwise.
            </returns>
            <remarks>
            This check should be used to gate any resource intensive operations to generate telemetry as well.
            </remarks>
        </member>
        <member name="M:Microsoft.IdentityModel.Abstractions.ITelemetryClient.TrackEvent(Microsoft.IdentityModel.Abstractions.TelemetryEventDetails)">
            <summary>
            Tracks an instance of a named event.
            </summary>
            <param name="eventDetails">Details of the event to track.</param>
        </member>
        <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})">
            <summary>
            Tracks an instance of a named event.
            </summary>
            <param name="eventName">Name of the event to track. Should be unique per scenario.</param>
            <param name="stringProperties">Key value pair of strings to long with the event.</param>
            <param name="longProperties">Key value pair of longs to long with the event.</param>
            <param name="boolProperties">Key value pair of bools to long with the event.</param>
            <param name="dateTimeProperties">Key value pair of DateTimes to long with the event.</param>
            <param name="doubleProperties">Key value pair of doubles to long with the event.</param>
            <param name="guidProperties">Key value pair of Guids to long with the event.</param>
        </member>
        <member name="T:Microsoft.IdentityModel.Abstractions.LogEntry">
            <summary>
            Defines the structure of a log entry.
            </summary>
        </member>
        <member name="P:Microsoft.IdentityModel.Abstractions.LogEntry.EventLogLevel">
            <summary>
            Defines the <see cref="P:Microsoft.IdentityModel.Abstractions.LogEntry.EventLogLevel"/>.
            </summary>
        </member>
        <member name="P:Microsoft.IdentityModel.Abstractions.LogEntry.Message">
            <summary>
            Message to be logged.
            </summary>
        </member>
        <member name="P:Microsoft.IdentityModel.Abstractions.LogEntry.CorrelationId">
            <summary>
            A unique identifier for a request that can help with diagnostics across components.
            </summary>
            <remarks>
            Also referred to as ActivityId in Microsoft.IdentityModel.Tokens.CallContext.
            </remarks>
        </member>
        <member name="T:Microsoft.IdentityModel.Abstractions.NullIdentityModelLogger">
            <summary>
            A minimalistic <see cref="T:Microsoft.IdentityModel.Abstractions.IIdentityLogger"/> implementation that is disabled by default and doesn't log.
            </summary>
        </member>
        <member name="P:Microsoft.IdentityModel.Abstractions.NullIdentityModelLogger.Instance">
            <summary>
            Default instance of <see cref="T:Microsoft.IdentityModel.Abstractions.NullIdentityModelLogger"/>.
            </summary>
        </member>
        <member name="M:Microsoft.IdentityModel.Abstractions.NullIdentityModelLogger.IsEnabled(Microsoft.IdentityModel.Abstractions.EventLogLevel)">
            <inheritdoc/>
        </member>
        <member name="M:Microsoft.IdentityModel.Abstractions.NullIdentityModelLogger.Log(Microsoft.IdentityModel.Abstractions.LogEntry)">
            <inheritdoc/>
        </member>
        <member name="T:Microsoft.IdentityModel.Abstractions.NullTelemetryClient">
            <summary>
            The default implementation of the <see cref="T:Microsoft.IdentityModel.Abstractions.ITelemetryClient"/> interface which swallows all telemetry signals.
            </summary>
        </member>
        <member name="P:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.ClientId">
            <inheritdoc />
        </member>
        <member name="P:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.Instance">
            <summary>
            Singleton instance of <see cref="T:Microsoft.IdentityModel.Abstractions.NullTelemetryClient"/>.
            </summary>
        </member>
        <member name="M:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.#ctor">
            <summary>
            Initializes an instance of <see cref="T:Microsoft.IdentityModel.Abstractions.NullTelemetryClient"/>.
            </summary>
            <remarks>
            Private constructor to prevent the default constructor being exposed.
            </remarks>
        </member>
        <member name="M:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.IsEnabled">
            <inheritdoc />
        </member>
        <member name="M:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.IsEnabled(System.String)">
            <inheritdoc/>
        </member>
        <member name="M:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.Initialize">
            <inheritdoc/>
        </member>
        <member name="M:Microsoft.IdentityModel.Abstractions.NullTelemetryClient.TrackEvent(Microsoft.IdentityModel.Abstractions.TelemetryEventDetails)">
            <inheritdoc/>
        </member>
        <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})">
            <inheritdoc/>
        </member>
        <member name="T:Microsoft.IdentityModel.Abstractions.ObservabilityConstants">
            <summary>
            Common class containing observability constants to be used as well known metric keys.
            </summary>
        </member>
        <member name="F:Microsoft.IdentityModel.Abstractions.ObservabilityConstants.Succeeded">
            <summary>
            String used for the name of the property indicating if the call was successful.
            </summary>
        </member>
        <member name="F:Microsoft.IdentityModel.Abstractions.ObservabilityConstants.Duration">
            <summary>
            String used for the name of the property indicating the call in Duration (ms).
            </summary>
        </member>
        <member name="F:Microsoft.IdentityModel.Abstractions.ObservabilityConstants.ActivityId">
            <summary>
            String used for the name of the property indicating the call's Activity Id/Correlation Id.
            </summary>
        </member>
        <member name="F:Microsoft.IdentityModel.Abstractions.ObservabilityConstants.ClientId">
            <summary>
            String used for the name of the property indicating the caller's ClientId.
            </summary>
        </member>
        <member name="T:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails">
            <summary>
            Details of the telemetry event.
            </summary>
            <remarks>
            This implementation is not meant to be thread-safe. This implementation would either need to be overridden or
            usage should not be concurrently operated on.
            </remarks>
        </member>
        <member name="P:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.PropertyValues">
            <summary>
            The underlying properties making up the <see cref="T:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails"/>.
            </summary>
        </member>
        <member name="P:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.Name">
            <summary>
            Name of the telemetry event, should be unique between events.
            </summary>
        </member>
        <member name="P:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.Properties">
            <summary>
            Properties which describe the event.
            </summary>
        </member>
        <member name="M:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.SetProperty(System.String,System.String)">
            <summary>
            Sets a property on the event details.
            </summary>
            <param name="key">Property key.</param>
            <param name="value">Property value.</param>
            <exception cref="T:System.ArgumentNullException">'key' is null.</exception>
        </member>
        <member name="M:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.SetProperty(System.String,System.Int64)">
            <summary>
            Sets a property on the event details.
            </summary>
            <param name="key">Property key.</param>
            <param name="value">Property value.</param>
            <exception cref="T:System.ArgumentNullException">'key' is null.</exception>
        </member>
        <member name="M:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.SetProperty(System.String,System.Boolean)">
            <summary>
            Sets a property on the event details.
            </summary>
            <param name="key">Property key.</param>
            <param name="value">Property value.</param>
            <exception cref="T:System.ArgumentNullException">'key' is null.</exception>
        </member>
        <member name="M:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.SetProperty(System.String,System.DateTime)">
            <summary>
            Sets a property on the event details.
            </summary>
            <param name="key">Property key.</param>
            <param name="value">Property value.</param>
            <exception cref="T:System.ArgumentNullException">'key' is null.</exception>
        </member>
        <member name="M:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.SetProperty(System.String,System.Double)">
            <summary>
            Sets a property on the event details.
            </summary>
            <param name="key">Property key.</param>
            <param name="value">Property value.</param>
            <exception cref="T:System.ArgumentNullException">'key' is null.</exception>
        </member>
        <member name="M:Microsoft.IdentityModel.Abstractions.TelemetryEventDetails.SetProperty(System.String,System.Guid)">
            <summary>
            Sets a property on the event details.
            </summary>
            <param name="key">Property key.</param>
            <param name="value">Property value.</param>
            <exception cref="T:System.ArgumentNullException">'key' is null.</exception>
        </member>
    </members>
</doc>