Interface IServerProxy

Hierarchy

Index

Properties

Methods

Properties

optional public alias?: Array<string>

[Config Option] (String[])

optional public alternateClassName?: any

[Config Option] (String/String[])

optional public api?: any

[Config Option] (Object)

optional public batchActions?: boolean

[Config Option] (Boolean)

optional public batchOrder?: string

[Config Option] (String)

optional public bubbleEvents?: any

[Config Option] (String/String[])

optional public cacheString?: string

[Config Option] (String)

optional public config?: any

[Config Option] (Object)

optional public directionParam?: string

[Config Option] (String)

optional public enablePagingParams?: boolean

[Config Option] (Boolean)

optional public extend?: string

[Config Option] (String)

optional public extraParams?: any

[Config Option] (Object)

optional public filterParam?: string

[Config Option] (String)

optional public groupParam?: string

[Config Option] (String)

optional public inheritableStatics?: any

[Config Option] (Object)

optional public limitParam?: string

[Config Option] (String)

optional public listeners?: any

[Config Option] (Object)

optional public mixins?: any

[Config Option] (Object)

optional public model?: any

[Config Option] (String/Ext.data.Model)

optional public noCache?: boolean

[Config Option] (Boolean)

optional public pageParam?: string

[Config Option] (String)

optional public platformConfig?: any

[Config Option] (Object)

optional public reader?: any

[Config Option] (Object/String/Ext.data.reader.Reader)

optional public self?: IClass

[Property] (Ext.Class)

optional public simpleSortMode?: boolean

[Config Option] (Boolean)

optional public singleton?: boolean

[Config Option] (Boolean)

optional public sortParam?: string

[Config Option] (String)

optional public startParam?: string

[Config Option] (String)

optional public statics?: any

[Config Option] (Object)

optional public timeout?: number

[Config Option] (Number)

optional public url?: string

[Config Option] (String)

optional public uses?: Array<string>

[Config Option] (String[])

optional public writer?: any

[Config Option] (Object/String/Ext.data.writer.Writer)

Methods

optional public addAfterListener(eventName?: any, fn?: any, scope?: any, options?: any)

[Method] Appends an after event handler

Parameters

  • eventName?: any optional

    String/String[]/Object The name of the event to listen for.

  • fn?: any optional

    Function/String The method the event invokes.

  • scope?: any optional

    Object The scope for fn.

  • options?: any optional

    Object An object containing handler configuration.

optional public addBeforeListener(eventName?: any, fn?: any, scope?: any, options?: any)

[Method] Appends a before event handler

Parameters

  • eventName?: any optional

    String/String[]/Object The name of the event to listen for.

  • fn?: any optional

    Function/String The method the event invokes.

  • scope?: any optional

    Object The scope for fn.

  • options?: any optional

    Object An object containing handler configuration.

optional public addEvents(eventNames?: any)

[Method] Adds the specified events to the list of events which this Observable may fire

Parameters

  • eventNames?: any optional

    Object/String... Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters.

optional public addListener(eventName?: any, fn?: any, scope?: any, options?: any, order?: string)

[Method] Appends an event handler to this object

Parameters

  • eventName?: any optional

    String/String[]/Object The name of the event to listen for. May also be an object who's property names are event names.

  • fn?: any optional

    Function/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below.

  • scope?: any optional

    Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

  • options?: any optional

    Object An object containing handler configuration. This object may contain any of the following properties:

  • order?: string optional

    String The order of when the listener should be added into the listener queue. Possible values are before, current and after.

optional public addManagedListener(object?: any, eventName?: any, fn?: any, scope?: any, options?: any)

[Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed

Parameters

  • object?: any optional

    Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners.

  • eventName?: any optional

    Object/String The event name, or an object containing event name properties.

  • fn?: any optional

    Function If the eventName parameter was an event name, this is the handler function.

  • scope?: any optional

    Object If the eventName parameter was an event name, this is the scope in which the handler function is executed.

  • options?: any optional

    Object If the eventName parameter was an event name, this is the addListener options.

optional public afterRequest(request?: IRequest, success?: boolean)

[Method] Optional callback function which can be used to clean up after a request has been completed

Parameters

  • request?: IRequest optional

    Ext.data.Request The Request object

  • success?: boolean optional

    Boolean True if the request was successful

optional public batch(options?: any): IBatch

[Method] Performs a batch of Operations in the order specified by batchOrder

Parameters

  • options?: any optional

    Object Object containing one or more properties supported by the batch method:

Returns

IBatch

Ext.data.Batch The newly created Batch

optional public buildRequest(operation?: IOperation): IRequest

[Method] Creates and returns an Ext data Request object based on the options passed by the Store that this Proxy is attached to

Parameters

  • operation?: IOperation optional

    Ext.data.Operation The Operation object to execute

Returns

IRequest

Ext.data.Request The request object

optional public buildUrl(request?: IRequest): string

[Method] Generates a url based on a given Ext data Request object

Parameters

  • request?: IRequest optional

    Ext.data.Request The request object

Returns

string

String The url

optional public callOverridden(args?: any): any

[Method] Call the original method that was previously overridden with override This method is deprecated as callParent does

Parameters

  • args?: any optional

    Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments)

