This class is used to write Ext.data.Model data to the server in a JSON format.\nThe allowSingle configuration can be set to false to force the records to always be\nencoded in an array, even if there is only a single record being sent.
\n", + "extends": "Ext.data.writer.Writer", + "mixins": [ + + ], + "alternateClassNames": [ + "Ext.data.JsonWriter" + ], + "xtype": null, + "author": null, + "docauthor": null, + "singleton": false, + "private": false, + "cfg": [ + { + "tagname": "cfg", + "name": "allowSingle", + "member": "Ext.data.writer.Json", + "type": "Boolean", + "doc": "False to ensure that records are always wrapped in an array, even if there is only\none record being sent. When there is more than one record, they will always be encoded into an array.\nDefaults to true. Example:
\n\n// with allowSingle: true\n\"root\": {\n \"first\": \"Mark\",\n \"last\": \"Corrigan\"\n}\n\n// with allowSingle: false\n\"root\": [{\n \"first\": \"Mark\",\n \"last\": \"Corrigan\"\n}]\nTrue to use Ext.encode() on the data before sending. Defaults to false.\nThe encode option should only be set to true when a root is defined, because the values will be\nsent as part of the request parameters as opposed to a raw post. The root will be the name of the parameter\nsent to the server.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/writer/Json.js", + "linenr": 25, + "html_filename": "Json2.html", + "href": "Json2.html#Ext-data-writer-Json-cfg-encode", + "shortDoc": "True to use Ext.encode() on the data before sending. Defaults to false.\nThe encode option should only be set to true ..." + }, + { + "tagname": "cfg", + "name": "nameProperty", + "member": "Ext.data.writer.Writer", + "type": "String", + "doc": "This property is used to read the key for each value that will be sent to the server.\nFor example:
\n\nExt.define('Person', {\n extend: 'Ext.data.Model',\n fields: [{\n name: 'first',\n mapping: 'firstName'\n }, {\n name: 'last',\n mapping: 'lastName'\n }, {\n name: 'age'\n }]\n});\nnew Ext.data.writer.Writer({\n writeAllFields: true,\n nameProperty: 'mapping'\n});\n\n// This will be sent to the server\n{\n firstName: 'first name value',\n lastName: 'last name value',\n age: 1\n}\n\nDefaults to name. If the value is not present, the field name will always be used.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/writer/Writer.js", + "linenr": 32, + "html_filename": "Writer.html", + "href": "Writer.html#Ext-data-writer-Writer-cfg-nameProperty", + "shortDoc": "This property is used to read the key for each value that will be sent to the server.\nFor example:\n\nExt.define('Perso..." + }, + { + "tagname": "cfg", + "name": "root", + "member": "Ext.data.writer.Json", + "type": "String", + "doc": "The key under which the records in this Writer will be placed. Defaults to undefined.\nExample generated request, using root: 'records':
\n\n{'records': [{name: 'my record'}, {name: 'another record'}]}\nTrue to write all fields from the record to the server. If set to false it\nwill only send the fields that were modified. Defaults to true. Note that any fields that have\nExt.data.Field.persist set to false will still be ignored.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/writer/Writer.js", + "linenr": 25, + "html_filename": "Writer.html", + "href": "Writer.html#Ext-data-writer-Writer-cfg-writeAllFields", + "shortDoc": "True to write all fields from the record to the server. If set to false it\nwill only send the fields that were modifi..." + } + ], + "method": [ + { + "tagname": "method", + "name": "Json", + "member": "Ext.data.writer.Writer", + "doc": "\n", + "params": [ + { + "type": "Object", + "name": "config", + "doc": "Optional config object
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/writer/Writer.js", + "linenr": 1, + "html_filename": "Writer.html", + "href": "Writer.html#Ext-data-writer-Writer-method-constructor", + "shortDoc": "\n" + }, + { + "tagname": "method", + "name": "getRecordData", + "member": "Ext.data.writer.Writer", + "doc": "Formats the data for each record before sending it to the server. This\nmethod should be overridden to format the data in a way that differs from the default.
\n", + "params": [ + { + "type": "Object", + "name": "record", + "doc": "The record that we are writing to the server.
\n", + "optional": false + } + ], + "return": { + "type": "Object", + "doc": "An object literal of name/value keys to be written to the server.\nBy default this method returns the data property on the record.
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/writer/Writer.js", + "linenr": 87, + "html_filename": "Writer.html", + "href": "Writer.html#Ext-data-writer-Writer-method-getRecordData", + "shortDoc": "Formats the data for each record before sending it to the server. This\nmethod should be overridden to format the data..." + }, + { + "tagname": "method", + "name": "write", + "member": "Ext.data.writer.Writer", + "doc": "Prepares a Proxy's Ext.data.Request object
\n", + "params": [ + { + "type": "Ext.data.Request", + "name": "request", + "doc": "The request object
\n", + "optional": false + } + ], + "return": { + "type": "Ext.data.Request", + "doc": "The modified request object
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/writer/Writer.js", + "linenr": 69, + "html_filename": "Writer.html", + "href": "Writer.html#Ext-data-writer-Writer-method-write", + "shortDoc": "Prepares a Proxy's Ext.data.Request object
\n" + } + ], + "property": [ + + ], + "event": [ + + ], + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/writer/Json.js", + "linenr": 1, + "html_filename": "Json2.html", + "href": "Json2.html#Ext-data-writer-Json", + "cssVar": [ + + ], + "cssMixin": [ + + ], + "component": false, + "superclasses": [ + "Ext.data.writer.Writer" + ], + "subclasses": [ + + ], + "mixedInto": [ + + ], + "allMixins": [ + + ] +}); \ No newline at end of file