transport.destroy Object|String|Function
The configuration used when the data source destroys data items. Those are items removed from the data source via the remove method.
The data source uses jQuery.ajax to make an HTTP request to the remote service. The value configured via
transport.destroy
is passed tojQuery.ajax
. This means that you can set all options supported byjQuery.ajax
viatransport.destroy
except thesuccess
anderror
callback functions which are used by the transport.
If the value of transport.destroy
is a function, the data source invokes that function instead of jQuery.ajax
.
If the value of transport.destroy
is a string, the data source uses this string as the URL of the remote service.
All transport actions (read, update, create, destroy) must be defined in the same way, that is, as functions or as objects. Mixing the different configuration alternatives is not possible.
Example - set the destroy remote service
<script>
var dataSource = new kendo.data.DataSource({
transport: {
read: {
url: "https://demos.telerik.com/kendo-ui/service/products",
dataType: "jsonp"
},
// make JSONP request to https://demos.telerik.com/kendo-ui/service/products/destroy
destroy: {
url: "https://demos.telerik.com/kendo-ui/service/products/destroy",
dataType: "jsonp" // "jsonp" is required for cross-domain requests; use "json" for same-domain requests
},
parameterMap: function(data, type) {
if (type == "destroy") {
// send the destroyed data items as the "models" service parameter encoded in JSON
return { models: kendo.stringify(data.models) }
}
}
},
batch: true,
schema: {
model: { id: "ProductID" }
}
});
dataSource.fetch(function() {
var products = dataSource.data();
// remove the first data item
dataSource.remove(products[0]);
// send the destroyed data item to the remote service
dataSource.sync();
});
</script>
Example - set destroy as a function
<script>
var dataSource = new kendo.data.DataSource({
transport: {
read: function(options) {
$.ajax({
url: "https://demos.telerik.com/kendo-ui/service/products",
dataType: "jsonp",
success: function(result) {
options.success(result);
}
});
},
destroy: function (options) {
// make JSONP request to https://demos.telerik.com/kendo-ui/service/products/destroy
$.ajax({
url: "https://demos.telerik.com/kendo-ui/service/products/destroy",
dataType: "jsonp", // "jsonp" is required for cross-domain requests; use "json" for same-domain requests
// send the destroyed data items as the "models" service parameter encoded in JSON
data: {
models: kendo.stringify(options.data.models)
},
success: function(result) {
// notify the data source that the request succeeded
options.success(result);
},
error: function(result) {
// notify the data source that the request failed
options.error(result);
}
});
}
},
batch: true,
schema: {
model: { id: "ProductID" }
}
});
dataSource.fetch(function() {
var products = dataSource.data();
dataSource.remove(products[0]);
dataSource.sync();
});
</script>
transport.destroy.cache Boolean
If set to false
, the request result will not be cached by the browser. Setting cache
to false
will only work correctly with HEAD and GET requests. It works by appending "_={timestamp}" to the GET parameters. By default, "jsonp"
requests are not cached.
Refer to the jQuery.ajax documentation for further information.
Example - enable request caching
<script>
var dataSource = new kendo.data.DataSource({
transport: {
destroy: {
/* omitted for brevity */
cache: true
}
}
});
</script>
transport.destroy.contentType String
The content-type HTTP header sent to the server. The default is "application/x-www-form-urlencoded"
. Use "application/json"
if the content is JSON. Refer to the jQuery.ajax documentation for further information.
Example - set the content type
<script>
var dataSource = new kendo.data.DataSource({
transport: {
destroy: {
/* omitted for brevity */
contentType: "application/json"
}
}
});
</script>
transport.destroy.data Object|Function
Additional parameters which are sent to the remote service. The parameter names must not match reserved words, which are used by the Kendo UI DataSource for sorting, filtering, paging, and grouping.
Refer to the jQuery.ajax documentation for further information.
Example - send additional parameters as an object
<script>
var dataSource = new kendo.data.DataSource({
transport: {
destroy: {
/* omitted for brevity */
data: {
name: "Jane Doe",
age: 30
}
}
}
});
</script>
Example - send additional parameters by returning them from a function
<script>
var dataSource = new kendo.data.DataSource({
transport: {
destroy: {
/* omitted for brevity */
data: function() {
return {
name: "Jane Doe",
age: 30
}
}
}
}
});
</script>
transport.destroy.dataType String
The type of result expected from the server. Commonly used values are "json"
and "jsonp"
.
Refer to the jQuery.ajax documentation for further information.
Example - set the data type to JSON
<script>
var dataSource = new kendo.data.DataSource({
transport: {
destroy: {
/* omitted for brevity */
dataType: "json"
}
}
});
</script>
transport.destroy.type String
The type of request to make ("POST"
, "GET"
, "PUT"
or "DELETE"
). The default request is "GET"
.
The
type
option is ignored ifdataType
is set to"jsonp"
. JSONP always uses GET requests.
Refer to the jQuery.ajax documentation for further information.
Example
<script>
var dataSource = new kendo.data.DataSource({
transport: {
destroy: {
/* omitted for brevity */
type: "POST"
}
}
});
</script>
transport.destroy.url String|Function
The URL to which the request is sent.
If set to a function, the data source will invoke it and use the result as the URL.
Example - specify the URL as a string
<script>
var dataSource = new kendo.data.DataSource({
transport: {
read: {
url: "https://demos.telerik.com/kendo-ui/service/products",
dataType: "jsonp"
},
destroy: {
url: "https://demos.telerik.com/kendo-ui/service/products/destroy",
dataType: "jsonp" // "jsonp" is required for cross-domain requests; use "json" for same-domain requests
},
parameterMap: function(data, type) {
if (type == "destroy") {
return { models: kendo.stringify(data.models) }
}
}
},
batch: true,
schema: {
model: { id: "ProductID" }
}
});
dataSource.fetch(function() {
var products = dataSource.data();
dataSource.remove(products[0]);
dataSource.sync();
});
</script>
Example - specify the URL as a function
<script>
var dataSource = new kendo.data.DataSource({
transport: {
read: {
url: "https://demos.telerik.com/kendo-ui/service/products",
dataType: "jsonp"
},
destroy: {
url: function (options) {
return "https://demos.telerik.com/kendo-ui/service/products/destroy"
},
dataType: "jsonp" // "jsonp" is required for cross-domain requests; use "json" for same-domain requests
},
parameterMap: function(data, type) {
if (type == "destroy") {
return { models: kendo.stringify(data.models) }
}
}
},
batch: true,
schema: {
model: { id: "ProductID" }
}
});
dataSource.fetch(function() {
var products = dataSource.data();
dataSource.remove(products[0]);
dataSource.sync();
});
</script>