---
name: "cancelUploadTask"
mode: "kit"
versionRequirements:
  - { name: "P2PKit", version: "0.0.1" }
platform:
  - "iOS"
  - "Android"
async: true
title: "ty.p2p.cancelUploadTask - Cancel the transfer task"
---

## cancelUploadTask

> [VERSION] P2PKit >= 0.0.1

> [PLATFORM] iOS, Android

> ⚡ **Supports Promise** — Returns a Promise when success / fail / complete callbacks are omitted.

### Description

cancel upload task

### Parameters

| Property | Type | Required | Default | Since | Description |
| --- | --- | --- | --- | --- | --- |
| `deviceId` | `string` | Yes | - | `0.0.1` | device id |
| `complete` | `() => void` | No | - | - | Callback function invoked when the API call ends (runs on success or failure) |
| `success` | `() => void` | No | - | - | Callback function invoked when the API call succeeds |
| `fail` | `(params: Object) => void` ↓see below | No | - | - | Callback function invoked when the API call fails |

#### fail callback parameters

| Property | Type | Description |
| --- | --- | --- |
| `errorMsg` | `string` | Error message |
| `errorCode` | `string \| number` | Error code |
| `innerError` | `Object` | Error extension |

##### fail(params).innerError properties

| Property | Type | Description |
| --- | --- | --- |
| `errorCode` | `string \| number` | Extended error code |
| `errorMsg` | `string` | Extended error info |


### Examples

```tsx
ty.p2p.cancelUploadTask({
  deviceId: "xx",
  success: data => {
    console.log(data);
  },
  fail: error => {
    console.error(error);
  },
});
```