Ext.NET  5.3.0
.NET Component Framework for Enterprise Level Apps
Ext.Net.RestProxy.Config Class Reference

More...

Inheritance diagram for Ext.Net.RestProxy.Config:
Ext.Net.AjaxProxy.Config Ext.Net.ServerProxy.Config Ext.Net.AbstractProxy.Config Ext.Net.BaseItem.Config Ext.Net.IApply

Static Public Member Functions

static implicit operator RestProxy.Builder (RestProxy.Config config)
 
- Static Public Member Functions inherited from Ext.Net.AjaxProxy.Config
static implicit operator AjaxProxy.Builder (AjaxProxy.Config config)
 
- Static Public Member Functions inherited from Ext.Net.BaseItem.Config
static Config Deserialize (string config)
 
static TConfig Deserialize< TConfig > (string config)
 

Properties

virtual bool AppendId [get, set]
 True to automatically append the ID of a Model instance when performing a request based on that single instance. See RestProxy intro docs for more details. Defaults to true. More...
 
virtual string Format [get, set]
 Optional data format to send to the server when making any request (e.g. 'json'). See the RestProxy intro docs for full details. Defaults to undefined. More...
 
- Properties inherited from Ext.Net.AjaxProxy.Config
ParameterCollection Headers [get]
 Any headers to add to the Ajax request. Defaults to undefined. More...
 
virtual bool Json [get, set]
 Send params as JSON object More...
 
virtual bool Xml [get, set]
 Send params as XML object More...
 
CRUDMethods ActionMethods [get]
 Mapping of action name to HTTP request method. In the basic AjaxProxy these are set to 'GET' for 'read' actions and 'POST' for 'create', 'update' and 'destroy' actions. The Ext.data.proxy.Rest maps these to the correct RESTful methods. More...
 
JFunction GetMethod [get]
 Returns the HTTP method name for a given request. By default this returns based on a lookup on actionMethods. More...
 
virtual string Password [get, set]
 Most oData feeds require basic HTTP authentication. This configuration allows you to specify the password. More...
 
virtual bool UseDefaultXhrHeader [get, set]
 Set this to false to not send the default Xhr header (X-Requested-With) with every request. This should be set to false when making CORS (cross-domain) requests. Defaults to true. More...
 
virtual string Username [get, set]
 Most oData feeds require basic HTTP authentication. This configuration allows you to specify the username.. More...
 
virtual bool WithCredentials [get, set]
 This configuration is sometimes necessary when using cross-origin resource sharing. Defaults to false. More...
 
- Properties inherited from Ext.Net.ServerProxy.Config
CRUDUrls API [get]
 Specific urls to call on CRUD action methods "read", "create", "update" and "destroy". More...
 
virtual string CacheString [get, set]
 The name of the cache param added to the url when using noCache (defaults to "_dc") More...
 
virtual string DirectionParam [get, set]
 The name of the direction parameter to send in a request. This is only used when simpleSortMode is set to true. Defaults to 'dir'. More...
 
ParameterCollection ExtraParams [get]
 Extra parameters that will be included on every request. Individual requests with params of the same name will override these params when they are in conflict. More...
 
virtual string FilterParam [get, set]
 The name of the 'filter' parameter to send in a request. Defaults to 'filter'. Set this to undefined if you don't want to send a filter parameter More...
 
virtual string GroupParam [get, set]
 The name of the 'group' parameter to send in a request. Defaults to 'group'. Set this to undefined if you don't want to send a group parameter More...
 
virtual string GroupDirectionParam [get, set]
 The name of the direction parameter to send in a request. This is only used when simpleGroupMode is set to true. Defaults to 'groupDir'. More...
 
virtual string IDParam [get, set]
 The name of the parameter which carries the id of the entity being operated upon. Defaults to: "id" More...
 
virtual string LimitParam [get, set]
 The name of the 'limit' parameter to send in a request. Defaults to 'limit'. Set this to undefined if you don't want to send a limit parameter More...
 
virtual bool NoCache [get, set]
 Defaults to true. Disable caching by adding a unique parameter name to the request. Set to false to allow caching. Defaults to true. More...
 
virtual bool AppendAction [get, set]
 
virtual string PageParam [get, set]
 The name of the 'page' parameter to send in a request. Defaults to 'page'. Set this to undefined if you don't want to send a page parameter More...
 
ReaderCollection Reader [get]
 The Ext.data.reader.Reader to use to decode the server's response. This can either be a Reader instance, a config object or just a valid Reader type name (e.g. 'json', 'xml'). More...
 
virtual bool SimpleSortMode [get, set]
 Enabling simpleSortMode in conjunction with remoteSort will only send one sort property and a direction when a remote sort is requested. The directionParam and sortParam will be sent with the property name and either 'ASC' or 'DESC'. Defaults to: false More...
 
virtual bool SimpleGroupMode [get, set]
 Enabling simpleGroupMode in conjunction with remoteGroup will only send one group property and a direction when a remote group is requested. The groupDirectionParam and groupParam will be sent with the property name and either 'ASC' or 'DESC'. Defaults to: false More...
 
virtual string SortParam [get, set]
 The name of the 'sort' parameter to send in a request. Defaults to 'sort'. Set this to undefined if you don't want to send a sort parameter More...
 
virtual string StartParam [get, set]
 The name of the 'start' parameter to send in a request. Defaults to 'start'. Set this to undefined if you don't want to send a start parameter More...
 
virtual int Timeout [get, set]
 The number of milliseconds to wait for a response. Defaults to 30000 milliseconds (30 seconds). More...
 
virtual string Url [get, set]
 The default URL to be used for requests to the server. More...
 
WriterCollection Writer [get]
 The Ext.data.writer.Writer to use to encode any request sent to the server. This can either be a Writer instance, a config object or just a valid Writer type name (e.g. 'json', 'xml'). More...
 
ProxyListeners Listeners [get]
 Client-side JavaScript Event Handlers More...
 
JFunction BuildUrl [get]
 Generates a url based on a given Ext.data.Request object. By default, ServerProxy's buildUrl will add the cache-buster param to the end of the url. Subclasses may need to perform additional modifications to the url. More...
 
- Properties inherited from Ext.Net.AbstractProxy.Config
virtual bool BatchActions [get, set]
 True to batch actions of a particular type when synchronizing the store. Defaults to true. More...
 
virtual string BatchOrder [get, set]
 Comma-separated ordering 'create', 'update' and 'destroy' actions when batching. Override this to set a different order for the batched CRUD actions to be executed in. Defaults to 'create,update,destroy' More...
 

Additional Inherited Members

- Public Member Functions inherited from Ext.Net.BaseItem.Config
override string ToString ()
 
override bool Equals (object obj)
 
override int GetHashCode ()
 
new Type GetType ()
 
object ApplyIf (object obj)
 
Apply< T > (object obj)
 
object Apply (object obj)
 
virtual string Serialize ()
 

Detailed Description

Member Function Documentation

◆ operator RestProxy.Builder()

static implicit Ext.Net.RestProxy.Config.operator RestProxy.Builder ( RestProxy.Config  config)
inlinestatic

Property Documentation

◆ AppendId

virtual bool Ext.Net.RestProxy.Config.AppendId
getset

True to automatically append the ID of a Model instance when performing a request based on that single instance. See RestProxy intro docs for more details. Defaults to true.

◆ Format

virtual string Ext.Net.RestProxy.Config.Format
getset

Optional data format to send to the server when making any request (e.g. 'json'). See the RestProxy intro docs for full details. Defaults to undefined.


The documentation for this class was generated from the following file: