-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
Renewing.xml
159 lines (147 loc) · 8.87 KB
/
Renewing.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
<Type Name="Renewing" FullName="System.IdentityModel.Protocols.WSTrust.Renewing">
<TypeSignature Language="C#" Value="public class Renewing" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Renewing extends System.Object" />
<TypeSignature Language="DocId" Value="T:System.IdentityModel.Protocols.WSTrust.Renewing" />
<TypeSignature Language="VB.NET" Value="Public Class Renewing" />
<TypeSignature Language="F#" Value="type Renewing = class" />
<TypeSignature Language="C++ CLI" Value="public ref class Renewing" />
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Represents the wst:Renewing element in a WS-Trust renew request.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This optional element indicates to the token issuer that the requested token can be renewed if the Allow attribute is true and that the token can be renewed after it expires if the OK attribute is true. These attributes are represented by the <xref:System.IdentityModel.Protocols.WSTrust.Renewing.AllowRenewal%2A> and the <xref:System.IdentityModel.Protocols.WSTrust.Renewing.OkForRenewalAfterExpiration%2A> properties respectively.
For more information about the element that this class represents, see the version of the WS-Trust specification that applies to your scenario.
]]></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.Protocols.WSTrust.Renewing" /> class.</summary>
</Docs>
</MemberGroup>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Renewing ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Protocols.WSTrust.Renewing.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 Renewing();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.IdentityModel.Protocols.WSTrust.Renewing" /><see cref="T:System.IdentityModel.Protocols.WSTrust.Renewing" /> class with default property values.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The following table shows the initial property values for the new <xref:System.IdentityModel.Protocols.WSTrust.Renewing> instance.
|Property|Value|
|--------------|-----------|
|<xref:System.IdentityModel.Protocols.WSTrust.Renewing.AllowRenewal%2A>|`true`|
|<xref:System.IdentityModel.Protocols.WSTrust.Renewing.OkForRenewalAfterExpiration%2A>|`false`|
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Renewing (bool allowRenewal, bool okForRenewalAfterExpiration);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(bool allowRenewal, bool okForRenewalAfterExpiration) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Protocols.WSTrust.Renewing.#ctor(System.Boolean,System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (allowRenewal As Boolean, okForRenewalAfterExpiration As Boolean)" />
<MemberSignature Language="F#" Value="new System.IdentityModel.Protocols.WSTrust.Renewing : bool * bool -> System.IdentityModel.Protocols.WSTrust.Renewing" Usage="new System.IdentityModel.Protocols.WSTrust.Renewing (allowRenewal, okForRenewalAfterExpiration)" />
<MemberSignature Language="C++ CLI" Value="public:
 Renewing(bool allowRenewal, bool okForRenewalAfterExpiration);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="allowRenewal" Type="System.Boolean" />
<Parameter Name="okForRenewalAfterExpiration" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="allowRenewal">
<see langword="true" /> if renewal is permitted; otherwise, <see langword="false" />.</param>
<param name="okForRenewalAfterExpiration">
<see langword="true" /> if the requested token can be renewed after it has expired; otherwise, <see langword="false" />.</param>
<summary>Initializes a new instance of the <see cref="T:System.IdentityModel.Protocols.WSTrust.Renewing" /><see cref="T:System.IdentityModel.Protocols.WSTrust.Renewing" /> class with the specified values.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The properties of the new <xref:System.IdentityModel.Protocols.WSTrust.Renewing> instance are set according to the value of the parameters.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="AllowRenewal">
<MemberSignature Language="C#" Value="public bool AllowRenewal { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool AllowRenewal" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Protocols.WSTrust.Renewing.AllowRenewal" />
<MemberSignature Language="VB.NET" Value="Public Property AllowRenewal As Boolean" />
<MemberSignature Language="F#" Value="member this.AllowRenewal : bool with get, set" Usage="System.IdentityModel.Protocols.WSTrust.Renewing.AllowRenewal" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool AllowRenewal { 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 token can be renewed.</summary>
<value>
<see langword="true" /> if renewal is permitted; otherwise, <see langword="false" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Represents the contents of the Allow attribute. This optional attribute is used to request a renewable token. The default value is `true`.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="OkForRenewalAfterExpiration">
<MemberSignature Language="C#" Value="public bool OkForRenewalAfterExpiration { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool OkForRenewalAfterExpiration" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Protocols.WSTrust.Renewing.OkForRenewalAfterExpiration" />
<MemberSignature Language="VB.NET" Value="Public Property OkForRenewalAfterExpiration As Boolean" />
<MemberSignature Language="F#" Value="member this.OkForRenewalAfterExpiration : bool with get, set" Usage="System.IdentityModel.Protocols.WSTrust.Renewing.OkForRenewalAfterExpiration" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool OkForRenewalAfterExpiration { 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 token can be renewed after it has expired.</summary>
<value>
<see langword="true" /> if the requested token can be renewed after it has expired; otherwise, <see langword="false" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Represents the contents of the OK attribute. This optional attribute is used to indicate that a renewable token is acceptable if the requested duration exceeds the limit of the issuance service. That is, if `true`, then the token can be renewed after its expiration. The default value is `false` for security reasons.
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>