Class default

Hierarchy

default

Constructors

constructor

new default(cookie): default
Parameters
- cookie: string
  在 https://pc.woozooo.com/mydisk.php 获取 cookie，有效期约两天
Returns default
- Defined in lanzou.ts:42

Properties

`Private` cookie

cookie: string

`Static` allowList

allowList: string[] = allowList

`Static` getTypeOfShareLink

getTypeOfShareLink: ((url) => Promise<ShareType>) = getTypeOfShareLink

Type declaration

- (url): Promise<ShareType>
- Parameters
  - url: string
    分享链接
  Returns Promise<ShareType>
  返回 {type: "file"|"folder"|"null", requirePassword: true|false}
  
  Description
  判断文件分享页的类型

`Static` isShareLink

isShareLink: ((url) => boolean) = isShareLink

Type declaration

- (url): boolean
- Parameters
  - url: string
    分享链接
  Returns boolean
  布尔值，是否为蓝奏云文件分享页链接
  
  Description
  判断是否为蓝奏云文件分享页链接，请求会进行一定的缓存

`Static` queryShareFileInfo

queryShareFileInfo: ((shareURL) => Promise<QueryShareFileResp>) = queryShareFileInfo

Type declaration

- (shareURL): Promise<QueryShareFileResp>
- Parameters
  - shareURL: string
  Returns Promise<QueryShareFileResp>

`Static` queryShareFileInfoWithPassword

queryShareFileInfoWithPassword: ((shareURL) => Promise<QueryShareFileResp>) = queryShareFileInfoWithPassword

Type declaration

- (shareURL): Promise<QueryShareFileResp>
- 查询信息无需密码
  Parameters
  - shareURL: string
  Returns Promise<QueryShareFileResp>

`Static` queryShareFileLink

queryShareFileLink: ((shareURL) => Promise<QueryShareLinkResp>) = queryShareFileLink

Type declaration

- (shareURL): Promise<QueryShareLinkResp>
- Parameters
  - shareURL: string
  Returns Promise<QueryShareLinkResp>

`Static` queryShareFileLinkWithPassword

queryShareFileLinkWithPassword: ((shareURL, password) => Promise<QueryShareLinkResp>) = queryShareFileLinkWithPassword

Type declaration

- (shareURL, password): Promise<QueryShareLinkResp>
- Parameters
  - shareURL: string
  - password: string
  Returns Promise<QueryShareLinkResp>

`Static` queryShareFolder

queryShareFolder: ((shareURL) => Promise<QueryShareFolderResp>) = queryShareFolder

Type declaration

- (shareURL): Promise<QueryShareFolderResp>
- !TODO 暂未实现
  Parameters
  - shareURL: string
  Returns Promise<QueryShareFolderResp>

`Static` queryShareFolderWithPassword

queryShareFolderWithPassword: ((shareURL, password, pgs?) => Promise<QueryShareFolderResp>) = queryShareFolderWithPassword

Type declaration

- (shareURL, password, pgs?): Promise<QueryShareFolderResp>
- Parameters
  - shareURL: string
  - password: string
  - pgs: number = 1
  Returns Promise<QueryShareFolderResp>

Methods

createFolder

createFolder(parent_id?, folder_name?, folder_description?): Promise<CreateFolderResp>
Parameters
- parent_id: number = 0
  父目录id，默认为根目录
- folder_name: string = "新建文件夹"
  文件夹名称，默认为 "新建文件夹"
- folder_description: string = ""
  文件夹描述，默认为空
Returns Promise<CreateFolderResp>
成功
```
 {"zt":1,"info":"创建成功","text":"生成的文件夹id字符串"}
```
Description
创建文件夹，文件夹名称可以重复
- Defined in lanzou.ts:202

deleteFile

deleteFile(file_id): Promise<OperateResp>
Parameters
- file_id: number
  文件id
Returns Promise<OperateResp>
成功值
```
 {"zt":1,"info":"已删除","text":null}
```
Description
删除指定文件
- Defined in lanzou.ts:170

deleteFolder

deleteFolder(folder_id): Promise<OperateResp>
Parameters
- folder_id: number
  文件夹id
Returns Promise<OperateResp>
成功值
```
 {"zt":1,"info":"删除成功","text":null}
```
Description
删除指定文件夹，注意蓝奏云只能删除没有子文件夹的文件夹
- Defined in lanzou.ts:185

`Private` fetchLanzou

