Results 1 to 2 of 2

Thread: parameters missing at Ext.data.ProxyStore.sync()

    This duplicates another bug already reported in our system: DOCS-363
  1. #1
    Sencha Premium Member
    Join Date
    Jun 2011
    Location
    NL
    Posts
    253
    Answers
    22

    Default parameters missing at Ext.data.ProxyStore.sync()

    No parameter documentation displayed for the sync() method on the Ext.data.ProxyStore class. This applies to Ext JS 5.0 and up (also current version 6.2.1).

    Example: http://docs.sencha.com/extjs/6.2.1/c...ml#method-sync

    docs missing sync params.jpg

    When I click on the view source link, I do see all parameters:

    Code:
    /*** Synchronizes the store with its {@link #proxy}. This asks the proxy to batch together any new, updated
    * and deleted records in the store, updating the store's internal representation of the records
    * as each operation completes.
    * 
    * @param {Object} [options] Object containing one or more properties supported by the sync method (these get 
    * passed along to the underlying proxy's {@link Ext.data.Proxy#batch batch} method):
    * 
    * @param {Ext.data.Batch/Object} [options.batch] A {@link Ext.data.Batch} object (or batch config to apply 
    * to the created batch). If unspecified a default batch will be auto-created as needed.
    * 
    * @param {Function} [options.callback] The function to be called upon completion of the sync.
    * The callback is called regardless of success or failure and is passed the following parameters:
    * @param {Ext.data.Batch} options.callback.batch The {@link Ext.data.Batch batch} that was processed,
    * containing all operations in their current state after processing
    * @param {Object} options.callback.options The options argument that was originally passed into sync
    * 
    * @param {Function} [options.success] The function to be called upon successful completion of the sync. The 
    * success function is called only if no exceptions were reported in any operations. If one or more exceptions
    * occurred then the failure function will be called instead. The success function is called 
    * with the following parameters:
    * @param {Ext.data.Batch} options.success.batch The {@link Ext.data.Batch batch} that was processed,
    * containing all operations in their current state after processing
    * @param {Object} options.success.options The options argument that was originally passed into sync
    * 
    * @param {Function} [options.failure] The function to be called upon unsuccessful completion of the sync. The 
    * failure function is called when one or more operations returns an exception during processing (even if some
    * operations were also successful). In this case you can check the batch's {@link Ext.data.Batch#exceptions 
    * exceptions} array to see exactly which operations had exceptions. The failure function is called with the 
    * following parameters:
    * @param {Ext.data.Batch} options.failure.batch The {@link Ext.data.Batch} that was processed, containing all
    * operations in their current state after processing
    * @param {Object} options.failure.options The options argument that was originally passed into sync
    * 
    * @param {Object} [options.params] Additional params to send during the sync Operation(s).
    *
    * @param {Object} [options.scope] The scope in which to execute any callbacks (i.e. the `this` object inside
    * the callback, success and/or failure functions). Defaults to the store's proxy.
    * 
    * @return {Ext.data.Store} this
    */

  2. #2
    Sencha User
    Join Date
    Mar 2012
    Location
    Lawrence, KS
    Posts
    462
    Answers
    65

    Default

    Thanks for the report! I have opened a bug in our bug tracker.

Similar Threads

  1. [OPEN] Documentation: missing Ext.data.JsonP.request() callbacks parameters
    By agarberi in forum Ext JS 6.x Bugs
    Replies: 1
    Last Post: 3 Feb 2016, 7:32 AM
  2. Replies: 3
    Last Post: 21 Jan 2016, 8:03 AM
  3. Passing parameters through store.sync()
    By Yazid in forum Ext: Discussion
    Replies: 2
    Last Post: 17 Apr 2013, 5:14 PM
  4. LocalStorage/Proxystore sync causes duplicate content in DataView
    By Brainstation.Mike in forum Sencha Touch 2.x: Q&A
    Replies: 2
    Last Post: 10 Apr 2013, 8:14 AM
  5. LocalStorage/Proxystore sync causes duplicate content in DataView
    By Brainstation.Mike in forum Sencha Architect 2.x: Help & Discussions
    Replies: 1
    Last Post: 6 Apr 2013, 12:46 AM

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •