---
name: "uploadFile"
mode: "kit"
versionRequirements:
  - { name: "P2PKit", version: "0.0.1" }
platform:
  - "iOS"
  - "Android"
async: true
title: "ty.p2p.uploadFile - P2PUpload file"
---

## uploadFile

> [VERSION] P2PKit >= 0.0.1

> [PLATFORM] iOS, Android

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

### Description

Upload file

### Parameters

| Property | Type | Required | Default | Since | Description |
| --- | --- | --- | --- | --- | --- |
| `deviceId` | `string` | Yes | - | `0.0.1` | Device ID |
| `albumName` | `string` | Yes | - | `0.0.1` | albumName, provided by the device |
| `filePath` | `string` | Yes | - | `0.0.1` | Local file path |
| `extData` | `string` | No | - | `0.0.1` | ext data |
| `extDataLength` | `number` | No | - | `0.0.1` | ext data length |
| `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` | Extended error |

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

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


### Examples

```tsx
ty.p2p.uploadFile({
  deviceId: "xx",
  albumName: "xx",
  filePath: "xx",
  extData: "xx",
  extDataLength: 1,
  success: data => {
    console.log(data);
  },
  fail: error => {
    console.error(error);
  },
});
```