DownloadTask.abort(params: Object)

Requires:
BaseKit≥2.0.1
Platforms:
iOSAndroid

Description

Abort the download task

Parameters

PropertyTypeRequiredDescription
complete() => voidNoCompletion callback (executed on both success and failure)
success() => voidNoCallback on successful API call
fail(params: Object) => voidNoFailure callback
fail callback parameters
PropertyTypeDescription
errorMsgstringError message
errorCodestring | numberError code
Error extension

Return Value

None

Examples

import { downloadFile } from '@ray-js/ray'

// abort is a method on DownloadTask; obtain the download task handle via ty.downloadFile first.
const downloadTask = await downloadFile({
  url: "https://airtake-public-data-1254153901.cos.ap-shanghai.myqcloud.com/ttttestfile/test_video.mp4",
});

downloadTask.abort({
  success: data => {
    console.log(data);
  },
  fail: error => {
    console.error(error);
  },
});