sync
[roojs1] / docs / symbols / Roo.data.DataProxy.json
1 {
2   "name" : "Roo.data.DataProxy",
3   "augments" : [],
4   "desc" : "This class is an abstract base class for implementations which provide retrieval of\nunformatted data objects.<br>\n<p>\nDataProxy implementations are usually used in conjunction with an implementation of Roo.data.DataReader\n(of the appropriate type which knows how to parse the data object) to provide a block of\n{@link Roo.data.Records} to an {@link Roo.data.Store}.<br>\n<p>\nCustom implementations must implement the load method as described in\n{@link Roo.data.HttpProxy#load}.",
5   "isSingleton" : false,
6   "isStatic" : false,
7   "isBuiltin" : false,
8   "memberOf" : "DataProxy",
9   "example" : "",
10   "deprecated" : "",
11   "since" : "",
12   "see" : "",
13   "params" : [],
14   "returns" : [],
15   "throws" : "",
16   "requires" : "",
17   "config" : [],
18   "methods" : [],
19   "events" : [
20     {
21       "name" : "load",
22       "type" : "function",
23       "desc" : "Fires before the load method's callback is called.",
24       "sig" : "function (This, o, arg)\n{\n\n}",
25       "memberOf" : "",
26       "example" : "",
27       "deprecated" : "",
28       "since" : "",
29       "see" : "",
30       "params" : [
31         {
32           "name" : "This",
33           "type" : "Object",
34           "desc" : "DataProxy object.",
35           "isOptional" : false
36         },
37         {
38           "name" : "o",
39           "type" : "Object",
40           "desc" : "The data object.",
41           "isOptional" : false
42         },
43         {
44           "name" : "arg",
45           "type" : "Object",
46           "desc" : "The callback argument object passed to the load function.",
47           "isOptional" : false
48         }
49       ],
50       "returns" : []
51     },
52     {
53       "name" : "beforeload",
54       "type" : "function",
55       "desc" : "Fires before a network request is made to retrieve a data object.",
56       "sig" : "function (This, params)\n{\n\n}",
57       "memberOf" : "",
58       "example" : "",
59       "deprecated" : "",
60       "since" : "",
61       "see" : "",
62       "params" : [
63         {
64           "name" : "This",
65           "type" : "Object",
66           "desc" : "DataProxy object.",
67           "isOptional" : false
68         },
69         {
70           "name" : "params",
71           "type" : "Object",
72           "desc" : "The params parameter to the load function.",
73           "isOptional" : false
74         }
75       ],
76       "returns" : []
77     },
78     {
79       "name" : "loadexception",
80       "type" : "function",
81       "desc" : "Fires if an Exception occurs during data retrieval.",
82       "sig" : "function (This, o, arg, e)\n{\n\n}",
83       "memberOf" : "",
84       "example" : "",
85       "deprecated" : "",
86       "since" : "",
87       "see" : "",
88       "params" : [
89         {
90           "name" : "This",
91           "type" : "Object",
92           "desc" : "DataProxy object.",
93           "isOptional" : false
94         },
95         {
96           "name" : "o",
97           "type" : "Object",
98           "desc" : "The data object.",
99           "isOptional" : false
100         },
101         {
102           "name" : "arg",
103           "type" : "Object",
104           "desc" : "The callback argument object passed to the load function.",
105           "isOptional" : false
106         },
107         {
108           "name" : "e",
109           "type" : "Object",
110           "desc" : "The Exception.",
111           "isOptional" : false
112         }
113       ],
114       "returns" : []
115     }
116   ]
117 }