-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
DisplayClaim.xml
351 lines (335 loc) · 22.5 KB
/
DisplayClaim.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
<Type Name="DisplayClaim" FullName="System.IdentityModel.Metadata.DisplayClaim">
<TypeSignature Language="C#" Value="public class DisplayClaim" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit DisplayClaim extends System.Object" />
<TypeSignature Language="DocId" Value="T:System.IdentityModel.Metadata.DisplayClaim" />
<TypeSignature Language="VB.NET" Value="Public Class DisplayClaim" />
<TypeSignature Language="F#" Value="type DisplayClaim = class" />
<TypeSignature Language="C++ CLI" Value="public ref class DisplayClaim" />
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Represents the displayable claim object.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Usually, the display tag (the <xref:System.IdentityModel.Metadata.DisplayClaim.DisplayTag%2A> property) and the description (the Description property) are localized. The <xref:System.IdentityModel.Metadata.DisplayClaim.ClaimType%2A> property identifies different claim types. The display value (the <xref:System.IdentityModel.Metadata.DisplayClaim.DisplayValue%2A> property) is the string representation of the claim.Resource.
]]></format>
</remarks>
</Docs>
<Members>
<MemberGroup MemberName=".ctor">
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.IdentityModel.Metadata.DisplayClaim" /> class.</summary>
</Docs>
</MemberGroup>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DisplayClaim (string claimType);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string claimType) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Metadata.DisplayClaim.#ctor(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (claimType As String)" />
<MemberSignature Language="F#" Value="new System.IdentityModel.Metadata.DisplayClaim : string -> System.IdentityModel.Metadata.DisplayClaim" Usage="new System.IdentityModel.Metadata.DisplayClaim claimType" />
<MemberSignature Language="C++ CLI" Value="public:
 DisplayClaim(System::String ^ claimType);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="claimType" Type="System.String" />
</Parameters>
<Docs>
<param name="claimType">The claim type for the display claim. Initializes the <see cref="P:System.IdentityModel.Metadata.DisplayClaim.ClaimType" /> property.</param>
<summary>Initializes a new instance of the <see cref="T:System.IdentityModel.Metadata.DisplayClaim" /> class that has the specified claim type.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="claimType" /> is <see langword="null" /> or an empty string.</exception>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DisplayClaim (string claimType, string displayTag, string description);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string claimType, string displayTag, string description) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Metadata.DisplayClaim.#ctor(System.String,System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (claimType As String, displayTag As String, description As String)" />
<MemberSignature Language="F#" Value="new System.IdentityModel.Metadata.DisplayClaim : string * string * string -> System.IdentityModel.Metadata.DisplayClaim" Usage="new System.IdentityModel.Metadata.DisplayClaim (claimType, displayTag, description)" />
<MemberSignature Language="C++ CLI" Value="public:
 DisplayClaim(System::String ^ claimType, System::String ^ displayTag, System::String ^ description);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="claimType" Type="System.String" />
<Parameter Name="displayTag" Type="System.String" />
<Parameter Name="description" Type="System.String" />
</Parameters>
<Docs>
<param name="claimType">The claim type for the display claim. Initializes the <see cref="P:System.IdentityModel.Metadata.DisplayClaim.ClaimType" /> property.</param>
<param name="displayTag">The display name (or friendly name) for the display claim. Initializes the <see cref="P:System.IdentityModel.Metadata.DisplayClaim.DisplayTag" /> property.</param>
<param name="description">The description for the display claim. Initializes the <see cref="P:System.IdentityModel.Metadata.DisplayClaim.Description" /> property.</param>
<summary>Initializes a new instance of the <see cref="T:System.IdentityModel.Metadata.DisplayClaim" /> class that has the specified claim type, display name, and description.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="claimType" /> is <see langword="null" /> or an empty string.</exception>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DisplayClaim (string claimType, string displayTag, string description, string displayValue);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string claimType, string displayTag, string description, string displayValue) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Metadata.DisplayClaim.#ctor(System.String,System.String,System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (claimType As String, displayTag As String, description As String, displayValue As String)" />
<MemberSignature Language="F#" Value="new System.IdentityModel.Metadata.DisplayClaim : string * string * string * string -> System.IdentityModel.Metadata.DisplayClaim" Usage="new System.IdentityModel.Metadata.DisplayClaim (claimType, displayTag, description, displayValue)" />
<MemberSignature Language="C++ CLI" Value="public:
 DisplayClaim(System::String ^ claimType, System::String ^ displayTag, System::String ^ description, System::String ^ displayValue);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="claimType" Type="System.String" />
<Parameter Name="displayTag" Type="System.String" />
<Parameter Name="description" Type="System.String" />
<Parameter Name="displayValue" Type="System.String" />
</Parameters>
<Docs>
<param name="claimType">The claim type for the display claim. Initializes the <see cref="P:System.IdentityModel.Metadata.DisplayClaim.ClaimType" /> property.</param>
<param name="displayTag">The display name (or friendly name) for the display claim. Initializes the <see cref="P:System.IdentityModel.Metadata.DisplayClaim.DisplayTag" /> property.</param>
<param name="description">The description for the display claim. Initializes the <see cref="P:System.IdentityModel.Metadata.DisplayClaim.Description" /> property.</param>
<param name="displayValue">The display value for the display claim. Initializes the <see cref="P:System.IdentityModel.Metadata.DisplayClaim.DisplayValue" /> property.</param>
<summary>Initializes a new instance of the <see cref="T:System.IdentityModel.Metadata.DisplayClaim" /> class that has the specified claim type, display name, display value, and description. The claim is required.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.IdentityModel.Metadata.DisplayClaim.Optional%2A> property is initialized to `true` in the new instance.
]]></format>
</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="claimType" /> is <see langword="null" /> or an empty string.</exception>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DisplayClaim (string claimType, string displayTag, string description, string displayValue, bool optional);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string claimType, string displayTag, string description, string displayValue, bool optional) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Metadata.DisplayClaim.#ctor(System.String,System.String,System.String,System.String,System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (claimType As String, displayTag As String, description As String, displayValue As String, optional As Boolean)" />
<MemberSignature Language="F#" Value="new System.IdentityModel.Metadata.DisplayClaim : string * string * string * string * bool -> System.IdentityModel.Metadata.DisplayClaim" Usage="new System.IdentityModel.Metadata.DisplayClaim (claimType, displayTag, description, displayValue, optional)" />
<MemberSignature Language="C++ CLI" Value="public:
 DisplayClaim(System::String ^ claimType, System::String ^ displayTag, System::String ^ description, System::String ^ displayValue, bool optional);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="claimType" Type="System.String" />
