# proxyee-down-extension

**Repository Path**: weihongbin/proxyee-down-extension

## Basic Information

- **Project Name**: proxyee-down-extension
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-04-18
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Proxyee Down 扩展仓库

根目录下每个文件夹代表一个扩展，文件夹里必须包含一个`manifest.json`文件。

## manifest.json

通过这个文件来配置插件相关信息，例如：

```json
{
  "title": "百度云下载插件",
  "version": 0.1,
  "description": "可以直接获取下载链接并推送到Proxyee Down下载",
  "proxyWildcards": ["pan.baidu.com", "yun.baidu.com", "d.pcs.baidu.com"],
  "sniffRegexs": [],
  "contentScripts": [
    {
      "matches": ["^(pan|yun).baidu.com/disk/home.*$"],
      "scripts": ["common.js", "home.js"]
    },
    {
      "matches": ["^(pan|yun).baidu.com/(s/|share/link).*$"],
      "scripts": ["common.js", "share.js"]
    }
  ]
}
```

### title

扩展的名称

### version

扩展的版本号，当检测到有更大的版本号时，扩展就会提示更新。

### description

扩展的描述

### proxyWildcards

域名通配符列表，代理服务器会在指定的域名通配符中生效

### sniffRegexs

正则表达式列表，会嗅探匹配的正则表达式列表的url请求，当请求为下载请求时会调用Proxyee Down进行下载

### contentScripts

配置扩展注入 js 的条件，可以配置多个。

- matches

  当浏览器`url`匹配到这里的正则表达式时，就会将 js 注入至对应的页面。

- scripts

  当`matches`生效时，注入扩展目录下指定的 js 文件。

## 贡献插件

1. 首先 fork 此仓库
2. 创建一个插件目录
3. 编写`manifest.json`和`脚本`
4. 编写`README.md`文件
5. 提交 PR

## API

插件脚本中可以访问`pdown`对象，目前支持以下方法：

方法名 | 参数 | 异步 | 说明
---|---|---|---
resolve | (request) | 否 | 根据请求解析出响应的相关信息(大小、文件名、是否支持断点下载)
resolveAsync | (request, onSuccess, onError) | 是 | 根据请求解析出响应的相关信息(大小、文件名、是否支持断点下载)
createTask | (taskForm) | 否 | 创建一个任务，会唤醒 proxyee-down 并弹出下载框
createTaskAsync | (taskForm, onSuccess, onError) | 是 | 创建一个任务，会唤醒 proxyee-down 并弹出下载框
pushTask | (taskForm, onSuccess, onError) | 是 | 创建一个任务，不弹下载框直接在后台下载
getDownConfig | () | 否 | 取下载相关配置信息
getDownConfigAsync | (onSuccess, onError) | 是 | 取下载相关配置信息
getCookie | (url) | 否 | 取目标网站的cookie，需要被代理服务器访问才能生效
getCookieAsync | (url, onSuccess, onError) | 是 | 取目标网站的cookie，需要被代理服务器访问才能生效