ExtJS 6 access messageProperty in store sync's callback

Question

I want to display a message from my server in the UI after synchronizing an ExtJS grid. Here's an excerpt of how that goes:

this.store.sync({
        callback: function (records, operation, success) {
          // messageProperty accessing code
        },
        success: function (batch, options) {
          // messageProperty accessing code
        },
        failure: function (batch, options) {
        }
    });

Here's a piece of the store definition:

 proxy: {
    headers: { 'Accept': 'application/json' },
    limitParam: undefined,
    pageParam: undefined,
    startParam: undefined,
    paramsAsJson: false,
    type: 'ajax',        
    // ...
    reader: {
        type: 'json',
        rootProperty: 'Data',
        messageProperty: 'Message'
    },
    // ...
},

Here's some data that comes back from the server (omitted the data inside the array:

{
 "Data":[
 ],
 "Message":"Success!"
}

The application doesn't seem to have issues with reading the data property (i.e. my grid works properly), but I'm not able to access the message property in either the callback or success event of the sync method. This is the error message:

Uncaught TypeError: Cannot read property 'Message' of undefined(…)

createAccessor: (function () {
    var re = /[\[\.]/;
    return function (expr) {
        var me = this,
            simple = me.getUseSimpleAccessors(),
            operatorIndex, result, current, parts, part, inExpr, isDot, isLeft, isRight, special, c, i, bracketed, len;
        if (!(expr || expr === 0)) {
            return;
        }
        if (typeof expr === 'function') {
            return expr;
        }
        if (!simple) {
            operatorIndex = String(expr).search(re);
        }
        if (simple === true || operatorIndex < 0) {
            result = function (raw) {
                return raw[expr];  <-------- This is where it goes wrong at some point
            };
        }

If I debug through this code, at some point the raw variable loses its value, which gives the expected undefined error message. My question is how I could be able to retrieve the message property in the callback or success functions of an Ext 6 store?

score 1 · Accepted Answer · answered Feb 05 '16 at 21:52

1

In ExtJS 6 Sencha has changed the default value of keepRawData to false. If you change it back to true, everything should work as expected again. Sencha docs tell us that there is a chance of a memory leak, but I have not yet experienced such an issue.

answered Feb 05 '16 at 21:52

Alexander

19,906
19
75
162

That worked. In the callback delegate, I can now access the message property using this code: this.reader.rawData.Message. – hbulens Feb 09 '16 at 08:47

score 0 · Answer 2 · answered Apr 14 '19 at 12:29

You may not have to change the default keepRawData value In ExtJS 6, you can also access the messageProperty from the operation parameter using:

operation.error;

or

operation.getError();

only problem is the error property is not set if the success parameter is true. In which case I guess they expect to you to use the records parameter since that is where the data from your server would be anyway.

ExtJS 6 access messageProperty in store sync's callback

2 Answers2

Linked