This class is used to send requests to the server using Ext.direct. When a request is made, the transport mechanism is handed off to the appropriate Provider to complete the call. More...

Inheritance diagram for Ext.Net.DirectProxy:

Classes
class	Builder

class	Config

Public Member Functions
	DirectProxy ()

DirectProxy.Builder	ToBuilder ()

override IControlBuilder	ToNativeBuilder ()

	DirectProxy (Config config)

Public Member Functions inherited from Ext.Net.BaseItem
virtual bool	HasExplicitValue (string name)

void	EnsureDataBind ()

virtual void	Call (string name)

virtual void	Call (string name, params object[] args)

virtual void	AddScript (string script)

virtual void	AddScript (string script, params object[] args)

virtual bool	IsEmptyObject ()

T	Apply< T > (IApply config)

BaseItem	Apply (object config)

virtual void	LoadViewState (object state)

virtual object	SaveViewState ()

virtual void	TrackViewState ()

void	SetDirty ()

virtual void	DataBind ()

Static Public Member Functions
static implicit	operator DirectProxy (DirectProxy.Config config)

Properties
override string	InstanceOf `[get]`

override string	Type `[get]`
	Alias More...

override CRUDUrls??	API `[get]`
	Specific direct functions to call on CRUD action methods "read", "create", "update" and "destroy". The direct function is built based upon the action being executed [load\|create\|save\|destroy] using the commensurate api property. More...

virtual JFunction	DirectFn `[get]`
	Function to call when executing a request. directFn is a simple alternative to defining the api configuration-parameter for Store's which will not implement a full CRUD api. More...

virtual string	ParamOrder `[get, set]`
	Defaults to undefined. A list of params to be executed server side. Specify the params in the order in which they must be executed on the server-side as a String of params delimited by either whitespace, comma, or pipe. For example, any of the following would be acceptable: paramOrder: 'param1 param2 param3' paramOrder: 'param1,param2,param3' paramOrder: 'param1\|param2\|param' More...

virtual bool	ParamsAsHash `[get, set]`
	Send parameters as a collection of named arguments (defaults to true). Providing a paramOrder nullifies this configuration. More...

override ConfigOptionsCollection	ConfigOptions `[get]`

Properties inherited from Ext.Net.ServerProxy
override string	InstanceOf `[get]`

virtual CRUDUrls??	API `[get]`
	Specific urls to call on CRUD action methods "read", "create", "update" and "destroy". The url is built based upon the action being executed [load\|create\|save\|destroy] using the commensurate api property, or if undefined default to the configured Ext.data.Store.url. If the specific URL for a given CRUD action is undefined, the CRUD action request will be directed to the configured url. 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...

virtual 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...

virtual 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...

virtual string	UrlProxy `[get]`

virtual string	StartParamProxy `[get]`

virtual string	LimitParamProxy `[get]`

virtual 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...

virtual 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. Parameters request : Ext.data.Request The request object Returns The url More...

override ConfigOptionsCollection	ConfigOptions `[get]`

Properties inherited from Ext.Net.AbstractProxy
override string	InstanceOf `[get]`

abstract string	Type `[get]`
	Alias More...

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...

string	PropertyName `[get]`

override ConfigOptionsCollection	ConfigOptions `[get]`

Properties inherited from Ext.Net.BaseItem
virtual string	InstanceOf `[get]`

ItemState	State `[get]`

virtual DefaultValueMode	DefaultValueMode `[get, set]`

virtual bool	DesignMode `[get]`

bool	AutoDataBind `[get, set]`

ResourceManager	ResourceManager `[get]`

virtual Control	Owner `[get, set]`
	The Owner Control for this Listener. More...

virtual bool	IsDefault `[get]`
	Does this object currently represent it's default state. More...

bool	IsTrackingViewState `[get]`

EventHandlerList	Events `[get]`

EventHandler	DataBinding

Control??	BindingContainer `[get]`

virtual ConfigItemCollection??	CustomConfig `[get]`
	Collection of custom js config More...

virtual ConfigOptionsCollection	ConfigOptions `[get]`

virtual ConfigOptionsExtraction	ConfigOptionsExtraction `[get]`

System.Web.Mvc.HtmlHelper??	HtmlHelper `[get, set]`

