@ray-js/api 1.7.69 → 1.7.71

package/@types/P2PKit.d.ts

@@ -1,424 +1,943 @@
 /**
  * P2PKit
  *
- * @version 2.1.0
+ * @version 7.7.6
  */
 declare namespace ty.p2p {
   /**
-   * P2P SDK 初始化
+   * P2P SDK init
+   * @public
+   * @since P2PKit 0.0.1
+   * @platform iOS Android
    */
-  export function P2PSDKInit(params: {
-    /** 用户id */
+  export function P2PSDKInit(params?: {
+    /**
+     * user id
+     * @since P2PKit 0.0.1
+     */
     userId?: string
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
+    /** 接口调用成功的回调函数 */
     success?: (params: null) => void
+    /** 接口调用失败的回调函数 */
     fail?: (params: {
+      /** 错误信息 */
       errorMsg: string
+      /** 错误码 */
       errorCode: string | number
+      /** 错误扩展 */
       innerError: {
+        /** 错误扩展码 */
         errorCode: string | number
+        /** 错误扩展信息 */
         errorMsg: string
       }
     }) => void
   }): void
 
   /**
-   * 建立P2P连接
+   * P2P connect
+   * @public
+   * @since P2PKit 0.0.1
+   * @platform iOS Android
    */
   export function connectDevice(params: {
-    /** 设备id */
+    /**
+     * device id
+     * @since P2PKit 0.0.1
+     */
     deviceId: string
-    /** 连接模式,0:INTERNET  1:LAN */
+    /**
+     * connect mode,0:INTERNET  1:LAN
+     * @since P2PKit 0.0.1
+     * @defaultValue 0
+     */
     mode?: number
-    /** 超时时长,单位：ms,设置0会设置成默认值，Internet：15000ms， Lan：3000ms */
+    /**
+     * timeout,unit：ms, default as Internet：15000ms,Lan：3000ms
+     * @since P2PKit 0.0.1
+     * @defaultValue 0
+     */
     timeout?: number
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
+    /** 接口调用成功的回调函数 */
     success?: (params: null) => void
+    /** 接口调用失败的回调函数 */
     fail?: (params: {
+      /** 错误信息 */
       errorMsg: string
+      /** 错误码 */
       errorCode: string | number
+      /** 错误扩展 */
       innerError: {
+        /** 错误扩展码 */
         errorCode: string | number
+        /** 错误扩展信息 */
         errorMsg: string
       }
     }) => void
   }): void
 
   /**
-   * 检查P2P连接
+   * check P2P status
+   * @public
+   * @since P2PKit 2.0.3
+   * @platform iOS Android
    */
   export function isP2PActive(params: {
-    /** 设备id */
+    /**
+     * device id
+     * @since P2PKit 2.0.3
+     */
     deviceId: string
-    /** 连接模式,0:INTERNET  1:LAN */
+    /**
+     * connect mode,0:INTERNET  1:LAN
+     * @since P2PKit 2.0.3
+     * @defaultValue 0
+     */
     mode?: number
-    /** 超时时长,单位：ms,设置0会设置成默认值，Internet：15000ms， Lan：3000ms */
+    /**
+     * timeout,unit：ms, default as Internet：15000ms,Lan：3000ms
+     * @since P2PKit 2.0.3
+     * @defaultValue 0
+     */
     timeout?: number
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
+    /** 接口调用成功的回调函数 */
     success?: (params: null) => void
+    /** 接口调用失败的回调函数 */
     fail?: (params: {
+      /** 错误信息 */
       errorMsg: string
+      /** 错误码 */
       errorCode: string | number
+      /** 错误扩展 */
       innerError: {
+        /** 错误扩展码 */
         errorCode: string | number
+        /** 错误扩展信息 */
         errorMsg: string
       }
     }) => void
   }): void
 
   /**
-   * 检查P2P连接
+   * check P2P status
+   * @public
+   * @since P2PKit 2.0.3
+   * @platform iOS Android
    */
   export function isP2PActiveSync(params?: ThingP2PConnectionParams): null
 
   /**
-   * 查询设备相册文件索引列表
+   * query device's album file index infos
+   * @public
+   * @since P2PKit 1.0.0
+   * @platform iOS Android
    */
   export function queryAlbumFileIndexs(params: {
-    /** 设备id */
+    /**
+     * device id
+     * @since P2PKit 1.0.0
+     */
     deviceId: string
-    /** albumName 和设备端约定字段 */
+    /**
+     * albumName,given by the device
+     * @since P2PKit 1.0.0
+     */
     albumName: string
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
+    /** 接口调用成功的回调函数 */
     success?: (params: {
-      /** 文件个数 */
+      /**
+       * file count
+       * @since P2PKit 2.0.2
+       */
       count: number
-      /** 文件索引 */
+      /**
+       * file index infos
+       * @since P2PKit 2.0.2
+       */
       items: ThingP2PAlbumFileIndex[]
     }) => void
+    /** 接口调用失败的回调函数 */
     fail?: (params: {
+      /** 错误信息 */
       errorMsg: string
+      /** 错误码 */
       errorCode: string | number
+      /** 错误扩展 */
       innerError: {
+        /** 错误扩展码 */
         errorCode: string | number
+        /** 错误扩展信息 */
         errorMsg: string
       }
     }) => void
   }): void
 
   /**
-   * P2P上传文件
+   * upload file
+   * @public
+   * @since P2PKit 0.0.1
+   * @platform iOS Android
    */
   export function uploadFile(params: {
-    /** 设备id */
+    /**
+     * device id
+     * @since P2PKit 0.0.1
+     */
     deviceId: string
-    /** albumName 和设备端约定字段 */
+    /**
+     * albumName given by the device
+     * @since P2PKit 0.0.1
+     */
     albumName: string
-    /** 文件本地路径 */
+    /**
+     * local file path
+     * @since P2PKit 0.0.1
+     */
     filePath: string
-    /** 扩展字段 */
+    /**
+     * ext data
+     * @since P2PKit 0.0.1
+     */
     extData?: string
-    /** 扩展字段长度 */
+    /**
+     * ext data length
+     * @since P2PKit 0.0.1
+     */
     extDataLength?: number
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
+    /** 接口调用成功的回调函数 */
     success?: (params: null) => void
+    /** 接口调用失败的回调函数 */
     fail?: (params: {
+      /** 错误信息 */
       errorMsg: string
+      /** 错误码 */
       errorCode: string | number
+      /** 错误扩展 */
       innerError: {
+        /** 错误扩展码 */
         errorCode: string | number
+        /** 错误扩展信息 */
         errorMsg: string
       }
     }) => void
   }): void
 
   /**
-   * P2P下载文件
+   * download file
+   * @public
+   * @since P2PKit 1.0.0
+   * @platform iOS Android
    */
   export function downloadFile(params: {
-    /** 设备id */
+    /**
+     * device id
+     * @since P2PKit 1.0.0
+     */
     deviceId: string
-    /** albumName 和设备端约定字段 */
+    /**
+     * albumName given by the device
+     * @since P2PKit 1.0.0
+     */
     albumName: string
-    /** 下载文件本地存储路径 */
+    /**
+     * local file path
+     * @since P2PKit 1.0.0
+     */
     filePath: string
-    /** 下载的文件名称，eg: {"files":["filesname1", "filesname2", "filesname3" ]} */
+    /**
+     * file name jsons，eg: {"files":["filesname1", "filesname2", "filesname3" ]}
+     * @since P2PKit 1.0.0
+     */
     jsonfiles: string
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
+    /** 接口调用成功的回调函数 */
     success?: (params: null) => void
+    /** 接口调用失败的回调函数 */
     fail?: (params: {
+      /** 错误信息 */
       errorMsg: string
+      /** 错误码 */
       errorCode: string | number
+      /** 错误扩展 */
       innerError: {
+        /** 错误扩展码 */
         errorCode: string | number
+        /** 错误扩展信息 */
         errorMsg: string
       }
     }) => void
   }): void
 
   /**
-   * P2P下载数据流
+   * download file stream
+   * @public
+   * @since P2PKit 2.0.2
+   * @platform iOS Android
    */
   export function downloadStream(params: {
-    /** 设备id */
+    /**
+     * device id
+     * @since P2PKit 2.0.2
+     */
     deviceId: string
-    /** albumName 和设备端约定字段 */
+    /**
+     * albumName given by the device
+     * @since P2PKit 2.0.2
+     */
     albumName: string
-    /** 下载的文件名称，eg: {"files":["filesname1", "filesname2", "filesname3" ]} */
+    /**
+     * file name jsons，eg: {"files":["filesname1", "filesname2", "filesname3" ]}
+     * @since P2PKit 2.0.2
+     */
     jsonfiles: string
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
+    /** 接口调用成功的回调函数 */
     success?: (params: null) => void
+    /** 接口调用失败的回调函数 */
     fail?: (params: {
+      /** 错误信息 */
       errorMsg: string
+      /** 错误码 */
       errorCode: string | number
+      /** 错误扩展 */
       innerError: {
+        /** 错误扩展码 */
         errorCode: string | number
+        /** 错误扩展信息 */
         errorMsg: string
       }
     }) => void
   }): void
 
   /**
-   * P2P追加下载数据流
+   * append download file stream
+   * @public
+   * @since P2PKit 2.1.0
+   * @platform iOS Android
    */
   export function appendDownloadStream(params: {
-    /** 设备id */
+    /**
+     * device id
+     * @since P2PKit 2.1.0
+     */
     deviceId: string
-    /** albumName 和设备端约定字段 */
+    /**
+     * albumName given by the device
+     * @since P2PKit 2.1.0
+     */
     albumName: string
-    /** 下载的文件名称，eg: {"files":["filesname1", "filesname2", "filesname3" ]} */
+    /**
+     * file name jsons，eg: {"files":["filesname1", "filesname2", "filesname3" ]}
+     * @since P2PKit 2.1.0
+     */
     jsonfiles: string
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
+    /** 接口调用成功的回调函数 */
     success?: (params: null) => void
+    /** 接口调用失败的回调函数 */
     fail?: (params: {
+      /** 错误信息 */
       errorMsg: string
+      /** 错误码 */
       errorCode: string | number
+      /** 错误扩展 */
       innerError: {
+        /** 错误扩展码 */
         errorCode: string | number
+        /** 错误扩展信息 */
         errorMsg: string
       }
     }) => void
   }): void
 
   /**
-   * 取消传输任务
+   * cancel upload task
+   * @public
+   * @since P2PKit 0.0.1
+   * @platform iOS Android
    */
   export function cancelUploadTask(params: {
-    /** 设备id */
+    /**
+     * device id
+     * @since P2PKit 0.0.1
+     */
     deviceId: string
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
+    /** 接口调用成功的回调函数 */
     success?: (params: null) => void
+    /** 接口调用失败的回调函数 */
     fail?: (params: {
+      /** 错误信息 */
       errorMsg: string
+      /** 错误码 */
       errorCode: string | number
+      /** 错误扩展 */
       innerError: {
+        /** 错误扩展码 */
         errorCode: string | number
+        /** 错误扩展信息 */
         errorMsg: string
       }
     }) => void
   }): void
 
   /**
-   * 取消下载任务
+   * cancel download task
+   * @public
+   * @since P2PKit 1.0.0
+   * @platform iOS Android
    */
   export function cancelDownloadTask(params: {
-    /** 设备id */
+    /**
+     * device id
+     * @since P2PKit 1.0.0
+     */
     deviceId: string
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
+    /** 接口调用成功的回调函数 */
     success?: (params: null) => void
+    /** 接口调用失败的回调函数 */
     fail?: (params: {
+      /** 错误信息 */
       errorMsg: string
+      /** 错误码 */
       errorCode: string | number
+      /** 错误扩展 */
       innerError: {
+        /** 错误扩展码 */
         errorCode: string | number
+        /** 错误扩展信息 */
         errorMsg: string
       }
     }) => void
   }): void
 
   /**
-   * 和设备断开连接
+   * P2P disconnect
+   * @public
+   * @since P2PKit 0.0.1
+   * @platform iOS Android
    */
   export function disconnectDevice(params: {
-    /** 设备id */
+    /**
+     * device id
+     * @since P2PKit 0.0.1
+     */
     deviceId: string
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
+    /** 接口调用成功的回调函数 */
     success?: (params: null) => void
+    /** 接口调用失败的回调函数 */
     fail?: (params: {
+      /** 错误信息 */
       errorMsg: string
+      /** 错误码 */
       errorCode: string | number
+      /** 错误扩展 */
       innerError: {
+        /** 错误扩展码 */
         errorCode: string | number
+        /** 错误扩展信息 */
         errorMsg: string
       }
     }) => void
   }): void
 
   /**
-   * P2P SDK 反初始化
+   * P2P SDK deinit
+   * @public
+   * @since P2PKit 0.0.1
+   * @platform iOS Android
    */
   export function deInitSDK(params?: {
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
+    /** 接口调用成功的回调函数 */
     success?: (params: null) => void
+    /** 接口调用失败的回调函数 */
     fail?: (params: {
+      /** 错误信息 */
       errorMsg: string
+      /** 错误码 */
       errorCode: string | number
+      /** 错误扩展 */
       innerError: {
+        /** 错误扩展码 */
         errorCode: string | number
+        /** 错误扩展信息 */
         errorMsg: string
       }
     }) => void
   }): void
 
   /**
-   * 连接状态改变回调
+   * P2P status changed event
+   * @public
+   * @since P2PKit 1.0.0
+   * @platform iOS Android
    */
-  export function onSessionStatusChange(listener: (params: ThingP2PSessionStatus) => void): void
+  export function onSessionStatusChange(
+    listener: (params: ThingP2PSessionStatus) => void
+  ): void
 
   /**
-   * 取消监听：连接状态改变回调
+   * P2P status changed event
+   * @public
+   * @since P2PKit 1.0.0
+   * @platform iOS Android
    */
-  export function offSessionStatusChange(listener: (params: ThingP2PSessionStatus) => void): void
+  export function offSessionStatusChange(
+    listener: (params: ThingP2PSessionStatus) => void
+  ): void
 
   /**
-   * 上传进度回调
+   * upload file progress event
+   * @public
+   * @since P2PKit 0.0.1
+   * @platform iOS Android
    */
-  export function onUploadProgressUpdate(listener: (params: ProgressEvent) => void): void
+  export function onUploadProgressUpdate(
+    listener: (params: ProgressEvent) => void
+  ): void
 
   /**
-   * 取消监听：上传进度回调
+   * upload file progress event
+   * @public
+   * @since P2PKit 0.0.1
+   * @platform iOS Android
    */
-  export function offUploadProgressUpdate(listener: (params: ProgressEvent) => void): void
+  export function offUploadProgressUpdate(
+    listener: (params: ProgressEvent) => void
+  ): void
 
   /**
-   * 单个文件下载进度回调
+   * single file download progress event
+   * @public
+   * @since P2PKit 1.0.0
+   * @platform iOS Android
    */
-  export function onDownloadProgressUpdate(listener: (params: DownloadProgressEvent) => void): void
+  export function onDownloadProgressUpdate(
+    listener: (params: DownloadProgressEvent) => void
+  ): void
 
   /**
-   * 取消监听：单个文件下载进度回调
+   * single file download progress event
+   * @public
+   * @since P2PKit 1.0.0
+   * @platform iOS Android
    */
-  export function offDownloadProgressUpdate(listener: (params: DownloadProgressEvent) => void): void
+  export function offDownloadProgressUpdate(
+    listener: (params: DownloadProgressEvent) => void
+  ): void
 
   /**
-   * 下载总进度回调
+   * total download progress event
+   * @public
+   * @since P2PKit 1.0.0
+   * @platform iOS Android
    */
   export function onDownloadTotalProgressUpdate(
     listener: (params: DownloadTotalProgressEvent) => void
   ): void
 
   /**
-   * 取消监听：下载总进度回调
+   * total download progress event
+   * @public
+   * @since P2PKit 1.0.0
+   * @platform iOS Android
    */
   export function offDownloadTotalProgressUpdate(
     listener: (params: DownloadTotalProgressEvent) => void
   ): void
 
   /**
-   * 单文件下载完成事件
+   * single file download completed event
+   * @public
+   * @since P2PKit 1.0.0
+   * @platform iOS Android
    */
   export function onFileDownloadComplete(
     listener: (params: FileDownloadCompletionEvent) => void
   ): void
 
   /**
-   * 取消监听：单文件下载完成事件
+   * single file download completed event
+   * @public
+   * @since P2PKit 1.0.0
+   * @platform iOS Android
    */
   export function offFileDownloadComplete(
     listener: (params: FileDownloadCompletionEvent) => void
   ): void
 
   /**
-   * 收到数据包事件
+   * download packet received event
+   * @public
+   * @since P2PKit 2.0.2
+   * @platform iOS Android
    */
   export function onStreamPacketReceive(
     listener: (params: StreamDownloadPacketReceivedEvent) => void
   ): void
 
   /**
-   * 取消监听：收到数据包事件
+   * download packet received event
+   * @public
+   * @since P2PKit 2.0.2
+   * @platform iOS Android
    */
   export function offStreamPacketReceive(
     listener: (params: StreamDownloadPacketReceivedEvent) => void
   ): void
 
-  export type ThingP2PConnectionParams = {
-    /** 设备id */
+  /** @since P2PKit 2.0.0 */
+  export interface ThingP2PInitConfigParams {
+    /**
+     * user id
+     * @since P2PKit 2.0.0
+     */
+    userId?: string
+  }
+
+  /** @since P2PKit 2.0.0 */
+  export interface ThingP2PConnectionParams {
+    /**
+     * device id
+     * @since P2PKit 2.0.3
+     */
     deviceId: string
-    /** 连接模式,0:INTERNET  1:LAN */
+    /**
+     * connect mode,0:INTERNET  1:LAN
+     * @since P2PKit 2.0.3
+     * @defaultValue 0
+     */
     mode?: number
-    /** 超时时长,单位：ms,设置0会设置成默认值，Internet：15000ms， Lan：3000ms */
+    /**
+     * timeout,unit：ms, default as Internet：15000ms,Lan：3000ms
+     * @since P2PKit 2.0.3
+     * @defaultValue 0
+     */
     timeout?: number
   }
 
-  export type ThingP2PAlbumFileIndex = {
-    /** idx 唯一标识，设备提供 */
+  /** @since P2PKit 2.0.0 */
+  export interface ThingP2PAlbum {
+    /**
+     * device id
+     * @since P2PKit 2.0.0
+     */
+    deviceId: string
+    /**
+     * albumName,given by the device
+     * @since P2PKit 2.0.0
+     */
+    albumName: string
+  }
+
+  /** @since P2PKit 2.0.0 */
+  export interface ThingP2PAlbumFileIndex {
+    /**
+     * idx,given by the device
+     * @since P2PKit 2.0.2
+     */
     idx: number
-    /** channel 通道号 */
+    /**
+     * channel channel number
+     * @since P2PKit 2.0.2
+     */
     channel: number
-    /** type 文件类型，0: 图片，2: mp4, 3: 全景拼接文件 */
+    /**
+     * type file type,0: image，2: mp4, 3: Panoramic stitching file
+     * @since P2PKit 2.0.2
+     */
     type: number
-    /** dir 0: 文件，1: 文件夹。保留字段，目前都是 0 */
+    /**
+     * dir 0: file，1: directory
+     * @since P2PKit 2.0.2
+     */
     dir: number
-    /** filename 文件名，带有文件后缀 */
+    /**
+     * file name contains suffix
+     * @since P2PKit 2.0.2
+     */
     filename: string
-    /** createTime 文件创建时间 */
+    /**
+     * createTime file create time
+     * @since P2PKit 2.0.2
+     */
     createTime: number
-    /** duration 视频文件时长 */
+    /**
+     * duration file duration
+     * @since P2PKit 2.0.2
+     */
     duration: number
   }
 
-  export type ThingP2PSessionStatus = {
-    /** 设备id */
+  /** @since P2PKit 2.0.0 */
+  export interface ThingP2PAlbumFileIndexs {
+    /**
+     * file count
+     * @since P2PKit 2.0.0
+     */
+    count: number
+    /**
+     * file index infos
+     * @since P2PKit 2.0.0
+     */
+    items: ThingP2PAlbumFileIndex[]
+  }
+
+  /** @since P2PKit 2.0.0 */
+  export interface ThingP2PUploadFile {
+    /**
+     * device id
+     * @since P2PKit 2.0.0
+     */
+    deviceId: string
+    /**
+     * albumName given by the device
+     * @since P2PKit 2.0.0
+     */
+    albumName: string
+    /**
+     * local file path
+     * @since P2PKit 2.0.0
+     */
+    filePath: string
+    /**
+     * ext data
+     * @since P2PKit 2.0.0
+     */
+    extData?: string
+    /**
+     * ext data length
+     * @since P2PKit 2.0.0
+     */
+    extDataLength?: number
+  }
+
+  /** @since P2PKit 2.0.0 */
+  export interface ThingP2PDownloadFile {
+    /**
+     * device id
+     * @since P2PKit 2.0.0
+     */
     deviceId: string
-    /** 状态值, 小于0为断开连接 */
+    /**
+     * albumName given by the device
+     * @since P2PKit 2.0.0
+     */
+    albumName: string
+    /**
+     * local file path
+     * @since P2PKit 2.0.0
+     */
+    filePath: string
+    /**
+     * file name jsons，eg: {"files":["filesname1", "filesname2", "filesname3" ]}
+     * @since P2PKit 2.0.0
+     */
+    jsonfiles: string
+  }
+
+  /** @since P2PKit 2.0.2 */
+  export interface ThingP2PDownloadStream {
+    /**
+     * device id
+     * @since P2PKit 2.0.2
+     */
+    deviceId: string
+    /**
+     * albumName given by the device
+     * @since P2PKit 2.0.2
+     */
+    albumName: string
+    /**
+     * file name jsons，eg: {"files":["filesname1", "filesname2", "filesname3" ]}
+     * @since P2PKit 2.0.2
+     */
+    jsonfiles: string
+  }
+
+  /** @since P2PKit 2.0.0 */
+  export interface ThingP2PSessionStatus {
+    /**
+     * device id
+     * @since P2PKit 2.0.0
+     */
+    deviceId: string
+    /**
+     * status, status < 0 means disconnected
+     * @since P2PKit 2.0.0
+     */
     status: number
   }
 
-  export type ProgressEvent = {
-    /** 设备id */
+  /** @since P2PKit 0.0.1 */
+  export interface ProgressEvent {
+    /**
+     * device id
+     * @since P2PKit 0.0.1
+     */
     deviceId: string
-    /** 文件本地路径 */
+    /**
+     * local file path
+     * @since P2PKit 0.0.1
+     */
     filePath: string
-    /** 上传/下载进度 */
+    /**
+     * upload/download progress
+     * @since P2PKit 0.0.1
+     */
     progress: number
   }
 
-  export type DownloadProgressEvent = {
-    /** 设备id */
+  /** @since P2PKit 1.0.0 */
+  export interface DownloadProgressEvent {
+    /**
+     * device id
+     * @since P2PKit 1.0.0
+     */
     deviceId: string
-    /** 正在下载的文件名称 */
+    /**
+     * file name on downloading
+     * @since P2PKit 1.0.0
+     */
     fileName: string
-    /** 上传/下载进度 */
+    /**
+     * upload/download progress
+     * @since P2PKit 1.0.0
+     */
     progress: number
   }
 
-  export type DownloadTotalProgressEvent = {
-    /** 设备id */
+  /** @since P2PKit 1.0.0 */
+  export interface DownloadTotalProgressEvent {
+    /**
+     * device id
+     * @since P2PKit 1.0.0
+     */
     deviceId: string
-    /** 上传/下载进度 */
+    /**
+     * upload/download progress
+     * @since P2PKit 1.0.0
+     */
     progress: number
   }
 
-  export type FileDownloadCompletionEvent = {
-    /** 设备id */
+  /** @since P2PKit 1.0.0 */
+  export interface FileDownloadCompletionEvent {
+    /**
+     * device id
+     * @since P2PKit 1.0.0
+     */
     deviceId: string
-    /** 文件名 */
+    /**
+     * file name
+     * @since P2PKit 1.0.0
+     */
     fileName: string
-    /** 索引 */
+    /**
+     * index
+     * @since P2PKit 1.0.0
+     */
     index: number
   }
 
-  export type StreamDownloadPacketReceivedEvent = {
-    /** 设备id */
+  /** @since P2PKit 2.0.2 */
+  export interface StreamDownloadPacketReceivedEvent {
+    /**
+     * device id
+     * @since P2PKit 2.0.2
+     */
     deviceId: string
-    /** 文件个数 */
+    /**
+     * total files count
+     * @since P2PKit 2.0.2
+     */
     totalFiles: number
-    /** 文件名 */
+    /**
+     * file name
+     * @since P2PKit 2.0.2
+     */
     fileName: string
-    /** 索引,目前错误数据 */
+    /**
+     * file index, dirty data
+     * @since P2PKit 2.0.2
+     */
     fileIndex: number
-    /** 文件大小 */
+    /**
+     * file length
+     * @since P2PKit 2.0.2
+     */
     fileLength: number
-    /** 数据 */
+    /**
+     * packet data
+     * @since P2PKit 2.0.2
+     */
     packetData: string
-    /** 包大小 */
+    /**
+     * packet data length
+     * @since P2PKit 2.0.2
+     */
     packetLength: number
-    /** 文件序列号 */
+    /**
+     * file serial number
+     * @since P2PKit 2.0.2
+     */
     fileSerialNumber: number
-    /** 包索引 */
+    /**
+     * packet index
+     * @since P2PKit 2.0.2
+     */
     packetIndex: number
-    /** 包头/包尾 0b00XY Y:包头  X:包尾 */
+    /**
+     * packet header/packet tail 0b00XY Y:packet header  X:packet tail
+     * @since P2PKit 2.0.2
+     */
     packetType: number
   }
+
+  /** @since P2PKit 2.0.0 */
+  export interface ThingP2PUploadTask {
+    /**
+     * device id
+     * @since P2PKit 2.0.0
+     */
+    deviceId: string
+  }
+
+  /** @since P2PKit 2.0.0 */
+  export interface ThingP2PDownloadTask {
+    /**
+     * device id
+     * @since P2PKit 2.0.0
+     */
+    deviceId: string
+  }
+
+  /** @since P2PKit 2.0.0 */
+  export interface ThingP2PDevice {
+    /**
+     * device id
+     * @since P2PKit 2.0.0
+     */
+    deviceId: string
+  }
 }