UploadTask.abort(params: Object)

Requires:
BaseKit≥2.0.1
Platforms:
iOSAndroid

Description

Abort upload 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, uploadFile } from '@ray-js/ray'

// Abort an upload task: call task.abort() after obtaining the UploadTask
downloadFile({
  url: "https://airtake-public-data-1254153901.cos.ap-shanghai.myqcloud.com/ttttestfile/test_image.jpg",
  success: ({ tempFilePath }) => {
    const task = uploadFile({
      url: "https://httpbin.org/post",
      filePath: tempFilePath,
      name: "file",
      success: () => {
        task.abort({
          success: () => console.log("Upload task aborted"),
          fail: error => console.error(error),
        });
      },
      fail: error => console.error(error),
    });
  },
  fail: error => console.error(error),
});