UploadFileTask
UploadFileTask.abort
Aborts an upload task.
Parameters
Object object
Callback functions for aborting the upload task.
Callback Parameters Object res
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| complete | function |
No | Callback function when the interface call ends (executed on both success and failure). | |
| success | function |
No | Callback function for a successful interface call. | |
| fail | function |
No | Callback function for a failed interface call. |
Function Definition Example
/**
* Aborts the upload task.
*/
export function abort(params: {
/** Callback function when the interface call ends (executed on both success and failure) */
complete?: () => void;
/** Callback function for a successful interface call */
success?: (params: null) => void;
failure?: (params: {
errorMsg: string;
errorCode: string | number;
innerError: {
errorCode: string | number;
errorMsg: string;
};
}) => void;
}): void;
UploadFileTask.onHeadersReceived
Listens for the HTTP Response Header event. This trigger occurs earlier than the request completion event.
Parameters
function callback
Callback function for listening to the HTTP Response Header event, which fires before the request completes.
Callback Parameters Object res
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| header | any |
Yes | HTTP Response Header returned by the developer server. | |
| requestId | string |
Yes | Network request ID. |
UploadFileTask.offHeadersReceived
Cancels listening to the HTTP Response Header event.
Parameters
function callback
Callback function for canceling the HTTP Response Header event listener.
Callback Parameters Object res
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| header | any |
Yes | HTTP Response Header returned by the developer server. | |
| requestId | string |
Yes | Network request ID. |
UploadFileTask.onProgressUpdate
Listens for upload progress changes.
Parameters
function callback
Callback function for listening to upload progress changes.
Callback Parameters Object res
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| progress | number |
Yes | Upload progress percentage. | |
| totalBytesSent | number |
Yes | Total bytes sent so far, in Bytes. | |
| totalBytesExpectedToSend | number |
Yes | Total bytes expected to be sent, in Bytes. | |
| requestId | string |
Yes | Network request ID. |
UploadFileTask.offProgressUpdate
Cancels listening to upload progress changes.
Parameters
function callback
Callback function for canceling the upload progress change listener.
Callback Parameters Object res
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| progress | number |
Yes | Upload progress percentage. | |
| totalBytesSent | number |
Yes | Total bytes sent so far, in Bytes. | |
| totalBytesExpectedToSend | number |
Yes | Total bytes expected to be sent, in Bytes. | |
| requestId | string |
Yes | Network request ID. |
DownloadFileTask
DownloadFileTask.abort
Aborts a download task.
Parameters
Object object
Callback functions for aborting the download task.
Callback Parameters Object res
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| complete | function |
No | Callback function when the interface call ends (executed on both success and failure). | |
| success | function |
No | Callback function for a successful interface call. | |
| fail | function |
No | Callback function for a failed interface call. |
Function Definition Example
/**
* Aborts the download task.
*/
export function abort(params: {
/** Callback function when the interface call ends (executed on both success and failure) */
complete?: () => void;
/** Callback function for a successful interface call */
success?: (params: null) => void;
failure?: (params: {
errorMsg: string;
errorCode: string | number;
innerError: {
errorCode: string | number;
errorMsg: string;
};
}) => void;
}): void;
DownloadFileTask.onHeadersReceived
Listens for the HTTP Response Header event. This trigger occurs earlier than the request completion event.
Parameters
function callback
Callback function for listening to the HTTP Response Header event, which fires before the request completes.
Callback Parameters Object res
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| header | any |
Yes | HTTP Response Header returned by the developer server. | |
| requestId | string |
Yes | Network request ID. |
DownloadFileTask.offHeadersReceived
Cancels listening to the HTTP Response Header event.
Parameters
function callback
Callback function for canceling the HTTP Response Header event listener.
Callback Parameters Object res
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| header | any |
Yes | HTTP Response Header returned by the developer server. | |
| requestId | string |
Yes | Network request ID. |
DownloadFileTask.onProgressUpdate
Listens for download progress changes.
Parameters
function callback
Callback function for listening to download progress changes.
Callback Parameters Object res
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| progress | number |
Yes | Download progress percantage. | |
| totalBytesSent | number |
Yes | Total bytes downloaded so far, in Bytes. | |
| totalBytesExpectedToSend | number |
Yes | Total bytes expected to be downloaded, in Bytes. | |
| requestId | string |
Yes | Network request ID. |
DownloadFileTask.offProgressUpdate
Cancels listening to download progress changes.
Parameters
function callback
Callback function for canceling the download progresss change listener.
Callback Parameters Object res
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| progress | number |
Yes | Download progress percentage. | |
| totalBytesSent | number |
Yes | Total bytes downloaded so far, in Bytes. | |
| totalBytesExpectedToSend | number |
Yes | Total bytes expected to be downloaded, in Bytes. | |
| requestId | string |
Yes | Network request ID. |