<Parameter Name="displayTag" Type="System.String" />
<Parameter Name="description" Type="System.String" />
<Parameter Name="displayValue" Type="System.String" />
<Parameter Name="optional" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="claimType">The claim type for the display claim. Initializes the <see cref="P:System.IdentityModel.Metadata.DisplayClaim.ClaimType" /> property.</param>
<param name="displayTag">The display name (or friendly name) for the display claim. Initializes the <see cref="P:System.IdentityModel.Metadata.DisplayClaim.DisplayTag" /> property.</param>
<param name="description">The description for the display claim. Initializes the <see cref="P:System.IdentityModel.Metadata.DisplayClaim.Description" /> property.</param>
<param name="displayValue">The display value for the display claim. Initializes the <see cref="P:System.IdentityModel.Metadata.DisplayClaim.DisplayValue" /> property.</param>
<param name="optional">
<see langword="true" /> if the claim is optional; otherwise, <see langword="false" />. Initializes the <see cref="P:System.IdentityModel.Metadata.DisplayClaim.Optional" /> property.</param>
<summary>Initializes a new instance of the <see cref="T:System.IdentityModel.Metadata.DisplayClaim" /> class that has the specified claim type, display name, display value, description, and optional attribute.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="claimType" /> is <see langword="null" /> or an empty string.</exception>
</Docs>
</Member>
<Member MemberName="ClaimType">
<MemberSignature Language="C#" Value="public string ClaimType { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ClaimType" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Metadata.DisplayClaim.ClaimType" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ClaimType As String" />
<MemberSignature Language="F#" Value="member this.ClaimType : string" Usage="System.IdentityModel.Metadata.DisplayClaim.ClaimType" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ ClaimType { System::String ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the claim type associated with the display claim.</summary>
<value>A URI that represents the claim type.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This required attribute provides the unique identifier (URI) of the individual claim returned in the security token
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="CreateDisplayClaimFromClaimType">
<MemberSignature Language="C#" Value="public static System.IdentityModel.Metadata.DisplayClaim CreateDisplayClaimFromClaimType (string claimType);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.IdentityModel.Metadata.DisplayClaim CreateDisplayClaimFromClaimType(string claimType) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Metadata.DisplayClaim.CreateDisplayClaimFromClaimType(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function CreateDisplayClaimFromClaimType (claimType As String) As DisplayClaim" />
<MemberSignature Language="F#" Value="static member CreateDisplayClaimFromClaimType : string -> System.IdentityModel.Metadata.DisplayClaim" Usage="System.IdentityModel.Metadata.DisplayClaim.CreateDisplayClaimFromClaimType claimType" />
<MemberSignature Language="C++ CLI" Value="public:
 static System::IdentityModel::Metadata::DisplayClaim ^ CreateDisplayClaimFromClaimType(System::String ^ claimType);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IdentityModel.Metadata.DisplayClaim</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="claimType" Type="System.String" />
</Parameters>
<Docs>
<param name="claimType">The URI that represents the claim type.</param>
<summary>Creates a display claim from the specified claim type.</summary>
<returns>Returns <see cref="T:System.IdentityModel.Metadata.DisplayClaim" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.IdentityModel.Metadata.DisplayClaim.DisplayTag%2A> and <xref:System.IdentityModel.Metadata.DisplayClaim.Description%2A> properties are set to default values based on the specified claim type. If default values do not exist for the properties, they are set to `null`.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Description">
<MemberSignature Language="C#" Value="public string Description { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Description" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Metadata.DisplayClaim.Description" />
<MemberSignature Language="VB.NET" Value="Public Property Description As String" />
<MemberSignature Language="F#" Value="member this.Description : string with get, set" Usage="System.IdentityModel.Metadata.DisplayClaim.Description" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ Description { System::String ^ get(); void set(System::String ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a description for the display claim.</summary>
<value>The description for the display claim.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This optional element provides a description of the semantics for the claim returned in the security token.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="DisplayTag">
<MemberSignature Language="C#" Value="public string DisplayTag { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string DisplayTag" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Metadata.DisplayClaim.DisplayTag" />
<MemberSignature Language="VB.NET" Value="Public Property DisplayTag As String" />
<MemberSignature Language="F#" Value="member this.DisplayTag : string with get, set" Usage="System.IdentityModel.Metadata.DisplayClaim.DisplayTag" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ DisplayTag { System::String ^ get(); void set(System::String ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the friendly name for the display claim.</summary>
<value>The friendly name for the display claim.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This optional element provides a friendly name for the claim returned in the security token.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="DisplayValue">
<MemberSignature Language="C#" Value="public string DisplayValue { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string DisplayValue" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Metadata.DisplayClaim.DisplayValue" />
<MemberSignature Language="VB.NET" Value="Public Property DisplayValue As String" />
<MemberSignature Language="F#" Value="member this.DisplayValue : string with get, set" Usage="System.IdentityModel.Metadata.DisplayClaim.DisplayValue" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ DisplayValue { System::String ^ get(); void set(System::String ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a displayable value for the display claim.</summary>
<value>The displayable value for the display claim.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This optional element provides one or more displayable values for the claim returned in the security token.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Optional">
<MemberSignature Language="C#" Value="public bool Optional { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool Optional" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Metadata.DisplayClaim.Optional" />
<MemberSignature Language="VB.NET" Value="Public Property Optional As Boolean" />
<MemberSignature Language="F#" Value="member this.Optional : bool with get, set" Usage="System.IdentityModel.Metadata.DisplayClaim.Optional" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool Optional { bool get(); void set(bool value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the optional attribute for the display claim.</summary>
<value>
<see langword="true" /> if the display claim is optional; otherwise, <see langword="false" />. The default is <see langword="false" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The optional attribute.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="WriteOptionalAttribute">
<MemberSignature Language="C#" Value="public bool WriteOptionalAttribute { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool WriteOptionalAttribute" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Metadata.DisplayClaim.WriteOptionalAttribute" />
<MemberSignature Language="VB.NET" Value="Public Property WriteOptionalAttribute As Boolean" />
<MemberSignature Language="F#" Value="member this.WriteOptionalAttribute : bool with get, set" Usage="System.IdentityModel.Metadata.DisplayClaim.WriteOptionalAttribute" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool WriteOptionalAttribute { bool get(); void set(bool value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value that indicates whether the optional attribute will be serialized.</summary>
<value>
<see langword="true" /> to serialize the optional attribute; otherwise, false. The default value is <see langword="false" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>