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

More...

Inheritance diagram for Ext.Net.ServerProxy.Config:
Ext.Net.AbstractProxy.Config Ext.Net.BaseItem.Config Ext.Net.IApply Ext.Net.AjaxProxy.Config Ext.Net.DirectProxy.Config Ext.Net.JsonPProxy.Config Ext.Net.PageProxy.Config Ext.Net.ODataProxy.Config Ext.Net.RestProxy.Config

Properties

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 ()
 
- Static Public Member Functions inherited from Ext.Net.BaseItem.Config
static Config Deserialize (string config)
 
static TConfig Deserialize< TConfig > (string config)
 

Detailed Description

Property Documentation

◆ API

CRUDUrls Ext.Net.ServerProxy.Config.API
get

Specific urls to call on CRUD action methods "read", "create", "update" and "destroy".

◆ AppendAction

virtual bool Ext.Net.ServerProxy.Config.AppendAction
getset

◆ BuildUrl

JFunction Ext.Net.ServerProxy.Config.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.

◆ CacheString

virtual string Ext.Net.ServerProxy.Config.CacheString
getset

The name of the cache param added to the url when using noCache (defaults to "_dc")

◆ DirectionParam

virtual string Ext.Net.ServerProxy.Config.DirectionParam
getset

The name of the direction parameter to send in a request. This is only used when simpleSortMode is set to true. Defaults to 'dir'.

◆ ExtraParams

ParameterCollection Ext.Net.ServerProxy.Config.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.

◆ FilterParam

virtual string Ext.Net.ServerProxy.Config.FilterParam
getset

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

◆ GroupDirectionParam

virtual string Ext.Net.ServerProxy.Config.GroupDirectionParam
getset

The name of the direction parameter to send in a request. This is only used when simpleGroupMode is set to true. Defaults to 'groupDir'.

◆ GroupParam

virtual string Ext.Net.ServerProxy.Config.GroupParam
getset

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

◆ IDParam

virtual string Ext.Net.ServerProxy.Config.IDParam
getset

The name of the parameter which carries the id of the entity being operated upon. Defaults to: "id"

◆ LimitParam

virtual string Ext.Net.ServerProxy.Config.LimitParam
getset

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

◆ Listeners

ProxyListeners Ext.Net.ServerProxy.Config.Listeners
get

Client-side JavaScript Event Handlers

◆ NoCache

virtual bool Ext.Net.ServerProxy.Config.NoCache
getset

Defaults to true. Disable caching by adding a unique parameter name to the request. Set to false to allow caching. Defaults to true.

◆ PageParam

virtual string Ext.Net.ServerProxy.Config.PageParam
getset

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

◆ Reader

ReaderCollection Ext.Net.ServerProxy.Config.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').

◆ SimpleGroupMode

virtual bool Ext.Net.ServerProxy.Config.SimpleGroupMode
getset

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

◆ SimpleSortMode

virtual bool Ext.Net.ServerProxy.Config.SimpleSortMode
getset

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

◆ SortParam

virtual string Ext.Net.ServerProxy.Config.SortParam
getset

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

◆ StartParam

virtual string Ext.Net.ServerProxy.Config.StartParam
getset

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

◆ Timeout

virtual int Ext.Net.ServerProxy.Config.Timeout
getset

The number of milliseconds to wait for a response. Defaults to 30000 milliseconds (30 seconds).

◆ Url

virtual string Ext.Net.ServerProxy.Config.Url
getset

The default URL to be used for requests to the server.

◆ Writer

WriterCollection Ext.Net.ServerProxy.Config.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').


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