Properties inherited from Ext.Net.IXObject
ConfigOptionsCollection	ConfigOptions `[get]`

ConfigOptionsExtraction	ConfigOptionsExtraction `[get]`

DefaultValueMode	DefaultValueMode `[get, set]`

Properties inherited from Ext.Net.IAlias
string	PropertyName `[get]`

Additional Inherited Members
Protected Member Functions inherited from Ext.Net.BaseItem
	BaseItem (Control owner)

	BaseItem ()

virtual void	OwnerUpdate (Control owner)

virtual void	OnDataBinding (EventArgs e)

Detailed Description

This class is used to send requests to the server using Ext.direct. When a request is made, the transport mechanism is handed off to the appropriate Provider to complete the call.

Specifying the function This proxy expects a Direct remoting method to be passed in order to be able to complete requests. This can be done by specifying the directFn configuration. This will use the same direct method for all requests. Alternatively, you can provide an api configuration. This allows you to specify a different remoting method for each CRUD action.

Paramaters This proxy provides options to help configure which parameters will be sent to the server. By specifying the paramsAsHash option, it will send an object literal containing each of the passed parameters. The paramOrder option can be used to specify the order in which the remoting method parameters are passed.

Example Usage

Ext.define('User', { extend: 'Ext.data.Model', fields: ['firstName', 'lastName'], proxy: { type: 'direct', directFn: MyApp.getUsers, paramOrder: 'id' // Tells the proxy to pass the id as the first parameter to the remoting method. } }); User.load(1);

Constructor & Destructor Documentation

◆ DirectProxy() [1/2]

Ext.Net.DirectProxy.DirectProxy ( )

inline

◆ DirectProxy() [2/2]

Ext.Net.DirectProxy.DirectProxy ( Config config )

inline

Member Function Documentation

◆ operator DirectProxy()

static implicit Ext.Net.DirectProxy.operator DirectProxy ( DirectProxy.Config config )

inlinestatic

◆ ToBuilder()

DirectProxy.Builder Ext.Net.DirectProxy.ToBuilder ( )

inline

◆ ToNativeBuilder()

override IControlBuilder Ext.Net.DirectProxy.ToNativeBuilder ( )

inlinevirtual

Reimplemented from Ext.Net.BaseItem.

Property Documentation

◆ API

override CRUDUrls?? Ext.Net.DirectProxy.API

get

Specific direct functions to call on CRUD action methods "read", "create", "update" and "destroy". The direct function is built based upon the action being executed [load|create|save|destroy] using the commensurate api property.

◆ ConfigOptions

override ConfigOptionsCollection Ext.Net.DirectProxy.ConfigOptions

get

◆ DirectFn

virtual JFunction Ext.Net.DirectProxy.DirectFn

get

Function to call when executing a request. directFn is a simple alternative to defining the api configuration-parameter for Store's which will not implement a full CRUD api.

◆ InstanceOf

override string Ext.Net.DirectProxy.InstanceOf

get

◆ ParamOrder

virtual string Ext.Net.DirectProxy.ParamOrder

getset

Defaults to undefined. A list of params to be executed server side. Specify the params in the order in which they must be executed on the server-side as a String of params delimited by either whitespace, comma, or pipe. For example, any of the following would be acceptable: paramOrder: 'param1 param2 param3' paramOrder: 'param1,param2,param3' paramOrder: 'param1|param2|param'

◆ ParamsAsHash

virtual bool Ext.Net.DirectProxy.ParamsAsHash

getset

Send parameters as a collection of named arguments (defaults to true). Providing a paramOrder nullifies this configuration.

◆ Type

override string Ext.Net.DirectProxy.Type

getprotected

Alias

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

DirectProxy.cs
DirectProxyConfigOptions.cs
DirectProxyBuilder.cs
DirectProxyConfig.cs

Classes

Public Member Functions

Static Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DirectProxy() [1/2]

◆ DirectProxy() [2/2]

Member Function Documentation

◆ operator DirectProxy()

◆ ToBuilder()

◆ ToNativeBuilder()

Property Documentation

◆ API

◆ ConfigOptions

◆ DirectFn

◆ InstanceOf

◆ ParamOrder

◆ ParamsAsHash

◆ Type