\Kendo\UI\UploadAsync

A PHP class representing the async setting of Upload.

Methods

autoRetryAfter

If async.autoRetryAfter is set, the failed upload request is repeated after the declared amount of time in miliseconds.

Returns

\Kendo\UI\UploadAsync

Parameters

$value float

Example

<?php
$async = new \Kendo\UI\UploadAsync();
$async->autoRetryAfter(1);
?>

autoUpload

By default, the selected files are uploaded immediately. To change this behavior, set autoUpload to false.

Returns

\Kendo\UI\UploadAsync

Parameters

$value boolean

Example

<?php
$async = new \Kendo\UI\UploadAsync();
$async->autoUpload(true);
?>

batch

By default and if supported by the browser, the selected files are uploaded in separate requests. To change this behavior, set batch to true. As a result, all selected files are uploaded in one request.The batch mode applies to multiple files which are selected simultaneously. Files that are selected one after the other are uploaded in separate requests.

Returns

\Kendo\UI\UploadAsync

Parameters

$value boolean

Example

<?php
$async = new \Kendo\UI\UploadAsync();
$async->batch(true);
?>

chunkSize

When async.chunkSize is set, the selected files are uploaded chunk by chunk with the declared size. Each request sends a separate file blob and additional string metadata to the server. This metadata is in a stringified JSON format and contains the chunkIndex, contentType, totalFileSize, totalChunks, and uploadUid properties. These properties enable the validation and combination of the file on the server side. The response also returns a JSON object with the uploaded and fileUid properties, which notifies the client what the next chunk is.

Returns

\Kendo\UI\UploadAsync

Parameters

$value float

Example

<?php
$async = new \Kendo\UI\UploadAsync();
$async->chunkSize(1);
?>

concurrent

By default, the selected files are uploaded one after the other. When async.concurrent is set to true, all selected files start to upload simultaneously.

Returns

\Kendo\UI\UploadAsync

Parameters

$value boolean

Example

<?php
$async = new \Kendo\UI\UploadAsync();
$async->concurrent(true);
?>

maxAutoRetries

Sets the maximum number of attempts that are performed if an upload fails.

Returns

\Kendo\UI\UploadAsync

Parameters

$value float

Example

<?php
$async = new \Kendo\UI\UploadAsync();
$async->maxAutoRetries(1);
?>

removeField

The name of the form field that is submitted to removeUrl.

Returns

\Kendo\UI\UploadAsync

Parameters

$value string

Example

<?php
$async = new \Kendo\UI\UploadAsync();
$async->removeField('value');
?>

removeUrl

The URL of the handler which is responsible for the removal of the uploaded files (if any). The handler must accept POST requests with one or more "fileNames" fields which specify the files that will be deleted.

Returns

\Kendo\UI\UploadAsync

Parameters

$value string

Example

<?php
$async = new \Kendo\UI\UploadAsync();
$async->removeUrl('value');
?>

removeVerb

The HTTP verb that will be used by the remove action.

Returns

\Kendo\UI\UploadAsync

Parameters

$value string

Example

<?php
$async = new \Kendo\UI\UploadAsync();
$async->removeVerb('value');
?>

saveField

The name of the form field which is submitted to saveUrl. The default value is the input name.

Returns

\Kendo\UI\UploadAsync

Parameters

$value string

Example

<?php
$async = new \Kendo\UI\UploadAsync();
$async->saveField('value');
?>

saveUrl

The URL of the handler that will receive the submitted files. The handler must accept POST requests which contain one or more fields with the same name as the original input name.

Returns

\Kendo\UI\UploadAsync

Parameters

$value string

Example

<?php
$async = new \Kendo\UI\UploadAsync();
$async->saveUrl('value');
?>

useArrayBuffer

By default, the files are uploaded as file data. When set to true, the files are read as a file buffer by using FileReader. This buffer is sent in the request body.

Returns

\Kendo\UI\UploadAsync

Parameters

$value boolean

Example

<?php
$async = new \Kendo\UI\UploadAsync();
$async->useArrayBuffer(true);
?>

withCredentials

Controls whether to send credentials (cookies, headers) for cross-site requests.

Returns

\Kendo\UI\UploadAsync

Parameters

$value boolean

Example

<?php
$async = new \Kendo\UI\UploadAsync();
$async->withCredentials(true);
?>
Is this article helpful? Yes / No
Thank you for your feedback!

Give article feedback

Tell us how we can improve this article

close
Dummy