fetchLanzou(bodyObj): Promise<LanzouResp>
Parameters
- bodyObj: object
Returns Promise<LanzouResp>
- Defined in lanzou.ts:71

getFileNameByID

getFileNameByID(file_id): Promise<LanzouResp>
Parameters
- file_id: number
  文件id
Returns Promise<LanzouResp>
成功值
```
 {"zt":1,"info":"文件名称","text":""}
```
Description
通过文件id获取文件的名称
- Defined in lanzou.ts:247

getFiles

getFiles(folder_id?, pg?): Promise<ListFileResp>
Parameters
- folder_id: number = -1
  目录id，默认为根目录
- pg: number = 1
  页数，默认为1
Returns Promise<ListFileResp>
成功值
```
 {"zt":1,"info":[],"text": [{},{},...]}
```
Description
按页获取指定目录文件
- Defined in lanzou.ts:105

getFolders

getFolders(folder_id?, pg?): Promise<ListFolderResp>
Parameters
- folder_id: number = -1
  目录id，默认为根目录
- pg: number = 1
  页数，默认为1
Returns Promise<ListFolderResp>
成功值
```
 {"zt":1,"info": [{},{},...],"text":null}
```
Description
按页获取指定目录文件夹
- Defined in lanzou.ts:123

moveFileAction

moveFileAction(file_id, folder_id): Promise<MoveFileActionResp>
Parameters
- file_id: number
  文件id
- folder_id: number
  目标文件夹id
Returns Promise<MoveFileActionResp>
成功值
```
 {"zt":1,"info":"移动成功","text":null}
```
Description
先通过moveFileTarget找到指定文件夹，再通过moveFileAction移动文件到指定的文件夹
- Defined in lanzou.ts:295

moveFileTarget

moveFileTarget(file_id): Promise<MoveFileTargetResp>
Parameters
- file_id: number
  文件id
Returns Promise<MoveFileTargetResp>
成功值
```
 {"zt":1,"info":[{folder_name:"name",folder_id:"id"},...],"text":null}
```
Description
先通过moveFileTarget找到指定文件夹，再通过moveFileAction移动文件到指定的文件夹
- Defined in lanzou.ts:280

renameFile

renameFile(file_id, file_name): Promise<OperateResp>
Parameters
- file_id: number
  文件id
- file_name: string
  新的文件名称
Returns Promise<OperateResp>
失败值
```
 {"zt":0,"info":"此功能仅会员使用，请先开通会员","text":null}
```
Description
只有会员才能重命名文件。
- Defined in lanzou.ts:264

renameFolder

renameFolder(folder_id, folder_name?, folder_description?): Promise<OperateResp>
Parameters
- folder_id: number
  文件夹id
- folder_name: string = "新建文件夹"
  重命名的文件夹名称，默认为 "新建文件夹"
- folder_description: string = ""
  文件夹描述，默认为空
Returns Promise<OperateResp>
成功值
```
 {"zt":1,"info":"修改成功","text":null}
```
Description
重命名文件夹和修改文件夹描述
- Defined in lanzou.ts:226

setFileDescription

setFileDescription(file_id, desc?): Promise<OperateResp>
Parameters
- file_id: number
  文件id
- desc: string = ""
  文件描述
Returns Promise<OperateResp>
成功值
```
 {"zt":1,"info":"设置成功","text":null}
```
Description
设置文件描述。如果之前已经有了就不能设置为空
- Defined in lanzou.ts:311

setFilePassword

setFilePassword(file_id, shows, shownames?): Promise<PasswordResp>
Parameters
- file_id: number
  文件id
- shows: 0 | 1
  是否需要密码，1需要，0不需要，如果需要密码但没有传入shownames则自动生成。非会员用户无法取消密码（即传入0无效）
- Optional shownames: string
  访问密码，长度在2-6之间，shows为0时无需传入
Returns Promise<PasswordResp>
成功值
```
 {"zt":1,"info":"设置/修改成功","text":0无密码/1有密码} 失败值，注意zt原本为null，但api将其设置为0以保证一致性 {"zt":null,"info":"此功能仅会员使用（个人中心 - 会员个性化）","text":null}
```
Description
设置文件是否公开，或设置文件访问密码。上传的文件默认不需要密码，非会员用户无法取消密码
- Defined in lanzou.ts:328

setFolderPassword

setFolderPassword(folder_id, shows, shownames?): Promise<PasswordResp>
Parameters
- folder_id: number
  文件夹id
- shows: 0 | 1
  是否需要密码，1需要，0不需要，非会员用户无法取消密码（即传入0无效）
