-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
IDataServiceConfiguration.xml
299 lines (285 loc) · 17.9 KB
/
IDataServiceConfiguration.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
<Type Name="IDataServiceConfiguration" FullName="System.Data.Services.IDataServiceConfiguration">
<TypeSignature Language="C#" Value="public interface IDataServiceConfiguration" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract IDataServiceConfiguration" />
<TypeSignature Language="DocId" Value="T:System.Data.Services.IDataServiceConfiguration" />
<TypeSignature Language="VB.NET" Value="Public Interface IDataServiceConfiguration" />
<TypeSignature Language="F#" Value="type IDataServiceConfiguration = interface" />
<TypeSignature Language="C++ CLI" Value="public interface class IDataServiceConfiguration" />
<AssemblyInfo>
<AssemblyName>System.Data.Services</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Docs>
<summary>The <see cref="T:System.Data.Services.IDataServiceConfiguration" /> is used by WCF Data Services to set up the behavior of the service, including rights on entity sets and service operations, limits on the allowed requests, registering types not discoverable by default, and the default verbosity on error handling.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This type is used by <xref:System.Data.Services.DataService%601> classes to configure the service by implementing a static method named InitializeService, returning void, and taking a single argument of type <xref:System.Data.Services.IDataServiceConfiguration>. The configuration object may only be used during the call to service initialization.
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName="MaxBatchCount">
<MemberSignature Language="C#" Value="public int MaxBatchCount { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 MaxBatchCount" />
<MemberSignature Language="DocId" Value="P:System.Data.Services.IDataServiceConfiguration.MaxBatchCount" />
<MemberSignature Language="VB.NET" Value="Public Property MaxBatchCount As Integer" />
<MemberSignature Language="F#" Value="member this.MaxBatchCount : int with get, set" Usage="System.Data.Services.IDataServiceConfiguration.MaxBatchCount" />
<MemberSignature Language="C++ CLI" Value="public:
 property int MaxBatchCount { int get(); void set(int value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Data.Services</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the maximum number of requests that can be handled in a batch.</summary>
<value>Integer value that indicates the maximum number of requests that can be handled in a batch.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MaxChangesetCount">
<MemberSignature Language="C#" Value="public int MaxChangesetCount { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 MaxChangesetCount" />
<MemberSignature Language="DocId" Value="P:System.Data.Services.IDataServiceConfiguration.MaxChangesetCount" />
<MemberSignature Language="VB.NET" Value="Public Property MaxChangesetCount As Integer" />
<MemberSignature Language="F#" Value="member this.MaxChangesetCount : int with get, set" Usage="System.Data.Services.IDataServiceConfiguration.MaxChangesetCount" />
<MemberSignature Language="C++ CLI" Value="public:
 property int MaxChangesetCount { int get(); void set(int value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Data.Services</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the maximum number of change sets that can be handled in a batch.</summary>
<value>Integer value that indicates the maximum number of change sets that can be handled in a batch.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MaxExpandCount">
<MemberSignature Language="C#" Value="public int MaxExpandCount { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 MaxExpandCount" />
<MemberSignature Language="DocId" Value="P:System.Data.Services.IDataServiceConfiguration.MaxExpandCount" />
<MemberSignature Language="VB.NET" Value="Public Property MaxExpandCount As Integer" />
<MemberSignature Language="F#" Value="member this.MaxExpandCount : int with get, set" Usage="System.Data.Services.IDataServiceConfiguration.MaxExpandCount" />
<MemberSignature Language="C++ CLI" Value="public:
 property int MaxExpandCount { int get(); void set(int value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Data.Services</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the maximum number of segments that can be expanded by the $expand query option for all requests to the data service.</summary>
<value>The maximum number of segments to expand.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
If the limit is exceeded, a 400 Bad Request status code is returned. The value specified must be between 0 and `int.MaxValue`; otherwise, an `ArgumentOutOfRangeException` is thrown.
The following query string sample has two segments:
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="MaxExpandDepth">
<MemberSignature Language="C#" Value="public int MaxExpandDepth { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 MaxExpandDepth" />
<MemberSignature Language="DocId" Value="P:System.Data.Services.IDataServiceConfiguration.MaxExpandDepth" />
<MemberSignature Language="VB.NET" Value="Public Property MaxExpandDepth As Integer" />
<MemberSignature Language="F#" Value="member this.MaxExpandDepth : int with get, set" Usage="System.Data.Services.IDataServiceConfiguration.MaxExpandDepth" />
<MemberSignature Language="C++ CLI" Value="public:
 property int MaxExpandDepth { int get(); void set(int value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Data.Services</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a maximum number of segments supported in a single <c>$expand</c> path for all requests to the data service.</summary>
<value>Integer representing the maximum number of supported segments in <c>$expand</c> path.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
If the limit is exceeded, a 400 Bad Request status code is returned. The value specified must be between 0 and `int.MaxValue`; otherwise, an `ArgumentOutOfRangeException` is thrown.
The following query string sample has two segments in the first `$expand` path and one in the second `$expand` path:
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="MaxObjectCountOnInsert">
<MemberSignature Language="C#" Value="public int MaxObjectCountOnInsert { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 MaxObjectCountOnInsert" />
<MemberSignature Language="DocId" Value="P:System.Data.Services.IDataServiceConfiguration.MaxObjectCountOnInsert" />
<MemberSignature Language="VB.NET" Value="Public Property MaxObjectCountOnInsert As Integer" />
<MemberSignature Language="F#" Value="member this.MaxObjectCountOnInsert : int with get, set" Usage="System.Data.Services.IDataServiceConfiguration.MaxObjectCountOnInsert" />
<MemberSignature Language="C++ CLI" Value="public:
 property int MaxObjectCountOnInsert { int get(); void set(int value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Data.Services</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the maximum number of objects that can be inserted in a single request.</summary>
<value>The integer value that contains the maximum number of objects that can be inserted in a single request.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MaxResultsPerCollection">
<MemberSignature Language="C#" Value="public int MaxResultsPerCollection { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 MaxResultsPerCollection" />
<MemberSignature Language="DocId" Value="P:System.Data.Services.IDataServiceConfiguration.MaxResultsPerCollection" />
<MemberSignature Language="VB.NET" Value="Public Property MaxResultsPerCollection As Integer" />
<MemberSignature Language="F#" Value="member this.MaxResultsPerCollection : int with get, set" Usage="System.Data.Services.IDataServiceConfiguration.MaxResultsPerCollection" />
<MemberSignature Language="C++ CLI" Value="public:
 property int MaxResultsPerCollection { int get(); void set(int value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Data.Services</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the maximum number of results per collection.</summary>
<value>The integer value that indicates the maximum number of results per collection.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RegisterKnownType">
<MemberSignature Language="C#" Value="public void RegisterKnownType (Type type);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void RegisterKnownType(class System.Type type) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Data.Services.IDataServiceConfiguration.RegisterKnownType(System.Type)" />
<MemberSignature Language="VB.NET" Value="Public Sub RegisterKnownType (type As Type)" />
<MemberSignature Language="F#" Value="abstract member RegisterKnownType : Type -> unit" Usage="iDataServiceConfiguration.RegisterKnownType type" />
<MemberSignature Language="C++ CLI" Value="public:
 void RegisterKnownType(Type ^ type);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Data.Services</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="type" Type="System.Type" />
</Parameters>
<Docs>
<param name="type">The resource type to register.</param>
<summary>Registers a resource type for use by the data service.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SetEntitySetAccessRule">
<MemberSignature Language="C#" Value="public void SetEntitySetAccessRule (string name, System.Data.Services.EntitySetRights rights);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void SetEntitySetAccessRule(string name, valuetype System.Data.Services.EntitySetRights rights) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Data.Services.IDataServiceConfiguration.SetEntitySetAccessRule(System.String,System.Data.Services.EntitySetRights)" />
<MemberSignature Language="VB.NET" Value="Public Sub SetEntitySetAccessRule (name As String, rights As EntitySetRights)" />
<MemberSignature Language="F#" Value="abstract member SetEntitySetAccessRule : string * System.Data.Services.EntitySetRights -> unit" Usage="iDataServiceConfiguration.SetEntitySetAccessRule (name, rights)" />
<MemberSignature Language="C++ CLI" Value="public:
 void SetEntitySetAccessRule(System::String ^ name, System::Data::Services::EntitySetRights rights);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Data.Services</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="rights" Type="System.Data.Services.EntitySetRights" />
</Parameters>
<Docs>
<param name="name">The name of the entity set for configured access.</param>
<param name="rights">The rights allowed for the entity set.</param>
<summary>Sets the access rules for the specified entity set.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The default configuration is to deny access to resources. When a service is initialized the access rights must be enabled.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="SetServiceOperationAccessRule">
<MemberSignature Language="C#" Value="public void SetServiceOperationAccessRule (string name, System.Data.Services.ServiceOperationRights rights);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void SetServiceOperationAccessRule(string name, valuetype System.Data.Services.ServiceOperationRights rights) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Data.Services.IDataServiceConfiguration.SetServiceOperationAccessRule(System.String,System.Data.Services.ServiceOperationRights)" />
<MemberSignature Language="VB.NET" Value="Public Sub SetServiceOperationAccessRule (name As String, rights As ServiceOperationRights)" />
<MemberSignature Language="F#" Value="abstract member SetServiceOperationAccessRule : string * System.Data.Services.ServiceOperationRights -> unit" Usage="iDataServiceConfiguration.SetServiceOperationAccessRule (name, rights)" />
<MemberSignature Language="C++ CLI" Value="public:
 void SetServiceOperationAccessRule(System::String ^ name, System::Data::Services::ServiceOperationRights rights);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Data.Services</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="rights" Type="System.Data.Services.ServiceOperationRights" />
</Parameters>
<Docs>
<param name="name">The name of the service operation on which to set access rights.</param>
<param name="rights">The rights allowed according to <see cref="T:System.Data.Services.ServiceOperationRights" /> enumeration.</param>
<summary>Sets the access rules for the specified service operation.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The default configuration is to deny access to resources. When a service is initialized, the access rights must be enabled.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="UseVerboseErrors">
<MemberSignature Language="C#" Value="public bool UseVerboseErrors { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool UseVerboseErrors" />
<MemberSignature Language="DocId" Value="P:System.Data.Services.IDataServiceConfiguration.UseVerboseErrors" />
<MemberSignature Language="VB.NET" Value="Public Property UseVerboseErrors As Boolean" />
<MemberSignature Language="F#" Value="member this.UseVerboseErrors : bool with get, set" Usage="System.Data.Services.IDataServiceConfiguration.UseVerboseErrors" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool UseVerboseErrors { bool get(); void set(bool value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Data.Services</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets whether verbose errors are used by default for all responses from the data service.</summary>
<value>A Boolean value that indicates whether verbose errors are returned.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The response from a specified request can be overridden by the data service developer by overriding the `HandleException` method. Verbose errors should only be enabled during development, not in production environments, for security reasons.
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>