Returns

any

Object Returns the result of calling the overridden method

optional public callOverridden(args?: any): any

[Method] Call the original method that was previously overridden with override This method is deprecated as callParent does

Parameters

  • args?: any optional

    Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments)

Returns

any

Object Returns the result of calling the overridden method

optional public callOverridden(args?: any): any

[Method] Call the original method that was previously overridden with override This method is deprecated as callParent does

Parameters

  • args?: any optional

    Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments)

Returns

any

Object Returns the result of calling the overridden method

optional public callParent(args?: any): any

[Method] Call the parent method of the current method

Parameters

  • args?: any optional

    Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments)

Returns

any

Object Returns the result of calling the parent method

optional public callParent(args?: any): any

[Method] Call the parent method of the current method

Parameters

  • args?: any optional

    Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments)

Returns

any

Object Returns the result of calling the parent method

optional public callParent(args?: any): any

[Method] Call the parent method of the current method

Parameters

  • args?: any optional

    Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments)

Returns

any

Object Returns the result of calling the parent method

optional public callSuper(args?: any): any

[Method] This method is used by an override to call the superclass method but bypass any overridden method

Parameters

  • args?: any optional

    Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments)

Returns

any

Object Returns the result of calling the superclass method

optional public callSuper(args?: any): any

[Method] This method is used by an override to call the superclass method but bypass any overridden method

Parameters

  • args?: any optional

    Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments)

Returns

any

Object Returns the result of calling the superclass method

optional public callSuper(args?: any): any

[Method] This method is used by an override to call the superclass method but bypass any overridden method

Parameters

  • args?: any optional

    Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments)

Returns

any

Object Returns the result of calling the superclass method

optional public clearListeners()

[Method] Removes all listeners for this object

optional public create()

[Method] in a ServerProxy all four CRUD operations are executed in the same manner so we delegate to doRequest in each case

optional public destroy()

[Method] Performs the given destroy operation

optional public doRequest(operation?: IOperation, callback?: any, scope?: any)

[Method] In ServerProxy subclasses the create read update and destroy methods all pass through to doRequest

Parameters

  • operation?: IOperation optional

    Ext.data.Operation The Ext.data.Operation object

  • callback?: any optional

    Function The callback function to call when the Operation has completed

  • scope?: any optional

    Object The scope in which to execute the callback

optional public enableBubble(events?: any)

[Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present

Parameters

  • events?: any optional

    String/String[] The event name to bubble, or an Array of event names.

optional public encodeFilters(filters?: IFilter[]): string

[Method] Encodes the array of Ext util Filter objects into a string to be sent in the request url

Parameters

  • filters?: IFilter[] optional

    Ext.util.Filter[] The array of Filter objects

Returns

string

String The encoded filters

optional public encodeSorters(sorters?: ISorter[]): string

[Method] Encodes the array of Ext util Sorter objects into a string to be sent in the request url

Parameters

  • sorters?: ISorter[] optional

    Ext.util.Sorter[] The array of Sorter objects

Returns

string

String The encoded sorters

optional public fireAction(eventName?: string, args?: Array<any>, fn?: any, scope?: any): any

[Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste

Parameters

  • eventName?: string optional

    String The name of the event to fire.

  • args?: Array<any> optional

    Array Arguments to pass to handers.

  • fn?: any optional

    Function Action.

  • scope?: any optional

    Object Scope of fn.

Returns

any

Object

optional public fireEvent(eventName: string, args?: Array<any>): boolean

[Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList

Parameters

  • eventName: string

    String The name of the event to fire.

  • args?: Array<any> optional

    Object... Variable number of parameters are passed to handlers.

Returns

boolean

Boolean Returns false if any of the handlers return false.

optional public getApi(): any

[Method] Returns the value of api

Returns

any

Object

optional public getBatchActions(): boolean

[Method] Returns the value of batchActions

Returns

boolean

Boolean

optional public getBatchOrder(): string

[Method] Returns the value of batchOrder

Returns

string

String

optional public getBubbleEvents(): any

[Method] Returns the value of bubbleEvents

Returns

any

String/String[]

optional public getCacheString(): string

[Method] Returns the value of cacheString

Returns

string

String

optional public getDirectionParam(): string

[Method] Returns the value of directionParam

Returns

string

String

optional public getEnablePagingParams(): boolean

[Method] Returns the value of enablePagingParams

Returns

boolean

Boolean

optional public getExtraParams(): any

[Method] Returns the value of extraParams

Returns

any

Object

optional public getFilterParam(): string

[Method] Returns the value of filterParam

Returns

string

String

optional public getGroupParam(): string

[Method] Returns the value of groupParam

Returns

string

String

optional public getId(): any

[Method] Retrieves the id of this component

Returns

any

any id

optional public getInitialConfig(name?: string): any

[Method] Returns the initial configuration passed to constructor

Parameters

  • name?: string optional

    String When supplied, value for particular configuration option is returned, otherwise the full config object is returned.

Returns

any

Object/Mixed

optional public getInitialConfig(name?: string): any

[Method] Returns the initial configuration passed to constructor

Parameters

  • name?: string optional

    String When supplied, value for particular configuration option is returned, otherwise the full config object is returned.

Returns

any

Object/Mixed

optional public getInitialConfig(name?: string): any

[Method] Returns the initial configuration passed to constructor

Parameters

  • name?: string optional

    String When supplied, value for particular configuration option is returned, otherwise the full config object is returned.

Returns

any

Object/Mixed

optional public getLimitParam(): string

[Method] Returns the value of limitParam

Returns

string

String

optional public getListeners(): any

[Method] Returns the value of listeners

Returns

any

Object

optional public getModel(): any

[Method] Returns the value of model

Returns

any

String/Ext.data.Model

optional public getNoCache(): boolean

[Method] Returns the value of noCache

Returns

boolean

Boolean

optional public getPageParam(): string

[Method] Returns the value of pageParam

Returns

string

String

optional public getReader(): any

[Method] Returns the value of reader

Returns

any

Object/String/Ext.data.reader.Reader

optional public getSimpleSortMode(): boolean

[Method] Returns the value of simpleSortMode

Returns

boolean

Boolean

optional public getSortParam(): string

[Method] Returns the value of sortParam

Returns

string

String

optional public getStartParam(): string

[Method] Returns the value of startParam

Returns

string

String

optional public getTimeout(): number

[Method] Returns the value of timeout

Returns

number

Number

optional public getWriter(): any

[Method] Returns the value of writer

Returns

any

Object/String/Ext.data.writer.Writer

optional public hasListener(eventName?: string): boolean

[Method] Checks to see if this object has any listeners for a specified event

Parameters

  • eventName?: string optional

    String The name of the event to check for

Returns

boolean

Boolean True if the event is being listened for, else false

optional public initConfig(instanceConfig?: any): any

[Method] Initialize configuration for this class

Parameters

  • instanceConfig?: any optional

    Object

Returns

any

Object mixins The mixin prototypes as key - value pairs

optional public initConfig(instanceConfig?: any): any

[Method] Initialize configuration for this class

Parameters

  • instanceConfig?: any optional

    Object

Returns

any

Object mixins The mixin prototypes as key - value pairs

optional public initConfig(instanceConfig?: any): any

[Method] Initialize configuration for this class

Parameters

  • instanceConfig?: any optional

    Object

Returns

any

Object mixins The mixin prototypes as key - value pairs

optional public mon(object?: any, eventName?: any, fn?: any, scope?: any, options?: any)

[Method] Alias for addManagedListener

Parameters

  • object?: any optional

    Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners.

  • eventName?: any optional

    Object/String The event name, or an object containing event name properties.

  • fn?: any optional

    Function If the eventName parameter was an event name, this is the handler function.

  • scope?: any optional

    Object If the eventName parameter was an event name, this is the scope in which the handler function is executed.

  • options?: any optional

    Object If the eventName parameter was an event name, this is the addListener options.

optional public mun(object?: any, eventName?: any, fn?: any, scope?: any)

[Method] Alias for removeManagedListener

Parameters

  • object?: any optional

    Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners.

  • eventName?: any optional

    Object/String The event name, or an object containing event name properties.

  • fn?: any optional

    Function If the eventName parameter was an event name, this is the handler function.

  • scope?: any optional

    Object If the eventName parameter was an event name, this is the scope in which the handler function is executed.

optional public on(eventName?: any, fn?: any, scope?: any, options?: any, order?: string)

[Method] Alias for addListener

Parameters

  • eventName?: any optional

    String/String[]/Object The name of the event to listen for. May also be an object who's property names are event names.

  • fn?: any optional

    Function/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below.

  • scope?: any optional

    Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

  • options?: any optional

    Object An object containing handler configuration. This object may contain any of the following properties:

  • order?: string optional

    String The order of when the listener should be added into the listener queue. Possible values are before, current and after.

optional public onAfter(eventName?: any, fn?: any, scope?: any, options?: any)

[Method] Alias for addAfterListener

Parameters

  • eventName?: any optional

    String/String[]/Object The name of the event to listen for.

  • fn?: any optional

    Function/String The method the event invokes.

  • scope?: any optional

    Object The scope for fn.

  • options?: any optional

    Object An object containing handler configuration.

optional public onBefore(eventName?: any, fn?: any, scope?: any, options?: any)

[Method] Alias for addBeforeListener

Parameters

  • eventName?: any optional

    String/String[]/Object The name of the event to listen for.

  • fn?: any optional

    Function/String The method the event invokes.

  • scope?: any optional

    Object The scope for fn.

  • options?: any optional

    Object An object containing handler configuration.

optional public processResponse(success?: boolean, operation?: IOperation, request?: IRequest, response?: any, callback?: any, scope?: any)

[Method] This method handles the processing of the response and is usually overridden by subclasses to do additional processing

Parameters

  • success?: boolean optional

    Boolean Whether or not this request was successful

  • operation?: IOperation optional

    Ext.data.Operation The operation we made this request for

  • request?: IRequest optional

    Ext.data.Request The request that was made

  • response?: any optional

    Object The response that we got

  • callback?: any optional

    Function The callback to be fired onces the response is processed

  • scope?: any optional

    Object The scope in which we call the callback

optional public read()

[Method] Performs the given read operation

optional public relayEvents(object?: any, events?: any): IObservable

[Method] Relays selected events from the specified Observable as if the events were fired by this

Parameters

  • object?: any optional

    Object The Observable whose events this object is to relay.

  • events?: any optional

    String/Array/Object Array of event names to relay.

Returns

IObservable

Ext.mixin.Observable this

optional public removeAfterListener(eventName?: any, fn?: any, scope?: any, options?: any)

[Method] Removes a before event handler

Parameters

  • eventName?: any optional

    String/String[]/Object The name of the event the handler was associated with.

  • fn?: any optional

    Function/String The handler to remove.

  • scope?: any optional

    Object The scope originally specified for fn.

  • options?: any optional

    Object Extra options object.

optional public removeBeforeListener(eventName?: any, fn?: any, scope?: any, options?: any)

[Method] Removes a before event handler

Parameters

  • eventName?: any optional

    String/String[]/Object The name of the event the handler was associated with.

  • fn?: any optional

    Function/String The handler to remove.

  • scope?: any optional

    Object The scope originally specified for fn.

  • options?: any optional

    Object Extra options object.

optional public removeListener(eventName?: any, fn?: any, scope?: any, options?: any, order?: string)

[Method] Removes an event handler

Parameters

  • eventName?: any optional

    String/String[]/Object The type of event the handler was associated with.

  • fn?: any optional

    Function/String The handler to remove. This must be a reference to the function passed into the addListener call.

  • scope?: any optional

    Object The scope originally specified for the handler. It must be the same as the scope argument specified in the original call to addListener or the listener will not be removed.

  • options?: any optional

    Object Extra options object. See addListener for details.

  • order?: string optional

    String The order of the listener to remove. Possible values are before, current and after.

optional public removeManagedListener(object?: any, eventName?: any, fn?: any, scope?: any)

[Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed

Parameters

  • object?: any optional

    Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners.

  • eventName?: any optional

    Object/String The event name, or an object containing event name properties.

  • fn?: any optional

    Function If the eventName parameter was an event name, this is the handler function.

  • scope?: any optional

    Object If the eventName parameter was an event name, this is the scope in which the handler function is executed.

optional public resumeEvents(discardQueuedEvents?: boolean)

[Method] Resumes firing events see suspendEvents

Parameters

  • discardQueuedEvents?: boolean optional

    Boolean Pass as true to discard any queued events.

optional public setApi(api?: any)

[Method] Sets the value of api

Parameters

  • api?: any optional

    Object

optional public setBatchActions(batchActions?: boolean)

[Method] Sets the value of batchActions

Parameters

  • batchActions?: boolean optional

    Boolean

optional public setBatchOrder(batchOrder?: string)

[Method] Sets the value of batchOrder

Parameters

  • batchOrder?: string optional

    String

optional public setBubbleEvents(bubbleEvents?: any)

[Method] Sets the value of bubbleEvents

Parameters

  • bubbleEvents?: any optional

    String/String[]

optional public setCacheString(cacheString?: string)

[Method] Sets the value of cacheString

Parameters

  • cacheString?: string optional

    String

optional public setDirectionParam(directionParam?: string)

[Method] Sets the value of directionParam

Parameters

  • directionParam?: string optional

    String

optional public setEnablePagingParams(enablePagingParams?: boolean)

[Method] Sets the value of enablePagingParams

Parameters

  • enablePagingParams?: boolean optional

    Boolean

optional public setExtraParam(name?: string, value?: any)

[Method] Sets a value in the underlying extraParams

Parameters

  • name?: string optional

    String The key for the new value

  • value?: any optional

    Object The value

optional public setExtraParams(extraParams?: any)

[Method] Sets the value of extraParams

Parameters

  • extraParams?: any optional

    Object

optional public setFilterParam(filterParam?: string)

[Method] Sets the value of filterParam

Parameters

  • filterParam?: string optional

    String

optional public setGroupParam(groupParam?: string)

[Method] Sets the value of groupParam

Parameters

  • groupParam?: string optional

    String

optional public setLimitParam(limitParam?: string)

[Method] Sets the value of limitParam

Parameters

  • limitParam?: string optional

    String

optional public setListeners(listeners?: any)

[Method] Sets the value of listeners

Parameters

  • listeners?: any optional

    Object

optional public setModel(model?: any)

[Method] Sets the value of model

Parameters

  • model?: any optional

    String/Ext.data.Model

optional public setNoCache(noCache?: boolean)

[Method] Sets the value of noCache

Parameters

  • noCache?: boolean optional

    Boolean

optional public setPageParam(pageParam?: string)

[Method] Sets the value of pageParam

Parameters

  • pageParam?: string optional

    String

optional public setReader(reader?: any)

[Method] Sets the value of reader

Parameters

  • reader?: any optional

    Object/String/Ext.data.reader.Reader

optional public setSimpleSortMode(simpleSortMode?: boolean)

[Method] Sets the value of simpleSortMode

Parameters

  • simpleSortMode?: boolean optional

    Boolean

optional public setSortParam(sortParam?: string)

[Method] Sets the value of sortParam

Parameters

  • sortParam?: string optional

    String

optional public setStartParam(startParam?: string)

[Method] Sets the value of startParam

Parameters

  • startParam?: string optional

    String

optional public setTimeout(timeout?: number)

[Method] Sets the value of timeout

Parameters

  • timeout?: number optional

    Number

optional public setUrl(url?: string)

[Method] Sets the value of url

Parameters

  • url?: string optional

    String

optional public setWriter(writer?: any)

[Method] Sets the value of writer

Parameters

  • writer?: any optional

    Object/String/Ext.data.writer.Writer

optional public suspendEvents()

[Method] Suspends the firing of all events

optional public un(eventName?: any, fn?: any, scope?: any, options?: any, order?: string)

[Method] Alias for removeListener

Parameters

  • eventName?: any optional

    String/String[]/Object The type of event the handler was associated with.

  • fn?: any optional

    Function/String The handler to remove. This must be a reference to the function passed into the addListener call.

  • scope?: any optional

    Object The scope originally specified for the handler. It must be the same as the scope argument specified in the original call to addListener or the listener will not be removed.

  • options?: any optional

    Object Extra options object. See addListener for details.

  • order?: string optional

    String The order of the listener to remove. Possible values are before, current and after.

optional public unAfter(eventName?: any, fn?: any, scope?: any, options?: any)

[Method] Alias for removeAfterListener

Parameters

  • eventName?: any optional

    String/String[]/Object The name of the event the handler was associated with.

  • fn?: any optional

    Function/String The handler to remove.

  • scope?: any optional

    Object The scope originally specified for fn.

  • options?: any optional

    Object Extra options object.

optional public unBefore(eventName?: any, fn?: any, scope?: any, options?: any)

[Method] Alias for removeBeforeListener

Parameters

  • eventName?: any optional

    String/String[]/Object The name of the event the handler was associated with.

  • fn?: any optional

    Function/String The handler to remove.

  • scope?: any optional

    Object The scope originally specified for fn.

  • options?: any optional

    Object Extra options object.

optional public update()

[Method] Performs the given update operation