- Optional shownames: string
  访问密码，长度在2-6之间
Returns Promise<PasswordResp>
成功值
```
 {"zt":1,"info":"修改成功","text":1} 失败值，注意zt原本为null，但api将其设置为0以保证一致性 {"zt":null,"info":"此功能仅会员使用（个人中心 - 会员个性化）","text":null}
```
Description
设置文件夹是否公开，或设置文件夹访问密码。文件夹默认不需要密码，非会员用户无法取消密码
- Defined in lanzou.ts:356

shareFile

shareFile(file_id): Promise<ShareFileResp>

Parameters

file_id: number
文件id

Returns Promise<ShareFileResp>

成功值

{"zt":1,"info":{"pwd":"访问密码","onof":"0","f_id":"ii5ZQ01qmpqb","taoc":"","is_newd":"https://upload.lanzouj.com"},"text":null}

Description

获取文件的分享地址

shareFolder

shareFolder(folder_id): Promise<ShareFolderResp>

Parameters

folder_id: number
文件夹id

Returns Promise<ShareFolderResp>

成功值

 {"zt":1,"info":{"name":"文件夹名称","des":"文件夹描述","pwd":"访问密码","onof":"1","taoc":"","is_newd":"https://upload.lanzouj.com","new_url":"https://upload.lanzouj.com/xxxx"},"text":null}

Description

获取文件夹的分享地址

uploadFile

uploadFile(folder_id?, filepath): Promise<UploadFileResp>
Parameters
- folder_id: number = -1
  存放的文件夹id，默认为根目录
- filepath: string
  文件路径
Returns Promise<UploadFileResp>
成功值
```
 {"zt":1,"info":"上传成功","text":[{"icon":"zip","id":"65107976","f_id":"iMnMi01qglvg","name_all":"test.zip","name":"test.zip","size":"100.0 M","time":"0 秒前","downs":"0","onof":"0","is_newd":"https://upload.lanzouj.com"}]}
```
Description
上传本地文件。注意文件上传受到限制，普通用户只能上传100M以下的文件，文件后缀也受限制。
- Defined in lanzou.ts:376

`Static` genRandomPassword

genRandomPassword(length?): string
Parameters
- length: number = 4
  密码长度
Returns string
Description
生成随机分享密码
- Defined in lanzou.ts:64

`Static` of

of(cookie): default
Parameters
- cookie: string
  在 https://pc.woozooo.com/mydisk.php 获取 cookie，有效期约两天
Returns default
LanzouAPI 实例
- Defined in lanzou.ts:35

Class default

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

cookie: string

Returns default

Properties

Private cookie

Static allowList

Static getTypeOfShareLink

Type declaration

Parameters

url: string

Returns Promise<ShareType>

Description

Static isShareLink

Type declaration

Parameters

url: string

Returns boolean

Description

Static queryShareFileInfo

Type declaration

Parameters

shareURL: string

Returns Promise<QueryShareFileResp>

Static queryShareFileInfoWithPassword

Type declaration

Parameters

shareURL: string

Returns Promise<QueryShareFileResp>

Static queryShareFileLink

Type declaration

Parameters

shareURL: string

Returns Promise<QueryShareLinkResp>

Static queryShareFileLinkWithPassword

Type declaration

Parameters

shareURL: string

password: string

Returns Promise<QueryShareLinkResp>

Static queryShareFolder

Type declaration

Parameters

shareURL: string

Returns Promise<QueryShareFolderResp>

Static queryShareFolderWithPassword

Type declaration

Parameters

shareURL: string

password: string

pgs: number = 1

Returns Promise<QueryShareFolderResp>

Methods

createFolder

Parameters

parent_id: number = 0

folder_name: string = "新建文件夹"

folder_description: string = ""

Returns Promise<CreateFolderResp>

Description

deleteFile

Parameters

file_id: number

Returns Promise<OperateResp>

Description

deleteFolder

Parameters

folder_id: number

Returns Promise<OperateResp>

Description

Private fetchLanzou

Parameters

bodyObj: object

`Private` cookie

`Static` allowList

`Static` getTypeOfShareLink

`Static` isShareLink

`Static` queryShareFileInfo

`Static` queryShareFileInfoWithPassword

`Static` queryShareFileLink

`Static` queryShareFileLinkWithPassword

`Static` queryShareFolder

`Static` queryShareFolderWithPassword

`Private` fetchLanzou

`Optional` shownames: string

`Optional` shownames: string